Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
883 lines (769 sloc) 24.516 kB
<?php
namespace wcf\system;
use wcf\data\application\Application;
use wcf\data\option\OptionEditor;
use wcf\data\package\Package;
use wcf\data\package\PackageCache;
use wcf\data\package\PackageEditor;
use wcf\system\application\ApplicationHandler;
use wcf\system\cache\builder\CoreObjectCacheBuilder;
use wcf\system\cache\builder\PackageUpdateCacheBuilder;
use wcf\system\cronjob\CronjobScheduler;
use wcf\system\event\EventHandler;
use wcf\system\exception\AJAXException;
use wcf\system\exception\IPrintableException;
use wcf\system\exception\NamedUserException;
use wcf\system\exception\PermissionDeniedException;
use wcf\system\exception\SystemException;
use wcf\system\language\LanguageFactory;
use wcf\system\package\PackageInstallationDispatcher;
use wcf\system\request\RouteHandler;
use wcf\system\session\SessionFactory;
use wcf\system\session\SessionHandler;
use wcf\system\style\StyleHandler;
use wcf\system\template\TemplateEngine;
use wcf\system\user\storage\UserStorageHandler;
use wcf\util\ArrayUtil;
use wcf\util\ClassUtil;
use wcf\util\FileUtil;
use wcf\util\StringUtil;
use wcf\util\UserUtil;
// try to set a time-limit to infinite
@set_time_limit(0);
// fix timezone warning issue
if (!@ini_get('date.timezone')) {
@date_default_timezone_set('Europe/London');
}
// define current wcf version
define('WCF_VERSION', '2.1.7 pl 1 (Typhoon)');
// define current unix timestamp
define('TIME_NOW', time());
// wcf imports
if (!defined('NO_IMPORTS')) {
require_once(WCF_DIR.'lib/core.functions.php');
}
/**
* WCF is the central class for the community framework.
* It holds the database connection, access to template and language engine.
*
* @author Marcel Werk
* @copyright 2001-2015 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
* @package com.woltlab.wcf
* @subpackage system
* @category Community Framework
*/
class WCF {
/**
* list of currently loaded applications
* @var array<\wcf\data\application\Application>
*/
protected static $applications = array();
/**
* list of currently loaded application objects
* @var array<\wcf\system\application\IApplication>
*/
protected static $applicationObjects = array();
/**
* list of autoload directories
* @var array
*/
protected static $autoloadDirectories = array();
/**
* list of unique instances of each core object
* @var array<\wcf\system\SingletonFactory>
*/
protected static $coreObject = array();
/**
* list of cached core objects
* @var array<array>
*/
protected static $coreObjectCache = array();
/**
* database object
* @var \wcf\system\database\Database
*/
protected static $dbObj = null;
/**
* language object
* @var \wcf\data\language\Language
*/
protected static $languageObj = null;
/**
* overrides disabled debug mode
* @var boolean
*/
protected static $overrideDebugMode = false;
/**
* session object
* @var \wcf\system\session\SessionHandler
*/
protected static $sessionObj = null;
/**
* template object
* @var \wcf\system\template\TemplateEngine
*/
protected static $tplObj = null;
/**
* true if Zend Opcache is loaded and enabled
* @var boolean
*/
protected static $zendOpcacheEnabled = null;
/**
* Calls all init functions of the WCF 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->initMagicQuotes();
$this->initDB();
$this->loadOptions();
$this->initSession();
$this->initLanguage();
$this->initTPL();
$this->initCronjobs();
$this->initCoreObjects();
$this->initApplications();
$this->initBlacklist();
EventHandler::getInstance()->fireAction($this, 'initialized');
}
/**
* Replacement of the "__destruct()" method.
* Seems that under specific conditions (windows) the destructor is not called automatically.
* So we use the php register_shutdown_function to register an own destructor method.
* Flushs the output, closes caches and updates the session.
*/
public static function destruct() {
try {
// database has to be initialized
if (!is_object(self::$dbObj)) return;
// flush output
if (ob_get_level() && ini_get('output_handler')) {
ob_flush();
}
else {
flush();
}
// update session
if (is_object(self::getSession())) {
self::getSession()->update();
}
// execute shutdown actions of user storage handler
UserStorageHandler::getInstance()->shutdown();
}
catch (\Exception $exception) {
die("<pre>WCF::destruct() Unhandled exception: ".$exception->getMessage()."\n\n".$exception->getTraceAsString());
}
}
/**
* Removes slashes in superglobal gpc data arrays if 'magic quotes gpc' is enabled.
*/
protected function initMagicQuotes() {
if (function_exists('get_magic_quotes_gpc')) {
if (@get_magic_quotes_gpc()) {
if (!empty($_REQUEST)) {
$_REQUEST = ArrayUtil::stripslashes($_REQUEST);
}
if (!empty($_POST)) {
$_POST = ArrayUtil::stripslashes($_POST);
}
if (!empty($_GET)) {
$_GET = ArrayUtil::stripslashes($_GET);
}
if (!empty($_COOKIE)) {
$_COOKIE = ArrayUtil::stripslashes($_COOKIE);
}
if (!empty($_FILES)) {
foreach ($_FILES as $name => $attributes) {
foreach ($attributes as $key => $value) {
if ($key != 'tmp_name') {
$_FILES[$name][$key] = ArrayUtil::stripslashes($value);
}
}
}
}
}
}
if (function_exists('set_magic_quotes_runtime')) {
@set_magic_quotes_runtime(0);
}
}
/**
* Returns the database object.
*
* @return \wcf\system\database\Database
*/
public static final function getDB() {
return self::$dbObj;
}
/**
* Returns the session object.
*
* @return \wcf\system\session\SessionHandler
*/
public static final function getSession() {
return self::$sessionObj;
}
/**
* Returns the user object.
*
* @return \wcf\data\user\User
*/
public static final function getUser() {
return self::getSession()->getUser();
}
/**
* Returns the language object.
*
* @return \wcf\data\language\Language
*/
public static final function getLanguage() {
return self::$languageObj;
}
/**
* Returns the template object.
*
* @return \wcf\system\template\TemplateEngine
*/
public static final function getTPL() {
return self::$tplObj;
}
/**
* Calls the show method on the given exception.
*
* @param \Exception $e
*/
public static final function handleException($e) {
try {
if (!($e instanceof \Exception)) throw $e;
if ($e instanceof IPrintableException) {
$e->show();
exit;
}
// repack Exception
self::handleException(new SystemException($e->getMessage(), $e->getCode(), '', $e));
}
catch (\Throwable $exception) {
die("<pre>WCF::handleException() Unhandled exception: ".$exception->getMessage()."\n\n".$exception->getTraceAsString());
}
catch (\Exception $exception) {
die("<pre>WCF::handleException() Unhandled exception: ".$exception->getMessage()."\n\n".$exception->getTraceAsString());
}
}
/**
* Catches php errors and throws instead a system exception.
*
* @param integer $errorNo
* @param string $message
* @param string $filename
* @param integer $lineNo
*/
public static final function handleError($errorNo, $message, $filename, $lineNo) {
if (error_reporting() != 0) {
$type = 'error';
switch ($errorNo) {
case 2: $type = 'warning';
break;
case 8: $type = 'notice';
break;
}
throw new SystemException('PHP '.$type.' in file '.$filename.' ('.$lineNo.'): '.$message, 0);
}
}
/**
* Loads the database configuration and creates a new connection to the database.
*/
protected function initDB() {
// get configuration
$dbHost = $dbUser = $dbPassword = $dbName = '';
$dbPort = 0;
$dbClass = 'wcf\system\database\MySQLDatabase';
require(WCF_DIR.'config.inc.php');
// create database connection
self::$dbObj = new $dbClass($dbHost, $dbUser, $dbPassword, $dbName, $dbPort);
}
/**
* Loads the options file, automatically created if not exists.
*/
protected function loadOptions() {
$filename = WCF_DIR.'options.inc.php';
// create options file if doesn't exist
if (!file_exists($filename) || filemtime($filename) <= 1) {
OptionEditor::rebuild();
}
require_once($filename);
}
/**
* Starts the session system.
*/
protected function initSession() {
$factory = new SessionFactory();
$factory->load();
self::$sessionObj = SessionHandler::getInstance();
}
/**
* Initialises the language engine.
*/
protected function initLanguage() {
if (isset($_GET['l']) && !self::getUser()->userID) {
self::getSession()->setLanguageID(intval($_GET['l']));
}
// set mb settings
mb_internal_encoding('UTF-8');
if (function_exists('mb_regex_encoding')) mb_regex_encoding('UTF-8');
mb_language('uni');
// get language
self::$languageObj = LanguageFactory::getInstance()->getUserLanguage(self::getSession()->getLanguageID());
}
/**
* Initialises the template engine.
*/
protected function initTPL() {
self::$tplObj = TemplateEngine::getInstance();
self::getTPL()->setLanguageID(self::getLanguage()->languageID);
$this->assignDefaultTemplateVariables();
$this->initStyle();
}
/**
* Initializes the user's style.
*/
protected function initStyle() {
if (isset($_REQUEST['styleID'])) {
self::getSession()->setStyleID(intval($_REQUEST['styleID']));
}
StyleHandler::getInstance()->changeStyle(self::getSession()->getStyleID());
}
/**
* Executes the blacklist.
*/
protected function initBlacklist() {
$isAjax = isset($_SERVER['HTTP_X_REQUESTED_WITH']) && ($_SERVER['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest');
if (defined('BLACKLIST_IP_ADDRESSES') && BLACKLIST_IP_ADDRESSES != '') {
if (!StringUtil::executeWordFilter(UserUtil::convertIPv6To4(self::getSession()->ipAddress), BLACKLIST_IP_ADDRESSES)) {
if ($isAjax) {
throw new AJAXException(self::getLanguage()->get('wcf.ajax.error.permissionDenied'), AJAXException::INSUFFICIENT_PERMISSIONS);
}
else {
throw new PermissionDeniedException();
}
}
else if (!StringUtil::executeWordFilter(self::getSession()->ipAddress, BLACKLIST_IP_ADDRESSES)) {
if ($isAjax) {
throw new AJAXException(self::getLanguage()->get('wcf.ajax.error.permissionDenied'), AJAXException::INSUFFICIENT_PERMISSIONS);
}
else {
throw new PermissionDeniedException();
}
}
}
if (defined('BLACKLIST_USER_AGENTS') && BLACKLIST_USER_AGENTS != '') {
if (!StringUtil::executeWordFilter(self::getSession()->userAgent, BLACKLIST_USER_AGENTS)) {
if ($isAjax) {
throw new AJAXException(self::getLanguage()->get('wcf.ajax.error.permissionDenied'), AJAXException::INSUFFICIENT_PERMISSIONS);
}
else {
throw new PermissionDeniedException();
}
}
}
if (defined('BLACKLIST_HOSTNAMES') && BLACKLIST_HOSTNAMES != '') {
if (!StringUtil::executeWordFilter(@gethostbyaddr(self::getSession()->ipAddress), BLACKLIST_HOSTNAMES)) {
if ($isAjax) {
throw new AJAXException(self::getLanguage()->get('wcf.ajax.error.permissionDenied'), AJAXException::INSUFFICIENT_PERMISSIONS);
}
else {
throw new PermissionDeniedException();
}
}
}
// handle banned users
if (self::getUser()->userID && self::getUser()->banned) {
if ($isAjax) {
throw new AJAXException(self::getLanguage()->getDynamicVariable('wcf.user.error.isBanned'), AJAXException::INSUFFICIENT_PERMISSIONS);
}
else {
throw new NamedUserException(self::getLanguage()->getDynamicVariable('wcf.user.error.isBanned'));
}
}
}
/**
* Initializes applications.
*/
protected function initApplications() {
// step 1) load all applications
$loadedApplications = array();
// register WCF as application
self::$applications['wcf'] = ApplicationHandler::getInstance()->getWCF();
if (PACKAGE_ID == 1) {
return;
}
// start main application
$application = ApplicationHandler::getInstance()->getActiveApplication();
$loadedApplications[] = $this->loadApplication($application);
// register primary application
$abbreviation = ApplicationHandler::getInstance()->getAbbreviation($application->packageID);
self::$applications[$abbreviation] = $application;
// start dependent applications
$applications = ApplicationHandler::getInstance()->getDependentApplications();
foreach ($applications as $application) {
$loadedApplications[] = $this->loadApplication($application, true);
}
// step 2) run each application
if (!class_exists('wcf\system\WCFACP', false)) {
foreach ($loadedApplications as $application) {
$application->__run();
}
// refresh the session 1 minute before it expires
self::getTPL()->assign('__sessionKeepAlive', (SESSION_TIMEOUT - 60));
}
}
/**
* Loads an application.
*
* @param \wcf\data\application\Application $application
* @param boolean $isDependentApplication
* @return \wcf\system\application\IApplication
*/
protected function loadApplication(Application $application, $isDependentApplication = false) {
$applicationObject = null;
$package = PackageCache::getInstance()->getPackage($application->packageID);
// package cache might be outdated
if ($package === null) {
$package = new Package($application->packageID);
// package cache is outdated, discard cache
if ($package->packageID) {
PackageEditor::resetCache();
}
else {
// package id is invalid
throw new SystemException("application identified by package id '".$application->packageID."' is unknown");
}
}
$abbreviation = ApplicationHandler::getInstance()->getAbbreviation($application->packageID);
$packageDir = FileUtil::getRealPath(WCF_DIR.$package->packageDir);
self::$autoloadDirectories[$abbreviation] = $packageDir . 'lib/';
$className = $abbreviation.'\system\\'.strtoupper($abbreviation).'Core';
if (class_exists($className) && ClassUtil::isInstanceOf($className, 'wcf\system\application\IApplication')) {
// include config file
$configPath = $packageDir . PackageInstallationDispatcher::CONFIG_FILE;
if (file_exists($configPath)) {
require_once($configPath);
}
else {
throw new SystemException('Unable to load configuration for '.$package->package);
}
// register template path if not within ACP
if (!class_exists('wcf\system\WCFACP', false)) {
// add template path and abbreviation
$this->getTPL()->addApplication($abbreviation, $packageDir . 'templates/');
}
// init application and assign it as template variable
self::$applicationObjects[$application->packageID] = call_user_func(array($className, 'getInstance'));
$this->getTPL()->assign('__'.$abbreviation, self::$applicationObjects[$application->packageID]);
}
else {
unset(self::$autoloadDirectories[$abbreviation]);
throw new SystemException("Unable to run '".$package->package."', '".$className."' is missing or does not implement 'wcf\system\application\IApplication'.");
}
// register template path in ACP
if (class_exists('wcf\system\WCFACP', false)) {
$this->getTPL()->addApplication($abbreviation, $packageDir . 'acp/templates/');
}
else if (!$isDependentApplication) {
// assign base tag
$this->getTPL()->assign('baseHref', $application->getPageURL());
}
// register application
self::$applications[$abbreviation] = $application;
return self::$applicationObjects[$application->packageID];
}
/**
* Returns the corresponding application object. Does not support the 'wcf' pseudo application.
*
* @param \wcf\data\application\Application $application
* @return \wcf\system\application\IApplication
*/
public static function getApplicationObject(Application $application) {
if (isset(self::$applicationObjects[$application->packageID])) {
return self::$applicationObjects[$application->packageID];
}
return null;
}
/**
* Loads an application on runtime, do not use this outside the package installation.
*
* @param integer $packageID
*/
public static function loadRuntimeApplication($packageID) {
$package = new Package($packageID);
$application = new Application($packageID);
$abbreviation = Package::getAbbreviation($package->package);
$packageDir = FileUtil::getRealPath(WCF_DIR.$package->packageDir);
self::$autoloadDirectories[$abbreviation] = $packageDir . 'lib/';
self::$applications[$abbreviation] = $application;
self::getTPL()->addApplication($abbreviation, $packageDir . 'acp/templates/');
}
/**
* Initializes core object cache.
*/
protected function initCoreObjects() {
// ignore core objects if installing WCF
if (PACKAGE_ID == 0) {
return;
}
self::$coreObjectCache = CoreObjectCacheBuilder::getInstance()->getData();
}
/**
* Assigns some default variables to the template engine.
*/
protected function assignDefaultTemplateVariables() {
self::getTPL()->registerPrefilter(array('event', 'hascontent', 'lang'));
self::getTPL()->assign(array(
'__wcf' => $this,
'__wcfVersion' => LAST_UPDATE_TIME // @deprecated since 2.1, use LAST_UPDATE_TIME directly
));
}
/**
* Wrapper for the getter methods of this class.
*
* @param string $name
* @return mixed value
*/
public function __get($name) {
$method = 'get'.ucfirst($name);
if (method_exists($this, $method)) {
return $this->$method();
}
throw new SystemException("method '".$method."' does not exist in class WCF");
}
/**
* Changes the active language.
*
* @param integer $languageID
*/
public static final function setLanguage($languageID) {
self::$languageObj = LanguageFactory::getInstance()->getLanguage($languageID);
self::getTPL()->setLanguageID(self::getLanguage()->languageID);
}
/**
* Includes the required util or exception classes automatically.
*
* @param string $className
* @see spl_autoload_register()
*/
public static final function autoload($className) {
$namespaces = explode('\\', $className);
if (count($namespaces) > 1) {
$applicationPrefix = array_shift($namespaces);
if ($applicationPrefix === '') {
$applicationPrefix = array_shift($namespaces);
}
if (isset(self::$autoloadDirectories[$applicationPrefix])) {
$classPath = self::$autoloadDirectories[$applicationPrefix] . implode('/', $namespaces) . '.class.php';
if (file_exists($classPath)) {
require_once($classPath);
}
}
}
}
/**
* @see \wcf\system\WCF::__callStatic()
*/
public final function __call($name, array $arguments) {
// bug fix to avoid php crash, see http://bugs.php.net/bug.php?id=55020
if (!method_exists($this, $name)) {
return self::__callStatic($name, $arguments);
}
return $this->$name($arguments);
}
/**
* Returns dynamically loaded core objects.
*
* @param string $name
* @param array $arguments
*/
public static final function __callStatic($name, array $arguments) {
$className = preg_replace('~^get~', '', $name);
if (isset(self::$coreObject[$className])) {
return self::$coreObject[$className];
}
$objectName = self::getCoreObject($className);
if ($objectName === null) {
throw new SystemException("Core object '".$className."' is unknown.");
}
if (class_exists($objectName)) {
if (!(ClassUtil::isInstanceOf($objectName, 'wcf\system\SingletonFactory'))) {
throw new SystemException("class '".$objectName."' does not implement the interface 'SingletonFactory'");
}
self::$coreObject[$className] = call_user_func(array($objectName, 'getInstance'));
return self::$coreObject[$className];
}
}
/**
* Searches for cached core object definition.
*
* @param string $className
* @return string
*/
protected static final function getCoreObject($className) {
if (isset(self::$coreObjectCache[$className])) {
return self::$coreObjectCache[$className];
}
return null;
}
/**
* Returns true if the debug mode is enabled, otherwise false.
*
* @param boolean $ignoreACP
* @return boolean
*/
public static function debugModeIsEnabled($ignoreACP = false) {
// ACP override
if (!$ignoreACP && self::$overrideDebugMode) {
return true;
}
else if (defined('ENABLE_DEBUG_MODE') && ENABLE_DEBUG_MODE) {
return true;
}
return false;
}
/**
* Returns true if benchmarking is enabled, otherwise false.
*
* @return boolean
*/
public static function benchmarkIsEnabled() {
// benchmarking is enabled by default
if (!defined('ENABLE_BENCHMARK') || ENABLE_BENCHMARK) return true;
return false;
}
/**
* Returns domain path for given application.
*
* @param string $abbreviation
* @return string
*/
public static function getPath($abbreviation = 'wcf') {
// workaround during WCFSetup
if (!PACKAGE_ID) {
return '../';
}
if (!isset(self::$applications[$abbreviation])) {
$abbreviation = 'wcf';
}
return self::$applications[$abbreviation]->getPageURL();
}
/**
* Returns a fully qualified anchor for current page.
*
* @param string $fragment
* @return string
*/
public function getAnchor($fragment) {
return self::getRequestURI() . '#' . $fragment;
}
/**
* Returns the URI of the current page.
*
* @return string
*/
public static function getRequestURI() {
if (URL_LEGACY_MODE) {
// resolve path and query components
$scriptName = $_SERVER['SCRIPT_NAME'];
$pathInfo = RouteHandler::getPathInfo();
if (empty($pathInfo)) {
// bug fix if URL omits script name and path
$scriptName = substr($scriptName, 0, strrpos($scriptName, '/'));
}
$path = str_replace('/index.php', '', str_replace($scriptName, '', $_SERVER['REQUEST_URI']));
if (!StringUtil::isUTF8($path)) {
$path = StringUtil::convertEncoding('ISO-8859-1', 'UTF-8', $path);
}
$path = FileUtil::removeLeadingSlash($path);
$baseHref = self::getTPL()->get('baseHref');
if (!empty($path) && mb_strpos($path, '?') !== 0) {
$baseHref .= 'index.php/';
}
return $baseHref . $path;
}
else {
$url = preg_replace('~^(https?://[^/]+)(?:/.*)?$~', '$1', self::getTPL()->get('baseHref'));
$url .= $_SERVER['REQUEST_URI'];
return $url;
}
}
/**
* Resets Zend Opcache cache if installed and enabled.
*
* @param string $script
*/
public static function resetZendOpcache($script = '') {
if (self::$zendOpcacheEnabled === null) {
self::$zendOpcacheEnabled = false;
if (extension_loaded('Zend Opcache') && @ini_get('opcache.enable')) {
self::$zendOpcacheEnabled = true;
}
}
if (self::$zendOpcacheEnabled) {
if (empty($script)) {
opcache_reset();
}
else {
opcache_invalidate($script, true);
}
}
}
/**
* Returns style handler.
*
* @return \wcf\system\style\StyleHandler
*/
public function getStyleHandler() {
return StyleHandler::getInstance();
}
/**
* Returns number of available updates.
*
* @return integer
*/
public function getAvailableUpdates() {
$data = PackageUpdateCacheBuilder::getInstance()->getData();
return $data['updates'];
}
/**
* Returns a 8 character prefix for editor autosave.
*
* @return string
*/
public function getAutosavePrefix() {
return substr(sha1(preg_replace('~^https~', 'http', self::getPath())), 0, 8);
}
/**
* Returns the favicon URL or a base64 encoded image.
*
* @return string
*/
public function getFavicon() {
$activeApplication = ApplicationHandler::getInstance()->getActiveApplication();
$primaryApplication = ApplicationHandler::getInstance()->getPrimaryApplication();
if ($activeApplication->domainName != $primaryApplication->domainName) {
if (file_exists(WCF_DIR.'images/favicon.ico')) {
$favicon = file_get_contents(WCF_DIR.'images/favicon.ico');
return 'data:image/x-icon;base64,' . base64_encode($favicon);
}
}
return self::getPath() . 'images/favicon.ico';
}
/**
* Initialises the cronjobs.
*/
protected function initCronjobs() {
if (PACKAGE_ID) {
self::getTPL()->assign('executeCronjobs', (CronjobScheduler::getInstance()->getNextExec() < TIME_NOW && defined('OFFLINE') && !OFFLINE));
}
}
}
Jump to Line
Something went wrong with that request. Please try again.