]> git.mxchange.org Git - friendica.git/blobdiff - src/Core/System.php
Remove deprecated App::removeBaseURL - process methods to DI::baseUrl()->remove()
[friendica.git] / src / Core / System.php
index d24581e996202a6b54be24bfc626abcfb4fec305..426eb0a53dc42120693b867472d0ee43080b5269 100644 (file)
@@ -4,9 +4,7 @@
  */
 namespace Friendica\Core;
 
-use Friendica\BaseObject;
-use Friendica\Core\Logger;
-use Friendica\Core\Renderer;
+use Friendica\DI;
 use Friendica\Network\HTTPException\InternalServerErrorException;
 use Friendica\Util\XML;
 
@@ -20,17 +18,17 @@ use Friendica\Util\XML;
 /**
  * @brief System methods
  */
-class System extends BaseObject
+class System
 {
        /**
         * @brief Retrieves the Friendica instance base URL
         *
-        * @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
+        * @param bool $ssl Whether to append http or https under BaseURL::SSL_POLICY_SELFSIGN
         * @return string Friendica server base URL
         */
        public static function baseUrl($ssl = false)
        {
-               return self::getApp()->getBaseURL($ssl);
+               return DI::baseUrl()->get($ssl);
        }
 
        /**
@@ -39,10 +37,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)
+       public static function removedBaseUrl(string $orig_url)
        {
-               return self::getApp()->removeBaseURL($orig_url);
+               return DI::baseUrl()->remove($orig_url);
        }
 
        /**
@@ -59,7 +58,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
@@ -92,6 +90,10 @@ class System extends BaseObject
         * 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 = '')
        {
@@ -111,43 +113,33 @@ class System extends BaseObject
 
                echo XML::fromArray($xmldata, $xml);
 
-               killme();
+               exit();
        }
 
        /**
         * @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
+        * @param integer $val     HTTP status result value
+        * @param string  $message Error message. Optional.
+        * @param string  $content Response body. Optional.
+        * @throws \Exception
         */
-       public static function httpExit($val, $description = [])
+       public static function httpExit($val, $message = '', $content = '')
        {
-               $err = '';
-               if ($val >= 400) {
-                       $err = 'Error';
-                       if (!isset($description["title"])) {
-                               $description["title"] = $err." ".$val;
-                       }
-               }
-
-               if ($val >= 200 && $val < 300) {
-                       $err = 'OK';
-               }
-
                Logger::log('http_status_exit ' . $val);
-               header($_SERVER["SERVER_PROTOCOL"] . ' ' . $val . ' ' . $err);
+               header($_SERVER["SERVER_PROTOCOL"] . ' ' . $val . ' ' . $message);
 
-               if (isset($description["title"])) {
-                       $tpl = Renderer::getMarkupTemplate('http_status.tpl');
-                       echo Renderer::replaceMacros($tpl, ['$title' => $description["title"],
-                               '$description' => defaults($description, 'description', '')]);
-               }
+               echo $content;
 
                exit();
        }
 
+       public static function jsonError($httpCode, $data, $content_type = 'application/json')
+       {
+               header($_SERVER["SERVER_PROTOCOL"] . ' ' . $httpCode);
+               self::jsonExit($data, $content_type);
+       }
+
        /**
         * @brief Encodes content to json.
         *
@@ -155,40 +147,42 @@ class System extends BaseObject
         * and adds an application/json HTTP header to the output.
         * After finishing the process is getting killed.
         *
-        * @param array  $x The input content.
+        * @param mixed  $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();
+               exit();
        }
 
        /**
         * Generates a random string in the UUID format
         *
-        * @param bool|string  $prefix   A given prefix (default is empty)
+        * @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);
+               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()->getHostName());
+                       $prefix = hash('crc32', DI::app()->getHostName());
                }
 
                while (strlen($prefix) < ($size - 13)) {
@@ -204,21 +198,6 @@ class System extends BaseObject
                }
        }
 
-       /**
-        * 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
         *
@@ -243,19 +222,89 @@ class System extends BaseObject
         * 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 string $url  The new Location to redirect
+        * @param int    $code The redirection code, which is used (Default is 302)
+        *
         * @throws InternalServerErrorException If the URL is not fully qualified
         */
-       public static function externalRedirect($url)
+       public static function externalRedirect($url, $code = 302)
        {
-               if (!filter_var($url, FILTER_VALIDATE_URL)) {
+               if (empty(parse_url($url, PHP_URL_SCHEME))) {
                        throw new InternalServerErrorException("'$url' is not a fully qualified URL, please use App->internalRedirect() instead");
                }
 
+               switch ($code) {
+                       case 302:
+                               // this is the default code for a REDIRECT
+                               // We don't need a extra header here
+                               break;
+                       case 301:
+                               header('HTTP/1.1 301 Moved Permanently');
+                               break;
+                       case 307:
+                               header('HTTP/1.1 307 Temporary Redirect');
+                               break;
+               }
+
                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()