bitPickups/friendica_2020-09-1_sharedHosting
1
0
Fork 0
Code Pull requests Activity

Fix issues in App.php

Browse source 
- Fix formatting
- Add method visibility
- Remove unused properties
- Remove unused methods
- Remove unused parameters
- Fix implode parameter order (?!)
This commit is contained in:
Hypolite Petovan 2018-01-15 19:13:21 -05:00
parent 78ac7afe9c
commit ad88b6e3af
1 changed files with 139 additions and 131 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

232
src/App.php
View file

@ -27,8 +27,8 @@ require_once 'include/text.php';
* before we spit the page out. * before we spit the page out.
* *
*/ */
class App { class App
{
public $module_loaded = false; public $module_loaded = false;
public $module_class = null; public $module_class = null;
public $query_string; public $query_string;
@ -114,12 +114,9 @@ class App {
]; ];
private $scheme; private $scheme;
private $hostname; private $hostname;
private $db;
private $curl_code; private $curl_code;
private $curl_content_type; private $curl_content_type;
private $curl_headers; private $curl_headers;
private $cached_profile_image;
private $cached_profile_picdate;
private static $a; private static $a;
/** /**
@ -127,20 +124,18 @@ class App {
* *
* @param string $basepath Path to the app base folder * @param string $basepath Path to the app base folder
*/ */
function __construct($basepath) { public function __construct($basepath)
{
global $default_timezone; global $default_timezone;
$hostname = ''; if (!static::directory_usable($basepath, false)) {
if (! static::directory_usable($basepath, false)) {
throw new Exception('Basepath ' . $basepath . ' isn\'t usable.'); throw new Exception('Basepath ' . $basepath . ' isn\'t usable.');
} }
$this->basepath = rtrim($basepath, DIRECTORY_SEPARATOR); $this->basepath = rtrim($basepath, DIRECTORY_SEPARATOR);
if (file_exists($this->basepath.DIRECTORY_SEPARATOR.'.htpreconfig.php')) { if (file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php')) {
include $this->basepath.DIRECTORY_SEPARATOR.'.htpreconfig.php'; include $this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php';
} }
$this->timezone = ((x($default_timezone)) ? $default_timezone : 'UTC'); $this->timezone = ((x($default_timezone)) ? $default_timezone : 'UTC');
@ -204,10 +199,6 @@ class App {
} }
} }
if ($hostname != '') {
$this->hostname = $hostname;
}
set_include_path( set_include_path(
get_include_path() . PATH_SEPARATOR get_include_path() . PATH_SEPARATOR
. $this->basepath . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR . $this->basepath . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
@ -312,18 +303,19 @@ class App {
* *
* @return string * @return string
*/ */
public function get_basepath() { public function get_basepath()
{
$basepath = $this->basepath; $basepath = $this->basepath;
if (! $basepath) { if (!$basepath) {
$basepath = Config::get('system', 'basepath'); $basepath = Config::get('system', 'basepath');
} }
if (! $basepath && x($_SERVER, 'DOCUMENT_ROOT')) { if (!$basepath && x($_SERVER, 'DOCUMENT_ROOT')) {
$basepath = $_SERVER['DOCUMENT_ROOT']; $basepath = $_SERVER['DOCUMENT_ROOT'];
} }
if (! $basepath && x($_SERVER, 'PWD')) { if (!$basepath && x($_SERVER, 'PWD')) {
$basepath = $_SERVER['PWD']; $basepath = $_SERVER['PWD'];
} }
@ -340,7 +332,8 @@ class App {
* @param string $path The path that is about to be normalized * @param string $path The path that is about to be normalized
* @return string normalized path - when possible * @return string normalized path - when possible
*/ */
public static function realpath($path) { public static function realpath($path)
{
$normalized = realpath($path); $normalized = realpath($path);
if (!is_bool($normalized)) { if (!is_bool($normalized)) {
@ -350,7 +343,8 @@ class App {
} }
} }
function get_scheme() { public function get_scheme()
{
return $this->scheme; return $this->scheme;
} }
@ -368,7 +362,8 @@ class App {
* @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
* @return string Friendica server base URL * @return string Friendica server base URL
*/ */
function get_baseurl($ssl = false) { public function get_baseurl($ssl = false)
{
$scheme = $this->scheme; $scheme = $this->scheme;
if (Config::get('system', 'ssl_policy') == SSL_POLICY_FULL) { if (Config::get('system', 'ssl_policy') == SSL_POLICY_FULL) {
@ -396,14 +391,15 @@ class App {
/** /**
* @brief Initializes the baseurl components * @brief Initializes the baseurl components
* *
* Clears the baseurl cache to prevent inconstistencies * Clears the baseurl cache to prevent inconsistencies
* *
* @param string $url * @param string $url
*/ */
function set_baseurl($url) { public function set_baseurl($url)
{
$parsed = @parse_url($url); $parsed = @parse_url($url);
if ($parsed) { if (x($parsed)) {
$this->scheme = $parsed['scheme']; $this->scheme = $parsed['scheme'];
$hostname = $parsed['host']; $hostname = $parsed['host'];
@ -414,8 +410,8 @@ class App {
$this->path = trim($parsed['path'], '\\/'); $this->path = trim($parsed['path'], '\\/');
} }
if (file_exists($this->basepath.DIRECTORY_SEPARATOR.'.htpreconfig.php')) { if (file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php')) {
include $this->basepath.DIRECTORY_SEPARATOR.'.htpreconfig.php'; include $this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php';
} }
if (Config::get('config', 'hostname') != '') { if (Config::get('config', 'hostname') != '') {
@ -428,7 +424,8 @@ class App {
} }
} }
function get_hostname() { public function get_hostname()
{
if (Config::get('config', 'hostname') != '') { if (Config::get('config', 'hostname') != '') {
$this->hostname = Config::get('config', 'hostname'); $this->hostname = Config::get('config', 'hostname');
} }
@ -436,33 +433,30 @@ class App {
return $this->hostname; return $this->hostname;
} }
function set_hostname($h) { public function get_path()
$this->hostname = $h; {
}
function set_path($p) {
$this->path = trim(trim($p), '/');
}
function get_path() {
return $this->path; return $this->path;
} }
function set_pager_total($n) { public function set_pager_total($n)
{
$this->pager['total'] = intval($n); $this->pager['total'] = intval($n);
} }
function set_pager_itemspage($n) { public function set_pager_itemspage($n)
{
$this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0); $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
$this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage']; $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
} }
function set_pager_page($n) { public function set_pager_page($n)
{
$this->pager['page'] = $n; $this->pager['page'] = $n;
$this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage']; $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
} }
function init_pagehead() { public function init_pagehead()
{
$interval = ((local_user()) ? PConfig::get(local_user(), 'system', 'update_interval') : 40000); $interval = ((local_user()) ? PConfig::get(local_user(), 'system', 'update_interval') : 40000);
// If the update is 'deactivated' set it to the highest integer number (~24 days) // If the update is 'deactivated' set it to the highest integer number (~24 days)
@ -529,7 +523,8 @@ class App {
]) . $this->page['htmlhead']; ]) . $this->page['htmlhead'];
} }
function init_page_end() { public function init_page_end()
{
if (!isset($this->page['end'])) { if (!isset($this->page['end'])) {
$this->page['end'] = ''; $this->page['end'] = '';
} }
@ -539,43 +534,45 @@ class App {
]) . $this->page['end']; ]) . $this->page['end'];
} }
function set_curl_code($code) { public function set_curl_code($code)
{
$this->curl_code = $code; $this->curl_code = $code;
} }
function get_curl_code() { public function get_curl_code()
{
return $this->curl_code; return $this->curl_code;
} }
function set_curl_content_type($content_type) { public function set_curl_content_type($content_type)
{
$this->curl_content_type = $content_type; $this->curl_content_type = $content_type;
} }
function get_curl_content_type() { public function get_curl_content_type()
{
return $this->curl_content_type; return $this->curl_content_type;
} }
function set_curl_headers($headers) { public function set_curl_headers($headers)
{
$this->curl_headers = $headers; $this->curl_headers = $headers;
} }
function get_curl_headers() { public function get_curl_headers()
{
return $this->curl_headers; return $this->curl_headers;
} }
function get_cached_avatar_image($avatar_image) {
return $avatar_image;
}
/** /**
* @brief Removes the baseurl from an url. This avoids some mixed content problems. * @brief Removes the base url from an url. This avoids some mixed content problems.
* *
* @param string $orig_url * @param string $orig_url
* *
* @return string The cleaned url * @return string The cleaned url
*/ */
function remove_baseurl($orig_url) { public function remove_baseurl($orig_url)
{
// Remove the hostname from the url if it is an internal link // Remove the hostname from the url if it is an internal link
$nurl = normalise_link($orig_url); $nurl = normalise_link($orig_url);
$base = normalise_link($this->get_baseurl()); $base = normalise_link($this->get_baseurl());
@ -592,23 +589,18 @@ class App {
/** /**
* @brief Register template engine class * @brief Register template engine class
* *
* If $name is '', is used class static property $class::$name
*
* @param string $class * @param string $class
* @param string $name
*/ */
function register_template_engine($class, $name = '') { private function register_template_engine($class)
/// @TODO Really === and not just == ? {
if ($name === '') {
$v = get_class_vars($class); $v = get_class_vars($class);
if (x($v, 'name')) if (x($v, 'name')) {
$name = $v['name']; $name = $v['name'];
} $this->template_engines[$name] = $class;
if ($name === '') { } else {
echo "template engine <tt>$class</tt> cannot be registered without a name.\n"; echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
killme(); killme();
} }
$this->template_engines[$name] = $class;
} }
/** /**
@ -617,19 +609,14 @@ class App {
* If $name is not defined, return engine defined by theme, * If $name is not defined, return engine defined by theme,
* or default * or default
* *
* @param string $name Template engine name
* @return object Template Engine instance * @return object Template Engine instance
*/ */
function template_engine($name = '') { public function template_engine()
/// @TODO really type-check included? {
if ($name !== '') {
$template_engine = $name;
} else {
$template_engine = 'smarty3'; $template_engine = 'smarty3';
if (x($this->theme, 'template_engine')) { if (x($this->theme, 'template_engine')) {
$template_engine = $this->theme['template_engine']; $template_engine = $this->theme['template_engine'];
} }
}
if (isset($this->template_engines[$template_engine])) { if (isset($this->template_engines[$template_engine])) {
if (isset($this->template_engine_instance[$template_engine])) { if (isset($this->template_engine_instance[$template_engine])) {
@ -651,23 +638,28 @@ class App {
* *
* @return string * @return string
*/ */
function get_template_engine() { public function get_template_engine()
{
return $this->theme['template_engine']; return $this->theme['template_engine'];
} }
function set_template_engine($engine = 'smarty3') { public function set_template_engine($engine = 'smarty3')
{
$this->theme['template_engine'] = $engine; $this->theme['template_engine'] = $engine;
} }
function get_template_ldelim($engine = 'smarty3') { public function get_template_ldelim($engine = 'smarty3')
{
return $this->ldelim[$engine]; return $this->ldelim[$engine];
} }
function get_template_rdelim($engine = 'smarty3') { public function get_template_rdelim($engine = 'smarty3')
{
return $this->rdelim[$engine]; return $this->rdelim[$engine];
} }
function save_timestamp($stamp, $value) { public function save_timestamp($stamp, $value)
{
if (!isset($this->config['system']['profiler']) || !$this->config['system']['profiler']) { if (!isset($this->config['system']['profiler']) || !$this->config['system']['profiler']) {
return; return;
} }
@ -692,7 +684,8 @@ class App {
$this->callstack[$value][$callstack] += (float) $duration; $this->callstack[$value][$callstack] += (float) $duration;
} }
function get_useragent() { public function get_useragent()
{
return return
FRIENDICA_PLATFORM . " '" . FRIENDICA_PLATFORM . " '" .
FRIENDICA_CODENAME . "' " . FRIENDICA_CODENAME . "' " .
@ -701,7 +694,8 @@ class App {
$this->get_baseurl(); $this->get_baseurl();
} }
function is_friendica_app() { public function is_friendica_app()
{
return $this->is_friendica_app; return $this->is_friendica_app;
} }
@ -713,27 +707,29 @@ class App {
* *
* @return bool Is it a known backend? * @return bool Is it a known backend?
*/ */
function is_backend() { public function is_backend()
static $backends = []; {
$backends[] = '_well_known'; static $backends = [
$backends[] = 'api'; '_well_known',
$backends[] = 'dfrn_notify'; 'api',
$backends[] = 'fetch'; 'dfrn_notify',
$backends[] = 'hcard'; 'fetch',
$backends[] = 'hostxrd'; 'hcard',
$backends[] = 'nodeinfo'; 'hostxrd',
$backends[] = 'noscrape'; 'nodeinfo',
$backends[] = 'p'; 'noscrape',
$backends[] = 'poco'; 'p',
$backends[] = 'post'; 'poco',
$backends[] = 'proxy'; 'post',
$backends[] = 'pubsub'; 'proxy',
$backends[] = 'pubsubhubbub'; 'pubsub',
$backends[] = 'receive'; 'pubsubhubbub',
$backends[] = 'rsd_xml'; 'receive',
$backends[] = 'salmon'; 'rsd_xml',
$backends[] = 'statistics_json'; 'salmon',
$backends[] = 'xrd'; 'statistics_json',
'xrd',
];
// Check if current module is in backend or backend flag is set // Check if current module is in backend or backend flag is set
return (in_array($this->module, $backends) || $this->backend); return (in_array($this->module, $backends) || $this->backend);
@ -744,10 +740,14 @@ class App {
* *
* @return bool Is the limit reached? * @return bool Is the limit reached?
*/ */
function max_processes_reached() { public function max_processes_reached()
{
// Deactivated, needs more investigating if this check really makes sense // Deactivated, needs more investigating if this check really makes sense
return false; return false;
/*
* Commented out to suppress static analyzer issues
*
if ($this->is_backend()) { if ($this->is_backend()) {
$process = 'backend'; $process = 'backend';
$max_processes = Config::get('system', 'max_processes_backend'); $max_processes = Config::get('system', 'max_processes_backend');
@ -772,6 +772,7 @@ class App {
} }
} }
return false; return false;
*/
} }
/** /**
@ -779,7 +780,8 @@ class App {
* *
* @return bool Is the memory limit reached? * @return bool Is the memory limit reached?
*/ */
public function min_memory_reached() { public function min_memory_reached()
{
$min_memory = Config::get('system', 'min_memory', 0); $min_memory = Config::get('system', 'min_memory', 0);
if ($min_memory == 0) { if ($min_memory == 0) {
return false; return false;
@ -798,7 +800,7 @@ class App {
$meminfo[$key] = (int) ($meminfo[$key] / 1024); $meminfo[$key] = (int) ($meminfo[$key] / 1024);
} }
if (!isset($meminfo['MemAvailable']) || ! isset($meminfo['MemFree'])) { if (!isset($meminfo['MemAvailable']) || !isset($meminfo['MemFree'])) {
return false; return false;
} }
@ -818,8 +820,8 @@ class App {
* *
* @return bool Is the load reached? * @return bool Is the load reached?
*/ */
function maxload_reached() { public function maxload_reached()
{
if ($this->is_backend()) { if ($this->is_backend()) {
$process = 'backend'; $process = 'backend';
$maxsysload = intval(Config::get('system', 'maxloadavg')); $maxsysload = intval(Config::get('system', 'maxloadavg'));
@ -844,8 +846,8 @@ class App {
return false; return false;
} }
function proc_run($args) { public function proc_run($args)
{
if (!function_exists('proc_open')) { if (!function_exists('proc_open')) {
return; return;
} }
@ -871,7 +873,7 @@ class App {
$args[$x] = escapeshellarg($args[$x]); $args[$x] = escapeshellarg($args[$x]);
} }
$cmdline = implode($args, ' '); $cmdline = implode(' ', $args);
if ($this->min_memory_reached()) { if ($this->min_memory_reached()) {
return; return;
@ -896,8 +898,9 @@ class App {
* *
* @return string system username * @return string system username
*/ */
static function systemuser() { private static function systemuser()
if (!function_exists('posix_getpwuid') || ! function_exists('posix_geteuid')) { {
if (!function_exists('posix_getpwuid') || !function_exists('posix_geteuid')) {
return ''; return '';
} }
@ -910,7 +913,8 @@ class App {
* *
* @return boolean the directory is usable * @return boolean the directory is usable
*/ */
static function directory_usable($directory, $check_writable = true) { public static function directory_usable($directory, $check_writable = true)
{
if ($directory == '') { if ($directory == '') {
logger('Directory is empty. This shouldn\'t happen.', LOGGER_DEBUG); logger('Directory is empty. This shouldn\'t happen.', LOGGER_DEBUG);
return false; return false;
@ -920,18 +924,22 @@ class App {
logger('Path "' . $directory . '" does not exist for user ' . self::systemuser(), LOGGER_DEBUG); logger('Path "' . $directory . '" does not exist for user ' . self::systemuser(), LOGGER_DEBUG);
return false; return false;
} }
if (is_file($directory)) { 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::systemuser(), LOGGER_DEBUG);
return false; return false;
} }
if (!is_dir($directory)) { 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::systemuser(), LOGGER_DEBUG);
return false; return false;
} }
if ($check_writable && !is_writable($directory)) { 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::systemuser(), LOGGER_DEBUG);
return false; return false;
} }
return true; return true;
} }
} }