From cf0570fc99236fa882e7efb530c7d05becfbef4a Mon Sep 17 00:00:00 2001 From: Mikael Nordfeldth Date: Mon, 7 Oct 2013 19:44:57 +0200 Subject: [PATCH] Cleaning up clientError and serverError --- actions/apistatusesfavs.php | 3 +- lib/action.php | 107 +++++++++++++++++++++++++++++++----- lib/apiaction.php | 81 --------------------------- 3 files changed, 94 insertions(+), 97 deletions(-) diff --git a/actions/apistatusesfavs.php b/actions/apistatusesfavs.php index 626ea3786c..9f3593593b 100644 --- a/actions/apistatusesfavs.php +++ b/actions/apistatusesfavs.php @@ -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; } diff --git a/lib/action.php b/lib/action.php index d16edfd804..bcd6aab26d 100644 --- a/lib/action.php +++ b/lib/action.php @@ -61,13 +61,15 @@ 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 - protected $error = null; - protected $msg = null; + // Related to front-end user representation + protected $format = null; + protected $error = null; + protected $msg = null; /** * Constructor @@ -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'); @@ -425,7 +431,7 @@ class Action extends HTMLOutputter // lawsuit $messages = array_merge($messages, $this->getScriptMessages()); - Event::handle('EndScriptMessages', array($this, &$messages)); + Event::handle('EndScriptMessages', array($this, &$messages)); } if (!empty($messages)) { @@ -1353,26 +1359,99 @@ 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__); - throw new ServerException($msg, $code); + 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 $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__); - throw new ClientException($msg, $code); + // $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); } /** diff --git a/lib/apiaction.php b/lib/apiaction.php index 0bafd8fdbb..538b172203 100644 --- a/lib/apiaction.php +++ b/lib/apiaction.php @@ -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();