From a6af3036ab665750221f3e77a54b84a981d20252 Mon Sep 17 00:00:00 2001 From: Trivernis Date: Tue, 17 Sep 2019 20:24:14 +0200 Subject: [PATCH 01/17] Create LICENSE --- LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 674 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. From 726e4ba34c67a169103e16aacc8c861bb379e79e Mon Sep 17 00:00:00 2001 From: Trivernis Date: Tue, 17 Sep 2019 20:25:01 +0200 Subject: [PATCH 02/17] Added Progress percentage to periodical task status --- .../net/trivernis/chunkmaster/lib/GenerationManager.kt | 6 ++++-- .../kotlin/net/trivernis/chunkmaster/lib/GenerationTask.kt | 4 ++-- src/main/resources/plugin.yml | 2 +- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationManager.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationManager.kt index 4516deb..0a87897 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationManager.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationManager.kt @@ -172,8 +172,10 @@ class GenerationManager(private val chunkmaster: Chunkmaster, private val server for (task in tasks) { try { val genTask = task.generationTask - server.consoleSender.sendMessage("Task #${task.id} running for \"${genTask.world.name}\". " + - "Progress ${task.generationTask.count} chunks. Last Chunk: ${genTask.lastChunk.x}, ${genTask.lastChunk.z}") + server.consoleSender.sendMessage("""Task #${task.id} running for "${genTask.world.name}". + |Progress ${task.generationTask.count} chunks + |${if (task.generationTask.stopAfter > 0)"(${(task.generationTask.count.toDouble()/task.generationTask.stopAfter.toDouble())*100}%)." else ""} + |Last Chunk: ${genTask.lastChunk.x}, ${genTask.lastChunk.z}""".trimMargin("|").replace('\n', ' ')) val updateStatement = chunkmaster.sqliteConnection.prepareStatement(""" UPDATE generation_tasks SET last_x = ?, last_z = ? WHERE id = ? diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTask.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTask.kt index 0c62ef7..da58b1e 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTask.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTask.kt @@ -7,8 +7,8 @@ import org.bukkit.scheduler.BukkitRunnable import org.bukkit.scheduler.BukkitTask class GenerationTask(private val plugin: Chunkmaster, val world: World, - private val centerChunk: Chunk, private val startChunk: Chunk, - private val stopAfter: Int = -1): Runnable { + centerChunk: Chunk, private val startChunk: Chunk, + val stopAfter: Int = -1): Runnable { private val spiral: Spiral = Spiral(Pair(centerChunk.x, centerChunk.z), Pair(startChunk.x, startChunk.z)) private val loadedChunks: HashSet = HashSet() private val chunkSkips = plugin.config.getInt("generation.chunks-skips-per-step") diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml index 26d5d3d..8708e9f 100644 --- a/src/main/resources/plugin.yml +++ b/src/main/resources/plugin.yml @@ -1,6 +1,6 @@ main: net.trivernis.chunkmaster.Chunkmaster name: Chunkmaster -version: '1.0 SNAPSHOT' +version: '0.10-beta-SNAPSHOT' description: Chunk commands plugin. author: Trivernis website: trivernis.net From 08bec14df94987cf1f0707ccfdfd6cb93475d342 Mon Sep 17 00:00:00 2001 From: Trivernis Date: Tue, 17 Sep 2019 23:38:04 +0200 Subject: [PATCH 03/17] Generation task seperation - Added interface GenerationTask - added method to GenerationManager that creates a task depending on the server type - added generation task for paper and spigot (to profit from async chunk loading) --- build.gradle | 23 ++++- .../net/trivernis/chunkmaster/Chunkmaster.kt | 2 + .../chunkmaster/lib/GenerationManager.kt | 22 ++++- .../chunkmaster/lib/GenerationTask.kt | 82 ++++------------ .../chunkmaster/lib/GenerationTaskPaper.kt | 97 +++++++++++++++++++ .../chunkmaster/lib/GenerationTaskSpigot.kt | 74 ++++++++++++++ 6 files changed, 233 insertions(+), 67 deletions(-) create mode 100644 src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTaskPaper.kt create mode 100644 src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTaskSpigot.kt diff --git a/build.gradle b/build.gradle index 55728e3..9930870 100644 --- a/build.gradle +++ b/build.gradle @@ -1,3 +1,12 @@ +buildscript { + repositories { + jcenter() + } + + dependencies { + classpath "com.github.jengelman.gradle.plugins:shadow:2.0.2" + } +} plugins { id 'idea' @@ -13,7 +22,7 @@ idea { } group "net.trivernis" -version "1.0-SNAPSHOT" +version "0.10-beta" sourceCompatibility = 1.8 @@ -28,6 +37,10 @@ repositories { maven { url 'https://mvnrepository.com/artifact/org.xerial/sqlite-jdbc' } + maven { + name 'papermc' + url 'https://papermc.io/repo/repository/maven-public/' + } } dependencies { @@ -36,16 +49,24 @@ dependencies { testCompile group: 'junit', name: 'junit', version: '4.12' compileOnly "org.spigotmc:spigot-api:1.14.4-R0.1-SNAPSHOT" compile group: 'org.xerial', name: 'sqlite-jdbc', version: '3.28.0' + compile "io.papermc:paperlib:1.0.2" +} + +apply plugin: "com.github.johnrengelman.shadow" +shadowJar { + relocate 'io.papermc.lib', 'net.trivernis.chunkmaster.paperlib' } jar { from configurations.compile.collect { it.isDirectory() ? it : zipTree(it) } } + compileKotlin { kotlinOptions { jvmTarget = "1.8" } } + compileTestKotlin { kotlinOptions { jvmTarget = "1.8" diff --git a/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt b/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt index af8ca59..ca705db 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt @@ -1,5 +1,6 @@ package net.trivernis.chunkmaster +import io.papermc.lib.PaperLib import net.trivernis.chunkmaster.commands.* import net.trivernis.chunkmaster.lib.GenerationManager import net.trivernis.chunkmaster.lib.SqlUpdateManager @@ -21,6 +22,7 @@ class Chunkmaster: JavaPlugin() { * On enable of the plugin */ override fun onEnable() { + PaperLib.suggestPaper(this) configure() initDatabase() generationManager = GenerationManager(this, server) diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationManager.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationManager.kt index 0a87897..3d0bb3b 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationManager.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationManager.kt @@ -1,11 +1,10 @@ package net.trivernis.chunkmaster.lib -import javafx.concurrent.Task +import io.papermc.lib.PaperLib import net.trivernis.chunkmaster.Chunkmaster import org.bukkit.Chunk import org.bukkit.Server import org.bukkit.World -import org.bukkit.scheduler.BukkitTask import java.lang.Exception import java.lang.NullPointerException @@ -20,7 +19,8 @@ class GenerationManager(private val chunkmaster: Chunkmaster, private val server */ fun addTask(world: World, stopAfter: Int = -1): Int { val centerChunk = world.getChunkAt(world.spawnLocation) - val generationTask = GenerationTask(chunkmaster, world, centerChunk, centerChunk, stopAfter) + val generationTask = createGenerationTask(world, centerChunk, centerChunk, stopAfter) + val insertStatement = chunkmaster.sqliteConnection.prepareStatement(""" INSERT INTO generation_tasks (center_x, center_z, last_x, last_z, world, stop_after) values (?, ?, ?, ?, ?, ?) @@ -59,7 +59,7 @@ class GenerationManager(private val chunkmaster: Chunkmaster, private val server private fun resumeTask(world: World, center: Chunk, last: Chunk, id: Int, stopAfter: Int = -1) { if (!paused) { chunkmaster.logger.info("Resuming chunk generation task for world \"${world.name}\"") - val generationTask = GenerationTask(chunkmaster, world, center, last, stopAfter) + val generationTask = createGenerationTask(world, center, last, stopAfter) val task = server.scheduler.runTaskTimer(chunkmaster, generationTask, 10, chunkmaster.config.getLong("generation.period")) tasks.add(TaskEntry(id, task, generationTask)) @@ -174,7 +174,7 @@ class GenerationManager(private val chunkmaster: Chunkmaster, private val server val genTask = task.generationTask server.consoleSender.sendMessage("""Task #${task.id} running for "${genTask.world.name}". |Progress ${task.generationTask.count} chunks - |${if (task.generationTask.stopAfter > 0)"(${(task.generationTask.count.toDouble()/task.generationTask.stopAfter.toDouble())*100}%)." else ""} + |${if (task.generationTask.stopAfter > 0)"(${(task.generationTask.count.toDouble()/task.generationTask.stopAfter.toDouble())*100}%)" else ""}. |Last Chunk: ${genTask.lastChunk.x}, ${genTask.lastChunk.z}""".trimMargin("|").replace('\n', ' ')) val updateStatement = chunkmaster.sqliteConnection.prepareStatement(""" UPDATE generation_tasks SET last_x = ?, last_z = ? @@ -195,4 +195,16 @@ class GenerationManager(private val chunkmaster: Chunkmaster, private val server } } } + + /** + * Creates a new generation task. This method is used to create a task depending + * on the server type (Paper/Spigot). + */ + private fun createGenerationTask(world: World, center: Chunk, start: Chunk, stopAfter: Int): GenerationTask { + return if (PaperLib.isPaper()) { + GenerationTaskPaper(chunkmaster, world, center, start, stopAfter) + } else { + GenerationTaskSpigot(chunkmaster, world, center, start, stopAfter) + } + } } \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTask.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTask.kt index da58b1e..230d843 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTask.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTask.kt @@ -3,73 +3,33 @@ package net.trivernis.chunkmaster.lib import net.trivernis.chunkmaster.Chunkmaster import org.bukkit.Chunk import org.bukkit.World -import org.bukkit.scheduler.BukkitRunnable -import org.bukkit.scheduler.BukkitTask -class GenerationTask(private val plugin: Chunkmaster, val world: World, - centerChunk: Chunk, private val startChunk: Chunk, - val stopAfter: Int = -1): Runnable { - private val spiral: Spiral = Spiral(Pair(centerChunk.x, centerChunk.z), Pair(startChunk.x, startChunk.z)) - private val loadedChunks: HashSet = HashSet() - private val chunkSkips = plugin.config.getInt("generation.chunks-skips-per-step") - private val msptThreshold = plugin.config.getLong("generation.mspt-pause-threshold") +/** + * Interface for generation tasks. + */ +abstract class GenerationTask(plugin: Chunkmaster, centerChunk: Chunk, startChunk: Chunk) : Runnable { - var count = 0 - private set - var lastChunk: Chunk = startChunk - private set - var endReached: Boolean = false - private set + abstract val stopAfter: Int + abstract val world: World + abstract val count: Int + abstract val lastChunk: Chunk + abstract val endReached: Boolean - /** - * Runs the generation task. Every Iteration the next chunk will be generated if - * it hasn't been generated already. - * After 10 chunks have been generated, they will all be unloaded and saved. - */ - override fun run() { - if (plugin.mspt < msptThreshold) { // pause when tps < 2 - if (loadedChunks.size > 10) { - for (chunk in loadedChunks) { - if (chunk.isLoaded) { - chunk.unload(true) - } - } - } else { - if (!world.worldBorder.isInside(lastChunk.getBlock(8, 0, 8).location) || (stopAfter in 1..count)) { - endReached = true - return - } - var nextChunkCoords = spiral.next() - var chunk = world.getChunkAt(nextChunkCoords.first, nextChunkCoords.second) + protected val spiral: Spiral = Spiral(Pair(centerChunk.x, centerChunk.z), Pair(startChunk.x, startChunk.z)) + protected val loadedChunks: HashSet = HashSet() + protected val chunkSkips = plugin.config.getInt("generation.chunks-skips-per-step") + protected val msptThreshold = plugin.config.getLong("generation.mspt-pause-threshold") - for (i in 1 until chunkSkips) { - if (world.isChunkGenerated(chunk.x, chunk.z)) { - nextChunkCoords = spiral.next() // if the chunk is generated skip 10 chunks per step - chunk = world.getChunkAt(nextChunkCoords.first, nextChunkCoords.second) - } else { - break - } - } + abstract override fun run() + abstract fun cancel() - if (!world.isChunkGenerated(chunk.x, chunk.z)) { - chunk.load(true) - loadedChunks.add(chunk) - } - lastChunk = chunk - count = spiral.count // set the count to the more accurate spiral count - } + val nextChunk: Chunk + get() { + val nextChunkCoords = spiral.next() + return world.getChunkAt(nextChunkCoords.first, nextChunkCoords.second) } - } - /** - * Cancels the generation task. - * This unloads all chunks that were generated but not unloaded yet. - */ - fun cancel() { - for (chunk in loadedChunks) { - if (chunk.isLoaded) { - chunk.unload(true) - } - } + protected fun borderReached(): Boolean { + return !world.worldBorder.isInside(lastChunk.getBlock(8, 0, 8).location) || (stopAfter in 1..count) } } \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTaskPaper.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTaskPaper.kt new file mode 100644 index 0000000..4703008 --- /dev/null +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTaskPaper.kt @@ -0,0 +1,97 @@ +package net.trivernis.chunkmaster.lib + +import net.trivernis.chunkmaster.Chunkmaster +import org.bukkit.Chunk +import org.bukkit.World +import java.util.concurrent.CompletableFuture +import io.papermc.lib.PaperLib + +class GenerationTaskPaper( + private val plugin: Chunkmaster, override val world: World, + centerChunk: Chunk, private val startChunk: Chunk, + override val stopAfter: Int = -1 +) : GenerationTask(plugin, centerChunk, startChunk) { + + private val pendingChunks = HashSet>() + + override var count = 0 + private set + override var lastChunk: Chunk = startChunk + private set + override var endReached: Boolean = false + private set + + /** + * Runs the generation task. Every Iteration the next chunk will be generated if + * it hasn't been generated already. + * After 10 chunks have been generated, they will all be unloaded and saved. + */ + override fun run() { + if (plugin.mspt < msptThreshold) { // pause when tps < 2 + if (loadedChunks.size > 10) { + for (chunk in loadedChunks) { + if (chunk.isLoaded) { + chunk.unload(true) + } + } + } else if (pendingChunks.size < 10) { // if more than 10 chunks are pending, wait. + if (borderReached()) { + endReached = true + return + } + + var chunk = nextChunk + for (i in 1 until chunkSkips) { + if (PaperLib.isChunkGenerated(world, chunk.x, chunk.z)) { + chunk = nextChunk + } else { + break + } + } + + if (!PaperLib.isChunkGenerated(world, chunk.x, chunk.z)) { + pendingChunks.add(PaperLib.getChunkAtAsync(world, chunk.x, chunk.z, true)) + } + lastChunk = chunk + count = spiral.count // set the count to the more accurate spiral count + } + } + checkChunksLoaded() + } + + /** + * Cancels the generation task. + * This unloads all chunks that were generated but not unloaded yet. + */ + override fun cancel() { + for (pendingChunk in pendingChunks) { + if (pendingChunk.isDone) { + loadedChunks.add(pendingChunk.get()) + } else { + pendingChunk.cancel(true) + } + } + pendingChunks.clear() + for (chunk in loadedChunks) { + if (chunk.isLoaded) { + chunk.unload(true) + } + } + } + + /** + * Checks if some chunks have been loaded and adds them to the loaded chunk set. + */ + private fun checkChunksLoaded() { + val completedEntrys = HashSet>() + for (pendingChunk in pendingChunks) { + if (pendingChunk.isDone) { + completedEntrys.add(pendingChunk) + loadedChunks.add(pendingChunk.get()) + } else if (pendingChunk.isCompletedExceptionally || pendingChunk.isCancelled) { + completedEntrys.add(pendingChunk) + } + } + pendingChunks.removeAll(completedEntrys) + } +} \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTaskSpigot.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTaskSpigot.kt new file mode 100644 index 0000000..9aa831f --- /dev/null +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTaskSpigot.kt @@ -0,0 +1,74 @@ +package net.trivernis.chunkmaster.lib + +import net.trivernis.chunkmaster.Chunkmaster +import org.bukkit.Chunk +import org.bukkit.World +import org.bukkit.scheduler.BukkitRunnable +import org.bukkit.scheduler.BukkitTask +import java.util.concurrent.CompletableFuture + +class GenerationTaskSpigot( + private val plugin: Chunkmaster, override val world: World, + centerChunk: Chunk, private val startChunk: Chunk, + override val stopAfter: Int = -1 +) : GenerationTask(plugin, centerChunk, startChunk) { + + + override var count = 0 + private set + override var lastChunk: Chunk = startChunk + private set + override var endReached: Boolean = false + private set + + /** + * Runs the generation task. Every Iteration the next chunk will be generated if + * it hasn't been generated already. + * After 10 chunks have been generated, they will all be unloaded and saved. + */ + override fun run() { + if (plugin.mspt < msptThreshold) { // pause when tps < 2 + if (loadedChunks.size > 10) { + for (chunk in loadedChunks) { + if (chunk.isLoaded) { + chunk.unload(true) + } + } + } else { + if (borderReached()) { + endReached = true + return + } + + var chunk = nextChunk + + for (i in 1 until chunkSkips) { + if (world.isChunkGenerated(chunk.x, chunk.z)) { + chunk = nextChunk + } else { + break + } + } + + if (!world.isChunkGenerated(chunk.x, chunk.z)) { + chunk.load(true) + loadedChunks.add(chunk) + } + lastChunk = chunk + count = spiral.count // set the count to the more accurate spiral count + } + } + } + + /** + * Cancels the generation task. + * This unloads all chunks that were generated but not unloaded yet. + */ + override fun cancel() { + for (chunk in loadedChunks) { + if (chunk.isLoaded) { + chunk.unload(true) + } + } + } +} \ No newline at end of file From c49036e35b40fb039ba0ed119ba3aa6cc30dd750 Mon Sep 17 00:00:00 2001 From: Trivernis Date: Tue, 17 Sep 2019 23:57:54 +0200 Subject: [PATCH 04/17] Performance improvements - improved performance on paper servers by using chunk coordinates instead of chunk instances to check if the chunk was generated - moved generation stuff to lib/generation --- .../net/trivernis/chunkmaster/Chunkmaster.kt | 2 +- .../lib/generation/ChunkCoordinates.kt | 4 ++++ .../lib/{ => generation}/GenerationManager.kt | 2 +- .../lib/{ => generation}/GenerationTask.kt | 15 +++++++++++---- .../lib/{ => generation}/GenerationTaskPaper.kt | 13 +++++++++---- .../lib/{ => generation}/GenerationTaskSpigot.kt | 5 +---- .../chunkmaster/lib/{ => generation}/TaskEntry.kt | 2 +- 7 files changed, 28 insertions(+), 15 deletions(-) create mode 100644 src/main/kotlin/net/trivernis/chunkmaster/lib/generation/ChunkCoordinates.kt rename src/main/kotlin/net/trivernis/chunkmaster/lib/{ => generation}/GenerationManager.kt (99%) rename src/main/kotlin/net/trivernis/chunkmaster/lib/{ => generation}/GenerationTask.kt (68%) rename src/main/kotlin/net/trivernis/chunkmaster/lib/{ => generation}/GenerationTaskPaper.kt (89%) rename src/main/kotlin/net/trivernis/chunkmaster/lib/{ => generation}/GenerationTaskSpigot.kt (92%) rename src/main/kotlin/net/trivernis/chunkmaster/lib/{ => generation}/TaskEntry.kt (72%) diff --git a/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt b/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt index ca705db..c26c4e0 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt @@ -2,7 +2,7 @@ package net.trivernis.chunkmaster import io.papermc.lib.PaperLib import net.trivernis.chunkmaster.commands.* -import net.trivernis.chunkmaster.lib.GenerationManager +import net.trivernis.chunkmaster.lib.generation.GenerationManager import net.trivernis.chunkmaster.lib.SqlUpdateManager import org.bukkit.plugin.java.JavaPlugin import org.bukkit.scheduler.BukkitTask diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/ChunkCoordinates.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/ChunkCoordinates.kt new file mode 100644 index 0000000..6c4627f --- /dev/null +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/ChunkCoordinates.kt @@ -0,0 +1,4 @@ +package net.trivernis.chunkmaster.lib.generation + +data class ChunkCoordinates(val x: Int, val z: Int) { +} \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationManager.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationManager.kt similarity index 99% rename from src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationManager.kt rename to src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationManager.kt index 3d0bb3b..a4c615c 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationManager.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationManager.kt @@ -1,4 +1,4 @@ -package net.trivernis.chunkmaster.lib +package net.trivernis.chunkmaster.lib.generation import io.papermc.lib.PaperLib import net.trivernis.chunkmaster.Chunkmaster diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTask.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTask.kt similarity index 68% rename from src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTask.kt rename to src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTask.kt index 230d843..697abd9 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTask.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTask.kt @@ -1,6 +1,7 @@ -package net.trivernis.chunkmaster.lib +package net.trivernis.chunkmaster.lib.generation import net.trivernis.chunkmaster.Chunkmaster +import net.trivernis.chunkmaster.lib.Spiral import org.bukkit.Chunk import org.bukkit.World @@ -15,7 +16,8 @@ abstract class GenerationTask(plugin: Chunkmaster, centerChunk: Chunk, startChun abstract val lastChunk: Chunk abstract val endReached: Boolean - protected val spiral: Spiral = Spiral(Pair(centerChunk.x, centerChunk.z), Pair(startChunk.x, startChunk.z)) + protected val spiral: Spiral = + Spiral(Pair(centerChunk.x, centerChunk.z), Pair(startChunk.x, startChunk.z)) protected val loadedChunks: HashSet = HashSet() protected val chunkSkips = plugin.config.getInt("generation.chunks-skips-per-step") protected val msptThreshold = plugin.config.getLong("generation.mspt-pause-threshold") @@ -23,10 +25,15 @@ abstract class GenerationTask(plugin: Chunkmaster, centerChunk: Chunk, startChun abstract override fun run() abstract fun cancel() - val nextChunk: Chunk + val nextChunkCoordinates: ChunkCoordinates get() { val nextChunkCoords = spiral.next() - return world.getChunkAt(nextChunkCoords.first, nextChunkCoords.second) + return ChunkCoordinates(nextChunkCoords.first, nextChunkCoords.second) + } + val nextChunk: Chunk + get() { + val next = nextChunkCoordinates + return world.getChunkAt(next.x, next.z) } protected fun borderReached(): Boolean { diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTaskPaper.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskPaper.kt similarity index 89% rename from src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTaskPaper.kt rename to src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskPaper.kt index 4703008..67b419c 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTaskPaper.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskPaper.kt @@ -1,4 +1,4 @@ -package net.trivernis.chunkmaster.lib +package net.trivernis.chunkmaster.lib.generation import net.trivernis.chunkmaster.Chunkmaster import org.bukkit.Chunk @@ -17,10 +17,15 @@ class GenerationTaskPaper( override var count = 0 private set override var lastChunk: Chunk = startChunk + get() { + return world.getChunkAt(lastChunkCoords.x, lastChunkCoords.z) + } private set override var endReached: Boolean = false private set + private var lastChunkCoords = ChunkCoordinates(startChunk.x, startChunk.z) + /** * Runs the generation task. Every Iteration the next chunk will be generated if * it hasn't been generated already. @@ -40,10 +45,10 @@ class GenerationTaskPaper( return } - var chunk = nextChunk + var chunk = nextChunkCoordinates for (i in 1 until chunkSkips) { if (PaperLib.isChunkGenerated(world, chunk.x, chunk.z)) { - chunk = nextChunk + chunk = nextChunkCoordinates } else { break } @@ -52,7 +57,7 @@ class GenerationTaskPaper( if (!PaperLib.isChunkGenerated(world, chunk.x, chunk.z)) { pendingChunks.add(PaperLib.getChunkAtAsync(world, chunk.x, chunk.z, true)) } - lastChunk = chunk + lastChunkCoords = chunk count = spiral.count // set the count to the more accurate spiral count } } diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTaskSpigot.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskSpigot.kt similarity index 92% rename from src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTaskSpigot.kt rename to src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskSpigot.kt index 9aa831f..0032a51 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/GenerationTaskSpigot.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskSpigot.kt @@ -1,11 +1,8 @@ -package net.trivernis.chunkmaster.lib +package net.trivernis.chunkmaster.lib.generation import net.trivernis.chunkmaster.Chunkmaster import org.bukkit.Chunk import org.bukkit.World -import org.bukkit.scheduler.BukkitRunnable -import org.bukkit.scheduler.BukkitTask -import java.util.concurrent.CompletableFuture class GenerationTaskSpigot( private val plugin: Chunkmaster, override val world: World, diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/TaskEntry.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/TaskEntry.kt similarity index 72% rename from src/main/kotlin/net/trivernis/chunkmaster/lib/TaskEntry.kt rename to src/main/kotlin/net/trivernis/chunkmaster/lib/generation/TaskEntry.kt index 4307646..f0de0dc 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/TaskEntry.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/TaskEntry.kt @@ -1,4 +1,4 @@ -package net.trivernis.chunkmaster.lib +package net.trivernis.chunkmaster.lib.generation import org.bukkit.scheduler.BukkitTask From 5a5fe74d9cdaece0a6c4c3e1da5e3a284d8d1f9d Mon Sep 17 00:00:00 2001 From: Trivernis Date: Wed, 18 Sep 2019 10:47:56 +0200 Subject: [PATCH 05/17] Performance and stability improvements - improved performance of paper generation task - improved stability of spigot generation task - Updated Readme - added configuration parameters for max pending chunks and max loaded chunks --- README.md | 21 +++++++++++++++++- .../net/trivernis/chunkmaster/Chunkmaster.kt | 4 +++- .../lib/generation/ChunkCoordinates.kt | 8 ++++++- .../lib/generation/GenerationTask.kt | 13 +++++++++-- .../lib/generation/GenerationTaskPaper.kt | 14 +++++------- .../lib/generation/GenerationTaskSpigot.kt | 22 ++++++------------- 6 files changed, 53 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 9f59125..a85f519 100644 --- a/README.md +++ b/README.md @@ -22,11 +22,24 @@ All features can be accessed with the command `/chunkmaster` or the aliases `/ch ```yaml generation: + # The maximum amount of chunks that are loaded before unloading and saving them. + # Higher values mean higher generation speed but greater memory usage. + # The value should be a positive integer. + max-loaded-chunks: 10 + + # Paper Only + # The maximum amount of requested chunks with the asynchronous paper chunk + # loading method. Higher values mean faster generation but more memory usage + # (and probably bigger performance impact). + # The value should be a positive integer. + max-pending-chunks: 10 + # The period (in ticks) in which a generation step is run. # Higher values mean less performance impact but slower generation. # The value should be a positive integer. period: 2 + # Paper Only # The number of already generated chunks that will be skipped for each step. # Notice that these still have a performance impact because the server needs to check # if the chunk is generated. @@ -47,4 +60,10 @@ generation: # process is minimal. # The value should be a boolean pause-on-join: true -``` \ No newline at end of file +``` + +## Spigot and Paper + +The plugin works on spigot and paper servers but is significantly faster on paper servers +(because it profits from asynchronous chunk loading an the better implementation of the +isChunkGenerated method). \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt b/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt index c26c4e0..117bb10 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt @@ -56,9 +56,11 @@ class Chunkmaster: JavaPlugin() { private fun configure() { dataFolder.mkdir() config.addDefault("generation.period", 2L) - config.addDefault("generation.chunks-skips-per-step", 4) + config.addDefault("generation.chunks-skips-per-step", 10) config.addDefault("generation.mspt-pause-threshold", 500L) config.addDefault("generation.pause-on-join", true) + config.addDefault("generation.max-pending-chunks", 10) + config.addDefault("generation.max-loaded-chunks", 10) config.options().copyDefaults(true) saveConfig() } diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/ChunkCoordinates.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/ChunkCoordinates.kt index 6c4627f..e9a7fc4 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/ChunkCoordinates.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/ChunkCoordinates.kt @@ -1,4 +1,10 @@ package net.trivernis.chunkmaster.lib.generation -data class ChunkCoordinates(val x: Int, val z: Int) { +import org.bukkit.Location +import org.bukkit.World + +class ChunkCoordinates(val x: Int, val z: Int) { + fun getCenterLocation(world: World): Location { + return Location(world, ((x*16) + 8).toDouble(), 1.0, ((x*16) + 8).toDouble()) + } } \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTask.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTask.kt index 697abd9..e8c1233 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTask.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTask.kt @@ -13,14 +13,15 @@ abstract class GenerationTask(plugin: Chunkmaster, centerChunk: Chunk, startChun abstract val stopAfter: Int abstract val world: World abstract val count: Int - abstract val lastChunk: Chunk abstract val endReached: Boolean protected val spiral: Spiral = Spiral(Pair(centerChunk.x, centerChunk.z), Pair(startChunk.x, startChunk.z)) protected val loadedChunks: HashSet = HashSet() + protected var lastChunkCoords = ChunkCoordinates(startChunk.x, startChunk.z) protected val chunkSkips = plugin.config.getInt("generation.chunks-skips-per-step") protected val msptThreshold = plugin.config.getLong("generation.mspt-pause-threshold") + protected val maxLoadedChunks = plugin.config.getInt("generation.max-loaded-chunks") abstract override fun run() abstract fun cancel() @@ -30,13 +31,21 @@ abstract class GenerationTask(plugin: Chunkmaster, centerChunk: Chunk, startChun val nextChunkCoords = spiral.next() return ChunkCoordinates(nextChunkCoords.first, nextChunkCoords.second) } + var lastChunk: Chunk = startChunk + get() { + return world.getChunkAt(lastChunkCoords.x, lastChunkCoords.z) + } + private set val nextChunk: Chunk get() { val next = nextChunkCoordinates return world.getChunkAt(next.x, next.z) } + /** + * Checks if the World border or the maximum chunk setting for the task is reached. + */ protected fun borderReached(): Boolean { - return !world.worldBorder.isInside(lastChunk.getBlock(8, 0, 8).location) || (stopAfter in 1..count) + return !world.worldBorder.isInside(lastChunkCoords.getCenterLocation(world)) || (stopAfter in 1..count) } } \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskPaper.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskPaper.kt index 67b419c..756d085 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskPaper.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskPaper.kt @@ -12,20 +12,15 @@ class GenerationTaskPaper( override val stopAfter: Int = -1 ) : GenerationTask(plugin, centerChunk, startChunk) { + private val maxPendingChunks = plugin.config.getInt("generation.max-pending-chunks") + private val pendingChunks = HashSet>() override var count = 0 private set - override var lastChunk: Chunk = startChunk - get() { - return world.getChunkAt(lastChunkCoords.x, lastChunkCoords.z) - } - private set override var endReached: Boolean = false private set - private var lastChunkCoords = ChunkCoordinates(startChunk.x, startChunk.z) - /** * Runs the generation task. Every Iteration the next chunk will be generated if * it hasn't been generated already. @@ -33,13 +28,14 @@ class GenerationTaskPaper( */ override fun run() { if (plugin.mspt < msptThreshold) { // pause when tps < 2 - if (loadedChunks.size > 10) { + if (loadedChunks.size > maxLoadedChunks) { for (chunk in loadedChunks) { if (chunk.isLoaded) { chunk.unload(true) } } - } else if (pendingChunks.size < 10) { // if more than 10 chunks are pending, wait. + loadedChunks.clear() + } else if (pendingChunks.size < maxPendingChunks) { // if more than 10 chunks are pending, wait. if (borderReached()) { endReached = true return diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskSpigot.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskSpigot.kt index 0032a51..f54f666 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskSpigot.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskSpigot.kt @@ -13,8 +13,6 @@ class GenerationTaskSpigot( override var count = 0 private set - override var lastChunk: Chunk = startChunk - private set override var endReached: Boolean = false private set @@ -25,33 +23,27 @@ class GenerationTaskSpigot( */ override fun run() { if (plugin.mspt < msptThreshold) { // pause when tps < 2 - if (loadedChunks.size > 10) { + if (loadedChunks.size > maxLoadedChunks) { for (chunk in loadedChunks) { if (chunk.isLoaded) { chunk.unload(true) } } + loadedChunks.clear() } else { if (borderReached()) { endReached = true return } - var chunk = nextChunk - - for (i in 1 until chunkSkips) { - if (world.isChunkGenerated(chunk.x, chunk.z)) { - chunk = nextChunk - } else { - break - } - } + val chunk = nextChunkCoordinates if (!world.isChunkGenerated(chunk.x, chunk.z)) { - chunk.load(true) - loadedChunks.add(chunk) + val chunkInstance = world.getChunkAt(chunk.x, chunk.z) + chunkInstance.load(true) + loadedChunks.add(chunkInstance) } - lastChunk = chunk + lastChunkCoords = chunk count = spiral.count // set the count to the more accurate spiral count } } From 638ae07fe53b62b974b3ae37f240db8c77b67b37 Mon Sep 17 00:00:00 2001 From: Trivernis Date: Wed, 18 Sep 2019 10:51:48 +0200 Subject: [PATCH 06/17] Code cleanup, Version correction - changed version from 0.10-beta-SNAPSHOT to 0.10-beta --- .../net/trivernis/chunkmaster/ChunkmasterEvents.kt | 11 +++++++---- .../net/trivernis/chunkmaster/lib/SqlUpdateManager.kt | 2 +- .../trivernis/chunkmaster/lib/generation/TaskEntry.kt | 3 +-- src/main/resources/plugin.yml | 2 +- 4 files changed, 10 insertions(+), 8 deletions(-) diff --git a/src/main/kotlin/net/trivernis/chunkmaster/ChunkmasterEvents.kt b/src/main/kotlin/net/trivernis/chunkmaster/ChunkmasterEvents.kt index 9cae7f2..b93c651 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/ChunkmasterEvents.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/ChunkmasterEvents.kt @@ -6,17 +6,19 @@ import org.bukkit.event.Listener import org.bukkit.event.player.PlayerJoinEvent import org.bukkit.event.player.PlayerQuitEvent -class ChunkmasterEvents(private val chunkmaster: Chunkmaster, private val server: Server): Listener { +class ChunkmasterEvents(private val chunkmaster: Chunkmaster, private val server: Server) : Listener { private val pauseOnJoin = chunkmaster.config.getBoolean("generation.pause-on-join") /** * Autostart generation tasks */ - @EventHandler fun onPlayerQuit(event: PlayerQuitEvent) { + @EventHandler + fun onPlayerQuit(event: PlayerQuitEvent) { if (pauseOnJoin) { if (server.onlinePlayers.size == 1 && server.onlinePlayers.contains(event.player) || - server.onlinePlayers.isEmpty()) { + server.onlinePlayers.isEmpty() + ) { if (!chunkmaster.generationManager.paused) { chunkmaster.generationManager.startAll() chunkmaster.logger.info("Server is empty. Starting chunk generation tasks.") @@ -28,7 +30,8 @@ class ChunkmasterEvents(private val chunkmaster: Chunkmaster, private val server /** * Autostop generation tasks */ - @EventHandler fun onPlayerJoin(event: PlayerJoinEvent) { + @EventHandler + fun onPlayerJoin(event: PlayerJoinEvent) { if (pauseOnJoin) { if (server.onlinePlayers.size == 1 || server.onlinePlayers.isEmpty()) { chunkmaster.generationManager.stopAll() diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/SqlUpdateManager.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/SqlUpdateManager.kt index 5c4fdf2..5da91d6 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/SqlUpdateManager.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/SqlUpdateManager.kt @@ -62,7 +62,7 @@ class SqlUpdateManager(private val connnection: Connection, private val chunkmas stmt.execute() stmt.close() } catch (err: Exception) { - chunkmaster.logger.severe("Error creating table $table."); + chunkmaster.logger.severe("Error creating table $table.") } } for (table in needUpdate) { diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/TaskEntry.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/TaskEntry.kt index f0de0dc..552461b 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/TaskEntry.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/TaskEntry.kt @@ -2,5 +2,4 @@ package net.trivernis.chunkmaster.lib.generation import org.bukkit.scheduler.BukkitTask -data class TaskEntry(val id: Int, val task: BukkitTask, val generationTask: GenerationTask) { -} \ No newline at end of file +data class TaskEntry(val id: Int, val task: BukkitTask, val generationTask: GenerationTask) \ No newline at end of file diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml index 8708e9f..096b64a 100644 --- a/src/main/resources/plugin.yml +++ b/src/main/resources/plugin.yml @@ -1,6 +1,6 @@ main: net.trivernis.chunkmaster.Chunkmaster name: Chunkmaster -version: '0.10-beta-SNAPSHOT' +version: '0.10-beta' description: Chunk commands plugin. author: Trivernis website: trivernis.net From 132294d683f542041923342f22e2c0a812a214cc Mon Sep 17 00:00:00 2001 From: Trivernis Date: Wed, 18 Sep 2019 15:20:08 +0200 Subject: [PATCH 07/17] TabComplete for all subcommands - added tab complete to all subcommands - added list of paused task when no task is running - added possibility to remove paused tasks --- .../chunkmaster/ChunkmasterEvents.kt | 17 +++++-- .../chunkmaster/commands/CmdCancel.kt | 22 +++++++++ .../chunkmaster/commands/CmdGenerate.kt | 20 ++++++++ .../trivernis/chunkmaster/commands/CmdList.kt | 46 +++++++++++++++++-- .../chunkmaster/commands/CmdPause.kt | 10 ++++ .../chunkmaster/commands/CmdResume.kt | 10 ++++ .../commands/CommandChunkmaster.kt | 11 ++++- .../trivernis/chunkmaster/lib/Subcommand.kt | 2 + .../lib/generation/GenerationManager.kt | 36 +++++++++++---- .../lib/generation/GenerationTaskPaper.kt | 3 ++ .../lib/generation/PausedTaskEntry.kt | 10 ++++ .../lib/generation/RunningTaskEntry.kt | 14 ++++++ .../chunkmaster/lib/generation/TaskEntry.kt | 10 +++- 13 files changed, 189 insertions(+), 22 deletions(-) create mode 100644 src/main/kotlin/net/trivernis/chunkmaster/lib/generation/PausedTaskEntry.kt create mode 100644 src/main/kotlin/net/trivernis/chunkmaster/lib/generation/RunningTaskEntry.kt diff --git a/src/main/kotlin/net/trivernis/chunkmaster/ChunkmasterEvents.kt b/src/main/kotlin/net/trivernis/chunkmaster/ChunkmasterEvents.kt index b93c651..60328f5 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/ChunkmasterEvents.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/ChunkmasterEvents.kt @@ -9,6 +9,7 @@ import org.bukkit.event.player.PlayerQuitEvent class ChunkmasterEvents(private val chunkmaster: Chunkmaster, private val server: Server) : Listener { private val pauseOnJoin = chunkmaster.config.getBoolean("generation.pause-on-join") + private var playerPaused = false /** * Autostart generation tasks @@ -19,9 +20,14 @@ class ChunkmasterEvents(private val chunkmaster: Chunkmaster, private val server if (server.onlinePlayers.size == 1 && server.onlinePlayers.contains(event.player) || server.onlinePlayers.isEmpty() ) { - if (!chunkmaster.generationManager.paused) { - chunkmaster.generationManager.startAll() - chunkmaster.logger.info("Server is empty. Starting chunk generation tasks.") + if (!playerPaused) { + chunkmaster.generationManager.resumeAll() + chunkmaster.logger.info("Server is empty. Resuming chunk generation tasks.") + } else if (chunkmaster.generationManager.paused){ + chunkmaster.logger.info("Generation was manually paused. Not resuming automatically.") + playerPaused = chunkmaster.generationManager.paused + } else { + chunkmaster.logger.info("Generation tasks are already running.") } } } @@ -34,8 +40,9 @@ class ChunkmasterEvents(private val chunkmaster: Chunkmaster, private val server fun onPlayerJoin(event: PlayerJoinEvent) { if (pauseOnJoin) { if (server.onlinePlayers.size == 1 || server.onlinePlayers.isEmpty()) { - chunkmaster.generationManager.stopAll() - chunkmaster.logger.info("Stopping generation tasks because of player join.") + playerPaused = chunkmaster.generationManager.paused + chunkmaster.generationManager.pauseAll() + chunkmaster.logger.info("Pausing generation tasks because of player join.") } } } diff --git a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdCancel.kt b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdCancel.kt index 80daf60..f0e16b0 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdCancel.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdCancel.kt @@ -4,11 +4,33 @@ import net.md_5.bungee.api.ChatColor import net.md_5.bungee.api.chat.ComponentBuilder import net.trivernis.chunkmaster.Chunkmaster import net.trivernis.chunkmaster.lib.Subcommand +import net.trivernis.chunkmaster.lib.generation.TaskEntry +import org.bukkit.command.Command import org.bukkit.command.CommandSender class CmdCancel(private val chunkmaster: Chunkmaster): Subcommand { override val name = "cancel" + /** + * TabComplete for subcommand cancel. + */ + override fun onTabComplete( + sender: CommandSender, + command: Command, + alias: String, + args: List + ): MutableList { + val genManager = chunkmaster.generationManager + val allTasks = HashSet() + allTasks.addAll(genManager.pausedTasks) + allTasks.addAll(genManager.tasks) + return allTasks.filter {it.id.toString().indexOf(args[0]) == 0} + .map { it.id.toString() }.toMutableList() + } + + /** + * Cancels the generation task if it exists. + */ override fun execute(sender: CommandSender, args: List): Boolean { return if (args.isNotEmpty() && args[0].toIntOrNull() != null) { if (chunkmaster.generationManager.removeTask(args[0].toInt())) { diff --git a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdGenerate.kt b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdGenerate.kt index 4ef2a15..8a7f588 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdGenerate.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdGenerate.kt @@ -4,12 +4,32 @@ import net.md_5.bungee.api.ChatColor import net.md_5.bungee.api.chat.ComponentBuilder import net.trivernis.chunkmaster.Chunkmaster import net.trivernis.chunkmaster.lib.Subcommand +import org.bukkit.command.Command import org.bukkit.command.CommandSender import org.bukkit.entity.Player class CmdGenerate(private val chunkmaster: Chunkmaster): Subcommand { override val name = "generate" + /** + * TabComplete for generate command. + */ + override fun onTabComplete( + sender: CommandSender, + command: Command, + alias: String, + args: List + ): MutableList { + if (args.size == 1) { + return sender.server.worlds.filter { it.name.indexOf(args[0]) == 0 } + .map {it.name}.toMutableList() + } + return emptyList().toMutableList() + } + + /** + * Creates a new generation task for the world and chunk count. + */ override fun execute(sender: CommandSender, args: List): Boolean { var worldName = "" var stopAfter = -1 diff --git a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdList.kt b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdList.kt index 3e5cca8..00703b7 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdList.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdList.kt @@ -4,21 +4,57 @@ import net.md_5.bungee.api.ChatColor import net.md_5.bungee.api.chat.ComponentBuilder import net.trivernis.chunkmaster.Chunkmaster import net.trivernis.chunkmaster.lib.Subcommand +import org.bukkit.command.Command import org.bukkit.command.CommandSender class CmdList(private val chunkmaster: Chunkmaster): Subcommand { override val name = "list" + override fun onTabComplete( + sender: CommandSender, + command: Command, + alias: String, + args: List + ): MutableList { + return emptyList().toMutableList() + } + + /** + * Lists all running or paused generation tasks. + */ override fun execute(sender: CommandSender, args: List): Boolean { val runningTasks = chunkmaster.generationManager.tasks - if (runningTasks.isEmpty()) { - sender.spigot().sendMessage(*ComponentBuilder("There are no running generation tasks.") + val pausedTasks = chunkmaster.generationManager.pausedTasks + + if (runningTasks.isEmpty() && pausedTasks.isEmpty()) { + sender.spigot().sendMessage(*ComponentBuilder("There are no generation tasks.") .color(ChatColor.BLUE).create()) + } else if (runningTasks.isEmpty()) { + val response = ComponentBuilder("Currently paused generation tasks:").color(ChatColor.WHITE).bold(true) + for (taskEntry in pausedTasks) { + val genTask = taskEntry.generationTask + response.append("\n - ").color(ChatColor.WHITE).bold(false) + response.append("#${taskEntry.id}").color(ChatColor.BLUE).append(" - ").color(ChatColor.WHITE) + response.append(genTask.world.name).color(ChatColor.GREEN).append(" - Progress: ").color(ChatColor.WHITE) + response.append("${genTask.count} chunks").color(ChatColor.BLUE) + + if (genTask.stopAfter > 0) { + response.append(" (${(genTask.count.toDouble()/genTask.stopAfter.toDouble())*100}%).") + } + } + sender.spigot().sendMessage(*response.create()) } else { - val response = ComponentBuilder("Currently running generation tasks:").color(ChatColor.WHITE) + val response = ComponentBuilder("Currently running generation tasks:").color(ChatColor.WHITE).bold(true) for (task in runningTasks) { - response.append("\n - #${task.id}: ${task.generationTask.world.name}, Progress ${task.generationTask.count}") - .color(ChatColor.BLUE) + val genTask = task.generationTask + response.append("\n - ").color(ChatColor.WHITE).bold(false) + .append("#${task.id}").color(ChatColor.BLUE).append(" - ").color(ChatColor.WHITE) + .append(genTask.world.name).color(ChatColor.GREEN).append(" - Progress: ").color(ChatColor.WHITE) + .append("${genTask.count} chunks").color(ChatColor.BLUE) + + if (genTask.stopAfter > 0) { + response.append(" (${(genTask.count.toDouble()/genTask.stopAfter.toDouble())*100}%).") + } } sender.spigot().sendMessage(*response.create()) } diff --git a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdPause.kt b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdPause.kt index b125f68..20c8fb8 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdPause.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdPause.kt @@ -4,11 +4,21 @@ import net.md_5.bungee.api.ChatColor import net.md_5.bungee.api.chat.ComponentBuilder import net.trivernis.chunkmaster.Chunkmaster import net.trivernis.chunkmaster.lib.Subcommand +import org.bukkit.command.Command import org.bukkit.command.CommandSender class CmdPause(private val chunkmaster: Chunkmaster) : Subcommand { override val name: String = "pause" + override fun onTabComplete( + sender: CommandSender, + command: Command, + alias: String, + args: List + ): MutableList { + return emptyList().toMutableList() + } + override fun execute(sender: CommandSender, args: List): Boolean { return if (!chunkmaster.generationManager.paused) { chunkmaster.generationManager.pauseAll() diff --git a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdResume.kt b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdResume.kt index 72b3068..df05ea6 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdResume.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdResume.kt @@ -4,11 +4,21 @@ import net.md_5.bungee.api.ChatColor import net.md_5.bungee.api.chat.ComponentBuilder import net.trivernis.chunkmaster.Chunkmaster import net.trivernis.chunkmaster.lib.Subcommand +import org.bukkit.command.Command import org.bukkit.command.CommandSender class CmdResume(private val chunkmaster: Chunkmaster): Subcommand { override val name = "resume" + override fun onTabComplete( + sender: CommandSender, + command: Command, + alias: String, + args: List + ): MutableList { + return emptyList().toMutableList() + } + override fun execute(sender: CommandSender, args: List): Boolean { return if (chunkmaster.generationManager.paused) { chunkmaster.generationManager.resumeAll() diff --git a/src/main/kotlin/net/trivernis/chunkmaster/commands/CommandChunkmaster.kt b/src/main/kotlin/net/trivernis/chunkmaster/commands/CommandChunkmaster.kt index c59f0ac..ef313a8 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/commands/CommandChunkmaster.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/commands/CommandChunkmaster.kt @@ -23,7 +23,16 @@ class CommandChunkmaster(private val chunkmaster: Chunkmaster, private val serve */ override fun onTabComplete(sender: CommandSender, command: Command, alias: String, args: Array): MutableList { - return commands.keys.filter { it.indexOf(args[0]) == 0 }.toMutableList() + if (args.size == 1) { + return commands.keys.filter { it.indexOf(args[0]) == 0 }.toMutableList() + } else if (args.isNotEmpty()){ + + if (commands.containsKey(args[0])) { + val commandEntry = commands[args[0]] + return commandEntry!!.onTabComplete(sender, command, alias, args.slice(1 until args.size)) + } + } + return emptyList().toMutableList() } /** diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/Subcommand.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/Subcommand.kt index 65cb06f..7341e30 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/Subcommand.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/Subcommand.kt @@ -1,8 +1,10 @@ package net.trivernis.chunkmaster.lib +import org.bukkit.command.Command import org.bukkit.command.CommandSender interface Subcommand { val name: String fun execute(sender: CommandSender, args: List): Boolean + fun onTabComplete(sender: CommandSender, command: Command, alias: String, args: List): MutableList } \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationManager.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationManager.kt index a4c615c..d225022 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationManager.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationManager.kt @@ -10,7 +10,8 @@ import java.lang.NullPointerException class GenerationManager(private val chunkmaster: Chunkmaster, private val server: Server) { - val tasks: HashSet = HashSet() + val tasks: HashSet = HashSet() + val pausedTasks: HashSet = HashSet() var paused = false private set @@ -47,7 +48,9 @@ class GenerationManager(private val chunkmaster: Chunkmaster, private val server if (!paused) { val task = server.scheduler.runTaskTimer(chunkmaster, generationTask, 10, chunkmaster.config.getLong("generation.period")) - tasks.add(TaskEntry(id, task, generationTask)) + tasks.add(RunningTaskEntry(id, task, generationTask)) + } else { + pausedTasks.add(PausedTaskEntry(id, generationTask)) } return id @@ -62,7 +65,7 @@ class GenerationManager(private val chunkmaster: Chunkmaster, private val server val generationTask = createGenerationTask(world, center, last, stopAfter) val task = server.scheduler.runTaskTimer(chunkmaster, generationTask, 10, chunkmaster.config.getLong("generation.period")) - tasks.add(TaskEntry(id, task, generationTask)) + tasks.add(RunningTaskEntry(id, task, generationTask)) } } @@ -70,18 +73,26 @@ class GenerationManager(private val chunkmaster: Chunkmaster, private val server * Stops a running generation task. */ fun removeTask(id: Int): Boolean { - val taskEntry = this.tasks.find {it.id == id} + val taskEntry: TaskEntry? = if (this.paused) { + this.pausedTasks.find {it.id == id} + } else { + this.tasks.find {it.id == id} + } if (taskEntry != null) { - taskEntry.generationTask.cancel() - taskEntry.task.cancel() + taskEntry.cancel() val deleteTask = chunkmaster.sqliteConnection.prepareStatement(""" DELETE FROM generation_tasks WHERE id = ?; """.trimIndent()) deleteTask.setInt(1, taskEntry.id) deleteTask.execute() deleteTask.close() - if (taskEntry.task.isCancelled) { - tasks.remove(taskEntry) + + if (taskEntry is RunningTaskEntry) { + if (taskEntry.task.isCancelled) { + tasks.remove(taskEntry) + } + } else if (taskEntry is PausedTaskEntry) { + pausedTasks.remove(taskEntry) } return true } @@ -109,7 +120,7 @@ class GenerationManager(private val chunkmaster: Chunkmaster, private val server */ fun stopAll() { saveProgress() - val removalSet = HashSet() + val removalSet = HashSet() for (task in tasks) { task.generationTask.cancel() task.task.cancel() @@ -154,6 +165,9 @@ class GenerationManager(private val chunkmaster: Chunkmaster, private val server */ fun pauseAll() { paused = true + for (task in tasks) { + pausedTasks.add(PausedTaskEntry(task.id, task.generationTask)) + } stopAll() } @@ -162,6 +176,7 @@ class GenerationManager(private val chunkmaster: Chunkmaster, private val server */ fun resumeAll() { paused = false + pausedTasks.clear() startAll() } @@ -174,7 +189,8 @@ class GenerationManager(private val chunkmaster: Chunkmaster, private val server val genTask = task.generationTask server.consoleSender.sendMessage("""Task #${task.id} running for "${genTask.world.name}". |Progress ${task.generationTask.count} chunks - |${if (task.generationTask.stopAfter > 0)"(${(task.generationTask.count.toDouble()/task.generationTask.stopAfter.toDouble())*100}%)" else ""}. + |${if (task.generationTask.stopAfter > 0)"(${(task.generationTask.count.toDouble()/ + task.generationTask.stopAfter.toDouble())*100}%)" else ""}. |Last Chunk: ${genTask.lastChunk.x}, ${genTask.lastChunk.z}""".trimMargin("|").replace('\n', ' ')) val updateStatement = chunkmaster.sqliteConnection.prepareStatement(""" UPDATE generation_tasks SET last_x = ?, last_z = ? diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskPaper.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskPaper.kt index 756d085..3b30d98 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskPaper.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskPaper.kt @@ -73,6 +73,9 @@ class GenerationTaskPaper( } } pendingChunks.clear() + if (loadedChunks.isNotEmpty()) { + lastChunkCoords = ChunkCoordinates(loadedChunks.last().x, loadedChunks.last().z) + } for (chunk in loadedChunks) { if (chunk.isLoaded) { chunk.unload(true) diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/PausedTaskEntry.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/PausedTaskEntry.kt new file mode 100644 index 0000000..90b7736 --- /dev/null +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/PausedTaskEntry.kt @@ -0,0 +1,10 @@ +package net.trivernis.chunkmaster.lib.generation + +class PausedTaskEntry( + override val id: Int, + override val generationTask: GenerationTask +) : TaskEntry { + override fun cancel() { + generationTask.cancel() + } +} \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/RunningTaskEntry.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/RunningTaskEntry.kt new file mode 100644 index 0000000..a53d89a --- /dev/null +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/RunningTaskEntry.kt @@ -0,0 +1,14 @@ +package net.trivernis.chunkmaster.lib.generation + +import org.bukkit.scheduler.BukkitTask + +class RunningTaskEntry( + override val id: Int, + val task: BukkitTask, + override val generationTask: GenerationTask +) : TaskEntry { + override fun cancel() { + task.cancel() + generationTask.cancel() + } +} \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/TaskEntry.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/TaskEntry.kt index 552461b..cf6b135 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/TaskEntry.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/TaskEntry.kt @@ -2,4 +2,12 @@ package net.trivernis.chunkmaster.lib.generation import org.bukkit.scheduler.BukkitTask -data class TaskEntry(val id: Int, val task: BukkitTask, val generationTask: GenerationTask) \ No newline at end of file +/** + * Generic task entry + */ +interface TaskEntry { + val id: Int + val generationTask: GenerationTask + + fun cancel() +} \ No newline at end of file From 5d0f1584276bde975ebc6178dfbdc313fb268982 Mon Sep 17 00:00:00 2001 From: Trivernis Date: Wed, 18 Sep 2019 16:17:05 +0200 Subject: [PATCH 08/17] Changes to task cancelation and fix - fixed generate command error on multiple tasks for one world - changed check of task completion from polling to interrupt (via callback function) --- .../chunkmaster/commands/CmdCancel.kt | 4 +- .../chunkmaster/commands/CmdGenerate.kt | 8 +- .../lib/generation/GenerationManager.kt | 76 +++++++++++-------- .../lib/generation/GenerationTask.kt | 10 +++ .../lib/generation/GenerationTaskPaper.kt | 1 + .../lib/generation/GenerationTaskSpigot.kt | 1 + 6 files changed, 65 insertions(+), 35 deletions(-) diff --git a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdCancel.kt b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdCancel.kt index f0e16b0..052ee60 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdCancel.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdCancel.kt @@ -21,9 +21,7 @@ class CmdCancel(private val chunkmaster: Chunkmaster): Subcommand { args: List ): MutableList { val genManager = chunkmaster.generationManager - val allTasks = HashSet() - allTasks.addAll(genManager.pausedTasks) - allTasks.addAll(genManager.tasks) + val allTasks = genManager.allTasks return allTasks.filter {it.id.toString().indexOf(args[0]) == 0} .map { it.id.toString() }.toMutableList() } diff --git a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdGenerate.kt b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdGenerate.kt index 8a7f588..b9a5431 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdGenerate.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdGenerate.kt @@ -59,17 +59,21 @@ class CmdGenerate(private val chunkmaster: Chunkmaster): Subcommand { } } val world = chunkmaster.server.getWorld(worldName) - return if (world != null) { + val allTasks = chunkmaster.generationManager.allTasks + return if (world != null && (allTasks.find { it.generationTask.world == world }) == null) { chunkmaster.generationManager.addTask(world, stopAfter) sender.spigot().sendMessage(*ComponentBuilder("Generation task for world ").color(ChatColor.BLUE) .append(worldName).color(ChatColor.GREEN).append(" until ").color(ChatColor.BLUE) .append(if (stopAfter > 0) "$stopAfter chunks" else "WorldBorder").color(ChatColor.GREEN) .append(" successfully created").color(ChatColor.BLUE).create()) true - } else { + } else if (world == null){ sender.spigot().sendMessage(*ComponentBuilder("World ").color(ChatColor.RED) .append(worldName).color(ChatColor.GREEN).append(" not found!").color(ChatColor.RED).create()) false + } else { + sender.spigot().sendMessage(*ComponentBuilder("Task already exists!").color(ChatColor.RED).create()) + return false } } } \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationManager.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationManager.kt index d225022..a7d01d4 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationManager.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationManager.kt @@ -12,6 +12,13 @@ class GenerationManager(private val chunkmaster: Chunkmaster, private val server val tasks: HashSet = HashSet() val pausedTasks: HashSet = HashSet() + val allTasks: HashSet + get() { + val all = HashSet() + all.addAll(pausedTasks) + all.addAll(tasks) + return all + } var paused = false private set @@ -19,41 +26,51 @@ class GenerationManager(private val chunkmaster: Chunkmaster, private val server * Adds a generation task */ fun addTask(world: World, stopAfter: Int = -1): Int { - val centerChunk = world.getChunkAt(world.spawnLocation) - val generationTask = createGenerationTask(world, centerChunk, centerChunk, stopAfter) + val foundTask = allTasks.find { it.generationTask.world == world } + if (foundTask == null) { + val centerChunk = world.getChunkAt(world.spawnLocation) + val generationTask = createGenerationTask(world, centerChunk, centerChunk, stopAfter) - val insertStatement = chunkmaster.sqliteConnection.prepareStatement(""" + val insertStatement = chunkmaster.sqliteConnection.prepareStatement(""" INSERT INTO generation_tasks (center_x, center_z, last_x, last_z, world, stop_after) values (?, ?, ?, ?, ?, ?) """) - insertStatement.setInt(1, centerChunk.x) - insertStatement.setInt(2, centerChunk.z) - insertStatement.setInt(3, centerChunk.x) - insertStatement.setInt(4, centerChunk.z) - insertStatement.setString(5, world.name) - insertStatement.setInt(6, stopAfter) - insertStatement.execute() - - val getIdStatement = chunkmaster.sqliteConnection.prepareStatement(""" + insertStatement.setInt(1, centerChunk.x) + insertStatement.setInt(2, centerChunk.z) + insertStatement.setInt(3, centerChunk.x) + insertStatement.setInt(4, centerChunk.z) + insertStatement.setString(5, world.name) + insertStatement.setInt(6, stopAfter) + insertStatement.execute() + + val getIdStatement = chunkmaster.sqliteConnection.prepareStatement(""" SELECT id FROM generation_tasks ORDER BY id DESC LIMIT 1 """.trimIndent()) - getIdStatement.execute() - val result = getIdStatement.resultSet - result.next() - val id: Int = result.getInt("id") + getIdStatement.execute() + val result = getIdStatement.resultSet + result.next() + val id: Int = result.getInt("id") - insertStatement.close() - getIdStatement.close() + insertStatement.close() + getIdStatement.close() - if (!paused) { - val task = server.scheduler.runTaskTimer(chunkmaster, generationTask, 10, - chunkmaster.config.getLong("generation.period")) - tasks.add(RunningTaskEntry(id, task, generationTask)) + generationTask.onEndReached { + server.consoleSender.sendMessage("Task #${id} finished after ${generationTask.count} chunks.") + removeTask(id) + } + + if (!paused) { + val task = server.scheduler.runTaskTimer(chunkmaster, generationTask, 10, + chunkmaster.config.getLong("generation.period")) + tasks.add(RunningTaskEntry(id, task, generationTask)) + } else { + pausedTasks.add(PausedTaskEntry(id, generationTask)) + } + + return id } else { - pausedTasks.add(PausedTaskEntry(id, generationTask)) + return foundTask.id } - - return id } /** @@ -66,6 +83,10 @@ class GenerationManager(private val chunkmaster: Chunkmaster, private val server val task = server.scheduler.runTaskTimer(chunkmaster, generationTask, 10, chunkmaster.config.getLong("generation.period")) tasks.add(RunningTaskEntry(id, task, generationTask)) + generationTask.onEndReached { + server.consoleSender.sendMessage("Task #${id} finished after ${generationTask.count} chunks.") + removeTask(id) + } } } @@ -201,11 +222,6 @@ class GenerationManager(private val chunkmaster: Chunkmaster, private val server updateStatement.setInt(3, task.id) updateStatement.execute() updateStatement.close() - - if (genTask.endReached) { // remove the task if it is finished after the progress has been saved - server.consoleSender.sendMessage("Task #${task.id} finished after ${genTask.count} chunks.") - removeTask(task.id) - } } catch (error: Exception) { server.consoleSender.sendMessage("Exception when saving task progress ${error.message}") } diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTask.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTask.kt index e8c1233..91f8575 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTask.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTask.kt @@ -23,6 +23,9 @@ abstract class GenerationTask(plugin: Chunkmaster, centerChunk: Chunk, startChun protected val msptThreshold = plugin.config.getLong("generation.mspt-pause-threshold") protected val maxLoadedChunks = plugin.config.getInt("generation.max-loaded-chunks") + protected var endReachedCallback: (() -> Unit)? = null + private set + abstract override fun run() abstract fun cancel() @@ -48,4 +51,11 @@ abstract class GenerationTask(plugin: Chunkmaster, centerChunk: Chunk, startChun protected fun borderReached(): Boolean { return !world.worldBorder.isInside(lastChunkCoords.getCenterLocation(world)) || (stopAfter in 1..count) } + + /** + * Registers end reached callback + */ + fun onEndReached(cb: () -> Unit) { + endReachedCallback = cb + } } \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskPaper.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskPaper.kt index 3b30d98..2a49321 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskPaper.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskPaper.kt @@ -38,6 +38,7 @@ class GenerationTaskPaper( } else if (pendingChunks.size < maxPendingChunks) { // if more than 10 chunks are pending, wait. if (borderReached()) { endReached = true + endReachedCallback?.invoke() return } diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskSpigot.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskSpigot.kt index f54f666..ea71d4d 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskSpigot.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskSpigot.kt @@ -33,6 +33,7 @@ class GenerationTaskSpigot( } else { if (borderReached()) { endReached = true + endReachedCallback?.invoke() return } From b7666525b0f4120f5e0bc016394413861d122af4 Mon Sep 17 00:00:00 2001 From: Trivernis Date: Wed, 18 Sep 2019 20:50:13 +0200 Subject: [PATCH 09/17] Added bStats --- build.gradle | 13 +++++++++---- .../kotlin/net/trivernis/chunkmaster/Chunkmaster.kt | 4 ++++ src/main/resources/plugin.yml | 2 +- 3 files changed, 14 insertions(+), 5 deletions(-) diff --git a/build.gradle b/build.gradle index 9930870..581da97 100644 --- a/build.gradle +++ b/build.gradle @@ -22,7 +22,7 @@ idea { } group "net.trivernis" -version "0.10-beta" +version "0.11-beta" sourceCompatibility = 1.8 @@ -31,9 +31,6 @@ repositories { maven { url "https://hub.spigotmc.org/nexus/content/repositories/snapshots" } - maven { - url 'https://papermc.io/repo/repository/maven-public/' - } maven { url 'https://mvnrepository.com/artifact/org.xerial/sqlite-jdbc' } @@ -41,6 +38,10 @@ repositories { name 'papermc' url 'https://papermc.io/repo/repository/maven-public/' } + maven { + name 'CodeMc' + url 'https://repo.codemc.org/repository/maven-public' + } } dependencies { @@ -50,11 +51,15 @@ dependencies { compileOnly "org.spigotmc:spigot-api:1.14.4-R0.1-SNAPSHOT" compile group: 'org.xerial', name: 'sqlite-jdbc', version: '3.28.0' compile "io.papermc:paperlib:1.0.2" + compile "org.bstats:bstats-bukkit:1.5" } apply plugin: "com.github.johnrengelman.shadow" +apply plugin: 'java' + shadowJar { relocate 'io.papermc.lib', 'net.trivernis.chunkmaster.paperlib' + relocate 'org.bstats', 'net.trivernis.chunkmaster.bstats' } jar { diff --git a/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt b/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt index 117bb10..6d5ab8b 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt @@ -4,6 +4,7 @@ import io.papermc.lib.PaperLib import net.trivernis.chunkmaster.commands.* import net.trivernis.chunkmaster.lib.generation.GenerationManager import net.trivernis.chunkmaster.lib.SqlUpdateManager +import org.bstats.bukkit.Metrics import org.bukkit.plugin.java.JavaPlugin import org.bukkit.scheduler.BukkitTask import java.lang.Exception @@ -24,6 +25,9 @@ class Chunkmaster: JavaPlugin() { override fun onEnable() { PaperLib.suggestPaper(this) configure() + + val metrics = Metrics(this) + initDatabase() generationManager = GenerationManager(this, server) generationManager.init() diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml index 096b64a..350e596 100644 --- a/src/main/resources/plugin.yml +++ b/src/main/resources/plugin.yml @@ -1,6 +1,6 @@ main: net.trivernis.chunkmaster.Chunkmaster name: Chunkmaster -version: '0.10-beta' +version: '0.11-beta' description: Chunk commands plugin. author: Trivernis website: trivernis.net From b9443c74874498ef73c5a23efdb77d9a78ecff99 Mon Sep 17 00:00:00 2001 From: Trivernis Date: Wed, 18 Sep 2019 20:50:13 +0200 Subject: [PATCH 10/17] Added bStats and changed jar build --- build.gradle | 13 +++++++++---- .../kotlin/net/trivernis/chunkmaster/Chunkmaster.kt | 4 ++++ src/main/resources/plugin.yml | 2 +- 3 files changed, 14 insertions(+), 5 deletions(-) diff --git a/build.gradle b/build.gradle index 9930870..581da97 100644 --- a/build.gradle +++ b/build.gradle @@ -22,7 +22,7 @@ idea { } group "net.trivernis" -version "0.10-beta" +version "0.11-beta" sourceCompatibility = 1.8 @@ -31,9 +31,6 @@ repositories { maven { url "https://hub.spigotmc.org/nexus/content/repositories/snapshots" } - maven { - url 'https://papermc.io/repo/repository/maven-public/' - } maven { url 'https://mvnrepository.com/artifact/org.xerial/sqlite-jdbc' } @@ -41,6 +38,10 @@ repositories { name 'papermc' url 'https://papermc.io/repo/repository/maven-public/' } + maven { + name 'CodeMc' + url 'https://repo.codemc.org/repository/maven-public' + } } dependencies { @@ -50,11 +51,15 @@ dependencies { compileOnly "org.spigotmc:spigot-api:1.14.4-R0.1-SNAPSHOT" compile group: 'org.xerial', name: 'sqlite-jdbc', version: '3.28.0' compile "io.papermc:paperlib:1.0.2" + compile "org.bstats:bstats-bukkit:1.5" } apply plugin: "com.github.johnrengelman.shadow" +apply plugin: 'java' + shadowJar { relocate 'io.papermc.lib', 'net.trivernis.chunkmaster.paperlib' + relocate 'org.bstats', 'net.trivernis.chunkmaster.bstats' } jar { diff --git a/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt b/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt index 117bb10..6d5ab8b 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt @@ -4,6 +4,7 @@ import io.papermc.lib.PaperLib import net.trivernis.chunkmaster.commands.* import net.trivernis.chunkmaster.lib.generation.GenerationManager import net.trivernis.chunkmaster.lib.SqlUpdateManager +import org.bstats.bukkit.Metrics import org.bukkit.plugin.java.JavaPlugin import org.bukkit.scheduler.BukkitTask import java.lang.Exception @@ -24,6 +25,9 @@ class Chunkmaster: JavaPlugin() { override fun onEnable() { PaperLib.suggestPaper(this) configure() + + val metrics = Metrics(this) + initDatabase() generationManager = GenerationManager(this, server) generationManager.init() diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml index 096b64a..350e596 100644 --- a/src/main/resources/plugin.yml +++ b/src/main/resources/plugin.yml @@ -1,6 +1,6 @@ main: net.trivernis.chunkmaster.Chunkmaster name: Chunkmaster -version: '0.10-beta' +version: '0.11-beta' description: Chunk commands plugin. author: Trivernis website: trivernis.net From 29e5b9c1171c86175df90c28b94f17174029138b Mon Sep 17 00:00:00 2001 From: Trivernis Date: Wed, 18 Sep 2019 21:23:52 +0200 Subject: [PATCH 11/17] Update gradle.yml --- .github/workflows/gradle.yml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 .github/workflows/gradle.yml diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml new file mode 100644 index 0000000..8fad17a --- /dev/null +++ b/.github/workflows/gradle.yml @@ -0,0 +1,17 @@ +name: Java CI + +on: [push] + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v1 + - name: Set up JDK 1.8 + uses: actions/setup-java@v1 + with: + java-version: 1.8 + - name: Build with Gradle + run: ./gradlew shadowJar From a1c64f76fc01e624e2e48e70636e8873fbc8d2ff Mon Sep 17 00:00:00 2001 From: Trivernis Date: Wed, 18 Sep 2019 21:25:52 +0200 Subject: [PATCH 12/17] Update gradle.yml --- .github/workflows/gradle.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml index 8fad17a..3f2a42c 100644 --- a/.github/workflows/gradle.yml +++ b/.github/workflows/gradle.yml @@ -1,6 +1,6 @@ name: Java CI -on: [push] +on: [push, pull_request] jobs: build: From 2e75d30318ecc237e2290580a6a1e532e8c33206 Mon Sep 17 00:00:00 2001 From: Trivernis Date: Wed, 18 Sep 2019 21:30:44 +0200 Subject: [PATCH 13/17] Update gradle.yml --- .github/workflows/gradle.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml index 3f2a42c..22ff184 100644 --- a/.github/workflows/gradle.yml +++ b/.github/workflows/gradle.yml @@ -10,7 +10,7 @@ jobs: steps: - uses: actions/checkout@v1 - name: Set up JDK 1.8 - uses: actions/setup-java@v1 + uses: docker://gcr.io/cloud-builders/gradle with: java-version: 1.8 - name: Build with Gradle From c6a4de48b14f4230130d1fe406f9611577472650 Mon Sep 17 00:00:00 2001 From: Trivernis Date: Wed, 18 Sep 2019 21:39:14 +0200 Subject: [PATCH 14/17] Update gradle.yml --- .github/workflows/gradle.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml index 22ff184..c3344a5 100644 --- a/.github/workflows/gradle.yml +++ b/.github/workflows/gradle.yml @@ -10,7 +10,7 @@ jobs: steps: - uses: actions/checkout@v1 - name: Set up JDK 1.8 - uses: docker://gcr.io/cloud-builders/gradle + uses: docker://gradle:latest with: java-version: 1.8 - name: Build with Gradle From 3a171f002b2448f90d079500b9aeb59ba205b12a Mon Sep 17 00:00:00 2001 From: Trivernis Date: Wed, 18 Sep 2019 21:41:01 +0200 Subject: [PATCH 15/17] Update gradle.yml --- .github/workflows/gradle.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml index c3344a5..bcc5fd0 100644 --- a/.github/workflows/gradle.yml +++ b/.github/workflows/gradle.yml @@ -14,4 +14,4 @@ jobs: with: java-version: 1.8 - name: Build with Gradle - run: ./gradlew shadowJar + run: ./gradle shadowJar From ed0cc68bd0fedd587c3ed5d95b61df9dd8ff0819 Mon Sep 17 00:00:00 2001 From: Trivernis Date: Wed, 18 Sep 2019 21:42:09 +0200 Subject: [PATCH 16/17] Update gradle.yml --- .github/workflows/gradle.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml index bcc5fd0..7d19d4f 100644 --- a/.github/workflows/gradle.yml +++ b/.github/workflows/gradle.yml @@ -14,4 +14,4 @@ jobs: with: java-version: 1.8 - name: Build with Gradle - run: ./gradle shadowJar + run: gradle shadowJar From 6c82136996ecdc8bef093f9d2b4d254114195604 Mon Sep 17 00:00:00 2001 From: Trivernis Date: Wed, 18 Sep 2019 21:44:14 +0200 Subject: [PATCH 17/17] Delete gradle.yml --- .github/workflows/gradle.yml | 17 ----------------- 1 file changed, 17 deletions(-) delete mode 100644 .github/workflows/gradle.yml diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml deleted file mode 100644 index 7d19d4f..0000000 --- a/.github/workflows/gradle.yml +++ /dev/null @@ -1,17 +0,0 @@ -name: Java CI - -on: [push, pull_request] - -jobs: - build: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v1 - - name: Set up JDK 1.8 - uses: docker://gradle:latest - with: - java-version: 1.8 - - name: Build with Gradle - run: gradle shadowJar