7 use Friendica\Core\Cache;
8 use Friendica\Core\Config;
9 use Friendica\Core\L10n;
10 use Friendica\Core\PConfig;
11 use Friendica\Core\System;
13 use Detection\MobileDetect;
17 require_once 'boot.php';
18 require_once 'include/text.php';
24 * @brief Our main application structure for the life of this page.
26 * Primarily deals with the URL that got us here
27 * and tries to make some sense of it, and
28 * stores our page contents and config storage
29 * and anything else that might need to be passed around
30 * before we spit the page out.
35 public $module_loaded = false;
36 public $module_class = null;
50 public $error = false;
61 public $interactive = true;
63 public $addons_admin = [];
66 public $is_mobile = false;
67 public $is_tablet = false;
68 public $is_friendica_app;
69 public $performance = [];
70 public $callstack = [];
71 public $theme_info = [];
72 public $backend = true;
75 // Allow themes to control internal parameters
76 // by changing App values in theme.php
78 public $sourcename = '';
79 public $videowidth = 425;
80 public $videoheight = 350;
81 public $force_max_items = 0;
82 public $theme_events_in_profile = true;
85 * @brief An array for all theme-controllable parameters
87 * Mostly unimplemented yet. Only options 'template_engine' and
94 'force_max_items' => 0,
96 'template_engine' => 'smarty3',
100 * @brief An array of registered template engines ('name'=>'class name')
102 public $template_engines = [];
105 * @brief An array of instanced template engines ('name'=>'instance')
107 public $template_engine_instance = [];
121 private $curl_content_type;
122 private $curl_headers;
126 * @brief App constructor.
128 * @param string $basepath Path to the app base folder
130 public function __construct($basepath)
132 global $default_timezone;
134 if (!static::directory_usable($basepath, false)) {
135 throw new Exception('Basepath ' . $basepath . ' isn\'t usable.');
138 $this->basepath = rtrim($basepath, DIRECTORY_SEPARATOR);
140 if (file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php')) {
141 include $this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php';
144 $this->timezone = ((x($default_timezone)) ? $default_timezone : 'UTC');
146 date_default_timezone_set($this->timezone);
148 $this->performance['start'] = microtime(true);
149 $this->performance['database'] = 0;
150 $this->performance['database_write'] = 0;
151 $this->performance['network'] = 0;
152 $this->performance['file'] = 0;
153 $this->performance['rendering'] = 0;
154 $this->performance['parser'] = 0;
155 $this->performance['marktime'] = 0;
156 $this->performance['markstart'] = microtime(true);
158 $this->callstack['database'] = [];
159 $this->callstack['database_write'] = [];
160 $this->callstack['network'] = [];
161 $this->callstack['file'] = [];
162 $this->callstack['rendering'] = [];
163 $this->callstack['parser'] = [];
169 $this->query_string = '';
171 $this->process_id = uniqid('log', true);
175 $this->scheme = 'http';
177 if ((x($_SERVER, 'HTTPS') && $_SERVER['HTTPS']) ||
178 (x($_SERVER, 'HTTP_FORWARDED') && preg_match('/proto=https/', $_SERVER['HTTP_FORWARDED'])) ||
179 (x($_SERVER, 'HTTP_X_FORWARDED_PROTO') && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') ||
180 (x($_SERVER, 'HTTP_X_FORWARDED_SSL') && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on') ||
181 (x($_SERVER, 'FRONT_END_HTTPS') && $_SERVER['FRONT_END_HTTPS'] == 'on') ||
182 (x($_SERVER, 'SERVER_PORT') && (intval($_SERVER['SERVER_PORT']) == 443)) // XXX: reasonable assumption, but isn't this hardcoding too much?
184 $this->scheme = 'https';
187 if (x($_SERVER, 'SERVER_NAME')) {
188 $this->hostname = $_SERVER['SERVER_NAME'];
190 if (x($_SERVER, 'SERVER_PORT') && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) {
191 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
194 * Figure out if we are running at the top of a domain
195 * or in a sub-directory and adjust accordingly
198 /// @TODO This kind of escaping breaks syntax-highlightning on CoolEdit (Midnight Commander)
199 $path = trim(dirname($_SERVER['SCRIPT_NAME']), '/\\');
200 if (isset($path) && strlen($path) && ($path != $this->path)) {
206 get_include_path() . PATH_SEPARATOR
207 . $this->basepath . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
208 . $this->basepath . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
212 if (is_array($_SERVER['argv']) && $_SERVER['argc'] > 1 && substr(end($_SERVER['argv']), 0, 4) == 'http') {
213 $this->set_baseurl(array_pop($_SERVER['argv']));
217 if ((x($_SERVER, 'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'], 0, 9) === 'pagename=') {
218 $this->query_string = substr($_SERVER['QUERY_STRING'], 9);
220 // removing trailing / - maybe a nginx problem
221 $this->query_string = ltrim($this->query_string, '/');
222 } elseif ((x($_SERVER, 'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'], 0, 2) === 'q=') {
223 $this->query_string = substr($_SERVER['QUERY_STRING'], 2);
225 // removing trailing / - maybe a nginx problem
226 $this->query_string = ltrim($this->query_string, '/');
229 if (x($_GET, 'pagename')) {
230 $this->cmd = trim($_GET['pagename'], '/\\');
231 } elseif (x($_GET, 'q')) {
232 $this->cmd = trim($_GET['q'], '/\\');
236 $this->query_string = str_replace($this->cmd . '&', $this->cmd . '?', $this->query_string);
238 // unix style "homedir"
239 if (substr($this->cmd, 0, 1) === '~') {
240 $this->cmd = 'profile/' . substr($this->cmd, 1);
243 // Diaspora style profile url
244 if (substr($this->cmd, 0, 2) === 'u/') {
245 $this->cmd = 'profile/' . substr($this->cmd, 2);
249 * Break the URL path into C style argc/argv style arguments for our
250 * modules. Given "http://example.com/module/arg1/arg2", $this->argc
251 * will be 3 (integer) and $this->argv will contain:
257 * There will always be one argument. If provided a naked domain
258 * URL, $this->argv[0] is set to "home".
261 $this->argv = explode('/', $this->cmd);
262 $this->argc = count($this->argv);
263 if ((array_key_exists('0', $this->argv)) && strlen($this->argv[0])) {
264 $this->module = str_replace('.', '_', $this->argv[0]);
265 $this->module = str_replace('-', '_', $this->module);
268 $this->argv = ['home'];
269 $this->module = 'home';
272 // See if there is any page number information, and initialise pagination
273 $this->pager['page'] = ((x($_GET, 'page') && intval($_GET['page']) > 0) ? intval($_GET['page']) : 1);
274 $this->pager['itemspage'] = 50;
275 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
277 if ($this->pager['start'] < 0) {
278 $this->pager['start'] = 0;
280 $this->pager['total'] = 0;
282 // Detect mobile devices
283 $mobile_detect = new MobileDetect();
284 $this->is_mobile = $mobile_detect->isMobile();
285 $this->is_tablet = $mobile_detect->isTablet();
288 $this->is_friendica_app = ($_SERVER['HTTP_USER_AGENT'] == 'Apache-HttpClient/UNAVAILABLE (java 1.4)');
290 // Register template engines
291 $dc = get_declared_classes();
292 foreach ($dc as $k) {
293 if (in_array('Friendica\Render\ITemplateEngine', class_implements($k))) {
294 $this->register_template_engine($k);
302 * @brief Returns the base filesystem path of the App
304 * It first checks for the internal variable, then for DOCUMENT_ROOT and
309 public function get_basepath()
311 $basepath = $this->basepath;
314 $basepath = Config::get('system', 'basepath');
317 if (!$basepath && x($_SERVER, 'DOCUMENT_ROOT')) {
318 $basepath = $_SERVER['DOCUMENT_ROOT'];
321 if (!$basepath && x($_SERVER, 'PWD')) {
322 $basepath = $_SERVER['PWD'];
325 return self::realpath($basepath);
329 * @brief Returns a normalized file path
331 * This is a wrapper for the "realpath" function.
332 * That function cannot detect the real path when some folders aren't readable.
333 * Since this could happen with some hosters we need to handle this.
335 * @param string $path The path that is about to be normalized
336 * @return string normalized path - when possible
338 public static function realpath($path)
340 $normalized = realpath($path);
342 if (!is_bool($normalized)) {
349 public function get_scheme()
351 return $this->scheme;
355 * @brief Retrieves the Friendica instance base URL
357 * This function assembles the base URL from multiple parts:
358 * - Protocol is determined either by the request or a combination of
359 * system.ssl_policy and the $ssl parameter.
360 * - Host name is determined either by system.hostname or inferred from request
361 * - Path is inferred from SCRIPT_NAME
363 * Note: $ssl parameter value doesn't directly correlate with the resulting protocol
365 * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
366 * @return string Friendica server base URL
368 public function get_baseurl($ssl = false)
370 $scheme = $this->scheme;
372 if (Config::get('system', 'ssl_policy') == SSL_POLICY_FULL) {
376 // Basically, we have $ssl = true on any links which can only be seen by a logged in user
377 // (and also the login link). Anything seen by an outsider will have it turned off.
379 if (Config::get('system', 'ssl_policy') == SSL_POLICY_SELFSIGN) {
387 if (Config::get('config', 'hostname') != '') {
388 $this->hostname = Config::get('config', 'hostname');
391 return $scheme . '://' . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' );
395 * @brief Initializes the baseurl components
397 * Clears the baseurl cache to prevent inconsistencies
401 public function set_baseurl($url)
403 $parsed = @parse_url($url);
406 $this->scheme = $parsed['scheme'];
408 $hostname = $parsed['host'];
409 if (x($parsed, 'port')) {
410 $hostname .= ':' . $parsed['port'];
412 if (x($parsed, 'path')) {
413 $this->path = trim($parsed['path'], '\\/');
416 if (file_exists($this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php')) {
417 include $this->basepath . DIRECTORY_SEPARATOR . '.htpreconfig.php';
420 if (Config::get('config', 'hostname') != '') {
421 $this->hostname = Config::get('config', 'hostname');
424 if (!isset($this->hostname) || ( $this->hostname == '')) {
425 $this->hostname = $hostname;
430 public function get_hostname()
432 if (Config::get('config', 'hostname') != '') {
433 $this->hostname = Config::get('config', 'hostname');
436 return $this->hostname;
439 public function get_path()
444 public function set_pager_total($n)
446 $this->pager['total'] = intval($n);
449 public function set_pager_itemspage($n)
451 $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
452 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
455 public function set_pager_page($n)
457 $this->pager['page'] = $n;
458 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
461 public function init_pagehead()
463 $interval = ((local_user()) ? PConfig::get(local_user(), 'system', 'update_interval') : 40000);
465 // If the update is 'deactivated' set it to the highest integer number (~24 days)
467 $interval = 2147483647;
470 if ($interval < 10000) {
474 // compose the page title from the sitename and the
475 // current module called
476 if (!$this->module == '') {
477 $this->page['title'] = $this->config['sitename'] . ' (' . $this->module . ')';
479 $this->page['title'] = $this->config['sitename'];
482 /* put the head template at the beginning of page['htmlhead']
483 * since the code added by the modules frequently depends on it
486 if (!isset($this->page['htmlhead'])) {
487 $this->page['htmlhead'] = '';
490 // If we're using Smarty, then doing replace_macros() will replace
491 // any unrecognized variables with a blank string. Since we delay
492 // replacing $stylesheet until later, we need to replace it now
493 // with another variable name
494 if ($this->theme['template_engine'] === 'smarty3') {
495 $stylesheet = $this->get_template_ldelim('smarty3') . '$stylesheet' . $this->get_template_rdelim('smarty3');
497 $stylesheet = '$stylesheet';
500 $shortcut_icon = Config::get('system', 'shortcut_icon');
501 if ($shortcut_icon == '') {
502 $shortcut_icon = 'images/friendica-32.png';
505 $touch_icon = Config::get('system', 'touch_icon');
506 if ($touch_icon == '') {
507 $touch_icon = 'images/friendica-128.png';
510 // get data wich is needed for infinite scroll on the network page
511 $invinite_scroll = infinite_scroll_data($this->module);
513 $tpl = get_markup_template('head.tpl');
514 $this->page['htmlhead'] = replace_macros($tpl, [
515 '$baseurl' => $this->get_baseurl(),
516 '$local_user' => local_user(),
517 '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
518 '$delitem' => L10n::t('Delete this item?'),
519 '$showmore' => L10n::t('show more'),
520 '$showfewer' => L10n::t('show fewer'),
521 '$update_interval' => $interval,
522 '$shortcut_icon' => $shortcut_icon,
523 '$touch_icon' => $touch_icon,
524 '$stylesheet' => $stylesheet,
525 '$infinite_scroll' => $invinite_scroll,
526 ]) . $this->page['htmlhead'];
529 public function init_page_end()
531 if (!isset($this->page['end'])) {
532 $this->page['end'] = '';
534 $tpl = get_markup_template('end.tpl');
535 $this->page['end'] = replace_macros($tpl, [
536 '$baseurl' => $this->get_baseurl()
537 ]) . $this->page['end'];
540 public function set_curl_code($code)
542 $this->curl_code = $code;
545 public function get_curl_code()
547 return $this->curl_code;
550 public function set_curl_content_type($content_type)
552 $this->curl_content_type = $content_type;
555 public function get_curl_content_type()
557 return $this->curl_content_type;
560 public function set_curl_headers($headers)
562 $this->curl_headers = $headers;
565 public function get_curl_headers()
567 return $this->curl_headers;
571 * @brief Removes the base url from an url. This avoids some mixed content problems.
573 * @param string $orig_url
575 * @return string The cleaned url
577 public function remove_baseurl($orig_url)
579 // Remove the hostname from the url if it is an internal link
580 $nurl = normalise_link($orig_url);
581 $base = normalise_link($this->get_baseurl());
582 $url = str_replace($base . '/', '', $nurl);
584 // if it is an external link return the orignal value
585 if ($url == normalise_link($orig_url)) {
593 * @brief Register template engine class
595 * @param string $class
597 private function register_template_engine($class)
599 $v = get_class_vars($class);
602 $this->template_engines[$name] = $class;
604 echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
610 * @brief Return template engine instance.
612 * If $name is not defined, return engine defined by theme,
615 * @return object Template Engine instance
617 public function template_engine()
619 $template_engine = 'smarty3';
620 if (x($this->theme, 'template_engine')) {
621 $template_engine = $this->theme['template_engine'];
624 if (isset($this->template_engines[$template_engine])) {
625 if (isset($this->template_engine_instance[$template_engine])) {
626 return $this->template_engine_instance[$template_engine];
628 $class = $this->template_engines[$template_engine];
630 $this->template_engine_instance[$template_engine] = $obj;
635 echo "template engine <tt>$template_engine</tt> is not registered!\n";
640 * @brief Returns the active template engine.
644 public function get_template_engine()
646 return $this->theme['template_engine'];
649 public function set_template_engine($engine = 'smarty3')
651 $this->theme['template_engine'] = $engine;
654 public function get_template_ldelim($engine = 'smarty3')
656 return $this->ldelim[$engine];
659 public function get_template_rdelim($engine = 'smarty3')
661 return $this->rdelim[$engine];
664 public function save_timestamp($stamp, $value)
666 if (!isset($this->config['system']['profiler']) || !$this->config['system']['profiler']) {
670 $duration = (float) (microtime(true) - $stamp);
672 if (!isset($this->performance[$value])) {
673 // Prevent ugly E_NOTICE
674 $this->performance[$value] = 0;
677 $this->performance[$value] += (float) $duration;
678 $this->performance['marktime'] += (float) $duration;
680 $callstack = System::callstack();
682 if (!isset($this->callstack[$value][$callstack])) {
683 // Prevent ugly E_NOTICE
684 $this->callstack[$value][$callstack] = 0;
687 $this->callstack[$value][$callstack] += (float) $duration;
690 public function get_useragent()
693 FRIENDICA_PLATFORM . " '" .
694 FRIENDICA_CODENAME . "' " .
695 FRIENDICA_VERSION . '-' .
696 DB_UPDATE_VERSION . '; ' .
697 $this->get_baseurl();
700 public function is_friendica_app()
702 return $this->is_friendica_app;
706 * @brief Checks if the site is called via a backend process
708 * This isn't a perfect solution. But we need this check very early.
709 * So we cannot wait until the modules are loaded.
711 * @return bool Is it a known backend?
713 public function is_backend()
737 // Check if current module is in backend or backend flag is set
738 return (in_array($this->module, $backends) || $this->backend);
742 * @brief Checks if the maximum number of database processes is reached
744 * @return bool Is the limit reached?
746 public function max_processes_reached()
748 // Deactivated, needs more investigating if this check really makes sense
752 * Commented out to suppress static analyzer issues
754 if ($this->is_backend()) {
755 $process = 'backend';
756 $max_processes = Config::get('system', 'max_processes_backend');
757 if (intval($max_processes) == 0) {
761 $process = 'frontend';
762 $max_processes = Config::get('system', 'max_processes_frontend');
763 if (intval($max_processes) == 0) {
768 $processlist = DBM::processlist();
769 if ($processlist['list'] != '') {
770 logger('Processcheck: Processes: ' . $processlist['amount'] . ' - Processlist: ' . $processlist['list'], LOGGER_DEBUG);
772 if ($processlist['amount'] > $max_processes) {
773 logger('Processcheck: Maximum number of processes for ' . $process . ' tasks (' . $max_processes . ') reached.', LOGGER_DEBUG);
782 * @brief Checks if the minimal memory is reached
784 * @return bool Is the memory limit reached?
786 public function min_memory_reached()
788 $min_memory = Config::get('system', 'min_memory', 0);
789 if ($min_memory == 0) {
793 if (!is_readable('/proc/meminfo')) {
797 $memdata = explode("\n", file_get_contents('/proc/meminfo'));
800 foreach ($memdata as $line) {
801 list($key, $val) = explode(':', $line);
802 $meminfo[$key] = (int) trim(str_replace('kB', '', $val));
803 $meminfo[$key] = (int) ($meminfo[$key] / 1024);
806 if (!isset($meminfo['MemAvailable']) || !isset($meminfo['MemFree'])) {
810 $free = $meminfo['MemAvailable'] + $meminfo['MemFree'];
812 $reached = ($free < $min_memory);
815 logger('Minimal memory reached: ' . $free . '/' . $meminfo['MemTotal'] . ' - limit ' . $min_memory, LOGGER_DEBUG);
822 * @brief Checks if the maximum load is reached
824 * @return bool Is the load reached?
826 public function maxload_reached()
828 if ($this->is_backend()) {
829 $process = 'backend';
830 $maxsysload = intval(Config::get('system', 'maxloadavg'));
831 if ($maxsysload < 1) {
835 $process = 'frontend';
836 $maxsysload = intval(Config::get('system', 'maxloadavg_frontend'));
837 if ($maxsysload < 1) {
842 $load = current_load();
844 if (intval($load) > $maxsysload) {
845 logger('system: load ' . $load . ' for ' . $process . ' tasks (' . $maxsysload . ') too high.');
852 public function proc_run($args)
854 if (!function_exists('proc_open')) {
858 // If the last worker fork was less than 2 seconds before then don't fork another one.
859 // This should prevent the forking of masses of workers.
860 $cachekey = 'app:proc_run:started';
861 $result = Cache::get($cachekey);
863 if (!is_null($result) && ( time() - $result) < 2) {
867 // Set the timestamp of the last proc_run
868 Cache::set($cachekey, time(), CACHE_MINUTE);
870 array_unshift($args, ((x($this->config, 'php_path')) && (strlen($this->config['php_path'])) ? $this->config['php_path'] : 'php'));
872 // add baseurl to args. cli scripts can't construct it
873 $args[] = $this->get_baseurl();
875 for ($x = 0; $x < count($args); $x ++) {
876 $args[$x] = escapeshellarg($args[$x]);
879 $cmdline = implode(' ', $args);
881 if ($this->min_memory_reached()) {
885 if (Config::get('system', 'proc_windows')) {
886 $resource = proc_open('cmd /c start /b ' . $cmdline, [], $foo, $this->get_basepath());
888 $resource = proc_open($cmdline . ' &', [], $foo, $this->get_basepath());
890 if (!is_resource($resource)) {
891 logger('We got no resource for command ' . $cmdline, LOGGER_DEBUG);
894 proc_close($resource);
898 * @brief Returns the system user that is executing the script
900 * This mostly returns something like "www-data".
902 * @return string system username
904 private static function systemuser()
906 if (!function_exists('posix_getpwuid') || !function_exists('posix_geteuid')) {
910 $processUser = posix_getpwuid(posix_geteuid());
911 return $processUser['name'];
915 * @brief Checks if a given directory is usable for the system
917 * @return boolean the directory is usable
919 public static function directory_usable($directory, $check_writable = true)
921 if ($directory == '') {
922 logger('Directory is empty. This shouldn\'t happen.', LOGGER_DEBUG);
926 if (!file_exists($directory)) {
927 logger('Path "' . $directory . '" does not exist for user ' . self::systemuser(), LOGGER_DEBUG);
931 if (is_file($directory)) {
932 logger('Path "' . $directory . '" is a file for user ' . self::systemuser(), LOGGER_DEBUG);
936 if (!is_dir($directory)) {
937 logger('Path "' . $directory . '" is not a directory for user ' . self::systemuser(), LOGGER_DEBUG);
941 if ($check_writable && !is_writable($directory)) {
942 logger('Path "' . $directory . '" is not writable for user ' . self::systemuser(), LOGGER_DEBUG);