3 * A class for an HTML response on an HTML request
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
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.
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.
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/>.
24 * The extended headers are taken from phpMyAdmin setup tool, written by
25 * Michal Cihar <michal@cihar.com>, licensed under GNU GPL 2.0.
27 class HtmlResponse extends BaseResponse implements Responseable {
29 * Protected constructor
33 protected function __construct () {
34 // Call parent constructor
35 parent::__construct(__CLASS__);
38 $this->setResponseType('html');
42 * Creates an object of this class
44 * @param $applicationInstance An instance of a manageable application
45 * @return $responseInstance A prepared instance of this class
47 public static final function createHtmlResponse (ManageableApplication $applicationInstance) {
49 $responseInstance = new HtmlResponse();
51 // Set the application instance
52 $responseInstance->setApplicationInstance($applicationInstance);
54 // Initialize the template engine here
55 $responseInstance->initTemplateEngine($applicationInstance);
57 // Init web output instance
58 $responseInstance->initWebOutputInstance();
60 // Return the prepared instance
61 return $responseInstance;
65 * Initializes the template engine instance
67 * @param $applicationInstance An instance of a manageable application
70 public final function initTemplateEngine (ManageableApplication $applicationInstance) {
71 $this->setTemplateInstance($this->prepareTemplateInstance($applicationInstance));
75 * Adds a cookie to the response
77 * @param $cookieName Cookie's name
78 * @param $cookieValue Value to store in the cookie
79 * @param $encrypted Do some extra encryption on the value
80 * @param $expires Timestamp of expiration (default: configured)
82 * @throws ResponseHeadersAlreadySentException If headers are already sent
83 * @todo Encryption of cookie data not yet supported.
84 * @todo Why are these parameters conflicting?
85 * @todo If the return statement is removed and setcookie() commented out,
86 * @todo this will send only one cookie out, the first one.
88 public function addCookie ($cookieName, $cookieValue, $encrypted = FALSE, $expires = NULL) {
89 //* DEBUG: */ echo $cookieName.'='.$cookieValue."<br />\n";
90 // Are headers already sent?
92 // Throw an exception here
94 throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
97 // Shall we encrypt the cookie?
98 if ($encrypted === TRUE) {
99 // Unsupported at the moment
100 $this->partialStub('Encryption is unsupported at the moment.');
103 // For slow browsers set the cookie array element first
104 $_COOKIE[$cookieName] = $cookieValue;
106 // Get all config entries
107 if (is_null($expires)) {
108 $expires = (time() + $this->getConfigInstance()->getConfigEntry('cookie_expire'));
111 $path = $this->getConfigInstance()->getConfigEntry('cookie_path');
112 $domain = $this->getConfigInstance()->getConfigEntry('cookie_domain');
114 setcookie($cookieName, $cookieValue, $expires);
115 //, $path, $domain, (isset($_SERVER['HTTPS']))
118 // Now construct the full header
119 $cookieString = $cookieName . '=' . $cookieValue . '; ';
120 $cookieString .= 'expires=' . date('D, d-F-Y H:i:s', $expires) . ' GMT';
121 // $cookieString .= "; path=".$path."; domain=".$domain;
123 // Set the cookie as a header
124 $this->cookies[$cookieName] = $cookieString;
128 * Redirect to a configured URL. The URL can be absolute or relative. In
129 * case of relative URL it will be extended automatically.
131 * @param $configEntry The configuration entry which holds our URL
133 * @throws ResponseHeadersAlreadySentException If headers are already sent
135 public function redirectToConfiguredUrl ($configEntry) {
136 // Is the header not yet sent?
137 if (headers_sent()) {
138 // Throw an exception here
139 throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
142 // Assign application data
143 $this->getTemplateInstance()->assignApplicationData($this->getApplicationInstance());
145 // Get the url from config
146 $url = $this->getConfigInstance()->getConfigEntry($configEntry . '_url');
149 $url = $this->getTemplateInstance()->compileRawCode($url);
151 // Do we have a 'http' in front of the URL?
152 if (substr(strtolower($url), 0, 4) != 'http') {
153 // Is there a / in front of the relative URL?
154 if (substr($url, 0, 1) == '/') {
155 $url = substr($url, 1);
158 // No, then extend it with our base URL
159 $url = $this->getConfigInstance()->getConfigEntry('base_url') . '/' . $url;
162 // Add redirect header
163 $this->addHeader('Location', str_replace('&', '&', $url));
165 // Set correct response status
166 $this->setResponseStatus('301 Moved Permanently');
169 $this->setResponseBody('');
172 $this->flushBuffer();
179 * Expires the given cookie if it is set
181 * @param $cookieName Cookie to expire
184 public function expireCookie ($cookieName) {
185 // Is the cookie there?
186 if (isset($_COOKIE[$cookieName])) {
187 // Then expire it with 20 minutes past
188 $this->addCookie($cookieName, '', FALSE, (time() - 1200));
190 // Remove it from array
191 unset($_COOKIE[$cookieName]);
196 * Refreshs a given cookie. This will make the cookie live longer
198 * @param $cookieName Cookie to refresh
201 public function refreshCookie ($cookieName) {
202 // Only update existing cookies
203 if (isset($_COOKIE[$cookieName])) {
205 $this->addCookie($cookieName, $_COOKIE[$cookieName], FALSE);