diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..1c80ba6 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,11 @@ +# LF ling endings on repository and locally +* text eol=lf +*.java text eol=lf + +# Binary files that should not be modified +*.dat binary +*.db binary +*.jpg binary +*.png binary +*.ttf binary +*.wav binary diff --git a/.gitignore b/.gitignore index 9a87cbc..3d89a3a 100644 --- a/.gitignore +++ b/.gitignore @@ -39,26 +39,29 @@ ehthumbs.db Icon? Thumbs.db +# Build files # +################# +MANIFEST.MF +dependency-reduced-pom.xml + # Project files # ################# .classpath .externalToolBuilders +.idea .project .settings -MANIFEST.MF - -# Netbeans files # -################## build dist nbproject +atlassian-ide-plugin.xml build.xml nb-configuration.xml - -# IntelliJ IDEA files # -####################### -.idea *.iml *.ipr *.iws -/config.yml + +# Misc files # +############## +*.bak +config.yml diff --git a/HEADER.txt b/HEADER.txt new file mode 100644 index 0000000..cd7403e --- /dev/null +++ b/HEADER.txt @@ -0,0 +1,17 @@ +This file is part of ${name}. + +${copyright} <${url}/> +${name} is licensed under the GNU Affero General Public License. + +${name} is free software: you can redistribute it and/or modify +it under the terms of the GNU Affero General Public License as +published by the Free Software Foundation, either version 3 of the +License, or (at your option) any later version. + +${name} 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 Affero General Public License for more details. + +You should have received a copy of the GNU Affero General Public License +along with this program. If not, see . \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..dba13ed --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/pom.xml b/pom.xml index e9e798b..4a5aacd 100644 --- a/pom.xml +++ b/pom.xml @@ -1,44 +1,113 @@ 4.0.0 + + + Aquaduct org.spout - flo + aquaduct 0.0.1-SNAPSHOT - Flo - A Control Panel for Spout Servers - - - - maven-compiler-plugin - 2.3.2 - - 1.6 - 1.6 - - - - + http://www.spout.org + 2012 + Web control panel for the Spout voxel game platform. + + + + UTF-8 + 2013 + dev-SNAPSHOT + 0.0.1-SNAPSHOT + custom + + + + + Spout LLC + http://www.spout.org + + + + + + GNU Affero General Public License + http://www.gnu.org/licenses/agpl.html + repo + + + + + + scm:git:git@github.com:SpoutDev/Aquaduct.git + scm:git:git://github.com/SpoutDev/Aquaduct.git + https://github.com/SpoutDev/Aquaduct + + + + + jenkins + http://build.spout.org/job/Aquaduct + + + + + jira + http://issues.spout.org/browse/PANEL + + + + + + spout-repo + http://repo.spout.org + + true + always + + + + + + + + spout-repo + http://repo.spout.org + + + + + + + + spout-releases + http://nexus.spout.org/content/repositories/releases + + + + spout-snapshots + http://nexus.spout.org/content/repositories/snapshots + + + + + org.spout spoutapi - dev-SNAPSHOT + ${spoutVersion} + provided + com.narrowtux blueberry - 0.0.1-SNAPSHOT - - - org.yaml - snakeyaml - 1.10 + ${blueberryVersion} compile commons-io commons-io - 2.3 + 2.4 compile @@ -51,6 +120,145 @@ com.google.code.gson gson 2.2.2 + compile + + + org.yaml + snakeyaml + 1.11 + compile - \ No newline at end of file + + + + clean install + + + + + + false + ${project.basedir} + . + + LICENSE.txt + + + + + true + ${project.basedir}/src/main/resources + . + + **/*.html + + + + + + + + + com.mycila.maven-license-plugin + maven-license-plugin + 1.10.b1 + + + + + ${project.name} + ${project.organization.url} + Copyright (c) ${project.inceptionYear}-${currentYear}, ${project.organization.name} + + true + UTF-8 + true +
${project.basedir}/HEADER.txt
+ + SLASHSTAR_STYLE + + + ${project.name} + license + + + src/main/java/** + src/test/java/** + + + clean + + format + + + + + + + com.sourcesense.maven + maven-nosnapshot-plugin + 0.0.7 + + + + ${project.version} + releaseVersion + + initialize + + strip + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + 3.0 + + 1.6 + 1.6 + + -Xlint:all + -Xlint:-path + + true + true + + + + + + + + + + org.eclipse.m2e + lifecycle-mapping + 1.0.0 + + + + + + com.sourcesense.maven + maven-nosnapshot-plugin + [0.0.7,) + + strip + + + + + + + + + + + + + + diff --git a/src/main/java/org/spout/aquaduct/Aquaduct.java b/src/main/java/org/spout/aquaduct/Aquaduct.java new file mode 100644 index 0000000..e2c3eea --- /dev/null +++ b/src/main/java/org/spout/aquaduct/Aquaduct.java @@ -0,0 +1,74 @@ +/* + * This file is part of Aquaduct. + * + * Copyright (c) 2012-2013, Spout LLC + * Aquaduct is licensed under the GNU Affero General Public License. + * + * Aquaduct is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * Aquaduct 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.spout.aquaduct; + +import java.util.LinkedList; +import java.util.List; + +import org.spout.api.exception.ConfigurationException; + +import org.spout.aquaduct.server.Server; +import org.spout.aquaduct.web.AquaductWebServer; + +public class Aquaduct { + private static Aquaduct instance = null; + private AquaductConfiguration configuration; + + public static Aquaduct instance() { + return instance; + } + + private AquaductWebServer webServer; + private List servers = new LinkedList(); + + Aquaduct () { + instance = this; + configuration = new AquaductConfiguration(); + try { + configuration.load(); + } catch (ConfigurationException e) { + e.printStackTrace(); + } + webServer = new AquaductWebServer(); + + Runtime.getRuntime().addShutdownHook(new Thread() { + @Override + public void run() { + Aquaduct.instance().stop(); + } + }); + } + + public void stop() { + webServer.stop(); + } + + public List getServers() { + return servers; + } + + public AquaductWebServer getWebServer() { + return webServer; + } + + public AquaductConfiguration getConfiguration() { + return configuration; + } +} diff --git a/src/main/java/org/spout/aquaduct/AquaductConfiguration.java b/src/main/java/org/spout/aquaduct/AquaductConfiguration.java new file mode 100644 index 0000000..d148ecd --- /dev/null +++ b/src/main/java/org/spout/aquaduct/AquaductConfiguration.java @@ -0,0 +1,43 @@ +/* + * This file is part of Aquaduct. + * + * Copyright (c) 2012-2013, Spout LLC + * Aquaduct is licensed under the GNU Affero General Public License. + * + * Aquaduct is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * Aquaduct 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.spout.aquaduct; + +import java.io.File; + +import org.spout.api.exception.ConfigurationException; +import org.spout.api.util.config.ConfigurationHolder; +import org.spout.api.util.config.ConfigurationHolderConfiguration; +import org.spout.api.util.config.yaml.YamlConfiguration; + +public class AquaductConfiguration extends ConfigurationHolderConfiguration { + public static ConfigurationHolder BIND_ADDRESS = new ConfigurationHolder((Object) null, "bind.address"); + public static ConfigurationHolder BIND_PORT = new ConfigurationHolder(80, "bind.port"); + public static ConfigurationHolder BASE_SERVER_FOLDER = new ConfigurationHolder("servers/", "servers.basefolder"); + + public AquaductConfiguration() { + super(new YamlConfiguration(new File("config.yml"))); + } + + @Override + public void load() throws ConfigurationException { + super.load(); + super.save(); + } +} diff --git a/src/main/java/org/spout/aquaduct/Start.java b/src/main/java/org/spout/aquaduct/Start.java new file mode 100644 index 0000000..88d715e --- /dev/null +++ b/src/main/java/org/spout/aquaduct/Start.java @@ -0,0 +1,27 @@ +/* + * This file is part of Aquaduct. + * + * Copyright (c) 2012-2013, Spout LLC + * Aquaduct is licensed under the GNU Affero General Public License. + * + * Aquaduct is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * Aquaduct 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.spout.aquaduct; + +public class Start { + public static void main(String args[]) { + @SuppressWarnings("unused") + Aquaduct aquaduct = new Aquaduct(); + } +} diff --git a/src/main/java/org/spout/aquaduct/server/Plugin.java b/src/main/java/org/spout/aquaduct/server/Plugin.java new file mode 100644 index 0000000..89a8e99 --- /dev/null +++ b/src/main/java/org/spout/aquaduct/server/Plugin.java @@ -0,0 +1,24 @@ +/* + * This file is part of Aquaduct. + * + * Copyright (c) 2012-2013, Spout LLC + * Aquaduct is licensed under the GNU Affero General Public License. + * + * Aquaduct is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * Aquaduct 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.spout.aquaduct.server; + +public class Plugin { + boolean enabled = false; +} diff --git a/src/main/java/org/spout/aquaduct/server/PluginException.java b/src/main/java/org/spout/aquaduct/server/PluginException.java new file mode 100644 index 0000000..19565e8 --- /dev/null +++ b/src/main/java/org/spout/aquaduct/server/PluginException.java @@ -0,0 +1,28 @@ +/* + * This file is part of Aquaduct. + * + * Copyright (c) 2012-2013, Spout LLC + * Aquaduct is licensed under the GNU Affero General Public License. + * + * Aquaduct is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * Aquaduct 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.spout.aquaduct.server; + +public class PluginException extends Exception { + private static final long serialVersionUID = -5864237892530538787L; + + public PluginException(String message) { + super(message); + } +} diff --git a/src/main/java/org/spout/flo/server/PluginManager.java b/src/main/java/org/spout/aquaduct/server/PluginManager.java similarity index 58% rename from src/main/java/org/spout/flo/server/PluginManager.java rename to src/main/java/org/spout/aquaduct/server/PluginManager.java index 7078e20..a0eb3b2 100644 --- a/src/main/java/org/spout/flo/server/PluginManager.java +++ b/src/main/java/org/spout/aquaduct/server/PluginManager.java @@ -1,14 +1,33 @@ -package org.spout.flo.server; +/* + * This file is part of Aquaduct. + * + * Copyright (c) 2012-2013, Spout LLC + * Aquaduct is licensed under the GNU Affero General Public License. + * + * Aquaduct is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * Aquaduct 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.spout.aquaduct.server; import java.util.List; public abstract class PluginManager { private Server parent; - + protected PluginManager(Server parent) { this.parent = parent; } - + /** * Gets the server this plugin manager works on * @return the server of this plugin manager @@ -16,7 +35,7 @@ protected PluginManager(Server parent) { public Server getServer() { return parent; } - + /** * Enables or disables the given plugin * @param plugin the plugin to enable/disable @@ -24,21 +43,21 @@ public Server getServer() { * @throws PluginException when an error occurs */ public abstract void setPluginEnabled(Plugin plugin, boolean enabled) throws PluginException; - + /** * Installs a plugin on the server * @param toInstall the plugin to install * @throws PluginException when an error occurs */ public abstract void installPlugin(Plugin toInstall) throws PluginException; - + /** * Removes a plugin from the server * @param toRemove the plugin to remove * @throws PluginException when an error occurs */ public abstract void removePlugin(Plugin toRemove) throws PluginException; - + /** * Gets a list of all installed plugins, wether they are enabled or not * @return a list of all installed plugins diff --git a/src/main/java/org/spout/flo/server/Server.java b/src/main/java/org/spout/aquaduct/server/Server.java similarity index 53% rename from src/main/java/org/spout/flo/server/Server.java rename to src/main/java/org/spout/aquaduct/server/Server.java index e49a736..0ff4d51 100644 --- a/src/main/java/org/spout/flo/server/Server.java +++ b/src/main/java/org/spout/aquaduct/server/Server.java @@ -1,4 +1,23 @@ -package org.spout.flo.server; +/* + * This file is part of Aquaduct. + * + * Copyright (c) 2012-2013, Spout LLC + * Aquaduct is licensed under the GNU Affero General Public License. + * + * Aquaduct is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * Aquaduct 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.spout.aquaduct.server; import org.spout.api.signal.Signal; import org.spout.api.signal.SignalSubscriberObject; @@ -6,44 +25,42 @@ public abstract class Server extends SignalSubscriberObject { /** * Emitted when the servers status changes. - * @sarg org.spout.flo.server.ServerStatus the new status of the server + * @sarg org.spout.aquaduct.server.ServerStatus the new status of the server */ public static final Signal SIGNAL_STATUS_CHANGE = new Signal("STATUS_CHANGE", ServerStatus.class); - + /** * Emitted when the servers console printed a new message * @sarg java.lang.String the message */ public static final Signal SIGNAL_CONSOLE_MESSAGE = new Signal("CONSOLE_MESSAGE", String.class); - + /** * Emitted when an error occurs that should be sent to watching web frontends * @sarg java.lang.String the message */ public static final Signal SIGNAL_ERROR = new Signal("ERROR", String.class); - + private String name; - + public Server() { registerSignal(SIGNAL_CONSOLE_MESSAGE); registerSignal(SIGNAL_STATUS_CHANGE); } - + public String getName() { return name; } - + public String getVersion() { return "0"; } - + public abstract PluginManager getPluginManager(); - + public abstract ServerStatus getStatus(); - + public abstract void start(); - + public abstract void stop(); - - } diff --git a/src/main/java/org/spout/aquaduct/server/ServerStatus.java b/src/main/java/org/spout/aquaduct/server/ServerStatus.java new file mode 100644 index 0000000..518054d --- /dev/null +++ b/src/main/java/org/spout/aquaduct/server/ServerStatus.java @@ -0,0 +1,60 @@ +/* + * This file is part of Aquaduct. + * + * Copyright (c) 2012-2013, Spout LLC + * Aquaduct is licensed under the GNU Affero General Public License. + * + * Aquaduct is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * Aquaduct 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.spout.aquaduct.server; + +/** + * Represents the current status of a server + */ +public enum ServerStatus { + /** + * When the server is completely shut down + */ + STOPPED(false), + /** + * When the server is starting up, but not ready for players yet + */ + STARTING(true), + /** + * When the server is running and ready for players + */ + STARTED(true), + /** + * When the server is currently shutting down + */ + STOPPING(true), + /** + * When the server or the JVM have crashed + */ + CRASHED(false), + /** + * When the server doesn't react to status polls + */ + UNRESPONSIVE(true), ; + + private final boolean isRunning; + + private ServerStatus(boolean running) { + this.isRunning = running; + } + + public boolean isRunning() { + return isRunning; + } +} diff --git a/src/main/java/org/spout/aquaduct/server/SpoutPluginManager.java b/src/main/java/org/spout/aquaduct/server/SpoutPluginManager.java new file mode 100644 index 0000000..93fe6e5 --- /dev/null +++ b/src/main/java/org/spout/aquaduct/server/SpoutPluginManager.java @@ -0,0 +1,50 @@ +/* + * This file is part of Aquaduct. + * + * Copyright (c) 2012-2013, Spout LLC + * Aquaduct is licensed under the GNU Affero General Public License. + * + * Aquaduct is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * Aquaduct 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.spout.aquaduct.server; + +import java.util.List; + +public class SpoutPluginManager extends PluginManager { + public SpoutPluginManager(Server parent) { + super(parent); + // TODO Auto-generated constructor stub + } + + @Override + public void setPluginEnabled(Plugin plugin, boolean enabled) throws PluginException { + // TODO Auto-generated method stub + } + + @Override + public void installPlugin(Plugin toInstall) throws PluginException { + // TODO Auto-generated method stub + } + + @Override + public void removePlugin(Plugin toRemove) throws PluginException { + // TODO Auto-generated method stub + } + + @Override + public List getInstalledPlugins() { + // TODO Auto-generated method stub + return null; + } +} diff --git a/src/main/java/org/spout/aquaduct/server/SpoutServer.java b/src/main/java/org/spout/aquaduct/server/SpoutServer.java new file mode 100644 index 0000000..f63b72c --- /dev/null +++ b/src/main/java/org/spout/aquaduct/server/SpoutServer.java @@ -0,0 +1,49 @@ +/* + * This file is part of Aquaduct. + * + * Copyright (c) 2012-2013, Spout LLC + * Aquaduct is licensed under the GNU Affero General Public License. + * + * Aquaduct is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * Aquaduct 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.spout.aquaduct.server; + +public class SpoutServer extends Server { + SpoutPluginManager pluginManager; + ServerStatus status = ServerStatus.STOPPED; + + @Override + public PluginManager getPluginManager() { + return pluginManager; + } + + @Override + public ServerStatus getStatus() { + return status; + } + + @Override + public void start() { + if (!getStatus().isRunning()) { // Only start the server if not already started + emit(SIGNAL_STATUS_CHANGE, ServerStatus.STARTING); + } + } + + @Override + public void stop() { + if (getStatus().isRunning()) { // Only stop the server if not already stopped + emit(SIGNAL_STATUS_CHANGE, ServerStatus.STOPPING); + } + } +} diff --git a/src/main/java/org/spout/aquaduct/web/AquaductWebServer.java b/src/main/java/org/spout/aquaduct/web/AquaductWebServer.java new file mode 100644 index 0000000..c3ce3f4 --- /dev/null +++ b/src/main/java/org/spout/aquaduct/web/AquaductWebServer.java @@ -0,0 +1,56 @@ +/* + * This file is part of Aquaduct. + * + * Copyright (c) 2012-2013, Spout LLC + * Aquaduct is licensed under the GNU Affero General Public License. + * + * Aquaduct is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * Aquaduct 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.spout.aquaduct.web; + +import java.net.InetAddress; +import java.net.UnknownHostException; + +import com.narrowtux.blueberry.Address; +import com.narrowtux.blueberry.BlueberryWebServer; + +import org.spout.aquaduct.AquaductConfiguration; + +public class AquaductWebServer { + BlueberryWebServer server; + AquaductWebSocketHandler webSocketHandler; + + public AquaductWebServer() { + server = new BlueberryWebServer(); + try { + server.bind(new Address(InetAddress.getByName(AquaductConfiguration.BIND_ADDRESS.getString(null)), AquaductConfiguration.BIND_PORT.getInt(5000))); + } catch (UnknownHostException e) { + e.printStackTrace(); + return; + } + server.setApplicationName("Aquaduct"); + server.getHandlers().add(new ResourceFileHandler()); + webSocketHandler = new AquaductWebSocketHandler(); + server.getHandlers().add(webSocketHandler); + server.start(); + } + + public AquaductWebSocketHandler getWebSocketHandler() { + return webSocketHandler; + } + + public void stop() { + server.stop(); + } +} diff --git a/src/main/java/org/spout/flo/web/FloWebSocketHandler.java b/src/main/java/org/spout/aquaduct/web/AquaductWebSocketHandler.java similarity index 75% rename from src/main/java/org/spout/flo/web/FloWebSocketHandler.java rename to src/main/java/org/spout/aquaduct/web/AquaductWebSocketHandler.java index c8f04d2..ba6dfcc 100644 --- a/src/main/java/org/spout/flo/web/FloWebSocketHandler.java +++ b/src/main/java/org/spout/aquaduct/web/AquaductWebSocketHandler.java @@ -1,4 +1,23 @@ -package org.spout.flo.web; +/* + * This file is part of Aquaduct. + * + * Copyright (c) 2012-2013, Spout LLC + * Aquaduct is licensed under the GNU Affero General Public License. + * + * Aquaduct is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * Aquaduct 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.spout.aquaduct.web; import java.io.IOException; import java.util.HashMap; @@ -11,25 +30,25 @@ import com.google.gson.JsonElement; import com.google.gson.JsonObject; import com.google.gson.JsonPrimitive; + import com.narrowtux.blueberry.websockets.Frame; import com.narrowtux.blueberry.websockets.TextFrame; import com.narrowtux.blueberry.websockets.WebSocketExchange; import com.narrowtux.blueberry.websockets.WebSocketRequestHandler; -public class FloWebSocketHandler extends WebSocketRequestHandler { +public class AquaductWebSocketHandler extends WebSocketRequestHandler { private HashSet connectedClients = new HashSet(); private static final Gson GSON = new Gson(); private HashMap requestHandlers = new HashMap(); - + private int countup = 1; private Timer timer = new Timer(); - - public FloWebSocketHandler() { + + public AquaductWebSocketHandler() { super(); setFilter("/websocket/"); - + timer.schedule(new TimerTask() { - @Override public void run() { countup ++; @@ -38,12 +57,12 @@ public void run() { } }, 100, 1000); } - + public void sendEvent(WebClientFrame event) { String data = GSON.toJson(event); sendToClients(new TextFrame(data)); } - + private void sendToClients(Frame frame) { for (WebSocketExchange ex:connectedClients) { try { @@ -53,14 +72,14 @@ private void sendToClients(Frame frame) { } } } - + @Override public void onConnect(WebSocketExchange exchange) throws IOException { sendToClients(new TextFrame("Client with ip "+ exchange.getHttpExchange().getRequestingAddress().toString()+" connected!")); connectedClients.add(exchange); System.out.println("Client connected!"); } - + @Override public void onFrameReceived(WebSocketExchange exchange, Frame frame) throws IOException { if (frame instanceof TextFrame) { @@ -69,7 +88,7 @@ public void onFrameReceived(WebSocketExchange exchange, Frame frame) throws IOEx String requestType = element.get("requestType").getAsString(); JsonElement data = element.get("data"); int requestId = element.get("requestId").getAsInt(); - + WebClientRequestHandler handler = requestHandlers.get(requestType); WebClientResponse response; if (handler == null) { @@ -80,18 +99,18 @@ public void onFrameReceived(WebSocketExchange exchange, Frame frame) throws IOEx Object replyData = handler.getResponse(requestType, data); response = new WebClientResponse(requestId, replyData); } - + exchange.sendFrame(new TextFrame(GSON.toJson(response))); } } - + @Override public void onClose(WebSocketExchange exchange) throws IOException { connectedClients.remove(exchange); sendToClients(new TextFrame("Client with ip "+ exchange.getHttpExchange().getRequestingAddress().toString()+" disconnected!")); System.out.println("Client disconnected!"); } - + public void registerWebRequestHandler(String requestType, WebClientRequestHandler handler) { requestHandlers.put(requestType, handler); } diff --git a/src/main/java/org/spout/flo/web/ResourceFileHandler.java b/src/main/java/org/spout/aquaduct/web/ResourceFileHandler.java similarity index 65% rename from src/main/java/org/spout/flo/web/ResourceFileHandler.java rename to src/main/java/org/spout/aquaduct/web/ResourceFileHandler.java index 760e7e7..24c46d8 100644 --- a/src/main/java/org/spout/flo/web/ResourceFileHandler.java +++ b/src/main/java/org/spout/aquaduct/web/ResourceFileHandler.java @@ -1,10 +1,28 @@ -package org.spout.flo.web; +/* + * This file is part of Aquaduct. + * + * Copyright (c) 2012-2013, Spout LLC + * Aquaduct is licensed under the GNU Affero General Public License. + * + * Aquaduct is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * Aquaduct 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.spout.aquaduct.web; import java.io.File; import java.io.FileInputStream; import java.io.IOException; import java.io.InputStream; - import javax.activation.MimetypesFileTypeMap; import org.joda.time.DateTime; @@ -16,27 +34,27 @@ public class ResourceFileHandler extends HttpRequestHandler { private static int BUFFER_SIZE = 512; - private static String BASE_PATH = "src/main/resources/"; //TODO configuration + private static String BASE_PATH = "src/main/resources/"; // TODO configuration private static MimetypesFileTypeMap MIMETYPES = new MimetypesFileTypeMap(); - + static { MIMETYPES.addMimeTypes("application/javascript js JS"); MIMETYPES.addMimeTypes("text/css css CSS"); MIMETYPES.addMimeTypes("image/jpeg jpg jpeg JPG JPEG"); MIMETYPES.addMimeTypes("image/png png PNG"); } - + public ResourceFileHandler() { setFilter("/static/"); } - + @Override public void handle(HttpExchange exchange) throws IOException, HttpException { String path = exchange.getRequestedUri().getPath().replaceFirst(getFilter(), ""); File file = new File(BASE_PATH, path); if (file.exists()) { DateTime modified = new DateTime(file.lastModified()); - + InputStream in = new FileInputStream(file); exchange.getResponseHeaders().setHeader("Content-Type", MIMETYPES.getContentType(file)); exchange.getResponseHeaders().setHeader("Last-Modified", modified); @@ -52,10 +70,8 @@ public void handle(HttpExchange exchange) throws IOException, HttpException { exchange.sendResponseHeaders(HttpStatusCode.HTTP_200_OK, 0); exchange.close(); in.close(); - } else { throw new HttpException(HttpStatusCode.HTTP_404_NOT_FOUND, "The file with the URL "+exchange.getRequestedUri().getPath() + " was not found on the server."); } } - } diff --git a/src/main/java/org/spout/aquaduct/web/WebClientEvent.java b/src/main/java/org/spout/aquaduct/web/WebClientEvent.java new file mode 100644 index 0000000..540d447 --- /dev/null +++ b/src/main/java/org/spout/aquaduct/web/WebClientEvent.java @@ -0,0 +1,34 @@ +/* + * This file is part of Aquaduct. + * + * Copyright (c) 2012-2013, Spout LLC + * Aquaduct is licensed under the GNU Affero General Public License. + * + * Aquaduct is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * Aquaduct 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.spout.aquaduct.web; + +public class WebClientEvent extends WebClientFrame { + private String eventType; + + public WebClientEvent(String eventType, Object data) { + super("push"); + this.eventType = eventType; + this.data = data; + } + + public String getEventType() { + return eventType; + } +} diff --git a/src/main/java/org/spout/aquaduct/web/WebClientFrame.java b/src/main/java/org/spout/aquaduct/web/WebClientFrame.java new file mode 100644 index 0000000..3882c0a --- /dev/null +++ b/src/main/java/org/spout/aquaduct/web/WebClientFrame.java @@ -0,0 +1,37 @@ +/* + * This file is part of Aquaduct. + * + * Copyright (c) 2012-2013, Spout LLC + * Aquaduct is licensed under the GNU Affero General Public License. + * + * Aquaduct is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * Aquaduct 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.spout.aquaduct.web; + +public class WebClientFrame { + private String frameType; + protected Object data; + + public WebClientFrame(String frameType) { + this.frameType = frameType; + } + + public String getFrameType() { + return frameType; + } + + public Object getData() { + return data; + } +} diff --git a/src/main/java/org/spout/aquaduct/web/WebClientRequestHandler.java b/src/main/java/org/spout/aquaduct/web/WebClientRequestHandler.java new file mode 100644 index 0000000..0a8e6b2 --- /dev/null +++ b/src/main/java/org/spout/aquaduct/web/WebClientRequestHandler.java @@ -0,0 +1,32 @@ +/* + * This file is part of Aquaduct. + * + * Copyright (c) 2012-2013, Spout LLC + * Aquaduct is licensed under the GNU Affero General Public License. + * + * Aquaduct is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * Aquaduct 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.spout.aquaduct.web; + +import com.google.gson.JsonElement; + +public interface WebClientRequestHandler { + /** + * Gets the response data for the requested data + * @param requestType the request type the request had + * @param args the arguments for the request + * @return the answer to the given request + */ + public Object getResponse(String requestType, JsonElement args); +} diff --git a/src/main/java/org/spout/aquaduct/web/WebClientResponse.java b/src/main/java/org/spout/aquaduct/web/WebClientResponse.java new file mode 100644 index 0000000..4e57750 --- /dev/null +++ b/src/main/java/org/spout/aquaduct/web/WebClientResponse.java @@ -0,0 +1,34 @@ +/* + * This file is part of Aquaduct. + * + * Copyright (c) 2012-2013, Spout LLC + * Aquaduct is licensed under the GNU Affero General Public License. + * + * Aquaduct is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * Aquaduct 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.spout.aquaduct.web; + +public class WebClientResponse extends WebClientFrame { + private int requestId; + + public WebClientResponse(int request, Object data) { + super("pull"); + this.requestId = request; + this.data = data; + } + + public int getRequest() { + return requestId; + } +} diff --git a/src/main/java/org/spout/flo/Flo.java b/src/main/java/org/spout/flo/Flo.java deleted file mode 100644 index 7168e82..0000000 --- a/src/main/java/org/spout/flo/Flo.java +++ /dev/null @@ -1,54 +0,0 @@ -package org.spout.flo; - -import java.util.LinkedList; -import java.util.List; - -import org.spout.api.exception.ConfigurationException; -import org.spout.flo.server.Server; -import org.spout.flo.web.FloWebServer; - -public class Flo { - private static Flo instance = null; - private FloConfiguration configuration; - - public static Flo instance() { - return instance; - } - - private FloWebServer webServer; - private List servers = new LinkedList(); - - Flo () { - instance = this; - configuration = new FloConfiguration(); - try { - configuration.load(); - } catch (ConfigurationException e) { - e.printStackTrace(); - } - webServer = new FloWebServer(); - - Runtime.getRuntime().addShutdownHook(new Thread() { - @Override - public void run() { - Flo.instance().stop(); - } - }); - } - - public void stop() { - webServer.stop(); - } - - public List getServers() { - return servers; - } - - public FloWebServer getWebServer() { - return webServer; - } - - public FloConfiguration getConfiguration() { - return configuration; - } -} diff --git a/src/main/java/org/spout/flo/FloConfiguration.java b/src/main/java/org/spout/flo/FloConfiguration.java deleted file mode 100644 index 0af658c..0000000 --- a/src/main/java/org/spout/flo/FloConfiguration.java +++ /dev/null @@ -1,25 +0,0 @@ -package org.spout.flo; - -import java.io.File; - -import org.spout.api.exception.ConfigurationException; -import org.spout.api.util.config.ConfigurationHolder; -import org.spout.api.util.config.ConfigurationHolderConfiguration; -import org.spout.api.util.config.yaml.YamlConfiguration; - -public class FloConfiguration extends ConfigurationHolderConfiguration { - - public static ConfigurationHolder BIND_ADDRESS = new ConfigurationHolder((Object) null, "bind.address"); - public static ConfigurationHolder BIND_PORT = new ConfigurationHolder(80, "bind.port"); - public static ConfigurationHolder BASE_SERVER_FOLDER = new ConfigurationHolder("servers/", "servers.basefolder"); - - public FloConfiguration() { - super(new YamlConfiguration(new File("config.yml"))); - } - - @Override - public void load() throws ConfigurationException { - super.load(); - super.save(); - } -} diff --git a/src/main/java/org/spout/flo/Start.java b/src/main/java/org/spout/flo/Start.java deleted file mode 100644 index ae4ac8c..0000000 --- a/src/main/java/org/spout/flo/Start.java +++ /dev/null @@ -1,8 +0,0 @@ -package org.spout.flo; - -public class Start { - public static void main(String args[]) { - @SuppressWarnings("unused") - Flo flo = new Flo(); - } -} diff --git a/src/main/java/org/spout/flo/server/Plugin.java b/src/main/java/org/spout/flo/server/Plugin.java deleted file mode 100644 index 144dc9f..0000000 --- a/src/main/java/org/spout/flo/server/Plugin.java +++ /dev/null @@ -1,6 +0,0 @@ -package org.spout.flo.server; - -public class Plugin { - - boolean enabled = false; -} diff --git a/src/main/java/org/spout/flo/server/PluginException.java b/src/main/java/org/spout/flo/server/PluginException.java deleted file mode 100644 index 8107d96..0000000 --- a/src/main/java/org/spout/flo/server/PluginException.java +++ /dev/null @@ -1,9 +0,0 @@ -package org.spout.flo.server; - -public class PluginException extends Exception { - private static final long serialVersionUID = -5864237892530538787L; - - public PluginException(String message) { - super(message); - } -} diff --git a/src/main/java/org/spout/flo/server/ServerStatus.java b/src/main/java/org/spout/flo/server/ServerStatus.java deleted file mode 100644 index f5cf838..0000000 --- a/src/main/java/org/spout/flo/server/ServerStatus.java +++ /dev/null @@ -1,41 +0,0 @@ -package org.spout.flo.server; - -/** - * Represents the current status of a server - */ -public enum ServerStatus { - /** - * When the server is completely shut down - */ - STOPPED(false), - /** - * When the server is starting up, but not ready for players yet - */ - STARTING(true), - /** - * When the server is running and ready for players - */ - STARTED(true), - /** - * When the server is currently shutting down - */ - STOPPING(true), - /** - * When the server or the JVM have crashed - */ - CRASHED(false), - /** - * When the server doesn't react to status polls - */ - UNRESPONSIVE(true), ; - - private final boolean isRunning; - - private ServerStatus(boolean running) { - this.isRunning = running; - } - - public boolean isRunning() { - return isRunning; - } -} diff --git a/src/main/java/org/spout/flo/server/SpoutPluginManager.java b/src/main/java/org/spout/flo/server/SpoutPluginManager.java deleted file mode 100644 index a0fbc2a..0000000 --- a/src/main/java/org/spout/flo/server/SpoutPluginManager.java +++ /dev/null @@ -1,36 +0,0 @@ -package org.spout.flo.server; - -import java.util.List; - -public class SpoutPluginManager extends PluginManager { - - public SpoutPluginManager(Server parent) { - super(parent); - // TODO Auto-generated constructor stub - } - - @Override - public void setPluginEnabled(Plugin plugin, boolean enabled) throws PluginException { - // TODO Auto-generated method stub - - } - - @Override - public void installPlugin(Plugin toInstall) throws PluginException { - // TODO Auto-generated method stub - - } - - @Override - public void removePlugin(Plugin toRemove) throws PluginException { - // TODO Auto-generated method stub - - } - - @Override - public List getInstalledPlugins() { - // TODO Auto-generated method stub - return null; - } - -} diff --git a/src/main/java/org/spout/flo/server/SpoutServer.java b/src/main/java/org/spout/flo/server/SpoutServer.java deleted file mode 100644 index 5e30483..0000000 --- a/src/main/java/org/spout/flo/server/SpoutServer.java +++ /dev/null @@ -1,32 +0,0 @@ -package org.spout.flo.server; - -public class SpoutServer extends Server { - SpoutPluginManager pluginManager; - ServerStatus status = ServerStatus.STOPPED; - - @Override - public PluginManager getPluginManager() { - return pluginManager; - } - - @Override - public ServerStatus getStatus() { - return status; - } - - @Override - public void start() { - if (!getStatus().isRunning()) { // Only start the server if not already started - emit(SIGNAL_STATUS_CHANGE, ServerStatus.STARTING); - - } - } - - @Override - public void stop() { - if (getStatus().isRunning()) { // Only stop the server if not already stopped - emit(SIGNAL_STATUS_CHANGE, ServerStatus.STOPPING); - - } - } -} diff --git a/src/main/java/org/spout/flo/web/FloWebServer.java b/src/main/java/org/spout/flo/web/FloWebServer.java deleted file mode 100644 index f35dd5b..0000000 --- a/src/main/java/org/spout/flo/web/FloWebServer.java +++ /dev/null @@ -1,37 +0,0 @@ -package org.spout.flo.web; - -import java.net.InetAddress; -import java.net.UnknownHostException; - -import org.spout.flo.FloConfiguration; - -import com.narrowtux.blueberry.Address; -import com.narrowtux.blueberry.BlueberryWebServer; - -public class FloWebServer { - BlueberryWebServer server; - FloWebSocketHandler webSocketHandler; - - public FloWebServer() { - server = new BlueberryWebServer(); - try { - server.bind(new Address(InetAddress.getByName(FloConfiguration.BIND_ADDRESS.getString(null)), FloConfiguration.BIND_PORT.getInt(5000))); - } catch (UnknownHostException e) { - e.printStackTrace(); - return; - } - server.setApplicationName("Flo"); - server.getHandlers().add(new ResourceFileHandler()); - webSocketHandler = new FloWebSocketHandler(); - server.getHandlers().add(webSocketHandler); - server.start(); - } - - public FloWebSocketHandler getWebSocketHandler() { - return webSocketHandler; - } - - public void stop() { - server.stop(); - } -} diff --git a/src/main/java/org/spout/flo/web/WebClientEvent.java b/src/main/java/org/spout/flo/web/WebClientEvent.java deleted file mode 100644 index dd3536a..0000000 --- a/src/main/java/org/spout/flo/web/WebClientEvent.java +++ /dev/null @@ -1,15 +0,0 @@ -package org.spout.flo.web; - -public class WebClientEvent extends WebClientFrame { - private String eventType; - - public WebClientEvent(String eventType, Object data) { - super("push"); - this.eventType = eventType; - this.data = data; - } - - public String getEventType() { - return eventType; - } -} diff --git a/src/main/java/org/spout/flo/web/WebClientFrame.java b/src/main/java/org/spout/flo/web/WebClientFrame.java deleted file mode 100644 index 67da0b8..0000000 --- a/src/main/java/org/spout/flo/web/WebClientFrame.java +++ /dev/null @@ -1,18 +0,0 @@ -package org.spout.flo.web; - -public class WebClientFrame { - private String frameType; - protected Object data; - - public WebClientFrame(String frameType) { - this.frameType = frameType; - } - - public String getFrameType() { - return frameType; - } - - public Object getData() { - return data; - } -} diff --git a/src/main/java/org/spout/flo/web/WebClientRequestHandler.java b/src/main/java/org/spout/flo/web/WebClientRequestHandler.java deleted file mode 100644 index ca65b99..0000000 --- a/src/main/java/org/spout/flo/web/WebClientRequestHandler.java +++ /dev/null @@ -1,13 +0,0 @@ -package org.spout.flo.web; - -import com.google.gson.JsonElement; - -public interface WebClientRequestHandler { - /** - * Gets the response data for the requested data - * @param requestType the request type the request had - * @param args the arguments for the request - * @return the answer to the given request - */ - public Object getResponse(String requestType, JsonElement args); -} diff --git a/src/main/java/org/spout/flo/web/WebClientResponse.java b/src/main/java/org/spout/flo/web/WebClientResponse.java deleted file mode 100644 index 66c926d..0000000 --- a/src/main/java/org/spout/flo/web/WebClientResponse.java +++ /dev/null @@ -1,15 +0,0 @@ -package org.spout.flo.web; - -public class WebClientResponse extends WebClientFrame { - private int requestId; - - public WebClientResponse(int request, Object data) { - super("pull"); - this.requestId = request; - this.data = data; - } - - public int getRequest() { - return requestId; - } -} diff --git a/src/main/resources/css/flo.css b/src/main/resources/css/style.css similarity index 98% rename from src/main/resources/css/flo.css rename to src/main/resources/css/style.css index 6e0862a..be2c445 100644 --- a/src/main/resources/css/flo.css +++ b/src/main/resources/css/style.css @@ -9,4 +9,4 @@ #server-list > tbody > tr > td > span.label { font-size: inherit; -} \ No newline at end of file +} diff --git a/src/main/resources/index.html b/src/main/resources/index.html index 9b26112..6e60450 100644 --- a/src/main/resources/index.html +++ b/src/main/resources/index.html @@ -1,9 +1,9 @@ -Flo | Dashboard +${project.name} | Dashboard - + @@ -12,7 +12,7 @@