introduced http_status() for sending HTTP status code FS#1698

It seems, some servers require a special Status: header for sending the
HTTP status code from PHP (F)CGI to the server. This patch introduces a
new function (adopted from CodeIgniter) for simplifying the status
handling.

inc/actions.php

@@ -172,7 +172,7 @@ function act_dispatch(){
     $evt->advise_after();
     // Make sure plugs can handle 'denied'
     if($conf['send404'] && $ACT == 'denied') {
-        header('HTTP/1.0 403 Forbidden');
+        http_status(403);
     }
     unset($evt);
 
@@ -658,7 +658,7 @@ function act_sitemap($act) {
     global $conf;
 
     if ($conf['sitemap'] < 1 || !is_numeric($conf['sitemap'])) {
-        header("HTTP/1.0 404 Not Found");
+        http_status(404);
         print "Sitemap generation is disabled.";
         exit;
     }
@@ -690,7 +690,7 @@ function act_sitemap($act) {
         exit;
     }
 
-    header("HTTP/1.0 500 Internal Server Error");
+    http_status(500);
     print "Could not read the sitemap file - bad permissions?";
     exit;
 }

inc/auth.php

@@ -267,7 +267,7 @@ function auth_login($user, $pass, $sticky = false, $silent = false) {
 function auth_validateToken($token) {
     if(!$token || $token != $_SESSION[DOKU_COOKIE]['auth']['token']) {
         // bad token
-        header("HTTP/1.0 401 Unauthorized");
+        http_status(401);
         print 'Invalid auth token - maybe the session timed out';
         unset($_SESSION[DOKU_COOKIE]['auth']['token']); // no second chance
         exit;

inc/httputils.php

@@ -250,6 +250,11 @@ function http_cached_finish($file, $content) {
     }
 }
 
+/**
+ * Fetches raw, unparsed POST data
+ *
+ * @return string
+ */
 function http_get_raw_post_data() {
     static $postData = null;
     if ($postData === null) {
@@ -257,3 +262,69 @@ function http_get_raw_post_data() {
     }
     return $postData;
 }
+
+/**
+ * Set the HTTP response status and takes care of the used PHP SAPI
+ *
+ * Inspired by CodeIgniter's set_status_header function
+ *
+ * @param int    $code
+ * @param string $text
+ */
+function http_status($code = 200, $text = '') {
+    static $stati = array(
+        200 => 'OK',
+        201 => 'Created',
+        202 => 'Accepted',
+        203 => 'Non-Authoritative Information',
+        204 => 'No Content',
+        205 => 'Reset Content',
+        206 => 'Partial Content',
+
+        300 => 'Multiple Choices',
+        301 => 'Moved Permanently',
+        302 => 'Found',
+        304 => 'Not Modified',
+        305 => 'Use Proxy',
+        307 => 'Temporary Redirect',
+
+        400 => 'Bad Request',
+        401 => 'Unauthorized',
+        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',
+
+        500 => 'Internal Server Error',
+        501 => 'Not Implemented',
+        502 => 'Bad Gateway',
+        503 => 'Service Unavailable',
+        504 => 'Gateway Timeout',
+        505 => 'HTTP Version Not Supported'
+    );
+
+    if($text == '' && isset($stati[$code])) {
+        $text = $stati[$code];
+    }
+
+    $server_protocol = (isset($_SERVER['SERVER_PROTOCOL'])) ? $_SERVER['SERVER_PROTOCOL'] : false;
+
+    if(substr(php_sapi_name(), 0, 3) == 'cgi') {
+        header("Status: {$code} {$text}", true);
+    } elseif($server_protocol == 'HTTP/1.1' OR $server_protocol == 'HTTP/1.0') {
+        header($server_protocol." {$code} {$text}", true, $code);
+    } else {
+        header("HTTP/1.1 {$code} {$text}", true, $code);
+    }
+}

inc/parser/code.php

@@ -43,7 +43,7 @@ class Doku_Renderer_code extends Doku_Renderer {
      * This should never be reached, if it is send a 404
      */
     function document_end() {
-        header("HTTP/1.0 404 Not Found");
+        http_status(404);
         echo '404 - Not found';
         exit;
     }

lib/exe/detail.php

@@ -31,7 +31,7 @@ if($AUTH >= AUTH_READ){
     $SRC = mediaFN($IMG);
     if(!@file_exists($SRC)){
         //doesn't exist!
-        header("HTTP/1.0 404 File not Found");
+        http_status(404);
         $ERROR = 'File not found';
     }
 }else{

lib/exe/fetch.php

@@ -58,7 +58,7 @@ if(!defined('SIMPLE_TEST')) {
         }
         // send any non 200 status
         if($data['status'] != 200) {
-            header('HTTP/1.0 '.$data['status'].' '.$data['statusmessage']);
+            http_status($data['status'], $data['statusmessage']);
         }
         // die on errors
         if($data['status'] > 203) {
@@ -137,7 +137,7 @@ function sendFile($file, $mime, $dl, $cache) {
     if($fp) {
         http_rangeRequest($fp, filesize($file), $mime);
     } else {
-        header("HTTP/1.0 500 Internal Server Error");
+        http_status(500);
         print "Could not read $file - bad permissions?";
     }
 }

lib/exe/mediamanager.php

@@ -36,7 +36,7 @@
 
     // do not display the manager if user does not have read access
     if($AUTH < AUTH_READ && !$fullscreen) {
-        header('HTTP/1.0 403 Forbidden');
+        http_status(403);
         die($lang['accessdenied']);
     }
 
@@ -48,7 +48,7 @@
         $_FILES['upload'] =& $_FILES['Filedata'];
         $JUMPTO = media_upload($NS,$AUTH);
         if($JUMPTO == false){
-            header("HTTP/1.0 400 Bad Request");
+            http_status(400);
             echo 'Upload failed';
         }
         echo 'ok';

lib/exe/xmlrpc.php

@@ -29,10 +29,10 @@ class dokuwiki_xmlrpc_server extends IXR_Server {
             return $result;
         } catch (RemoteAccessDeniedException $e) {
             if (!isset($_SERVER['REMOTE_USER'])) {
-                header('HTTP/1.1 401 Unauthorized');
+                http_status(401);
                 return new IXR_Error(-32603, "server error. not authorized to call method $methodname");
             } else {
-                header('HTTP/1.1 403 Forbidden');
+                http_status(403);
                 return new IXR_Error(-32604, "server error. forbidden to call the method $methodname");
             }
         } catch (RemoteException $e) {