823b9e889e2a54c81ffcec33b33b5acee31053da
[mailer.git] / inc / http-functions.php
1 <?php
2 /************************************************************************
3  * Mailer v0.2.1-FINAL                                Start: 03/08/2011 *
4  * ===================                          Last change: 03/08/2011 *
5  *                                                                      *
6  * -------------------------------------------------------------------- *
7  * File              : http-functions.php                               *
8  * -------------------------------------------------------------------- *
9  * Short description : HTTP-related functions                           *
10  * -------------------------------------------------------------------- *
11  * Kurzbeschreibung  : HTTP-relevante Funktionen                        *
12  * -------------------------------------------------------------------- *
13  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
14  * Copyright (c) 2009 - 2015 by Mailer Developer Team                   *
15  * For more information visit: http://mxchange.org                      *
16  *                                                                      *
17  * This program is free software; you can redistribute it and/or modify *
18  * it under the terms of the GNU General Public License as published by *
19  * the Free Software Foundation; either version 2 of the License, or    *
20  * (at your option) any later version.                                  *
21  *                                                                      *
22  * This program is distributed in the hope that it will be useful,      *
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
25  * GNU General Public License for more details.                         *
26  *                                                                      *
27  * You should have received a copy of the GNU General Public License    *
28  * along with this program; if not, write to the Free Software          *
29  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
30  * MA  02110-1301  USA                                                  *
31  ************************************************************************/
32
33 // Some security stuff...
34 if (!defined('__SECURITY')) {
35         die();
36 } // END - if
37
38 // Initialize HTTP handling
39 function initHttp () {
40         // Initialize array
41         $GLOBALS['http_header'] = array();
42 }
43
44 // Sends out all headers required for HTTP/1.1 reply
45 function sendHttpHeaders () {
46         // Used later
47         $now = gmdate('D, d M Y H:i:s') . ' GMT';
48
49         // Send HTTP header
50         addHttpHeader('HTTP/1.1 ' . getHttpStatus());
51
52         // General headers for no caching
53         addHttpHeader('Expires: ' . $now); // RFC2616 - Section 14.21
54         addHttpHeader('Last-Modified: ' . $now);
55         addHttpHeader('Cache-Control: no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0'); // HTTP/1.1
56         addHttpHeader('Pragma: no-cache'); // HTTP/1.0
57         addHttpHeader('Connection: Close');
58
59         // There shall be no output mode in raw output-mode
60         if (!isRawOutputMode()) {
61                 // Send content-type not in raw output-mode
62                 addHttpHeader('Content-Type: ' . getContentType() . '; charset=UTF-8');
63         } // END - if
64
65         // Add language
66         addHttpHeader('Content-Language: ' . getLanguage());
67 }
68
69 // Checks whether the URL is full-qualified (http[s]:// + hostname [+ request data])
70 function isFullQualifiedUrl ($url) {
71         // Is there cache?
72         if (!isset($GLOBALS[__FUNCTION__][$url])) {
73                 // Determine it
74                 $GLOBALS[__FUNCTION__][$url] = ((substr($url, 0, 7) == 'http://') || (substr($url, 0, 8) == 'https://'));
75         } // END - if
76
77         // Return cache
78         return $GLOBALS[__FUNCTION__][$url];
79 }
80
81 // Generates the full GET URL from given base URL and data array
82 function generateGetUrlFromBaseUrlData ($baseUrl, $requestData = array()) {
83         // Init URL
84         $getUrl = $baseUrl;
85
86         // Is it full-qualified?
87         if (!isFullQualifiedUrl($getUrl)) {
88                 // Need to prepend a slash?
89                 if (substr($getUrl, 0, 1) != '/') {
90                         // Prepend it
91                         $getUrl = '/' . $getUrl;
92                 } // END - if
93
94                 // Prepend http://hostname from mxchange.org server
95                 $getUrl = getServerUrl() . $getUrl;
96         } // END - if
97
98         // Add data
99         $body = http_build_query($requestData, '', '&');
100
101         // There should be data, else we don't need to extend $baseUrl with $body
102         if (!empty($body)) {
103                 // Is there a question-mark in the script?
104                 if (!isInString('?', $baseUrl)) {
105                         // No, so first char must be question mark
106                         $body = '?' . $body;
107                 } else {
108                         // Ok, add &
109                         $body = '&' . $body;
110                 }
111
112                 // Add script data
113                 $getUrl .= $body;
114
115                 // Remove trailed & to make it more conform
116                 if (substr($getUrl, -1, 1) == '&') {
117                         $getUrl = substr($getUrl, 0, -1);
118                 } // END - if
119         } // END - if
120
121         // Return it
122         return $getUrl;
123 }
124
125 // Removes http[s]://<hostname> from given url
126 function removeHttpHostNameFromUrl ($url) {
127         // Remove http[s]://
128         $remove = explode(':', $url);
129         $remove = explode('/', substr($remove[1], 3));
130
131         // Remove the first element (should be the hostname)
132         unset($remove[0]);
133
134         // implode() back all other elements and prepend a slash
135         $url = '/' . implode('/', $remove);
136
137         // Return prepared URL
138         return $url;
139 }
140
141 // Sends a HTTP request (GET, POST, HEAD are currently supported)
142 function sendHttpRequest ($requestType, $baseUrl, $requestData = array(), $removeHeader = FALSE, $allowOnlyHttpOkay = TRUE) {
143         // Init response
144         $response = array();
145
146         // Start "detecting" the request type
147         switch ($requestType) {
148                 case 'HEAD': // Send a HTTP/1.1 HEAD request
149                         $response = sendHttpHeadRequest($baseUrl, $requestData, $allowOnlyHttpOkay);
150                         break;
151
152                 case 'GET': // Send a HTTP/1.1 GET request
153                         $response = sendHttpGetRequest($baseUrl, $requestData, $removeHeader, $allowOnlyHttpOkay);
154                         break;
155
156                 case 'POST': // Send a HTTP/1.1 POST request
157                         $response = sendHttpPostRequest($baseUrl, $requestData, $removeHeader, $allowOnlyHttpOkay);
158                         break;
159
160                 default: // Unsupported HTTP request, this is really bad and needs fixing
161                         reportBug(__FUNCTION__, __LINE__, 'Unsupported request detected. requestType=' . $requestType . ',baseUrl=' . $baseUrl . ',requestData()=' . count($requestData));
162                         break;
163         } // END - switch
164
165         // Return response
166         return $response;
167 }
168
169 // Sends a HEAD request
170 function sendHttpHeadRequest ($baseUrl, $requestData = array(), $allowOnlyHttpOkay = TRUE) {
171         // Generate full GET URL
172         $getUrl = generateGetUrlFromBaseUrlData($baseUrl, $requestData);
173         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getUrl=' . $getUrl);
174
175         // Is there http[s]:// in front of the URL?
176         if (isFullQualifiedUrl($getUrl)) {
177                 // Remove http[s]://<hostname> from URL
178                 $getUrl = removeHttpHostNameFromUrl($getUrl);
179         } elseif (substr($getUrl, 0, 1) != '/') {
180                 // Prepend a slash
181                 $getUrl = '/' . $getUrl;
182         }
183
184         // Extract hostname and port from script
185         $host = extractHostnameFromUrl($baseUrl);
186
187         // Generate HEAD request header
188         $request  = 'HEAD ' . (isProxyUsed() === TRUE ? $baseUrl : '') . trim($getUrl) . ' HTTP/1.1' . getConfig('HTTP_EOL');
189         $request .= 'Host: ' . $host . getConfig('HTTP_EOL');
190         $request .= 'Referer: ' . getUrl() . '/admin.php' . getConfig('HTTP_EOL');
191         if (isConfigEntrySet('FULL_VERSION')) {
192                 $request .= 'User-Agent: ' . getTitle() . '/' . getFullVersion() . getConfig('HTTP_EOL');
193         } else {
194                 $request .= 'User-Agent: ' . getTitle() . '/' . getConfig('VERSION') . getConfig('HTTP_EOL');
195         }
196         $request .= 'Accept: image/png,image/*;q=0.8,text/plain,text/html,*/*;q=0.5' . getConfig('HTTP_EOL');
197         $request .= 'Accept-Charset: UTF-8,*' . getConfig('HTTP_EOL');
198         $request .= 'Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0' . getConfig('HTTP_EOL');
199         $request .= 'Connection: close' . getConfig('HTTP_EOL');
200         $request .= getConfig('HTTP_EOL');
201
202         // Send the raw request
203         $response = sendRawRequest($host, $request, $allowOnlyHttpOkay);
204
205         // Return the result to the caller function
206         return $response;
207 }
208
209 // Send a GET request
210 function sendHttpGetRequest ($baseUrl, $requestData = array(), $removeHeader = FALSE, $allowOnlyHttpOkay = TRUE) {
211         // Generate full GET URL
212         $getUrl = generateGetUrlFromBaseUrlData($baseUrl, $requestData);
213         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getUrl=' . $getUrl);
214
215         // Is there http[s]:// in front of the URL?
216         if (isFullQualifiedUrl($getUrl)) {
217                 // Remove http[s]://<hostname> from url
218                 $getUrl = removeHttpHostNameFromUrl($getUrl);
219         } elseif (substr($getUrl, 0, 1) != '/') {
220                 // Prepend a slash
221                 $getUrl = '/' . $getUrl;
222         }
223
224         // Extract hostname and port from script
225         $host = extractHostnameFromUrl($baseUrl);
226
227         // Generate GET request header
228         $request  = 'GET ' . (isProxyUsed() === TRUE ? $baseUrl : '') . trim($getUrl) . ' HTTP/1.1' . getConfig('HTTP_EOL');
229         $request .= 'Host: ' . $host . getConfig('HTTP_EOL');
230         $request .= 'Referer: ' . getUrl() . '/admin.php' . getConfig('HTTP_EOL');
231         if (isConfigEntrySet('FULL_VERSION')) {
232                 $request .= 'User-Agent: ' . getTitle() . '/' . getFullVersion() . getConfig('HTTP_EOL');
233         } else {
234                 $request .= 'User-Agent: ' . getTitle() . '/' . getConfig('VERSION') . getConfig('HTTP_EOL');
235         }
236         $request .= 'Accept: image/png,image/*;q=0.8,text/plain,text/html,*/*;q=0.5' . getConfig('HTTP_EOL');
237         $request .= 'Accept-Charset: UTF-8,*' . getConfig('HTTP_EOL');
238         $request .= 'Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0' . getConfig('HTTP_EOL');
239         $request .= 'Connection: close' . getConfig('HTTP_EOL');
240         $request .= getConfig('HTTP_EOL');
241
242         // Send the raw request
243         $response = sendRawRequest($host, $request, $allowOnlyHttpOkay);
244
245         // Should we remove header lines?
246         if ($removeHeader === TRUE) {
247                 // Okay, remove them
248                 $response = removeHttpHeaderFromResponse($response);
249         } // END - if
250
251         // Return the result to the caller function
252         return $response;
253 }
254
255 // Send a POST request, sometimes even POST requests have no parameters
256 function sendHttpPostRequest ($baseUrl, $requestData = array(), $removeHeader = FALSE, $allowOnlyHttpOkay = TRUE) {
257         // Copy baseUrl to getUrl
258         $getUrl = $baseUrl;
259
260         // Is there http[s]:// in front of the URL?
261         if (isFullQualifiedUrl($getUrl)) {
262                 // Remove http[s]://<hostname> from url
263                 $getUrl = removeHttpHostNameFromUrl($getUrl);
264         } elseif (substr($getUrl, 0, 1) != '/') {
265                 // Prepend a slash
266                 $getUrl = '/' . $getUrl;
267         }
268
269         // Extract host name from script
270         $host = extractHostnameFromUrl($baseUrl);
271
272         // Construct request body
273         $body = http_build_query($requestData, '', '&');
274
275         // Generate POST request header
276         $request  = 'POST ' . (isProxyUsed() === TRUE ? $getUrl : '') . trim($getUrl) . ' HTTP/1.0' . getConfig('HTTP_EOL');
277         $request .= 'Host: ' . $host . getConfig('HTTP_EOL');
278         $request .= 'Referer: ' . getUrl() . '/admin.php' . getConfig('HTTP_EOL');
279         if (isConfigEntrySet('FULL_VERSION')) {
280                 $request .= 'User-Agent: ' . getTitle() . '/' . getFullVersion() . getConfig('HTTP_EOL');
281         } else {
282                 $request .= 'User-Agent: ' . getTitle() . '/' . getConfig('VERSION') . getConfig('HTTP_EOL');
283         }
284         $request .= 'Accept: text/plain;q=0.8' . getConfig('HTTP_EOL');
285         $request .= 'Accept-Charset: UTF-8,*' . getConfig('HTTP_EOL');
286         $request .= 'Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0' . getConfig('HTTP_EOL');
287         $request .= 'Content-Type: application/x-www-form-urlencoded' . getConfig('HTTP_EOL');
288         $request .= 'Content-Length: ' . strlen($body) . getConfig('HTTP_EOL');
289         $request .= 'Connection: close' . getConfig('HTTP_EOL');
290         $request .= getConfig('HTTP_EOL');
291
292         // Add body
293         $request .= $body;
294
295         // Send the raw request
296         $response = sendRawRequest($host, $request, $allowOnlyHttpOkay);
297
298         // Should we remove header lines?
299         if ($removeHeader === TRUE) {
300                 // Okay, remove them
301                 $response = removeHttpHeaderFromResponse($response);
302         } // END - if
303
304         // Return the result to the caller function
305         return $response;
306 }
307
308 // Sends a raw request (string) to given host (hostnames will be solved)
309 function sendRawRequest ($host, $request, $allowOnlyHttpOkay = TRUE) {
310         //* DEBUG: */ die('host='.$host.',request=<pre>'.$request.'</pre>');
311         // Init errno and errdesc with 'all fine' values
312         $errno = '0';
313         $errdesc = '';
314
315         // Default port is 80
316         $port = 80;
317
318         // Initialize array
319         $response = array();
320
321         // Default is non-broken HTTP server implementation
322         $GLOBALS['is_http_server_broken'] = FALSE;
323
324         // Load include
325         loadIncludeOnce('inc/classes/resolver.class.php');
326
327         // Extract port part from host
328         $portArray = explode(':', $host);
329         if (count($portArray) == 2) {
330                 // Extract host and port
331                 $host = $portArray[0];
332                 $port = $portArray[1];
333         } elseif (count($portArray) > 2) {
334                 // This should not happen!
335                 reportBug(__FUNCTION__, __LINE__, 'Invalid ' . $host . '. Please report this to the Mailer-Project team.');
336         }
337
338         // Get resolver instance
339         $resolver = new HostnameResolver();
340
341         // Default is no proxy
342         $proxyHost = NULL;
343
344         // Is the configuration entry set?
345         if ((!isInstaller()) && (isConfigEntrySet('proxy_host'))) {
346                 // Get proxy host
347                 $proxyHost = compileRawCode(getProxyHost());
348         } // END - if
349
350         // Open connection
351         if (isProxyUsed() === TRUE) {
352                 // Resolve hostname into IP address
353                 $ip = $resolver->resolveHostname($proxyHost);
354
355                 // Connect to host through proxy connection
356                 $resource = fsockopen($ip, bigintval(getProxyPort()), $errno, $errdesc, 30);
357         } else {
358                 // Resolve hostname into IP address
359                 $ip = $resolver->resolveHostname($host);
360
361                 // Connect to host directly
362                 $resource = fsockopen($ip, $port, $errno, $errdesc, 30);
363         }
364         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ip=' . $ip . ',host=' . $host . ',isProxyUsed()=' . intval(isProxyUsed()));
365
366         // Is there a link?
367         if (!is_resource($resource)) {
368                 // Failed!
369                 logDebugMessage(__FUNCTION__, __LINE__, $errdesc . ' (' . $errno . ')');
370                 return array('', '', '');
371         } elseif ((!stream_set_blocking($resource, 0)) || (!stream_set_timeout($resource, 1))) {
372                 // Cannot set non-blocking mode or timeout
373                 logDebugMessage(__FUNCTION__, __LINE__, socket_strerror(socket_last_error()));
374                 return array('', '', '');
375         }
376
377         // Shall proxy be used?
378         if (isProxyUsed() === TRUE) {
379                 // Setup proxy tunnel
380                 $response = setupProxyTunnel($host, $proxyHost, $port, $resource);
381
382                 // If the response is invalid, abort
383                 if ((count($response) == 3) && (empty($response[0])) && (empty($response[1])) && (empty($response[2]))) {
384                         // Invalid response!
385                         logDebugMessage(__FUNCTION__, __LINE__, 'Proxy tunnel not working?');
386                         return $response;
387                 } // END - if
388         } // END - if
389
390         // Write request
391         fwrite($resource, $request);
392
393         // Start counting
394         $start = microtime(TRUE);
395
396         // Read response
397         while (!feof($resource)) {
398                 // Get info from stream
399                 $info = stream_get_meta_data($resource);
400
401                 // Is it timed out? 15 seconds is a really patient...
402                 if (($info['timed_out'] == TRUE) || (microtime(TRUE) - $start) > 15) {
403                         // Timeout
404                         logDebugMessage(__FUNCTION__, __LINE__, 'Timed out to get data from host ' . $host);
405
406                         // Abort here
407                         break;
408                 } // END - if
409
410                 // Get line from stream
411                 $line = fgets($resource, 128);
412
413                 /*
414                  * Ignore empty lines because of non-blocking mode, you cannot use
415                  * empty() here as it would also see \r\n as "empty".
416                  */
417                 if (strlen($line) == 0) {
418                         // uslepp a little to avoid 100% CPU load
419                         usleep(10);
420
421                         // Skip this
422                         continue;
423                 } // END - if
424
425                 // Check for broken HTTP implementations
426                 if (substr(strtolower($line), 0, 7) == 'server:') {
427                         // Anomic (see http://anomic.de, http://yacy.net) is currently broken
428                         $GLOBALS['is_http_server_broken'] = (count(getArrayKeysFromSubStrArray(strtolower($line), array('anomichttpd'))) > 0);
429                 } // END - if
430
431                 // Add it to response
432                 //* DEBUG: */ print 'line(' . strlen($line) . ')='.$line.'<br />';
433                 array_push($response, $line);
434         } // END - while
435
436         // Close socket
437         fclose($resource);
438
439         // Time request if debug-mode is enabled
440         if (isDebugModeEnabled()) {
441                 // Add debug message...
442                 logDebugMessage(__FUNCTION__, __LINE__, 'Request took ' . (microtime(TRUE) - $start) . ' seconds and returned ' . count($response) . ' line(s).');
443         } // END - if
444
445         //* DEBUG: */ debugOutput('<strong>Request:</strong><pre>'.print_r($request, TRUE).'</pre>');
446         //* DEBUG: */ debugOutput('<strong>Response:</strong><pre>'.print_r($response, TRUE).'</pre>');
447
448         // Proxy agent found or something went wrong?
449         if (!isFilledArray($response)) {
450                 // No response, maybe timeout
451                 $response = array('', '', '');
452                 logDebugMessage(__FUNCTION__, __LINE__, 'Invalid empty response array, maybe timed out?');
453         } elseif ((substr(strtolower($response[0]), 0, 11) == 'proxy-agent') && (isProxyUsed() === TRUE)) {
454                 // Proxy header detected, so remove two lines
455                 array_shift($response);
456                 array_shift($response);
457         } // END - if
458
459         // Was the request successfull?
460         if ((!isHttpStatusOkay($response[0])) && ($allowOnlyHttpOkay === TRUE)) {
461                 // Not found / access forbidden
462                 logDebugMessage(__FUNCTION__, __LINE__, 'Unexpected status code ' . $response[0] . ' detected. "200 OK" was expected.');
463                 $response = array('', '', '');
464         } else {
465                 // Check array for chuncked encoding
466                 $response = unchunkHttpResponse($response);
467         } // END - if
468
469         // Return response
470         return $response;
471 }
472
473 // Is HTTP status okay?
474 function isHttpStatusOkay ($header) {
475         // Determine it
476         return in_array(strtoupper(trim($header)), array('HTTP/1.1 200 OK', 'HTTP/1.0 200 OK'));
477 }
478
479 // Sets up a proxy tunnel for given hostname and through resource
480 function setupProxyTunnel ($host, $proxyHost, $port, $resource) {
481         // Initialize array
482         $response = array('', '', '');
483
484         // Generate CONNECT request header
485         $proxyTunnel  = 'CONNECT ' . $host . ':' . $port . ' HTTP/1.0' . getConfig('HTTP_EOL');
486         $proxyTunnel .= 'Host: ' . $host . getConfig('HTTP_EOL');
487         $proxyTunnel .= 'Proxy-Connection: Keep-Alive' . getConfig('HTTP_EOL');
488
489         // Use login data to proxy? (username at least!)
490         if (getProxyUsername() != '') {
491                 // Add it as well
492                 $encodedAuth = base64_encode(compileRawCode(getProxyUsername()) . ':' . compileRawCode(getProxyPassword()));
493                 $proxyTunnel .= 'Proxy-Authorization: Basic ' . $encodedAuth . getConfig('HTTP_EOL');
494         } // END - if
495
496         // Add last new-line
497         $proxyTunnel .= getConfig('HTTP_EOL');
498         //* DEBUG: */ debugOutput('<strong>proxyTunnel=</strong><pre>' . $proxyTunnel.'</pre>');
499
500         // Write request
501         fwrite($resource, $proxyTunnel);
502
503         // Got response?
504         if (feof($resource)) {
505                 // No response received
506                 return $response;
507         } // END - if
508
509         // Read the first line
510         $resp = trim(fgets($resource, 10240));
511         $respArray = explode(' ', $resp);
512         if (((strtolower($respArray[0]) !== 'http/1.0') && (strtolower($respArray[0]) !== 'http/1.1')) || ($respArray[1] != '200')) {
513                 // Invalid response!
514                 return $response;
515         } // END - if
516
517         // All fine!
518         return $respArray;
519 }
520
521 // Check array for chuncked encoding
522 function unchunkHttpResponse ($response) {
523         // Default is not chunked
524         $isChunked = FALSE;
525
526         // Check if we have chunks
527         foreach ($response as $line) {
528                 // Make lower-case and trim it
529                 $line = trim($line);
530
531                 // Entry found?
532                 if ((isInStringIgnoreCase('transfer-encoding', $line)) && (isInStringIgnoreCase('chunked', $line))) {
533                         // Found!
534                         $isChunked = TRUE;
535                         break;
536                 } elseif (empty($line)) {
537                         // Empty line found (header->body)
538                         break;
539                 }
540         } // END - foreach
541
542         // Save whole body
543         $body = removeHttpHeaderFromResponse($response);
544
545         // Is it chunked?
546         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'isChunked=' . intval($isChunked));
547         if ($isChunked === TRUE) {
548                 // Make sure, that body is an array
549                 assert(is_array($body));
550
551                 // Good, we still have the HTTP headers in there, so we need to get rid
552                 // of them temporarly
553                 //* DEBUG: */ die('<pre>'.htmlentities(print_r(removeHttpHeaderFromResponse($response), TRUE)).'</pre>');
554                 $tempResponse = http_chunked_decode(implode('', $body));
555
556                 // We got a string back from http_chunked_decode(), so we need to convert it back to an array
557                 //* DEBUG: */ die('tempResponse['.strlen($tempResponse).'/'.gettype($tempResponse).']=<pre>'.replaceReturnNewLine(htmlentities($tempResponse)).'</pre>');
558
559                 // Re-add the headers
560                 $response = mergeHttpHeadersWithBody($tempResponse);
561         } elseif (is_array($body)) {
562                 /*
563                  * Make sure the body is in one array element as many other functions
564                  * get disturbed by it.
565                  */
566
567                 // Put all array elements from body together
568                 $body = implode('', $body);
569
570                 // Now merge the extracted headers + fixed body together
571                 $response = mergeHttpHeadersWithBody($body);
572         }
573
574         // Return the unchunked array
575         return $response;
576 }
577
578 // Merges HTTP header lines with given body (string)
579 function mergeHttpHeadersWithBody ($body) {
580         // Add empty entry to mimic header->body
581         $GLOBALS['http_headers'][] = getConfig('HTTP_EOL');
582
583         // Make sure at least one header is there (which is still not valid but okay here)
584         assert(isFilledArray($GLOBALS['http_headers']));
585
586         // Merge both together
587         return merge_array($GLOBALS['http_headers'], array(count($GLOBALS['http_headers']) => $body));
588 }
589
590 // Removes HTTP header lines from a response array (e.g. output from send<Get|Post>Request() )
591 function removeHttpHeaderFromResponse ($response) {
592         // Save headers for later usage
593         $GLOBALS['http_headers'] = array();
594
595         // The first array element has to contain HTTP
596         if ((isset($response[0])) && (substr(strtoupper($response[0]), 0, 5) == 'HTTP/')) {
597                 // Okay, we have headers, now remove them with a second array
598                 $response2 = $response;
599                 foreach ($response as $line) {
600                         // Remove line
601                         array_shift($response2);
602
603                         // Trim it for testing
604                         $lineTest = trim($line);
605
606                         // Is this line empty?
607                         if (empty($lineTest)) {
608                                 // Then stop here
609                                 break;
610                         } // END - if
611
612                         // Is the last line set and is not ending with \r\n?
613                         if ((isset($GLOBALS['http_headers'][count($GLOBALS['http_headers']) - 1])) && (substr($GLOBALS['http_headers'][count($GLOBALS['http_headers']) - 1], -2, 2) != getConfig('HTTP_EOL'))) {
614                                 // Add it to previous one
615                                 $GLOBALS['http_headers'][count($GLOBALS['http_headers']) - 1] .= $line;
616                         } else {
617                                 // Add full line to temporary global array
618                                 array_push($GLOBALS['http_headers'], $line);
619                         }
620                 } // END - foreach
621
622                 // Write back the array
623                 $response = $response2;
624         } // END - if
625
626         // Return the modified response array
627         return $response;
628 }
629
630 // Returns the flag if a broken HTTP server implementation was detected
631 function isBrokenHttpServerImplentation () {
632         // Determine it
633         $isBroken = ((isset($GLOBALS['is_http_server_broken'])) && ($GLOBALS['is_http_server_broken'] === TRUE));
634
635         // ... and return it
636         return $isBroken;
637 }
638
639 // Extract host from script name
640 function extractHostnameFromUrl (&$script) {
641         // Use default SERVER_URL by default... ;) So?
642         $url = getServerUrl();
643
644         // Is this URL valid?
645         if (substr($script, 0, 7) == 'http://') {
646                 // Use the hostname from script URL as new hostname
647                 $url = substr($script, 7);
648                 $extract = explode('/', $url);
649                 $url = $extract[0];
650                 // Done extracting the URL :)
651         } // END - if
652
653         // Extract host name
654         $host = str_replace(array('http://', 'https://'), array('', ''), $url);
655
656         // Is there a slash at the end?
657         if (isInString('/', $host)) {
658                 $host = substr($host, 0, strpos($host, '/'));
659         } // END - if
660
661         // Is there a double-dot in? (Means port number)
662         if (strpos($host, ':') !== FALSE) {
663                 // Detected a double-dot
664                 $hostArray = explode(':', $host);
665                 $host = $hostArray[0];
666         } // END - if
667
668         // Generate relative URL
669         //* DEBUG: */ debugOutput('SCRIPT=' . $script);
670         if (substr(strtolower($script), 0, 7) == 'http://') {
671                 // But only if http:// is in front!
672                 $script = substr($script, (strlen($url) + 7));
673         } elseif (substr(strtolower($script), 0, 8) == 'https://') {
674                 // Does this work?!
675                 $script = substr($script, (strlen($url) + 8));
676         }
677
678         //* DEBUG: */ debugOutput('SCRIPT=' . $script);
679         if (substr($script, 0, 1) == '/') {
680                 $script = substr($script, 1);
681         } // END - if
682
683         // Return host name
684         return $host;
685 }
686
687 // Adds a HTTP header to array
688 function addHttpHeader ($header) {
689         // Send the header
690         //* DEBUG: */ logDebugMessage(__FUNCTION__ . ': header=' . $header);
691         array_push($GLOBALS['http_header'], trim($header));
692 }
693
694 // Flushes all HTTP headers
695 function flushHttpHeaders () {
696         // Is the header already sent?
697         if (headers_sent()) {
698                 // Then abort here
699                 reportBug(__FUNCTION__, __LINE__, 'Headers already sent!');
700         } elseif ((!isset($GLOBALS['http_header'])) || (!is_array($GLOBALS['http_header']))) {
701                 // Not set or not an array
702                 reportBug(__FUNCTION__, __LINE__, 'Headers not set or not an array, isset()=' . isset($GLOBALS['http_header']) . ', please report this.');
703         }
704
705         // Flush all headers if found
706         foreach ($GLOBALS['http_header'] as $header) {
707                 // Send a single header
708                 header($header);
709         } // END - foreach
710
711         // Mark them as flushed
712         $GLOBALS['http_header'] = array();
713 }
714
715 //-----------------------------------------------------------------------------
716 // Automatically re-created functions, all taken from user comments on www.php.net
717 //-----------------------------------------------------------------------------
718
719 if (!function_exists('http_build_query')) {
720         // Taken from documentation on www.php.net, credits to Marco K. (Germany) and some light mods by R.Haeder
721         function http_build_query($requestData, $prefix = '', $sep = '', $key = '') {
722                 $ret = array();
723                 foreach ((array) $requestData as $k => $v) {
724                         if (is_int($k) && !is_null($prefix)) {
725                                 $k = urlencode($prefix . $k);
726                         } // END - if
727
728                         if ((!empty($key)) || ($key === 0)) {
729                                 $k = $key . '[' . urlencode($k) . ']';
730                         } // END - if
731
732                         if (is_array($v) || is_object($v)) {
733                                 array_push($ret, http_build_query($v, '', $sep, $k));
734                         } else {
735                                 array_push($ret, $k . '=' . urlencode($v));
736                         }
737                 } // END - foreach
738
739                 if (empty($sep)) {
740                         $sep = ini_get('arg_separator.output');
741                 } // END - if
742
743                 return implode($sep, $ret);
744         }
745 } // END - if
746
747 if (!function_exists('http_chunked_decode')) {
748         /**
749          * dechunk an HTTP 'transfer-encoding: chunked' message.
750          *
751          * @param       $chunk          The encoded message
752          * @return      $dechunk        The decoded message. If $chunk wasn't encoded properly reportBug() is being called
753          * @author      Marques Johansson (initial author)
754          * @author      Roland Haeder (heavy modifications and simplification)
755          * @link        http://php.net/manual/en/function.http-chunked-decode.php#89786
756          */
757         function http_chunked_decode ($chunk) {
758                 // Detect multi-byte encoding
759                 $mbPrefix = detectMultiBytePrefix($chunk);
760                 //* DEBUG: */ print 'mbPrefix=' . $mbPrefix . '<br />';
761
762                 // Init some variables
763                 $offset = 0;
764                 $len = call_user_func_array($mbPrefix . 'strlen', array(($chunk)));
765                 $dechunk = '';
766
767                 // Walk through all chunks
768                 while ($offset < $len) {
769                         // Where does the \r\n begin?
770                         $lineEndAt = call_user_func_array($mbPrefix . 'strpos', array($chunk, getConfig('HTTP_EOL'), $offset));
771
772                         /* DEBUG: *
773                         print 'lineEndAt[<em>'.__LINE__.'</em>]='.$lineEndAt.'<br />
774 offset[<em>'.__LINE__.'</em>]='.$offset.'<br />
775 len='.$len.'<br />
776 next[offset,10]=<pre>'.replaceReturnNewLine(htmlentities(call_user_func_array($mbPrefix . 'substr', array($chunk, $offset, 10)))).'</pre>';
777                         /* DEBUG: */
778
779                         // Get next hex-coded chunk length
780                         $chunkLenHex = call_user_func_array($mbPrefix . 'substr', array($chunk, $offset, ($lineEndAt - $offset)));
781
782                         /* DEBUG: *
783                         print 'chunkLenHex[<em>'.__LINE__.'</em>]='.replaceReturnNewLine(htmlentities($chunkLenHex)).'<br />
784 ';
785                         /* DEBUG: */
786
787                         // Validation if it is hexadecimal
788                         if (!isHexadecimal($chunkLenHex)) {
789                                 // Please help debugging this
790                                 //* DEBUG: */ die('ABORT:chunkLenHex=<pre>'.replaceReturnNewLine(htmlentities($chunkLenHex)).'</pre>');
791                                 reportBug(__FUNCTION__, __LINE__, 'Value ' . $chunkLenHex . ' is no valid hexa-decimal string.');
792
793                                 // This won't be reached
794                                 return $chunk;
795                         } // END - if
796
797                         // Position of next chunk is right after \r\n
798                         $offset   = $offset + strlen($chunkLenHex) + strlen(getConfig('HTTP_EOL'));
799                         $chunkLen = hexdec(rtrim($chunkLenHex, getConfig('HTTP_EOL')));
800
801                         /* DEBUG: *
802                         print 'chunkLen='.$chunkLen.'<br />
803 offset[<em>'.__LINE__.'</em>]='.$offset.'<br />';
804                         /* DEBUG: */
805
806                         // Moved out for debugging
807                         $next  = call_user_func_array($mbPrefix . 'substr', array($chunk, $offset, $chunkLen));
808                         //* DEBUG: */ print 'next=<pre>'.replaceReturnNewLine(htmlentities($next)).'</pre>';
809
810                         /*
811                          * Hack for e.g. YaCy HTTPDaemon (Anomic Server), this HTTP server
812                          * is currently (revision 7567 and maybe earlier) broken and does
813                          * not include the \r\n characters when it sents a "chunked" HTTP
814                          * message.
815                          */
816                         $count = 0;
817                         if (isBrokenHttpServerImplentation()) {
818                                 // Count occurrences of \r\n
819                                 $count = call_user_func_array($mbPrefix . 'substr_count', array($next, getConfig('HTTP_EOL')));
820                         } // END - if
821
822                         /*
823                          * Correct chunk length because some broken HTTP server
824                          * implementation subtract occurrences of \r\n in their chunk
825                          * lengths.
826                          */
827                         $chunkLen = hexdec(rtrim($chunkLenHex, getConfig('HTTP_EOL'))) - ($count * strlen(getConfig('HTTP_EOL')));
828
829                         // Add next chunk to $dechunk
830                         $dechunk .= call_user_func_array($mbPrefix . 'substr', array($chunk, $offset, $chunkLen));
831
832                         /* DEBUG: *
833                         print('offset[<em>'.__LINE__.'</em>]='.$offset.'<br />
834 lineEndAt[<em>'.__LINE__.'</em>]='.$lineEndAt.'<br />
835 len='.$len.'<br />
836 count='.$count.'<br />
837 chunkLen='.$chunkLen.'<br />
838 chunkLenHex='.$chunkLenHex.'<br />
839 dechunk=<pre>'.replaceReturnNewLine(htmlentities($dechunk)).'</pre>
840 chunk=<pre>'.replaceReturnNewLine(htmlentities($chunk)).'</pre>');
841                         /* DEBUG: */
842
843                         // Is $offset + $chunkLen larger than or equal $len?
844                         if (($offset + $chunkLen) >= $len) {
845                                 // Then stop processing here
846                                 break;
847                         } // END - if
848
849                         // Calculate offset of next chunk
850                         $offset = call_user_func_array($mbPrefix . 'strpos', array($chunk, getConfig('HTTP_EOL'), $offset + $chunkLen)) + 2;
851
852                         /* DEBUG: *
853                         print('offset[<em>'.__LINE__.'</em>]='.$offset.'<br />
854 next[100]=<pre>'.replaceReturnNewLine(htmlentities(call_user_func_array($mbPrefix . 'substr', array($chunk, $offset, 100)))).'</pre>
855 ---:---:---:---:---:---:---:---:---<br />
856 ');
857                         /* DEBUG: */
858                 } // END - while
859
860                 // Return de-chunked string
861                 return $dechunk;
862         }
863 } // END - if
864
865 // Getter for request method
866 function getHttpRequestMethod () {
867         // Console is default
868         $requestMethod = 'console';
869
870         // Is it set?
871         if (isset($_SERVER['REQUEST_METHOD'])) {
872                 // Get current request method
873                 $requestMethod = $_SERVER['REQUEST_METHOD'];
874         } // END - if
875
876         // Return it
877         return $requestMethod;
878 }
879
880 // Checks if 'content_type' is set
881 function isContentTypeSet () {
882         return isset($GLOBALS['content_type']);
883 }
884
885 // Setter for content type
886 function setContentType ($contentType) {
887         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'contentType=' . $contentType);
888         $GLOBALS['content_type'] = (string) $contentType;
889 }
890
891 // Getter for content type
892 function getContentType () {
893         // Is it there?
894         if (!isContentTypeSet()) {
895                 // Please fix this
896                 reportBug(__FUNCTION__, __LINE__, 'content_type not set in GLOBALS array.');
897         } // END - if
898
899         // Return it
900         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'content_type=' . $GLOBALS['content_type']);
901         return $GLOBALS['content_type'];
902 }
903
904 // Logs wrong SERVER_NAME attempts
905 function logWrongServerNameRedirect () {
906         // Is ext-sql_patches at least version 0.9.2?
907         if (isExtensionInstalledAndNewer('sql_patches', '0.9.2')) {
908                 // Is there an entry?
909                 if (countSumTotalData(detectServerName(), 'server_name_log', 'server_name_id', 'server_name', TRUE, str_replace('%', '{PER}', sprintf(" AND `server_name_remote_addr`='%s' AND `server_name_ua`='%s' AND `server_name_referrer`='%s'", sqlEscapeString(detectRemoteAddr(TRUE)), sqlEscapeString(detectUserAgent(TRUE)), sqlEscapeString(detectReferer(TRUE))))) == 1) {
910                         // Update counter, as all are the same
911                         sqlQueryEscaped("UPDATE
912         `{?_MYSQL_PREFIX?}_server_name_log`
913 SET
914         `server_name_counter`=`server_name_counter`+1
915 WHERE
916         `server_name`='%s' AND
917         `server_name_remote_addr`='%s' AND
918         `server_name_ua`='%s' AND
919         `server_name_referrer`='%s'
920 LIMIT 1",
921                                 array(
922                                         detectServerName(),
923                                         detectRemoteAddr(TRUE),
924                                         detectUserAgent(TRUE),
925                                         detectReferer(TRUE)
926                                 ), __FUNCTION__, __LINE__);
927                 } else {
928                         // Then log it away
929                         sqlQueryEscaped("INSERT INTO `{?_MYSQL_PREFIX?}_server_name_log` (`server_name`, `server_name_remote_addr`, `server_name_ua`, `server_name_referrer`) VALUES('%s','%s', '%s', '%s')",
930                                 array(
931                                         detectServerName(),
932                                         detectRemoteAddr(TRUE),
933                                         detectUserAgent(TRUE),
934                                         detectReferer(TRUE)
935                                 ), __FUNCTION__, __LINE__);
936                 }
937         } // END - if
938 }
939
940 // Check if response status OK and array index 'response' is set
941 function isHttpResponseStatusOkay ($response) {
942         // Assertion on array
943         assert(is_array($response));
944
945         // Test it
946         $isOkay = ((isset($response['status'])) && ($response['status'] == 'OK') && (!empty($response['response'])));
947
948         // Return result
949         return $isOkay;
950 }
951
952 // [EOF]
953 ?>