diff --git a/.gitignore b/.gitignore index b63da45..bf3e1b2 100644 --- a/.gitignore +++ b/.gitignore @@ -39,4 +39,5 @@ bin/ .vscode/ ### Mac OS ### -.DS_Store \ No newline at end of file +.DS_Store +/.idea/ diff --git a/.idea/misc.xml b/.idea/misc.xml index 6680db9..cc57d5f 100644 --- a/.idea/misc.xml +++ b/.idea/misc.xml @@ -1,5 +1,10 @@ + + + + + diff --git a/.idea/workspace.xml b/.idea/workspace.xml index 824b297..3622bac 100644 --- a/.idea/workspace.xml +++ b/.idea/workspace.xml @@ -4,7 +4,17 @@ - + + + + + + + + + + + + + + + + @@ -28,9 +48,50 @@ "keyToString": { "RunOnceActivity.OpenProjectViewOnStart": "true", "RunOnceActivity.ShowReadmeOnStart": "true", - "WebServerToolWindowFactoryState": "false" + "WebServerToolWindowFactoryState": "false", + "project.structure.last.edited": "Modules", + "project.structure.proportion": "0.0", + "project.structure.side.proportion": "0.0" } }]]> + + + + + + + true + true + false + + + + + + + + + + + @@ -39,7 +100,26 @@ + + + + + + + + \ No newline at end of file diff --git a/LICENSE b/LICENSE index e69de29..261eeb9 100644 --- a/LICENSE +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index e69de29..13ece6b 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,7 @@ +# HSLDataConverter +A simple library to convert serialized legacy HuskSync (v1.x) data into Spigot API data. + +This library is only for use in upgrading or converting HuskSync v1.x data in a portable manner and is utilised in HuskSync v2.x for data migration. + +## Building +To build, simply run `./gradlew clean build` in the source root. Legacy HuskSync serialized classes are bundled and this resource does not depend on the HuskSync plugin itself. \ No newline at end of file diff --git a/build.gradle b/build.gradle index 3cae2d7..e6690ec 100644 --- a/build.gradle +++ b/build.gradle @@ -1,17 +1,32 @@ plugins { id 'java' + id 'maven-publish' } -group 'org.example' -version '1.0-SNAPSHOT' +group 'net.william278' +version '1.0' repositories { mavenCentral() + mavenLocal() + + maven { url 'https://hub.spigotmc.org/nexus/content/repositories/snapshots/' } } dependencies { - testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.1' - testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.1' + compileOnly 'org.spigotmc:spigot-api:1.16.5-R0.1-SNAPSHOT' + compileOnly 'org.jetbrains:annotations:23.0.0' + + testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.2' + testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.2' +} + +publishing { + publications { + gpr(MavenPublication) { + from(components.java) + } + } } test { diff --git a/settings.gradle b/settings.gradle index 915b42e..09c103c 100644 --- a/settings.gradle +++ b/settings.gradle @@ -1,2 +1,2 @@ -rootProject.name = 'HSLMigrator' +rootProject.name = 'hsldataconverter' diff --git a/src/main/java/me/william278/husksync/bukkit/data/DataSerializer.java b/src/main/java/me/william278/husksync/bukkit/data/DataSerializer.java index 5817f6e..b8fb5ef 100644 --- a/src/main/java/me/william278/husksync/bukkit/data/DataSerializer.java +++ b/src/main/java/me/william278/husksync/bukkit/data/DataSerializer.java @@ -1,4 +1,4 @@ -package me.william278.husksync.data; +package me.william278.husksync.bukkit.data; import org.bukkit.Material; import org.bukkit.Statistic; diff --git a/src/main/java/net/william278/hslmigrator/HSLConverter.java b/src/main/java/net/william278/hslmigrator/HSLConverter.java index a192a49..ba1002c 100644 --- a/src/main/java/net/william278/hslmigrator/HSLConverter.java +++ b/src/main/java/net/william278/hslmigrator/HSLConverter.java @@ -1,2 +1,123 @@ -package net.william278.hslmigrator;public class HSLConverter { +package net.william278.hslmigrator; + +import me.william278.husksync.bukkit.data.DataSerializer; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.io.ObjectInputStream; +import java.util.ArrayList; +import java.util.Base64; +import java.util.HashMap; +import java.util.List; + + +/** + * Class used for converting legacy HuskSync data to Bukkit data + */ +@SuppressWarnings("unused") +public class HSLConverter { + + private static HSLConverter instance; + + private HSLConverter() { + } + + /** + * Returns an instance of the {@link HSLConverter} + * + * @return {@link HSLConverter} instance + */ + @NotNull + public static HSLConverter getInstance() { + if (instance == null) { + instance = new HSLConverter(); + } + return instance; + } + + /** + * Deserializes a player's location data from a string into a {@link DataSerializer.PlayerLocation} + * + * @param serializedLocationData String containing the player's location data + * @return {@link DataSerializer.PlayerLocation} containing the player's location data + * @throws IOException If the string is not a valid Base64 encoded player location string + */ + @Nullable + public DataSerializer.PlayerLocation deserializePlayerLocationData(@NotNull String serializedLocationData) + throws IOException { + if (serializedLocationData.isEmpty()) { + return null; + } + try { + return (DataSerializer.PlayerLocation) deserialize(serializedLocationData); + } catch (ClassNotFoundException e) { + throw new IOException("Unable to decode class type.", e); + } + } + + /** + * Deserializes a player's advancement data into {@link DataSerializer.AdvancementRecordDate} data. + * + * @param serializedAdvancementData The serialized advancement data {@link String} + * @return The deserialized {@link DataSerializer.AdvancementRecordDate} for the player + * @throws IOException If the deserialization fails + */ + @SuppressWarnings({"unchecked", "deprecation"}) // Ignore the unchecked cast here + @NotNull + public List deserializeAdvancementData( + @NotNull String serializedAdvancementData) throws IOException { + if (serializedAdvancementData.isEmpty()) { + return new ArrayList<>(); + } + try { + List deserialize = (List) deserialize(serializedAdvancementData); + + // Migrate old AdvancementRecord into date format + if (!deserialize.isEmpty() && deserialize.get(0) instanceof DataSerializer.AdvancementRecord) { + deserialize = ((List) deserialize).stream() + .map(o -> new DataSerializer.AdvancementRecordDate( + o.advancementKey(), + o.awardedAdvancementCriteria() + )).toList(); + } + + return (List) deserialize; + } catch (ClassNotFoundException e) { + throw new IOException("Unable to decode class type.", e); + } + } + + /** + * Deserializes a player's statistic data as serialized into {@link DataSerializer.StatisticData}. + * + * @param serializedStatisticData The serialized statistic data {@link String} + * @return The deserialized {@link DataSerializer.StatisticData} for the player + * @throws IOException If the deserialization fails + */ + @NotNull + public DataSerializer.StatisticData deserializeStatisticData(@NotNull String serializedStatisticData) + throws IOException { + if (serializedStatisticData.isEmpty()) { + return new DataSerializer.StatisticData(new HashMap<>(), new HashMap<>(), new HashMap<>(), new HashMap<>()); + } + try { + return (DataSerializer.StatisticData) deserialize(serializedStatisticData); + } catch (ClassNotFoundException e) { + throw new IOException("Unable to decode class type.", e); + } + } + + /** + * Deserialize an object from a Base64 string + */ + @NotNull + private Object deserialize(@NotNull String serializedString) throws IOException, ClassNotFoundException { + byte[] data = Base64.getDecoder().decode(serializedString); + try (ObjectInputStream objectInputStream = new ObjectInputStream(new ByteArrayInputStream(data))) { + return objectInputStream.readObject(); + } + } + }