From b85178f3c89530df219647cfb20921fc866b8377 Mon Sep 17 00:00:00 2001 From: mbax Date: Mon, 2 Nov 2020 22:49:17 -0500 Subject: [PATCH 01/11] How else do you catch a kitteh? --- .gitignore | 8 + LICENSE | 674 ++++++++++++++++++ LICENSE_FILE_HEADER | 15 + README.md | 18 + pom.xml | 191 +++++ .../org/kitteh/cardboardbox/CardboardBox.java | 251 +++++++ src/main/resources/cardboard-box-credit.txt | 19 + 7 files changed, 1176 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 LICENSE_FILE_HEADER create mode 100644 README.md create mode 100644 pom.xml create mode 100644 src/main/java/org/kitteh/cardboardbox/CardboardBox.java create mode 100644 src/main/resources/cardboard-box-credit.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6d330be --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +# This is a simple .gitignore for simple needs. + +# To ignore files system-wide, use the global git setting core.excludesfile +# For repo-specific ignoring, use .git/info/exclude +# To ignore the opinions of others, cover your ears and scream "LA LA LA!" + +# Maven makes this! +/target diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/LICENSE_FILE_HEADER b/LICENSE_FILE_HEADER new file mode 100644 index 0000000..e65ab4d --- /dev/null +++ b/LICENSE_FILE_HEADER @@ -0,0 +1,15 @@ +Cardboard Box +Copyright (C) 2020 Matt Baxter + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..ab0afbc --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +Cardboard Box +============= + +A simple library for storing and retrieving ItemStacks in Bukkit-related environments. + +Example +------- + +Example demonstration of storing and retrieving the item in a player's hand: +```java +if (CardboardBox.isReady()) { + ItemStack item = player.getInventory().getItemInMainHand(); + byte[] data = CardboardBox.serializeItem(item); + this.getLogger().info(Base64.getEncoder().encodeToString(data)); + ItemStack item2 = CardboardBox.deserializeItem(data); + this.getLogger().info(item2.toString()); +} +``` \ No newline at end of file diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..4f988a4 --- /dev/null +++ b/pom.xml @@ -0,0 +1,191 @@ + + + 4.0.0 + + org.kitteh + cardboardbox + 0.1.0 + jar + + Cardboard Box + A Bukkit-related data storage handler + + + + mbaxter + Matt Baxter + matt@kitteh.org + https://kitteh.org + Kitteh + https://kitteh.org + + Lead Developer + Cat Wrangler + + + + + + + GNU General Public License (GPL) version 3 + https://www.gnu.org/licenses/gpl-3.0.txt + + + + + GitHub + https://github.com/KittehOrg/CardboardBox/issues + + + + scm:git:git@github.com:KittehOrg/CardboardBox.git + scm:git:git@github.com:KittehOrg/CardboardBox.git + git@github.com:KittehOrg/CardboardBox.git + + + + UTF-8 + + + + + papermc + https://papermc.io/repo/repository/maven-public/ + + + + + + com.destroystokyo.paper + paper-api + 1.16.4-R0.1-SNAPSHOT + provided + + + + + + + org.apache.maven.plugins + maven-clean-plugin + 3.1.0 + + + org.apache.maven.plugins + maven-resources-plugin + 3.2.0 + + + org.apache.maven.plugins + maven-compiler-plugin + 3.8.1 + + 1.8 + 1.8 + + + + org.apache.maven.plugins + maven-jar-plugin + 3.2.0 + + + + org.kitteh.irc.client.library + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 3.2.0 + + + attach-javadocs + package + + jar + + + + + + org.apache.maven.plugins + maven-source-plugin + 3.2.1 + + + attach-sources + package + + jar-no-fork + + + + + + com.mycila + license-maven-plugin + 3.0 + + + clean + + format + + + + + true + UTF-8 + true +
${basedir}/LICENSE_FILE_HEADER
+ + SLASHSTAR_STYLE + + + src/main/java/org/kitteh/** + + + + + + + + + release + + + + org.apache.maven.plugins + maven-gpg-plugin + 1.6 + + + sign-artifacts + verify + + sign + + + + + + org.sonatype.plugins + nexus-staging-maven-plugin + 1.6.8 + true + + ossrh + https://oss.sonatype.org/ + true + + + + + + + \ No newline at end of file diff --git a/src/main/java/org/kitteh/cardboardbox/CardboardBox.java b/src/main/java/org/kitteh/cardboardbox/CardboardBox.java new file mode 100644 index 0000000..38f4b85 --- /dev/null +++ b/src/main/java/org/kitteh/cardboardbox/CardboardBox.java @@ -0,0 +1,251 @@ +/* + * Cardboard Box + * Copyright (C) 2020 Matt Baxter + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +package org.kitteh.cardboardbox; + +import org.bukkit.Bukkit; +import org.bukkit.Material; +import org.bukkit.inventory.ItemStack; +import org.bukkit.inventory.meta.ItemMeta; + +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.InputStream; +import java.io.OutputStream; +import java.lang.reflect.Constructor; +import java.lang.reflect.Field; +import java.lang.reflect.Method; +import java.util.Base64; + +@SuppressWarnings("UnqualifiedStaticUsage") +public class CardboardBox { + private static final String NMS = "net.minecraft.server."; + private static final String OBC = "org.bukkit.craftbukkit."; + private static final int OLD_DATA_VERSION = 1343; + + private static Method itemStackFromCompound; + private static Method itemStackSave; + private static Method nbtCompressedStreamToolsRead; + private static Method nbtCompressedStreamToolsWrite; + private static Method nbtTagCompoundGetInt; + private static Method nbtTagCompoundSetInt; + private static Method dataFixerUpdate; + private static Constructor dynamic; + private static Constructor nbtTagCompoundConstructor; + private static Constructor itemStackConstructor; + + private static Class craftItemStack; + private static Field craftItemStackHandle; + private static Method craftItemStackAsNMSCopy; + private static Method craftItemStackAsCraftMirror; + private static Method dynamicGetValue; + + private static Object dynamicOpsNBT; + private static Object dataConverterTypesItemStack; + private static Object dataConverterRegistryDataFixer; + + private static int dataVersion; + private static boolean hasDataVersion = false; + + private static boolean failure = true; + private static Exception exception; + private static boolean testPending = true; + + static { + try { + String[] packageSplit = Bukkit.getServer().getClass().getPackage().getName().split("\\."); + String packageVersion = packageSplit[packageSplit.length - 1] + '.'; + String nms = NMS + packageVersion; + String obc = OBC + packageVersion; + + // Time to load ALL the things! + + // NMS + Class itemStack = Class.forName(nms + "ItemStack"); + Class nbtCompressedStreamTools = Class.forName(nms + "NBTCompressedStreamTools"); + Class nbtTagCompound = Class.forName(nms + "NBTTagCompound"); + nbtTagCompoundConstructor = nbtTagCompound.getConstructor(); + try { + itemStackFromCompound = itemStack.getMethod("fromCompound", nbtTagCompound); + } catch (NoSuchMethodException e) { + try { + itemStackFromCompound = itemStack.getMethod("createStack", nbtTagCompound); + } catch (NoSuchMethodException e2) { + try { + itemStackFromCompound = itemStack.getMethod("a", nbtTagCompound); + } catch (NoSuchMethodException e3) { + itemStackConstructor = itemStack.getConstructor(nbtTagCompound); + } + } + } + itemStackSave = itemStack.getMethod("save", nbtTagCompound); + nbtCompressedStreamToolsRead = nbtCompressedStreamTools.getMethod("a", InputStream.class); + nbtCompressedStreamToolsWrite = nbtCompressedStreamTools.getMethod("a", nbtTagCompound, OutputStream.class); + nbtTagCompoundGetInt = nbtTagCompound.getMethod("getInt", String.class); + nbtTagCompoundSetInt = nbtTagCompound.getMethod("setInt", String.class, int.class); + + // OBC + craftItemStack = Class.forName(obc + "inventory.CraftItemStack"); + Class craftMagicNumbers = Class.forName(obc + "util.CraftMagicNumbers"); + craftItemStackHandle = craftItemStack.getDeclaredField("handle"); + craftItemStackHandle.setAccessible(true); + Field craftMagicNumbersInstance = craftMagicNumbers.getField("INSTANCE"); + craftItemStackAsNMSCopy = craftItemStack.getMethod("asNMSCopy", ItemStack.class); + craftItemStackAsCraftMirror = craftItemStack.getMethod("asCraftMirror", itemStack); + + // DataFixer + try { + craftMagicNumbers.getMethod("getDataVersion"); + dataVersion = (int) craftMagicNumbers.getMethod("getDataVersion").invoke(craftMagicNumbersInstance.get(null)); + Class dataFixer = Class.forName("com.mojang.datafixers.DataFixer"); + for (Method method : dataFixer.getMethods()) { + if (method.getName().equals("update") && method.getParameterCount() == 4) { + dataFixerUpdate = method; + break; + } + } + + Class dataConverterRegistry = Class.forName(nms + "DataConverterRegistry"); + for (Field field : dataConverterRegistry.getDeclaredFields()) { + if (dataFixer.isAssignableFrom(field.getType())) { + field.setAccessible(true); + dataConverterRegistryDataFixer = field.get(null); + break; + } + } + if (dataConverterRegistryDataFixer == null) { + throw new IllegalStateException("No sign of data fixer"); + } + dataConverterTypesItemStack = Class.forName(nms + "DataConverterTypes").getField("ITEM_STACK").get(null); + dynamicOpsNBT = Class.forName(nms + "DynamicOpsNBT").getField("a").get(null); + Class dynamicClass = dataFixerUpdate.getParameterTypes()[1]; + for (Constructor constructor : dynamicClass.getConstructors()) { + if (constructor.getParameterCount() == 2) { + dynamic = constructor; + break; + } + } + dynamicGetValue = dynamicClass.getMethod("getValue"); + hasDataVersion = true; + } catch (Exception ignored) { + } + failure = false; + } catch (Exception e) { + exception = e; + } + } + + /** + * Gets if Cardboard Box is ready to work, or failed to initialize. + * + * @return true if ready + */ + public static boolean isReady() { + if (!failure && testPending) { + testPending = false; + try { + // TODO come up with an insane itemstack to deserialize and reserialize as a test. + ItemStack itemStack = new ItemStack(Material.DIRT); + ItemMeta meta = itemStack.getItemMeta(); + meta.setDisplayName("DIRTY"); + deserializeItem(serializeItem(itemStack)); + } catch (Exception e) { + failure = true; + exception = e; + } + } + return !failure; + } + + // The below are modeled on the work of Mariell Hoversholm (Proximyst) + // released under GPLv3 for the Paper project + + /** + * Serializes an ItemStack to bytes. Will store air and null the same, as + * just a single byte of 0x0. + * + * @param item item to serialize + * @return bytes of the item serialized + * @throws IllegalStateException if CardboardBox failed to initialize + * (check with {@link #isReady()}) + * @throws RuntimeException if serialization failed for any reason + */ + public static byte[] serializeItem(ItemStack item) { + if (failure) { + throw new IllegalStateException("Cardboard Box failed to initialize. Cannot serialize without risk.", exception); + } + if (item == null || item.getType() == Material.AIR) { + return new byte[]{0x0}; + } + ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); + try { + Object nmsItem; + if (craftItemStack.isAssignableFrom(item.getClass())) { + nmsItem = craftItemStackHandle.get(item); + } else { + nmsItem = craftItemStackAsNMSCopy.invoke(null, item); + } + Object compound = itemStackSave.invoke(nmsItem, nbtTagCompoundConstructor.newInstance()); + if (hasDataVersion) { + nbtTagCompoundSetInt.invoke(compound, "DataVersion", dataVersion); + } + nbtCompressedStreamToolsWrite.invoke(null, compound, outputStream); + } catch (Exception e) { + throw new RuntimeException("Failed to serialize item stack\n" + item, e); + } + return outputStream.toByteArray(); + } + + /** + * Deserializes an ItemStack previously serialized by Cardboard Box. Will + * return air for a null or empty array of data. + * + * @param data data to deserialize + * @return the ItemStack + * @throws IllegalArgumentException if the stored item's version is + * greater than the current server data version + * @throws IllegalStateException if CardboardBox failed to initialize + * (check with {@link #isReady()}) + * @throws RuntimeException if deserialization failed for any reason + */ + public static ItemStack deserializeItem(byte[] data) { + if (failure) { + throw new IllegalStateException("Cardboard Box failed to initialize. Cannot serialize without risk.", exception); + } + if (data == null || data.length == 0 || (data.length == 1 && data[0] == 0x0)) { + return new ItemStack(Material.AIR); + } + + try { + Object compound = nbtCompressedStreamToolsRead.invoke(null, new ByteArrayInputStream(data)); + + if (hasDataVersion) { + int version = (int) nbtTagCompoundGetInt.invoke(compound, "DataVersion"); + if (version == 0) { + version = OLD_DATA_VERSION; + } + if (version > dataVersion) { + throw new IllegalArgumentException("Attempting to load an item of version " + version + " but this server is version " + dataVersion); + } + compound = dynamicGetValue.invoke(dataFixerUpdate.invoke(dataConverterRegistryDataFixer, dataConverterTypesItemStack, dynamic.newInstance(dynamicOpsNBT, compound), version, dataVersion)); + } + return (ItemStack) craftItemStackAsCraftMirror.invoke(null, itemStackFromCompound == null ? itemStackConstructor.newInstance(compound) : itemStackFromCompound.invoke(null, compound)); + } catch (Exception e) { + throw new RuntimeException("Failed to deserialize item stack\n" + Base64.getEncoder().encodeToString(data), e); + } + } +} diff --git a/src/main/resources/cardboard-box-credit.txt b/src/main/resources/cardboard-box-credit.txt new file mode 100644 index 0000000..c3e7f3d --- /dev/null +++ b/src/main/resources/cardboard-box-credit.txt @@ -0,0 +1,19 @@ +Powered by Cardboard Box, a Kitteh.org project + +Special thanks to Mariell Hoversholm (Proximyst) + +Cardboard Box +Copyright (C) 2020 Matt Baxter + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . \ No newline at end of file From bee4993fdb2fa9de2b53f630fdfcd3fd1dd88ac4 Mon Sep 17 00:00:00 2001 From: mbax Date: Sun, 8 Nov 2020 18:20:33 -0500 Subject: [PATCH 02/11] jitpack instructions --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index ab0afbc..0eb70bd 100644 --- a/README.md +++ b/README.md @@ -15,4 +15,22 @@ if (CardboardBox.isReady()) { ItemStack item2 = CardboardBox.deserializeItem(data); this.getLogger().info(item2.toString()); } +``` + +Using +----- + +```xml + + jitpack.io + https://jitpack.io + +``` + +```xml + + org.kitteh + cardboardbox + 0.1.0 + ``` \ No newline at end of file From c086e7311bfa5db79103809a55382e2aa6e43d36 Mon Sep 17 00:00:00 2001 From: mbax Date: Sun, 28 Feb 2021 22:10:54 -0500 Subject: [PATCH 03/11] Test for, and use, modern Paper API first --- pom.xml | 4 +-- .../org/kitteh/cardboardbox/CardboardBox.java | 33 +++++++++++++++++-- 2 files changed, 32 insertions(+), 5 deletions(-) diff --git a/pom.xml b/pom.xml index 4f988a4..a59328b 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ org.kitteh cardboardbox - 0.1.0 + 0.2.0-SNAPSHOT jar Cardboard Box @@ -60,7 +60,7 @@ com.destroystokyo.paper paper-api - 1.16.4-R0.1-SNAPSHOT + 1.16.5-R0.1-SNAPSHOT provided diff --git a/src/main/java/org/kitteh/cardboardbox/CardboardBox.java b/src/main/java/org/kitteh/cardboardbox/CardboardBox.java index 38f4b85..e9fa477 100644 --- a/src/main/java/org/kitteh/cardboardbox/CardboardBox.java +++ b/src/main/java/org/kitteh/cardboardbox/CardboardBox.java @@ -62,10 +62,22 @@ public class CardboardBox { private static boolean hasDataVersion = false; private static boolean failure = true; + private static boolean modernPaper = false; private static Exception exception; private static boolean testPending = true; static { + init(); + } + + private static void init() { + try { + ItemStack.class.getDeclaredMethod("deserializeBytes", byte[].class); + ItemStack.class.getDeclaredMethod("serializeAsBytes"); + modernPaper = true; + return; + } catch (Exception ignored) { + } try { String[] packageSplit = Bukkit.getServer().getClass().getPackage().getName().split("\\."); String packageVersion = packageSplit[packageSplit.length - 1] + '.'; @@ -149,19 +161,29 @@ public class CardboardBox { } } + /** + * Gets if Cardboard Box will just use Paper's built-in functionality. + * + * @return true if the built-in methods exist, eliminating stress + */ + public static boolean isModernPaperSupport() { + return modernPaper; + } + /** * Gets if Cardboard Box is ready to work, or failed to initialize. * * @return true if ready */ public static boolean isReady() { + if (modernPaper) { + return true; + } if (!failure && testPending) { testPending = false; try { // TODO come up with an insane itemstack to deserialize and reserialize as a test. ItemStack itemStack = new ItemStack(Material.DIRT); - ItemMeta meta = itemStack.getItemMeta(); - meta.setDisplayName("DIRTY"); deserializeItem(serializeItem(itemStack)); } catch (Exception e) { failure = true; @@ -191,6 +213,9 @@ public static byte[] serializeItem(ItemStack item) { if (item == null || item.getType() == Material.AIR) { return new byte[]{0x0}; } + if (modernPaper) { + return item.serializeAsBytes(); + } ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); try { Object nmsItem; @@ -229,7 +254,9 @@ public static ItemStack deserializeItem(byte[] data) { if (data == null || data.length == 0 || (data.length == 1 && data[0] == 0x0)) { return new ItemStack(Material.AIR); } - + if (modernPaper) { + return ItemStack.deserializeBytes(data); + } try { Object compound = nbtCompressedStreamToolsRead.invoke(null, new ByteArrayInputStream(data)); From 854a4da31ae77f4f0def0e3e7a564d03b6d8538e Mon Sep 17 00:00:00 2001 From: mbax Date: Fri, 11 Jun 2021 23:00:35 -0400 Subject: [PATCH 04/11] Update to handle MC 1.17 --- .../org/kitteh/cardboardbox/CardboardBox.java | 40 ++++++++++++++----- 1 file changed, 29 insertions(+), 11 deletions(-) diff --git a/src/main/java/org/kitteh/cardboardbox/CardboardBox.java b/src/main/java/org/kitteh/cardboardbox/CardboardBox.java index e9fa477..414cf62 100644 --- a/src/main/java/org/kitteh/cardboardbox/CardboardBox.java +++ b/src/main/java/org/kitteh/cardboardbox/CardboardBox.java @@ -20,7 +20,6 @@ import org.bukkit.Bukkit; import org.bukkit.Material; import org.bukkit.inventory.ItemStack; -import org.bukkit.inventory.meta.ItemMeta; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; @@ -33,8 +32,6 @@ @SuppressWarnings("UnqualifiedStaticUsage") public class CardboardBox { - private static final String NMS = "net.minecraft.server."; - private static final String OBC = "org.bukkit.craftbukkit."; private static final int OLD_DATA_VERSION = 1343; private static Method itemStackFromCompound; @@ -75,21 +72,42 @@ private static void init() { ItemStack.class.getDeclaredMethod("deserializeBytes", byte[].class); ItemStack.class.getDeclaredMethod("serializeAsBytes"); modernPaper = true; + failure = false; return; } catch (Exception ignored) { } try { String[] packageSplit = Bukkit.getServer().getClass().getPackage().getName().split("\\."); String packageVersion = packageSplit[packageSplit.length - 1] + '.'; - String nms = NMS + packageVersion; - String obc = OBC + packageVersion; + int ver = Integer.parseInt(packageVersion.split("_")[1]); + + String obc = "org.bukkit.craftbukkit." + packageVersion; + String nmsItemStack, nmsNBTCompressedStreamTools, nmsNBTTagCompound, nmsDynamicOpsNBT, nmsDataConverterTypes, nmsDataConverterRegistry; + + if (ver < 17) { + String nms = "net.minecraft.server." + packageVersion; + nmsItemStack = nms + "ItemStack"; + nmsNBTTagCompound = nms + "NBTTagCompound"; + nmsNBTCompressedStreamTools = nms + "NBTCompressedStreamTools"; + nmsDynamicOpsNBT = nms + "DynamicOpsNBT"; + nmsDataConverterTypes = nms + "DataConverterTypes"; + nmsDataConverterRegistry = nms + "DataConverterRegistry"; + } else { + nmsItemStack = "net.minecraft.world.item.ItemStack"; + nmsNBTTagCompound = "net.minecraft.nbt.NBTTagCompound"; + nmsNBTCompressedStreamTools = "net.minecraft.nbt.NBTCompressedStreamTools"; + nmsDynamicOpsNBT = "net.minecraft.nbt.DynamicOpsNBT"; + nmsDataConverterTypes = "net.minecraft.util.datafix.fixes.DataConverterTypes"; + nmsDataConverterRegistry = "net.minecraft.util.datafix.DataConverterRegistry"; + } + // Time to load ALL the things! // NMS - Class itemStack = Class.forName(nms + "ItemStack"); - Class nbtCompressedStreamTools = Class.forName(nms + "NBTCompressedStreamTools"); - Class nbtTagCompound = Class.forName(nms + "NBTTagCompound"); + Class itemStack = Class.forName(nmsItemStack); + Class nbtCompressedStreamTools = Class.forName(nmsNBTCompressedStreamTools); + Class nbtTagCompound = Class.forName(nmsNBTTagCompound); nbtTagCompoundConstructor = nbtTagCompound.getConstructor(); try { itemStackFromCompound = itemStack.getMethod("fromCompound", nbtTagCompound); @@ -131,7 +149,7 @@ private static void init() { } } - Class dataConverterRegistry = Class.forName(nms + "DataConverterRegistry"); + Class dataConverterRegistry = Class.forName(nmsDataConverterRegistry); for (Field field : dataConverterRegistry.getDeclaredFields()) { if (dataFixer.isAssignableFrom(field.getType())) { field.setAccessible(true); @@ -142,8 +160,8 @@ private static void init() { if (dataConverterRegistryDataFixer == null) { throw new IllegalStateException("No sign of data fixer"); } - dataConverterTypesItemStack = Class.forName(nms + "DataConverterTypes").getField("ITEM_STACK").get(null); - dynamicOpsNBT = Class.forName(nms + "DynamicOpsNBT").getField("a").get(null); + dataConverterTypesItemStack = Class.forName(nmsDataConverterTypes).getField("ITEM_STACK").get(null); + dynamicOpsNBT = Class.forName(nmsDynamicOpsNBT).getField("a").get(null); Class dynamicClass = dataFixerUpdate.getParameterTypes()[1]; for (Constructor constructor : dynamicClass.getConstructors()) { if (constructor.getParameterCount() == 2) { From f7d34250e0f09917c0278572fb0fbf1404458a21 Mon Sep 17 00:00:00 2001 From: mbax Date: Fri, 11 Jun 2021 23:01:03 -0400 Subject: [PATCH 05/11] Meow meow meow --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index a59328b..745ed5b 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ org.kitteh cardboardbox - 0.2.0-SNAPSHOT + 0.2.0 jar Cardboard Box From a5d43463647686279f58893ea44a9dfe154439e1 Mon Sep 17 00:00:00 2001 From: mbax Date: Fri, 11 Jun 2021 23:31:03 -0400 Subject: [PATCH 06/11] Update readme oops --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0eb70bd..2cbd538 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,6 @@ Using org.kitteh cardboardbox - 0.1.0 + 0.2.0 ``` \ No newline at end of file From 18953d82d68fcb94eb084421c0eb56e7157f3092 Mon Sep 17 00:00:00 2001 From: mbax Date: Thu, 8 Jul 2021 16:18:08 -0400 Subject: [PATCH 07/11] Fix DFU mistake for 1.17 --- LICENSE_FILE_HEADER | 2 +- pom.xml | 12 +++++++++++- .../java/org/kitteh/cardboardbox/CardboardBox.java | 9 +++++++-- 3 files changed, 19 insertions(+), 4 deletions(-) diff --git a/LICENSE_FILE_HEADER b/LICENSE_FILE_HEADER index e65ab4d..9df0599 100644 --- a/LICENSE_FILE_HEADER +++ b/LICENSE_FILE_HEADER @@ -1,5 +1,5 @@ Cardboard Box -Copyright (C) 2020 Matt Baxter +Copyright (C) 2020-2021 Matt Baxter 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 diff --git a/pom.xml b/pom.xml index 745ed5b..a34003c 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ org.kitteh cardboardbox - 0.2.0 + 0.2.1 jar Cardboard Box @@ -54,6 +54,10 @@ papermc https://papermc.io/repo/repository/maven-public/ + + mojang + https://libraries.minecraft.net + @@ -63,6 +67,12 @@ 1.16.5-R0.1-SNAPSHOT provided + + com.mojang + datafixerupper + 1.0.20 + provided + diff --git a/src/main/java/org/kitteh/cardboardbox/CardboardBox.java b/src/main/java/org/kitteh/cardboardbox/CardboardBox.java index 414cf62..31eb628 100644 --- a/src/main/java/org/kitteh/cardboardbox/CardboardBox.java +++ b/src/main/java/org/kitteh/cardboardbox/CardboardBox.java @@ -1,6 +1,6 @@ /* * Cardboard Box - * Copyright (C) 2020 Matt Baxter + * Copyright (C) 2020-2021 Matt Baxter * * 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 @@ -17,6 +17,7 @@ */ package org.kitteh.cardboardbox; +import com.mojang.datafixers.DSL; import org.bukkit.Bukkit; import org.bukkit.Material; import org.bukkit.inventory.ItemStack; @@ -160,7 +161,11 @@ private static void init() { if (dataConverterRegistryDataFixer == null) { throw new IllegalStateException("No sign of data fixer"); } - dataConverterTypesItemStack = Class.forName(nmsDataConverterTypes).getField("ITEM_STACK").get(null); + if (ver < 17) { + dataConverterTypesItemStack = Class.forName(nmsDataConverterTypes).getField("ITEM_STACK").get(null); + } else { + dataConverterTypesItemStack = (DSL.TypeReference) () -> "item_stack"; + } dynamicOpsNBT = Class.forName(nmsDynamicOpsNBT).getField("a").get(null); Class dynamicClass = dataFixerUpdate.getParameterTypes()[1]; for (Constructor constructor : dynamicClass.getConstructors()) { From 40e34b158dc7689d952fccf245ac79c3acac30f5 Mon Sep 17 00:00:00 2001 From: mbax Date: Tue, 27 Jul 2021 13:51:42 -0400 Subject: [PATCH 08/11] Forgot to write newer version on readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2cbd538..b55a3ca 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,6 @@ Using org.kitteh cardboardbox - 0.2.0 + 0.2.1 ``` \ No newline at end of file From 112277413115192e6d50e729c8f57b2faac85167 Mon Sep 17 00:00:00 2001 From: mbax Date: Sat, 27 Nov 2021 16:02:04 -0500 Subject: [PATCH 09/11] Update for Spigot 1.18 (already works Paper) --- README.md | 2 +- pom.xml | 2 +- src/main/java/org/kitteh/cardboardbox/CardboardBox.java | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b55a3ca..f645fc7 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,6 @@ Using org.kitteh cardboardbox - 0.2.1 + 0.2.2 ``` \ No newline at end of file diff --git a/pom.xml b/pom.xml index a34003c..08ed458 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ org.kitteh cardboardbox - 0.2.1 + 0.2.2 jar Cardboard Box diff --git a/src/main/java/org/kitteh/cardboardbox/CardboardBox.java b/src/main/java/org/kitteh/cardboardbox/CardboardBox.java index 31eb628..5a63f49 100644 --- a/src/main/java/org/kitteh/cardboardbox/CardboardBox.java +++ b/src/main/java/org/kitteh/cardboardbox/CardboardBox.java @@ -123,11 +123,11 @@ private static void init() { } } } - itemStackSave = itemStack.getMethod("save", nbtTagCompound); + itemStackSave = itemStack.getMethod(ver >= 18 ? "b" : "save", nbtTagCompound); nbtCompressedStreamToolsRead = nbtCompressedStreamTools.getMethod("a", InputStream.class); nbtCompressedStreamToolsWrite = nbtCompressedStreamTools.getMethod("a", nbtTagCompound, OutputStream.class); - nbtTagCompoundGetInt = nbtTagCompound.getMethod("getInt", String.class); - nbtTagCompoundSetInt = nbtTagCompound.getMethod("setInt", String.class, int.class); + nbtTagCompoundGetInt = nbtTagCompound.getMethod(ver >= 18 ? "h" : "getInt", String.class); + nbtTagCompoundSetInt = nbtTagCompound.getMethod(ver >= 18 ? "a" : "setInt", String.class, int.class); // OBC craftItemStack = Class.forName(obc + "inventory.CraftItemStack"); From 5d83d8f7f814814d05f467ea1bb8f1dcd7cc2721 Mon Sep 17 00:00:00 2001 From: mbax Date: Sat, 6 Jan 2024 20:33:22 -0500 Subject: [PATCH 10/11] 1.20.4 support --- pom.xml | 2 +- .../org/kitteh/cardboardbox/CardboardBox.java | 39 +++++++++++++++---- 2 files changed, 32 insertions(+), 9 deletions(-) diff --git a/pom.xml b/pom.xml index 08ed458..3efa175 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ org.kitteh cardboardbox - 0.2.2 + 1.0.0 jar Cardboard Box diff --git a/src/main/java/org/kitteh/cardboardbox/CardboardBox.java b/src/main/java/org/kitteh/cardboardbox/CardboardBox.java index 5a63f49..4dbbecc 100644 --- a/src/main/java/org/kitteh/cardboardbox/CardboardBox.java +++ b/src/main/java/org/kitteh/cardboardbox/CardboardBox.java @@ -30,6 +30,8 @@ import java.lang.reflect.Field; import java.lang.reflect.Method; import java.util.Base64; +import java.util.regex.Matcher; +import java.util.regex.Pattern; @SuppressWarnings("UnqualifiedStaticUsage") public class CardboardBox { @@ -42,6 +44,7 @@ public class CardboardBox { private static Method nbtTagCompoundGetInt; private static Method nbtTagCompoundSetInt; private static Method dataFixerUpdate; + private static Method nbtAccounterUnlimitedHeap; private static Constructor dynamic; private static Constructor nbtTagCompoundConstructor; private static Constructor itemStackConstructor; @@ -78,14 +81,23 @@ private static void init() { } catch (Exception ignored) { } try { + Pattern versionPattern = Pattern.compile("1\\.(\\d{1,2})(?:\\.(\\d{1,2}))?"); + Matcher versionMatcher = versionPattern.matcher(Bukkit.getVersion()); + if (!versionMatcher.find()) { + throw new RuntimeException("Could not parse version"); + } + int minor = Integer.parseInt(versionMatcher.group(1)); + String patchS = versionMatcher.group(2); + int patch = (patchS == null || patchS.isEmpty()) ? 0 : Integer.parseInt(patchS); + int ver = (minor * 100) + patch; String[] packageSplit = Bukkit.getServer().getClass().getPackage().getName().split("\\."); String packageVersion = packageSplit[packageSplit.length - 1] + '.'; - int ver = Integer.parseInt(packageVersion.split("_")[1]); String obc = "org.bukkit.craftbukkit." + packageVersion; String nmsItemStack, nmsNBTCompressedStreamTools, nmsNBTTagCompound, nmsDynamicOpsNBT, nmsDataConverterTypes, nmsDataConverterRegistry; + String nmsNBTReadLimiter = "net.minecraft.nbt.NBTReadLimiter"; - if (ver < 17) { + if (ver < 1700) { String nms = "net.minecraft.server." + packageVersion; nmsItemStack = nms + "ItemStack"; nmsNBTTagCompound = nms + "NBTTagCompound"; @@ -123,11 +135,17 @@ private static void init() { } } } - itemStackSave = itemStack.getMethod(ver >= 18 ? "b" : "save", nbtTagCompound); - nbtCompressedStreamToolsRead = nbtCompressedStreamTools.getMethod("a", InputStream.class); + itemStackSave = itemStack.getMethod(ver >= 1800 ? "b" : "save", nbtTagCompound); + if (ver < 2004) { + nbtCompressedStreamToolsRead = nbtCompressedStreamTools.getMethod("a", InputStream.class); + } else { + Class nbtAccounter = Class.forName(nmsNBTReadLimiter); + nbtCompressedStreamToolsRead = nbtCompressedStreamTools.getMethod("a", InputStream.class, nbtAccounter); + nbtAccounterUnlimitedHeap = nbtAccounter.getMethod("a"); + } nbtCompressedStreamToolsWrite = nbtCompressedStreamTools.getMethod("a", nbtTagCompound, OutputStream.class); - nbtTagCompoundGetInt = nbtTagCompound.getMethod(ver >= 18 ? "h" : "getInt", String.class); - nbtTagCompoundSetInt = nbtTagCompound.getMethod(ver >= 18 ? "a" : "setInt", String.class, int.class); + nbtTagCompoundGetInt = nbtTagCompound.getMethod(ver >= 1800 ? "h" : "getInt", String.class); + nbtTagCompoundSetInt = nbtTagCompound.getMethod(ver >= 1800 ? "a" : "setInt", String.class, int.class); // OBC craftItemStack = Class.forName(obc + "inventory.CraftItemStack"); @@ -161,7 +179,7 @@ private static void init() { if (dataConverterRegistryDataFixer == null) { throw new IllegalStateException("No sign of data fixer"); } - if (ver < 17) { + if (ver < 1700) { dataConverterTypesItemStack = Class.forName(nmsDataConverterTypes).getField("ITEM_STACK").get(null); } else { dataConverterTypesItemStack = (DSL.TypeReference) () -> "item_stack"; @@ -281,7 +299,12 @@ public static ItemStack deserializeItem(byte[] data) { return ItemStack.deserializeBytes(data); } try { - Object compound = nbtCompressedStreamToolsRead.invoke(null, new ByteArrayInputStream(data)); + Object compound; + if (nbtAccounterUnlimitedHeap == null) { + compound = nbtCompressedStreamToolsRead.invoke(null, new ByteArrayInputStream(data)); + } else { + compound = nbtCompressedStreamToolsRead.invoke(null, new ByteArrayInputStream(data), nbtAccounterUnlimitedHeap.invoke(null)); + } if (hasDataVersion) { int version = (int) nbtTagCompoundGetInt.invoke(compound, "DataVersion"); From f96b9e8c8d8ea50d076990d04a756270d9809486 Mon Sep 17 00:00:00 2001 From: mbax Date: Sat, 13 Jan 2024 15:14:50 -0500 Subject: [PATCH 11/11] More 1.0.0 updating --- LICENSE_FILE_HEADER | 2 +- README.md | 6 +- pom.xml | 70 +++++++++---------- .../org/kitteh/cardboardbox/CardboardBox.java | 5 +- 4 files changed, 42 insertions(+), 41 deletions(-) diff --git a/LICENSE_FILE_HEADER b/LICENSE_FILE_HEADER index 9df0599..25f7f9b 100644 --- a/LICENSE_FILE_HEADER +++ b/LICENSE_FILE_HEADER @@ -1,5 +1,5 @@ Cardboard Box -Copyright (C) 2020-2021 Matt Baxter +Copyright (C) 2020-2024 Matt Baxter 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 diff --git a/README.md b/README.md index f645fc7..1ded41e 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,8 @@ Using ```xml - jitpack.io - https://jitpack.io + dependency.download + https://dependency.download/repository/public/ ``` @@ -31,6 +31,6 @@ Using org.kitteh cardboardbox - 0.2.2 + 1.0.0 ``` \ No newline at end of file diff --git a/pom.xml b/pom.xml index 3efa175..40f3330 100644 --- a/pom.xml +++ b/pom.xml @@ -75,6 +75,13 @@ + + + dependency.download + https://dependency.download/repository/maven-releases/ + + + @@ -161,41 +168,32 @@ + + maven-deploy-plugin + 3.1.1 + + true + + + + org.sonatype.plugins + nexus-staging-maven-plugin + 1.6.13 + + + default-deploy + deploy + + deploy + + + + + dependency.download + https://dependency.download/ + true + + - - - - release - - - - org.apache.maven.plugins - maven-gpg-plugin - 1.6 - - - sign-artifacts - verify - - sign - - - - - - org.sonatype.plugins - nexus-staging-maven-plugin - 1.6.8 - true - - ossrh - https://oss.sonatype.org/ - true - - - - - - - \ No newline at end of file + diff --git a/src/main/java/org/kitteh/cardboardbox/CardboardBox.java b/src/main/java/org/kitteh/cardboardbox/CardboardBox.java index 4dbbecc..6f54abb 100644 --- a/src/main/java/org/kitteh/cardboardbox/CardboardBox.java +++ b/src/main/java/org/kitteh/cardboardbox/CardboardBox.java @@ -1,6 +1,6 @@ /* * Cardboard Box - * Copyright (C) 2020-2021 Matt Baxter + * Copyright (C) 2020-2024 Matt Baxter * * 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 @@ -33,6 +33,9 @@ import java.util.regex.Matcher; import java.util.regex.Pattern; +/** + * Cardboard Box! + */ @SuppressWarnings("UnqualifiedStaticUsage") public class CardboardBox { private static final int OLD_DATA_VERSION = 1343;