diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 000000000..52d913562 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +github: astei diff --git a/HEADER.txt b/HEADER.txt new file mode 100644 index 000000000..9f7cf8e97 --- /dev/null +++ b/HEADER.txt @@ -0,0 +1,14 @@ +Copyright (C) 2018 Velocity Contributors + +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 . \ No newline at end of file diff --git a/LICENSE b/LICENSE index 44ba3e38a..f288702d2 100644 --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,674 @@ -Copyright 2018 Velocity team + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + 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. -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + Preamble -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file + 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 4b35a9a02..f665aaa5f 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,7 @@ A Minecraft server proxy with unparalleled server support, scalability, and flexibility. -Velocity is licensed under the MIT license for ultimate permissiveness -and expanding the pool of potential contributors and users. +Velocity is licensed under the GPLv3 license. ## Goals @@ -34,4 +33,4 @@ Once you've built Velocity, you can copy and run the `-all` JAR from and you can configure it from there. Alternatively, you can get the proxy JAR from the [downloads](https://www.velocitypowered.com/downloads) -page. \ No newline at end of file +page. diff --git a/api/HEADER.txt b/api/HEADER.txt new file mode 100644 index 000000000..15aa7e2b4 --- /dev/null +++ b/api/HEADER.txt @@ -0,0 +1,4 @@ +Copyright (C) 2018 Velocity Contributors + +The Velocity API is licensed under the terms of the MIT License. For more details, +reference the LICENSE file in the api top-level directory. \ No newline at end of file diff --git a/api/LICENSE b/api/LICENSE new file mode 100644 index 000000000..3bd76aa5a --- /dev/null +++ b/api/LICENSE @@ -0,0 +1,7 @@ +Copyright 2018 Velocity Contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/api/build.gradle b/api/build.gradle index 6240c4b98..db1147901 100644 --- a/api/build.gradle +++ b/api/build.gradle @@ -4,6 +4,7 @@ plugins { id 'checkstyle' } +apply plugin: 'org.cadixdev.licenser' apply from: '../gradle/checkstyle.gradle' apply from: '../gradle/publish.gradle' apply plugin: 'com.github.johnrengelman.shadow' @@ -13,6 +14,10 @@ java { targetCompatibility = JavaVersion.VERSION_11 } +license { + header = project.file('HEADER.txt') +} + sourceSets { ap { compileClasspath += main.compileClasspath + main.output @@ -30,7 +35,7 @@ dependencies { api("net.kyori:coffee:1.0.0-SNAPSHOT") api "org.slf4j:slf4j-api:${slf4jVersion}" - api 'com.google.inject:guice:4.2.3' + api 'com.google.inject:guice:5.0.1' api "org.checkerframework:checker-qual:${checkerFrameworkVersion}" api 'com.velocitypowered:velocity-brigadier:1.0.0-SNAPSHOT' @@ -71,13 +76,13 @@ javadoc { options.encoding = 'UTF-8' options.charSet = 'UTF-8' options.source = '8' -// options.links( -// 'https://www.slf4j.org/apidocs/', -// 'https://guava.dev/releases/30.0-jre/api/docs/', -// 'https://google.github.io/guice/api-docs/4.2/javadoc/', -// 'https://docs.oracle.com/javase/8/docs/api/', -// 'https://jd.adventure.kyori.net/api/4.0.0/' -// ) + options.links( + 'http://www.slf4j.org/apidocs/', + 'https://google.github.io/guava/releases/30.0-jre/api/docs/', + 'https://google.github.io/guice/api-docs/4.2/javadoc/', + 'https://docs.oracle.com/javase/8/docs/api/', + 'https://jd.adventure.kyori.net/api/4.7.0/' + ) // Disable the crazy super-strict doclint tool in Java 8 options.addStringOption('Xdoclint:none', '-quiet') @@ -95,10 +100,6 @@ test { useJUnitPlatform() } -test { - useJUnitPlatform() -} - publishing { publications { mavenJava(MavenPublication) { diff --git a/api/src/ap/java/com/velocitypowered/api/plugin/ap/PluginAnnotationProcessor.java b/api/src/ap/java/com/velocitypowered/api/plugin/ap/PluginAnnotationProcessor.java index eef691ba4..6fd77ddf3 100644 --- a/api/src/ap/java/com/velocitypowered/api/plugin/ap/PluginAnnotationProcessor.java +++ b/api/src/ap/java/com/velocitypowered/api/plugin/ap/PluginAnnotationProcessor.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.plugin.ap; import com.google.gson.Gson; diff --git a/api/src/ap/java/com/velocitypowered/api/plugin/ap/SerializedPluginDescription.java b/api/src/ap/java/com/velocitypowered/api/plugin/ap/SerializedPluginDescription.java index 9e0cf7d5a..e785d9adb 100644 --- a/api/src/ap/java/com/velocitypowered/api/plugin/ap/SerializedPluginDescription.java +++ b/api/src/ap/java/com/velocitypowered/api/plugin/ap/SerializedPluginDescription.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.plugin.ap; import com.google.common.base.Preconditions; diff --git a/api/src/main/java/com/velocitypowered/api/command/BrigadierCommand.java b/api/src/main/java/com/velocitypowered/api/command/BrigadierCommand.java index edf4d6b2e..da40f48a5 100644 --- a/api/src/main/java/com/velocitypowered/api/command/BrigadierCommand.java +++ b/api/src/main/java/com/velocitypowered/api/command/BrigadierCommand.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.command; import com.google.common.base.Preconditions; diff --git a/api/src/main/java/com/velocitypowered/api/command/Command.java b/api/src/main/java/com/velocitypowered/api/command/Command.java index 5650cc600..68f4594e4 100644 --- a/api/src/main/java/com/velocitypowered/api/command/Command.java +++ b/api/src/main/java/com/velocitypowered/api/command/Command.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.command; import com.velocitypowered.api.proxy.connection.Player; @@ -6,19 +13,16 @@ import com.velocitypowered.api.proxy.connection.Player; * Represents a command that can be executed by a {@link CommandSource} * such as a {@link Player} or the console. * - *

Velocity 1.1.0 introduces specialized command subinterfaces to separate - * command parsing concerns. These include, in order of preference: + *

You should not subclass Command. Use one of the following + * subinterfaces:

* *
    - *
  • {@link BrigadierCommand}, which supports parameterized arguments and - * specialized execution, tab complete suggestions and permission-checking logic. + *
  • {@link BrigadierCommand} wraps a Brigadier literal command node. It supports parameterized + * arguments and specialized execution, tab complete suggestions and permission-checking logic. * - *
  • {@link SimpleCommand}, modelled after the convention popularized by - * Bukkit and BungeeCord. Older classes directly implementing {@link Command} - * are suggested to migrate to this interface. + *
  • {@link SimpleCommand} is modelled after the convention popularized by Bukkit and BungeeCord. * - *
  • {@link RawCommand}, useful for bolting on external command frameworks - * to Velocity. + *
  • {@link RawCommand} is useful for bolting on external command frameworks onto Velocity. * *
*/ diff --git a/api/src/main/java/com/velocitypowered/api/command/CommandInvocation.java b/api/src/main/java/com/velocitypowered/api/command/CommandInvocation.java index 191602bf4..bc9be26ea 100644 --- a/api/src/main/java/com/velocitypowered/api/command/CommandInvocation.java +++ b/api/src/main/java/com/velocitypowered/api/command/CommandInvocation.java @@ -1,7 +1,14 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.command; /** - * Provides information related to the possible execution of a {@link Command}. + * Provides information related to the (possible) execution of a {@link Command}. * * @param the type of the arguments */ diff --git a/api/src/main/java/com/velocitypowered/api/command/CommandManager.java b/api/src/main/java/com/velocitypowered/api/command/CommandManager.java index 08bea41f9..144d3e579 100644 --- a/api/src/main/java/com/velocitypowered/api/command/CommandManager.java +++ b/api/src/main/java/com/velocitypowered/api/command/CommandManager.java @@ -1,6 +1,13 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.command; -import com.velocitypowered.api.event.command.CommandExecuteEvent; +import com.velocitypowered.api.event.command.CommandExecuteEventImpl; import java.util.concurrent.CompletableFuture; /** @@ -15,7 +22,7 @@ public interface CommandManager { * @param alias the first command alias * @return a {@link CommandMeta} builder */ - CommandMeta.Builder metaBuilder(String alias); + CommandMeta.Builder createMetaBuilder(String alias); /** * Returns a builder to create a {@link CommandMeta} for @@ -24,7 +31,7 @@ public interface CommandManager { * @param command the command * @return a {@link CommandMeta} builder */ - CommandMeta.Builder metaBuilder(BrigadierCommand command); + CommandMeta.Builder createMetaBuilder(BrigadierCommand command); /** * Registers the specified command with the specified aliases. @@ -35,7 +42,7 @@ public interface CommandManager { * @throws IllegalArgumentException if one of the given aliases is already registered */ default void register(String alias, Command command, String... otherAliases) { - register(metaBuilder(alias).aliases(otherAliases).build(), command); + register(createMetaBuilder(alias).aliases(otherAliases).build(), command); } /** @@ -74,7 +81,7 @@ public interface CommandManager { /** * Attempts to asynchronously execute a command from the given {@code cmdLine} - * without firing a {@link CommandExecuteEvent}. + * without firing a {@link CommandExecuteEventImpl}. * * @param source the source to execute the command for * @param cmdLine the command to run diff --git a/api/src/main/java/com/velocitypowered/api/command/CommandMeta.java b/api/src/main/java/com/velocitypowered/api/command/CommandMeta.java index 65965e0d1..60f933c0b 100644 --- a/api/src/main/java/com/velocitypowered/api/command/CommandMeta.java +++ b/api/src/main/java/com/velocitypowered/api/command/CommandMeta.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.command; import com.mojang.brigadier.tree.CommandNode; @@ -14,7 +21,7 @@ public interface CommandMeta { * * @return the command aliases */ - Collection getAliases(); + Collection aliases(); /** * Returns a collection containing command nodes that provide additional @@ -23,7 +30,7 @@ public interface CommandMeta { * * @return the hinting command nodes */ - Collection> getHints(); + Collection> hints(); /** * Provides a fluent interface to create {@link CommandMeta}s. diff --git a/api/src/main/java/com/velocitypowered/api/command/CommandSource.java b/api/src/main/java/com/velocitypowered/api/command/CommandSource.java index fe414b74d..82c67151d 100644 --- a/api/src/main/java/com/velocitypowered/api/command/CommandSource.java +++ b/api/src/main/java/com/velocitypowered/api/command/CommandSource.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.command; import com.velocitypowered.api.permission.PermissionSubject; diff --git a/api/src/main/java/com/velocitypowered/api/command/ConsoleCommandSource.java b/api/src/main/java/com/velocitypowered/api/command/ConsoleCommandSource.java index a1d671cc4..3a369ca45 100644 --- a/api/src/main/java/com/velocitypowered/api/command/ConsoleCommandSource.java +++ b/api/src/main/java/com/velocitypowered/api/command/ConsoleCommandSource.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.command; import com.velocitypowered.api.command.CommandSource; diff --git a/api/src/main/java/com/velocitypowered/api/command/InvocableCommand.java b/api/src/main/java/com/velocitypowered/api/command/InvocableCommand.java index 80125f25b..e6183e52d 100644 --- a/api/src/main/java/com/velocitypowered/api/command/InvocableCommand.java +++ b/api/src/main/java/com/velocitypowered/api/command/InvocableCommand.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.command; import com.google.common.collect.ImmutableList; diff --git a/api/src/main/java/com/velocitypowered/api/command/RawCommand.java b/api/src/main/java/com/velocitypowered/api/command/RawCommand.java index 1edc22e61..62e3f5f70 100644 --- a/api/src/main/java/com/velocitypowered/api/command/RawCommand.java +++ b/api/src/main/java/com/velocitypowered/api/command/RawCommand.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.command; /** @@ -11,12 +18,5 @@ public interface RawCommand extends InvocableCommand { * Contains the invocation data for a raw command. */ interface Invocation extends CommandInvocation { - - /** - * Returns the used alias to execute the command. - * - * @return the used command alias - */ - String alias(); } } diff --git a/api/src/main/java/com/velocitypowered/api/command/SimpleCommand.java b/api/src/main/java/com/velocitypowered/api/command/SimpleCommand.java index 2233e2a9b..1286d80ee 100644 --- a/api/src/main/java/com/velocitypowered/api/command/SimpleCommand.java +++ b/api/src/main/java/com/velocitypowered/api/command/SimpleCommand.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.command; import org.checkerframework.checker.nullness.qual.NonNull; @@ -15,12 +22,5 @@ public interface SimpleCommand extends InvocableCommand { - - /** - * Returns the used alias to execute the command. - * - * @return the used command alias - */ - String alias(); } } diff --git a/api/src/main/java/com/velocitypowered/api/command/package-info.java b/api/src/main/java/com/velocitypowered/api/command/package-info.java index 9d323f55a..410f8eacc 100644 --- a/api/src/main/java/com/velocitypowered/api/command/package-info.java +++ b/api/src/main/java/com/velocitypowered/api/command/package-info.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + /** * Provides a command framework. */ diff --git a/api/src/main/java/com/velocitypowered/api/event/Continuation.java b/api/src/main/java/com/velocitypowered/api/event/Continuation.java index 412bf04ca..e4d7048ab 100644 --- a/api/src/main/java/com/velocitypowered/api/event/Continuation.java +++ b/api/src/main/java/com/velocitypowered/api/event/Continuation.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event; /** diff --git a/api/src/main/java/com/velocitypowered/api/event/EventHandler.java b/api/src/main/java/com/velocitypowered/api/event/EventHandler.java index bef9d23e4..fdf25862e 100644 --- a/api/src/main/java/com/velocitypowered/api/event/EventHandler.java +++ b/api/src/main/java/com/velocitypowered/api/event/EventHandler.java @@ -1,8 +1,16 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event; /** - * Represents an interface to perform direct dispatch of an event. This makes integration easier to - * achieve with platforms such as RxJava. + * Allows a listener to receive direct dispatches of events. This interface can be used directly + * by a listener (using {@link EventManager#register(Object, Class, short, EventHandler)} or + * similar), or pass events through to an external system to be handled. */ @FunctionalInterface public interface EventHandler { diff --git a/api/src/main/java/com/velocitypowered/api/event/EventManager.java b/api/src/main/java/com/velocitypowered/api/event/EventManager.java index 26ec24faf..b1fd542db 100644 --- a/api/src/main/java/com/velocitypowered/api/event/EventManager.java +++ b/api/src/main/java/com/velocitypowered/api/event/EventManager.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event; import java.util.concurrent.CompletableFuture; diff --git a/api/src/main/java/com/velocitypowered/api/event/EventTask.java b/api/src/main/java/com/velocitypowered/api/event/EventTask.java index 1c4000e97..6dad00e58 100644 --- a/api/src/main/java/com/velocitypowered/api/event/EventTask.java +++ b/api/src/main/java/com/velocitypowered/api/event/EventTask.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event; import static java.util.Objects.requireNonNull; diff --git a/api/src/main/java/com/velocitypowered/api/event/PostOrder.java b/api/src/main/java/com/velocitypowered/api/event/PostOrder.java index f083129e4..b2cdf976d 100644 --- a/api/src/main/java/com/velocitypowered/api/event/PostOrder.java +++ b/api/src/main/java/com/velocitypowered/api/event/PostOrder.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event; /** diff --git a/api/src/main/java/com/velocitypowered/api/event/ResultedEvent.java b/api/src/main/java/com/velocitypowered/api/event/ResultedEvent.java index ec390bd7c..fd889a19b 100644 --- a/api/src/main/java/com/velocitypowered/api/event/ResultedEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/ResultedEvent.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event; import com.google.common.base.Preconditions; @@ -16,7 +23,7 @@ public interface ResultedEvent { * * @return the result of this event */ - R getResult(); + R result(); /** * Sets the result of this event. The result must be non-null. @@ -92,7 +99,7 @@ public interface ResultedEvent { return status; } - public Optional getReason() { + public Optional reason() { return Optional.ofNullable(reason); } diff --git a/api/src/main/java/com/velocitypowered/api/event/Subscribe.java b/api/src/main/java/com/velocitypowered/api/event/Subscribe.java index bcdc57a6f..6d6acea77 100644 --- a/api/src/main/java/com/velocitypowered/api/event/Subscribe.java +++ b/api/src/main/java/com/velocitypowered/api/event/Subscribe.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event; import java.lang.annotation.ElementType; @@ -20,11 +27,12 @@ public @interface Subscribe { short order() default PostOrder.NORMAL; /** - * Whether the handler is required to be called asynchronously. + * Whether the handler must be called asynchronously. * *

If this method returns {@code true}, the method is guaranteed to be executed - * asynchronously from the current thread. Otherwise, the handler may be executed on the - * current thread or asynchronously.

+ * asynchronously. Otherwise, the handler may be executed on the current thread or + * asynchronously. This still means you must consider thread-safety in your + * event listeners as the "current thread" can and will be different each time.

* *

If any method handler targeting an event type is marked with {@code true}, then every * handler targeting that event type will be executed asynchronously.

diff --git a/api/src/main/java/com/velocitypowered/api/event/command/CommandExecuteEvent.java b/api/src/main/java/com/velocitypowered/api/event/command/CommandExecuteEvent.java index b899616d1..a799986fe 100644 --- a/api/src/main/java/com/velocitypowered/api/event/command/CommandExecuteEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/command/CommandExecuteEvent.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.command; import com.google.common.base.Preconditions; @@ -9,63 +16,22 @@ import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; /** - * This event is fired when someone executing command. + * This event is fired when someone executes a command. */ -public final class CommandExecuteEvent implements ResultedEvent { +public interface CommandExecuteEvent extends ResultedEvent { - private final CommandSource commandSource; - private final String command; - private CommandResult result; + CommandSource source(); /** - * Constructs a CommandExecuteEvent. - * @param commandSource the source executing the command - * @param command the command being executed without first slash - */ - public CommandExecuteEvent(CommandSource commandSource, String command) { - this.commandSource = Preconditions.checkNotNull(commandSource, "commandSource"); - this.command = Preconditions.checkNotNull(command, "command"); - this.result = CommandResult.allowed(); - } - - public CommandSource getCommandSource() { - return commandSource; - } - - /** - * Gets the original command being executed without first slash. + * Gets the original command being executed without the first slash. * @return the original command being executed */ - public String getCommand() { - return command; - } + String rawCommand(); - @Override - public CommandResult getResult() { - return result; - } + final class CommandResult implements ResultedEvent.Result { - @Override - public void setResult(CommandResult result) { - this.result = Preconditions.checkNotNull(result, "result"); - } - - @Override - public String toString() { - return "CommandExecuteEvent{" - + "commandSource=" + commandSource - + ", command=" + command - + ", result=" + result - + '}'; - } - - /** - * Represents the result of the {@link CommandExecuteEvent}. - */ - public static final class CommandResult implements ResultedEvent.Result { - - private static final CommandResult ALLOWED = new CommandResult(true, false,null); - private static final CommandResult DENIED = new CommandResult(false, false,null); + private static final CommandResult ALLOWED = new CommandResult(true, false, null); + private static final CommandResult DENIED = new CommandResult(false, false, null); private static final CommandResult FORWARD_TO_SERVER = new CommandResult(false, true, null); private @Nullable String command; @@ -78,7 +44,7 @@ public final class CommandExecuteEvent implements ResultedEvent { this.command = command; } - public Optional getCommand() { + public Optional modifiedCommand() { return Optional.ofNullable(command); } @@ -98,6 +64,7 @@ public final class CommandExecuteEvent implements ResultedEvent { /** * Allows the command to be sent, without modification. + * * @return the allowed result */ public static CommandResult allowed() { @@ -106,6 +73,7 @@ public final class CommandExecuteEvent implements ResultedEvent { /** * Prevents the command from being executed. + * * @return the denied result */ public static CommandResult denied() { @@ -114,6 +82,7 @@ public final class CommandExecuteEvent implements ResultedEvent { /** * Prevents the command from being executed, but forward command to server. + * * @return the forward result */ public static CommandResult forwardToServer() { @@ -122,6 +91,7 @@ public final class CommandExecuteEvent implements ResultedEvent { /** * Prevents the command from being executed on proxy, but forward command to server. + * * @param newCommand the command without first slash to use instead * @return a result with a new command being forwarded to server */ @@ -132,6 +102,7 @@ public final class CommandExecuteEvent implements ResultedEvent { /** * Allows the command to be executed, but silently replaced old command with another. + * * @param newCommand the command to use instead without first slash * @return a result with a new command */ @@ -140,4 +111,5 @@ public final class CommandExecuteEvent implements ResultedEvent { return new CommandResult(true, false, newCommand); } } + } diff --git a/api/src/main/java/com/velocitypowered/api/event/command/CommandExecuteEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/command/CommandExecuteEventImpl.java new file mode 100644 index 000000000..c4cae21df --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/command/CommandExecuteEventImpl.java @@ -0,0 +1,66 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.command; + +import com.google.common.base.Preconditions; +import com.velocitypowered.api.command.CommandSource; + +/** + * This event is fired when someone executing command. + */ +public final class CommandExecuteEventImpl implements CommandExecuteEvent { + + private final CommandSource commandSource; + private final String command; + private CommandResult result; + + /** + * Constructs a CommandExecuteEvent. + * @param commandSource the source executing the command + * @param command the command being executed without first slash + */ + public CommandExecuteEventImpl(CommandSource commandSource, String command) { + this.commandSource = Preconditions.checkNotNull(commandSource, "commandSource"); + this.command = Preconditions.checkNotNull(command, "command"); + this.result = CommandResult.allowed(); + } + + @Override + public CommandSource source() { + return commandSource; + } + + /** + * Gets the original command being executed without first slash. + * @return the original command being executed + */ + @Override + public String rawCommand() { + return command; + } + + @Override + public CommandResult result() { + return result; + } + + @Override + public void setResult(CommandResult result) { + this.result = Preconditions.checkNotNull(result, "result"); + } + + @Override + public String toString() { + return "CommandExecuteEvent{" + + "commandSource=" + commandSource + + ", command=" + command + + ", result=" + result + + '}'; + } + +} diff --git a/api/src/main/java/com/velocitypowered/api/event/command/PlayerAvailableCommandsEvent.java b/api/src/main/java/com/velocitypowered/api/event/command/PlayerAvailableCommandsEvent.java index 657b2b77a..9cc5b560d 100644 --- a/api/src/main/java/com/velocitypowered/api/event/command/PlayerAvailableCommandsEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/command/PlayerAvailableCommandsEvent.java @@ -1,8 +1,12 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.command; -import static com.google.common.base.Preconditions.checkNotNull; - -import com.google.common.annotations.Beta; import com.mojang.brigadier.tree.RootCommandNode; import com.velocitypowered.api.proxy.connection.Player; @@ -10,28 +14,9 @@ import com.velocitypowered.api.proxy.connection.Player; * Allows plugins to modify the packet indicating commands available on the server to a * Minecraft 1.13+ client. */ -@Beta -public class PlayerAvailableCommandsEvent { +public interface PlayerAvailableCommandsEvent { - private final Player player; - private final RootCommandNode rootNode; + Player player(); - /** - * Constructs an available commands event. - * @param player the targeted player - * @param rootNode the Brigadier root node - */ - public PlayerAvailableCommandsEvent(Player player, - RootCommandNode rootNode) { - this.player = checkNotNull(player, "player"); - this.rootNode = checkNotNull(rootNode, "rootNode"); - } - - public Player getPlayer() { - return player; - } - - public RootCommandNode getRootNode() { - return rootNode; - } + RootCommandNode rootNode(); } diff --git a/api/src/main/java/com/velocitypowered/api/event/command/PlayerAvailableCommandsEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/command/PlayerAvailableCommandsEventImpl.java new file mode 100644 index 000000000..313ea751d --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/command/PlayerAvailableCommandsEventImpl.java @@ -0,0 +1,46 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.command; + +import static com.google.common.base.Preconditions.checkNotNull; + +import com.google.common.annotations.Beta; +import com.mojang.brigadier.tree.RootCommandNode; +import com.velocitypowered.api.proxy.connection.Player; + +/** + * Allows plugins to modify the packet indicating commands available on the server to a + * Minecraft 1.13+ client. + */ +@Beta +public class PlayerAvailableCommandsEventImpl implements PlayerAvailableCommandsEvent { + + private final Player player; + private final RootCommandNode rootNode; + + /** + * Constructs an available commands event. + * @param player the targeted player + * @param rootNode the Brigadier root node + */ + public PlayerAvailableCommandsEventImpl(Player player, + RootCommandNode rootNode) { + this.player = checkNotNull(player, "player"); + this.rootNode = checkNotNull(rootNode, "rootNode"); + } + + @Override + public Player player() { + return player; + } + + @Override + public RootCommandNode rootNode() { + return rootNode; + } +} diff --git a/api/src/main/java/com/velocitypowered/api/event/connection/ConnectionHandshakeEvent.java b/api/src/main/java/com/velocitypowered/api/event/connection/ConnectionHandshakeEvent.java index db5aed77a..a744dbe8a 100644 --- a/api/src/main/java/com/velocitypowered/api/event/connection/ConnectionHandshakeEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/connection/ConnectionHandshakeEvent.java @@ -1,27 +1,18 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.connection; -import com.google.common.base.Preconditions; import com.velocitypowered.api.proxy.connection.InboundConnection; /** * This event is fired when a handshake is established between a client and the proxy. */ -public final class ConnectionHandshakeEvent { +public interface ConnectionHandshakeEvent { - private final InboundConnection connection; - - public ConnectionHandshakeEvent(InboundConnection connection) { - this.connection = Preconditions.checkNotNull(connection, "connection"); - } - - public InboundConnection getConnection() { - return connection; - } - - @Override - public String toString() { - return "ConnectionHandshakeEvent{" - + "connection=" + connection - + '}'; - } + InboundConnection connection(); } diff --git a/api/src/main/java/com/velocitypowered/api/event/connection/ConnectionHandshakeEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/connection/ConnectionHandshakeEventImpl.java new file mode 100644 index 000000000..4df985717 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/connection/ConnectionHandshakeEventImpl.java @@ -0,0 +1,35 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.connection; + +import com.google.common.base.Preconditions; +import com.velocitypowered.api.proxy.connection.InboundConnection; + +/** + * This event is fired when a handshake is established between a client and the proxy. + */ +public final class ConnectionHandshakeEventImpl implements ConnectionHandshakeEvent { + + private final InboundConnection connection; + + public ConnectionHandshakeEventImpl(InboundConnection connection) { + this.connection = Preconditions.checkNotNull(connection, "connection"); + } + + @Override + public InboundConnection connection() { + return connection; + } + + @Override + public String toString() { + return "ConnectionHandshakeEvent{" + + "connection=" + connection + + '}'; + } +} diff --git a/api/src/main/java/com/velocitypowered/api/event/connection/PluginMessageEvent.java b/api/src/main/java/com/velocitypowered/api/event/connection/PluginMessageEvent.java index fbcc61d51..74b8155f0 100644 --- a/api/src/main/java/com/velocitypowered/api/event/connection/PluginMessageEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/connection/PluginMessageEvent.java @@ -1,95 +1,43 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.connection; -import com.google.common.base.Preconditions; import com.google.common.io.ByteArrayDataInput; -import com.google.common.io.ByteStreams; import com.velocitypowered.api.event.ResultedEvent; import com.velocitypowered.api.proxy.connection.Player; import com.velocitypowered.api.proxy.connection.ServerConnection; -import com.velocitypowered.api.proxy.messages.ChannelIdentifier; import com.velocitypowered.api.proxy.messages.ChannelMessageSink; import com.velocitypowered.api.proxy.messages.ChannelMessageSource; +import com.velocitypowered.api.proxy.messages.PluginChannelId; import java.io.ByteArrayInputStream; -import java.util.Arrays; /** * This event is fired when a plugin message is sent to the proxy, either from a client ({@link * Player}) or a server ({@link ServerConnection}). */ -public final class PluginMessageEvent implements ResultedEvent { +public interface PluginMessageEvent extends ResultedEvent { - private final ChannelMessageSource source; - private final ChannelMessageSink target; - private final ChannelIdentifier identifier; - private final byte[] data; - private ForwardResult result; + ChannelMessageSource source(); - /** - * Creates a new instance. - * - * @param source the source of the plugin message - * @param target the destination of the plugin message - * @param identifier the channel for this plugin message - * @param data the payload of the plugin message - */ - public PluginMessageEvent(ChannelMessageSource source, ChannelMessageSink target, - ChannelIdentifier identifier, byte[] data) { - this.source = Preconditions.checkNotNull(source, "source"); - this.target = Preconditions.checkNotNull(target, "target"); - this.identifier = Preconditions.checkNotNull(identifier, "identifier"); - this.data = Preconditions.checkNotNull(data, "data"); - this.result = ForwardResult.forward(); - } + ChannelMessageSink sink(); - @Override - public ForwardResult getResult() { - return result; - } + PluginChannelId channel(); - @Override - public void setResult(ForwardResult result) { - this.result = Preconditions.checkNotNull(result, "result"); - } + byte[] rawMessage(); - public ChannelMessageSource getSource() { - return source; - } + ByteArrayInputStream messageAsInputStream(); - public ChannelMessageSink getTarget() { - return target; - } - - public ChannelIdentifier getIdentifier() { - return identifier; - } - - public byte[] getData() { - return Arrays.copyOf(data, data.length); - } - - public ByteArrayInputStream dataAsInputStream() { - return new ByteArrayInputStream(data); - } - - public ByteArrayDataInput dataAsDataStream() { - return ByteStreams.newDataInput(data); - } - - @Override - public String toString() { - return "PluginMessageEvent{" - + "source=" + source - + ", target=" + target - + ", identifier=" + identifier - + ", data=" + Arrays.toString(data) - + ", result=" + result - + '}'; - } + ByteArrayDataInput messageAsDataInput(); /** * A result determining whether or not to forward this message on. */ - public static final class ForwardResult implements ResultedEvent.Result { + public static final class ForwardResult implements Result { private static final ForwardResult ALLOWED = new ForwardResult(true); private static final ForwardResult DENIED = new ForwardResult(false); diff --git a/api/src/main/java/com/velocitypowered/api/event/connection/PluginMessageEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/connection/PluginMessageEventImpl.java new file mode 100644 index 000000000..adc18c7c2 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/connection/PluginMessageEventImpl.java @@ -0,0 +1,101 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.connection; + +import com.google.common.base.Preconditions; +import com.google.common.io.ByteArrayDataInput; +import com.google.common.io.ByteStreams; +import com.velocitypowered.api.proxy.connection.Player; +import com.velocitypowered.api.proxy.connection.ServerConnection; +import com.velocitypowered.api.proxy.messages.ChannelMessageSink; +import com.velocitypowered.api.proxy.messages.ChannelMessageSource; +import com.velocitypowered.api.proxy.messages.PluginChannelId; +import java.io.ByteArrayInputStream; +import java.util.Arrays; + +/** + * This event is fired when a plugin message is sent to the proxy, either from a client ({@link + * Player}) or a server ({@link ServerConnection}). + */ +public final class PluginMessageEventImpl implements PluginMessageEvent { + + private final ChannelMessageSource source; + private final ChannelMessageSink target; + private final PluginChannelId identifier; + private final byte[] data; + private ForwardResult result; + + /** + * Creates a new instance. + * + * @param source the source of the plugin message + * @param target the destination of the plugin message + * @param identifier the channel for this plugin message + * @param data the payload of the plugin message + */ + public PluginMessageEventImpl(ChannelMessageSource source, ChannelMessageSink target, + PluginChannelId identifier, byte[] data) { + this.source = Preconditions.checkNotNull(source, "source"); + this.target = Preconditions.checkNotNull(target, "target"); + this.identifier = Preconditions.checkNotNull(identifier, "identifier"); + this.data = Preconditions.checkNotNull(data, "data"); + this.result = ForwardResult.forward(); + } + + @Override + public ForwardResult result() { + return result; + } + + @Override + public void setResult(ForwardResult result) { + this.result = Preconditions.checkNotNull(result, "result"); + } + + @Override + public ChannelMessageSource source() { + return source; + } + + @Override + public ChannelMessageSink sink() { + return target; + } + + @Override + public PluginChannelId channel() { + return identifier; + } + + @Override + public byte[] rawMessage() { + return Arrays.copyOf(data, data.length); + } + + @Override + public ByteArrayInputStream messageAsInputStream() { + return new ByteArrayInputStream(data); + } + + @Override + public ByteArrayDataInput messageAsDataInput() { + return ByteStreams.newDataInput(data); + } + + @Override + public String toString() { + return "PluginMessageEvent{" + + "source=" + source + + ", target=" + target + + ", identifier=" + identifier + + ", data=" + Arrays.toString(data) + + ", result=" + result + + '}'; + } + +} diff --git a/api/src/main/java/com/velocitypowered/api/event/connection/ProxyPingEvent.java b/api/src/main/java/com/velocitypowered/api/event/connection/ProxyPingEvent.java index f6ee8c5db..fb16908bb 100644 --- a/api/src/main/java/com/velocitypowered/api/event/connection/ProxyPingEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/connection/ProxyPingEvent.java @@ -1,39 +1,23 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.connection; -import com.google.common.base.Preconditions; import com.velocitypowered.api.proxy.connection.InboundConnection; import com.velocitypowered.api.proxy.server.ServerPing; /** * This event is fired when a server list ping request is sent by a remote client. */ -public final class ProxyPingEvent { +public interface ProxyPingEvent { - private final InboundConnection connection; - private ServerPing ping; + InboundConnection connection(); - public ProxyPingEvent(InboundConnection connection, ServerPing ping) { - this.connection = Preconditions.checkNotNull(connection, "connection"); - this.ping = Preconditions.checkNotNull(ping, "ping"); - } + ServerPing ping(); - public InboundConnection getConnection() { - return connection; - } - - public ServerPing getPing() { - return ping; - } - - public void setPing(ServerPing ping) { - this.ping = Preconditions.checkNotNull(ping, "ping"); - } - - @Override - public String toString() { - return "ProxyPingEvent{" - + "connection=" + connection - + ", ping=" + ping - + '}'; - } + void setPing(ServerPing ping); } diff --git a/api/src/main/java/com/velocitypowered/api/event/connection/ProxyPingEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/connection/ProxyPingEventImpl.java new file mode 100644 index 000000000..3a308a4ad --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/connection/ProxyPingEventImpl.java @@ -0,0 +1,49 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.connection; + +import com.google.common.base.Preconditions; +import com.velocitypowered.api.proxy.connection.InboundConnection; +import com.velocitypowered.api.proxy.server.ServerPing; + +/** + * This event is fired when a server list ping request is sent by a remote client. + */ +public final class ProxyPingEventImpl implements ProxyPingEvent { + + private final InboundConnection connection; + private ServerPing ping; + + public ProxyPingEventImpl(InboundConnection connection, ServerPing ping) { + this.connection = Preconditions.checkNotNull(connection, "connection"); + this.ping = Preconditions.checkNotNull(ping, "ping"); + } + + @Override + public InboundConnection connection() { + return connection; + } + + @Override + public ServerPing ping() { + return ping; + } + + @Override + public void setPing(ServerPing ping) { + this.ping = Preconditions.checkNotNull(ping, "ping"); + } + + @Override + public String toString() { + return "ProxyPingEvent{" + + "connection=" + connection + + ", ping=" + ping + + '}'; + } +} diff --git a/api/src/main/java/com/velocitypowered/api/event/connection/ProxyQueryEvent.java b/api/src/main/java/com/velocitypowered/api/event/connection/ProxyQueryEvent.java index f9cf5bf2b..058d357f7 100644 --- a/api/src/main/java/com/velocitypowered/api/event/connection/ProxyQueryEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/connection/ProxyQueryEvent.java @@ -1,80 +1,52 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.connection; -import com.google.common.base.Preconditions; import com.velocitypowered.api.proxy.server.QueryResponse; import java.net.InetAddress; /** * This event is fired if proxy is getting queried over GS4 Query protocol. */ -public final class ProxyQueryEvent { - - private final QueryType queryType; - private final InetAddress querierAddress; - private QueryResponse response; - - /** - * Creates a new event. - * - * @param queryType the type of query - * @param querierAddress the remote address for the query - * @param response the current query response - */ - public ProxyQueryEvent(QueryType queryType, InetAddress querierAddress, QueryResponse response) { - this.queryType = Preconditions.checkNotNull(queryType, "queryType"); - this.querierAddress = Preconditions.checkNotNull(querierAddress, "querierAddress"); - this.response = Preconditions.checkNotNull(response, "response"); - } +public interface ProxyQueryEvent { /** * Returns the kind of query the remote client is performing. * * @return query type */ - public QueryType getQueryType() { - return queryType; - } + QueryType type(); /** * Get the address of the client that sent this query. * * @return querier address */ - public InetAddress getQuerierAddress() { - return querierAddress; - } + InetAddress queryingAddress(); /** * Returns the current query response. * * @return the current query response */ - public QueryResponse getResponse() { - return response; - } + QueryResponse response(); /** * Sets a new query response. * * @param response the new non-null query response */ - public void setResponse(QueryResponse response) { - this.response = Preconditions.checkNotNull(response, "response"); - } - - @Override - public String toString() { - return "ProxyQueryEvent{" - + "queryType=" + queryType - + ", querierAddress=" + querierAddress - + ", response=" + response - + '}'; - } + void setResponse(QueryResponse response); /** * Represents the type of query the client is asking for. */ - public enum QueryType { + enum QueryType { /** * Basic query asks only a subset of information, such as hostname, game type (hardcoded to *
MINECRAFT
), map, current players, max players, proxy port and proxy hostname. diff --git a/api/src/main/java/com/velocitypowered/api/event/connection/ProxyQueryEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/connection/ProxyQueryEventImpl.java new file mode 100644 index 000000000..e45bd26eb --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/connection/ProxyQueryEventImpl.java @@ -0,0 +1,85 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.connection; + +import com.google.common.base.Preconditions; +import com.velocitypowered.api.proxy.server.QueryResponse; +import java.net.InetAddress; + +/** + * This event is fired if proxy is getting queried over GS4 Query protocol. + */ +public final class ProxyQueryEventImpl implements ProxyQueryEvent { + + private final QueryType queryType; + private final InetAddress querierAddress; + private QueryResponse response; + + /** + * Creates a new event. + * + * @param queryType the type of query + * @param querierAddress the remote address for the query + * @param response the current query response + */ + public ProxyQueryEventImpl(QueryType queryType, InetAddress querierAddress, QueryResponse response) { + this.queryType = Preconditions.checkNotNull(queryType, "queryType"); + this.querierAddress = Preconditions.checkNotNull(querierAddress, "querierAddress"); + this.response = Preconditions.checkNotNull(response, "response"); + } + + /** + * Returns the kind of query the remote client is performing. + * + * @return query type + */ + @Override + public QueryType type() { + return queryType; + } + + /** + * Get the address of the client that sent this query. + * + * @return querier address + */ + @Override + public InetAddress queryingAddress() { + return querierAddress; + } + + /** + * Returns the current query response. + * + * @return the current query response + */ + @Override + public QueryResponse response() { + return response; + } + + /** + * Sets a new query response. + * + * @param response the new non-null query response + */ + @Override + public void setResponse(QueryResponse response) { + this.response = Preconditions.checkNotNull(response, "response"); + } + + @Override + public String toString() { + return "ProxyQueryEvent{" + + "queryType=" + queryType + + ", querierAddress=" + querierAddress + + ", response=" + response + + '}'; + } + +} diff --git a/api/src/main/java/com/velocitypowered/api/event/connection/package-info.java b/api/src/main/java/com/velocitypowered/api/event/connection/package-info.java index 8f02c2b15..ed94ee839 100644 --- a/api/src/main/java/com/velocitypowered/api/event/connection/package-info.java +++ b/api/src/main/java/com/velocitypowered/api/event/connection/package-info.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + /** * Provides events for handling incoming connections to the proxy and logins. */ diff --git a/api/src/main/java/com/velocitypowered/api/event/lifecycle/ProxyInitializeEvent.java b/api/src/main/java/com/velocitypowered/api/event/lifecycle/ProxyInitializeEvent.java index 3a55a388d..046ff239a 100644 --- a/api/src/main/java/com/velocitypowered/api/event/lifecycle/ProxyInitializeEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/lifecycle/ProxyInitializeEvent.java @@ -1,13 +1,16 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.lifecycle; /** * This event is fired by the proxy after plugins have been loaded but before the proxy starts * accepting connections. */ -public final class ProxyInitializeEvent { +public interface ProxyInitializeEvent { - @Override - public String toString() { - return "ProxyInitializeEvent"; - } } diff --git a/api/src/main/java/com/velocitypowered/api/event/lifecycle/ProxyInitializeEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/lifecycle/ProxyInitializeEventImpl.java new file mode 100644 index 000000000..a03c85167 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/lifecycle/ProxyInitializeEventImpl.java @@ -0,0 +1,20 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.lifecycle; + +/** + * This event is fired by the proxy after plugins have been loaded but before the proxy starts + * accepting connections. + */ +public final class ProxyInitializeEventImpl implements ProxyInitializeEvent { + + @Override + public String toString() { + return "ProxyInitializeEvent"; + } +} diff --git a/api/src/main/java/com/velocitypowered/api/event/lifecycle/ProxyReloadEvent.java b/api/src/main/java/com/velocitypowered/api/event/lifecycle/ProxyReloadEvent.java index d29684142..763cee952 100644 --- a/api/src/main/java/com/velocitypowered/api/event/lifecycle/ProxyReloadEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/lifecycle/ProxyReloadEvent.java @@ -1,12 +1,15 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.lifecycle; /** * This event is fired when the proxy is reloaded by the user using {@code /velocity reload}. */ -public class ProxyReloadEvent { +public interface ProxyReloadEvent { - @Override - public String toString() { - return "ProxyReloadEvent"; - } } diff --git a/api/src/main/java/com/velocitypowered/api/event/lifecycle/ProxyReloadEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/lifecycle/ProxyReloadEventImpl.java new file mode 100644 index 000000000..4e79a7be4 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/lifecycle/ProxyReloadEventImpl.java @@ -0,0 +1,19 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.lifecycle; + +/** + * This event is fired when the proxy is reloaded by the user using {@code /velocity reload}. + */ +public class ProxyReloadEventImpl implements ProxyReloadEvent { + + @Override + public String toString() { + return "ProxyReloadEvent"; + } +} diff --git a/api/src/main/java/com/velocitypowered/api/event/lifecycle/ProxyShutdownEvent.java b/api/src/main/java/com/velocitypowered/api/event/lifecycle/ProxyShutdownEvent.java index 010b61821..cb0118907 100644 --- a/api/src/main/java/com/velocitypowered/api/event/lifecycle/ProxyShutdownEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/lifecycle/ProxyShutdownEvent.java @@ -1,13 +1,16 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.lifecycle; /** * This event is fired by the proxy after the proxy has stopped accepting connections but before the * proxy process exits. */ -public final class ProxyShutdownEvent { +public interface ProxyShutdownEvent { - @Override - public String toString() { - return "ProxyShutdownEvent"; - } } diff --git a/api/src/main/java/com/velocitypowered/api/event/lifecycle/ProxyShutdownEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/lifecycle/ProxyShutdownEventImpl.java new file mode 100644 index 000000000..15b35ce39 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/lifecycle/ProxyShutdownEventImpl.java @@ -0,0 +1,16 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.lifecycle; + +public final class ProxyShutdownEventImpl implements ProxyShutdownEvent { + + @Override + public String toString() { + return "ProxyShutdownEvent"; + } +} diff --git a/api/src/main/java/com/velocitypowered/api/event/lifecycle/network/ListenerBoundEvent.java b/api/src/main/java/com/velocitypowered/api/event/lifecycle/network/ListenerBoundEvent.java new file mode 100644 index 000000000..e53ed6277 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/lifecycle/network/ListenerBoundEvent.java @@ -0,0 +1,21 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.lifecycle.network; + +import com.velocitypowered.api.network.ListenerType; +import java.net.SocketAddress; + +/** + * This event is fired by the proxy after a listener starts accepting connections. + */ +public interface ListenerBoundEvent { + + SocketAddress address(); + + ListenerType type(); +} diff --git a/api/src/main/java/com/velocitypowered/api/event/lifecycle/network/ListenerBoundEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/lifecycle/network/ListenerBoundEventImpl.java new file mode 100644 index 000000000..a004e4956 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/lifecycle/network/ListenerBoundEventImpl.java @@ -0,0 +1,44 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.lifecycle.network; + +import com.google.common.base.Preconditions; +import com.velocitypowered.api.network.ListenerType; +import java.net.SocketAddress; + +/** + * This event is fired by the proxy after a listener starts accepting connections. + */ +public final class ListenerBoundEventImpl implements ListenerBoundEvent { + + private final SocketAddress address; + private final ListenerType listenerType; + + public ListenerBoundEventImpl(SocketAddress address, ListenerType listenerType) { + this.address = Preconditions.checkNotNull(address, "address"); + this.listenerType = Preconditions.checkNotNull(listenerType, "listenerType"); + } + + @Override + public SocketAddress address() { + return address; + } + + @Override + public ListenerType type() { + return listenerType; + } + + @Override + public String toString() { + return "ListenerBoundEvent{" + + "address=" + address + + ", listenerType=" + listenerType + + '}'; + } +} \ No newline at end of file diff --git a/api/src/main/java/com/velocitypowered/api/event/lifecycle/network/ListenerClosedEvent.java b/api/src/main/java/com/velocitypowered/api/event/lifecycle/network/ListenerClosedEvent.java new file mode 100644 index 000000000..78595935c --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/lifecycle/network/ListenerClosedEvent.java @@ -0,0 +1,21 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.lifecycle.network; + +import com.velocitypowered.api.network.ListenerType; +import java.net.SocketAddress; + +/** + * This event is fired by the proxy before the proxy stops accepting connections. + */ +public interface ListenerClosedEvent { + + SocketAddress address(); + + ListenerType type(); +} diff --git a/api/src/main/java/com/velocitypowered/api/event/lifecycle/network/ListenerClosedEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/lifecycle/network/ListenerClosedEventImpl.java new file mode 100644 index 000000000..fbfa9abf0 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/lifecycle/network/ListenerClosedEventImpl.java @@ -0,0 +1,44 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.lifecycle.network; + +import com.google.common.base.Preconditions; +import com.velocitypowered.api.network.ListenerType; +import java.net.SocketAddress; + +/** + * This event is fired by the proxy before the proxy stops accepting connections. + */ +public final class ListenerClosedEventImpl implements ListenerClosedEvent { + + private final SocketAddress address; + private final ListenerType listenerType; + + public ListenerClosedEventImpl(SocketAddress address, ListenerType listenerType) { + this.address = Preconditions.checkNotNull(address, "address"); + this.listenerType = Preconditions.checkNotNull(listenerType, "listenerType"); + } + + @Override + public SocketAddress address() { + return address; + } + + @Override + public ListenerType type() { + return listenerType; + } + + @Override + public String toString() { + return "ListenerCloseEvent{" + + "address=" + address + + ", listenerType=" + listenerType + + '}'; + } +} \ No newline at end of file diff --git a/api/src/main/java/com/velocitypowered/api/event/lifecycle/package-info.java b/api/src/main/java/com/velocitypowered/api/event/lifecycle/package-info.java index c19111823..6e3a04bac 100644 --- a/api/src/main/java/com/velocitypowered/api/event/lifecycle/package-info.java +++ b/api/src/main/java/com/velocitypowered/api/event/lifecycle/package-info.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + /** * Provides events for handling the lifecycle of the proxy. */ diff --git a/api/src/main/java/com/velocitypowered/api/event/package-info.java b/api/src/main/java/com/velocitypowered/api/event/package-info.java index 34819f6ba..7fdc617ec 100644 --- a/api/src/main/java/com/velocitypowered/api/event/package-info.java +++ b/api/src/main/java/com/velocitypowered/api/event/package-info.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + /** * Provides core support for handling events with Velocity. Subpackages include event classes. */ diff --git a/api/src/main/java/com/velocitypowered/api/event/permission/PermissionsSetupEvent.java b/api/src/main/java/com/velocitypowered/api/event/permission/PermissionsSetupEvent.java index f7232a1d0..99241271a 100644 --- a/api/src/main/java/com/velocitypowered/api/event/permission/PermissionsSetupEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/permission/PermissionsSetupEvent.java @@ -1,6 +1,12 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.permission; -import com.google.common.base.Preconditions; import com.velocitypowered.api.permission.PermissionFunction; import com.velocitypowered.api.permission.PermissionProvider; import com.velocitypowered.api.permission.PermissionSubject; @@ -11,20 +17,9 @@ import org.checkerframework.checker.nullness.qual.Nullable; * *

This event is only called once per subject, on initialisation.

*/ -public final class PermissionsSetupEvent { +public interface PermissionsSetupEvent { - private final PermissionSubject subject; - private final PermissionProvider defaultProvider; - private PermissionProvider provider; - - public PermissionsSetupEvent(PermissionSubject subject, PermissionProvider provider) { - this.subject = Preconditions.checkNotNull(subject, "subject"); - this.provider = this.defaultProvider = Preconditions.checkNotNull(provider, "provider"); - } - - public PermissionSubject getSubject() { - return this.subject; - } + PermissionSubject subject(); /** * Uses the provider function to obtain a {@link PermissionFunction} for the subject. @@ -32,13 +27,9 @@ public final class PermissionsSetupEvent { * @param subject the subject * @return the obtained permission function */ - public PermissionFunction createFunction(PermissionSubject subject) { - return this.provider.createFunction(subject); - } + PermissionFunction createFunction(PermissionSubject subject); - public PermissionProvider getProvider() { - return this.provider; - } + PermissionProvider provider(); /** * Sets the {@link PermissionFunction} that should be used for the subject. @@ -48,16 +39,5 @@ public final class PermissionsSetupEvent { * * @param provider the provider */ - public void setProvider(@Nullable PermissionProvider provider) { - this.provider = provider == null ? this.defaultProvider : provider; - } - - @Override - public String toString() { - return "PermissionsSetupEvent{" - + "subject=" + subject - + ", defaultProvider=" + defaultProvider - + ", provider=" + provider - + '}'; - } + void setProvider(@Nullable PermissionProvider provider); } diff --git a/api/src/main/java/com/velocitypowered/api/event/permission/PermissionsSetupEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/permission/PermissionsSetupEventImpl.java new file mode 100644 index 000000000..36f9488e4 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/permission/PermissionsSetupEventImpl.java @@ -0,0 +1,74 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.permission; + +import com.google.common.base.Preconditions; +import com.velocitypowered.api.permission.PermissionFunction; +import com.velocitypowered.api.permission.PermissionProvider; +import com.velocitypowered.api.permission.PermissionSubject; +import org.checkerframework.checker.nullness.qual.Nullable; + +/** + * Called when a {@link PermissionSubject}'s permissions are being setup. + * + *

This event is only called once per subject, on initialisation.

+ */ +public final class PermissionsSetupEventImpl implements PermissionsSetupEvent { + + private final PermissionSubject subject; + private final PermissionProvider defaultProvider; + private PermissionProvider provider; + + public PermissionsSetupEventImpl(PermissionSubject subject, PermissionProvider provider) { + this.subject = Preconditions.checkNotNull(subject, "subject"); + this.provider = this.defaultProvider = Preconditions.checkNotNull(provider, "provider"); + } + + @Override + public PermissionSubject subject() { + return this.subject; + } + + /** + * Uses the provider function to obtain a {@link PermissionFunction} for the subject. + * + * @param subject the subject + * @return the obtained permission function + */ + @Override + public PermissionFunction createFunction(PermissionSubject subject) { + return this.provider.createFunction(subject); + } + + @Override + public PermissionProvider provider() { + return this.provider; + } + + /** + * Sets the {@link PermissionFunction} that should be used for the subject. + * + *

Specifying null will reset the provider to the default + * instance given when the event was posted.

+ * + * @param provider the provider + */ + @Override + public void setProvider(@Nullable PermissionProvider provider) { + this.provider = provider == null ? this.defaultProvider : provider; + } + + @Override + public String toString() { + return "PermissionsSetupEvent{" + + "subject=" + subject + + ", defaultProvider=" + defaultProvider + + ", provider=" + provider + + '}'; + } +} diff --git a/api/src/main/java/com/velocitypowered/api/event/permission/package-info.java b/api/src/main/java/com/velocitypowered/api/event/permission/package-info.java index 402d8db84..9f1eb764c 100644 --- a/api/src/main/java/com/velocitypowered/api/event/permission/package-info.java +++ b/api/src/main/java/com/velocitypowered/api/event/permission/package-info.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + /** * Provides events to handle setting up permissions for permission subjects. */ diff --git a/api/src/main/java/com/velocitypowered/api/event/player/DisconnectEvent.java b/api/src/main/java/com/velocitypowered/api/event/player/DisconnectEvent.java index 12c238370..85f0744e8 100644 --- a/api/src/main/java/com/velocitypowered/api/event/player/DisconnectEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/player/DisconnectEvent.java @@ -1,37 +1,23 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.player; -import com.google.common.base.Preconditions; import com.velocitypowered.api.proxy.connection.Player; /** * This event is fired when a player disconnects from the proxy. Operations on the provided player, * aside from basic data retrieval operations, may behave in undefined ways. */ -public final class DisconnectEvent { +public interface DisconnectEvent { - private final Player player; - private final LoginStatus loginStatus; + Player player(); - public DisconnectEvent(Player player, LoginStatus loginStatus) { - this.player = Preconditions.checkNotNull(player, "player"); - this.loginStatus = Preconditions.checkNotNull(loginStatus, "loginStatus"); - } - - public Player getPlayer() { - return player; - } - - public LoginStatus getLoginStatus() { - return loginStatus; - } - - @Override - public String toString() { - return "DisconnectEvent{" - + "player=" + player + ", " - + "loginStatus=" + loginStatus - + '}'; - } + LoginStatus loginStatus(); public enum LoginStatus { diff --git a/api/src/main/java/com/velocitypowered/api/event/player/DisconnectEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/player/DisconnectEventImpl.java new file mode 100644 index 000000000..a6a55b81c --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/player/DisconnectEventImpl.java @@ -0,0 +1,45 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.player; + +import com.google.common.base.Preconditions; +import com.velocitypowered.api.proxy.connection.Player; + +/** + * This event is fired when a player disconnects from the proxy. Operations on the provided player, + * aside from basic data retrieval operations, may behave in undefined ways. + */ +public final class DisconnectEventImpl implements DisconnectEvent { + + private final Player player; + private final LoginStatus loginStatus; + + public DisconnectEventImpl(Player player, LoginStatus loginStatus) { + this.player = Preconditions.checkNotNull(player, "player"); + this.loginStatus = Preconditions.checkNotNull(loginStatus, "loginStatus"); + } + + @Override + public Player player() { + return player; + } + + @Override + public LoginStatus loginStatus() { + return loginStatus; + } + + @Override + public String toString() { + return "DisconnectEvent{" + + "player=" + player + ", " + + "loginStatus=" + loginStatus + + '}'; + } + +} diff --git a/api/src/main/java/com/velocitypowered/api/event/player/GameProfileRequestEvent.java b/api/src/main/java/com/velocitypowered/api/event/player/GameProfileRequestEvent.java index a2386f539..cb6efa4c4 100644 --- a/api/src/main/java/com/velocitypowered/api/event/player/GameProfileRequestEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/player/GameProfileRequestEvent.java @@ -1,52 +1,29 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.player; -import com.google.common.base.Preconditions; import com.velocitypowered.api.proxy.connection.InboundConnection; import com.velocitypowered.api.util.GameProfile; import org.checkerframework.checker.nullness.qual.Nullable; /** - * This event is fired after the {@link PreLoginEvent} in - * order to set up the game profile for the user. This can be used to configure a custom profile for - * a user, i.e. skin replacement. + * This event is fired after the {@link PreLoginEventImpl} in order to set up the game profile for + * the user. This can be used to configure a custom profile for a user, i.e. skin replacement. */ -public final class GameProfileRequestEvent { +public interface GameProfileRequestEvent { - private final String username; - private final InboundConnection connection; - private final GameProfile originalProfile; - private final boolean onlineMode; - private @Nullable GameProfile gameProfile; + InboundConnection connection(); - /** - * Creates a new instance. - * @param connection the connection connecting to the proxy - * @param originalProfile the original {@link GameProfile} for the user - * @param onlineMode whether or not the user connected in online or offline mode - */ - public GameProfileRequestEvent(InboundConnection connection, GameProfile originalProfile, - boolean onlineMode) { - this.connection = Preconditions.checkNotNull(connection, "connection"); - this.originalProfile = Preconditions.checkNotNull(originalProfile, "originalProfile"); - this.username = originalProfile.getName(); - this.onlineMode = onlineMode; - } + String username(); - public InboundConnection getConnection() { - return connection; - } + GameProfile initialProfile(); - public String getUsername() { - return username; - } - - public GameProfile getOriginalProfile() { - return originalProfile; - } - - public boolean isOnlineMode() { - return onlineMode; - } + boolean isOnlineMode(); /** * Returns the game profile that will be used to initialize the connection with. Should no profile @@ -55,26 +32,12 @@ public final class GameProfileRequestEvent { * * @return the user's {@link GameProfile} */ - public GameProfile getGameProfile() { - return gameProfile == null ? originalProfile : gameProfile; - } + GameProfile gameProfile(); /** * Sets the game profile to use for this connection. * * @param gameProfile the profile for this connection, {@code null} uses the original profile */ - public void setGameProfile(@Nullable GameProfile gameProfile) { - this.gameProfile = gameProfile; - } - - @Override - public String toString() { - return "GameProfileRequestEvent{" - + "username=" + username - + ", gameProfile=" + gameProfile - + "}"; - } - - + void setGameProfile(@Nullable GameProfile gameProfile); } diff --git a/api/src/main/java/com/velocitypowered/api/event/player/GameProfileRequestEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/player/GameProfileRequestEventImpl.java new file mode 100644 index 000000000..aa3a25535 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/player/GameProfileRequestEventImpl.java @@ -0,0 +1,92 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.player; + +import com.google.common.base.Preconditions; +import com.velocitypowered.api.proxy.connection.InboundConnection; +import com.velocitypowered.api.util.GameProfile; +import org.checkerframework.checker.nullness.qual.Nullable; + +/** + * This event is fired after the {@link PreLoginEventImpl} in order to set up the game profile for + * the user. This can be used to configure a custom profile for a user, i.e. skin replacement. + */ +public final class GameProfileRequestEventImpl implements GameProfileRequestEvent { + + private final String username; + private final InboundConnection connection; + private final GameProfile originalProfile; + private final boolean onlineMode; + private @Nullable GameProfile gameProfile; + + /** + * Creates a new instance. + * @param connection the connection connecting to the proxy + * @param originalProfile the original {@link GameProfile} for the user + * @param onlineMode whether or not the user connected in online or offline mode + */ + public GameProfileRequestEventImpl(InboundConnection connection, GameProfile originalProfile, + boolean onlineMode) { + this.connection = Preconditions.checkNotNull(connection, "connection"); + this.originalProfile = Preconditions.checkNotNull(originalProfile, "originalProfile"); + this.username = originalProfile.getName(); + this.onlineMode = onlineMode; + } + + @Override + public InboundConnection connection() { + return connection; + } + + @Override + public String username() { + return username; + } + + @Override + public GameProfile initialProfile() { + return originalProfile; + } + + @Override + public boolean isOnlineMode() { + return onlineMode; + } + + /** + * Returns the game profile that will be used to initialize the connection with. Should no profile + * be currently specified, the one generated by the proxy (for offline mode) or retrieved from the + * Mojang session servers (for online mode) will be returned instead. + * + * @return the user's {@link GameProfile} + */ + @Override + public GameProfile gameProfile() { + return gameProfile == null ? originalProfile : gameProfile; + } + + /** + * Sets the game profile to use for this connection. + * + * @param gameProfile the profile for this connection, {@code null} uses the original profile + */ + @Override + public void setGameProfile(@Nullable GameProfile gameProfile) { + this.gameProfile = gameProfile; + } + + @Override + public String toString() { + return "GameProfileRequestEvent{" + + "username=" + username + + ", gameProfile=" + gameProfile + + "}"; + } + + +} diff --git a/api/src/main/java/com/velocitypowered/api/event/player/KickedFromServerEvent.java b/api/src/main/java/com/velocitypowered/api/event/player/KickedFromServerEvent.java index 75a8c3af2..07044d907 100644 --- a/api/src/main/java/com/velocitypowered/api/event/player/KickedFromServerEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/player/KickedFromServerEvent.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.player; import com.google.common.base.Preconditions; @@ -6,7 +13,6 @@ import com.velocitypowered.api.proxy.connection.Player; import com.velocitypowered.api.proxy.server.RegisteredServer; import java.util.Optional; import net.kyori.adventure.text.Component; -import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; /** @@ -15,84 +21,43 @@ import org.checkerframework.checker.nullness.qual.Nullable; * Velocity will notify the user (if they are already connected to a server) or disconnect them * (if they are not on a server and no other servers are available). */ -public final class KickedFromServerEvent implements +public interface KickedFromServerEvent extends ResultedEvent { - private final Player player; - private final RegisteredServer server; - private final @Nullable Component originalReason; - private final boolean duringServerConnect; - private ServerKickResult result; + Player player(); - /** - * Creates a {@code KickedFromServerEvent} instance. - * @param player the player affected - * @param server the server the player disconnected from - * @param originalReason the reason for being kicked, optional - * @param duringServerConnect whether or not the player was kicked during the connection process - * @param result the initial result - */ - public KickedFromServerEvent(Player player, RegisteredServer server, - net.kyori.adventure.text.@Nullable Component originalReason, - boolean duringServerConnect, ServerKickResult result) { - this.player = Preconditions.checkNotNull(player, "player"); - this.server = Preconditions.checkNotNull(server, "server"); - this.originalReason = originalReason; - this.duringServerConnect = duringServerConnect; - this.result = Preconditions.checkNotNull(result, "result"); - } - - @Override - public ServerKickResult getResult() { - return result; - } - - @Override - public void setResult(@NonNull ServerKickResult result) { - this.result = Preconditions.checkNotNull(result, "result"); - } - - public Player getPlayer() { - return player; - } - - public RegisteredServer getServer() { - return server; - } + RegisteredServer server(); /** * Gets the reason the server kicked the player from the server. + * * @return the server kicked the player from the server */ - public Optional getServerKickReason() { - return Optional.ofNullable(originalReason); - } + Optional serverKickReason(); /** * Returns whether or not the player got kicked while connecting to another server. * * @return whether or not the player got kicked */ - public boolean kickedDuringServerConnect() { - return duringServerConnect; - } + boolean kickedDuringServerConnect(); /** * Represents the base interface for {@link KickedFromServerEvent} results. */ - public interface ServerKickResult extends ResultedEvent.Result { + public interface ServerKickResult extends Result { } /** * Tells the proxy to disconnect the player with the specified reason. */ - public static final class DisconnectPlayer implements ServerKickResult { + final class DisconnectPlayer implements ServerKickResult { - private final Component component; + private final Component message; - private DisconnectPlayer(Component component) { - this.component = Preconditions.checkNotNull(component, "component"); + private DisconnectPlayer(Component message) { + this.message = Preconditions.checkNotNull(message, "message"); } @Override @@ -100,8 +65,8 @@ public final class KickedFromServerEvent implements return true; } - public Component getReason() { - return component; + public Component message() { + return message; } /** @@ -119,13 +84,13 @@ public final class KickedFromServerEvent implements * Tells the proxy to redirect the player to another server. No messages will be sent from the * proxy when this result is used. */ - public static final class RedirectPlayer implements ServerKickResult { + final class RedirectPlayer implements ServerKickResult { private final Component message; private final RegisteredServer server; private RedirectPlayer(RegisteredServer server, - net.kyori.adventure.text.@Nullable Component message) { + @Nullable Component message) { this.server = Preconditions.checkNotNull(server, "server"); this.message = message; } @@ -139,7 +104,7 @@ public final class KickedFromServerEvent implements return server; } - public Component getMessage() { + public Component message() { return message; } @@ -164,7 +129,7 @@ public final class KickedFromServerEvent implements * result to use if the player was trying to connect to a different server, otherwise it is * treated like a {@link DisconnectPlayer} result. */ - public static final class Notify implements ServerKickResult { + final class Notify implements ServerKickResult { private final Component message; @@ -177,7 +142,7 @@ public final class KickedFromServerEvent implements return false; } - public Component getMessage() { + public Component message() { return message; } diff --git a/api/src/main/java/com/velocitypowered/api/event/player/KickedFromServerEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/player/KickedFromServerEventImpl.java new file mode 100644 index 000000000..8591bd7f8 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/player/KickedFromServerEventImpl.java @@ -0,0 +1,89 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.player; + +import com.google.common.base.Preconditions; +import com.velocitypowered.api.proxy.connection.Player; +import com.velocitypowered.api.proxy.server.RegisteredServer; +import java.util.Optional; +import net.kyori.adventure.text.Component; +import org.checkerframework.checker.nullness.qual.NonNull; +import org.checkerframework.checker.nullness.qual.Nullable; + +/** + * Fired when a player is kicked from a server. You may either allow Velocity to kick the player + * (with an optional reason override) or redirect the player to a separate server. By default, + * Velocity will notify the user (if they are already connected to a server) or disconnect them + * (if they are not on a server and no other servers are available). + */ +public final class KickedFromServerEventImpl implements KickedFromServerEvent { + + private final Player player; + private final RegisteredServer server; + private final @Nullable Component originalReason; + private final boolean duringServerConnect; + private ServerKickResult result; + + /** + * Creates a {@code KickedFromServerEvent} instance. + * @param player the player affected + * @param server the server the player disconnected from + * @param originalReason the reason for being kicked, optional + * @param duringServerConnect whether or not the player was kicked during the connection process + * @param result the initial result + */ + public KickedFromServerEventImpl(Player player, RegisteredServer server, + net.kyori.adventure.text.@Nullable Component originalReason, + boolean duringServerConnect, ServerKickResult result) { + this.player = Preconditions.checkNotNull(player, "player"); + this.server = Preconditions.checkNotNull(server, "server"); + this.originalReason = originalReason; + this.duringServerConnect = duringServerConnect; + this.result = Preconditions.checkNotNull(result, "result"); + } + + @Override + public ServerKickResult result() { + return result; + } + + @Override + public void setResult(@NonNull ServerKickResult result) { + this.result = Preconditions.checkNotNull(result, "result"); + } + + @Override + public Player player() { + return player; + } + + @Override + public RegisteredServer server() { + return server; + } + + /** + * Gets the reason the server kicked the player from the server. + * @return the server kicked the player from the server + */ + @Override + public Optional serverKickReason() { + return Optional.ofNullable(originalReason); + } + + /** + * Returns whether or not the player got kicked while connecting to another server. + * + * @return whether or not the player got kicked + */ + @Override + public boolean kickedDuringServerConnect() { + return duringServerConnect; + } + +} diff --git a/api/src/main/java/com/velocitypowered/api/event/player/LoginEvent.java b/api/src/main/java/com/velocitypowered/api/event/player/LoginEvent.java index e90137bcc..fd909dfff 100644 --- a/api/src/main/java/com/velocitypowered/api/event/player/LoginEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/player/LoginEvent.java @@ -1,6 +1,12 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.player; -import com.google.common.base.Preconditions; import com.velocitypowered.api.event.ResultedEvent; import com.velocitypowered.api.proxy.connection.Player; @@ -8,35 +14,8 @@ import com.velocitypowered.api.proxy.connection.Player; * This event is fired once the player has been authenticated but before they connect to a server on * the proxy. */ -public final class LoginEvent implements ResultedEvent { +public interface LoginEvent extends ResultedEvent { - private final Player player; - private ComponentResult result; + Player player(); - public LoginEvent(Player player) { - this.player = Preconditions.checkNotNull(player, "player"); - this.result = ComponentResult.allowed(); - } - - public Player getPlayer() { - return player; - } - - @Override - public ComponentResult getResult() { - return result; - } - - @Override - public void setResult(ComponentResult result) { - this.result = Preconditions.checkNotNull(result, "result"); - } - - @Override - public String toString() { - return "LoginEvent{" - + "player=" + player - + ", result=" + result - + '}'; - } } diff --git a/api/src/main/java/com/velocitypowered/api/event/player/LoginEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/player/LoginEventImpl.java new file mode 100644 index 000000000..4735361e2 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/player/LoginEventImpl.java @@ -0,0 +1,49 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.player; + +import com.google.common.base.Preconditions; +import com.velocitypowered.api.proxy.connection.Player; + +/** + * This event is fired once the player has been authenticated but before they connect to a server on + * the proxy. + */ +public final class LoginEventImpl implements LoginEvent { + + private final Player player; + private ComponentResult result; + + public LoginEventImpl(Player player) { + this.player = Preconditions.checkNotNull(player, "player"); + this.result = ComponentResult.allowed(); + } + + @Override + public Player player() { + return player; + } + + @Override + public ComponentResult result() { + return result; + } + + @Override + public void setResult(ComponentResult result) { + this.result = Preconditions.checkNotNull(result, "result"); + } + + @Override + public String toString() { + return "LoginEvent{" + + "player=" + player + + ", result=" + result + + '}'; + } +} diff --git a/api/src/main/java/com/velocitypowered/api/event/player/PlayerChannelRegisterEvent.java b/api/src/main/java/com/velocitypowered/api/event/player/PlayerChannelRegisterEvent.java index 2672f3632..891c29bb6 100644 --- a/api/src/main/java/com/velocitypowered/api/event/player/PlayerChannelRegisterEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/player/PlayerChannelRegisterEvent.java @@ -1,38 +1,23 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.player; -import com.google.common.base.Preconditions; import com.velocitypowered.api.proxy.connection.Player; -import com.velocitypowered.api.proxy.messages.ChannelIdentifier; - +import com.velocitypowered.api.proxy.messages.PluginChannelId; import java.util.List; /** * This event is fired when a client ({@link Player}) sends a plugin message through the * register channel. */ -public final class PlayerChannelRegisterEvent { +public interface PlayerChannelRegisterEvent { - private final Player player; - private final List channels; + Player player(); - public PlayerChannelRegisterEvent(Player player, List channels) { - this.player = Preconditions.checkNotNull(player, "player"); - this.channels = Preconditions.checkNotNull(channels, "channels"); - } - - public Player getPlayer() { - return player; - } - - public List getChannels() { - return channels; - } - - @Override - public String toString() { - return "PlayerChannelRegisterEvent{" - + "player=" + player - + ", channels=" + channels - + '}'; - } + List channels(); } diff --git a/api/src/main/java/com/velocitypowered/api/event/player/PlayerChannelRegisterEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/player/PlayerChannelRegisterEventImpl.java new file mode 100644 index 000000000..8f30d69ba --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/player/PlayerChannelRegisterEventImpl.java @@ -0,0 +1,46 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.player; + +import com.google.common.base.Preconditions; +import com.velocitypowered.api.proxy.connection.Player; +import com.velocitypowered.api.proxy.messages.PluginChannelId; +import java.util.List; + +/** + * This event is fired when a client ({@link Player}) sends a plugin message through the + * register channel. + */ +public final class PlayerChannelRegisterEventImpl implements PlayerChannelRegisterEvent { + + private final Player player; + private final List channels; + + public PlayerChannelRegisterEventImpl(Player player, List channels) { + this.player = Preconditions.checkNotNull(player, "player"); + this.channels = Preconditions.checkNotNull(channels, "channels"); + } + + @Override + public Player player() { + return player; + } + + @Override + public List channels() { + return channels; + } + + @Override + public String toString() { + return "PlayerChannelRegisterEvent{" + + "player=" + player + + ", channels=" + channels + + '}'; + } +} diff --git a/api/src/main/java/com/velocitypowered/api/event/player/PlayerChatEvent.java b/api/src/main/java/com/velocitypowered/api/event/player/PlayerChatEvent.java index 43d422714..a8b390bd9 100644 --- a/api/src/main/java/com/velocitypowered/api/event/player/PlayerChatEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/player/PlayerChatEvent.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.player; import com.google.common.base.Preconditions; @@ -7,57 +14,16 @@ import java.util.Optional; import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; -/** - * This event is fired when a player types in a chat message. - */ -public final class PlayerChatEvent implements ResultedEvent { +public interface PlayerChatEvent extends ResultedEvent { - private final Player player; - private final String message; - private ChatResult result; + Player player(); - /** - * Constructs a PlayerChatEvent. - * @param player the player sending the message - * @param message the message being sent - */ - public PlayerChatEvent(Player player, String message) { - this.player = Preconditions.checkNotNull(player, "player"); - this.message = Preconditions.checkNotNull(message, "message"); - this.result = ChatResult.allowed(); - } - - public Player getPlayer() { - return player; - } - - public String getMessage() { - return message; - } - - @Override - public ChatResult getResult() { - return result; - } - - @Override - public void setResult(ChatResult result) { - this.result = Preconditions.checkNotNull(result, "result"); - } - - @Override - public String toString() { - return "PlayerChatEvent{" - + "player=" + player - + ", message=" + message - + ", result=" + result - + '}'; - } + String sentMessage(); /** * Represents the result of the {@link PlayerChatEvent}. */ - public static final class ChatResult implements ResultedEvent.Result { + final class ChatResult implements Result { private static final ChatResult ALLOWED = new ChatResult(true, null); private static final ChatResult DENIED = new ChatResult(false, null); @@ -70,7 +36,7 @@ public final class PlayerChatEvent implements ResultedEvent getMessage() { + public Optional modifiedMessage() { return Optional.ofNullable(message); } @@ -86,6 +52,7 @@ public final class PlayerChatEvent implements ResultedEvent getInitialServer() { - return Optional.ofNullable(initialServer); - } + Optional initialServer(); /** * Sets the new initial server. + * * @param server the initial server the player should connect to */ - public void setInitialServer(RegisteredServer server) { - this.initialServer = server; - } - - @Override - public String toString() { - return "PlayerChooseInitialServerEvent{" - + "player=" + player - + ", initialServer=" + initialServer - + '}'; - } + void setInitialServer(RegisteredServer server); } diff --git a/api/src/main/java/com/velocitypowered/api/event/player/PlayerChooseInitialServerEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/player/PlayerChooseInitialServerEventImpl.java new file mode 100644 index 000000000..19bbb95c5 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/player/PlayerChooseInitialServerEventImpl.java @@ -0,0 +1,61 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.player; + +import com.google.common.base.Preconditions; +import com.velocitypowered.api.proxy.connection.Player; +import com.velocitypowered.api.proxy.server.RegisteredServer; +import java.util.Optional; +import org.checkerframework.checker.nullness.qual.Nullable; + +/** + * Fired when a player has finished connecting to the proxy and we need to choose the first server + * to connect to. + */ +public class PlayerChooseInitialServerEventImpl implements PlayerChooseInitialServerEvent { + + private final Player player; + private @Nullable RegisteredServer initialServer; + + /** + * Constructs a PlayerChooseInitialServerEvent. + * @param player the player that was connected + * @param initialServer the initial server selected, may be {@code null} + */ + public PlayerChooseInitialServerEventImpl(Player player, @Nullable RegisteredServer initialServer) { + this.player = Preconditions.checkNotNull(player, "player"); + this.initialServer = initialServer; + } + + @Override + public Player player() { + return player; + } + + @Override + public Optional initialServer() { + return Optional.ofNullable(initialServer); + } + + /** + * Sets the new initial server. + * @param server the initial server the player should connect to + */ + @Override + public void setInitialServer(RegisteredServer server) { + this.initialServer = server; + } + + @Override + public String toString() { + return "PlayerChooseInitialServerEvent{" + + "player=" + player + + ", initialServer=" + initialServer + + '}'; + } +} diff --git a/api/src/main/java/com/velocitypowered/api/event/player/PlayerClientSettingsChangedEvent.java b/api/src/main/java/com/velocitypowered/api/event/player/PlayerClientSettingsChangedEvent.java new file mode 100644 index 000000000..8b12d268a --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/player/PlayerClientSettingsChangedEvent.java @@ -0,0 +1,18 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.player; + +import com.velocitypowered.api.proxy.connection.Player; +import com.velocitypowered.api.proxy.player.ClientSettings; + +public interface PlayerClientSettingsChangedEvent { + + Player player(); + + ClientSettings settings(); +} diff --git a/api/src/main/java/com/velocitypowered/api/event/player/PlayerClientSettingsChangedEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/player/PlayerClientSettingsChangedEventImpl.java new file mode 100644 index 000000000..d16df9fc4 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/player/PlayerClientSettingsChangedEventImpl.java @@ -0,0 +1,43 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.player; + +import com.google.common.base.MoreObjects; +import com.google.common.base.Preconditions; +import com.velocitypowered.api.proxy.connection.Player; +import com.velocitypowered.api.proxy.player.ClientSettings; + +public final class PlayerClientSettingsChangedEventImpl implements + PlayerClientSettingsChangedEvent { + + private final Player player; + private final ClientSettings clientSettings; + + public PlayerClientSettingsChangedEventImpl(Player player, ClientSettings clientSettings) { + this.player = Preconditions.checkNotNull(player, "player"); + this.clientSettings = Preconditions.checkNotNull(clientSettings, "playerSettings"); + } + + @Override + public Player player() { + return player; + } + + @Override + public ClientSettings settings() { + return clientSettings; + } + + @Override + public String toString() { + return MoreObjects.toStringHelper(this) + .add("player", player) + .add("playerSettings", clientSettings) + .toString(); + } +} diff --git a/api/src/main/java/com/velocitypowered/api/event/player/PlayerModInfoEvent.java b/api/src/main/java/com/velocitypowered/api/event/player/PlayerModInfoEvent.java index b881bbb06..020fd4c9e 100644 --- a/api/src/main/java/com/velocitypowered/api/event/player/PlayerModInfoEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/player/PlayerModInfoEvent.java @@ -1,36 +1,22 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.player; -import com.google.common.base.MoreObjects; -import com.google.common.base.Preconditions; import com.velocitypowered.api.proxy.connection.Player; import com.velocitypowered.api.util.ModInfo; /** - * This event is fired when a Forge client sends its mods to the proxy while connecting to a server. + * This event is fired when a modded client sends its mods to the proxy while connecting to a + * server. */ -public final class PlayerModInfoEvent { +public interface PlayerModInfoEvent { - private final Player player; - private final ModInfo modInfo; + Player player(); - public PlayerModInfoEvent(Player player, ModInfo modInfo) { - this.player = Preconditions.checkNotNull(player, "player"); - this.modInfo = Preconditions.checkNotNull(modInfo, "modInfo"); - } - - public Player getPlayer() { - return player; - } - - public ModInfo getModInfo() { - return modInfo; - } - - @Override - public String toString() { - return MoreObjects.toStringHelper(this) - .add("player", player) - .add("modInfo", modInfo) - .toString(); - } + ModInfo modInfo(); } diff --git a/api/src/main/java/com/velocitypowered/api/event/player/PlayerModInfoEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/player/PlayerModInfoEventImpl.java new file mode 100644 index 000000000..6b0c1d1d6 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/player/PlayerModInfoEventImpl.java @@ -0,0 +1,42 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.player; + +import com.google.common.base.MoreObjects; +import com.google.common.base.Preconditions; +import com.velocitypowered.api.proxy.connection.Player; +import com.velocitypowered.api.util.ModInfo; + +public final class PlayerModInfoEventImpl implements PlayerModInfoEvent { + + private final Player player; + private final ModInfo modInfo; + + public PlayerModInfoEventImpl(Player player, ModInfo modInfo) { + this.player = Preconditions.checkNotNull(player, "player"); + this.modInfo = Preconditions.checkNotNull(modInfo, "modInfo"); + } + + @Override + public Player player() { + return player; + } + + @Override + public ModInfo modInfo() { + return modInfo; + } + + @Override + public String toString() { + return MoreObjects.toStringHelper(this) + .add("player", player) + .add("modInfo", modInfo) + .toString(); + } +} diff --git a/api/src/main/java/com/velocitypowered/api/event/player/PlayerResourcePackStatusEvent.java b/api/src/main/java/com/velocitypowered/api/event/player/PlayerResourcePackStatusEvent.java index e41ed6acf..1e3a75a39 100644 --- a/api/src/main/java/com/velocitypowered/api/event/player/PlayerResourcePackStatusEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/player/PlayerResourcePackStatusEvent.java @@ -1,52 +1,38 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.player; -import com.google.common.base.Preconditions; import com.velocitypowered.api.proxy.connection.Player; /** * This event is fired when the status of a resource pack sent to the player by the server is * changed. */ -public class PlayerResourcePackStatusEvent { - - private final Player player; - private final Status status; - - public PlayerResourcePackStatusEvent(Player player, Status status) { - this.player = Preconditions.checkNotNull(player, "player"); - this.status = Preconditions.checkNotNull(status, "status"); - } +public interface PlayerResourcePackStatusEvent { /** * Returns the player affected by the change in resource pack status. * * @return the player */ - public Player getPlayer() { - return player; - } + Player player(); /** * Returns the new status for the resource pack. * * @return the new status */ - public Status getStatus() { - return status; - } - - @Override - public String toString() { - return "PlayerResourcePackStatusEvent{" - + "player=" + player - + ", status=" + status - + '}'; - } + Status status(); /** * Represents the possible statuses for the resource pack. */ - public enum Status { + enum Status { /** * The resource pack was applied successfully. */ diff --git a/api/src/main/java/com/velocitypowered/api/event/player/PlayerResourcePackStatusEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/player/PlayerResourcePackStatusEventImpl.java new file mode 100644 index 000000000..55dadc7e9 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/player/PlayerResourcePackStatusEventImpl.java @@ -0,0 +1,55 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.player; + +import com.google.common.base.Preconditions; +import com.velocitypowered.api.proxy.connection.Player; + +/** + * This event is fired when the status of a resource pack sent to the player by the server is + * changed. + */ +public class PlayerResourcePackStatusEventImpl implements PlayerResourcePackStatusEvent { + + private final Player player; + private final Status status; + + public PlayerResourcePackStatusEventImpl(Player player, Status status) { + this.player = Preconditions.checkNotNull(player, "player"); + this.status = Preconditions.checkNotNull(status, "status"); + } + + /** + * Returns the player affected by the change in resource pack status. + * + * @return the player + */ + @Override + public Player player() { + return player; + } + + /** + * Returns the new status for the resource pack. + * + * @return the new status + */ + @Override + public Status status() { + return status; + } + + @Override + public String toString() { + return "PlayerResourcePackStatusEvent{" + + "player=" + player + + ", status=" + status + + '}'; + } + +} diff --git a/api/src/main/java/com/velocitypowered/api/event/player/PlayerSettingsChangedEvent.java b/api/src/main/java/com/velocitypowered/api/event/player/PlayerSettingsChangedEvent.java deleted file mode 100644 index c9574dbaf..000000000 --- a/api/src/main/java/com/velocitypowered/api/event/player/PlayerSettingsChangedEvent.java +++ /dev/null @@ -1,33 +0,0 @@ -package com.velocitypowered.api.event.player; - -import com.google.common.base.MoreObjects; -import com.google.common.base.Preconditions; -import com.velocitypowered.api.proxy.connection.Player; -import com.velocitypowered.api.proxy.player.PlayerSettings; - -public final class PlayerSettingsChangedEvent { - - private final Player player; - private final PlayerSettings playerSettings; - - public PlayerSettingsChangedEvent(Player player, PlayerSettings playerSettings) { - this.player = Preconditions.checkNotNull(player, "player"); - this.playerSettings = Preconditions.checkNotNull(playerSettings, "playerSettings"); - } - - public Player getPlayer() { - return player; - } - - public PlayerSettings getPlayerSettings() { - return playerSettings; - } - - @Override - public String toString() { - return MoreObjects.toStringHelper(this) - .add("player", player) - .add("playerSettings", playerSettings) - .toString(); - } -} diff --git a/api/src/main/java/com/velocitypowered/api/event/player/PostLoginEvent.java b/api/src/main/java/com/velocitypowered/api/event/player/PostLoginEvent.java index 29b5d6460..47348ae29 100644 --- a/api/src/main/java/com/velocitypowered/api/event/player/PostLoginEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/player/PostLoginEvent.java @@ -1,28 +1,19 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.player; -import com.google.common.base.Preconditions; import com.velocitypowered.api.proxy.connection.Player; /** * This event is fired once the player has been fully initialized and is about to connect to their * first server. */ -public final class PostLoginEvent { +public interface PostLoginEvent { - private final Player player; - - public PostLoginEvent(Player player) { - this.player = Preconditions.checkNotNull(player, "player"); - } - - public Player getPlayer() { - return player; - } - - @Override - public String toString() { - return "PostLoginEvent{" - + "player=" + player - + '}'; - } + Player player(); } diff --git a/api/src/main/java/com/velocitypowered/api/event/player/PostLoginEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/player/PostLoginEventImpl.java new file mode 100644 index 000000000..84af1e219 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/player/PostLoginEventImpl.java @@ -0,0 +1,36 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.player; + +import com.google.common.base.Preconditions; +import com.velocitypowered.api.proxy.connection.Player; + +/** + * This event is fired once the player has been fully initialized and is about to connect to their + * first server. + */ +public final class PostLoginEventImpl implements PostLoginEvent { + + private final Player player; + + public PostLoginEventImpl(Player player) { + this.player = Preconditions.checkNotNull(player, "player"); + } + + @Override + public Player player() { + return player; + } + + @Override + public String toString() { + return "PostLoginEvent{" + + "player=" + player + + '}'; + } +} diff --git a/api/src/main/java/com/velocitypowered/api/event/player/PreLoginEvent.java b/api/src/main/java/com/velocitypowered/api/event/player/PreLoginEvent.java index 40c98cb28..b48e32c26 100644 --- a/api/src/main/java/com/velocitypowered/api/event/player/PreLoginEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/player/PreLoginEvent.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.player; import com.google.common.base.Preconditions; @@ -13,55 +20,17 @@ import org.checkerframework.checker.nullness.qual.Nullable; * authenticates the player with Mojang or before the player's proxy connection is fully established * (for offline mode). */ -public final class PreLoginEvent implements ResultedEvent { +public interface PreLoginEvent extends ResultedEvent { - private final InboundConnection connection; - private final String username; - private PreLoginComponentResult result; + InboundConnection connection(); - /** - * Creates a new instance. - * @param connection the connection logging into the proxy - * @param username the player's username - */ - public PreLoginEvent(InboundConnection connection, String username) { - this.connection = Preconditions.checkNotNull(connection, "connection"); - this.username = Preconditions.checkNotNull(username, "username"); - this.result = PreLoginComponentResult.allowed(); - } - - public InboundConnection getConnection() { - return connection; - } - - public String getUsername() { - return username; - } - - @Override - public PreLoginComponentResult getResult() { - return result; - } - - @Override - public void setResult(@NonNull PreLoginComponentResult result) { - this.result = Preconditions.checkNotNull(result, "result"); - } - - @Override - public String toString() { - return "PreLoginEvent{" - + "connection=" + connection - + ", username='" + username + '\'' - + ", result=" + result - + '}'; - } + String username(); /** * Represents an "allowed/allowed with forced online\offline mode/denied" result with a reason * allowed for denial. */ - public static final class PreLoginComponentResult implements ResultedEvent.Result { + final class PreLoginComponentResult implements Result { private static final PreLoginComponentResult ALLOWED = new PreLoginComponentResult( Result.ALLOWED, null); @@ -84,7 +53,7 @@ public final class PreLoginEvent implements ResultedEvent getReason() { + public Optional denialReason() { return Optional.ofNullable(reason); } diff --git a/api/src/main/java/com/velocitypowered/api/event/player/PreLoginEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/player/PreLoginEventImpl.java new file mode 100644 index 000000000..37e2e0fae --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/player/PreLoginEventImpl.java @@ -0,0 +1,65 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.player; + +import com.google.common.base.Preconditions; +import com.velocitypowered.api.proxy.connection.InboundConnection; +import org.checkerframework.checker.nullness.qual.NonNull; + +/** + * This event is fired when a player has initiated a connection with the proxy but before the proxy + * authenticates the player with Mojang or before the player's proxy connection is fully established + * (for offline mode). + */ +public final class PreLoginEventImpl implements PreLoginEvent { + + private final InboundConnection connection; + private final String username; + private PreLoginComponentResult result; + + /** + * Creates a new instance. + * @param connection the connection logging into the proxy + * @param username the player's username + */ + public PreLoginEventImpl(InboundConnection connection, String username) { + this.connection = Preconditions.checkNotNull(connection, "connection"); + this.username = Preconditions.checkNotNull(username, "username"); + this.result = PreLoginComponentResult.allowed(); + } + + @Override + public InboundConnection connection() { + return connection; + } + + @Override + public String username() { + return username; + } + + @Override + public PreLoginComponentResult result() { + return result; + } + + @Override + public void setResult(@NonNull PreLoginComponentResult result) { + this.result = Preconditions.checkNotNull(result, "result"); + } + + @Override + public String toString() { + return "PreLoginEvent{" + + "connection=" + connection + + ", username='" + username + '\'' + + ", result=" + result + + '}'; + } + +} diff --git a/api/src/main/java/com/velocitypowered/api/event/player/ServerConnectedEvent.java b/api/src/main/java/com/velocitypowered/api/event/player/ServerConnectedEvent.java index 5cabd7ef2..98de16158 100644 --- a/api/src/main/java/com/velocitypowered/api/event/player/ServerConnectedEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/player/ServerConnectedEvent.java @@ -1,52 +1,25 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.player; -import com.google.common.base.Preconditions; import com.velocitypowered.api.proxy.connection.Player; import com.velocitypowered.api.proxy.server.RegisteredServer; import java.util.Optional; -import org.checkerframework.checker.nullness.qual.Nullable; /** * This event is fired once the player has successfully connected to the target server and the * connection to the previous server has been de-established. */ -public final class ServerConnectedEvent { +public interface ServerConnectedEvent { - private final Player player; - private final RegisteredServer server; - private final @Nullable RegisteredServer previousServer; + Player player(); - /** - * Constructs a ServerConnectedEvent. - * @param player the player that was connected - * @param server the server the player was connected to - * @param previousServer the server the player was previously connected to, null if none - */ - public ServerConnectedEvent(Player player, RegisteredServer server, - @Nullable RegisteredServer previousServer) { - this.player = Preconditions.checkNotNull(player, "player"); - this.server = Preconditions.checkNotNull(server, "server"); - this.previousServer = previousServer; - } + RegisteredServer target(); - public Player getPlayer() { - return player; - } - - public RegisteredServer getServer() { - return server; - } - - public Optional getPreviousServer() { - return Optional.ofNullable(previousServer); - } - - @Override - public String toString() { - return "ServerConnectedEvent{" - + "player=" + player - + ", server=" + server - + ", previousServer=" + previousServer - + '}'; - } + Optional previousServer(); } diff --git a/api/src/main/java/com/velocitypowered/api/event/player/ServerConnectedEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/player/ServerConnectedEventImpl.java new file mode 100644 index 000000000..d9725a79e --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/player/ServerConnectedEventImpl.java @@ -0,0 +1,62 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.player; + +import com.google.common.base.Preconditions; +import com.velocitypowered.api.proxy.connection.Player; +import com.velocitypowered.api.proxy.server.RegisteredServer; +import java.util.Optional; +import org.checkerframework.checker.nullness.qual.Nullable; + +/** + * This event is fired once the player has successfully connected to the target server and the + * connection to the previous server has been de-established. + */ +public final class ServerConnectedEventImpl implements ServerConnectedEvent { + + private final Player player; + private final RegisteredServer server; + private final @Nullable RegisteredServer previousServer; + + /** + * Constructs a ServerConnectedEvent. + * @param player the player that was connected + * @param server the server the player was connected to + * @param previousServer the server the player was previously connected to, null if none + */ + public ServerConnectedEventImpl(Player player, RegisteredServer server, + @Nullable RegisteredServer previousServer) { + this.player = Preconditions.checkNotNull(player, "player"); + this.server = Preconditions.checkNotNull(server, "server"); + this.previousServer = previousServer; + } + + @Override + public Player player() { + return player; + } + + @Override + public RegisteredServer target() { + return server; + } + + @Override + public Optional previousServer() { + return Optional.ofNullable(previousServer); + } + + @Override + public String toString() { + return "ServerConnectedEvent{" + + "player=" + player + + ", server=" + server + + ", previousServer=" + previousServer + + '}'; + } +} diff --git a/api/src/main/java/com/velocitypowered/api/event/player/ServerPostConnectEvent.java b/api/src/main/java/com/velocitypowered/api/event/player/ServerPostConnectEvent.java index 27dab7a08..3eaf6a068 100644 --- a/api/src/main/java/com/velocitypowered/api/event/player/ServerPostConnectEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/player/ServerPostConnectEvent.java @@ -1,39 +1,23 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.player; -import com.google.common.annotations.Beta; -import com.google.common.base.Preconditions; import com.velocitypowered.api.proxy.connection.Player; import com.velocitypowered.api.proxy.server.RegisteredServer; import org.checkerframework.checker.nullness.qual.Nullable; /** * Fired after the player has connected to a server. The server the player is now connected to is - * available in {@link Player#getCurrentServer()}. + * available in {@link Player#connectedServer()}. */ -@Beta -public class ServerPostConnectEvent { - private final Player player; - private final RegisteredServer previousServer; +public interface ServerPostConnectEvent { - public ServerPostConnectEvent(Player player, - @Nullable RegisteredServer previousServer) { - this.player = Preconditions.checkNotNull(player, "player"); - this.previousServer = previousServer; - } + Player player(); - public Player getPlayer() { - return player; - } - - public @Nullable RegisteredServer getPreviousServer() { - return previousServer; - } - - @Override - public String toString() { - return "ServerPostConnectEvent{" - + "player=" + player - + ", previousServer=" + previousServer - + '}'; - } + @Nullable RegisteredServer previousServer(); } diff --git a/api/src/main/java/com/velocitypowered/api/event/player/ServerPostConnectEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/player/ServerPostConnectEventImpl.java new file mode 100644 index 000000000..fad2ff268 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/player/ServerPostConnectEventImpl.java @@ -0,0 +1,47 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.player; + +import com.google.common.base.Preconditions; +import com.velocitypowered.api.proxy.connection.Player; +import com.velocitypowered.api.proxy.server.RegisteredServer; +import org.checkerframework.checker.nullness.qual.Nullable; + +/** + * Fired after the player has connected to a server. The server the player is now connected to is + * available in {@link Player#connectedServer()}. + */ +public class ServerPostConnectEventImpl implements ServerPostConnectEvent { + + private final Player player; + private final RegisteredServer previousServer; + + public ServerPostConnectEventImpl(Player player, + @Nullable RegisteredServer previousServer) { + this.player = Preconditions.checkNotNull(player, "player"); + this.previousServer = previousServer; + } + + @Override + public Player player() { + return player; + } + + @Override + public @Nullable RegisteredServer previousServer() { + return previousServer; + } + + @Override + public String toString() { + return "ServerPostConnectEvent{" + + "player=" + player + + ", previousServer=" + previousServer + + '}'; + } +} diff --git a/api/src/main/java/com/velocitypowered/api/event/player/ServerPreConnectEvent.java b/api/src/main/java/com/velocitypowered/api/event/player/ServerPreConnectEvent.java index 8783f88c9..89840bf6b 100644 --- a/api/src/main/java/com/velocitypowered/api/event/player/ServerPreConnectEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/player/ServerPreConnectEvent.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.player; import com.google.common.base.Preconditions; @@ -12,95 +19,59 @@ import org.checkerframework.checker.nullness.qual.Nullable; /** * This event is fired before the player connects to a server. */ -public final class ServerPreConnectEvent implements - ResultedEvent { - - private final Player player; - private final RegisteredServer originalServer; - private ServerResult result; - - /** - * Creates the ServerPreConnectEvent. - * @param player the player who is connecting to a server - * @param originalServer the server the player was trying to connect to - */ - public ServerPreConnectEvent(Player player, RegisteredServer originalServer) { - this.player = Preconditions.checkNotNull(player, "player"); - this.originalServer = Preconditions.checkNotNull(originalServer, "originalServer"); - this.result = ServerResult.allowed(originalServer); - } +public interface ServerPreConnectEvent extends ResultedEvent { /** * Returns the player connecting to the server. + * * @return the player connecting to the server */ - public Player getPlayer() { - return player; - } - - @Override - public ServerResult getResult() { - return result; - } - - @Override - public void setResult(ServerResult result) { - this.result = Preconditions.checkNotNull(result, "result"); - } + Player player(); /** - * Returns the server that the player originally tried to connect to. To get the server the - * player will connect to, see the {@link ServerResult} of this event. To get the server the - * player is currently on when this event is fired, use {@link Player#getCurrentServer()}. + * Returns the server that the player originally tried to connect to. To get the server the player + * will connect to, see the {@link ServerResult} of this event. To get the server the player is + * currently on when this event is fired, use {@link Player#connectedServer()}. + * * @return the server that the player originally tried to connect to */ - public RegisteredServer getOriginalServer() { - return originalServer; - } - - @Override - public String toString() { - return "ServerPreConnectEvent{" - + "player=" + player - + ", originalServer=" + originalServer - + ", result=" + result - + '}'; - } + RegisteredServer originalTarget(); /** * Represents the result of the {@link ServerPreConnectEvent}. */ - public static class ServerResult implements ResultedEvent.Result { + class ServerResult implements Result { private static final ServerResult DENIED = new ServerResult(null); - private final @Nullable RegisteredServer server; + private final @Nullable RegisteredServer target; - private ServerResult(@Nullable RegisteredServer server) { - this.server = server; + private ServerResult(@Nullable RegisteredServer target) { + this.target = target; } @Override public boolean isAllowed() { - return server != null; + return target != null; } - public Optional getServer() { - return Optional.ofNullable(server); + public Optional target() { + return Optional.ofNullable(target); } @Override public String toString() { - if (server != null) { - return "allowed: connect to " + server.getServerInfo().getName(); + if (target != null) { + return "allowed: connect to " + target.serverInfo().name(); } return "denied"; } /** * Returns a result that will prevent players from connecting to another server. If this result - * is used, then {@link ConnectionRequestBuilder#connect()}'s result will have the status - * {@link Status#CONNECTION_CANCELLED}. + * is used, then {@link ConnectionRequestBuilder#connect()}'s result will have the status {@link + * Status#CONNECTION_CANCELLED}. + * * @return a result to deny conneections */ public static ServerResult denied() { @@ -109,12 +80,13 @@ public final class ServerPreConnectEvent implements /** * Allows the player to connect to the specified server. - * @param server the new server to connect to + * + * @param target the new server to connect to * @return a result to allow the player to connect to the specified server */ - public static ServerResult allowed(RegisteredServer server) { - Preconditions.checkNotNull(server, "server"); - return new ServerResult(server); + public static ServerResult allowed(RegisteredServer target) { + Preconditions.checkNotNull(target, "server"); + return new ServerResult(target); } } } diff --git a/api/src/main/java/com/velocitypowered/api/event/player/ServerPreConnectEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/player/ServerPreConnectEventImpl.java new file mode 100644 index 000000000..abb6e619e --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/player/ServerPreConnectEventImpl.java @@ -0,0 +1,73 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.player; + +import com.google.common.base.Preconditions; +import com.velocitypowered.api.proxy.connection.Player; +import com.velocitypowered.api.proxy.server.RegisteredServer; + +/** + * This event is fired before the player connects to a server. + */ +public final class ServerPreConnectEventImpl implements ServerPreConnectEvent { + + private final Player player; + private final RegisteredServer originalServer; + private ServerResult result; + + /** + * Creates the ServerPreConnectEvent. + * @param player the player who is connecting to a server + * @param originalServer the server the player was trying to connect to + */ + public ServerPreConnectEventImpl(Player player, RegisteredServer originalServer) { + this.player = Preconditions.checkNotNull(player, "player"); + this.originalServer = Preconditions.checkNotNull(originalServer, "originalServer"); + this.result = ServerResult.allowed(originalServer); + } + + /** + * Returns the player connecting to the server. + * @return the player connecting to the server + */ + @Override + public Player player() { + return player; + } + + @Override + public ServerResult result() { + return result; + } + + @Override + public void setResult(ServerResult result) { + this.result = Preconditions.checkNotNull(result, "result"); + } + + /** + * Returns the server that the player originally tried to connect to. To get the server the + * player will connect to, see the {@link ServerResult} of this event. To get the server the + * player is currently on when this event is fired, use {@link Player#connectedServer()}. + * @return the server that the player originally tried to connect to + */ + @Override + public RegisteredServer originalTarget() { + return originalServer; + } + + @Override + public String toString() { + return "ServerPreConnectEvent{" + + "player=" + player + + ", originalServer=" + originalServer + + ", result=" + result + + '}'; + } + +} diff --git a/api/src/main/java/com/velocitypowered/api/event/player/TabCompleteEvent.java b/api/src/main/java/com/velocitypowered/api/event/player/TabCompleteEvent.java index 5ae4c1a00..d15e8efa6 100644 --- a/api/src/main/java/com/velocitypowered/api/event/player/TabCompleteEvent.java +++ b/api/src/main/java/com/velocitypowered/api/event/player/TabCompleteEvent.java @@ -1,62 +1,39 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.event.player; -import static com.google.common.base.Preconditions.checkNotNull; - import com.velocitypowered.api.proxy.connection.Player; -import java.util.ArrayList; import java.util.List; /** * This event is fired after a tab complete response is sent by the remote server, for clients on * 1.12.2 and below. You have the opportunity to modify the response sent to the remote player. */ -public class TabCompleteEvent { - private final Player player; - private final String partialMessage; - private final List suggestions; - - /** - * Constructs a new TabCompleteEvent instance. - * @param player the player - * @param partialMessage the partial message - * @param suggestions the initial list of suggestions - */ - public TabCompleteEvent(Player player, String partialMessage, List suggestions) { - this.player = checkNotNull(player, "player"); - this.partialMessage = checkNotNull(partialMessage, "partialMessage"); - this.suggestions = new ArrayList<>(checkNotNull(suggestions, "suggestions")); - } +public interface TabCompleteEvent { /** * Returns the player requesting the tab completion. + * * @return the requesting player */ - public Player getPlayer() { - return player; - } + Player player(); /** * Returns the message being partially completed. + * * @return the partial message */ - public String getPartialMessage() { - return partialMessage; - } + String partialMessage(); /** * Returns all the suggestions provided to the user, as a mutable list. + * * @return the suggestions */ - public List getSuggestions() { - return suggestions; - } - - @Override - public String toString() { - return "TabCompleteEvent{" - + "player=" + player - + ", partialMessage='" + partialMessage + '\'' - + ", suggestions=" + suggestions - + '}'; - } + List suggestions(); } diff --git a/api/src/main/java/com/velocitypowered/api/event/player/TabCompleteEventImpl.java b/api/src/main/java/com/velocitypowered/api/event/player/TabCompleteEventImpl.java new file mode 100644 index 000000000..c2128c53c --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/event/player/TabCompleteEventImpl.java @@ -0,0 +1,72 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.event.player; + +import static com.google.common.base.Preconditions.checkNotNull; + +import com.velocitypowered.api.proxy.connection.Player; +import java.util.ArrayList; +import java.util.List; + +/** + * This event is fired after a tab complete response is sent by the remote server, for clients on + * 1.12.2 and below. You have the opportunity to modify the response sent to the remote player. + */ +public class TabCompleteEventImpl implements TabCompleteEvent { + private final Player player; + private final String partialMessage; + private final List suggestions; + + /** + * Constructs a new TabCompleteEvent instance. + * @param player the player + * @param partialMessage the partial message + * @param suggestions the initial list of suggestions + */ + public TabCompleteEventImpl(Player player, String partialMessage, List suggestions) { + this.player = checkNotNull(player, "player"); + this.partialMessage = checkNotNull(partialMessage, "partialMessage"); + this.suggestions = new ArrayList<>(checkNotNull(suggestions, "suggestions")); + } + + /** + * Returns the player requesting the tab completion. + * @return the requesting player + */ + @Override + public Player player() { + return player; + } + + /** + * Returns the message being partially completed. + * @return the partial message + */ + @Override + public String partialMessage() { + return partialMessage; + } + + /** + * Returns all the suggestions provided to the user, as a mutable list. + * @return the suggestions + */ + @Override + public List suggestions() { + return suggestions; + } + + @Override + public String toString() { + return "TabCompleteEvent{" + + "player=" + player + + ", partialMessage='" + partialMessage + '\'' + + ", suggestions=" + suggestions + + '}'; + } +} diff --git a/api/src/main/java/com/velocitypowered/api/event/player/package-info.java b/api/src/main/java/com/velocitypowered/api/event/player/package-info.java index 1d0513b60..4cada542b 100644 --- a/api/src/main/java/com/velocitypowered/api/event/player/package-info.java +++ b/api/src/main/java/com/velocitypowered/api/event/player/package-info.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + /** * Provides events for handling actions performed by players. */ diff --git a/api/src/main/java/com/velocitypowered/api/network/ListenerType.java b/api/src/main/java/com/velocitypowered/api/network/ListenerType.java new file mode 100644 index 000000000..e0c901307 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/network/ListenerType.java @@ -0,0 +1,27 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.network; + +/** + * Represents each listener type. + */ +public enum ListenerType { + MINECRAFT("Minecraft"), + QUERY("Query"); + + final String name; + + ListenerType(final String name) { + this.name = name; + } + + @Override + public String toString() { + return this.name; + } +} diff --git a/api/src/main/java/com/velocitypowered/api/network/ProtocolVersion.java b/api/src/main/java/com/velocitypowered/api/network/ProtocolVersion.java index c1dc3c798..55ee5b751 100644 --- a/api/src/main/java/com/velocitypowered/api/network/ProtocolVersion.java +++ b/api/src/main/java/com/velocitypowered/api/network/ProtocolVersion.java @@ -1,9 +1,18 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.network; +import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableMap; import com.google.common.collect.Sets; import java.util.EnumSet; import java.util.HashMap; +import java.util.List; import java.util.Map; import java.util.Set; import net.kyori.coffee.Ordered; @@ -14,16 +23,19 @@ import net.kyori.coffee.Ordered; public enum ProtocolVersion implements Ordered { UNKNOWN(-1, "Unknown"), LEGACY(-2, "Legacy"), - MINECRAFT_1_7_2(4, "1.7.2"), - MINECRAFT_1_7_6(5, "1.7.6"), - MINECRAFT_1_8(47, "1.8"), + MINECRAFT_1_7_2(4, + "1.7.2", "1.7.3", "1.7.4", "1.7.5"), + MINECRAFT_1_7_6(5, + "1.7.6", "1.7.7", "1.7.8", "1.7.9", "1.7.10"), + MINECRAFT_1_8(47, + "1.8", "1.8.1", "1.8.2", "1.8.3", "1.8.4", "1.8.5", "1.8.6", "1.8.7", "1.8.8", "1.8.9"), MINECRAFT_1_9(107, "1.9"), MINECRAFT_1_9_1(108, "1.9.1"), MINECRAFT_1_9_2(109, "1.9.2"), - MINECRAFT_1_9_4(110, "1.9.4"), - MINECRAFT_1_10(210, "1.10"), + MINECRAFT_1_9_4(110, "1.9.3", "1.9.4"), + MINECRAFT_1_10(210, "1.10", "1.10.1", "1.10.2"), MINECRAFT_1_11(315, "1.11"), - MINECRAFT_1_11_1(316, "1.11.1"), + MINECRAFT_1_11_1(316, "1.11.1", "1.11.2"), MINECRAFT_1_12(335, "1.12"), MINECRAFT_1_12_1(338, "1.12.1"), MINECRAFT_1_12_2(340, "1.12.2"), @@ -42,13 +54,13 @@ public enum ProtocolVersion implements Ordered { MINECRAFT_1_16_1(736, "1.16.1"), MINECRAFT_1_16_2(751, "1.16.2"), MINECRAFT_1_16_3(753, "1.16.3"), - MINECRAFT_1_16_4(754, "1.16.4"); + MINECRAFT_1_16_4(754, "1.16.4", "1.16.5"); private static final int SNAPSHOT_BIT = 30; private final int protocol; private final int snapshotProtocol; - private final String name; + private final String[] names; /** * Represents the lowest supported version. @@ -63,7 +75,8 @@ public enum ProtocolVersion implements Ordered { * The user-friendly representation of the lowest and highest supported versions. */ public static final String SUPPORTED_VERSION_STRING = String - .format("%s-%s", MINIMUM_VERSION, MAXIMUM_VERSION); + .format("%s-%s", MINIMUM_VERSION.versionIntroducedIn(), + MAXIMUM_VERSION.mostRecentSupportedVersion()); /** * A map linking the protocol version number to its {@link ProtocolVersion} representation. @@ -102,11 +115,11 @@ public enum ProtocolVersion implements Ordered { SUPPORTED_VERSIONS = Sets.immutableEnumSet(versions); } - ProtocolVersion(int protocol, String name) { - this(protocol, -1, name); + ProtocolVersion(int protocol, String... names) { + this(protocol, -1, names); } - ProtocolVersion(int protocol, int snapshotProtocol, String name) { + ProtocolVersion(int protocol, int snapshotProtocol, String... names) { if (snapshotProtocol != -1) { this.snapshotProtocol = (1 << SNAPSHOT_BIT) | snapshotProtocol; } else { @@ -114,7 +127,7 @@ public enum ProtocolVersion implements Ordered { } this.protocol = protocol; - this.name = name; + this.names = names; } /** @@ -122,17 +135,37 @@ public enum ProtocolVersion implements Ordered { * * @return the protocol version */ - public int getProtocol() { + public int protocol() { return protocol == -1 ? snapshotProtocol : protocol; } /** - * Returns the user-friendly name for this protocol. + * Returns the user-friendly name of the version + * this protocol was introduced in. * - * @return the protocol name + * @return the version name */ - public String getName() { - return name; + public String versionIntroducedIn() { + return names[0]; + } + + /** + * Returns the user-friendly name of the last + * version this protocol is valid for. + * + * @return the version name + */ + public String mostRecentSupportedVersion() { + return names[names.length - 1]; + } + + /** + * Returns all versions this protocol is valid for. + * + * @return the version names + */ + public List supportedVersions() { + return ImmutableList.copyOf(names); } /** @@ -141,7 +174,7 @@ public enum ProtocolVersion implements Ordered { * @param protocol the protocol as an int * @return the protocol version */ - public static ProtocolVersion getProtocolVersion(int protocol) { + public static ProtocolVersion byMinecraftProtocolVersion(int protocol) { return ID_TO_PROTOCOL_CONSTANT.getOrDefault(protocol, UNKNOWN); } @@ -187,6 +220,6 @@ public enum ProtocolVersion implements Ordered { @Override public String toString() { - return name; + return versionIntroducedIn(); } } diff --git a/api/src/main/java/com/velocitypowered/api/permission/PermissionFunction.java b/api/src/main/java/com/velocitypowered/api/permission/PermissionFunction.java index 98f2cc707..2fecf03b8 100644 --- a/api/src/main/java/com/velocitypowered/api/permission/PermissionFunction.java +++ b/api/src/main/java/com/velocitypowered/api/permission/PermissionFunction.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.permission; /** @@ -22,10 +29,10 @@ public interface PermissionFunction { PermissionFunction ALWAYS_UNDEFINED = p -> Tristate.UNDEFINED; /** - * Gets the subjects setting for a particular permission. + * Evaluates whether or not the player has a permission. * * @param permission the permission * @return the value the permission is set to */ - Tristate getPermissionValue(String permission); + Tristate evaluatePermission(String permission); } diff --git a/api/src/main/java/com/velocitypowered/api/permission/PermissionProvider.java b/api/src/main/java/com/velocitypowered/api/permission/PermissionProvider.java index d6fdc507e..18f3b7f44 100644 --- a/api/src/main/java/com/velocitypowered/api/permission/PermissionProvider.java +++ b/api/src/main/java/com/velocitypowered/api/permission/PermissionProvider.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.permission; /** diff --git a/api/src/main/java/com/velocitypowered/api/permission/PermissionSubject.java b/api/src/main/java/com/velocitypowered/api/permission/PermissionSubject.java index 85a7a0958..8a8d6c91b 100644 --- a/api/src/main/java/com/velocitypowered/api/permission/PermissionSubject.java +++ b/api/src/main/java/com/velocitypowered/api/permission/PermissionSubject.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.permission; /** @@ -12,7 +19,7 @@ public interface PermissionSubject { * @return whether or not the subject has the permission */ default boolean hasPermission(String permission) { - return getPermissionValue(permission).asBoolean(); + return evaluatePermission(permission).asBoolean(); } /** @@ -21,5 +28,5 @@ public interface PermissionSubject { * @param permission the permission * @return the value the permission is set to */ - Tristate getPermissionValue(String permission); + Tristate evaluatePermission(String permission); } diff --git a/api/src/main/java/com/velocitypowered/api/permission/Tristate.java b/api/src/main/java/com/velocitypowered/api/permission/Tristate.java index 65df88572..70653eef6 100644 --- a/api/src/main/java/com/velocitypowered/api/permission/Tristate.java +++ b/api/src/main/java/com/velocitypowered/api/permission/Tristate.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.permission; import org.checkerframework.checker.nullness.qual.Nullable; diff --git a/api/src/main/java/com/velocitypowered/api/permission/package-info.java b/api/src/main/java/com/velocitypowered/api/permission/package-info.java index a68255248..7e367ab82 100644 --- a/api/src/main/java/com/velocitypowered/api/permission/package-info.java +++ b/api/src/main/java/com/velocitypowered/api/permission/package-info.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + /** * Provides the basic building blocks for a custom permission system. */ diff --git a/api/src/main/java/com/velocitypowered/api/plugin/Dependency.java b/api/src/main/java/com/velocitypowered/api/plugin/Dependency.java index c004563db..03412ec16 100644 --- a/api/src/main/java/com/velocitypowered/api/plugin/Dependency.java +++ b/api/src/main/java/com/velocitypowered/api/plugin/Dependency.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.plugin; import java.lang.annotation.Retention; diff --git a/api/src/main/java/com/velocitypowered/api/plugin/InvalidPluginException.java b/api/src/main/java/com/velocitypowered/api/plugin/InvalidPluginException.java index ac48c06fe..46530ef73 100644 --- a/api/src/main/java/com/velocitypowered/api/plugin/InvalidPluginException.java +++ b/api/src/main/java/com/velocitypowered/api/plugin/InvalidPluginException.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.plugin; public class InvalidPluginException extends Exception { diff --git a/api/src/main/java/com/velocitypowered/api/plugin/Plugin.java b/api/src/main/java/com/velocitypowered/api/plugin/Plugin.java index 2ed9970f7..04e3d511d 100644 --- a/api/src/main/java/com/velocitypowered/api/plugin/Plugin.java +++ b/api/src/main/java/com/velocitypowered/api/plugin/Plugin.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.plugin; import java.lang.annotation.ElementType; diff --git a/api/src/main/java/com/velocitypowered/api/plugin/PluginContainer.java b/api/src/main/java/com/velocitypowered/api/plugin/PluginContainer.java index 1c0e8a422..b5fe9ab44 100644 --- a/api/src/main/java/com/velocitypowered/api/plugin/PluginContainer.java +++ b/api/src/main/java/com/velocitypowered/api/plugin/PluginContainer.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.plugin; import java.util.Optional; @@ -12,14 +19,14 @@ public interface PluginContainer { * * @return the plugin's description */ - PluginDescription getDescription(); + PluginDescription description(); /** * Returns the created plugin if it is available. * * @return the instance if available */ - default Optional getInstance() { + default Optional instance() { return Optional.empty(); } } diff --git a/api/src/main/java/com/velocitypowered/api/plugin/PluginDescription.java b/api/src/main/java/com/velocitypowered/api/plugin/PluginDescription.java index b5b925273..101272b32 100644 --- a/api/src/main/java/com/velocitypowered/api/plugin/PluginDescription.java +++ b/api/src/main/java/com/velocitypowered/api/plugin/PluginDescription.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.plugin; import com.google.common.collect.ImmutableList; @@ -27,7 +34,7 @@ public interface PluginDescription { * @return the plugin ID * @see Plugin#id() */ - String getId(); + String id(); /** * Gets the name of the {@link Plugin} within this container. @@ -35,7 +42,7 @@ public interface PluginDescription { * @return an {@link Optional} with the plugin name, may be empty * @see Plugin#name() */ - default Optional getName() { + default Optional name() { return Optional.empty(); } @@ -45,7 +52,7 @@ public interface PluginDescription { * @return an {@link Optional} with the plugin version, may be empty * @see Plugin#version() */ - default Optional getVersion() { + default Optional version() { return Optional.empty(); } @@ -55,7 +62,7 @@ public interface PluginDescription { * @return an {@link Optional} with the plugin description, may be empty * @see Plugin#description() */ - default Optional getDescription() { + default Optional description() { return Optional.empty(); } @@ -65,7 +72,7 @@ public interface PluginDescription { * @return an {@link Optional} with the plugin url, may be empty * @see Plugin#url() */ - default Optional getUrl() { + default Optional url() { return Optional.empty(); } @@ -75,7 +82,7 @@ public interface PluginDescription { * @return the plugin authors, may be empty * @see Plugin#authors() */ - default List getAuthors() { + default List authors() { return ImmutableList.of(); } @@ -85,7 +92,7 @@ public interface PluginDescription { * @return the plugin dependencies, can be empty * @see Plugin#dependencies() */ - default Collection getDependencies() { + default Collection dependencies() { return ImmutableSet.of(); } @@ -94,11 +101,11 @@ public interface PluginDescription { } /** - * Returns the source the plugin was loaded from. + * Returns the file path the plugin was loaded from. * - * @return the source the plugin was loaded from or {@link Optional#empty()} if unknown + * @return the path the plugin was loaded from or {@link Optional#empty()} if unknown */ - default Optional getSource() { + default Optional file() { return Optional.empty(); } } diff --git a/api/src/main/java/com/velocitypowered/api/plugin/PluginManager.java b/api/src/main/java/com/velocitypowered/api/plugin/PluginManager.java index 36ac27cfb..4688f9bf1 100644 --- a/api/src/main/java/com/velocitypowered/api/plugin/PluginManager.java +++ b/api/src/main/java/com/velocitypowered/api/plugin/PluginManager.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.plugin; import java.nio.file.Path; @@ -32,7 +39,7 @@ public interface PluginManager { * * @return the plugins */ - Collection getPlugins(); + Collection plugins(); /** * Checks if a plugin is loaded based on its ID. diff --git a/api/src/main/java/com/velocitypowered/api/plugin/annotation/DataDirectory.java b/api/src/main/java/com/velocitypowered/api/plugin/annotation/DataDirectory.java index c3575cf55..5349204f2 100644 --- a/api/src/main/java/com/velocitypowered/api/plugin/annotation/DataDirectory.java +++ b/api/src/main/java/com/velocitypowered/api/plugin/annotation/DataDirectory.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.plugin.annotation; import com.google.inject.BindingAnnotation; diff --git a/api/src/main/java/com/velocitypowered/api/plugin/annotation/package-info.java b/api/src/main/java/com/velocitypowered/api/plugin/annotation/package-info.java index 81486dfed..377a036da 100644 --- a/api/src/main/java/com/velocitypowered/api/plugin/annotation/package-info.java +++ b/api/src/main/java/com/velocitypowered/api/plugin/annotation/package-info.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + /** * Provides annotations to handle injecting dependencies for plugins. */ diff --git a/api/src/main/java/com/velocitypowered/api/plugin/meta/PluginDependency.java b/api/src/main/java/com/velocitypowered/api/plugin/meta/PluginDependency.java index dc7464a39..9d75eaa46 100644 --- a/api/src/main/java/com/velocitypowered/api/plugin/meta/PluginDependency.java +++ b/api/src/main/java/com/velocitypowered/api/plugin/meta/PluginDependency.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.plugin.meta; import static com.google.common.base.Preconditions.checkArgument; diff --git a/api/src/main/java/com/velocitypowered/api/plugin/meta/package-info.java b/api/src/main/java/com/velocitypowered/api/plugin/meta/package-info.java index cde1887ae..66b3be097 100644 --- a/api/src/main/java/com/velocitypowered/api/plugin/meta/package-info.java +++ b/api/src/main/java/com/velocitypowered/api/plugin/meta/package-info.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + /** * Provides metadata for plugins. */ diff --git a/api/src/main/java/com/velocitypowered/api/plugin/package-info.java b/api/src/main/java/com/velocitypowered/api/plugin/package-info.java index 6eea17fd6..ce6018d70 100644 --- a/api/src/main/java/com/velocitypowered/api/plugin/package-info.java +++ b/api/src/main/java/com/velocitypowered/api/plugin/package-info.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + /** * Provides the Velocity plugin API. */ diff --git a/api/src/main/java/com/velocitypowered/api/proxy/ProxyServer.java b/api/src/main/java/com/velocitypowered/api/proxy/ProxyServer.java index 93a5e13ed..a82ffbe98 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/ProxyServer.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/ProxyServer.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.proxy; import com.velocitypowered.api.command.CommandManager; @@ -17,6 +24,7 @@ import java.util.Collection; import java.util.Optional; import java.util.UUID; import net.kyori.adventure.audience.Audience; +import net.kyori.adventure.text.Component; /** * Provides an interface to a Minecraft server proxy. @@ -28,7 +36,7 @@ public interface ProxyServer extends Audience { * * @param reason message to kick online players with */ - void shutdown(net.kyori.adventure.text.Component reason); + void shutdown(Component reason); /** * Shuts down the proxy, kicking players with the default reason. @@ -58,14 +66,14 @@ public interface ProxyServer extends Audience { * * @return the players online on this proxy */ - Collection getAllPlayers(); + Collection connectedPlayers(); /** * Returns the number of players currently connected to this proxy. * * @return the players on this proxy */ - int getPlayerCount(); + int countConnectedPlayers(); /** * Retrieves a registered {@link RegisteredServer} instance by its name. The search is @@ -74,14 +82,14 @@ public interface ProxyServer extends Audience { * @param name the name of the server * @return the registered server, which may be empty */ - Optional getServer(String name); + Optional server(String name); /** * Retrieves all {@link RegisteredServer}s registered with this proxy. * * @return the servers registered with this proxy */ - Collection getAllServers(); + Collection registeredServers(); /** * Matches all {@link Player}s whose names start with the provided partial name. @@ -122,62 +130,54 @@ public interface ProxyServer extends Audience { * * @return the console command invoker */ - ConsoleCommandSource getConsoleCommandSource(); + ConsoleCommandSource consoleCommandSource(); /** * Gets the {@link PluginManager} instance. * * @return the plugin manager instance */ - PluginManager getPluginManager(); + PluginManager pluginManager(); /** * Gets the {@link EventManager} instance. * * @return the event manager instance */ - EventManager getEventManager(); + EventManager eventManager(); /** * Gets the {@link CommandManager} instance. * * @return the command manager */ - CommandManager getCommandManager(); + CommandManager commandManager(); /** * Gets the {@link Scheduler} instance. * * @return the scheduler instance */ - Scheduler getScheduler(); + Scheduler scheduler(); /** * Gets the {@link ChannelRegistrar} instance. * * @return the channel registrar */ - ChannelRegistrar getChannelRegistrar(); - - /** - * Gets the address that this proxy is bound to. This does not necessarily indicate the external - * IP address of the proxy. - * - * @return the address the proxy is bound to - */ - SocketAddress getBoundAddress(); + ChannelRegistrar channelRegistrar(); /** * Gets the {@link ProxyConfig} instance. * * @return the proxy config */ - ProxyConfig getConfiguration(); + ProxyConfig configuration(); /** * Returns the version of the proxy. * * @return the proxy version */ - ProxyVersion getVersion(); + ProxyVersion version(); } diff --git a/api/src/main/java/com/velocitypowered/api/proxy/config/ProxyConfig.java b/api/src/main/java/com/velocitypowered/api/proxy/config/ProxyConfig.java index 430681747..e5e4440e4 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/config/ProxyConfig.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/config/ProxyConfig.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.proxy.config; import com.velocitypowered.api.proxy.ProxyServer; @@ -73,7 +80,7 @@ public interface ProxyConfig { /** * Get a Map of all servers registered in velocity.toml. This method does * not return all the servers currently in memory, although in most cases it - * does. For a view of all registered servers, see {@link ProxyServer#getAllServers()}. + * does. For a view of all registered servers, see {@link ProxyServer#registeredServers()}. * * @return registered servers map */ diff --git a/api/src/main/java/com/velocitypowered/api/proxy/connection/InboundConnection.java b/api/src/main/java/com/velocitypowered/api/proxy/connection/InboundConnection.java index ec0bda8fe..c03adb9a8 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/connection/InboundConnection.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/connection/InboundConnection.java @@ -1,7 +1,13 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.proxy.connection; import com.velocitypowered.api.network.ProtocolVersion; - import java.net.InetSocketAddress; import java.net.SocketAddress; import java.util.Optional; @@ -16,14 +22,14 @@ public interface InboundConnection { * * @return the player's remote address */ - SocketAddress getRemoteAddress(); + SocketAddress remoteAddress(); /** * Returns the hostname that the user entered into the client, if applicable. * * @return the hostname from the client */ - Optional getVirtualHost(); + Optional connectedHostname(); /** * Determine whether or not the player remains online. @@ -37,5 +43,5 @@ public interface InboundConnection { * * @return the protocol version the connection uses */ - ProtocolVersion getProtocolVersion(); + ProtocolVersion protocolVersion(); } diff --git a/api/src/main/java/com/velocitypowered/api/proxy/connection/Player.java b/api/src/main/java/com/velocitypowered/api/proxy/connection/Player.java index d493f145c..f08131743 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/connection/Player.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/connection/Player.java @@ -1,11 +1,19 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.proxy.connection; import com.velocitypowered.api.command.CommandSource; import com.velocitypowered.api.event.player.PlayerResourcePackStatusEvent; import com.velocitypowered.api.proxy.messages.ChannelMessageSink; import com.velocitypowered.api.proxy.messages.ChannelMessageSource; +import com.velocitypowered.api.proxy.messages.PluginChannelId; +import com.velocitypowered.api.proxy.player.ClientSettings; import com.velocitypowered.api.proxy.player.ConnectionRequestBuilder; -import com.velocitypowered.api.proxy.player.PlayerSettings; import com.velocitypowered.api.proxy.player.TabList; import com.velocitypowered.api.proxy.server.RegisteredServer; import com.velocitypowered.api.util.GameProfile; @@ -27,49 +35,49 @@ public interface Player extends CommandSource, Identified, InboundConnection, * * @return the username */ - String getUsername(); + String username(); /** * Returns the player's UUID. * * @return the UUID */ - UUID getUniqueId(); + UUID id(); /** * Returns the server that the player is currently connected to. * * @return an {@link Optional} the server that the player is connected to, which may be empty */ - Optional getCurrentServer(); + Optional connectedServer(); /** * Returns the player's client settings. * * @return the settings */ - PlayerSettings getPlayerSettings(); + ClientSettings clientSettings(); /** * Returns the player's mod info if they have a modded client. * * @return an {@link Optional} the mod info. which may be empty */ - Optional getModInfo(); + Optional modInfo(); /** * Returns the current player's ping. * * @return the player's ping or -1 if ping information is currently unknown */ - long getPing(); + long ping(); /** * Returns the player's connection status. * * @return true if the player is authenticated with Mojang servers */ - boolean isOnlineMode(); + boolean onlineMode(); /** * Creates a new connection request so that the player can connect to another server. @@ -89,14 +97,14 @@ public interface Player extends CommandSource, Identified, InboundConnection, /** * Returns the player's game profile. */ - GameProfile getGameProfile(); + GameProfile gameProfile(); /** * Returns the player's tab list. * * @return this player's tab list */ - TabList getTabList(); + TabList tabList(); /** * Disconnects the player with the specified reason. Once this method is called, further calls to @@ -131,4 +139,16 @@ public interface Player extends CommandSource, Identified, InboundConnection, * @param hash the SHA-1 hash value for the resource pack */ void sendResourcePack(String url, byte[] hash); + + /** + * Note that this method does not send a plugin message to the server the player + * is connected to. You should only use this method if you are trying to communicate + * with a mod that is installed on the player's client. To send a plugin message to the server + * from the player, you should use the equivalent method on the instance returned by + * {@link #connectedServer()}. + * + * @inheritDoc + */ + @Override + boolean sendPluginMessage(PluginChannelId identifier, byte[] data); } diff --git a/api/src/main/java/com/velocitypowered/api/proxy/connection/ServerConnection.java b/api/src/main/java/com/velocitypowered/api/proxy/connection/ServerConnection.java index a5c179b1c..63f1fee32 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/connection/ServerConnection.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/connection/ServerConnection.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.proxy.connection; import com.velocitypowered.api.proxy.messages.ChannelMessageSink; @@ -15,19 +22,19 @@ public interface ServerConnection extends ChannelMessageSource, ChannelMessageSi * * @return the server this connection is connected to */ - RegisteredServer getServer(); + RegisteredServer target(); /** * Returns the server info for this connection. * * @return the server info for this connection */ - ServerInfo getServerInfo(); + ServerInfo serverInfo(); /** * Returns the player that this connection is associated with. * * @return the player for this connection */ - Player getPlayer(); + Player player(); } diff --git a/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelIdentifier.java b/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelIdentifier.java deleted file mode 100644 index fd3101e70..000000000 --- a/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelIdentifier.java +++ /dev/null @@ -1,14 +0,0 @@ -package com.velocitypowered.api.proxy.messages; - -/** - * Represents a channel identifier for use with plugin messaging. - */ -public interface ChannelIdentifier { - - /** - * Returns the textual representation of this identifier. - * - * @return the textual representation of the identifier - */ - String getId(); -} diff --git a/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelMessageSink.java b/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelMessageSink.java index f61c58963..e84ccb7ec 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelMessageSink.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelMessageSink.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.proxy.messages; /** @@ -12,5 +19,5 @@ public interface ChannelMessageSink { * @param data the data to send * @return whether or not the message could be sent */ - boolean sendPluginMessage(ChannelIdentifier identifier, byte[] data); + boolean sendPluginMessage(PluginChannelId identifier, byte[] data); } diff --git a/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelMessageSource.java b/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelMessageSource.java index 108d082a4..cf96af30b 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelMessageSource.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelMessageSource.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.proxy.messages; /** diff --git a/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelRegistrar.java b/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelRegistrar.java index e1a232b80..b01037dd6 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelRegistrar.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelRegistrar.java @@ -1,23 +1,32 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.proxy.messages; +import com.velocitypowered.api.event.connection.PluginMessageEventImpl; + /** - * Represents an interface to register and unregister {@link ChannelIdentifier}s for the proxy to + * Represents an interface to register and unregister {@link PluginChannelId}s for the proxy to * listen on. */ public interface ChannelRegistrar { /** * Registers the specified message identifiers to listen on so you can intercept plugin messages - * on the channel using {@link com.velocitypowered.api.event.connection.PluginMessageEvent}. + * on the channel using {@link PluginMessageEventImpl}. * * @param identifiers the channel identifiers to register */ - void register(ChannelIdentifier... identifiers); + void register(PluginChannelId... identifiers); /** * Removes the intent to listen for the specified channel. * * @param identifiers the identifiers to unregister */ - void unregister(ChannelIdentifier... identifiers); + void unregister(PluginChannelId... identifiers); } diff --git a/api/src/main/java/com/velocitypowered/api/proxy/messages/KeyedPluginChannelId.java b/api/src/main/java/com/velocitypowered/api/proxy/messages/KeyedPluginChannelId.java new file mode 100644 index 000000000..14b66c836 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/proxy/messages/KeyedPluginChannelId.java @@ -0,0 +1,51 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.proxy.messages; + +import com.google.common.base.Preconditions; +import net.kyori.adventure.key.Key; + +/** + * Represents a modern namespaced channel identifier. + */ +public final class KeyedPluginChannelId implements PluginChannelId { + + private final Key key; + + KeyedPluginChannelId(Key key) { + this.key = Preconditions.checkNotNull(key, "key"); + } + + public Key key() { + return key; + } + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + + KeyedPluginChannelId that = (KeyedPluginChannelId) o; + + return key.equals(that.key); + } + + @Override + public int hashCode() { + return key.hashCode(); + } + + @Override + public String toString() { + return key.asString(); + } +} diff --git a/api/src/main/java/com/velocitypowered/api/proxy/messages/LegacyChannelIdentifier.java b/api/src/main/java/com/velocitypowered/api/proxy/messages/LegacyChannelIdentifier.java deleted file mode 100644 index c9f471035..000000000 --- a/api/src/main/java/com/velocitypowered/api/proxy/messages/LegacyChannelIdentifier.java +++ /dev/null @@ -1,57 +0,0 @@ -package com.velocitypowered.api.proxy.messages; - -import com.google.common.base.Preconditions; -import com.google.common.base.Strings; -import java.util.Objects; -import org.checkerframework.checker.nullness.qual.Nullable; - -/** - * Reperesents a legacy channel identifier (for Minecraft 1.12 and below). For modern 1.13 plugin - * messages, please see {@link MinecraftChannelIdentifier}. This class is immutable and safe for - * multi-threaded use. - */ -public final class LegacyChannelIdentifier implements ChannelIdentifier { - - private final String name; - - /** - * Creates a new legacy channel identifier. - * - * @param name the name for the channel - */ - public LegacyChannelIdentifier(String name) { - Preconditions.checkArgument(!Strings.isNullOrEmpty(name), "provided name is empty"); - this.name = name; - } - - public String getName() { - return name; - } - - @Override - public String toString() { - return name + " (legacy)"; - } - - @Override - public boolean equals(@Nullable Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - LegacyChannelIdentifier that = (LegacyChannelIdentifier) o; - return Objects.equals(name, that.name); - } - - @Override - public int hashCode() { - return Objects.hash(name); - } - - @Override - public String getId() { - return this.getName(); - } -} diff --git a/api/src/main/java/com/velocitypowered/api/proxy/messages/MinecraftChannelIdentifier.java b/api/src/main/java/com/velocitypowered/api/proxy/messages/MinecraftChannelIdentifier.java deleted file mode 100644 index b374f5b47..000000000 --- a/api/src/main/java/com/velocitypowered/api/proxy/messages/MinecraftChannelIdentifier.java +++ /dev/null @@ -1,107 +0,0 @@ -package com.velocitypowered.api.proxy.messages; - -import com.google.common.base.Preconditions; -import com.google.common.base.Strings; -import java.util.Objects; -import java.util.regex.Pattern; -import org.checkerframework.checker.nullness.qual.Nullable; - -/** - * Represents a Minecraft 1.13+ channel identifier. This class is immutable and safe for - * multi-threaded use. - */ -public final class MinecraftChannelIdentifier implements ChannelIdentifier { - - private static final Pattern VALID_IDENTIFIER_REGEX = Pattern.compile("[a-z0-9/\\-_]*"); - - private final String namespace; - private final String name; - - private MinecraftChannelIdentifier(String namespace, String name) { - this.namespace = namespace; - this.name = name; - } - - /** - * Creates an identifier in the default namespace ({@code minecraft}). Plugins are strongly - * encouraged to provide their own namespace. - * - * @param name the name in the default namespace to use - * @return a new channel identifier - */ - public static MinecraftChannelIdentifier forDefaultNamespace(String name) { - return new MinecraftChannelIdentifier("minecraft", name); - } - - /** - * Creates an identifier in the specified namespace. - * - * @param namespace the namespace to use - * @param name the channel name inside the specified namespace - * @return a new channel identifier - */ - public static MinecraftChannelIdentifier create(String namespace, String name) { - Preconditions.checkArgument(!Strings.isNullOrEmpty(namespace), "namespace is null or empty"); - Preconditions.checkArgument(name != null, "namespace is null or empty"); - Preconditions.checkArgument(VALID_IDENTIFIER_REGEX.matcher(namespace).matches(), - "namespace is not valid"); - Preconditions - .checkArgument(VALID_IDENTIFIER_REGEX.matcher(name).matches(), "name is not valid"); - return new MinecraftChannelIdentifier(namespace, name); - } - - /** - * Creates an channel identifier from the specified Minecraft identifier. - * - * @param identifier the Minecraft identifier - * @return a new channel identifier - */ - public static MinecraftChannelIdentifier from(String identifier) { - int colonPos = identifier.indexOf(':'); - if (colonPos == -1) { - throw new IllegalArgumentException("Identifier does not contain a colon."); - } - if (colonPos + 1 == identifier.length()) { - throw new IllegalArgumentException("Identifier is empty."); - } - String namespace = identifier.substring(0, colonPos); - String name = identifier.substring(colonPos + 1); - return create(namespace, name); - } - - public String getNamespace() { - return namespace; - } - - public String getName() { - return name; - } - - @Override - public String toString() { - return namespace + ":" + name + " (modern)"; - } - - @Override - public boolean equals(@Nullable Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MinecraftChannelIdentifier that = (MinecraftChannelIdentifier) o; - return Objects.equals(namespace, that.namespace) - && Objects.equals(name, that.name); - } - - @Override - public int hashCode() { - return Objects.hash(namespace, name); - } - - @Override - public String getId() { - return namespace + ":" + name; - } -} diff --git a/api/src/main/java/com/velocitypowered/api/proxy/messages/PairedPluginChannelId.java b/api/src/main/java/com/velocitypowered/api/proxy/messages/PairedPluginChannelId.java new file mode 100644 index 000000000..2bce1abc0 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/proxy/messages/PairedPluginChannelId.java @@ -0,0 +1,71 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.proxy.messages; + +import com.google.common.base.Preconditions; +import com.google.common.base.Strings; +import net.kyori.adventure.key.Key; + +/** + * Reperesents a legacy channel identifier (for Minecraft 1.12 and below) paired with a namespaced + * key for 1.13 and above. This class is immutable and safe for multi-threaded use. + */ +public final class PairedPluginChannelId implements PluginChannelId { + + private final String legacyChannel; + private final Key modernChannelKey; + + /** + * Creates a new legacy channel identifier. + * + * @param legacyChannel the name for the legacy channel name + * @param modernChannelKey the modern channel key to use + */ + PairedPluginChannelId(String legacyChannel, Key modernChannelKey) { + Preconditions.checkArgument(!Strings.isNullOrEmpty(legacyChannel), "provided name is empty"); + this.legacyChannel = legacyChannel; + this.modernChannelKey = Preconditions.checkNotNull(modernChannelKey, "modernChannelKey"); + } + + public String legacyChannel() { + return legacyChannel; + } + + public Key modernChannelKey() { + return modernChannelKey; + } + + @Override + public String toString() { + return legacyChannel + "/" + modernChannelKey.asString(); + } + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + + PairedPluginChannelId that = (PairedPluginChannelId) o; + + if (!legacyChannel.equals(that.legacyChannel)) { + return false; + } + return modernChannelKey.equals(that.modernChannelKey); + } + + @Override + public int hashCode() { + int result = legacyChannel.hashCode(); + result = 31 * result + modernChannelKey.hashCode(); + return result; + } +} diff --git a/api/src/main/java/com/velocitypowered/api/proxy/messages/PluginChannelId.java b/api/src/main/java/com/velocitypowered/api/proxy/messages/PluginChannelId.java new file mode 100644 index 000000000..49c4dd767 --- /dev/null +++ b/api/src/main/java/com/velocitypowered/api/proxy/messages/PluginChannelId.java @@ -0,0 +1,41 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + +package com.velocitypowered.api.proxy.messages; + +import net.kyori.adventure.key.Key; + +/** + * Represents a channel identifier for use with plugin messaging. + */ +public interface PluginChannelId { + + /** + * Wraps the specified Minecraft key so it can be used as a {@link PluginChannelId}. + * If the client is connected using Minecraft 1.12.2 or earlier, use the key as the + * channel name. + * + * @param key the key instance to wrap + * @return a wrapped plugin channel ID + */ + static KeyedPluginChannelId wrap(Key key) { + return new KeyedPluginChannelId(key); + } + + /** + * Wraps the specified Minecraft key so it can be used as a {@link PluginChannelId}, + * with the specified {@code legacyChannel} for clients connected using Minecraft 1.12.2 + * or earlier. + * + * @param legacyChannel the legacy channel name + * @param modernChannelKey the key instance to wrap + * @return a wrapped plugin channel ID + */ + static PairedPluginChannelId withLegacy(String legacyChannel, Key modernChannelKey) { + return new PairedPluginChannelId(legacyChannel, modernChannelKey); + } +} diff --git a/api/src/main/java/com/velocitypowered/api/proxy/messages/package-info.java b/api/src/main/java/com/velocitypowered/api/proxy/messages/package-info.java index 753595884..d4323b5cd 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/messages/package-info.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/messages/package-info.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + /** * Provides an interface to receive, handle, and send plugin messages on the proxy from clients and * servers. diff --git a/api/src/main/java/com/velocitypowered/api/proxy/package-info.java b/api/src/main/java/com/velocitypowered/api/proxy/package-info.java index 3a22511ab..c817c3b1e 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/package-info.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/package-info.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + /** * Provides an interface to interact with the proxy at a low level. */ diff --git a/api/src/main/java/com/velocitypowered/api/proxy/player/PlayerSettings.java b/api/src/main/java/com/velocitypowered/api/proxy/player/ClientSettings.java similarity index 83% rename from api/src/main/java/com/velocitypowered/api/proxy/player/PlayerSettings.java rename to api/src/main/java/com/velocitypowered/api/proxy/player/ClientSettings.java index 98d52806f..723bf6df3 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/player/PlayerSettings.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/player/ClientSettings.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.proxy.player; import java.util.Locale; @@ -5,7 +12,7 @@ import java.util.Locale; /** * Represents the client settings for the player. */ -public interface PlayerSettings { +public interface ClientSettings { /** * Returns the locale of the Minecraft client. diff --git a/api/src/main/java/com/velocitypowered/api/proxy/player/ConnectionRequestBuilder.java b/api/src/main/java/com/velocitypowered/api/proxy/player/ConnectionRequestBuilder.java index de0372204..94bdce1e4 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/player/ConnectionRequestBuilder.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/player/ConnectionRequestBuilder.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.proxy.player; import com.velocitypowered.api.proxy.connection.Player; @@ -17,7 +24,7 @@ public interface ConnectionRequestBuilder { * * @return the server this request will connect to */ - RegisteredServer getServer(); + RegisteredServer target(); /** * Initiates the connection to the remote server and emits a result on the {@link @@ -54,7 +61,7 @@ public interface ConnectionRequestBuilder { * @return whether or not the request succeeded */ default boolean isSuccessful() { - return getStatus() == Status.SUCCESS; + return status() == Status.SUCCESS; } /** @@ -62,21 +69,21 @@ public interface ConnectionRequestBuilder { * * @return the status for this result */ - Status getStatus(); + Status status(); /** * Returns an (optional) textual reason for the failure to connect to the server. * * @return the reason why the user could not connect to the server */ - Optional getReason(); + Optional failureReason(); /** * Returns the server we actually tried to connect to. * * @return the server we actually tried to connect to */ - RegisteredServer getAttemptedConnection(); + RegisteredServer finalTarget(); } /** diff --git a/api/src/main/java/com/velocitypowered/api/proxy/player/SkinParts.java b/api/src/main/java/com/velocitypowered/api/proxy/player/SkinParts.java index 0a5d0833e..e897dd0f2 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/player/SkinParts.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/player/SkinParts.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.proxy.player; public final class SkinParts { diff --git a/api/src/main/java/com/velocitypowered/api/proxy/player/TabList.java b/api/src/main/java/com/velocitypowered/api/proxy/player/TabList.java index c21882237..bcee9d204 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/player/TabList.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/player/TabList.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.proxy.player; import com.velocitypowered.api.proxy.connection.Player; @@ -56,7 +63,7 @@ public interface TabList { * * @return immutable {@link Collection} of tab list entries */ - Collection getEntries(); + Collection entries(); /** * Builds a tab list entry. diff --git a/api/src/main/java/com/velocitypowered/api/proxy/player/TabListEntry.java b/api/src/main/java/com/velocitypowered/api/proxy/player/TabListEntry.java index 59fd902f8..eedeee88b 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/player/TabListEntry.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/player/TabListEntry.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.proxy.player; import com.velocitypowered.api.util.GameProfile; @@ -15,7 +22,7 @@ public interface TabListEntry { * * @return parent {@link TabList} */ - TabList getTabList(); + TabList parent(); /** * Returns the {@link GameProfile} of the entry, which uniquely identifies the entry with the @@ -24,7 +31,7 @@ public interface TabListEntry { * * @return {@link GameProfile} of the entry */ - GameProfile getProfile(); + GameProfile gameProfile(); /** * Returns {@link Optional} text {@link Component}, which if present is the text @@ -34,7 +41,7 @@ public interface TabListEntry { * @return {@link Optional} text {@link Component} of name displayed in the tab * list */ - Optional getDisplayName(); + Optional displayName(); /** * Sets the text {@link Component} to be displayed for {@code this} {@link TabListEntry}. If @@ -61,16 +68,16 @@ public interface TabListEntry { * * @return latency set for {@code this} entry */ - int getLatency(); + int ping(); /** * Sets the latency for {@code this} entry to the specified value. * * @param latency to changed to * @return {@code this}, for chaining - * @see #getLatency() + * @see #ping() */ - TabListEntry setLatency(int latency); + TabListEntry setPing(int latency); /** * Gets the game mode {@code this} entry has been set to. @@ -85,14 +92,14 @@ public interface TabListEntry { * * @return the game mode */ - int getGameMode(); + int gameMode(); /** * Sets the game mode for {@code this} entry to the specified value. * * @param gameMode to change to * @return {@code this}, for chaining - * @see #getGameMode() + * @see #gameMode() */ TabListEntry setGameMode(int gameMode); @@ -138,7 +145,7 @@ public interface TabListEntry { * * @param profile to set * @return {@code this}, for chaining - * @see TabListEntry#getProfile() + * @see TabListEntry#gameProfile() */ public Builder profile(GameProfile profile) { this.profile = profile; @@ -150,7 +157,7 @@ public interface TabListEntry { * * @param displayName to set * @return {@code this}, for chaining - * @see TabListEntry#getDisplayName() + * @see TabListEntry#displayName() */ public Builder displayName(@Nullable Component displayName) { this.displayName = displayName; @@ -162,7 +169,7 @@ public interface TabListEntry { * * @param latency to set * @return {@code this}, for chaining - * @see TabListEntry#getLatency() + * @see TabListEntry#ping() */ public Builder latency(int latency) { this.latency = latency; @@ -174,7 +181,7 @@ public interface TabListEntry { * * @param gameMode to set * @return {@code this}, for chaining - * @see TabListEntry#getGameMode() + * @see TabListEntry#gameMode() */ public Builder gameMode(int gameMode) { this.gameMode = gameMode; diff --git a/api/src/main/java/com/velocitypowered/api/proxy/player/package-info.java b/api/src/main/java/com/velocitypowered/api/proxy/player/package-info.java index aa3f7686b..248872a3d 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/player/package-info.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/player/package-info.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + /** * Provides an interface to work with players connected to the proxy. */ diff --git a/api/src/main/java/com/velocitypowered/api/proxy/server/QueryResponse.java b/api/src/main/java/com/velocitypowered/api/proxy/server/QueryResponse.java index 566dd0659..bf46d37d4 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/server/QueryResponse.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/server/QueryResponse.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.proxy.server; import com.google.common.annotations.VisibleForTesting; @@ -23,7 +30,7 @@ public final class QueryResponse { private final String hostname; private final String gameVersion; private final String map; - private final int currentPlayers; + private final int onlinePlayers; private final int maxPlayers; private final String proxyHost; private final int proxyPort; @@ -32,13 +39,13 @@ public final class QueryResponse { private final ImmutableCollection plugins; @VisibleForTesting - QueryResponse(String hostname, String gameVersion, String map, int currentPlayers, + QueryResponse(String hostname, String gameVersion, String map, int onlinePlayers, int maxPlayers, String proxyHost, int proxyPort, ImmutableCollection players, String proxyVersion, ImmutableCollection plugins) { this.hostname = hostname; this.gameVersion = gameVersion; this.map = map; - this.currentPlayers = currentPlayers; + this.onlinePlayers = onlinePlayers; this.maxPlayers = maxPlayers; this.proxyHost = proxyHost; this.proxyPort = proxyPort; @@ -53,7 +60,7 @@ public final class QueryResponse { * * @return hostname */ - public String getHostname() { + public String hostname() { return hostname; } @@ -63,7 +70,7 @@ public final class QueryResponse { * * @return game version */ - public String getGameVersion() { + public String gameVersion() { return gameVersion; } @@ -73,7 +80,7 @@ public final class QueryResponse { * * @return map name */ - public String getMap() { + public String mapName() { return map; } @@ -82,8 +89,8 @@ public final class QueryResponse { * * @return online player count */ - public int getCurrentPlayers() { - return currentPlayers; + public int onlinePlayers() { + return onlinePlayers; } /** @@ -91,7 +98,7 @@ public final class QueryResponse { * * @return max player count */ - public int getMaxPlayers() { + public int maxPlayers() { return maxPlayers; } @@ -100,7 +107,7 @@ public final class QueryResponse { * * @return proxy hostname */ - public String getProxyHost() { + public String proxyHost() { return proxyHost; } @@ -109,7 +116,7 @@ public final class QueryResponse { * * @return proxy port */ - public int getProxyPort() { + public int proxyPort() { return proxyPort; } @@ -118,7 +125,7 @@ public final class QueryResponse { * * @return collection of players */ - public Collection getPlayers() { + public Collection players() { return players; } @@ -127,7 +134,7 @@ public final class QueryResponse { * * @return server software */ - public String getProxyVersion() { + public String proxyVersion() { return proxyVersion; } @@ -136,11 +143,10 @@ public final class QueryResponse { * * @return collection of plugins */ - public Collection getPlugins() { + public Collection plugins() { return plugins; } - /** * Creates a new {@link Builder} instance from data represented by this response, so that you * may create a new {@link QueryResponse} with new data. It is guaranteed that @@ -151,16 +157,16 @@ public final class QueryResponse { */ public Builder toBuilder() { return QueryResponse.builder() - .hostname(getHostname()) - .gameVersion(getGameVersion()) - .map(getMap()) - .currentPlayers(getCurrentPlayers()) - .maxPlayers(getMaxPlayers()) - .proxyHost(getProxyHost()) - .proxyPort(getProxyPort()) - .players(getPlayers()) - .proxyVersion(getProxyVersion()) - .plugins(getPlugins()); + .hostname(hostname()) + .gameVersion(gameVersion()) + .map(mapName()) + .onlinePlayers(onlinePlayers()) + .maxPlayers(maxPlayers()) + .proxyHost(proxyHost()) + .proxyPort(proxyPort()) + .players(players()) + .proxyVersion(proxyVersion()) + .plugins(plugins()); } /** @@ -181,7 +187,7 @@ public final class QueryResponse { return false; } QueryResponse response = (QueryResponse) o; - return currentPlayers == response.currentPlayers + return onlinePlayers == response.onlinePlayers && maxPlayers == response.maxPlayers && proxyPort == response.proxyPort && hostname.equals(response.hostname) @@ -195,9 +201,8 @@ public final class QueryResponse { @Override public int hashCode() { - return Objects - .hash(hostname, gameVersion, map, currentPlayers, maxPlayers, proxyHost, proxyPort, players, - proxyVersion, plugins); + return Objects.hash(hostname, gameVersion, map, onlinePlayers, maxPlayers, proxyHost, + proxyPort, players, proxyVersion, plugins); } @Override @@ -206,7 +211,7 @@ public final class QueryResponse { + "hostname='" + hostname + '\'' + ", gameVersion='" + gameVersion + '\'' + ", map='" + map + '\'' - + ", currentPlayers=" + currentPlayers + + ", onlinePlayers=" + onlinePlayers + ", maxPlayers=" + maxPlayers + ", proxyHost='" + proxyHost + '\'' + ", proxyPort=" + proxyPort @@ -226,7 +231,7 @@ public final class QueryResponse { private @MonotonicNonNull String proxyHost; private @MonotonicNonNull String proxyVersion; - private int currentPlayers; + private int onlinePlayers; private int maxPlayers; private int proxyPort; @@ -268,12 +273,12 @@ public final class QueryResponse { /** * Sets the players that are currently claimed to be online. - * @param currentPlayers a non-negative number representing all players online + * @param players a non-negative number representing all players online * @return this builder, for chaining */ - public Builder currentPlayers(int currentPlayers) { - Preconditions.checkArgument(currentPlayers >= 0, "currentPlayers cannot be negative"); - this.currentPlayers = currentPlayers; + public Builder onlinePlayers(int players) { + Preconditions.checkArgument(players >= 0, "currentPlayers cannot be negative"); + this.onlinePlayers = players; return this; } @@ -331,7 +336,7 @@ public final class QueryResponse { } /** - * Removes all players from the builder. This does not affect {@link #getCurrentPlayers()}. + * Removes all players from the builder. This does not affect {@link #onlinePlayers()}. * @return this builder, for chaining */ public Builder clearPlayers() { @@ -390,7 +395,7 @@ public final class QueryResponse { Preconditions.checkNotNull(hostname, "hostname"), Preconditions.checkNotNull(gameVersion, "gameVersion"), Preconditions.checkNotNull(map, "map"), - currentPlayers, + onlinePlayers, maxPlayers, Preconditions.checkNotNull(proxyHost, "proxyHost"), proxyPort, diff --git a/api/src/main/java/com/velocitypowered/api/proxy/server/RegisteredServer.java b/api/src/main/java/com/velocitypowered/api/proxy/server/RegisteredServer.java index 7eb7e454c..db7fbd3af 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/server/RegisteredServer.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/server/RegisteredServer.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.proxy.server; import com.velocitypowered.api.proxy.connection.Player; @@ -18,14 +25,14 @@ public interface RegisteredServer extends ChannelMessageSink, Audience { * * @return the server info */ - ServerInfo getServerInfo(); + ServerInfo serverInfo(); /** * Returns a list of all the players currently connected to this server on this proxy. * * @return the players on this proxy */ - Collection getPlayersConnected(); + Collection connectedPlayers(); /** * Attempts to ping the remote server and return the server list ping result. diff --git a/api/src/main/java/com/velocitypowered/api/proxy/server/ServerInfo.java b/api/src/main/java/com/velocitypowered/api/proxy/server/ServerInfo.java index eb54c2902..b1f9b8427 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/server/ServerInfo.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/server/ServerInfo.java @@ -1,7 +1,13 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.proxy.server; import com.google.common.base.Preconditions; -import java.net.InetSocketAddress; import java.net.SocketAddress; import java.util.Objects; import org.checkerframework.checker.nullness.qual.Nullable; @@ -26,11 +32,11 @@ public final class ServerInfo implements Comparable { this.address = Preconditions.checkNotNull(address, "address"); } - public final String getName() { + public final String name() { return name; } - public final SocketAddress getAddress() { + public final SocketAddress address() { return address; } @@ -62,6 +68,6 @@ public final class ServerInfo implements Comparable { @Override public int compareTo(ServerInfo o) { - return this.name.compareTo(o.getName()); + return this.name.compareTo(o.name()); } } diff --git a/api/src/main/java/com/velocitypowered/api/proxy/server/ServerPing.java b/api/src/main/java/com/velocitypowered/api/proxy/server/ServerPing.java index 8b2f0b0dd..e27e3b08e 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/server/ServerPing.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/server/ServerPing.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.proxy.server; import com.google.common.base.MoreObjects; @@ -11,7 +18,6 @@ import java.util.List; import java.util.Objects; import java.util.Optional; import java.util.UUID; - import net.kyori.adventure.text.Component; import org.checkerframework.checker.nullness.qual.Nullable; @@ -50,23 +56,23 @@ public final class ServerPing { this.modinfo = modinfo; } - public Version getVersion() { + public Version version() { return version; } - public Optional getPlayers() { + public Optional players() { return Optional.ofNullable(players); } - public Component getDescription() { + public Component description() { return description; } - public Optional getFavicon() { + public Optional favicon() { return Optional.ofNullable(favicon); } - public Optional getModinfo() { + public Optional modInfo() { return Optional.ofNullable(modinfo); } @@ -116,7 +122,7 @@ public final class ServerPing { if (players != null) { builder.onlinePlayers = players.online; builder.maximumPlayers = players.max; - builder.samplePlayers.addAll(players.getSample()); + builder.samplePlayers.addAll(players.sample()); } else { builder.nullOutPlayers = true; } @@ -313,11 +319,11 @@ public final class ServerPing { this.name = Preconditions.checkNotNull(name, "name"); } - public int getProtocol() { + public int protocol() { return protocol; } - public String getName() { + public String name() { return name; } @@ -365,15 +371,15 @@ public final class ServerPing { this.sample = ImmutableList.copyOf(sample); } - public int getOnline() { + public int online() { return online; } - public int getMax() { + public int maximum() { return max; } - public List getSample() { + public List sample() { return sample == null ? ImmutableList.of() : sample; } @@ -415,11 +421,11 @@ public final class ServerPing { this.id = id; } - public String getName() { + public String name() { return name; } - public UUID getId() { + public UUID id() { return id; } diff --git a/api/src/main/java/com/velocitypowered/api/proxy/server/package-info.java b/api/src/main/java/com/velocitypowered/api/proxy/server/package-info.java index 7f902113a..eed29b5e7 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/server/package-info.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/server/package-info.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + /** * Provides utilities to handle server information. */ diff --git a/api/src/main/java/com/velocitypowered/api/scheduler/ScheduledTask.java b/api/src/main/java/com/velocitypowered/api/scheduler/ScheduledTask.java index 15cdbd149..1d4161294 100644 --- a/api/src/main/java/com/velocitypowered/api/scheduler/ScheduledTask.java +++ b/api/src/main/java/com/velocitypowered/api/scheduler/ScheduledTask.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.scheduler; /** diff --git a/api/src/main/java/com/velocitypowered/api/scheduler/Scheduler.java b/api/src/main/java/com/velocitypowered/api/scheduler/Scheduler.java index 6f850b98c..f59324d65 100644 --- a/api/src/main/java/com/velocitypowered/api/scheduler/Scheduler.java +++ b/api/src/main/java/com/velocitypowered/api/scheduler/Scheduler.java @@ -1,5 +1,13 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.scheduler; +import java.time.Duration; import java.util.concurrent.TimeUnit; import org.checkerframework.common.value.qual.IntRange; @@ -31,6 +39,16 @@ public interface Scheduler { */ TaskBuilder delay(@IntRange(from = 0) long time, TimeUnit unit); + /** + * Specifies that the task should delay its execution by the specified amount of time. + * + * @param duration the duration of the delay + * @return this builder, for chaining + */ + default TaskBuilder delay(Duration duration) { + return delay(duration.toMillis(), TimeUnit.MILLISECONDS); + } + /** * Specifies that the task should continue running after waiting for the specified amount, until * it is cancelled. @@ -41,6 +59,17 @@ public interface Scheduler { */ TaskBuilder repeat(@IntRange(from = 0) long time, TimeUnit unit); + /** + * Specifies that the task should continue running after waiting for the specified amount, until + * it is cancelled. + * + * @param duration the duration of the delay + * @return this builder, for chaining + */ + default TaskBuilder repeat(Duration duration) { + return repeat(duration.toMillis(), TimeUnit.MILLISECONDS); + } + /** * Clears the delay on this task. * diff --git a/api/src/main/java/com/velocitypowered/api/scheduler/TaskStatus.java b/api/src/main/java/com/velocitypowered/api/scheduler/TaskStatus.java index 2ec051fec..bd10e9b47 100644 --- a/api/src/main/java/com/velocitypowered/api/scheduler/TaskStatus.java +++ b/api/src/main/java/com/velocitypowered/api/scheduler/TaskStatus.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.scheduler; public enum TaskStatus { diff --git a/api/src/main/java/com/velocitypowered/api/scheduler/package-info.java b/api/src/main/java/com/velocitypowered/api/scheduler/package-info.java index 155395528..ade4cdddb 100644 --- a/api/src/main/java/com/velocitypowered/api/scheduler/package-info.java +++ b/api/src/main/java/com/velocitypowered/api/scheduler/package-info.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + /** * Provides utilities for scheduling tasks with a fluent builder. */ diff --git a/api/src/main/java/com/velocitypowered/api/util/FastUuidSansHyphens.java b/api/src/main/java/com/velocitypowered/api/util/FastUuidSansHyphens.java index 158f7e07b..feba60464 100644 --- a/api/src/main/java/com/velocitypowered/api/util/FastUuidSansHyphens.java +++ b/api/src/main/java/com/velocitypowered/api/util/FastUuidSansHyphens.java @@ -1,25 +1,8 @@ /* - * The MIT License (MIT) + * Copyright (C) 2018 Velocity Contributors * - * Copyright (c) 2018 Jon Chambers - * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. */ package com.velocitypowered.api.util; diff --git a/api/src/main/java/com/velocitypowered/api/util/Favicon.java b/api/src/main/java/com/velocitypowered/api/util/Favicon.java index 9ee159991..32d96d22d 100644 --- a/api/src/main/java/com/velocitypowered/api/util/Favicon.java +++ b/api/src/main/java/com/velocitypowered/api/util/Favicon.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.util; import com.google.common.base.Preconditions; diff --git a/api/src/main/java/com/velocitypowered/api/util/FaviconChecker.java b/api/src/main/java/com/velocitypowered/api/util/FaviconChecker.java index 4dcd5a374..2cac6cb3b 100644 --- a/api/src/main/java/com/velocitypowered/api/util/FaviconChecker.java +++ b/api/src/main/java/com/velocitypowered/api/util/FaviconChecker.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.util; import java.nio.ByteBuffer; diff --git a/api/src/main/java/com/velocitypowered/api/util/GameProfile.java b/api/src/main/java/com/velocitypowered/api/util/GameProfile.java index 809eb7850..0f9f41d19 100644 --- a/api/src/main/java/com/velocitypowered/api/util/GameProfile.java +++ b/api/src/main/java/com/velocitypowered/api/util/GameProfile.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.util; import com.google.common.base.Preconditions; diff --git a/api/src/main/java/com/velocitypowered/api/util/ModInfo.java b/api/src/main/java/com/velocitypowered/api/util/ModInfo.java index ac1bd0080..8a2dea74e 100644 --- a/api/src/main/java/com/velocitypowered/api/util/ModInfo.java +++ b/api/src/main/java/com/velocitypowered/api/util/ModInfo.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.util; import com.google.common.base.Preconditions; diff --git a/api/src/main/java/com/velocitypowered/api/util/ProxyVersion.java b/api/src/main/java/com/velocitypowered/api/util/ProxyVersion.java index 59d31a903..22f0e571f 100644 --- a/api/src/main/java/com/velocitypowered/api/util/ProxyVersion.java +++ b/api/src/main/java/com/velocitypowered/api/util/ProxyVersion.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.util; import com.google.common.base.Preconditions; diff --git a/api/src/main/java/com/velocitypowered/api/util/UuidUtils.java b/api/src/main/java/com/velocitypowered/api/util/UuidUtils.java index dfe05af1c..ac0de4fa5 100644 --- a/api/src/main/java/com/velocitypowered/api/util/UuidUtils.java +++ b/api/src/main/java/com/velocitypowered/api/util/UuidUtils.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.util; import com.google.common.base.Preconditions; diff --git a/api/src/main/java/com/velocitypowered/api/util/package-info.java b/api/src/main/java/com/velocitypowered/api/util/package-info.java index ef28b6624..c26f70e7f 100644 --- a/api/src/main/java/com/velocitypowered/api/util/package-info.java +++ b/api/src/main/java/com/velocitypowered/api/util/package-info.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + /** * Provides a selection of miscellaneous utilities for use by plugins and the proxy. */ diff --git a/api/src/test/java/com/velocitypowered/api/proxy/messages/MinecraftChannelIdentifierTest.java b/api/src/test/java/com/velocitypowered/api/proxy/messages/MinecraftChannelIdentifierTest.java deleted file mode 100644 index e7f02e95a..000000000 --- a/api/src/test/java/com/velocitypowered/api/proxy/messages/MinecraftChannelIdentifierTest.java +++ /dev/null @@ -1,56 +0,0 @@ -package com.velocitypowered.api.proxy.messages; - -import static com.velocitypowered.api.proxy.messages.MinecraftChannelIdentifier.create; -import static com.velocitypowered.api.proxy.messages.MinecraftChannelIdentifier.from; -import static org.junit.jupiter.api.Assertions.assertAll; -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertThrows; - -import org.junit.jupiter.api.Test; - -class MinecraftChannelIdentifierTest { - - @Test - void createAllowsValidNamespaces() { - create("minecraft", "brand"); - } - - @Test - void createAllowsEmptyName() { - create("minecraft", ""); - } - - @Test - void createDisallowsNull() { - assertAll( - () -> assertThrows(IllegalArgumentException.class, () -> create(null, "")), - () -> assertThrows(IllegalArgumentException.class, () -> create("", "")), - () -> assertThrows(IllegalArgumentException.class, () -> create("minecraft", null)) - ); - } - - @Test - void fromIdentifierIsCorrect() { - MinecraftChannelIdentifier expected = MinecraftChannelIdentifier.create("velocity", "test"); - assertEquals(expected, MinecraftChannelIdentifier.from("velocity:test")); - } - - @Test - void createAllowsSlashes() { - create("velocity", "test/test2"); - } - - @Test - void fromIdentifierThrowsOnBadValues() { - assertAll( - () -> assertThrows(IllegalArgumentException.class, () -> from("")), - () -> assertThrows(IllegalArgumentException.class, () -> from(":")), - () -> assertThrows(IllegalArgumentException.class, () -> from(":a")), - () -> assertThrows(IllegalArgumentException.class, () -> from("a:")), - () -> assertThrows(IllegalArgumentException.class, () -> from("hello:$$$$$$")), - () -> assertThrows(IllegalArgumentException.class, () -> from("hello::")) - ); - } - - -} \ No newline at end of file diff --git a/api/src/test/java/com/velocitypowered/api/proxy/server/QueryResponseTest.java b/api/src/test/java/com/velocitypowered/api/proxy/server/QueryResponseTest.java index c7222a06f..55964dd22 100644 --- a/api/src/test/java/com/velocitypowered/api/proxy/server/QueryResponseTest.java +++ b/api/src/test/java/com/velocitypowered/api/proxy/server/QueryResponseTest.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.proxy.server; import static org.junit.jupiter.api.Assertions.assertEquals; @@ -13,7 +20,7 @@ class QueryResponseTest { QueryResponse response = new QueryResponse("test", "test", "test", 1, 2, "test", 1234, ImmutableList.of("tuxed"), "0.0.1", ImmutableList.of(new PluginInformation("test", "1.0.0"), - new PluginInformation("test2", null))); + new PluginInformation("test2", null))); assertEquals(response, response.toBuilder().build()); } } \ No newline at end of file diff --git a/api/src/test/java/com/velocitypowered/api/proxy/server/ServerPingTest.java b/api/src/test/java/com/velocitypowered/api/proxy/server/ServerPingTest.java index a99b30c54..9b016ca37 100644 --- a/api/src/test/java/com/velocitypowered/api/proxy/server/ServerPingTest.java +++ b/api/src/test/java/com/velocitypowered/api/proxy/server/ServerPingTest.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.proxy.server; import static org.junit.jupiter.api.Assertions.assertEquals; diff --git a/api/src/test/java/com/velocitypowered/api/util/FaviconCheckerTest.java b/api/src/test/java/com/velocitypowered/api/util/FaviconCheckerTest.java index b61b19323..41073300a 100644 --- a/api/src/test/java/com/velocitypowered/api/util/FaviconCheckerTest.java +++ b/api/src/test/java/com/velocitypowered/api/util/FaviconCheckerTest.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.util; import static org.junit.jupiter.api.Assertions.assertFalse; diff --git a/api/src/test/java/com/velocitypowered/api/util/UuidUtilsTest.java b/api/src/test/java/com/velocitypowered/api/util/UuidUtilsTest.java index b6b37620f..6f467e7ca 100644 --- a/api/src/test/java/com/velocitypowered/api/util/UuidUtilsTest.java +++ b/api/src/test/java/com/velocitypowered/api/util/UuidUtilsTest.java @@ -1,3 +1,10 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * The Velocity API is licensed under the terms of the MIT License. For more details, + * reference the LICENSE file in the api top-level directory. + */ + package com.velocitypowered.api.util; import static org.junit.jupiter.api.Assertions.assertEquals; diff --git a/build.gradle b/build.gradle index 5723240f0..9f7823941 100644 --- a/build.gradle +++ b/build.gradle @@ -10,6 +10,7 @@ buildscript { plugins { id 'java' id "com.github.spotbugs" version "4.2.4" apply false + id 'org.cadixdev.licenser' version '0.5.1' apply false } allprojects { @@ -20,14 +21,14 @@ allprojects { ext { // dependency versions - adventureVersion = '4.5.0' + adventureVersion = '4.7.0' junitVersion = '5.7.0' slf4jVersion = '1.7.30' log4jVersion = '2.13.3' nettyVersion = '4.1.59.Final' guavaVersion = '30.0-jre' checkerFrameworkVersion = '3.6.1' - configurateVersion = '4.0.0-SNAPSHOT' + configurateVersion = '4.0.0' getCurrentShortRevision = { new ByteArrayOutputStream().withStream { os -> diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml index 31cc2ea7c..f419cca1f 100644 --- a/config/checkstyle/checkstyle.xml +++ b/config/checkstyle/checkstyle.xml @@ -31,6 +31,12 @@ + + + + + + diff --git a/proxy/src/test/java/com/velocitypowered/proxy/command/CommandManagerTests.java b/proxy/src/test/java/com/velocitypowered/proxy/command/CommandManagerTests.java index 634555600..158aa8b35 100644 --- a/proxy/src/test/java/com/velocitypowered/proxy/command/CommandManagerTests.java +++ b/proxy/src/test/java/com/velocitypowered/proxy/command/CommandManagerTests.java @@ -1,3 +1,20 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * 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 . + */ + package com.velocitypowered.proxy.command; import static org.junit.jupiter.api.Assertions.assertArrayEquals; @@ -27,7 +44,7 @@ import java.util.List; import java.util.concurrent.ExecutionException; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicReference; -import org.checkerframework.checker.nullness.qual.NonNull; +import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; public class CommandManagerTests { @@ -74,12 +91,12 @@ public class CommandManagerTests { .literal("bar") .build(); BrigadierCommand aliasesCommand = new BrigadierCommand(barNode); - CommandMeta meta = manager.metaBuilder(aliasesCommand) + CommandMeta meta = manager.createMetaBuilder(aliasesCommand) .aliases("baZ") .build(); - assertEquals(ImmutableSet.of("bar", "baz"), meta.getAliases()); - assertTrue(meta.getHints().isEmpty()); + assertEquals(ImmutableSet.of("bar", "baz"), meta.aliases()); + assertTrue(meta.hints().isEmpty()); manager.register(meta, aliasesCommand); assertTrue(manager.hasCommand("bAr")); assertTrue(manager.hasCommand("Baz")); @@ -362,6 +379,7 @@ public class CommandManagerTests { } @Test + @Disabled void testHinting() { VelocityCommandManager manager = createManager(); AtomicBoolean executed = new AtomicBoolean(false); @@ -395,7 +413,7 @@ public class CommandManagerTests { CommandNode bazHint = LiteralArgumentBuilder .literal("baz") .build(); - CommandMeta meta = manager.metaBuilder("foo") + CommandMeta meta = manager.createMetaBuilder("foo") .aliases("foo2") .hint(barHint) .hint(bazHint) diff --git a/proxy/src/test/java/com/velocitypowered/proxy/command/MockCommandSource.java b/proxy/src/test/java/com/velocitypowered/proxy/command/MockCommandSource.java index 52077ccfc..6d056a995 100644 --- a/proxy/src/test/java/com/velocitypowered/proxy/command/MockCommandSource.java +++ b/proxy/src/test/java/com/velocitypowered/proxy/command/MockCommandSource.java @@ -1,3 +1,20 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * 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 . + */ + package com.velocitypowered.proxy.command; import com.velocitypowered.api.command.CommandSource; @@ -8,7 +25,7 @@ public class MockCommandSource implements CommandSource { public static final CommandSource INSTANCE = new MockCommandSource(); @Override - public Tristate getPermissionValue(final String permission) { + public Tristate evaluatePermission(final String permission) { return Tristate.UNDEFINED; } } diff --git a/proxy/src/test/java/com/velocitypowered/proxy/connection/client/HandshakeSessionHandlerTest.java b/proxy/src/test/java/com/velocitypowered/proxy/connection/client/HandshakeSessionHandlerTest.java index c89fc9b87..4a8af8228 100644 --- a/proxy/src/test/java/com/velocitypowered/proxy/connection/client/HandshakeSessionHandlerTest.java +++ b/proxy/src/test/java/com/velocitypowered/proxy/connection/client/HandshakeSessionHandlerTest.java @@ -1,3 +1,20 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * 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 . + */ + package com.velocitypowered.proxy.connection.client; import static com.velocitypowered.proxy.connection.client.HandshakeSessionHandler.cleanVhost; diff --git a/proxy/src/test/java/com/velocitypowered/proxy/event/EventTest.java b/proxy/src/test/java/com/velocitypowered/proxy/event/EventTest.java index ae7590701..bd6941d45 100644 --- a/proxy/src/test/java/com/velocitypowered/proxy/event/EventTest.java +++ b/proxy/src/test/java/com/velocitypowered/proxy/event/EventTest.java @@ -1,3 +1,20 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * 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 . + */ + package com.velocitypowered.proxy.event; import static org.junit.jupiter.api.Assertions.assertEquals; diff --git a/proxy/src/test/java/com/velocitypowered/proxy/event/MockEventManager.java b/proxy/src/test/java/com/velocitypowered/proxy/event/MockEventManager.java index 6b937cda5..f71098d7e 100644 --- a/proxy/src/test/java/com/velocitypowered/proxy/event/MockEventManager.java +++ b/proxy/src/test/java/com/velocitypowered/proxy/event/MockEventManager.java @@ -1,3 +1,20 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * 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 . + */ + package com.velocitypowered.proxy.event; import com.velocitypowered.proxy.plugin.MockPluginManager; diff --git a/proxy/src/test/java/com/velocitypowered/proxy/network/PluginMessageUtilTest.java b/proxy/src/test/java/com/velocitypowered/proxy/network/PluginMessageUtilTest.java index 77cde9a7b..bc9031ffc 100644 --- a/proxy/src/test/java/com/velocitypowered/proxy/network/PluginMessageUtilTest.java +++ b/proxy/src/test/java/com/velocitypowered/proxy/network/PluginMessageUtilTest.java @@ -1,3 +1,20 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * 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 . + */ + package com.velocitypowered.proxy.network; import static org.junit.jupiter.api.Assertions.assertEquals; diff --git a/proxy/src/test/java/com/velocitypowered/proxy/plugin/MockPluginManager.java b/proxy/src/test/java/com/velocitypowered/proxy/plugin/MockPluginManager.java index 170c0cdb6..8fb1247a1 100644 --- a/proxy/src/test/java/com/velocitypowered/proxy/plugin/MockPluginManager.java +++ b/proxy/src/test/java/com/velocitypowered/proxy/plugin/MockPluginManager.java @@ -1,3 +1,20 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * 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 . + */ + package com.velocitypowered.proxy.plugin; import com.google.common.collect.ImmutableList; @@ -22,7 +39,7 @@ public class MockPluginManager implements PluginManager { } @Override - public Collection getPlugins() { + public Collection plugins() { return ImmutableList.of(); } diff --git a/proxy/src/test/java/com/velocitypowered/proxy/plugin/util/PluginDependencyUtilsTest.java b/proxy/src/test/java/com/velocitypowered/proxy/plugin/util/PluginDependencyUtilsTest.java index 0a2901360..aff2ae73f 100644 --- a/proxy/src/test/java/com/velocitypowered/proxy/plugin/util/PluginDependencyUtilsTest.java +++ b/proxy/src/test/java/com/velocitypowered/proxy/plugin/util/PluginDependencyUtilsTest.java @@ -1,3 +1,20 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * 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 . + */ + package com.velocitypowered.proxy.plugin.util; import static org.junit.jupiter.api.Assertions.assertEquals; diff --git a/proxy/src/test/java/com/velocitypowered/proxy/protocol/ProtocolUtilsTest.java b/proxy/src/test/java/com/velocitypowered/proxy/protocol/ProtocolUtilsTest.java new file mode 100644 index 000000000..374fea442 --- /dev/null +++ b/proxy/src/test/java/com/velocitypowered/proxy/protocol/ProtocolUtilsTest.java @@ -0,0 +1,167 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * 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 . + */ + +package com.velocitypowered.proxy.protocol; + +import static org.junit.jupiter.api.Assertions.assertArrayEquals; +import static org.junit.jupiter.api.Assertions.assertEquals; + +import com.velocitypowered.proxy.network.ProtocolUtils; +import io.netty.buffer.ByteBuf; +import io.netty.buffer.ByteBufUtil; +import io.netty.buffer.Unpooled; +import org.junit.jupiter.api.Test; + +public class ProtocolUtilsTest { + + @Test + void negativeVarIntBytes() { + assertEquals(5, ProtocolUtils.varIntBytes(-1)); + assertEquals(5, ProtocolUtils.varIntBytes(Integer.MIN_VALUE)); + } + + @Test + void zeroVarIntBytes() { + assertEquals(1, ProtocolUtils.varIntBytes(0)); + assertEquals(1, ProtocolUtils.varIntBytes(1)); + } + + @Test + void ensureConsistencyAcrossNumberBits() { + for (int i = 0; i <= 31; i++) { + int number = (1 << i) - 1; + assertEquals(conventionalWrittenBytes(number), ProtocolUtils.varIntBytes(number), + "mismatch with " + i + "-bit number"); + } + } + + @Test + void testPositiveOld() { + ByteBuf buf = Unpooled.buffer(5); + for (int i = 0; i >= 0; i += 127) { + writeReadTestOld(buf, i); + } + } + + @Test + void testNegativeOld() { + ByteBuf buf = Unpooled.buffer(5); + for (int i = 0; i <= 0; i -= 127) { + writeReadTestOld(buf, i); + } + } + + private void writeReadTestOld(ByteBuf buf, int test) { + buf.clear(); + writeVarIntOld(buf, test); + assertEquals(test, ProtocolUtils.readVarIntSafely(buf)); + } + + @Test + void test3Bytes() { + ByteBuf buf = Unpooled.buffer(5); + for (int i = 0; i < 2097152; i += 31) { + writeReadTest3Bytes(buf, i); + } + } + + private void writeReadTest3Bytes(ByteBuf buf, int test) { + buf.clear(); + ProtocolUtils.write21BitVarInt(buf, test); + assertEquals(test, ProtocolUtils.readVarInt(buf)); + } + + @Test + void testBytesWrittenAtBitBoundaries() { + ByteBuf varintNew = Unpooled.buffer(5); + ByteBuf varintOld = Unpooled.buffer(5); + + long bytesNew = 0; + long bytesOld = 0; + for (int bit = 0; bit <= 31; bit++) { + int i = (1 << bit) - 1; + + writeVarIntOld(varintOld, i); + ProtocolUtils.writeVarInt(varintNew, i); + assertArrayEquals(ByteBufUtil.getBytes(varintOld), ByteBufUtil.getBytes(varintNew), + "Encoding of " + i + " was invalid"); + + assertEquals(i, oldReadVarIntSafely(varintNew)); + assertEquals(i, ProtocolUtils.readVarIntSafely(varintOld)); + + varintNew.clear(); + varintOld.clear(); + } + assertEquals(bytesNew, bytesOld, "byte sizes differ"); + } + + @Test + void testBytesWritten() { + ByteBuf varintNew = Unpooled.buffer(5); + ByteBuf varintOld = Unpooled.buffer(5); + + long bytesNew = 0; + long bytesOld = 0; + for (int i = 0; i <= 1_000_000; i++) { + ProtocolUtils.writeVarInt(varintNew, i); + writeVarIntOld(varintOld, i); + bytesNew += varintNew.readableBytes(); + bytesOld += varintOld.readableBytes(); + varintNew.clear(); + varintOld.clear(); + } + assertEquals(bytesNew, bytesOld, "byte sizes differ"); + } + + private static int oldReadVarIntSafely(ByteBuf buf) { + int i = 0; + int maxRead = Math.min(5, buf.readableBytes()); + for (int j = 0; j < maxRead; j++) { + int k = buf.readByte(); + i |= (k & 0x7F) << j * 7; + if ((k & 0x80) != 128) { + return i; + } + } + return Integer.MIN_VALUE; + } + + private void writeVarIntOld(ByteBuf buf, int value) { + while (true) { + if ((value & 0xFFFFFF80) == 0) { + buf.writeByte(value); + return; + } + + buf.writeByte(value & 0x7F | 0x80); + value >>>= 7; + } + } + + private int conventionalWrittenBytes(int value) { + int wouldBeWritten = 0; + while (true) { + if ((value & ~0x7FL) == 0) { + wouldBeWritten++; + return wouldBeWritten; + } else { + wouldBeWritten++; + value >>>= 7; + } + } + } +} diff --git a/proxy/src/test/java/com/velocitypowered/proxy/scheduler/VelocitySchedulerTest.java b/proxy/src/test/java/com/velocitypowered/proxy/scheduler/VelocitySchedulerTest.java index 2afc90830..a7e565cd8 100644 --- a/proxy/src/test/java/com/velocitypowered/proxy/scheduler/VelocitySchedulerTest.java +++ b/proxy/src/test/java/com/velocitypowered/proxy/scheduler/VelocitySchedulerTest.java @@ -1,3 +1,20 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * 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 . + */ + package com.velocitypowered.proxy.scheduler; import static org.junit.jupiter.api.Assertions.assertEquals; diff --git a/proxy/src/test/java/com/velocitypowered/proxy/testutil/FakePluginManager.java b/proxy/src/test/java/com/velocitypowered/proxy/testutil/FakePluginManager.java index 1aedeeaab..b72ea461b 100644 --- a/proxy/src/test/java/com/velocitypowered/proxy/testutil/FakePluginManager.java +++ b/proxy/src/test/java/com/velocitypowered/proxy/testutil/FakePluginManager.java @@ -1,3 +1,20 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * 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 . + */ + package com.velocitypowered.proxy.testutil; import com.google.common.collect.ImmutableList; @@ -41,7 +58,7 @@ public class FakePluginManager implements PluginManager { } @Override - public @NonNull Collection getPlugins() { + public @NonNull Collection plugins() { return ImmutableList.of(PC_A, PC_B); } @@ -66,12 +83,12 @@ public class FakePluginManager implements PluginManager { } @Override - public @NonNull PluginDescription getDescription() { + public @NonNull PluginDescription description() { return () -> id; } @Override - public Optional getInstance() { + public Optional instance() { return Optional.of(instance); } } diff --git a/proxy/src/test/java/com/velocitypowered/proxy/util/EncryptionUtilsTest.java b/proxy/src/test/java/com/velocitypowered/proxy/util/EncryptionUtilsTest.java index f6229a018..7aa347796 100644 --- a/proxy/src/test/java/com/velocitypowered/proxy/util/EncryptionUtilsTest.java +++ b/proxy/src/test/java/com/velocitypowered/proxy/util/EncryptionUtilsTest.java @@ -1,3 +1,20 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * 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 . + */ + package com.velocitypowered.proxy.util; import static org.junit.jupiter.api.Assertions.assertEquals; diff --git a/proxy/src/test/java/com/velocitypowered/proxy/util/ServerMapTest.java b/proxy/src/test/java/com/velocitypowered/proxy/util/ServerMapTest.java index 7c67b48bf..ad1206702 100644 --- a/proxy/src/test/java/com/velocitypowered/proxy/util/ServerMapTest.java +++ b/proxy/src/test/java/com/velocitypowered/proxy/util/ServerMapTest.java @@ -1,3 +1,20 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * 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 . + */ + package com.velocitypowered.proxy.util; import static org.junit.jupiter.api.Assertions.assertEquals; diff --git a/proxy/src/test/java/com/velocitypowered/proxy/util/VelocityChannelRegistrarTest.java b/proxy/src/test/java/com/velocitypowered/proxy/util/VelocityChannelRegistrarTest.java index 40af50794..ed10149f9 100644 --- a/proxy/src/test/java/com/velocitypowered/proxy/util/VelocityChannelRegistrarTest.java +++ b/proxy/src/test/java/com/velocitypowered/proxy/util/VelocityChannelRegistrarTest.java @@ -1,25 +1,37 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * 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 . + */ + package com.velocitypowered.proxy.util; import static org.junit.jupiter.api.Assertions.assertEquals; import com.google.common.collect.ImmutableSet; -import com.velocitypowered.api.proxy.messages.LegacyChannelIdentifier; -import com.velocitypowered.api.proxy.messages.MinecraftChannelIdentifier; +import com.velocitypowered.api.proxy.messages.KeyedPluginChannelId; +import com.velocitypowered.api.proxy.messages.PairedPluginChannelId; +import com.velocitypowered.api.proxy.messages.PluginChannelId; +import net.kyori.adventure.key.Key; import org.junit.jupiter.api.Test; class VelocityChannelRegistrarTest { - private static final MinecraftChannelIdentifier MODERN = MinecraftChannelIdentifier - .create("velocity", "test"); - private static final LegacyChannelIdentifier SIMPLE_LEGACY = - new LegacyChannelIdentifier("VelocityTest"); - - private static final MinecraftChannelIdentifier MODERN_SPECIAL_REMAP = MinecraftChannelIdentifier - .create("bungeecord", "main"); - private static final LegacyChannelIdentifier SPECIAL_REMAP_LEGACY = - new LegacyChannelIdentifier("BungeeCord"); - - private static final String SIMPLE_LEGACY_REMAPPED = "legacy:velocitytest"; + private static final KeyedPluginChannelId MODERN = PluginChannelId.wrap( + Key.key("velocity", "moderntest")); + private static final PairedPluginChannelId SIMPLE_LEGACY = + PluginChannelId.withLegacy("VelocityTest", Key.key("velocity", "test")); @Test void register() { @@ -28,30 +40,21 @@ class VelocityChannelRegistrarTest { // Two channels cover the modern channel (velocity:test) and the legacy-mapped channel // (legacy:velocitytest). Make sure they're what we expect. - assertEquals(ImmutableSet.of(MODERN.getId(), SIMPLE_LEGACY_REMAPPED), registrar - .getModernChannelIds()); - assertEquals(ImmutableSet.of(SIMPLE_LEGACY.getId(), MODERN.getId()), registrar + assertEquals( + ImmutableSet.of(MODERN.key().asString(), SIMPLE_LEGACY.modernChannelKey().asString()), + registrar.getModernChannelIds()); + assertEquals( + ImmutableSet.of(SIMPLE_LEGACY.legacyChannel(), MODERN.key().asString()), registrar .getLegacyChannelIds()); } - @Test - void registerSpecialRewrite() { - VelocityChannelRegistrar registrar = new VelocityChannelRegistrar(); - registrar.register(SPECIAL_REMAP_LEGACY, MODERN_SPECIAL_REMAP); - - // This one, just one channel for the modern case. - assertEquals(ImmutableSet.of(MODERN_SPECIAL_REMAP.getId()), registrar.getModernChannelIds()); - assertEquals(ImmutableSet.of(MODERN_SPECIAL_REMAP.getId(), SPECIAL_REMAP_LEGACY.getId()), - registrar.getLegacyChannelIds()); - } - @Test void unregister() { VelocityChannelRegistrar registrar = new VelocityChannelRegistrar(); - registrar.register(MODERN, SIMPLE_LEGACY); + registrar.register(MODERN); registrar.unregister(SIMPLE_LEGACY); - assertEquals(ImmutableSet.of(MODERN.getId()), registrar.getModernChannelIds()); - assertEquals(ImmutableSet.of(MODERN.getId()), registrar.getLegacyChannelIds()); + assertEquals(ImmutableSet.of(MODERN.key().asString()), registrar.getModernChannelIds()); + assertEquals(ImmutableSet.of(MODERN.key().asString()), registrar.getLegacyChannelIds()); } } \ No newline at end of file diff --git a/proxy/src/test/java/com/velocitypowered/proxy/util/collect/CappedSetTest.java b/proxy/src/test/java/com/velocitypowered/proxy/util/collect/CappedSetTest.java index 11df2237d..73943be90 100644 --- a/proxy/src/test/java/com/velocitypowered/proxy/util/collect/CappedSetTest.java +++ b/proxy/src/test/java/com/velocitypowered/proxy/util/collect/CappedSetTest.java @@ -1,3 +1,20 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * 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 . + */ + package com.velocitypowered.proxy.util.collect; import static org.junit.jupiter.api.Assertions.assertEquals; diff --git a/proxy/src/test/java/com/velocitypowered/proxy/util/concurrent/OnceTest.java b/proxy/src/test/java/com/velocitypowered/proxy/util/concurrent/OnceTest.java index f84b81159..aeb7ffb50 100644 --- a/proxy/src/test/java/com/velocitypowered/proxy/util/concurrent/OnceTest.java +++ b/proxy/src/test/java/com/velocitypowered/proxy/util/concurrent/OnceTest.java @@ -1,3 +1,20 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * 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 . + */ + package com.velocitypowered.proxy.util.concurrent; import static org.junit.jupiter.api.Assertions.assertEquals; diff --git a/proxy/src/test/java/com/velocitypowered/proxy/util/ratelimit/GuavaCacheRatelimiterTest.java b/proxy/src/test/java/com/velocitypowered/proxy/util/ratelimit/GuavaCacheRatelimiterTest.java index 3ebb8db0f..39f50e7f2 100644 --- a/proxy/src/test/java/com/velocitypowered/proxy/util/ratelimit/GuavaCacheRatelimiterTest.java +++ b/proxy/src/test/java/com/velocitypowered/proxy/util/ratelimit/GuavaCacheRatelimiterTest.java @@ -1,3 +1,20 @@ +/* + * Copyright (C) 2018 Velocity Contributors + * + * 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 . + */ + package com.velocitypowered.proxy.util.ratelimit; import static org.junit.jupiter.api.Assertions.assertFalse;