From 1a056d2d132162407da603dc64abbf18b7f60fba Mon Sep 17 00:00:00 2001 From: KingRainbow44 Date: Fri, 22 Apr 2022 20:42:55 -0400 Subject: [PATCH 1/7] Move manifest to resources --- src/main/{java => resources}/META-INF/MANIFEST.MF | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename src/main/{java => resources}/META-INF/MANIFEST.MF (100%) diff --git a/src/main/java/META-INF/MANIFEST.MF b/src/main/resources/META-INF/MANIFEST.MF similarity index 100% rename from src/main/java/META-INF/MANIFEST.MF rename to src/main/resources/META-INF/MANIFEST.MF From e3d6b86dd9d38a90772a2c8f88aaa315cf478edb Mon Sep 17 00:00:00 2001 From: KingRainbow44 Date: Fri, 22 Apr 2022 21:45:44 -0400 Subject: [PATCH 2/7] Basic plugin manager --- src/main/java/emu/grasscutter/Config.java | 3 +- .../java/emu/grasscutter/Grasscutter.java | 11 +- .../java/emu/grasscutter/plugin/Plugin.java | 71 ++++++++++++ .../emu/grasscutter/plugin/PluginConfig.java | 18 ++++ .../grasscutter/plugin/PluginIdentifier.java | 29 +++++ .../emu/grasscutter/plugin/PluginManager.java | 102 ++++++++++++++++++ .../java/emu/grasscutter/utils/Utils.java | 9 ++ 7 files changed, 239 insertions(+), 4 deletions(-) create mode 100644 src/main/java/emu/grasscutter/plugin/Plugin.java create mode 100644 src/main/java/emu/grasscutter/plugin/PluginConfig.java create mode 100644 src/main/java/emu/grasscutter/plugin/PluginIdentifier.java create mode 100644 src/main/java/emu/grasscutter/plugin/PluginManager.java diff --git a/src/main/java/emu/grasscutter/Config.java b/src/main/java/emu/grasscutter/Config.java index 4a6f71680..7da51f912 100644 --- a/src/main/java/emu/grasscutter/Config.java +++ b/src/main/java/emu/grasscutter/Config.java @@ -1,7 +1,5 @@ package emu.grasscutter; -import java.util.ArrayList; - public final class Config { public String DatabaseUrl = "mongodb://localhost:27017"; @@ -12,6 +10,7 @@ public final class Config { public String PACKETS_FOLDER = "./packets/"; public String DUMPS_FOLDER = "./dumps/"; public String KEY_FOLDER = "./keys/"; + public String PLUGINS_FOLDER = "./plugins/"; public String RunMode = "HYBRID"; // HYBRID, DISPATCH_ONLY, GAME_ONLY public GameServerOptions GameServer = new GameServerOptions(); diff --git a/src/main/java/emu/grasscutter/Grasscutter.java b/src/main/java/emu/grasscutter/Grasscutter.java index abcdc3557..de7025b12 100644 --- a/src/main/java/emu/grasscutter/Grasscutter.java +++ b/src/main/java/emu/grasscutter/Grasscutter.java @@ -8,6 +8,7 @@ import java.io.InputStreamReader; import java.net.InetSocketAddress; import emu.grasscutter.command.CommandMap; +import emu.grasscutter.plugin.PluginManager; import emu.grasscutter.utils.Utils; import org.reflections.Reflections; import org.slf4j.LoggerFactory; @@ -35,6 +36,7 @@ public final class Grasscutter { private static GameServer gameServer; public static final Reflections reflector = new Reflections(); + public static final PluginManager pluginManager; static { // Declare logback configuration. @@ -45,6 +47,9 @@ public final class Grasscutter { // Check server structure. Utils.startupCheck(); + + // Call plugin manager. + pluginManager = new PluginManager(); } public static void main(String[] args) throws Exception { @@ -91,8 +96,6 @@ public final class Grasscutter { getLogger().error("Shutting down..."); System.exit(1); } - - // Open console. startConsole(); @@ -161,4 +164,8 @@ public final class Grasscutter { public static GameServer getGameServer() { return gameServer; } + + public static PluginManager getPluginManager() { + return pluginManager; + } } diff --git a/src/main/java/emu/grasscutter/plugin/Plugin.java b/src/main/java/emu/grasscutter/plugin/Plugin.java new file mode 100644 index 000000000..145a06eb8 --- /dev/null +++ b/src/main/java/emu/grasscutter/plugin/Plugin.java @@ -0,0 +1,71 @@ +package emu.grasscutter.plugin; + +import emu.grasscutter.Grasscutter; +import emu.grasscutter.server.game.GameServer; + +/** + * The base class for all plugins to extend. + */ +public abstract class Plugin { + private final PluginIdentifier identifier; + + /** + * Empty constructor for developers. + * Should not be called by users. + */ + public Plugin() { + this(new PluginIdentifier("", "", "", new String[]{})); + } + + /** + * Constructor for plugins. + * @param identifier The plugin's identifier. + */ + public Plugin(PluginIdentifier identifier) { + this.identifier = identifier; + } + + /** + * The plugin's identifier instance. + * @return An instance of {@link PluginIdentifier}. + */ + public final PluginIdentifier getIdentifier(){ + return this.identifier; + } + + /** + * Get the plugin's name. + */ + public final String getName() { + return this.identifier.name; + } + + /** + * Get the plugin's description. + */ + public final String getDescription() { + return this.identifier.description; + } + + /** + * Get the plugin's version. + */ + public final String getVersion() { + return this.identifier.version; + } + + /** + * Returns the server that initialized the plugin. + * @return A server instance. + */ + public final GameServer getServer() { + return Grasscutter.getGameServer(); + } + + /* Called when the plugin is first loaded. */ + public void onLoad() { } + /* Called after (most of) the server enables. */ + public void onEnable() { } + /* Called before the server disables. */ + public void onDisable() { } +} diff --git a/src/main/java/emu/grasscutter/plugin/PluginConfig.java b/src/main/java/emu/grasscutter/plugin/PluginConfig.java new file mode 100644 index 000000000..0fb07037c --- /dev/null +++ b/src/main/java/emu/grasscutter/plugin/PluginConfig.java @@ -0,0 +1,18 @@ +package emu.grasscutter.plugin; + +/** + * The data contained in the plugin's `plugin.json` file. + */ +public final class PluginConfig { + public String name, description, version; + public String mainClass; + public String[] authors; + + /** + * Attempts to validate this config instance. + * @return True if the config is valid, false otherwise. + */ + public boolean validate() { + return name != null && description != null && mainClass != null; + } +} diff --git a/src/main/java/emu/grasscutter/plugin/PluginIdentifier.java b/src/main/java/emu/grasscutter/plugin/PluginIdentifier.java new file mode 100644 index 000000000..a467e3949 --- /dev/null +++ b/src/main/java/emu/grasscutter/plugin/PluginIdentifier.java @@ -0,0 +1,29 @@ +package emu.grasscutter.plugin; + +// TODO: Potentially replace with Lombok? +public final class PluginIdentifier { + public final String name, description, version; + public final String[] authors; + + public PluginIdentifier( + String name, String description, String version, + String[] authors + ) { + this.name = name; + this.description = description; + this.version = version; + this.authors = authors; + } + + /** + * Converts a {@link PluginConfig} into a {@link PluginIdentifier}. + */ + public static PluginIdentifier fromPluginConfig(PluginConfig config) { + if(!config.validate()) + throw new IllegalArgumentException("A valid plugin config is required to convert into a plugin identifier."); + return new PluginIdentifier( + config.name, config.description, config.version, + config.authors + ); + } +} diff --git a/src/main/java/emu/grasscutter/plugin/PluginManager.java b/src/main/java/emu/grasscutter/plugin/PluginManager.java new file mode 100644 index 000000000..3177bb291 --- /dev/null +++ b/src/main/java/emu/grasscutter/plugin/PluginManager.java @@ -0,0 +1,102 @@ +package emu.grasscutter.plugin; + +import emu.grasscutter.Grasscutter; +import emu.grasscutter.utils.Utils; + +import java.io.File; +import java.io.InputStreamReader; +import java.net.URL; +import java.net.URLClassLoader; +import java.util.Arrays; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; + +/** + * Manages the server's plugins & the event system. + */ +public final class PluginManager { + private final Map plugins = new HashMap<>(); + + public PluginManager() { + this.loadPlugins(); // Load all plugins from the plugins directory. + } + + /** + * Loads plugins from the config-specified directory. + */ + private void loadPlugins() { + String directory = Grasscutter.getConfig().PLUGINS_FOLDER; + File pluginsDir = new File(Utils.toFilePath(directory)); + if(!pluginsDir.exists() && !pluginsDir.mkdirs()) { + Grasscutter.getLogger().error("Failed to create plugins directory: " + pluginsDir.getAbsolutePath()); + return; + } + + File[] files = pluginsDir.listFiles(); + if(files == null) { + // The directory is empty, there aren't any plugins to load. + return; + } + + List plugins = Arrays.stream(files) + .filter(file -> file.getName().endsWith(".jar")) + .collect(Collectors.toList()); + + plugins.forEach(plugin -> { + try { + URL url = plugin.toURI().toURL(); + try (URLClassLoader loader = new URLClassLoader(new URL[]{url})) { + URL configFile = loader.findResource("plugin.json"); + InputStreamReader fileReader = new InputStreamReader(configFile.openStream()); + + PluginConfig pluginConfig = Grasscutter.getGsonFactory().fromJson(fileReader, PluginConfig.class); + if(!pluginConfig.validate()) { + Utils.logObject(pluginConfig); + Grasscutter.getLogger().warn("Plugin " + plugin.getName() + " has an invalid config file."); + return; + } + + Class pluginClass = loader.loadClass(pluginConfig.mainClass); + Plugin pluginInstance = (Plugin) pluginClass.getDeclaredConstructor(PluginIdentifier.class) + .newInstance(PluginIdentifier.fromPluginConfig(pluginConfig)); + this.loadPlugin(pluginInstance); + + fileReader.close(); // Close the file reader. + } catch (ClassNotFoundException ignored) { + Grasscutter.getLogger().warn("Plugin " + plugin.getName() + " has an invalid main class."); + } + } catch (Exception exception) { + Grasscutter.getLogger().error("Failed to load plugin: " + plugin.getName(), exception); + } + }); + } + + /** + * Load the specified plugin. + * @param plugin The plugin instance. + */ + private void loadPlugin(Plugin plugin) { + Grasscutter.getLogger().info("Loading plugin: " + plugin.getName()); + + // Add the plugin to the list of loaded plugins. + this.plugins.put(plugin.getName(), plugin); + // Call the plugin's onLoad method. + plugin.onLoad(); + } + + /** + * Enables all registered plugins. + */ + public void enablePlugins() { + + } + + /** + * Disables all registered plugins. + */ + public void disablePlugins() { + + } +} \ No newline at end of file diff --git a/src/main/java/emu/grasscutter/utils/Utils.java b/src/main/java/emu/grasscutter/utils/Utils.java index c481ffd07..5b7b8c439 100644 --- a/src/main/java/emu/grasscutter/utils/Utils.java +++ b/src/main/java/emu/grasscutter/utils/Utils.java @@ -137,6 +137,15 @@ public final class Utils { return nonNull != null ? nonNull : fallback; } + /** + * Logs an object to the console. + * @param object The object to log. + */ + public static void logObject(Object object) { + String asJson = Grasscutter.getGsonFactory().toJson(object); + Grasscutter.getLogger().info(asJson); + } + /** * Checks for required files and folders before startup. */ From 3ba8c42b428c37993d5772c6d33d9f0a7f73bbda Mon Sep 17 00:00:00 2001 From: KingRainbow44 Date: Sat, 23 Apr 2022 00:55:31 -0400 Subject: [PATCH 3/7] Merge `origin/development` into `plugin-system` --- README.md | 2 +- build.gradle | 11 +- keystore.p12 | Bin 2389 -> 2679 bytes src/main/java/emu/grasscutter/Config.java | 2 +- .../emu/grasscutter/command/CommandMap.java | 1 + .../command/commands/ClearWeaponsCommand.java | 29 +++++ .../grasscutter/database/DatabaseCounter.java | 2 +- .../grasscutter/database/DatabaseHelper.java | 117 +++++++----------- .../grasscutter/database/DatabaseManager.java | 54 ++++---- .../java/emu/grasscutter/game/Account.java | 30 ++--- .../emu/grasscutter/game/GenshinPlayer.java | 18 ++- .../java/emu/grasscutter/game/TeamInfo.java | 2 + .../emu/grasscutter/game/TeamManager.java | 2 + .../game/avatar/AvatarProfileData.java | 3 + .../game/avatar/GenshinAvatar.java | 2 +- .../grasscutter/game/friends/Friendship.java | 2 +- .../game/friends/PlayerProfile.java | 1 + .../game/gacha/PlayerGachaBannerInfo.java | 3 + .../game/gacha/PlayerGachaInfo.java | 3 + .../game/inventory/GenshinItem.java | 2 +- .../game/player/PlayerBirthday.java | 68 ++++++++++ .../grasscutter/net/packet/PacketOpcodes.java | 3 +- .../recv/HandleEvtAvatarSitDownNotify.java | 21 ++++ .../server/packet/recv/HandleSitReq.java | 24 ++++ .../recv/HandlerSetPlayerBirthdayReq.java | 38 ++++++ .../send/PacketEvtAvatarSitDownNotify.java | 20 +++ .../send/PacketSetPlayerBirthdayRsp.java | 20 +++ .../server/packet/send/PacketSitRsp.java | 21 ++++ .../java/emu/grasscutter/utils/Position.java | 2 + start.cmd | 4 + 30 files changed, 373 insertions(+), 134 deletions(-) create mode 100644 src/main/java/emu/grasscutter/command/commands/ClearWeaponsCommand.java create mode 100644 src/main/java/emu/grasscutter/game/player/PlayerBirthday.java create mode 100644 src/main/java/emu/grasscutter/server/packet/recv/HandleEvtAvatarSitDownNotify.java create mode 100644 src/main/java/emu/grasscutter/server/packet/recv/HandleSitReq.java create mode 100644 src/main/java/emu/grasscutter/server/packet/recv/HandlerSetPlayerBirthdayReq.java create mode 100644 src/main/java/emu/grasscutter/server/packet/send/PacketEvtAvatarSitDownNotify.java create mode 100644 src/main/java/emu/grasscutter/server/packet/send/PacketSetPlayerBirthdayRsp.java create mode 100644 src/main/java/emu/grasscutter/server/packet/send/PacketSitRsp.java diff --git a/README.md b/README.md index 853c37ae3..e6843b116 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ A WIP server reimplementation for *some anime game* 2.3-2.6 * If you update from an older version, delete `config.json` for regeneration ### Prerequisites -* JDK-8u202 ([mirror link](https://mirrors.huaweicloud.com/java/jdk/8u202-b08/) since Oracle required an account to download old builds) +* Java 16 * Mongodb (recommended 4.0+) * Proxy daemon: mitmproxy (mitmdump, recommended), Fiddler Classic, etc. diff --git a/build.gradle b/build.gradle index 97477456a..dcc109d0e 100644 --- a/build.gradle +++ b/build.gradle @@ -14,17 +14,16 @@ plugins { id 'application' } -sourceCompatibility = 1.8 -targetCompatibility = 1.8 +sourceCompatibility = 16 +targetCompatibility = 16 repositories { mavenCentral() - jcenter() } dependencies { implementation fileTree(dir: 'lib', include: ['*.jar']) - + implementation group: 'org.slf4j', name: 'slf4j-api', version: '1.7.32' implementation group: 'ch.qos.logback', name: 'logback-core', version: '1.2.6' implementation group: 'ch.qos.logback', name: 'logback-classic', version: '1.2.6' @@ -33,9 +32,9 @@ dependencies { implementation group: 'com.google.code.gson', name: 'gson', version: '2.8.8' implementation group: 'com.google.protobuf', name: 'protobuf-java', version: '3.18.1' - implementation group: 'org.reflections', name: 'reflections', version: '0.9.12' + implementation group: 'org.reflections', name: 'reflections', version: '0.10.2' - implementation group: 'dev.morphia.morphia', name: 'core', version: '1.6.1' + implementation group: 'dev.morphia.morphia', name: 'morphia-core', version: '2.2.6' implementation group: 'org.greenrobot', name: 'eventbus-java', version: '3.3.1' } diff --git a/keystore.p12 b/keystore.p12 index 9fa5cf19c6611eeada69c4d18df372578eef4845..5ea492e292dce655be2b7b8adaca0293427000d7 100644 GIT binary patch literal 2679 zcmY+Ec{~#i1BW+eGOHY;$V84}er!zS7CCa{m^l`)*vLIc%27tHTp>s9m}8FILe5-K z44EUzeI+4s#`}5S&-?y><01w|zV|f-h0~ymfR4v^%9hs zz}xV!ipWK3n>U`8e^6X8dmCniTUTQj%;lw1NECa)o%;4vtIIe@8SGu?wNBazK~_;J z+_AW@wnQirY03ggUK#iZ($%rsr(3sulHYbl1tBAz@`y8i#M-n>IftYrMb(^vZ1*is zStmV;XA06$oLausFWu=A;%_r@$d6fdf2@!Qd34&0;qNJT8L&@dDS3TW9n^%4hhDWc z>bys2b1{EoZGL^zTuYo*-u#dh`XtfNng%dJ8_iEuRoKE(W&^*jLC5DCi;Mg}{}Hp= zxzAmkU=h7fqghiY*h|yL3R|n#N|dRVzdKw5qhQH3jWKxPHzP7c`Ow&=8I!dTA34Ve zc{2qje(6{%O9z|gd1hKb-~d6JFn0LEU6q2G zQ|D_)pls?z&QQU(QQ?27Z8Vi!sq=AS(QaEI3_2eO%HNG$HFQL#JR=9)jRXW4_+ z)h4&0=)Hi{3&Br1YeN{&(H;z8=ViLAFUIO%s#sx%3ubqgR9@c)gJrZeo}}6f={9cg zsXFaty-^AvXTQI#GKhJQyWEQA_Vvq$xE=jPp-pNLer2&xT{gcWCdViX>6@J+xT^-@ z+7G|04>J{jSuQ9Fmu1~1Y&24S>eAvyskfen6(1vbvm$Pm$0}!VhoVnvAKq5RJ>wO@8Q{elRIJYit=3MH1E;b-Q=#PIiox$UDGlp%l{~mc5SDYh~ImqJbAD=rPtC zqw_t zhJ!Zlm_|Q=_JcCGmvY1SFfyh&E|IB=aUGVuGcAvs)#t1M8^Fq4+^C-1Zxb8`8&c21 zbN)Mfa=I2wN}eEf_9h>8<~@l@!UU=&%z!)Ow~6E9(l`AOaH%%kSwu!qmWONc*V~i? zu|AFAchhq9*(aZ(xs6&4^_~qZpReKRJqYKp#c*BSiv-fE6TeOgK zHKm!R`XA?7Y8bsXq%(lqxkYy)mQP0U9eNAl6!zsY(#xHAE#BPWCo}tMsc{Q9RNvl> zZ-agNtExOZ7v(Tfy7Q{CN`XpT7(V@>p5K=KUwOOm*|$B6y((v3YeH+nnbfja_6AxGjgmp4kz`QP-x4!8hYWg#B!hw(fB+;J^!OhF{J-LY|6N=ith%ceDH5oC z#cbP7sQe3C}R>F4grrS2TKqB0(fpuJA-Q!uVu5gB6Wn$1`si~96 z#JxHx(T19@29ss;4m6qke8x#fSjK(ZqF<Y7(vE$9bbI_^2U zgPC>?jDH9}zVFwtD#-P$VWqpsa^B04GBwHk4tmD29!A*@I(=oXq`(h&gL%1Ig4Blq z>OJEykvmY1E9*I~JV%+ICFA?H>t3b9P)X_ma1$7U5f=tNWOjIVSVM$zf(%MJy^AbZ z?xzUFX;oL6O*_LMt`z+u2`oa+_D;Sp(qrqu9mc?Kcx+;>?y-5abDBaC9Yda|Ioadj zB}26g-w50va*rL#yD*{6Ehc3$@x_A)cWFSs6rjY{Ml^`K>3LE-Ee?{X4%W1$`lojmKU+ulQ|9LX5Vfh7^;*kb z*kRB=PJ`aRLJnW--?W?9UqbXvI-OTT_(Uttv|L-vCr*IvPxc4CP=KSV2QLNOwg*(O zueip&3JYXHS884Pw-^NAd|BQD`on&NCe8}`-=QOoLisfGk5$^nf#;Ec`lMEZ08h=j zpD}8pt&0)eTH8=6aF!)+BHJ)rkbbp6UZQ6^uKDNp+Ne(hT{|hfwM~2D*u`t>2_XED zlfPDSgMNH>Qr@K{W&^L#km$)JeSu?(o{Uzm)$tDo7p}LvyOc^)Lq0BO`yNcU_l=72 z^{_l9hW9VW+1(095=J9rM0n)TBv+K5F7aw9tPaty?73nbN}Kb5va4h$K(D(qa69~kT=os;pWX9%I2ft#Cy*v8qZoyt58*us5c ze7NSTn5@DtyvH|gu23t0(!!D%QKU6vr?QDyxC?r1j$<&6&2qtTn=8KNSMs zQl;Q2#SK{xt_ukuRgi*67BCay93ulS695GJuyr`kGk?u=$lEu>Sej>UJf@SIw bxuSh`5Rj#`v2-u(Z<%K%@Q+Wtm)X2E&L2AjxzQodyF-VwUB+yQbx^*$i9slqGJ*%`#w3H zLPM60W#mXqWnU}1ai5;&-h1x-`};iaf1ej1qii5xC_qLDaiJ6_CX{U+FalgkMj>Hj z6bvAvKmZxq{7>R4B}1P8WawiE_-A?ePXPmBT*hT2cJ+NBuDfbX_`L)Yora-Aw(^D! zVnJ_x(MhaW@$-qwS8H#t>|1W^CP%XJEl1#QGC5m2dlV=qJ2AhNUv4}mX}eM_pB2#((`KvL8C0OJEoWa zs+u5O#Zhr=OYdd(&q~%SyKjDUNXFHaUJql#%6~ca!E(EtVxXYehC?W+Ub5?3bJq_) zA)`C-d0kpU(zQ3T)r3azA$joD7%evxt$2MZ;l-L^=I!gnn{q2VKADBO%4KGt#VOC? zTtp+KtWw6ZBvtkcK(>HgC0+Uh^W)TFgzv2Us&Sl_d7Ych-A-+lGe(50EF&UdW9rqV z9ta^^UGJn;tIEF9?@Bb&1uF9^`l=Q^nn3p8SbdFr>#3 zl8ZhPYJGm0-T@&%NeoG2jqZ)_m=dM5tzM0&)}hGcrjVRF-#aQ=<^lCYTvfS$u+6{ZP zM|F+%%F6c*quk4D=;}hgVkcJ~A#L-lTs88Qwsl^;w5t>MXQt3E)`jqPLa52V9i2$e z5k@?}|N4~fpV~EfCWJ>M?Pep{xqQT9o`%zOS09<97HR#+Lh8a1>k{o~MbHRRjpa))D=xY+e5I*r%y&8Q=Tj?r*XUbFAO`Jg9Wn6(F zUr=GEp_PTO)mOt}r``qsGL+UX?MD3xYU>;O28nJXjb954ZSk}O58-N;Nq`L3{U4yE zWH=s1hARVPxB@_ipXNIDAFgOHq?8O>1<0_)|5FV8skp}3ep1^{-|wel7#Y@UHXM4f zcmrN(7?`+w0i5-wu)5UN+s0)nuf2ZDVQsL@DqTw;xI6Z@lDBeK;%*@=g-06EDub1# zQN*5nBX8})=d(z;B$YdGC-hxy&XCTGKx%E)F$K@ql?Kl>bH|$C~dYTiK zL&>R4F~U_IeNoDaf1vgtTE92~+VHgtVa$qGwOw4hm8$fmqQtM=9~oamk4?g#5oKK( z{Zn|m50Zk-_bLX>r3`km48sK`7Osd2*K%QMgQM22Zubw%*GS3ISe=5$5p~bM^$Vb- zfIWjBvKcE~2+p77L)Hhp34q_ySL3}DDe(EZc736K+gB^olO2!{&d2UB=@v$^tT?w5 zWn!r@Cw=g_XVSuE(D`wS=6I~L&Mzk|PCK4&8G2f3j`ylC#>|5I65@W3kn11uzvo05 zzx*Zpc;wF5DBjZ|_1amtnY;P4`N)QcKP1Wi-f2UM(x`z#{>*ew>P#U4-Cao@*dZiT zaW=EL*@w5CzOlYv-@vfOyRv!MWe%~EVGH6p4b|_yOUy9km*dZzZJ8w_+!mPHN0ExYTfui=F*LK>*{((etonVE zi;wOHbs`-9z*vP^fIhc`u0ZRsc#Rb8yt-^SSOL#OZ%UyzNsgh~mFBF__yUy4r=X9o zd+MWsz;_yMp5<2?-G2v*ny%iw)H|JUxuyC?dL{>}uxt(a@Yn1Uy?`i`r*>yW6JV7eYQlxzB#pK1WMf?g+YfVj=O zH4!R*jaHEXE^FK<$agZ2&GOw-l370-tbF##{?6r4$cqO-g-C=^aXj1lgUCm?}1OTU4jZ zIbDd>*cXkCi67S7M;fbcyuI%I* commands = new HashMap<>(); private final Map annotations = new HashMap<>(); + public CommandMap() { this(false); } diff --git a/src/main/java/emu/grasscutter/command/commands/ClearWeaponsCommand.java b/src/main/java/emu/grasscutter/command/commands/ClearWeaponsCommand.java new file mode 100644 index 000000000..8fab1768b --- /dev/null +++ b/src/main/java/emu/grasscutter/command/commands/ClearWeaponsCommand.java @@ -0,0 +1,29 @@ +package emu.grasscutter.command.commands; + +import emu.grasscutter.command.Command; +import emu.grasscutter.command.CommandHandler; +import emu.grasscutter.game.GenshinPlayer; +import emu.grasscutter.game.inventory.Inventory; +import emu.grasscutter.game.inventory.ItemType; + +import java.util.List; + +@Command(label = "clearweapons", usage = "clearweapons", + description = "Deletes all unequipped and unlocked weapons, including yellow rarity ones from your inventory", + aliases = {"clearwpns"}, permission = "player.clearweapons") +public final class ClearWeaponsCommand implements CommandHandler { + + @Override + public void execute(GenshinPlayer sender, List args) { + if (sender == null) { + CommandHandler.sendMessage(null, "Run this command in-game."); + return; // TODO: clear player's weapons from console or other players + } + + Inventory playerInventory = sender.getInventory(); + playerInventory.getItems().values().stream() + .filter(item -> item.getItemType() == ItemType.ITEM_WEAPON) + .filter(item -> !item.isLocked() && !item.isEquipped()) + .forEach(item -> playerInventory.removeItem(item, item.getCount())); + } +} diff --git a/src/main/java/emu/grasscutter/database/DatabaseCounter.java b/src/main/java/emu/grasscutter/database/DatabaseCounter.java index 37fa59d7c..a70fe518a 100644 --- a/src/main/java/emu/grasscutter/database/DatabaseCounter.java +++ b/src/main/java/emu/grasscutter/database/DatabaseCounter.java @@ -3,7 +3,7 @@ package emu.grasscutter.database; import dev.morphia.annotations.Entity; import dev.morphia.annotations.Id; -@Entity(value = "counters", noClassnameStored = true) +@Entity(value = "counters", useDiscriminator = false) public class DatabaseCounter { @Id private String id; diff --git a/src/main/java/emu/grasscutter/database/DatabaseHelper.java b/src/main/java/emu/grasscutter/database/DatabaseHelper.java index ed092e976..fc24b70e6 100644 --- a/src/main/java/emu/grasscutter/database/DatabaseHelper.java +++ b/src/main/java/emu/grasscutter/database/DatabaseHelper.java @@ -2,41 +2,33 @@ package emu.grasscutter.database; import java.util.List; -import com.mongodb.WriteResult; - -import dev.morphia.query.FindOptions; -import dev.morphia.query.Query; -import dev.morphia.query.internal.MorphiaCursor; +import com.mongodb.client.result.DeleteResult; +import dev.morphia.query.experimental.filters.Filters; import emu.grasscutter.GenshinConstants; -import emu.grasscutter.Grasscutter; import emu.grasscutter.game.Account; import emu.grasscutter.game.GenshinPlayer; import emu.grasscutter.game.avatar.GenshinAvatar; import emu.grasscutter.game.friends.Friendship; import emu.grasscutter.game.inventory.GenshinItem; -public class DatabaseHelper { - - protected static FindOptions FIND_ONE = new FindOptions().limit(1); - +public final class DatabaseHelper { public static Account createAccount(String username) { return createAccountWithId(username, 0); } - + public static Account createAccountWithId(String username, int reservedId) { // Unique names only Account exists = DatabaseHelper.getAccountByName(username); if (exists != null) { return null; } - + // Make sure there are no id collisions if (reservedId > 0) { // Cannot make account with the same uid as the server console if (reservedId == GenshinConstants.SERVER_CONSOLE_UID) { return null; } - exists = DatabaseHelper.getAccountByPlayerId(reservedId); if (exists != null) { return null; @@ -47,10 +39,10 @@ public class DatabaseHelper { Account account = new Account(); account.setUsername(username); account.setId(Integer.toString(DatabaseManager.getNextId(account))); - + if (reservedId > 0) { account.setPlayerId(reservedId); - } + } DatabaseHelper.saveAccount(account); return account; @@ -63,65 +55,52 @@ public class DatabaseHelper { if (exists != null) { return null; } - + // Account Account account = new Account(); account.setId(Integer.toString(DatabaseManager.getNextId(account))); account.setUsername(username); account.setPassword(password); - DatabaseHelper.saveAccount(account); + DatabaseHelper.saveAccount(account); return account; } public static void saveAccount(Account account) { DatabaseManager.getAccountDatastore().save(account); } - + public static Account getAccountByName(String username) { - MorphiaCursor cursor = DatabaseManager.getAccountDatastore().createQuery(Account.class).field("username").equalIgnoreCase(username).find(FIND_ONE); - if (!cursor.hasNext()) return null; - return cursor.next(); + return DatabaseManager.getDatastore().find(Account.class).filter(Filters.eq("username", username)).first(); } - + public static Account getAccountByToken(String token) { - if (token == null) return null; - MorphiaCursor cursor = DatabaseManager.getAccountDatastore().createQuery(Account.class).field("token").equal(token).find(FIND_ONE); - if (!cursor.hasNext()) return null; - return cursor.next(); + if(token == null) return null; + return DatabaseManager.getDatastore().find(Account.class).filter(Filters.eq("token", token)).first(); } - + public static Account getAccountById(String uid) { - MorphiaCursor cursor = DatabaseManager.getAccountDatastore().createQuery(Account.class).field("_id").equal(uid).find(FIND_ONE); - if (!cursor.hasNext()) return null; - return cursor.next(); + return DatabaseManager.getDatastore().find(Account.class).filter(Filters.eq("_id", uid)).first(); } - + public static Account getAccountByPlayerId(int playerId) { - MorphiaCursor cursor = DatabaseManager.getAccountDatastore().createQuery(Account.class).field("playerId").equal(playerId).find(FIND_ONE); - if (!cursor.hasNext()) return null; - return cursor.next(); + return DatabaseManager.getDatastore().find(Account.class).filter(Filters.eq("playerId", playerId)).first(); } - + public static boolean deleteAccount(String username) { - Query q = DatabaseManager.getAccountDatastore().createQuery(Account.class).field("username").equalIgnoreCase(username); - return DatabaseManager.getDatastore().findAndDelete(q) != null; + return DatabaseManager.getDatastore().find(Account.class).filter(Filters.eq("username", username)).delete().getDeletedCount() > 0; } - + public static GenshinPlayer getPlayerById(int id) { - Query query = DatabaseManager.getDatastore().createQuery(GenshinPlayer.class).field("_id").equal(id); - MorphiaCursor cursor = query.find(FIND_ONE); - if (!cursor.hasNext()) return null; - return cursor.next(); + return DatabaseManager.getDatastore().find(GenshinPlayer.class).filter(Filters.eq("_id", id)).first(); } - + public static boolean checkPlayerExists(int id) { - MorphiaCursor query = DatabaseManager.getDatastore().createQuery(GenshinPlayer.class).field("_id").equal(id).find(FIND_ONE); - return query.hasNext(); + return DatabaseManager.getDatastore().find(GenshinPlayer.class).filter(Filters.eq("_id", id)).first() != null; } - + public static synchronized GenshinPlayer createPlayer(GenshinPlayer character, int reservedId) { // Check if reserved id - int id = 0; + int id; if (reservedId > 0 && !checkPlayerExists(reservedId)) { id = reservedId; character.setUid(id); @@ -136,10 +115,10 @@ public class DatabaseHelper { DatabaseManager.getDatastore().save(character); return character; } - + public static synchronized int getNextPlayerId(int reservedId) { // Check if reserved id - int id = 0; + int id; if (reservedId > 0 && !checkPlayerExists(reservedId)) { id = reservedId; } else { @@ -150,41 +129,37 @@ public class DatabaseHelper { } return id; } - + public static void savePlayer(GenshinPlayer character) { DatabaseManager.getDatastore().save(character); } - + public static void saveAvatar(GenshinAvatar avatar) { DatabaseManager.getDatastore().save(avatar); } - + public static List getAvatars(GenshinPlayer player) { - Query query = DatabaseManager.getDatastore().createQuery(GenshinAvatar.class).filter("ownerId", player.getUid()); - return query.find().toList(); + return DatabaseManager.getDatastore().find(GenshinAvatar.class).filter(Filters.eq("ownerId", player.getUid())).stream().toList(); } - + public static void saveItem(GenshinItem item) { DatabaseManager.getDatastore().save(item); } - + public static boolean deleteItem(GenshinItem item) { - WriteResult result = DatabaseManager.getDatastore().delete(item); + DeleteResult result = DatabaseManager.getDatastore().delete(item); return result.wasAcknowledged(); } - + public static List getInventoryItems(GenshinPlayer player) { - Query query = DatabaseManager.getDatastore().createQuery(GenshinItem.class).filter("ownerId", player.getUid()); - return query.find().toList(); + return DatabaseManager.getDatastore().find(GenshinItem.class).filter(Filters.eq("ownerId", player.getUid())).stream().toList(); } public static List getFriends(GenshinPlayer player) { - Query query = DatabaseManager.getDatastore().createQuery(Friendship.class).filter("ownerId", player.getUid()); - return query.find().toList(); + return DatabaseManager.getDatastore().find(Friendship.class).filter(Filters.eq("ownerId", player.getUid())).stream().toList(); } - + public static List getReverseFriends(GenshinPlayer player) { - Query query = DatabaseManager.getDatastore().createQuery(Friendship.class).filter("friendId", player.getUid()); - return query.find().toList(); + return DatabaseManager.getDatastore().find(Friendship.class).filter(Filters.eq("friendId", player.getUid())).stream().toList(); } public static void saveFriendship(Friendship friendship) { @@ -196,13 +171,9 @@ public class DatabaseHelper { } public static Friendship getReverseFriendship(Friendship friendship) { - Query query = DatabaseManager.getDatastore().createQuery(Friendship.class); - query.and( - query.criteria("ownerId").equal(friendship.getFriendId()), - query.criteria("friendId").equal(friendship.getOwnerId()) - ); - MorphiaCursor reverseFriendship = query.find(FIND_ONE); - if (!reverseFriendship.hasNext()) return null; - return reverseFriendship.next(); + return DatabaseManager.getDatastore().find(Friendship.class).filter(Filters.and( + Filters.eq("ownerId", friendship.getFriendId()), + Filters.eq("friendId", friendship.getOwnerId()) + )).first(); } } diff --git a/src/main/java/emu/grasscutter/database/DatabaseManager.java b/src/main/java/emu/grasscutter/database/DatabaseManager.java index 46dad537d..9d64f9258 100644 --- a/src/main/java/emu/grasscutter/database/DatabaseManager.java +++ b/src/main/java/emu/grasscutter/database/DatabaseManager.java @@ -1,13 +1,16 @@ package emu.grasscutter.database; -import com.mongodb.MongoClient; import com.mongodb.MongoClientURI; import com.mongodb.MongoCommandException; +import com.mongodb.client.MongoClient; +import com.mongodb.client.MongoClients; import com.mongodb.client.MongoDatabase; import com.mongodb.client.MongoIterable; import dev.morphia.Datastore; import dev.morphia.Morphia; +import dev.morphia.mapping.MapperOptions; +import dev.morphia.query.experimental.filters.Filters; import emu.grasscutter.Grasscutter; import emu.grasscutter.game.Account; import emu.grasscutter.game.GenshinPlayer; @@ -16,6 +19,7 @@ import emu.grasscutter.game.friends.Friendship; import emu.grasscutter.game.inventory.GenshinItem; public final class DatabaseManager { + private static MongoClient mongoClient; private static MongoClient dispatchMongoClient; @@ -26,15 +30,11 @@ public final class DatabaseManager { DatabaseCounter.class, Account.class, GenshinPlayer.class, GenshinAvatar.class, GenshinItem.class, Friendship.class }; - public static MongoClient getMongoClient() { - return mongoClient; + public static Datastore getDatastore() { + return datastore; } - - public static Datastore getDatastore() { - return datastore; - } - - public static MongoDatabase getDatabase() { + + public static MongoDatabase getDatabase() { return getDatastore().getDatabase(); } @@ -50,27 +50,23 @@ public final class DatabaseManager { public static void initialize() { // Initialize - mongoClient = new MongoClient(new MongoClientURI(Grasscutter.getConfig().DatabaseUrl)); - Morphia morphia = new Morphia(); + MongoClient mongoClient = MongoClients.create(Grasscutter.getConfig().DatabaseUrl); - // TODO Update when migrating to Morphia 2.0 - morphia.getMapper().getOptions().setStoreEmpties(true); - morphia.getMapper().getOptions().setStoreNulls(false); - morphia.getMapper().getOptions().setDisableEmbeddedIndexes(true); - - // Map - morphia.map(mappedClasses); - - // Build datastore - datastore = morphia.createDatastore(mongoClient, Grasscutter.getConfig().DatabaseCollection); + // Set mapper options. + MapperOptions mapperOptions = MapperOptions.builder() + .storeEmpties(true).storeNulls(false).build(); + // Create data store. + datastore = Morphia.createDatastore(mongoClient, Grasscutter.getConfig().DatabaseCollection, mapperOptions); + // Map classes. + datastore.getMapper().map(mappedClasses); // Ensure indexes try { datastore.ensureIndexes(); - } catch (MongoCommandException e) { - Grasscutter.getLogger().info("Mongo index error: ", e); + } catch (MongoCommandException exception) { + Grasscutter.getLogger().info("Mongo index error: ", exception); // Duplicate index error - if (e.getCode() == 85) { + if (exception.getCode() == 85) { // Drop all indexes and re add them MongoIterable collections = datastore.getDatabase().listCollectionNames(); for (String name : collections) { @@ -82,8 +78,8 @@ public final class DatabaseManager { } if(Grasscutter.getConfig().RunMode.equalsIgnoreCase("GAME_ONLY")) { - dispatchMongoClient = new MongoClient(new MongoClientURI(Grasscutter.getConfig().getGameServerOptions().DispatchServerDatabaseUrl)); - dispatchDatastore = morphia.createDatastore(dispatchMongoClient, Grasscutter.getConfig().getGameServerOptions().DispatchServerDatabaseCollection); + dispatchMongoClient = MongoClients.create(Grasscutter.getConfig().getGameServerOptions().DispatchServerDatabaseUrl); + dispatchDatastore = Morphia.createDatastore(dispatchMongoClient, Grasscutter.getConfig().getGameServerOptions().DispatchServerDatabaseCollection); // Ensure indexes for dispatch server try { @@ -103,9 +99,9 @@ public final class DatabaseManager { } } } - + public static synchronized int getNextId(Class c) { - DatabaseCounter counter = getDatastore().createQuery(DatabaseCounter.class).field("_id").equal(c.getSimpleName()).find().tryNext(); + DatabaseCounter counter = getDatastore().find(DatabaseCounter.class).filter(Filters.eq("_id", c.getName())).first(); if (counter == null) { counter = new DatabaseCounter(c.getSimpleName()); } @@ -115,7 +111,7 @@ public final class DatabaseManager { getDatastore().save(counter); } } - + public static synchronized int getNextId(Object o) { return getNextId(o.getClass()); } diff --git a/src/main/java/emu/grasscutter/game/Account.java b/src/main/java/emu/grasscutter/game/Account.java index dfb1e2829..dbd6ef854 100644 --- a/src/main/java/emu/grasscutter/game/Account.java +++ b/src/main/java/emu/grasscutter/game/Account.java @@ -1,22 +1,18 @@ package emu.grasscutter.game; -import dev.morphia.annotations.AlsoLoad; -import dev.morphia.annotations.Collation; -import dev.morphia.annotations.Entity; -import dev.morphia.annotations.Id; -import dev.morphia.annotations.Indexed; -import dev.morphia.annotations.PreLoad; +import dev.morphia.annotations.*; import emu.grasscutter.database.DatabaseHelper; import emu.grasscutter.utils.Crypto; import emu.grasscutter.utils.Utils; -import dev.morphia.annotations.IndexOptions; import java.util.ArrayList; import java.util.List; +import org.bson.Document; + import com.mongodb.DBObject; -@Entity(value = "accounts", noClassnameStored = true) +@Entity(value = "accounts", useDiscriminator = false) public class Account { @Id private String id; @@ -31,7 +27,7 @@ public class Account { private String token; private String sessionKey; // Session token for dispatch server private List permissions; - + @Deprecated public Account() { this.permissions = new ArrayList<>(); @@ -122,15 +118,15 @@ public class Account { return this.token; } - @PreLoad - public void onLoad(DBObject dbObj) { - // Grant the superuser permissions to accounts created before the permissions update - if (!dbObj.containsField("permissions")) { - this.addPermission("*"); - } - } - public void save() { DatabaseHelper.saveAccount(this); } + + @PreLoad + public void onLoad(Document document) { + // Grant the superuser permissions to accounts created before the permissions update + if (!document.containsKey("permissions")) { + this.addPermission("*"); + } + } } diff --git a/src/main/java/emu/grasscutter/game/GenshinPlayer.java b/src/main/java/emu/grasscutter/game/GenshinPlayer.java index 44f960198..cdef5852e 100644 --- a/src/main/java/emu/grasscutter/game/GenshinPlayer.java +++ b/src/main/java/emu/grasscutter/game/GenshinPlayer.java @@ -18,6 +18,7 @@ import emu.grasscutter.game.friends.PlayerProfile; import emu.grasscutter.game.gacha.PlayerGachaInfo; import emu.grasscutter.game.inventory.GenshinItem; import emu.grasscutter.game.inventory.Inventory; +import emu.grasscutter.game.player.PlayerBirthday; import emu.grasscutter.game.props.ActionReason; import emu.grasscutter.game.props.PlayerProperty; import emu.grasscutter.net.packet.GenshinPacket; @@ -61,7 +62,7 @@ import emu.grasscutter.utils.Position; import it.unimi.dsi.fastutil.ints.Int2ObjectMap; import it.unimi.dsi.fastutil.ints.Int2ObjectOpenHashMap; -@Entity(value = "players", noClassnameStored = true) +@Entity(value = "players", useDiscriminator = false) public class GenshinPlayer { @Id private int id; @Indexed(options = @IndexOptions(unique = true)) private String accountId; @@ -73,6 +74,7 @@ public class GenshinPlayer { private int nameCardId = 210001; private Position pos; private Position rotation; + private PlayerBirthday birthday; private Map properties; private Set nameCardList; @@ -139,6 +141,8 @@ public class GenshinPlayer { this.combatInvokeHandler = new InvokeHandler(PacketCombatInvocationsNotify.class); this.abilityInvokeHandler = new InvokeHandler(PacketAbilityInvocationsNotify.class); this.clientAbilityInitFinishHandler = new InvokeHandler(PacketClientAbilityInitFinishNotify.class); + + this.birthday = new PlayerBirthday(); } // On player creation @@ -150,6 +154,7 @@ public class GenshinPlayer { this.nickname = "Traveler"; this.signature = ""; this.teamManager = new TeamManager(this); + this.birthday = new PlayerBirthday(); this.setProperty(PlayerProperty.PROP_PLAYER_LEVEL, 1); this.setProperty(PlayerProperty.PROP_IS_SPRING_AUTO_USE, 1); this.setProperty(PlayerProperty.PROP_SPRING_AUTO_USE_PERCENT, 50); @@ -642,6 +647,15 @@ public class GenshinPlayer { return onlineInfo.build(); } + public PlayerBirthday getBirthday(){ + return this.birthday; + } + + public void setBirthday(int d, int m) { + this.birthday = new PlayerBirthday(d, m); + this.updateProfile(); + } + public SocialDetail.Builder getSocialDetail() { SocialDetail.Builder social = SocialDetail.newBuilder() .setUid(this.getUid()) @@ -649,7 +663,7 @@ public class GenshinPlayer { .setNickname(this.getNickname()) .setSignature(this.getSignature()) .setLevel(this.getLevel()) - .setBirthday(Birthday.newBuilder()) + .setBirthday(this.getBirthday().getFilledProtoWhenNotEmpty()) .setWorldLevel(this.getWorldLevel()) .setUnk1(1) .setUnk3(1) diff --git a/src/main/java/emu/grasscutter/game/TeamInfo.java b/src/main/java/emu/grasscutter/game/TeamInfo.java index c60ce8cc0..efaf5ea1c 100644 --- a/src/main/java/emu/grasscutter/game/TeamInfo.java +++ b/src/main/java/emu/grasscutter/game/TeamInfo.java @@ -3,10 +3,12 @@ package emu.grasscutter.game; import java.util.ArrayList; import java.util.List; +import dev.morphia.annotations.Entity; import emu.grasscutter.GenshinConstants; import emu.grasscutter.Grasscutter; import emu.grasscutter.game.avatar.GenshinAvatar; +@Entity public class TeamInfo { private String name; private List avatars; diff --git a/src/main/java/emu/grasscutter/game/TeamManager.java b/src/main/java/emu/grasscutter/game/TeamManager.java index 065c3bd28..6cd447d49 100644 --- a/src/main/java/emu/grasscutter/game/TeamManager.java +++ b/src/main/java/emu/grasscutter/game/TeamManager.java @@ -8,6 +8,7 @@ import java.util.List; import java.util.Map; import java.util.Set; +import dev.morphia.annotations.Entity; import dev.morphia.annotations.Transient; import emu.grasscutter.GenshinConstants; import emu.grasscutter.Grasscutter; @@ -41,6 +42,7 @@ import it.unimi.dsi.fastutil.ints.Int2ObjectOpenHashMap; import it.unimi.dsi.fastutil.ints.IntOpenHashSet; import it.unimi.dsi.fastutil.ints.IntSet; +@Entity public class TeamManager { @Transient private GenshinPlayer player; diff --git a/src/main/java/emu/grasscutter/game/avatar/AvatarProfileData.java b/src/main/java/emu/grasscutter/game/avatar/AvatarProfileData.java index 5458c1752..d04c9d326 100644 --- a/src/main/java/emu/grasscutter/game/avatar/AvatarProfileData.java +++ b/src/main/java/emu/grasscutter/game/avatar/AvatarProfileData.java @@ -1,5 +1,8 @@ package emu.grasscutter.game.avatar; +import dev.morphia.annotations.Entity; + +@Entity public class AvatarProfileData { private int avatarId; private int level; diff --git a/src/main/java/emu/grasscutter/game/avatar/GenshinAvatar.java b/src/main/java/emu/grasscutter/game/avatar/GenshinAvatar.java index 6906d3896..b80b080d9 100644 --- a/src/main/java/emu/grasscutter/game/avatar/GenshinAvatar.java +++ b/src/main/java/emu/grasscutter/game/avatar/GenshinAvatar.java @@ -56,7 +56,7 @@ import it.unimi.dsi.fastutil.ints.Int2IntOpenHashMap; import it.unimi.dsi.fastutil.ints.Int2ObjectMap; import it.unimi.dsi.fastutil.ints.Int2ObjectOpenHashMap; -@Entity(value = "avatars", noClassnameStored = true) +@Entity(value = "avatars", useDiscriminator = false) public class GenshinAvatar { @Id private ObjectId id; @Indexed private int ownerId; // Id of player that this avatar belongs to diff --git a/src/main/java/emu/grasscutter/game/friends/Friendship.java b/src/main/java/emu/grasscutter/game/friends/Friendship.java index 172d1bd43..28561dc39 100644 --- a/src/main/java/emu/grasscutter/game/friends/Friendship.java +++ b/src/main/java/emu/grasscutter/game/friends/Friendship.java @@ -9,7 +9,7 @@ import emu.grasscutter.net.proto.FriendBriefOuterClass.FriendBrief; import emu.grasscutter.net.proto.FriendOnlineStateOuterClass.FriendOnlineState; import emu.grasscutter.net.proto.HeadImageOuterClass.HeadImage; -@Entity(value = "friendships", noClassnameStored = true) +@Entity(value = "friendships", useDiscriminator = false) public class Friendship { @Id private ObjectId id; diff --git a/src/main/java/emu/grasscutter/game/friends/PlayerProfile.java b/src/main/java/emu/grasscutter/game/friends/PlayerProfile.java index b9381c901..4af5f570e 100644 --- a/src/main/java/emu/grasscutter/game/friends/PlayerProfile.java +++ b/src/main/java/emu/grasscutter/game/friends/PlayerProfile.java @@ -4,6 +4,7 @@ import dev.morphia.annotations.*; import emu.grasscutter.game.GenshinPlayer; import emu.grasscutter.utils.Utils; +@Entity public class PlayerProfile { @Transient private GenshinPlayer player; diff --git a/src/main/java/emu/grasscutter/game/gacha/PlayerGachaBannerInfo.java b/src/main/java/emu/grasscutter/game/gacha/PlayerGachaBannerInfo.java index 2e144226e..b0c85d355 100644 --- a/src/main/java/emu/grasscutter/game/gacha/PlayerGachaBannerInfo.java +++ b/src/main/java/emu/grasscutter/game/gacha/PlayerGachaBannerInfo.java @@ -1,5 +1,8 @@ package emu.grasscutter.game.gacha; +import dev.morphia.annotations.Entity; + +@Entity public class PlayerGachaBannerInfo { private int pity5 = 0; private int pity4 = 0; diff --git a/src/main/java/emu/grasscutter/game/gacha/PlayerGachaInfo.java b/src/main/java/emu/grasscutter/game/gacha/PlayerGachaInfo.java index c3aabcb76..8dd0e380e 100644 --- a/src/main/java/emu/grasscutter/game/gacha/PlayerGachaInfo.java +++ b/src/main/java/emu/grasscutter/game/gacha/PlayerGachaInfo.java @@ -1,5 +1,8 @@ package emu.grasscutter.game.gacha; +import dev.morphia.annotations.Entity; + +@Entity public class PlayerGachaInfo { private PlayerGachaBannerInfo standardBanner; private PlayerGachaBannerInfo eventCharacterBanner; diff --git a/src/main/java/emu/grasscutter/game/inventory/GenshinItem.java b/src/main/java/emu/grasscutter/game/inventory/GenshinItem.java index 0b0db49c4..a395825da 100644 --- a/src/main/java/emu/grasscutter/game/inventory/GenshinItem.java +++ b/src/main/java/emu/grasscutter/game/inventory/GenshinItem.java @@ -34,7 +34,7 @@ import emu.grasscutter.net.proto.SceneWeaponInfoOuterClass.SceneWeaponInfo; import emu.grasscutter.net.proto.WeaponOuterClass.Weapon; import emu.grasscutter.utils.WeightedList; -@Entity(value = "items", noClassnameStored = true) +@Entity(value = "items", useDiscriminator = false) public class GenshinItem { @Id private ObjectId id; @Indexed private int ownerId; diff --git a/src/main/java/emu/grasscutter/game/player/PlayerBirthday.java b/src/main/java/emu/grasscutter/game/player/PlayerBirthday.java new file mode 100644 index 000000000..733f58ee5 --- /dev/null +++ b/src/main/java/emu/grasscutter/game/player/PlayerBirthday.java @@ -0,0 +1,68 @@ +package emu.grasscutter.game.player; + +import emu.grasscutter.net.proto.BirthdayOuterClass.Birthday; + +public class PlayerBirthday { + private int day; + private int month; + + public PlayerBirthday(){ + this.day = 0; + this.month = 0; + } + + public PlayerBirthday(int day, int month){ + this.day = day; + this.month = month; + } + + public PlayerBirthday set(PlayerBirthday birth){ + this.day = birth.day; + this.month = birth.month; + + return this; + } + + public PlayerBirthday set(int d, int m){ + this.day = d; + this.month = m; + + return this; + } + + public PlayerBirthday setDay(int value){ + this.day = value; + return this; + } + + public PlayerBirthday setMonth(int value){ + this.month = value; + return this; + } + + public int getDay(){ + return this.day; + } + + public int getMonth(){ + return this.month; + } + + public Birthday toProto(){ + return Birthday.newBuilder() + .setDay(this.getDay()) + .setMonth(this.getMonth()) + .build(); + } + + public Birthday.Builder getFilledProtoWhenNotEmpty(){ + if(this.getDay() > 0) + { + return Birthday.newBuilder() + .setDay(this.getDay()) + .setMonth(this.getMonth()); + } + + return Birthday.newBuilder(); + } +} \ No newline at end of file diff --git a/src/main/java/emu/grasscutter/net/packet/PacketOpcodes.java b/src/main/java/emu/grasscutter/net/packet/PacketOpcodes.java index 418f16a4b..365055e26 100644 --- a/src/main/java/emu/grasscutter/net/packet/PacketOpcodes.java +++ b/src/main/java/emu/grasscutter/net/packet/PacketOpcodes.java @@ -1034,6 +1034,8 @@ public class PacketOpcodes { public static final int ShowTemplateReminderNotify = 3164; public static final int SignInInfoReq = 2510; public static final int SignInInfoRsp = 2515; + public static final int SitReq = 354; + public static final int SitRsp = 335; public static final int SocialDataNotify = 4063; public static final int SpringUseReq = 1720; public static final int SpringUseRsp = 1727; @@ -1208,5 +1210,4 @@ public class PacketOpcodes { public static final int WorldRoutineChangeNotify = 3548; public static final int WorldRoutineTypeCloseNotify = 3513; public static final int WorldRoutineTypeRefreshNotify = 3545; - } \ No newline at end of file diff --git a/src/main/java/emu/grasscutter/server/packet/recv/HandleEvtAvatarSitDownNotify.java b/src/main/java/emu/grasscutter/server/packet/recv/HandleEvtAvatarSitDownNotify.java new file mode 100644 index 000000000..8f653dde9 --- /dev/null +++ b/src/main/java/emu/grasscutter/server/packet/recv/HandleEvtAvatarSitDownNotify.java @@ -0,0 +1,21 @@ +package emu.grasscutter.server.packet.recv; + +import emu.grasscutter.net.packet.Opcodes; +import emu.grasscutter.net.packet.PacketOpcodes; +import emu.grasscutter.net.proto.EvtAvatarSitDownNotifyOuterClass.EvtAvatarSitDownNotify; +import emu.grasscutter.net.packet.PacketHandler; +import emu.grasscutter.server.game.GameSession; +import emu.grasscutter.server.packet.send.PacketEvtAvatarSitDownNotify; + +@Opcodes(PacketOpcodes.EvtAvatarSitDownNotify) +public class HandleEvtAvatarSitDownNotify extends PacketHandler { + + @Override + public void handle(GameSession session, byte[] header, byte[] payload) throws Exception { + EvtAvatarSitDownNotify notify = EvtAvatarSitDownNotify.parseFrom(payload); + + session.send(new PacketEvtAvatarSitDownNotify(notify)); + } + +} + diff --git a/src/main/java/emu/grasscutter/server/packet/recv/HandleSitReq.java b/src/main/java/emu/grasscutter/server/packet/recv/HandleSitReq.java new file mode 100644 index 000000000..418d99eef --- /dev/null +++ b/src/main/java/emu/grasscutter/server/packet/recv/HandleSitReq.java @@ -0,0 +1,24 @@ +package emu.grasscutter.server.packet.recv; + +import emu.grasscutter.net.packet.Opcodes; +import emu.grasscutter.net.packet.PacketHandler; +import emu.grasscutter.net.packet.PacketOpcodes; +import emu.grasscutter.net.proto.SitReqOuterClass; +import emu.grasscutter.server.game.GameSession; +import emu.grasscutter.server.packet.send.PacketSitRsp; +import emu.grasscutter.utils.Position; + +@Opcodes(PacketOpcodes.SitReq) +public class HandleSitReq extends PacketHandler { + @Override + public void handle(GameSession session, byte[] header, byte[] payload) throws Exception { + SitReqOuterClass.SitReq req = SitReqOuterClass.SitReq.parseFrom(payload); + + float x = req.getPosition().getX(); + float y = req.getPosition().getY(); + float z = req.getPosition().getZ(); + + session.send(new PacketSitRsp(req.getChairId(), new Position(x, y, z), session.getPlayer().getTeamManager().getCurrentAvatarEntity().getId())); + } + +} \ No newline at end of file diff --git a/src/main/java/emu/grasscutter/server/packet/recv/HandlerSetPlayerBirthdayReq.java b/src/main/java/emu/grasscutter/server/packet/recv/HandlerSetPlayerBirthdayReq.java new file mode 100644 index 000000000..0edb08f73 --- /dev/null +++ b/src/main/java/emu/grasscutter/server/packet/recv/HandlerSetPlayerBirthdayReq.java @@ -0,0 +1,38 @@ +package emu.grasscutter.server.packet.recv; + +import emu.grasscutter.server.game.GameSession; +import emu.grasscutter.server.packet.send.PacketGetPlayerSocialDetailRsp; +import emu.grasscutter.server.packet.send.PacketSetPlayerBirthdayRsp; + +import emu.grasscutter.net.packet.Opcodes; +import emu.grasscutter.net.packet.PacketOpcodes; +import emu.grasscutter.net.packet.PacketHandler; + +import emu.grasscutter.net.proto.SocialDetailOuterClass.SocialDetail; +import emu.grasscutter.net.proto.SetPlayerBirthdayReqOuterClass.SetPlayerBirthdayReq; + +import com.google.gson.Gson; + +@Opcodes(PacketOpcodes.SetPlayerBirthdayReq) +public class HandlerSetPlayerBirthdayReq extends PacketHandler { + @Override + public void handle(GameSession session, byte[] header, byte[] payload) throws Exception { + SetPlayerBirthdayReq req = SetPlayerBirthdayReq.parseFrom(payload); + + if(req.getBirth() != null && req.getBirth().getDay() > 0 && req.getBirth().getMonth() > 0) + { + int day = req.getBirth().getDay(); + int month = req.getBirth().getMonth(); + + // Update birthday value + session.getPlayer().setBirthday(day, month); + + // Save birthday month and day + session.getPlayer().save(); + SocialDetail.Builder detail = session.getPlayer().getSocialDetail(); + + session.send(new PacketSetPlayerBirthdayRsp(session.getPlayer())); + session.send(new PacketGetPlayerSocialDetailRsp(detail)); + } + } +} diff --git a/src/main/java/emu/grasscutter/server/packet/send/PacketEvtAvatarSitDownNotify.java b/src/main/java/emu/grasscutter/server/packet/send/PacketEvtAvatarSitDownNotify.java new file mode 100644 index 000000000..6a051024a --- /dev/null +++ b/src/main/java/emu/grasscutter/server/packet/send/PacketEvtAvatarSitDownNotify.java @@ -0,0 +1,20 @@ +package emu.grasscutter.server.packet.send; + +import emu.grasscutter.net.packet.GenshinPacket; +import emu.grasscutter.net.packet.PacketOpcodes; +import emu.grasscutter.net.proto.EvtAvatarSitDownNotifyOuterClass.EvtAvatarSitDownNotify; + +public class PacketEvtAvatarSitDownNotify extends GenshinPacket { + + public PacketEvtAvatarSitDownNotify(EvtAvatarSitDownNotify notify) { + super(PacketOpcodes.EvtAvatarSitDownNotify); + + EvtAvatarSitDownNotify proto = EvtAvatarSitDownNotify.newBuilder() + .setEntityId(notify.getEntityId()) + .setPosition(notify.getPosition()) + .setChairId(notify.getChairId()) + .build(); + + this.setData(proto); + } +} diff --git a/src/main/java/emu/grasscutter/server/packet/send/PacketSetPlayerBirthdayRsp.java b/src/main/java/emu/grasscutter/server/packet/send/PacketSetPlayerBirthdayRsp.java new file mode 100644 index 000000000..9b73b6b13 --- /dev/null +++ b/src/main/java/emu/grasscutter/server/packet/send/PacketSetPlayerBirthdayRsp.java @@ -0,0 +1,20 @@ +package emu.grasscutter.server.packet.send; + +import emu.grasscutter.Grasscutter; +import emu.grasscutter.game.GenshinPlayer; +import emu.grasscutter.net.packet.GenshinPacket; +import emu.grasscutter.net.packet.PacketOpcodes; +import emu.grasscutter.net.proto.SetPlayerBirthdayRspOuterClass.SetPlayerBirthdayRsp; +import emu.grasscutter.net.proto.BirthdayOuterClass.Birthday; + +public class PacketSetPlayerBirthdayRsp extends GenshinPacket { + public PacketSetPlayerBirthdayRsp(GenshinPlayer player) { + super(PacketOpcodes.SetPlayerBirthdayRsp); + + SetPlayerBirthdayRsp proto = SetPlayerBirthdayRsp.newBuilder() + .setBirth(player.getBirthday().toProto()) + .build(); + + this.setData(proto); + } +} diff --git a/src/main/java/emu/grasscutter/server/packet/send/PacketSitRsp.java b/src/main/java/emu/grasscutter/server/packet/send/PacketSitRsp.java new file mode 100644 index 000000000..70893965b --- /dev/null +++ b/src/main/java/emu/grasscutter/server/packet/send/PacketSitRsp.java @@ -0,0 +1,21 @@ +package emu.grasscutter.server.packet.send; + +import emu.grasscutter.net.packet.GenshinPacket; +import emu.grasscutter.net.packet.PacketOpcodes; +import emu.grasscutter.net.proto.SitRspOuterClass.SitRsp; +import emu.grasscutter.utils.Position; + +public class PacketSitRsp extends GenshinPacket { + + public PacketSitRsp(long chairId, Position pos, int EntityId) { + super(PacketOpcodes.SitRsp); + + SitRsp proto = SitRsp.newBuilder() + .setEntityId(EntityId) + .setPosition(pos.toProto()) + .setChairId(chairId) + .build(); + + this.setData(proto); + } +} diff --git a/src/main/java/emu/grasscutter/utils/Position.java b/src/main/java/emu/grasscutter/utils/Position.java index 6a02dacba..f2ecb6915 100644 --- a/src/main/java/emu/grasscutter/utils/Position.java +++ b/src/main/java/emu/grasscutter/utils/Position.java @@ -2,8 +2,10 @@ package emu.grasscutter.utils; import java.io.Serializable; +import dev.morphia.annotations.Entity; import emu.grasscutter.net.proto.VectorOuterClass.Vector; +@Entity public class Position implements Serializable { private static final long serialVersionUID = -2001232313615923575L; diff --git a/start.cmd b/start.cmd index 8c89f359e..8c525dfc8 100644 --- a/start.cmd +++ b/start.cmd @@ -74,7 +74,9 @@ for /f "tokens=2*" %%a in ('reg query "HKCU\Software\Microsoft\Windows\CurrentVe @rem TODO: External proxy when ORIG_PROXY_ENABLE == 0x1 echo set ws = createobject("wscript.shell") > "%temp%\proxy.vbs" +if not "%MITMDUMP_PATH%" == "" ( echo ws.currentdirectory = "%MITMDUMP_PATH%" >> "%temp%\proxy.vbs" +) echo ws.run "cmd /c mitmdump.exe -s "^&chr(34)^&"%PROXY_SCRIPT_NAME%"^&chr(34)^&" -k",0 >> "%temp%\proxy.vbs" "%temp%\proxy.vbs" del /f /q "%temp%\proxy.vbs" >nul 2>nul @@ -117,7 +119,9 @@ set DATABASE=true mkdir "%DATABASE_STORAGE_PATH%" >nul 2>nul echo set ws = createobject("wscript.shell") > "%temp%\db.vbs" +if not "%MONGODB_PATH%" == "" ( echo ws.currentdirectory = "%MONGODB_PATH%" >> "%temp%\db.vbs" +) echo ws.run "cmd /c mongod.exe --dbpath "^&chr(34)^&"%DATABASE_STORAGE_PATH%"^&chr(34)^&"",0 >> "%temp%\db.vbs" "%temp%\db.vbs" del /f /q "%temp%\db.vbs" >nul 2>nul From 7a3fbcdcf745941926bf3731c1161075bc7c824c Mon Sep 17 00:00:00 2001 From: KingRainbow44 Date: Sat, 23 Apr 2022 01:17:35 -0400 Subject: [PATCH 4/7] Plugin enabling & disabling --- .../java/emu/grasscutter/Grasscutter.java | 59 ++++++++++++------- .../java/emu/grasscutter/plugin/Plugin.java | 20 +++---- .../emu/grasscutter/plugin/PluginManager.java | 34 +++++++---- 3 files changed, 69 insertions(+), 44 deletions(-) diff --git a/src/main/java/emu/grasscutter/Grasscutter.java b/src/main/java/emu/grasscutter/Grasscutter.java index abcdc3557..8f64f0e51 100644 --- a/src/main/java/emu/grasscutter/Grasscutter.java +++ b/src/main/java/emu/grasscutter/Grasscutter.java @@ -8,6 +8,7 @@ import java.io.InputStreamReader; import java.net.InetSocketAddress; import emu.grasscutter.command.CommandMap; +import emu.grasscutter.plugin.PluginManager; import emu.grasscutter.utils.Utils; import org.reflections.Reflections; import org.slf4j.LoggerFactory; @@ -33,6 +34,7 @@ public final class Grasscutter { public static RunMode MODE = RunMode.BOTH; private static DispatchServer dispatchServer; private static GameServer gameServer; + private static PluginManager pluginManager; public static final Reflections reflector = new Reflections(); @@ -52,15 +54,11 @@ public final class Grasscutter { for (String arg : args) { switch (arg.toLowerCase()) { - case "-auth": - MODE = RunMode.AUTH; - break; - case "-game": - MODE = RunMode.GAME; - break; - case "-handbook": - Tools.createGmHandbook(); - return; + case "-auth" -> MODE = RunMode.AUTH; + case "-game" -> MODE = RunMode.GAME; + case "-handbook" -> { + Tools.createGmHandbook(); return; + } } } @@ -71,19 +69,21 @@ public final class Grasscutter { ResourceLoader.loadAll(); // Database DatabaseManager.initialize(); + + // Create server instances. + dispatchServer = new DispatchServer(); + gameServer = new GameServer(new InetSocketAddress(getConfig().getGameServerOptions().Ip, getConfig().getGameServerOptions().Port)); + + // Create plugin manager instance. + pluginManager = new PluginManager(); // Start servers. if(getConfig().RunMode.equalsIgnoreCase("HYBRID")) { - dispatchServer = new DispatchServer(); dispatchServer.start(); - - gameServer = new GameServer(new InetSocketAddress(getConfig().getGameServerOptions().Ip, getConfig().getGameServerOptions().Port)); gameServer.start(); - } else if(getConfig().RunMode.equalsIgnoreCase("DISPATCH_ONLY")) { - dispatchServer = new DispatchServer(); + } else if (getConfig().RunMode.equalsIgnoreCase("DISPATCH_ONLY")) { dispatchServer.start(); - } else if(getConfig().RunMode.equalsIgnoreCase("GAME_ONLY")) { - gameServer = new GameServer(new InetSocketAddress(getConfig().getGameServerOptions().Ip, getConfig().getGameServerOptions().Port)); + } else if (getConfig().RunMode.equalsIgnoreCase("GAME_ONLY")) { gameServer.start(); } else { getLogger().error("Invalid server run mode. " + getConfig().RunMode); @@ -91,12 +91,23 @@ public final class Grasscutter { getLogger().error("Shutting down..."); System.exit(1); } - - + + // Enable all plugins. + pluginManager.enablePlugins(); // Open console. startConsole(); + // Hook into shutdown event. + Runtime.getRuntime().addShutdownHook(new Thread(Grasscutter::onShutdown)); } + + /** + * Server shutdown event. + */ + private static void onShutdown() { + // Disable all plugins. + pluginManager.disablePlugins(); + } public static void loadConfig() { try (FileReader file = new FileReader(configFile)) { @@ -112,7 +123,7 @@ public final class Grasscutter { try (FileWriter file = new FileWriter(configFile)) { file.write(gson.toJson(config)); } catch (Exception e) { - Grasscutter.getLogger().error("Config save error"); + Grasscutter.getLogger().error("Unable to save config file."); } } @@ -122,13 +133,13 @@ public final class Grasscutter { while ((input = br.readLine()) != null) { try { if(getConfig().RunMode.equalsIgnoreCase("DISPATCH_ONLY")) { - getLogger().error("Commands are not supported in dispatch only mode"); + getLogger().error("Commands are not supported in dispatch only mode."); return; } + CommandMap.getInstance().invoke(null, input); } catch (Exception e) { - Grasscutter.getLogger().error("Command error: "); - e.printStackTrace(); + Grasscutter.getLogger().error("Command error:", e); } } } catch (Exception e) { @@ -161,4 +172,8 @@ public final class Grasscutter { public static GameServer getGameServer() { return gameServer; } + + public static PluginManager getPluginManager() { + return pluginManager; + } } diff --git a/src/main/java/emu/grasscutter/plugin/Plugin.java b/src/main/java/emu/grasscutter/plugin/Plugin.java index 145a06eb8..a3160d7c7 100644 --- a/src/main/java/emu/grasscutter/plugin/Plugin.java +++ b/src/main/java/emu/grasscutter/plugin/Plugin.java @@ -7,22 +7,18 @@ import emu.grasscutter.server.game.GameServer; * The base class for all plugins to extend. */ public abstract class Plugin { - private final PluginIdentifier identifier; + private PluginIdentifier identifier; /** - * Empty constructor for developers. - * Should not be called by users. - */ - public Plugin() { - this(new PluginIdentifier("", "", "", new String[]{})); - } - - /** - * Constructor for plugins. + * This method is reflected into. + * + * Set plugin variables. * @param identifier The plugin's identifier. */ - public Plugin(PluginIdentifier identifier) { - this.identifier = identifier; + private void initializePlugin(PluginIdentifier identifier) { + if(this.identifier == null) + this.identifier = identifier; + else Grasscutter.getLogger().warn(this.identifier.name + " had a reinitialization attempt."); } /** diff --git a/src/main/java/emu/grasscutter/plugin/PluginManager.java b/src/main/java/emu/grasscutter/plugin/PluginManager.java index 3177bb291..3e55e4ad8 100644 --- a/src/main/java/emu/grasscutter/plugin/PluginManager.java +++ b/src/main/java/emu/grasscutter/plugin/PluginManager.java @@ -5,13 +5,13 @@ import emu.grasscutter.utils.Utils; import java.io.File; import java.io.InputStreamReader; +import java.lang.reflect.Method; import java.net.URL; import java.net.URLClassLoader; import java.util.Arrays; import java.util.HashMap; import java.util.List; import java.util.Map; -import java.util.stream.Collectors; /** * Manages the server's plugins & the event system. @@ -42,7 +42,7 @@ public final class PluginManager { List plugins = Arrays.stream(files) .filter(file -> file.getName().endsWith(".jar")) - .collect(Collectors.toList()); + .toList(); plugins.forEach(plugin -> { try { @@ -59,9 +59,8 @@ public final class PluginManager { } Class pluginClass = loader.loadClass(pluginConfig.mainClass); - Plugin pluginInstance = (Plugin) pluginClass.getDeclaredConstructor(PluginIdentifier.class) - .newInstance(PluginIdentifier.fromPluginConfig(pluginConfig)); - this.loadPlugin(pluginInstance); + Plugin pluginInstance = (Plugin) pluginClass.getDeclaredConstructor().newInstance(); + this.loadPlugin(pluginInstance, PluginIdentifier.fromPluginConfig(pluginConfig)); fileReader.close(); // Close the file reader. } catch (ClassNotFoundException ignored) { @@ -77,11 +76,20 @@ public final class PluginManager { * Load the specified plugin. * @param plugin The plugin instance. */ - private void loadPlugin(Plugin plugin) { - Grasscutter.getLogger().info("Loading plugin: " + plugin.getName()); + private void loadPlugin(Plugin plugin, PluginIdentifier identifier) { + Grasscutter.getLogger().info("Loading plugin: " + identifier.name); + + // Add the plugin's identifier. + try { + Class pluginClass = Plugin.class; + Method method = pluginClass.getDeclaredMethod("initializePlugin", PluginIdentifier.class); + method.setAccessible(true); method.invoke(plugin, identifier); method.setAccessible(false); + } catch (Exception ignored) { + Grasscutter.getLogger().warn("Failed to add plugin identifier: " + identifier.name); + } // Add the plugin to the list of loaded plugins. - this.plugins.put(plugin.getName(), plugin); + this.plugins.put(identifier.name, plugin); // Call the plugin's onLoad method. plugin.onLoad(); } @@ -90,13 +98,19 @@ public final class PluginManager { * Enables all registered plugins. */ public void enablePlugins() { - + this.plugins.forEach((name, plugin) -> { + Grasscutter.getLogger().info("Enabling plugin: " + name); + plugin.onEnable(); + }); } /** * Disables all registered plugins. */ public void disablePlugins() { - + this.plugins.forEach((name, plugin) -> { + Grasscutter.getLogger().info("Disabling plugin: " + name); + plugin.onDisable(); + }); } } \ No newline at end of file From 6056e962d696a645c7df58a0041d0e8233e4cf81 Mon Sep 17 00:00:00 2001 From: KingRainbow44 Date: Sat, 23 Apr 2022 01:58:37 -0400 Subject: [PATCH 5/7] Implement an event handler --- .../emu/grasscutter/plugin/PluginManager.java | 44 +++++++++++++++++-- .../grasscutter/server/event/Cancellable.java | 8 ++++ .../emu/grasscutter/server/event/Event.java | 33 ++++++++++++++ .../server/event/EventHandler.java | 11 +++++ .../grasscutter/server/event/Listener.java | 7 +++ .../grasscutter/server/event/ServerEvent.java | 17 +++++++ 6 files changed, 116 insertions(+), 4 deletions(-) create mode 100644 src/main/java/emu/grasscutter/server/event/Cancellable.java create mode 100644 src/main/java/emu/grasscutter/server/event/Event.java create mode 100644 src/main/java/emu/grasscutter/server/event/EventHandler.java create mode 100644 src/main/java/emu/grasscutter/server/event/Listener.java create mode 100644 src/main/java/emu/grasscutter/server/event/ServerEvent.java diff --git a/src/main/java/emu/grasscutter/plugin/PluginManager.java b/src/main/java/emu/grasscutter/plugin/PluginManager.java index 3e55e4ad8..7b54f460f 100644 --- a/src/main/java/emu/grasscutter/plugin/PluginManager.java +++ b/src/main/java/emu/grasscutter/plugin/PluginManager.java @@ -1,23 +1,25 @@ package emu.grasscutter.plugin; import emu.grasscutter.Grasscutter; +import emu.grasscutter.server.event.Event; +import emu.grasscutter.server.event.EventHandler; +import emu.grasscutter.server.event.Listener; import emu.grasscutter.utils.Utils; +import org.reflections.Reflections; import java.io.File; import java.io.InputStreamReader; import java.lang.reflect.Method; import java.net.URL; import java.net.URLClassLoader; -import java.util.Arrays; -import java.util.HashMap; -import java.util.List; -import java.util.Map; +import java.util.*; /** * Manages the server's plugins & the event system. */ public final class PluginManager { private final Map plugins = new HashMap<>(); + private final Map> listeners = new HashMap<>(); public PluginManager() { this.loadPlugins(); // Load all plugins from the plugins directory. @@ -113,4 +115,38 @@ public final class PluginManager { plugin.onDisable(); }); } + + /** + * Registers a plugin's event listener. + * @param plugin The plugin instance. + * @param listener The event listener. + */ + public void registerListener(Plugin plugin, Listener listener) { + this.listeners.computeIfAbsent(plugin, k -> new ArrayList<>()).add(listener); + } + + /** + * Invoke the provided event on all registered event listeners. + * @param event The event to invoke. + */ + public void invokeEvent(Event event) { + this.listeners.values().stream() + .flatMap(Collection::stream) + .forEach(listener -> this.invokeOnListener(listener, event)); + } + + /** + * Attempts to invoke the event on the provided listener. + */ + private void invokeOnListener(Listener listener, Event event) { + try { + Class listenerClass = listener.getClass(); + Method[] methods = listenerClass.getMethods(); + for (Method method : methods) { + if(!method.isAnnotationPresent(EventHandler.class)) return; + if(!method.getParameterTypes()[0].isAssignableFrom(event.getClass())) return; + method.invoke(listener, event); + } + } catch (Exception ignored) { } + } } \ No newline at end of file diff --git a/src/main/java/emu/grasscutter/server/event/Cancellable.java b/src/main/java/emu/grasscutter/server/event/Cancellable.java new file mode 100644 index 000000000..0296f0b36 --- /dev/null +++ b/src/main/java/emu/grasscutter/server/event/Cancellable.java @@ -0,0 +1,8 @@ +package emu.grasscutter.server.event; + +/** + * Implementing this interface marks an event as cancellable. + */ +public interface Cancellable { + void cancel(); +} diff --git a/src/main/java/emu/grasscutter/server/event/Event.java b/src/main/java/emu/grasscutter/server/event/Event.java new file mode 100644 index 000000000..7dd67b84d --- /dev/null +++ b/src/main/java/emu/grasscutter/server/event/Event.java @@ -0,0 +1,33 @@ +package emu.grasscutter.server.event; + +import emu.grasscutter.Grasscutter; + +/** + * A generic server event. + */ +public abstract class Event { + private boolean cancelled = false; + + /** + * Return the cancelled state of the event. + */ + public boolean isCanceled() { + return this.cancelled; + } + + /** + * Cancels the event if possible. + */ + public void cancel() throws IllegalAccessException { + if(!(this instanceof Cancellable)) + throw new IllegalAccessException("Event is not cancellable."); + this.cancelled = true; + } + + /** + * Pushes this event to all listeners. + */ + public void call() { + Grasscutter.getPluginManager().invokeEvent(this); + } +} diff --git a/src/main/java/emu/grasscutter/server/event/EventHandler.java b/src/main/java/emu/grasscutter/server/event/EventHandler.java new file mode 100644 index 000000000..d924933f2 --- /dev/null +++ b/src/main/java/emu/grasscutter/server/event/EventHandler.java @@ -0,0 +1,11 @@ +package emu.grasscutter.server.event; + +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; + +/** + * Declares a class as an event listener/handler. + */ +@Retention(RetentionPolicy.RUNTIME) +public @interface EventHandler { +} \ No newline at end of file diff --git a/src/main/java/emu/grasscutter/server/event/Listener.java b/src/main/java/emu/grasscutter/server/event/Listener.java new file mode 100644 index 000000000..2949cfe4a --- /dev/null +++ b/src/main/java/emu/grasscutter/server/event/Listener.java @@ -0,0 +1,7 @@ +package emu.grasscutter.server.event; + +/** + * Implementing this interface declares a class as an event listener. + */ +public interface Listener { +} diff --git a/src/main/java/emu/grasscutter/server/event/ServerEvent.java b/src/main/java/emu/grasscutter/server/event/ServerEvent.java new file mode 100644 index 000000000..e87abae0d --- /dev/null +++ b/src/main/java/emu/grasscutter/server/event/ServerEvent.java @@ -0,0 +1,17 @@ +package emu.grasscutter.server.event; + +/** + * An event that is related to the internals of the server. + */ +public abstract class ServerEvent extends Event { + protected final Type type; + + public ServerEvent(Type type) { + this.type = type; + } + + public enum Type { + DISPATCH, + GAME + } +} From 600decbc09e8b8b2bb8ade31ebe086324545922c Mon Sep 17 00:00:00 2001 From: KingRainbow44 Date: Sat, 23 Apr 2022 01:59:06 -0400 Subject: [PATCH 6/7] Implement region events --- .../server/dispatch/DispatchServer.java | 22 ++++++++++++++----- .../event/dispatch/QueryAllRegionsEvent.java | 21 ++++++++++++++++++ .../dispatch/QueryCurrentRegionEvent.java | 21 ++++++++++++++++++ 3 files changed, 58 insertions(+), 6 deletions(-) create mode 100644 src/main/java/emu/grasscutter/server/event/dispatch/QueryAllRegionsEvent.java create mode 100644 src/main/java/emu/grasscutter/server/event/dispatch/QueryCurrentRegionEvent.java diff --git a/src/main/java/emu/grasscutter/server/dispatch/DispatchServer.java b/src/main/java/emu/grasscutter/server/dispatch/DispatchServer.java index 7c7915675..ba280fb3e 100644 --- a/src/main/java/emu/grasscutter/server/dispatch/DispatchServer.java +++ b/src/main/java/emu/grasscutter/server/dispatch/DispatchServer.java @@ -18,6 +18,8 @@ import emu.grasscutter.net.proto.RegionInfoOuterClass.RegionInfo; import emu.grasscutter.net.proto.RegionSimpleInfoOuterClass.RegionSimpleInfo; import emu.grasscutter.server.dispatch.json.*; import emu.grasscutter.server.dispatch.json.ComboTokenReqJson.LoginTokenData; +import emu.grasscutter.server.event.dispatch.QueryAllRegionsEvent; +import emu.grasscutter.server.event.dispatch.QueryCurrentRegionEvent; import emu.grasscutter.utils.FileUtils; import emu.grasscutter.utils.Utils; @@ -189,24 +191,32 @@ public final class DispatchServer { // Dispatch server.createContext("/query_region_list", t -> { - // Log + // Log incoming request. Grasscutter.getLogger().info(String.format("[Dispatch] Client %s request: query_region_list", t.getRemoteAddress())); - - responseHTML(t, regionListBase64); + + // Invoke event. + QueryAllRegionsEvent event = new QueryAllRegionsEvent(this.regionListBase64); event.call(); + // Respond with event result. + responseHTML(t, event.getRegionList()); }); for (String regionName : regions.keySet()) { server.createContext("/query_cur_region_" + regionName, t -> { String regionCurrentBase64 = regions.get(regionName).Base64; - // Log + // Log incoming request. Grasscutter.getLogger().info(String.format("Client %s request: query_cur_region_%s", t.getRemoteAddress(), regionName)); - // Create a response form the request query parameters + + // Create a response from the request query parameters. URI uri = t.getRequestURI(); String response = "CAESGE5vdCBGb3VuZCB2ZXJzaW9uIGNvbmZpZw=="; if (uri.getQuery() != null && uri.getQuery().length() > 0) { response = regionCurrentBase64; } - responseHTML(t, response); + + // Invoke event. + QueryCurrentRegionEvent event = new QueryCurrentRegionEvent(response); event.call(); + // Respond with event result. + responseHTML(t, event.getRegionInfo()); }); } diff --git a/src/main/java/emu/grasscutter/server/event/dispatch/QueryAllRegionsEvent.java b/src/main/java/emu/grasscutter/server/event/dispatch/QueryAllRegionsEvent.java new file mode 100644 index 000000000..8595f6221 --- /dev/null +++ b/src/main/java/emu/grasscutter/server/event/dispatch/QueryAllRegionsEvent.java @@ -0,0 +1,21 @@ +package emu.grasscutter.server.event.dispatch; + +import emu.grasscutter.server.event.ServerEvent; + +public final class QueryAllRegionsEvent extends ServerEvent { + private String regionList; + + public QueryAllRegionsEvent(String regionList) { + super(Type.DISPATCH); + + this.regionList = regionList; + } + + public void setRegionList(String regionList) { + this.regionList = regionList; + } + + public String getRegionList() { + return this.regionList; + } +} diff --git a/src/main/java/emu/grasscutter/server/event/dispatch/QueryCurrentRegionEvent.java b/src/main/java/emu/grasscutter/server/event/dispatch/QueryCurrentRegionEvent.java new file mode 100644 index 000000000..d6a20b2df --- /dev/null +++ b/src/main/java/emu/grasscutter/server/event/dispatch/QueryCurrentRegionEvent.java @@ -0,0 +1,21 @@ +package emu.grasscutter.server.event.dispatch; + +import emu.grasscutter.server.event.ServerEvent; + +public final class QueryCurrentRegionEvent extends ServerEvent { + private String regionInfo; + + public QueryCurrentRegionEvent(String regionInfo) { + super(Type.DISPATCH); + + this.regionInfo = regionInfo; + } + + public void setRegionInfo(String regionInfo) { + this.regionInfo = regionInfo; + } + + public String getRegionInfo() { + return this.regionInfo; + } +} From 832c460a830c0f2e1542b59b0b4b78f8bc6c77e6 Mon Sep 17 00:00:00 2001 From: KingRainbow44 Date: Sat, 23 Apr 2022 02:08:31 -0400 Subject: [PATCH 7/7] Implement packet send/receive events --- .../emu/grasscutter/server/event/Event.java | 7 ++-- .../server/event/game/ReceivePacketEvent.java | 35 +++++++++++++++++++ .../server/event/game/SendPacketEvent.java | 30 ++++++++++++++++ .../server/game/GameServerPacketHandler.java | 11 +++--- .../grasscutter/server/game/GameSession.java | 12 +++---- 5 files changed, 80 insertions(+), 15 deletions(-) create mode 100644 src/main/java/emu/grasscutter/server/event/game/ReceivePacketEvent.java create mode 100644 src/main/java/emu/grasscutter/server/event/game/SendPacketEvent.java diff --git a/src/main/java/emu/grasscutter/server/event/Event.java b/src/main/java/emu/grasscutter/server/event/Event.java index 7dd67b84d..bea7dd66f 100644 --- a/src/main/java/emu/grasscutter/server/event/Event.java +++ b/src/main/java/emu/grasscutter/server/event/Event.java @@ -18,10 +18,9 @@ public abstract class Event { /** * Cancels the event if possible. */ - public void cancel() throws IllegalAccessException { - if(!(this instanceof Cancellable)) - throw new IllegalAccessException("Event is not cancellable."); - this.cancelled = true; + public void cancel() { + if(this instanceof Cancellable) + this.cancelled = true; } /** diff --git a/src/main/java/emu/grasscutter/server/event/game/ReceivePacketEvent.java b/src/main/java/emu/grasscutter/server/event/game/ReceivePacketEvent.java new file mode 100644 index 000000000..51109c720 --- /dev/null +++ b/src/main/java/emu/grasscutter/server/event/game/ReceivePacketEvent.java @@ -0,0 +1,35 @@ +package emu.grasscutter.server.event.game; + +import emu.grasscutter.server.event.Cancellable; +import emu.grasscutter.server.event.ServerEvent; +import emu.grasscutter.server.game.GameSession; + +public final class ReceivePacketEvent extends ServerEvent implements Cancellable { + private final GameSession gameSession; + private final int packetId; + private byte[] packetData; + + public ReceivePacketEvent(GameSession gameSession, int packetId, byte[] packetData) { + super(Type.GAME); + + this.gameSession = gameSession; + this.packetId = packetId; + this.packetData = packetData; + } + + public GameSession getGameSession() { + return this.gameSession; + } + + public int getPacketId() { + return this.packetId; + } + + public void setPacketData(byte[] packetData) { + this.packetData = packetData; + } + + public byte[] getPacketData() { + return this.packetData; + } +} diff --git a/src/main/java/emu/grasscutter/server/event/game/SendPacketEvent.java b/src/main/java/emu/grasscutter/server/event/game/SendPacketEvent.java new file mode 100644 index 000000000..7a25b4e10 --- /dev/null +++ b/src/main/java/emu/grasscutter/server/event/game/SendPacketEvent.java @@ -0,0 +1,30 @@ +package emu.grasscutter.server.event.game; + +import emu.grasscutter.net.packet.GenshinPacket; +import emu.grasscutter.server.event.Cancellable; +import emu.grasscutter.server.event.ServerEvent; +import emu.grasscutter.server.game.GameSession; + +public final class SendPacketEvent extends ServerEvent implements Cancellable { + private final GameSession gameSession; + private GenshinPacket packet; + + public SendPacketEvent(GameSession gameSession, GenshinPacket packet) { + super(Type.GAME); + + this.gameSession = gameSession; + this.packet = packet; + } + + public GameSession getGameSession() { + return this.gameSession; + } + + public void setPacket(GenshinPacket packet) { + this.packet = packet; + } + + public GenshinPacket getPacket() { + return this.packet; + } +} diff --git a/src/main/java/emu/grasscutter/server/game/GameServerPacketHandler.java b/src/main/java/emu/grasscutter/server/game/GameServerPacketHandler.java index 62a57df91..50d508bed 100644 --- a/src/main/java/emu/grasscutter/server/game/GameServerPacketHandler.java +++ b/src/main/java/emu/grasscutter/server/game/GameServerPacketHandler.java @@ -2,6 +2,7 @@ package emu.grasscutter.server.game; import java.util.Set; +import emu.grasscutter.server.event.game.ReceivePacketEvent; import org.reflections.Reflections; import emu.grasscutter.Grasscutter; @@ -48,9 +49,7 @@ public class GameServerPacketHandler { } public void handle(GameSession session, int opcode, byte[] header, byte[] payload) { - PacketHandler handler = null; - - handler = this.handlers.get(opcode); + PacketHandler handler = this.handlers.get(opcode); if (handler != null) { try { @@ -77,8 +76,10 @@ public class GameServerPacketHandler { } } - // Handle - handler.handle(session, header, payload); + // Invoke event. + ReceivePacketEvent event = new ReceivePacketEvent(session, opcode, payload); event.call(); + if(!event.isCanceled()) // If event is not canceled, continue. + handler.handle(session, header, event.getPacketData()); } catch (Exception ex) { // TODO Remove this when no more needed ex.printStackTrace(); diff --git a/src/main/java/emu/grasscutter/server/game/GameSession.java b/src/main/java/emu/grasscutter/server/game/GameSession.java index ebd66dc20..53b4f32cc 100644 --- a/src/main/java/emu/grasscutter/server/game/GameSession.java +++ b/src/main/java/emu/grasscutter/server/game/GameSession.java @@ -10,6 +10,7 @@ import emu.grasscutter.game.GenshinPlayer; import emu.grasscutter.net.packet.GenshinPacket; import emu.grasscutter.net.packet.PacketOpcodesUtil; import emu.grasscutter.netty.MihoyoKcpChannel; +import emu.grasscutter.server.event.game.SendPacketEvent; import emu.grasscutter.utils.Crypto; import emu.grasscutter.utils.FileUtils; import emu.grasscutter.utils.Utils; @@ -161,16 +162,15 @@ public class GameSession extends MihoyoKcpChannel { genshinPacket.buildHeader(this.getNextClientSequence()); } - // Build packet - byte[] data = genshinPacket.build(); - // Log if (Grasscutter.getConfig().getGameServerOptions().LOG_PACKETS) { logPacket(genshinPacket); } - - // Send - send(data); + + // Invoke event. + SendPacketEvent event = new SendPacketEvent(this, genshinPacket); event.call(); + if(!event.isCanceled()) // If event is not cancelled, continue. + this.send(event.getPacket().build()); } private void logPacket(int opcode) {