From 8990aaebb4a52d38ba6b58338f19366509e0b37a Mon Sep 17 00:00:00 2001
From: Zach Copley <zach@controlyourself.ca>
Date: Thu, 22 Jan 2009 03:13:11 -0800
Subject: [PATCH] New HTTP error message classes for uiredesign
---
actions/clienterror.php | 94 +++++++++++++++++++++++++++++++++++++++++
actions/servererror.php | 92 ++++++++++++++++++++++++++++++++++++++++
lib/htmloutputter.php | 12 ++++++
3 files changed, 198 insertions(+)
create mode 100644 actions/clienterror.php
create mode 100644 actions/servererror.php
diff --git a/actions/clienterror.php b/actions/clienterror.php
new file mode 100644
index 0000000000..ef6fd51dff
--- /dev/null
+++ b/actions/clienterror.php
@@ -0,0 +1,94 @@
+<?php
+
+/**
+ * Client error action.
+ *
+ * PHP version 5
+ *
+ * @category Action
+ * @package Laconica
+ * @author Evan Prodromou <evan@controlyourself.ca>
+ * @author Zach Copley <zach@controlyourself.ca>
+ * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link http://laconi.ca/
+ *
+ * Laconica - a distributed open-source microblogging tool
+ * Copyright (C) 2008, Controlez-Vous, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+if (!defined('LACONICA')) {
+ exit(1);
+}
+
+require_once INSTALLDIR.'/lib/error.php';
+
+/**
+ * Class for displaying HTTP client errors
+ *
+ * @category Action
+ * @package Laconica
+ * @author Zach Copley <zach@controlyourself.ca>
+ * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link http://laconi.ca/
+ */
+class ClientErrorAction extends ErrorAction
+{
+ function __construct($message='Error', $code=400)
+ {
+ parent::__construct($message, $code);
+
+ $this->status = array(400 => 'Bad Request',
+ 401 => 'Unauthorized',
+ 402 => 'Payment Required',
+ 403 => 'Forbidden',
+ 404 => 'Not Found',
+ 405 => 'Method Not Allowed',
+ 406 => 'Not Acceptable',
+ 407 => 'Proxy Authentication Required',
+ 408 => 'Request Timeout',
+ 409 => 'Conflict',
+ 410 => 'Gone',
+ 411 => 'Length Required',
+ 412 => 'Precondition Failed',
+ 413 => 'Request Entity Too Large',
+ 414 => 'Request-URI Too Long',
+ 415 => 'Unsupported Media Type',
+ 416 => 'Requested Range Not Satisfiable',
+ 417 => 'Expectation Failed');
+ $this->default = 400;
+ }
+
+ // XXX: Should these error actions even be invokable via URI?
+
+ function handle($args)
+ {
+ parent::handle($args);
+
+ $this->code = $this->trimmed('code');
+
+ if (!$this->code || $code < 400 || $code > 499) {
+ $this->code = $this->default;
+ }
+
+ $this->message = $this->trimmed('message');
+
+ if (!$this->message) {
+ $this->message = "Client Error $this->code";
+ }
+
+ $this->showPage();
+ }
+}
diff --git a/actions/servererror.php b/actions/servererror.php
new file mode 100644
index 0000000000..a398865915
--- /dev/null
+++ b/actions/servererror.php
@@ -0,0 +1,92 @@
+<?php
+
+/**
+ * Server error action.
+ *
+ * PHP version 5
+ *
+ * @category Action
+ * @package Laconica
+ * @author Evan Prodromou <evan@controlyourself.ca>
+ * @author Zach Copley <zach@controlyourself.ca>
+ * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link http://laconi.ca/
+ *
+ * Laconica - a distributed open-source microblogging tool
+ * Copyright (C) 2008, Controlez-Vous, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+if (!defined('LACONICA')) {
+ exit(1);
+}
+
+require_once INSTALLDIR.'/lib/error.php';
+
+/**
+ * Class for displaying HTTP server errors
+ *
+ * Note: The older util.php class simply printed a string, but the spec
+ * says that 500 errors should be treated similarly to 400 errors, and
+ * it's easier to give an HTML response. Maybe we can customize these
+ * to display some funny animal cartoons. If not, we can probably role
+ * these classes up into a single class.
+ *
+ * See: http://tools.ietf.org/html/rfc2616#section-10
+ *
+ * @category Action
+ * @package Laconica
+ * @author Zach Copley <zach@controlyourself.ca>
+ * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link http://laconi.ca/
+ */
+class ServerErrorAction extends ErrorAction
+{
+ function __construct($message='Error', $code=500)
+ {
+ parent::__construct($message, $code);
+
+ $this->status = array(500 => 'Internal Server Error',
+ 501 => 'Not Implemented',
+ 502 => 'Bad Gateway',
+ 503 => 'Service Unavailable',
+ 504 => 'Gateway Timeout',
+ 505 => 'HTTP Version Not Supported');
+
+ $this->default = 500;
+ }
+
+ // XXX: Should these error actions even be invokable via URI?
+
+ function handle($args)
+ {
+ parent::handle($args);
+
+ $this->code = $this->trimmed('code');
+
+ if (!$this->code || $code < 500 || $code > 599) {
+ $this->code = $this->default;
+ }
+
+ $this->message = $this->trimmed('message');
+
+ if (!$this->message) {
+ $this->message = "Server Error $this->code";
+ }
+
+ $this->showPage();
+ }
+
+}
diff --git a/lib/htmloutputter.php b/lib/htmloutputter.php
index 1e164933ce..f9245414f2 100644
--- a/lib/htmloutputter.php
+++ b/lib/htmloutputter.php
@@ -108,6 +108,8 @@ class HTMLOutputter extends XMLOutputter
}
header('Content-Type: '.$type);
+
+ $this->extraHeaders();
$this->startXML('html',
'-//W3C//DTD XHTML 1.0 Strict//EN',
@@ -132,6 +134,16 @@ class HTMLOutputter extends XMLOutputter
$this->elementEnd('html');
$this->endXML();
}
+
+ /**
+ * To specify additional HTTP headers for the action
+ *
+ * @return void
+ */
+ function extraHeaders()
+ {
+ // Needs to be overloaded
+ }
/**
* Output an HTML text input element
--
2.39.5