]> git.mxchange.org Git - mailer.git/blobdiff - inc/http-functions.php
Fixes: Use instead of (old), extracted proxy hostname to variable
[mailer.git] / inc / http-functions.php
index 3b9a630eefbe48e362a17f109bf5d28c70dec282..2ea26e6b11729d0ac84a16e14f518b1956a21ebc 100644 (file)
@@ -17,7 +17,7 @@
  * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
  * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
- * For more information visit: http://www.mxchange.org                  *
+ * For more information visit: http://mxchange.org                      *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
  * it under the terms of the GNU General Public License as published by *
@@ -46,30 +46,60 @@ function sendHttpHeaders () {
        $now = gmdate('D, d M Y H:i:s') . ' GMT';
 
        // Send HTTP header
-       sendHeader('HTTP/1.1 ' . getHttpStatus());
+       addHttpHeader('HTTP/1.1 ' . getHttpStatus());
 
        // General headers for no caching
-       sendHeader('Expires: ' . $now); // RFC2616 - Section 14.21
-       sendHeader('Last-Modified: ' . $now);
-       sendHeader('Cache-Control: no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0'); // HTTP/1.1
-       sendHeader('Pragma: no-cache'); // HTTP/1.0
-       sendHeader('Connection: Close');
-       sendHeader('Content-Type: ' . getContentType() . '; charset=UTF-8');
-       sendHeader('Content-Language: ' . getLanguage());
+       addHttpHeader('Expires: ' . $now); // RFC2616 - Section 14.21
+       addHttpHeader('Last-Modified: ' . $now);
+       addHttpHeader('Cache-Control: no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0'); // HTTP/1.1
+       addHttpHeader('Pragma: no-cache'); // HTTP/1.0
+       addHttpHeader('Connection: Close');
+       // There shall be no output mode in raw/AJAX mode
+       if ((!isRawOutputMode()) && (!isAjaxOutputMode())) {
+               // Send content-type only in CSS/HTML mode
+               addHttpHeader('Content-Type: ' . getContentType() . '; charset=UTF-8');
+       } else {
+               //
+       } // END - if
+       addHttpHeader('Content-Language: ' . getLanguage());
 }
 
-// Send a GET request
-function sendGetRequest ($baseUrl, $data = array(), $removeHeader = false) {
-       // Extract hostname and port from script
-       $host = extractHostnameFromUrl($baseUrl);
+// Checks wether the URL is full-qualified (http[s]:// + hostname [+ request data])
+function isFullQualifiedUrl ($url) {
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__][$url])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__][$url] = ((substr($url, 0, 7) == 'http://') || (substr($url, 0, 8) == 'https://'));
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__][$url];
+}
+
+// Generates the full GET URL from given base URL and data array
+function generateGetUrlFromBaseUrlData ($baseUrl, $requestData = array()) {
+       // Init URL
+       $getUrl = $baseUrl;
+
+       // Is it full-qualified?
+       if (!isFullQualifiedUrl($getUrl)) {
+               // Need to prepend a slash?
+               if (substr($getUrl, 0, 1) != '/') {
+                       // Prepend it
+                       $getUrl = '/' . $getUrl;
+               } // END - if
+
+               // Prepend http://hostname from mxchange.org server
+               $getUrl = getServerUrl() . $getUrl;
+       } // END - if
 
        // Add data
-       $body = http_build_query($data, '', '&');
+       $body = http_build_query($requestData, '', '&');
 
        // There should be data, else we don't need to extend $baseUrl with $body
        if (!empty($body)) {
                // Do we have a question-mark in the script?
-               if (strpos($baseUrl, '?') === false) {
+               if (!isInString('?', $baseUrl)) {
                        // No, so first char must be question mark
                        $body = '?' . $body;
                } else {
@@ -78,16 +108,120 @@ function sendGetRequest ($baseUrl, $data = array(), $removeHeader = false) {
                }
 
                // Add script data
-               $baseUrl .= $body;
+               $getUrl .= $body;
 
                // Remove trailed & to make it more conform
-               if (substr($baseUrl, -1, 1) == '&') {
-                       $baseUrl = substr($baseUrl, 0, -1);
+               if (substr($getUrl, -1, 1) == '&') {
+                       $getUrl = substr($getUrl, 0, -1);
                } // END - if
        } // END - if
 
+       // Return it
+       return $getUrl;
+}
+
+// Removes http[s]://<hostname> from given url
+function removeHttpHostNameFromUrl ($url) {
+       // Remove http[s]://
+       $remove = explode(':', $url);
+       $remove = explode('/', substr($remove[1], 3));
+
+       // Remove the first element (should be the hostname)
+       unset($remove[0]);
+
+       // implode() back all other elements and prepend a slash
+       $url = '/' . implode('/', $remove);
+
+       // Return prepared URL
+       return $url;
+}
+
+// Sends a HTTP request (GET, POST, HEAD are currently supported)
+function sendHttpRequest ($requestType, $baseUrl, $requestData = array(), $removeHeader = false) {
+       // Init response
+       $response = array();
+
+       // Start "detecting" the request type
+       switch ($requestType) {
+               case 'HEAD': // Send a HTTP/1.1 HEAD request
+                       $response = sendHeadRequest($baseUrl, $requestData);
+                       break;
+
+               case 'GET': // Send a HTTP/1.1 GET request
+                       $response = sendGetRequest($baseUrl, $requestData, $removeHeader);
+                       break;
+
+               case 'POST': // Send a HTTP/1.1 POST request
+                       $response = sendPostRequest($baseUrl, $requestData, $removeHeader);
+                       break;
+
+               default: // Unsupported HTTP request, this is really bad and needs fixing
+                       debug_report_bug(__FUNCTION__, __LINE__, 'Unsupported request detected. requestType=' . $requestType . ',baseUrl=' . $baseUrl . ',requestData()=' . count($requestData));
+                       break;
+       } // END - switch
+
+       // Return response
+       return $response;
+}
+
+// Sends a HEAD request
+function sendHeadRequest ($baseUrl, $requestData = array()) {
+       // Generate full GET URL
+       $getUrl = generateGetUrlFromBaseUrlData($baseUrl, $requestData);
+
+       // Do we have http[s]:// in front of the URL?
+       if (isFullQualifiedUrl($getUrl)) {
+               // Remove http[s]://<hostname> from URL
+               $getUrl = removeHttpHostNameFromUrl($getUrl);
+       } elseif (substr($getUrl, 0, 1) != '/') {
+               // Prepend a slash
+               $getUrl = '/' . $getUrl;
+       }
+
+       // Extract hostname and port from script
+       $host = extractHostnameFromUrl($baseUrl);
+
+       // Generate HEAD request header
+       $request  = 'HEAD ' . trim($getUrl) . ' HTTP/1.1' . getConfig('HTTP_EOL');
+       $request .= 'Host: ' . $host . getConfig('HTTP_EOL');
+       $request .= 'Referer: ' . getUrl() . '/admin.php' . getConfig('HTTP_EOL');
+       if (isConfigEntrySet('FULL_VERSION')) {
+               $request .= 'User-Agent: ' . getTitle() . '/' . getFullVersion() . getConfig('HTTP_EOL');
+       } else {
+               $request .= 'User-Agent: ' . getTitle() . '/' . getConfig('VERSION') . getConfig('HTTP_EOL');
+       }
+       $request .= 'Accept: image/png,image/*;q=0.8,text/plain,text/html,*/*;q=0.5' . getConfig('HTTP_EOL');
+       $request .= 'Accept-Charset: UTF-8,*' . getConfig('HTTP_EOL');
+       $request .= 'Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0' . getConfig('HTTP_EOL');
+       $request .= 'Connection: close' . getConfig('HTTP_EOL');
+       $request .= getConfig('HTTP_EOL');
+
+       // Send the raw request
+       $response = sendRawRequest($host, $request);
+
+       // Return the result to the caller function
+       return $response;
+}
+
+// Send a GET request
+function sendGetRequest ($baseUrl, $requestData = array(), $removeHeader = false) {
+       // Generate full GET URL
+       $getUrl = generateGetUrlFromBaseUrlData($baseUrl, $requestData);
+
+       // Do we have http[s]:// in front of the URL?
+       if (isFullQualifiedUrl($getUrl)) {
+               // Remove http[s]://<hostname> from url
+               $getUrl = removeHttpHostNameFromUrl($getUrl);
+       } elseif (substr($getUrl, 0, 1) != '/') {
+               // Prepend a slash
+               $getUrl = '/' . $getUrl;
+       }
+
+       // Extract hostname and port from script
+       $host = extractHostnameFromUrl($baseUrl);
+
        // Generate GET request header
-       $request  = 'GET /' . trim($baseUrl) . ' HTTP/1.1' . getConfig('HTTP_EOL');
+       $request  = 'GET ' . trim($getUrl) . ' HTTP/1.1' . getConfig('HTTP_EOL');
        $request .= 'Host: ' . $host . getConfig('HTTP_EOL');
        $request .= 'Referer: ' . getUrl() . '/admin.php' . getConfig('HTTP_EOL');
        if (isConfigEntrySet('FULL_VERSION')) {
@@ -115,21 +249,37 @@ function sendGetRequest ($baseUrl, $data = array(), $removeHeader = false) {
 }
 
 // Send a POST request
-function sendPostRequest ($baseUrl, $postData, $removeHeader = false) {
+function sendPostRequest ($baseUrl, $requestData, $removeHeader = false) {
+       // Copy baseUrl to getUrl
+       $getUrl = $baseUrl;
+
+       // Do we have http[s]:// in front of the URL?
+       if (isFullQualifiedUrl($getUrl)) {
+               // Remove http[s]://<hostname> from url
+               $getUrl = removeHttpHostNameFromUrl($getUrl);
+       } elseif (substr($getUrl, 0, 1) != '/') {
+               // Prepend a slash
+               $getUrl = '/' . $getUrl;
+       }
+
        // Extract host name from script
        $host = extractHostnameFromUrl($baseUrl);
 
        // Construct request body
-       $body = http_build_query($postData, '', '&');
+       $body = http_build_query($requestData, '', '&');
 
        // Generate POST request header
-       $request  = 'POST /' . trim($baseUrl) . ' HTTP/1.0' . getConfig('HTTP_EOL');
+       $request  = 'POST ' . trim($baseUrl) . ' HTTP/1.0' . getConfig('HTTP_EOL');
        $request .= 'Host: ' . $host . getConfig('HTTP_EOL');
        $request .= 'Referer: ' . getUrl() . '/admin.php' . getConfig('HTTP_EOL');
-       $request .= 'User-Agent: ' . getTitle() . '/' . getFullVersion() . getConfig('HTTP_EOL');
+       if (isConfigEntrySet('FULL_VERSION')) {
+               $request .= 'User-Agent: ' . getTitle() . '/' . getFullVersion() . getConfig('HTTP_EOL');
+       } else {
+               $request .= 'User-Agent: ' . getTitle() . '/' . getConfig('VERSION') . getConfig('HTTP_EOL');
+       }
        $request .= 'Accept: text/plain;q=0.8' . getConfig('HTTP_EOL');
        $request .= 'Accept-Charset: UTF-8,*' . getConfig('HTTP_EOL');
-       $request .= 'Cache-Control: no-cache' . getConfig('HTTP_EOL');
+       $request .= 'Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0' . getConfig('HTTP_EOL');
        $request .= 'Content-Type: application/x-www-form-urlencoded' . getConfig('HTTP_EOL');
        $request .= 'Content-Length: ' . strlen($body) . getConfig('HTTP_EOL');
        $request .= 'Connection: close' . getConfig('HTTP_EOL');
@@ -151,8 +301,9 @@ function sendPostRequest ($baseUrl, $postData, $removeHeader = false) {
        return $response;
 }
 
-// Sends a raw request to another host
+// Sends a raw request (string) to given host (hostnames will be solved)
 function sendRawRequest ($host, $request) {
+       //* DEBUG: */ die('host='.$host.',request=<pre>'.$request.'</pre>');
        // Init errno and errdesc with 'all fine' values
        $errno = '0';
        $errdesc = '';
@@ -163,18 +314,9 @@ function sendRawRequest ($host, $request) {
        // Initialize array
        $response = array('', '', '');
 
-       // Default is not to use proxy
-       $useProxy = false;
-
        // Default is non-broken HTTP server implementation
        $GLOBALS['is_http_server_broken'] = false;
 
-       // Are proxy settins set?
-       if (isProxyUsed()) {
-               // Then use it
-               $useProxy = true;
-       } // END - if
-
        // Load include
        loadIncludeOnce('inc/classes/resolver.class.php');
 
@@ -192,37 +334,40 @@ function sendRawRequest ($host, $request) {
        // Get resolver instance
        $resolver = new HostnameResolver();
 
+       // Get proxy host
+       $proxyHost = compileRawCode(getProxyHost());
+
        // Open connection
-       //* DEBUG: */ die('baseUrl=' . $baseUrl);
-       if ($useProxy === true) {
+       if (isProxyUsed() === true) {
                // Resolve hostname into IP address
-               $ip = $resolver->resolveHostname(compileRawCode(getProxyHost()));
+               $ip = $resolver->resolveHostname($proxyHost);
 
                // Connect to host through proxy connection
-               $fp = fsockopen($ip, bigintval(getProxyPort()), $errno, $errdesc, 30);
+               $resource = fsockopen($ip, bigintval(getProxyPort()), $errno, $errdesc, 30);
        } else {
                // Resolve hostname into IP address
                $ip = $resolver->resolveHostname($host);
 
                // Connect to host directly
-               $fp = fsockopen($ip, $port, $errno, $errdesc, 30);
+               $resource = fsockopen($ip, $port, $errno, $errdesc, 30);
        }
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ip=' . $ip . ',host=' . $host . ',isProxyUsed()=' . intval(isProxyUsed()));
 
        // Is there a link?
-       if (!is_resource($fp)) {
+       if (!is_resource($resource)) {
                // Failed!
                logDebugMessage(__FUNCTION__, __LINE__, $errdesc . ' (' . $errno . ')');
                return $response;
-       } elseif ((!stream_set_blocking($fp, 0)) || (!stream_set_timeout($fp, 1))) {
+       } elseif ((!stream_set_blocking($resource, 0)) || (!stream_set_timeout($resource, 1))) {
                // Cannot set non-blocking mode or timeout
                logDebugMessage(__FUNCTION__, __LINE__, socket_strerror(socket_last_error()));
                return $response;
        }
 
        // Do we use proxy?
-       if ($useProxy === true) {
+       if (isProxyUsed() === true) {
                // Setup proxy tunnel
-               $response = setupProxyTunnel($host, $port, $fp);
+               $response = setupProxyTunnel($host, $proxyHost, $port, $resource);
 
                // If the response is invalid, abort
                if ((count($response) == 3) && (empty($response[0])) && (empty($response[1])) && (empty($response[2]))) {
@@ -233,15 +378,15 @@ function sendRawRequest ($host, $request) {
        } // END - if
 
        // Write request
-       fwrite($fp, $request);
+       fwrite($resource, $request);
 
        // Start counting
        $start = microtime(true);
 
        // Read response
-       while (!feof($fp)) {
+       while (!feof($resource)) {
                // Get info from stream
-               $info = stream_get_meta_data($fp);
+               $info = stream_get_meta_data($resource);
 
                // Is it timed out? 15 seconds is a really patient...
                if (($info['timed_out'] == true) || (microtime(true) - $start) > 15) {
@@ -253,7 +398,7 @@ function sendRawRequest ($host, $request) {
                } // END - if
 
                // Get line from stream
-               $line = fgets($fp, 128);
+               $line = fgets($resource, 128);
 
                // Ignore empty lines because of non-blocking mode
                if (empty($line)) {
@@ -271,11 +416,12 @@ function sendRawRequest ($host, $request) {
                } // END - if
 
                // Add it to response
+               //* DEBUG: */ print 'line='.$line.'<br />';
                $response[] = $line;
        } // END - while
 
        // Close socket
-       fclose($fp);
+       fclose($resource);
 
        // Time request if debug-mode is enabled
        if (isDebugModeEnabled()) {
@@ -307,7 +453,7 @@ function sendRawRequest ($host, $request) {
                // No response, maybe timeout
                $response = array('', '', '');
                logDebugMessage(__FUNCTION__, __LINE__, 'Invalid empty response array, maybe timed out?');
-       } elseif ((substr(strtolower($response[0]), 0, 11) == 'proxy-agent') && ($useProxy === true)) {
+       } elseif ((substr(strtolower($response[0]), 0, 11) == 'proxy-agent') && (isProxyUsed() === true)) {
                // Proxy header detected, so remove two lines
                array_shift($response);
                array_shift($response);
@@ -328,13 +474,13 @@ function sendRawRequest ($host, $request) {
 }
 
 // Sets up a proxy tunnel for given hostname and through resource
-function setupProxyTunnel ($host, $port, $resource) {
+function setupProxyTunnel ($host, $proxyHost, $port, $resource) {
        // Initialize array
        $response = array('', '', '');
 
        // Generate CONNECT request header
        $proxyTunnel  = 'CONNECT ' . $host . ':' . $port . ' HTTP/1.0' . getConfig('HTTP_EOL');
-       $proxyTunnel .= 'Host: ' . $host . getConfig('HTTP_EOL');
+       $proxyTunnel .= 'Host: ' . $proxyHost . getConfig('HTTP_EOL');
 
        // Use login data to proxy? (username at least!)
        if (getProxyUsername() != '') {
@@ -348,16 +494,16 @@ function setupProxyTunnel ($host, $port, $resource) {
        //* DEBUG: */ debugOutput('<strong>proxyTunnel=</strong><pre>' . $proxyTunnel.'</pre>');
 
        // Write request
-       fwrite($fp, $proxyTunnel);
+       fwrite($resource, $proxyTunnel);
 
        // Got response?
-       if (feof($fp)) {
+       if (feof($resource)) {
                // No response received
                return $response;
        } // END - if
 
        // Read the first line
-       $resp = trim(fgets($fp, 10240));
+       $resp = trim(fgets($resource, 10240));
        $respArray = explode(' ', $resp);
        if ((strtolower($respArray[0]) !== 'http/1.0') || ($respArray[1] != '200')) {
                // Invalid response!
@@ -376,10 +522,10 @@ function unchunkHttpResponse ($response) {
        // Check if we have chunks
        foreach ($response as $line) {
                // Make lower-case and trim it
-               $line = trim(strtolower($line));
+               $line = trim($line);
 
                // Entry found?
-               if ((strpos($line, 'transfer-encoding') !== false) && (strpos($line, 'chunked') !== false)) {
+               if ((isInStringIgnoreCase('transfer-encoding', $line)) && (isInStringIgnoreCase('chunked', $line))) {
                        // Found!
                        $isChunked = true;
                        break;
@@ -447,15 +593,80 @@ function isBrokenHttpServerImplentation () {
        return $isBroken;
 }
 
+// Extract host from script name
+function extractHostnameFromUrl (&$script) {
+       // Use default SERVER_URL by default... ;) So?
+       $url = getServerUrl();
+
+       // Is this URL valid?
+       if (substr($script, 0, 7) == 'http://') {
+               // Use the hostname from script URL as new hostname
+               $url = substr($script, 7);
+               $extract = explode('/', $url);
+               $url = $extract[0];
+               // Done extracting the URL :)
+       } // END - if
+
+       // Extract host name
+       $host = str_replace('http://', '', $url);
+       if (isInString('/', $host)) {
+               $host = substr($host, 0, strpos($host, '/'));
+       } // END - if
+
+       // Generate relative URL
+       //* DEBUG: */ debugOutput('SCRIPT=' . $script);
+       if (substr(strtolower($script), 0, 7) == 'http://') {
+               // But only if http:// is in front!
+               $script = substr($script, (strlen($url) + 7));
+       } elseif (substr(strtolower($script), 0, 8) == 'https://') {
+               // Does this work?!
+               $script = substr($script, (strlen($url) + 8));
+       }
+
+       //* DEBUG: */ debugOutput('SCRIPT=' . $script);
+       if (substr($script, 0, 1) == '/') {
+               $script = substr($script, 1);
+       } // END - if
+
+       // Return host name
+       return $host;
+}
+
+// Adds a HTTP header to array
+function addHttpHeader ($header) {
+       // Send the header
+       //* DEBUG: */ logDebugMessage(__FUNCTION__ . ': header=' . $header);
+       $GLOBALS['http_header'][] = trim($header);
+}
+
+// Flushes all HTTP headers
+function flushHttpHeaders () {
+       // Is the header already sent?
+       if (headers_sent()) {
+               // Then abort here
+               debug_report_bug(__FUNCTION__, __LINE__, 'Headers already sent!');
+       } // END - if
+
+       // Flush all headers if found
+       if ((isset($GLOBALS['http_header'])) && (is_array($GLOBALS['http_header']))) {
+               foreach ($GLOBALS['http_header'] as $header) {
+                       header($header);
+               } // END - foreach
+       } // END - if
+
+       // Mark them as flushed
+       $GLOBALS['http_header'] = array();
+}
+
 //-----------------------------------------------------------------------------
 // Automatically re-created functions, all taken from user comments on www.php.net
 //-----------------------------------------------------------------------------
 
 if (!function_exists('http_build_query')) {
        // Taken from documentation on www.php.net, credits to Marco K. (Germany) and some light mods by R.Haeder
-       function http_build_query($data, $prefix = '', $sep = '', $key = '') {
+       function http_build_query($requestData, $prefix = '', $sep = '', $key = '') {
                $ret = array();
-               foreach ((array) $data as $k => $v) {
+               foreach ((array) $requestData as $k => $v) {
                        if (is_int($k) && $prefix != null) {
                                $k = urlencode($prefix . $k);
                        } // END - if