public $argc;
public $module;
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
*/
private $mode;
+ /**
+ * @var string The App basepath
+ */
+ 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;
+
/**
* Register a stylesheet file path to be included in the <head> tag of every page.
* Inclusion is done in App->initHead().
*/
public function registerStylesheet($path)
{
- $url = str_replace($this->get_basepath() . DIRECTORY_SEPARATOR, '', $path);
+ $url = str_replace($this->getBasePath() . DIRECTORY_SEPARATOR, '', $path);
$this->stylesheets[] = trim($url, '/');
}
*/
public function registerFooterScript($path)
{
- $url = str_replace($this->get_basepath() . DIRECTORY_SEPARATOR, '', $path);
+ $url = str_replace($this->getBasePath() . DIRECTORY_SEPARATOR, '', $path);
$this->footerScripts[] = trim($url, '/');
}
];
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 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)) {
+ if (!static::isDirectoryUsable($basepath, false)) {
throw new Exception('Basepath ' . $basepath . ' isn\'t usable.');
}
BaseObject::setApp($this);
$this->basepath = rtrim($basepath, DIRECTORY_SEPARATOR);
+ $this->checkBackend($backend);
+ $this->checkFriendicaApp();
$this->performance['start'] = microtime(true);
$this->performance['database'] = 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)';
-
// Register template engines
- $this->register_template_engine('Friendica\Render\FriendicaSmartyEngine');
+ $this->registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
}
/**
$this->loadDatabase();
- $this->getMode()->determine($this->basepath);
+ $this->getMode()->determine($this->getBasePath());
- $this->determineUrlPath();
+ $this->determineURLPath();
Config::load();
*/
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', true);
+ 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);
}
}
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', true);
+ 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');
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');
+ $this->saveTimestamp($stamp1, 'network');
}
/**
*
* @return string
*/
- public function get_basepath()
+ public function getBasePath()
{
$basepath = $this->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 = '';
$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;
}
- 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'];
* 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?'),
$tpl = get_markup_template('footer.tpl');
$this->page['footer'] = replace_macros($tpl, [
- '$baseurl' => $this->get_baseurl(),
+ '$baseurl' => $this->getBaseURL(),
'$footerScripts' => $this->footerScripts,
]) . $this->page['footer'];
}
- 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;
- }
-
- public function get_curl_content_type()
- {
- return $this->curl_content_type;
- }
-
- public function set_curl_headers($headers)
- {
- $this->curl_headers = $headers;
- }
-
- public function get_curl_headers()
- {
- return $this->curl_headers;
- }
-
/**
* @brief Removes the base url from an url. This avoids some mixed content problems.
*
*
* @return string The cleaned url
*/
- public function remove_baseurl($orig_url)
+ public function removeBaseURL($orig_url)
{
// Remove the hostname from the url if it is an internal link
$nurl = normalise_link($orig_url);
- $base = normalise_link($this->get_baseurl());
+ $base = normalise_link($this->getBaseURL());
$url = str_replace($base . '/', '', $nurl);
// if it is an external link return the orignal value
*
* @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')) {
*
* @return string
*/
- public function get_template_engine()
+ public function getActiveTemplateEngine()
{
return $this->theme['template_engine'];
}
- public function set_template_engine($engine = 'smarty3')
+ public function setActiveTemplateEngine($engine = 'smarty3')
{
$this->theme['template_engine'] = $engine;
}
- public function get_template_ldelim($engine = 'smarty3')
+ public function getTemplateLdelim($engine = 'smarty3')
{
return $this->ldelim[$engine];
}
- public function get_template_rdelim($engine = 'smarty3')
+ public function getTemplateRdelim($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();
+ }
+
+ /**
+ * 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()
+ {
+ // Friendica-Client
+ $this->isFriendicaApp = isset($_SERVER['HTTP_USER_AGENT']) && $_SERVER['HTTP_USER_AGENT'] == 'Apache-HttpClient/UNAVAILABLE (java 1.4)';
}
- public function is_friendica_app()
+ /**
+ * 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->is_friendica_app;
+ 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?
*/
- 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) || $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) {
*/
public function isMaxLoadReached()
{
- if ($this->is_backend()) {
+ if ($this->isBackend()) {
$process = 'backend';
$maxsysload = intval(Config::get('system', 'maxloadavg'));
if ($maxsysload < 1) {
}
}
- 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)
{
* @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)
{
{
$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()
{
/// 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));
&& (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;
}
}
projects / friendica.git / blobdiff