X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FCore%2FSystem.php;h=f0ed08357359f5cc75f1d3a77652085e35ca657e;hb=4facd1dfdba93ede48ca40b5e146424e6701118b;hp=5b5fac82f01b520e4f31e86e70904932d719a709;hpb=74c5f1f684a8b8bd357329f0feb409fbc1aa6042;p=friendica.git diff --git a/src/Core/System.php b/src/Core/System.php index 5b5fac82f0..f0ed083573 100644 --- a/src/Core/System.php +++ b/src/Core/System.php @@ -5,6 +5,7 @@ namespace Friendica\Core; use Friendica\BaseObject; +use Friendica\Network\HTTPException\InternalServerErrorException; use Friendica\Util\XML; /** @@ -24,6 +25,7 @@ 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) { @@ -36,6 +38,7 @@ 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) { @@ -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 @@ -89,6 +91,10 @@ class System extends BaseObject * Generic XML return * Outputs a basic dfrn XML status structure to STDOUT, with a variable * of $st and an optional text of $message and terminates the current process. + * + * @param $st + * @param string $message + * @throws \Exception */ public static function xmlExit($st, $message = '') { @@ -99,7 +105,7 @@ class System extends BaseObject } 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"); @@ -108,7 +114,7 @@ class System extends BaseObject echo XML::fromArray($xmldata, $xml); - killme(); + exit(); } /** @@ -118,14 +124,39 @@ class System extends BaseObject * @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]; + } } } @@ -133,16 +164,16 @@ class System extends BaseObject $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(); } /** @@ -158,27 +189,29 @@ class System extends BaseObject 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 = '') { @@ -236,17 +269,87 @@ class System extends BaseObject 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)