From f89262e53837c7fb953ba69d54f3afe5b64e0eeb Mon Sep 17 00:00:00 2001 From: trivernis Date: Thu, 23 Jan 2020 22:00:00 +0100 Subject: [PATCH] Add ignore-worldborder config option - [Convert to unix linebreaks] - Add ignore-worldborder config option to generate past the vanilla world border --- .circleci/config.yml | 88 +- .gitignore | 10 +- LICENSE | 1348 ++++++++--------- README.md | 148 +- build.gradle | 157 +- settings.gradle | 4 +- .../net/trivernis/chunkmaster/Chunkmaster.kt | 173 ++- .../chunkmaster/ChunkmasterEvents.kt | 108 +- .../chunkmaster/commands/CmdCancel.kt | 94 +- .../chunkmaster/commands/CmdGenerate.kt | 264 ++-- .../trivernis/chunkmaster/commands/CmdList.kt | 124 +- .../chunkmaster/commands/CmdPause.kt | 72 +- .../chunkmaster/commands/CmdReload.kt | 66 +- .../chunkmaster/commands/CmdResume.kt | 66 +- .../chunkmaster/commands/CmdTpChunk.kt | 102 +- .../commands/CommandChunkmaster.kt | 178 +-- .../net/trivernis/chunkmaster/lib/Spiral.kt | 126 +- .../chunkmaster/lib/SqliteManager.kt | 272 ++-- .../trivernis/chunkmaster/lib/Subcommand.kt | 18 +- .../lib/generation/ChunkCoordinates.kt | 18 +- .../lib/generation/GenerationManager.kt | 526 +++---- .../lib/generation/GenerationTask.kt | 128 +- .../lib/generation/GenerationTaskPaper.kt | 231 ++- .../lib/generation/GenerationTaskSpigot.kt | 137 +- .../lib/generation/PausedTaskEntry.kt | 18 +- .../lib/generation/RunningTaskEntry.kt | 72 +- .../chunkmaster/lib/generation/TaskEntry.kt | 24 +- src/main/resources/plugin.yml | 114 +- 28 files changed, 2346 insertions(+), 2340 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index a132e08..5c6990d 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -1,45 +1,45 @@ -# Java Gradle CircleCI 2.0 configuration file -# -# Check https://circleci.com/docs/2.0/language-java/ for more details -# -version: 2 -jobs: - build: - docker: - # specify the version you desire here - - image: circleci/openjdk:8-jdk - - # Specify service dependencies here if necessary - # CircleCI maintains a library of pre-built images - # documented at https://circleci.com/docs/2.0/circleci-images/ - # - image: circleci/postgres:9.4 - - working_directory: ~/repo - - environment: - # Customize the JVM maximum heap limit - JVM_OPTS: -Xmx3200m - TERM: dumb - - steps: - - checkout - - # Download and cache dependencies - - restore_cache: - keys: - - v1-dependencies-{{ checksum "build.gradle" }} - # fallback to using the latest cache if no exact match is found - - v1-dependencies- - - - run: gradle dependencies - - - save_cache: - paths: - - ~/.gradle - key: v1-dependencies-{{ checksum "build.gradle" }} - - # Build jar - - run: gradle shadowJar - - store_artifacts: - path: build/libs +# Java Gradle CircleCI 2.0 configuration file +# +# Check https://circleci.com/docs/2.0/language-java/ for more details +# +version: 2 +jobs: + build: + docker: + # specify the version you desire here + - image: circleci/openjdk:8-jdk + + # Specify service dependencies here if necessary + # CircleCI maintains a library of pre-built images + # documented at https://circleci.com/docs/2.0/circleci-images/ + # - image: circleci/postgres:9.4 + + working_directory: ~/repo + + environment: + # Customize the JVM maximum heap limit + JVM_OPTS: -Xmx3200m + TERM: dumb + + steps: + - checkout + + # Download and cache dependencies + - restore_cache: + keys: + - v1-dependencies-{{ checksum "build.gradle" }} + # fallback to using the latest cache if no exact match is found + - v1-dependencies- + + - run: gradle dependencies + + - save_cache: + paths: + - ~/.gradle + key: v1-dependencies-{{ checksum "build.gradle" }} + + # Build jar + - run: gradle shadowJar + - store_artifacts: + path: build/libs destination: build \ No newline at end of file diff --git a/.gitignore b/.gitignore index 4a8c18f..0313c4f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,6 @@ -gradle -.gradle -.idea -build -out +gradle +.gradle +.idea +build +out gradlew* \ No newline at end of file diff --git a/LICENSE b/LICENSE index f288702..3877ae0 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +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 -. + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index 17ddda6..5bcc87b 100644 --- a/README.md +++ b/README.md @@ -1,75 +1,75 @@ -# chunkmaster - -This plugin can be used to pre-generate the region of a world around the spawn chunk. -The generation automatically pauses when a player joins the server (assuming the server was empty before) -and resumes when the server is empty again. The generation also auto-resumes after a server -restart. The plugin tracks the ticks per second and pauses the generation when the tps -is lower than 2 (configurable). - -## Commands - -All features can be accessed with the command `/chunkmaster` or the aliases `/chm`, `chunkm`, `cmaster`. - -- `/chunkmaster generate [world] [chunk count] [unit]` Starts the generation until the specified chunk count or the world border is reached. -- `/chunkmaster list` Lists all running generation tasks -- `/chunkmaster cancel ` Cancels the generation task with the specified id (if it is running). -- `/chunkmaster pause` Pauses all generation tasks until the resume command is executed. -- `/chunkmaster resume` Resumes all paused generation tasks. -- `/chunkmaster reload` Reloads the configuration file. -- `/chunkmaster tpchunk ` Teleports you to the specified chunk coordinates. - -## Config - -```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 - - # The max amount of chunks that should be generated per step. - # Higher values mean higher generation speed but higher performance impact. - # The value should be a positive integer. - chunks-per-step: 4 - - # 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. - # Higher values mean faster generation but greater performance impact. - # The value should be a positive integer. - chunk-skips-per-step: 100 - - # The maximum milliseconds per tick the server is allowed to have - # during the cunk generation process. - # If the mspt is greather than this, the chunk generation task pauses. - # The value should be a positive integer greater than 50. - mspt-pause-threshold: 500 - - # If the chunk generation process should pause on player join. - # Notice that playing on a server that constantly generates chunks can be - # very laggy and can cause it to crash. - # You could configure the values above so that the performance impact of the generation - # process is minimal. - # The value should be a boolean - pause-on-join: true -``` - -## 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 +# chunkmaster + +This plugin can be used to pre-generate the region of a world around the spawn chunk. +The generation automatically pauses when a player joins the server (assuming the server was empty before) +and resumes when the server is empty again. The generation also auto-resumes after a server +restart. The plugin tracks the ticks per second and pauses the generation when the tps +is lower than 2 (configurable). + +## Commands + +All features can be accessed with the command `/chunkmaster` or the aliases `/chm`, `chunkm`, `cmaster`. + +- `/chunkmaster generate [world] [chunk count] [unit]` Starts the generation until the specified chunk count or the world border is reached. +- `/chunkmaster list` Lists all running generation tasks +- `/chunkmaster cancel ` Cancels the generation task with the specified id (if it is running). +- `/chunkmaster pause` Pauses all generation tasks until the resume command is executed. +- `/chunkmaster resume` Resumes all paused generation tasks. +- `/chunkmaster reload` Reloads the configuration file. +- `/chunkmaster tpchunk ` Teleports you to the specified chunk coordinates. + +## Config + +```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 + + # The max amount of chunks that should be generated per step. + # Higher values mean higher generation speed but higher performance impact. + # The value should be a positive integer. + chunks-per-step: 4 + + # 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. + # Higher values mean faster generation but greater performance impact. + # The value should be a positive integer. + chunk-skips-per-step: 100 + + # The maximum milliseconds per tick the server is allowed to have + # during the cunk generation process. + # If the mspt is greather than this, the chunk generation task pauses. + # The value should be a positive integer greater than 50. + mspt-pause-threshold: 500 + + # If the chunk generation process should pause on player join. + # Notice that playing on a server that constantly generates chunks can be + # very laggy and can cause it to crash. + # You could configure the values above so that the performance impact of the generation + # process is minimal. + # The value should be a boolean + pause-on-join: true +``` + +## 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/build.gradle b/build.gradle index 4ac78ff..b7f41c6 100644 --- a/build.gradle +++ b/build.gradle @@ -1,79 +1,80 @@ -buildscript { - repositories { - jcenter() - } - - dependencies { - classpath "com.github.jengelman.gradle.plugins:shadow:2.0.2" - } -} - -plugins { - id 'idea' - id 'org.jetbrains.kotlin.jvm' version '1.3.50' - id 'com.github.johnrengelman.shadow' version '2.0.4' -} - -idea { - module { - downloadJavadoc = true - downloadSources = true - } -} - -group "net.trivernis" -version "0.13-beta" - -sourceCompatibility = 1.8 - -repositories { - mavenCentral() - maven { - url "https://hub.spigotmc.org/nexus/content/repositories/snapshots" - } - maven { - url 'https://mvnrepository.com/artifact/org.xerial/sqlite-jdbc' - } - maven { - name 'papermc' - url 'https://papermc.io/repo/repository/maven-public/' - } - maven { - name 'CodeMc' - url 'https://repo.codemc.org/repository/maven-public' - } -} - -dependencies { - compile "org.jetbrains.kotlin:kotlin-stdlib-jdk8" - implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8" - 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" - 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 { - from configurations.compile.collect { it.isDirectory() ? it : zipTree(it) } -} - -compileKotlin { - kotlinOptions { - jvmTarget = "1.8" - } -} - -compileTestKotlin { - kotlinOptions { - jvmTarget = "1.8" - } +buildscript { + repositories { + jcenter() + } + + dependencies { + classpath "com.github.jengelman.gradle.plugins:shadow:2.0.2" + } +} + +plugins { + id 'idea' + id 'org.jetbrains.kotlin.jvm' version '1.3.50' + id 'com.github.johnrengelman.shadow' version '2.0.4' +} + +idea { + module { + downloadJavadoc = true + downloadSources = true + } +} + +group "net.trivernis" +version "0.13-beta" + +sourceCompatibility = 1.8 + +repositories { + mavenCentral() + maven { + url "https://hub.spigotmc.org/nexus/content/repositories/snapshots" + } + maven { + url 'https://mvnrepository.com/artifact/org.xerial/sqlite-jdbc' + } + maven { + name 'papermc' + url 'https://papermc.io/repo/repository/maven-public/' + } + maven { + name 'CodeMc' + url 'https://repo.codemc.org/repository/maven-public' + } +} + +dependencies { + compile "org.jetbrains.kotlin:kotlin-stdlib-jdk8" + implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8" + testCompile group: 'junit', name: 'junit', version: '4.12' + //compileOnly "org.spigotmc:spigot-api:1.14.4-R0.1-SNAPSHOT" + compileOnly "com.destroystokyo.paper:paper-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 { + from configurations.compile.collect { it.isDirectory() ? it : zipTree(it) } +} + +compileKotlin { + kotlinOptions { + jvmTarget = "1.8" + } +} + +compileTestKotlin { + kotlinOptions { + jvmTarget = "1.8" + } } \ No newline at end of file diff --git a/settings.gradle b/settings.gradle index e2cead2..8ec5487 100644 --- a/settings.gradle +++ b/settings.gradle @@ -1,2 +1,2 @@ -rootProject.name = 'chunkmaster' - +rootProject.name = 'chunkmaster' + diff --git a/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt b/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt index 8a64861..f24c79e 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt @@ -1,85 +1,90 @@ -package net.trivernis.chunkmaster - -import io.papermc.lib.PaperLib -import net.trivernis.chunkmaster.commands.* -import net.trivernis.chunkmaster.lib.generation.GenerationManager -import net.trivernis.chunkmaster.lib.SqliteManager -import org.bstats.bukkit.Metrics -import org.bukkit.plugin.java.JavaPlugin -import org.bukkit.scheduler.BukkitTask -import java.lang.Exception -import java.sql.Connection -import java.sql.DriverManager - -class Chunkmaster: JavaPlugin() { - lateinit var sqliteManager: SqliteManager - lateinit var generationManager: GenerationManager - private lateinit var tpsTask: BukkitTask - var mspt = 50L // keep track of the milliseconds per tick - private set - - /** - * On enable of the plugin - */ - override fun onEnable() { - PaperLib.suggestPaper(this) - configure() - - val metrics = Metrics(this) - - initDatabase() - generationManager = GenerationManager(this, server) - generationManager.init() - - getCommand("chunkmaster")?.aliases = mutableListOf("chm", "chunkm", "cmaster") - getCommand("chunkmaster")?.setExecutor(CommandChunkmaster(this, server)) - - server.pluginManager.registerEvents(ChunkmasterEvents(this, server), this) - - tpsTask = server.scheduler.runTaskTimer(this, Runnable { - val start = System.currentTimeMillis() - server.scheduler.runTaskLater(this, Runnable { - mspt = System.currentTimeMillis() - start - }, 1) - }, 1, 300) - } - - /** - * Stop all tasks and close database connection on disable - */ - override fun onDisable() { - logger.info("Stopping all generation tasks...") - generationManager.stopAll() - } - - /** - * Cofigure the config file - */ - private fun configure() { - dataFolder.mkdir() - config.addDefault("generation.period", 2L) - config.addDefault("generation.chunks-per-step", 2) - config.addDefault("generation.chunk-skips-per-step", 100) - 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.addDefault("database.filename", "chunkmaster.db") - config.options().copyDefaults(true) - saveConfig() - } - - /** - * Initializes the database - */ - private fun initDatabase() { - logger.info("Initializing Database...") - try { - this.sqliteManager = SqliteManager( this) - sqliteManager.init() - logger.info("Database fully initialized.") - } catch(e: Exception) { - logger.warning("Failed to init database: ${e.message}") - } - } +package net.trivernis.chunkmaster + +import io.papermc.lib.PaperLib +import net.trivernis.chunkmaster.commands.* +import net.trivernis.chunkmaster.lib.generation.GenerationManager +import net.trivernis.chunkmaster.lib.SqliteManager +import org.bstats.bukkit.Metrics +import org.bukkit.plugin.java.JavaPlugin +import org.bukkit.scheduler.BukkitTask +import java.lang.Exception + +class Chunkmaster: JavaPlugin() { + lateinit var sqliteManager: SqliteManager + lateinit var generationManager: GenerationManager + private lateinit var tpsTask: BukkitTask + var mspt = 20 // keep track of the milliseconds per tick + private set + + /** + * On enable of the plugin + */ + override fun onEnable() { + PaperLib.suggestPaper(this) + configure() + + val metrics = Metrics(this) + + initDatabase() + generationManager = GenerationManager(this, server) + generationManager.init() + + getCommand("chunkmaster")?.aliases = mutableListOf("chm", "chunkm", "cmaster") + getCommand("chunkmaster")?.setExecutor(CommandChunkmaster(this, server)) + + server.pluginManager.registerEvents(ChunkmasterEvents(this, server), this) + + if (PaperLib.isPaper() && PaperLib.getMinecraftPatchVersion() >= 225) { + tpsTask = server.scheduler.runTaskTimer(this, Runnable { + mspt = 1000/server.currentTick // use papers exposed tick rather than calculating it + }, 1, 300) + } else { + tpsTask = server.scheduler.runTaskTimer(this, Runnable { + val start = System.currentTimeMillis() + server.scheduler.runTaskLater(this, Runnable { + mspt = (System.currentTimeMillis() - start).toInt() + }, 1) + }, 1, 300) + } + } + + /** + * Stop all tasks and close database connection on disable + */ + override fun onDisable() { + logger.info("Stopping all generation tasks...") + generationManager.stopAll() + } + + /** + * Cofigure the config file + */ + private fun configure() { + dataFolder.mkdir() + config.addDefault("generation.period", 2L) + config.addDefault("generation.chunks-per-step", 2) + config.addDefault("generation.chunk-skips-per-step", 100) + 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.addDefault("generation.ignore-worldborder", false) + config.addDefault("database.filename", "chunkmaster.db") + config.options().copyDefaults(true) + saveConfig() + } + + /** + * Initializes the database + */ + private fun initDatabase() { + logger.info("Initializing Database...") + try { + this.sqliteManager = SqliteManager( this) + sqliteManager.init() + logger.info("Database fully initialized.") + } catch(e: Exception) { + logger.warning("Failed to init database: ${e.message}") + } + } } \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/ChunkmasterEvents.kt b/src/main/kotlin/net/trivernis/chunkmaster/ChunkmasterEvents.kt index 3232bdf..7c57428 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/ChunkmasterEvents.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/ChunkmasterEvents.kt @@ -1,55 +1,55 @@ -package net.trivernis.chunkmaster - -import net.trivernis.chunkmaster.lib.generation.GenerationTaskPaper -import org.bukkit.Server -import org.bukkit.event.EventHandler -import org.bukkit.event.Listener -import org.bukkit.event.player.PlayerJoinEvent -import org.bukkit.event.player.PlayerQuitEvent -import org.bukkit.event.world.WorldSaveEvent - -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 - */ - @EventHandler - fun onPlayerQuit(event: PlayerQuitEvent) { - if (pauseOnJoin) { - if (server.onlinePlayers.size == 1 && server.onlinePlayers.contains(event.player) || - server.onlinePlayers.isEmpty() - ) { - if (!playerPaused) { - if (chunkmaster.generationManager.pausedTasks.isNotEmpty()) { - chunkmaster.logger.info("Server is empty. Resuming chunk generation tasks.") - } - chunkmaster.generationManager.resumeAll() - } 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.") - } - } - } - } - - /** - * Autostop generation tasks - */ - @EventHandler - fun onPlayerJoin(event: PlayerJoinEvent) { - if (pauseOnJoin) { - if (server.onlinePlayers.size == 1 || server.onlinePlayers.isEmpty()) { - if (chunkmaster.generationManager.tasks.isNotEmpty()) { - chunkmaster.logger.info("Pausing generation tasks because of player join.") - } - playerPaused = chunkmaster.generationManager.paused - chunkmaster.generationManager.pauseAll() - } - } - } +package net.trivernis.chunkmaster + +import net.trivernis.chunkmaster.lib.generation.GenerationTaskPaper +import org.bukkit.Server +import org.bukkit.event.EventHandler +import org.bukkit.event.Listener +import org.bukkit.event.player.PlayerJoinEvent +import org.bukkit.event.player.PlayerQuitEvent +import org.bukkit.event.world.WorldSaveEvent + +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 + */ + @EventHandler + fun onPlayerQuit(event: PlayerQuitEvent) { + if (pauseOnJoin) { + if (server.onlinePlayers.size == 1 && server.onlinePlayers.contains(event.player) || + server.onlinePlayers.isEmpty() + ) { + if (!playerPaused) { + if (chunkmaster.generationManager.pausedTasks.isNotEmpty()) { + chunkmaster.logger.info("Server is empty. Resuming chunk generation tasks.") + } + chunkmaster.generationManager.resumeAll() + } 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.") + } + } + } + } + + /** + * Autostop generation tasks + */ + @EventHandler + fun onPlayerJoin(event: PlayerJoinEvent) { + if (pauseOnJoin) { + if (server.onlinePlayers.size == 1 || server.onlinePlayers.isEmpty()) { + if (chunkmaster.generationManager.tasks.isNotEmpty()) { + chunkmaster.logger.info("Pausing generation tasks because of player join.") + } + playerPaused = chunkmaster.generationManager.paused + chunkmaster.generationManager.pauseAll() + } + } + } } \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdCancel.kt b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdCancel.kt index 052ee60..b1fa084 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdCancel.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdCancel.kt @@ -1,48 +1,48 @@ -package net.trivernis.chunkmaster.commands - -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 = genManager.allTasks - 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())) { - sender.sendMessage("Task ${args[0]} canceled.") - true - } else { - sender.spigot().sendMessage(*ComponentBuilder("Task ${args[0]} not found!") - .color(ChatColor.RED).create()) - false - } - } else { - sender.spigot().sendMessage(*ComponentBuilder("You need to provide a task id to cancel.") - .color(ChatColor.RED).create()) - false - } - } +package net.trivernis.chunkmaster.commands + +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 = genManager.allTasks + 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())) { + sender.sendMessage("Task ${args[0]} canceled.") + true + } else { + sender.spigot().sendMessage(*ComponentBuilder("Task ${args[0]} not found!") + .color(ChatColor.RED).create()) + false + } + } else { + sender.spigot().sendMessage(*ComponentBuilder("You need to provide a task id to cancel.") + .color(ChatColor.RED).create()) + false + } + } } \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdGenerate.kt b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdGenerate.kt index 7b25762..9ea4dde 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdGenerate.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdGenerate.kt @@ -1,133 +1,133 @@ -package net.trivernis.chunkmaster.commands - -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 -import kotlin.math.pow - -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() - } else if (args.size == 2) { - if (args[0].toIntOrNull() != null) { - return units.filter {it.indexOf(args[1]) == 0}.toMutableList() - } - } else if (args.size > 2) { - if (args[1].toIntOrNull() != null) { - return units.filter {it.indexOf(args[2]) == 0}.toMutableList() - } - } - return emptyList().toMutableList() - } - val units = listOf("blockradius", "radius", "diameter") - - - /** - * Creates a new generation task for the world and chunk count. - */ - override fun execute(sender: CommandSender, args: List): Boolean { - var worldName = "" - var stopAfter = -1 - if (sender is Player) { - if (args.isNotEmpty()) { - if (args[0].toIntOrNull() != null) { - stopAfter = args[0].toInt() - worldName = sender.world.name - } else { - worldName = args[0] - } - if (args.size > 1) { - if (args[1].toIntOrNull() != null) { - stopAfter = args[1].toInt() - } else if (args[1] in units && args[0].toIntOrNull() != null) { - stopAfter = getStopAfter(stopAfter, args[1]) - } else { - worldName = args[1] - } - } - if (args.size > 2 && args[2] in units && args[1].toIntOrNull() != null) { - stopAfter = getStopAfter(stopAfter, args[2]) - } - } else { - worldName = sender.world.name - } - } else { - if (args.isNotEmpty()) { - worldName = args[0] - if (args.size > 1) { - if (args[1].toIntOrNull() != null) { - stopAfter = args[1].toInt() - } - } - if (args.size > 2 && args[2] in units) { - stopAfter = getStopAfter(stopAfter, args[2]) - } - } else { - sender.spigot().sendMessage( - *ComponentBuilder("You need to provide a world name").color(ChatColor.RED).create()) - return false - } - } - return createTask(sender, worldName, stopAfter) - } - - /** - * Returns stopAfter for a given unit - */ - private fun getStopAfter(number: Int, unit: String): Int { - if (unit in units) { - return when (unit) { - "radius" -> { - ((number * 2)+1).toDouble().pow(2.0).toInt() - } - "diameter" -> { - number.toDouble().pow(2.0).toInt() - } - "blockradius" -> { - ((number.toDouble()+1)/8).pow(2.0).toInt() - } - else -> number - } - } - return number - } - - /** - * Creates the task with the given arguments. - */ - private fun createTask(sender: CommandSender, worldName: String, stopAfter: Int): Boolean { - val world = chunkmaster.server.getWorld(worldName) - 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 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 - } - } +package net.trivernis.chunkmaster.commands + +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 +import kotlin.math.pow + +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() + } else if (args.size == 2) { + if (args[0].toIntOrNull() != null) { + return units.filter {it.indexOf(args[1]) == 0}.toMutableList() + } + } else if (args.size > 2) { + if (args[1].toIntOrNull() != null) { + return units.filter {it.indexOf(args[2]) == 0}.toMutableList() + } + } + return emptyList().toMutableList() + } + val units = listOf("blockradius", "radius", "diameter") + + + /** + * Creates a new generation task for the world and chunk count. + */ + override fun execute(sender: CommandSender, args: List): Boolean { + var worldName = "" + var stopAfter = -1 + if (sender is Player) { + if (args.isNotEmpty()) { + if (args[0].toIntOrNull() != null) { + stopAfter = args[0].toInt() + worldName = sender.world.name + } else { + worldName = args[0] + } + if (args.size > 1) { + if (args[1].toIntOrNull() != null) { + stopAfter = args[1].toInt() + } else if (args[1] in units && args[0].toIntOrNull() != null) { + stopAfter = getStopAfter(stopAfter, args[1]) + } else { + worldName = args[1] + } + } + if (args.size > 2 && args[2] in units && args[1].toIntOrNull() != null) { + stopAfter = getStopAfter(stopAfter, args[2]) + } + } else { + worldName = sender.world.name + } + } else { + if (args.isNotEmpty()) { + worldName = args[0] + if (args.size > 1) { + if (args[1].toIntOrNull() != null) { + stopAfter = args[1].toInt() + } + } + if (args.size > 2 && args[2] in units) { + stopAfter = getStopAfter(stopAfter, args[2]) + } + } else { + sender.spigot().sendMessage( + *ComponentBuilder("You need to provide a world name").color(ChatColor.RED).create()) + return false + } + } + return createTask(sender, worldName, stopAfter) + } + + /** + * Returns stopAfter for a given unit + */ + private fun getStopAfter(number: Int, unit: String): Int { + if (unit in units) { + return when (unit) { + "radius" -> { + ((number * 2)+1).toDouble().pow(2.0).toInt() + } + "diameter" -> { + number.toDouble().pow(2.0).toInt() + } + "blockradius" -> { + ((number.toDouble()+1)/8).pow(2.0).toInt() + } + else -> number + } + } + return number + } + + /** + * Creates the task with the given arguments. + */ + private fun createTask(sender: CommandSender, worldName: String, stopAfter: Int): Boolean { + val world = chunkmaster.server.getWorld(worldName) + 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 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/commands/CmdList.kt b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdList.kt index 00703b7..b98a6f4 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdList.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdList.kt @@ -1,63 +1,63 @@ -package net.trivernis.chunkmaster.commands - -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 - 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).bold(true) - for (task in runningTasks) { - 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()) - } - return true - } +package net.trivernis.chunkmaster.commands + +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 + 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).bold(true) + for (task in runningTasks) { + 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()) + } + return true + } } \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdPause.kt b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdPause.kt index 20c8fb8..6e1d46c 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdPause.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdPause.kt @@ -1,37 +1,37 @@ -package net.trivernis.chunkmaster.commands - -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() - sender.spigot().sendMessage( - *ComponentBuilder("Paused all generation tasks.") - .color(ChatColor.BLUE).create() - ) - true - } else { - sender.spigot().sendMessage( - *ComponentBuilder("The generation process is already paused.").color(ChatColor.RED).create() - ) - false - } - } +package net.trivernis.chunkmaster.commands + +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() + sender.spigot().sendMessage( + *ComponentBuilder("Paused all generation tasks.") + .color(ChatColor.BLUE).create() + ) + true + } else { + sender.spigot().sendMessage( + *ComponentBuilder("The generation process is already paused.").color(ChatColor.RED).create() + ) + false + } + } } \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdReload.kt b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdReload.kt index 419165e..91b6c81 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdReload.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdReload.kt @@ -1,34 +1,34 @@ -package net.trivernis.chunkmaster.commands - -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 CmdReload(private val chunkmaster: Chunkmaster): Subcommand { - override val name = "reload" - - override fun onTabComplete( - sender: CommandSender, - command: Command, - alias: String, - args: List - ): MutableList { - return emptyList().toMutableList() - } - - /** - * Reload command to reload the config and restart the tasks. - */ - override fun execute(sender: CommandSender, args: List): Boolean { - sender.spigot().sendMessage(*ComponentBuilder("Reloading config and restarting tasks...") - .color(ChatColor.YELLOW).create()) - chunkmaster.generationManager.stopAll() - chunkmaster.reloadConfig() - chunkmaster.generationManager.startAll() - sender.spigot().sendMessage(*ComponentBuilder("Config reload complete!").color(ChatColor.GREEN).create()) - return true - } +package net.trivernis.chunkmaster.commands + +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 CmdReload(private val chunkmaster: Chunkmaster): Subcommand { + override val name = "reload" + + override fun onTabComplete( + sender: CommandSender, + command: Command, + alias: String, + args: List + ): MutableList { + return emptyList().toMutableList() + } + + /** + * Reload command to reload the config and restart the tasks. + */ + override fun execute(sender: CommandSender, args: List): Boolean { + sender.spigot().sendMessage(*ComponentBuilder("Reloading config and restarting tasks...") + .color(ChatColor.YELLOW).create()) + chunkmaster.generationManager.stopAll() + chunkmaster.reloadConfig() + chunkmaster.generationManager.startAll() + sender.spigot().sendMessage(*ComponentBuilder("Config reload complete!").color(ChatColor.GREEN).create()) + return true + } } \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdResume.kt b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdResume.kt index df05ea6..c5beb9c 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdResume.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdResume.kt @@ -1,34 +1,34 @@ -package net.trivernis.chunkmaster.commands - -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() - sender.spigot().sendMessage( - *ComponentBuilder("Resumed all generation tasks.").color(ChatColor.BLUE).create()) - true - } else { - sender.spigot().sendMessage( - *ComponentBuilder("There are no paused generation tasks.").color(ChatColor.RED).create()) - false - } - } +package net.trivernis.chunkmaster.commands + +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() + sender.spigot().sendMessage( + *ComponentBuilder("Resumed all generation tasks.").color(ChatColor.BLUE).create()) + true + } else { + sender.spigot().sendMessage( + *ComponentBuilder("There are no paused generation tasks.").color(ChatColor.RED).create()) + false + } + } } \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdTpChunk.kt b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdTpChunk.kt index 89253bd..20d6c4d 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdTpChunk.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/commands/CmdTpChunk.kt @@ -1,52 +1,52 @@ -package net.trivernis.chunkmaster.commands - -import io.papermc.lib.PaperLib -import net.md_5.bungee.api.ChatColor -import net.md_5.bungee.api.chat.ComponentBuilder -import net.trivernis.chunkmaster.lib.Subcommand -import org.bukkit.Material -import org.bukkit.command.Command -import org.bukkit.command.CommandSender -import org.bukkit.entity.Player - -class CmdTpChunk: Subcommand { - override val name = "tpchunk" - - override fun onTabComplete( - sender: CommandSender, - command: Command, - alias: String, - args: List - ): MutableList { - return emptyList().toMutableList() - } - - /** - * Teleports the player to a save location in the chunk - */ - override fun execute(sender: CommandSender, args: List): Boolean { - if (sender is Player) { - if (args.size == 2 && args[0].toIntOrNull() != null && args[1].toIntOrNull() != null) { - val location = sender.world.getChunkAt(args[0].toInt(), args[1].toInt()).getBlock(8, 60, 8).location - - while (location.block.blockData.material != Material.AIR) { - location.y++ - } - if (PaperLib.isPaper()) { - PaperLib.teleportAsync(sender, location) - } else { - sender.teleport(location) - } - sender.spigot().sendMessage(*ComponentBuilder("You have been teleportet to chunk") - .color(ChatColor.YELLOW).append("${args[0]}, ${args[1]}").color(ChatColor.BLUE).create()) - return true - } else { - return false - } - } else { - sender.spigot().sendMessage(*ComponentBuilder("This command can only be executed by a player!") - .color(ChatColor.RED).create()) - return false - } - } +package net.trivernis.chunkmaster.commands + +import io.papermc.lib.PaperLib +import net.md_5.bungee.api.ChatColor +import net.md_5.bungee.api.chat.ComponentBuilder +import net.trivernis.chunkmaster.lib.Subcommand +import org.bukkit.Material +import org.bukkit.command.Command +import org.bukkit.command.CommandSender +import org.bukkit.entity.Player + +class CmdTpChunk: Subcommand { + override val name = "tpchunk" + + override fun onTabComplete( + sender: CommandSender, + command: Command, + alias: String, + args: List + ): MutableList { + return emptyList().toMutableList() + } + + /** + * Teleports the player to a save location in the chunk + */ + override fun execute(sender: CommandSender, args: List): Boolean { + if (sender is Player) { + if (args.size == 2 && args[0].toIntOrNull() != null && args[1].toIntOrNull() != null) { + val location = sender.world.getChunkAt(args[0].toInt(), args[1].toInt()).getBlock(8, 60, 8).location + + while (location.block.blockData.material != Material.AIR) { + location.y++ + } + if (PaperLib.isPaper()) { + PaperLib.teleportAsync(sender, location) + } else { + sender.teleport(location) + } + sender.spigot().sendMessage(*ComponentBuilder("You have been teleportet to chunk") + .color(ChatColor.YELLOW).append("${args[0]}, ${args[1]}").color(ChatColor.BLUE).create()) + return true + } else { + return false + } + } else { + sender.spigot().sendMessage(*ComponentBuilder("This command can only be executed by a player!") + .color(ChatColor.RED).create()) + return false + } + } } \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/commands/CommandChunkmaster.kt b/src/main/kotlin/net/trivernis/chunkmaster/commands/CommandChunkmaster.kt index 50bd98e..a3072cc 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/commands/CommandChunkmaster.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/commands/CommandChunkmaster.kt @@ -1,90 +1,90 @@ -package net.trivernis.chunkmaster.commands - -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.Server -import org.bukkit.command.Command -import org.bukkit.command.CommandExecutor -import org.bukkit.command.CommandSender -import org.bukkit.command.TabCompleter - -class CommandChunkmaster(private val chunkmaster: Chunkmaster, private val server: Server) : CommandExecutor, - TabCompleter { - private val commands = HashMap() - - init { - registerCommands() - } - - /** - * Tab complete for commands - */ - override fun onTabComplete(sender: CommandSender, command: Command, alias: String, args: Array): - MutableList { - 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() - } - - /** - * /chunkmaster command to handle all commands - */ - override fun onCommand(sender: CommandSender, command: Command, label: String, args: Array): Boolean { - if (args.isNotEmpty()) { - if (sender.hasPermission("chunkmaster.${args[0]}")) { - return if (commands.containsKey(args[0])) { - commands[args[0]]!!.execute(sender, args.slice(1 until args.size)) - } else { - sender.spigot().sendMessage( - *ComponentBuilder("Subcommand ").color(ChatColor.RED) - .append(args[0]).color(ChatColor.GREEN).append(" not found").color(ChatColor.RED).create() - ) - false - } - } else { - sender.spigot().sendMessage( - *ComponentBuilder("You do not have permission!") - .color(ChatColor.RED).create() - ) - } - return true - } else { - return false - } - } - - /** - * Registers all subcommands. - */ - private fun registerCommands() { - val cmdGenerate = CmdGenerate(chunkmaster) - commands[cmdGenerate.name] = cmdGenerate - - val cmdPause = CmdPause(chunkmaster) - commands[cmdPause.name] = cmdPause - - val cmdResume = CmdResume(chunkmaster) - commands[cmdResume.name] = cmdResume - - val cmdCancel = CmdCancel(chunkmaster) - commands[cmdCancel.name] = cmdCancel - - val cmdList = CmdList(chunkmaster) - commands[cmdList.name] = cmdList - - val cmdReload = CmdReload(chunkmaster) - commands[cmdReload.name] = cmdReload - - val cmdTpChunk = CmdTpChunk() - commands[cmdTpChunk.name] = cmdTpChunk - } +package net.trivernis.chunkmaster.commands + +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.Server +import org.bukkit.command.Command +import org.bukkit.command.CommandExecutor +import org.bukkit.command.CommandSender +import org.bukkit.command.TabCompleter + +class CommandChunkmaster(private val chunkmaster: Chunkmaster, private val server: Server) : CommandExecutor, + TabCompleter { + private val commands = HashMap() + + init { + registerCommands() + } + + /** + * Tab complete for commands + */ + override fun onTabComplete(sender: CommandSender, command: Command, alias: String, args: Array): + MutableList { + 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() + } + + /** + * /chunkmaster command to handle all commands + */ + override fun onCommand(sender: CommandSender, command: Command, label: String, args: Array): Boolean { + if (args.isNotEmpty()) { + if (sender.hasPermission("chunkmaster.${args[0]}")) { + return if (commands.containsKey(args[0])) { + commands[args[0]]!!.execute(sender, args.slice(1 until args.size)) + } else { + sender.spigot().sendMessage( + *ComponentBuilder("Subcommand ").color(ChatColor.RED) + .append(args[0]).color(ChatColor.GREEN).append(" not found").color(ChatColor.RED).create() + ) + false + } + } else { + sender.spigot().sendMessage( + *ComponentBuilder("You do not have permission!") + .color(ChatColor.RED).create() + ) + } + return true + } else { + return false + } + } + + /** + * Registers all subcommands. + */ + private fun registerCommands() { + val cmdGenerate = CmdGenerate(chunkmaster) + commands[cmdGenerate.name] = cmdGenerate + + val cmdPause = CmdPause(chunkmaster) + commands[cmdPause.name] = cmdPause + + val cmdResume = CmdResume(chunkmaster) + commands[cmdResume.name] = cmdResume + + val cmdCancel = CmdCancel(chunkmaster) + commands[cmdCancel.name] = cmdCancel + + val cmdList = CmdList(chunkmaster) + commands[cmdList.name] = cmdList + + val cmdReload = CmdReload(chunkmaster) + commands[cmdReload.name] = cmdReload + + val cmdTpChunk = CmdTpChunk() + commands[cmdTpChunk.name] = cmdTpChunk + } } \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/Spiral.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/Spiral.kt index de201be..15b063f 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/Spiral.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/Spiral.kt @@ -1,64 +1,64 @@ -package net.trivernis.chunkmaster.lib - -import kotlin.math.abs - -class Spiral(private val center: Pair, start: Pair) { - private var currentPos = start - private var direction = 0 - var count = 0 - - /** - * Returns the next value in the spiral - */ - fun next(): Pair { - if (count == 0 && currentPos != center) { - // simulate the spiral to get the correct direction - // TODO: Improve performance of this workaround (replace it with acutal stuff) - val simSpiral = Spiral(center, center) - while (simSpiral.next() != currentPos); - direction = simSpiral.direction - count = simSpiral.count - } - if (count == 1) { // because of the center behaviour - count ++ - return currentPos - } - if (currentPos == center) { // the center has to be handled exclusively - currentPos = Pair(center.first, center.second + 1) - count ++ - return center - } else { - val distances = getDistances(center, currentPos) - if (abs(distances.first) == abs(distances.second)) { - direction = (direction + 1)%5 - } - } - when(direction) { - 0 -> { - currentPos = Pair(currentPos.first + 1, currentPos.second) - } - 1 -> { - currentPos = Pair(currentPos.first, currentPos.second - 1) - } - 2 -> { - currentPos = Pair(currentPos.first - 1, currentPos.second) - } - 3 -> { - currentPos = Pair(currentPos.first, currentPos.second + 1) - } - 4 -> { - currentPos = Pair(currentPos.first, currentPos.second + 1) - direction = 0 - } - } - count ++ - return currentPos - } - - /** - * Returns the distances between 2 coordinates - */ - private fun getDistances(pos1: Pair, pos2: Pair): Pair { - return Pair(pos2.first - pos1.first, pos2.second - pos1.second) - } +package net.trivernis.chunkmaster.lib + +import kotlin.math.abs + +class Spiral(private val center: Pair, start: Pair) { + private var currentPos = start + private var direction = 0 + var count = 0 + + /** + * Returns the next value in the spiral + */ + fun next(): Pair { + if (count == 0 && currentPos != center) { + // simulate the spiral to get the correct direction + // TODO: Improve performance of this workaround (replace it with acutal stuff) + val simSpiral = Spiral(center, center) + while (simSpiral.next() != currentPos); + direction = simSpiral.direction + count = simSpiral.count + } + if (count == 1) { // because of the center behaviour + count ++ + return currentPos + } + if (currentPos == center) { // the center has to be handled exclusively + currentPos = Pair(center.first, center.second + 1) + count ++ + return center + } else { + val distances = getDistances(center, currentPos) + if (abs(distances.first) == abs(distances.second)) { + direction = (direction + 1)%5 + } + } + when(direction) { + 0 -> { + currentPos = Pair(currentPos.first + 1, currentPos.second) + } + 1 -> { + currentPos = Pair(currentPos.first, currentPos.second - 1) + } + 2 -> { + currentPos = Pair(currentPos.first - 1, currentPos.second) + } + 3 -> { + currentPos = Pair(currentPos.first, currentPos.second + 1) + } + 4 -> { + currentPos = Pair(currentPos.first, currentPos.second + 1) + direction = 0 + } + } + count ++ + return currentPos + } + + /** + * Returns the distances between 2 coordinates + */ + private fun getDistances(pos1: Pair, pos2: Pair): Pair { + return Pair(pos2.first - pos1.first, pos2.second - pos1.second) + } } \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/SqliteManager.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/SqliteManager.kt index e446882..d28db0b 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/SqliteManager.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/SqliteManager.kt @@ -1,137 +1,137 @@ -package net.trivernis.chunkmaster.lib - -import net.trivernis.chunkmaster.Chunkmaster -import org.apache.commons.lang.exception.ExceptionUtils -import org.sqlite.SQLiteConnection -import java.lang.Exception -import java.sql.Connection -import java.sql.DriverManager -import java.sql.PreparedStatement -import java.sql.ResultSet - -class SqliteManager(private val chunkmaster: Chunkmaster) { - private val tables = listOf( - Pair( - "generation_tasks", - listOf( - Pair("id", "integer PRIMARY KEY AUTOINCREMENT"), - Pair("center_x", "integer NOT NULL DEFAULT 0"), - Pair("center_z", "integer NOT NULL DEFAULT 0"), - Pair("last_x", "integer NOT NULL DEFAULT 0"), - Pair("last_z", "integer NOT NULL DEFAULT 0"), - Pair("world", "text UNIQUE NOT NULL DEFAULT 'world'"), - Pair("stop_after", "integer DEFAULT -1") - ) - ) - ) - private val needUpdate = HashSet>>() - private val needCreation = HashSet() - - /** - * Returns the connection to the database - */ - fun getConnection(): Connection? { - try { - Class.forName("org.sqlite.JDBC") - return DriverManager.getConnection("jdbc:sqlite:${chunkmaster.dataFolder.absolutePath}/" + - "${chunkmaster.config.getString("database.filename")}") - } catch (e: Exception) { - chunkmaster.logger.severe("Could not get database connection.") - chunkmaster.logger.severe(e.message) - } - return null - } - - /** - * Checks for and performs an update - */ - fun init() { - this.checkUpdate() - this.performUpdate() - } - - /** - * Checks which tables need an update or creation. - */ - private fun checkUpdate() { - val meta = getConnection()!!.metaData - - for (table in tables) { - val resTables = meta.getTables(null, null, table.first, null) - - if (resTables.next()) { // table exists - for (column in table.second) { - val resColumn = meta.getColumns(null, null, table.first, column.first) - if (!resColumn.next()) { - needUpdate.add(Pair(table.first, column)) - } - resColumn.close() - } - } else { - needCreation.add(table.first) - } - resTables.close() - } - } - - /** - * Executes a sql statement on the database. - */ - fun executeStatement(sql: String, values: HashMap, callback: ((ResultSet) -> Unit)?) { - val connection = getConnection() - if (connection != null) { - try { - val statement = connection.prepareStatement(sql) - for (parameterValue in values) { - statement.setObject(parameterValue.key, parameterValue.value) - } - statement.execute() - val res = statement.resultSet - if (callback != null) { - callback(res) - } - statement.close() - } catch (e: Exception) { - chunkmaster.logger.severe("An error occured on sql $sql. ${e.message}") - chunkmaster.logger.info(ExceptionUtils.getStackTrace(e)) - } finally { - connection.close() - } - } else { - chunkmaster.logger.severe("Could not execute sql $sql. No database connection established.") - } - } - - /** - * Creates or updates tables that needed an update. - */ - private fun performUpdate() { - for (table in needCreation) { - try { - var tableDef = "CREATE TABLE IF NOT EXISTS $table (" - - for (column in tables.find{it.first == table}!!.second) { - tableDef += "${column.first} ${column.second}," - } - tableDef = tableDef.substringBeforeLast(",") + ");" - chunkmaster.logger.info("Creating table $table with definition $tableDef") - executeStatement(tableDef, HashMap(), null) - } catch (e: Exception) { - chunkmaster.logger.severe("Error creating table $table.") - chunkmaster.logger.severe(e.message) - chunkmaster.logger.info(ExceptionUtils.getStackTrace(e)) - } - } - for (table in needUpdate) { - val updateSql = "ALTER TABLE ${table.first} ADD COLUMN ${table.second.first} ${table.second.second}" - try { - executeStatement(updateSql, HashMap(), null) - chunkmaster.logger.info("Updated table ${table.first} with sql $updateSql") - } catch (e: Exception) { - chunkmaster.logger.severe("Failed to update table ${table.first} with sql $updateSql") - chunkmaster.logger.severe(e.message) - chunkmaster.logger.info(ExceptionUtils.getStackTrace(e)) - } - } - } +package net.trivernis.chunkmaster.lib + +import net.trivernis.chunkmaster.Chunkmaster +import org.apache.commons.lang.exception.ExceptionUtils +import org.sqlite.SQLiteConnection +import java.lang.Exception +import java.sql.Connection +import java.sql.DriverManager +import java.sql.PreparedStatement +import java.sql.ResultSet + +class SqliteManager(private val chunkmaster: Chunkmaster) { + private val tables = listOf( + Pair( + "generation_tasks", + listOf( + Pair("id", "integer PRIMARY KEY AUTOINCREMENT"), + Pair("center_x", "integer NOT NULL DEFAULT 0"), + Pair("center_z", "integer NOT NULL DEFAULT 0"), + Pair("last_x", "integer NOT NULL DEFAULT 0"), + Pair("last_z", "integer NOT NULL DEFAULT 0"), + Pair("world", "text UNIQUE NOT NULL DEFAULT 'world'"), + Pair("stop_after", "integer DEFAULT -1") + ) + ) + ) + private val needUpdate = HashSet>>() + private val needCreation = HashSet() + + /** + * Returns the connection to the database + */ + fun getConnection(): Connection? { + try { + Class.forName("org.sqlite.JDBC") + return DriverManager.getConnection("jdbc:sqlite:${chunkmaster.dataFolder.absolutePath}/" + + "${chunkmaster.config.getString("database.filename")}") + } catch (e: Exception) { + chunkmaster.logger.severe("Could not get database connection.") + chunkmaster.logger.severe(e.message) + } + return null + } + + /** + * Checks for and performs an update + */ + fun init() { + this.checkUpdate() + this.performUpdate() + } + + /** + * Checks which tables need an update or creation. + */ + private fun checkUpdate() { + val meta = getConnection()!!.metaData + + for (table in tables) { + val resTables = meta.getTables(null, null, table.first, null) + + if (resTables.next()) { // table exists + for (column in table.second) { + val resColumn = meta.getColumns(null, null, table.first, column.first) + if (!resColumn.next()) { + needUpdate.add(Pair(table.first, column)) + } + resColumn.close() + } + } else { + needCreation.add(table.first) + } + resTables.close() + } + } + + /** + * Executes a sql statement on the database. + */ + fun executeStatement(sql: String, values: HashMap, callback: ((ResultSet) -> Unit)?) { + val connection = getConnection() + if (connection != null) { + try { + val statement = connection.prepareStatement(sql) + for (parameterValue in values) { + statement.setObject(parameterValue.key, parameterValue.value) + } + statement.execute() + val res = statement.resultSet + if (callback != null) { + callback(res) + } + statement.close() + } catch (e: Exception) { + chunkmaster.logger.severe("An error occured on sql $sql. ${e.message}") + chunkmaster.logger.info(ExceptionUtils.getStackTrace(e)) + } finally { + connection.close() + } + } else { + chunkmaster.logger.severe("Could not execute sql $sql. No database connection established.") + } + } + + /** + * Creates or updates tables that needed an update. + */ + private fun performUpdate() { + for (table in needCreation) { + try { + var tableDef = "CREATE TABLE IF NOT EXISTS $table (" + + for (column in tables.find{it.first == table}!!.second) { + tableDef += "${column.first} ${column.second}," + } + tableDef = tableDef.substringBeforeLast(",") + ");" + chunkmaster.logger.info("Creating table $table with definition $tableDef") + executeStatement(tableDef, HashMap(), null) + } catch (e: Exception) { + chunkmaster.logger.severe("Error creating table $table.") + chunkmaster.logger.severe(e.message) + chunkmaster.logger.info(ExceptionUtils.getStackTrace(e)) + } + } + for (table in needUpdate) { + val updateSql = "ALTER TABLE ${table.first} ADD COLUMN ${table.second.first} ${table.second.second}" + try { + executeStatement(updateSql, HashMap(), null) + chunkmaster.logger.info("Updated table ${table.first} with sql $updateSql") + } catch (e: Exception) { + chunkmaster.logger.severe("Failed to update table ${table.first} with sql $updateSql") + chunkmaster.logger.severe(e.message) + chunkmaster.logger.info(ExceptionUtils.getStackTrace(e)) + } + } + } } \ No newline at end of file diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/Subcommand.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/Subcommand.kt index 7341e30..a309d93 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/Subcommand.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/Subcommand.kt @@ -1,10 +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 +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/ChunkCoordinates.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/ChunkCoordinates.kt index e9a7fc4..1376d53 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/ChunkCoordinates.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/ChunkCoordinates.kt @@ -1,10 +1,10 @@ -package net.trivernis.chunkmaster.lib.generation - -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()) - } +package net.trivernis.chunkmaster.lib.generation + +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/GenerationManager.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationManager.kt index fc032eb..6a08d76 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationManager.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationManager.kt @@ -1,264 +1,264 @@ -package net.trivernis.chunkmaster.lib.generation - -import io.papermc.lib.PaperLib -import net.trivernis.chunkmaster.Chunkmaster -import org.bukkit.Server -import org.bukkit.World - -class GenerationManager(private val chunkmaster: Chunkmaster, private val server: 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 - - /** - * Adds a generation task - */ - fun addTask(world: World, stopAfter: Int = -1): Int { - val foundTask = allTasks.find { it.generationTask.world == world } - if (foundTask == null) { - val centerChunk = ChunkCoordinates(world.spawnLocation.chunk.x, world.spawnLocation.chunk.z) - val generationTask = createGenerationTask(world, centerChunk, centerChunk, stopAfter) - - chunkmaster.sqliteManager.executeStatement( - """ - INSERT INTO generation_tasks (center_x, center_z, last_x, last_z, world, stop_after) - values (?, ?, ?, ?, ?, ?) - """, - HashMap( - mapOf( - 1 to centerChunk.x, - 2 to centerChunk.z, - 3 to centerChunk.x, - 4 to centerChunk.z, - 5 to world.name, - 6 to stopAfter - ) - ), - null - ) - - var id = 0 - chunkmaster.sqliteManager.executeStatement( - """ - SELECT id FROM generation_tasks ORDER BY id DESC LIMIT 1 - """.trimIndent(), - HashMap() - ) { - it.next() - id = it.getInt("id") - } - - generationTask.onEndReached { - chunkmaster.logger.info("Task #${id} finished after ${it.count} chunks.") - removeTask(id) - } - - if (!paused) { - val task = server.scheduler.runTaskTimer( - chunkmaster, generationTask, 200, // 10 sec delay - chunkmaster.config.getLong("generation.period") - ) - tasks.add(RunningTaskEntry(id, task, generationTask)) - } else { - pausedTasks.add(PausedTaskEntry(id, generationTask)) - } - - return id - } else { - return foundTask.id - } - } - - /** - * Resumes a generation task - */ - private fun resumeTask( - world: World, - center: ChunkCoordinates, - last: ChunkCoordinates, - id: Int, - stopAfter: Int = -1 - ) { - if (!paused) { - chunkmaster.logger.info("Resuming chunk generation task for world \"${world.name}\"") - val generationTask = createGenerationTask(world, center, last, stopAfter) - val task = server.scheduler.runTaskTimer( - chunkmaster, generationTask, 200, // 10 sec delay - chunkmaster.config.getLong("generation.period") - ) - tasks.add(RunningTaskEntry(id, task, generationTask)) - generationTask.onEndReached { - chunkmaster.logger.info("Task #${id} finished after ${generationTask.count} chunks.") - removeTask(id) - } - } - } - - /** - * Stops a running generation task. - */ - fun removeTask(id: Int): Boolean { - val taskEntry: TaskEntry? = if (this.paused) { - this.pausedTasks.find { it.id == id } - } else { - this.tasks.find { it.id == id } - } - if (taskEntry != null) { - taskEntry.cancel() - chunkmaster.sqliteManager.executeStatement( - """ - DELETE FROM generation_tasks WHERE id = ?; - """.trimIndent(), - HashMap(mapOf(1 to taskEntry.id)), - null - ) - - if (taskEntry is RunningTaskEntry) { - if (taskEntry.task.isCancelled) { - tasks.remove(taskEntry) - } - } else if (taskEntry is PausedTaskEntry) { - pausedTasks.remove(taskEntry) - } - return true - } - return false - } - - /** - * Init - * Loads tasks from the database and resumes them - */ - fun init() { - chunkmaster.logger.info("Creating task to load chunk generation Tasks later...") - server.scheduler.runTaskTimer(chunkmaster, Runnable { - saveProgress() // save progress every 30 seconds - }, 600, 600) - server.scheduler.runTaskLater(chunkmaster, Runnable { - if (server.onlinePlayers.isEmpty()) { - startAll() // run startAll after 10 seconds if empty - } - }, 600) - } - - /** - * Stops all generation tasks - */ - fun stopAll() { - saveProgress() - val removalSet = HashSet() - for (task in tasks) { - task.generationTask.cancel() - task.task.cancel() - if (task.task.isCancelled) { - removalSet.add(task) - } - chunkmaster.logger.info("Canceled task #${task.id}") - } - tasks.removeAll(removalSet) - } - - /** - * Starts all generation tasks. - */ - fun startAll() { - chunkmaster.sqliteManager.executeStatement("SELECT * FROM generation_tasks", HashMap()) { - val res = it - while (res.next()) { - try { - val id = res.getInt("id") - val world = server.getWorld(res.getString("world")) - val center = ChunkCoordinates(res.getInt("center_x"), res.getInt("center_z")) - val last = ChunkCoordinates(res.getInt("last_x"), res.getInt("last_z")) - val stopAfter = res.getInt("stop_after") - if (this.tasks.find { it.id == id } == null) { - resumeTask(world!!, center, last, id, stopAfter) - } - } catch (error: NullPointerException) { - chunkmaster.logger.severe("Failed to load Task ${res.getInt("id")}.") - } - } - } - - if (tasks.isNotEmpty()) { - chunkmaster.logger.info("${tasks.size} saved tasks loaded.") - } - } - - /** - * Pauses all tasks - */ - fun pauseAll() { - paused = true - for (task in tasks) { - pausedTasks.add(PausedTaskEntry(task.id, task.generationTask)) - } - stopAll() - } - - /** - * Resumes all tasks - */ - fun resumeAll() { - paused = false - pausedTasks.clear() - startAll() - } - - /** - * Saves the task progress - */ - private fun saveProgress() { - for (task in tasks) { - try { - val genTask = task.generationTask - chunkmaster.logger.info( - """Task #${task.id} running for "${genTask.world.name}". - |Progress ${task.generationTask.count} chunks - |${if (task.generationTask.stopAfter > 0) "(${"%.2f".format( - (task.generationTask.count.toDouble() / - task.generationTask.stopAfter.toDouble()) * 100 - )}%)" else ""}. - | Speed: ${"%.1f".format(task.generationSpeed)} chunks/sec, - |Last Chunk: ${genTask.lastChunk.x}, ${genTask.lastChunk.z}""".trimMargin("|").replace('\n', ' ') - ) - chunkmaster.sqliteManager.executeStatement( - """ - UPDATE generation_tasks SET last_x = ?, last_z = ? - WHERE id = ? - """.trimIndent(), - HashMap(mapOf(1 to genTask.lastChunk.x, 2 to genTask.lastChunk.z, 3 to task.id)), - null - ) - } catch (error: Exception) { - chunkmaster.logger.warning("Exception when saving task progress ${error.message}") - } - } - } - - /** - * 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: ChunkCoordinates, - start: ChunkCoordinates, - stopAfter: Int - ): GenerationTask { - return if (PaperLib.isPaper()) { - GenerationTaskPaper(chunkmaster, world, center, start, stopAfter) - } else { - GenerationTaskSpigot(chunkmaster, world, center, start, stopAfter) - } - } +package net.trivernis.chunkmaster.lib.generation + +import io.papermc.lib.PaperLib +import net.trivernis.chunkmaster.Chunkmaster +import org.bukkit.Server +import org.bukkit.World + +class GenerationManager(private val chunkmaster: Chunkmaster, private val server: 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 + + /** + * Adds a generation task + */ + fun addTask(world: World, stopAfter: Int = -1): Int { + val foundTask = allTasks.find { it.generationTask.world == world } + if (foundTask == null) { + val centerChunk = ChunkCoordinates(world.spawnLocation.chunk.x, world.spawnLocation.chunk.z) + val generationTask = createGenerationTask(world, centerChunk, centerChunk, stopAfter) + + chunkmaster.sqliteManager.executeStatement( + """ + INSERT INTO generation_tasks (center_x, center_z, last_x, last_z, world, stop_after) + values (?, ?, ?, ?, ?, ?) + """, + HashMap( + mapOf( + 1 to centerChunk.x, + 2 to centerChunk.z, + 3 to centerChunk.x, + 4 to centerChunk.z, + 5 to world.name, + 6 to stopAfter + ) + ), + null + ) + + var id = 0 + chunkmaster.sqliteManager.executeStatement( + """ + SELECT id FROM generation_tasks ORDER BY id DESC LIMIT 1 + """.trimIndent(), + HashMap() + ) { + it.next() + id = it.getInt("id") + } + + generationTask.onEndReached { + chunkmaster.logger.info("Task #${id} finished after ${it.count} chunks.") + removeTask(id) + } + + if (!paused) { + val task = server.scheduler.runTaskTimer( + chunkmaster, generationTask, 200, // 10 sec delay + chunkmaster.config.getLong("generation.period") + ) + tasks.add(RunningTaskEntry(id, task, generationTask)) + } else { + pausedTasks.add(PausedTaskEntry(id, generationTask)) + } + + return id + } else { + return foundTask.id + } + } + + /** + * Resumes a generation task + */ + private fun resumeTask( + world: World, + center: ChunkCoordinates, + last: ChunkCoordinates, + id: Int, + stopAfter: Int = -1 + ) { + if (!paused) { + chunkmaster.logger.info("Resuming chunk generation task for world \"${world.name}\"") + val generationTask = createGenerationTask(world, center, last, stopAfter) + val task = server.scheduler.runTaskTimer( + chunkmaster, generationTask, 200, // 10 sec delay + chunkmaster.config.getLong("generation.period") + ) + tasks.add(RunningTaskEntry(id, task, generationTask)) + generationTask.onEndReached { + chunkmaster.logger.info("Task #${id} finished after ${generationTask.count} chunks.") + removeTask(id) + } + } + } + + /** + * Stops a running generation task. + */ + fun removeTask(id: Int): Boolean { + val taskEntry: TaskEntry? = if (this.paused) { + this.pausedTasks.find { it.id == id } + } else { + this.tasks.find { it.id == id } + } + if (taskEntry != null) { + taskEntry.cancel() + chunkmaster.sqliteManager.executeStatement( + """ + DELETE FROM generation_tasks WHERE id = ?; + """.trimIndent(), + HashMap(mapOf(1 to taskEntry.id)), + null + ) + + if (taskEntry is RunningTaskEntry) { + if (taskEntry.task.isCancelled) { + tasks.remove(taskEntry) + } + } else if (taskEntry is PausedTaskEntry) { + pausedTasks.remove(taskEntry) + } + return true + } + return false + } + + /** + * Init + * Loads tasks from the database and resumes them + */ + fun init() { + chunkmaster.logger.info("Creating task to load chunk generation Tasks later...") + server.scheduler.runTaskTimer(chunkmaster, Runnable { + saveProgress() // save progress every 30 seconds + }, 600, 600) + server.scheduler.runTaskLater(chunkmaster, Runnable { + if (server.onlinePlayers.isEmpty()) { + startAll() // run startAll after 10 seconds if empty + } + }, 600) + } + + /** + * Stops all generation tasks + */ + fun stopAll() { + saveProgress() + val removalSet = HashSet() + for (task in tasks) { + task.generationTask.cancel() + task.task.cancel() + if (task.task.isCancelled) { + removalSet.add(task) + } + chunkmaster.logger.info("Canceled task #${task.id}") + } + tasks.removeAll(removalSet) + } + + /** + * Starts all generation tasks. + */ + fun startAll() { + chunkmaster.sqliteManager.executeStatement("SELECT * FROM generation_tasks", HashMap()) { + val res = it + while (res.next()) { + try { + val id = res.getInt("id") + val world = server.getWorld(res.getString("world")) + val center = ChunkCoordinates(res.getInt("center_x"), res.getInt("center_z")) + val last = ChunkCoordinates(res.getInt("last_x"), res.getInt("last_z")) + val stopAfter = res.getInt("stop_after") + if (this.tasks.find { it.id == id } == null) { + resumeTask(world!!, center, last, id, stopAfter) + } + } catch (error: NullPointerException) { + chunkmaster.logger.severe("Failed to load Task ${res.getInt("id")}.") + } + } + } + + if (tasks.isNotEmpty()) { + chunkmaster.logger.info("${tasks.size} saved tasks loaded.") + } + } + + /** + * Pauses all tasks + */ + fun pauseAll() { + paused = true + for (task in tasks) { + pausedTasks.add(PausedTaskEntry(task.id, task.generationTask)) + } + stopAll() + } + + /** + * Resumes all tasks + */ + fun resumeAll() { + paused = false + pausedTasks.clear() + startAll() + } + + /** + * Saves the task progress + */ + private fun saveProgress() { + for (task in tasks) { + try { + val genTask = task.generationTask + chunkmaster.logger.info( + """Task #${task.id} running for "${genTask.world.name}". + |Progress ${task.generationTask.count} chunks + |${if (task.generationTask.stopAfter > 0) "(${"%.2f".format( + (task.generationTask.count.toDouble() / + task.generationTask.stopAfter.toDouble()) * 100 + )}%)" else ""}. + | Speed: ${"%.1f".format(task.generationSpeed)} chunks/sec, + |Last Chunk: ${genTask.lastChunk.x}, ${genTask.lastChunk.z}""".trimMargin("|").replace('\n', ' ') + ) + chunkmaster.sqliteManager.executeStatement( + """ + UPDATE generation_tasks SET last_x = ?, last_z = ? + WHERE id = ? + """.trimIndent(), + HashMap(mapOf(1 to genTask.lastChunk.x, 2 to genTask.lastChunk.z, 3 to task.id)), + null + ) + } catch (error: Exception) { + chunkmaster.logger.warning("Exception when saving task progress ${error.message}") + } + } + } + + /** + * 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: ChunkCoordinates, + start: ChunkCoordinates, + 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/generation/GenerationTask.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTask.kt index fe4f032..d089772 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTask.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTask.kt @@ -1,64 +1,66 @@ -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 - -/** - * Interface for generation tasks. - */ -abstract class GenerationTask(plugin: Chunkmaster, centerChunk: ChunkCoordinates, startChunk: ChunkCoordinates) : - Runnable { - - abstract val stopAfter: Int - abstract val world: World - abstract val count: Int - 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.chunk-skips-per-step") - protected val msptThreshold = plugin.config.getLong("generation.mspt-pause-threshold") - protected val maxLoadedChunks = plugin.config.getInt("generation.max-loaded-chunks") - protected val chunksPerStep = plugin.config.getInt("generation.chunks-per-step") - - protected var endReachedCallback: ((GenerationTask) -> Unit)? = null - private set - - abstract override fun run() - abstract fun cancel() - - val nextChunkCoordinates: ChunkCoordinates - get() { - val nextChunkCoords = spiral.next() - return ChunkCoordinates(nextChunkCoords.first, nextChunkCoords.second) - } - - val lastChunk: Chunk - get() { - return world.getChunkAt(lastChunkCoords.x, lastChunkCoords.z) - } - - 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(lastChunkCoords.getCenterLocation(world)) || (stopAfter in 1..count) - } - - /** - * Registers end reached callback - */ - fun onEndReached(cb: (GenerationTask) -> Unit) { - endReachedCallback = cb - } +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 + +/** + * Interface for generation tasks. + */ +abstract class GenerationTask(plugin: Chunkmaster, centerChunk: ChunkCoordinates, startChunk: ChunkCoordinates) : + Runnable { + + abstract val stopAfter: Int + abstract val world: World + abstract val count: Int + 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.chunk-skips-per-step") + protected val msptThreshold = plugin.config.getLong("generation.mspt-pause-threshold") + protected val maxLoadedChunks = plugin.config.getInt("generation.max-loaded-chunks") + protected val chunksPerStep = plugin.config.getInt("generation.chunks-per-step") + protected val ignoreWorldborder = plugin.config.getBoolean("generation.ignore-worldborder") + + protected var endReachedCallback: ((GenerationTask) -> Unit)? = null + private set + + abstract override fun run() + abstract fun cancel() + + val nextChunkCoordinates: ChunkCoordinates + get() { + val nextChunkCoords = spiral.next() + return ChunkCoordinates(nextChunkCoords.first, nextChunkCoords.second) + } + + val lastChunk: Chunk + get() { + return world.getChunkAt(lastChunkCoords.x, lastChunkCoords.z) + } + + 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(lastChunkCoords.getCenterLocation(world)) && !ignoreWorldborder) + || (stopAfter in 1..count) + } + + /** + * Registers end reached callback + */ + fun onEndReached(cb: (GenerationTask) -> 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 9c7ef53..7342df1 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskPaper.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskPaper.kt @@ -1,117 +1,116 @@ -package net.trivernis.chunkmaster.lib.generation - -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: ChunkCoordinates, private val startChunk: ChunkCoordinates, - 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 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 > maxLoadedChunks) { - for (chunk in loadedChunks) { - if (chunk.isLoaded) { - chunk.unload(true) - } - } - loadedChunks.clear() - } else if (pendingChunks.size < maxPendingChunks) { // if more than 10 chunks are pending, wait. - if (borderReached()) { - endReached = true - endReachedCallback?.invoke(this) - return - } - - var chunk = nextChunkCoordinates - for (i in 1 until chunkSkips) { - if (PaperLib.isChunkGenerated(world, chunk.x, chunk.z)) { - chunk = nextChunkCoordinates - } else { - break - } - } - - if (!PaperLib.isChunkGenerated(world, chunk.x, chunk.z)) { - for (i in 0 until minOf(chunksPerStep, (stopAfter - count) - 1)) { - if (!PaperLib.isChunkGenerated(world, chunk.x, chunk.z)) { - pendingChunks.add(PaperLib.getChunkAtAsync(world, chunk.x, chunk.z, true)) - } - chunk = nextChunkCoordinates - } - if (!PaperLib.isChunkGenerated(world, chunk.x, chunk.z)) { - pendingChunks.add(PaperLib.getChunkAtAsync(world, chunk.x, chunk.z, true)) - } - } - lastChunkCoords = 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() { - unloadAllChunks() - } - - /** - * Cancels all pending chunks and unloads all loaded chunks. - */ - fun unloadAllChunks() { - for (pendingChunk in pendingChunks) { - if (pendingChunk.isDone) { - loadedChunks.add(pendingChunk.get()) - } else { - pendingChunk.cancel(true) - } - } - pendingChunks.clear() - if (loadedChunks.isNotEmpty()) { - lastChunkCoords = ChunkCoordinates(loadedChunks.last().x, loadedChunks.last().z) - } - 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) - } +package net.trivernis.chunkmaster.lib.generation + +import net.trivernis.chunkmaster.Chunkmaster +import org.bukkit.Chunk +import org.bukkit.World +import java.util.concurrent.CompletableFuture + +class GenerationTaskPaper( + private val plugin: Chunkmaster, override val world: World, + centerChunk: ChunkCoordinates, private val startChunk: ChunkCoordinates, + 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 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 > maxLoadedChunks) { + for (chunk in loadedChunks) { + if (chunk.isLoaded) { + chunk.unload(true) + } + } + loadedChunks.clear() + } else if (pendingChunks.size < maxPendingChunks) { // if more than 10 chunks are pending, wait. + if (borderReached()) { + endReached = true + endReachedCallback?.invoke(this) + return + } + + var chunk = nextChunkCoordinates + for (i in 1 until chunkSkips) { + if (world.isChunkGenerated(chunk.x, chunk.z)) { + chunk = nextChunkCoordinates + } else { + break + } + } + + if (!world.isChunkGenerated(chunk.x, chunk.z)) { + for (i in 0 until minOf(chunksPerStep, (stopAfter - count) - 1)) { + if (!world.isChunkGenerated(chunk.x, chunk.z)) { + pendingChunks.add(world.getChunkAtAsync(chunk.x, chunk.z, true)) + } + chunk = nextChunkCoordinates + } + if (!world.isChunkGenerated(chunk.x, chunk.z)) { + pendingChunks.add(world.getChunkAtAsync(chunk.x, chunk.z, true)) + } + } + lastChunkCoords = 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() { + unloadAllChunks() + } + + /** + * Cancels all pending chunks and unloads all loaded chunks. + */ + fun unloadAllChunks() { + for (pendingChunk in pendingChunks) { + if (pendingChunk.isDone) { + loadedChunks.add(pendingChunk.get()) + } else { + pendingChunk.cancel(true) + } + } + pendingChunks.clear() + if (loadedChunks.isNotEmpty()) { + lastChunkCoords = ChunkCoordinates(loadedChunks.last().x, loadedChunks.last().z) + } + 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/generation/GenerationTaskSpigot.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskSpigot.kt index 2ff3485..cb0f9b1 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskSpigot.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskSpigot.kt @@ -1,70 +1,69 @@ -package net.trivernis.chunkmaster.lib.generation - -import net.trivernis.chunkmaster.Chunkmaster -import org.bukkit.Chunk -import org.bukkit.World - -class GenerationTaskSpigot( - private val plugin: Chunkmaster, override val world: World, - centerChunk: ChunkCoordinates, private val startChunk: ChunkCoordinates, - override val stopAfter: Int = -1 -) : GenerationTask(plugin, centerChunk, startChunk) { - - - override var count = 0 - 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 > maxLoadedChunks) { - for (chunk in loadedChunks) { - if (chunk.isLoaded) { - chunk.unload(true) - } - } - loadedChunks.clear() - } else { - if (borderReached()) { - endReached = true - endReachedCallback?.invoke(this) - return - } - - var chunk = nextChunkCoordinates - - if (!world.isChunkGenerated(chunk.x, chunk.z)) { - for (i in 0 until minOf(chunksPerStep, stopAfter - count)) { - val chunkInstance = world.getChunkAt(chunk.x, chunk.z) - chunkInstance.load(true) - loadedChunks.add(chunkInstance) - chunk = nextChunkCoordinates - } - val chunkInstance = world.getChunkAt(chunk.x, chunk.z) - chunkInstance.load(true) - loadedChunks.add(chunkInstance) - } - lastChunkCoords = 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) - } - } - } +package net.trivernis.chunkmaster.lib.generation + +import net.trivernis.chunkmaster.Chunkmaster +import org.bukkit.World + +class GenerationTaskSpigot( + private val plugin: Chunkmaster, override val world: World, + centerChunk: ChunkCoordinates, private val startChunk: ChunkCoordinates, + override val stopAfter: Int = -1 +) : GenerationTask(plugin, centerChunk, startChunk) { + + + override var count = 0 + 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 > maxLoadedChunks) { + for (chunk in loadedChunks) { + if (chunk.isLoaded) { + chunk.unload(true) + } + } + loadedChunks.clear() + } else { + if (borderReached()) { + endReached = true + endReachedCallback?.invoke(this) + return + } + + var chunk = nextChunkCoordinates + + if (!world.isChunkGenerated(chunk.x, chunk.z)) { + for (i in 0 until minOf(chunksPerStep, stopAfter - count)) { + val chunkInstance = world.getChunkAt(chunk.x, chunk.z) + chunkInstance.load(true) + loadedChunks.add(chunkInstance) + chunk = nextChunkCoordinates + } + val chunkInstance = world.getChunkAt(chunk.x, chunk.z) + chunkInstance.load(true) + loadedChunks.add(chunkInstance) + } + lastChunkCoords = 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 diff --git a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/PausedTaskEntry.kt b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/PausedTaskEntry.kt index 90b7736..e8a752e 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/PausedTaskEntry.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/PausedTaskEntry.kt @@ -1,10 +1,10 @@ -package net.trivernis.chunkmaster.lib.generation - -class PausedTaskEntry( - override val id: Int, - override val generationTask: GenerationTask -) : TaskEntry { - override fun cancel() { - generationTask.cancel() - } +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 index cc4c294..a5f35c0 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/RunningTaskEntry.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/RunningTaskEntry.kt @@ -1,37 +1,37 @@ -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 { - - private var lastProgress: Pair? = null - - /** - * Returns the generation Speed - */ - val generationSpeed: Double? - get() { - var generationSpeed: Double? = null - if (lastProgress != null) { - val chunkDiff = generationTask.count - lastProgress!!.second - val timeDiff = (System.currentTimeMillis() - lastProgress!!.first).toDouble()/1000 - generationSpeed = chunkDiff.toDouble()/timeDiff - } - lastProgress = Pair(System.currentTimeMillis(), generationTask.count) - return generationSpeed - } - - init { - lastProgress = Pair(System.currentTimeMillis(), generationTask.count) - } - - - override fun cancel() { - task.cancel() - generationTask.cancel() - } +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 { + + private var lastProgress: Pair? = null + + /** + * Returns the generation Speed + */ + val generationSpeed: Double? + get() { + var generationSpeed: Double? = null + if (lastProgress != null) { + val chunkDiff = generationTask.count - lastProgress!!.second + val timeDiff = (System.currentTimeMillis() - lastProgress!!.first).toDouble()/1000 + generationSpeed = chunkDiff.toDouble()/timeDiff + } + lastProgress = Pair(System.currentTimeMillis(), generationTask.count) + return generationSpeed + } + + init { + lastProgress = Pair(System.currentTimeMillis(), generationTask.count) + } + + + 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 cf6b135..47eda34 100644 --- a/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/TaskEntry.kt +++ b/src/main/kotlin/net/trivernis/chunkmaster/lib/generation/TaskEntry.kt @@ -1,13 +1,13 @@ -package net.trivernis.chunkmaster.lib.generation - -import org.bukkit.scheduler.BukkitTask - -/** - * Generic task entry - */ -interface TaskEntry { - val id: Int - val generationTask: GenerationTask - - fun cancel() +package net.trivernis.chunkmaster.lib.generation + +import org.bukkit.scheduler.BukkitTask + +/** + * Generic task entry + */ +interface TaskEntry { + val id: Int + val generationTask: GenerationTask + + fun cancel() } \ No newline at end of file diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml index bcd774a..c63905a 100644 --- a/src/main/resources/plugin.yml +++ b/src/main/resources/plugin.yml @@ -1,58 +1,58 @@ -main: net.trivernis.chunkmaster.Chunkmaster -name: Chunkmaster -version: '0.13-beta' -description: Chunk commands plugin. -author: Trivernis -website: trivernis.net -api-version: '1.14' -commands: - chunkmaster: - description: Main command - permission: chunkmaster.chunkmaster - usage: | - / generate [, ] - generates chunks starting from the spawn until the chunk-count is reached - / cancel - cancels the generation task with the task-id - / list - lists all running and paused generation tasks - / pause - pauses all generation tasks - / resume - resumes all generation tasks - / reload - reloads the configuration and restarts all tasks - / tpchunk - teleports you to the chunk with the given chunk coordinates - aliases: - - chm - - chunkm - - cmaster -permissions: - cunkmaster.generate: - description: Allows the generate subcommand. - default: op - chunkmaster.list: - description: Allows the list subcommand. - default: op - chunkmaster.cancel: - description: Allows the remove subcommand. - default: op - chunkmaster.pause: - description: Allows the pause subcommand. - default: op - chunkmaster.resume: - description: Allows the resume subcommand. - default: op - chunkmaster.reload: - description: Allows the reload subcommand. - default: op - chunkmaster.tpchunk: - description: Allows the tpchunk subcommand. - default: op - chunkmaster.chunkmaster: - description: Allows Chunkmaster commands. - default: op - chunkmaster.*: - description: Wildcard permission - default: op - children: - - chunkmaster.generate - - chunkmaster.listgentasks - - chunkmaster.removegentask - - chunkmaster.pausegentasks - - chunkmaster.resumegentasks +main: net.trivernis.chunkmaster.Chunkmaster +name: Chunkmaster +version: '0.13-beta' +description: Chunk commands plugin. +author: Trivernis +website: trivernis.net +api-version: '1.14' +commands: + chunkmaster: + description: Main command + permission: chunkmaster.chunkmaster + usage: | + / generate [, ] - generates chunks starting from the spawn until the chunk-count is reached + / cancel - cancels the generation task with the task-id + / list - lists all running and paused generation tasks + / pause - pauses all generation tasks + / resume - resumes all generation tasks + / reload - reloads the configuration and restarts all tasks + / tpchunk - teleports you to the chunk with the given chunk coordinates + aliases: + - chm + - chunkm + - cmaster +permissions: + cunkmaster.generate: + description: Allows the generate subcommand. + default: op + chunkmaster.list: + description: Allows the list subcommand. + default: op + chunkmaster.cancel: + description: Allows the remove subcommand. + default: op + chunkmaster.pause: + description: Allows the pause subcommand. + default: op + chunkmaster.resume: + description: Allows the resume subcommand. + default: op + chunkmaster.reload: + description: Allows the reload subcommand. + default: op + chunkmaster.tpchunk: + description: Allows the tpchunk subcommand. + default: op + chunkmaster.chunkmaster: + description: Allows Chunkmaster commands. + default: op + chunkmaster.*: + description: Wildcard permission + default: op + children: + - chunkmaster.generate + - chunkmaster.listgentasks + - chunkmaster.removegentask + - chunkmaster.pausegentasks + - chunkmaster.resumegentasks - chunkmaster.chunkmaster \ No newline at end of file