X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FApp.php;h=0015405c46bea5892cc634282f50c6c87d62d3f8;hb=c9a6063a2a6bcf1af3c063c9ccf789a27b548e1f;hp=445101309384a2f651b46fd69f78b507835538a4;hpb=09c94dba86db9120026415ff3226ad939459e07b;p=friendica.git diff --git a/src/App.php b/src/App.php index 4451013093..0015405c46 100644 --- a/src/App.php +++ b/src/App.php @@ -10,9 +10,7 @@ use DOMXPath; use Exception; use Friendica\Database\DBA; use Friendica\Network\HTTPException\InternalServerErrorException; - -require_once 'boot.php'; -require_once 'include/text.php'; +use Psr\Log\LoggerInterface; /** * @@ -104,6 +102,16 @@ class App */ private $isAjax; + /** + * @var MobileDetect + */ + public $mobileDetect; + + /** + * @var LoggerInterface The current logger of this App + */ + private $logger; + /** * Register a stylesheet file path to be included in the tag of every page. * Inclusion is done in App->initHead(). @@ -112,6 +120,7 @@ class App * @see initHead() * * @param string $path + * @throws InternalServerErrorException */ public function registerStylesheet($path) { @@ -128,6 +137,7 @@ class App * @see initFooter() * * @param string $path + * @throws InternalServerErrorException */ public function registerFooterScript($path) { @@ -144,13 +154,16 @@ class App /** * @brief App constructor. * - * @param string $basePath Path to the app base folder - * @param bool $isBackend Whether it is used for backend or frontend (Default true=backend) + * @param string $basePath Path to the app base folder + * @param LoggerInterface $logger Logger of this application + * @param bool $isBackend Whether it is used for backend or frontend (Default true=backend) * * @throws Exception if the Basepath is not usable */ - public function __construct($basePath, $isBackend = true) + public function __construct($basePath, LoggerInterface $logger, $isBackend = true) { + $this->logger = $logger; + if (!static::isDirectoryUsable($basePath, false)) { throw new Exception('Basepath ' . $basePath . ' isn\'t usable.'); } @@ -214,7 +227,7 @@ class App set_include_path( get_include_path() . PATH_SEPARATOR . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR - . $this->getBasePath(). DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR + . $this->getBasePath() . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR . $this->getBasePath()); if (!empty($_SERVER['QUERY_STRING']) && strpos($_SERVER['QUERY_STRING'], 'pagename=') === 0) { @@ -271,6 +284,9 @@ class App // Detect mobile devices $mobile_detect = new MobileDetect(); + + $this->mobileDetect = $mobile_detect; + $this->is_mobile = $mobile_detect->isMobile(); $this->is_tablet = $mobile_detect->isTablet(); @@ -296,6 +312,21 @@ class App return $this->mode; } + /** + * Returns the Logger of the Application + * + * @return LoggerInterface The Logger + * @throws InternalServerErrorException when the logger isn't created + */ + public function getLogger() + { + if (empty($this->logger)) { + throw new InternalServerErrorException('Logger of the Application is not defined'); + } + + return $this->logger; + } + /** * Reloads the whole app instance */ @@ -323,30 +354,32 @@ class App Core\L10n::init(); $this->process_id = Core\System::processID('log'); + + Core\Logger::setLogger($this->logger); } /** * Load the configuration files * * First loads the default value for all the configuration keys, then the legacy configuration files, then the - * expected local.ini.php + * expected local.config.php */ private function loadConfigFiles() { - $this->loadConfigFile($this->getBasePath() . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'config.ini.php'); - $this->loadConfigFile($this->getBasePath() . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'settings.ini.php'); + $this->loadConfigFile($this->getBasePath() . '/config/defaults.config.php'); + $this->loadConfigFile($this->getBasePath() . '/config/settings.config.php'); // Legacy .htconfig.php support - if (file_exists($this->getBasePath() . DIRECTORY_SEPARATOR . '.htpreconfig.php')) { + if (file_exists($this->getBasePath() . '/.htpreconfig.php')) { $a = $this; - include $this->getBasePath() . DIRECTORY_SEPARATOR . '.htpreconfig.php'; + include $this->getBasePath() . '/.htpreconfig.php'; } // Legacy .htconfig.php support - if (file_exists($this->getBasePath() . DIRECTORY_SEPARATOR . '.htconfig.php')) { + if (file_exists($this->getBasePath() . '/.htconfig.php')) { $a = $this; - include $this->getBasePath() . DIRECTORY_SEPARATOR . '.htconfig.php'; + include $this->getBasePath() . '/.htconfig.php'; $this->setConfigValue('database', 'hostname', $db_host); $this->setConfigValue('database', 'username', $db_user); @@ -374,33 +407,26 @@ class App } } - if (file_exists($this->getBasePath() . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php')) { - $this->loadConfigFile($this->getBasePath() . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php', true); + if (file_exists($this->getBasePath() . '/config/local.config.php')) { + $this->loadConfigFile($this->getBasePath() . '/config/local.config.php', true); + } elseif (file_exists($this->getBasePath() . '/config/local.ini.php')) { + $this->loadINIConfigFile($this->getBasePath() . '/config/local.ini.php', true); } } /** - * Tries to load the specified configuration file into the App->config array. + * Tries to load the specified legacy configuration file into the App->config array. * Doesn't overwrite previously set values by default to prevent default config files to supersede DB Config. * - * The config format is INI and the template for configuration files is the following: - * - * $values) { - foreach ($values as $key => $value) { - if ($overwrite) { - $this->setConfigValue($category, $key, $value); - } else { - $this->setDefaultConfigValue($category, $key, $value); - } - } + $this->loadConfigArray($config, $overwrite); + } + + /** + * Tries to load the specified configuration file into the App->config array. + * Doesn't overwrite previously set values by default to prevent default config files to supersede DB Config. + * + * The config format is PHP array and the template for configuration files is the following: + * + * [ + * 'key' => 'value', + * ], + * ]; + * + * @param string $filepath + * @param bool $overwrite Force value overwrite if the config key already exists + * @throws Exception + */ + public function loadConfigFile($filepath, $overwrite = false) + { + if (!file_exists($filepath)) { + throw new Exception('Error loading non-existent config file ' . $filepath); } + + $config = include($filepath); + + if (!is_array($config)) { + throw new Exception('Error loading config file ' . $filepath); + } + + $this->loadConfigArray($config, $overwrite); } /** * Loads addons configuration files * - * First loads all activated addons default configuration throught the load_config hook, then load the local.ini.php + * First loads all activated addons default configuration through the load_config hook, then load the local.config.php * again to overwrite potential local addon configuration. */ private function loadAddonConfig() { // Loads addons default config - Core\Addon::callHooks('load_config'); + Core\Hook::callAll('load_config'); // Load the local addon config file to overwritten default addon config values - if (file_exists($this->getBasePath() . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'addon.ini.php')) { - $this->loadConfigFile($this->getBasePath() . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'addon.ini.php', true); + if (file_exists($this->getBasePath() . '/config/addon.config.php')) { + $this->loadConfigFile($this->getBasePath() . '/config/addon.config.php', true); + } elseif (file_exists($this->getBasePath() . '/config/addon.ini.php')) { + $this->loadINIConfigFile($this->getBasePath() . '/config/addon.ini.php', true); + } + } + + /** + * Tries to load the specified configuration array into the App->config array. + * Doesn't overwrite previously set values by default to prevent default config files to supersede DB Config. + * + * @param array $config + * @param bool $overwrite Force value overwrite if the config key already exists + */ + private function loadConfigArray(array $config, $overwrite = false) + { + foreach ($config as $category => $values) { + foreach ($values as $key => $value) { + if ($overwrite) { + $this->setConfigValue($category, $key, $value); + } else { + $this->setDefaultConfigValue($category, $key, $value); + } + } } } @@ -485,7 +556,7 @@ class App if (!empty($relative_script_path)) { // Module if (!empty($_SERVER['QUERY_STRING'])) { - $path = trim(dirname($relative_script_path, substr_count(trim($_SERVER['QUERY_STRING'], '/'), '/') + 1), '/'); + $path = trim(rdirname($relative_script_path, substr_count(trim($_SERVER['QUERY_STRING'], '/'), '/') + 1), '/'); } else { // Root page $path = trim($relative_script_path, '/'); @@ -511,7 +582,7 @@ class App // Use environment variables for mysql if they are set beforehand if (!empty(getenv('MYSQL_HOST')) - && (!empty(getenv('MYSQL_USERNAME')) || !empty(getenv('MYSQL_USER'))) + && !empty(getenv('MYSQL_USERNAME') || !empty(getenv('MYSQL_USER'))) && getenv('MYSQL_PASSWORD') !== false && !empty(getenv('MYSQL_DATABASE'))) { @@ -547,6 +618,7 @@ class App * finally for PWD * * @return string + * @throws InternalServerErrorException */ public function getBasePath() { @@ -606,6 +678,7 @@ class App * * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN * @return string Friendica server base URL + * @throws InternalServerErrorException */ public function getBaseURL($ssl = false) { @@ -630,7 +703,7 @@ class App $this->hostname = Core\Config::get('config', 'hostname'); } - return $scheme . '://' . $this->hostname . (!empty($this->getURLPath()) ? '/' . $this->getURLPath() : '' ); + return $scheme . '://' . $this->hostname . !empty($this->getURLPath() ? '/' . $this->getURLPath() : '' ); } /** @@ -639,6 +712,7 @@ class App * Clears the baseurl cache to prevent inconsistencies * * @param string $url + * @throws InternalServerErrorException */ public function setBaseURL($url) { @@ -661,8 +735,8 @@ class App $this->urlPath = trim($parsed['path'], '\\/'); } - if (file_exists($this->getBasePath() . DIRECTORY_SEPARATOR . '.htpreconfig.php')) { - include $this->getBasePath() . DIRECTORY_SEPARATOR . '.htpreconfig.php'; + if (file_exists($this->getBasePath() . '/.htpreconfig.php')) { + include $this->getBasePath() . '/.htpreconfig.php'; } if (Core\Config::get('config', 'hostname') != '') { @@ -738,7 +812,7 @@ class App $touch_icon = 'images/friendica-128.png'; } - Core\Addon::callHooks('head', $this->page['htmlhead']); + Core\Hook::callAll('head', $this->page['htmlhead']); $tpl = Core\Renderer::getMarkupTemplate('head.tpl'); /* put the head template at the beginning of page['htmlhead'] @@ -797,7 +871,7 @@ class App ]); } - Core\Addon::callHooks('footer', $this->page['footer']); + Core\Hook::callAll('footer', $this->page['footer']); $tpl = Core\Renderer::getMarkupTemplate('footer.tpl'); $this->page['footer'] = Core\Renderer::replaceMacros($tpl, [ @@ -812,6 +886,7 @@ class App * @param string $origURL * * @return string The cleaned url + * @throws InternalServerErrorException */ public function removeBaseURL($origURL) { @@ -865,6 +940,7 @@ class App * Returns the current UserAgent as a String * * @return string the UserAgent as a String + * @throws InternalServerErrorException */ public function getUserAgent() { @@ -988,6 +1064,7 @@ class App * @brief Checks if the minimal memory is reached * * @return bool Is the memory limit reached? + * @throws InternalServerErrorException */ public function isMinMemoryReached() { @@ -1013,11 +1090,11 @@ class App $meminfo[$key] = (int) ($meminfo[$key] / 1024); } - if (!isset($meminfo['MemAvailable']) || !isset($meminfo['MemFree'])) { + if (!isset($meminfo['MemFree'])) { return false; } - $free = $meminfo['MemAvailable'] + $meminfo['MemFree']; + $free = $meminfo['MemFree']; $reached = ($free < $min_memory); @@ -1032,6 +1109,7 @@ class App * @brief Checks if the maximum load is reached * * @return bool Is the load reached? + * @throws InternalServerErrorException */ public function isMaxLoadReached() { @@ -1064,6 +1142,7 @@ class App * * @param string $command The command to execute * @param array $args Arguments to pass to the command ( [ 'key' => value, 'key2' => value2, ... ] + * @throws InternalServerErrorException */ public function proc_run($command, $args) { @@ -1120,7 +1199,10 @@ class App /** * @brief Checks if a given directory is usable for the system * + * @param $directory + * @param bool $check_writable * @return boolean the directory is usable + * @throws Exception */ public static function isDirectoryUsable($directory, $check_writable = true) { @@ -1298,6 +1380,7 @@ class App * Generates the site's default sender email address * * @return string + * @throws InternalServerErrorException */ public function getSenderEmailAddress() { @@ -1318,6 +1401,7 @@ class App * Returns the current theme name. * * @return string the name of the current theme + * @throws InternalServerErrorException */ public function getCurrentTheme() { @@ -1325,14 +1409,18 @@ class App return ''; } - //// @TODO Compute the current theme only once (this behavior has - /// already been implemented, but it didn't work well - - /// https://github.com/friendica/friendica/issues/5092) - $this->computeCurrentTheme(); + if (!$this->currentTheme) { + $this->computeCurrentTheme(); + } return $this->currentTheme; } + public function setCurrentTheme($theme) + { + $this->currentTheme = $theme; + } + /** * Computes the current theme name based on the node settings, the user settings and the device type * @@ -1395,6 +1483,7 @@ class App * Provide a sane default if nothing is chosen or the specified theme does not exist. * * @return string + * @throws InternalServerErrorException */ public function getCurrentThemeStylesheetPath() { @@ -1487,7 +1576,7 @@ class App } Core\Session::init(); - Core\Addon::callHooks('init_1'); + Core\Hook::callAll('init_1'); } // Exclude the backend processes from the session management @@ -1671,23 +1760,14 @@ class App } } - // Load current theme info - $theme_info_file = 'view/theme/' . $this->getCurrentTheme() . '/theme.php'; - if (file_exists($theme_info_file)) { - require_once $theme_info_file; - } - - // initialise content region - if ($this->getMode()->isNormal()) { - Core\Addon::callHooks('page_content_top', $this->page['content']); - } + $content = ''; - // Call module functions + // Initialize module that can set the current theme in the init() method, either directly or via App->profile_uid if ($this->module_loaded) { $this->page['page_title'] = $this->module; $placeholder = ''; - Core\Addon::callHooks($this->module . '_mod_init', $placeholder); + Core\Hook::callAll($this->module . '_mod_init', $placeholder); call_user_func([$this->module_class, 'init']); @@ -1696,37 +1776,47 @@ class App if (!$this->error) { call_user_func([$this->module_class, 'rawContent']); } + } - if (function_exists(str_replace('-', '_', $this->getCurrentTheme()) . '_init')) { - $func = str_replace('-', '_', $this->getCurrentTheme()) . '_init'; - $func($this); - } + // Load current theme info after module has been initialized as theme could have been set in module + $theme_info_file = 'view/theme/' . $this->getCurrentTheme() . '/theme.php'; + if (file_exists($theme_info_file)) { + require_once $theme_info_file; + } + if (function_exists(str_replace('-', '_', $this->getCurrentTheme()) . '_init')) { + $func = str_replace('-', '_', $this->getCurrentTheme()) . '_init'; + $func($this); + } + + if ($this->module_loaded) { if (! $this->error && $_SERVER['REQUEST_METHOD'] === 'POST') { - Core\Addon::callHooks($this->module . '_mod_post', $_POST); + Core\Hook::callAll($this->module . '_mod_post', $_POST); call_user_func([$this->module_class, 'post']); } if (! $this->error) { - Core\Addon::callHooks($this->module . '_mod_afterpost', $placeholder); + Core\Hook::callAll($this->module . '_mod_afterpost', $placeholder); call_user_func([$this->module_class, 'afterpost']); } if (! $this->error) { - $arr = ['content' => $this->page['content']]; - Core\Addon::callHooks($this->module . '_mod_content', $arr); - $this->page['content'] = $arr['content']; + $arr = ['content' => $content]; + Core\Hook::callAll($this->module . '_mod_content', $arr); + $content = $arr['content']; $arr = ['content' => call_user_func([$this->module_class, 'content'])]; - Core\Addon::callHooks($this->module . '_mod_aftercontent', $arr); - $this->page['content'] .= $arr['content']; + Core\Hook::callAll($this->module . '_mod_aftercontent', $arr); + $content .= $arr['content']; } + } - if (function_exists(str_replace('-', '_', $this->getCurrentTheme()) . '_content_loaded')) { - $func = str_replace('-', '_', $this->getCurrentTheme()) . '_content_loaded'; - $func($this); - } + // initialise content region + if ($this->getMode()->isNormal()) { + Core\Hook::callAll('page_content_top', $this->page['content']); } + $this->page['content'] .= $content; + /* Create the page head after setting the language * and getting any auth credentials. * @@ -1749,7 +1839,7 @@ class App } // Report anything which needs to be communicated in the notification area (before the main body) - Core\Addon::callHooks('page_end', $this->page['content']); + Core\Hook::callAll('page_end', $this->page['content']); // Add the navigation (menu) template if ($this->module != 'install' && $this->module != 'maintenance') { @@ -1779,14 +1869,14 @@ class App // And then append it to the target $target->documentElement->appendChild($item); } - } - if (isset($_GET["mode"]) && ($_GET["mode"] == "raw")) { - header("Content-type: text/html; charset=utf-8"); + if ($_GET["mode"] == "raw") { + header("Content-type: text/html; charset=utf-8"); - echo substr($target->saveHTML(), 6, -8); + echo substr($target->saveHTML(), 6, -8); - exit(); + exit(); + } } $page = $this->page; @@ -1842,7 +1932,7 @@ class App */ public function internalRedirect($toUrl = '', $ssl = false) { - if (filter_var($toUrl, FILTER_VALIDATE_URL)) { + if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) { throw new InternalServerErrorException("'$toUrl is not a relative path, please use System::externalRedirectTo"); } @@ -1855,11 +1945,11 @@ class App * Should only be used if it isn't clear if the URL is either internal or external * * @param string $toUrl The target URL - * + * @throws InternalServerErrorException */ public function redirect($toUrl) { - if (filter_var($toUrl, FILTER_VALIDATE_URL)) { + if (!empty(parse_url($toUrl, PHP_URL_SCHEME))) { Core\System::externalRedirect($toUrl); } else { $this->internalRedirect($toUrl);