]> git.mxchange.org Git - friendica.git/blobdiff - src/Core/System.php
Use toConfigValue in case of serialized, legacy data
[friendica.git] / src / Core / System.php
index 9002c5a7b370c44c0f97b543ecc55d6396632ca0..f94004a880ab10a047935c653432cb887cc25aab 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2010-2021, the Friendica project
+ * @copyright Copyright (C) 2010-2023, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
 
 namespace Friendica\Core;
 
-use Exception;
-use Friendica\App;
+use Friendica\Content\Text\BBCode;
+use Friendica\Content\Text\HTML;
 use Friendica\Core\Config\Capability\IManageConfigValues;
 use Friendica\DI;
+use Friendica\Module\Response;
 use Friendica\Network\HTTPException\FoundException;
 use Friendica\Network\HTTPException\MovedPermanentlyException;
 use Friendica\Network\HTTPException\TemporaryRedirectException;
@@ -106,6 +107,12 @@ class System
         */
        public function isMinMemoryReached(): bool
        {
+               // Deactivated, needs more investigating if this check really makes sense
+               return false;
+
+               /*
+                * Commented out to suppress static analyzer issues
+                *
                $min_memory = $this->config->get('system', 'min_memory', 0);
                if ($min_memory == 0) {
                        return false;
@@ -141,6 +148,7 @@ class System
                }
 
                return $reached;
+                */
        }
 
        /**
@@ -243,7 +251,7 @@ class System
 
                                // Don't show multiple calls from the Database classes to show the essential parts of the callstack
                                $func['database'] = in_array($func['class'], ['Friendica\Database\DBA', 'Friendica\Database\Database']);
-                               if (!$previous['database'] || !$func['database']) {     
+                               if (!$previous['database'] || !$func['database']) {
                                        $classparts = explode("\\", $func['class']);
                                        $callstack[] = array_pop($classparts).'::'.$func['function'];
                                        $previous = $func;
@@ -285,13 +293,11 @@ class System
                        Logger::notice('xml_status returning non_zero: ' . $st . " message=" . $message);
                }
 
-               header("Content-type: text/xml");
+               DI::apiResponse()->setType(Response::TYPE_XML);
+               DI::apiResponse()->addContent(XML::fromArray(['result' => $result]));
+               DI::page()->exit(DI::apiResponse()->generate());
 
-               $xmldata = ["result" => $result];
-
-               echo XML::fromArray($xmldata, $xml);
-
-               exit();
+               self::exit();
        }
 
        /**
@@ -302,25 +308,42 @@ class System
         * @param string  $content Response body. Optional.
         * @throws \Exception
         */
-       public static function httpExit($val, $message = '', $content = '')
+       public static function httpError($httpCode, $message = '', $content = '')
        {
-               if ($val >= 400) {
-                       Logger::debug('Exit with error', ['code' => $val, 'message' => $message, 'callstack' => System::callstack(20), 'method' => $_SERVER['REQUEST_METHOD'], 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '']);
+               if ($httpCode >= 400) {
+                       Logger::debug('Exit with error', ['code' => $httpCode, 'message' => $message, 'callstack' => System::callstack(20), 'method' => DI::args()->getMethod(), 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '']);
                }
-               header($_SERVER["SERVER_PROTOCOL"] . ' ' . $val . ' ' . $message);
+               DI::apiResponse()->setStatus($httpCode, $message);
+               DI::apiResponse()->addContent($content);
+               DI::page()->exit(DI::apiResponse()->generate());
 
-               echo $content;
+               self::exit();
+       }
 
-               exit();
+       /**
+        * This function adds the content and a content-teype HTTP header to the output.
+        * After finishing the process is getting killed.
+        *
+        * @param string $content
+        * @param string $type
+        * @param string|null $content_type
+        * @return void
+        */
+       public static function httpExit(string $content, string $type = Response::TYPE_HTML, ?string $content_type = null) {
+               DI::apiResponse()->setType($type, $content_type);
+               DI::apiResponse()->addContent($content);
+               DI::page()->exit(DI::apiResponse()->generate());
+
+               self::exit();
        }
 
-       public static function jsonError($httpCode, $data, $content_type = 'application/json')
+       public static function jsonError($httpCode, $content, $content_type = 'application/json')
        {
                if ($httpCode >= 400) {
-                       Logger::debug('Exit with error', ['code' => $httpCode, 'content_type' => $content_type, 'callstack' => System::callstack(20), 'method' => $_SERVER['REQUEST_METHOD'], 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '']);
+                       Logger::debug('Exit with error', ['code' => $httpCode, 'content_type' => $content_type, 'callstack' => System::callstack(20), 'method' => DI::args()->getMethod(), 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '']);
                }
-               header($_SERVER["SERVER_PROTOCOL"] . ' ' . $httpCode);
-               self::jsonExit($data, $content_type);
+               DI::apiResponse()->setStatus($httpCode);
+               self::jsonExit($content, $content_type);
        }
 
        /**
@@ -330,13 +353,25 @@ class System
         * and adds an application/json HTTP header to the output.
         * After finishing the process is getting killed.
         *
-        * @param mixed   $x The input content.
-        * @param string  $content_type Type of the input (Default: 'application/json').
-        * @param integer $options JSON options
+        * @param mixed   $content      The input content
+        * @param string  $content_type Type of the input (Default: 'application/json')
+        * @param integer $options      JSON options
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        */
+       public static function jsonExit($content, $content_type = 'application/json', int $options = JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT) {
+               DI::apiResponse()->setType(Response::TYPE_JSON, $content_type);
+               DI::apiResponse()->addContent(json_encode($content, $options));
+               DI::page()->exit(DI::apiResponse()->generate());
+
+               self::exit();
+       }
+
+       /**
+        * Exit the program execution.
         */
-       public static function jsonExit($x, $content_type = 'application/json', int $options = 0) {
-               header("Content-type: $content_type");
-               echo json_encode($x, $options);
+       public static function exit()
+       {
+               DI::page()->logRuntime(DI::config(), 'exit');
                exit();
        }
 
@@ -402,12 +437,56 @@ class System
                return max($load_arr[0], $load_arr[1]);
        }
 
+       /**
+        * Fetch the load and number of processes
+        *
+        * @param bool $get_processes
+        * @return array
+        */
+       public static function getLoadAvg(bool $get_processes = true): array
+       {
+               if ($get_processes && @is_readable('/proc/loadavg')) {
+                       $content = @file_get_contents('/proc/loadavg');
+                       if (empty($content)) {
+                               $content = shell_exec('uptime | sed "s/.*averages*: //" | sed "s/,//g"');
+                       }
+               }
+
+               if (empty($content) || !preg_match("#([.\d]+)\s([.\d]+)\s([.\d]+)\s(\d+)/(\d+)#", $content, $matches)) {
+                       $load_arr = sys_getloadavg();
+                       if (empty($load_arr)) {
+                               return [];
+                       }
+                       return [
+                               'average1'  => $load_arr[0],
+                               'average5'  => $load_arr[1],
+                               'average15' => $load_arr[2],
+                               'runnable'  => 0,
+                               'scheduled' => 0
+                       ];
+               }
+
+               return [
+                       'average1'  => (float)$matches[1],
+                       'average5'  => (float)$matches[2],
+                       'average15' => (float)$matches[3],
+                       'runnable'  => (float)$matches[4],
+                       'scheduled' => (float)$matches[5]
+               ];
+       }
+
        /**
         * Redirects to an external URL (fully qualified URL)
         * If you want to route relative to the current Friendica base, use App->internalRedirect()
         *
         * @param string $url  The new Location to redirect
         * @param int    $code The redirection code, which is used (Default is 302)
+        *
+        * @throws FoundException
+        * @throws MovedPermanentlyException
+        * @throws TemporaryRedirectException
+        *
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function externalRedirect($url, $code = 302)
        {
@@ -426,8 +505,7 @@ class System
                        case 307:
                                throw new TemporaryRedirectException();
                }
-
-               exit();
+               self::exit();
        }
 
        /**
@@ -455,30 +533,30 @@ class System
         *
         * @return boolean the directory is usable
         */
-       public static function isDirectoryUsable($directory, $check_writable = true)
+       private static function isDirectoryUsable($directory, $check_writable = true)
        {
                if ($directory == '') {
-                       Logger::info('Directory is empty. This shouldn\'t happen.');
+                       Logger::warning('Directory is empty. This shouldn\'t happen.');
                        return false;
                }
 
                if (!file_exists($directory)) {
-                       Logger::info('Path "' . $directory . '" does not exist for user ' . static::getUser());
+                       Logger::warning('Path does not exist', ['directory' => $directory, 'user' => static::getUser()]);
                        return false;
                }
 
                if (is_file($directory)) {
-                       Logger::info('Path "' . $directory . '" is a file for user ' . static::getUser());
+                       Logger::warning('Path is a file', ['directory' => $directory, 'user' => static::getUser()]);
                        return false;
                }
 
                if (!is_dir($directory)) {
-                       Logger::info('Path "' . $directory . '" is not a directory for user ' . static::getUser());
+                       Logger::warning('Path is not a directory', ['directory' => $directory, 'user' => static::getUser()]);
                        return false;
                }
 
                if ($check_writable && !is_writable($directory)) {
-                       Logger::info('Path "' . $directory . '" is not writable for user ' . static::getUser());
+                       Logger::warning('Path is not writable', ['directory' => $directory, 'user' => static::getUser()]);
                        return false;
                }
 
@@ -492,7 +570,7 @@ class System
         */
        public static function htmlUpdateExit($o)
        {
-               header("Content-type: text/html");
+               DI::apiResponse()->setType(Response::TYPE_HTML);
                echo "<!DOCTYPE html><html><body>\r\n";
                // We can remove this hack once Internet Explorer recognises HTML5 natively
                echo "<section>";
@@ -500,7 +578,7 @@ class System
                echo str_replace("\t", "       ", $o);
                echo "</section>";
                echo "</body></html>\r\n";
-               exit();
+               self::exit();
        }
 
        /**
@@ -512,7 +590,7 @@ class System
        {
                $temppath = DI::config()->get("system", "temppath");
 
-               if (($temppath != "") && System::isDirectoryUsable($temppath)) {
+               if (($temppath != "") && self::isDirectoryUsable($temppath)) {
                        // We have a temp path and it is usable
                        return BasePath::getRealPath($temppath);
                }
@@ -521,7 +599,7 @@ class System
                $temppath = sys_get_temp_dir();
 
                // Check if it is usable
-               if (($temppath != "") && System::isDirectoryUsable($temppath)) {
+               if (($temppath != "") && self::isDirectoryUsable($temppath)) {
                        // Always store the real path, not the path through symlinks
                        $temppath = BasePath::getRealPath($temppath);
 
@@ -532,7 +610,7 @@ class System
                                mkdir($new_temppath);
                        }
 
-                       if (System::isDirectoryUsable($new_temppath)) {
+                       if (self::isDirectoryUsable($new_temppath)) {
                                // The new path is usable, we are happy
                                DI::config()->set("system", "temppath", $new_temppath);
                                return $new_temppath;
@@ -555,7 +633,7 @@ class System
        public static function getSpoolPath()
        {
                $spoolpath = DI::config()->get('system', 'spoolpath');
-               if (($spoolpath != "") && System::isDirectoryUsable($spoolpath)) {
+               if (($spoolpath != "") && self::isDirectoryUsable($spoolpath)) {
                        // We have a spool path and it is usable
                        return $spoolpath;
                }
@@ -570,7 +648,7 @@ class System
                                mkdir($spoolpath);
                        }
 
-                       if (System::isDirectoryUsable($spoolpath)) {
+                       if (self::isDirectoryUsable($spoolpath)) {
                                // The new path is usable, we are happy
                                DI::config()->set("system", "spoolpath", $spoolpath);
                                return $spoolpath;
@@ -584,4 +662,35 @@ class System
                // Reaching this point means that the operating system is configured badly.
                return "";
        }
+
+       /**
+        * Fetch the system rules
+        * @param bool $numeric_id If set to "true", the rules are returned with a numeric id as key.
+        *
+        * @return array
+        */
+       public static function getRules(bool $numeric_id = false): array
+       {
+               $rules = [];
+               $id    = 0;
+
+               if (DI::config()->get('system', 'tosdisplay')) {
+                       $rulelist = DI::config()->get('system', 'tosrules') ?: DI::config()->get('system', 'tostext');
+                       $html = BBCode::convert($rulelist, false, BBCode::EXTERNAL);
+
+                       $msg = HTML::toPlaintext($html, 0, true);
+                       foreach (explode("\n", trim($msg)) as $line) {
+                               $line = trim($line);
+                               if ($line) {
+                                       if ($numeric_id) {
+                                               $rules[++$id] = $line;
+                                       } else {
+                                               $rules[] = ['id' => (string)++$id, 'text' => $line];
+                                       }
+                               }
+                       }
+               }
+
+               return $rules;
+       }
 }