commit 421525c41d12de9218f5c3dd64c6bec19be9c1b8 Author: Alexander01998 Date: Thu Jun 6 08:11:08 2019 +0200 Initial commit diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..81d2b697 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +# Disable LF normalization +* -text diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..f6b38a40 --- /dev/null +++ b/.gitignore @@ -0,0 +1,28 @@ +# gradle + +.gradle/ +build/ +out/ +classes/ + +# idea + +.idea/ +*.iml +*.ipr +*.iws + +# vscode + +.settings/ +.vscode/ +bin/ +.classpath +.project + +# fabric + +run/ + +# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml +hs_err_pid* diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 00000000..f288702d --- /dev/null +++ b/LICENSE.txt @@ -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/Minecraft_Client.launch b/Minecraft_Client.launch new file mode 100644 index 00000000..e7ca2f53 --- /dev/null +++ b/Minecraft_Client.launch @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/Minecraft_Server.launch b/Minecraft_Server.launch new file mode 100644 index 00000000..76277f2c --- /dev/null +++ b/Minecraft_Server.launch @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/README.md b/README.md new file mode 100644 index 00000000..b4c0dc45 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# Wurst Client MC 1.14.2 + +## Setup (Windows 10, Eclipse) + +1. Run these two commands in PowerShell: + +``` +./gradlew.bat genSources +./gradlew.bat eclipse +``` + +2. In Eclipse, go to `Import...` > `Existing Projects into Workspace` and select this project. + +## License + +This code is licensed under the GNU General Public License v3. **You can only use this code in open-source clients that you release under the same license! Using it in closed-source/proprietary clients is not allowed!** diff --git a/build.gradle b/build.gradle new file mode 100644 index 00000000..a4d3b80b --- /dev/null +++ b/build.gradle @@ -0,0 +1,80 @@ +plugins { + id 'fabric-loom' version '0.2.2-SNAPSHOT' + id 'maven-publish' +} + +sourceCompatibility = JavaVersion.VERSION_1_8 +targetCompatibility = JavaVersion.VERSION_1_8 + +archivesBaseName = project.archives_base_name +version = project.mod_version +group = project.maven_group + +minecraft { +} + +dependencies { + //to change the versions see the gradle.properties file + minecraft "com.mojang:minecraft:${project.minecraft_version}" + mappings "net.fabricmc:yarn:${project.yarn_mappings}" + modCompile "net.fabricmc:fabric-loader:${project.loader_version}" + + // Fabric API. This is technically optional, but you probably want it anyway. + modCompile "net.fabricmc.fabric-api:fabric-api:${project.fabric_version}" + + // PSA: Some older mods, compiled on Loom 0.2.1, might have outdated Maven POMs. + // You may need to force-disable transitiveness on them. +} + +processResources { + inputs.property "version", project.version + + from(sourceSets.main.resources.srcDirs) { + include "fabric.mod.json" + expand "version": project.version + } + + from(sourceSets.main.resources.srcDirs) { + exclude "fabric.mod.json" + } +} + +// ensure that the encoding is set to UTF-8, no matter what the system default is +// this fixes some edge cases with special characters not displaying correctly +// see http://yodaconditions.net/blog/fix-for-java-file-encoding-problems-with-gradle.html +tasks.withType(JavaCompile) { + options.encoding = "UTF-8" +} + +// Loom will automatically attach sourcesJar to a RemapSourcesJar task and to the "build" task +// if it is present. +// If you remove this task, sources will not be generated. +task sourcesJar(type: Jar, dependsOn: classes) { + classifier = "sources" + from sourceSets.main.allSource +} + +jar { + from "LICENSE" +} + +// configure the maven publication +publishing { + publications { + mavenJava(MavenPublication) { + // add all the jars that should be included when publishing to maven + artifact(jar) { + builtBy remapJar + } + artifact(sourcesJar) { + builtBy remapSourcesJar + } + } + } + + // select the repositories you want to publish to + repositories { + // uncomment to publish to the local maven + // mavenLocal() + } +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 00000000..94ec4cf5 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,17 @@ +# Done to increase the memory available to gradle. +org.gradle.jvmargs=-Xmx1G + +# Fabric Properties + # check these on https://fabricmc.net/use + minecraft_version=1.14.2 + yarn_mappings=1.14.2+build.2 + loader_version=0.4.8+build.154 + +# Mod Properties + mod_version = 1.0.0 + maven_group = net.wurstclient + archives_base_name = wurst + +# Dependencies + # currently not on the main fabric site, check on the maven: https://maven.fabricmc.net/net/fabricmc/fabric + fabric_version=0.3.0+build.175 diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..29953ea1 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 00000000..290541c7 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.3-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 00000000..cccdd3d5 --- /dev/null +++ b/gradlew @@ -0,0 +1,172 @@ +#!/usr/bin/env sh + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$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="" + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# 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 + ;; + 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" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=$(save "$@") + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong +if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then + cd "$(dirname "$0")" +fi + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 00000000..f9553162 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,84 @@ +@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 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= + +@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 init + +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 init + +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 + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +: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 %CMD_LINE_ARGS% + +: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/settings.gradle b/settings.gradle new file mode 100644 index 00000000..5b60df3d --- /dev/null +++ b/settings.gradle @@ -0,0 +1,10 @@ +pluginManagement { + repositories { + jcenter() + maven { + name = 'Fabric' + url = 'https://maven.fabricmc.net/' + } + gradlePluginPortal() + } +} diff --git a/src/main/java/net/fabricmc/example/mixin/ExampleMixin.java b/src/main/java/net/fabricmc/example/mixin/ExampleMixin.java new file mode 100644 index 00000000..e4d2b815 --- /dev/null +++ b/src/main/java/net/fabricmc/example/mixin/ExampleMixin.java @@ -0,0 +1,17 @@ +package net.fabricmc.example.mixin; + +import net.minecraft.client.MinecraftClient; +import org.spongepowered.asm.mixin.Mixin; +import org.spongepowered.asm.mixin.injection.At; +import org.spongepowered.asm.mixin.injection.Inject; +import org.spongepowered.asm.mixin.injection.callback.CallbackInfo; + +@Mixin(MinecraftClient.class) +public class ExampleMixin +{ + @Inject(at = @At("HEAD"), method = "init()V") + private void init(CallbackInfo info) + { + System.out.println("This line is printed by an example mod mixin!"); + } +} diff --git a/src/main/java/net/wurstclient/WurstClient.java b/src/main/java/net/wurstclient/WurstClient.java new file mode 100644 index 00000000..f47ceb6d --- /dev/null +++ b/src/main/java/net/wurstclient/WurstClient.java @@ -0,0 +1,69 @@ +/* + * Copyright (C) 2014 - 2019 | Wurst-Imperium | All rights reserved. + * + * This source code is subject to the terms of the GNU General Public + * License, version 3. If a copy of the GPL was not distributed with this + * file, You can obtain one at: https://www.gnu.org/licenses/gpl-3.0.txt + */ +package net.wurstclient; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; + +import net.minecraft.client.MinecraftClient; +import net.wurstclient.analytics.WurstAnalytics; +import net.wurstclient.event.EventManager; + +public final class WurstClient +{ + public static final String VERSION = "7.0"; + + private final Path wurstFolder; + private final WurstAnalytics analytics; + private final EventManager eventManager; + + private boolean enabled = true; + + public WurstClient() + { + wurstFolder = createWurstFolder(); + + analytics = new WurstAnalytics("UA-52838431-5", + "client.wurstclient.net", wurstFolder.resolve("analytics.json")); + + eventManager = new EventManager(this); + + analytics.trackPageView("/mc1.14.2/v" + VERSION, + "Wurst " + VERSION + " MC1.14.2"); + } + + private Path createWurstFolder() + { + MinecraftClient mc = MinecraftClient.getInstance(); + Path dotMinecraftFolder = mc.runDirectory.toPath(); + Path wurstFolder = dotMinecraftFolder.resolve("wurst"); + + try + { + Files.createDirectories(wurstFolder); + + }catch(IOException e) + { + throw new RuntimeException( + "Couldn't create .minecraft/wurst folder.", e); + } + + return wurstFolder; + } + + public boolean isEnabled() + { + return enabled; + } + + public void setEnabled(boolean enabled) + { + this.enabled = enabled; + } +} diff --git a/src/main/java/net/wurstclient/WurstInitializer.java b/src/main/java/net/wurstclient/WurstInitializer.java new file mode 100644 index 00000000..fb788b28 --- /dev/null +++ b/src/main/java/net/wurstclient/WurstInitializer.java @@ -0,0 +1,24 @@ +/* + * Copyright (C) 2014 - 2019 | Wurst-Imperium | All rights reserved. + * + * This source code is subject to the terms of the GNU General Public + * License, version 3. If a copy of the GPL was not distributed with this + * file, You can obtain one at: https://www.gnu.org/licenses/gpl-3.0.txt + */ +package net.wurstclient; + +import net.fabricmc.api.ModInitializer; + +public final class WurstInitializer implements ModInitializer +{ + @Override + public void onInitialize() + { + // This code runs as soon as Minecraft is in a mod-load-ready state. + // However, some things (like resources) may still be uninitialized. + // Proceed with mild caution. + + System.out.println("Hello Fabric world!"); + new WurstClient(); + } +} diff --git a/src/main/java/net/wurstclient/analytics/AnalyticsConfigFile.java b/src/main/java/net/wurstclient/analytics/AnalyticsConfigFile.java new file mode 100644 index 00000000..37c651c7 --- /dev/null +++ b/src/main/java/net/wurstclient/analytics/AnalyticsConfigFile.java @@ -0,0 +1,144 @@ +/* + * Copyright (C) 2014 - 2019 | Wurst-Imperium | All rights reserved. + * + * This source code is subject to the terms of the GNU General Public + * License, version 3. If a copy of the GPL was not distributed with this + * file, You can obtain one at: https://www.gnu.org/licenses/gpl-3.0.txt + */ +package net.wurstclient.analytics; + +import java.io.BufferedReader; +import java.io.BufferedWriter; +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.NoSuchFileException; +import java.nio.file.Path; + +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParseException; + +import net.wurstclient.analytics.dmurph.VisitorData; +import net.wurstclient.utils.JsonUtils; + +public final class AnalyticsConfigFile +{ + private final Path path; + + public AnalyticsConfigFile(Path path) + { + this.path = path; + } + + public void load(WurstAnalyticsTracker tracker) + { + try + { + JsonElement json = parseJson(path); + tracker.setEnabled(readEnabled(json)); + tracker.getConfigData().setVisitorData(readVisitorData(json)); + + }catch(ConfigFileException e) + { + System.out.println("Couldn't load " + path.getFileName()); + e.printStackTrace(); + + }catch(NoSuchFileException e) + { + + } + + save(tracker); + } + + private JsonElement parseJson(Path path) + throws NoSuchFileException, ConfigFileException + { + try(BufferedReader reader = Files.newBufferedReader(path)) + { + return JsonUtils.JSON_PARSER.parse(reader); + + }catch(NoSuchFileException e) + { + throw e; + + }catch(IOException | JsonParseException e) + { + throw new ConfigFileException(e); + } + } + + private boolean readEnabled(JsonElement json) throws ConfigFileException + { + try + { + return json.getAsJsonObject().get("enabled").getAsBoolean(); + + }catch(Exception e) + { + throw new ConfigFileException(e); + } + } + + private VisitorData readVisitorData(JsonElement json) + throws ConfigFileException + { + int visitorID; + long firstLaunch; + long lastLaunch; + int launches; + + try + { + JsonObject jo = json.getAsJsonObject(); + visitorID = jo.get("id").getAsInt(); + firstLaunch = jo.get("first_launch").getAsLong(); + lastLaunch = jo.get("last_launch").getAsLong(); + launches = jo.get("launches").getAsInt(); + + }catch(Exception e) + { + throw new ConfigFileException(e); + } + + return VisitorData.newSession(visitorID, firstLaunch, lastLaunch, + launches); + } + + public void save(WurstAnalyticsTracker tracker) + { + JsonObject json = createJson(tracker); + + try(BufferedWriter writer = Files.newBufferedWriter(path)) + { + JsonUtils.PRETTY_GSON.toJson(json, writer); + + }catch(IOException e) + { + System.out.println("Couldn't save " + path.getFileName()); + e.printStackTrace(); + } + } + + private JsonObject createJson(WurstAnalyticsTracker tracker) + { + JsonObject json = new JsonObject(); + json.addProperty("enabled", tracker.isEnabled()); + + VisitorData visitorData = tracker.getConfigData().getVisitorData(); + json.addProperty("id", visitorData.getVisitorId()); + json.addProperty("first_launch", visitorData.getTimestampFirst()); + json.addProperty("last_launch", visitorData.getTimestampCurrent()); + json.addProperty("launches", visitorData.getVisits()); + + return json; + } + + private static final class ConfigFileException extends Exception + { + public ConfigFileException(Throwable cause) + { + super(cause); + } + } +} diff --git a/src/main/java/net/wurstclient/analytics/WurstAnalytics.java b/src/main/java/net/wurstclient/analytics/WurstAnalytics.java new file mode 100644 index 00000000..5f8b354d --- /dev/null +++ b/src/main/java/net/wurstclient/analytics/WurstAnalytics.java @@ -0,0 +1,73 @@ +/* + * Copyright (C) 2014 - 2019 | Wurst-Imperium | All rights reserved. + * + * This source code is subject to the terms of the GNU General Public + * License, version 3. If a copy of the GPL was not distributed with this + * file, You can obtain one at: https://www.gnu.org/licenses/gpl-3.0.txt + */ +package net.wurstclient.analytics; + +import java.nio.file.Path; + +import net.wurstclient.analytics.dmurph.AnalyticsRequestData; + +public final class WurstAnalytics +{ + private final String hostname; + private final WurstAnalyticsTracker tracker; + private final AnalyticsConfigFile configFile; + + public WurstAnalytics(String trackingID, String hostname, Path configFile) + { + tracker = new WurstAnalyticsTracker(trackingID); + this.hostname = hostname; + this.configFile = new AnalyticsConfigFile(configFile); + this.configFile.load(tracker); + } + + public void setEnabled(boolean enabled) + { + tracker.setEnabled(enabled); + configFile.save(tracker); + } + + public void trackPageView(String url, String title) + { + tracker.trackPageView(url, title, hostname); + } + + public void trackPageViewFromReferrer(String url, String title, + String referrerSite, String referrerPage) + { + tracker.trackPageViewFromReferrer(url, title, hostname, referrerSite, + referrerPage); + } + + public void trackPageViewFromSearch(String url, String title, + String searchSource, String keywords) + { + tracker.trackPageViewFromSearch(url, title, hostname, searchSource, + keywords); + } + + public void trackEvent(String category, String action) + { + tracker.trackEvent(category, action); + } + + public void trackEvent(String category, String action, String label) + { + tracker.trackEvent(category, action, label); + } + + public void trackEvent(String category, String action, String label, + Integer value) + { + tracker.trackEvent(category, action, label, value); + } + + public void makeCustomRequest(AnalyticsRequestData data) + { + tracker.makeCustomRequest(data); + } +} diff --git a/src/main/java/net/wurstclient/analytics/WurstAnalyticsConfigData.java b/src/main/java/net/wurstclient/analytics/WurstAnalyticsConfigData.java new file mode 100644 index 00000000..4ccb1854 --- /dev/null +++ b/src/main/java/net/wurstclient/analytics/WurstAnalyticsConfigData.java @@ -0,0 +1,25 @@ +/* + * Copyright (C) 2014 - 2019 | Wurst-Imperium | All rights reserved. + * + * This source code is subject to the terms of the GNU General Public + * License, version 3. If a copy of the GPL was not distributed with this + * file, You can obtain one at: https://www.gnu.org/licenses/gpl-3.0.txt + */ +package net.wurstclient.analytics; + +import java.awt.Dimension; +import java.awt.Toolkit; + +import net.wurstclient.analytics.dmurph.AnalyticsConfigData; +import net.wurstclient.analytics.dmurph.VisitorData; + +public final class WurstAnalyticsConfigData extends AnalyticsConfigData +{ + public WurstAnalyticsConfigData(String argTrackingCode) + { + super(argTrackingCode, VisitorData.newVisitor()); + + Dimension screen = Toolkit.getDefaultToolkit().getScreenSize(); + setScreenResolution(screen.width + "x" + screen.height); + } +} diff --git a/src/main/java/net/wurstclient/analytics/WurstAnalyticsTracker.java b/src/main/java/net/wurstclient/analytics/WurstAnalyticsTracker.java new file mode 100644 index 00000000..0db79cdb --- /dev/null +++ b/src/main/java/net/wurstclient/analytics/WurstAnalyticsTracker.java @@ -0,0 +1,103 @@ +/* + * Copyright (C) 2014 - 2019 | Wurst-Imperium | All rights reserved. + * + * This source code is subject to the terms of the GNU General Public + * License, version 3. If a copy of the GPL was not distributed with this + * file, You can obtain one at: https://www.gnu.org/licenses/gpl-3.0.txt + */ +package net.wurstclient.analytics; + +import net.wurstclient.analytics.dmurph.AnalyticsRequestData; +import net.wurstclient.analytics.dmurph.JGoogleAnalyticsTracker; + +public final class WurstAnalyticsTracker extends JGoogleAnalyticsTracker +{ + private boolean enabled = true; + + public WurstAnalyticsTracker(String trackingID) + { + super(new WurstAnalyticsConfigData(trackingID), + GoogleAnalyticsVersion.V_4_7_2); + } + + @Override + public void trackPageView(String argPageURL, String argPageTitle, + String argHostName) + { + if(!enabled) + return; + + super.trackPageView(argPageURL, argPageTitle, argHostName); + } + + @Override + public void trackPageViewFromReferrer(String argPageURL, + String argPageTitle, String argHostName, String argReferrerSite, + String argReferrerPage) + { + if(!enabled) + return; + + super.trackPageViewFromReferrer(argPageURL, argPageTitle, argHostName, + argReferrerSite, argReferrerPage); + } + + @Override + public void trackPageViewFromSearch(String argPageURL, String argPageTitle, + String argHostName, String argSearchSource, String argSearchKeywords) + { + if(!enabled) + return; + + super.trackPageViewFromSearch(argPageURL, argPageTitle, argHostName, + argSearchSource, argSearchKeywords); + } + + @Override + public void trackEvent(String argCategory, String argAction) + { + if(!enabled) + return; + + super.trackEvent(argCategory, argAction); + } + + @Override + public void trackEvent(String argCategory, String argAction, + String argLabel) + { + if(!enabled) + return; + + super.trackEvent(argCategory, argAction, argLabel); + } + + @Override + public void trackEvent(String argCategory, String argAction, + String argLabel, Integer argValue) + { + if(!enabled) + return; + + super.trackEvent(argCategory, argAction, argLabel, argValue); + } + + @Override + public synchronized void makeCustomRequest(AnalyticsRequestData argData) + { + if(!enabled) + return; + + super.makeCustomRequest(argData); + } + + public boolean isEnabled() + { + return enabled; + } + + public void setEnabled(boolean enabled) + { + this.enabled = enabled; + } +} diff --git a/src/main/java/net/wurstclient/analytics/dmurph/AnalyticsConfigData.java b/src/main/java/net/wurstclient/analytics/dmurph/AnalyticsConfigData.java new file mode 100644 index 00000000..735cb354 --- /dev/null +++ b/src/main/java/net/wurstclient/analytics/dmurph/AnalyticsConfigData.java @@ -0,0 +1,188 @@ +/** + * Copyright (c) 2010 Daniel Murphy + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +/** + * Created at Jul 22, 2010, 11:37:36 PM + */ +package net.wurstclient.analytics.dmurph; + +/** + * Data that is client-specific, and should be common for all tracking requests. + * For convenience most of this data is populated automatically by + * {@link #populateFromSystem()}. + * + * @author Daniel Murphy + * + */ +public class AnalyticsConfigData +{ + + private final String trackingCode; + private String encoding = "UTF-8"; + private String screenResolution = null; + private String colorDepth = null; + private String userLanguage = null; + private String flashVersion = null; + private String userAgent = null; + private VisitorData visitorData; + + /** + * constructs with the tracking code using the provided visitor data. + * + * @param argTrackingCode + */ + public AnalyticsConfigData(String argTrackingCode, VisitorData visitorData) + { + if(argTrackingCode == null) + throw new RuntimeException("Tracking code cannot be null"); + trackingCode = argTrackingCode; + this.visitorData = visitorData; + } + + /** + * @return the colorDepth + */ + public String getColorDepth() + { + return colorDepth; + } + + /** + * @return the encoding + */ + public String getEncoding() + { + return encoding; + } + + /** + * @return the flashVersion + */ + public String getFlashVersion() + { + return flashVersion; + } + + /** + * @return the screenResolution + */ + public String getScreenResolution() + { + return screenResolution; + } + + /** + * @return the trackingCode + */ + public String getTrackingCode() + { + return trackingCode; + } + + /** + * @return the userLanguage + */ + public String getUserLanguage() + { + return userLanguage; + } + + /** + * @return the user agent used for the network requests + */ + public String getUserAgent() + { + return userAgent; + } + + /** + * @return the visitor data, used to track unique visitors + */ + public VisitorData getVisitorData() + { + return visitorData; + } + + public void setVisitorData(VisitorData visitorData) + { + this.visitorData = visitorData; + } + + /** + * Sets the color depth of the user. like 32 bit. + * + * @param argColorDepth + */ + public void setColorDepth(String argColorDepth) + { + colorDepth = argColorDepth; + } + + /** + * Sets the character encoding of the client. like UTF-8 + * + * @param argEncoding + * the encoding to set + */ + public void setEncoding(String argEncoding) + { + encoding = argEncoding; + } + + /** + * Sets the flash version of the client, like "9.0 r24" + * + * @param argFlashVersion + * the flashVersion to set + */ + public void setFlashVersion(String argFlashVersion) + { + flashVersion = argFlashVersion; + } + + /** + * Sets the screen resolution, like "1280x800". + * + * @param argScreenResolution + * the screenResolution to set + */ + public void setScreenResolution(String argScreenResolution) + { + screenResolution = argScreenResolution; + } + + /** + * Sets the user language, like "EN-us" + * + * @param argUserLanguage + * the userLanguage to set + */ + public void setUserLanguage(String argUserLanguage) + { + userLanguage = argUserLanguage; + } + + public void setUserAgent(String userAgent) + { + this.userAgent = userAgent; + } +} diff --git a/src/main/java/net/wurstclient/analytics/dmurph/AnalyticsRequestData.java b/src/main/java/net/wurstclient/analytics/dmurph/AnalyticsRequestData.java new file mode 100644 index 00000000..5940a23b --- /dev/null +++ b/src/main/java/net/wurstclient/analytics/dmurph/AnalyticsRequestData.java @@ -0,0 +1,274 @@ +/** + * Copyright (c) 2010 Daniel Murphy + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +/** + * Created on Jul 20, 2010, 4:53:44 AM + */ +package net.wurstclient.analytics.dmurph; + +/** + * Tracking data that is pertinent to each individual tracking + * request. + * + * @author Daniel Murphy + */ +public class AnalyticsRequestData +{ + + private String pageTitle = null; + private String hostName = null; + private String pageURL = null; + private String eventCategory = null; + private String eventAction = null; + private String eventLabel = null; + private Integer eventValue = null; + // utmcsr + // Identifies a search engine, newsletter name, or other source specified in + // the + // utm_source query parameter See the ÒMarketing Campaign TrackingÓ + // section for more information about query parameters. + // + // utmccn + // Stores the campaign name or value in the utm_campaign query parameter. + // + // utmctr + // Identifies the keywords used in an organic search or the value in the + // utm_term query parameter. + // + // utmcmd + // A campaign medium or value of utm_medium query parameter. + // + // utmcct + // Campaign content or the content of a particular ad (used for A/B testing) + // The value from utm_content query parameter. + // referal: + // utmcsr=forums.jinx.com|utmcct=/topic.asp|utmcmd=referral + // utmcsr=rolwheels.com|utmccn=(referral)|utmcmd=referral|utmcct=/rol_dhuez_wheels.php + // search: + // utmcsr=google|utmccn=(organic)|utmcmd=organic|utmctr=rol%20wheels + + // utmcsr%3D(direct)%7Cutmccn%D(direct)%7utmcmd%3D(none) + private String utmcsr = "(direct)"; + private String utmccn = "(direct)"; + private String utmctr = null; + private String utmcmd = "(none)"; + private String utmcct = null; + + public void setReferrer(String argSite, String argPage) + { + utmcmd = "referral"; + utmcct = argPage; + utmccn = "(referral)"; + utmcsr = argSite; + utmctr = null; + } + + public void setSearchReferrer(String argSearchSource, + String argSearchKeywords) + { + utmcsr = argSearchSource; + utmctr = argSearchKeywords; + utmcmd = "organic"; + utmccn = "(organic)"; + utmcct = null; + } + + /** + * @return the utmcsr + */ + public String getUtmcsr() + { + return utmcsr; + } + + /** + * @return the utmccn + */ + public String getUtmccn() + { + return utmccn; + } + + /** + * @return the utmctr + */ + public String getUtmctr() + { + return utmctr; + } + + /** + * @return the utmcmd + */ + public String getUtmcmd() + { + return utmcmd; + } + + /** + * @return the utmcct + */ + public String getUtmcct() + { + return utmcct; + } + + /** + * @return the eventAction + */ + public String getEventAction() + { + return eventAction; + } + + /** + * @return the eventCategory + */ + public String getEventCategory() + { + return eventCategory; + } + + /** + * @return the eventLabel + */ + public String getEventLabel() + { + return eventLabel; + } + + /** + * @return the eventValue + */ + public Integer getEventValue() + { + return eventValue; + } + + /** + * @return the hostName + */ + public String getHostName() + { + return hostName; + } + + /** + * @return the contentTitle + */ + public String getPageTitle() + { + return pageTitle; + } + + /** + * @return the pageURL + */ + public String getPageURL() + { + return pageURL; + } + + /** + * Sets the event action, which is required for + * tracking events. + * + * @param argEventAction + * the eventAction to set + */ + public void setEventAction(String argEventAction) + { + eventAction = argEventAction; + } + + /** + * Sets the event category, which is required for + * tracking events. + * + * @param argEventCategory + * the eventCategory to set + */ + public void setEventCategory(String argEventCategory) + { + eventCategory = argEventCategory; + } + + /** + * Sets the event label, which is optional for + * tracking events. + * + * @param argEventLabel + * the eventLabel to set + */ + public void setEventLabel(String argEventLabel) + { + eventLabel = argEventLabel; + } + + /** + * Sets the event value, which is optional for tracking + * events. + * + * @param argEventValue + * the eventValue to set + */ + public void setEventValue(Integer argEventValue) + { + eventValue = argEventValue; + } + + /** + * The host name of the page + * + * @param argHostName + * the hostName to set + */ + public void setHostName(String argHostName) + { + hostName = argHostName; + } + + /** + * Sets the page title, which will be the Content Title + * in Google Analytics + * + * @param argContentTitle + * the contentTitle to set + */ + public void setPageTitle(String argContentTitle) + { + pageTitle = argContentTitle; + } + + /** + * The page url, which is required. Traditionally + * this is of the form "/content/page.html", but you can + * put anything here (like "/com/dmurph/test.java"). + * + * @param argPageURL + * the pageURL to set + */ + public void setPageURL(String argPageURL) + { + pageURL = argPageURL; + } +} diff --git a/src/main/java/net/wurstclient/analytics/dmurph/GoogleAnalyticsV4_7_2.java b/src/main/java/net/wurstclient/analytics/dmurph/GoogleAnalyticsV4_7_2.java new file mode 100644 index 00000000..1b4964e8 --- /dev/null +++ b/src/main/java/net/wurstclient/analytics/dmurph/GoogleAnalyticsV4_7_2.java @@ -0,0 +1,222 @@ +/** + * Copyright (c) 2010 Daniel Murphy + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +/** + * Created at Jul 20, 2010, 4:39:49 AM + */ +package net.wurstclient.analytics.dmurph; + +import java.util.Random; + +/** + * http://code.google.com/apis/analytics/docs/tracking/gaTrackingTroubleshooting + * .html#gifParameters + * + * @author Daniel Murphy + * + */ +public class GoogleAnalyticsV4_7_2 implements IGoogleAnalyticsURLBuilder +{ + public static final String URL_PREFIX = + "http://www.google-analytics.com/__utm.gif"; + + private AnalyticsConfigData config; + private Random random = new Random((long)(Math.random() * Long.MAX_VALUE)); + + public GoogleAnalyticsV4_7_2(AnalyticsConfigData argConfig) + { + config = argConfig; + } + + /** + * @see net.wurstclient.analytics.dmurph.IGoogleAnalyticsURLBuilder#getGoogleAnalyticsVersion() + */ + @Override + public String getGoogleAnalyticsVersion() + { + return "4.7.2"; + } + + /** + * @see net.wurstclient.analytics.dmurph.IGoogleAnalyticsURLBuilder#buildURL(net.wurstclient.analytics.dmurph.AnalyticsRequestData) + */ + @Override + public String buildURL(AnalyticsRequestData argData) + { + StringBuilder sb = new StringBuilder(); + sb.append(URL_PREFIX); + + System.currentTimeMillis(); + + sb.append("?utmwv=" + getGoogleAnalyticsVersion()); // version + sb.append("&utmn=" + random.nextInt()); // random int so no caching + + if(argData.getHostName() != null) + sb.append("&utmhn=" + getURIString(argData.getHostName())); // hostname + + if(argData.getEventAction() != null + && argData.getEventCategory() != null) + { + sb.append("&utmt=event"); + String category = getURIString(argData.getEventCategory()); + String action = getURIString(argData.getEventAction()); + + sb.append("&utme=5(" + category + "*" + action); + + if(argData.getEventLabel() != null) + sb.append("*" + getURIString(argData.getEventLabel())); + sb.append(")"); + + if(argData.getEventValue() != null) + sb.append("(" + argData.getEventValue() + ")"); + }else if(argData.getEventAction() != null + || argData.getEventCategory() != null) + throw new IllegalArgumentException( + "Event tracking must have both a category and an action"); + + if(config.getEncoding() != null) + sb.append("&utmcs=" + getURIString(config.getEncoding())); // encoding + else + sb.append("&utmcs=-"); + if(config.getScreenResolution() != null) + sb.append("&utmsr=" + getURIString(config.getScreenResolution())); // screen + // resolution + if(config.getColorDepth() != null) + sb.append("&utmsc=" + getURIString(config.getColorDepth())); // color + // depth + if(config.getUserLanguage() != null) + sb.append("&utmul=" + getURIString(config.getUserLanguage())); // language + sb.append("&utmje=1"); // java enabled (probably) + + if(config.getFlashVersion() != null) + sb.append("&utmfl=" + getURIString(config.getFlashVersion())); // flash + // version + + if(argData.getPageTitle() != null) + sb.append("&utmdt=" + getURIString(argData.getPageTitle())); // page + // title + + sb.append("&utmhid=" + random.nextInt()); + + if(argData.getPageURL() != null) + sb.append("&utmp=" + getURIString(argData.getPageURL())); // page + // url + + sb.append("&utmac=" + config.getTrackingCode()); // tracking code + + // cookie data + // utmccn=(organic)|utmcsr=google|utmctr=snotwuh |utmcmd=organic + String utmcsr = getURIString(argData.getUtmcsr()); + String utmccn = getURIString(argData.getUtmccn()); + String utmctr = getURIString(argData.getUtmctr()); + String utmcmd = getURIString(argData.getUtmcmd()); + String utmcct = getURIString(argData.getUtmcct()); + + // yes, this did take a while to figure out + int hostnameHash = hostnameHash(argData.getHostName()); + int visitorId = config.getVisitorData().getVisitorId(); + long timestampFirst = config.getVisitorData().getTimestampFirst(); + long timestampPrevious = config.getVisitorData().getTimestampPrevious(); + long timestampCurrent = config.getVisitorData().getTimestampCurrent(); + int visits = config.getVisitorData().getVisits(); + + sb.append("&utmcc=__utma%3D" + hostnameHash + "." + visitorId + "." + + timestampFirst + "." + timestampPrevious + "." + timestampCurrent + + "." + visits + "%3B%2B__utmz%3D" + hostnameHash + "." + + timestampCurrent + ".1.1.utmcsr%3D" + utmcsr + "%7Cutmccn%3D" + + utmccn + "%7Cutmcmd%3D" + utmcmd + + (utmctr != null ? "%7Cutmctr%3D" + utmctr : "") + + (utmcct != null ? "%7Cutmcct%3D" + utmcct : "") + "%3B&gaq=1"); + return sb.toString(); + } + + /* + * page view url: + * http://www.google-analytics.com/__utm.gif + * ?utmwv=4.7.2 + * &utmn=631966530 + * &utmhn=www.dmurph.com + * &utmcs=ISO-8859-1 + * &utmsr=1280x800 + * &utmsc=24-bit + * &utmul=en-us + * &utmje=1 + * &utmfl=10.1%20r53 + * &utmdt=Hello + * &utmhid=2043994175 + * &utmr=0 + * &utmp=%2Ftest%2Ftest.php + * &utmac=UA-17109202-5 + * &utmcc=__utma%3D143101472.2118079581.1279863622.1279863622.1279863622.1% + * 3B + * % + * 2B__utmz%3D143101472.1279863622.1.1.utmcsr%3D(direct)%7Cutmccn%3D(direct) + * %7Cutmcmd%3D(none)%3B&gaq=1 + */ + + // tracking url: + /* + * http://www.google-analytics.com/__utm.gif + * ?utmwv=4.7.2 + * &utmn=480124034 + * &utmhn=www.dmurph.com + * &utmt=event + * &utme=5(Videos*Play) + * &utmcs=ISO-8859-1 + * &utmsr=1280x800 + * &utmsc=24-bit + * &utmul=en-us + * &utmje=1 + * &utmfl=10.1%20r53 + * &utmdt=Hello + * &utmhid=166062212 + * &utmr=0 + * &utmp=%2Ftest%2Ftest.php + * &utmac=UA-17109202-5 + * &utmcc=__utma%3D143101472.2118079581.1279863622.1279863622.1279863622.1% + * 3B + * % + * 2B__utmz%3D143101472.1279863622.1.1.utmcsr%3D(direct)%7Cutmccn%3D(direct) + * %7Cutmcmd%3D(none)%3B&gaq=1 + */ + + private String getURIString(String argString) + { + if(argString == null) + return null; + return URIEncoder.encodeURI(argString); + } + + private int hostnameHash(String hostname) + { + return 999; + } + + /** + * @see net.wurstclient.analytics.dmurph.IGoogleAnalyticsURLBuilder#resetSession() + */ + @Override + public void resetSession() + { + config.getVisitorData().resetSession(); + } +} diff --git a/src/main/java/net/wurstclient/analytics/dmurph/IGoogleAnalyticsURLBuilder.java b/src/main/java/net/wurstclient/analytics/dmurph/IGoogleAnalyticsURLBuilder.java new file mode 100644 index 00000000..24e0e1d1 --- /dev/null +++ b/src/main/java/net/wurstclient/analytics/dmurph/IGoogleAnalyticsURLBuilder.java @@ -0,0 +1,57 @@ +/** + * Copyright (c) 2010 Daniel Murphy + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +/** + * Created at Jul 20, 2010, 4:56:30 AM + */ +package net.wurstclient.analytics.dmurph; + +/** + * URL builder for the tracking requests. Interfaced for supporting future + * versions. + * + * @author Daniel Murphy + * + */ +public interface IGoogleAnalyticsURLBuilder +{ + + /** + * Reset the session cookie. + */ + public void resetSession(); + + /** + * Gets the version for this builder. + * + * @return + */ + public String getGoogleAnalyticsVersion(); + + /** + * Build the url request from the data. + * + * @param argData + * @return + */ + public String buildURL(AnalyticsRequestData argData); +} diff --git a/src/main/java/net/wurstclient/analytics/dmurph/JGoogleAnalyticsTracker.java b/src/main/java/net/wurstclient/analytics/dmurph/JGoogleAnalyticsTracker.java new file mode 100644 index 00000000..351c1c42 --- /dev/null +++ b/src/main/java/net/wurstclient/analytics/dmurph/JGoogleAnalyticsTracker.java @@ -0,0 +1,672 @@ +/** + * Copyright (c) 2010 Daniel Murphy, Stefan Brozinski + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +/** + * Created at Jul 20, 2010, 4:04:22 AM + */ +package net.wurstclient.analytics.dmurph; + +import java.net.HttpURLConnection; +import java.net.InetSocketAddress; +import java.net.Proxy; +import java.net.Proxy.Type; +import java.net.SocketAddress; +import java.net.URL; +import java.util.LinkedList; +import java.util.Scanner; +import java.util.logging.Level; +import java.util.logging.Logger; +import java.util.regex.MatchResult; + +/** + * Common tracking calls are implemented as methods, but if you want to control + * what data to send, then use {@link #makeCustomRequest(AnalyticsRequestData)}. + * If you are making custom calls, the only requirements are: + *
    + *
  • If you are tracking an event, + * {@link AnalyticsRequestData#setEventCategory(String)} and + * {@link AnalyticsRequestData#setEventAction(String)} must both be + * populated.
    • + *
  • If you are not tracking an event, + * {@link AnalyticsRequestData#setPageURL(String)} must be populated
    • + *
+ * See the + * Google Troubleshooting Guide for more info on the tracking parameters + * (although it doesn't seem to be fully updated). + *

+ * The tracker can operate in three modes: + *

    + *
  • synchronous mode: The HTTP request is sent to GA immediately, before the + * track method returns. This may slow your application down if GA doesn't + * respond fast. + *
  • multi-thread mode: Each track method call creates a new short-lived + * thread that sends the HTTP request to GA in the background and terminates. + *
  • single-thread mode (the default): The track method stores the request in + * a FIFO and returns immediately. A single long-lived background thread + * consumes the FIFO content and sends the HTTP requests to GA. + *
+ *

+ *

+ * To halt the background thread safely, use the call + * {@link #stopBackgroundThread(long)}, where the parameter is the timeout to + * wait for any remaining queued tracking calls to be made. Keep in mind that if + * new tracking requests are made after the thread is stopped, they will just be + * stored in the queue, and will not be sent to GA until the thread is started + * again with {@link #startBackgroundThread()} (This is assuming you are in + * single-threaded mode to begin with). + *

+ * + * @author Daniel Murphy, Stefan Brozinski + */ +public class JGoogleAnalyticsTracker +{ + public static enum DispatchMode + { + /** + * Each tracking call will wait until the http request + * completes before returning + */ + SYNCHRONOUS, + /** + * Each tracking call spawns a new thread to make the http request + */ + MULTI_THREAD, + /** + * Each tracking request is added to a queue, and a single dispatch + * thread makes the requests. + */ + SINGLE_THREAD + } + + private static Logger logger = + Logger.getLogger(JGoogleAnalyticsTracker.class.getName()); + private static final ThreadGroup asyncThreadGroup = + new ThreadGroup("Async Google Analytics Threads"); + private static long asyncThreadsRunning = 0; + private static Proxy proxy = Proxy.NO_PROXY; + private static LinkedList fifo = new LinkedList<>(); + private static volatile Thread backgroundThread = null; + // the thread used in 'queued' mode. + + private static boolean backgroundThreadMayRun = false; + + static + { + asyncThreadGroup.setMaxPriority(Thread.MIN_PRIORITY); + asyncThreadGroup.setDaemon(true); + JGoogleAnalyticsTracker.setProxy(System.getenv("http_proxy")); + } + + public static enum GoogleAnalyticsVersion + { + V_4_7_2 + } + + private GoogleAnalyticsVersion gaVersion; + private AnalyticsConfigData configData; + private IGoogleAnalyticsURLBuilder builder; + private DispatchMode mode; + private boolean enabled; + + public JGoogleAnalyticsTracker(AnalyticsConfigData argConfigData, + GoogleAnalyticsVersion argVersion) + { + this(argConfigData, argVersion, DispatchMode.SINGLE_THREAD); + } + + public JGoogleAnalyticsTracker(AnalyticsConfigData argConfigData, + GoogleAnalyticsVersion argVersion, DispatchMode argMode) + { + gaVersion = argVersion; + configData = argConfigData; + createBuilder(); + enabled = true; + setDispatchMode(argMode); + } + + /** + * Sets the dispatch mode + * + * @see DispatchMode + * @param argMode + * the mode to to put the tracker in. If this is null, the + * tracker + * defaults to {@link DispatchMode#SINGLE_THREAD} + */ + public void setDispatchMode(DispatchMode argMode) + { + if(argMode == null) + argMode = DispatchMode.SINGLE_THREAD; + if(argMode == DispatchMode.SINGLE_THREAD) + startBackgroundThread(); + mode = argMode; + } + + /** + * Gets the current dispatch mode. Default is + * {@link DispatchMode#SINGLE_THREAD}. + * + * @see DispatchMode + * @return + */ + public DispatchMode getDispatchMode() + { + return mode; + } + + /** + * Convenience method to check if the tracker is in synchronous mode. + * + * @return + */ + public boolean isSynchronous() + { + return mode == DispatchMode.SYNCHRONOUS; + } + + /** + * Convenience method to check if the tracker is in single-thread mode + * + * @return + */ + public boolean isSingleThreaded() + { + return mode == DispatchMode.SINGLE_THREAD; + } + + /** + * Convenience method to check if the tracker is in multi-thread mode + * + * @return + */ + public boolean isMultiThreaded() + { + return mode == DispatchMode.MULTI_THREAD; + } + + /** + * Resets the session cookie. + */ + public void resetSession() + { + builder.resetSession(); + } + + /** + * Sets if the api dispatches tracking requests. + * + * @param argEnabled + */ + public void setEnabled(boolean argEnabled) + { + enabled = argEnabled; + } + + /** + * If the api is dispatching tracking requests (default of true). + * + * @return + */ + public boolean isEnabled() + { + return enabled; + } + + /** + * Define the proxy to use for all GA tracking requests. + *

+ * Call this static method early (before creating any tracking requests). + * + * @param argProxy + * The proxy to use + */ + public static void setProxy(Proxy argProxy) + { + proxy = argProxy != null ? argProxy : Proxy.NO_PROXY; + } + + /** + * Define the proxy to use for all GA tracking requests. + *

+ * Call this static method early (before creating any tracking requests). + * + * @param proxyAddr + * "addr:port" of the proxy to use; may also be given as URL + * ("http://addr:port/"). + */ + public static void setProxy(String proxyAddr) + { + if(proxyAddr != null) + { + Scanner s = new Scanner(proxyAddr); + + // Split into "proxyAddr:proxyPort". + proxyAddr = null; + int proxyPort = 8080; + try + { + s.findInLine("(http://|)([^:/]+)(:|)([0-9]*)(/|)"); + MatchResult m = s.match(); + + if(m.groupCount() >= 2) + proxyAddr = m.group(2); + + if(m.groupCount() >= 4 && !(m.group(4).length() == 0)) + proxyPort = Integer.parseInt(m.group(4)); + }finally + { + s.close(); + } + + if(proxyAddr != null) + { + SocketAddress sa = new InetSocketAddress(proxyAddr, proxyPort); + setProxy(new Proxy(Type.HTTP, sa)); + } + } + } + + /** + * Wait for background tasks to complete. + *

+ * This works in queued and asynchronous mode. + * + * @param timeoutMillis + * The maximum number of milliseconds to wait. + */ + public static void completeBackgroundTasks(long timeoutMillis) + { + + boolean fifoEmpty = false; + boolean asyncThreadsCompleted = false; + + long absTimeout = System.currentTimeMillis() + timeoutMillis; + while(System.currentTimeMillis() < absTimeout) + { + synchronized(fifo) + { + fifoEmpty = fifo.size() == 0; + } + + synchronized(JGoogleAnalyticsTracker.class) + { + asyncThreadsCompleted = asyncThreadsRunning == 0; + } + + if(fifoEmpty && asyncThreadsCompleted) + break; + + try + { + Thread.sleep(100); + }catch(InterruptedException e) + { + break; + } + } + } + + /** + * Tracks a page view. + * + * @param argPageURL + * required, Google won't track without it. Ex: + * "org/me/javaclass.java", or anything you want as + * the page url. + * @param argPageTitle + * content title + * @param argHostName + * the host name for the url + */ + public void trackPageView(String argPageURL, String argPageTitle, + String argHostName) + { + if(argPageURL == null) + throw new IllegalArgumentException( + "Page URL cannot be null, Google will not track the data."); + AnalyticsRequestData data = new AnalyticsRequestData(); + data.setHostName(argHostName); + data.setPageTitle(argPageTitle); + data.setPageURL(argPageURL); + makeCustomRequest(data); + } + + /** + * Tracks a page view. + * + * @param argPageURL + * required, Google won't track without it. Ex: + * "org/me/javaclass.java", or anything you want as + * the page url. + * @param argPageTitle + * content title + * @param argHostName + * the host name for the url + * @param argReferrerSite + * site of the referrer. ex, www.dmurph.com + * @param argReferrerPage + * page of the referrer. ex, /mypage.php + */ + public void trackPageViewFromReferrer(String argPageURL, + String argPageTitle, String argHostName, String argReferrerSite, + String argReferrerPage) + { + if(argPageURL == null) + throw new IllegalArgumentException( + "Page URL cannot be null, Google will not track the data."); + AnalyticsRequestData data = new AnalyticsRequestData(); + data.setHostName(argHostName); + data.setPageTitle(argPageTitle); + data.setPageURL(argPageURL); + data.setReferrer(argReferrerSite, argReferrerPage); + makeCustomRequest(data); + } + + /** + * Tracks a page view. + * + * @param argPageURL + * required, Google won't track without it. Ex: + * "org/me/javaclass.java", or anything you want as + * the page url. + * @param argPageTitle + * content title + * @param argHostName + * the host name for the url + * @param argSearchSource + * source of the search engine. ex: google + * @param argSearchKeywords + * the keywords of the search. ex: java google analytics tracking + * utility + */ + public void trackPageViewFromSearch(String argPageURL, String argPageTitle, + String argHostName, String argSearchSource, String argSearchKeywords) + { + if(argPageURL == null) + throw new IllegalArgumentException( + "Page URL cannot be null, Google will not track the data."); + AnalyticsRequestData data = new AnalyticsRequestData(); + data.setHostName(argHostName); + data.setPageTitle(argPageTitle); + data.setPageURL(argPageURL); + data.setSearchReferrer(argSearchSource, argSearchKeywords); + makeCustomRequest(data); + } + + /** + * Tracks an event. To provide more info about the page, use + * {@link #makeCustomRequest(AnalyticsRequestData)}. + * + * @param argCategory + * @param argAction + */ + public void trackEvent(String argCategory, String argAction) + { + trackEvent(argCategory, argAction, null, null); + } + + /** + * Tracks an event. To provide more info about the page, use + * {@link #makeCustomRequest(AnalyticsRequestData)}. + * + * @param argCategory + * @param argAction + * @param argLabel + */ + public void trackEvent(String argCategory, String argAction, + String argLabel) + { + trackEvent(argCategory, argAction, argLabel, null); + } + + /** + * Tracks an event. To provide more info about the page, use + * {@link #makeCustomRequest(AnalyticsRequestData)}. + * + * @param argCategory + * required + * @param argAction + * required + * @param argLabel + * optional + * @param argValue + * optional + */ + public void trackEvent(String argCategory, String argAction, + String argLabel, Integer argValue) + { + AnalyticsRequestData data = new AnalyticsRequestData(); + data.setEventCategory(argCategory); + data.setEventAction(argAction); + data.setEventLabel(argLabel); + data.setEventValue(argValue); + + makeCustomRequest(data); + } + + /** + * Makes a custom tracking request based from the given data. + * + * @param argData + * @throws NullPointerException + * if argData is null or if the URL builder is null + */ + public synchronized void makeCustomRequest(AnalyticsRequestData argData) + { + if(!enabled) + { + logger.log(Level.CONFIG, + "Ignoring tracking request, enabled is false"); + return; + } + if(argData == null) + throw new NullPointerException("Data cannot be null"); + if(builder == null) + throw new NullPointerException("Class was not initialized"); + final String url = builder.buildURL(argData); + final String userAgent = configData.getUserAgent(); + + switch(mode) + { + case MULTI_THREAD: + Thread t = new Thread(asyncThreadGroup, + "AnalyticsThread-" + asyncThreadGroup.activeCount()) + { + @Override + public void run() + { + synchronized(JGoogleAnalyticsTracker.class) + { + asyncThreadsRunning++; + } + try + { + dispatchRequest(url, userAgent); + }finally + { + synchronized(JGoogleAnalyticsTracker.class) + { + asyncThreadsRunning--; + } + } + } + }; + t.setDaemon(true); + t.start(); + break; + case SYNCHRONOUS: + dispatchRequest(url, userAgent); + break; + default: // in case it's null, we default to the single-thread + synchronized(fifo) + { + fifo.addLast(url); + fifo.notify(); + } + if(!backgroundThreadMayRun) + logger.log(Level.SEVERE, + "A tracker request has been added to the queue but the background thread isn't running.", + url); + break; + } + } + + private static void dispatchRequest(String argURL, String userAgent) + { + try + { + URL url = new URL(argURL); + HttpURLConnection connection = + (HttpURLConnection)url.openConnection(proxy); + connection.setRequestMethod("GET"); + connection.setInstanceFollowRedirects(true); + if(userAgent != null) + connection.addRequestProperty("User-Agent", userAgent); + connection.connect(); + int responseCode = connection.getResponseCode(); + if(responseCode != HttpURLConnection.HTTP_OK) + logger.log(Level.SEVERE, + "JGoogleAnalyticsTracker: Error requesting url '" + argURL + + "', received response code " + responseCode); + else + logger.log(Level.CONFIG, + "JGoogleAnalyticsTracker: Tracking success for url '" + + argURL + "'"); + }catch(Exception e) + { + logger.log(Level.SEVERE, "Error making tracking request", e); + } + } + + private void createBuilder() + { + switch(gaVersion) + { + case V_4_7_2: + builder = new GoogleAnalyticsV4_7_2(configData); + break; + default: + builder = new GoogleAnalyticsV4_7_2(configData); + break; + } + } + + /** + * If the background thread for 'queued' mode is not running, start it now. + */ + private synchronized void startBackgroundThread() + { + if(backgroundThread == null) + { + backgroundThreadMayRun = true; + backgroundThread = + new Thread(asyncThreadGroup, "AnalyticsBackgroundThread") + { + @Override + public void run() + { + logger.log(Level.CONFIG, + "AnalyticsBackgroundThread started"); + while(backgroundThreadMayRun) + try + { + String url = null; + + synchronized(fifo) + { + if(fifo.isEmpty()) + fifo.wait(); + + if(!fifo.isEmpty()) + // Get a reference to the oldest element + // in + // the FIFO, but leave it in the FIFO + // until + // it is processed. + url = fifo.getFirst(); + } + + if(url != null) + try + { + dispatchRequest(url, + configData.getUserAgent()); + }finally + { + // Now that we have completed the HTTP + // request to GA, remove the element + // from + // the FIFO. + synchronized(fifo) + { + fifo.removeFirst(); + } + } + }catch(Exception e) + { + logger.log(Level.SEVERE, + "Got exception from dispatch thread", e); + } + } + }; + + // Don't prevent the application from terminating. + // Use completeBackgroundTasks() before exit if you want to ensure + // that all pending GA requests are sent. + backgroundThread.setDaemon(true); + + backgroundThread.start(); + } + } + + /** + * Stop the long-lived background thread. + *

+ * This method is needed for debugging purposes only. Calling it in an + * application is not really required: The background thread will terminate + * automatically when the application exits. + * + * @param timeoutMillis + * If nonzero, wait for thread completion before returning. + */ + public synchronized static void stopBackgroundThread(long timeoutMillis) + { + backgroundThreadMayRun = false; + fifo.notify(); + if(backgroundThread != null && timeoutMillis > 0) + { + try + { + backgroundThread.join(timeoutMillis); + }catch(InterruptedException e) + {} + backgroundThread = null; + } + } + + public AnalyticsConfigData getConfigData() + { + return configData; + } +} diff --git a/src/main/java/net/wurstclient/analytics/dmurph/URIEncoder.java b/src/main/java/net/wurstclient/analytics/dmurph/URIEncoder.java new file mode 100644 index 00000000..d336ae45 --- /dev/null +++ b/src/main/java/net/wurstclient/analytics/dmurph/URIEncoder.java @@ -0,0 +1,52 @@ +/** + * Copyright (c) 2010 Daniel Murphy + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +package net.wurstclient.analytics.dmurph; + +/** + * simple uri encoder, made from the spec at: + * http://www.ietf.org/rfc/rfc2396.txt + * + * @author Daniel Murphy + */ +public class URIEncoder +{ + + private static String mark = "-_.!~*'()\""; + + public static String encodeURI(String argString) + { + StringBuffer uri = new StringBuffer(); // Encoded URL + + char[] chars = argString.toCharArray(); + for(char c : chars) + if(c >= '0' && c <= '9' || c >= 'a' && c <= 'z' + || c >= 'A' && c <= 'Z' || mark.indexOf(c) != -1) + uri.append(c); + else + { + uri.append("%"); + uri.append(Integer.toHexString(c)); + } + return uri.toString(); + } +} diff --git a/src/main/java/net/wurstclient/analytics/dmurph/VisitorData.java b/src/main/java/net/wurstclient/analytics/dmurph/VisitorData.java new file mode 100644 index 00000000..09421209 --- /dev/null +++ b/src/main/java/net/wurstclient/analytics/dmurph/VisitorData.java @@ -0,0 +1,78 @@ +package net.wurstclient.analytics.dmurph; + +import java.security.SecureRandom; + +public class VisitorData +{ + private int visitorId; + private long timestampFirst; + private long timestampPrevious; + private long timestampCurrent; + private int visits; + + private VisitorData(int visitorId, long timestampFirst, + long timestampPrevious, long timestampCurrent, int visits) + { + this.visitorId = visitorId; + this.timestampFirst = timestampFirst; + this.timestampPrevious = timestampPrevious; + this.timestampCurrent = timestampCurrent; + this.visits = visits; + } + + /** + * initializes a new visitor data, with new visitorid + */ + public static VisitorData newVisitor() + { + int visitorId = new SecureRandom().nextInt() & 0x7FFFFFFF; + long now = now(); + return new VisitorData(visitorId, now, now, now, 1); + } + + public static VisitorData newSession(int visitorId, long timestampfirst, + long timestamplast, int visits) + { + return new VisitorData(visitorId, timestampfirst, timestamplast, now(), + visits + 1); + } + + public void resetSession() + { + long now = now(); + timestampPrevious = timestampCurrent; + timestampCurrent = now; + visits++; + } + + private static long now() + { + return System.currentTimeMillis() / 1000L; + } + + public int getVisitorId() + { + return visitorId; + } + + public long getTimestampFirst() + { + return timestampFirst; + } + + public long getTimestampPrevious() + { + return timestampPrevious; + } + + public long getTimestampCurrent() + { + return timestampCurrent; + } + + public int getVisits() + { + return visits; + } + +} diff --git a/src/main/java/net/wurstclient/event/CancellableEvent.java b/src/main/java/net/wurstclient/event/CancellableEvent.java new file mode 100644 index 00000000..247acbaa --- /dev/null +++ b/src/main/java/net/wurstclient/event/CancellableEvent.java @@ -0,0 +1,23 @@ +/* + * Copyright (C) 2014 - 2018 | Wurst-Imperium | All rights reserved. + * + * This source code is subject to the terms of the GNU General Public + * License, version 3. If a copy of the GPL was not distributed with this + * file, You can obtain one at: https://www.gnu.org/licenses/gpl-3.0.txt + */ +package net.wurstclient.event; + +public abstract class CancellableEvent extends Event +{ + private boolean cancelled = false; + + public void cancel() + { + cancelled = true; + } + + public boolean isCancelled() + { + return cancelled; + } +} diff --git a/src/main/java/net/wurstclient/event/Event.java b/src/main/java/net/wurstclient/event/Event.java new file mode 100644 index 00000000..d88fe4eb --- /dev/null +++ b/src/main/java/net/wurstclient/event/Event.java @@ -0,0 +1,17 @@ +/* + * Copyright (C) 2014 - 2018 | Wurst-Imperium | All rights reserved. + * + * This source code is subject to the terms of the GNU General Public + * License, version 3. If a copy of the GPL was not distributed with this + * file, You can obtain one at: https://www.gnu.org/licenses/gpl-3.0.txt + */ +package net.wurstclient.event; + +import java.util.ArrayList; + +public abstract class Event +{ + public abstract void fire(ArrayList listeners); + + public abstract Class getListenerType(); +} diff --git a/src/main/java/net/wurstclient/event/EventManager.java b/src/main/java/net/wurstclient/event/EventManager.java new file mode 100644 index 00000000..fbc2b342 --- /dev/null +++ b/src/main/java/net/wurstclient/event/EventManager.java @@ -0,0 +1,122 @@ +/* + * Copyright (C) 2014 - 2018 | Wurst-Imperium | All rights reserved. + * + * This source code is subject to the terms of the GNU General Public + * License, version 3. If a copy of the GPL was not distributed with this + * file, You can obtain one at: https://www.gnu.org/licenses/gpl-3.0.txt + */ +package net.wurstclient.event; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.Objects; + +import net.minecraft.util.crash.CrashException; +import net.minecraft.util.crash.CrashReport; +import net.minecraft.util.crash.CrashReportSection; +import net.wurstclient.WurstClient; + +public final class EventManager +{ + private final WurstClient wurst; + private final HashMap, ArrayList> listenerMap = + new HashMap<>(); + + public EventManager(WurstClient wurst) + { + this.wurst = wurst; + } + + public > void fire(E event) + { + if(!wurst.isEnabled()) + return; + + try + { + Class type = event.getListenerType(); + @SuppressWarnings("unchecked") + ArrayList listeners = (ArrayList)listenerMap.get(type); + + if(listeners == null || listeners.isEmpty()) + return; + + // Creating a copy of the list to avoid concurrent modification + // issues. + ArrayList listeners2 = new ArrayList<>(listeners); + + // remove() sets an element to null before removing it. When one + // thread calls remove() while another calls fire(), it is possible + // for this list to contain null elements, which need to be filtered + // out. + listeners2.removeIf(Objects::isNull); + + event.fire(listeners2); + + }catch(Throwable e) + { + e.printStackTrace(); + + CrashReport report = CrashReport.create(e, "Firing Wurst event"); + CrashReportSection section = report.addElement("Affected event"); + section.add("Event class", () -> event.getClass().getName()); + + throw new CrashException(report); + } + } + + public void add(Class type, L listener) + { + try + { + @SuppressWarnings("unchecked") + ArrayList listeners = (ArrayList)listenerMap.get(type); + + if(listeners == null) + { + listeners = new ArrayList<>(Arrays.asList(listener)); + listenerMap.put(type, listeners); + return; + } + + listeners.add(listener); + + }catch(Throwable e) + { + e.printStackTrace(); + + CrashReport report = + CrashReport.create(e, "Adding Wurst event listener"); + CrashReportSection section = report.addElement("Affected listener"); + section.add("Listener type", () -> type.getName()); + section.add("Listener class", () -> listener.getClass().getName()); + + throw new CrashException(report); + } + } + + public void remove(Class type, L listener) + { + try + { + @SuppressWarnings("unchecked") + ArrayList listeners = (ArrayList)listenerMap.get(type); + + if(listeners != null) + listeners.remove(listener); + + }catch(Throwable e) + { + e.printStackTrace(); + + CrashReport report = + CrashReport.create(e, "Removing Wurst event listener"); + CrashReportSection section = report.addElement("Affected listener"); + section.add("Listener type", () -> type.getName()); + section.add("Listener class", () -> listener.getClass().getName()); + + throw new CrashException(report); + } + } +} diff --git a/src/main/java/net/wurstclient/event/Listener.java b/src/main/java/net/wurstclient/event/Listener.java new file mode 100644 index 00000000..083d306b --- /dev/null +++ b/src/main/java/net/wurstclient/event/Listener.java @@ -0,0 +1,15 @@ +/* + * Copyright (C) 2014 - 2018 | Wurst-Imperium | All rights reserved. + * + * This source code is subject to the terms of the GNU General Public + * License, version 3. If a copy of the GPL was not distributed with this + * file, You can obtain one at: https://www.gnu.org/licenses/gpl-3.0.txt + */ +package net.wurstclient.event; + +import java.util.EventListener; + +public interface Listener extends EventListener +{ + +} diff --git a/src/main/java/net/wurstclient/utils/JsonUtils.java b/src/main/java/net/wurstclient/utils/JsonUtils.java new file mode 100644 index 00000000..f48741ab --- /dev/null +++ b/src/main/java/net/wurstclient/utils/JsonUtils.java @@ -0,0 +1,24 @@ +/* + * Copyright (C) 2014 - 2019 | Wurst-Imperium | All rights reserved. + * + * This source code is subject to the terms of the GNU General Public + * License, version 3. If a copy of the GPL was not distributed with this + * file, You can obtain one at: https://www.gnu.org/licenses/gpl-3.0.txt + */ +package net.wurstclient.utils; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonParser; + +public enum JsonUtils +{ + ; + + public static final Gson GSON = new Gson(); + + public static final Gson PRETTY_GSON = + new GsonBuilder().setPrettyPrinting().create(); + + public static final JsonParser JSON_PARSER = new JsonParser(); +} diff --git a/src/main/resources/assets/modid/icon.png b/src/main/resources/assets/modid/icon.png new file mode 100644 index 00000000..047b91f2 Binary files /dev/null and b/src/main/resources/assets/modid/icon.png differ diff --git a/src/main/resources/fabric.mod.json b/src/main/resources/fabric.mod.json new file mode 100644 index 00000000..0f2528c0 --- /dev/null +++ b/src/main/resources/fabric.mod.json @@ -0,0 +1,36 @@ +{ + "schemaVersion": 1, + "id": "modid", + "version": "${version}", + + "name": "Example Mod", + "description": "This is an example description! Tell everyone what your mod is about!", + "authors": [ + "Me!" + ], + "contact": { + "homepage": "https://fabricmc.net/", + "sources": "https://github.com/FabricMC/fabric-example-mod" + }, + + "license": "GPL-3.0-or-later", + "icon": "assets/modid/icon.png", + + "environment": "client", + "entrypoints": { + "main": [ + "net.wurstclient.WurstClient" + ] + }, + "mixins": [ + "modid.mixins.json" + ], + + "depends": { + "fabricloader": ">=0.4.0", + "fabric": "*" + }, + "suggests": { + "flamingo": "*" + } +} diff --git a/src/main/resources/modid.mixins.json b/src/main/resources/modid.mixins.json new file mode 100644 index 00000000..e243f0a2 --- /dev/null +++ b/src/main/resources/modid.mixins.json @@ -0,0 +1,13 @@ +{ + "required": true, + "package": "net.fabricmc.example.mixin", + "compatibilityLevel": "JAVA_8", + "mixins": [ + ], + "client": [ + "ExampleMixin" + ], + "injectors": { + "defaultRequire": 1 + } +}