|
'addons_manager', 'name' => 'Server Content Manager', 'group' => 'admin' )
@@ -165,4 +165,35 @@ $install_queries[3] = array(
return true;
},
);
+
+// ── db_version 5 : content-type specific metadata for Workshop/config/folder actions ──
+$install_queries[4] = array(
+ function ($db) {
+ $prefix = OGP_DB_PREFIX;
+ $new_columns = array(
+ 'workshop_item_id' => "VARCHAR(64) NULL AFTER `description`",
+ 'workshop_app_id' => "VARCHAR(32) NULL AFTER `workshop_item_id`",
+ 'target_path_template' => "VARCHAR(255) NULL AFTER `workshop_app_id`",
+ 'optional_folder_name' => "VARCHAR(255) NULL AFTER `target_path_template`",
+ 'config_edit_rule' => "TEXT NULL AFTER `optional_folder_name`",
+ 'launch_param_additions' => "VARCHAR(255) NULL AFTER `config_edit_rule`",
+ );
+ 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;
+ }
+ }
+ }
+ return true;
+ },
+);
?>
diff --git a/Panel/modules/addonsmanager/server_content_helpers.php b/Panel/modules/addonsmanager/server_content_helpers.php
index efebbb0c..2f40f4aa 100644
--- a/Panel/modules/addonsmanager/server_content_helpers.php
+++ b/Panel/modules/addonsmanager/server_content_helpers.php
@@ -255,15 +255,146 @@ function scm_get_cache_mode($db)
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',
+ 'download_zip' => 'Compressed file download',
+ 'download_file' => 'Direct file download',
+ 'steam_workshop' => 'Steam Workshop item',
+ 'post_script' => 'Script/action only',
+ 'config_edit' => 'Config edit only',
+ 'create_folder' => 'Folder/create path only',
);
}
+function scm_get_install_method_help_text()
+{
+ return array(
+ 'download_zip' => 'Downloads and extracts an archive into the target path.',
+ 'download_file' => 'Downloads a single file to the target path without extraction.',
+ 'steam_workshop' => 'Downloads/updates a Steam Workshop item and applies it to the server path.',
+ 'post_script' => 'Runs only the post-install script/action body (no download).',
+ 'config_edit' => 'Applies config edit rules to a target config file/path.',
+ 'create_folder' => 'Creates the target directory path only.',
+ );
+}
+
+function scm_get_install_method_required_fields()
+{
+ return array(
+ 'download_zip' => array('url', 'path'),
+ 'download_file' => array('url', 'path'),
+ 'steam_workshop' => array('workshop_item_id', 'target_path_template'),
+ 'post_script' => array('post_script'),
+ 'config_edit' => array('path', 'config_edit_rule'),
+ 'create_folder' => array('path'),
+ );
+}
+
+function scm_get_install_method_validation_errors()
+{
+ return array(
+ 'url' => 'Please enter a download URL.',
+ 'workshop_item_id' => 'Please enter a Workshop ID.',
+ 'target_path_template' => 'Please select a target install path.',
+ 'post_script' => 'Please enter a script/action body.',
+ 'config_edit_rule' => 'Please enter a config edit rule.',
+ 'path' => 'Please select a target install path.',
+ );
+}
+
+function scm_get_install_method_default($value = '')
+{
+ $methods = scm_get_install_methods();
+ $value = trim((string)$value);
+ return isset($methods[$value]) ? $value : 'download_zip';
+}
+
+function scm_validate_install_method_payload($install_method, array $payload, &$message = '')
+{
+ $install_method = scm_get_install_method_default($install_method);
+ $required = scm_get_install_method_required_fields();
+ $errors = scm_get_install_method_validation_errors();
+ if (!isset($required[$install_method])) {
+ $message = 'Invalid install/content type selected.';
+ return false;
+ }
+ foreach ($required[$install_method] as $field) {
+ $value = isset($payload[$field]) ? trim((string)$payload[$field]) : '';
+ if ($value === '') {
+ $message = isset($errors[$field]) ? $errors[$field] : 'Missing required field.';
+ return false;
+ }
+ }
+ if ($install_method === 'steam_workshop') {
+ $wid = isset($payload['workshop_item_id']) ? trim((string)$payload['workshop_item_id']) : '';
+ if ($wid === '' || !preg_match('/^[0-9]+$/', $wid)) {
+ $message = 'Please enter a Workshop ID.';
+ return false;
+ }
+ }
+ $message = '';
+ return true;
+}
+
+function scm_build_placeholder_map(array $home_info, array $server_context = array(), array $overrides = array())
+{
+ $home_id = (int)(isset($home_info['home_id']) ? $home_info['home_id'] : 0);
+ $server_root = rtrim(clean_path((string)(isset($home_info['home_path']) ? $home_info['home_path'] : '')), '/');
+ $game_root = $server_root;
+ if (!empty($server_context['exe_location'])) {
+ $exe_location = clean_path((string)$server_context['exe_location']);
+ $exe_dir = dirname($exe_location);
+ if ($exe_dir !== '.' && $exe_dir !== '/') {
+ $game_root = clean_path($server_root . '/' . ltrim($exe_dir, '/'));
+ }
+ }
+ $map = array(
+ '{HOME_ID}' => (string)$home_id,
+ '{SERVER_ROOT}' => $server_root,
+ '{GAME_ROOT}' => $game_root,
+ '{WORKSHOP_ID}' => '',
+ '{WORKSHOP_APP_ID}' => '',
+ '{STEAM_APP_ID}' => '',
+ );
+ foreach ($overrides as $key => $value) {
+ $token = '{' . strtoupper(trim((string)$key, '{}')) . '}';
+ $map[$token] = (string)$value;
+ }
+ return $map;
+}
+
+function scm_apply_placeholders($template, array $placeholder_map)
+{
+ $template = (string)$template;
+ if ($template === '') {
+ return '';
+ }
+ return str_replace(array_keys($placeholder_map), array_values($placeholder_map), $template);
+}
+
+function scm_content_logs_dir()
+{
+ return dirname(__FILE__) . '/logs';
+}
+
+function scm_content_log_file()
+{
+ return scm_content_logs_dir() . '/content_install.log';
+}
+
+function scm_log_content_install_action(array $context)
+{
+ $dir = scm_content_logs_dir();
+ if (!is_dir($dir)) {
+ @mkdir($dir, 0775, true);
+ }
+ $context['logged_at'] = date('Y-m-d H:i:s');
+ $line = json_encode($context);
+ if ($line === false) {
+ $line = '{"logged_at":"' . date('Y-m-d H:i:s') . '","error":"json_encode_failed"}';
+ }
+ @error_log($line . PHP_EOL, 3, scm_content_log_file());
+ return true;
+}
+
/**
* Idempotently ensures the Phase 2 schema is present.
* Called from pages that use manifest / history data so that existing
@@ -290,6 +421,12 @@ function scm_ensure_phase2_schema($db)
'restart_after_install' => "TINYINT(1) NOT NULL DEFAULT 0",
'is_cacheable' => "TINYINT(1) NOT NULL DEFAULT 0",
'description' => "TEXT NULL",
+ 'workshop_item_id' => "VARCHAR(64) NULL",
+ 'workshop_app_id' => "VARCHAR(32) NULL",
+ 'target_path_template' => "VARCHAR(255) NULL",
+ 'optional_folder_name' => "VARCHAR(255) NULL",
+ 'config_edit_rule' => "TEXT NULL",
+ 'launch_param_additions'=> "VARCHAR(255) NULL",
);
foreach ($new_columns as $col => $definition) {
$escaped_col = $db->realEscapeSingle($col);
@@ -489,4 +626,3 @@ function scm_upsert_manifest($db, $home_id, $addon_id, array $fields = array())
updated_at = NOW()"
);
}
-
diff --git a/Panel/modules/addonsmanager/workshop_action.php b/Panel/modules/addonsmanager/workshop_action.php
index 5a865957..1e4c4c1c 100644
--- a/Panel/modules/addonsmanager/workshop_action.php
+++ b/Panel/modules/addonsmanager/workshop_action.php
@@ -67,7 +67,7 @@ function scm_workshop_filter_existing_ids($db, $home_id, array $item_ids)
return array_values($allowed);
}
-function scm_workshop_write_manifest_and_run($db, array $home_info, $server_xml, $action, array $item_ids, &$error = '')
+function scm_workshop_write_manifest_and_run($db, array $home_info, $server_xml, $action, array $item_ids, &$error = '', array $extra_manifest = array())
{
$error = '';
if (empty($item_ids)) {
@@ -102,6 +102,9 @@ function scm_workshop_write_manifest_and_run($db, array $home_info, $server_xml,
'workshop_app_id' => scm_extract_workshop_app_id($server_xml),
'items' => array_values($item_ids),
);
+ if (!empty($extra_manifest)) {
+ $manifest['extra'] = $extra_manifest;
+ }
$manifest_json = json_encode($manifest);
if ($manifest_json === false) {
$error = 'Failed to encode workshop manifest JSON.';
@@ -274,4 +277,3 @@ function scm_workshop_handle_action($db, array $home_info, $user_id, $action, $r
$message = 'Invalid workshop action.';
return false;
}
-
diff --git a/Panel/modules/steam_workshop/includes/functions.php b/Panel/modules/steam_workshop/includes/functions.php
index 2cd04e54..9cbb8d97 100644
--- a/Panel/modules/steam_workshop/includes/functions.php
+++ b/Panel/modules/steam_workshop/includes/functions.php
@@ -577,3 +577,61 @@ function sw_apply_detected_profile_defaults($db, array $profile, array $detected
);
return $updated;
}
+
+function steam_workshop_resolve_paths($db, array $home_info, $workshop_id, $target_path_template = '', $optional_folder_name = '', $workshop_app_id_override = '')
+{
+ $profile = sw_get_profile_for_home($db, (int)$home_info['home_id']);
+ if (!$profile || !is_array($profile)) {
+ return array('ok' => false, 'error' => 'No enabled Steam Workshop profile for this server home.');
+ }
+ $workshop_id = trim((string)$workshop_id);
+ if ($workshop_id === '' || !preg_match('/^[0-9]+$/', $workshop_id)) {
+ return array('ok' => false, 'error' => 'Invalid Workshop ID.');
+ }
+ $workshop_app_id = trim((string)$workshop_app_id_override);
+ if ($workshop_app_id === '') {
+ $workshop_app_id = (string)$profile['workshop_app_id'];
+ }
+ $folder_name = trim((string)$optional_folder_name);
+ if ($folder_name === '') {
+ $folder_name = '@' . $workshop_id;
+ }
+ $vars = array(
+ 'HOME_ID' => (int)$home_info['home_id'],
+ 'SERVER_ROOT' => rtrim((string)$home_info['home_path'], '/'),
+ 'GAME_ROOT' => rtrim((string)$home_info['home_path'], '/'),
+ 'WORKSHOP_ID' => $workshop_id,
+ 'WORKSHOP_APP_ID' => $workshop_app_id,
+ 'STEAM_APP_ID' => (string)$profile['steam_app_id'],
+ 'FOLDER_NAME' => $folder_name,
+ 'MOD_FOLDER' => $folder_name,
+ );
+ $target_template = trim((string)$target_path_template);
+ if ($target_template === '') {
+ $target_template = !empty($profile['install_path_template']) ? (string)$profile['install_path_template'] : '{SERVER_ROOT}/{MOD_FOLDER}';
+ }
+ $resolved_target = sw_apply_template($target_template, $vars);
+ return array(
+ 'ok' => true,
+ 'profile' => $profile,
+ 'workshop_id' => $workshop_id,
+ 'workshop_app_id' => $workshop_app_id,
+ 'steam_app_id' => (string)$profile['steam_app_id'],
+ 'folder_name' => $folder_name,
+ 'target_path_template' => $target_template,
+ 'target_path_resolved' => $resolved_target,
+ 'vars' => $vars,
+ );
+}
+
+function steam_workshop_download_item($db, array $home_info, $workshop_id, $target_path_template = '', array $options = array())
+{
+ $optional_folder_name = isset($options['optional_folder_name']) ? $options['optional_folder_name'] : '';
+ $workshop_app_id = isset($options['workshop_app_id']) ? $options['workshop_app_id'] : '';
+ return steam_workshop_resolve_paths($db, $home_info, $workshop_id, $target_path_template, $optional_folder_name, $workshop_app_id);
+}
+
+function steam_workshop_install_item_to_home($db, array $home_info, $workshop_id, $target_path_template = '', array $options = array())
+{
+ return steam_workshop_download_item($db, $home_info, $workshop_id, $target_path_template, $options);
+}
diff --git a/Panel/ogp_api.php b/Panel/ogp_api.php
index 37ca95b3..6d27d5cb 100644
--- a/Panel/ogp_api.php
+++ b/Panel/ogp_api.php
@@ -1357,6 +1357,10 @@ function api_litefm()
function api_addonsmanager()
{
global $request, $db, $user_info;
+ require_once(MODULES.'addonsmanager/server_content_helpers.php');
+ require_once(MODULES.'addonsmanager/workshop_action.php');
+ if (file_exists(MODULES.'steam_workshop/includes/functions.php'))
+ require_once(MODULES.'steam_workshop/includes/functions.php');
if($db->isModuleInstalled('addonsmanager') === FALSE)
return array("status" => '349', "message" => "This function is not available because the module is not installed.");
@@ -1427,9 +1431,22 @@ function api_addonsmanager()
$addon_info = $addons_rows[0];
+ $install_method = scm_get_install_method_default(isset($addon_info['install_method']) ? $addon_info['install_method'] : 'download_zip');
+ $validation_payload = array(
+ 'url' => isset($addon_info['url']) ? $addon_info['url'] : '',
+ 'path' => isset($addon_info['path']) ? $addon_info['path'] : '',
+ 'workshop_item_id' => isset($addon_info['workshop_item_id']) ? $addon_info['workshop_item_id'] : '',
+ 'target_path_template' => isset($addon_info['target_path_template']) ? $addon_info['target_path_template'] : '',
+ 'post_script' => isset($addon_info['post_script']) ? $addon_info['post_script'] : '',
+ 'config_edit_rule' => isset($addon_info['config_edit_rule']) ? $addon_info['config_edit_rule'] : '',
+ );
+ $validation_message = '';
+ if (!scm_validate_install_method_payload($install_method, $validation_payload, $validation_message))
+ return array("status" => '422', "message" => $validation_message);
$url = $addon_info['url'];
$filename = basename($url);
+ $post_script = '';
if($addon_info['post_script'] != "")
{
$addon_info['post_script'] = strip_real_escape_string($addon_info['post_script']);
@@ -1461,7 +1478,45 @@ function api_addonsmanager()
$post_script = preg_replace( "/\%incremental\%/i", $home_info['incremental'], $post_script);
}
- $pid = $remote->start_file_download($addon_info['url'], $home_info['home_path']."/".$addon_info['path'], $filename, "uncompress", $post_script);
+ if ($install_method === 'steam_workshop') {
+ scm_ensure_workshop_schema($db);
+ $workshop_item_id = trim((string)$addon_info['workshop_item_id']);
+ $workshop_error = '';
+ $extra_manifest = array(
+ 'addon_id' => (int)$addon_id,
+ 'target_path_template' => isset($addon_info['target_path_template']) ? (string)$addon_info['target_path_template'] : '',
+ 'optional_folder_name' => isset($addon_info['optional_folder_name']) ? (string)$addon_info['optional_folder_name'] : '',
+ 'config_edit_rule' => isset($addon_info['config_edit_rule']) ? (string)$addon_info['config_edit_rule'] : '',
+ 'launch_param_additions' => isset($addon_info['launch_param_additions']) ? (string)$addon_info['launch_param_additions'] : '',
+ );
+ $ok = scm_workshop_write_manifest_and_run($db, $home_info, $server_xml, 'install', array($workshop_item_id), $workshop_error, $extra_manifest);
+ if ($ok)
+ return array("status" => "200", "message" => "Workshop content installed successfully.");
+ return array("status" => "342", "message" => "Workshop install failed: ".$workshop_error);
+ }
+ if ($install_method === 'post_script') {
+ $output = $remote->exec("cd " . escapeshellarg($home_info['home_path']) . " && /bin/bash -lc " . escapeshellarg((string)$post_script) . " ; echo __GSP_SCRIPT_EXIT:$?");
+ if (is_string($output) && preg_match('/__GSP_SCRIPT_EXIT:(\d+)/', $output, $m) && (int)$m[1] === 0)
+ return array("status" => "200", "message" => "Script/action completed.");
+ return array("status" => "342", "message" => "Script/action failed.");
+ }
+ if ($install_method === 'config_edit' || $install_method === 'create_folder') {
+ $path = trim((string)$addon_info['path']);
+ if ($path === '')
+ return array("status" => "422", "message" => "Please select a target install path.");
+ $target = (strpos($path, '/') === 0) ? $path : clean_path(rtrim($home_info['home_path'], '/') . '/' . ltrim($path, '/'));
+ if ($install_method === 'create_folder')
+ $out = $remote->exec("mkdir -p " . escapeshellarg($target) . " && echo __GSP_FOLDER_OK");
+ else {
+ $rule = trim((string)$addon_info['config_edit_rule']);
+ $out = $remote->exec("mkdir -p " . escapeshellarg(dirname($target)) . " && touch " . escapeshellarg($target) . " && printf %s " . escapeshellarg($rule . PHP_EOL) . " >> " . escapeshellarg($target) . " && echo __GSP_CONFIG_OK");
+ }
+ if (is_string($out))
+ return array("status" => "200", "message" => "Content action completed.");
+ return array("status" => "342", "message" => "Content action failed.");
+ }
+ $download_action = ($install_method === 'download_file') ? "" : "uncompress";
+ $pid = $remote->start_file_download($addon_info['url'], $home_info['home_path']."/".$addon_info['path'], $filename, $download_action, $post_script);
if($pid > 0)
{
$status = "200";
|