use Friendica\Core\PConfig;
use Friendica\Core\System;
use Friendica\Database\DBA;
+use Friendica\Network\HTTPException\InternalServerErrorException;
require_once 'boot.php';
require_once 'include/dba.php';
*/
class App
{
- const MODE_LOCALCONFIGPRESENT = 1;
- const MODE_DBAVAILABLE = 2;
- const MODE_DBCONFIGAVAILABLE = 4;
- const MODE_MAINTENANCEDISABLED = 8;
-
- /**
- * @deprecated since version 2008.08 Use App->isInstallMode() instead to check for install mode.
- */
- const MODE_INSTALL = 0;
-
- /**
- * @deprecated since version 2008.08 Use the precise mode constant to check for a specific capability instead.
- */
- const MODE_NORMAL = App::MODE_LOCALCONFIGPRESENT | App::MODE_DBAVAILABLE | App::MODE_DBCONFIGAVAILABLE | App::MODE_MAINTENANCEDISABLED;
-
public $module_loaded = false;
public $module_class = null;
public $query_string = '';
public $argv;
public $argc;
public $module;
- public $mode = App::MODE_INSTALL;
public $strings;
- public $basepath;
- public $urlpath;
public $hooks = [];
public $timezone;
public $interactive = true;
public $identities;
public $is_mobile = false;
public $is_tablet = false;
- public $is_friendica_app;
public $performance = [];
public $callstack = [];
public $theme_info = [];
- public $backend = true;
public $nav_sel;
public $category;
// Allow themes to control internal parameters
public $force_max_items = 0;
public $theme_events_in_profile = true;
+ public $stylesheets = [];
+ public $footerScripts = [];
+
+ /**
+ * @var App\Mode The Mode of the Application
+ */
+ private $mode;
+
+ /**
+ * @var string The App base path
+ */
+ private $basePath;
+
+ /**
+ * @var string The App URL path
+ */
+ private $urlPath;
+
+ /**
+ * @var bool true, if the call is from the Friendica APP, otherwise false
+ */
+ private $isFriendicaApp;
+
+ /**
+ * @var bool true, if the call is from an backend node (f.e. worker)
+ */
+ private $isBackend;
+
+ /**
+ * @var string The name of the current theme
+ */
+ private $currentTheme;
+
+ /**
+ * @var bool check if request was an AJAX (xmlhttprequest) request
+ */
+ private $isAjax;
+
+ /**
+ * Register a stylesheet file path to be included in the <head> tag of every page.
+ * Inclusion is done in App->initHead().
+ * The path can be absolute or relative to the Friendica installation base folder.
+ *
+ * @see App->initHead()
+ *
+ * @param string $path
+ */
+ public function registerStylesheet($path)
+ {
+ $url = str_replace($this->getBasePath() . DIRECTORY_SEPARATOR, '', $path);
+
+ $this->stylesheets[] = trim($url, '/');
+ }
+
+ /**
+ * Register a javascript file path to be included in the <footer> tag of every page.
+ * Inclusion is done in App->initFooter().
+ * The path can be absolute or relative to the Friendica installation base folder.
+ *
+ * @see App->initFooter()
+ *
+ * @param string $path
+ */
+ public function registerFooterScript($path)
+ {
+ $url = str_replace($this->getBasePath() . DIRECTORY_SEPARATOR, '', $path);
+
+ $this->footerScripts[] = trim($url, '/');
+ }
+
/**
* @brief An array for all theme-controllable parameters
*
];
private $scheme;
private $hostname;
- private $curl_code;
- private $curl_content_type;
- private $curl_headers;
/**
* @brief App constructor.
*
- * @param string $basepath Path to the app base folder
+ * @param string $basePath Path to the app base folder
+ * @param bool $backend true, if the call is from backend, otherwise set to true (Default true)
+ *
+ * @throws Exception if the Basepath is not usable
*/
- public function __construct($basepath)
+ public function __construct($basePath, $backend = true)
{
- if (!static::directory_usable($basepath, false)) {
- throw new Exception('Basepath ' . $basepath . ' isn\'t usable.');
+ if (!static::isDirectoryUsable($basePath, false)) {
+ throw new Exception('Basepath ' . $basePath . ' isn\'t usable.');
}
BaseObject::setApp($this);
- $this->basepath = rtrim($basepath, DIRECTORY_SEPARATOR);
+ $this->basePath = rtrim($basePath, DIRECTORY_SEPARATOR);
+ $this->checkBackend($backend);
+ $this->checkFriendicaApp();
$this->performance['start'] = microtime(true);
$this->performance['database'] = 0;
$this->callstack['rendering'] = [];
$this->callstack['parser'] = [];
- // The order of the following calls is important to ensure proper initialization
- $this->loadConfigFiles();
-
- $this->loadDatabase();
+ $this->mode = new App\Mode($basePath);
- $this->determineMode();
-
- $this->determineUrlPath();
-
- Config::load();
-
- if ($this->mode & self::MODE_DBAVAILABLE) {
- Core\Addon::loadHooks();
-
- $this->loadAddonConfig();
- }
-
- $this->loadDefaultTimezone();
-
- $this->page = [
- 'aside' => '',
- 'bottom' => '',
- 'content' => '',
- 'end' => '',
- 'footer' => '',
- 'htmlhead' => '',
- 'nav' => '',
- 'page_title' => '',
- 'right_aside' => '',
- 'template' => '',
- 'title' => ''
- ];
-
- $this->process_id = System::processID('log');
+ $this->reload();
set_time_limit(0);
set_include_path(
get_include_path() . PATH_SEPARATOR
- . $this->basepath . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
- . $this->basepath . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
- . $this->basepath);
+ . $this->getBasePath() . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
+ . $this->getBasePath(). DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
+ . $this->getBasePath());
if ((x($_SERVER, 'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'], 0, 9) === 'pagename=') {
$this->query_string = substr($_SERVER['QUERY_STRING'], 9);
$this->is_mobile = $mobile_detect->isMobile();
$this->is_tablet = $mobile_detect->isTablet();
- // Friendica-Client
- $this->is_friendica_app = isset($_SERVER['HTTP_USER_AGENT']) && $_SERVER['HTTP_USER_AGENT'] == 'Apache-HttpClient/UNAVAILABLE (java 1.4)';
+ $this->isAjax = strtolower(defaults($_SERVER, 'HTTP_X_REQUESTED_WITH', '')) == 'xmlhttprequest';
// Register template engines
- $this->register_template_engine('Friendica\Render\FriendicaSmartyEngine');
+ $this->registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
+ }
+
+ /**
+ * Returns the Mode of the Application
+ *
+ * @return App\Mode The Application Mode
+ *
+ * @throws InternalServerErrorException when the mode isn't created
+ */
+ public function getMode()
+ {
+ if (empty($this->mode)) {
+ throw new InternalServerErrorException('Mode of the Application is not defined');
+ }
+
+ return $this->mode;
+ }
+
+ /**
+ * Reloads the whole app instance
+ */
+ public function reload()
+ {
+ // The order of the following calls is important to ensure proper initialization
+ $this->loadConfigFiles();
+
+ $this->loadDatabase();
+
+ $this->getMode()->determine($this->getBasePath());
+
+ $this->determineURLPath();
+
+ Config::load();
+
+ if ($this->getMode()->has(App\Mode::DBAVAILABLE)) {
+ Core\Addon::loadHooks();
+
+ $this->loadAddonConfig();
+ }
+
+ $this->loadDefaultTimezone();
+
+ $this->page = [
+ 'aside' => '',
+ 'bottom' => '',
+ 'content' => '',
+ 'footer' => '',
+ 'htmlhead' => '',
+ 'nav' => '',
+ 'page_title' => '',
+ 'right_aside' => '',
+ 'template' => '',
+ 'title' => ''
+ ];
+
+ $this->process_id = System::processID('log');
}
/**
*/
private function loadConfigFiles()
{
- $this->loadConfigFile($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'config.ini.php');
- $this->loadConfigFile($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'settings.ini.php');
+ $this->loadConfigFile($this->getBasePath() . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'config.ini.php');
+ $this->loadConfigFile($this->getBasePath() . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'settings.ini.php');
// Legacy .htconfig.php support
- if (file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php')) {
+ if (file_exists($this->getBasePath() . DIRECTORY_SEPARATOR . '.htpreconfig.php')) {
$a = $this;
- include $this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php';
+ include $this->getBasePath() . DIRECTORY_SEPARATOR . '.htpreconfig.php';
}
// Legacy .htconfig.php support
- if (file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htconfig.php')) {
+ if (file_exists($this->getBasePath() . DIRECTORY_SEPARATOR . '.htconfig.php')) {
$a = $this;
- include $this->basepath . DIRECTORY_SEPARATOR . '.htconfig.php';
+ include $this->getBasePath() . DIRECTORY_SEPARATOR . '.htconfig.php';
$this->setConfigValue('database', 'hostname', $db_host);
$this->setConfigValue('database', 'username', $db_user);
}
}
- if (file_exists($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php')) {
- $this->loadConfigFile($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php');
+ 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);
}
}
/**
* Tries to load the specified configuration file into the App->config array.
- * Overwrites previously set values.
+ * 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:
*
* INI;
* // Keep this line
*
- * @param type $filepath
+ * @param string $filepath
+ * @param bool $overwrite Force value overwrite if the config key already exists
* @throws Exception
*/
- public function loadConfigFile($filepath)
+ public function loadConfigFile($filepath, $overwrite = false)
{
if (!file_exists($filepath)) {
throw new Exception('Error parsing non-existent config file ' . $filepath);
foreach ($config as $category => $values) {
foreach ($values as $key => $value) {
- $this->setConfigValue($category, $key, $value);
+ if ($overwrite) {
+ $this->setConfigValue($category, $key, $value);
+ } else {
+ $this->setDefaultConfigValue($category, $key, $value);
+ }
}
}
}
Core\Addon::callHooks('load_config');
// Load the local addon config file to overwritten default addon config values
- if (file_exists($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'addon.ini.php')) {
- $this->loadConfigFile($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'addon.ini.php');
+ 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);
}
}
/**
* Figure out if we are running at the top of a domain or in a sub-directory and adjust accordingly
*/
- private function determineUrlPath()
+ private function determineURLPath()
{
- $this->urlpath = $this->getConfigValue('system', 'urlpath');
+ /* Relative script path to the web server root
+ * Not all of those $_SERVER properties can be present, so we do by inverse priority order
+ */
+ $relative_script_path = '';
+ $relative_script_path = defaults($_SERVER, 'REDIRECT_URL' , $relative_script_path);
+ $relative_script_path = defaults($_SERVER, 'REDIRECT_URI' , $relative_script_path);
+ $relative_script_path = defaults($_SERVER, 'REDIRECT_SCRIPT_URL', $relative_script_path);
+ $relative_script_path = defaults($_SERVER, 'SCRIPT_URL' , $relative_script_path);
- /* SCRIPT_URL gives /path/to/friendica/module/parameter
+ $this->urlPath = $this->getConfigValue('system', 'urlpath');
+
+ /* $relative_script_path gives /relative/path/to/friendica/module/parameter
* QUERY_STRING gives pagename=module/parameter
*
- * To get /path/to/friendica we perform dirname() for as many levels as there are slashes in the QUERY_STRING
+ * To get /relative/path/to/friendica we perform dirname() for as many levels as there are slashes in the QUERY_STRING
*/
- if (!empty($_SERVER['SCRIPT_URL'])) {
+ if (!empty($relative_script_path)) {
// Module
if (!empty($_SERVER['QUERY_STRING'])) {
- $path = trim(dirname($_SERVER['SCRIPT_URL'], substr_count(trim($_SERVER['QUERY_STRING'], '/'), '/') + 1), '/');
+ $path = trim(dirname($relative_script_path, substr_count(trim($_SERVER['QUERY_STRING'], '/'), '/') + 1), '/');
} else {
// Root page
- $path = trim($_SERVER['SCRIPT_URL'], '/');
+ $path = trim($relative_script_path, '/');
}
- if ($path && $path != $this->urlpath) {
- $this->urlpath = $path;
+ if ($path && $path != $this->urlPath) {
+ $this->urlPath = $path;
}
}
}
- /**
- * Sets the App mode
- *
- * - App::MODE_INSTALL : Either the database connection can't be established or the config table doesn't exist
- * - App::MODE_MAINTENANCE: The maintenance mode has been set
- * - App::MODE_NORMAL : Normal run with all features enabled
- *
- * @return type
- */
- private function determineMode()
- {
- $this->mode = 0;
-
- if (!file_exists($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php')
- && !file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htconfig.php')) {
- return;
- }
-
- $this->mode |= App::MODE_LOCALCONFIGPRESENT;
-
- if (!DBA::connected()) {
- return;
- }
-
- $this->mode |= App::MODE_DBAVAILABLE;
-
- if (DBA::fetchFirst("SHOW TABLES LIKE 'config'") === false) {
- return;
- }
-
- $this->mode |= App::MODE_DBCONFIGAVAILABLE;
-
- if (Config::get('system', 'maintenance')) {
- return;
- }
-
- $this->mode |= App::MODE_MAINTENANCEDISABLED;
- }
-
public function loadDatabase()
{
if (DBA::connected()) {
DBA::connect($db_host, $db_user, $db_pass, $db_data, $charset);
unset($db_host, $db_user, $db_pass, $db_data, $charset);
- $this->save_timestamp($stamp1, 'network');
- }
-
- /**
- * Install mode is when the local config file is missing or the DB schema hasn't been installed yet.
- *
- * @return bool
- */
- public function isInstallMode()
- {
- return !($this->mode & App::MODE_LOCALCONFIGPRESENT) || !($this->mode & App::MODE_DBCONFIGAVAILABLE);
+ $this->saveTimestamp($stamp1, 'network');
}
/**
*
* @return string
*/
- public function get_basepath()
+ public function getBasePath()
{
- $basepath = $this->basepath;
+ $basepath = $this->basePath;
if (!$basepath) {
$basepath = Config::get('system', 'basepath');
$basepath = $_SERVER['PWD'];
}
- return self::realpath($basepath);
+ return self::getRealPath($basepath);
}
/**
* @param string $path The path that is about to be normalized
* @return string normalized path - when possible
*/
- public static function realpath($path)
+ public static function getRealPath($path)
{
$normalized = realpath($path);
}
}
- public function get_scheme()
+ public function getScheme()
{
return $this->scheme;
}
* @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
* @return string Friendica server base URL
*/
- public function get_baseurl($ssl = false)
+ public function getBaseURL($ssl = false)
{
$scheme = $this->scheme;
$this->hostname = Config::get('config', 'hostname');
}
- return $scheme . '://' . $this->hostname . (!empty($this->urlpath) ? '/' . $this->urlpath : '' );
+ return $scheme . '://' . $this->hostname . (!empty($this->getURLPath()) ? '/' . $this->getURLPath() : '' );
}
/**
*
* @param string $url
*/
- public function set_baseurl($url)
+ public function setBaseURL($url)
{
$parsed = @parse_url($url);
$hostname = '';
$hostname .= ':' . $parsed['port'];
}
if (x($parsed, 'path')) {
- $this->urlpath = trim($parsed['path'], '\\/');
+ $this->urlPath = trim($parsed['path'], '\\/');
}
- if (file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php')) {
- include $this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php';
+ if (file_exists($this->getBasePath() . DIRECTORY_SEPARATOR . '.htpreconfig.php')) {
+ include $this->getBasePath() . DIRECTORY_SEPARATOR . '.htpreconfig.php';
}
if (Config::get('config', 'hostname') != '') {
}
}
- public function get_hostname()
+ public function getHostName()
{
if (Config::get('config', 'hostname') != '') {
$this->hostname = Config::get('config', 'hostname');
return $this->hostname;
}
- public function get_path()
+ public function getURLPath()
{
- return $this->urlpath;
+ return $this->urlPath;
}
- public function set_pager_total($n)
+ public function setPagerTotal($n)
{
$this->pager['total'] = intval($n);
}
- public function set_pager_itemspage($n)
+ public function setPagerItemsPage($n)
{
$this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
$this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
}
- public function set_pager_page($n)
+ public function setPagerPage($n)
{
$this->pager['page'] = $n;
$this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
}
- public function init_pagehead()
+ /**
+ * Initializes App->page['htmlhead'].
+ *
+ * Includes:
+ * - Page title
+ * - Favicons
+ * - Registered stylesheets (through App->registerStylesheet())
+ * - Infinite scroll data
+ * - head.tpl template
+ */
+ public function initHead()
{
$interval = ((local_user()) ? PConfig::get(local_user(), 'system', 'update_interval') : 40000);
$this->page['title'] = $this->config['sitename'];
}
- /* put the head template at the beginning of page['htmlhead']
- * since the code added by the modules frequently depends on it
- * being first
- */
- if (!isset($this->page['htmlhead'])) {
- $this->page['htmlhead'] = '';
- }
-
- // If we're using Smarty, then doing replace_macros() will replace
- // any unrecognized variables with a blank string. Since we delay
- // replacing $stylesheet until later, we need to replace it now
- // with another variable name
- if ($this->theme['template_engine'] === 'smarty3') {
- $stylesheet = $this->get_template_ldelim('smarty3') . '$stylesheet' . $this->get_template_rdelim('smarty3');
+ if (!empty($this->theme['stylesheet'])) {
+ $stylesheet = $this->theme['stylesheet'];
} else {
- $stylesheet = '$stylesheet';
+ $stylesheet = $this->getCurrentThemeStylesheetPath();
}
+ $this->registerStylesheet($stylesheet);
+
$shortcut_icon = Config::get('system', 'shortcut_icon');
if ($shortcut_icon == '') {
$shortcut_icon = 'images/friendica-32.png';
}
// get data wich is needed for infinite scroll on the network page
- $invinite_scroll = infinite_scroll_data($this->module);
+ $infinite_scroll = infinite_scroll_data($this->module);
+
+ Core\Addon::callHooks('head', $this->page['htmlhead']);
$tpl = get_markup_template('head.tpl');
+ /* put the head template at the beginning of page['htmlhead']
+ * since the code added by the modules frequently depends on it
+ * being first
+ */
$this->page['htmlhead'] = replace_macros($tpl, [
- '$baseurl' => $this->get_baseurl(),
+ '$baseurl' => $this->getBaseURL(),
'$local_user' => local_user(),
'$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
'$delitem' => L10n::t('Delete this item?'),
'$update_interval' => $interval,
'$shortcut_icon' => $shortcut_icon,
'$touch_icon' => $touch_icon,
- '$stylesheet' => $stylesheet,
- '$infinite_scroll' => $invinite_scroll,
+ '$infinite_scroll' => $infinite_scroll,
'$block_public' => intval(Config::get('system', 'block_public')),
+ '$stylesheets' => $this->stylesheets,
]) . $this->page['htmlhead'];
}
- public function init_page_end()
+ /**
+ * Initializes App->page['footer'].
+ *
+ * Includes:
+ * - Javascript homebase
+ * - Mobile toggle link
+ * - Registered footer scripts (through App->registerFooterScript())
+ * - footer.tpl template
+ */
+ public function initFooter()
{
- if (!isset($this->page['end'])) {
- $this->page['end'] = '';
+ // If you're just visiting, let javascript take you home
+ if (!empty($_SESSION['visitor_home'])) {
+ $homebase = $_SESSION['visitor_home'];
+ } elseif (local_user()) {
+ $homebase = 'profile/' . $this->user['nickname'];
}
- $tpl = get_markup_template('end.tpl');
- $this->page['end'] = replace_macros($tpl, [
- '$baseurl' => $this->get_baseurl()
- ]) . $this->page['end'];
- }
-
- public function set_curl_code($code)
- {
- $this->curl_code = $code;
- }
- public function get_curl_code()
- {
- return $this->curl_code;
- }
-
- public function set_curl_content_type($content_type)
- {
- $this->curl_content_type = $content_type;
- }
+ if (isset($homebase)) {
+ $this->page['footer'] .= '<script>var homebase="' . $homebase . '";</script>' . "\n";
+ }
- public function get_curl_content_type()
- {
- return $this->curl_content_type;
- }
+ /*
+ * Add a "toggle mobile" link if we're using a mobile device
+ */
+ if ($this->is_mobile || $this->is_tablet) {
+ if (isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) {
+ $link = 'toggle_mobile?address=' . curPageURL();
+ } else {
+ $link = 'toggle_mobile?off=1&address=' . curPageURL();
+ }
+ $this->page['footer'] .= replace_macros(get_markup_template("toggle_mobile_footer.tpl"), [
+ '$toggle_link' => $link,
+ '$toggle_text' => Core\L10n::t('toggle mobile')
+ ]);
+ }
- public function set_curl_headers($headers)
- {
- $this->curl_headers = $headers;
- }
+ Core\Addon::callHooks('footer', $this->page['footer']);
- public function get_curl_headers()
- {
- return $this->curl_headers;
+ $tpl = get_markup_template('footer.tpl');
+ $this->page['footer'] = replace_macros($tpl, [
+ '$baseurl' => $this->getBaseURL(),
+ '$footerScripts' => $this->footerScripts,
+ ]) . $this->page['footer'];
}
/**
* @brief Removes the base url from an url. This avoids some mixed content problems.
*
- * @param string $orig_url
+ * @param string $origURL
*
* @return string The cleaned url
*/
- public function remove_baseurl($orig_url)
+ public function removeBaseURL($origURL)
{
// Remove the hostname from the url if it is an internal link
- $nurl = normalise_link($orig_url);
- $base = normalise_link($this->get_baseurl());
+ $nurl = normalise_link($origURL);
+ $base = normalise_link($this->getBaseURL());
$url = str_replace($base . '/', '', $nurl);
// if it is an external link return the orignal value
- if ($url == normalise_link($orig_url)) {
- return $orig_url;
+ if ($url == normalise_link($origURL)) {
+ return $origURL;
} else {
return $url;
}
*
* @param string $class
*/
- private function register_template_engine($class)
+ private function registerTemplateEngine($class)
{
$v = get_class_vars($class);
if (x($v, 'name')) {
*
* @return object Template Engine instance
*/
- public function template_engine()
+ public function getTemplateEngine()
{
$template_engine = 'smarty3';
if (x($this->theme, 'template_engine')) {
/**
* @brief Returns the active template engine.
*
- * @return string
+ * @return string the active template engine
*/
- public function get_template_engine()
+ public function getActiveTemplateEngine()
{
return $this->theme['template_engine'];
}
- public function set_template_engine($engine = 'smarty3')
+ /**
+ * sets the active template engine
+ *
+ * @param string $engine the template engine (default is Smarty3)
+ */
+ public function setActiveTemplateEngine($engine = 'smarty3')
{
$this->theme['template_engine'] = $engine;
}
- public function get_template_ldelim($engine = 'smarty3')
+ /**
+ * Gets the right delimiter for a template engine
+ *
+ * Currently:
+ * Internal = ''
+ * Smarty3 = '{{'
+ *
+ * @param string $engine The template engine (default is Smarty3)
+ *
+ * @return string the right delimiter
+ */
+ public function getTemplateLeftDelimiter($engine = 'smarty3')
{
return $this->ldelim[$engine];
}
- public function get_template_rdelim($engine = 'smarty3')
+ /**
+ * Gets the left delimiter for a template engine
+ *
+ * Currently:
+ * Internal = ''
+ * Smarty3 = '}}'
+ *
+ * @param string $engine The template engine (default is Smarty3)
+ *
+ * @return string the left delimiter
+ */
+ public function getTemplateRightDelimiter($engine = 'smarty3')
{
return $this->rdelim[$engine];
}
- public function save_timestamp($stamp, $value)
+ /**
+ * Saves a timestamp for a value - f.e. a call
+ * Necessary for profiling Friendica
+ *
+ * @param int $timestamp the Timestamp
+ * @param string $value A value to profile
+ */
+ public function saveTimestamp($timestamp, $value)
{
if (!isset($this->config['system']['profiler']) || !$this->config['system']['profiler']) {
return;
}
- $duration = (float) (microtime(true) - $stamp);
+ $duration = (float) (microtime(true) - $timestamp);
if (!isset($this->performance[$value])) {
// Prevent ugly E_NOTICE
$this->callstack[$value][$callstack] += (float) $duration;
}
- public function get_useragent()
+ /**
+ * Returns the current UserAgent as a String
+ *
+ * @return string the UserAgent as a String
+ */
+ public function getUserAgent()
{
return
FRIENDICA_PLATFORM . " '" .
FRIENDICA_CODENAME . "' " .
FRIENDICA_VERSION . '-' .
DB_UPDATE_VERSION . '; ' .
- $this->get_baseurl();
+ $this->getBaseURL();
}
- public function is_friendica_app()
+ /**
+ * Checks, if the call is from the Friendica App
+ *
+ * Reason:
+ * The friendica client has problems with the GUID in the notify. this is some workaround
+ */
+ private function checkFriendicaApp()
{
- return $this->is_friendica_app;
+ // Friendica-Client
+ $this->isFriendicaApp = isset($_SERVER['HTTP_USER_AGENT']) && $_SERVER['HTTP_USER_AGENT'] == 'Apache-HttpClient/UNAVAILABLE (java 1.4)';
+ }
+
+ /**
+ * Is the call via the Friendica app? (not a "normale" call)
+ *
+ * @return bool true if it's from the Friendica app
+ */
+ public function isFriendicaApp()
+ {
+ return $this->isFriendicaApp;
}
/**
* This isn't a perfect solution. But we need this check very early.
* So we cannot wait until the modules are loaded.
*
- * @return bool Is it a known backend?
+ * @param string $backend true, if the backend flag was set during App initialization
+ *
*/
- public function is_backend()
- {
+ private function checkBackend($backend) {
static $backends = [
'_well_known',
'api',
];
// Check if current module is in backend or backend flag is set
- return (in_array($this->module, $backends) || $this->backend);
+ $this->isBackend = (in_array($this->module, $backends) || $backend || $this->isBackend);
+ }
+
+ /**
+ * Returns true, if the call is from a backend node (f.e. from a worker)
+ *
+ * @return bool Is it a known backend?
+ */
+ public function isBackend()
+ {
+ return $this->isBackend;
}
/**
*
* @return bool Is the memory limit reached?
*/
- public function min_memory_reached()
+ public function isMinMemoryReached()
{
$min_memory = Config::get('system', 'min_memory', 0);
if ($min_memory == 0) {
$meminfo = [];
foreach ($memdata as $line) {
- list($key, $val) = explode(':', $line);
+ $data = explode(':', $line);
+ if (count($data) != 2) {
+ continue;
+ }
+ list($key, $val) = $data;
$meminfo[$key] = (int) trim(str_replace('kB', '', $val));
$meminfo[$key] = (int) ($meminfo[$key] / 1024);
}
*/
public function isMaxLoadReached()
{
- if ($this->is_backend()) {
+ if ($this->isBackend()) {
$process = 'backend';
$maxsysload = intval(Config::get('system', 'maxloadavg'));
if ($maxsysload < 1) {
}
}
- $load = current_load();
+ $load = System::currentLoad();
if ($load) {
if (intval($load) > $maxsysload) {
logger('system: load ' . $load . ' for ' . $process . ' tasks (' . $maxsysload . ') too high.');
return;
}
- $cmdline = $this->getConfigValue('config', 'php_path', 'php') . ' ' . $command;
+ $cmdline = $this->getConfigValue('config', 'php_path', 'php') . ' ' . escapeshellarg($command);
foreach ($args as $key => $value) {
if (!is_null($value) && is_bool($value) && !$value) {
}
}
- $cmdline = escapeshellarg($cmdline);
-
- if ($this->min_memory_reached()) {
+ if ($this->isMinMemoryReached()) {
return;
}
if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
- $resource = proc_open('cmd /c start /b ' . $cmdline, [], $foo, $this->get_basepath());
+ $resource = proc_open('cmd /c start /b ' . $cmdline, [], $foo, $this->getBasePath());
} else {
- $resource = proc_open($cmdline . ' &', [], $foo, $this->get_basepath());
+ $resource = proc_open($cmdline . ' &', [], $foo, $this->getBasePath());
}
if (!is_resource($resource)) {
logger('We got no resource for command ' . $cmdline, LOGGER_DEBUG);
*
* @return string system username
*/
- private static function systemuser()
+ private static function getSystemUser()
{
if (!function_exists('posix_getpwuid') || !function_exists('posix_geteuid')) {
return '';
*
* @return boolean the directory is usable
*/
- public static function directory_usable($directory, $check_writable = true)
+ public static function isDirectoryUsable($directory, $check_writable = true)
{
if ($directory == '') {
logger('Directory is empty. This shouldn\'t happen.', LOGGER_DEBUG);
}
if (!file_exists($directory)) {
- logger('Path "' . $directory . '" does not exist for user ' . self::systemuser(), LOGGER_DEBUG);
+ logger('Path "' . $directory . '" does not exist for user ' . self::getSystemUser(), LOGGER_DEBUG);
return false;
}
if (is_file($directory)) {
- logger('Path "' . $directory . '" is a file for user ' . self::systemuser(), LOGGER_DEBUG);
+ logger('Path "' . $directory . '" is a file for user ' . self::getSystemUser(), LOGGER_DEBUG);
return false;
}
if (!is_dir($directory)) {
- logger('Path "' . $directory . '" is not a directory for user ' . self::systemuser(), LOGGER_DEBUG);
+ logger('Path "' . $directory . '" is not a directory for user ' . self::getSystemUser(), LOGGER_DEBUG);
return false;
}
if ($check_writable && !is_writable($directory)) {
- logger('Path "' . $directory . '" is not writable for user ' . self::systemuser(), LOGGER_DEBUG);
+ logger('Path "' . $directory . '" is not writable for user ' . self::getSystemUser(), LOGGER_DEBUG);
return false;
}
* @param string $cat Config category
* @param string $k Config key
* @param mixed $default Default value if it isn't set
+ *
+ * @return string Returns the value of the Config entry
*/
public function getConfigValue($cat, $k, $default = null)
{
return $return;
}
+ /**
+ * Sets a default value in the config cache. Ignores already existing keys.
+ *
+ * @param string $cat Config category
+ * @param string $k Config key
+ * @param mixed $v Default value to set
+ */
+ private function setDefaultConfigValue($cat, $k, $v)
+ {
+ if (!isset($this->config[$cat][$k])) {
+ $this->setConfigValue($cat, $k, $v);
+ }
+ }
+
/**
* Sets a value in the config cache. Accepts raw output from the config table
*
* @param string $cat Config category
* @param string $k Config key
* @param mixed $default Default value if key isn't set
+ *
+ * @return string The value of the config entry
*/
public function getPConfigValue($uid, $cat, $k, $default = null)
{
// Only arrays are serialized in database, so we have to unserialize sparingly
$value = is_string($v) && preg_match("|^a:[0-9]+:{.*}$|s", $v) ? unserialize($v) : $v;
- if (!isset($this->config[$uid])) {
+ if (!isset($this->config[$uid]) || !is_array($this->config[$uid])) {
$this->config[$uid] = [];
}
- if (!isset($this->config[$uid][$cat])) {
+ if (!isset($this->config[$uid][$cat]) || !is_array($this->config[$uid][$cat])) {
$this->config[$uid][$cat] = [];
}
{
$sender_email = Config::get('config', 'sender_email');
if (empty($sender_email)) {
- $hostname = $this->get_hostname();
+ $hostname = $this->getHostName();
if (strpos($hostname, ':')) {
$hostname = substr($hostname, 0, strpos($hostname, ':'));
}
/**
* Returns the current theme name.
*
- * @return string
+ * @return string the name of the current theme
*/
public function getCurrentTheme()
{
- if ($this->isInstallMode()) {
+ if ($this->getMode()->isInstall()) {
return '';
}
/// https://github.com/friendica/friendica/issues/5092)
$this->computeCurrentTheme();
- return $this->current_theme;
+ return $this->currentTheme;
}
/**
}
// Sane default
- $this->current_theme = $system_theme;
+ $this->currentTheme = $system_theme;
$allowed_themes = explode(',', Config::get('system', 'allowed_themes', $system_theme));
}
}
- if (!empty($_SESSION)) {
- $user_theme = defaults($_SESSION, 'theme', $system_theme);
- } else {
- $user_theme = $system_theme;
- }
+ $user_theme = Core\Session::get('theme', $system_theme);
// Specific mobile theme override
- if (($this->is_mobile || $this->is_tablet) && defaults($_SESSION, 'show-mobile', true)) {
+ if (($this->is_mobile || $this->is_tablet) && Core\Session::get('show-mobile', true)) {
$system_mobile_theme = Config::get('system', 'mobile-theme');
- $user_mobile_theme = defaults($_SESSION, 'mobile-theme', $system_mobile_theme);
+ $user_mobile_theme = Core\Session::get('mobile-theme', $system_mobile_theme);
// --- means same mobile theme as desktop
if (!empty($user_mobile_theme) && $user_mobile_theme !== '---') {
&& (file_exists('view/theme/' . $theme_name . '/style.css')
|| file_exists('view/theme/' . $theme_name . '/style.php'))
) {
- $this->current_theme = $theme_name;
+ $this->currentTheme = $theme_name;
}
}
{
return Core\Theme::getStylesheetPath($this->getCurrentTheme());
}
+
+ /**
+ * Check if request was an AJAX (xmlhttprequest) request.
+ *
+ * @return boolean true if it was an AJAX request
+ */
+ public function isAjax()
+ {
+ return $this->isAjax;
+ }
+
+ /**
+ * Returns the value of a argv key
+ * TODO there are a lot of $a->argv usages in combination with defaults() which can be replaced with this method
+ *
+ * @param int $position the position of the argument
+ * @param mixed $default the default value if not found
+ *
+ * @return mixed returns the value of the argument
+ */
+ public function getArgumentValue($position, $default = '')
+ {
+ if (array_key_exists($position, $this->argv)) {
+ return $this->argv[$position];
+ }
+
+ return $default;
+ }
}
projects / friendica.git / blobdiff