Logger::warning(API_LOG_PREFIX . 'not implemented', ['module' => 'api', 'action' => 'call', 'query' => DI::args()->getQueryString()]);
throw new NotFoundException();
} catch (HTTPException $e) {
- header("HTTP/1.1 {$e->getCode()} {$e->httpdesc}");
+ header("HTTP/1.1 {$e->getCode()} {$e->getDescription()}");
return api_error($type, $e, $args);
}
}
public static function content(array $parameters = [])
{
if (!local_user()) {
- $e = new HTTPException\ForbiddenException(DI::l10n()->t('Only logged in users are permitted to perform a probing.'));
- $e->httpdesc = DI::l10n()->t('Public access denied.');
- throw $e;
+ throw new HTTPException\ForbiddenException(DI::l10n()->t('Only logged in users are permitted to perform a probing.'));
}
$addr = $_GET['addr'] ?? '';
public static function content(array $parameters = [])
{
if (!local_user()) {
- $e = new \Friendica\Network\HTTPException\ForbiddenException(DI::l10n()->t('Only logged in users are permitted to perform a probing.'));
- $e->httpdesc = DI::l10n()->t('Public access denied.');
- throw $e;
+ throw new \Friendica\Network\HTTPException\ForbiddenException(DI::l10n()->t('Only logged in users are permitted to perform a probing.'));
}
$addr = $_GET['addr'] ?? '';
}
if (DI::config()->get('system', 'local_search') && !Session::isAuthenticated()) {
- $e = new HTTPException\ForbiddenException(DI::l10n()->t('Only logged in users are permitted to perform a search.'));
- $e->httpdesc = DI::l10n()->t('Public access denied.');
- throw $e;
+ throw new HTTPException\ForbiddenException(DI::l10n()->t('Only logged in users are permitted to perform a search.'));
}
if (DI::config()->get('system', 'permit_crawling') && !Session::isAuthenticated()) {
{
// Explanations are mostly taken from https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
$vars = [
- '$title' => $e->httpdesc ?: 'Error ' . $e->getCode(),
- '$message' => $e->getMessage() ?: $e->explanation,
+ '$title' => $e->getDescription() ?: 'Error ' . $e->getCode(),
+ '$message' => $e->getMessage() ?: $e->getExplanation(),
'$back' => DI::l10n()->t('Go back'),
'$stack_trace' => DI::l10n()->t('Stack trace:'),
];
$content = Renderer::replaceMacros($tpl, self::getVars($e));
}
- System::httpExit($e->getCode(), $e->httpdesc, $content);
+ System::httpExit($e->getCode(), $e->getDescription(), $content);
}
/**
*/
public static function content(\Friendica\Network\HTTPException $e)
{
- header($_SERVER["SERVER_PROTOCOL"] . ' ' . $e->getCode() . ' ' . $e->httpdesc);
+ header($_SERVER["SERVER_PROTOCOL"] . ' ' . $e->getCode() . ' ' . $e->getDescription());
if ($e->getCode() >= 400) {
- Logger::debug('Exit with error', ['code' => $e->getCode(), 'description' => $e->httpdesc, 'query' => DI::args()->getQueryString(), 'callstack' => System::callstack(20), 'method' => $_SERVER['REQUEST_METHOD'], 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '']);
+ Logger::debug('Exit with error', ['code' => $e->getCode(), 'description' => $e->getDescription(), 'query' => DI::args()->getQueryString(), 'callstack' => System::callstack(20), 'method' => $_SERVER['REQUEST_METHOD'], 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '']);
}
$tpl = Renderer::getMarkupTemplate('exception.tpl');
*/
abstract class HTTPException extends Exception
{
- public $httpdesc = '';
- public $explanation = '';
+ protected $httpdesc = '';
+ protected $explanation = '';
public function __construct($message = '', Exception $previous = null)
{
parent::__construct($message, $this->code, $previous);
}
+
+ public function getDescription()
+ {
+ return $this->httpdesc;
+ }
+
+ public function getExplanation()
+ {
+ return $this->explanation;
+ }
}
class AcceptedException extends HTTPException
{
- protected $code = 202;
- var $httpdesc = 'Accepted';
+ protected $code = 202;
+ protected $httpdesc = 'Accepted';
}
class BadGatewayException extends HTTPException
{
- protected $code = 502;
- var $httpdesc = 'Bad Gateway';
- var $explanation = 'The server was acting as a gateway or proxy and received an invalid response from the upstream server.';
+ protected $code = 502;
+ protected $httpdesc = 'Bad Gateway';
+ protected $explanation = 'The server was acting as a gateway or proxy and received an invalid response from the upstream server.';
}
class BadRequestException extends HTTPException
{
- protected $code = 400;
- var $httpdesc = 'Bad Request';
- var $explanation = 'The server cannot or will not process the request due to an apparent client error.';
+ protected $code = 400;
+ protected $httpdesc = 'Bad Request';
+ protected $explanation = 'The server cannot or will not process the request due to an apparent client error.';
}
class ConflictException extends HTTPException
{
- protected $code = 409;
- var $httpdesc = 'Conflict ';
- var $explanation = 'Indicates that the request could not be processed because of conflict in the current state of the resource, such as an edit conflict between multiple simultaneous updates.';
+ protected $code = 409;
+ protected $httpdesc = 'Conflict ';
+ protected $explanation = 'Indicates that the request could not be processed because of conflict in the current state of the resource, such as an edit conflict between multiple simultaneous updates.';
}
class ExpectationFailedException extends HTTPException
{
- protected $code = 417;
- var $httpdesc = 'Expectation Failed';
- var $explanation = 'The server cannot meet the requirements of the Expect request-header field.';
+ protected $code = 417;
+ protected $httpdesc = 'Expectation Failed';
+ protected $explanation = 'The server cannot meet the requirements of the Expect request-header field.';
}
class ForbiddenException extends HTTPException
{
- protected $code = 403;
- var $httpdesc = 'Forbidden';
- var $explanation = '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.';
+ protected $code = 403;
+ protected $httpdesc = 'Forbidden';
+ protected $explanation = '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.';
}
class FoundException extends HTTPException
{
- protected $code = 302;
- var $httpdesc = 'Found (Moved Temporarily)';
+ protected $code = 302;
+ protected $httpdesc = 'Found (Moved Temporarily)';
}
class GatewayTimeoutException extends HTTPException
{
- protected $code = 504;
- var $httpdesc = 'Gateway Timeout';
- var $explanation = 'The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.';
+ protected $code = 504;
+ protected $httpdesc = 'Gateway Timeout';
+ protected $explanation = 'The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.';
}
class GoneException extends HTTPException
{
- protected $code = 410;
- var $httpdesc = 'Gone';
- var $explanation = 'Indicates that the resource requested is no longer available and will not be available again.';
+ protected $code = 410;
+ protected $httpdesc = 'Gone';
+ protected $explanation = 'Indicates that the resource requested is no longer available and will not be available again.';
}
class ImATeapotException extends HTTPException
{
- protected $code = 418;
- var $httpdesc = "I'm A Teapot";
- var $explanation = 'This is a teapot that is requested to brew coffee.';
+ protected $code = 418;
+ protected $httpdesc = "I'm A Teapot";
+ protected $explanation = 'This is a teapot that is requested to brew coffee.';
}
class InternalServerErrorException extends HTTPException
{
- protected $code = 500;
- var $httpdesc = 'Internal Server Error';
- var $explanation = 'An unexpected condition was encountered and no more specific message is suitable.';
+ protected $code = 500;
+ protected $httpdesc = 'Internal Server Error';
+ protected $explanation = 'An unexpected condition was encountered and no more specific message is suitable.';
}
class LenghtRequiredException extends HTTPException
{
- protected $code = 411;
- var $httpdesc = 'Length Required';
- var $explanation = 'The request did not specify the length of its content, which is required by the requested resource.';
+ protected $code = 411;
+ protected $httpdesc = 'Length Required';
+ protected $explanation = 'The request did not specify the length of its content, which is required by the requested resource.';
}
class MethodNotAllowedException extends HTTPException
{
- protected $code = 405;
- var $httpdesc = 'Method Not Allowed';
- var $explanation = 'A request method is not supported for the requested resource; for example, a GET request on a form that requires data to be presented via POST, or a PUT request on a read-only resource.';
+ protected $code = 405;
+ protected $httpdesc = 'Method Not Allowed';
+ protected $explanation = 'A request method is not supported for the requested resource; for example, a GET request on a form that requires data to be presented via POST, or a PUT request on a read-only resource.';
}
class MovedPermanentlyException extends HTTPException
{
- protected $code = 301;
- var $httpdesc = 'Moved Permanently';
+ protected $code = 301;
+ protected $httpdesc = 'Moved Permanently';
}
class NoContentException extends HTTPException
{
- protected $code = 204;
- var $httpdesc = 'No Content';
+ protected $code = 204;
+ protected $httpdesc = 'No Content';
}
class NonAcceptableException extends HTTPException
{
- protected $code = 406;
- var $httpdesc = 'Not Acceptable';
- var $explanation = 'The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.';
+ protected $code = 406;
+ protected $httpdesc = 'Not Acceptable';
+ protected $explanation = 'The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.';
}
class NotFoundException extends HTTPException
{
- protected $code = 404;
- var $httpdesc = 'Not Found';
- var $explanation = 'The requested resource could not be found but may be available in the future.';
+ protected $code = 404;
+ protected $httpdesc = 'Not Found';
+ protected $explanation = 'The requested resource could not be found but may be available in the future.';
}
class NotImplementedException extends HTTPException
{
- protected $code = 501;
- var $httpdesc = 'Not Implemented';
- var $explanation = 'The server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).';
+ protected $code = 501;
+ protected $httpdesc = 'Not Implemented';
+ protected $explanation = 'The server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).';
}
class NotModifiedException extends HTTPException
{
- protected $code = 304;
- var $httpdesc = 'Not Modified';
+ protected $code = 304;
+ protected $httpdesc = 'Not Modified';
}
class OKException extends HTTPException
{
- protected $code = 200;
- var $httpdesc = 'OK';
+ protected $code = 200;
+ protected $httpdesc = 'OK';
}
class PreconditionFailedException extends HTTPException
{
- protected $code = 412;
- var $httpdesc = 'Precondition Failed';
- var $explanation = 'The server does not meet one of the preconditions that the requester put on the request header fields.';
+ protected $code = 412;
+ protected $httpdesc = 'Precondition Failed';
+ protected $explanation = 'The server does not meet one of the preconditions that the requester put on the request header fields.';
}
class ServiceUnavailableException extends HTTPException
{
- protected $code = 503;
- var $httpdesc = 'Service Unavailable';
- var $explanation = 'The server is currently unavailable (because it is overloaded or down for maintenance). Please try again later.';
+ protected $code = 503;
+ protected $httpdesc = 'Service Unavailable';
+ protected $explanation = 'The server is currently unavailable (because it is overloaded or down for maintenance). Please try again later.';
}
class TemporaryRedirectException extends HTTPException
{
- protected $code = 307;
- var $httpdesc = 'Temporary Redirect';
+ protected $code = 307;
+ protected $httpdesc = 'Temporary Redirect';
}
class TooManyRequestsException extends HTTPException
{
- protected $code = 429;
- var $httpdesc = 'Too Many Requests';
- var $explanation = 'The user has sent too many requests in a given amount of time.';
+ protected $code = 429;
+ protected $httpdesc = 'Too Many Requests';
+ protected $explanation = 'The user has sent too many requests in a given amount of time.';
}
class UnauthorizedException extends HTTPException
{
- protected $code = 401;
- var $httpdesc = 'Unauthorized';
- var $explanation = 'Authentication is required and has failed or has not yet been provided.';
+ protected $code = 401;
+ protected $httpdesc = 'Unauthorized';
+ protected $explanation = 'Authentication is required and has failed or has not yet been provided.';
}
class UnprocessableEntityException extends HTTPException
{
- protected $code = 422;
- var $httpdesc = 'Unprocessable Entity';
- var $explanation = 'The request was well-formed but was unable to be followed due to semantic errors.';
+ protected $code = 422;
+ protected $httpdesc = 'Unprocessable Entity';
+ protected $explanation = 'The request was well-formed but was unable to be followed due to semantic errors.';
}
class UnsupportedMediaTypeException extends HTTPException
{
- protected $code = 415;
- var $httpdesc = 'Unsupported Media Type';
- var $explanation = 'The request entity has a media type which the server or resource does not support. For example, the client uploads an image as image/svg+xml, but the server requires that images use a different format.';
+ protected $code = 415;
+ protected $httpdesc = 'Unsupported Media Type';
+ protected $explanation = 'The request entity has a media type which the server or resource does not support. For example, the client uploads an image as image/svg+xml, but the server requires that images use a different format.';
}