Copyright updated
[core.git] / inc / classes / main / response / class_BaseResponse.php
1 <?php
2 /**
3  * A generic request class
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.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 BaseResponse extends BaseFrameworkSystem {
28         /**
29          * Response status
30          */
31         private $responseStatus = "200 OK";
32
33         /**
34          * Array with all headers
35          */
36         private $responseHeaders = array();
37
38         /**
39          * Cookies we shall sent out
40          */
41         private $cookies = array();
42
43         /**
44          * Body of the response
45          */
46         private $responseBody = '';
47
48         /**
49          * Instance of the template engine
50          */
51         private $templateInstance = null;
52
53         /**
54          * Fatal resolved messages from filters and so on
55          */
56         private $fatalMessages = array();
57
58         /**
59          * Protected constructor
60          *
61          * @param       $className      Name of the concrete response
62          * @return      void
63          */
64         protected function __construct ($className) {
65                 // Call parent constructor
66                 parent::__construct($className);
67         }
68
69         /**
70          * Setter for status
71          *
72          * @param       $status         New response status
73          * @return      void
74          */
75         public final function setResponseStatus ($status) {
76                 $this->responseStatus = (string) $status;
77         }
78
79         /**
80          * Add header element
81          *
82          * @param       $name   Name of header element
83          * @param       $value  Value of header element
84          * @return      void
85          */
86         public final function addHeader ($name, $value) {
87                 $this->responseHeaders[$name] = $value;
88         }
89
90         /**
91          * Reset the header array
92          *
93          * @return      void
94          */
95         public final function resetResponseHeaders () {
96                 $this->responseHeaders = array();
97         }
98
99         /**
100          * "Writes" data to the response body
101          *
102          * @param       $output         Output we shall sent in the HTTP response
103          * @return      void
104          */
105         public final function writeToBody ($output) {
106                 $this->responseBody .= $output;
107         }
108
109         /**
110          * Sets the response body to something new
111          *
112          * @param       $output         Output we shall sent in the HTTP response
113          * @return      void
114          */
115         public final function setResponseBody ($output) {
116                 $this->responseBody = $output;
117         }
118
119         /**
120          * Adds a fatal message id to the response. The added messages can then be
121          * processed and outputed to the world
122          *
123          * @param       $messageId      The message id we shall add
124          * @return      void
125          */
126         public final function addFatalMessage ($messageId) {
127                 // Adds the resolved message id to the fatal message list
128                 $this->fatalMessages[] = $this->getApplicationInstance()->getLanguageInstance()->getMessage($messageId);
129         }
130
131         /**
132          * Adds a plain fatal message id to the response
133          *
134          * @param       $message        The plain message we shall add
135          * @return      void
136          */
137         public final function addFatalMessagePlain ($message) {
138                 // Adds the resolved message id to the fatal message list
139                 $this->fatalMessages[] = $message;
140         }
141
142         /**
143          * Flushs the cached HTTP response to the outer world
144          *
145          * @param       $force  Wether we shall force the output or abort if headers are
146          *                                      already sent with an exception
147          * @return      void
148          * @throws      ResponseHeadersAlreadySentException             Thrown if headers are
149          *                                                                                                      already sent
150          */
151         public function flushBuffer ($force = false) {
152                 if ((headers_sent()) && ($force === false)) {
153                         // Headers are already sent!
154                         throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
155                 } elseif (!headers_sent()) {
156                         // Send headers out
157                         header("HTTP/1.1 {$this->responseStatus}");
158
159                         // Used later
160                         $now = gmdate('D, d M Y H:i:s') . ' GMT';
161
162                         // General header for no caching
163                         $this->addHeader('Expired', $now); // RFC2616 - Section 14.21
164                         $this->addHeader('Last-Modified', $now);
165                         $this->addHeader('Cache-Control', 'no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0'); // HTTP/1.1
166                         $this->addHeader('Pragma', 'no-cache'); // HTTP/1.0
167
168                         // Define the charset to be used
169                         //$this->addHeader('Content-type:', sprintf("text/html; charset=%s", $this->getConfigInstance()->getConfigEntry('header_charset')));
170
171                         // Send all headers
172                         foreach ($this->responseHeaders as $name => $value) {
173                                 header("{$name}: {$value}");
174                                 //* DEBUG: */ echo "{$name}: {$value}<br />\n";
175                         } // END - foreach
176
177                         // Send cookies out?
178                         if (count($this->cookies) > 0) {
179                                 // Send all cookies
180                                 $cookieString = implode(' ', $this->cookies);
181                                 header("Set-Cookie: {$cookieString}");
182
183                                 // Remove them all
184                                 $this->cookies = array();
185                         } // END - if
186                 }
187
188                 // Are there some error messages?
189                 if (count($this->fatalMessages) == 0) {
190                         // Flush the output to the world
191                         $this->getWebOutputInstance()->output($this->responseBody);
192                 } else {
193                         // Display all error messages
194                         $this->getApplicationInstance()->handleFatalMessages($this->fatalMessages);
195
196                         // Send the error messages out to the world
197                         $this->getWebOutputInstance()->output($this->responseBody);
198                 }
199
200                 // Clear response header and body
201                 $this->setResponseBody('');
202                 $this->resetResponseHeaders();
203         }
204 }
205
206 // [EOF]
207 ?>