2 if (version_compare(PHP_VERSION
, '8.0.0', '<'))
3 die("This webserver is using PHP version ".PHP_VERSION
." but we require at least PHP 8.0.0.<br>".
4 "If you already installed PHP8 but are still seeing this error, then it means ".
5 "apache/nginx/.. is loading an older PHP version. Eg. on Debian/Ubuntu you need ".
6 "<code>apt-get install libapache2-mod-php8.2</code> (or a similar version) and ".
7 "<code>apt-get remove libapache2-mod-php7.4</code> (or a similar version). ".
8 "You may also need to choose again the PHP module to load in apache via <code>a2enmod php8.2</code>");
10 define('UPATH', dirname(__DIR__
));
12 function get_config($setting)
17 foreach(explode("::", $setting) as $x)
27 function page_requires_no_config()
29 if (str_ends_with($_SERVER['SCRIPT_FILENAME'],"install.php") ||
30 str_ends_with($_SERVER['SCRIPT_FILENAME'],"installation.php"))
37 function page_requires_no_login()
39 if (str_ends_with($_SERVER['SCRIPT_FILENAME'],"login/index.php") ||
40 page_requires_no_config())
47 function read_config_file()
50 GLOBAL $config_transition_unreal_server;
53 if (!file_exists(UPATH
."/config/config.php") && file_exists(UPATH
."/config.php"))
55 require_once UPATH
. "/config.php";
56 require_once UPATH
. "/config/compat.php";
58 if ((@include(UPATH
. "/config/config.php")) !== 1)
60 if (isset($config['unrealircd']))
61 $config_transition_unreal_server = true;
65 function read_config_db()
69 if (page_requires_no_config())
72 $merge = DbSettings
::get();
73 /* DB settings overwrite config.php keys: */
74 $config = array_merge($config, $merge);
77 function config_is_file_item($name)
79 if (($name == "plugins") ||
81 ($name == "base_url") ||
89 function write_config_file()
94 foreach($config as $k=>$v)
96 if (config_is_file_item($k))
97 $file_settings[$k] = $v;
100 $cfg_filename = UPATH
.'/config/config.php';
101 $tmpfile = UPATH
.'/config/config.tmp.'.bin2hex(random_bytes(8)).'.php';
102 $fd = fopen($tmpfile, "w");
104 die("Could not write to temporary config file $tmpfile.<br>We need write permissions on the config/ directory!<br>");
106 $str = var_export($file_settings, true);
108 die("Error while running write_config_file() -- weird!");
109 if (!fwrite($fd, "<?php\n".
110 "/* This config file is written automatically by the UnrealIRCd webpanel.\n".
111 " * You are not really supposed to edit it manually.\n".
113 '$config = '.$str.";\n"))
115 die("Error writing to config file $tmpfile (on fwrite).<br>");
118 die("Error writing to config file $tmpfile (on close).<br>");
119 /* Now atomically rename the file */
120 if (!rename($tmpfile, $cfg_filename))
121 die("Could not write (rename) to file ".$cfg_filename."<br>");
122 if (function_exists('opcache_invalidate'))
123 opcache_invalidate($cfg_filename);
125 /* Do not re-read config, as it would reinitialize config
126 * without having the DB settings read. (And it also
132 // XXX: handle unsetting of config items :D - explicit unset function ?
134 function write_config($setting = null)
138 /* Specific request? Easy, write only this setting to the DB (never used for file) */
139 if ($setting !== null)
141 return DbSettings
::set($setting, $config[$setting]);
144 /* Otherwise write the whole config.
145 * TODO: avoid writing settings file if unneeded,
146 * as it is more noisy than db settings.
150 foreach($config as $k=>$v)
152 if (!config_is_file_item($k))
153 $db_settings[$k] = $v;
156 if (!write_config_file())
159 foreach($db_settings as $k=>$v)
161 $ret = DbSettings
::set($k, $v);
169 function get_version()
171 $fd = @fopen(UPATH
."/.git/FETCH_HEAD", "r");
174 $line = fgets($fd, 512);
176 $commit = substr($line, 0, 8);
177 return $commit; /* short git commit id */
180 function generate_secrets()
184 if (!isset($config['secrets']))
185 $config['secrets'] = Array();
187 if (!isset($config['secrets']['pepper']))
188 $config['secrets']['pepper'] = rtrim(base64_encode(random_bytes(16)),'=');
190 if (!isset($config['secrets']['key']))
191 $config['secrets']['key'] = rtrim(base64_encode(sodium_crypto_aead_xchacha20poly1305_ietf_keygen()),'=');
194 function secret_encrypt(string $text)
198 $key = base64_decode($config['secrets']['key']);
199 $nonce = \random_bytes
(\SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES
);
200 $encrypted_text = sodium_crypto_aead_xchacha20poly1305_ietf_encrypt($text, '', $nonce, $key);
201 return "secret:".rtrim(base64_encode($nonce),'=').':'.rtrim(base64_encode($encrypted_text),'='); // secret:base64(NONCE):base64(ENCRYPTEDTEXT)
204 function secret_decrypt(string $crypted)
208 $key = base64_decode($config['secrets']['key']);
209 $d = explode(":", $crypted);
212 $nonce = base64_decode($d[1]);
213 $ciphertext = base64_decode($d[2]);
215 $ret = sodium_crypto_aead_xchacha20poly1305_ietf_decrypt($ciphertext, '', $nonce, $key);
221 function upgrade_check()
223 GLOBAL $config_transition_unreal_server;
226 /* Moving of a config.php item to DB: */
227 if ($config_transition_unreal_server)
230 /* Our own stuff may need upgrading.. */
231 /* - generating secrets */
232 if (!isset($config['secrets']))
237 /* - encrypting rpc_password */
238 if (isset($config['unrealircd']) &&
239 isset($config['unrealircd']['rpc_password']) &&
240 !str_starts_with($config['unrealircd']['rpc_password'], "secret:"))
242 $ret = secret_encrypt($config['unrealircd']['rpc_password']);
245 $config['unrealircd']['rpc_password'] = $ret;
246 write_config('unrealircd');
250 $version = get_version();
251 if (!isset($config['webpanel_version']))
252 $config['webpanel_version'] = '';
253 if ($version != $config['webpanel_version'])
256 "old_version" => $config['webpanel_version'],
257 "new_version" => $version
259 /* And inform the hook (eg the database backends) */
260 Hook
::run(HOOKTYPE_UPGRADE
, $versioninfo);
261 /* And set the new version now that the upgrade is "done" */
262 $config['webpanel_version'] = $version;
263 write_config("webpanel_version");
267 function panel_start_session($user = false)
269 if (!isset($_SESSION))
271 session_set_cookie_params(86400); // can't set this to session_timeout due to catch-22
277 $user = unreal_get_current_user();
283 if (isset($user->user_meta
['session_timeout']))
284 $timeout = (INT)$user->user_meta
['session_timeout'];
286 if (!isset($_SESSION['session_timeout']))
287 $_SESSION['session_timeout'] = $timeout;
289 $_SESSION['last-activity'] = time();
293 /* Now read the config, and redirect to install screen if we don't have it */
294 $config_transition_unreal_server = false;
295 if (!read_config_file())
297 if (page_requires_no_config())
299 /* Allow empty conf */
301 if (!file_exists(UPATH
."/config/config.php") && !file_exists(UPATH
."/config.php"))
303 header("Location: settings/install.php");
308 require_once UPATH
. "/Classes/class-hook.php";
309 if (!is_dir(UPATH
. "/vendor"))
310 die("The vendor/ directory is missing. Most likely the admin forgot to run 'composer install'\n");
311 require_once UPATH
. '/vendor/autoload.php';
312 require_once UPATH
. "/Classes/class-cmodes.php";
313 require_once UPATH
. "/inc/defines.php";
314 require_once UPATH
. "/misc/strings.php";
315 require_once UPATH
. "/misc/channel-lookup-misc.php";
316 require_once UPATH
. "/misc/user-lookup-misc.php";
317 require_once UPATH
. "/misc/server-lookup-misc.php";
318 require_once UPATH
. "/misc/ip-whois-misc.php";
319 require_once UPATH
. "/Classes/class-log.php";
320 require_once UPATH
. "/Classes/class-message.php";
321 require_once UPATH
. "/Classes/class-rpc.php";
322 require_once UPATH
. "/Classes/class-paneluser.php";
323 require_once UPATH
. "/plugins.php";
325 /* Do various checks and reading, except during setup step 1. */
326 if (!page_requires_no_config())
328 /* Now that plugins are loaded, read config from DB */
331 /* Check if anything needs upgrading (eg on panel version change) */
335 if (!get_config("base_url"))
336 die("The base_url was not found in your config. Setup went wrong?");
342 "Channels" => "channels",
343 "Servers" => "servers",
345 "Server Bans" => "server-bans",
346 "Name Bans" => "server-bans/name-bans.php",
347 "Ban Exceptions" => "server-bans/ban-exceptions.php"
349 "Spamfilter" => "spamfilter.php",
351 "IP WHOIS" => "tools/ip-whois.php",
354 "Plugins" => "settings/plugins.php",
357 "News" => "news.php",
360 if (!panel_start_session())
362 if (!page_requires_no_login())
364 if (!is_auth_provided())
365 die("No authentication plugin loaded. You must load either sql_auth, file_auth, or a similar auth plugin!");
366 $current_page = $_SERVER['REQUEST_URI'];
367 header("Location: ".get_config("base_url")."login/?redirect=".urlencode($current_page));
371 $pages["Settings"]["Accounts"] = "settings";
372 if (current_user_can(PERMISSION_MANAGE_USERS
))
373 $pages["Settings"]["Role Editor"] = "settings/user-role-edit.php";
374 $user = unreal_get_current_user();
377 /* Add logout page, if logged in */
378 $pages["Logout"] = "login/?logout=true";
382 Hook
::run(HOOKTYPE_NAVBAR
, $pages);
384 /* Example to add new menu item:
389 * function __construct()
391 * Hook::func(HOOKTYPE_NAVBAR, [$this, 'add_menu'])
394 * function add_menu(&$pages) // this should pass by reference (using the & prefix)
396 * $page_name = "My New Page";
397 * $page_link = "link/to/page.php";
398 * $pages[$page_name] = $page_link;