/**
* @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
* @throws InternalServerErrorException
*/
/**
* @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
- * @throws InternalServerErrorException
+ * @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) {
- 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];
- }
- }
- }
-
- 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.
*
}
}
- /**
- * 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
*
* 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 (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();
}
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()
projects / friendica.git / blobdiff