Merge pull request #205 from yuzumika/face-hair-dedup #patch

use isFace and isHair in ItemInformationProvider.getStringData

config.yaml

@@ -234,6 +234,7 @@ server:
     USE_STARTING_AP_4: false             #Use early-GMS 4/4/4/4 starting stats. To overcome AP shortage, this gives 4AP/5AP at 1st/2nd job advancements.
     USE_AUTOBAN: false                  #Commands the server to detect infractors automatically.
     USE_AUTOBAN_LOG: true               #Log autoban related messages. Still logs even with USE_AUTOBAN disabled.
+    USE_EXP_GAIN_LOG: false #Logs characters exp gains; logs world rate & coupon exp, total gained exp, and current exp, level can be calculated from "ExpTable".
     USE_AUTOSAVE: true                  #Enables server autosaving feature (saves characters to DB each 1 hour).
     USE_SERVER_AUTOASSIGNER: false       #HeavenMS-builtin autoassigner, uses algorithm based on distributing AP accordingly with required secondary stat on equipments.
     USE_REFRESH_RANK_MOVE: true

database/sql/1-db_database.sql

@@ -21484,6 +21484,17 @@ CREATE TABLE IF NOT EXISTS `worldtransfers` (
   INDEX (characterid)
 ) ENGINE=InnoDB  DEFAULT CHARSET=latin1 AUTO_INCREMENT=1 ;
 
+CREATE TABLE IF NOT EXISTS `characterexplogs` (
+    `id` BIGINT NOT NULL AUTO_INCREMENT,
+  	`world_exp_rate` INT,
+    `exp_coupon` INT,
+    `gained_exp` BIGINT,
+    `current_exp` INT,
+    `exp_gain_time` DATETIME,
+    `charid` int(11) NOT NULL,
+    PRIMARY KEY (`id`),
+    FOREIGN KEY (`charid`) REFERENCES `characters`(`id`) ON DELETE CASCADE
+) ENGINE=InnoDB DEFAULT CHARSET=latin1 AUTO_INCREMENT=1 ;
 
 ALTER TABLE `dueyitems`
   ADD CONSTRAINT `dueyitems_ibfk_1` FOREIGN KEY (`PackageId`) REFERENCES `dueypackages` (`PackageId`) ON DELETE CASCADE;

src/main/java/client/Character.java

@@ -59,6 +59,7 @@ import scripting.AbstractPlayerInteraction;
 import scripting.event.EventInstanceManager;
 import scripting.item.ItemScriptManager;
 import server.*;
+import server.ExpLogger.ExpLogRecord;
 import server.ItemInformationProvider.ScriptedItem;
 import server.events.Events;
 import server.events.RescueGaga;
@@ -150,6 +151,7 @@ public class Character extends AbstractCharacterObject {
     private final AtomicInteger gachaexp = new AtomicInteger();
     private final AtomicInteger meso = new AtomicInteger();
     private final AtomicInteger chair = new AtomicInteger(-1);
+    private long totalExpGained = 0;
     private int merchantmeso;
     private BuddyList buddylist;
     private EventInstanceManager eventInstance = null;
@@ -3092,6 +3094,7 @@ public class Character extends AbstractCharacterObject {
                 leftover = nextExp - Integer.MAX_VALUE;
             }
             updateSingleStat(Stat.EXP, exp.addAndGet((int) total));
+            totalExpGained += total;
             if (show) {
                 announceExpGain(gain, equip, party, inChat, white);
             }
@@ -3108,6 +3111,20 @@ public class Character extends AbstractCharacterObject {
                 gainExpInternal(leftover, equip, party, false, inChat, white);
             } else {
                 lastExpGainTime = System.currentTimeMillis();
+
+                if (YamlConfig.config.server.USE_EXP_GAIN_LOG) {
+                    ExpLogRecord expLogRecord = new ExpLogger.ExpLogRecord(
+                        getWorldServer().getExpRate(),
+                        expCoupon,
+                        totalExpGained,
+                        exp.get(),
+                        new Timestamp(lastExpGainTime),
+                        id
+                    );
+                    ExpLogger.putExpLogRecord(expLogRecord);
+                }
+
+                totalExpGained = 0;
             }
         }
     }

src/main/java/config/ServerConfig.java

@@ -82,6 +82,7 @@ public class ServerConfig {
     public boolean USE_STARTING_AP_4;
     public boolean USE_AUTOBAN;
     public boolean USE_AUTOBAN_LOG;
+    public boolean USE_EXP_GAIN_LOG;
     public boolean USE_AUTOSAVE;
     public boolean USE_SERVER_AUTOASSIGNER;
     public boolean USE_REFRESH_RANK_MOVE;

src/main/java/scripting/quest/QuestScriptManager.java

@@ -107,7 +107,7 @@ public class QuestScriptManager extends AbstractScriptManager {
 
     public void end(Client c, short questid, int npc) {
         Quest quest = Quest.getInstance(questid);
-        if (!c.getPlayer().getQuest(quest).getStatus().equals(QuestStatus.Status.STARTED) || !c.getPlayer().getMap().containsNPC(npc)) {
+        if (!c.getPlayer().getQuest(quest).getStatus().equals(QuestStatus.Status.STARTED) || (!c.getPlayer().getMap().containsNPC(npc) && !quest.isAutoComplete())) {
             dispose(c);
             return;
         }

src/main/java/server/ExpLogger.java

@@ -0,0 +1,93 @@
+package server;
+
+import java.sql.Connection;
+import java.sql.PreparedStatement;
+import java.sql.SQLException;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.concurrent.Executors;
+import java.util.concurrent.LinkedBlockingQueue;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.ThreadFactory;
+import java.sql.Timestamp;
+import static java.util.concurrent.TimeUnit.*;
+
+import config.YamlConfig;
+import tools.DatabaseConnection;
+
+public class ExpLogger {
+    private static final LinkedBlockingQueue<ExpLogRecord> expLoggerQueue = new LinkedBlockingQueue<>();
+    private static final short EXP_LOGGER_THREAD_SLEEP_DURATION_SECONDS = 60;
+    private static final short EXP_LOGGER_THREAD_SHUTDOWN_WAIT_DURATION_MINUTES = 5;
+
+    public record ExpLogRecord(int worldExpRate, int expCoupon, long gainedExp, int currentExp,Timestamp expGainTime, int charid) {}
+
+    public static void putExpLogRecord(ExpLogRecord expLogRecord) {
+        try {
+            expLoggerQueue.put(expLogRecord);
+        } catch (InterruptedException e) {
+            e.printStackTrace();
+        }
+    }
+
+    static private ScheduledExecutorService schdExctr = Executors.newSingleThreadScheduledExecutor(new ThreadFactory() {
+        @Override
+        public Thread newThread(Runnable r) {
+            Thread t = new Thread(r);
+            t.setPriority(Thread.MIN_PRIORITY);
+            return t;
+        }
+    });
+
+    private static Runnable saveExpLoggerToDBRunnable = new Runnable() {
+        @Override
+        public void run() {
+            try (Connection con = DatabaseConnection.getConnection();
+                    PreparedStatement ps = con.prepareStatement("INSERT INTO characterexplogs (world_exp_rate, exp_coupon, gained_exp, current_exp, exp_gain_time, charid) VALUES (?, ?, ?, ?, ?, ?)")) {
+
+                List<ExpLogRecord> drainedExpLogs = new ArrayList<>();
+                expLoggerQueue.drainTo(drainedExpLogs);
+                for (ExpLogRecord expLogRecord : drainedExpLogs) {
+                    ps.setInt(1, expLogRecord.worldExpRate);
+                    ps.setInt(2, expLogRecord.expCoupon);
+                    ps.setLong(3, expLogRecord.gainedExp);
+                    ps.setInt(4, expLogRecord.currentExp);
+                    ps.setTimestamp(5, expLogRecord.expGainTime);
+                    ps.setInt(6, expLogRecord.charid);
+                    ps.addBatch();
+                }
+                ps.executeBatch();
+            } catch (SQLException sqle) {
+                sqle.printStackTrace();
+            }
+        }
+    };
+
+
+    private static void startExpLogger() {
+        schdExctr.scheduleWithFixedDelay(saveExpLoggerToDBRunnable, EXP_LOGGER_THREAD_SLEEP_DURATION_SECONDS, EXP_LOGGER_THREAD_SLEEP_DURATION_SECONDS, SECONDS);
+        Runtime.getRuntime().addShutdownHook(new Thread(() -> {
+           stopExpLogger();
+        }));
+    }
+
+    private static boolean stopExpLogger() {
+        schdExctr.shutdown();
+        try {
+            schdExctr.awaitTermination(EXP_LOGGER_THREAD_SHUTDOWN_WAIT_DURATION_MINUTES, MINUTES);
+            Thread runThreadBeforeShutdown = new Thread(saveExpLoggerToDBRunnable);
+            runThreadBeforeShutdown.setPriority(Thread.MIN_PRIORITY);
+            runThreadBeforeShutdown.start();
+            return true;
+        } catch (InterruptedException e) {
+            e.printStackTrace();
+            return false;
+        }
+    }
+
+    static {
+        if (YamlConfig.config.server.USE_EXP_GAIN_LOG) {
+            startExpLogger();
+        }
+    }
+}

src/main/java/server/ItemInformationProvider.java

@@ -204,13 +204,13 @@ public class ItemInformationProvider {
         } else if (itemId >= 1040000 && itemId < 1050000) {
             theData = eqpStringData;
             cat = "Eqp/Coat";
-        } else if (itemId >= 20000 && itemId < 22000) {
+        } else if (ItemConstants.isFace(itemId)) {
             theData = eqpStringData;
             cat = "Eqp/Face";
         } else if (itemId >= 1080000 && itemId < 1090000) {
             theData = eqpStringData;
             cat = "Eqp/Glove";
-        } else if (itemId >= 30000 && itemId < 35000) {
+        } else if (ItemConstants.isHair(itemId)) {
             theData = eqpStringData;
             cat = "Eqp/Hair";
         } else if (itemId >= 1050000 && itemId < 1060000) {