3 * @copyright Copyright (C) 2010-2021, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Core;
26 use Friendica\Core\Config\Capability\IManageConfigValues;
28 use Friendica\Network\HTTPException\FoundException;
29 use Friendica\Network\HTTPException\MovedPermanentlyException;
30 use Friendica\Network\HTTPException\TemporaryRedirectException;
31 use Friendica\Util\BasePath;
32 use Friendica\Util\XML;
33 use Psr\Log\LoggerInterface;
36 * Contains the class with system relevant stuff
41 * @var LoggerInterface
46 * @var IManageConfigValues
55 public function __construct(LoggerInterface $logger, IManageConfigValues $config, string $basepath)
57 $this->logger = $logger;
58 $this->config = $config;
59 $this->basePath = $basepath;
63 * Checks if the maximum number of database processes is reached
65 * @return bool Is the limit reached?
67 public function isMaxProcessesReached(): bool
69 // Deactivated, needs more investigating if this check really makes sense
73 * Commented out to suppress static analyzer issues
75 if ($this->mode->isBackend()) {
77 $max_processes = $this->config->get('system', 'max_processes_backend');
78 if (intval($max_processes) == 0) {
82 $process = 'frontend';
83 $max_processes = $this->config->get('system', 'max_processes_frontend');
84 if (intval($max_processes) == 0) {
89 $processlist = DBA::processlist();
90 if ($processlist['list'] != '') {
91 $this->logger->debug('Processcheck: Processes: ' . $processlist['amount'] . ' - Processlist: ' . $processlist['list']);
93 if ($processlist['amount'] > $max_processes) {
94 $this->logger->debug('Processcheck: Maximum number of processes for ' . $process . ' tasks (' . $max_processes . ') reached.');
103 * Checks if the minimal memory is reached
105 * @return bool Is the memory limit reached?
107 public function isMinMemoryReached(): bool
109 $min_memory = $this->config->get('system', 'min_memory', 0);
110 if ($min_memory == 0) {
114 if (!is_readable('/proc/meminfo')) {
118 $memdata = explode("\n", file_get_contents('/proc/meminfo'));
121 foreach ($memdata as $line) {
122 $data = explode(':', $line);
123 if (count($data) != 2) {
126 [$key, $val] = $data;
127 $meminfo[$key] = (int)trim(str_replace('kB', '', $val));
128 $meminfo[$key] = (int)($meminfo[$key] / 1024);
131 if (!isset($meminfo['MemFree'])) {
135 $free = $meminfo['MemFree'];
137 $reached = ($free < $min_memory);
140 $this->logger->warning('Minimal memory reached.', ['free' => $free, 'memtotal' => $meminfo['MemTotal'], 'limit' => $min_memory]);
147 * Checks if the maximum load is reached
149 * @return bool Is the load reached?
151 public function isMaxLoadReached(): bool
153 $maxsysload = intval($this->config->get('system', 'maxloadavg'));
154 if ($maxsysload < 1) {
158 $load = System::currentLoad();
160 if (intval($load) > $maxsysload) {
161 $this->logger->warning('system load for process too high.', ['load' => $load, 'process' => 'backend', 'maxsysload' => $maxsysload]);
169 * Executes a child process with 'proc_open'
171 * @param string $command The command to execute
172 * @param array $args Arguments to pass to the command ( [ 'key' => value, 'key2' => value2, ... ]
174 public function run(string $command, array $args)
176 if (!function_exists('proc_open')) {
177 $this->logger->warning('"proc_open" not available - quitting');
181 $cmdline = $this->config->get('config', 'php_path', 'php') . ' ' . escapeshellarg($command);
183 foreach ($args as $key => $value) {
184 if (!is_null($value) && is_bool($value) && !$value) {
188 $cmdline .= ' --' . $key;
189 if (!is_null($value) && !is_bool($value)) {
190 $cmdline .= ' ' . $value;
194 if ($this->isMinMemoryReached()) {
195 $this->logger->warning('Memory limit reached - quitting');
199 if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
200 $resource = proc_open('cmd /c start /b ' . $cmdline, [], $foo, $this->basePath);
202 $resource = proc_open($cmdline . ' &', [], $foo, $this->basePath);
205 if (!is_resource($resource)) {
206 $this->logger->warning('We got no resource for command.', ['command' => $cmdline]);
210 proc_close($resource);
212 $this->logger->info('Executed "proc_open"', ['command' => $cmdline, 'callstack' => System::callstack(10)]);
216 * Returns a string with a callstack. Can be used for logging.
218 * @param integer $depth How many calls to include in the stacks after filtering
219 * @param int $offset How many calls to shave off the top of the stack, for example if
220 * this is called from a centralized method that isn't relevant to the callstack
223 public static function callstack(int $depth = 4, int $offset = 0): string
225 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
227 // We remove at least the first two items from the list since they contain data that we don't need.
228 $trace = array_slice($trace, 2 + $offset);
231 $previous = ['class' => '', 'function' => '', 'database' => false];
233 // The ignore list contains all functions that are only wrapper functions
234 $ignore = ['call_user_func_array'];
236 while ($func = array_pop($trace)) {
237 if (!empty($func['class'])) {
238 if (in_array($previous['function'], ['insert', 'fetch', 'toArray', 'exists', 'count', 'selectFirst', 'selectToArray',
239 'select', 'update', 'delete', 'selectFirstForUser', 'selectForUser'])
240 && (substr($previous['class'], 0, 15) === 'Friendica\Model')) {
244 // Don't show multiple calls from the Database classes to show the essential parts of the callstack
245 $func['database'] = in_array($func['class'], ['Friendica\Database\DBA', 'Friendica\Database\Database']);
246 if (!$previous['database'] || !$func['database']) {
247 $classparts = explode("\\", $func['class']);
248 $callstack[] = array_pop($classparts).'::'.$func['function'];
251 } elseif (!in_array($func['function'], $ignore)) {
252 $func['database'] = ($func['function'] == 'q');
253 $callstack[] = $func['function'];
260 while ((count($callstack2) < $depth) && (count($callstack) > 0)) {
261 $callstack2[] = array_pop($callstack);
264 return implode(', ', $callstack2);
269 * Outputs a basic dfrn XML status structure to STDOUT, with a <status> variable
270 * of $st and an optional text <message> of $message and terminates the current process.
273 * @param string $message
276 public static function xmlExit($st, $message = '')
278 $result = ['status' => $st];
280 if ($message != '') {
281 $result['message'] = $message;
285 Logger::notice('xml_status returning non_zero: ' . $st . " message=" . $message);
288 header("Content-type: text/xml");
290 $xmldata = ["result" => $result];
292 echo XML::fromArray($xmldata, $xml);
298 * Send HTTP status header and exit.
300 * @param integer $val HTTP status result value
301 * @param string $message Error message. Optional.
302 * @param string $content Response body. Optional.
305 public static function httpExit($val, $message = '', $content = '')
308 Logger::debug('Exit with error', ['code' => $val, 'message' => $message, 'callstack' => System::callstack(20), 'method' => $_SERVER['REQUEST_METHOD'], 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '']);
310 header($_SERVER["SERVER_PROTOCOL"] . ' ' . $val . ' ' . $message);
317 public static function jsonError($httpCode, $data, $content_type = 'application/json')
319 if ($httpCode >= 400) {
320 Logger::debug('Exit with error', ['code' => $httpCode, 'content_type' => $content_type, 'callstack' => System::callstack(20), 'method' => $_SERVER['REQUEST_METHOD'], 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '']);
322 header($_SERVER["SERVER_PROTOCOL"] . ' ' . $httpCode);
323 self::jsonExit($data, $content_type);
327 * Encodes content to json.
329 * This function encodes an array to json format
330 * and adds an application/json HTTP header to the output.
331 * After finishing the process is getting killed.
333 * @param mixed $x The input content.
334 * @param string $content_type Type of the input (Default: 'application/json').
335 * @param integer $options JSON options
337 public static function jsonExit($x, $content_type = 'application/json', int $options = 0) {
338 header("Content-type: $content_type");
339 echo json_encode($x, $options);
344 * Generates a random string in the UUID format
346 * @param bool|string $prefix A given prefix (default is empty)
347 * @return string a generated UUID
350 public static function createUUID($prefix = '')
352 $guid = System::createGUID(32, $prefix);
353 return substr($guid, 0, 8) . '-' . substr($guid, 8, 4) . '-' . substr($guid, 12, 4) . '-' . substr($guid, 16, 4) . '-' . substr($guid, 20, 12);
357 * Generates a GUID with the given parameters
359 * @param int $size The size of the GUID (default is 16)
360 * @param bool|string $prefix A given prefix (default is empty)
361 * @return string a generated GUID
364 public static function createGUID($size = 16, $prefix = '')
366 if (is_bool($prefix) && !$prefix) {
368 } elseif (empty($prefix)) {
369 $prefix = hash('crc32', DI::baseUrl()->getHostname());
372 while (strlen($prefix) < ($size - 13)) {
373 $prefix .= mt_rand();
377 $prefix = substr($prefix, 0, $size - 22);
378 return str_replace('.', '', uniqid($prefix, true));
380 $prefix = substr($prefix, 0, max($size - 13, 0));
381 return uniqid($prefix);
386 * Returns the current Load of the System
390 public static function currentLoad()
392 if (!function_exists('sys_getloadavg')) {
396 $load_arr = sys_getloadavg();
398 if (!is_array($load_arr)) {
402 return max($load_arr[0], $load_arr[1]);
406 * Redirects to an external URL (fully qualified URL)
407 * If you want to route relative to the current Friendica base, use App->internalRedirect()
409 * @param string $url The new Location to redirect
410 * @param int $code The redirection code, which is used (Default is 302)
412 public static function externalRedirect($url, $code = 302)
414 if (empty(parse_url($url, PHP_URL_SCHEME))) {
415 Logger::warning('No fully qualified URL provided', ['url' => $url, 'callstack' => self::callstack(20)]);
416 DI::baseUrl()->redirect($url);
419 header("Location: $url");
423 throw new FoundException();
425 throw new MovedPermanentlyException();
427 throw new TemporaryRedirectException();
434 * Returns the system user that is executing the script
436 * This mostly returns something like "www-data".
438 * @return string system username
440 public static function getUser()
442 if (!function_exists('posix_getpwuid') || !function_exists('posix_geteuid')) {
446 $processUser = posix_getpwuid(posix_geteuid());
447 return $processUser['name'];
451 * Checks if a given directory is usable for the system
454 * @param bool $check_writable
456 * @return boolean the directory is usable
458 public static function isDirectoryUsable($directory, $check_writable = true)
460 if ($directory == '') {
461 Logger::info('Directory is empty. This shouldn\'t happen.');
465 if (!file_exists($directory)) {
466 Logger::info('Path "' . $directory . '" does not exist for user ' . static::getUser());
470 if (is_file($directory)) {
471 Logger::info('Path "' . $directory . '" is a file for user ' . static::getUser());
475 if (!is_dir($directory)) {
476 Logger::info('Path "' . $directory . '" is not a directory for user ' . static::getUser());
480 if ($check_writable && !is_writable($directory)) {
481 Logger::info('Path "' . $directory . '" is not writable for user ' . static::getUser());
489 * Exit method used by asynchronous update modules
493 public static function htmlUpdateExit($o)
495 header("Content-type: text/html");
496 echo "<!DOCTYPE html><html><body>\r\n";
497 // We can remove this hack once Internet Explorer recognises HTML5 natively
499 // reportedly some versions of MSIE don't handle tabs in XMLHttpRequest documents very well
500 echo str_replace("\t", " ", $o);
502 echo "</body></html>\r\n";
507 * Fetch the temp path of the system
509 * @return string Path for temp files
511 public static function getTempPath()
513 $temppath = DI::config()->get("system", "temppath");
515 if (($temppath != "") && System::isDirectoryUsable($temppath)) {
516 // We have a temp path and it is usable
517 return BasePath::getRealPath($temppath);
520 // We don't have a working preconfigured temp path, so we take the system path.
521 $temppath = sys_get_temp_dir();
523 // Check if it is usable
524 if (($temppath != "") && System::isDirectoryUsable($temppath)) {
525 // Always store the real path, not the path through symlinks
526 $temppath = BasePath::getRealPath($temppath);
528 // To avoid any interferences with other systems we create our own directory
529 $new_temppath = $temppath . "/" . DI::baseUrl()->getHostname();
530 if (!is_dir($new_temppath)) {
531 /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
532 mkdir($new_temppath);
535 if (System::isDirectoryUsable($new_temppath)) {
536 // The new path is usable, we are happy
537 DI::config()->set("system", "temppath", $new_temppath);
538 return $new_temppath;
540 // We can't create a subdirectory, strange.
541 // But the directory seems to work, so we use it but don't store it.
546 // Reaching this point means that the operating system is configured badly.
551 * Returns the path where spool files are stored
553 * @return string Spool path
555 public static function getSpoolPath()
557 $spoolpath = DI::config()->get('system', 'spoolpath');
558 if (($spoolpath != "") && System::isDirectoryUsable($spoolpath)) {
559 // We have a spool path and it is usable
563 // We don't have a working preconfigured spool path, so we take the temp path.
564 $temppath = self::getTempPath();
566 if ($temppath != "") {
567 // To avoid any interferences with other systems we create our own directory
568 $spoolpath = $temppath . "/spool";
569 if (!is_dir($spoolpath)) {
573 if (System::isDirectoryUsable($spoolpath)) {
574 // The new path is usable, we are happy
575 DI::config()->set("system", "spoolpath", $spoolpath);
578 // We can't create a subdirectory, strange.
579 // But the directory seems to work, so we use it but don't store it.
584 // Reaching this point means that the operating system is configured badly.