5 use Friendica\Core\Config;
6 use Friendica\Core\PConfig;
11 use Detection\MobileDetect;
19 * @brief Our main application structure for the life of this page.
21 * Primarily deals with the URL that got us here
22 * and tries to make some sense of it, and
23 * stores our page contents and config storage
24 * and anything else that might need to be passed around
25 * before we spit the page out.
30 public $module_loaded = false;
42 public $data = array();
43 public $error = false;
54 public $interactive = true;
56 public $apps = array();
58 public $is_mobile = false;
59 public $is_tablet = false;
60 public $is_friendica_app;
61 public $performance = array();
62 public $callstack = array();
63 public $theme_info = array();
64 public $backend = true;
67 // Allow themes to control internal parameters
68 // by changing App values in theme.php
70 public $sourcename = '';
71 public $videowidth = 425;
72 public $videoheight = 350;
73 public $force_max_items = 0;
74 public $theme_thread_allow = true;
75 public $theme_events_in_profile = true;
78 * @brief An array for all theme-controllable parameters
80 * Mostly unimplemented yet. Only options 'template_engine' and
83 public $theme = array(
87 'force_max_items' => 0,
88 'thread_allow' => true,
90 'template_engine' => 'smarty3',
94 * @brief An array of registered template engines ('name'=>'class name')
96 public $template_engines = array();
99 * @brief An array of instanced template engines ('name'=>'instance')
101 public $template_engine_instance = array();
104 private $ldelim = array(
108 private $rdelim = array(
116 private $curl_content_type;
117 private $curl_headers;
118 private $cached_profile_image;
119 private $cached_profile_picdate;
123 * @brief App constructor.
125 * @param string $basepath Path to the app base folder
127 function __construct($basepath) {
129 global $default_timezone;
133 if (file_exists('.htpreconfig.php')) {
134 include '.htpreconfig.php';
137 $this->timezone = ((x($default_timezone)) ? $default_timezone : 'UTC');
139 date_default_timezone_set($this->timezone);
141 $this->performance['start'] = microtime(true);
142 $this->performance['database'] = 0;
143 $this->performance['database_write'] = 0;
144 $this->performance['network'] = 0;
145 $this->performance['file'] = 0;
146 $this->performance['rendering'] = 0;
147 $this->performance['parser'] = 0;
148 $this->performance['marktime'] = 0;
149 $this->performance['markstart'] = microtime(true);
151 $this->callstack['database'] = array();
152 $this->callstack['database_write'] = array();
153 $this->callstack['network'] = array();
154 $this->callstack['file'] = array();
155 $this->callstack['rendering'] = array();
156 $this->callstack['parser'] = array();
158 $this->config = array();
159 $this->page = array();
160 $this->pager = array();
162 $this->query_string = '';
164 $this->process_id = uniqid('log', true);
168 $this->scheme = 'http';
170 if ((x($_SERVER, 'HTTPS') && $_SERVER['HTTPS']) ||
171 (x($_SERVER, 'HTTP_FORWARDED') && preg_match('/proto=https/', $_SERVER['HTTP_FORWARDED'])) ||
172 (x($_SERVER, 'HTTP_X_FORWARDED_PROTO') && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') ||
173 (x($_SERVER, 'HTTP_X_FORWARDED_SSL') && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on') ||
174 (x($_SERVER, 'FRONT_END_HTTPS') && $_SERVER['FRONT_END_HTTPS'] == 'on') ||
175 (x($_SERVER, 'SERVER_PORT') && (intval($_SERVER['SERVER_PORT']) == 443)) // XXX: reasonable assumption, but isn't this hardcoding too much?
177 $this->scheme = 'https';
180 if (x($_SERVER, 'SERVER_NAME')) {
181 $this->hostname = $_SERVER['SERVER_NAME'];
183 if (x($_SERVER, 'SERVER_PORT') && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) {
184 $this->hostname .= ':' . $_SERVER['SERVER_PORT'];
187 * Figure out if we are running at the top of a domain
188 * or in a sub-directory and adjust accordingly
191 /// @TODO This kind of escaping breaks syntax-highlightning on CoolEdit (Midnight Commander)
192 $path = trim(dirname($_SERVER['SCRIPT_NAME']), '/\\');
193 if (isset($path) && strlen($path) && ($path != $this->path)) {
198 if ($hostname != '') {
199 $this->hostname = $hostname;
202 if (! static::directory_usable($basepath, false)) {
203 throw new Exception('Basepath ' . $basepath . ' isn\'t usable.');
206 $this->basepath = rtrim($basepath, DIRECTORY_SEPARATOR);
209 get_include_path() . PATH_SEPARATOR
210 . $this->basepath . DIRECTORY_SEPARATOR . 'include' . PATH_SEPARATOR
211 . $this->basepath . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR
212 . $this->basepath . DIRECTORY_SEPARATOR . 'library/langdet' . PATH_SEPARATOR
216 if (is_array($_SERVER['argv']) && $_SERVER['argc'] > 1 && substr(end($_SERVER['argv']), 0, 4) == 'http') {
217 $this->set_baseurl(array_pop($_SERVER['argv']));
221 if ((x($_SERVER, 'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'], 0, 9) === 'pagename=') {
222 $this->query_string = substr($_SERVER['QUERY_STRING'], 9);
224 // removing trailing / - maybe a nginx problem
225 $this->query_string = ltrim($this->query_string, '/');
226 } elseif ((x($_SERVER, 'QUERY_STRING')) && substr($_SERVER['QUERY_STRING'], 0, 2) === 'q=') {
227 $this->query_string = substr($_SERVER['QUERY_STRING'], 2);
229 // removing trailing / - maybe a nginx problem
230 $this->query_string = ltrim($this->query_string, '/');
233 if (x($_GET, 'pagename')) {
234 $this->cmd = trim($_GET['pagename'], '/\\');
235 } elseif (x($_GET, 'q')) {
236 $this->cmd = trim($_GET['q'], '/\\');
240 $this->query_string = str_replace($this->cmd . '&', $this->cmd . '?', $this->query_string);
242 // unix style "homedir"
243 if (substr($this->cmd, 0, 1) === '~') {
244 $this->cmd = 'profile/' . substr($this->cmd, 1);
247 // Diaspora style profile url
248 if (substr($this->cmd, 0, 2) === 'u/') {
249 $this->cmd = 'profile/' . substr($this->cmd, 2);
253 * Break the URL path into C style argc/argv style arguments for our
254 * modules. Given "http://example.com/module/arg1/arg2", $this->argc
255 * will be 3 (integer) and $this->argv will contain:
261 * There will always be one argument. If provided a naked domain
262 * URL, $this->argv[0] is set to "home".
265 $this->argv = explode('/', $this->cmd);
266 $this->argc = count($this->argv);
267 if ((array_key_exists('0', $this->argv)) && strlen($this->argv[0])) {
268 $this->module = str_replace('.', '_', $this->argv[0]);
269 $this->module = str_replace('-', '_', $this->module);
272 $this->argv = array('home');
273 $this->module = 'home';
276 // See if there is any page number information, and initialise pagination
277 $this->pager['page'] = ((x($_GET, 'page') && intval($_GET['page']) > 0) ? intval($_GET['page']) : 1);
278 $this->pager['itemspage'] = 50;
279 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
281 if ($this->pager['start'] < 0) {
282 $this->pager['start'] = 0;
284 $this->pager['total'] = 0;
286 // Detect mobile devices
287 $mobile_detect = new MobileDetect();
288 $this->is_mobile = $mobile_detect->isMobile();
289 $this->is_tablet = $mobile_detect->isTablet();
292 $this->is_friendica_app = ($_SERVER['HTTP_USER_AGENT'] == 'Apache-HttpClient/UNAVAILABLE (java 1.4)');
294 // Register template engines
295 $dc = get_declared_classes();
296 foreach ($dc as $k) {
297 if (in_array('ITemplateEngine', class_implements($k))) {
298 $this->register_template_engine($k);
306 * @brief Returns the base filesystem path of the App
308 * It first checks for the internal variable, then for DOCUMENT_ROOT and
313 public static function get_basepath() {
315 $basepath = $this->basepath;
319 $basepath = Config::get('system', 'basepath');
322 if (! $basepath && x($_SERVER, 'DOCUMENT_ROOT')) {
323 $basepath = $_SERVER['DOCUMENT_ROOT'];
326 if (! $basepath && x($_SERVER, 'PWD')) {
327 $basepath = $_SERVER['PWD'];
330 return self::realpath($basepath);
334 * @brief Returns a normalized file path
336 * This is a wrapper for the "realpath" function.
337 * That function cannot detect the real path when some folders aren't readable.
338 * Since this could happen with some hosters we need to handle this.
340 * @param string $path The path that is about to be normalized
341 * @return string normalized path - when possible
343 public static function realpath($path) {
344 $normalized = realpath($path);
346 if (!is_bool($normalized)) {
353 function get_scheme() {
354 return $this->scheme;
358 * @brief Retrieves the Friendica instance base URL
360 * This function assembles the base URL from multiple parts:
361 * - Protocol is determined either by the request or a combination of
362 * system.ssl_policy and the $ssl parameter.
363 * - Host name is determined either by system.hostname or inferred from request
364 * - Path is inferred from SCRIPT_NAME
366 * Note: $ssl parameter value doesn't directly correlate with the resulting protocol
368 * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
369 * @return string Friendica server base URL
371 function get_baseurl($ssl = false) {
372 // Is the function called statically?
373 if (!(isset($this) && get_class($this) == __CLASS__)) {
374 return self::$a->get_baseurl($ssl);
377 $scheme = $this->scheme;
379 if (Config::get('system', 'ssl_policy') == SSL_POLICY_FULL) {
383 // Basically, we have $ssl = true on any links which can only be seen by a logged in user
384 // (and also the login link). Anything seen by an outsider will have it turned off.
386 if (Config::get('system', 'ssl_policy') == SSL_POLICY_SELFSIGN) {
394 if (Config::get('config', 'hostname') != '') {
395 $this->hostname = Config::get('config', 'hostname');
398 return $scheme . '://' . $this->hostname . ((isset($this->path) && strlen($this->path)) ? '/' . $this->path : '' );
402 * @brief Initializes the baseurl components
404 * Clears the baseurl cache to prevent inconstistencies
408 function set_baseurl($url) {
409 $parsed = @parse_url($url);
412 $this->scheme = $parsed['scheme'];
414 $hostname = $parsed['host'];
415 if (x($parsed, 'port')) {
416 $hostname .= ':' . $parsed['port'];
418 if (x($parsed, 'path')) {
419 $this->path = trim($parsed['path'], '\\/');
422 if (file_exists('.htpreconfig.php')) {
423 include '.htpreconfig.php';
426 if (Config::get('config', 'hostname') != '') {
427 $this->hostname = Config::get('config', 'hostname');
430 if (!isset($this->hostname) || ( $this->hostname == '')) {
431 $this->hostname = $hostname;
436 function get_hostname() {
437 if (Config::get('config', 'hostname') != '') {
438 $this->hostname = Config::get('config', 'hostname');
441 return $this->hostname;
444 function set_hostname($h) {
445 $this->hostname = $h;
448 function set_path($p) {
449 $this->path = trim(trim($p), '/');
452 function get_path() {
456 function set_pager_total($n) {
457 $this->pager['total'] = intval($n);
460 function set_pager_itemspage($n) {
461 $this->pager['itemspage'] = ((intval($n) > 0) ? intval($n) : 0);
462 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
465 function set_pager_page($n) {
466 $this->pager['page'] = $n;
467 $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
470 function init_pagehead() {
471 $interval = ((local_user()) ? PConfig::get(local_user(), 'system', 'update_interval') : 40000);
473 // If the update is 'deactivated' set it to the highest integer number (~24 days)
475 $interval = 2147483647;
478 if ($interval < 10000) {
482 // compose the page title from the sitename and the
483 // current module called
484 if (!$this->module == '') {
485 $this->page['title'] = $this->config['sitename'] . ' (' . $this->module . ')';
487 $this->page['title'] = $this->config['sitename'];
490 /* put the head template at the beginning of page['htmlhead']
491 * since the code added by the modules frequently depends on it
494 if (!isset($this->page['htmlhead'])) {
495 $this->page['htmlhead'] = '';
498 // If we're using Smarty, then doing replace_macros() will replace
499 // any unrecognized variables with a blank string. Since we delay
500 // replacing $stylesheet until later, we need to replace it now
501 // with another variable name
502 if ($this->theme['template_engine'] === 'smarty3') {
503 $stylesheet = $this->get_template_ldelim('smarty3') . '$stylesheet' . $this->get_template_rdelim('smarty3');
505 $stylesheet = '$stylesheet';
508 $shortcut_icon = Config::get('system', 'shortcut_icon');
509 if ($shortcut_icon == '') {
510 $shortcut_icon = 'images/friendica-32.png';
513 $touch_icon = Config::get('system', 'touch_icon');
514 if ($touch_icon == '') {
515 $touch_icon = 'images/friendica-128.png';
518 // get data wich is needed for infinite scroll on the network page
519 $invinite_scroll = infinite_scroll_data($this->module);
521 $tpl = get_markup_template('head.tpl');
522 $this->page['htmlhead'] = replace_macros($tpl, array(
523 '$baseurl' => $this->get_baseurl(), // FIXME for z_path!!!!
524 '$local_user' => local_user(),
525 '$generator' => 'Friendica' . ' ' . FRIENDICA_VERSION,
526 '$delitem' => t('Delete this item?'),
527 '$showmore' => t('show more'),
528 '$showfewer' => t('show fewer'),
529 '$update_interval' => $interval,
530 '$shortcut_icon' => $shortcut_icon,
531 '$touch_icon' => $touch_icon,
532 '$stylesheet' => $stylesheet,
533 '$infinite_scroll' => $invinite_scroll,
534 )) . $this->page['htmlhead'];
537 function init_page_end() {
538 if (!isset($this->page['end'])) {
539 $this->page['end'] = '';
541 $tpl = get_markup_template('end.tpl');
542 $this->page['end'] = replace_macros($tpl, array(
543 '$baseurl' => $this->get_baseurl() // FIXME for z_path!!!!
544 )) . $this->page['end'];
547 function set_curl_code($code) {
548 $this->curl_code = $code;
551 function get_curl_code() {
552 return $this->curl_code;
555 function set_curl_content_type($content_type) {
556 $this->curl_content_type = $content_type;
559 function get_curl_content_type() {
560 return $this->curl_content_type;
563 function set_curl_headers($headers) {
564 $this->curl_headers = $headers;
567 function get_curl_headers() {
568 return $this->curl_headers;
571 function get_cached_avatar_image($avatar_image) {
572 return $avatar_image;
576 * @brief Removes the baseurl from an url. This avoids some mixed content problems.
578 * @param string $orig_url
580 * @return string The cleaned url
582 function remove_baseurl($orig_url) {
584 // Is the function called statically?
585 if (!(isset($this) && get_class($this) == __CLASS__)) {
586 return self::$a->remove_baseurl($orig_url);
589 // Remove the hostname from the url if it is an internal link
590 $nurl = normalise_link($orig_url);
591 $base = normalise_link($this->get_baseurl());
592 $url = str_replace($base . '/', '', $nurl);
594 // if it is an external link return the orignal value
595 if ($url == normalise_link($orig_url)) {
603 * @brief Register template engine class
605 * If $name is '', is used class static property $class::$name
607 * @param string $class
608 * @param string $name
610 function register_template_engine($class, $name = '') {
611 /// @TODO Really === and not just == ?
613 $v = get_class_vars($class);
618 echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
621 $this->template_engines[$name] = $class;
625 * @brief Return template engine instance.
627 * If $name is not defined, return engine defined by theme,
630 * @param strin $name Template engine name
631 * @return object Template Engine instance
633 function template_engine($name = '') {
634 /// @TODO really type-check included?
636 $template_engine = $name;
638 $template_engine = 'smarty3';
639 if (x($this->theme, 'template_engine')) {
640 $template_engine = $this->theme['template_engine'];
644 if (isset($this->template_engines[$template_engine])) {
645 if (isset($this->template_engine_instance[$template_engine])) {
646 return $this->template_engine_instance[$template_engine];
648 $class = $this->template_engines[$template_engine];
650 $this->template_engine_instance[$template_engine] = $obj;
655 echo "template engine <tt>$template_engine</tt> is not registered!\n";
660 * @brief Returns the active template engine.
664 function get_template_engine() {
665 return $this->theme['template_engine'];
668 function set_template_engine($engine = 'smarty3') {
669 $this->theme['template_engine'] = $engine;
672 function get_template_ldelim($engine = 'smarty3') {
673 return $this->ldelim[$engine];
676 function get_template_rdelim($engine = 'smarty3') {
677 return $this->rdelim[$engine];
680 function save_timestamp($stamp, $value) {
681 if (!isset($this->config['system']['profiler']) || !$this->config['system']['profiler']) {
685 $duration = (float) (microtime(true) - $stamp);
687 if (!isset($this->performance[$value])) {
688 // Prevent ugly E_NOTICE
689 $this->performance[$value] = 0;
692 $this->performance[$value] += (float) $duration;
693 $this->performance['marktime'] += (float) $duration;
695 $callstack = $this->callstack();
697 if (!isset($this->callstack[$value][$callstack])) {
698 // Prevent ugly E_NOTICE
699 $this->callstack[$value][$callstack] = 0;
702 $this->callstack[$value][$callstack] += (float) $duration;
706 * @brief Log active processes into the "process" table
708 function start_process() {
709 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
711 $command = basename($trace[0]['file']);
713 $this->remove_inactive_processes();
715 q('START TRANSACTION');
717 $r = q('SELECT `pid` FROM `process` WHERE `pid` = %d', intval(getmypid()));
718 if (!dbm::is_result($r)) {
719 q("INSERT INTO `process` (`pid`,`command`,`created`) VALUES (%d, '%s', '%s')", intval(getmypid()), dbesc($command), dbesc(datetime_convert()));
725 * @brief Remove inactive processes
727 function remove_inactive_processes() {
728 q('START TRANSACTION');
730 $r = q('SELECT `pid` FROM `process`');
731 if (dbm::is_result($r)) {
732 foreach ($r AS $process) {
733 if (!posix_kill($process['pid'], 0)) {
734 q('DELETE FROM `process` WHERE `pid` = %d', intval($process['pid']));
742 * @brief Remove the active process from the "process" table
744 function end_process() {
745 q('DELETE FROM `process` WHERE `pid` = %d', intval(getmypid()));
749 * @brief Returns a string with a callstack. Can be used for logging.
753 function callstack($depth = 4) {
754 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, $depth + 2);
756 // We remove the first two items from the list since they contain data that we don't need.
760 $callstack = array();
761 foreach ($trace AS $func) {
762 $callstack[] = $func['function'];
765 return implode(', ', $callstack);
768 function get_useragent() {
770 FRIENDICA_PLATFORM . " '" .
771 FRIENDICA_CODENAME . "' " .
772 FRIENDICA_VERSION . '-' .
773 DB_UPDATE_VERSION . '; ' .
774 $this->get_baseurl();
777 function is_friendica_app() {
778 return $this->is_friendica_app;
782 * @brief Checks if the site is called via a backend process
784 * This isn't a perfect solution. But we need this check very early.
785 * So we cannot wait until the modules are loaded.
787 * @return bool Is it a known backend?
789 function is_backend() {
790 static $backends = array();
791 $backends[] = '_well_known';
793 $backends[] = 'dfrn_notify';
794 $backends[] = 'fetch';
795 $backends[] = 'hcard';
796 $backends[] = 'hostxrd';
797 $backends[] = 'nodeinfo';
798 $backends[] = 'noscrape';
800 $backends[] = 'poco';
801 $backends[] = 'post';
802 $backends[] = 'proxy';
803 $backends[] = 'pubsub';
804 $backends[] = 'pubsubhubbub';
805 $backends[] = 'receive';
806 $backends[] = 'rsd_xml';
807 $backends[] = 'salmon';
808 $backends[] = 'statistics_json';
811 // Check if current module is in backend or backend flag is set
812 return (in_array($this->module, $backends) || $this->backend);
816 * @brief Checks if the maximum number of database processes is reached
818 * @return bool Is the limit reached?
820 function max_processes_reached() {
821 // Deactivated, needs more investigating if this check really makes sense
824 if ($this->is_backend()) {
825 $process = 'backend';
826 $max_processes = Config::get('system', 'max_processes_backend');
827 if (intval($max_processes) == 0) {
831 $process = 'frontend';
832 $max_processes = Config::get('system', 'max_processes_frontend');
833 if (intval($max_processes) == 0) {
838 $processlist = dbm::processlist();
839 if ($processlist['list'] != '') {
840 logger('Processcheck: Processes: ' . $processlist['amount'] . ' - Processlist: ' . $processlist['list'], LOGGER_DEBUG);
842 if ($processlist['amount'] > $max_processes) {
843 logger('Processcheck: Maximum number of processes for ' . $process . ' tasks (' . $max_processes . ') reached.', LOGGER_DEBUG);
851 * @brief Checks if the minimal memory is reached
853 * @return bool Is the memory limit reached?
855 public function min_memory_reached() {
856 $min_memory = Config::get('system', 'min_memory', 0);
857 if ($min_memory == 0) {
861 if (!is_readable('/proc/meminfo')) {
865 $memdata = explode("\n", file_get_contents('/proc/meminfo'));
868 foreach ($memdata as $line) {
869 list($key, $val) = explode(':', $line);
870 $meminfo[$key] = (int) trim(str_replace('kB', '', $val));
871 $meminfo[$key] = (int) ($meminfo[$key] / 1024);
874 if (!isset($meminfo['MemAvailable']) || ! isset($meminfo['MemFree'])) {
878 $free = $meminfo['MemAvailable'] + $meminfo['MemFree'];
880 $reached = ($free < $min_memory);
883 logger('Minimal memory reached: ' . $free . '/' . $meminfo['MemTotal'] . ' - limit ' . $min_memory, LOGGER_DEBUG);
890 * @brief Checks if the maximum load is reached
892 * @return bool Is the load reached?
894 function maxload_reached() {
896 if ($this->is_backend()) {
897 $process = 'backend';
898 $maxsysload = intval(Config::get('system', 'maxloadavg'));
899 if ($maxsysload < 1) {
903 $process = 'frontend';
904 $maxsysload = intval(Config::get('system', 'maxloadavg_frontend'));
905 if ($maxsysload < 1) {
910 $load = current_load();
912 if (intval($load) > $maxsysload) {
913 logger('system: load ' . $load . ' for ' . $process . ' tasks (' . $maxsysload . ') too high.');
920 function proc_run($args) {
922 if (!function_exists('proc_open')) {
926 // If the last worker fork was less than 2 seconds before then don't fork another one.
927 // This should prevent the forking of masses of workers.
928 $cachekey = 'app:proc_run:started';
929 $result = Cache::get($cachekey);
931 if (!is_null($result) && ( time() - $result) < 2) {
935 // Set the timestamp of the last proc_run
936 Cache::set($cachekey, time(), CACHE_MINUTE);
938 array_unshift($args, ((x($this->config, 'php_path')) && (strlen($this->config['php_path'])) ? $this->config['php_path'] : 'php'));
940 // add baseurl to args. cli scripts can't construct it
941 $args[] = $this->get_baseurl();
943 for ($x = 0; $x < count($args); $x ++) {
944 $args[$x] = escapeshellarg($args[$x]);
947 $cmdline = implode($args, ' ');
949 if ($this->min_memory_reached()) {
953 if (Config::get('system', 'proc_windows')) {
954 $resource = proc_open('cmd /c start /b ' . $cmdline, array(), $foo, $this->get_basepath());
956 $resource = proc_open($cmdline . ' &', array(), $foo, $this->get_basepath());
958 if (!is_resource($resource)) {
959 logger('We got no resource for command ' . $cmdline, LOGGER_DEBUG);
962 proc_close($resource);
966 * @brief Returns the system user that is executing the script
968 * This mostly returns something like "www-data".
970 * @return string system username
972 static function systemuser() {
973 if (!function_exists('posix_getpwuid') || ! function_exists('posix_geteuid')) {
977 $processUser = posix_getpwuid(posix_geteuid());
978 return $processUser['name'];
982 * @brief Checks if a given directory is usable for the system
984 * @return boolean the directory is usable
986 static function directory_usable($directory, $check_writable = true) {
987 if ($directory == '') {
988 logger('Directory is empty. This shouldn\'t happen.', LOGGER_DEBUG);
992 if (!file_exists($directory)) {
993 logger('Path "' . $directory . '" does not exist for user ' . self::systemuser(), LOGGER_DEBUG);
996 if (is_file($directory)) {
997 logger('Path "' . $directory . '" is a file for user ' . self::systemuser(), LOGGER_DEBUG);
1000 if (!is_dir($directory)) {
1001 logger('Path "' . $directory . '" is not a directory for user ' . self::systemuser(), LOGGER_DEBUG);
1004 if ($check_writable && !is_writable($directory)) {
1005 logger('Path "' . $directory . '" is not writable for user ' . self::systemuser(), LOGGER_DEBUG);