]> git.mxchange.org Git - core.git/blob - inc/classes/main/response/image/class_ImageResponse.php
Moved from shipsimu project.
[core.git] / inc / classes / main / response / image / class_ImageResponse.php
1 <?php
2 /**
3  * A class for an image response on an HTTP request
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
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
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 ImageResponse extends BaseResponse implements Responseable {
28         /**
29          * Protected constructor
30          *
31          * @return      void
32          */
33         protected function __construct () {
34                 // Call parent constructor
35                 parent::__construct(__CLASS__);
36
37                 // Set response type
38                 $this->setResponseType('image');
39         }
40
41         /**
42          * Creates an object of this class
43          *
44          * @param       $applicationInstance    An instance of a manageable application
45          * @return      $responseInstance               A prepared instance of this class
46          */
47         public static final function createImageResponse (ManageableApplication $applicationInstance) {
48                 // Get a new instance
49                 $responseInstance = new ImageResponse();
50
51                 // Set the application instance
52                 $responseInstance->setApplicationInstance($applicationInstance);
53
54                 // Initialize the template engine here
55                 $responseInstance->initTemplateEngine($applicationInstance);
56
57                 // Init web output instance
58                 $responseInstance->initWebOutputInstance();
59
60                 // Return the prepared instance
61                 return $responseInstance;
62         }
63
64         /**
65          * Initializes the template engine instance
66          *
67          * @param       $applicationInstance    An instance of a manageable application
68          * @return      void
69          */
70         public final function initTemplateEngine (ManageableApplication $applicationInstance) {
71                 // Get config instance
72                 $cfg = $this->getConfigInstance();
73
74                 // Set new template engine
75                 $cfg->setConfigEntry('html_template_class'    , $cfg->getConfigEntry('image_template_class'));
76                 $cfg->setConfigEntry('raw_template_extension' , '.img');
77                 $cfg->setConfigEntry('code_template_extension', '.xml');
78                 $cfg->setConfigEntry('tpl_base_path'          , 'templates/images/');
79                 $cfg->setConfigEntry('code_template_type'     , 'image');
80
81                 // Get a prepared instance
82                 $this->setTemplateInstance($this->prepareTemplateInstance($applicationInstance));
83         }
84
85         /**
86          * Adds a cookie to the response
87          *
88          * @param       $cookieName             Cookie's name
89          * @param       $cookieValue    Value to store in the cookie
90          * @param       $encrypted              Do some extra encryption on the value
91          * @param       $expires                Timestamp of expiration (default: configured)
92          * @return      void
93          * @throws      ResponseHeadersAlreadySentException             If headers are already sent
94          * @todo        Encryption of cookie data not yet supported.
95          * @todo        Why are these parameters conflicting?
96          * @todo        If the return statement is removed and setcookie() commented out,
97          * @todo        this will send only one cookie out, the first one.
98          */
99         public function addCookie ($cookieName, $cookieValue, $encrypted = FALSE, $expires = NULL) {
100                 // Are headers already sent?
101                 if (headers_sent()) {
102                         // Throw an exception here
103                         throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
104                 } // END - if
105
106                 // Shall we encrypt the cookie?
107                 if ($encrypted === TRUE) {
108                         // Unsupported at the moment
109                         $this->partialStub('Encryption is unsupported at the moment.');
110                 } // END - if
111
112                 // For slow browsers set the cookie array element first
113                 $_COOKIE[$cookieName] = $cookieValue;
114
115                 // Get all config entries
116                 if (is_null($expires)) {
117                         $expires = (time() + $this->getConfigInstance()->getConfigEntry('cookie_expire'));
118                 } // END - if
119
120                 $path = $this->getConfigInstance()->getConfigEntry('cookie_path');
121                 $domain = $this->getConfigInstance()->getConfigEntry('cookie_domain');
122
123                 setcookie($cookieName, $cookieValue, $expires);
124                 //, $path, $domain, (isset($_SERVER['HTTPS']))
125                 return;
126
127                 // Now construct the full header
128                 $cookieString = $cookieName . '=' . $cookieValue . '; ';
129                 $cookieString .= 'expires=' . date('D, d-F-Y H:i:s', $expires) . ' GMT';
130                 // TODO Why is this not always working? $cookieString .= '; path=' . $path . '; domain=' . $domain;
131
132                 // Set the cookie as a header
133                 $this->cookies[$cookieName] = $cookieString;
134         }
135
136         /**
137          * Redirect to a configured URL. The URL can be absolute or relative. In
138          * case of relative URL it will be extended automatically.
139          *
140          * @param       $configEntry    The configuration entry which holds our URL
141          * @return      void
142          * @throws      ResponseHeadersAlreadySentException             If headers are already sent
143          */
144         public function redirectToConfiguredUrl ($configEntry) {
145                 // Is the header not yet sent?
146                 if (headers_sent()) {
147                         // Throw an exception here
148                         throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
149                 } // END - if
150
151                 // Assign application data
152                 $this->getTemplateInstance()->assignApplicationData($this->getApplicationInstance());
153
154                 // Get the url from config
155                 $url = $this->getConfigInstance()->getConfigEntry($configEntry . '_url');
156
157                 // Compile the URL
158                 $url = $this->getTemplateInstance()->compileRawCode($url);
159
160                 // Do we have a 'http' in front of the URL?
161                 if (substr(strtolower($url), 0, 4) != 'http') {
162                         // Is there a / in front of the relative URL?
163                         if (substr($url, 0, 1) == '/') $url = substr($url, 1);
164
165                         // No, then extend it with our base URL
166                         $url = $this->getConfigInstance()->getConfigEntry('base_url') . '/' . $url;
167                 } // END - if
168
169                 // Add redirect header
170                 $this->addHeader('Location', str_replace('&amp;', '&', $url));
171
172                 // Set correct response status
173                 $this->setResponseStatus('301 Moved Permanently');
174
175                 // Clear the body
176                 $this->setResponseBody('');
177
178                 // Flush the result
179                 $this->flushBuffer();
180
181                 // All done here...
182                 exit();
183         }
184
185         /**
186          * Flushs the cached HTTP response to the outer world
187          *
188          * @param       $force  Whether we shall force the output or abort if headers are
189          *                                      already sent with an exception
190          * @return      void
191          */
192         public function flushBuffer ($force = FALSE) {
193                 // Finish the image
194                 $this->getImageInstance()->finishImage();
195
196                 // Get image content
197                 $content = $this->getImageInstance()->getContent();
198
199                 // Set it as response body
200                 $this->setResponseBody($content);
201
202                 // Set content type
203                 $this->addHeader('Content-type', 'image/' . $this->getImageInstance()->getImageType());
204
205                 // Call parent method
206                 parent::flushBuffer($force);
207         }
208
209         /**
210          * Expires the given cookie if it is set
211          *
212          * @param       $cookieName             Cookie to expire
213          * @return      void
214          */
215         public function expireCookie ($cookieName) {
216                 // Is the cookie there?
217                 if (isset($_COOKIE[$cookieName])) {
218                         // Then expire it with 20 minutes past
219                         $this->addCookie($cookieName, '', FALSE, (time() - 1200));
220
221                         // Remove it from array
222                         unset($_COOKIE[$cookieName]);
223                 } // END - if
224         }
225
226         /**
227          * Refreshs a given cookie. This will make the cookie live longer
228          *
229          * @param       $cookieName             Cookie to refresh
230          * @return      void
231          */
232         public function refreshCookie ($cookieName) {
233                 // Only update existing cookies
234                 if (isset($_COOKIE[$cookieName])) {
235                         // Update the cookie
236                         $this->addCookie($cookieName, $_COOKIE[$cookieName], FALSE);
237                 } // END - if
238         }
239 }
240
241 // [EOF]
242 ?>