Merge branch '3.0'

[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / system / WCFACP.class.php

<?php
namespace wcf\system;
use wcf\acp\form\MasterPasswordForm;
use wcf\acp\form\MasterPasswordInitForm;
use wcf\data\menu\Menu;
use wcf\data\menu\MenuCache;
use wcf\system\application\ApplicationHandler;
use wcf\system\cache\builder\ACPSearchProviderCacheBuilder;
use wcf\system\event\EventHandler;
use wcf\system\exception\AJAXException;
use wcf\system\exception\PermissionDeniedException;
use wcf\system\exception\SystemException;
use wcf\system\request\LinkHandler;
use wcf\system\request\RouteHandler;
use wcf\system\session\ACPSessionFactory;
use wcf\system\session\SessionHandler;
use wcf\system\template\ACPTemplateEngine;
use wcf\util\FileUtil;
use wcf\util\HeaderUtil;

/**
 * Extends WCF class with functions for the ACP.
 * 
 * @author	Marcel Werk
 * @copyright	2001-2018 WoltLab GmbH
 * @license	GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 * @package	WoltLabSuite\Core\System
 */
class WCFACP extends WCF {
	/**
	 * rescue mode
	 * @var	boolean
	 */
	protected static $inRescueMode;
	
	/**
	 * URL to WCF within rescue mode
	 * @var	string
	 */
	protected static $rescueModePageURL;
	
	/** @noinspection PhpMissingParentConstructorInspection */
	/**
	 * Calls all init functions of the WCF and the WCFACP class. 
	 */
	public function __construct() {
		// add autoload directory
		self::$autoloadDirectories['wcf'] = WCF_DIR . 'lib/';
		
		// define tmp directory
		if (!defined('TMP_DIR')) define('TMP_DIR', FileUtil::getTempFolder());
		
		// start initialization
		$this->initDB();
		$this->loadOptions();
		$this->initPackage();
		$this->initSession();
		$this->initLanguage();
		$this->initTPL();
		$this->initCronjobs();
		$this->initCoreObjects();
		
		// prevent application loading during setup
		if (PACKAGE_ID) {
			$this->initApplications();
		}
		
		$this->initBlacklist();
		$this->initAuth();
		
		EventHandler::getInstance()->fireAction($this, 'initialized');
	}
	
	/**
	 * Returns the main menu object.
	 * 
	 * @return	Menu|null	menu object
	 * @since	3.0
	 */
	public function getFrontendMenu() {
		return MenuCache::getInstance()->getMainMenu();
	}
	
	/**
	 * Returns true if ACP is currently in rescue mode.
	 * 
	 * @return	boolean
	 */
	public static function inRescueMode() {
		if (self::$inRescueMode === null) {
			self::$inRescueMode = false;
			
			if (PACKAGE_ID && isset($_SERVER['HTTP_HOST'])) {
				self::$inRescueMode = true;
				
				foreach (ApplicationHandler::getInstance()->getApplications() as $application) {
					if ($application->domainName === $_SERVER['HTTP_HOST']) {
						self::$inRescueMode = false;
						break;
					}
				}
				
				if (self::$inRescueMode) {
					self::$rescueModePageURL = RouteHandler::getProtocol() . $_SERVER['HTTP_HOST'] . RouteHandler::getPath(['acp']);
				}
			}
		}
		
		return self::$inRescueMode;
	}
	
	/**
	 * Returns URL for rescue mode page.
	 * 
	 * @return	string
	 */
	public static function getRescueModePageURL() {
		if (self::inRescueMode()) {
			return self::$rescueModePageURL;
		}
		
		return '';
	}
	
	/**
	 * Does the user authentication.
	 */
	protected function initAuth() {
		// this is a work-around since neither RequestHandler
		// nor RouteHandler are populated right now
		$pathInfo = RouteHandler::getPathInfo();
		
		if (self::inRescueMode()) {
			if (!preg_match('~^/?rescue-mode/~', $pathInfo)) {
				$redirectURI =  self::$rescueModePageURL . 'acp/index.php?rescue-mode/';
				
				HeaderUtil::redirect($redirectURI);
				exit;
			}
		}
		else if (empty($pathInfo) || !preg_match('~^/?(acp-?captcha|login|logout)/~i', $pathInfo)) {
			if (WCF::getUser()->userID == 0) {
				// work-around for AJAX-requests within ACP
				if (isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest') {
					throw new AJAXException(WCF::getLanguage()->getDynamicVariable('wcf.ajax.error.sessionExpired'), AJAXException::SESSION_EXPIRED, '');
				}
				
				// build redirect path
				$application = ApplicationHandler::getInstance()->getActiveApplication();
				if ($application === null) {
					throw new SystemException("You have aborted the installation, therefore this installation is unusable. You are required to reinstall the software.");
				}
				
				HeaderUtil::redirect(
					LinkHandler::getInstance()->getLink('Login', [
						'url' => RouteHandler::getProtocol() . $_SERVER['HTTP_HOST'] . WCF::getSession()->requestURI
					])
				);
				exit;
			}
			else {
				// work-around for AJAX-requests within ACP
				if (isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest') {
					try {
						WCF::getSession()->checkPermissions(['admin.general.canUseAcp']);
					}
					catch (PermissionDeniedException $e) {
						throw new AJAXException(self::getLanguage()->getDynamicVariable('wcf.ajax.error.permissionDenied'), AJAXException::INSUFFICIENT_PERMISSIONS, $e->getTraceAsString());
					}
				}
				else {
					WCF::getSession()->checkPermissions(['admin.general.canUseAcp']);
				}
				
				// force debug mode if in ACP and authenticated
				self::$overrideDebugMode = true;
			}
		}
	}
	
	/**
	 * @inheritDoc
	 */
	protected function initSession() {
		self::$sessionObj = SessionHandler::getInstance();
		self::$sessionObj->setCookieSuffix('_acp');
		
		$factory = new ACPSessionFactory();
		$factory->load();
		
		self::$sessionObj->setHasValidCookie($factory->hasValidCookie());
	}
	
	/**
	 * @inheritDoc
	 */
	protected function initTPL() {
		self::$tplObj = ACPTemplateEngine::getInstance();
		self::getTPL()->setLanguageID(self::getLanguage()->languageID);
		$this->assignDefaultTemplateVariables();
	}
	
	/**
	 * @inheritDoc
	 */
	protected function assignDefaultTemplateVariables() {
		parent::assignDefaultTemplateVariables();
		
		// base tag is determined on runtime
		$host = RouteHandler::getHost();
		$path = RouteHandler::getPath();
		
		// available acp search providers
		$availableAcpSearchProviders = [];
		foreach (ACPSearchProviderCacheBuilder::getInstance()->getData() as $searchProvider) {
			$availableAcpSearchProviders[$searchProvider->providerName] = self::getLanguage()->get('wcf.acp.search.provider.'.$searchProvider->providerName);
		}
		asort($availableAcpSearchProviders);
		
		self::getTPL()->assign([
			'baseHref' => $host . $path,
			'availableAcpSearchProviders' => $availableAcpSearchProviders
		]);
	}
	
	/**
	 * Initializes the active package.
	 */
	protected function initPackage() {
		// define active package id
		if (!defined('PACKAGE_ID')) {
			define('PACKAGE_ID', 1);
		}
	}
	
	/**
	 * Checks whether the active user has entered the valid master password.
	 */
	public static function checkMasterPassword() {
		if (defined('MODULE_MASTER_PASSWORD') && MODULE_MASTER_PASSWORD == 1 && !WCF::getSession()->getVar('masterPassword')) {
			if (file_exists(WCF_DIR.'acp/masterPassword.inc.php')) {
				require_once(WCF_DIR.'acp/masterPassword.inc.php');
			}
			if (defined('MASTER_PASSWORD')) {
				$form = new MasterPasswordForm();
				$form->__run();
				exit;
			}
			else {
				$form = new MasterPasswordInitForm();
				$form->__run();
				exit;
			}
		}
	}
}