3 namespace CoreFramework\Response;
5 // Import framework stuff
6 use CoreFramework\Manager\ManageableApplication;
7 use CoreFramework\Response\Responseable;
10 * A class for an image response on an HTTP request
12 * @author Roland Haeder <webmaster@shipsimu.org>
14 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
15 * @license GNU GPL 3.0 or any newer version
16 * @link http://www.shipsimu.org
18 * This program is free software: you can redistribute it and/or modify
19 * it under the terms of the GNU 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.
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 General Public License for more details.
28 * You should have received a copy of the GNU General Public License
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 * The extended headers are taken from phpMyAdmin setup tool, written by
32 * Michal Cihar <michal@cihar.com>, licensed under GNU GPL 2.0.
34 class ImageResponse extends BaseResponse implements Responseable {
36 * Protected constructor
40 protected function __construct () {
41 // Call parent constructor
42 parent::__construct(__CLASS__);
45 $this->setResponseType('image');
49 * Creates an object of this class
51 * @param $applicationInstance An instance of a manageable application
52 * @return $responseInstance A prepared instance of this class
54 public static final function createImageResponse (ManageableApplication $applicationInstance) {
56 $responseInstance = new ImageResponse();
58 // Set the application instance
59 $responseInstance->setApplicationInstance($applicationInstance);
61 // Initialize the template engine here
62 $responseInstance->initTemplateEngine($applicationInstance);
64 // Init web output instance
65 $responseInstance->initWebOutputInstance();
67 // Return the prepared instance
68 return $responseInstance;
72 * Initializes the template engine instance
74 * @param $applicationInstance An instance of a manageable application
77 public final function initTemplateEngine (ManageableApplication $applicationInstance) {
78 // Get config instance
79 $cfg = $this->getConfigInstance();
81 // Set new template engine
82 $cfg->setConfigEntry('html_template_class' , $cfg->getConfigEntry('image_template_class'));
83 $cfg->setConfigEntry('raw_template_extension' , '.img');
84 $cfg->setConfigEntry('code_template_extension', '.xml');
85 $cfg->setConfigEntry('tpl_base_path' , 'templates/images/');
86 // @TODO Please fix this
87 $cfg->setConfigEntry('code_template_type' , 'image');
89 // Get a prepared instance
90 $this->setTemplateInstance($this->prepareTemplateInstance($applicationInstance));
94 * Adds a cookie to the response
96 * @param $cookieName Cookie's name
97 * @param $cookieValue Value to store in the cookie
98 * @param $encrypted Do some extra encryption on the value
99 * @param $expires Timestamp of expiration (default: configured)
101 * @throws ResponseHeadersAlreadySentException If headers are already sent
102 * @todo Encryption of cookie data not yet supported.
103 * @todo Why are these parameters conflicting?
104 * @todo If the return statement is removed and setcookie() commented out,
105 * @todo this will send only one cookie out, the first one.
107 public function addCookie ($cookieName, $cookieValue, $encrypted = FALSE, $expires = NULL) {
108 // Are headers already sent?
109 if (headers_sent()) {
110 // Throw an exception here
111 throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
114 // Shall we encrypt the cookie?
115 if ($encrypted === TRUE) {
116 // Unsupported at the moment
117 $this->partialStub('Encryption is unsupported at the moment.');
120 // For slow browsers set the cookie array element first
121 $_COOKIE[$cookieName] = $cookieValue;
123 // Get all config entries
124 if (is_null($expires)) {
125 $expires = (time() + $this->getConfigInstance()->getConfigEntry('cookie_expire'));
128 $path = $this->getConfigInstance()->getConfigEntry('cookie_path');
129 $domain = $this->getConfigInstance()->getConfigEntry('cookie_domain');
131 setcookie($cookieName, $cookieValue, $expires);
132 //, $path, $domain, (isset($_SERVER['HTTPS']))
135 // Now construct the full header
136 $cookieString = $cookieName . '=' . $cookieValue . '; ';
137 $cookieString .= 'expires=' . date('D, d-F-Y H:i:s', $expires) . ' GMT';
138 // TODO Why is this not always working? $cookieString .= '; path=' . $path . '; domain=' . $domain;
140 // Set the cookie as a header
141 $this->cookies[$cookieName] = $cookieString;
145 * Redirect to a configured URL. The URL can be absolute or relative. In
146 * case of relative URL it will be extended automatically.
148 * @param $configEntry The configuration entry which holds our URL
150 * @throws ResponseHeadersAlreadySentException If headers are already sent
152 public function redirectToConfiguredUrl ($configEntry) {
153 // Is the header not yet sent?
154 if (headers_sent()) {
155 // Throw an exception here
156 throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
159 // Assign application data
160 $this->getTemplateInstance()->assignApplicationData($this->getApplicationInstance());
162 // Get the url from config
163 $url = $this->getConfigInstance()->getConfigEntry($configEntry . '_url');
166 $url = $this->getTemplateInstance()->compileRawCode($url);
168 // Do we have a 'http' in front of the URL?
169 if (substr(strtolower($url), 0, 4) != 'http') {
170 // Is there a / in front of the relative URL?
171 if (substr($url, 0, 1) == '/') $url = substr($url, 1);
173 // No, then extend it with our base URL
174 $url = $this->getConfigInstance()->getConfigEntry('base_url') . '/' . $url;
177 // Add redirect header
178 $this->addHeader('Location', str_replace('&', '&', $url));
180 // Set correct response status
181 $this->setResponseStatus('301 Moved Permanently');
184 $this->setResponseBody('');
187 $this->flushBuffer();
194 * Flushs the cached HTTP response to the outer world
196 * @param $force Whether we shall force the output or abort if headers are
197 * already sent with an exception
200 public function flushBuffer ($force = FALSE) {
202 $this->getImageInstance()->finishImage();
205 $content = $this->getImageInstance()->getContent();
207 // Set it as response body
208 $this->setResponseBody($content);
211 $this->addHeader('Content-type', 'image/' . $this->getImageInstance()->getImageType());
213 // Call parent method
214 parent::flushBuffer($force);
218 * Expires the given cookie if it is set
220 * @param $cookieName Cookie to expire
223 public function expireCookie ($cookieName) {
224 // Is the cookie there?
225 if (isset($_COOKIE[$cookieName])) {
226 // Then expire it with 20 minutes past
227 $this->addCookie($cookieName, '', FALSE, (time() - 1200));
229 // Remove it from array
230 unset($_COOKIE[$cookieName]);
235 * Refreshs a given cookie. This will make the cookie live longer
237 * @param $cookieName Cookie to refresh
240 public function refreshCookie ($cookieName) {
241 // Only update existing cookies
242 if (isset($_COOKIE[$cookieName])) {
244 $this->addCookie($cookieName, $_COOKIE[$cookieName], FALSE);