inc/classes/main/response/class_HttpResponse.php

   1 <?php
   2 /**
   3  * A class for an HTTP response on an HTTP request
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  *
  24  * The extended headers are taken from phpMyAdmin setup tool, written by
  25  * Michal Cihar <michal@cihar.com>, licensed under GNU GPL 2.0.
  26  */
  27 class HttpResponse extends BaseFrameworkSystem implements Responseable {
  28         /**
  29          * Response status
  30          */
  31         private $responseStatus = "200 OK";
  32
  33         /**
  34          * Array with all headers
  35          */
  36         private $responseHeaders = array();
  37
  38         /**
  39          * Cookies we shall sent out
  40          */
  41         private $cookies = array();
  42
  43         /**
  44          * Body of the response
  45          */
  46         private $responseBody = "";
  47
  48         /**
  49          * Instance of the template engine
  50          */
  51         private $templateInstance = null;
  52
  53         /**
  54          * Fatal resolved messages from filters and so on
  55          */
  56         private $fatalMessages = array();
  57
  58         /**
  59          * Protected constructor
  60          *
  61          * @return      void
  62          */
  63         protected function __construct () {
  64                 // Call parent constructor
  65                 parent::__construct(__CLASS__);
  66
  67                 // Clean up a little
  68                 $this->removeNumberFormaters();
  69                 $this->removeSystemArray();
  70         }
  71
  72         /**
  73          * Creates an object of this class
  74          *
  75          * @param       $appInstance            An instance of a manageable application
  76          * @return      $responseInstance       A prepared instance of this class
  77          */
  78         public final static function createHttpResponse (ManageableApplication $appInstance) {
  79                 // Get a new instance
  80                 $responseInstance = new HttpResponse();
  81
  82                 // Set the application instance
  83                 $responseInstance->setApplicationInstance($appInstance);
  84
  85                 // Initialize the template engine here
  86                 $responseInstance->initTemplateEngine($appInstance);
  87
  88                 // Return the prepared instance
  89                 return $responseInstance;
  90         }
  91
  92         /**
  93          * Setter for status
  94          *
  95          * @param       $status         New response status
  96          * @return      void
  97          */
  98         public final function setResponseStatus ($status) {
  99                 $this->responseStatus = (string) $status;
 100         }
 101
 102         /**
 103          * Add header element
 104          *
 105          * @param       $name   Name of header element
 106          * @param       $value  Value of header element
 107          * @return      void
 108          */
 109         public final function addHeader ($name, $value) {
 110                 $this->responseHeaders[$name] = $value;
 111         }
 112
 113         /**
 114          * Reset the header array
 115          *
 116          * @return      void
 117          */
 118         public final function resetResponseHeaders () {
 119                 $this->responseHeaders = array();
 120         }
 121
 122         /**
 123          * "Writes" data to the response body
 124          *
 125          * @param       $output         Output we shall sent in the HTTP response
 126          * @return      void
 127          */
 128         public function writeToBody ($output) {
 129                 $this->responseBody .= $output;
 130         }
 131
 132         /**
 133          * Sets the response body to something new
 134          *
 135          * @param       $output         Output we shall sent in the HTTP response
 136          * @return      void
 137          */
 138         public function setResponseBody ($output) {
 139                 $this->responseBody = $output;
 140         }
 141
 142         /**
 143          * Flushs the cached HTTP response to the outer world
 144          *
 145          * @param       $force  Wether we shall force the output or abort if headers are
 146          *                                      already sent with an exception
 147          * @return      void
 148          * @throws      ResponseHeadersAlreadySentException             Thrown if headers are
 149          *                                                                                                      already sent
 150          */
 151         public function flushBuffer ($force=false) {
 152                 if ((headers_sent()) && (!$force)) {
 153                         // Headers are already sent!
 154                         throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
 155                 } elseif (!headers_sent()) {
 156                         // Send headers out
 157                         header("HTTP/1.1 {$this->responseStatus}");
 158
 159                         // Used later
 160                         $now = gmdate('D, d M Y H:i:s') . ' GMT';
 161
 162                         // General header for no caching
 163                         $this->addHeader('Expired', $now); // rfc2616 - Section 14.21
 164                         $this->addHeader('Last-Modified', $now);
 165                         $this->addHeader('Cache-Control', 'no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0'); // HTTP/1.1
 166                         $this->addHeader('Pragma', 'no-cache'); // HTTP/1.0
 167
 168                         // Define the charset to be used
 169                         //$this->addHeader('Content-Type:', sprintf("text/html; charset=%s", $this->getConfigInstance()->readConfig('header_charset')));
 170
 171                         foreach ($this->responseHeaders as $name=>$value) {
 172                                 header("{$name}: {$value}");
 173                         } // END - foreach
 174
 175                         // Send cookies out?
 176                         if (count($this->cookies) > 0) {
 177                                 // Send all cookies
 178                                 $cookieString = implode(" ", $this->cookies);
 179                                 header("Set-Cookie: {$cookieString}");
 180
 181                                 // Remove them all
 182                                 $this->cookies = array();
 183                         } // END - if
 184                 }
 185
 186                 // Are there some error messages?
 187                 if (count($this->fatalMessages) == 0) {
 188                         // Flush the output to the world
 189                         $this->getWebOutputInstance()->output($this->responseBody);
 190                 } else {
 191                         // Display all error messages
 192                         $this->getApplicationInstance()->handleFatalMessages($this->fatalMessages);
 193
 194                         // Send the error messages out to the world
 195                         $this->getWebOutputInstance()->output($this->responseBody);
 196                 }
 197
 198                 // Clear response header and body
 199                 $this->setResponseBody("");
 200                 $this->resetResponseHeaders();
 201         }
 202
 203         /**
 204          * Initializes the template engine instance
 205          *
 206          * @param       $appInstance    An instance of a manageable application
 207          * @return      void
 208          */
 209         public final function initTemplateEngine (ManageableApplication $appInstance) {
 210                 $this->setTemplateInstance($this->prepareTemplateInstance($appInstance));
 211         }
 212
 213         /**
 214          * Adds a fatal message id to the response. The added messages can then be
 215          * processed and outputed to the world
 216          *
 217          * @param       $messageId      The message id we shall add
 218          * @return      void
 219          */
 220         public final function addFatalMessage ($messageId) {
 221                 // Adds the resolved message id to the fatal message list
 222                 $this->fatalMessages[] = $this->getApplicationInstance()->getLanguageInstance()->getMessage($messageId);
 223         }
 224
 225         /**
 226          * Adds a cookie to the response
 227          *
 228          * @param       $cookieName             Cookie's name
 229          * @param       $cookieValue    Value to store in the cookie
 230          * @param       $encrypted              Do some extra encryption on the value
 231          * @param       $expires                Timestamp of expiration (default: configured)
 232          * @return      void
 233          * @throws      ResponseHeadersAlreadySentException             If headers are already sent
 234          * @todo        Encryption of cookie data not yet supported.
 235          * @todo        Why are these parameters conflicting?
 236          * @todo        If the return statement is removed and setcookie() commented out,
 237          * @todo        this will send only one cookie out, the first one.
 238          */
 239         public function addCookie ($cookieName, $cookieValue, $encrypted = false, $expires = null) {
 240                 //* DEBUG: */ echo $cookieName."=".$cookieValue."<br />\n";
 241                 // Are headers already sent?
 242                 if (headers_sent()) {
 243                         // Throw an exception here
 244                         //* DEBUG: */ return;
 245                         throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
 246                 } // END - if
 247
 248                 // Shall we encrypt the cookie?
 249                 if ($encrypted === true) {
 250                 } // END - if
 251
 252                 // For slow browsers set the cookie array element first
 253                 $_COOKIE[$cookieName] = $cookieValue;
 254
 255                 // Get all config entries
 256                 if (is_null($expires)) {
 257                         $expires = (time() + $this->getConfigInstance()->readConfig('cookie_expire'));
 258                 } // END - if
 259
 260                 $path = $this->getConfigInstance()->readConfig('cookie_path');
 261                 $domain = $this->getConfigInstance()->readConfig('cookie_domain');
 262
 263                 setcookie($cookieName, $cookieValue, $expires);
 264                 //, $path, $domain, (isset($_SERVER['HTTPS']))
 265                 return;
 266
 267                 // Now construct the full header
 268                 $cookieString = $cookieName . "=" . $cookieValue . "; ";
 269                 $cookieString .= "expires=" . date("D, d-F-Y H:i:s", $expires) . " GMT";
 270                 // $cookieString .= "; path=".$path."; domain=".$domain;
 271
 272                 // Set the cookie as a header
 273                 $this->cookies[$cookieName] = $cookieString;
 274         }
 275
 276         /**
 277          * Redirect to a configured URL. The URL can be absolute or relative. In
 278          * case of relative URL it will be extended automatically.
 279          *
 280          * @param       $configEntry    The configuration entry which holds our URL
 281          * @return      void
 282          * @throws      ResponseHeadersAlreadySentException             If headers are already sent
 283          */
 284         public function redirectToConfiguredUrl ($configEntry) {
 285                 // Is the header not yet sent?
 286                 if (headers_sent()) {
 287                         // Throw an exception here
 288                         throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
 289                 } // END - if
 290
 291                 // Get the url from config
 292                 $url = $this->getConfigInstance()->readConfig($configEntry);
 293
 294                 // Do we have a "http" in front of the URL?
 295                 if (substr(strtolower($url), 0, 4) != "http") {
 296                         // Is there a / in front of the relative URL?
 297                         if (substr($url, 0, 1) == "/") $url = substr($url, 1);
 298
 299                         // No, then extend it with our base URL
 300                         $url = $this->getConfigInstance()->readConfig('base_url') . "/" . $url;
 301                 } // END - if
 302
 303                 // Add redirect header
 304                 $this->addHeader("Location", $url);
 305
 306                 // Set correct response status
 307                 $this->setResponseStatus("301 Moved Permanently");
 308
 309                 // Clear the body
 310                 $this->setResponseBody("");
 311
 312                 // Flush the result
 313                 $this->flushBuffer();
 314
 315                 // All done here...
 316                 exit();
 317         }
 318
 319         /**
 320          * Expires the given cookie if it is set
 321          *
 322          * @param       $cookieName             Cookie to expire
 323          * @return      void
 324          */
 325         public function expireCookie ($cookieName) {
 326                 // Is the cookie there?
 327                 if (isset($_COOKIE[$cookieName])) {
 328                         // Then expire it with 20 minutes past
 329                         $this->addCookie($cookieName, "", false, (time() - 1200));
 330
 331                         // Remove it from array
 332                         unset($_COOKIE[$cookieName]);
 333                 } // END - if
 334         }
 335
 336         /**
 337          * Refreshs a given cookie. This will make the cookie live longer
 338          *
 339          * @param       $cookieName             Cookie to refresh
 340          * @return      void
 341          */
 342         public function refreshCookie ($cookieName) {
 343                 // Only update existing cookies
 344                 if (isset($_COOKIE[$cookieName])) {
 345                         // Update the cookie
 346                         $this->addCookie($cookieName, $_COOKIE[$cookieName], false);
 347                 } // END - if
 348         }
 349
 350         /**
 351          * Getter for default command
 352          *
 353          * @return      $defaultCommand         Default command for this response
 354          */
 355         public function getDefaultCommand () {
 356                 $defaultCommand = $this->getConfigInstance()->readConfig('default_web_command');
 357                 return $defaultCommand;
 358         }
 359 }
 360
 361 // [EOF]
 362 ?>