Bootstrap::handleNoLockInstallState() - Code Metrics - Inspection of "Merge pull request #3822 from Spuds/LocalDev" - elkarte/Elkarte - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — development ( b773b4...471a27 )

by Spuds
created 2025-12-07 17:28 UTC
Bootstrap::handleNoLockInstallState() C

↳ Parent: Bootstrap
Complexity

Conditions	13
Paths	88
Size

Total Lines	39
Code Lines	20
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	13
eloc	20
c	1
b	0
f	0
nc	88
nop	1
dl	0
loc	39
rs	6.6166
How to fix Complexity

<?php

/**
 * Initialize the ElkArte environment.
 *
 * @package   ElkArte Forum
 * @copyright ElkArte Forum contributors
 * @license   BSD http://opensource.org/licenses/BSD-3-Clause (see accompanying LICENSE.txt file)
 *
 * This file contains code covered by:
 * copyright: 2011 Simple Machines (http://www.simplemachines.org)
 *
 * @version 2.0 dev
 */

use BBC\ParserWrapper;
use ElkArte\Cache\Cache;
use ElkArte\Controller\Auth;
use ElkArte\Debug;
use ElkArte\Errors\Errors;
filter:
    dependency_paths: ["lib/*"]
use ElkArte\EventManager;
use ElkArte\ext\Composer\Autoload\ClassLoader;
use ElkArte\Helper\TokenHash;
use ElkArte\Hooks;
use ElkArte\MembersList;
use ElkArte\Request;
use ElkArte\Themes\ThemeLoader;
use ElkArte\User;

/**
 * Class Bootstrap
 *
 * Takes care of the initial loading and feeding of Elkarte from
 * either SSI or Index
 */
class Bootstrap
{
	/** @var array What is returned by the function getrusage. */
	protected $rusage_start = [];

	/**
	 * Bootstrap constructor.
	 *
	 * @param bool $standalone
	 *  - True to boot outside elkarte
	 *  - False to bootstrap the main elkarte site.
	 */
	public function __construct($standalone = true)
	{
		// Bootstrap only once.
		if (!defined('ELKBOOT'))
		{
			// We're going to set a few globals
			global $time_start, $ssi_error_reporting, $db_show_debug;

			// Your on the clock
			$time_start = microtime(true);

			// Unless settings.php tells us otherwise
			$db_show_debug = false;

			// Report errors but not depreciated ones
			$ssi_error_reporting = error_reporting(E_ALL & ~E_DEPRECATED);

			// Get the things needed for ALL modes
			$this->bringUpBasics();

			// Going to run from the side entrance and not directly from inside elkarte
			if ($standalone)
			{
				$this->ssi_main();
			}
		}
	}

	/**
	 * Calls various initialization functions in the necessary order
	 */
	public function bringUpBasics()
	{
		$this->setConstants();
		$this->setRusage();
		$this->clearGlobals();
		$this->loadSettingsFile();
		$this->validatePaths();
		$this->loadDependants();
		$this->loadAutoloader();
		$this->checkMaintance();
		$this->setDebug();
		$this->bringUp();
	}

	/**
	 * Set the core constants, you know the ones we often forget to
	 * update on new releases.
	 */
	private function setConstants()
	{
		// First things first, but not necessarily in that order.
		if (!defined('ELK'))
		{
			define('ELK', '1');
		}

		define('ELKBOOT', '1');

		// The software version
		define('FORUM_VERSION', 'ElkArte 2.0 dev');

		// Shortcut for the browser cache stale
		define('CACHE_STALE', '?20dev');
	}

	/**
	 * Get initial resource usage
	 */
	private function setRusage()
	{
		$this->rusage_start = getrusage();
	}

	/**
	 * If they glo, they need to be cleaned.
	 */
	private function clearGlobals()
	{
		// We don't need no globals. (a bug in "old" versions of PHP)
		foreach (['db_character_set', 'cachedir'] as $variable)
		{
			if (isset($GLOBALS[$variable]))
			{
				unset($GLOBALS[$variable], $GLOBALS[$variable]);
			}
		}
	}

	/**
	 * Loads the Settings.php values into the global space
	 */
	private function loadSettingsFile()
	{
		// All those wonderful things found in settings
		global $maintenance, $mtitle, $msubject, $mmessage, $mbname, $language, $boardurl, $webmaster_email;
		global $cookiename, $db_type, $db_server, $db_port, $db_name, $db_user, $db_passwd;
		global $ssi_db_user, $ssi_db_passwd, $db_prefix, $db_persist, $db_error_send;
		global $cache_uid, $cache_password, $cache_enable, $cache_servers, $cache_accelerator;
		global $db_show_debug, $url_format, $cachedir, $boarddir, $sourcedir, $extdir, $languagedir;

		// Where the Settings.php file is located
		$settings_location = __DIR__ . '/Settings.php';

		// First thing: prefer the presence of a lock file to short-circuit any installer logic
		// The IGNORE_INSTALL_DIR constant is intended for development only.
		if (file_exists(__DIR__ . '/installed.lock'))
		{
			require_once($settings_location);
			return;
		}

		// No lock present: decide if we should redirect to install/upgrade or continue
		$this->handleNoLockInstallState($settings_location);
	}

	/**
	 * Decides installation vs upgrade vs a normal load when no lock file is present.
	 *
	 * Rules:
	 * - If Settings.php exists and $install_time is set (not 0/empty) and installer exists → redirect to upgrade.php
	 * - If Settings.php exists and $install_time is 0/empty and installer exists → redirect to install.php
	 * - If Settings.php does not exist and installer exists → redirect to install.php
	 * - Otherwise, just continue (and Settings.php will be loaded by caller if present)
	 *
	 * @param string $settings_location Absolute path to Settings.php
	 */
	private function handleNoLockInstallState($settings_location)
	{
		// Values defined in Settings
		global $maintenance, $mtitle, $msubject, $mmessage, $mbname, $language, $boardurl, $webmaster_email;
		global $cookiename, $db_type, $db_server, $db_port, $db_name, $db_user, $db_passwd;
		global $ssi_db_user, $ssi_db_passwd, $db_prefix, $db_persist, $db_error_send;
		global $cache_uid, $cache_password, $cache_enable, $cache_servers, $cache_accelerator;
		global $db_show_debug, $url_format, $cachedir, $boarddir, $sourcedir, $extdir, $languagedir;

		$hasInstallDir = is_dir(__DIR__ . '/install');
		$hasInstall = $hasInstallDir && file_exists(__DIR__ . '/install/install.php');
		$hasUpgrade = $hasInstallDir && file_exists(__DIR__ . '/install/upgrade.php');
		$hasSettings = file_exists($settings_location);

		if ($hasSettings)
		{
			// Load to get $install_time and set the globals
			require_once($settings_location);
		}

		// If we have an installer directory available, decide the proper entry
		if (!defined('IGNORE_INSTALL_DIR') && ($hasInstall || $hasUpgrade))
		{
			$redirect_file = 'install.php';

			if ($hasSettings)
			{
				// If install_time is non-empty and non-zero, prefer upgrade flow when available
				$isInstalled = !empty($install_time) && $install_time !== '0';

				if ($isInstalled && $hasUpgrade && empty($_SESSION['installing']))
				{
					$redirect_file = 'upgrade.php';
				}
			}

			// Build a safe, relative redirect to avoid host header issues
			$version_running = defined('FORUM_VERSION') ? str_replace('ElkArte ', '', FORUM_VERSION) : '';
			header('Location: install/' . $redirect_file . '?v=' . $version_running);
			die();
		}

		// No installer available, nothing to redirect to; simply return
	}

	/**
	 * Validate the paths set in Settings.php, correct as needed and move them to constants.
	 */
	private function validatePaths()
	{
		global $boarddir, $sourcedir, $cachedir, $extdir, $languagedir;

		// Make sure the paths are correct... at least try to fix them.
		if (!file_exists($boarddir) && file_exists(__DIR__ . '/bootstrap.php'))
		{
			$boarddir = __DIR__;
		}

		if (!file_exists($sourcedir . '/SiteDispatcher.class.php') && file_exists($boarddir . '/sources'))
		{
			$sourcedir = $boarddir . '/sources';
		}

		// Check that directories which didn't exist in past releases are initialized.
		if ((empty($cachedir) || !file_exists($cachedir)) && file_exists($boarddir . '/cache'))
		{
			$cachedir = $boarddir . '/cache';
		}

		if ((empty($extdir) || !file_exists($extdir)) && file_exists($sourcedir . '/ext'))
		{
			$extdir = $sourcedir . '/ext';
		}

		if ((empty($languagedir) || !file_exists($languagedir)) && file_exists($sourcedir . '/Languages/Index'))
		{
			$languagedir = $sourcedir . '/ElkArte/Languages';
		}

		// Time to forget about variables and go with constants!
		define('BOARDDIR', $boarddir);
		define('CACHEDIR', $cachedir);
		define('EXTDIR', $extdir);
		define('LANGUAGEDIR', $languagedir);
		define('SOURCEDIR', $sourcedir);
		define('ADMINDIR', $sourcedir . '/ElkArte/AdminController');
		define('CONTROLLERDIR', $sourcedir . '/ElkArte/Controller');
		define('SUBSDIR', $sourcedir . '/subs');
		define('ADDONSDIR', $boarddir . '/Addons');
		define('ELKARTEDIR', $sourcedir . '/ElkArte');
		unset($boarddir, $cachedir, $sourcedir, $languagedir, $extdir);
	}

	/**
	 * We require access to several important files, so load them upfront
	 */
	private function loadDependants()
	{
		// Files we cannot live without.
		require_once(SOURCEDIR . '/QueryString.php');
		require_once(SOURCEDIR . '/Session.php');
		require_once(SOURCEDIR . '/Subs.php');
		require_once(SOURCEDIR . '/Logging.php');
		require_once(SOURCEDIR . '/Load.php');
		require_once(SOURCEDIR . '/Security.php');
		require_once(SUBSDIR . '/Cache.subs.php');
	}

	/**
	 * The autoloader will take care of most requests for files
	 */
	private function loadAutoloader()
	{
		require_once(EXTDIR . '/ClassLoader.php');

		$loader = new ClassLoader();
		$loader->setPsr4('ElkArte\\', SOURCEDIR . '/ElkArte');
		$loader->setPsr4('ElkArte\\', /** @scrutinizer ignore-type */ SOURCEDIR . '/ElkArte');
		$loader->setPsr4('BBC\\', SOURCEDIR . '/ElkArte/BBC');
		$loader->setPsr4('Addons\\', BOARDDIR . '/Addons');
		$loader->register();
	}

	/**
	 * Check if we are in maintenance mode, if so end here.
	 */
	private function checkMaintance()
	{
		global $maintenance, $ssi_maintenance_off;

		// Don't do john didley if the forum's been shut down completely.
		if (empty($maintenance))
		{
			return;
		}

		if ((int) $maintenance !== 2)
		{
			return;
		}

		if (isset($ssi_maintenance_off) && $ssi_maintenance_off === true)
		{
			return;
		}

		Errors::instance()->display_maintenance_message();
	}

	/**
	 * If you like lots of debug information in error messages and below the footer
	 * then set $db_show_debug to true in settings.  Don't do this on a production site.
	 */
	private function setDebug()
	{
		global $db_show_debug, $ssi_error_reporting;

		// Show lots of debug information below the page, not for production sites
		if ($db_show_debug === true)
		{
			Debug::instance()->rusage('start', $this->rusage_start);
			$ssi_error_reporting = error_reporting(E_ALL | E_STRICT & ~8192);
		}
	}

	/**
	 * Time to see what has been requested, by whom and dispatch it to the proper handler
	 */
	private function bringUp()
	{
		global $context;

		// Initiate the database connection and define some database functions to use.
		loadDatabase();

		// Let's set up our shiny new hooks handler.
		Hooks::init(database(), Debug::instance());

		// It's time for settings loaded from the database.
		reloadSettings();

		// Clean the request.
		cleanRequest();

		// Make sure we have the list of members for populating it
		MembersList::init(database(), Cache::instance(), ParserWrapper::instance());

		// Our good ole' contextual array, which will hold everything
		if (empty($context))
		{
			$context = [];
		}
	}

	/**
	 * If you are running SSI standalone, you need to call this function after bootstrap is
	 * initialized.
	 */
	public function ssi_main()
	{
		global $ssi_layers, $ssi_theme, $ssi_gzip, $ssi_ban, $ssi_guest_access;
		global $modSettings, $context, $board, $topic, $txt;

		// Check on any hacking attempts.
		$this->_validRequestCheck();

		// Gzip output? (because it must be boolean and true, this can't be hacked.)
		if (isset($ssi_gzip) && $ssi_gzip === true && detectServer()->outPutCompressionEnabled())
		{
			ob_start('ob_gzhandler');
		}
		else
		{
			$modSettings['enableCompressedOutput'] = '0';
		}

		// Primarily, this is to fix the URLs...
		ob_start('ob_sessrewrite');

		// Start the session... known to scramble SSI includes in cases...
		if (!headers_sent())
		{
			loadSession();
		}
		else
		{
			if (isset($_COOKIE[session_name()]) || isset($_REQUEST[session_name()]))
			{
				// Make a stab at it, but ignore the E_WARNINGs generated because we can't send headers.
				$temp = error_reporting(error_reporting() & !E_WARNING);
				loadSession();
				error_reporting($temp);
			}

			if (!isset($_SESSION['session_value']))
			{
				$tokenizer = new TokenHash();
				$_SESSION['session_value'] = $tokenizer->generate_hash(32, session_id());
				$_SESSION['session_var'] = substr(preg_replace('~^\d+~', '', $tokenizer->generate_hash(16, session_id())), 0, rand(7, 12));
			}

			// This is here only to avoid session errors in PHP7
			// microtime effectively forces the replacing of the session in the db each
			// time the page is loaded
			$_SESSION['mictrotime'] = microtime();
		}

		// Get rid of $board and $topic... do stuff loadBoard would do.
		unset($board, $topic);
		$context['breadcrumbs'] = [];

		// Load the user and their cookie, as well as their settings.
		User::load(true);
		$context['user']['is_mod'] = User::$info->is_mod ?? false;

		// Load the current user's permissions....
		loadPermissions();

		// Load the current or SSI theme. (just use $ssi_theme = id_theme;)
		new ThemeLoader(isset($ssi_theme) ? (int) $ssi_theme : 0);

		// Load BadBehavior functions, but not when running from CLI
		if (!defined('STDIN') && runBadBehavior())
		{
			// 403 and gone
			Errors::instance()->display_403_error(true);
		}

		// Take care of any banning that needs to be done.
		if (isset($_REQUEST['ssi_ban']) || (isset($ssi_ban) && $ssi_ban === true))
		{
			is_not_banned();
		}

		// Do we allow guests in here?
		if (empty($ssi_guest_access) && empty($modSettings['allow_guestAccess']) && User::$info->is_guest && basename($_SERVER['PHP_SELF']) !== 'SSI.php')
		{
			$controller = new Auth(new EventManager());
			$controller->setUser(User::$info);
			$controller->action_kickguest();
			obExit(null, true);
		}

		if (!empty($modSettings['front_page']) && class_exists($modSettings['front_page'])
			&& in_array('frontPageHook', get_class_methods($modSettings['front_page'])))
		{
			$modSettings['default_forum_action'] = ['action' => 'forum'];
		}
		else
		{
			$modSettings['default_forum_action'] = [];
		}

		// Load the stuff like the menu bar, etc.
		if (isset($ssi_layers))
		{
			$template_layers = theme()->getLayers();
			$template_layers->removeAll();
			foreach ($ssi_layers as $layer)
			{
				$template_layers->addBegin($layer);
			}

			template_header();
		}
		else
		{
			setupThemeContext();
		}

		// We need to set up user agent, and make more checks on the request
		$req = Request::instance();

		// Make sure they didn't muss around with the settings... but only if it's not cli.
		if (isset($_SERVER['REMOTE_ADDR']) && session_id() === '')
		{
			trigger_error($txt['ssi_session_broken']);
		}

		// Without visiting the forum this session variable might not be set on submit.
		if (isset($_SESSION['USER_AGENT']))
		{
			return;
		}

		if (isset($_GET['ssi_function']) && $_GET['ssi_function'] === 'pollVote')
		{
			return;
		}

		$_SESSION['USER_AGENT'] = $req->user_agent();
	}

	/**
	 * Used to ensure SSI requests are valid and not a probing attempt
	 */
	private function _validRequestCheck()
	{
		global $ssi_theme, $ssi_layers;

		// Check on any hacking attempts.
		if (
			isset($_REQUEST['GLOBALS']) || isset($_COOKIE['GLOBALS'])
			|| (isset($_REQUEST['ssi_theme']) && ((int) $_REQUEST['ssi_theme'] === (int) $ssi_theme))
			|| (isset($_COOKIE['ssi_theme']) && ((int) $_COOKIE['ssi_theme'] === (int) $ssi_theme))
			|| (isset($_REQUEST['ssi_layers'], $ssi_layers) && ($_REQUEST['ssi_layers'] == $ssi_layers))
			|| isset($_REQUEST['context']))
		{
			die('No access...');

		}
	}
}

elkarte / Elkarte

Push — development ( b773b4...471a27 )

Bootstrap::handleNoLockInstallState() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like
