Cleaning up clientError and serverError
This commit is contained in:
parent
ece8ba8ea4
commit
cf0570fc99
@ -56,8 +56,7 @@ class ApiStatusesFavsAction extends ApiAuthAction
|
||||
|
||||
if (empty($this->original)) {
|
||||
// TRANS: Client error displayed trying to display redents of a non-exiting notice.
|
||||
$this->clientError(_('No such notice.'),
|
||||
400, $this->format);
|
||||
$this->clientError(_('No such notice.'), 400, $this->format);
|
||||
return false;
|
||||
}
|
||||
|
||||
|
@ -61,11 +61,13 @@ class Action extends HTMLOutputter // lawsuit
|
||||
protected $ajax = false;
|
||||
protected $menus = true;
|
||||
protected $needLogin = false;
|
||||
protected $needPost = false;
|
||||
|
||||
// The currently scoped profile (normally Profile::current; from $this->auth_user for API)
|
||||
protected $scoped = null;
|
||||
|
||||
// Messages to the front-end user
|
||||
// Related to front-end user representation
|
||||
protected $format = null;
|
||||
protected $error = null;
|
||||
protected $msg = null;
|
||||
|
||||
@ -132,6 +134,10 @@ class Action extends HTMLOutputter // lawsuit
|
||||
*/
|
||||
protected function prepare(array $args=array())
|
||||
{
|
||||
if ($this->needPost && !$this->isPost()) {
|
||||
$this->clientError(_('This method requires a POST.'), 400, $this->format);
|
||||
}
|
||||
|
||||
$this->args = common_copy_args($args);
|
||||
|
||||
$this->action = $this->trimmed('action');
|
||||
@ -1353,27 +1359,100 @@ class Action extends HTMLOutputter // lawsuit
|
||||
*
|
||||
* @return nothing
|
||||
*/
|
||||
function serverError($msg, $code=500)
|
||||
function serverError($msg, $code=500, $format=null)
|
||||
{
|
||||
$action = $this->trimmed('action');
|
||||
common_debug("Server error '$code' on '$action': $msg", __FILE__);
|
||||
if ($format === null) {
|
||||
$format = $this->format;
|
||||
}
|
||||
|
||||
common_debug("Server error '{$code}' on '{$this->action}': {$msg}", __FILE__);
|
||||
|
||||
if (!array_key_exists($code, ServerErrorAction::$status)) {
|
||||
$code = 500;
|
||||
}
|
||||
|
||||
$status_string = ServerErrorAction::$status[$code];
|
||||
|
||||
switch ($format) {
|
||||
case 'xml':
|
||||
header("HTTP/1.1 {$code} {$status_string}");
|
||||
$this->initDocument('xml');
|
||||
$this->elementStart('hash');
|
||||
$this->element('error', null, $msg);
|
||||
$this->element('request', null, $_SERVER['REQUEST_URI']);
|
||||
$this->elementEnd('hash');
|
||||
$this->endDocument('xml');
|
||||
break;
|
||||
case 'json':
|
||||
if (!isset($this->callback)) {
|
||||
header("HTTP/1.1 {$code} {$status_string}");
|
||||
}
|
||||
$this->initDocument('json');
|
||||
$error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
|
||||
print(json_encode($error_array));
|
||||
$this->endDocument('json');
|
||||
break;
|
||||
default:
|
||||
throw new ServerException($msg, $code);
|
||||
}
|
||||
|
||||
exit((int)$code);
|
||||
}
|
||||
|
||||
/**
|
||||
* Client error
|
||||
*
|
||||
* @param string $msg error message to display
|
||||
* @param integer $code http error code, 400 by default
|
||||
* @param string $format error format (json, xml, text) for ApiAction
|
||||
*
|
||||
* @return nothing
|
||||
* @throws ClientException always
|
||||
*/
|
||||
function clientError($msg, $code=400)
|
||||
function clientError($msg, $code=400, $format=null)
|
||||
{
|
||||
$action = $this->trimmed('action');
|
||||
common_debug("User error '$code' on '$action': $msg", __FILE__);
|
||||
// $format is currently only relevant for an ApiAction anyway
|
||||
if ($format === null) {
|
||||
$format = $this->format;
|
||||
}
|
||||
|
||||
common_debug("User error '{$code}' on '{$this->action}': {$msg}", __FILE__);
|
||||
|
||||
if (!array_key_exists($code, ClientErrorAction::$status)) {
|
||||
$code = 400;
|
||||
}
|
||||
|
||||
$status_string = ClientErrorAction::$status[$code];
|
||||
|
||||
switch ($format) {
|
||||
case 'xml':
|
||||
header("HTTP/1.1 {$code} {$status_string}");
|
||||
$this->initDocument('xml');
|
||||
$this->elementStart('hash');
|
||||
$this->element('error', null, $msg);
|
||||
$this->element('request', null, $_SERVER['REQUEST_URI']);
|
||||
$this->elementEnd('hash');
|
||||
$this->endDocument('xml');
|
||||
break;
|
||||
case 'json':
|
||||
if (!isset($this->callback)) {
|
||||
header("HTTP/1.1 {$code} {$status_string}");
|
||||
}
|
||||
$this->initDocument('json');
|
||||
$error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
|
||||
$this->text(json_encode($error_array));
|
||||
$this->endDocument('json');
|
||||
break;
|
||||
case 'text':
|
||||
header("HTTP/1.1 {$code} {$status_string}");
|
||||
header('Content-Type: text/plain; charset=utf-8');
|
||||
echo $msg;
|
||||
break;
|
||||
default:
|
||||
throw new ClientException($msg, $code);
|
||||
}
|
||||
exit((int)$code);
|
||||
}
|
||||
|
||||
/**
|
||||
* If not logged in, take appropriate action (redir or exception)
|
||||
|
@ -119,7 +119,6 @@ class ApiAction extends Action
|
||||
const READ_ONLY = 1;
|
||||
const READ_WRITE = 2;
|
||||
|
||||
var $format = null;
|
||||
var $user = null;
|
||||
var $auth_user = null;
|
||||
var $page = null;
|
||||
@ -1352,86 +1351,6 @@ class ApiAction extends Action
|
||||
return;
|
||||
}
|
||||
|
||||
function clientError($msg, $code = 400, $format = null)
|
||||
{
|
||||
$action = $this->trimmed('action');
|
||||
if ($format === null) {
|
||||
$format = $this->format;
|
||||
}
|
||||
|
||||
common_debug("User error '$code' on '$action': $msg", __FILE__);
|
||||
|
||||
if (!array_key_exists($code, ClientErrorAction::$status)) {
|
||||
$code = 400;
|
||||
}
|
||||
|
||||
$status_string = ClientErrorAction::$status[$code];
|
||||
|
||||
// Do not emit error header for JSONP
|
||||
if (!isset($this->callback)) {
|
||||
header('HTTP/1.1 ' . $code . ' ' . $status_string);
|
||||
}
|
||||
|
||||
switch($format) {
|
||||
case 'xml':
|
||||
$this->initDocument('xml');
|
||||
$this->elementStart('hash');
|
||||
$this->element('error', null, $msg);
|
||||
$this->element('request', null, $_SERVER['REQUEST_URI']);
|
||||
$this->elementEnd('hash');
|
||||
$this->endDocument('xml');
|
||||
break;
|
||||
case 'json':
|
||||
$this->initDocument('json');
|
||||
$error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
|
||||
print(json_encode($error_array));
|
||||
$this->endDocument('json');
|
||||
break;
|
||||
case 'text':
|
||||
header('Content-Type: text/plain; charset=utf-8');
|
||||
print $msg;
|
||||
break;
|
||||
default:
|
||||
// If user didn't request a useful format, throw a regular client error
|
||||
throw new ClientException($msg, $code);
|
||||
}
|
||||
}
|
||||
|
||||
function serverError($msg, $code = 500, $content_type = null)
|
||||
{
|
||||
$action = $this->trimmed('action');
|
||||
if ($content_type === null) {
|
||||
$content_type = $this->format;
|
||||
}
|
||||
|
||||
common_debug("Server error '$code' on '$action': $msg", __FILE__);
|
||||
|
||||
if (!array_key_exists($code, ServerErrorAction::$status)) {
|
||||
$code = 400;
|
||||
}
|
||||
|
||||
$status_string = ServerErrorAction::$status[$code];
|
||||
|
||||
// Do not emit error header for JSONP
|
||||
if (!isset($this->callback)) {
|
||||
header('HTTP/1.1 '.$code.' '.$status_string);
|
||||
}
|
||||
|
||||
if ($content_type == 'xml') {
|
||||
$this->initDocument('xml');
|
||||
$this->elementStart('hash');
|
||||
$this->element('error', null, $msg);
|
||||
$this->element('request', null, $_SERVER['REQUEST_URI']);
|
||||
$this->elementEnd('hash');
|
||||
$this->endDocument('xml');
|
||||
} else {
|
||||
$this->initDocument('json');
|
||||
$error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
|
||||
print(json_encode($error_array));
|
||||
$this->endDocument('json');
|
||||
}
|
||||
}
|
||||
|
||||
function initTwitterRss()
|
||||
{
|
||||
$this->startXML();
|
||||
|
Loading…
Reference in New Issue
Block a user