|
'addons_manager', 'name' => 'Server Content Manager', 'group' => 'admin' )
@@ -72,4 +77,92 @@ $install_queries[2] = array(
KEY `idx_install_state` (`install_state`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;"
);
+
+// ── db_version 4 : Phase 2 – install_method, per-server manifest, install history ──
+//
+// Uses a PHP callable so each ALTER is applied only when the column does not
+// already exist (safe for repeated runs, compatible with all MySQL versions).
+//
+$install_queries[3] = array(
+ function ($db) {
+ $prefix = OGP_DB_PREFIX;
+
+ // ── Extend the addons table with Phase 2 columns ──────────────────────
+ $new_columns = array(
+ 'install_method' => "VARCHAR(32) NOT NULL DEFAULT 'download_zip' AFTER `group_id`",
+ 'content_version' => "VARCHAR(64) NULL AFTER `install_method`",
+ 'requires_stop' => "TINYINT(1) NOT NULL DEFAULT 1 AFTER `content_version`",
+ 'backup_before_install' => "TINYINT(1) NOT NULL DEFAULT 1 AFTER `requires_stop`",
+ 'restart_after_install' => "TINYINT(1) NOT NULL DEFAULT 0 AFTER `backup_before_install`",
+ 'is_cacheable' => "TINYINT(1) NOT NULL DEFAULT 0 AFTER `restart_after_install`",
+ 'description' => "TEXT NULL AFTER `is_cacheable`",
+ );
+
+ foreach ($new_columns as $col => $definition) {
+ $escaped_col = $db->realEscapeSingle($col);
+ $escaped_table = $db->realEscapeSingle($prefix . 'addons');
+ $check = $db->resultQuery(
+ "SELECT 1 FROM INFORMATION_SCHEMA.COLUMNS
+ WHERE TABLE_SCHEMA = DATABASE()
+ AND TABLE_NAME = '{$escaped_table}'
+ AND COLUMN_NAME = '{$escaped_col}'"
+ );
+ if (empty($check)) {
+ if (!$db->query("ALTER TABLE `{$prefix}addons` ADD COLUMN `{$col}` {$definition}")) {
+ return false;
+ }
+ }
+ }
+
+ // ── Per-server installed-content manifest ─────────────────────────────
+ if (!$db->query(
+ "CREATE TABLE IF NOT EXISTS `{$prefix}server_content_manifest` (
+ `id` INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,
+ `home_id` INT NOT NULL,
+ `addon_id` INT NOT NULL,
+ `install_method` VARCHAR(32) NOT NULL DEFAULT 'download_zip',
+ `content_version` VARCHAR(64) NULL,
+ `install_state` VARCHAR(32) NOT NULL DEFAULT 'installed',
+ `checksum_sha256` VARCHAR(64) NULL,
+ `source_url` VARCHAR(255) NULL,
+ `installed_at` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+ `installed_by` INT NULL,
+ `updated_at` DATETIME NULL,
+ `notes` TEXT NULL,
+ UNIQUE KEY `uniq_home_addon` (`home_id`, `addon_id`),
+ KEY `idx_home_id` (`home_id`),
+ KEY `idx_addon_id` (`addon_id`),
+ KEY `idx_install_state` (`install_state`)
+ ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci"
+ )) {
+ return false;
+ }
+
+ // ── Install history (one row per install attempt) ─────────────────────
+ if (!$db->query(
+ "CREATE TABLE IF NOT EXISTS `{$prefix}server_content_install_history` (
+ `id` INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,
+ `home_id` INT NOT NULL,
+ `addon_id` INT NOT NULL,
+ `installed_by` INT NULL,
+ `started_at` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+ `completed_at` DATETIME NULL,
+ `install_state` VARCHAR(32) NOT NULL DEFAULT 'started',
+ `install_method` VARCHAR(32) NULL,
+ `content_version` VARCHAR(64) NULL,
+ `source_url` VARCHAR(255) NULL,
+ `cache_mode_used` VARCHAR(32) NULL,
+ `result_code` INT NULL,
+ `log_output` MEDIUMTEXT NULL,
+ KEY `idx_home_id` (`home_id`),
+ KEY `idx_addon_id` (`addon_id`),
+ KEY `idx_started_at` (`started_at`)
+ ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci"
+ )) {
+ return false;
+ }
+
+ return true;
+ },
+);
?>
diff --git a/Panel/modules/addonsmanager/server_content_helpers.php b/Panel/modules/addonsmanager/server_content_helpers.php
index cb5c1d38..efebbb0c 100644
--- a/Panel/modules/addonsmanager/server_content_helpers.php
+++ b/Panel/modules/addonsmanager/server_content_helpers.php
@@ -198,3 +198,295 @@ function scm_validate_csrf_token($token)
return hash_equals((string)$_SESSION['addonsmanager_workshop_csrf'], (string)$token);
}
+// ─────────────────────────────────────────────────────────────────────────────
+// Phase 2 helpers – schema guard, cache mode, manifest, install history
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Returns the allowed values for the server_content_cache_mode panel setting.
+ *
+ * disabled – Always install from the configured source. No scanning,
+ * no shared cache. (DEFAULT – safest choice)
+ * search_existing_servers – Agent may scan other local game-server folders for
+ * matching cacheable content and copy directly if safe.
+ * shared_cache – Agent may store cacheable content in a shared cache
+ * folder and reuse it on future installs.
+ * shared_cache_and_search – Both shared_cache and search_existing_servers are
+ * active simultaneously.
+ *
+ * Security note: only content explicitly marked is_cacheable=1 on the addon
+ * record may ever be shared or cached. Private configs, user-edited files,
+ * saves, databases, logs, and credentials must never be included.
+ *
+ * @return array key => human-readable label
+ */
+function scm_get_valid_cache_modes()
+{
+ return array(
+ 'disabled' => 'Disabled (always install from source)',
+ 'search_existing_servers' => 'Search existing servers (copy from local installs)',
+ 'shared_cache' => 'Shared cache (store and reuse cached copies)',
+ 'shared_cache_and_search' => 'Shared cache + search existing servers',
+ );
+}
+
+/**
+ * Reads the current server_content_cache_mode panel setting.
+ * Returns 'disabled' if not set.
+ *
+ * @param object $db Panel DB handle
+ * @return string One of the scm_get_valid_cache_modes() keys
+ */
+function scm_get_cache_mode($db)
+{
+ $valid = scm_get_valid_cache_modes();
+ $value = '';
+ if (method_exists($db, 'getSetting')) {
+ $value = (string)$db->getSetting('server_content_cache_mode');
+ }
+ return array_key_exists($value, $valid) ? $value : 'disabled';
+}
+
+/**
+ * Returns allowed install_method values and their display labels.
+ *
+ * @return array
+ */
+function scm_get_install_methods()
+{
+ return array(
+ 'download_zip' => 'Download & extract archive (.zip / .tar.gz)',
+ 'download_file' => 'Download single file (no extraction)',
+ 'post_script' => 'Run post-script only (no download)',
+ 'steam_workshop' => 'Steam Workshop (via agent SteamCMD)',
+ 'minecraft_jar' => 'Minecraft server jar / version switcher',
+ 'profile_copy' => 'Copy stored profile directory',
+ );
+}
+
+/**
+ * Idempotently ensures the Phase 2 schema is present.
+ * Called from pages that use manifest / history data so that existing
+ * installs that have not yet run the module updater are covered.
+ *
+ * @param object $db Panel DB handle
+ * @return bool
+ */
+function scm_ensure_phase2_schema($db)
+{
+ static $phase2_checked = false;
+ if ($phase2_checked) {
+ return true;
+ }
+ $phase2_checked = true;
+ $prefix = OGP_DB_PREFIX;
+
+ // ── Extend addons table ───────────────────────────────────────────────────
+ $new_columns = array(
+ 'install_method' => "VARCHAR(32) NOT NULL DEFAULT 'download_zip'",
+ 'content_version' => "VARCHAR(64) NULL",
+ 'requires_stop' => "TINYINT(1) NOT NULL DEFAULT 1",
+ 'backup_before_install' => "TINYINT(1) NOT NULL DEFAULT 1",
+ 'restart_after_install' => "TINYINT(1) NOT NULL DEFAULT 0",
+ 'is_cacheable' => "TINYINT(1) NOT NULL DEFAULT 0",
+ 'description' => "TEXT NULL",
+ );
+ foreach ($new_columns as $col => $definition) {
+ $escaped_col = $db->realEscapeSingle($col);
+ $escaped_table = $db->realEscapeSingle($prefix . 'addons');
+ $check = $db->resultQuery(
+ "SELECT 1 FROM INFORMATION_SCHEMA.COLUMNS
+ WHERE TABLE_SCHEMA = DATABASE()
+ AND TABLE_NAME = '{$escaped_table}'
+ AND COLUMN_NAME = '{$escaped_col}'"
+ );
+ if (empty($check)) {
+ $db->query("ALTER TABLE `{$prefix}addons` ADD COLUMN `{$col}` {$definition}");
+ }
+ }
+
+ // ── Per-server manifest ───────────────────────────────────────────────────
+ $db->query(
+ "CREATE TABLE IF NOT EXISTS `{$prefix}server_content_manifest` (
+ `id` INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,
+ `home_id` INT NOT NULL,
+ `addon_id` INT NOT NULL,
+ `install_method` VARCHAR(32) NOT NULL DEFAULT 'download_zip',
+ `content_version` VARCHAR(64) NULL,
+ `install_state` VARCHAR(32) NOT NULL DEFAULT 'installed',
+ `checksum_sha256` VARCHAR(64) NULL,
+ `source_url` VARCHAR(255) NULL,
+ `installed_at` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+ `installed_by` INT NULL,
+ `updated_at` DATETIME NULL,
+ `notes` TEXT NULL,
+ UNIQUE KEY `uniq_home_addon` (`home_id`, `addon_id`),
+ KEY `idx_home_id` (`home_id`),
+ KEY `idx_addon_id` (`addon_id`),
+ KEY `idx_install_state` (`install_state`)
+ ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci"
+ );
+
+ // ── Install history ───────────────────────────────────────────────────────
+ $db->query(
+ "CREATE TABLE IF NOT EXISTS `{$prefix}server_content_install_history` (
+ `id` INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,
+ `home_id` INT NOT NULL,
+ `addon_id` INT NOT NULL,
+ `installed_by` INT NULL,
+ `started_at` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+ `completed_at` DATETIME NULL,
+ `install_state` VARCHAR(32) NOT NULL DEFAULT 'started',
+ `install_method` VARCHAR(32) NULL,
+ `content_version` VARCHAR(64) NULL,
+ `source_url` VARCHAR(255) NULL,
+ `cache_mode_used` VARCHAR(32) NULL,
+ `result_code` INT NULL,
+ `log_output` MEDIUMTEXT NULL,
+ KEY `idx_home_id` (`home_id`),
+ KEY `idx_addon_id` (`addon_id`),
+ KEY `idx_started_at` (`started_at`)
+ ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci"
+ );
+
+ return true;
+}
+
+/**
+ * Returns all manifest rows for a given server home.
+ *
+ * @param object $db
+ * @param int $home_id
+ * @return array
+ */
+function scm_get_manifest_rows($db, $home_id)
+{
+ $home_id = (int)$home_id;
+ if ($home_id <= 0 || !scm_ensure_phase2_schema($db)) {
+ return array();
+ }
+ $rows = $db->resultQuery(
+ "SELECT m.*, a.name AS addon_name, a.addon_type, a.install_method AS addon_install_method
+ FROM `".OGP_DB_PREFIX."server_content_manifest` m
+ LEFT JOIN `".OGP_DB_PREFIX."addons` a ON a.addon_id = m.addon_id
+ WHERE m.home_id = {$home_id}
+ ORDER BY m.installed_at DESC"
+ );
+ return is_array($rows) ? $rows : array();
+}
+
+/**
+ * Creates a new install history row and returns its insert ID.
+ * Returns 0 on failure.
+ *
+ * @param object $db
+ * @param int $home_id
+ * @param int $addon_id
+ * @param int $user_id
+ * @param string $source_url
+ * @param string $content_version
+ * @param string $install_method
+ * @param string $cache_mode_used
+ * @return int history row ID, or 0 on failure
+ */
+function scm_record_install_start($db, $home_id, $addon_id, $user_id, $source_url = '', $content_version = '', $install_method = 'download_zip', $cache_mode_used = 'disabled')
+{
+ $home_id = (int)$home_id;
+ $addon_id = (int)$addon_id;
+ $user_id = (int)$user_id;
+ $source_url = $db->realEscapeSingle((string)$source_url);
+ $content_version = $db->realEscapeSingle((string)$content_version);
+ $install_method = $db->realEscapeSingle((string)$install_method);
+ $cache_mode_used = $db->realEscapeSingle((string)$cache_mode_used);
+
+ if (!scm_ensure_phase2_schema($db)) {
+ return 0;
+ }
+ $id = $db->resultInsertId(
+ 'server_content_install_history',
+ array(
+ 'home_id' => $home_id,
+ 'addon_id' => $addon_id,
+ 'installed_by' => $user_id,
+ 'install_state' => 'started',
+ 'install_method' => $install_method,
+ 'content_version' => $content_version,
+ 'source_url' => $source_url,
+ 'cache_mode_used' => $cache_mode_used,
+ )
+ );
+ return is_numeric($id) ? (int)$id : 0;
+}
+
+/**
+ * Updates an existing install history row with the final result.
+ *
+ * @param object $db
+ * @param int $history_id
+ * @param string $state 'installed' | 'failed' | 'cancelled'
+ * @param int $result_code Exit code (0 = success)
+ * @param string $log_output Script/download log snippet
+ * @return bool
+ */
+function scm_record_install_done($db, $history_id, $state = 'installed', $result_code = 0, $log_output = '')
+{
+ $history_id = (int)$history_id;
+ $state = $db->realEscapeSingle((string)$state);
+ $result_code = (int)$result_code;
+ $log_output = $db->realEscapeSingle((string)$log_output);
+ if ($history_id <= 0) {
+ return false;
+ }
+ return (bool)$db->query(
+ "UPDATE `".OGP_DB_PREFIX."server_content_install_history`
+ SET install_state = '{$state}',
+ result_code = {$result_code},
+ log_output = '{$log_output}',
+ completed_at = NOW()
+ WHERE id = {$history_id}"
+ );
+}
+
+/**
+ * Inserts or updates a server_content_manifest row for a successful install.
+ *
+ * @param object $db
+ * @param int $home_id
+ * @param int $addon_id
+ * @param array $fields Optional overrides: install_method, content_version,
+ * install_state, source_url, checksum_sha256, installed_by
+ * @return bool
+ */
+function scm_upsert_manifest($db, $home_id, $addon_id, array $fields = array())
+{
+ $home_id = (int)$home_id;
+ $addon_id = (int)$addon_id;
+ if ($home_id <= 0 || $addon_id <= 0 || !scm_ensure_phase2_schema($db)) {
+ return false;
+ }
+ $install_method = $db->realEscapeSingle((string)(isset($fields['install_method']) ? $fields['install_method'] : 'download_zip'));
+ $content_version = $db->realEscapeSingle((string)(isset($fields['content_version']) ? $fields['content_version'] : ''));
+ $install_state = $db->realEscapeSingle((string)(isset($fields['install_state']) ? $fields['install_state'] : 'installed'));
+ $source_url = $db->realEscapeSingle((string)(isset($fields['source_url']) ? $fields['source_url'] : ''));
+ $checksum = $db->realEscapeSingle((string)(isset($fields['checksum_sha256']) ? $fields['checksum_sha256'] : ''));
+ $installed_by = isset($fields['installed_by']) ? (int)$fields['installed_by'] : 'NULL';
+ if ($installed_by !== 'NULL' && $installed_by <= 0) {
+ $installed_by = 'NULL';
+ }
+
+ return (bool)$db->query(
+ "INSERT INTO `".OGP_DB_PREFIX."server_content_manifest`
+ (`home_id`,`addon_id`,`install_method`,`content_version`,`install_state`,`source_url`,`checksum_sha256`,`installed_by`,`installed_at`,`updated_at`)
+ VALUES
+ ({$home_id},{$addon_id},'{$install_method}','{$content_version}','{$install_state}','{$source_url}','{$checksum}',{$installed_by},NOW(),NOW())
+ ON DUPLICATE KEY UPDATE
+ install_method = VALUES(install_method),
+ content_version = VALUES(content_version),
+ install_state = VALUES(install_state),
+ source_url = VALUES(source_url),
+ checksum_sha256 = VALUES(checksum_sha256),
+ installed_at = NOW(),
+ updated_at = NOW()"
+ );
+}
+
diff --git a/Panel/modules/settings/settings.php b/Panel/modules/settings/settings.php
index e69798b0..ce988c9e 100644
--- a/Panel/modules/settings/settings.php
+++ b/Panel/modules/settings/settings.php
@@ -77,7 +77,9 @@ function exec_ogp_module()
"discord_webhook_main" => $_REQUEST['discord_webhook_main'],
"discord_webhook_admin" => $_REQUEST['discord_webhook_admin'],
// Debug
- "debug_level" => $_REQUEST['debug_level'] ?? '1'
+ "debug_level" => $_REQUEST['debug_level'] ?? '1',
+ // Server Content
+ "server_content_cache_mode" => $_REQUEST['server_content_cache_mode'] ?? 'disabled',
);
$db->setSettings($settings);
@@ -208,8 +210,24 @@ function exec_ogp_module()
$ft->add_custom_field('debug_level',
create_drop_box_from_array($debug_level_options, 'debug_level', @$row['debug_level'] ?? '1', false));
+ // Server Content cache mode
+ // Controls whether the agent may copy cacheable content from other servers
+ // or a shared cache instead of always re-downloading from the source.
+ // Default: disabled (safest – no copying of any content between servers).
+ // See addonsmanager/SERVER_CONTENT_ROADMAP.md for full description.
+ $cache_mode_options = array(
+ 'disabled' => 'Disabled (always install from source — default)',
+ 'search_existing_servers' => 'Search existing servers (copy cacheable content from local game-server folders)',
+ 'shared_cache' => 'Shared cache (store and reuse cacheable content in a shared cache folder)',
+ 'shared_cache_and_search' => 'Shared cache + search existing servers',
+ );
+ $current_cache_mode = isset($row['server_content_cache_mode']) && array_key_exists($row['server_content_cache_mode'], $cache_mode_options)
+ ? $row['server_content_cache_mode'] : 'disabled';
+ $ft->add_custom_field('server_content_cache_mode',
+ create_drop_box_from_array($cache_mode_options, 'server_content_cache_mode', $current_cache_mode, false));
+
// Add option to reset game server order to default
- $ft->add_field('checkbox','reset_game_server_order','0');
+ $ft->add_field('checkbox','reset_game_server_order','0');
$ft->end_table();
$ft->add_button("submit","update_settings",get_lang('update_settings'));
|