src/Core/System.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  *
  20  */
  21
  22 namespace Friendica\Core;
  23
  24 use Friendica\Content\Text\BBCode;
  25 use Friendica\Content\Text\HTML;
  26 use Friendica\Core\Config\Capability\IManageConfigValues;
  27 use Friendica\DI;
  28 use Friendica\Module\Response;
  29 use Friendica\Network\HTTPException\FoundException;
  30 use Friendica\Network\HTTPException\MovedPermanentlyException;
  31 use Friendica\Network\HTTPException\TemporaryRedirectException;
  32 use Friendica\Util\BasePath;
  33 use Friendica\Util\XML;
  34 use Psr\Log\LoggerInterface;
  35
  36 /**
  37  * Contains the class with system relevant stuff
  38  */
  39 class System
  40 {
  41         /**
  42          * @var LoggerInterface
  43          */
  44         private $logger;
  45
  46         /**
  47          * @var IManageConfigValues
  48          */
  49         private $config;
  50
  51         /**
  52          * @var string
  53          */
  54         private $basePath;
  55
  56         public function __construct(LoggerInterface $logger, IManageConfigValues $config, string $basepath)
  57         {
  58                 $this->logger   = $logger;
  59                 $this->config   = $config;
  60                 $this->basePath = $basepath;
  61         }
  62
  63         /**
  64          * Checks if the maximum number of database processes is reached
  65          *
  66          * @return bool Is the limit reached?
  67          */
  68         public function isMaxProcessesReached(): bool
  69         {
  70                 // Deactivated, needs more investigating if this check really makes sense
  71                 return false;
  72
  73                 /*
  74                  * Commented out to suppress static analyzer issues
  75                  *
  76                 if ($this->mode->isBackend()) {
  77                         $process = 'backend';
  78                         $max_processes = $this->config->get('system', 'max_processes_backend');
  79                         if (intval($max_processes) == 0) {
  80                                 $max_processes = 5;
  81                         }
  82                 } else {
  83                         $process = 'frontend';
  84                         $max_processes = $this->config->get('system', 'max_processes_frontend');
  85                         if (intval($max_processes) == 0) {
  86                                 $max_processes = 20;
  87                         }
  88                 }
  89
  90                 $processlist = DBA::processlist();
  91                 if ($processlist['list'] != '') {
  92                         $this->logger->debug('Processcheck: Processes: ' . $processlist['amount'] . ' - Processlist: ' . $processlist['list']);
  93
  94                         if ($processlist['amount'] > $max_processes) {
  95                                 $this->logger->debug('Processcheck: Maximum number of processes for ' . $process . ' tasks (' . $max_processes . ') reached.');
  96                                 return true;
  97                         }
  98                 }
  99                 return false;
 100                  */
 101         }
 102
 103         /**
 104          * Checks if the minimal memory is reached
 105          *
 106          * @return bool Is the memory limit reached?
 107          */
 108         public function isMinMemoryReached(): bool
 109         {
 110                 // Deactivated, needs more investigating if this check really makes sense
 111                 return false;
 112
 113                 /*
 114                  * Commented out to suppress static analyzer issues
 115                  *
 116                 $min_memory = $this->config->get('system', 'min_memory', 0);
 117                 if ($min_memory == 0) {
 118                         return false;
 119                 }
 120
 121                 if (!is_readable('/proc/meminfo')) {
 122                         return false;
 123                 }
 124
 125                 $memdata = explode("\n", file_get_contents('/proc/meminfo'));
 126
 127                 $meminfo = [];
 128                 foreach ($memdata as $line) {
 129                         $data = explode(':', $line);
 130                         if (count($data) != 2) {
 131                                 continue;
 132                         }
 133                         [$key, $val]     = $data;
 134                         $meminfo[$key]   = (int)trim(str_replace('kB', '', $val));
 135                         $meminfo[$key]   = (int)($meminfo[$key] / 1024);
 136                 }
 137
 138                 if (!isset($meminfo['MemFree'])) {
 139                         return false;
 140                 }
 141
 142                 $free = $meminfo['MemFree'];
 143
 144                 $reached = ($free < $min_memory);
 145
 146                 if ($reached) {
 147                         $this->logger->warning('Minimal memory reached.', ['free' => $free, 'memtotal' => $meminfo['MemTotal'], 'limit' => $min_memory]);
 148                 }
 149
 150                 return $reached;
 151                  */
 152         }
 153
 154         /**
 155          * Checks if the maximum load is reached
 156          *
 157          * @return bool Is the load reached?
 158          */
 159         public function isMaxLoadReached(): bool
 160         {
 161                 $maxsysload = intval($this->config->get('system', 'maxloadavg'));
 162                 if ($maxsysload < 1) {
 163                         $maxsysload = 50;
 164                 }
 165
 166                 $load = System::currentLoad();
 167                 if ($load) {
 168                         if (intval($load) > $maxsysload) {
 169                                 $this->logger->notice('system load for process too high.', ['load' => $load, 'process' => 'backend', 'maxsysload' => $maxsysload]);
 170                                 return true;
 171                         }
 172                 }
 173                 return false;
 174         }
 175
 176         /**
 177          * Executes a child process with 'proc_open'
 178          *
 179          * @param string $command The command to execute
 180          * @param array  $args    Arguments to pass to the command ( [ 'key' => value, 'key2' => value2, ... ]
 181          */
 182         public function run(string $command, array $args)
 183         {
 184                 if (!function_exists('proc_open')) {
 185                         $this->logger->warning('"proc_open" not available - quitting');
 186                         return;
 187                 }
 188
 189                 $cmdline = $this->config->get('config', 'php_path', 'php') . ' ' . escapeshellarg($command);
 190
 191                 foreach ($args as $key => $value) {
 192                         if (!is_null($value) && is_bool($value) && !$value) {
 193                                 continue;
 194                         }
 195
 196                         $cmdline .= ' --' . $key;
 197                         if (!is_null($value) && !is_bool($value)) {
 198                                 $cmdline .= ' ' . $value;
 199                         }
 200                 }
 201
 202                 if ($this->isMinMemoryReached()) {
 203                         $this->logger->warning('Memory limit reached - quitting');
 204                         return;
 205                 }
 206
 207                 if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
 208                         $resource = proc_open('cmd /c start /b ' . $cmdline, [], $foo, $this->basePath);
 209                 } else {
 210                         $resource = proc_open($cmdline . ' &', [], $foo, $this->basePath);
 211                 }
 212
 213                 if (!is_resource($resource)) {
 214                         $this->logger->warning('We got no resource for command.', ['command' => $cmdline]);
 215                         return;
 216                 }
 217
 218                 proc_close($resource);
 219
 220                 $this->logger->info('Executed "proc_open"', ['command' => $cmdline, 'callstack' => System::callstack(10)]);
 221         }
 222
 223         /**
 224          * Returns a string with a callstack. Can be used for logging.
 225          *
 226          * @param integer $depth  How many calls to include in the stacks after filtering
 227          * @param int     $offset How many calls to shave off the top of the stack, for example if
 228          *                        this is called from a centralized method that isn't relevant to the callstack
 229          * @return string
 230          */
 231         public static function callstack(int $depth = 4, int $offset = 0): string
 232         {
 233                 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
 234
 235                 // We remove at least the first two items from the list since they contain data that we don't need.
 236                 $trace = array_slice($trace, 2 + $offset);
 237
 238                 $callstack = [];
 239                 $previous = ['class' => '', 'function' => '', 'database' => false];
 240
 241                 // The ignore list contains all functions that are only wrapper functions
 242                 $ignore = ['call_user_func_array'];
 243
 244                 while ($func = array_pop($trace)) {
 245                         if (!empty($func['class'])) {
 246                                 if (in_array($previous['function'], ['insert', 'fetch', 'toArray', 'exists', 'count', 'selectFirst', 'selectToArray',
 247                                         'select', 'update', 'delete', 'selectFirstForUser', 'selectForUser'])
 248                                         && (substr($previous['class'], 0, 15) === 'Friendica\Model')) {
 249                                         continue;
 250                                 }
 251
 252                                 // Don't show multiple calls from the Database classes to show the essential parts of the callstack
 253                                 $func['database'] = in_array($func['class'], ['Friendica\Database\DBA', 'Friendica\Database\Database']);
 254                                 if (!$previous['database'] || !$func['database']) {
 255                                         $classparts = explode("\\", $func['class']);
 256                                         $callstack[] = array_pop($classparts).'::'.$func['function'] . (isset($func['line']) ? ' (' . $func['line'] . ')' : '');
 257                                         $previous = $func;
 258                                 }
 259                         } elseif (!in_array($func['function'], $ignore)) {
 260                                 $func['database'] = ($func['function'] == 'q');
 261                                 $callstack[] = $func['function'] . (isset($func['line']) ? ' (' . $func['line'] . ')' : '');
 262                                 $func['class'] = '';
 263                                 $previous = $func;
 264                         }
 265                 }
 266
 267                 $callstack2 = [];
 268                 while ((count($callstack2) < $depth) && (count($callstack) > 0)) {
 269                         $callstack2[] = array_pop($callstack);
 270                 }
 271
 272                 return implode(', ', $callstack2);
 273         }
 274
 275         /**
 276          * Generic XML return
 277          * Outputs a basic dfrn XML status structure to STDOUT, with a <status> variable
 278          * of $st and an optional text <message> of $message and terminates the current process.
 279          *
 280          * @param        $st
 281          * @param string $message
 282          * @throws \Exception
 283          */
 284         public static function xmlExit($st, $message = '')
 285         {
 286                 $result = ['status' => $st];
 287
 288                 if ($message != '') {
 289                         $result['message'] = $message;
 290                 }
 291
 292                 if ($st) {
 293                         Logger::notice('xml_status returning non_zero: ' . $st . " message=" . $message);
 294                 }
 295
 296                 DI::apiResponse()->setType(Response::TYPE_XML);
 297                 DI::apiResponse()->addContent(XML::fromArray(['result' => $result]));
 298                 DI::page()->exit(DI::apiResponse()->generate());
 299
 300                 self::exit();
 301         }
 302
 303         /**
 304          * Send HTTP status header and exit.
 305          *
 306          * @param integer $val     HTTP status result value
 307          * @param string  $message Error message. Optional.
 308          * @param string  $content Response body. Optional.
 309          * @throws \Exception
 310          */
 311         public static function httpError($httpCode, $message = '', $content = '')
 312         {
 313                 if ($httpCode >= 400) {
 314                         Logger::debug('Exit with error', ['code' => $httpCode, 'message' => $message, 'callstack' => System::callstack(20), 'method' => DI::args()->getMethod(), 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '']);
 315                 }
 316                 DI::apiResponse()->setStatus($httpCode, $message);
 317                 DI::apiResponse()->addContent($content);
 318                 DI::page()->exit(DI::apiResponse()->generate());
 319
 320                 self::exit();
 321         }
 322
 323         /**
 324          * This function adds the content and a content-type HTTP header to the output.
 325          * After finishing the process is getting killed.
 326          *
 327          * @param string $content
 328          * @param string $type
 329          * @param string|null $content_type
 330          * @return void
 331          */
 332         public static function httpExit(string $content, string $type = Response::TYPE_HTML, ?string $content_type = null) {
 333                 DI::apiResponse()->setType($type, $content_type);
 334                 DI::apiResponse()->addContent($content);
 335                 DI::page()->exit(DI::apiResponse()->generate());
 336
 337                 self::exit();
 338         }
 339
 340         public static function jsonError($httpCode, $content, $content_type = 'application/json')
 341         {
 342                 if ($httpCode >= 400) {
 343                         Logger::debug('Exit with error', ['code' => $httpCode, 'content_type' => $content_type, 'callstack' => System::callstack(20), 'method' => DI::args()->getMethod(), 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '']);
 344                 }
 345                 DI::apiResponse()->setStatus($httpCode);
 346                 self::jsonExit($content, $content_type);
 347         }
 348
 349         /**
 350          * Encodes content to json.
 351          *
 352          * This function encodes an array to json format
 353          * and adds an application/json HTTP header to the output.
 354          * After finishing the process is getting killed.
 355          *
 356          * @param mixed   $content      The input content
 357          * @param string  $content_type Type of the input (Default: 'application/json')
 358          * @param integer $options      JSON options
 359          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 360          */
 361         public static function jsonExit($content, $content_type = 'application/json', int $options = JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT) {
 362                 DI::apiResponse()->setType(Response::TYPE_JSON, $content_type);
 363                 DI::apiResponse()->addContent(json_encode($content, $options));
 364                 DI::page()->exit(DI::apiResponse()->generate());
 365
 366                 self::exit();
 367         }
 368
 369         /**
 370          * Exit the program execution.
 371          */
 372         public static function exit()
 373         {
 374                 DI::page()->logRuntime(DI::config(), 'exit');
 375                 exit();
 376         }
 377
 378         /**
 379          * Generates a random string in the UUID format
 380          *
 381          * @param bool|string $prefix A given prefix (default is empty)
 382          * @return string a generated UUID
 383          * @throws \Exception
 384          */
 385         public static function createUUID($prefix = '')
 386         {
 387                 $guid = System::createGUID(32, $prefix);
 388                 return substr($guid, 0, 8) . '-' . substr($guid, 8, 4) . '-' . substr($guid, 12, 4) . '-' . substr($guid, 16, 4) . '-' . substr($guid, 20, 12);
 389         }
 390
 391         /**
 392          * Generates a GUID with the given parameters
 393          *
 394          * @param int         $size   The size of the GUID (default is 16)
 395          * @param bool|string $prefix A given prefix (default is empty)
 396          * @return string a generated GUID
 397          * @throws \Exception
 398          */
 399         public static function createGUID($size = 16, $prefix = '')
 400         {
 401                 if (is_bool($prefix) && !$prefix) {
 402                         $prefix = '';
 403                 } elseif (empty($prefix)) {
 404                         $prefix = hash('crc32', DI::baseUrl()->getHost());
 405                 }
 406
 407                 while (strlen($prefix) < ($size - 13)) {
 408                         $prefix .= mt_rand();
 409                 }
 410
 411                 if ($size >= 24) {
 412                         $prefix = substr($prefix, 0, $size - 22);
 413                         return str_replace('.', '', uniqid($prefix, true));
 414                 } else {
 415                         $prefix = substr($prefix, 0, max($size - 13, 0));
 416                         return uniqid($prefix);
 417                 }
 418         }
 419
 420         /**
 421          * Returns the current Load of the System
 422          *
 423          * @return integer
 424          */
 425         public static function currentLoad()
 426         {
 427                 if (!function_exists('sys_getloadavg')) {
 428                         return false;
 429                 }
 430
 431                 $load_arr = sys_getloadavg();
 432
 433                 if (!is_array($load_arr)) {
 434                         return false;
 435                 }
 436
 437                 return max($load_arr[0], $load_arr[1]);
 438         }
 439
 440         /**
 441          * Fetch the load and number of processes
 442          *
 443          * @param bool $get_processes
 444          * @return array
 445          */
 446         public static function getLoadAvg(bool $get_processes = true): array
 447         {
 448                 $load_arr = sys_getloadavg();
 449                 if (empty($load_arr)) {
 450                         return [];
 451                 }
 452
 453                 $load = [
 454                         'average1'  => $load_arr[0],
 455                         'average5'  => $load_arr[1],
 456                         'average15' => $load_arr[2],
 457                         'runnable'  => 0,
 458                         'scheduled' => 0
 459                 ];
 460
 461                 if ($get_processes && @is_readable('/proc/loadavg')) {
 462                         $content = @file_get_contents('/proc/loadavg');
 463                         if (!empty($content) && preg_match("#([.\d]+)\s([.\d]+)\s([.\d]+)\s(\d+)/(\d+)#", $content, $matches)) {
 464                                 $load['runnable']  = (float)$matches[4];
 465                                 $load['scheduled'] = (float)$matches[5];
 466                         }
 467                 }
 468
 469                 return $load;
 470         }
 471
 472         /**
 473          * Redirects to an external URL (fully qualified URL)
 474          * If you want to route relative to the current Friendica base, use App->internalRedirect()
 475          *
 476          * @param string $url  The new Location to redirect
 477          * @param int    $code The redirection code, which is used (Default is 302)
 478          *
 479          * @throws FoundException
 480          * @throws MovedPermanentlyException
 481          * @throws TemporaryRedirectException
 482          *
 483          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 484          */
 485         public static function externalRedirect($url, $code = 302)
 486         {
 487                 if (empty(parse_url($url, PHP_URL_SCHEME))) {
 488                         Logger::warning('No fully qualified URL provided', ['url' => $url, 'callstack' => self::callstack(20)]);
 489                         DI::baseUrl()->redirect($url);
 490                 }
 491
 492                 header("Location: $url");
 493
 494                 switch ($code) {
 495                         case 302:
 496                                 throw new FoundException();
 497                         case 301:
 498                                 throw new MovedPermanentlyException();
 499                         case 307:
 500                                 throw new TemporaryRedirectException();
 501                 }
 502                 self::exit();
 503         }
 504
 505         /**
 506          * Returns the system user that is executing the script
 507          *
 508          * This mostly returns something like "www-data".
 509          *
 510          * @return string system username
 511          */
 512         public static function getUser()
 513         {
 514                 if (!function_exists('posix_getpwuid') || !function_exists('posix_geteuid')) {
 515                         return '';
 516                 }
 517
 518                 $processUser = posix_getpwuid(posix_geteuid());
 519                 return $processUser['name'];
 520         }
 521
 522         /**
 523          * Checks if a given directory is usable for the system
 524          *
 525          * @param      $directory
 526          *
 527          * @return boolean the directory is usable
 528          */
 529         private static function isDirectoryUsable(string $directory): bool
 530         {
 531                 if (empty($directory)) {
 532                         Logger::warning('Directory is empty. This shouldn\'t happen.');
 533                         return false;
 534                 }
 535
 536                 if (!file_exists($directory)) {
 537                         Logger::info('Path does not exist', ['directory' => $directory, 'user' => static::getUser()]);
 538                         return false;
 539                 }
 540
 541                 if (is_file($directory)) {
 542                         Logger::warning('Path is a file', ['directory' => $directory, 'user' => static::getUser()]);
 543                         return false;
 544                 }
 545
 546                 if (!is_dir($directory)) {
 547                         Logger::warning('Path is not a directory', ['directory' => $directory, 'user' => static::getUser()]);
 548                         return false;
 549                 }
 550
 551                 if (!is_writable($directory)) {
 552                         Logger::warning('Path is not writable', ['directory' => $directory, 'user' => static::getUser()]);
 553                         return false;
 554                 }
 555
 556                 return true;
 557         }
 558
 559         /**
 560          * Exit method used by asynchronous update modules
 561          *
 562          * @param string $o
 563          */
 564         public static function htmlUpdateExit($o)
 565         {
 566                 DI::apiResponse()->setType(Response::TYPE_HTML);
 567                 echo "<!DOCTYPE html><html><body>\r\n";
 568                 // We can remove this hack once Internet Explorer recognises HTML5 natively
 569                 echo "<section>";
 570                 // reportedly some versions of MSIE don't handle tabs in XMLHttpRequest documents very well
 571                 echo str_replace("\t", "       ", $o);
 572                 echo "</section>";
 573                 echo "</body></html>\r\n";
 574                 self::exit();
 575         }
 576
 577         /**
 578          * Fetch the temp path of the system
 579          *
 580          * @return string Path for temp files
 581          */
 582         public static function getTempPath()
 583         {
 584                 $temppath = DI::config()->get("system", "temppath");
 585
 586                 if (($temppath != "") && self::isDirectoryUsable($temppath)) {
 587                         // We have a temp path and it is usable
 588                         return BasePath::getRealPath($temppath);
 589                 }
 590
 591                 // We don't have a working preconfigured temp path, so we take the system path.
 592                 $temppath = sys_get_temp_dir();
 593
 594                 // Check if it is usable
 595                 if (($temppath != "") && self::isDirectoryUsable($temppath)) {
 596                         // Always store the real path, not the path through symlinks
 597                         $temppath = BasePath::getRealPath($temppath);
 598
 599                         // To avoid any interferences with other systems we create our own directory
 600                         $new_temppath = $temppath . "/" . DI::baseUrl()->getHost();
 601                         if (!is_dir($new_temppath)) {
 602                                 /// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
 603                                 @mkdir($new_temppath);
 604                         }
 605
 606                         if (self::isDirectoryUsable($new_temppath)) {
 607                                 // The new path is usable, we are happy
 608                                 DI::config()->set("system", "temppath", $new_temppath);
 609                                 return $new_temppath;
 610                         } else {
 611                                 // We can't create a subdirectory, strange.
 612                                 // But the directory seems to work, so we use it but don't store it.
 613                                 return $temppath;
 614                         }
 615                 }
 616
 617                 // Reaching this point means that the operating system is configured badly.
 618                 return '';
 619         }
 620
 621         /**
 622          * Returns the path where spool files are stored
 623          *
 624          * @return string Spool path
 625          */
 626         public static function getSpoolPath()
 627         {
 628                 $spoolpath = DI::config()->get('system', 'spoolpath');
 629                 if (($spoolpath != "") && self::isDirectoryUsable($spoolpath)) {
 630                         // We have a spool path and it is usable
 631                         return $spoolpath;
 632                 }
 633
 634                 // We don't have a working preconfigured spool path, so we take the temp path.
 635                 $temppath = self::getTempPath();
 636
 637                 if ($temppath != "") {
 638                         // To avoid any interferences with other systems we create our own directory
 639                         $spoolpath = $temppath . "/spool";
 640                         if (!is_dir($spoolpath)) {
 641                                 mkdir($spoolpath);
 642                         }
 643
 644                         if (self::isDirectoryUsable($spoolpath)) {
 645                                 // The new path is usable, we are happy
 646                                 DI::config()->set("system", "spoolpath", $spoolpath);
 647                                 return $spoolpath;
 648                         } else {
 649                                 // We can't create a subdirectory, strange.
 650                                 // But the directory seems to work, so we use it but don't store it.
 651                                 return $temppath;
 652                         }
 653                 }
 654
 655                 // Reaching this point means that the operating system is configured badly.
 656                 return "";
 657         }
 658
 659         /**
 660          * Fetch the system rules
 661          * @param bool $numeric_id If set to "true", the rules are returned with a numeric id as key.
 662          *
 663          * @return array
 664          */
 665         public static function getRules(bool $numeric_id = false): array
 666         {
 667                 $rules = [];
 668                 $id    = 0;
 669
 670                 if (DI::config()->get('system', 'tosdisplay')) {
 671                         $rulelist = DI::config()->get('system', 'tosrules') ?: DI::config()->get('system', 'tostext');
 672                         $html = BBCode::convert($rulelist, false, BBCode::EXTERNAL);
 673
 674                         $msg = HTML::toPlaintext($html, 0, true);
 675                         foreach (explode("\n", trim($msg)) as $line) {
 676                                 $line = trim($line);
 677                                 if ($line) {
 678                                         if ($numeric_id) {
 679                                                 $rules[++$id] = $line;
 680                                         } else {
 681                                                 $rules[] = ['id' => (string)++$id, 'text' => $line];
 682                                         }
 683                                 }
 684                         }
 685                 }
 686
 687                 return $rules;
 688         }
 689 }