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 $templateEngine = 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                 // Set part description
  68                 $this->setObjectDescription("HTTP response");
  69
  70                 // Create unique ID number
  71                 $this->generateUniqueId();
  72
  73                 // Clean up a little
  74                 $this->removeNumberFormaters();
  75                 $this->removeSystemArray();
  76         }
  77
  78         /**
  79          * Creates an object of this class
  80          *
  81          * @param       $appInstance            An instance of a manageable application
  82          * @return      $responseInstance       A prepared instance of this class
  83          */
  84         public final static function createHttpResponse (ManageableApplication $appInstance) {
  85                 // Get a new instance
  86                 $responseInstance = new HttpResponse();
  87
  88                 // Set the application instance
  89                 $responseInstance->setApplicationInstance($appInstance);
  90
  91                 // Initialize the template engine here
  92                 $responseInstance->initTemplateEngine($appInstance);
  93
  94                 // Return the prepared instance
  95                 return $responseInstance;
  96         }
  97
  98         /**
  99          * Setter for status
 100          *
 101          * @param       $status         New response status
 102          * @return      void
 103          */
 104         public final function setResponseStatus ($status) {
 105                 $this->responseStatus = (string) $status;
 106         }
 107
 108         /**
 109          * Add header element
 110          *
 111          * @param       $name   Name of header element
 112          * @param       $value  Value of header element
 113          * @return      void
 114          */
 115         public final function addHeader ($name, $value) {
 116                 $this->responseHeaders[$name] = $value;
 117         }
 118
 119         /**
 120          * Reset the header array
 121          *
 122          * @return      void
 123          */
 124         public final function resetResponseHeaders () {
 125                 $this->responseHeaders = array();
 126         }
 127
 128         /**
 129          * "Writes" data to the response body
 130          *
 131          * @param       $output         Output we shall sent in the HTTP response
 132          * @return      void
 133          */
 134         public function writeToBody ($output) {
 135                 $this->responseBody .= $output;
 136         }
 137
 138         /**
 139          * Sets the response body to something new
 140          *
 141          * @param       $output         Output we shall sent in the HTTP response
 142          * @return      void
 143          */
 144         public function setResponseBody ($output) {
 145                 $this->responseBody = $output;
 146         }
 147
 148         /**
 149          * Flushs the cached HTTP response to the outer world
 150          *
 151          * @param       $force  Wether we shall force the output or abort if headers are
 152          *                                      already sent with an exception
 153          * @return      void
 154          * @throws      ResponseHeadersAlreadySentException             Thrown if headers are
 155          *                                                                                                      already sent
 156          */
 157         public function flushBuffer ($force=false) {
 158                 if ((headers_sent()) && (!$force)) {
 159                         // Headers are already sent!
 160                         throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
 161                 } elseif (!headers_sent()) {
 162                         // Send headers out
 163                         header("HTTP/1.1 {$this->responseStatus}");
 164
 165                         // Used later
 166                         $now = gmdate('D, d M Y H:i:s') . ' GMT';
 167
 168                         // General header for no caching
 169                         $this->addHeader('Expired', $now); // rfc2616 - Section 14.21
 170                         $this->addHeader('Last-Modified', $now);
 171                         $this->addHeader('Cache-Control', 'no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0'); // HTTP/1.1
 172                         $this->addHeader('Pragma', 'no-cache'); // HTTP/1.0
 173
 174                         // Define the charset to be used
 175                         //$this->addHeader('Content-Type:', sprintf("text/html; charset=%s", $this->getConfigInstance()->readConfig('header_charset')));
 176
 177                         foreach ($this->responseHeaders as $name=>$value) {
 178                                 header("{$name}: {$value}");
 179                         } // END - foreach
 180
 181                         // Send cookies out?
 182                         if (count($this->cookies) > 0) {
 183                                 // Send all cookies
 184                                 $cookieString = implode(" ", $this->cookies);
 185                                 header("Set-Cookie: {$cookieString}");
 186
 187                                 // Remove them all
 188                                 $this->cookies = array();
 189                         } // END - if
 190                 }
 191
 192                 // Are there some error messages?
 193                 if (count($this->fatalMessages) == 0) {
 194                         // Flush the output to the world
 195                         $this->getWebOutputInstance()->output($this->responseBody);
 196                 } else {
 197                         // Display all error messages
 198                         $this->getApplicationInstance()->handleFatalMessages($this->fatalMessages);
 199
 200                         // Send the error messages out to the world
 201                         $this->getWebOutputInstance()->output($this->responseBody);
 202                 }
 203
 204                 // Clear response header and body
 205                 $this->setResponseBody("");
 206                 $this->resetResponseHeaders();
 207         }
 208
 209         /**
 210          * Initializes the template engine instance
 211          *
 212          * @param       $appInstance    An instance of a manageable application
 213          * @return      void
 214          */
 215         public final function initTemplateEngine (ManageableApplication $appInstance) {
 216                 $this->templateEngine = $this->prepareTemplateEngine($appInstance);
 217         }
 218
 219         /**
 220          * Getter for the template engine instance
 221          *
 222          * @return      $templateEngine         An instance of the used template engine
 223          */
 224         public final function getTemplateEngine () {
 225                 return $this->templateEngine;
 226         }
 227
 228         /**
 229          * Adds a fatal message id to the response. The added messages can then be
 230          * processed and outputed to the world
 231          *
 232          * @param       $messageId      The message id we shall add
 233          * @return      void
 234          */
 235         public final function addFatalMessage ($messageId) {
 236                 // Adds the resolved message id to the fatal message list
 237                 $this->fatalMessages[] = $this->getApplicationInstance()->getLanguageInstance()->getMessage($messageId);
 238         }
 239
 240         /**
 241          * Adds a cookie to the response
 242          *
 243          * @param       $cookieName             Cookie's name
 244          * @param       $cookieValue    Value to store in the cookie
 245          * @param       $encrypted              Do some extra encryption on the value
 246          * @param       $expires                Timestamp of expiration (default: configured)
 247          * @return      void
 248          * @throws      ResponseHeadersAlreadySentException             If headers are already sent
 249          */
 250         public function addCookie ($cookieName, $cookieValue, $encrypted = false, $expires = null) {
 251                 // Are headers already sent?
 252                 if (headers_sent()) {
 253                         // Throw an exception here
 254                         throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
 255                 } // END - if
 256
 257                 // Shall we encrypt the cookie?
 258                 if ($encrypted === true) {
 259                         /* @TODO Encryption of cookie data not yet supported */
 260                 } // END - if
 261
 262                 // For slow browsers set the cookie array element first
 263                 $_COOKIE[$cookieName] = $cookieValue;
 264
 265                 // Get all config entries
 266                 if (is_null($expires)) {
 267                         $expires = (time() + $this->getConfigInstance()->readConfig('cookie_expire'));
 268                 } // END - if
 269
 270                 $path = $this->getConfigInstance()->readConfig('cookie_path');
 271                 $domain = $this->getConfigInstance()->readConfig('cookie_domain');
 272
 273                 setcookie($cookieName, $cookieValue, $expires);
 274                 /* @TODO Why are these parameters conflicting? */
 275                 //, $path, $domain, (isset($_SERVER['HTTPS']))
 276                 return;
 277                 /* @TODO This will send only one cookie out, the first one. */
 278
 279                 // Now construct the full header
 280                 $cookieString = $cookieName . "=" . $cookieValue . "; ";
 281                 $cookieString .= "expires=" . date("D, d-F-Y H:i:s", $expires) . " GMT";
 282                 /* @TODO Why are these parameters conflicting? */
 283                 // $cookieString .= "; path=".$path."; domain=".$domain;
 284
 285                 // Set the cookie as a header
 286                 $this->cookies[$cookieName] = $cookieString;
 287         }
 288
 289         /**
 290          * Redirect to a configured URL. The URL can be absolute or relative. In
 291          * case of relative URL it will be extended automatically.
 292          *
 293          * @param       $configEntry    The configuration entry which holds our URL
 294          * @return      void
 295          * @throws      ResponseHeadersAlreadySentException             If headers are already sent
 296          */
 297         public function redirectToConfiguredUrl ($configEntry) {
 298                 // Is the header not yet sent?
 299                 if (headers_sent()) {
 300                         // Throw an exception here
 301                         throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
 302                 } // END - if
 303
 304                 // Get the url from config
 305                 $url = $this->getConfigInstance()->readConfig($configEntry);
 306
 307                 // Do we have a "http" in front of the URL?
 308                 if (substr(strtolower($url), 0, 4) != "http") {
 309                         // Is there a / in front of the relative URL?
 310                         if (substr($url, 0, 1) == "/") $url = substr($url, 1);
 311
 312                         // No, then extend it with our base URL
 313                         $url = $this->getConfigInstance()->readConfig('base_url') . "/" . $url;
 314                 } // END - if
 315
 316                 // Add redirect header
 317                 $this->addHeader("Location", $url);
 318
 319                 // Set correct response status
 320                 $this->setResponseStatus("301 Moved Permanently");
 321
 322                 // Clear the body
 323                 $this->setResponseBody("");
 324
 325                 // Flush the result
 326                 $this->flushBuffer();
 327
 328                 // All done here...
 329                 exit();
 330         }
 331
 332         /**
 333          * Expires the given cookie if it is set
 334          *
 335          * @param       $cookieName             Cookie to expire
 336          * @return      void
 337          */
 338         public function expireCookie ($cookieName) {
 339                 // Is the cookie there?
 340                 if (isset($_COOKIE[$cookieName])) {
 341                         // Then expire it with 20 minutes past
 342                         $this->addCookie($cookieName, "", false, (time() - 1200));
 343
 344                         // Remove it from array
 345                         unset($_COOKIE[$cookieName]);
 346                 } // END - if
 347         }
 348 }
 349
 350 // [EOF]
 351 ?>