Extract certain resources to memory and not filesystem (#1074)

Author: lochel

3rdParty

@@ -124,6 +124,11 @@ ELSE()
   MESSAGE(STATUS "Using C++17 instead of Boost")
 ENDIF()
 
+##########################
+# Configuring for zip/minizip
+set(MINIZIP_INCLUDEDIR ${PROJECT_SOURCE_DIR}/3rdParty/minizip/install/${PLATFORM_STRING}/include)
+set(MINIZIP_LIBRARYDIR ${PROJECT_SOURCE_DIR}/3rdParty/minizip/install/${PLATFORM_STRING}/lib)
+
 ##########################
 # Configuring for FMILibrary
 set(FMILibrary_ROOT ${PROJECT_SOURCE_DIR}/3rdParty/FMIL/install/${PLATFORM_STRING})
@@ -153,11 +158,6 @@ set(PUGIXML_INCLUDEDIR ${PROJECT_SOURCE_DIR}/3rdParty/PugiXml)
 # Configuring for CTPL
 set(CTPL_INCLUDEDIR ${PROJECT_SOURCE_DIR}/3rdParty/CTPL)
 
-##########################
-# Configuring for minizip
-set(MINIZIP_INCLUDEDIR ${PROJECT_SOURCE_DIR}/3rdParty/zlib/install/${PLATFORM_STRING}/include)
-set(MINIZIP_LIBRARYDIR ${PROJECT_SOURCE_DIR}/3rdParty/zlib/install/${PLATFORM_STRING}/lib)
-
 ##########################
 # Configuring for Python
 find_package(PythonLibs)

CMakeLists.txt

@@ -123,7 +123,7 @@ else
 	CMAKE_BOOST_ROOT="-DBOOST_ROOT=$(BOOST_ROOT)"
 endif
 
-.PHONY: OMSimulator OMSimulatorCore config-OMSimulator config-fmil config-lua config-zlib config-cvode config-kinsol config-3rdParty distclean testsuite doc doc-html doc-doxygen OMTLMSimulator OMTLMSimulatorClean RegEx pip
+.PHONY: OMSimulator OMSimulatorCore config-OMSimulator config-fmil config-lua config-minizip config-cvode config-kinsol config-3rdParty distclean testsuite doc doc-html doc-doxygen OMTLMSimulator OMTLMSimulatorClean RegEx pip
 
 OMSimulator:
 	@echo OS: $(detected_OS)
@@ -195,7 +195,7 @@ RegEx: 3rdParty/RegEx/OMSRegEx$(EEXT)
 	@echo "Please checkout the 3rdParty submodule, e.g. using \"git submodule update --init 3rdParty\", and try again."
 	@false
 
-config-3rdParty: 3rdParty/README.md config-fmil config-lua config-zlib config-cvode config-kinsol config-libxml2
+config-3rdParty: 3rdParty/README.md config-fmil config-lua config-minizip config-cvode config-kinsol config-libxml2
 
 config-OMSimulator: $(BUILD_DIR)/Makefile
 $(BUILD_DIR)/Makefile: RegEx CMakeLists.txt
@@ -224,23 +224,15 @@ config-lua: 3rdParty/Lua/$(INSTALL_DIR)/liblua.a
 	@echo
 	$(MAKE) -C 3rdParty/Lua $(LUA_EXTRA_FLAGS)
 
-config-zlib: 3rdParty/zlib/$(INSTALL_DIR)/libminizip.a
-3rdParty/zlib/$(INSTALL_DIR)/libzlibstatic.a: 3rdParty/zlib/$(BUILD_DIR)/zlib/Makefile
-	$(MAKE) -C 3rdParty/zlib/$(BUILD_DIR)/zlib/ install
-3rdParty/zlib/$(INSTALL_DIR)/libminizip.a: 3rdParty/zlib/$(INSTALL_DIR)/libzlibstatic.a 3rdParty/zlib/$(BUILD_DIR)/minizip/Makefile
-	$(MAKE) -C 3rdParty/zlib/$(BUILD_DIR)/minizip/ install
-3rdParty/zlib/$(BUILD_DIR)/zlib/Makefile:
+config-minizip: 3rdParty/minizip/$(INSTALL_DIR)/libminizip.a
+3rdParty/minizip/$(INSTALL_DIR)/libminizip.a: 3rdParty/minizip/$(BUILD_DIR)/Makefile
+	$(MAKE) -C 3rdParty/minizip/$(BUILD_DIR)/ install
+3rdParty/minizip/$(BUILD_DIR)/Makefile:
 	@echo
-	@echo "# config zlib library"
+	@echo "# config minizip"
 	@echo
-	$(MKDIR) 3rdParty/zlib/$(BUILD_DIR)/zlib
-	cd 3rdParty/zlib/$(BUILD_DIR)/zlib && $(CMAKE) $(CMAKE_TARGET) ../../../zlib-1.2.11 -DCMAKE_INSTALL_PREFIX=../../../$(INSTALL_DIR)
-3rdParty/zlib/$(BUILD_DIR)/minizip/Makefile:
-	@echo
-	@echo "# config zlib minizip"
-	@echo
-	$(MKDIR) 3rdParty/zlib/$(BUILD_DIR)/minizip
-	cd 3rdParty/zlib/$(BUILD_DIR)/minizip && $(CMAKE) $(CMAKE_TARGET) ../../../minizip -DCMAKE_INSTALL_PREFIX=../../../$(INSTALL_DIR)
+	$(MKDIR) 3rdParty/minizip/$(BUILD_DIR)/
+	cd 3rdParty/minizip/$(BUILD_DIR)/ && $(CMAKE) $(CMAKE_TARGET) ../../src -DCMAKE_INSTALL_PREFIX=../../$(INSTALL_DIR)
 
 config-cvode: 3rdParty/cvode/$(INSTALL_DIR)/lib/libsundials_cvode.a
 3rdParty/cvode/$(INSTALL_DIR)/lib/libsundials_cvode.a: 3rdParty/cvode/$(BUILD_DIR)/Makefile

Makefile

@@ -66,7 +66,7 @@ IF NOT EXIST install\\win\\lib MKDIR install\\win\\lib
 IF ["%TARGET%"]==["clean"] GOTO clean
 IF ["%TARGET%"]==["fmil"] GOTO fmil
 IF ["%TARGET%"]==["lua"] GOTO lua
-IF ["%TARGET%"]==["zlib"] GOTO zlib
+IF ["%TARGET%"]==["minizip"] GOTO minizip
 IF ["%TARGET%"]==["cvode"] GOTO cvode
 IF ["%TARGET%"]==["kinsol"] GOTO kinsol
 IF ["%TARGET%"]==["pthread"] GOTO pthread
@@ -117,29 +117,21 @@ EXIT /B 0
 :: -- build Lua -----------------------
 
 
-:: -- build zlib ----------------------
-:zlib
-ECHO # config zlib
-IF EXIST "3rdParty\zlib\build\win\" RMDIR /S /Q 3rdParty\zlib\build\win
-IF EXIST "3rdParty\zlib\install\win\" RMDIR /S /Q 3rdParty\zlib\install\win
-MKDIR 3rdParty\zlib\build\win\zlib
-CD 3rdParty\zlib\build\win\zlib
-cmake.exe -G %OMS_VS_VERSION% ..\..\..\zlib-1.2.11\ -DCMAKE_INSTALL_PREFIX=..\..\..\install\win
-IF NOT ["%ERRORLEVEL%"]==["0"] GOTO fail
-CD ..\..\..\..\..
-MKDIR 3rdParty\zlib\build\win\minizip
-CD 3rdParty\zlib\build\win\minizip
-cmake.exe -G %OMS_VS_VERSION% ..\..\..\minizip\ -DCMAKE_INSTALL_PREFIX=..\..\..\install\win
-IF NOT ["%ERRORLEVEL%"]==["0"] GOTO fail
-CD ..\..\..\..\..
-ECHO # build zlib
-msbuild.exe "3rdParty\zlib\build\win\zlib\INSTALL.vcxproj" /t:Build /p:configuration=Release /maxcpucount
+:: -- build minizip ----------------------
+:minizip
+ECHO # config minizip
+IF EXIST "3rdParty\minizip\build\win\" RMDIR /S /Q 3rdParty\minizip\build\win
+IF EXIST "3rdParty\minizip\install\win\" RMDIR /S /Q 3rdParty\minizip\install\win
+MKDIR 3rdParty\minizip\build\win
+CD 3rdParty\minizip\build\win
+cmake.exe -G %OMS_VS_VERSION% ..\..\src\ -DCMAKE_INSTALL_PREFIX=..\..\install\win
 IF NOT ["%ERRORLEVEL%"]==["0"] GOTO fail
+CD ..\..\..\..
 ECHO # build minizip
-msbuild.exe "3rdParty\zlib\build\win\minizip\INSTALL.vcxproj" /t:Build /p:configuration=Release /maxcpucount
+msbuild.exe "3rdParty\minizip\build\win\INSTALL.vcxproj" /t:Build /p:configuration=Release /maxcpucount
 IF NOT ["%ERRORLEVEL%"]==["0"] GOTO fail
 EXIT /B 0
-:: -- build zlib ----------------------
+:: -- build minizip ----------------------
 
 
 :: -- config cvode --------------------
@@ -244,7 +236,7 @@ START /B /WAIT CMD /C "%~0 %OMS_VS_TARGET% fmil"
 IF NOT ["%ERRORLEVEL%"]==["0"] GOTO fail
 START /B /WAIT CMD /C "%~0 %OMS_VS_TARGET% lua"
 IF NOT ["%ERRORLEVEL%"]==["0"] GOTO fail
-START /B /WAIT CMD /C "%~0 %OMS_VS_TARGET% zlib"
+START /B /WAIT CMD /C "%~0 %OMS_VS_TARGET% minizip"
 IF NOT ["%ERRORLEVEL%"]==["0"] GOTO fail
 START /B /WAIT CMD /C "%~0 %OMS_VS_TARGET% cvode"
 IF NOT ["%ERRORLEVEL%"]==["0"] GOTO fail

configWinVS.bat

@@ -5,12 +5,12 @@ set(CMAKE_INSTALL_RPATH "$ORIGIN/../lib/${HOST_SHORT}:$ORIGIN/")
 include_directories(../OMSimulatorLib)
 
 link_directories(
+  ${MINIZIP_LIBRARYDIR}
   ${FMILibrary_LIBRARYDIR}
   ${LUALibrary_LIBRARYDIR}
   ${CVODELibrary_LIBRARYDIR}
   ${KINSOLLibrary_LIBRARYDIR}
-  ${Boost_LIBRARY_DIRS}
-  ${MINIZIP_LIBRARYDIR})
+  ${Boost_LIBRARY_DIRS})
 IF (OMTLM)
   link_directories(${OMTLMSIMULATORLIB_LIBRARYDIR})
 ENDIF ()

src/OMSimulator/CMakeLists.txt

@@ -109,13 +109,13 @@ include_directories(
   ../../3rdParty/RegEx
   ../OMSimulatorLib
   ../OMSimulatorLua
+  ${MINIZIP_INCLUDEDIR}
   ${Boost_INCLUDE_DIRS}
   ${CTPL_INCLUDEDIR}
   ${CVODELibrary_INCLUDEDIR}
   ${FMILibrary_INCLUDEDIR}
   ${KINSOLLibrary_INCLUDEDIR}
   ${LUALibrary_INCLUDEDIR}
-  ${MINIZIP_INCLUDEDIR}
   ${OMTLM_SOURCES}
   ${PUGIXML_INCLUDEDIR})
 IF (OMTLM)
@@ -126,12 +126,12 @@ IF (OMTLM)
 ENDIF (OMTLM)
 
 link_directories(
+  ${MINIZIP_LIBRARYDIR}
   ${FMILibrary_LIBRARYDIR}
   ${LUALibrary_LIBRARYDIR}
   ${CVODELibrary_LIBRARYDIR}
   ${KINSOLLibrary_LIBRARYDIR}
-  ${Boost_LIBRARY_DIRS}
-  ${MINIZIP_LIBRARYDIR})
+  ${Boost_LIBRARY_DIRS})
 IF (OMTLM)
   link_directories(${OMTLMSIMULATORLIB_LIBRARYDIR})
 ENDIF ()
@@ -156,8 +156,8 @@ IF (WIN32 AND MSVC)
   add_definitions(-DBOOST_ALL_DYN_LINK)
 ENDIF ()
 
-target_link_libraries(OMSimulatorLib fmilib sundials_kinsol sundials_cvode sundials_nvecserial minizip ${LIB_ATOMIC} ${Boost_LIBRARIES} ${OMTLM_LINKFLAGS} ${CMAKE_DL_LIBS} ${CMAKE_THREAD_LIBS_INIT} ${CPP_FS_LIBS})
-target_link_libraries(OMSimulatorLib_static fmilib sundials_kinsol sundials_cvode sundials_nvecserial minizip lua ${CMAKE_DL_LIBS} ${LIB_ATOMIC} ${CMAKE_THREAD_LIBS_INIT} ${Boost_LIBRARIES} ${OMTLM_LINKFLAGS} ${CPP_FS_LIBS})
+target_link_libraries(OMSimulatorLib minizip fmilib sundials_kinsol sundials_cvode sundials_nvecserial ${LIB_ATOMIC} ${Boost_LIBRARIES} ${OMTLM_LINKFLAGS} ${CMAKE_DL_LIBS} ${CMAKE_THREAD_LIBS_INIT} ${CPP_FS_LIBS})
+target_link_libraries(OMSimulatorLib_static minizip fmilib sundials_kinsol sundials_cvode sundials_nvecserial lua ${CMAKE_DL_LIBS} ${LIB_ATOMIC} ${CMAKE_THREAD_LIBS_INIT} ${Boost_LIBRARIES} ${OMTLM_LINKFLAGS} ${CPP_FS_LIBS})
 
 IF (WIN32 AND MINGW)
   target_link_libraries(OMSimulatorLib shlwapi)

src/OMSimulatorLib/CMakeLists.txt

@@ -1596,34 +1596,14 @@ oms_status_enu_t oms_extractFMIKind(const char* filename, oms_fmi_kind_enu_t* ki
   if (!kind)
     return logError("Invalid argument \"kind=NULL\"");
 
-  // Usage: miniunz [-e] [-x] [-v] [-l] [-o] [-p password] file.zip [file_to_extr.] [-d extractdir]
-  //        -e  Extract without pathname (junk paths)
-  //        -x  Extract with pathname
-  //        -v  list files
-  //        -l  list files
-  //        -d  directory to extract into
-  //        -o  overwrite files without prompting
-  //        -p  extract crypted file using password
-
-  std::string cd = oms::Scope::GetInstance().getWorkingDirectory();
-  int argc = 6;
-  char **argv = new char*[argc];
-  int i=0;
-  argv[i++] = (char*)"miniunz";
-  argv[i++] = (char*)"-xo";
-  argv[i++] = (char*)filename;
-  argv[i++] = (char*)"modelDescription.xml";
-  argv[i++] = (char*)"-d";
-  argv[i++] = (char*)oms::Scope::GetInstance().getTempDirectory().c_str();
-  int status = ::miniunz(argc, argv);
-  delete[] argv;
-  oms::Scope::GetInstance().setWorkingDirectory(cd);
-
-  if (status != 0)
-    return logError("failed to extract modelDescription.xml from \"" + std::string(filename) + "\"");
+  const char* modelDescription = ::miniunz_onefile_to_memory(filename, "modelDescription.xml");
+  if (!modelDescription)
+    return logError("failed to extract \"modelDescription.xml\" from \"" + std::string(filename) + "\"");
 
   oms::Snapshot snapshot;
-  if (oms_status_ok != snapshot.importResourceFile("modelDescription.xml", oms::Scope::GetInstance().getTempDirectory()))
+  oms_status_enu_t status = snapshot.importResourceMemory("modelDescription.xml", modelDescription);
+  ::miniunz_free(modelDescription);
+  if (oms_status_ok != status)
     return logError("Failed to import");
   const pugi::xml_node node = snapshot.getResourceNode("modelDescription.xml");
 

src/OMSimulatorLib/OMSimulator.cpp

@@ -141,12 +141,10 @@ oms_status_enu_t oms::Scope::exportModel(const oms::ComRef& cref, const std::str
   return model->exportToFile(filename);
 }
 
-oms_status_enu_t oms::Scope::miniunz(const std::string& filename, const std::string& extractdir, bool systemStructure)
+oms_status_enu_t oms::Scope::miniunz(const std::string& filename, const std::string& extractdir)
 {
-  // This function is used to extract (1) complete SSP/FMU files or to extract
-  // (2) the SystemStructure.ssd from an SSP file:
-  //     (1) miniunz -xo <filename> -d <extractdir>
-  //     (2) miniunz -xo <filename> SystemStructure.ssd -d <extractdir>
+  // This function is used to extract complete SSP/FMU files:
+  //        miniunz -xo <filename> -d <extractdir>
 
   // Usage: miniunz [-e] [-x] [-v] [-l] [-o] [-p password] file.zip [file_to_extr.] [-d extractdir]
   //        -e  Extract without pathname (junk paths)
@@ -159,14 +157,12 @@ oms_status_enu_t oms::Scope::miniunz(const std::string& filename, const std::str
 
   std::string cd = Scope::GetInstance().getWorkingDirectory();
 
-  int argc = systemStructure ? 6 : 5;
+  int argc = 5;
   char **argv = new char*[argc];
   int i=0;
   argv[i++] = (char*)"miniunz";
   argv[i++] = (char*)"-xo";
   argv[i++] = (char*)filename.c_str();
-  if (systemStructure)
-    argv[i++] = (char*)"SystemStructure.ssd";
   argv[i++] = (char*)"-d";
   argv[i++] = (char*)extractdir.c_str();
   int status = ::miniunz(argc, argv);
@@ -195,13 +191,17 @@ oms_status_enu_t oms::Scope::importModel(const std::string& filename, char** _cr
   if (extension != ".ssp")
     return logError("filename extension must be \".ssp\"; no other formats are supported");
 
-  // extract SystemStructure.ssd to temp
-  filesystem::path temp_root(getTempDirectory());
-  if (oms_status_ok != oms::Scope::miniunz(filename, temp_root.string(), true))
-    return logError("failed to extract \"SystemStructure.ssd\" from \"" + filename + "\"");
+  // extract SystemStructure.ssd to memory
+  const char* systemStructure = ::miniunz_onefile_to_memory(filename.c_str(), "SystemStructure.ssd");
+  if (!systemStructure)
+    return logError("failed to extract \"SystemStructure.ssd\" from \"" + std::string(filename) + "\"");
 
   Snapshot snapshot;
-  snapshot.importResourceFile("SystemStructure.ssd", temp_root);
+  oms_status_enu_t status = snapshot.importResourceMemory("SystemStructure.ssd", systemStructure);
+  ::miniunz_free(systemStructure);
+  if (oms_status_ok != status)
+    return logError("Failed to import");
+
   const pugi::xml_node node = snapshot.getResourceNode("SystemStructure.ssd");
   if (!node)
     return logError("failed to load \"SystemStructure.ssd\"");
@@ -217,7 +217,7 @@ oms_status_enu_t oms::Scope::importModel(const std::string& filename, char** _cr
     logWarning("Unknown SSD version: " + ssdVersion);
 
   // extract the ssp file
-  oms::Scope::miniunz(filename, model->getTempDirectory(), false);
+  oms::Scope::miniunz(filename, model->getTempDirectory());
 
   std::string cd = Scope::GetInstance().getWorkingDirectory();
   Scope::GetInstance().setWorkingDirectory(model->getTempDirectory());
@@ -233,7 +233,7 @@ oms_status_enu_t oms::Scope::importModel(const std::string& filename, char** _cr
 
   // snapshot.debugPrintAll();
 
-  oms_status_enu_t status = model->importFromSnapshot(snapshot);
+  status = model->importFromSnapshot(snapshot);
   model->copyResources(old_copyResources);
 
   Scope::GetInstance().setWorkingDirectory(cd);

src/OMSimulatorLib/Scope.cpp

@@ -77,7 +77,7 @@ namespace oms
     std::string getWorkingDirectory();
 
   protected:
-    static oms_status_enu_t miniunz(const std::string& filename, const std::string& extractdir, bool systemStructure);
+    static oms_status_enu_t miniunz(const std::string& filename, const std::string& extractdir);
 
   private:
     std::vector<Model*> models; ///< last element is always NULL