lib/servererroraction.php

   1 <?php
   2
   3 /**
   4  * Server error action.
   5  *
   6  * PHP version 5
   7  *
   8  * @category Action
   9  * @package  StatusNet
  10  * @author   Evan Prodromou <evan@status.net>
  11  * @author   Zach Copley <zach@status.net>
  12  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  13  * @link     http://status.net/
  14  *
  15  * StatusNet - the distributed open-source microblogging tool
  16  * Copyright (C) 2008, 2009, StatusNet, Inc.
  17  *
  18  * This program is free software: you can redistribute it and/or modify
  19  * it under the terms of the GNU Affero General Public License as published by
  20  * the Free Software Foundation, either version 3 of the License, or
  21  * (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU Affero General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU Affero General Public License
  29  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  30  */
  31
  32 if (!defined('STATUSNET') && !defined('LACONICA')) {
  33     exit(1);
  34 }
  35
  36 require_once INSTALLDIR.'/lib/error.php';
  37
  38 /**
  39  * Class for displaying HTTP server errors
  40  *
  41  * Note: The older util.php class simply printed a string, but the spec
  42  * says that 500 errors should be treated similarly to 400 errors, and
  43  * it's easier to give an HTML response.  Maybe we can customize these
  44  * to display some funny animal cartoons.  If not, we can probably role
  45  * these classes up into a single class.
  46  *
  47  * See: http://tools.ietf.org/html/rfc2616#section-10
  48  *
  49  * @category Action
  50  * @package  StatusNet
  51  * @author   Zach Copley <zach@status.net>
  52  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  53  * @link     http://status.net/
  54  */
  55
  56 class ServerErrorAction extends ErrorAction
  57 {
  58     static $status = array(500 => 'Internal Server Error',
  59                            501 => 'Not Implemented',
  60                            502 => 'Bad Gateway',
  61                            503 => 'Service Unavailable',
  62                            504 => 'Gateway Timeout',
  63                            505 => 'HTTP Version Not Supported');
  64
  65     function __construct($message='Error', $code=500, $ex=null)
  66     {
  67         parent::__construct($message, $code);
  68
  69         $this->default = 500;
  70
  71         // Server errors must be logged.
  72         $log = "ServerErrorAction: $code $message";
  73         if ($ex) {
  74             $log .= "\n" . $ex->getTraceAsString();
  75         }
  76         common_log(LOG_ERR, $log);
  77     }
  78
  79     // XXX: Should these error actions even be invokable via URI?
  80
  81     function handle(array $args=array())
  82     {
  83         parent::handle($args);
  84
  85         $this->code = $this->trimmed('code');
  86
  87         if (!$this->code || $code < 500 || $code > 599) {
  88             $this->code = $this->default;
  89         }
  90
  91         $this->message = $this->trimmed('message');
  92
  93         if (!$this->message) {
  94             $this->message = "Server Error $this->code";
  95         }
  96
  97         $this->showPage();
  98     }
  99
 100     /**
 101      *  To specify additional HTTP headers for the action
 102      *
 103      *  @return void
 104      */
 105     function extraHeaders()
 106     {
 107         $status_string = @self::$status[$this->code];
 108         header('HTTP/1.1 '.$this->code.' '.$status_string);
 109     }
 110
 111     /**
 112      * Page title.
 113      *
 114      * @return page title
 115      */
 116
 117     function title()
 118     {
 119         return @self::$status[$this->code];
 120     }
 121
 122 }