From 40b0d383d52af2475220bc35e2ec891a8ce2eb9b Mon Sep 17 00:00:00 2001 From: rabuzarus <> Date: Thu, 24 Dec 2015 01:31:17 +0100 Subject: [PATCH] boot.php - code cleanup + doxygen --- boot.php | 2021 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 1034 insertions(+), 987 deletions(-) diff --git a/boot.php b/boot.php index bd2bee3ab8..b1a8867328 100644 --- a/boot.php +++ b/boot.php @@ -1,4 +1,21 @@ '', - 'videowidth' => 425, - 'videoheight' => 350, - 'force_max_items' => 0, - 'thread_allow' => true, - 'stylesheet' => '', - 'template_engine' => 'smarty3', - ); - - // array of registered template engines ('name'=>'class name') - public $template_engines = array(); - // array of instanced template engines ('name'=>'instance') - public $template_engine_instance = array(); - - private $ldelim = array( - 'internal' => '', - 'smarty3' => '{{' - ); - private $rdelim = array( - 'internal' => '', - 'smarty3' => '}}' - ); + /** + * @brief An array for all theme-controllable parameters + * + * Mostly unimplemented yet. Only options 'template_engine' and + * beyond are used. + */ + public $theme = array( + 'sourcename' => '', + 'videowidth' => 425, + 'videoheight' => 350, + 'force_max_items' => 0, + 'thread_allow' => true, + 'stylesheet' => '', + 'template_engine' => 'smarty3', + ); - private $scheme; - private $hostname; - private $baseurl; - private $db; + /** + * @brief An array of registered template engines ('name'=>'class name') + */ + public $template_engines = array(); + /** + * @brief An array of instanced template engines ('name'=>'instance') + */ + public $template_engine_instance = array(); - private $curl_code; - private $curl_content_type; - private $curl_headers; + private $ldelim = array( + 'internal' => '', + 'smarty3' => '{{' + ); + private $rdelim = array( + 'internal' => '', + 'smarty3' => '}}' + ); - private $cached_profile_image; - private $cached_profile_picdate; + private $scheme; + private $hostname; + private $baseurl; + private $db; - function __construct() { + private $curl_code; + private $curl_content_type; + private $curl_headers; - global $default_timezone; + private $cached_profile_image; + private $cached_profile_picdate; - $hostname = ""; + /** + * App constructor. + */ + function __construct() { - if (file_exists(".htpreconfig.php")) - @include(".htpreconfig.php"); + global $default_timezone; - $this->timezone = ((x($default_timezone)) ? $default_timezone : 'UTC'); - - date_default_timezone_set($this->timezone); - - $this->performance["start"] = microtime(true); - $this->performance["database"] = 0; - $this->performance["network"] = 0; - $this->performance["file"] = 0; - $this->performance["rendering"] = 0; - $this->performance["parser"] = 0; - $this->performance["marktime"] = 0; - $this->performance["markstart"] = microtime(true); - - $this->config = array(); - $this->page = array(); - $this->pager= array(); - - $this->query_string = ''; - - startup(); - - set_include_path( - 'include' . PATH_SEPARATOR - . 'library' . PATH_SEPARATOR - . 'library/phpsec' . PATH_SEPARATOR - . 'library/langdet' . PATH_SEPARATOR - . '.' ); - - - $this->scheme = 'http'; - if(x($_SERVER,'HTTPS') && $_SERVER['HTTPS']) - $this->scheme = 'https'; - elseif(x($_SERVER,'SERVER_PORT') && (intval($_SERVER['SERVER_PORT']) == 443)) - $this->scheme = 'https'; - - if(x($_SERVER,'SERVER_NAME')) { - $this->hostname = $_SERVER['SERVER_NAME']; - - // See bug 437 - this didn't work so disabling it - //if(stristr($this->hostname,'xn--')) { - // PHP or webserver may have converted idn to punycode, so - // convert punycode back to utf-8 - // require_once('library/simplepie/idn/idna_convert.class.php'); - // $x = new idna_convert(); - // $this->hostname = $x->decode($_SERVER['SERVER_NAME']); - //} - - if(x($_SERVER,'SERVER_PORT') && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) - $this->hostname .= ':' . $_SERVER['SERVER_PORT']; - /** - * Figure out if we are running at the top of a domain - * or in a sub-directory and adjust accordingly - */ - - $path = trim(dirname($_SERVER['SCRIPT_NAME']),'/\\'); - if(isset($path) && strlen($path) && ($path != $this->path)) - $this->path = $path; - } + $hostname = ""; - if ($hostname != "") - $this->hostname = $hostname; + if (file_exists(".htpreconfig.php")) + @include(".htpreconfig.php"); - if (is_array($_SERVER["argv"]) && $_SERVER["argc"]>1 && substr(end($_SERVER["argv"]), 0, 4)=="http" ) { - $this->set_baseurl(array_pop($_SERVER["argv"]) ); - $_SERVER["argc"] --; - } + $this->timezone = ((x($default_timezone)) ? $default_timezone : 'UTC'); - #set_include_path("include/$this->hostname" . PATH_SEPARATOR . get_include_path()); - - if((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,9) === "pagename=") { - $this->query_string = substr($_SERVER['QUERY_STRING'],9); - // removing trailing / - maybe a nginx problem - if (substr($this->query_string, 0, 1) == "/") - $this->query_string = substr($this->query_string, 1); - } elseif((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,2) === "q=") { - $this->query_string = substr($_SERVER['QUERY_STRING'],2); - // removing trailing / - maybe a nginx problem - if (substr($this->query_string, 0, 1) == "/") - $this->query_string = substr($this->query_string, 1); - } + date_default_timezone_set($this->timezone); - if (x($_GET,'pagename')) - $this->cmd = trim($_GET['pagename'],'/\\'); - elseif (x($_GET,'q')) - $this->cmd = trim($_GET['q'],'/\\'); + $this->performance["start"] = microtime(true); + $this->performance["database"] = 0; + $this->performance["network"] = 0; + $this->performance["file"] = 0; + $this->performance["rendering"] = 0; + $this->performance["parser"] = 0; + $this->performance["marktime"] = 0; + $this->performance["markstart"] = microtime(true); + $this->config = array(); + $this->page = array(); + $this->pager= array(); - // fix query_string - $this->query_string = str_replace($this->cmd."&",$this->cmd."?", $this->query_string); + $this->query_string = ''; + startup(); - // unix style "homedir" + set_include_path( + 'include' . PATH_SEPARATOR + . 'library' . PATH_SEPARATOR + . 'library/phpsec' . PATH_SEPARATOR + . 'library/langdet' . PATH_SEPARATOR + . '.' ); - if(substr($this->cmd,0,1) === '~') - $this->cmd = 'profile/' . substr($this->cmd,1); - // Diaspora style profile url + $this->scheme = 'http'; + if(x($_SERVER,'HTTPS') && $_SERVER['HTTPS']) + $this->scheme = 'https'; + elseif(x($_SERVER,'SERVER_PORT') && (intval($_SERVER['SERVER_PORT']) == 443)) + $this->scheme = 'https'; - if(substr($this->cmd,0,2) === 'u/') - $this->cmd = 'profile/' . substr($this->cmd,2); + if(x($_SERVER,'SERVER_NAME')) { + $this->hostname = $_SERVER['SERVER_NAME']; + // See bug 437 - this didn't work so disabling it + //if(stristr($this->hostname,'xn--')) { + // PHP or webserver may have converted idn to punycode, so + // convert punycode back to utf-8 + // require_once('library/simplepie/idn/idna_convert.class.php'); + // $x = new idna_convert(); + // $this->hostname = $x->decode($_SERVER['SERVER_NAME']); + //} + if(x($_SERVER,'SERVER_PORT') && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) + $this->hostname .= ':' . $_SERVER['SERVER_PORT']; /** - * - * Break the URL path into C style argc/argv style arguments for our - * modules. Given "http://example.com/module/arg1/arg2", $this->argc - * will be 3 (integer) and $this->argv will contain: - * [0] => 'module' - * [1] => 'arg1' - * [2] => 'arg2' - * - * - * There will always be one argument. If provided a naked domain - * URL, $this->argv[0] is set to "home". - * + * Figure out if we are running at the top of a domain + * or in a sub-directory and adjust accordingly */ - $this->argv = explode('/',$this->cmd); - $this->argc = count($this->argv); - if((array_key_exists('0',$this->argv)) && strlen($this->argv[0])) { - $this->module = str_replace(".", "_", $this->argv[0]); - $this->module = str_replace("-", "_", $this->module); - } - else { - $this->argc = 1; - $this->argv = array('home'); - $this->module = 'home'; - } + $path = trim(dirname($_SERVER['SCRIPT_NAME']),'/\\'); + if(isset($path) && strlen($path) && ($path != $this->path)) + $this->path = $path; + } - /** - * See if there is any page number information, and initialise - * pagination - */ + if ($hostname != "") + $this->hostname = $hostname; - $this->pager['page'] = ((x($_GET,'page') && intval($_GET['page']) > 0) ? intval($_GET['page']) : 1); - $this->pager['itemspage'] = 50; - $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage']; - if($this->pager['start'] < 0) - $this->pager['start'] = 0; - $this->pager['total'] = 0; + if (is_array($_SERVER["argv"]) && $_SERVER["argc"]>1 && substr(end($_SERVER["argv"]), 0, 4)=="http" ) { + $this->set_baseurl(array_pop($_SERVER["argv"]) ); + $_SERVER["argc"] --; + } - /** - * Detect mobile devices - */ + #set_include_path("include/$this->hostname" . PATH_SEPARATOR . get_include_path()); + + if((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,9) === "pagename=") { + $this->query_string = substr($_SERVER['QUERY_STRING'],9); + // removing trailing / - maybe a nginx problem + if (substr($this->query_string, 0, 1) == "/") + $this->query_string = substr($this->query_string, 1); + } elseif((x($_SERVER,'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'],0,2) === "q=") { + $this->query_string = substr($_SERVER['QUERY_STRING'],2); + // removing trailing / - maybe a nginx problem + if (substr($this->query_string, 0, 1) == "/") + $this->query_string = substr($this->query_string, 1); + } - $mobile_detect = new Mobile_Detect(); - $this->is_mobile = $mobile_detect->isMobile(); - $this->is_tablet = $mobile_detect->isTablet(); + if (x($_GET,'pagename')) + $this->cmd = trim($_GET['pagename'],'/\\'); + elseif (x($_GET,'q')) + $this->cmd = trim($_GET['q'],'/\\'); - // Friendica-Client - $this->is_friendica_app = ($_SERVER['HTTP_USER_AGENT'] == "Apache-HttpClient/UNAVAILABLE (java 1.4)"); - /** - * register template engines - */ - $dc = get_declared_classes(); - foreach ($dc as $k) { - if (in_array("ITemplateEngine", class_implements($k))){ - $this->register_template_engine($k); - } - } + // fix query_string + $this->query_string = str_replace($this->cmd."&",$this->cmd."?", $this->query_string); - } - function get_basepath() { + // unix style "homedir" - $basepath = get_config("system", "basepath"); + if(substr($this->cmd,0,1) === '~') + $this->cmd = 'profile/' . substr($this->cmd,1); - if ($basepath == "") - $basepath = dirname(__FILE__); + // Diaspora style profile url - if ($basepath == "") - $basepath = $_SERVER["DOCUMENT_ROOT"]; + if(substr($this->cmd,0,2) === 'u/') + $this->cmd = 'profile/' . substr($this->cmd,2); - if ($basepath == "") - $basepath = $_SERVER["PWD"]; - return($basepath); - } + /** + * + * Break the URL path into C style argc/argv style arguments for our + * modules. Given "http://example.com/module/arg1/arg2", $this->argc + * will be 3 (integer) and $this->argv will contain: + * [0] => 'module' + * [1] => 'arg1' + * [2] => 'arg2' + * + * + * There will always be one argument. If provided a naked domain + * URL, $this->argv[0] is set to "home". + * + */ - function get_scheme() { - return($this->scheme); + $this->argv = explode('/',$this->cmd); + $this->argc = count($this->argv); + if((array_key_exists('0',$this->argv)) && strlen($this->argv[0])) { + $this->module = str_replace(".", "_", $this->argv[0]); + $this->module = str_replace("-", "_", $this->module); + } + else { + $this->argc = 1; + $this->argv = array('home'); + $this->module = 'home'; } - function get_baseurl($ssl = false) { + /** + * See if there is any page number information, and initialise + * pagination + */ - $scheme = $this->scheme; + $this->pager['page'] = ((x($_GET,'page') && intval($_GET['page']) > 0) ? intval($_GET['page']) : 1); + $this->pager['itemspage'] = 50; + $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage']; + if($this->pager['start'] < 0) + $this->pager['start'] = 0; + $this->pager['total'] = 0; - if((x($this->config,'system')) && (x($this->config['system'],'ssl_policy'))) { - if(intval($this->config['system']['ssl_policy']) === intval(SSL_POLICY_FULL)) - $scheme = 'https'; + /** + * Detect mobile devices + */ - // Basically, we have $ssl = true on any links which can only be seen by a logged in user - // (and also the login link). Anything seen by an outsider will have it turned off. + $mobile_detect = new Mobile_Detect(); + $this->is_mobile = $mobile_detect->isMobile(); + $this->is_tablet = $mobile_detect->isTablet(); - if($this->config['system']['ssl_policy'] == SSL_POLICY_SELFSIGN) { - if($ssl) - $scheme = 'https'; - else - $scheme = 'http'; - } + // Friendica-Client + $this->is_friendica_app = ($_SERVER['HTTP_USER_AGENT'] == "Apache-HttpClient/UNAVAILABLE (java 1.4)"); + + /** + * register template engines + */ + $dc = get_declared_classes(); + foreach ($dc as $k) { + if (in_array("ITemplateEngine", class_implements($k))){ + $this->register_template_engine($k); } + } - if (get_config('config','hostname') != "") - $this->hostname = get_config('config','hostname'); + } - $this->baseurl = $scheme . "://" . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' ); - return $this->baseurl; - } + function get_basepath() { - function set_baseurl($url) { - $parsed = @parse_url($url); + $basepath = get_config("system", "basepath"); - $this->baseurl = $url; + if ($basepath == "") + $basepath = dirname(__FILE__); - if($parsed) { - $this->scheme = $parsed['scheme']; + if ($basepath == "") + $basepath = $_SERVER["DOCUMENT_ROOT"]; - $hostname = $parsed['host']; - if(x($parsed,'port')) - $hostname .= ':' . $parsed['port']; - if(x($parsed,'path')) - $this->path = trim($parsed['path'],'\\/'); + if ($basepath == "") + $basepath = $_SERVER["PWD"]; - if (file_exists(".htpreconfig.php")) - @include(".htpreconfig.php"); + return($basepath); + } - if (get_config('config','hostname') != "") - $this->hostname = get_config('config','hostname'); + function get_scheme() { + return($this->scheme); + } - if (!isset($this->hostname) OR ($this->hostname == "")) - $this->hostname = $hostname; - } + function get_baseurl($ssl = false) { + + $scheme = $this->scheme; + + if((x($this->config,'system')) && (x($this->config['system'],'ssl_policy'))) { + if(intval($this->config['system']['ssl_policy']) === intval(SSL_POLICY_FULL)) + $scheme = 'https'; + // Basically, we have $ssl = true on any links which can only be seen by a logged in user + // (and also the login link). Anything seen by an outsider will have it turned off. + + if($this->config['system']['ssl_policy'] == SSL_POLICY_SELFSIGN) { + if($ssl) + $scheme = 'https'; + else + $scheme = 'http'; + } } - function get_hostname() { + if (get_config('config','hostname') != "") + $this->hostname = get_config('config','hostname'); + + $this->baseurl = $scheme . "://" . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' ); + return $this->baseurl; + } + + function set_baseurl($url) { + $parsed = @parse_url($url); + + $this->baseurl = $url; + + if($parsed) { + $this->scheme = $parsed['scheme']; + + $hostname = $parsed['host']; + if(x($parsed,'port')) + $hostname .= ':' . $parsed['port']; + if(x($parsed,'path')) + $this->path = trim($parsed['path'],'\\/'); + + if (file_exists(".htpreconfig.php")) + @include(".htpreconfig.php"); + if (get_config('config','hostname') != "") $this->hostname = get_config('config','hostname'); - return $this->hostname; + if (!isset($this->hostname) OR ($this->hostname == "")) + $this->hostname = $hostname; } - function set_hostname($h) { - $this->hostname = $h; - } + } - function set_path($p) { - $this->path = trim(trim($p),'/'); - } + function get_hostname() { + if (get_config('config','hostname') != "") + $this->hostname = get_config('config','hostname'); - function get_path() { - return $this->path; - } + return $this->hostname; + } - function set_pager_total($n) { - $this->pager['total'] = intval($n); - } + function set_hostname($h) { + $this->hostname = $h; + } - function set_pager_itemspage($n) { - $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0); - $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage']; - } + function set_path($p) { + $this->path = trim(trim($p),'/'); + } - function set_pager_page($n) { - $this->pager['page'] = $n; - $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage']; - } + function get_path() { + return $this->path; + } - function init_pagehead() { - $interval = ((local_user()) ? get_pconfig(local_user(),'system','update_interval') : 40000); + function set_pager_total($n) { + $this->pager['total'] = intval($n); + } - // If the update is "deactivated" set it to the highest integer number (~24 days) - if ($interval < 0) - $interval = 2147483647; + function set_pager_itemspage($n) { + $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0); + $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage']; + } - if($interval < 10000) - $interval = 40000; + function set_pager_page($n) { + $this->pager['page'] = $n; + $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage']; + } - // compose the page title from the sitename and the - // current module called - if (!$this->module=='') - { - $this->page['title'] = $this->config['sitename'].' ('.$this->module.')'; - } else { - $this->page['title'] = $this->config['sitename']; - } + function init_pagehead() { + $interval = ((local_user()) ? get_pconfig(local_user(),'system','update_interval') : 40000); - /* 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'); - else - $stylesheet = '$stylesheet'; - - $shortcut_icon = get_config("system", "shortcut_icon"); - if ($shortcut_icon == "") - $shortcut_icon = $this->get_baseurl()."/images/friendica-32.png"; - - $touch_icon = get_config("system", "touch_icon"); - if ($touch_icon == "") - $touch_icon = $this->get_baseurl()."/images/friendica-128.png"; - - $tpl = get_markup_template('head.tpl'); - $this->page['htmlhead'] = replace_macros($tpl,array( - '$baseurl' => $this->get_baseurl(), // FIXME for z_path!!!! - '$local_user' => local_user(), - '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION, - '$delitem' => t('Delete this item?'), - '$comment' => t('Comment'), - '$showmore' => t('show more'), - '$showfewer' => t('show fewer'), - '$update_interval' => $interval, - '$shortcut_icon' => $shortcut_icon, - '$touch_icon' => $touch_icon, - '$stylesheet' => $stylesheet - )) . $this->page['htmlhead']; - } + // If the update is "deactivated" set it to the highest integer number (~24 days) + if ($interval < 0) + $interval = 2147483647; - function init_page_end() { - if(!isset($this->page['end'])) - $this->page['end'] = ''; - $tpl = get_markup_template('end.tpl'); - $this->page['end'] = replace_macros($tpl,array( - '$baseurl' => $this->get_baseurl() // FIXME for z_path!!!! - )) . $this->page['end']; - } + if($interval < 10000) + $interval = 40000; - function set_curl_code($code) { - $this->curl_code = $code; + // compose the page title from the sitename and the + // current module called + if (!$this->module=='') + { + $this->page['title'] = $this->config['sitename'].' ('.$this->module.')'; + } else { + $this->page['title'] = $this->config['sitename']; } - function get_curl_code() { - return $this->curl_code; - } + /* 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'); + else + $stylesheet = '$stylesheet'; + + $shortcut_icon = get_config("system", "shortcut_icon"); + if ($shortcut_icon == "") + $shortcut_icon = $this->get_baseurl()."/images/friendica-32.png"; + + $touch_icon = get_config("system", "touch_icon"); + if ($touch_icon == "") + $touch_icon = $this->get_baseurl()."/images/friendica-128.png"; + + $tpl = get_markup_template('head.tpl'); + $this->page['htmlhead'] = replace_macros($tpl,array( + '$baseurl' => $this->get_baseurl(), // FIXME for z_path!!!! + '$local_user' => local_user(), + '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION, + '$delitem' => t('Delete this item?'), + '$comment' => t('Comment'), + '$showmore' => t('show more'), + '$showfewer' => t('show fewer'), + '$update_interval' => $interval, + '$shortcut_icon' => $shortcut_icon, + '$touch_icon' => $touch_icon, + '$stylesheet' => $stylesheet + )) . $this->page['htmlhead']; + } - function set_curl_content_type($content_type) { - $this->curl_content_type = $content_type; - } + function init_page_end() { + if(!isset($this->page['end'])) + $this->page['end'] = ''; + $tpl = get_markup_template('end.tpl'); + $this->page['end'] = replace_macros($tpl,array( + '$baseurl' => $this->get_baseurl() // FIXME for z_path!!!! + )) . $this->page['end']; + } - function get_curl_content_type() { - return $this->curl_content_type; - } + function set_curl_code($code) { + $this->curl_code = $code; + } - function set_curl_headers($headers) { - $this->curl_headers = $headers; - } + function get_curl_code() { + return $this->curl_code; + } - function get_curl_headers() { - return $this->curl_headers; - } + function set_curl_content_type($content_type) { + $this->curl_content_type = $content_type; + } - function get_cached_avatar_image($avatar_image){ - if($this->cached_profile_image[$avatar_image]) - return $this->cached_profile_image[$avatar_image]; + function get_curl_content_type() { + return $this->curl_content_type; + } - $path_parts = explode("/",$avatar_image); - $common_filename = $path_parts[count($path_parts)-1]; + function set_curl_headers($headers) { + $this->curl_headers = $headers; + } - if($this->cached_profile_picdate[$common_filename]){ - $this->cached_profile_image[$avatar_image] = $avatar_image . $this->cached_profile_picdate[$common_filename]; - } else { - $r = q("SELECT `contact`.`avatar-date` AS picdate FROM `contact` WHERE `contact`.`thumb` like '%%/%s'", - $common_filename); - if(! count($r)){ - $this->cached_profile_image[$avatar_image] = $avatar_image; - } else { - $this->cached_profile_picdate[$common_filename] = "?rev=".urlencode($r[0]['picdate']); - $this->cached_profile_image[$avatar_image] = $avatar_image.$this->cached_profile_picdate[$common_filename]; - } - } - return $this->cached_profile_image[$avatar_image]; - } + function get_curl_headers() { + return $this->curl_headers; + } + function get_cached_avatar_image($avatar_image){ + if($this->cached_profile_image[$avatar_image]) + return $this->cached_profile_image[$avatar_image]; - /** - * register template engine class - * if $name is "", is used class static property $class::$name - * @param string $class - * @param string $name - */ - function register_template_engine($class, $name = '') { - if ($name===""){ - $v = get_class_vars( $class ); - if(x($v,"name")) $name = $v['name']; - } - if ($name===""){ - echo "template engine $class cannot be registered without a name.\n"; - killme(); - } - $this->template_engines[$name] = $class; - } + $path_parts = explode("/",$avatar_image); + $common_filename = $path_parts[count($path_parts)-1]; - /** - * return template engine instance. If $name is not defined, - * return engine defined by theme, or default - * - * @param strin $name Template engine name - * @return object Template Engine instance - */ - function template_engine($name = ''){ - if ($name!=="") { - $template_engine = $name; + if($this->cached_profile_picdate[$common_filename]){ + $this->cached_profile_image[$avatar_image] = $avatar_image . $this->cached_profile_picdate[$common_filename]; + } else { + $r = q("SELECT `contact`.`avatar-date` AS picdate FROM `contact` WHERE `contact`.`thumb` like '%%/%s'", + $common_filename); + if(! count($r)){ + $this->cached_profile_image[$avatar_image] = $avatar_image; } else { - $template_engine = 'smarty3'; - if (x($this->theme, 'template_engine')) { - $template_engine = $this->theme['template_engine']; - } + $this->cached_profile_picdate[$common_filename] = "?rev=".urlencode($r[0]['picdate']); + $this->cached_profile_image[$avatar_image] = $avatar_image.$this->cached_profile_picdate[$common_filename]; } + } + return $this->cached_profile_image[$avatar_image]; + } - if (isset($this->template_engines[$template_engine])){ - if(isset($this->template_engine_instance[$template_engine])){ - return $this->template_engine_instance[$template_engine]; - } else { - $class = $this->template_engines[$template_engine]; - $obj = new $class; - $this->template_engine_instance[$template_engine] = $obj; - return $obj; - } - } - echo "template engine $template_engine is not registered!\n"; killme(); + /** + * @brief Register template engine class + * + * If $name is "", is used class static property $class::$name + * + * @param string $class + * @param string $name + */ + function register_template_engine($class, $name = '') { + if ($name===""){ + $v = get_class_vars( $class ); + if(x($v,"name")) $name = $v['name']; } - - function get_template_engine() { - return $this->theme['template_engine']; + if ($name===""){ + echo "template engine $class cannot be registered without a name.\n"; + killme(); } + $this->template_engines[$name] = $class; + } - function set_template_engine($engine = 'smarty3') { - $this->theme['template_engine'] = $engine; - /* - $this->theme['template_engine'] = 'smarty3'; - - switch($engine) { - case 'smarty3': - if(is_writable('view/smarty3/')) - $this->theme['template_engine'] = 'smarty3'; - break; - default: - break; + /** + * @brief Return template engine instance. + * + * If $name is not defined, return engine defined by theme, + * or default + * + * @param strin $name Template engine name + * @return object Template Engine instance + */ + function template_engine($name = ''){ + if ($name!=="") { + $template_engine = $name; + } else { + $template_engine = 'smarty3'; + if (x($this->theme, 'template_engine')) { + $template_engine = $this->theme['template_engine']; } - */ } - function get_template_ldelim($engine = 'smarty3') { - return $this->ldelim[$engine]; + if (isset($this->template_engines[$template_engine])){ + if(isset($this->template_engine_instance[$template_engine])){ + return $this->template_engine_instance[$template_engine]; + } else { + $class = $this->template_engines[$template_engine]; + $obj = new $class; + $this->template_engine_instance[$template_engine] = $obj; + return $obj; + } } - function get_template_rdelim($engine = 'smarty3') { - return $this->rdelim[$engine]; - } + echo "template engine $template_engine is not registered!\n"; killme(); + } - function save_timestamp($stamp, $value) { - $duration = (float)(microtime(true)-$stamp); + /** + * @brief Returns the active template engine. + * + * @return string + */ + function get_template_engine() { + return $this->theme['template_engine']; + } - $this->performance[$value] += (float)$duration; - $this->performance["marktime"] += (float)$duration; + function set_template_engine($engine = 'smarty3') { + $this->theme['template_engine'] = $engine; + /* + $this->theme['template_engine'] = 'smarty3'; + + switch($engine) { + case 'smarty3': + if(is_writable('view/smarty3/')) + $this->theme['template_engine'] = 'smarty3'; + break; + default: + break; } + */ + } - function mark_timestamp($mark) { - //$this->performance["markstart"] -= microtime(true) - $this->performance["marktime"]; - $this->performance["markstart"] = microtime(true) - $this->performance["markstart"] - $this->performance["marktime"]; - } + function get_template_ldelim($engine = 'smarty3') { + return $this->ldelim[$engine]; + } - function get_useragent() { - return(FRIENDICA_PLATFORM." '".FRIENDICA_CODENAME."' ".FRIENDICA_VERSION."-".DB_UPDATE_VERSION."; ".$this->get_baseurl()); - } + function get_template_rdelim($engine = 'smarty3') { + return $this->rdelim[$engine]; + } - function is_friendica_app() { - return($this->is_friendica_app); - } + function save_timestamp($stamp, $value) { + $duration = (float)(microtime(true)-$stamp); + $this->performance[$value] += (float)$duration; + $this->performance["marktime"] += (float)$duration; } -} -// retrieve the App structure -// useful in functions which require it but don't get it passed to them + function mark_timestamp($mark) { + //$this->performance["markstart"] -= microtime(true) - $this->performance["marktime"]; + $this->performance["markstart"] = microtime(true) - $this->performance["markstart"] - $this->performance["marktime"]; + } + + function get_useragent() { + return(FRIENDICA_PLATFORM." '".FRIENDICA_CODENAME."' ".FRIENDICA_VERSION."-".DB_UPDATE_VERSION."; ".$this->get_baseurl()); + } -if(! function_exists('get_app')) { - function get_app() { - global $a; - return $a; + function is_friendica_app() { + return($this->is_friendica_app); } -}; +} -// Multi-purpose function to check variable state. -// Usage: x($var) or $x($array,'key') -// returns false if variable/key is not set -// if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0. -// e.g. x('') or x(0) returns 0; +/** + * @brief Retrieve the App structure + * + * Useful in functions which require it but don't get it passed to them + */ +function get_app() { + global $a; + return $a; +} -if(! function_exists('x')) { - function x($s,$k = NULL) { - if($k != NULL) { - if((is_array($s)) && (array_key_exists($k,$s))) { - if($s[$k]) - return (int) 1; - return (int) 0; - } - return false; - } - else { - if(isset($s)) { - if($s) { - return (int) 1; - } - return (int) 0; + +/** + * @brief Multi-purpose function to check variable state. + * + * Usage: x($var) or $x($array, 'key') + * + * returns false if variable/key is not set + * if variable is set, returns 1 if has 'non-zero' value, otherwise returns 0. + * e.g. x('') or x(0) returns 0; + * + * @param string|array $s variable to check + * @param string $k key inside the array to check + * + * @return bool|int + */ +function x($s,$k = NULL) { + if($k != NULL) { + if((is_array($s)) && (array_key_exists($k,$s))) { + if($s[$k]) + return (int) 1; + return (int) 0; + } + return false; + } + else { + if(isset($s)) { + if($s) { + return (int) 1; } - return false; + return (int) 0; } + return false; } } -// called from db initialisation if db is dead. -if(! function_exists('system_unavailable')) { - function system_unavailable() { - include('system_unavailable.php'); - system_down(); - killme(); - } +/** + * @brief Called from db initialisation if db is dead. + */ +function system_unavailable() { + include('system_unavailable.php'); + system_down(); + killme(); } - function clean_urls() { global $a; // if($a->config['system']['clean_urls']) @@ -1016,17 +1054,36 @@ function z_path() { return $base; } +/** + * @brief Returns the baseurl. + * + * @see App::get_baseurl() + * + * @return string + */ function z_root() { global $a; return $a->get_baseurl(); } +/** + * @brief Return absolut URL for given $path. + * + * @param string $path + * + * @return string + */ function absurl($path) { if(strpos($path,'/') === 0) return z_path() . $path; return $path; } +/** + * @brief Function to check if request was an AJAX (xmlhttprequest) request. + * + * @return boolean + */ function is_ajax() { return (!empty($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest'); } @@ -1044,197 +1101,190 @@ function check_db() { } +/** + * Sets the base url for use in cmdline programs which don't have + * $_SERVER variables + */ +function check_url(&$a) { + + $url = get_config('system','url'); + + // if the url isn't set or the stored url is radically different + // than the currently visited url, store the current value accordingly. + // "Radically different" ignores common variations such as http vs https + // and www.example.com vs example.com. + // We will only change the url to an ip address if there is no existing setting + + if(! x($url)) + $url = set_config('system','url',$a->get_baseurl()); + if((! link_compare($url,$a->get_baseurl())) && (! preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/",$a->get_hostname))) + $url = set_config('system','url',$a->get_baseurl()); + + return; +} + + +/** + * @brief Automatic database updates + */ +function update_db(&$a) { + $build = get_config('system','build'); + if(! x($build)) + $build = set_config('system','build',DB_UPDATE_VERSION); + if($build != DB_UPDATE_VERSION) { + $stored = intval($build); + $current = intval(DB_UPDATE_VERSION); + if($stored < $current) { + load_config('database'); -// Sets the base url for use in cmdline programs which don't have -// $_SERVER variables + // We're reporting a different version than what is currently installed. + // Run any existing update scripts to bring the database up to current. -if(! function_exists('check_url')) { - function check_url(&$a) { + // make sure that boot.php and update.php are the same release, we might be + // updating right this very second and the correct version of the update.php + // file may not be here yet. This can happen on a very busy site. - $url = get_config('system','url'); + if(DB_UPDATE_VERSION == UPDATE_VERSION) { + // Compare the current structure with the defined structure - // if the url isn't set or the stored url is radically different - // than the currently visited url, store the current value accordingly. - // "Radically different" ignores common variations such as http vs https - // and www.example.com vs example.com. - // We will only change the url to an ip address if there is no existing setting + $t = get_config('database','dbupdate_'.DB_UPDATE_VERSION); + if($t !== false) + return; - if(! x($url)) - $url = set_config('system','url',$a->get_baseurl()); - if((! link_compare($url,$a->get_baseurl())) && (! preg_match("/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/",$a->get_hostname))) - $url = set_config('system','url',$a->get_baseurl()); + set_config('database','dbupdate_'.DB_UPDATE_VERSION, time()); - return; - } -} + // run old update routine (wich could modify the schema and + // conflits with new routine) + for ($x = $stored; $x < NEW_UPDATE_ROUTINE_VERSION; $x++) { + $r = run_update_function($x); + if (!$r) break; + } + if ($stored < NEW_UPDATE_ROUTINE_VERSION) $stored = NEW_UPDATE_ROUTINE_VERSION; -// Automatic database updates - -if(! function_exists('update_db')) { - function update_db(&$a) { - $build = get_config('system','build'); - if(! x($build)) - $build = set_config('system','build',DB_UPDATE_VERSION); - - if($build != DB_UPDATE_VERSION) { - $stored = intval($build); - $current = intval(DB_UPDATE_VERSION); - if($stored < $current) { - load_config('database'); - - // We're reporting a different version than what is currently installed. - // Run any existing update scripts to bring the database up to current. - - // make sure that boot.php and update.php are the same release, we might be - // updating right this very second and the correct version of the update.php - // file may not be here yet. This can happen on a very busy site. - - if(DB_UPDATE_VERSION == UPDATE_VERSION) { - // Compare the current structure with the defined structure - - $t = get_config('database','dbupdate_'.DB_UPDATE_VERSION); - if($t !== false) - return; - - set_config('database','dbupdate_'.DB_UPDATE_VERSION, time()); - - // run old update routine (wich could modify the schema and - // conflits with new routine) - for ($x = $stored; $x < NEW_UPDATE_ROUTINE_VERSION; $x++) { - $r = run_update_function($x); - if (!$r) break; - } - if ($stored < NEW_UPDATE_ROUTINE_VERSION) $stored = NEW_UPDATE_ROUTINE_VERSION; - - - // run new update routine - // it update the structure in one call - $retval = update_structure(false, true); - if($retval) { - update_fail( - DB_UPDATE_VERSION, - $retval - ); - return; - } else { - set_config('database','dbupdate_'.DB_UPDATE_VERSION, 'success'); - } - - // run any left update_nnnn functions in update.php - for($x = $stored; $x < $current; $x ++) { - $r = run_update_function($x); - if (!$r) break; - } + // run new update routine + // it update the structure in one call + $retval = update_structure(false, true); + if($retval) { + update_fail( + DB_UPDATE_VERSION, + $retval + ); + return; + } else { + set_config('database','dbupdate_'.DB_UPDATE_VERSION, 'success'); + } + + // run any left update_nnnn functions in update.php + for($x = $stored; $x < $current; $x ++) { + $r = run_update_function($x); + if (!$r) break; } } } - - return; } + + return; } -if(!function_exists('run_update_function')){ - function run_update_function($x) { - if(function_exists('update_' . $x)) { - - // There could be a lot of processes running or about to run. - // We want exactly one process to run the update command. - // So store the fact that we're taking responsibility - // after first checking to see if somebody else already has. - - // If the update fails or times-out completely you may need to - // delete the config entry to try again. - - $t = get_config('database','update_' . $x); - if($t !== false) - return false; - set_config('database','update_' . $x, time()); - - // call the specific update - - $func = 'update_' . $x; - $retval = $func(); - - if($retval) { - //send the administrator an e-mail - update_fail( - $x, - sprintf(t('Update %s failed. See error logs.'), $x) - ); - return false; - } else { - set_config('database','update_' . $x, 'success'); - set_config('system','build', $x + 1); - return true; - } + +function run_update_function($x) { + if(function_exists('update_' . $x)) { + + // There could be a lot of processes running or about to run. + // We want exactly one process to run the update command. + // So store the fact that we're taking responsibility + // after first checking to see if somebody else already has. + + // If the update fails or times-out completely you may need to + // delete the config entry to try again. + + $t = get_config('database','update_' . $x); + if($t !== false) + return false; + set_config('database','update_' . $x, time()); + + // call the specific update + + $func = 'update_' . $x; + $retval = $func(); + + if($retval) { + //send the administrator an e-mail + update_fail( + $x, + sprintf(t('Update %s failed. See error logs.'), $x) + ); + return false; } else { set_config('database','update_' . $x, 'success'); set_config('system','build', $x + 1); return true; } + } else { + set_config('database','update_' . $x, 'success'); + set_config('system','build', $x + 1); return true; } + return true; } -if(! function_exists('check_plugins')) { - function check_plugins(&$a) { +function check_plugins(&$a) { - /** - * - * Synchronise plugins: - * - * $a->config['system']['addon'] contains a comma-separated list of names - * of plugins/addons which are used on this system. - * Go through the database list of already installed addons, and if we have - * an entry, but it isn't in the config list, call the uninstall procedure - * and mark it uninstalled in the database (for now we'll remove it). - * Then go through the config list and if we have a plugin that isn't installed, - * call the install procedure and add it to the database. - * - */ + /** + * + * Synchronise plugins: + * + * $a->config['system']['addon'] contains a comma-separated list of names + * of plugins/addons which are used on this system. + * Go through the database list of already installed addons, and if we have + * an entry, but it isn't in the config list, call the uninstall procedure + * and mark it uninstalled in the database (for now we'll remove it). + * Then go through the config list and if we have a plugin that isn't installed, + * call the install procedure and add it to the database. + * + */ - $r = q("SELECT * FROM `addon` WHERE `installed` = 1"); - if(count($r)) - $installed = $r; - else - $installed = array(); + $r = q("SELECT * FROM `addon` WHERE `installed` = 1"); + if(count($r)) + $installed = $r; + else + $installed = array(); - $plugins = get_config('system','addon'); - $plugins_arr = array(); + $plugins = get_config('system','addon'); + $plugins_arr = array(); - if($plugins) - $plugins_arr = explode(',',str_replace(' ', '',$plugins)); + if($plugins) + $plugins_arr = explode(',',str_replace(' ', '',$plugins)); - $a->plugins = $plugins_arr; + $a->plugins = $plugins_arr; - $installed_arr = array(); + $installed_arr = array(); - if(count($installed)) { - foreach($installed as $i) { - if(! in_array($i['name'],$plugins_arr)) { - uninstall_plugin($i['name']); - } - else { - $installed_arr[] = $i['name']; - } + if(count($installed)) { + foreach($installed as $i) { + if(! in_array($i['name'],$plugins_arr)) { + uninstall_plugin($i['name']); + } + else { + $installed_arr[] = $i['name']; } } + } - if(count($plugins_arr)) { - foreach($plugins_arr as $p) { - if(! in_array($p,$installed_arr)) { - install_plugin($p); - } + if(count($plugins_arr)) { + foreach($plugins_arr as $p) { + if(! in_array($p,$installed_arr)) { + install_plugin($p); } } + } - load_hooks(); + load_hooks(); - return; - } + return; } function get_guid($size=16, $prefix = "") { @@ -1256,158 +1306,158 @@ function get_guid($size=16, $prefix = "") { } } -// wrapper for adding a login box. If $register == true provide a registration -// link. This will most always depend on the value of $a->config['register_policy']. -// returns the complete html for inserting into the page - -if(! function_exists('login')) { - function login($register = false, $hiddens=false) { - $a = get_app(); - $o = ""; - $reg = false; - if ($register) { - $reg = array( - 'title' => t('Create a New Account'), - 'desc' => t('Register') - ); - } +/** + * @brief Wrapper for adding a login box. + * + * @param bool $register + * If $register == true provide a registration link. + * This will most always depend on the value of $a->config['register_policy']. + * @param bool $hiddens + * + * @return string + * Returns the complete html for inserting into the page + */ +function login($register = false, $hiddens=false) { + $a = get_app(); + $o = ""; + $reg = false; + if ($register) { + $reg = array( + 'title' => t('Create a New Account'), + 'desc' => t('Register') + ); + } - $noid = get_config('system','no_openid'); + $noid = get_config('system','no_openid'); - $dest_url = $a->get_baseurl(true) . '/' . $a->query_string; + $dest_url = $a->get_baseurl(true) . '/' . $a->query_string; - if(local_user()) { - $tpl = get_markup_template("logout.tpl"); - } - else { - $a->page['htmlhead'] .= replace_macros(get_markup_template("login_head.tpl"),array( - '$baseurl' => $a->get_baseurl(true) - )); + if(local_user()) { + $tpl = get_markup_template("logout.tpl"); + } + else { + $a->page['htmlhead'] .= replace_macros(get_markup_template("login_head.tpl"),array( + '$baseurl' => $a->get_baseurl(true) + )); - $tpl = get_markup_template("login.tpl"); - $_SESSION['return_url'] = $a->query_string; - $a->module = 'login'; - } + $tpl = get_markup_template("login.tpl"); + $_SESSION['return_url'] = $a->query_string; + $a->module = 'login'; + } - $o .= replace_macros($tpl, array( + $o .= replace_macros($tpl, array( - '$dest_url' => $dest_url, - '$logout' => t('Logout'), - '$login' => t('Login'), + '$dest_url' => $dest_url, + '$logout' => t('Logout'), + '$login' => t('Login'), - '$lname' => array('username', t('Nickname or Email address: ') , '', ''), - '$lpassword' => array('password', t('Password: '), '', ''), - '$lremember' => array('remember', t('Remember me'), 0, ''), + '$lname' => array('username', t('Nickname or Email address: ') , '', ''), + '$lpassword' => array('password', t('Password: '), '', ''), + '$lremember' => array('remember', t('Remember me'), 0, ''), - '$openid' => !$noid, - '$lopenid' => array('openid_url', t('Or login using OpenID: '),'',''), + '$openid' => !$noid, + '$lopenid' => array('openid_url', t('Or login using OpenID: '),'',''), - '$hiddens' => $hiddens, + '$hiddens' => $hiddens, - '$register' => $reg, + '$register' => $reg, - '$lostpass' => t('Forgot your password?'), - '$lostlink' => t('Password Reset'), + '$lostpass' => t('Forgot your password?'), + '$lostlink' => t('Password Reset'), - '$tostitle' => t('Website Terms of Service'), - '$toslink' => t('terms of service'), + '$tostitle' => t('Website Terms of Service'), + '$toslink' => t('terms of service'), - '$privacytitle' => t('Website Privacy Policy'), - '$privacylink' => t('privacy policy'), + '$privacytitle' => t('Website Privacy Policy'), + '$privacylink' => t('privacy policy'), - )); + )); - call_hooks('login_hook',$o); + call_hooks('login_hook',$o); - return $o; - } + return $o; } -// Used to end the current process, after saving session state. - -if(! function_exists('killme')) { - function killme() { - session_write_close(); - exit; - } +/** + * @brief Used to end the current process, after saving session state. + */ +function killme() { + session_write_close(); + exit; } -// redirect to another URL and terminate this process. - -if(! function_exists('goaway')) { - function goaway($s) { - header("Location: $s"); - killme(); - } +/** + * @brief Redirect to another URL and terminate this process. + */ +function goaway($s) { + header("Location: $s"); + killme(); } -// Returns the uid of locally logged in user or false. - -if(! function_exists('local_user')) { - function local_user() { - if((x($_SESSION,'authenticated')) && (x($_SESSION,'uid'))) - return intval($_SESSION['uid']); - return false; - } +/** + * @brief Returns the user id of locally logged in user or false. + * + * @return int|bool user id or false + */ +function local_user() { + if((x($_SESSION,'authenticated')) && (x($_SESSION,'uid'))) + return intval($_SESSION['uid']); + return false; } -// Returns contact id of authenticated site visitor or false - -if(! function_exists('remote_user')) { - function remote_user() { - if((x($_SESSION,'authenticated')) && (x($_SESSION,'visitor_id'))) - return intval($_SESSION['visitor_id']); - return false; - } +/** +/* @brief Returns contact id of authenticated site visitor or false + * + * @return int|bool visitor_id or false + */ +function remote_user() { + if((x($_SESSION,'authenticated')) && (x($_SESSION,'visitor_id'))) + return intval($_SESSION['visitor_id']); + return false; } -// contents of $s are displayed prominently on the page the next time -// a page is loaded. Usually used for errors or alerts. - -if(! function_exists('notice')) { - /** - * Show an error message to user. - * - * This function save text in session, to be shown to the user at next page load - * - * @param string $s - Text of notice - */ - function notice($s) { - $a = get_app(); - if(! x($_SESSION,'sysmsg')) $_SESSION['sysmsg'] = array(); - if($a->interactive) - $_SESSION['sysmsg'][] = $s; - } +/** + * @brief Show an error message to user. + * + * This function save text in session, to be shown to the user at next page load + * + * @param string $s - Text of notice + */ +function notice($s) { + $a = get_app(); + if(! x($_SESSION,'sysmsg')) $_SESSION['sysmsg'] = array(); + if($a->interactive) + $_SESSION['sysmsg'][] = $s; } -if(! function_exists('info')) { - /** - * Show an info message to user. - * - * This function save text in session, to be shown to the user at next page load - * - * @param string $s - Text of notice - */ - function info($s) { - $a = get_app(); - if (local_user() AND get_pconfig(local_user(),'system','ignore_info')) - return; +/** + * @brief Show an info message to user. + * + * This function save text in session, to be shown to the user at next page load + * + * @param string $s - Text of notice + */ +function info($s) { + $a = get_app(); - if(! x($_SESSION,'sysmsg_info')) $_SESSION['sysmsg_info'] = array(); - if($a->interactive) - $_SESSION['sysmsg_info'][] = $s; - } -} + if (local_user() AND get_pconfig(local_user(),'system','ignore_info')) + return; + if(! x($_SESSION,'sysmsg_info')) $_SESSION['sysmsg_info'] = array(); + if($a->interactive) + $_SESSION['sysmsg_info'][] = $s; +} -// wrapper around config to limit the text length of an incoming message -if(! function_exists('get_max_import_size')) { - function get_max_import_size() { - global $a; - return ((x($a->config,'max_import_size')) ? $a->config['max_import_size'] : 0 ); - } +/** + * @brief Wrapper around config to limit the text length of an incoming message + * + * @return int + */ +function get_max_import_size() { + global $a; + return ((x($a->config,'max_import_size')) ? $a->config['max_import_size'] : 0 ); } /** @@ -1423,285 +1473,282 @@ if(! function_exists('get_max_import_size')) { * * $cmd and string args are surrounded with "" */ +function proc_run($cmd){ -if(! function_exists('proc_run')) { - function proc_run($cmd){ - - $a = get_app(); + $a = get_app(); - $args = func_get_args(); + $args = func_get_args(); - $newargs = array(); - if(! count($args)) - return; + $newargs = array(); + if(! count($args)) + return; - // expand any arrays + // expand any arrays - foreach($args as $arg) { - if(is_array($arg)) { - foreach($arg as $n) { - $newargs[] = $n; - } + foreach($args as $arg) { + if(is_array($arg)) { + foreach($arg as $n) { + $newargs[] = $n; } - else - $newargs[] = $arg; } + else + $newargs[] = $arg; + } - $args = $newargs; - - $arr = array('args' => $args, 'run_cmd' => true); + $args = $newargs; - call_hooks("proc_run", $arr); - if(! $arr['run_cmd']) - return; + $arr = array('args' => $args, 'run_cmd' => true); - if(count($args) && $args[0] === 'php') { + call_hooks("proc_run", $arr); + if(! $arr['run_cmd']) + return; - if (get_config("system", "worker")) { - $argv = $args; - array_shift($argv); + if(count($args) && $args[0] === 'php') { - $parameters = json_encode($argv); - $found = q("SELECT `id` FROM `workerqueue` WHERE `parameter` = '%s'", - dbesc($parameters)); + if (get_config("system", "worker")) { + $argv = $args; + array_shift($argv); - if (!$found) - q("INSERT INTO `workerqueue` (`parameter`, `created`, `priority`) - VALUES ('%s', '%s', %d)", - dbesc($parameters), - dbesc(datetime_convert()), - intval(0)); + $parameters = json_encode($argv); + $found = q("SELECT `id` FROM `workerqueue` WHERE `parameter` = '%s'", + dbesc($parameters)); - // Should we quit and wait for the poller to be called as a cronjob? - if (get_config("system", "worker_dont_fork")) - return; + if (!$found) + q("INSERT INTO `workerqueue` (`parameter`, `created`, `priority`) + VALUES ('%s', '%s', %d)", + dbesc($parameters), + dbesc(datetime_convert()), + intval(0)); - // Checking number of workers - $workers = q("SELECT COUNT(*) AS `workers` FROM `workerqueue` WHERE `executed` != '0000-00-00 00:00:00'"); + // Should we quit and wait for the poller to be called as a cronjob? + if (get_config("system", "worker_dont_fork")) + return; - // Get number of allowed number of worker threads - $queues = intval(get_config("system", "worker_queues")); + // Checking number of workers + $workers = q("SELECT COUNT(*) AS `workers` FROM `workerqueue` WHERE `executed` != '0000-00-00 00:00:00'"); - if ($queues == 0) - $queues = 4; + // Get number of allowed number of worker threads + $queues = intval(get_config("system", "worker_queues")); - // If there are already enough workers running, don't fork another one - if ($workers[0]["workers"] >= $queues) - return; + if ($queues == 0) + $queues = 4; - // Now call the poller to execute the jobs that we just added to the queue - $args = array("php", "include/poller.php", "no_cron"); - } + // If there are already enough workers running, don't fork another one + if ($workers[0]["workers"] >= $queues) + return; - $args[0] = ((x($a->config,'php_path')) && (strlen($a->config['php_path'])) ? $a->config['php_path'] : 'php'); + // Now call the poller to execute the jobs that we just added to the queue + $args = array("php", "include/poller.php", "no_cron"); } - // add baseurl to args. cli scripts can't construct it - $args[] = $a->get_baseurl(); + $args[0] = ((x($a->config,'php_path')) && (strlen($a->config['php_path'])) ? $a->config['php_path'] : 'php'); + } - for($x = 0; $x < count($args); $x ++) - $args[$x] = escapeshellarg($args[$x]); + // add baseurl to args. cli scripts can't construct it + $args[] = $a->get_baseurl(); - $cmdline = implode($args," "); + for($x = 0; $x < count($args); $x ++) + $args[$x] = escapeshellarg($args[$x]); - if(get_config('system','proc_windows')) - proc_close(proc_open('cmd /c start /b ' . $cmdline,array(),$foo,dirname(__FILE__))); - else - proc_close(proc_open($cmdline." &",array(),$foo,dirname(__FILE__))); - } + $cmdline = implode($args," "); + + if(get_config('system','proc_windows')) + proc_close(proc_open('cmd /c start /b ' . $cmdline,array(),$foo,dirname(__FILE__))); + else + proc_close(proc_open($cmdline." &",array(),$foo,dirname(__FILE__))); } -if(! function_exists('current_theme')) { - function current_theme(){ - $app_base_themes = array('duepuntozero', 'dispy', 'quattro'); +function current_theme(){ + $app_base_themes = array('duepuntozero', 'dispy', 'quattro'); - $a = get_app(); + $a = get_app(); - $page_theme = null; + $page_theme = null; - // Find the theme that belongs to the user whose stuff we are looking at + // Find the theme that belongs to the user whose stuff we are looking at - if($a->profile_uid && ($a->profile_uid != local_user())) { - $r = q("select theme from user where uid = %d limit 1", - intval($a->profile_uid) - ); - if($r) - $page_theme = $r[0]['theme']; - } + if($a->profile_uid && ($a->profile_uid != local_user())) { + $r = q("select theme from user where uid = %d limit 1", + intval($a->profile_uid) + ); + if($r) + $page_theme = $r[0]['theme']; + } - // Allow folks to over-rule user themes and always use their own on their own site. - // This works only if the user is on the same server + // Allow folks to over-rule user themes and always use their own on their own site. + // This works only if the user is on the same server - if($page_theme && local_user() && (local_user() != $a->profile_uid)) { - if(get_pconfig(local_user(),'system','always_my_theme')) - $page_theme = null; - } + if($page_theme && local_user() && (local_user() != $a->profile_uid)) { + if(get_pconfig(local_user(),'system','always_my_theme')) + $page_theme = null; + } // $mobile_detect = new Mobile_Detect(); // $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet(); - $is_mobile = $a->is_mobile || $a->is_tablet; + $is_mobile = $a->is_mobile || $a->is_tablet; - $standard_system_theme = ((isset($a->config['system']['theme'])) ? $a->config['system']['theme'] : ''); - $standard_theme_name = ((isset($_SESSION) && x($_SESSION,'theme')) ? $_SESSION['theme'] : $standard_system_theme); + $standard_system_theme = ((isset($a->config['system']['theme'])) ? $a->config['system']['theme'] : ''); + $standard_theme_name = ((isset($_SESSION) && x($_SESSION,'theme')) ? $_SESSION['theme'] : $standard_system_theme); + + if($is_mobile) { + if(isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) { + $system_theme = $standard_system_theme; + $theme_name = $standard_theme_name; + } + else { + $system_theme = ((isset($a->config['system']['mobile-theme'])) ? $a->config['system']['mobile-theme'] : $standard_system_theme); + $theme_name = ((isset($_SESSION) && x($_SESSION,'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme); - if($is_mobile) { - if(isset($_SESSION['show-mobile']) && !$_SESSION['show-mobile']) { + if($theme_name === '---') { + // user has selected to have the mobile theme be the same as the normal one $system_theme = $standard_system_theme; $theme_name = $standard_theme_name; - } - else { - $system_theme = ((isset($a->config['system']['mobile-theme'])) ? $a->config['system']['mobile-theme'] : $standard_system_theme); - $theme_name = ((isset($_SESSION) && x($_SESSION,'mobile-theme')) ? $_SESSION['mobile-theme'] : $system_theme); - - if($theme_name === '---') { - // user has selected to have the mobile theme be the same as the normal one - $system_theme = $standard_system_theme; - $theme_name = $standard_theme_name; - if($page_theme) - $theme_name = $page_theme; - } + if($page_theme) + $theme_name = $page_theme; } } - else { - $system_theme = $standard_system_theme; - $theme_name = $standard_theme_name; + } + else { + $system_theme = $standard_system_theme; + $theme_name = $standard_theme_name; - if($page_theme) - $theme_name = $page_theme; - } + if($page_theme) + $theme_name = $page_theme; + } - if($theme_name && - (file_exists('view/theme/' . $theme_name . '/style.css') || - file_exists('view/theme/' . $theme_name . '/style.php'))) - return($theme_name); + if($theme_name && + (file_exists('view/theme/' . $theme_name . '/style.css') || + file_exists('view/theme/' . $theme_name . '/style.php'))) + return($theme_name); - foreach($app_base_themes as $t) { - if(file_exists('view/theme/' . $t . '/style.css')|| - file_exists('view/theme/' . $t . '/style.php')) - return($t); - } + foreach($app_base_themes as $t) { + if(file_exists('view/theme/' . $t . '/style.css')|| + file_exists('view/theme/' . $t . '/style.php')) + return($t); + } - $fallback = array_merge(glob('view/theme/*/style.css'),glob('view/theme/*/style.php')); - if(count($fallback)) - return (str_replace('view/theme/','', substr($fallback[0],0,-10))); + $fallback = array_merge(glob('view/theme/*/style.css'),glob('view/theme/*/style.php')); + if(count($fallback)) + return (str_replace('view/theme/','', substr($fallback[0],0,-10))); - } } -/* - * Return full URL to theme which is currently in effect. -* Provide a sane default if nothing is chosen or the specified theme does not exist. -*/ -if(! function_exists('current_theme_url')) { - function current_theme_url() { - global $a; +/** + * @brief Return full URL to theme which is currently in effect. + * + * Provide a sane default if nothing is chosen or the specified theme does not exist. + * + * @return string + */ +function current_theme_url() { + global $a; - $t = current_theme(); + $t = current_theme(); - $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : ''); - if (file_exists('view/theme/' . $t . '/style.php')) - return($a->get_baseurl() . '/view/theme/' . $t . '/style.pcss' . $opts); + $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : ''); + if (file_exists('view/theme/' . $t . '/style.php')) + return($a->get_baseurl() . '/view/theme/' . $t . '/style.pcss' . $opts); - return($a->get_baseurl() . '/view/theme/' . $t . '/style.css'); - } + return($a->get_baseurl() . '/view/theme/' . $t . '/style.css'); } -if(! function_exists('feed_birthday')) { - function feed_birthday($uid,$tz) { +function feed_birthday($uid,$tz) { - /** - * - * Determine the next birthday, but only if the birthday is published - * in the default profile. We _could_ also look for a private profile that the - * recipient can see, but somebody could get mad at us if they start getting - * public birthday greetings when they haven't made this info public. - * - * Assuming we are able to publish this info, we are then going to convert - * the start time from the owner's timezone to UTC. - * - * This will potentially solve the problem found with some social networks - * where birthdays are converted to the viewer's timezone and salutations from - * elsewhere in the world show up on the wrong day. We will convert it to the - * viewer's timezone also, but first we are going to convert it from the birthday - * person's timezone to GMT - so the viewer may find the birthday starting at - * 6:00PM the day before, but that will correspond to midnight to the birthday person. - * - */ + /** + * + * Determine the next birthday, but only if the birthday is published + * in the default profile. We _could_ also look for a private profile that the + * recipient can see, but somebody could get mad at us if they start getting + * public birthday greetings when they haven't made this info public. + * + * Assuming we are able to publish this info, we are then going to convert + * the start time from the owner's timezone to UTC. + * + * This will potentially solve the problem found with some social networks + * where birthdays are converted to the viewer's timezone and salutations from + * elsewhere in the world show up on the wrong day. We will convert it to the + * viewer's timezone also, but first we are going to convert it from the birthday + * person's timezone to GMT - so the viewer may find the birthday starting at + * 6:00PM the day before, but that will correspond to midnight to the birthday person. + * + */ - $birthday = ''; + $birthday = ''; - if(! strlen($tz)) - $tz = 'UTC'; + if(! strlen($tz)) + $tz = 'UTC'; - $p = q("SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1", - intval($uid) - ); + $p = q("SELECT `dob` FROM `profile` WHERE `is-default` = 1 AND `uid` = %d LIMIT 1", + intval($uid) + ); - if($p && count($p)) { - $tmp_dob = substr($p[0]['dob'],5); - if(intval($tmp_dob)) { - $y = datetime_convert($tz,$tz,'now','Y'); - $bd = $y . '-' . $tmp_dob . ' 00:00'; - $t_dob = strtotime($bd); - $now = strtotime(datetime_convert($tz,$tz,'now')); - if($t_dob < $now) - $bd = $y + 1 . '-' . $tmp_dob . ' 00:00'; - $birthday = datetime_convert($tz,'UTC',$bd,ATOM_TIME); - } + if($p && count($p)) { + $tmp_dob = substr($p[0]['dob'],5); + if(intval($tmp_dob)) { + $y = datetime_convert($tz,$tz,'now','Y'); + $bd = $y . '-' . $tmp_dob . ' 00:00'; + $t_dob = strtotime($bd); + $now = strtotime(datetime_convert($tz,$tz,'now')); + if($t_dob < $now) + $bd = $y + 1 . '-' . $tmp_dob . ' 00:00'; + $birthday = datetime_convert($tz,'UTC',$bd,ATOM_TIME); } - - return $birthday; } + + return $birthday; } -if(! function_exists('is_site_admin')) { - function is_site_admin() { - $a = get_app(); +/** + * @brief Check if current user has admin role. + * + * @return bool true if user is an admin + */ +function is_site_admin() { + $a = get_app(); - $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email'])); + $adminlist = explode(",", str_replace(" ", "", $a->config['admin_email'])); - //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email'])) - if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && in_array($a->user['email'], $adminlist)) - return true; - return false; - } + //if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && ($a->user['email'] === $a->config['admin_email'])) + if(local_user() && x($a->user,'email') && x($a->config,'admin_email') && in_array($a->user['email'], $adminlist)) + return true; + return false; } -if(! function_exists('load_contact_links')) { - function load_contact_links($uid) { +function load_contact_links($uid) { - $a = get_app(); + $a = get_app(); - $ret = array(); + $ret = array(); - if(! $uid || x($a->contacts,'empty')) - return; + if(! $uid || x($a->contacts,'empty')) + return; - $r = q("SELECT `id`,`network`,`url`,`thumb`, `rel` FROM `contact` WHERE `uid` = %d AND `self` = 0 AND `blocked` = 0 AND `thumb` != ''", - intval($uid) - ); - if(count($r)) { - foreach($r as $rr){ - $url = normalise_link($rr['url']); - $ret[$url] = $rr; - } - } else - $ret['empty'] = true; + $r = q("SELECT `id`,`network`,`url`,`thumb`, `rel` FROM `contact` WHERE `uid` = %d AND `self` = 0 AND `blocked` = 0 AND `thumb` != ''", + intval($uid) + ); + if(count($r)) { + foreach($r as $rr){ + $url = normalise_link($rr['url']); + $ret[$url] = $rr; + } + } else + $ret['empty'] = true; - $a->contacts = $ret; - return; - } + $a->contacts = $ret; + return; } /** -* returns querystring as string from a mapped array -* -* @param params Array -* @return string -*/ + * @brief Returns querystring as string from a mapped array. + * + * @param array $params mapped array with query parameters + * @param string $name of parameter, default null + * + * @return string + */ function build_querystring($params, $name=null) { $ret = ""; foreach($params as $key=>$val) { -- 2.39.5