commit 574098a06a748b76ec99e91abb45421c12270dcf Author: UrAvgCode Date: Tue Sep 9 23:50:59 2025 +0200 initial commit diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..1ef705a --- /dev/null +++ b/.editorconfig @@ -0,0 +1,19 @@ +# https://editorconfig.org +root = true + +[*] +indent_style = space +indent_size = 2 +max_line_length = 140 + +charset = utf-8 +end_of_line = lf +trim_trailing_whitespace = true +insert_final_newline = true + +[*.{java,kt,kts,xml,gradle}] +indent_size = 4 + +[*.md] +trim_trailing_whitespace = false +max_line_length = unset diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml new file mode 100644 index 0000000..55f3cec --- /dev/null +++ b/.github/workflows/gradle.yml @@ -0,0 +1,33 @@ +name: gradle build + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: read + + steps: + - uses: actions/checkout@v5 + - name: setup java + uses: actions/setup-java@v5 + with: + java-version: '21' + distribution: 'temurin' + + - name: setup gradle + uses: gradle/actions/setup-gradle@v4 + + - name: build + run: ./gradlew build + + - name: upload release apk + uses: actions/upload-artifact@v4 + with: + name: build + path: build/libs/*.jar diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e569c07 --- /dev/null +++ b/.gitignore @@ -0,0 +1,26 @@ +# class file +*.class + +# log file +*.log + +# package files # +*.jar +*.war +*.nar +*.ear +*.zip +*.tar.gz +*.rar + +# gradle +.gradle/ +**/build/ +!**/src/**/build/ +gradle-app.setting +.gradletasknamecache +!gradle-wrapper.properties +!gradle-wrapper.jar + +# intellij +.idea/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f72b464 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Global Whitelist + +**Global Whitelist** is a lightweight Velocity plugin that brings whitelist functionality to your proxy network. It +supports all the standard whitelist commands and uses the same `whitelist.json` format as vanilla Minecraft servers. +This means you can easily migrate your existing whitelists. + +## Commands & Permissions + +| Command | Description | Permission | +|------------------------------------|---------------------------------------------------------------------------------|-------------------------| +| `/globalwhitelist add ` | Add a player to the whitelist | `globalwhitelist` | +| `/globalwhitelist remove ` | Remove a player from the whitelist | `globalwhitelist` | +| `/globalwhitelist list` | Displays all players in the whitelist | `globalwhitelist` | +| `/globalwhitelist on` | Enable the whitelist | `globalwhitelist.admin` | +| `/globalwhitelist off` | Disable the whitelist | `globalwhitelist.admin` | +| `/globalwhitelist enforced` | Enforce the whitelist. Players not on the whitelist (if enabled) will be kicked | `globalwhitelist.admin` | +| `/globalwhitelist unenforced` | Disable enforcement. Players not on the whitelist will not be kicked | `globalwhitelist.admin` | +| `/globalwhitelist reload` | Reload the whitelist configuration | `globalwhitelist.admin` | diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..17fee37 --- /dev/null +++ b/build.gradle @@ -0,0 +1,54 @@ +plugins { + id 'java' + id 'org.jetbrains.gradle.plugin.idea-ext' version '1.3' + id("xyz.jpenilla.run-velocity") version "2.3.1" +} + +group = 'com.uravgcode' +version = '1.0' + +repositories { + mavenCentral() + maven { + name = "papermc-repo" + url = "https://repo.papermc.io/repository/maven-public/" + } +} + +dependencies { + compileOnly("com.velocitypowered:velocity-api:3.4.0-SNAPSHOT") + annotationProcessor("com.velocitypowered:velocity-api:3.4.0-SNAPSHOT") + + implementation("com.google.code.gson:gson:2.13.1") +} + +tasks { + runVelocity { + velocityVersion("3.4.0-SNAPSHOT") + } +} + +def targetJavaVersion = 21 +java { + toolchain.languageVersion = JavaLanguageVersion.of(targetJavaVersion) +} + +tasks.withType(JavaCompile).configureEach { + options.encoding = 'UTF-8' + options.release.set(targetJavaVersion) +} + +def templateSource = file('src/main/templates') +def templateDest = layout.buildDirectory.dir('generated/sources/templates') +def generateTemplates = tasks.register('generateTemplates', Copy) { task -> + def props = ['version': project.version] + task.inputs.properties props + + task.from templateSource + task.into templateDest + task.expand props +} + +sourceSets.main.java.srcDir(generateTemplates.map { it.outputs }) + +project.idea.project.settings.taskTriggers.afterSync generateTemplates diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..0536f34 --- /dev/null +++ b/gradle.properties @@ -0,0 +1 @@ +javaVersion=21 diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..8bdaf60 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..3e781fb --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,8 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionSha256Sum=8fad3d78296ca518113f3d29016617c7f9367dc005f932bd9d93bf45ba46072b +distributionUrl=https\://services.gradle.org/distributions/gradle-9.0.0-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..ef07e01 --- /dev/null +++ b/gradlew @@ -0,0 +1,251 @@ +#!/bin/sh + +# +# Copyright © 2015 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH="\\\"\\\"" + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..db3a6ac --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,94 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH= + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..e42eb8c --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'global-whitelist' diff --git a/src/main/java/com/uravgcode/globalwhitelist/GlobalWhitelistPlugin.java b/src/main/java/com/uravgcode/globalwhitelist/GlobalWhitelistPlugin.java new file mode 100644 index 0000000..b8db011 --- /dev/null +++ b/src/main/java/com/uravgcode/globalwhitelist/GlobalWhitelistPlugin.java @@ -0,0 +1,80 @@ +package com.uravgcode.globalwhitelist; + +import com.google.inject.Inject; +import com.uravgcode.globalwhitelist.command.WhitelistCommand; +import com.uravgcode.globalwhitelist.config.MessagesConfig; +import com.uravgcode.globalwhitelist.config.WhitelistConfig; +import com.uravgcode.globalwhitelist.service.MinecraftProfileService; +import com.uravgcode.globalwhitelist.whitelist.PlayerProfile; +import com.uravgcode.globalwhitelist.whitelist.Whitelist; +import com.velocitypowered.api.event.ResultedEvent; +import com.velocitypowered.api.event.Subscribe; +import com.velocitypowered.api.event.connection.LoginEvent; +import com.velocitypowered.api.event.proxy.ProxyInitializeEvent; +import com.velocitypowered.api.plugin.Plugin; +import com.velocitypowered.api.plugin.annotation.DataDirectory; +import com.velocitypowered.api.proxy.ProxyServer; +import org.slf4j.Logger; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; + +@Plugin( + id = "global-whitelist", + name = "global-whitelist", + version = BuildConstants.VERSION, + url = "https://github.com/uravgcode/global-whitelist", + description = "velocity whitelist plugin", + authors = {"UrAvgCode"} +) +public class GlobalWhitelistPlugin { + private final ProxyServer proxy; + private final MinecraftProfileService profileService; + + private final Whitelist whitelist; + private final WhitelistConfig config; + private final MessagesConfig messages; + + @Inject + public GlobalWhitelistPlugin(ProxyServer server, Logger logger, @DataDirectory Path dataDirectory) { + this.proxy = server; + this.profileService = new MinecraftProfileService(logger); + + this.whitelist = new Whitelist(dataDirectory.resolve("whitelist.json"), logger); + this.config = new WhitelistConfig(dataDirectory.resolve("config.properties"), logger); + this.messages = new MessagesConfig(dataDirectory.resolve("messages.properties"), logger); + + try { + Files.createDirectories(dataDirectory); + } catch (IOException e) { + logger.error("failed to create plugin directory: {}", e.getMessage()); + } + } + + @Subscribe + public void onProxyInitialization(ProxyInitializeEvent event) { + config.reload(); + whitelist.reload(); + messages.reload(); + + proxy.getEventManager().register(this, LoginEvent.class, loginEvent -> { + if (!config.whitelistEnabled()) { + return; + } + + var player = loginEvent.getPlayer(); + if (!whitelist.contains(new PlayerProfile(player.getUniqueId(), player.getUsername()))) { + loginEvent.setResult(ResultedEvent.ComponentResult.denied(messages.getMessage(MessagesConfig.WHITELIST_REJECTED))); + } + }); + + var commandManager = proxy.getCommandManager(); + var commandMeta = commandManager.metaBuilder("gwl") + .plugin(this) + .build(); + + var command = WhitelistCommand.createBrigadierCommand(proxy, profileService, whitelist, config, messages); + commandManager.register(commandMeta, command); + } +} diff --git a/src/main/java/com/uravgcode/globalwhitelist/command/WhitelistCommand.java b/src/main/java/com/uravgcode/globalwhitelist/command/WhitelistCommand.java new file mode 100644 index 0000000..3960acf --- /dev/null +++ b/src/main/java/com/uravgcode/globalwhitelist/command/WhitelistCommand.java @@ -0,0 +1,94 @@ +package com.uravgcode.globalwhitelist.command; + +import com.mojang.brigadier.arguments.StringArgumentType; +import com.mojang.brigadier.builder.LiteralArgumentBuilder; +import com.mojang.brigadier.tree.LiteralCommandNode; +import com.uravgcode.globalwhitelist.config.MessagesConfig; +import com.uravgcode.globalwhitelist.config.WhitelistConfig; +import com.uravgcode.globalwhitelist.service.MinecraftProfileService; +import com.uravgcode.globalwhitelist.whitelist.Whitelist; +import com.velocitypowered.api.command.BrigadierCommand; +import com.velocitypowered.api.command.CommandSource; +import com.velocitypowered.api.proxy.ProxyServer; + +public final class WhitelistCommand { + private static final String PERMISSION_BASE = "globalwhitelist"; + private static final String PERMISSION_ADMIN = "globalwhitelist.admin"; + + public static BrigadierCommand createBrigadierCommand( + final ProxyServer proxy, + final MinecraftProfileService profileService, + final Whitelist whitelist, + final WhitelistConfig config, + final MessagesConfig messages + ) { + var commandHandler = new WhitelistCommandHandler(proxy, profileService, whitelist, config, messages); + + LiteralCommandNode helloNode = BrigadierCommand.literalArgumentBuilder("globalwhitelist") + .requires(source -> source.hasPermission(PERMISSION_BASE) || source.hasPermission(PERMISSION_ADMIN)) + .executes(commandHandler::help) + .then(buildAddCommand(commandHandler)) + .then(buildRemoveCommand(commandHandler)) + .then(buildListCommand(commandHandler)) + .then(buildReloadCommand(commandHandler)) + .then(buildOnCommand(commandHandler)) + .then(buildOffCommand(commandHandler)) + .then(buildEnforcedCommand(commandHandler)) + .then(buildUnenforcedCommand(commandHandler)) + .build(); + + return new BrigadierCommand(helloNode); + } + + private static LiteralArgumentBuilder buildAddCommand(WhitelistCommandHandler handler) { + return BrigadierCommand.literalArgumentBuilder("add") + .requires(source -> source.hasPermission(PERMISSION_BASE)) + .then(BrigadierCommand.requiredArgumentBuilder("player", StringArgumentType.word()) + .suggests(handler::suggestOnlinePlayers) + .executes(handler::add)); + } + + private static LiteralArgumentBuilder buildRemoveCommand(WhitelistCommandHandler handler) { + return BrigadierCommand.literalArgumentBuilder("remove") + .requires(source -> source.hasPermission(PERMISSION_BASE)) + .then(BrigadierCommand.requiredArgumentBuilder("player", StringArgumentType.word()) + .suggests(handler::suggestWhitelistedPlayers) + .executes(handler::remove)); + } + + private static LiteralArgumentBuilder buildListCommand(WhitelistCommandHandler handler) { + return BrigadierCommand.literalArgumentBuilder("list") + .requires(source -> source.hasPermission(PERMISSION_BASE)) + .executes(handler::list); + } + + private static LiteralArgumentBuilder buildOnCommand(WhitelistCommandHandler handler) { + return BrigadierCommand.literalArgumentBuilder("on") + .requires(source -> source.hasPermission(PERMISSION_ADMIN)) + .executes(handler::on); + } + + private static LiteralArgumentBuilder buildOffCommand(WhitelistCommandHandler handler) { + return BrigadierCommand.literalArgumentBuilder("off") + .requires(source -> source.hasPermission(PERMISSION_ADMIN)) + .executes(handler::off); + } + + private static LiteralArgumentBuilder buildEnforcedCommand(WhitelistCommandHandler handler) { + return BrigadierCommand.literalArgumentBuilder("enforced") + .requires(source -> source.hasPermission(PERMISSION_ADMIN)) + .executes(handler::enforced); + } + + private static LiteralArgumentBuilder buildUnenforcedCommand(WhitelistCommandHandler handler) { + return BrigadierCommand.literalArgumentBuilder("unenforced") + .requires(source -> source.hasPermission(PERMISSION_ADMIN)) + .executes(handler::unenforced); + } + + private static LiteralArgumentBuilder buildReloadCommand(WhitelistCommandHandler handler) { + return BrigadierCommand.literalArgumentBuilder("reload") + .requires(source -> source.hasPermission(PERMISSION_ADMIN)) + .executes(handler::reload); + } +} diff --git a/src/main/java/com/uravgcode/globalwhitelist/command/WhitelistCommandHandler.java b/src/main/java/com/uravgcode/globalwhitelist/command/WhitelistCommandHandler.java new file mode 100644 index 0000000..d51d00d --- /dev/null +++ b/src/main/java/com/uravgcode/globalwhitelist/command/WhitelistCommandHandler.java @@ -0,0 +1,174 @@ +package com.uravgcode.globalwhitelist.command; + +import com.mojang.brigadier.Command; +import com.mojang.brigadier.context.CommandContext; +import com.mojang.brigadier.suggestion.Suggestions; +import com.mojang.brigadier.suggestion.SuggestionsBuilder; +import com.uravgcode.globalwhitelist.config.MessagesConfig; +import com.uravgcode.globalwhitelist.config.WhitelistConfig; +import com.uravgcode.globalwhitelist.service.MinecraftProfileService; +import com.uravgcode.globalwhitelist.whitelist.PlayerProfile; +import com.uravgcode.globalwhitelist.whitelist.Whitelist; +import com.velocitypowered.api.command.CommandSource; +import com.velocitypowered.api.proxy.ProxyServer; + +import java.util.concurrent.CompletableFuture; + +public class WhitelistCommandHandler { + private final ProxyServer proxy; + private final MinecraftProfileService profileService; + + private final Whitelist whitelist; + private final WhitelistConfig config; + private final MessagesConfig messages; + + public WhitelistCommandHandler( + final ProxyServer proxy, + final MinecraftProfileService profileService, + final Whitelist whitelist, + final WhitelistConfig config, + final MessagesConfig messages + ) { + this.proxy = proxy; + this.profileService = profileService; + this.whitelist = whitelist; + this.config = config; + this.messages = messages; + } + + public CompletableFuture suggestOnlinePlayers(CommandContext ignored, SuggestionsBuilder builder) { + proxy.getAllPlayers().forEach(player -> builder.suggest(player.getUsername())); + return builder.buildFuture(); + } + + public CompletableFuture suggestWhitelistedPlayers(CommandContext ignored, SuggestionsBuilder builder) { + whitelist.list().forEach(builder::suggest); + return builder.buildFuture(); + } + + public int help(CommandContext context) { + context.getSource().sendMessage(messages.getMessage(MessagesConfig.WHITELIST_HELP)); + return Command.SINGLE_SUCCESS; + } + + public int add(CommandContext context) { + var source = context.getSource(); + var playerName = context.getArgument("player", String.class); + + profileService.getProfile(playerName).ifPresentOrElse(player -> { + if (whitelist.add(player)) { + source.sendMessage(messages.getMessage(MessagesConfig.WHITELIST_ADD_SUCCESS, playerName)); + } else { + source.sendMessage(messages.getMessage(MessagesConfig.WHITELIST_ADD_ALREADY_WHITELISTED, playerName)); + } + }, () -> source.sendMessage(messages.getMessage(MessagesConfig.WHITELIST_PLAYER_DOES_NOT_EXIST, playerName))); + + return Command.SINGLE_SUCCESS; + } + + public int remove(CommandContext context) { + var source = context.getSource(); + var playerName = context.getArgument("player", String.class); + + profileService.getProfile(playerName).ifPresentOrElse(player -> { + if (whitelist.remove(player)) { + source.sendMessage(messages.getMessage(MessagesConfig.WHITELIST_REMOVE_SUCCESS, playerName)); + if (config.whitelistEnabled() && config.enforceWhitelistEnabled()) { + proxy.getPlayer(playerName).ifPresent(p -> p.disconnect(messages.getMessage(MessagesConfig.WHITELIST_REJECTED))); + } + } else { + source.sendMessage(messages.getMessage(MessagesConfig.WHITELIST_REMOVE_NOT_WHITELISTED, playerName)); + } + }, () -> source.sendMessage(messages.getMessage(MessagesConfig.WHITELIST_PLAYER_DOES_NOT_EXIST, playerName))); + + return Command.SINGLE_SUCCESS; + } + + public int list(CommandContext context) { + var source = context.getSource(); + var playerList = whitelist.list(); + + if (playerList.isEmpty()) { + source.sendMessage(messages.getMessage(MessagesConfig.WHITELIST_LIST_EMPTY)); + } else { + source.sendMessage(messages.getMessage(MessagesConfig.WHITELIST_LIST, playerList)); + } + + return Command.SINGLE_SUCCESS; + } + + public int on(CommandContext context) { + CommandSource source = context.getSource(); + + if (config.whitelistEnabled()) { + source.sendMessage(messages.getMessage(MessagesConfig.WHITELIST_ON_ALREADY)); + } else { + config.setWhitelistEnabled(true); + source.sendMessage(messages.getMessage(MessagesConfig.WHITELIST_ON)); + if (config.enforceWhitelistEnabled()) { + for (var player : proxy.getAllPlayers()) { + if (!whitelist.contains(new PlayerProfile(player.getUniqueId(), player.getUsername()))) { + player.disconnect(messages.getMessage(MessagesConfig.WHITELIST_REJECTED)); + } + } + } + } + + return Command.SINGLE_SUCCESS; + } + + public int off(CommandContext context) { + CommandSource source = context.getSource(); + + if (config.whitelistEnabled()) { + config.setWhitelistEnabled(false); + source.sendMessage(messages.getMessage(MessagesConfig.WHITELIST_OFF)); + } else { + source.sendMessage(messages.getMessage(MessagesConfig.WHITELIST_OFF_ALREADY)); + } + + return Command.SINGLE_SUCCESS; + } + + public int enforced(CommandContext context) { + CommandSource source = context.getSource(); + + if (config.enforceWhitelistEnabled()) { + source.sendMessage(messages.getMessage(MessagesConfig.WHITELIST_ENFORCED_ALREADY)); + } else { + config.setEnforceWhitelistEnabled(true); + source.sendMessage(messages.getMessage(MessagesConfig.WHITELIST_ENFORCED)); + if (config.whitelistEnabled()) { + for (var player : proxy.getAllPlayers()) { + if (!whitelist.contains(new PlayerProfile(player.getUniqueId(), player.getUsername()))) { + player.disconnect(messages.getMessage(MessagesConfig.WHITELIST_REJECTED)); + } + } + } + } + + return Command.SINGLE_SUCCESS; + } + + public int unenforced(CommandContext context) { + CommandSource source = context.getSource(); + + if (config.enforceWhitelistEnabled()) { + config.setEnforceWhitelistEnabled(false); + source.sendMessage(messages.getMessage(MessagesConfig.WHITELIST_UNENFORCED)); + } else { + source.sendMessage(messages.getMessage(MessagesConfig.WHITELIST_UNENFORCED_ALREADY)); + } + + return Command.SINGLE_SUCCESS; + } + + public int reload(CommandContext context) { + whitelist.reload(); + config.reload(); + messages.reload(); + CommandSource source = context.getSource(); + source.sendMessage(messages.getMessage(MessagesConfig.WHITELIST_RELOAD)); + return Command.SINGLE_SUCCESS; + } +} diff --git a/src/main/java/com/uravgcode/globalwhitelist/config/MessagesConfig.java b/src/main/java/com/uravgcode/globalwhitelist/config/MessagesConfig.java new file mode 100644 index 0000000..2ed2269 --- /dev/null +++ b/src/main/java/com/uravgcode/globalwhitelist/config/MessagesConfig.java @@ -0,0 +1,129 @@ +package com.uravgcode.globalwhitelist.config; + +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.minimessage.MiniMessage; +import net.kyori.adventure.text.minimessage.tag.resolver.Placeholder; +import org.slf4j.Logger; + +import java.io.File; +import java.io.FileInputStream; +import java.io.FileOutputStream; +import java.io.IOException; +import java.nio.file.Path; +import java.util.List; +import java.util.Properties; + +public class MessagesConfig { + public static final String WHITELIST_HELP = "whitelist.help"; + + public static final String WHITELIST_ADD_SUCCESS = "whitelist.add.success"; + public static final String WHITELIST_ADD_ALREADY_WHITELISTED = "whitelist.add.already_whitelisted"; + + public static final String WHITELIST_REMOVE_SUCCESS = "whitelist.remove.success"; + public static final String WHITELIST_REMOVE_NOT_WHITELISTED = "whitelist.remove.not_whitelisted"; + + public static final String WHITELIST_PLAYER_DOES_NOT_EXIST = "whitelist.player_does_not_exist"; + + public static final String WHITELIST_LIST = "whitelist.list"; + public static final String WHITELIST_LIST_EMPTY = "whitelist.list.empty"; + + public static final String WHITELIST_ON = "whitelist.on"; + public static final String WHITELIST_ON_ALREADY = "whitelist.on.already"; + public static final String WHITELIST_OFF = "whitelist.off"; + public static final String WHITELIST_OFF_ALREADY = "whitelist.off.already"; + + public static final String WHITELIST_ENFORCED = "whitelist.enforced"; + public static final String WHITELIST_ENFORCED_ALREADY = "whitelist.enforced.already"; + public static final String WHITELIST_UNENFORCED = "whitelist.unenforced"; + public static final String WHITELIST_UNENFORCED_ALREADY = "whitelist.unenforced.already"; + + public static final String WHITELIST_RELOAD = "whitelist.reload"; + + public static final String WHITELIST_REJECTED = "whitelist.rejected"; + + private final Logger logger; + private final Properties messages; + private final File messagesFile; + private final MiniMessage miniMessage; + + public MessagesConfig( + final Path messagesPath, + final Logger logger + ) { + this.messagesFile = messagesPath.toFile(); + this.logger = logger; + this.messages = new Properties(); + this.miniMessage = MiniMessage.miniMessage(); + } + + public void reload() { + if (!messagesFile.exists()) { + loadDefaults(); + save(); + return; + } + + try (FileInputStream in = new FileInputStream(messagesFile)) { + messages.load(in); + } catch (IOException e) { + logger.error("failed to load messages config: {}", e.getMessage()); + } + } + + public void save() { + try (FileOutputStream out = new FileOutputStream(messagesFile)) { + messages.store(out, "messages config"); + } catch (IOException e) { + logger.error("failed to save messages config: {}", e.getMessage()); + } + } + + private void loadDefaults() { + messages.setProperty(WHITELIST_HELP, "/globalwhitelist "); + + messages.setProperty(WHITELIST_ADD_SUCCESS, "Added to the whitelist"); + messages.setProperty(WHITELIST_ADD_ALREADY_WHITELISTED, "Player is already whitelisted"); + + messages.setProperty(WHITELIST_REMOVE_SUCCESS, "Removed from the whitelist"); + messages.setProperty(WHITELIST_REMOVE_NOT_WHITELISTED, "Player is not whitelisted"); + + messages.setProperty(WHITELIST_PLAYER_DOES_NOT_EXIST, "That player does not exist"); + + messages.setProperty(WHITELIST_LIST, "There are whitelisted player(s): "); + messages.setProperty(WHITELIST_LIST_EMPTY, "There are no whitelisted players"); + + messages.setProperty(WHITELIST_ON, "Whitelist is now turned on"); + messages.setProperty(WHITELIST_ON_ALREADY, "Whitelist is already turned on"); + messages.setProperty(WHITELIST_OFF, "Whitelist is now turned off"); + messages.setProperty(WHITELIST_OFF_ALREADY, "Whitelist is already turned off"); + + messages.setProperty(WHITELIST_ENFORCED, "Enforce whitelist is now turned on"); + messages.setProperty(WHITELIST_ENFORCED_ALREADY, "Enforce whitelist is already turned on"); + messages.setProperty(WHITELIST_UNENFORCED, "Enforce whitelist is now turned off"); + messages.setProperty(WHITELIST_UNENFORCED_ALREADY, "Enforce whitelist is already turned off"); + + messages.setProperty(WHITELIST_RELOAD, "Reloaded the whitelist"); + + messages.setProperty(WHITELIST_REJECTED, "You are not whitelisted on this server!"); + } + + public String get(String key) { + return messages.getProperty(key, ""); + } + + public Component getMessage(String key) { + return miniMessage.deserialize(get(key)); + } + + public Component getMessage(String key, String player) { + return miniMessage.deserialize(get(key), Placeholder.component("player", Component.text(player))); + } + + public Component getMessage(String key, List players) { + return miniMessage.deserialize( + get(key), + Placeholder.component("count", Component.text(players.size())), + Placeholder.component("players", Component.text(String.join(", ", players))) + ); + } +} diff --git a/src/main/java/com/uravgcode/globalwhitelist/config/WhitelistConfig.java b/src/main/java/com/uravgcode/globalwhitelist/config/WhitelistConfig.java new file mode 100644 index 0000000..43906a8 --- /dev/null +++ b/src/main/java/com/uravgcode/globalwhitelist/config/WhitelistConfig.java @@ -0,0 +1,66 @@ +package com.uravgcode.globalwhitelist.config; + +import org.slf4j.Logger; + +import java.io.File; +import java.io.FileInputStream; +import java.io.FileOutputStream; +import java.io.IOException; +import java.nio.file.Path; +import java.util.Properties; + +public class WhitelistConfig { + private static final String WHITE_LIST = "white-list"; + private static final String ENFORCE_WHITELIST = "enforce-whitelist"; + + private final File configFile; + private final Logger logger; + private final Properties config; + + public WhitelistConfig(Path configPath, Logger logger) { + this.configFile = configPath.toFile(); + this.logger = logger; + this.config = new Properties(); + } + + public void reload() { + if (!configFile.exists()) { + config.setProperty(WHITE_LIST, "false"); + config.setProperty(ENFORCE_WHITELIST, "false"); + save(); + return; + } + + try (FileInputStream in = new FileInputStream(configFile)) { + config.load(in); + } catch (IOException e) { + logger.error("failed to load whitelist config: {}", e.getMessage()); + } + } + + public void save() { + try (FileOutputStream out = new FileOutputStream(configFile)) { + config.store(out, "whitelist config"); + } catch (IOException e) { + logger.error("failed to save whitelist config: {}", e.getMessage()); + } + } + + public boolean whitelistEnabled() { + return Boolean.parseBoolean(config.getProperty(WHITE_LIST)); + } + + public void setWhitelistEnabled(boolean enabled) { + config.setProperty(WHITE_LIST, Boolean.toString(enabled)); + save(); + } + + public boolean enforceWhitelistEnabled() { + return Boolean.parseBoolean(config.getProperty(ENFORCE_WHITELIST)); + } + + public void setEnforceWhitelistEnabled(boolean enabled) { + config.setProperty(ENFORCE_WHITELIST, Boolean.toString(enabled)); + save(); + } +} diff --git a/src/main/java/com/uravgcode/globalwhitelist/service/MinecraftProfileService.java b/src/main/java/com/uravgcode/globalwhitelist/service/MinecraftProfileService.java new file mode 100644 index 0000000..cae4147 --- /dev/null +++ b/src/main/java/com/uravgcode/globalwhitelist/service/MinecraftProfileService.java @@ -0,0 +1,96 @@ +package com.uravgcode.globalwhitelist.service; + +import com.google.gson.JsonObject; +import com.google.gson.JsonParser; +import com.uravgcode.globalwhitelist.whitelist.PlayerProfile; +import org.slf4j.Logger; + +import java.io.IOException; +import java.net.URI; +import java.net.http.HttpClient; +import java.net.http.HttpRequest; +import java.net.http.HttpResponse; +import java.time.Duration; +import java.util.Optional; +import java.util.UUID; +import java.util.regex.Pattern; + +public class MinecraftProfileService { + private static final URI API_BASE_URL = URI.create("https://api.minecraftservices.com/minecraft/profile/lookup/name/"); + private static final Pattern UUID_PATTERN = Pattern.compile("(\\p{XDigit}{8})(\\p{XDigit}{4})(\\p{XDigit}{4})(\\p{XDigit}{4})(\\p{XDigit}{12})"); + private static final Duration TIMEOUT = Duration.ofSeconds(5); + + private final Logger logger; + private final HttpClient httpClient; + + public MinecraftProfileService(Logger logger) { + this.logger = logger; + this.httpClient = HttpClient.newBuilder() + .connectTimeout(TIMEOUT) + .build(); + } + + public Optional getProfile(String playerName) { + if (playerName == null || playerName.isBlank()) { + logger.warn("player name cannot be null or empty"); + return Optional.empty(); + } + + try { + var request = HttpRequest.newBuilder() + .uri(API_BASE_URL.resolve(playerName)) + .timeout(TIMEOUT) + .GET() + .build(); + + var response = httpClient.send(request, HttpResponse.BodyHandlers.ofString()); + + return switch (response.statusCode()) { + case 200 -> parseProfile(response.body()); + case 404 -> { + logger.warn("player with name {} not found", playerName); + yield Optional.empty(); + } + default -> { + logger.warn("api request failed with status {}: {}", response.statusCode(), response.body()); + yield Optional.empty(); + } + }; + + } catch (IOException e) { + logger.error("network error while fetching profile for '{}': {}", playerName, e.getMessage()); + return Optional.empty(); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + logger.error("request interrupted while fetching profile for '{}': {}", playerName, e.getMessage()); + return Optional.empty(); + } + } + + private Optional parseProfile(String jsonString) { + try { + JsonObject jsonObject = JsonParser.parseString(jsonString).getAsJsonObject(); + + if (!jsonObject.has("id") || !jsonObject.has("name")) { + logger.warn("missing 'id' or 'name' in json:\n{}", jsonString); + return Optional.empty(); + } + + String uuidString = jsonObject.get("id").getAsString(); + String name = jsonObject.get("name").getAsString(); + + var matcher = UUID_PATTERN.matcher(uuidString); + if (!matcher.matches()) { + logger.warn("invalid uuid format in json:\n{}", jsonString); + return Optional.empty(); + } + + var uuid = UUID.fromString(matcher.replaceFirst("$1-$2-$3-$4-$5")); + return Optional.of(new PlayerProfile(uuid, name)); + + } catch (Exception e) { + logger.error("failed to parse json:\n{}\nerror: {}", jsonString, e.getMessage()); + return Optional.empty(); + } + } +} diff --git a/src/main/java/com/uravgcode/globalwhitelist/whitelist/PlayerProfile.java b/src/main/java/com/uravgcode/globalwhitelist/whitelist/PlayerProfile.java new file mode 100644 index 0000000..e4a04f3 --- /dev/null +++ b/src/main/java/com/uravgcode/globalwhitelist/whitelist/PlayerProfile.java @@ -0,0 +1,17 @@ +package com.uravgcode.globalwhitelist.whitelist; + +import java.util.UUID; + +public record PlayerProfile(UUID uuid, String name) { + @Override + public boolean equals(Object obj) { + if (this == obj) return true; + if (!(obj instanceof PlayerProfile other)) return false; + return uuid.equals(other.uuid); + } + + @Override + public int hashCode() { + return uuid.hashCode(); + } +} diff --git a/src/main/java/com/uravgcode/globalwhitelist/whitelist/Whitelist.java b/src/main/java/com/uravgcode/globalwhitelist/whitelist/Whitelist.java new file mode 100644 index 0000000..c562337 --- /dev/null +++ b/src/main/java/com/uravgcode/globalwhitelist/whitelist/Whitelist.java @@ -0,0 +1,84 @@ +package com.uravgcode.globalwhitelist.whitelist; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.reflect.TypeToken; +import org.slf4j.Logger; + +import java.io.File; +import java.io.FileReader; +import java.io.FileWriter; +import java.io.IOException; +import java.lang.reflect.Type; +import java.nio.file.Path; +import java.util.HashSet; +import java.util.List; +import java.util.Set; + +public class Whitelist { + private final Logger logger; + private final File whitelistFile; + private final Set whitelistPlayers; + + private final Gson gson = new GsonBuilder().setPrettyPrinting().create(); + + public Whitelist(Path whitelistPath, Logger logger) { + this.logger = logger; + this.whitelistFile = whitelistPath.toFile(); + this.whitelistPlayers = new HashSet<>(); + } + + public boolean contains(PlayerProfile player) { + return whitelistPlayers.contains(player); + } + + public boolean add(PlayerProfile player) { + if (whitelistPlayers.add(player)) { + save(); + return true; + } + return false; + } + + public boolean remove(PlayerProfile player) { + if (whitelistPlayers.remove(player)) { + save(); + return true; + } + return false; + } + + public List list() { + return whitelistPlayers.stream().map(PlayerProfile::name).toList(); + } + + public void reload() { + try { + if (whitelistFile.createNewFile()) { + whitelistPlayers.clear(); + return; + } + + try (FileReader reader = new FileReader(whitelistFile)) { + Type listType = new TypeToken>() { + }.getType(); + List players = gson.fromJson(reader, listType); + + if (players != null) { + whitelistPlayers.clear(); + whitelistPlayers.addAll(players); + } + } + } catch (IOException e) { + throw new RuntimeException(e); + } + } + + private void save() { + try (FileWriter writer = new FileWriter(whitelistFile)) { + gson.toJson(List.copyOf(whitelistPlayers), writer); + } catch (IOException e) { + logger.error("failed to save whitelist: {}", e.getMessage()); + } + } +} diff --git a/src/main/templates/com/uravgcode/globalwhitelist/BuildConstants.java b/src/main/templates/com/uravgcode/globalwhitelist/BuildConstants.java new file mode 100644 index 0000000..77091ad --- /dev/null +++ b/src/main/templates/com/uravgcode/globalwhitelist/BuildConstants.java @@ -0,0 +1,5 @@ +package com.uravgcode.globalwhitelist; + +public class BuildConstants { + public static final String VERSION = "${version}"; +}