This repository has been archived by the owner on Nov 26, 2017. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 298
/
response.php
333 lines (293 loc) · 6.32 KB
/
response.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
<?php
/**
* @package Joomla.Platform
* @subpackage Environment
*
* @copyright Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* JResponse Class.
*
* This class serves to provide the Joomla Platform with a common interface to access
* response variables. This includes header and body.
*
* @package Joomla.Platform
* @subpackage Environment
* @since 11.1
*/
class JResponse
{
/**
* @var array Body
* @since 11.1
*/
protected static $body = array();
/**
* @var boolean Cachable
* @since 11.1
*/
protected static $cachable = false;
/**
* @var array Headers
* @since 11.1
*/
protected static $headers = array();
/**
* Set/get cachable state for the response.
*
* If $allow is set, sets the cachable state of the response. Always returns current state.
*
* @param boolean $allow True to allow browser caching.
*
* @return boolean True if browser caching should be allowed
*
* @since 11.1
*/
public static function allowCache($allow = null)
{
if (!is_null($allow))
{
self::$cachable = (bool) $allow;
}
return self::$cachable;
}
/**
* Set a header.
*
* If $replace is true, replaces any headers already defined with that $name.
*
* @param string $name The name of the header to set.
* @param string $value The value of the header to set.
* @param boolean $replace True to replace any existing headers by name.
*
* @return void
*
* @since 11.1
*/
public static function setHeader($name, $value, $replace = false)
{
$name = (string) $name;
$value = (string) $value;
if ($replace)
{
foreach (self::$headers as $key => $header)
{
if ($name == $header['name'])
{
unset(self::$headers[$key]);
}
}
}
self::$headers[] = array('name' => $name, 'value' => $value);
}
/**
* Return array of headers.
*
* @return array
*
* @since 11.1
*/
public static function getHeaders()
{
return self::$headers;
}
/**
* Clear headers.
*
* @return void
*
* @since 11.1
*/
public static function clearHeaders()
{
self::$headers = array();
}
/**
* Send all headers.
*
* @return void
*
* @since 11.1
*/
public static function sendHeaders()
{
if (!headers_sent())
{
foreach (self::$headers as $header)
{
if ('status' == strtolower($header['name']))
{
// 'status' headers indicate an HTTP status, and need to be handled slightly differently
header(ucfirst(strtolower($header['name'])) . ': ' . $header['value'], null, (int) $header['value']);
}
else
{
header($header['name'] . ': ' . $header['value'], false);
}
}
}
}
/**
* Set body content.
*
* If body content already defined, this will replace it.
*
* @param string $content The content to set to the response body.
*
* @return void
*
* @since 11.1
*/
public static function setBody($content)
{
self::$body = array((string) $content);
}
/**
* Prepend content to the body content
*
* @param string $content The content to prepend to the response body.
*
* @return void
*
* @since 11.1
*/
public static function prependBody($content)
{
array_unshift(self::$body, (string) $content);
}
/**
* Append content to the body content
*
* @param string $content The content to append to the response body.
*
* @return void
*
* @since 11.1
*/
public static function appendBody($content)
{
array_push(self::$body, (string) $content);
}
/**
* Return the body content
*
* @param boolean $toArray Whether or not to return the body content as an array of strings or as a single string; defaults to false.
*
* @return string array
*
* @since 11.1
*/
public static function getBody($toArray = false)
{
if ($toArray)
{
return self::$body;
}
ob_start();
foreach (self::$body as $content)
{
echo $content;
}
return ob_get_clean();
}
/**
* Sends all headers prior to returning the string
*
* @param boolean $compress If true, compress the data
*
* @return string
*
* @since 11.1
*/
public static function toString($compress = false)
{
$data = self::getBody();
// Don't compress something if the server is going to do it anyway. Waste of time.
if ($compress && !ini_get('zlib.output_compression') && ini_get('output_handler') != 'ob_gzhandler')
{
$data = self::compress($data);
}
if (self::allowCache() === false)
{
self::setHeader('Cache-Control', 'no-cache', false);
// HTTP 1.0
self::setHeader('Pragma', 'no-cache');
}
self::sendHeaders();
return $data;
}
/**
* Compress the data
*
* Checks the accept encoding of the browser and compresses the data before
* sending it to the client.
*
* @param string $data Content to compress for output.
*
* @return string compressed data
*
* @note Replaces _compress method in 11.1
* @since 11.1
*/
protected static function compress($data)
{
$encoding = self::clientEncoding();
if (!$encoding)
{
return $data;
}
if (!extension_loaded('zlib') || ini_get('zlib.output_compression'))
{
return $data;
}
if (headers_sent())
{
return $data;
}
if (connection_status() !== 0)
{
return $data;
}
// Ideal level
$level = 4;
/*
$size = strlen($data);
$crc = crc32($data);
$gzdata = "\x1f\x8b\x08\x00\x00\x00\x00\x00";
$gzdata .= gzcompress($data, $level);
$gzdata = substr($gzdata, 0, strlen($gzdata) - 4);
$gzdata .= pack("V",$crc) . pack("V", $size);
*/
$gzdata = gzencode($data, $level);
self::setHeader('Content-Encoding', $encoding);
self::setHeader('X-Content-Encoded-By', 'Joomla! 1.6');
return $gzdata;
}
/**
* Check, whether client supports compressed data
*
* @return boolean
*
* @since 11.1
* @note Replaces _clientEncoding method from 11.1
*/
protected static function clientEncoding()
{
if (!isset($_SERVER['HTTP_ACCEPT_ENCODING']))
{
return false;
}
$encoding = false;
if (false !== strpos($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip'))
{
$encoding = 'gzip';
}
if (false !== strpos($_SERVER['HTTP_ACCEPT_ENCODING'], 'x-gzip'))
{
$encoding = 'x-gzip';
}
return $encoding;
}
}