diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..726e651 --- /dev/null +++ b/.gitignore @@ -0,0 +1,45 @@ +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### IntelliJ IDEA ### +.idea/modules.xml +.idea/jarRepositories.xml +.idea/compiler.xml +.idea/libraries/ +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### Eclipse ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ + +### Jetbrains IDE ### +.idea + +### Mac OS ### +.DS_Store \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..2f959c3 --- /dev/null +++ b/README.md @@ -0,0 +1,79 @@ +# Netty Http Server + +Netty HttpServer is a Kotlin-based library for building web REST APIs on top of Netty. It provides a simple way to handle HTTP requests and responses, with built-in support for WebSockets and file serving. This library has been used in production as part of the [LiquidBounce](https://github.com/CCBlueX/LiquidBounce) project and is now available as a standalone library. + +## Getting Started + +### Installation + +To include Netty HttpServer in your project, add the following dependency to your `build.gradle` file: + +```gradle +implementation 'com.github.CCBlueX:netty-httpserver:1.0.0' +``` + +### Basic Usage + +Here is an example of how to use the library to create a simple "Hello, World!" REST API: + +```kotlin +import com.google.gson.JsonObject +import net.ccbluex.netty.http.HttpServer +import net.ccbluex.netty.http.util.httpOk + +fun main() { + val server = HttpServer() + + server.routeController.apply { + get("/hello") { + httpOk(JsonObject().apply { + addProperty("message", "Hello, World!") + }) + } + } + + server.start(8080) // Start the server on port 8080 +} +``` + +In this example, the server listens on port `8080` and responds with a JSON message `"Hello, World!"` when accessing the `/hello` endpoint. + +### Examples + +You can find additional examples in the `/examples` folder of the repository. These include: + +1. **Hello World Example**: A basic server that responds with "Hello, World!". +2. **Echo Server**: A server that echoes back any JSON data sent to it. +3. **File Server**: A server that serves files from a specified directory. + +### Running the Examples + +To run the examples, you can use Gradle. In the root of the repository, execute the following command: + +```bash +./gradlew run -Pexample= +``` + +Replace `` with the name of the example you want to run, such as `hello-world`, `echo-server`, or `file-server`. + +For instance, to run the Hello World example, use: + +```bash +./gradlew run -Pexample=hello-world +``` + +## License + +Netty HttpServer is licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for more details. + +## Contributing + +Contributions are welcome! If you have suggestions or improvements, please open an issue or submit a pull request. + +## Author + +Netty HttpServer is developed and maintained by CCBlueX. It was originally part of the LiquidBounce project. + +--- + +Feel free to explore the examples provided and adapt them to your specific needs. Happy coding! \ No newline at end of file diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..61d5e9c --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,101 @@ +plugins { + kotlin("jvm") version "2.0.0" + `maven-publish` +} + +val projectName = "Netty-HttpServer" +val projectDescription = "A Kotlin library for web REST APIs built on top of Netty." +val licenseName = "GNU General Public License v3.0" +val licenseUrl = "https://www.gnu.org/licenses/gpl-3.0.en.html" +val authorName = "ccbluex" +val projectUrl = "https://github.com/ccbluex/netty-httpserver" + +group = "net.ccbluex" +version = "1.0.0" + +repositories { + mavenCentral() +} + +java { + sourceCompatibility = JavaVersion.VERSION_21 + targetCompatibility = JavaVersion.VERSION_21 +} + +kotlin { + jvmToolchain(21) +} + +dependencies { + // https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-core + implementation("org.apache.logging.log4j:log4j-core:2.23.1") + // https://mvnrepository.com/artifact/io.netty/netty-all + implementation("io.netty:netty-all:4.1.82.Final") + // https://mvnrepository.com/artifact/com.google.code.gson/gson + implementation("com.google.code.gson:gson:2.10.1") + // https://mvnrepository.com/artifact/org.apache.tika/tika-core + implementation("org.apache.tika:tika-core:2.9.2") + + testImplementation(kotlin("test")) + // https://mvnrepository.com/artifact/org.mockito/mockito-core + testImplementation("org.mockito:mockito-core:5.13.0") +} + +tasks.test { + useJUnitPlatform() +} + +tasks.withType { + options.release.set(21) +} + +tasks.withType { + manifest { + attributes( + "Implementation-Title" to projectName, + "Implementation-Version" to version, + "Implementation-Vendor" to authorName, + "License" to licenseName, + "License-Url" to licenseUrl + ) + } + + // Include LICENSE file in the JAR + from("LICENSE") { + into("META-INF/") + } +} + +publishing { + publications { + create("pub") { + from(components["java"]) + + pom { + name.set(projectName) + description.set(projectDescription) + url.set(projectUrl) + + licenses { + license { + name.set(licenseName) + url.set(licenseUrl) + } + } + + developers { + developer { + id.set("ccbluex") + name.set(authorName) + } + } + + scm { + connection.set("scm:git:git://github.com/ccbluex/netty-httpserver.git") + developerConnection.set("scm:git:ssh://github.com:ccbluex/netty-httpserver.git") + url.set(projectUrl) + } + } + } + } +} \ No newline at end of file diff --git a/examples/echo-server/.gitignore b/examples/echo-server/.gitignore new file mode 100644 index 0000000..6e1065f --- /dev/null +++ b/examples/echo-server/.gitignore @@ -0,0 +1,21 @@ +.gradle +**/build/ +!src/**/build/ + +# Ignore Gradle GUI config +gradle-app.setting + +# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) +!gradle-wrapper.jar + +# Avoid ignore Gradle wrappper properties +!gradle-wrapper.properties + +# Cache of project +.gradletasknamecache + +# Eclipse Gradle plugin generated files +# Eclipse Core +.project +# JDT-specific (Eclipse Java Development Tools) +.classpath \ No newline at end of file diff --git a/examples/echo-server/build.gradle.kts b/examples/echo-server/build.gradle.kts new file mode 100644 index 0000000..c8e4544 --- /dev/null +++ b/examples/echo-server/build.gradle.kts @@ -0,0 +1,55 @@ +plugins { + kotlin("jvm") version "2.0.0" + application +} +group = "net.ccbluex" +version = "1.0.0" + +repositories { + mavenCentral() +} + +java { + sourceCompatibility = JavaVersion.VERSION_21 + targetCompatibility = JavaVersion.VERSION_21 +} + +kotlin { + jvmToolchain(21) +} + +dependencies { + implementation(project(":")) + + // https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-core + implementation("org.apache.logging.log4j:log4j-core:2.23.1") + // https://mvnrepository.com/artifact/io.netty/netty-all + implementation("io.netty:netty-all:4.1.82.Final") + // https://mvnrepository.com/artifact/com.google.code.gson/gson + implementation("com.google.code.gson:gson:2.10.1") + // https://mvnrepository.com/artifact/org.apache.tika/tika-core + implementation("org.apache.tika:tika-core:2.9.2") +} + +application { + mainClass.set("EchoServerExampleKt") // Specify the main class to run the example +} + +tasks.test { + useJUnitPlatform() +} + +tasks.withType { + options.release.set(21) +} + +tasks.withType { + manifest { + attributes["Main-Class"] = "EchoServerExampleKt" + } + + // Include runtime dependencies in the JAR + from(configurations.runtimeClasspath.get().map { if (it.isDirectory) it else zipTree(it) }) + // Prevent duplicate files from being added to the JAR + duplicatesStrategy = DuplicatesStrategy.EXCLUDE +} \ No newline at end of file diff --git a/examples/echo-server/src/main/kotlin/EchoServerExample.kt b/examples/echo-server/src/main/kotlin/EchoServerExample.kt new file mode 100644 index 0000000..418ebb8 --- /dev/null +++ b/examples/echo-server/src/main/kotlin/EchoServerExample.kt @@ -0,0 +1,15 @@ +import com.google.gson.JsonObject +import net.ccbluex.netty.http.HttpServer +import net.ccbluex.netty.http.util.httpOk + +fun main() { + val server = HttpServer() + + server.routeController.apply { + post("/echo") { request -> + httpOk(request.asJson()) + } + } + + server.start(8080) // Start the server on port 8080 +} diff --git a/examples/file-server/.gitignore b/examples/file-server/.gitignore new file mode 100644 index 0000000..6e1065f --- /dev/null +++ b/examples/file-server/.gitignore @@ -0,0 +1,21 @@ +.gradle +**/build/ +!src/**/build/ + +# Ignore Gradle GUI config +gradle-app.setting + +# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) +!gradle-wrapper.jar + +# Avoid ignore Gradle wrappper properties +!gradle-wrapper.properties + +# Cache of project +.gradletasknamecache + +# Eclipse Gradle plugin generated files +# Eclipse Core +.project +# JDT-specific (Eclipse Java Development Tools) +.classpath \ No newline at end of file diff --git a/examples/file-server/build.gradle.kts b/examples/file-server/build.gradle.kts new file mode 100644 index 0000000..521dd5b --- /dev/null +++ b/examples/file-server/build.gradle.kts @@ -0,0 +1,55 @@ +plugins { + kotlin("jvm") version "2.0.0" + application +} +group = "net.ccbluex" +version = "1.0.0" + +repositories { + mavenCentral() +} + +java { + sourceCompatibility = JavaVersion.VERSION_21 + targetCompatibility = JavaVersion.VERSION_21 +} + +kotlin { + jvmToolchain(21) +} + +dependencies { + implementation(project(":")) + + // https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-core + implementation("org.apache.logging.log4j:log4j-core:2.23.1") + // https://mvnrepository.com/artifact/io.netty/netty-all + implementation("io.netty:netty-all:4.1.82.Final") + // https://mvnrepository.com/artifact/com.google.code.gson/gson + implementation("com.google.code.gson:gson:2.10.1") + // https://mvnrepository.com/artifact/org.apache.tika/tika-core + implementation("org.apache.tika:tika-core:2.9.2") +} + +application { + mainClass.set("FileServerExampleKt") +} + +tasks.test { + useJUnitPlatform() +} + +tasks.withType { + options.release.set(21) +} + +tasks.withType { + manifest { + attributes["Main-Class"] = "FileServerExampleKt" + } + + // Include runtime dependencies in the JAR + from(configurations.runtimeClasspath.get().map { if (it.isDirectory) it else zipTree(it) }) + // Prevent duplicate files from being added to the JAR + duplicatesStrategy = DuplicatesStrategy.EXCLUDE +} \ No newline at end of file diff --git a/examples/file-server/files/index.html b/examples/file-server/files/index.html new file mode 100644 index 0000000..e51aca4 --- /dev/null +++ b/examples/file-server/files/index.html @@ -0,0 +1,11 @@ + + + + + + Hello World + + +

Hello World!

+ + \ No newline at end of file diff --git a/examples/file-server/src/main/kotlin/FileServerExample.kt b/examples/file-server/src/main/kotlin/FileServerExample.kt new file mode 100644 index 0000000..de8487c --- /dev/null +++ b/examples/file-server/src/main/kotlin/FileServerExample.kt @@ -0,0 +1,15 @@ +import net.ccbluex.netty.http.HttpServer +import java.io.File + +fun main() { + val server = HttpServer() + val folder = File("files") + println("Serving files from: ${folder.absolutePath}") + + server.routeController.apply { + // Serve files from the "files" directory + file("/files", folder) + } + + server.start(8080) // Start the server on port 8080 +} diff --git a/examples/hello-world/.gitignore b/examples/hello-world/.gitignore new file mode 100644 index 0000000..6e1065f --- /dev/null +++ b/examples/hello-world/.gitignore @@ -0,0 +1,21 @@ +.gradle +**/build/ +!src/**/build/ + +# Ignore Gradle GUI config +gradle-app.setting + +# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) +!gradle-wrapper.jar + +# Avoid ignore Gradle wrappper properties +!gradle-wrapper.properties + +# Cache of project +.gradletasknamecache + +# Eclipse Gradle plugin generated files +# Eclipse Core +.project +# JDT-specific (Eclipse Java Development Tools) +.classpath \ No newline at end of file diff --git a/examples/hello-world/build.gradle.kts b/examples/hello-world/build.gradle.kts new file mode 100644 index 0000000..1ad5bb3 --- /dev/null +++ b/examples/hello-world/build.gradle.kts @@ -0,0 +1,55 @@ +plugins { + kotlin("jvm") version "2.0.0" + application +} +group = "net.ccbluex" +version = "1.0.0" + +repositories { + mavenCentral() +} + +java { + sourceCompatibility = JavaVersion.VERSION_21 + targetCompatibility = JavaVersion.VERSION_21 +} + +kotlin { + jvmToolchain(21) +} + +dependencies { + implementation(project(":")) + + // https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-core + implementation("org.apache.logging.log4j:log4j-core:2.23.1") + // https://mvnrepository.com/artifact/io.netty/netty-all + implementation("io.netty:netty-all:4.1.82.Final") + // https://mvnrepository.com/artifact/com.google.code.gson/gson + implementation("com.google.code.gson:gson:2.10.1") + // https://mvnrepository.com/artifact/org.apache.tika/tika-core + implementation("org.apache.tika:tika-core:2.9.2") +} + +application { + mainClass.set("HelloWorldExampleKt") +} + +tasks.test { + useJUnitPlatform() +} + +tasks.withType { + options.release.set(21) +} + +tasks.withType { + manifest { + attributes["Main-Class"] = "HelloWorldExampleKt" + } + + // Include runtime dependencies in the JAR + from(configurations.runtimeClasspath.get().map { if (it.isDirectory) it else zipTree(it) }) + // Prevent duplicate files from being added to the JAR + duplicatesStrategy = DuplicatesStrategy.EXCLUDE +} \ No newline at end of file diff --git a/examples/hello-world/src/main/kotlin/HelloWorldExample.kt b/examples/hello-world/src/main/kotlin/HelloWorldExample.kt new file mode 100644 index 0000000..457bea2 --- /dev/null +++ b/examples/hello-world/src/main/kotlin/HelloWorldExample.kt @@ -0,0 +1,17 @@ +import com.google.gson.JsonObject +import net.ccbluex.netty.http.HttpServer +import net.ccbluex.netty.http.util.httpOk + +fun main() { + val server = HttpServer() + + server.routeController.apply { + get("/hello") { + httpOk(JsonObject().apply { + addProperty("message", "Hello, World!") + }) + } + } + + server.start(8080) // Start the server on port 8080 +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..7fc6f1f --- /dev/null +++ b/gradle.properties @@ -0,0 +1 @@ +kotlin.code.style=official diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..249e583 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..6fc2aa6 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Mon Sep 02 03:41:15 CEST 2024 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..1b6c787 --- /dev/null +++ b/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/jitpack.yml b/jitpack.yml new file mode 100644 index 0000000..a202792 --- /dev/null +++ b/jitpack.yml @@ -0,0 +1,2 @@ +jdk: + - openjdk21 \ No newline at end of file diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..85cfcbf --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,8 @@ +plugins { + id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0" +} +rootProject.name = "netty-httpserver" + +include(":examples:hello-world") +include(":examples:echo-server") +include(":examples:file-server") diff --git a/src/main/kotlin/net/ccbluex/netty/http/HttpChannelInitializer.kt b/src/main/kotlin/net/ccbluex/netty/http/HttpChannelInitializer.kt new file mode 100644 index 0000000..2106799 --- /dev/null +++ b/src/main/kotlin/net/ccbluex/netty/http/HttpChannelInitializer.kt @@ -0,0 +1,39 @@ +/* + * This file is part of Netty-Rest (https://github.com/CCBlueX/netty-rest) + * + * Copyright (c) 2024 CCBlueX + * + * LiquidBounce 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. + * + * Netty-Rest 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 Netty-Rest. If not, see . + * + */ +package net.ccbluex.netty.http + +import io.netty.channel.ChannelInitializer +import io.netty.channel.socket.SocketChannel +import io.netty.handler.codec.http.HttpServerCodec + +internal class HttpChannelInitializer(private val server: HttpServer) : ChannelInitializer() { + + /** + * Initializes the channel with the necessary handlers. + * + * @param socketChannel The socket channel to initialize. + */ + override fun initChannel(socketChannel: SocketChannel) { + val pipeline = socketChannel.pipeline() + pipeline.addLast("httpServerCodec", HttpServerCodec()) + pipeline.addLast("httpHandler", HttpServerHandler(server)) + } + +} diff --git a/src/main/kotlin/net/ccbluex/netty/http/HttpConductor.kt b/src/main/kotlin/net/ccbluex/netty/http/HttpConductor.kt new file mode 100644 index 0000000..056f2ed --- /dev/null +++ b/src/main/kotlin/net/ccbluex/netty/http/HttpConductor.kt @@ -0,0 +1,85 @@ +/* + * This file is part of Netty-Rest (https://github.com/CCBlueX/netty-rest) + * + * Copyright (c) 2024 CCBlueX + * + * LiquidBounce 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. + * + * Netty-Rest 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 Netty-Rest. If not, see . + * + */ +package net.ccbluex.netty.http + +import io.netty.buffer.Unpooled +import io.netty.handler.codec.http.* +import net.ccbluex.netty.http.HttpServer.Companion.logger +import net.ccbluex.netty.http.util.httpBadRequest +import net.ccbluex.netty.http.util.httpInternalServerError +import net.ccbluex.netty.http.util.httpNotFound +import net.ccbluex.netty.http.model.RequestObject + +internal class HttpConductor(private val server: HttpServer) { + + /** + * Processes the incoming request object and returns the response. + * + * @param requestObject The incoming request object. + * @return The response to the request. + */ + fun processRequestObject(requestObject: RequestObject) = runCatching { + val context = requestObject.context + val method = context.httpMethod + + logger.debug("Request {}", requestObject) + + if (!context.headers["content-length"].isNullOrEmpty() && + context.headers["content-length"]?.toInt() != requestObject.content.toByteArray(Charsets.UTF_8).size) { + logger.warn("Received incomplete request: $requestObject") + return@runCatching httpBadRequest("Incomplete request") + } + + if (method == HttpMethod.OPTIONS) { + val response = DefaultFullHttpResponse( + HttpVersion.HTTP_1_1, + HttpResponseStatus.OK, + Unpooled.wrappedBuffer(ByteArray(0)) + ) + + val httpHeaders = response.headers() + httpHeaders[HttpHeaderNames.CONTENT_TYPE] = "text/plain" + httpHeaders[HttpHeaderNames.CONTENT_LENGTH] = response.content().readableBytes() + httpHeaders[HttpHeaderNames.ACCESS_CONTROL_ALLOW_ORIGIN] = "*" + httpHeaders[HttpHeaderNames.ACCESS_CONTROL_ALLOW_METHODS] = "GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS" + httpHeaders[HttpHeaderNames.ACCESS_CONTROL_ALLOW_HEADERS] = "Content-Type, Content-Length, Authorization, Accept, X-Requested-With" + return@runCatching response + } + + server.routeController.findRoute(context.path, method)?.let { route -> + logger.debug("Found route {}", route) + return@runCatching route.handler(requestObject) + } + + if (method == HttpMethod.GET) { + server.routeController.findFileServant(context.path)?.let { (fileServant, path) -> + logger.debug("Found file servant {}", fileServant) + return@runCatching fileServant.handleFileRequest(path) + } + } + + httpNotFound(context.path, "Route not found") + }.getOrElse { + logger.error("Error while processing request object: $requestObject", it) + httpInternalServerError(it.message ?: "Unknown error") + } + + +} diff --git a/src/main/kotlin/net/ccbluex/netty/http/HttpServer.kt b/src/main/kotlin/net/ccbluex/netty/http/HttpServer.kt new file mode 100644 index 0000000..4ebd4bb --- /dev/null +++ b/src/main/kotlin/net/ccbluex/netty/http/HttpServer.kt @@ -0,0 +1,83 @@ +/* + * This file is part of Netty-Rest (https://github.com/CCBlueX/netty-rest) + * + * Copyright (c) 2024 CCBlueX + * + * LiquidBounce 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. + * + * Netty-Rest 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 Netty-Rest. If not, see . + * + */ +package net.ccbluex.netty.http + +import io.netty.bootstrap.ServerBootstrap +import io.netty.channel.ChannelOption +import io.netty.channel.epoll.Epoll +import io.netty.channel.epoll.EpollEventLoopGroup +import io.netty.channel.epoll.EpollServerSocketChannel +import io.netty.channel.nio.NioEventLoopGroup +import io.netty.channel.socket.nio.NioServerSocketChannel +import io.netty.handler.logging.LogLevel +import io.netty.handler.logging.LoggingHandler +import net.ccbluex.netty.http.rest.RouteController +import net.ccbluex.netty.http.websocket.WebSocketController +import org.apache.logging.log4j.LogManager + +/** + * NettyRest - A Web Rest-API server with support for WebSocket and File Serving using Netty. + * + * @since 1.0 + */ +class HttpServer { + + val routeController = RouteController() + val webSocketController = WebSocketController() + + companion object { + internal val logger = LogManager.getLogger("HttpServer") + } + + /** + * Starts the Netty server on the specified port. + */ + fun start(port: Int) { + val bossGroup = if (Epoll.isAvailable()) EpollEventLoopGroup() else NioEventLoopGroup() + val workerGroup = if (Epoll.isAvailable()) EpollEventLoopGroup() else NioEventLoopGroup() + + try { + logger.info("Starting Netty server...") + val b = ServerBootstrap() + b.option(ChannelOption.SO_BACKLOG, 1024) + b.group(bossGroup, workerGroup) + .channel(if (Epoll.isAvailable()) EpollServerSocketChannel::class.java else NioServerSocketChannel::class.java) + .handler(LoggingHandler(LogLevel.INFO)) + .childHandler(HttpChannelInitializer(this)) + val ch = b.bind(port).sync().channel() + + logger.info("Netty server started on port $port.") + ch.closeFuture().sync() + } catch (e: InterruptedException) { + logger.error("Netty server interrupted", e) + } catch (t: Throwable) { + logger.error("Netty server failed - $port", t) + + // Forward the exception because we ran into an unexpected error + throw t + } finally { + bossGroup.shutdownGracefully() + workerGroup.shutdownGracefully() + } + + logger.info("Netty server stopped.") + } + +} diff --git a/src/main/kotlin/net/ccbluex/netty/http/HttpServerHandler.kt b/src/main/kotlin/net/ccbluex/netty/http/HttpServerHandler.kt new file mode 100644 index 0000000..8c76c48 --- /dev/null +++ b/src/main/kotlin/net/ccbluex/netty/http/HttpServerHandler.kt @@ -0,0 +1,126 @@ +/* + * This file is part of Netty-Rest (https://github.com/CCBlueX/netty-rest) + * + * Copyright (c) 2024 CCBlueX + * + * LiquidBounce 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. + * + * Netty-Rest 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 Netty-Rest. If not, see . + * + */ +package net.ccbluex.netty.http + +import io.netty.channel.ChannelHandlerContext +import io.netty.channel.ChannelInboundHandlerAdapter +import io.netty.handler.codec.http.HttpContent +import io.netty.handler.codec.http.HttpHeaderNames +import io.netty.handler.codec.http.HttpRequest +import io.netty.handler.codec.http.LastHttpContent +import io.netty.handler.codec.http.websocketx.WebSocketServerHandshakerFactory +import net.ccbluex.netty.http.HttpServer.Companion.logger +import net.ccbluex.netty.http.model.RequestContext +import net.ccbluex.netty.http.model.RequestObject +import net.ccbluex.netty.http.websocket.WebSocketHandler +import java.net.URLDecoder + +/** + * Handles HTTP requests + * + * @property server The instance of the http server. + */ +internal class HttpServerHandler(private val server: HttpServer) : ChannelInboundHandlerAdapter() { + + private val localRequestContext = ThreadLocal() + + /** + * Extension property to get the WebSocket URL from an HttpRequest. + */ + private val HttpRequest.webSocketUrl: String + get() = "ws://${headers().get("Host")}${uri()}" + + /** + * Reads the incoming messages and processes HTTP requests. + * + * @param ctx The context of the channel handler. + * @param msg The incoming message. + */ + override fun channelRead(ctx: ChannelHandlerContext, msg: Any) { + when (msg) { + is HttpRequest -> { + val headers = msg.headers() + val connection = headers.get(HttpHeaderNames.CONNECTION) + val upgrade = headers.get(HttpHeaderNames.UPGRADE) + + logger.debug( + "Incoming connection {} with headers: \n{}", + ctx.channel(), + headers.joinToString { "${it.key}=${it.value}\n" }) + + if (connection.equals("Upgrade", ignoreCase = true) && + upgrade.equals("WebSocket", ignoreCase = true)) { + // Takes out Http Request Handler from the pipeline and replaces it with WebSocketHandler + ctx.pipeline().replace(this, "websocketHandler", WebSocketHandler(server)) + + // Upgrade connection from Http to WebSocket protocol + val wsFactory = WebSocketServerHandshakerFactory(msg.webSocketUrl, null, true) + val handshaker = wsFactory.newHandshaker(msg) + + if (handshaker == null) { + // This means the version of the websocket protocol is not supported + // Unlikely to happen, but it's better to be safe than sorry + WebSocketServerHandshakerFactory.sendUnsupportedVersionResponse(ctx.channel()) + } else { + // Otherwise pass handshake to the handshaker + handshaker.handshake(ctx.channel(), msg) + } + + server.webSocketController.activeContexts += ctx + } else { + val requestContext = RequestContext( + msg.method(), + URLDecoder.decode(msg.uri(), "UTF-8"), + msg.headers().associate { it.key to it.value }, + ) + + localRequestContext.set(requestContext) + } + } + + is HttpContent -> { + if (localRequestContext.get() == null) { + logger.warn("Received HttpContent without HttpRequest") + return + } + + // Append content to the buffer + val requestContext = localRequestContext.get() + requestContext + .contentBuffer + .append(msg.content().toString(Charsets.UTF_8)) + + // If this is the last content, process the request + if (msg is LastHttpContent) { + val requestObject = RequestObject(requestContext) + localRequestContext.remove() + + val httpConductor = HttpConductor(server) + val response = httpConductor.processRequestObject(requestObject) + ctx.writeAndFlush(response) + } + } + + } + + super.channelRead(ctx, msg) + } + +} \ No newline at end of file diff --git a/src/main/kotlin/net/ccbluex/netty/http/model/RequestContext.kt b/src/main/kotlin/net/ccbluex/netty/http/model/RequestContext.kt new file mode 100644 index 0000000..09a7232 --- /dev/null +++ b/src/main/kotlin/net/ccbluex/netty/http/model/RequestContext.kt @@ -0,0 +1,55 @@ +/* + * This file is part of Netty-Rest (https://github.com/CCBlueX/netty-rest) + * + * Copyright (c) 2024 CCBlueX + * + * LiquidBounce 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. + * + * Netty-Rest 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 Netty-Rest. If not, see . + * + */ +package net.ccbluex.netty.http.model + +import io.netty.handler.codec.http.HttpMethod +import java.util.* +import java.util.stream.Collectors + +data class RequestContext(var httpMethod: HttpMethod, var uri: String, var headers: Map) { + val contentBuffer = StringBuilder() + val path = if (uri.contains("?")) uri.substring(0, uri.indexOf('?')) else uri + val params = getUriParams(uri) +} + +/** + * The received uri should be like: '...?param1=value¶m2=value' + */ +private fun getUriParams(uri: String): Map { + if (uri.contains("?")) { + val paramsString = uri.substring(uri.indexOf('?') + 1) + + // in case of duplicated params, will be used la last value + return Arrays.stream( + if (paramsString.contains("&")) paramsString.split("&".toRegex()).dropLastWhile { it.isEmpty() } + .toTypedArray() else arrayOf(paramsString)) + .map { value: String -> + value.split("=".toRegex()).dropLastWhile { it.isEmpty() } + .toTypedArray() + } + .collect( + Collectors.toMap( + { paramValue: Array -> paramValue[0] }, + { paramValue: Array -> paramValue[1] }, + { v1: String?, v2: String -> v2 }) + ) + } + return HashMap() +} diff --git a/src/main/kotlin/net/ccbluex/netty/http/model/RequestObject.kt b/src/main/kotlin/net/ccbluex/netty/http/model/RequestObject.kt new file mode 100644 index 0000000..801d3bd --- /dev/null +++ b/src/main/kotlin/net/ccbluex/netty/http/model/RequestObject.kt @@ -0,0 +1,32 @@ +/* + * This file is part of Netty-Rest (https://github.com/CCBlueX/netty-rest) + * + * Copyright (c) 2024 CCBlueX + * + * LiquidBounce 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. + * + * Netty-Rest 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 Netty-Rest. If not, see . + * + */ +package net.ccbluex.netty.http.model + +import com.google.gson.Gson + +data class RequestObject(var context: RequestContext) { + val content = context.contentBuffer.toString() + val params = context.params + + inline fun asJson(): T { + return Gson().fromJson(content, T::class.java) + } + +} diff --git a/src/main/kotlin/net/ccbluex/netty/http/rest/RouteControl.kt b/src/main/kotlin/net/ccbluex/netty/http/rest/RouteControl.kt new file mode 100644 index 0000000..7bc4475 --- /dev/null +++ b/src/main/kotlin/net/ccbluex/netty/http/rest/RouteControl.kt @@ -0,0 +1,175 @@ +/* + * This file is part of Netty-Rest (https://github.com/CCBlueX/netty-rest) + * + * Copyright (c) 2024 CCBlueX + * + * LiquidBounce 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. + * + * Netty-Rest 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 Netty-Rest. If not, see . + * + */ +package net.ccbluex.netty.http.rest + +import io.netty.handler.codec.http.FullHttpResponse +import io.netty.handler.codec.http.HttpMethod +import net.ccbluex.netty.http.HttpServer.Companion.logger +import net.ccbluex.netty.http.util.httpFile +import net.ccbluex.netty.http.util.httpForbidden +import net.ccbluex.netty.http.util.httpNotFound +import net.ccbluex.netty.http.model.RequestObject +import java.io.File + +class RouteController : RestNode("") + +@Suppress("TooManyFunctions") +open class RestNode(val path: String) { + + private val nodes = mutableListOf() + + fun new(path: String) = RestNode(path).also { nodes += it } + + fun get(path: String, handler: (RequestObject) -> FullHttpResponse) + = Route(path, HttpMethod.GET, handler).also { nodes += it } + + fun post(path: String, handler: (RequestObject) -> FullHttpResponse) + = Route(path, HttpMethod.POST, handler).also { nodes += it } + + fun put(path: String, handler: (RequestObject) -> FullHttpResponse) + = Route(path, HttpMethod.PUT, handler).also { nodes += it } + + fun delete(path: String, handler: (RequestObject) -> FullHttpResponse) + = Route(path, HttpMethod.DELETE, handler).also { nodes += it } + + fun patch(path: String, handler: (RequestObject) -> FullHttpResponse) + = Route(path, HttpMethod.PATCH, handler).also { nodes += it } + + fun head(path: String, handler: (RequestObject) -> FullHttpResponse) + = Route(path, HttpMethod.HEAD, handler).also { nodes += it } + + fun options(path: String, handler: (RequestObject) -> FullHttpResponse) + = Route(path, HttpMethod.OPTIONS, handler).also { nodes += it } + + fun trace(path: String, handler: (RequestObject) -> FullHttpResponse) + = Route(path, HttpMethod.TRACE, handler).also { nodes += it } + + fun file(path: String, baseFolder: File) = FileServant(path, baseFolder).also { nodes += it } + + /** + * Find a route for the given URI path and http method + * + * @param path URI path + * @param method HTTP method + * @return Route or null if no route was found + * + * @example findRoute("/api/v1/users", HttpMethod.GET) + */ + fun findRoute(path: String, method: HttpMethod): Route? { + logger.debug("FR --------- ${if (this is Route) "ROUTE" else "NODE"} ${this.path} ---------") + + val takenOff = path.substring(this.path.length) + logger.debug("Search for route: {} {}", method, takenOff) + + // Nodes can now either include a route with the correct method or a node with a path that matches + // the given path + val nodes = nodes.filter { + logger.debug("Check node: $takenOff startsWith ${it.path} -> ${path.startsWith(it.path)}") + takenOff.startsWith(it.path) + } + + logger.debug("Found ${nodes.size} nodes") + + // Now we have to decide if the route matches the path exactly or if it is a node step + val exactMatch = nodes.filterIsInstance().find { + logger.debug("Check route: {} == {} && {} == {}", it.path, takenOff, it.method, method) + it.method == method && it.path == takenOff + } + if (exactMatch != null) { + return exactMatch + } + + logger.debug("No exact match found") + + // If we have no exact match we have to find the node that matches the path + val nodeMatch = nodes.firstOrNull() ?: return null + logger.debug("Found node match: ${nodeMatch.path}") + return nodeMatch.findRoute(takenOff, method) + } + + /** + * Find a route for the given URI path and http method + * + * @param path URI path + * @param method HTTP method + * @return Route or null if no route was found + * + * @example findRoute("/api/v1/users", HttpMethod.GET) + */ + fun findFileServant(path: String): Pair? { + logger.debug("FFS --------- ${if (this is Route) "ROUTE" else "NODE"} ${this.path} ---------") + + val takenOff = path.substring(this.path.length) + logger.debug("Search for file servant: {}", takenOff) + + // Nodes can now either include a route with the correct method or a node with a path that matches + // the given path + val nodes = nodes.filter { + logger.debug("Check node: $takenOff startsWith ${it.path} -> ${path.startsWith(it.path)}") + takenOff.startsWith(it.path) + } + + logger.debug("Found ${nodes.size} nodes") + + // Now we have to decide if the file servant matches the path exactly or if it is a node step + val exactMatch = nodes.filterIsInstance().firstOrNull() + if (exactMatch != null) { + return exactMatch to takenOff + } + + logger.debug("No exact match found") + + // If we have no exact match we have to find the node that matches the path + val nodeMatch = nodes.firstOrNull() ?: return null + logger.debug("Found node match: ${nodeMatch.path}") + return nodeMatch.findFileServant(takenOff) + } + +} + +open class Route(name: String, val method: HttpMethod, val handler: (RequestObject) -> FullHttpResponse) + : RestNode(name) + +class FileServant(val name: String, private val baseFolder: File) : RestNode(name) { + + internal fun handleFileRequest(path: String): FullHttpResponse { + val filePath = path.substring(name.length).let { + if (it.startsWith("/")) it.substring(1) else it + } + + val sanitizedPath = filePath.replace("..", "") + val file = baseFolder.resolve(sanitizedPath) + + return when { + !file.exists() -> httpNotFound(filePath, "File not found") + !file.isFile -> { + val indexFile = file.resolve("index.html") + + when { + indexFile.exists() && indexFile.isFile -> httpFile(indexFile) + else -> httpForbidden("File is not a file") + } + } + file.isHidden -> httpForbidden("File is hidden") + else -> httpFile(file) + } + } + +} diff --git a/src/main/kotlin/net/ccbluex/netty/http/util/Base64.kt b/src/main/kotlin/net/ccbluex/netty/http/util/Base64.kt new file mode 100644 index 0000000..11e9982 --- /dev/null +++ b/src/main/kotlin/net/ccbluex/netty/http/util/Base64.kt @@ -0,0 +1,36 @@ +/* + * This file is part of Netty-Rest (https://github.com/CCBlueX/netty-rest) + * + * Copyright (c) 2024 CCBlueX + * + * LiquidBounce 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. + * + * Netty-Rest 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 Netty-Rest. If not, see . + * + */ +package net.ccbluex.netty.http.util + +import java.nio.file.Path +import kotlin.io.encoding.Base64 +import kotlin.io.encoding.ExperimentalEncodingApi +import kotlin.io.path.readBytes + +/** + * Reads the image at the given [path] and returns it as a base64 encoded string. + */ +fun readImageAsBase64(path: Path): String = path.readBytes().encodeBase64() + +/** + * Encodes the byte array to a base64 encoded string. + */ +@OptIn(ExperimentalEncodingApi::class) +private fun ByteArray.encodeBase64() = Base64.encode(this) diff --git a/src/main/kotlin/net/ccbluex/netty/http/util/HttpResponse.kt b/src/main/kotlin/net/ccbluex/netty/http/util/HttpResponse.kt new file mode 100644 index 0000000..e9ae85f --- /dev/null +++ b/src/main/kotlin/net/ccbluex/netty/http/util/HttpResponse.kt @@ -0,0 +1,168 @@ +/* + * This file is part of Netty-Rest (https://github.com/CCBlueX/netty-rest) + * + * Copyright (c) 2024 CCBlueX + * + * LiquidBounce 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. + * + * Netty-Rest 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 Netty-Rest. If not, see . + * + */ +package net.ccbluex.netty.http.util + +import com.google.gson.Gson +import com.google.gson.JsonElement +import com.google.gson.JsonObject +import io.netty.buffer.Unpooled +import io.netty.handler.codec.http.* +import org.apache.tika.Tika +import java.io.File +import java.io.InputStream + +/** + * Creates an HTTP response with the given status, content type, and content. + * + * @param status The HTTP response status. + * @param contentType The content type of the response. Defaults to "text/plain". + * @param content The content of the response. + * @return A FullHttpResponse object. + */ +fun httpResponse(status: HttpResponseStatus, contentType: String = "text/plain", + content: String): FullHttpResponse { + val response = DefaultFullHttpResponse( + HttpVersion.HTTP_1_1, + status, + Unpooled.wrappedBuffer(content.toByteArray()) + ) + + val httpHeaders = response.headers() + httpHeaders[HttpHeaderNames.CONTENT_TYPE] = contentType + httpHeaders[HttpHeaderNames.CONTENT_LENGTH] = response.content().readableBytes() + httpHeaders[HttpHeaderNames.ACCESS_CONTROL_ALLOW_ORIGIN] = "*" + httpHeaders[HttpHeaderNames.ACCESS_CONTROL_ALLOW_METHODS] = "GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS" + httpHeaders[HttpHeaderNames.ACCESS_CONTROL_ALLOW_HEADERS] = "Content-Type, Content-Length, Authorization, Accept, X-Requested-With" + return response +} + +/** + * Creates an HTTP response with the given status and JSON content. + * + * @param status The HTTP response status. + * @param json The JSON content of the response. + * @return A FullHttpResponse object. + */ +fun httpResponse(status: HttpResponseStatus, json: JsonElement) + = httpResponse(status, "application/json", Gson().toJson(json)) + +/** + * Creates an HTTP 200 OK response with the given JSON content. + * + * @param jsonElement The JSON content of the response. + * @return A FullHttpResponse object. + */ +fun httpOk(jsonElement: JsonElement) + = httpResponse(HttpResponseStatus.OK, jsonElement) + +/** + * Creates an HTTP 404 Not Found response with the given path and reason. + * + * @param path The path that was not found. + * @param reason The reason for the 404 error. + * @return A FullHttpResponse object. + */ +fun httpNotFound(path: String, reason: String): FullHttpResponse { + val jsonObject = JsonObject() + jsonObject.addProperty("path", path) + jsonObject.addProperty("reason", reason) + return httpResponse(HttpResponseStatus.NOT_FOUND, jsonObject) +} + +/** + * Creates an HTTP 500 Internal Server Error response with the given exception message. + * + * @param exception The exception message. + * @return A FullHttpResponse object. + */ +fun httpInternalServerError(exception: String): FullHttpResponse { + val jsonObject = JsonObject() + jsonObject.addProperty("reason", exception) + return httpResponse(HttpResponseStatus.INTERNAL_SERVER_ERROR, jsonObject) +} + +/** + * Creates an HTTP 403 Forbidden response with the given reason. + * + * @param reason The reason for the 403 error. + * @return A FullHttpResponse object. + */ +fun httpForbidden(reason: String): FullHttpResponse { + val jsonObject = JsonObject() + jsonObject.addProperty("reason", reason) + return httpResponse(HttpResponseStatus.FORBIDDEN, jsonObject) +} + +/** + * Creates an HTTP 400 Bad Request response with the given reason. + * + * @param reason The reason for the 400 error. + * @return A FullHttpResponse object. + */ +fun httpBadRequest(reason: String): FullHttpResponse { + val jsonObject = JsonObject() + jsonObject.addProperty("reason", reason) + return httpResponse(HttpResponseStatus.BAD_REQUEST, jsonObject) +} + +private val tika = Tika() + +/** + * Creates an HTTP response for the given file. + * + * @param file The file to be included in the response. + * @return A FullHttpResponse object. + */ +fun httpFile(file: File): FullHttpResponse { + val response = DefaultFullHttpResponse( + HttpVersion.HTTP_1_1, + HttpResponseStatus.OK, + Unpooled.wrappedBuffer(file.readBytes()) + ) + + val httpHeaders = response.headers() + httpHeaders[HttpHeaderNames.CONTENT_TYPE] = tika.detect(file) + httpHeaders[HttpHeaderNames.CONTENT_LENGTH] = response.content().readableBytes() + httpHeaders[HttpHeaderNames.ACCESS_CONTROL_ALLOW_ORIGIN] = "*" + return response +} + +/** + * Creates an HTTP response for the given input stream. + * + * @param stream The input stream to be included in the response. + * @return A FullHttpResponse object. + */ +fun httpFileStream(stream: InputStream): FullHttpResponse { + val bytes = stream.readBytes() + + val response = DefaultFullHttpResponse( + HttpVersion.HTTP_1_1, + HttpResponseStatus.OK, + Unpooled.wrappedBuffer(bytes) + ) + + val httpHeaders = response.headers() + httpHeaders[HttpHeaderNames.CONTENT_TYPE] = tika.detect(bytes) + httpHeaders[HttpHeaderNames.CONTENT_LENGTH] = response.content().readableBytes() + httpHeaders[HttpHeaderNames.ACCESS_CONTROL_ALLOW_ORIGIN] = "*" + + return response +} \ No newline at end of file diff --git a/src/main/kotlin/net/ccbluex/netty/http/websocket/WebSocketController.kt b/src/main/kotlin/net/ccbluex/netty/http/websocket/WebSocketController.kt new file mode 100644 index 0000000..c6fd6a0 --- /dev/null +++ b/src/main/kotlin/net/ccbluex/netty/http/websocket/WebSocketController.kt @@ -0,0 +1,61 @@ +/* + * This file is part of Netty-Rest (https://github.com/CCBlueX/netty-rest) + * + * Copyright (c) 2024 CCBlueX + * + * LiquidBounce 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. + * + * Netty-Rest 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 Netty-Rest. If not, see . + * + */ +package net.ccbluex.netty.http.websocket + +import io.netty.channel.ChannelHandlerContext +import io.netty.handler.codec.http.websocketx.WebSocketFrame + +/** + * Controller for handling websocket connections. + */ +class WebSocketController { + + /** + * Keeps track of all connected websocket connections to the server. + * This is used to broadcast messages to all connected clients. + */ + val activeContexts = mutableListOf() + + /** + * Broadcasts a message to all connected clients. + * + * @param message The message to broadcast. + * @param failure The action to take if a failure occurs. + */ + fun broadcast(message: WebSocketFrame, failure: (ChannelHandlerContext, Throwable) -> Unit = { _, _ -> }) { + activeContexts.forEach { + try { + it.writeAndFlush(message) + } catch (e: Throwable) { + failure(it, e) + } + } + } + + /** + * Closes all active contexts. + */ + fun closeAll() { + activeContexts.forEach { + it.close() + } + } + +} \ No newline at end of file diff --git a/src/main/kotlin/net/ccbluex/netty/http/websocket/WebSocketHandler.kt b/src/main/kotlin/net/ccbluex/netty/http/websocket/WebSocketHandler.kt new file mode 100644 index 0000000..e165abf --- /dev/null +++ b/src/main/kotlin/net/ccbluex/netty/http/websocket/WebSocketHandler.kt @@ -0,0 +1,62 @@ +/* + * This file is part of Netty-Rest (https://github.com/CCBlueX/netty-rest) + * + * Copyright (c) 2024 CCBlueX + * + * LiquidBounce 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. + * + * Netty-Rest 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 Netty-Rest. If not, see . + * + */ +package net.ccbluex.netty.http.websocket + +import io.netty.channel.ChannelHandlerContext +import io.netty.channel.ChannelInboundHandlerAdapter +import io.netty.handler.codec.http.websocketx.* +import net.ccbluex.netty.http.HttpServer +import net.ccbluex.netty.http.HttpServer.Companion.logger + +/** + * Handles WebSocket frames for the http server. + * + * @property server The instance of the http server. + * @see [https://tools.ietf.org/html/rfc6455] + */ +internal class WebSocketHandler(private val server: HttpServer) : ChannelInboundHandlerAdapter() { + + /** + * Reads the incoming messages and processes WebSocket frames. + * + * @param ctx The context of the channel handler. + * @param msg The incoming message. + */ + override fun channelRead(ctx: ChannelHandlerContext, msg: Any) { + if (msg is WebSocketFrame) { + logger.debug("WebSocketFrame received ({}): {}", ctx.channel(), msg.javaClass.name) + + when (msg) { + is TextWebSocketFrame -> ctx.channel().writeAndFlush(TextWebSocketFrame(msg.text())) + is PingWebSocketFrame -> ctx.channel().writeAndFlush(PongWebSocketFrame(msg.content().retain())) + is CloseWebSocketFrame -> { + // Accept close frame and send close frame back + ctx.channel().writeAndFlush(msg.retainedDuplicate()) + ctx.channel().close().sync() + + server.webSocketController.activeContexts -= ctx + logger.debug("WebSocket closed due to ${msg.reasonText()} (${msg.statusCode()})") + } + else -> logger.error("Unknown WebSocketFrame type: ${msg.javaClass.name}") + } + } + } + +} \ No newline at end of file diff --git a/src/test/kotlin/HttpResponseUtilTest.kt b/src/test/kotlin/HttpResponseUtilTest.kt new file mode 100644 index 0000000..2f08b2a --- /dev/null +++ b/src/test/kotlin/HttpResponseUtilTest.kt @@ -0,0 +1,86 @@ +import io.netty.handler.codec.http.* +import com.google.gson.JsonObject +import net.ccbluex.netty.http.util.* +import org.junit.jupiter.api.Assertions.* +import org.junit.jupiter.api.Test +import java.io.File + +class HttpResponseUtilTest { + + @Test + fun httpResponse_createsResponseWithCorrectStatusAndContent() { + val response = httpResponse(HttpResponseStatus.OK, "text/plain", "Hello, World!") + assertEquals(HttpResponseStatus.OK, response.status()) + assertEquals("text/plain", response.headers()[HttpHeaderNames.CONTENT_TYPE]) + assertEquals("Hello, World!", response.content().toString(Charsets.UTF_8)) + } + + @Test + fun httpResponse_createsJsonResponse() { + val json = JsonObject().apply { addProperty("key", "value") } + val response = httpResponse(HttpResponseStatus.OK, json) + assertEquals(HttpResponseStatus.OK, response.status()) + assertEquals("application/json", response.headers()[HttpHeaderNames.CONTENT_TYPE]) + assertEquals("{\"key\":\"value\"}", response.content().toString(Charsets.UTF_8)) + } + + @Test + fun httpOk_creates200Response() { + val json = JsonObject().apply { addProperty("key", "value") } + val response = httpOk(json) + assertEquals(HttpResponseStatus.OK, response.status()) + assertEquals("application/json", response.headers()[HttpHeaderNames.CONTENT_TYPE]) + assertEquals("{\"key\":\"value\"}", response.content().toString(Charsets.UTF_8)) + } + + @Test + fun httpNotFound_creates404Response() { + val response = httpNotFound("/path", "Not Found") + assertEquals(HttpResponseStatus.NOT_FOUND, response.status()) + assertEquals("application/json", response.headers()[HttpHeaderNames.CONTENT_TYPE]) + assertEquals("{\"path\":\"/path\",\"reason\":\"Not Found\"}", response.content().toString(Charsets.UTF_8)) + } + + @Test + fun httpInternalServerError_creates500Response() { + val response = httpInternalServerError("Exception occurred") + assertEquals(HttpResponseStatus.INTERNAL_SERVER_ERROR, response.status()) + assertEquals("application/json", response.headers()[HttpHeaderNames.CONTENT_TYPE]) + assertEquals("{\"reason\":\"Exception occurred\"}", response.content().toString(Charsets.UTF_8)) + } + + @Test + fun httpForbidden_creates403Response() { + val response = httpForbidden("Forbidden") + assertEquals(HttpResponseStatus.FORBIDDEN, response.status()) + assertEquals("application/json", response.headers()[HttpHeaderNames.CONTENT_TYPE]) + assertEquals("{\"reason\":\"Forbidden\"}", response.content().toString(Charsets.UTF_8)) + } + + @Test + fun httpBadRequest_creates400Response() { + val response = httpBadRequest("Bad Request") + assertEquals(HttpResponseStatus.BAD_REQUEST, response.status()) + assertEquals("application/json", response.headers()[HttpHeaderNames.CONTENT_TYPE]) + assertEquals("{\"reason\":\"Bad Request\"}", response.content().toString(Charsets.UTF_8)) + } + + @Test + fun httpFile_createsResponseWithFileContent() { + val file = File("test.txt").apply { writeText("File content") } + val response = httpFile(file) + assertEquals(HttpResponseStatus.OK, response.status()) + assertEquals("text/plain", response.headers()[HttpHeaderNames.CONTENT_TYPE]) + assertEquals("File content", response.content().toString(Charsets.UTF_8)) + file.delete() + } + + @Test + fun httpFileStream_createsResponseWithStreamContent() { + val stream = "Stream content".byteInputStream() + val response = httpFileStream(stream) + assertEquals(HttpResponseStatus.OK, response.status()) + assertEquals("text/plain", response.headers()[HttpHeaderNames.CONTENT_TYPE]) + assertEquals("Stream content", response.content().toString(Charsets.UTF_8)) + } +} \ No newline at end of file diff --git a/src/test/kotlin/HttpServerTest.kt b/src/test/kotlin/HttpServerTest.kt new file mode 100644 index 0000000..af75203 --- /dev/null +++ b/src/test/kotlin/HttpServerTest.kt @@ -0,0 +1,41 @@ +import io.netty.channel.ChannelHandlerContext +import io.netty.handler.codec.http.websocketx.TextWebSocketFrame +import net.ccbluex.netty.http.HttpServer +import org.junit.jupiter.api.Test +import org.mockito.Mockito.* + +class HttpServerTest { + + @Test + fun broadcast_sendsMessageToAllActiveContexts() { + val server = HttpServer() + val ctx1 = mock(ChannelHandlerContext::class.java) + val ctx2 = mock(ChannelHandlerContext::class.java) + server.webSocketController.activeContexts.add(ctx1) + server.webSocketController.activeContexts.add(ctx2) + + val message = TextWebSocketFrame("Test message") + server.webSocketController.broadcast(message) + + verify(ctx1).writeAndFlush(message) + verify(ctx2).writeAndFlush(message) + } + + @Test + fun broadcast_handlesExceptions() { + val server = HttpServer() + val ctx1 = mock(ChannelHandlerContext::class.java) + val ctx2 = mock(ChannelHandlerContext::class.java) + server.webSocketController.activeContexts.add(ctx1) + server.webSocketController.activeContexts.add(ctx2) + + val message = TextWebSocketFrame("Test message") + doThrow(RuntimeException::class.java).`when`(ctx1).writeAndFlush(message) + + server.webSocketController.broadcast(message) + + verify(ctx1).writeAndFlush(message) + verify(ctx2).writeAndFlush(message) + } + +} \ No newline at end of file