]> git.mxchange.org Git - friendica.git/blobdiff - src/Core/System.php
Moved functions out of boot.php into class
[friendica.git] / src / Core / System.php
index 4ec5b2ad352480fe259757a9e8f84f467f8413ff..5b5fac82f01b520e4f31e86e70904932d719a709 100644 (file)
@@ -5,6 +5,7 @@
 namespace Friendica\Core;
 
 use Friendica\BaseObject;
+use Friendica\Util\XML;
 
 /**
  * @file include/Core/System.php
@@ -26,7 +27,7 @@ class System extends BaseObject
         */
        public static function baseUrl($ssl = false)
        {
-               return self::getApp()->get_baseurl($ssl);
+               return self::getApp()->getBaseURL($ssl);
        }
 
        /**
@@ -38,7 +39,7 @@ class System extends BaseObject
         */
        public static function removedBaseUrl($orig_url)
        {
-               return self::getApp()->remove_baseurl($orig_url);
+               return self::getApp()->removeBaseURL($orig_url);
        }
 
        /**
@@ -54,28 +55,29 @@ class System extends BaseObject
                array_shift($trace);
                array_shift($trace);
 
-               $callstack = array();
+               $callstack = [];
                $counter = 0;
-               $previous = array('class' => '', 'function' => '');
+               $previous = ['class' => '', 'function' => ''];
 
                // The ignore list contains all functions that are only wrapper functions
-               $ignore = array('get_config', 'get_pconfig', 'set_config', 'set_pconfig', 'fetch_url', 'probe_url');
+               $ignore = ['fetchUrl', 'call_user_func_array'];
 
                while ($func = array_pop($trace)) {
                        if (!empty($func['class'])) {
-                               // Don't show multiple calls from the same function (mostly used for "dba" class)
-                               if (($previous['class'] != $func['class']) && ($previous['function'] != 'q')) {
+                               // Don't show multiple calls from the "dba" class to show the essential parts of the callstack
+                               if ((($previous['class'] != $func['class']) || ($func['class'] != 'Friendica\Database\DBA')) && ($previous['function'] != 'q')) {
                                        $classparts = explode("\\", $func['class']);
                                        $callstack[] = array_pop($classparts).'::'.$func['function'];
                                        $previous = $func;
                                }
                        } elseif (!in_array($func['function'], $ignore)) {
                                $callstack[] = $func['function'];
+                               $func['class'] = '';
                                $previous = $func;
                        }
                }
 
-               $callstack2 = array();
+               $callstack2 = [];
                while ((count($callstack2) < $depth) && (count($callstack) > 0)) {
                        $callstack2[] = array_pop($callstack);
                }
@@ -84,22 +86,158 @@ class System extends BaseObject
        }
 
        /**
-        * @brief Called from db initialisation when db is dead.
+        * Generic XML return
+        * Outputs a basic dfrn XML status structure to STDOUT, with a <status> variable
+        * of $st and an optional text <message> of $message and terminates the current process.
         */
-       static public function unavailable() {
-echo <<< EOT
-<html>
-       <head><title>System Unavailable</title></head>
-       <body>Apologies but this site is unavailable at the moment. Please try again later.</body>
-</html>
-EOT;
+       public static function xmlExit($st, $message = '')
+       {
+               $result = ['status' => $st];
+
+               if ($message != '') {
+                       $result['message'] = $message;
+               }
+
+               if ($st) {
+                       logger('xml_status returning non_zero: ' . $st . " message=" . $message);
+               }
+
+               header("Content-type: text/xml");
+
+               $xmldata = ["result" => $result];
+
+               echo XML::fromArray($xmldata, $xml);
 
                killme();
        }
 
+       /**
+        * @brief Send HTTP status header and exit.
+        *
+        * @param integer $val         HTTP status result value
+        * @param array   $description optional message
+        *                             'title' => header title
+        *                             'description' => optional message
+        */
+       public static function httpExit($val, $description = [])
+       {
+               $err = '';
+               if ($val >= 400) {
+                       $err = 'Error';
+                       if (!isset($description["title"])) {
+                               $description["title"] = $err." ".$val;
+                       }
+               }
+
+               if ($val >= 200 && $val < 300) {
+                       $err = 'OK';
+               }
+
+               logger('http_status_exit ' . $val);
+               header($_SERVER["SERVER_PROTOCOL"] . ' ' . $val . ' ' . $err);
+
+               if (isset($description["title"])) {
+                       $tpl = get_markup_template('http_status.tpl');
+                       echo replace_macros($tpl, ['$title' => $description["title"],
+                               '$description' => defaults($description, 'description', '')]);
+               }
+
+               killme();
+       }
+
+       /**
+        * @brief Encodes content to json.
+        *
+        * This function encodes an array to json format
+        * and adds an application/json HTTP header to the output.
+        * After finishing the process is getting killed.
+        *
+        * @param array  $x The input content.
+        * @param string $content_type Type of the input (Default: 'application/json').
+        */
+       public static function jsonExit($x, $content_type = 'application/json') {
+               header("Content-type: $content_type");
+               echo json_encode($x);
+               killme();
+       }
+
+       /**
+        * Generates a random string in the UUID format
+        *
+        * @param bool|string  $prefix   A given prefix (default is empty)
+        * @return string a generated UUID
+        */
+       public static function createUUID($prefix = '')
+       {
+               $guid = System::createGUID(32, $prefix);
+               return substr($guid, 0, 8). '-' . substr($guid, 8, 4) . '-' . substr($guid, 12, 4) . '-' . substr($guid, 16, 4) . '-' . substr($guid, 20, 12);
+       }
+
+       /**
+        * Generates a GUID with the given parameters
+        *
+        * @param int          $size     The size of the GUID (default is 16)
+        * @param bool|string  $prefix   A given prefix (default is empty)
+        * @return string a generated GUID
+        */
+       public static function createGUID($size = 16, $prefix = '')
+       {
+               if (is_bool($prefix) && !$prefix) {
+                       $prefix = '';
+               } elseif (empty($prefix)) {
+                       $prefix = hash('crc32', self::getApp()->getHostName());
+               }
+
+               while (strlen($prefix) < ($size - 13)) {
+                       $prefix .= mt_rand();
+               }
+
+               if ($size >= 24) {
+                       $prefix = substr($prefix, 0, $size - 22);
+                       return str_replace('.', '', uniqid($prefix, true));
+               } else {
+                       $prefix = substr($prefix, 0, max($size - 13, 0));
+                       return uniqid($prefix);
+               }
+       }
+
+       /**
+        * Generates a process identifier for the logging
+        *
+        * @param string $prefix A given prefix
+        *
+        * @return string a generated process identifier
+        */
+       public static function processID($prefix)
+       {
+               // We aren't calling any other function here.
+               // Doing so could easily create an endless loop
+               $trailer = $prefix . ':' . getmypid() . ':';
+               return substr($trailer . uniqid('') . mt_rand(), 0, 26);
+       }
+
+       /**
+        * Returns the current Load of the System
+        *
+        * @return integer
+        */
+       public static function currentLoad()
+       {
+               if (!function_exists('sys_getloadavg')) {
+                       return false;
+               }
+
+               $load_arr = sys_getloadavg();
+
+               if (!is_array($load_arr)) {
+                       return false;
+               }
+
+               return max($load_arr[0], $load_arr[1]);
+       }
+
        /// @todo Move the following functions from boot.php
        /*
-       function get_guid($size = 16, $prefix = "")
        function killme()
        function goaway($s)
        function local_user()
@@ -114,6 +252,5 @@ EOT;
        function get_cachefile($file, $writemode = true)
        function get_itemcachepath()
        function get_spoolpath()
-       function current_load()
        */
 }