]> git.mxchange.org Git - friendica.git/blobdiff - src/Core/System.php
Avoid memory issue in exception
[friendica.git] / src / Core / System.php
index 46d1b34e555a6dfe0bf802e7ab3a13593f9f4ef1..f0ed08357359f5cc75f1d3a77652085e35ca657e 100644 (file)
@@ -5,6 +5,7 @@
 namespace Friendica\Core;
 
 use Friendica\BaseObject;
+use Friendica\Network\HTTPException\InternalServerErrorException;
 use Friendica\Util\XML;
 
 /**
@@ -24,10 +25,11 @@ class System extends BaseObject
         *
         * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
         * @return string Friendica server base URL
+        * @throws InternalServerErrorException
         */
        public static function baseUrl($ssl = false)
        {
-               return self::getApp()->get_baseurl($ssl);
+               return self::getApp()->getBaseURL($ssl);
        }
 
        /**
@@ -36,10 +38,11 @@ class System extends BaseObject
         * @param string $orig_url The url to be cleaned
         *
         * @return string The cleaned url
+        * @throws \Exception
         */
        public static function removedBaseUrl($orig_url)
        {
-               return self::getApp()->remove_baseurl($orig_url);
+               return self::getApp()->removeBaseURL($orig_url);
        }
 
        /**
@@ -56,7 +59,6 @@ class System extends BaseObject
                array_shift($trace);
 
                $callstack = [];
-               $counter = 0;
                $previous = ['class' => '', 'function' => ''];
 
                // The ignore list contains all functions that are only wrapper functions
@@ -65,7 +67,7 @@ class System extends BaseObject
                while ($func = array_pop($trace)) {
                        if (!empty($func['class'])) {
                                // Don't show multiple calls from the "dba" class to show the essential parts of the callstack
-                               if ((($previous['class'] != $func['class']) || ($func['class'] != 'dba')) && ($previous['function'] != 'q')) {
+                               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;
@@ -85,24 +87,14 @@ class System extends BaseObject
                return implode(', ', $callstack2);
        }
 
-       /**
-        * @brief Called from db initialisation when db is dead.
-        */
-       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;
-
-               killme();
-       }
-
        /**
         * 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.
+        *
+        * @param        $st
+        * @param string $message
+        * @throws \Exception
         */
        public static function xmlExit($st, $message = '')
        {
@@ -113,7 +105,7 @@ EOT;
                }
 
                if ($st) {
-                       logger('xml_status returning non_zero: ' . $st . " message=" . $message);
+                       Logger::log('xml_status returning non_zero: ' . $st . " message=" . $message);
                }
 
                header("Content-type: text/xml");
@@ -122,7 +114,7 @@ EOT;
 
                echo XML::fromArray($xmldata, $xml);
 
-               killme();
+               exit();
        }
 
        /**
@@ -132,14 +124,39 @@ EOT;
         * @param array   $description optional message
         *                             'title' => header title
         *                             'description' => optional message
+        * @throws InternalServerErrorException
         */
        public static function httpExit($val, $description = [])
        {
                $err = '';
                if ($val >= 400) {
-                       $err = 'Error';
-                       if (!isset($description["title"])) {
-                               $description["title"] = $err." ".$val;
+                       if (!empty($description['title'])) {
+                               $err = $description['title'];
+                       } else {
+                               $title = [
+                                       '400' => L10n::t('Error 400 - Bad Request'),
+                                       '401' => L10n::t('Error 401 - Unauthorized'),
+                                       '403' => L10n::t('Error 403 - Forbidden'),
+                                       '404' => L10n::t('Error 404 - Not Found'),
+                                       '500' => L10n::t('Error 500 - Internal Server Error'),
+                                       '503' => L10n::t('Error 503 - Service Unavailable'),
+                                       ];
+                               $err = defaults($title, $val, 'Error ' . $val);
+                               $description['title'] = $err;
+                       }
+                       if (empty($description['description'])) {
+                               // Explanations are taken from https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
+                               $explanation = [
+                                       '400' => L10n::t('The server cannot or will not process the request due to an apparent client error.'),
+                                       '401' => L10n::t('Authentication is required and has failed or has not yet been provided.'),
+                                       '403' => L10n::t('The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource, or may need an account.'),
+                                       '404' => L10n::t('The requested resource could not be found but may be available in the future.'),
+                                       '500' => L10n::t('An unexpected condition was encountered and no more specific message is suitable.'),
+                                       '503' => L10n::t('The server is currently unavailable (because it is overloaded or down for maintenance). Please try again later.'),
+                                       ];
+                               if (!empty($explanation[$val])) {
+                                       $description['description'] = $explanation[$val];
+                               }
                        }
                }
 
@@ -147,16 +164,16 @@ EOT;
                        $err = 'OK';
                }
 
-               logger('http_status_exit ' . $val);
+               Logger::log('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"],
+                       $tpl = Renderer::getMarkupTemplate('http_status.tpl');
+                       echo Renderer::replaceMacros($tpl, ['$title' => $description["title"],
                                '$description' => defaults($description, 'description', '')]);
                }
 
-               killme();
+               exit();
        }
 
        /**
@@ -172,22 +189,36 @@ EOT;
        public static function jsonExit($x, $content_type = 'application/json') {
                header("Content-type: $content_type");
                echo json_encode($x);
-               killme();
+               exit();
+       }
+
+       /**
+        * Generates a random string in the UUID format
+        *
+        * @param bool|string $prefix A given prefix (default is empty)
+        * @return string a generated UUID
+        * @throws \Exception
+        */
+       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)
+        * @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
+        * @throws \Exception
         */
        public static function createGUID($size = 16, $prefix = '')
        {
                if (is_bool($prefix) && !$prefix) {
                        $prefix = '';
                } elseif (empty($prefix)) {
-                       $prefix = hash('crc32', self::getApp()->get_hostname());
+                       $prefix = hash('crc32', self::getApp()->getHostName());
                }
 
                while (strlen($prefix) < ($size - 13)) {
@@ -203,22 +234,126 @@ EOT;
                }
        }
 
+       /**
+        * 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]);
+       }
+
+       /**
+        * 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
+        * @throws InternalServerErrorException If the URL is not fully qualified
+        */
+       public static function externalRedirect($url)
+       {
+               if (empty(parse_url($url, PHP_URL_SCHEME))) {
+                       throw new InternalServerErrorException("'$url' is not a fully qualified URL, please use App->internalRedirect() instead");
+               }
+
+               header("Location: $url");
+               exit();
+       }
+
+       /**
+        * @brief Returns the system user that is executing the script
+        *
+        * This mostly returns something like "www-data".
+        *
+        * @return string system username
+        */
+       public static function getUser()
+       {
+               if (!function_exists('posix_getpwuid') || !function_exists('posix_geteuid')) {
+                       return '';
+               }
+
+               $processUser = posix_getpwuid(posix_geteuid());
+               return $processUser['name'];
+       }
+
+       /**
+        * @brief Checks if a given directory is usable for the system
+        *
+        * @param      $directory
+        * @param bool $check_writable
+        *
+        * @return boolean the directory is usable
+        */
+       public static function isDirectoryUsable($directory, $check_writable = true)
+       {
+               if ($directory == '') {
+                       Logger::log('Directory is empty. This shouldn\'t happen.', Logger::DEBUG);
+                       return false;
+               }
+
+               if (!file_exists($directory)) {
+                       Logger::log('Path "' . $directory . '" does not exist for user ' . static::getUser(), Logger::DEBUG);
+                       return false;
+               }
+
+               if (is_file($directory)) {
+                       Logger::log('Path "' . $directory . '" is a file for user ' . static::getUser(), Logger::DEBUG);
+                       return false;
+               }
+
+               if (!is_dir($directory)) {
+                       Logger::log('Path "' . $directory . '" is not a directory for user ' . static::getUser(), Logger::DEBUG);
+                       return false;
+               }
+
+               if ($check_writable && !is_writable($directory)) {
+                       Logger::log('Path "' . $directory . '" is not writable for user ' . static::getUser(), Logger::DEBUG);
+                       return false;
+               }
+
+               return true;
+       }
+
        /// @todo Move the following functions from boot.php
        /*
        function killme()
-       function goaway($s)
        function local_user()
        function public_contact()
        function remote_user()
        function notice($s)
        function info($s)
        function is_site_admin()
-       function random_digits($digits)
        function get_server()
        function get_temppath()
        function get_cachefile($file, $writemode = true)
        function get_itemcachepath()
        function get_spoolpath()
-       function current_load()
        */
 }