Program Database & Archive Library

.github/workflows/continuous_integration.yml

@@ -13,7 +13,7 @@ jobs:
         - {
             name: "macOS",
             os: macos-12,
-            deps_cmdline: "brew install fluidsynth freeimage ftgl glm lua mpg123 sfml wxwidgets"
+            deps_cmdline: "brew install fluidsynth freeimage ftgl glm lua mpg123 sfml sqlite wxwidgets"
           }
         - {
             name: "Linux GCC",
@@ -22,7 +22,7 @@ jobs:
 						   sudo apt-add-repository 'deb https://repos.codelite.org/wx3.2.0/ubuntu/ focal universe' && \
 						   sudo apt update && sudo apt install \
                            libfluidsynth-dev libfreeimage-dev libftgl-dev libglm-dev libgtk-3-dev \
-                           liblua5.3-dev libmpg123-dev libsfml-dev libwxgtk3.2unofficial-dev"
+                           liblua5.3-dev libmpg123-dev libsfml-dev libsqlite3-dev libwxgtk3.2unofficial-dev"
           }
         - {
             name: "Linux Clang",
@@ -32,7 +32,7 @@ jobs:
 						   sudo apt-add-repository 'deb https://repos.codelite.org/wx3.2.0/ubuntu/ focal universe' && \
 						   sudo apt update && sudo apt install \
                            libfluidsynth-dev libfreeimage-dev libftgl-dev libglm-dev libgtk-3-dev \
-                           liblua5.3-dev libmpg123-dev libsfml-dev libwxgtk3.2unofficial-dev"
+                           liblua5.3-dev libmpg123-dev libsfml-dev libsqlite3-dev libwxgtk3.2unofficial-dev"
           }
 
     steps:

.gitignore

@@ -39,6 +39,7 @@
 !/dist/res
 !/dist/CMakeLists.txt
 !/dist/makebuild.ps1
+!/dist/7z_command.cmake
 
 /msvc/*
 !/msvc/resource.h

cmake/unix.cmake

@@ -111,6 +111,7 @@ if (NOT NO_LUA)
 endif()
 find_package(MPG123 REQUIRED)
 find_package(glm REQUIRED)
+find_package(SQLite3 REQUIRED)
 include_directories(
 	${FREEIMAGE_INCLUDE_DIR}
 	${SFML_INCLUDE_DIR}
@@ -180,6 +181,7 @@ target_link_libraries(slade
 	${LUA_LIBRARIES}
 	${MPG123_LIBRARIES}
 	glm::glm
+	sqlite3
 )
 
 if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU" AND CMAKE_CXX_COMPILER_VERSION LESS 9)

cmake/win_msvc.cmake

@@ -37,6 +37,8 @@ find_package(MPG123 CONFIG REQUIRED)
 find_package(OpenGL REQUIRED)
 find_package(SFML COMPONENTS system audio window network CONFIG REQUIRED)
 find_package(glm REQUIRED)
+find_package(unofficial-sqlite3 CONFIG REQUIRED)
+#find_package(xxHash CONFIG REQUIRED)
 
 
 # Include Search Paths ---------------------------------------------------------
@@ -46,6 +48,7 @@ include_directories(
 	.
 	..
 	../thirdparty/glad/include
+	../thirdparty/SQLiteCpp/include
 	./Application
 )
 
@@ -97,6 +100,8 @@ target_link_libraries(slade
 	sfml-network
 	sfml-window
 	glm::glm
+	unofficial::sqlite3::sqlite3
+#	xxHash::xxhash
 )
 
 if (NOT NO_LUA)

dist/res/actions.cfg

@@ -12,6 +12,7 @@
 #include "actions/ptxt.cfg" // TextEntryPanel
 #include "actions/mapw.cfg" // MapEditorWindow
 #include "actions/scrm.cfg" // ScriptManagerWindow
+#include "actions/alib.cfg" // LibraryPanel
 
 // MapEntryPanel
 action pmap_open_text

dist/res/actions/alib.cfg

@@ -0,0 +1,21 @@
+
+action alib_open
+{
+	text		= "Open";
+	icon		= "open";
+	help_text	= "Open the seleted archive(s)";
+}
+
+action alib_remove
+{
+	text		= "Remove";
+	icon		= "delete";
+	help_text	= "Remove the selected archive(s) from the library";
+}
+
+action alib_run
+{
+	text		= "Run";
+	icon		= "run";
+	help_text	= "Run the selected archive";
+}

dist/res/actions/main.cfg

@@ -32,7 +32,7 @@ action main_setbra
 
 action main_preferences
 {
-	text			= "&Preferences...";
+	text			= "&Preferences";
 	icon			= "settings";
 	help_text		= "Setup SLADE options and preferences";
 	custom_wx_id	= 5022; // wxID_PREFERENCES
@@ -100,7 +100,7 @@ action main_about
 
 action main_updatecheck
 {
-	text		= "Check for Updates...";
+	text		= "Check for Updates";
 	help_text	= "Check online for updates";
 	icon		= "up";
 }
@@ -111,3 +111,10 @@ action main_runscript
 	icon		= "script";
 	help_text	= "Open the Script Manager to write/run a SLADE script";
 }
+
+action main_showlibrary
+{
+	text = "Archive Library";
+	icon = "library";
+	help_text = "Open the SLADE Archive Library";
+}

dist/res/config/archive_formats.cfg

@@ -13,8 +13,8 @@ archive_formats
 
 		extensions
 		{
-			wad = "WAD";
-			iwad = "IWAD";
+			wad = "Doom WAD";
+			iwad = "Doom IWAD";
 			dta = "SRB2 DTA";
 			gwa = "GL-Nodes WAD";
 			hwa = "EDGE HWA";
@@ -56,7 +56,7 @@ archive_formats
 	{
 		name = "Quake BSP";
 		entry_format = "archive_bsp";
-		extensions { bsp = "BSP"; }
+		extensions { bsp = "Quake BSP"; }
 	}
 
 	bz2
@@ -209,7 +209,7 @@ archive_formats
 		max_name_length = 16;
 		names_extensions = false;
 		entry_format = "archive_wad2";
-		extensions { wad = "WAD2"; }
+		extensions { wad = "Quake WAD2"; }
 	}
 
 	wadj
@@ -220,7 +220,7 @@ archive_formats
 		max_name_length = 8;
 		entry_format = "archive_wadj";
 		prefer_uppercase = true;
-		extensions { wad = "WAD"; }
+		extensions { wad = "Jaguar Doom WAD"; }
 	}
 
 	wolf
@@ -249,6 +249,6 @@ archive_formats
 		max_name_length = 120;
 		supports_dirs = true;
 		entry_format = "archive_sin";
-		extensions { sin = "SiN"; }
+		extensions { sin = "SiN File"; }
 	}
 }

dist/res/database/tables/archive_bookmark.sql

@@ -0,0 +1,12 @@
+BEGIN;
+
+CREATE TABLE archive_bookmark (
+    archive_id INTEGER REFERENCES archive_file (id) ON DELETE CASCADE,
+    entry_id   INTEGER,
+    UNIQUE (
+        archive_id,
+        entry_id
+    )
+);
+
+COMMIT;

dist/res/database/tables/archive_entry.sql

@@ -0,0 +1,24 @@
+BEGIN;
+
+CREATE TABLE archive_entry (
+    archive_id INTEGER REFERENCES archive_file (id) ON DELETE CASCADE,
+    id         INTEGER,
+    path       TEXT,
+    [index]    INTEGER,
+    name       TEXT,
+    size       INTEGER,
+    hash       TEXT,
+    type_id    TEXT,
+    CONSTRAINT primary_key UNIQUE (
+        archive_id,
+        id
+    )
+);
+
+CREATE INDEX entry_match ON archive_entry (
+    name,
+    path,
+    hash
+);
+
+COMMIT;

dist/res/database/tables/archive_entry_property.sql

@@ -0,0 +1,16 @@
+BEGIN;
+
+CREATE TABLE archive_entry_property (
+    archive_id INTEGER REFERENCES archive_file (id) ON DELETE CASCADE,
+    entry_id   INTEGER,
+    [key]      TEXT,
+    value_type INTEGER,
+    value      NONE,
+    UNIQUE (
+        archive_id,
+        entry_id,
+        [key]
+    )
+);
+
+COMMIT;

dist/res/database/tables/archive_file.sql

@@ -0,0 +1,14 @@
+BEGIN;
+
+CREATE TABLE archive_file (
+	id            INTEGER  PRIMARY KEY,
+	path          TEXT     UNIQUE,		                                  -- Path to the archive file on disk (or directory), must be unique in the table
+    size          INTEGER,                                                -- Size of the file on disk (in bytes)
+    hash          TEXT,                                                   -- Hash (xxHash 128-bit) of the file data on disk
+    format_id     TEXT,                                                   -- Archive format id (eg. 'wad')
+    last_opened   DATETIME,                                               -- Time the archive was last opened in SLADE
+    last_modified DATETIME,                                               -- Modified time of the file on disk
+	parent_id     INTEGER  REFERENCES archive_file (id) ON DELETE CASCADE -- For archives within archives, the id of this archive's parent
+);
+
+COMMIT;

dist/res/database/tables/archive_map.sql

@@ -0,0 +1,14 @@
+BEGIN;
+
+CREATE TABLE archive_map (
+    archive_id      INTEGER REFERENCES archive_file (id) ON DELETE CASCADE,
+    header_entry_id INTEGER,
+    name            TEXT,
+    format          INTEGER,
+    UNIQUE (
+        archive_id,
+        header_entry_id
+    )
+);
+
+COMMIT;

dist/res/database/tables/archive_map_config.sql

@@ -0,0 +1,9 @@
+BEGIN;
+
+CREATE TABLE archive_map_config (
+    archive_id INTEGER REFERENCES archive_file (id) ON DELETE CASCADE,
+    game       TEXT,
+    port       TEXT
+);
+
+COMMIT;

dist/res/database/tables/archive_run_config.sql

@@ -0,0 +1,12 @@
+BEGIN;
+
+CREATE TABLE archive_run_config (
+    archive_id    INTEGER PRIMARY KEY
+                          REFERENCES archive_file (id) ON DELETE CASCADE,
+    executable_id TEXT,
+    run_config    INTEGER,
+    run_extra     TEXT,
+    iwad_path     TEXT
+);
+
+COMMIT;

dist/res/database/tables/archive_ui_config.sql

@@ -0,0 +1,18 @@
+BEGIN;
+
+CREATE TABLE archive_ui_config (
+    archive_id            INTEGER PRIMARY KEY
+                                  REFERENCES archive_file (id) ON DELETE CASCADE,
+    elist_index_visible   BOOLEAN,
+    elist_index_width     INTEGER,
+    elist_name_width      INTEGER,
+    elist_size_visible    BOOLEAN,
+    elist_size_width      INTEGER,
+    elist_type_visible    BOOLEAN,
+    elist_type_width      INTEGER,
+    elist_sort_column     TEXT,
+    elist_sort_descending BOOLEAN,
+    splitter_position     INTEGER
+);
+
+COMMIT;

dist/res/database/tables/db_info.sql

@@ -0,0 +1,7 @@
+BEGIN;
+
+CREATE TABLE db_info (
+    version INTEGER
+);
+
+COMMIT;

dist/res/database/tables/session.sql

@@ -0,0 +1,13 @@
+BEGIN;
+
+CREATE TABLE session (
+    id               INTEGER  PRIMARY KEY,
+    opened_time      DATETIME,
+    closed_time      DATETIME,
+    version_major    INTEGER,
+    version_minor    INTEGER,
+    version_revision INTEGER,
+    version_beta     INTEGER
+);
+
+COMMIT;

dist/res/database/tables/ui_state.sql

@@ -0,0 +1,8 @@
+BEGIN;
+
+CREATE TABLE ui_state (
+    name  TEXT PRIMARY KEY,
+    value NONE
+);
+
+COMMIT;

dist/res/database/tables/window_info.sql

@@ -0,0 +1,12 @@
+BEGIN;
+
+CREATE TABLE window_info (
+    window_id TEXT    PRIMARY KEY
+                      NOT NULL,
+    left      INTEGER,
+    top       INTEGER,
+    width     INTEGER,
+    height    INTEGER
+);
+
+COMMIT;

dist/res/database/tables/window_layout.sql

@@ -0,0 +1,13 @@
+BEGIN;
+
+CREATE TABLE window_layout (
+    window_id TEXT,
+    component TEXT,
+    layout    TEXT,
+    UNIQUE (
+        window_id,
+        component
+    )
+);
+
+COMMIT;

dist/res/database/views/archive_library_list.sql

@@ -0,0 +1,26 @@
+BEGIN;
+
+CREATE VIEW archive_library_list AS
+	SELECT archive_file.id,
+		archive_file.path,
+		archive_file.size,
+		archive_file.format_id,
+		archive_file.last_opened,
+		archive_file.last_modified,
+		archive_file.parent_id,
+		(
+			SELECT COUNT( * ) 
+				FROM archive_entry
+				WHERE archive_entry.archive_id = archive_file.id
+		)
+		AS entry_count,
+		(
+			SELECT COUNT( * ) 
+				FROM archive_map
+				WHERE archive_map.archive_id = archive_file.id
+		)
+		AS map_count
+	FROM archive_file
+	ORDER BY archive_file.path COLLATE NOCASE ASC;
+
+COMMIT;