6e424bee60
Agent-Logs-Url: https://github.com/GameServerPanel/GSP/sessions/fca65480-29f6-4a76-ae4f-442477782a2c Co-authored-by: iaretechnician <2749183+iaretechnician@users.noreply.github.com>
223 lines
11 KiB
PHP
223 lines
11 KiB
PHP
<?php
|
||
/*
|
||
*
|
||
* OGP - Open Game Panel
|
||
* Copyright (C) 2008 - 2018 The OGP Development Team
|
||
*
|
||
* http://www.opengamepanel.org/
|
||
*
|
||
* This program is free software; you can redistribute it and/or
|
||
* modify it under the terms of the GNU General Public License
|
||
* as published by the Free Software Foundation; either version 2
|
||
* of the License, or any later version.
|
||
*
|
||
* This program is distributed in the hope that it will be useful,
|
||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
* GNU General Public License for more details.
|
||
*
|
||
* You should have received a copy of the GNU General Public License
|
||
* along with this program; if not, write to the Free Software
|
||
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
||
*
|
||
*/
|
||
// Module general information
|
||
$module_title = "Steam Workshop";
|
||
$module_version = "2.3";
|
||
$db_version = 2;
|
||
$module_required = TRUE;
|
||
$module_menus = array();
|
||
|
||
// -----------------------------------------------------------------------
|
||
// $install_queries[0] – executed for FRESH installs (all keys run).
|
||
// Contains the full v2 schema with every column.
|
||
// $install_queries[2] – executed when upgrading an existing v1 install
|
||
// to v2 (ALTER TABLE + new settings table).
|
||
// $db_version = 2 (v1 = original release; v2 = this rewrite).
|
||
// -----------------------------------------------------------------------
|
||
$install_queries = array();
|
||
|
||
// Full schema for fresh installs (includes every column from all versions).
|
||
$install_queries[0] = array(
|
||
"CREATE TABLE IF NOT EXISTS `".OGP_DB_PREFIX."workshop_game_profiles` (
|
||
`id` INT NOT NULL AUTO_INCREMENT,
|
||
`game_key` VARCHAR(100) NOT NULL,
|
||
`game_name` VARCHAR(255) NOT NULL,
|
||
`steam_app_id` VARCHAR(32) NOT NULL DEFAULT '',
|
||
`workshop_app_id` VARCHAR(32) NOT NULL,
|
||
`steam_login_required` TINYINT(1) NOT NULL DEFAULT 0,
|
||
`steamcmd_login_mode` ENUM('anonymous','account') NOT NULL DEFAULT 'anonymous',
|
||
`steamcmd_path` VARCHAR(512) NOT NULL DEFAULT '',
|
||
`supported_os` SET('linux','windows') NOT NULL DEFAULT 'linux',
|
||
`cache_path_template` TEXT NOT NULL,
|
||
`install_path_template` TEXT NOT NULL,
|
||
`folder_naming_format` ENUM('@%mod_name%','@%workshop_id%','custom') NOT NULL DEFAULT '@%workshop_id%',
|
||
`folder_name_template` VARCHAR(255) NOT NULL DEFAULT '@%workshop_id%',
|
||
`mod_launch_param` VARCHAR(512) NOT NULL DEFAULT '',
|
||
`mod_separator` ENUM('semicolon','comma','space') NOT NULL DEFAULT 'semicolon',
|
||
`copy_method` ENUM('copy','rsync','symlink') NOT NULL DEFAULT 'rsync',
|
||
`copy_keys` TINYINT(1) NOT NULL DEFAULT 0,
|
||
`key_source_path` TEXT NULL,
|
||
`key_dest_path` TEXT NULL,
|
||
`pre_update_script` TEXT NULL,
|
||
`install_script` TEXT NULL,
|
||
`post_update_script` TEXT NULL,
|
||
`config_file_template` TEXT NULL,
|
||
`launch_param_template` TEXT NULL,
|
||
`requires_restart` TINYINT(1) NOT NULL DEFAULT 1,
|
||
`validation_notes` TEXT NULL,
|
||
`enabled` TINYINT(1) NOT NULL DEFAULT 1,
|
||
`created_at` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
|
||
`updated_at` DATETIME NULL,
|
||
PRIMARY KEY (`id`),
|
||
UNIQUE KEY `uniq_game_key` (`game_key`)
|
||
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci",
|
||
|
||
"CREATE TABLE IF NOT EXISTS `".OGP_DB_PREFIX."workshop_cache` (
|
||
`id` INT NOT NULL AUTO_INCREMENT,
|
||
`agent_id` INT NOT NULL,
|
||
`os_type` ENUM('linux','windows') NOT NULL DEFAULT 'linux',
|
||
`workshop_app_id` VARCHAR(32) NOT NULL,
|
||
`workshop_id` VARCHAR(64) NOT NULL,
|
||
`title` VARCHAR(255) NULL,
|
||
`cache_path` TEXT NOT NULL,
|
||
`status` ENUM('missing','cached','failed') NOT NULL DEFAULT 'missing',
|
||
`last_checked` DATETIME NULL,
|
||
`last_updated` DATETIME NULL,
|
||
`last_error` TEXT NULL,
|
||
PRIMARY KEY (`id`),
|
||
UNIQUE KEY `uniq_agent_workshop` (`agent_id`, `workshop_app_id`, `workshop_id`)
|
||
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci",
|
||
|
||
"CREATE TABLE IF NOT EXISTS `".OGP_DB_PREFIX."server_workshop_mods` (
|
||
`id` INT NOT NULL AUTO_INCREMENT,
|
||
`home_id` INT NOT NULL,
|
||
`agent_id` INT NOT NULL,
|
||
`profile_id` INT NOT NULL,
|
||
`workshop_app_id` VARCHAR(32) NOT NULL,
|
||
`workshop_id` VARCHAR(64) NOT NULL,
|
||
`title` VARCHAR(255) NULL,
|
||
`custom_folder` VARCHAR(255) NOT NULL DEFAULT '',
|
||
`enabled` TINYINT(1) NOT NULL DEFAULT 1,
|
||
`install_path` TEXT NOT NULL,
|
||
`load_order` INT NOT NULL DEFAULT 0,
|
||
`installed_at` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
|
||
`updated_at` DATETIME NULL,
|
||
PRIMARY KEY (`id`),
|
||
UNIQUE KEY `uniq_home_workshop` (`home_id`, `workshop_id`)
|
||
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci",
|
||
|
||
"CREATE TABLE IF NOT EXISTS `".OGP_DB_PREFIX."server_workshop_settings` (
|
||
`home_id` INT NOT NULL,
|
||
`workshop_enabled` TINYINT(1) NOT NULL DEFAULT 0,
|
||
`profile_id` INT NULL,
|
||
`update_mode` ENUM('manual','scheduled','on_restart') NOT NULL DEFAULT 'manual',
|
||
`restart_behavior` ENUM('none','queue','stop_update_start') NOT NULL DEFAULT 'none',
|
||
`update_queued` TINYINT(1) NOT NULL DEFAULT 0,
|
||
`last_update_status` VARCHAR(20) NOT NULL DEFAULT '',
|
||
`last_update_error` TEXT NULL,
|
||
`last_update_time` DATETIME NULL,
|
||
`last_success_time` DATETIME NULL,
|
||
`updated_at` DATETIME NULL,
|
||
PRIMARY KEY (`home_id`)
|
||
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci"
|
||
);
|
||
|
||
// Migration: upgrade existing v1 installs to v2 schema.
|
||
//
|
||
// ADD COLUMN IF NOT EXISTS is not supported in MySQL 5.7 (MariaDB only).
|
||
// Each column addition is therefore performed via a PHP closure that:
|
||
// 1. Queries INFORMATION_SCHEMA.COLUMNS to check whether the column exists.
|
||
// 2. Runs ALTER TABLE ADD COLUMN only when it does not exist.
|
||
// This makes the migration safe to run multiple times without errors.
|
||
// OGP_DB_PREFIX in SQL strings is replaced at runtime by the panel DB wrapper.
|
||
$install_queries[2] = array(
|
||
|
||
// Add new columns to workshop_game_profiles one-by-one (MySQL 5.7 safe).
|
||
function($db) {
|
||
// 'OGP_DB_PREFIX' is the literal token that $db->query() / $db->resultQuery()
|
||
// replaces with the configured table prefix (e.g. 'gsp_') via str_replace at
|
||
// runtime. Using it directly in string literals below is intentional and is
|
||
// the same mechanism used everywhere else in the panel.
|
||
$tbl_profiles = 'OGP_DB_PREFIXworkshop_game_profiles';
|
||
|
||
// column_name => column definition (no AFTER clause for portability)
|
||
// $col is always a value from this hardcoded array — not from user input.
|
||
$columns = array(
|
||
'steam_app_id' => "VARCHAR(32) NOT NULL DEFAULT ''",
|
||
'steam_login_required' => "TINYINT(1) NOT NULL DEFAULT 0",
|
||
'steamcmd_login_mode' => "ENUM('anonymous','account') NOT NULL DEFAULT 'anonymous'",
|
||
'steamcmd_path' => "VARCHAR(512) NOT NULL DEFAULT ''",
|
||
'folder_naming_format' => "ENUM('@%mod_name%','@%workshop_id%','custom') NOT NULL DEFAULT '@%workshop_id%'",
|
||
'mod_launch_param' => "VARCHAR(512) NOT NULL DEFAULT ''",
|
||
'mod_separator' => "ENUM('semicolon','comma','space') NOT NULL DEFAULT 'semicolon'",
|
||
'copy_keys' => "TINYINT(1) NOT NULL DEFAULT 0",
|
||
'key_source_path' => "TEXT NULL",
|
||
'key_dest_path' => "TEXT NULL",
|
||
'pre_update_script' => "TEXT NULL",
|
||
'post_update_script' => "TEXT NULL",
|
||
'validation_notes' => "TEXT NULL",
|
||
);
|
||
foreach ($columns as $col => $def) {
|
||
// INFORMATION_SCHEMA.COLUMNS always returns one row for COUNT(*),
|
||
// so resultQuery returns an array (never FALSE for this query form).
|
||
// Escape $col when embedding it in the SQL string literal.
|
||
$safe_col = $db->realEscapeSingle($col);
|
||
$check = $db->resultQuery(
|
||
"SELECT COUNT(*) AS n
|
||
FROM information_schema.COLUMNS
|
||
WHERE TABLE_SCHEMA = DATABASE()
|
||
AND TABLE_NAME = '" . $tbl_profiles . "'
|
||
AND COLUMN_NAME = '" . $safe_col . "'"
|
||
);
|
||
// If n > 0 the column already exists; skip it.
|
||
if ($check !== false && isset($check[0]['n']) && (int)$check[0]['n'] > 0) {
|
||
continue;
|
||
}
|
||
// $col is backtick-quoted so it is safe as an identifier.
|
||
if (!$db->query(
|
||
"ALTER TABLE `" . $tbl_profiles . "`
|
||
ADD COLUMN `" . $col . "` " . $def
|
||
)) {
|
||
return false;
|
||
}
|
||
}
|
||
return true;
|
||
},
|
||
|
||
// Add custom_folder to server_workshop_mods (MySQL 5.7 safe).
|
||
function($db) {
|
||
// See note above: 'OGP_DB_PREFIX' is replaced by str_replace at runtime.
|
||
$tbl_mods = 'OGP_DB_PREFIXserver_workshop_mods';
|
||
$check = $db->resultQuery(
|
||
"SELECT COUNT(*) AS n
|
||
FROM information_schema.COLUMNS
|
||
WHERE TABLE_SCHEMA = DATABASE()
|
||
AND TABLE_NAME = '" . $tbl_mods . "'
|
||
AND COLUMN_NAME = 'custom_folder'"
|
||
);
|
||
if ($check !== false && isset($check[0]['n']) && (int)$check[0]['n'] > 0) {
|
||
return true; // Column already exists.
|
||
}
|
||
return (bool)$db->query(
|
||
"ALTER TABLE `" . $tbl_mods . "`
|
||
ADD COLUMN `custom_folder` VARCHAR(255) NOT NULL DEFAULT ''"
|
||
);
|
||
},
|
||
|
||
// New server-level settings table (CREATE IF NOT EXISTS is safe to re-run).
|
||
"CREATE TABLE IF NOT EXISTS `".OGP_DB_PREFIX."server_workshop_settings` (
|
||
`home_id` INT NOT NULL,
|
||
`workshop_enabled` TINYINT(1) NOT NULL DEFAULT 0,
|
||
`profile_id` INT NULL,
|
||
`update_mode` ENUM('manual','scheduled','on_restart') NOT NULL DEFAULT 'manual',
|
||
`restart_behavior` ENUM('none','queue','stop_update_start') NOT NULL DEFAULT 'none',
|
||
`update_queued` TINYINT(1) NOT NULL DEFAULT 0,
|
||
`last_update_status` VARCHAR(20) NOT NULL DEFAULT '',
|
||
`last_update_error` TEXT NULL,
|
||
`last_update_time` DATETIME NULL,
|
||
`last_success_time` DATETIME NULL,
|
||
`updated_at` DATETIME NULL,
|
||
PRIMARY KEY (`home_id`)
|
||
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci"
|
||
);
|