3 namespace Org\Mxchange\CoreFramework\Response;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
7 use Org\Mxchange\CoreFramework\Image\BaseImage;
8 use Org\Mxchange\CoreFramework\Manager\ManageableApplication;
9 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
10 use Org\Mxchange\CoreFramework\Response\Responseable;
13 * A class for an image response on an HTTP request
15 * @author Roland Haeder <webmaster@shipsimu.org>
17 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
18 * @license GNU GPL 3.0 or any newer version
19 * @link http://www.shipsimu.org
21 * This program is free software: you can redistribute it and/or modify
22 * it under the terms of the GNU General Public License as published by
23 * the Free Software Foundation, either version 3 of the License, or
24 * (at your option) any later version.
26 * This program is distributed in the hope that it will be useful,
27 * but WITHOUT ANY WARRANTY; without even the implied warranty of
28 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29 * GNU General Public License for more details.
31 * You should have received a copy of the GNU General Public License
32 * along with this program. If not, see <http://www.gnu.org/licenses/>.
34 * The extended headers are taken from phpMyAdmin setup tool, written by
35 * Michal Cihar <michal@cihar.com>, licensed under GNU GPL 2.0.
37 class ImageResponse extends BaseResponse implements Responseable {
39 * Instance of the image
41 private $imageInstance = NULL;
44 * Protected constructor
48 protected function __construct () {
49 // Call parent constructor
50 parent::__construct(__CLASS__);
53 $this->setResponseType('image');
57 * Creates an object of this class
59 * @return $responseInstance A prepared instance of this class
61 public static final function createImageResponse () {
63 $responseInstance = new ImageResponse();
65 // Return the prepared instance
66 return $responseInstance;
70 * Setter for image instance
72 * @param $imageInstance An instance of an image
75 public final function setImageInstance (BaseImage $imageInstance) {
76 $this->imageInstance = $imageInstance;
80 * Getter for image instance
82 * @return $imageInstance An instance of an image
84 public final function getImageInstance () {
85 return $this->imageInstance;
89 * Initializes the template engine instance
91 * @param $applicationInstance An instance of a manageable application
94 public final function initTemplateEngine (ManageableApplication $applicationInstance) {
95 // Get config instance
96 $cfg = FrameworkBootstrap::getConfigurationInstance();
98 // Set new template engine
99 $cfg->setConfigEntry('html_template_class' , $cfg->getConfigEntry('image_template_class'));
100 $cfg->setConfigEntry('raw_template_extension' , '.img');
101 $cfg->setConfigEntry('code_template_extension', '.xml');
102 $cfg->setConfigEntry('tpl_base_path' , 'templates/images/');
103 // @TODO Please fix this
104 $cfg->setConfigEntry('code_template_type' , 'image');
106 // Get a prepared instance
107 $this->setTemplateInstance($this->prepareTemplateInstance($applicationInstance));
111 * Adds a cookie to the response
113 * @param $cookieName Cookie's name
114 * @param $cookieValue Value to store in the cookie
115 * @param $encrypted Do some extra encryption on the value
116 * @param $expires Timestamp of expiration (default: configured)
118 * @throws ResponseHeadersAlreadySentException If headers are already sent
119 * @todo Encryption of cookie data not yet supported.
120 * @todo Why are these parameters conflicting?
121 * @todo If the return statement is removed and setcookie() commented out,
122 * @todo this will send only one cookie out, the first one.
124 public function addCookie ($cookieName, $cookieValue, $encrypted = false, $expires = NULL) {
125 // Are headers already sent?
126 if (headers_sent()) {
127 // Throw an exception here
128 throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
131 // Shall we encrypt the cookie?
132 if ($encrypted === true) {
133 // Unsupported at the moment
134 $this->partialStub('Encryption is unsupported at the moment.');
137 // For slow browsers set the cookie array element first
138 $_COOKIE[$cookieName] = $cookieValue;
140 // Get all config entries
141 if (is_null($expires)) {
142 $expires = (time() + FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('cookie_expire'));
145 $path = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('cookie_path');
146 $domain = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('cookie_domain');
148 setcookie($cookieName, $cookieValue, $expires);
149 //, $path, $domain, (isset($_SERVER['HTTPS']))
152 // Now construct the full header
153 $cookieString = $cookieName . '=' . $cookieValue . '; ';
154 $cookieString .= 'expires=' . date('D, d-F-Y H:i:s', $expires) . ' GMT';
155 // TODO Why is this not always working? $cookieString .= '; path=' . $path . '; domain=' . $domain;
157 // Set the cookie as a header
158 $this->cookies[$cookieName] = $cookieString;
162 * Redirect to a configured URL. The URL can be absolute or relative. In
163 * case of relative URL it will be extended automatically.
165 * @param $configEntry The configuration entry which holds our URL
167 * @throws ResponseHeadersAlreadySentException If headers are already sent
169 public function redirectToConfiguredUrl ($configEntry) {
170 // Get application instance
171 $applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
173 // Is the header not yet sent?
174 if (headers_sent()) {
175 // Throw an exception here
176 throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
179 // Assign application data
180 $this->getTemplateInstance()->assignApplicationData($applicationInstance);
182 // Get the url from config
183 $url = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry($configEntry . '_url');
186 $url = $this->getTemplateInstance()->compileRawCode($url);
188 // Do we have a 'http' in front of the URL?
189 if (substr(strtolower($url), 0, 4) != 'http') {
190 // Is there a / in front of the relative URL?
191 if (substr($url, 0, 1) == '/') $url = substr($url, 1);
193 // No, then extend it with our base URL
194 $url = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('base_url') . '/' . $url;
197 // Add redirect header
198 $this->addHeader('Location', str_replace('&', '&', $url));
200 // Set correct response status
201 $this->setResponseStatus('301 Moved Permanently');
204 $this->setResponseBody('');
207 $this->flushBuffer();
214 * Flushs the cached HTTP response to the outer world
216 * @param $force Whether we shall force the output or abort if headers are
217 * already sent with an exception
220 public function flushBuffer ($force = false) {
222 $this->getImageInstance()->finishImage();
225 $content = $this->getImageInstance()->getContent();
227 // Set it as response body
228 $this->setResponseBody($content);
231 $this->addHeader('Content-type', 'image/' . $this->getImageInstance()->getImageType());
233 // Call parent method
234 parent::flushBuffer($force);
238 * Expires the given cookie if it is set
240 * @param $cookieName Cookie to expire
243 public function expireCookie ($cookieName) {
244 // Is the cookie there?
245 if (isset($_COOKIE[$cookieName])) {
246 // Then expire it with 20 minutes past
247 $this->addCookie($cookieName, '', false, (time() - 1200));
249 // Remove it from array
250 unset($_COOKIE[$cookieName]);
255 * Refreshs a given cookie. This will make the cookie live longer
257 * @param $cookieName Cookie to refresh
260 public function refreshCookie ($cookieName) {
261 // Only update existing cookies
262 if (isset($_COOKIE[$cookieName])) {
264 $this->addCookie($cookieName, $_COOKIE[$cookieName], false);