[Enhancement] - Automatically unzip world.zip in world folder if otbm file doesn't exist on server start (#205)

This change will allow the server to automatically extract the map from the zip (to the global server) in case the .otbm file is not found.

It is necessary to install "libzippp", through the command "./vcpkg install libzippp"

Author: omeranha

.github/workflows/build-windows.yml

@@ -29,7 +29,7 @@ jobs:
             packages: >
               boost-asio boost-iostreams boost-system boost-filesystem
               boost-variant boost-lockfree cryptopp curl jsoncpp
-              luajit libmariadb pugixml spdlog
+              luajit libmariadb pugixml spdlog libzippp
 
     steps:
       - name: Checkout repository

src/CMakeLists.txt

@@ -83,6 +83,7 @@ if (MSVC)
   find_package(PugiXML REQUIRED)
   find_package(spdlog CONFIG REQUIRED)
   find_package(Threads REQUIRED)
+  find_package(libzippp CONFIG REQUIRED)
 else()
   find_package(Boost REQUIRED COMPONENTS system filesystem iostreams date_time)
   find_package(cryptopp CONFIG REQUIRED)
@@ -93,6 +94,7 @@ else()
   find_package(spdlog CONFIG REQUIRED)
   find_package(Threads REQUIRED)
   find_package(unofficial-libmariadb CONFIG REQUIRED)
+  find_package(libzippp CONFIG REQUIRED)
 endif (MSVC)
 
 include(GNUInstallDirs)
@@ -265,6 +267,7 @@ target_link_libraries(${PROJECT_NAME}
     ${CURL_LIBRARIES}
     jsoncpp_lib
     spdlog::spdlog
+    libzippp::libzippp
 )
 
 else()
@@ -290,6 +293,7 @@ else()
       spdlog::spdlog
       Threads::Threads
       ${LUA_LIBRARIES}
+      libzippp::libzippp
   )
 
 endif (MSVC)

src/map/map.cpp

@@ -19,13 +19,17 @@
 
 #include "otpch.h"
 
+#include <boost/filesystem.hpp>
+#include "libzippp.h"
+
 #include "io/iomap.h"
 #include "io/iomapserialize.h"
 #include "creatures/combat/combat.h"
 #include "creatures/creature.h"
 #include "game/game.h"
 #include "creatures/monsters/monster.h"
 #include "creatures/npcs/npc.h"
+#include "utils/tools.h"
 
 extern Game g_game;
 
@@ -38,8 +42,33 @@ bool Map::load(const std::string& identifier) {
 	return true;
 }
 
+bool Map::extractMap(const std::string& identifier) const {
+	if (boost::filesystem::exists(identifier)) {
+		return true;
+	}
+	
+	using namespace libzippp;
+	std::string mapName = g_configManager().getString(MAP_NAME) + ".otbm";
+	SPDLOG_INFO("Unzipping " + mapName + " to world folder");
+	ZipArchive zf("data/world/world.zip");
+
+	if (!zf.open(ZipArchive::ReadOnly)) {
+		SPDLOG_ERROR("[Map::extractMap] - Failed to unzip world.zip, file doesn't exist");
+		consoleHandlerExit();
+		return false;
+	}
+
+	std::ofstream unzippedFile("data/world/" + mapName, std::ofstream::binary);
+	zf.getEntry(mapName).readContent(unzippedFile, ZipArchive::Current);
+	zf.close();
+	return true;
+}
+
 bool Map::loadMap(const std::string& identifier, bool loadHouses, bool loadMonsters, bool loadNpcs)
 {
+	// Extract the map
+	this->extractMap(identifier);
+
 	// Load the map
 	this->load(identifier);
 

src/map/map.h

@@ -187,6 +187,11 @@ class Map
          */
 		bool load(const std::string& identifier);
 		/**
+         * Extract the map.
+         * \returns true if the map was extracted successfully
+         */
+		bool extractMap(const std::string& identifier) const;
+		/**
 		* Load the main map
 		 * \param identifier Is the main map name (name of file .otbm)
 		 * \param loadHouses if true, the main map houses is loaded

src/utils/tools.cpp

@@ -21,7 +21,6 @@
 
 #include "utils/tools.h"
 
-
 void printXMLError(const std::string& where, const std::string& fileName, const pugi::xml_parse_result& result)
 {
 	SPDLOG_ERROR("[{}] Failed to load {}: {}", where, fileName, result.description());
@@ -1410,6 +1409,18 @@ void capitalizeWords(std::string& source)
 	}
 }
 
+/**
+ * @details
+ * Prevents the console from closing so there is time to read the error information
+ * Then can press any key to close
+*/
+void consoleHandlerExit()
+{
+	SPDLOG_ERROR("The program will close after pressing the enter key...");
+	getchar();
+	return;
+}
+
 NameEval_t validateName(const std::string &name)
 {
 

src/utils/tools.h

@@ -105,6 +105,7 @@ ItemAttrTypes stringToItemAttribute(const std::string& str);
 const char* getReturnMessage(ReturnValue value);
 
 void capitalizeWords(std::string &source);
+void consoleHandlerExit();
 NameEval_t validateName(const std::string &name);
 
 bool isCaskItem(uint16_t itemId);

vcpkg.json

@@ -16,6 +16,7 @@
     "curl",
     "jsoncpp",
     "cryptopp",
+    "libzippp",
     {
       "name": "luajit",
       "platform": "windows"