X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fresponse%2Fclass_HttpResponse.php;h=5a21d8988aea96d544f2a8a69a440a0b82c39eb4;hb=c9beed8839a04b5a170f2aca90b86623d097c5ad;hp=3679fe96a33bae43603dd8c35154dc288c40dfa9;hpb=b912eda46059527fc0475e043944c3ebff47fbcd;p=shipsimu.git
diff --git a/inc/classes/main/response/class_HttpResponse.php b/inc/classes/main/response/class_HttpResponse.php
index 3679fe9..5a21d89 100644
--- a/inc/classes/main/response/class_HttpResponse.php
+++ b/inc/classes/main/response/class_HttpResponse.php
@@ -20,6 +20,9 @@
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
+ *
+ * The extended headers are taken from phpMyAdmin setup tool, written by
+ * Michal Cihar , licensed under GNU GPL 2.0.
*/
class HttpResponse extends BaseFrameworkSystem implements Responseable {
/**
@@ -42,6 +45,11 @@ class HttpResponse extends BaseFrameworkSystem implements Responseable {
*/
private $templateEngine = null;
+ /**
+ * Fatal resolved messages from filters and so on
+ */
+ private $fatalMessages = array();
+
/**
* Protected constructor
*
@@ -52,10 +60,10 @@ class HttpResponse extends BaseFrameworkSystem implements Responseable {
parent::__construct(__CLASS__);
// Set part description
- $this->setObjectDescription("HTTP-Antwort");
+ $this->setObjectDescription("HTTP response");
// Create unique ID number
- $this->createUniqueID();
+ $this->generateUniqueId();
// Clean up a little
$this->removeNumberFormaters();
@@ -72,6 +80,9 @@ class HttpResponse extends BaseFrameworkSystem implements Responseable {
// Get a new instance
$responseInstance = new HttpResponse();
+ // Set the application instance
+ $responseInstance->setApplicationInstance($appInstance);
+
// Initialize the template engine here
$responseInstance->initTemplateEngine($appInstance);
@@ -100,6 +111,15 @@ class HttpResponse extends BaseFrameworkSystem implements Responseable {
$this->responseHeaders[$name] = $value;
}
+ /**
+ * Reset the header array
+ *
+ * @return void
+ */
+ public final function resetResponseHeaders () {
+ $this->responseHeaders = array();
+ }
+
/**
* "Writes" data to the response body
*
@@ -110,6 +130,16 @@ class HttpResponse extends BaseFrameworkSystem implements Responseable {
$this->responseBody .= $output;
}
+ /**
+ * Sets the response body to something new
+ *
+ * @param $output Output we shall sent in the HTTP response
+ * @return void
+ */
+ public function setResponseBody ($output) {
+ $this->responseBody = $output;
+ }
+
/**
* Flushs the cached HTTP response to the outer world
*
@@ -119,22 +149,46 @@ class HttpResponse extends BaseFrameworkSystem implements Responseable {
* @throws ResponseHeadersAlreadySentException Thrown if headers are
* already sent
*/
- public function flushResponse ($force=false) {
+ public function flushBuffer ($force=false) {
if ((headers_sent()) && (!$force)) {
// Headers are already sent!
throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
} elseif (!headers_sent()) {
// Send headers out
- header("HTTP/1.0 {$this->responseStatus}");
+ header("HTTP/1.1 {$this->responseStatus}");
+
+ // Used later
+ $now = gmdate('D, d M Y H:i:s') . ' GMT';
+
+ // General header for no caching
+ $this->addHeader('Expired', $now); // rfc2616 - Section 14.21
+ $this->addHeader('Last-Modified', $now);
+ $this->addHeader('Cache-Control:', 'no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0'); // HTTP/1.1
+ $this->addHeader('Pragma:', 'no-cache'); // HTTP/1.0
+
+ // Define the charset to be used
+ //$this->addHeader('Content-Type:', sprintf("text/html; charset=%s", $this->getConfigInstance()->readConfig('header_charset')));
+
foreach ($this->responseHeaders as $name=>$value) {
header("{$name}: {$value}");
}
}
- // Flush the output to the world
- $this->getWebOutputInstance()->output($this->responseBody);
- $this->reponseBody = "";
- $this->responseHeaders = array();
+ // Are there some error messages?
+ if (count($this->fatalMessages) == 0) {
+ // Flush the output to the world
+ $this->getWebOutputInstance()->output($this->responseBody);
+ } else {
+ // Display all error messages
+ $this->getApplicationInstance()->handleFatalMessages($this->fatalMessages);
+
+ // Send the error messages out to the world
+ $this->getWebOutputInstance()->output($this->responseBody);
+ }
+
+ // Clear response header and body
+ $this->setResponseBody("");
+ $this->resetResponseHeaders();
}
/**
@@ -155,6 +209,101 @@ class HttpResponse extends BaseFrameworkSystem implements Responseable {
public final function getTemplateEngine () {
return $this->templateEngine;
}
+
+ /**
+ * Adds a fatal message id to the response. The added messages can then be
+ * processed and outputed to the world
+ *
+ * @param $messageId The message id we shall add
+ * @return void
+ */
+ public final function addFatalMessage ($messageId) {
+ // Adds the resolved message id to the fatal message list
+ $this->fatalMessages[] = $this->getApplicationInstance()->getLanguageInstance()->getMessage($messageId);
+ }
+
+ /**
+ * Adds a cookie to the response
+ *
+ * @param $cookieName Cookie's name
+ * @param $cookieValue Value to store in the cookie
+ * @param $encrypted Do some extra encryption on the value
+ * @return void
+ * @throws ResponseHeadersAlreadySentException If headers are already sent
+ */
+ public function addCookie ($cookieName, $cookieValue, $encrypted = false) {
+ // Are headers already sent?
+ if (headers_sent()) {
+ // Throw an exception here
+ throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
+ } // END - if
+
+ // Shall we encrypt the cookie?
+ if ($encrypted === true) {
+ // @TODO Encryption of cookie data not yet supported
+ } // END - if
+
+ // Set the cookie
+ //echo $cookieName."=".$cookieValue.
+ // ", expire=".(time()+$this->getConfigInstance()->readConfig('cookie_expire')).
+ // ", path=".$this->getConfigInstance()->readConfig('cookie_path').
+ // ", domain=".$this->getConfigInstance()->readConfig('cookie_domain').
+ // ", ssl=".$this->getConfigInstance()->readConfig('cookie_ssl');
+ setcookie(
+ $cookieName,
+ $cookieValue,
+ (time() + $this->getConfigInstance()->readConfig('cookie_expire')),
+ $this->getConfigInstance()->readConfig('cookie_path'),
+ $this->getConfigInstance()->readConfig('cookie_domain'),
+ $this->getConfigInstance()->readConfig('cookie_ssl')
+ );
+ }
+
+ /**
+ * Redirect to a configured URL. The URL can be absolute or relative. In
+ * case of relative URL it will be extended automatically.
+ *
+ * @param $configEntry The configuration entry which holds our URL
+ * @return void
+ * @throws ResponseHeadersAlreadySentException If headers are already sent
+ */
+ public function redirectToConfiguredUrl ($configEntry) {
+ // Is the header not yet sent?
+ if (headers_sent()) {
+ // Throw an exception here
+ throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
+ } // END - if
+
+ // Get the url from config
+ $url = $this->getConfigInstance()->readConfig($configEntry);
+
+ // Do we have a "http" in front of the URL?
+ if (substr(strtolower($url), 0, 4) != "http") {
+ // Is there a / in front of the relative URL?
+ if (substr($url, 0, 1) == "/") $url = substr($url, 1);
+
+ // No, then extend it with our base URL
+ $url = $this->getConfigInstance()->readConfig('base_url') . "/" . $url;
+ } // END - if
+
+ // Clean response headers
+ $this->resetResponseHeaders();
+
+ // Add redirect header
+ $this->addHeader("Location", $url);
+
+ // Set correct response status
+ $this->setResponseStatus("301 Moved Permanently");
+
+ // Clear the body
+ $this->setResponseBody("");
+
+ // Flush the result
+ $this->flushBuffer();
+
+ // All done here...
+ exit();
+ }
}
// [EOF]