GSP/Panel
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Panel/includes/helpers.php
copilot-swe-agent[bot] 7377f955fd
Fix PHP 8.3 htmlentities null safety, remove unused themes, rename OGP_LANG_ to LANG_ 
Agent-Logs-Url: https://github.com/GameServerPanel/GSP/sessions/9909a053-0a66-4453-a844-d3b80d727b27

Co-authored-by: iaretechnician <2749183+iaretechnician@users.noreply.github.com>
2026-05-04 17:31:16 +00:00

495 lines
15 KiB
PHP
Raw Blame History

<?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.
*
*/
// Globals
$OGPLangPre = "LANG_";
// Ignore any request with unwanted values at 'm' or 'p'
if( isset($_REQUEST['m']) and !preg_match("/^([a-z]|[0-9]|_|-)+$/i", $_REQUEST['m']) )
unset($_POST['m'], $_GET['m'], $_REQUEST['m']);
if( isset($_REQUEST['p']) and ( !isset($_REQUEST['m']) or !preg_match("/^([a-z]|[0-9]|_|-)+$/i", $_REQUEST['p']) ) )
{
if( isset($_REQUEST['m']) )
unset($_POST['m'], $_GET['m'], $_REQUEST['m']);
unset($_POST['p'], $_GET['p'], $_REQUEST['p']);
}
if(file_exists(__DIR__ . "/lang.php")){
require_once(__DIR__ . "/lang.php");
}else{
require_once("lang.php");
}
/// \return the database object when the creation was successfull.
/// \return FALSE if database type was invalid.
/// \return negative value in case of error
function createDatabaseConnection($db_type,$db_host,$db_user,$db_pass,$db_name,$table_prefix,$db_port=NULL)
{
if ( $db_type == "mysql" )
{
if ( function_exists('mysqli_connect') )
require_once("includes/database_mysqli.php");
else
die("<p class='failure'>OGP requires the <a href='http://php.net/manual/en/book.mysqli.php' target='_blank'>mysqli PHP extension</a>. Please install it, and then try again.</p>");
$database = new OGPDatabaseMysql();
$connect_value = $database->connect($db_host,$db_user,$db_pass,$db_name,$table_prefix,$db_port);
if ($connect_value === TRUE)
return $database;
// See return values from database classes.
return $connect_value;
}
else
{
return -98;
}
}
function get_db_error_text ($db_retval, &$error_text)
{
if (is_a($db_retval,"OGPDatabase"))
return FALSE;
switch ($db_retval) {
case -1:
$error_text = get_lang("db_error_invalid_host");
break;
case -11:
$error_text = get_lang("db_error_invalid_user_and_pass");
break;
case -12:
$error_text = get_lang("db_error_invalid_database");
break;
case -98:
$error_text = get_lang("db_error_invalid_db_type");
break;
case -99:
$error_text = get_lang("db_error_module_missing");
break;
default:
$error_text = get_lang_f("db_unknown_error",$db_retval);
break;
}
return TRUE;
}
// Create a list of files or folders and store them in an array
function makefilelist($folder, $filter, $sort=true, $type="files") {
$res = array();
$filter = explode("|", $filter);
$temp = opendir($folder);
while ($file = readdir($temp)) {
if ($type == "files" && !in_array($file, $filter)) {
if (!is_dir($folder.$file)) $res[] = $file;
} elseif ($type == "folders" && !in_array($file, $filter)) {
if (is_dir($folder.$file)) $res[] = $file;
}
}
closedir($temp);
if ($sort) sort($res);
return $res;
}
function isPortValid($port)
{
return ( $port > 0 && $port <= 65535 );
}
function cleanFilenames($file_array)
{
$retval = array();
foreach ((array)$file_array as $file_name)
{
if($file_name === "." && $file_name === "..")
continue;
/// \todo @ is because of files without . in the name.extension.
@list($value, $ext) = explode(".", $file_name);
array_push($retval,$value);
}
return $retval;
}
function clean_id_string($id_string)
{
return preg_replace("/-/","",$id_string);
}
function get_first_existing_file($paths, $referrer = "", $agent = "")
{
foreach ((array)$paths as $path)
{
if(preg_match("/^http/", $path))
{
if(cURLEnabled()){
// Get headers using cURL
$file_headers = @get_headers_curl($path, $referrer, $agent);
}else{
// Five second timeout...
$origSocketTimeout = ini_get('default_socket_timeout');
ini_set('default_socket_timeout', 5);
// Get headers with a socket timeout value of 5 seconds...
if(isset($agent) && !empty($agent)){
stream_context_set_default(
array(
'http' => array(
'method' => 'GET',
'user_agent' => $agent
)
)
);
}
$file_headers = @get_headers($path);
// Reset timeout to old value
ini_set('default_socket_timeout', $origSocketTimeout);
}
if(trim($file_headers[0]) == 'HTTP/1.0 200 OK' || trim($file_headers[0]) == 'HTTP/1.1 200 OK') return $path;
}
if (file_exists($path)) return $path;
}
return false;
}
function cURLEnabled(){
return function_exists('curl_version');
}
function get_headers_curl($url, $referrer = "", $agent = "")
{
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HEADER, true);
curl_setopt($ch, CURLOPT_NOBODY, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
if(isset($referrer) && !empty($referrer)){
curl_setopt($ch, CURLOPT_REFERER, $referrer);
}
if(isset($agent) && !empty($agent)){
curl_setopt($ch, CURLOPT_USERAGENT, $agent);
}
// 5 second timeout should be reasonable...
curl_setopt($ch, CURLOPT_TIMEOUT, 5);
$r = curl_exec($ch);
$r = explode("\n", $r);
if(is_array($r)){
$r = array_filter($r, 'strlen');
// Get rid of the last index value which appears to be holding odd characters
array_pop($r);
}
return $r;
}
function clean_path($path)
{
// Replace multiple / or \ marks with one /.
return preg_replace("/[\/|\\\\]+/","/",$path);
}
function sanitizeInputStr($strToProcess, $removeHTML = true, $trim = true, $removeQuotes = true){
// Remove quotes from string
if($removeQuotes){
// For magic quotes or addslashes values
$strToProcess = str_replace('\"', '', $strToProcess);
$strToProcess = str_replace("\'", "", $strToProcess);
// Remove any possible leftovers
$strToProcess = str_replace('"', '', $strToProcess);
$strToProcess = str_replace("'", "", $strToProcess);
}
// Trim string value
if($trim){
$strToProcess = trim($strToProcess);
}
// Remove HTML tags
if($removeHTML){
$strToProcess = strip_tags($strToProcess);
}
// Return the processed string
return $strToProcess;
}
function startSession(){
if(!isset($_SESSION)){
session_name("opengamepanel_web");
session_start();
}
}
function updateGameConfigsPostInstall($clear_old = false){
global $db;
if(file_exists('modules/config_games/server_config_parser.php')){
require_once('modules/config_games/server_config_parser.php');
}else{
require_once(__DIR__ . '/../modules/config_games/server_config_parser.php');
}
if(function_exists("read_server_config")){
removeOldGameConfigs();
$files = glob(SERVER_CONFIG_LOCATION."*.xml");
if ( empty($files) )
{
return false;
}
$db->clearGameCfgs($clear_old);
$counter = 0;
foreach ((array)$files as $config_file)
{
$config = read_server_config($config_file);
if ( !$db->addGameCfg($config) )
{
$counter++;
continue;
}
}
if($counter == count((array)$files)){
return false;
}
return true;
}
return false;
}
function isCoreModule($module){
$coreModules = array('modulemanager', 'server', 'settings', 'gamemanager', 'config_games', 'administration', 'user_games', 'user_admin', 'update');
if(in_array($module, $coreModules)){
return true;
}
return false;
}
function recursiveDelete($str) {
if (file_exists($str) && is_file($str)) {
return @unlink($str);
}else if(file_exists($str) && is_dir($str)){
// Strip the trailing slash from the directory if there is one
$str = rtrim($str,'/');
// Get the index of the last slash in the path so that we can pull just the relative folder name being scanned
$lastSlash = strrpos($str, "/");
if($lastSlash != false){
// Get the folder name so we can ignore "." and ".." which relates to current directory and up a level
$folder = substr($str, $lastSlash + 1);
if($folder != ".." && $folder != "."){
$scan = glob($str . '/{,.}*', GLOB_BRACE);
if(isset($scan) && is_array($scan)){
foreach ((array)$scan as $index=>$path) {
recursiveDelete($path);
}
}
return @rmdir($str);
}
}
}
return true;
}
function removeOldGameConfigs(){ // Wrote this function in-case we rename config files like we did for TS3 (https://sourceforge.net/p/hldstart/svn/3376/)
$oldConfigsToRemove = array(
'modules/config_games/server_configs/ins_win32.xml',
'modules/config_games/server_configs/ins.xml',
'modules/config_games/server_configs/insurgency.xml',
'modules/config_games/server_configs/left_4_dead.xml',
'modules/config_games/server_configs/left_4_dead2.xml',
'modules/config_games/server_configs/left_4_dead2_win.xml',
'modules/config_games/server_configs/warsow.xml',
'modules/config_games/server_configs/big_brother_bot.xml',
'modules/config_games/server_configs/big_brother_bot_win.xml',
'modules/config_games/server_configs/egs_win64.xml',
'modules/config_games/server_configs/7_days_to_die_linux.xml',
'modules/config_games/server_configs/7_days_to_die_linux64.xml',
'modules/config_games/server_configs/TrackManiaForever.xml',
'modules/config_games/server_configs/trackmania_nations.xml',
'modules/config_games/server_configs/ventrilo.xml',
'modules/config_games/server_configs/ventrilo_win.xml',
'modules/config_games/server_configs/vice_city_multiplayer.xml',
'modules/config_games/server_configs/vice_city_multiplayer_win.xml',
'modules/config_games/server_configs/san_andreas_multiplayer.xml',
'modules/config_games/server_configs/san_andreas_multiplayer_win.xml',
'modules/config_games/server_configs/MultiTheftAuto.xml',
'modules/config_games/server_configs/MultiTheftAuto_win.xml',
'modules/config_games/server_configs/alienvspredator2010.xml',
'modules/config_games/server_configs/cod_mw2_win.xml',
'modules/config_games/server_configs/cod_uo_win.xml',
'modules/config_games/server_configs/cod_1_win.xml',
'modules/config_games/server_configs/cod_mw3_win.xml',
'modules/config_games/server_configs/cod2.xml',
'modules/config_games/server_configs/cod2_win.xml',
'modules/config_games/server_configs/cod4.xml',
'modules/config_games/server_configs/cod4_win.xml',
'modules/config_games/server_configs/cod5.xml',
'modules/config_games/server_configs/cod_world_at_war_win.xml',
'modules/config_games/server_configs/minecraft_tekkit.xml',
'modules/config_games/server_configs/minecraft_tekkit_win.xml',
'modules/config_games/server_configs/minecraft_bukkit.xml',
'modules/config_games/server_configs/minecraft_bukkit_win.xml',
'modules/config_games/server_configs/minecraft_server.xml',
'modules/config_games/server_configs/minecraft_server_win.xml',
'modules/config_games/server_configs/life_is_feudal_win32.xml',
'modules/config_games/server_configs/cs2d.xml',
'modules/config_games/server_configs/openttd.xml',
'modules/config_games/server_configs/ark_linux.xml',
'modules/config_games/server_configs/ark_win.xml',
'modules/config_games/server_configs/teamspeak3_32bit.xml',
'modules/config_games/server_configs/teamspeak3_64bit.xml',
'modules/config_games/server_configs/tekkit_linux32.xml',
'modules/config_games/server_configs/tekkit_linux64.xml',
'modules/config_games/server_configs/tekkit_win32.xml',
'modules/config_games/server_configs/tekkit_win64.xml',
'modules/config_games/server_configs/bukkit_linux32.xml',
'modules/config_games/server_configs/bukkit_linux64.xml',
'modules/config_games/server_configs/bukkit_win32.xml',
'modules/config_games/server_configs/bukkit_win64.xml',
);
foreach ((array)$oldConfigsToRemove as $config){
recursiveDelete($config);
}
}
function removeOldPanelFiles(){ // Should run post panel update to remove old files that are no longer users
$oldFiles = array(
'includes/database_mysql.php',
'protocol/GameQ/gameq'
);
foreach ((array)$oldFiles as $file){
recursiveDelete($file);
}
}
function runPostUpdateOperations(){
if(file_exists('modules/cron/shared_cron_functions.php')){
// Update cronjobs to use the new token based API
require_once('modules/cron/shared_cron_functions.php');
if(function_exists("updateCronJobsToNewApi")){
updateCronJobsToNewApi();
}
}
if(function_exists("updateAllPanelModules")){
updateAllPanelModules();
}
if(function_exists("removeOldPanelFiles")){
removeOldPanelFiles();
}
if(!array_key_exists("users_api_key", (array)$_SESSION)){
$_SESSION['users_api_key'] = $db->getApiToken($_SESSION['user_id']);
}
}
function getOGPGitHubURL($gitHubUsername, $repo){
$OGPGitHub = "https://github.com/OpenGamePanel/";
$gitHubURL = $OGPGitHub;
if(isset($gitHubUsername) && !empty($gitHubUsername)){
$gitHubURL = "https://github.com/" . $gitHubUsername . "/";
}
$paths[] = $gitHubURL . $repo . "/commits/master.atom";
$exists = get_first_existing_file($paths);
if($exists !== false){
return $gitHubURL;
}
return $OGPGitHub;
}
function getOGPGitHubURLUnstrict($gitHubUsername){
$OGPGitHub = "https://github.com/OpenGamePanel/";
$gitHubURL = $OGPGitHub;
if(isset($gitHubUsername) && !empty($gitHubUsername)){
$gitHubURL = "https://github.com/" . $gitHubUsername . "/";
}
$paths[] = $gitHubURL;
$exists = get_first_existing_file($paths);
if($exists !== false){
return $gitHubURL;
}
return $OGPGitHub;
}
function getGitHubOrganization($gitHubURL){
$gitHubOrg = "OpenGamePanel";
$githubCom = "github.com";
if(substr($gitHubURL, -1) == "/" && stripos($gitHubURL, $githubCom) !== false){
// Get the immediate folder after github.com
$gitHubOrg = substr($gitHubURL, stripos($gitHubURL, $githubCom) + strlen($githubCom) + 1);
// Strip last forward slash
$gitHubOrg = substr($gitHubOrg, 0, -1);
}
return $gitHubOrg;
}
function getOGPLangConstantsJSON(){
global $OGPLangPre;
$finalConsts = array();
$consts = get_defined_constants(true);
foreach ((array)$consts["user"] as $key => $value){
if(startsWith($key, $OGPLangPre)){
$finalConsts[$key] = $value;
}
}
if(count((array)$finalConsts) > 0){
return json_encode(utf8ize($finalConsts));
}
return false;
}
?>
Reference in a new issue View git blame Copy permalink