Renamed Registry -> GenericRegistry to make it clear that this registry does
[core.git] / framework / main / classes / response / html / class_HtmlResponse.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Response;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
7 use Org\Mxchange\CoreFramework\Response\Responseable;
8
9 /**
10  * A class for an HTML response on an HTML request
11  *
12  * @author              Roland Haeder <webmaster@shipsimu.org>
13  * @version             0.0.0
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
17  *
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.
22  *
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.
27  *
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/>.
30  *
31  * The extended headers are taken from phpMyAdmin setup tool, written by
32  * Michal Cihar <michal@cihar.com>, licensed under GNU GPL 2.0.
33  */
34 class HtmlResponse extends BaseResponse implements Responseable {
35         /**
36          * Protected constructor
37          *
38          * @return      void
39          */
40         protected function __construct () {
41                 // Call parent constructor
42                 parent::__construct(__CLASS__);
43
44                 // Set response type
45                 $this->setResponseType('http');
46         }
47
48         /**
49          * Creates an object of this class
50          *
51          * @return      $responseInstance       A prepared instance of this class
52          */
53         public static final function createHtmlResponse () {
54                 // Get a new instance
55                 $responseInstance = new HtmlResponse();
56
57                 // Return the prepared instance
58                 return $responseInstance;
59         }
60
61         /**
62          * Initializes the template engine instance
63          *
64          * @param       $applicationInstance    An instance of a manageable application
65          * @return      void
66          */
67         public final function initTemplateEngine (ManageableApplication $applicationInstance) {
68                 $this->setTemplateInstance($this->prepareTemplateInstance($applicationInstance));
69         }
70
71         /**
72          * Adds a cookie to the response
73          *
74          * @param       $cookieName             Cookie's name
75          * @param       $cookieValue    Value to store in the cookie
76          * @param       $encrypted              Do some extra encryption on the value
77          * @param       $expires                Timestamp of expiration (default: configured)
78          * @return      void
79          * @throws      ResponseHeadersAlreadySentException             If headers are already sent
80          * @todo        Encryption of cookie data not yet supported.
81          * @todo        Why are these parameters conflicting?
82          * @todo        If the return statement is removed and setcookie() commented out,
83          * @todo        this will send only one cookie out, the first one.
84          */
85         public function addCookie ($cookieName, $cookieValue, $encrypted = false, $expires = NULL) {
86                 //* DEBUG: */ echo $cookieName.'='.$cookieValue."<br />\n";
87                 // Are headers already sent?
88                 if (headers_sent()) {
89                         // Throw an exception here
90                         //* DEBUG: */ return;
91                         throw new ResponseHeadersAlreadySentException($this, self::EXCEPTION_HEADERS_ALREADY_SENT);
92                 } // END - if
93
94                 // Shall we encrypt the cookie?
95                 if ($encrypted === true) {
96                         // Unsupported at the moment
97                         $this->partialStub('Encryption is unsupported at the moment.');
98                 } // END - if
99
100                 // For slow browsers set the cookie array element first
101                 $_COOKIE[$cookieName] = $cookieValue;
102
103                 // Get all config entries
104                 if (is_null($expires)) {
105                         $expires = (time() + $this->getConfigInstance()->getConfigEntry('cookie_expire'));
106                 } // END - if
107
108                 $path = $this->getConfigInstance()->getConfigEntry('cookie_path');
109                 $domain = $this->getConfigInstance()->getConfigEntry('cookie_domain');
110
111                 setcookie($cookieName, $cookieValue, $expires);
112                 //, $path, $domain, (isset($_SERVER['HTTPS']))
113                 return;
114
115                 // Now construct the full header
116                 $cookieString = $cookieName . '=' . $cookieValue . '; ';
117                 $cookieString .= 'expires=' . date('D, d-F-Y H:i:s', $expires) . ' GMT';
118                 // $cookieString .= "; path=".$path."; domain=".$domain;
119
120                 // Set the cookie as a header
121                 $this->cookies[$cookieName] = $cookieString;
122         }
123
124         /**
125          * Redirect to a configured URL. The URL can be absolute or relative. In
126          * case of relative URL it will be extended automatically.
127          *
128          * @param       $configEntry    The configuration entry which holds our URL
129          * @return      void
130          * @throws      ResponseHeadersAlreadySentException             If headers are already sent
131          */
132         public function redirectToConfiguredUrl ($configEntry) {
133                 // Get application instance
134                 $applicationInstance = GenericRegistry::getRegistry()->getInstance('app');
135
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);
140                 } // END - if
141
142                 // Assign application data
143                 $this->getTemplateInstance()->assignApplicationData($applicationInstance());
144
145                 // Get the url from config
146                 $url = $this->getConfigInstance()->getConfigEntry($configEntry . '_url');
147
148                 // Compile the URL
149                 $url = $this->getTemplateInstance()->compileRawCode($url);
150
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);
156                         } // END - if
157
158                         // No, then extend it with our base URL
159                         $url = $this->getConfigInstance()->getConfigEntry('base_url') . '/' . $url;
160                 } // END - if
161
162                 // Add redirect header
163                 $this->addHeader('Location', str_replace('&amp;', '&', $url));
164
165                 // Set correct response status
166                 $this->setResponseStatus('301 Moved Permanently');
167
168                 // Clear the body
169                 $this->setResponseBody('');
170
171                 // Flush the result
172                 $this->flushBuffer();
173
174                 // All done here...
175                 exit();
176         }
177
178         /**
179          * Expires the given cookie if it is set
180          *
181          * @param       $cookieName             Cookie to expire
182          * @return      void
183          */
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));
189
190                         // Remove it from array
191                         unset($_COOKIE[$cookieName]);
192                 } // END - if
193         }
194
195         /**
196          * Refreshs a given cookie. This will make the cookie live longer
197          *
198          * @param       $cookieName             Cookie to refresh
199          * @return      void
200          */
201         public function refreshCookie ($cookieName) {
202                 // Only update existing cookies
203                 if (isset($_COOKIE[$cookieName])) {
204                         // Update the cookie
205                         $this->addCookie($cookieName, $_COOKIE[$cookieName], false);
206                 } // END - if
207         }
208
209 }