X-Git-Url: https://git.mxchange.org/?p=mailer.git;a=blobdiff_plain;f=inc%2Ffunctions.php;h=e65600e13e36994bee1d1796de5e7cea09bad849;hp=79e5d8d5a7541f79bae4a3cc289f8032a9a5e27d;hb=0f3a135204757cc8750262871c8e62c42300acb4;hpb=1c28686d33a76fa9e3e5bd90f737b20bfe211575
diff --git a/inc/functions.php b/inc/functions.php
index 79e5d8d5a7..e65600e13e 100644
--- a/inc/functions.php
+++ b/inc/functions.php
@@ -40,24 +40,6 @@ if (!defined('__SECURITY')) {
die();
} // END - if
-// Sends out all headers required for HTTP/1.1 reply
-function sendHttpHeaders () {
- // Used later
- $now = gmdate('D, d M Y H:i:s') . ' GMT';
-
- // Send HTTP header
- sendHeader('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());
-}
-
// Init fatal message array
function initFatalMessages () {
$GLOBALS['fatal_messages'] = array();
@@ -103,29 +85,27 @@ function getTotalFatalErrors () {
// Send mail out to an email address
function sendEmail ($toEmail, $subject, $message, $isHtml = 'N', $mailHeader = '') {
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'toEmail=' . $toEmail . ',subject=' . $subject . ',isHtml=' . $isHtml);
+ // Empty parameters should be avoided, so we need to find them
+ if (empty($isHtml)) {
+ // isHtml is empty
+ debug_report_bug(__FUNCTION__, __LINE__, 'isHtml is empty.');
+ } // END - if
// Set from header
if ((!isInStringIgnoreCase('@', $toEmail)) && ($toEmail > 0)) {
- // Value detected, is the message extension installed?
- // @TODO Extension 'msg' does not exist
- if (isExtensionActive('msg')) {
- ADD_MESSAGE_TO_BOX($toEmail, $subject, $message, $isHtml);
- return;
+ // Does the user exist?
+ if ((isExtensionActive('user')) && (fetchUserData($toEmail))) {
+ // Get the email
+ $toEmail = getUserData('email');
} else {
- // Does the user exist?
- if (fetchUserData($toEmail)) {
- // Get the email
- $toEmail = getUserData('email');
- } else {
- // Set webmaster
- $toEmail = getWebmaster();
- }
+ // Set webmaster
+ $toEmail = getWebmaster();
}
} elseif ($toEmail == '0') {
// Is the webmaster!
$toEmail = getWebmaster();
}
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "TO={$toEmail}
");
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'TO=' . $toEmail);
// Check for PHPMailer or debug-mode
if ((!checkPhpMailerUsage()) || (isDebugModeEnabled())) {
@@ -148,11 +128,6 @@ function sendEmail ($toEmail, $subject, $message, $isHtml = 'N', $mailHeader = '
}
} // END - if
- // Fix HTML parameter (default is no!)
- if (empty($isHtml)) {
- $isHtml = 'N';
- } // END - if
-
// Debug mode enabled?
if (isDebugModeEnabled()) {
// In debug mode we want to display the mail instead of sending it away so we can debug this part
@@ -259,13 +234,18 @@ function sendRawEmail ($toEmail, $subject, $message, $headers) {
}
// Generate a password in a specified length or use default password length
-function generatePassword ($length = '0') {
+function generatePassword ($length = '0', $exclude = array()) {
// Auto-fix invalid length of zero
- if ($length == '0') $length = getPassLen();
+ if ($length == '0') {
+ $length = getPassLen();
+ } // END - if
// Initialize array with all allowed chars
$ABC = explode(',', 'a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z,A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z,0,1,2,3,4,5,6,7,8,9,-,+,_,/,.');
+ // Exclude some entries
+ $ABC = array_diff($ABC, $exclude);
+
// Start creating password
$PASS = '';
for ($i = '0'; $i < $length; $i++) {
@@ -286,7 +266,7 @@ function generatePassword ($length = '0') {
// Generates a human-readable timestamp from the Uni* stamp
function generateDateTime ($time, $mode = '0') {
// If the stamp is zero it mostly didn't "happen"
- if ($time == '0') {
+ if (($time == '0') || (is_null($time))) {
// Never happend
return '{--NEVER_HAPPENED--}';
} // END - if
@@ -311,6 +291,7 @@ function generateDateTime ($time, $mode = '0') {
case '4': $ret = date('d.m.Y|H:i:s', $time); break;
case '5': $ret = date('d-m-Y (l-F-T)', $time); break;
case '6': $ret = date('Ymd', $time); break;
+ case '7': $ret = date('Y-m-d H:i:s', $time); break; // Compatible with MySQL TIMESTAMP
default:
logDebugMessage(__FUNCTION__, __LINE__, sprintf("Invalid date mode %s detected.", $mode));
break;
@@ -326,6 +307,7 @@ function generateDateTime ($time, $mode = '0') {
case '4': $ret = date('d.m.Y|H:i:s', $time); break;
case '5': $ret = date('d-m-Y (l-F-T)', $time); break;
case '6': $ret = date('Ymd', $time); break;
+ case '7': $ret = date('Y-m-d H:i:s', $time); break; // Compatible with MySQL TIMESTAMP
default:
logDebugMessage(__FUNCTION__, __LINE__, sprintf("Invalid date mode %s detected.", $mode));
break;
@@ -364,14 +346,18 @@ function translateComma ($dotted, $cut = true, $max = '0') {
// First, cast all to double, due to PHP changes
$dotted = (double) $dotted;
- // Default is 3 you can change this in admin area "Misc -> Misc Options"
- if (!isConfigEntrySet('max_comma')) setConfigEntry('max_comma', 3);
+ // Default is 3 you can change this in admin area "Settings -> Misc Options"
+ if (!isConfigEntrySet('max_comma')) {
+ setConfigEntry('max_comma', 3);
+ } // END - if
// Use from config is default
$maxComma = getConfig('max_comma');
// Use from parameter?
- if ($max > 0) $maxComma = $max;
+ if ($max > 0) {
+ $maxComma = $max;
+ } // END - if
// Cut zeros off?
if (($cut === true) && ($max == '0')) {
@@ -485,22 +471,22 @@ function translateMenuVisibleLocked ($content, $prefix = '') {
}
// Generates an URL for the dereferer
-function generateDerefererUrl ($URL) {
+function generateDerefererUrl ($url) {
// Don't de-refer our own links!
- if (substr($URL, 0, strlen(getUrl())) != getUrl()) {
+ if (substr($url, 0, strlen(getUrl())) != getUrl()) {
// De-refer this link
- $URL = '{%url=modules.php?module=loader&url=' . encodeString(compileUriCode($URL)) . '%}';
+ $url = '{%url=modules.php?module=loader&url=' . encodeString(compileUriCode($url)) . '%}';
} // END - if
// Return link
- return $URL;
+ return $url;
}
// Generates an URL for the frametester
-function generateFrametesterUrl ($URL) {
+function generateFrametesterUrl ($url) {
// Prepare frametester URL
$frametesterUrl = sprintf("{%%url=modules.php?module=frametester&url=%s%%}",
- encodeString(compileUriCode($URL))
+ encodeString(compileUriCode($url))
);
// Return the new URL
@@ -547,38 +533,31 @@ function makeTime ($hours, $minutes, $seconds, $stamp) {
}
// Redirects to an URL and if neccessarry extends it with own base URL
-function redirectToUrl ($URL, $allowSpider = true) {
+function redirectToUrl ($url, $allowSpider = true) {
// Remove {%url=
- if (substr($URL, 0, 6) == '{%url=') $URL = substr($URL, 6, -2);
+ if (substr($url, 0, 6) == '{%url=') {
+ $url = substr($url, 6, -2);
+ } // END - if
// Compile out codes
- eval('$URL = "' . compileRawCode(encodeUrl($URL)) . '";');
+ eval('$url = "' . compileRawCode(encodeUrl($url)) . '";');
// Default 'rel' value is external, nofollow is evil from Google and hurts the Internet
$rel = ' rel="external"';
// Do we have internal or external URL?
- if (substr($URL, 0, strlen(getUrl())) == getUrl()) {
+ if (substr($url, 0, strlen(getUrl())) == getUrl()) {
// Own (=internal) URL
$rel = '';
} // END - if
// Three different ways to debug...
- //* DEBUG: */ debug_report_bug(__FUNCTION__, __LINE__, 'URL=' . $URL);
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'URL=' . $URL);
- //* DEBUG: */ die($URL);
-
- // Simple probe for bots/spiders from search engines
- if ((isSpider()) && ($allowSpider === true)) {
- // Set HTTP-Status
- setHttpStatus('200 OK');
+ //* DEBUG: */ debug_report_bug(__FUNCTION__, __LINE__, 'URL=' . $url);
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'URL=' . $url);
+ //* DEBUG: */ die($url);
- // Set content-type here to fix a missing array element
- setContentType('text/html');
-
- // Output new location link as anchor
- outputHtml('' . secureString($URL) . '');
- } elseif (!headers_sent()) {
+ // We should not sent a redirect if headers are already sent
+ if (!headers_sent()) {
// Clear output buffer
clearOutputBuffer();
@@ -586,11 +565,11 @@ function redirectToUrl ($URL, $allowSpider = true) {
$GLOBALS['output'] = '';
// Load URL when headers are not sent
- sendRawRedirect(doFinalCompilation(str_replace('&', '&', $URL), false));
+ sendRawRedirect(doFinalCompilation(str_replace('&', '&', $url), false));
} else {
// Output error message
loadInclude('inc/header.php');
- loadTemplate('redirect_url', false, str_replace('&', '&', $URL));
+ loadTemplate('redirect_url', false, str_replace('&', '&', $url));
loadInclude('inc/footer.php');
}
@@ -615,26 +594,26 @@ function redirectToUrl ($URL, $allowSpider = true) {
* *
************************************************************************/
function array_pk_sort (&$array, $a_sort, $primary_key = '0', $order = -1, $nums = false) {
- $dummy = $array;
+ $temporaryArray = $array;
while ($primary_key < count($a_sort)) {
- foreach ($dummy[$a_sort[$primary_key]] as $key => $value) {
- foreach ($dummy[$a_sort[$primary_key]] as $key2 => $value2) {
+ foreach ($temporaryArray[$a_sort[$primary_key]] as $key => $value) {
+ foreach ($temporaryArray[$a_sort[$primary_key]] as $key2 => $value2) {
$match = false;
if ($nums === false) {
// Sort byte-by-byte (also numbers will be interpreted as chars! E.g.: "9" > "10")
- if (($key != $key2) && (strcmp(strtolower($dummy[$a_sort[$primary_key]][$key]), strtolower($dummy[$a_sort[$primary_key]][$key2])) == $order)) $match = true;
+ if (($key != $key2) && (strcmp(strtolower($temporaryArray[$a_sort[$primary_key]][$key]), strtolower($temporaryArray[$a_sort[$primary_key]][$key2])) == $order)) $match = true;
} elseif ($key != $key2) {
// Sort numbers (E.g.: 9 < 10)
- if (($dummy[$a_sort[$primary_key]][$key] < $dummy[$a_sort[$primary_key]][$key2]) && ($order == -1)) $match = true;
- if (($dummy[$a_sort[$primary_key]][$key] > $dummy[$a_sort[$primary_key]][$key2]) && ($order == 1)) $match = true;
+ if (($temporaryArray[$a_sort[$primary_key]][$key] < $temporaryArray[$a_sort[$primary_key]][$key2]) && ($order == -1)) $match = true;
+ if (($temporaryArray[$a_sort[$primary_key]][$key] > $temporaryArray[$a_sort[$primary_key]][$key2]) && ($order == 1)) $match = true;
}
if ($match) {
// We have found two different values, so let's sort whole array
- foreach ($dummy as $sort_key => $sort_val) {
- $t = $dummy[$sort_key][$key];
- $dummy[$sort_key][$key] = $dummy[$sort_key][$key2];
- $dummy[$sort_key][$key2] = $t;
+ foreach ($temporaryArray as $sort_key => $sort_val) {
+ $t = $temporaryArray[$sort_key][$key];
+ $temporaryArray[$sort_key][$key] = $temporaryArray[$sort_key][$key2];
+ $temporaryArray[$sort_key][$key2] = $t;
unset($t);
} // END - foreach
} // END - if
@@ -646,33 +625,33 @@ function array_pk_sort (&$array, $a_sort, $primary_key = '0', $order = -1, $nums
} // END - while
// Write back sorted array
- $array = $dummy;
+ $array = $temporaryArray;
}
//
// Deprecated : $length (still has one reference in this function)
-// Optional : $DATA
+// Optional : $extraData
//
-function generateRandomCode ($length, $code, $userid, $DATA = '') {
+function generateRandomCode ($length, $code, $userid, $extraData = '') {
// Build server string
$server = $_SERVER['PHP_SELF'] . getEncryptSeperator() . detectUserAgent() . getEncryptSeperator() . getenv('SERVER_SOFTWARE') . getEncryptSeperator() . detectRealIpAddress() . getEncryptSeperator() . detectRemoteAddr();
// Build key string
$keys = getSiteKey() . getEncryptSeperator() . getDateKey();
if (isConfigEntrySet('secret_key')) {
- $keys .= getEncryptSeperator().getSecretKey();
+ $keys .= getEncryptSeperator() . getSecretKey();
} // END - if
if (isConfigEntrySet('file_hash')) {
- $keys .= getEncryptSeperator().getFileHash();
+ $keys .= getEncryptSeperator() . getFileHash();
} // END - if
- $keys .= getEncryptSeperator() . getDateFromPatchTime();
+ $keys .= getEncryptSeperator() . getDateFromRepository();
if (isConfigEntrySet('master_salt')) {
- $keys .= getEncryptSeperator().getMasterSalt();
+ $keys .= getEncryptSeperator() . getMasterSalt();
} // END - if
// Build string from misc data
- $data = $code . getEncryptSeperator() . $userid . getEncryptSeperator() . $DATA;
+ $data = $code . getEncryptSeperator() . $userid . getEncryptSeperator() . $extraData;
// Add more additional data
if (isSessionVariableSet('u_hash')) {
@@ -691,28 +670,27 @@ function generateRandomCode ($length, $code, $userid, $DATA = '') {
if (isConfigEntrySet('master_salt')) {
// Generate hash with master salt from modula of number with the prime number and other data
$saltedHash = generateHash(($a % getPrime()) . getEncryptSeperator() . $server . getEncryptSeperator() . $keys . getEncryptSeperator() . $data . getEncryptSeperator() . getDateKey() . getEncryptSeperator() . $a, getMasterSalt());
-
- // Create number from hash
- $rcode = hexdec(substr($saltedHash, strlen(getMasterSalt()), 9)) / abs(getRandNo() - $a + sqrt(getConfig('_ADD'))) / pi();
} else {
// Generate hash with "hash of site key" from modula of number with the prime number and other data
$saltedHash = generateHash(($a % getPrime()) . getEncryptSeperator() . $server . getEncryptSeperator() . $keys . getEncryptSeperator() . $data . getEncryptSeperator() . getDateKey() . getEncryptSeperator() . $a, substr(sha1(getSiteKey()), 0, getSaltLength()));
-
- // Create number from hash
- $rcode = hexdec(substr($saltedHash, 8, 9)) / abs(getRandNo() - $a + sqrt(getConfig('_ADD'))) / pi();
}
+ // Create number from hash
+ $rcode = hexdec(substr($saltedHash, getSaltLength(), 9)) / abs(getRandNo() - $a + sqrt(getConfig('_ADD'))) / pi();
+
// At least 10 numbers shall be secure enought!
- $len = getCodeLength();
- if ($len == '0') {
+ if (isExtensionActive('other')) {
+ $len = getCodeLength();
+ } else {
$len = $length;
} // END - if
+
if ($len == '0') {
$len = 10;
} // END - if
- // Cut off requested counts of number
- $return = substr(str_replace('.', '', $rcode), 0, $len);
+ // Cut off requested counts of number, but skip first digit (which is mostly a zero)
+ $return = substr($rcode, (strpos($rcode, '.') + 1), $len);
// Done building code
return $return;
@@ -740,7 +718,7 @@ function bigintval ($num, $castValue = true, $abortOnMismatch = true) {
}
// Creates a Uni* timestamp from given selection data and prefix
-function createTimestampFromSelections ($prefix, $postData) {
+function createEpocheTimeFromSelections ($prefix, $postData) {
// Initial return value
$ret = '0';
@@ -750,7 +728,9 @@ function createTimestampFromSelections ($prefix, $postData) {
$M1 = getMonth();
// If so and if current time is before 02/29 and estimated time is after 02/29 then add 86400 seconds (one day)
- if ((floor($TEST) == $TEST) && ($M1 == '02') && ($postData[$prefix . '_mo'] > '02')) $SWITCH = getOneDay();
+ if ((floor($TEST) == $TEST) && ($M1 == '02') && ($postData[$prefix . '_mo'] > '02')) {
+ $SWITCH = getOneDay();
+ } // END - if
// First add years...
$ret += $postData[$prefix . '_ye'] * (31536000 + $SWITCH);
@@ -842,377 +822,6 @@ function extractHostnameFromUrl (&$script) {
return $host;
}
-// Send a GET request
-function sendGetRequest ($script, $data = array(), $removeHeader = false) {
- // Extract hostname and port from script
- $host = extractHostnameFromUrl($script);
-
- // Add data
- $body = http_build_query($data, '', '&');
-
- // There should be data, else we don't need to extend $script with $body
- if (!empty($body)) {
- // Do we have a question-mark in the script?
- if (strpos($script, '?') === false) {
- // No, so first char must be question mark
- $body = '?' . $body;
- } else {
- // Ok, add &
- $body = '&' . $body;
- }
-
- // Add script data
- $script .= $body;
-
- // Remove trailed & to make it more conform
- if (substr($script, -1, 1) == '&') {
- $script = substr($script, 0, -1);
- } // END - if
- } // END - if
-
- // Generate GET request header
- $request = 'GET /' . trim($script) . ' 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);
-
- // Should we remove header lines?
- if ($removeHeader === true) {
- // Okay, remove them
- $response = removeHttpHeaderFromResponse($response);
- } // END - if
-
- // Return the result to the caller function
- return $response;
-}
-
-// Send a POST request
-function sendPostRequest ($script, array $postData, $removeHeader = false) {
- // Extract host name from script
- $host = extractHostnameFromUrl($script);
-
- // Construct request body
- $body = http_build_query($postData, '', '&');
-
- // Generate POST request header
- $request = 'POST /' . trim($script) . ' 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');
- $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 .= 'Content-Type: application/x-www-form-urlencoded' . getConfig('HTTP_EOL');
- $request .= 'Content-Length: ' . strlen($body) . getConfig('HTTP_EOL');
- $request .= 'Connection: close' . getConfig('HTTP_EOL');
- $request .= getConfig('HTTP_EOL');
-
- // Add body
- $request .= $body;
-
- // Send the raw request
- $response = sendRawRequest($host, $request);
-
- // Should we remove header lines?
- if ($removeHeader === true) {
- // Okay, remove them
- $response = removeHttpHeaderFromResponse($response);
- } // END - if
-
- // Return the result to the caller function
- return $response;
-}
-
-// Sends a raw request to another host
-function sendRawRequest ($host, $request) {
- // Init errno and errdesc with 'all fine' values
- $errno = '0';
- $errdesc = '';
-
- // Default port is 80
- $port = 80;
-
- // Initialize array
- $response = array('', '', '');
-
- // Default is not to use proxy
- $useProxy = false;
-
- // Are proxy settins set?
- if (isProxyUsed()) {
- // Then use it
- $useProxy = true;
- } // END - if
-
- // Load include
- loadIncludeOnce('inc/classes/resolver.class.php');
-
- // Extract port part from host
- $portArray = explode(':', $host);
- if (count($portArray) == 2) {
- // Extract host and port
- $host = $portArray[0];
- $port = $portArray[1];
- } elseif (count($portArray) > 2) {
- // This should not happen!
- debug_report_bug(__FUNCTION__, __LINE__, 'Invalid ' . $host . '. Please report this to the Mailer-Project team.');
- }
-
- // Get resolver instance
- $resolver = new HostnameResolver();
-
- // Open connection
- //* DEBUG: */ die('SCRIPT=' . $script);
- if ($useProxy === true) {
- // Resolve hostname into IP address
- $ip = $resolver->resolveHostname(compileRawCode(getProxyHost()));
-
- // Connect to host through proxy connection
- $fp = 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);
- }
-
- // Is there a link?
- if (!is_resource($fp)) {
- // Failed!
- logDebugMessage(__FUNCTION__, __LINE__, $errdesc . ' (' . $errno . ')');
- return $response;
- } elseif ((!stream_set_blocking($fp, 0)) || (!stream_set_timeout($fp, 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) {
- // Setup proxy tunnel
- $response = setupProxyTunnel($host, $port, $fp);
-
- // If the response is invalid, abort
- if ((count($response) == 3) && (empty($response[0])) && (empty($response[1])) && (empty($response[2]))) {
- // Invalid response!
- logDebugMessage(__FUNCTION__, __LINE__, 'Proxy tunnel not working?');
- return $response;
- } // END - if
- } // END - if
-
- // Write request
- fwrite($fp, $request);
-
- // Start counting
- $start = microtime(true);
-
- // Read response
- while (!feof($fp)) {
- // Get info from stream
- $info = stream_get_meta_data($fp);
-
- // Is it timed out? 15 seconds is a really patient...
- if (($info['timed_out'] == true) || (microtime(true) - $start) > 15) {
- // Timeout
- logDebugMessage(__FUNCTION__, __LINE__, 'Timed out to get data from host ' . $host);
-
- // Abort here
- break;
- } // END - if
-
- // Get line from stream
- $line = fgets($fp, 128);
-
- // Ignore empty lines because of non-blocking mode
- if (empty($line)) {
- // uslepp a little to avoid 100% CPU load
- usleep(10);
-
- // Skip this
- continue;
- } // END - if
-
- // Add it to response
- $response[] = $line;
- } // END - while
-
- // Close socket
- fclose($fp);
-
- // Time request if debug-mode is enabled
- if (isDebugModeEnabled()) {
- // Add debug message...
- logDebugMessage(__FUNCTION__, __LINE__, 'Request took ' . (microtime(true) - $start) . ' seconds and returned ' . count($response) . ' line(s).');
- } // END - if
-
- // Skip first empty lines
- $resp = $response;
- foreach ($resp as $idx => $line) {
- // Trim space away
- $line = trim($line);
-
- // Is this line empty?
- if (empty($line)) {
- // Then remove it
- array_shift($response);
- } else {
- // Abort on first non-empty line
- break;
- }
- } // END - foreach
-
- //* DEBUG: */ debugOutput('Request:
'.print_r($request, true).''); - //* DEBUG: */ debugOutput('Response:
'.print_r($response, true).''); - - // Proxy agent found or something went wrong? - if (!isset($response[0])) { - // 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)) { - // Proxy header detected, so remove two lines - array_shift($response); - array_shift($response); - } // END - if - - // Was the request successfull? - if ((!isInStringIgnoreCase('200 OK', $response[0])) || (empty($response[0]))) { - // Not found / access forbidden - logDebugMessage(__FUNCTION__, __LINE__, 'Unexpected status code ' . $response[0] . ' detected. "200 OK" was expected.'); - $response = array('', '', ''); - } else { - // Check array for chuncked encoding - $response = unchunkHttpResponse($response); - } // END - if - - // Return response - return $response; -} - -// Sets up a proxy tunnel for given hostname and through resource -function setupProxyTunnel ($host, $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'); - - // Use login data to proxy? (username at least!) - if (getProxyUsername() != '') { - // Add it as well - $encodedAuth = base64_encode(compileRawCode(getProxyUsername()) . ':' . compileRawCode(getProxyPassword())); - $proxyTunnel .= 'Proxy-Authorization: Basic ' . $encodedAuth . getConfig('HTTP_EOL'); - } // END - if - - // Add last new-line - $proxyTunnel .= getConfig('HTTP_EOL'); - //* DEBUG: */ debugOutput('proxyTunnel=
' . $proxyTunnel.''); - - // Write request - fwrite($fp, $proxyTunnel); - - // Got response? - if (feof($fp)) { - // No response received - return $response; - } // END - if - - // Read the first line - $resp = trim(fgets($fp, 10240)); - $respArray = explode(' ', $resp); - if ((strtolower($respArray[0]) !== 'http/1.0') || ($respArray[1] != '200')) { - // Invalid response! - return $response; - } // END - if - - // All fine! - return $respArray; -} - -// Check array for chuncked encoding -function unchunkHttpResponse (array $response) { - // Default is not chunked - $isChunked = false; - - // Check if we have chunks - foreach ($response as $line) { - // Make lower-case and trim it - $line = trim(strtolower($line)); - - // Entry found? - if ((strpos($line, 'transfer-encoding') !== false) && (strpos($line, 'chunked') !== false)) { - // Found! - $isChunked = true; - break; - } // END - if - } // END - foreach - - // Is it chunked? - if ($isChunked === true) { - // Good, we still have the HTTP headers in there, so we need to get rid - // of them temporarly - //* DEBUG: */ die('
'.htmlentities(print_r(removeHttpHeaderFromResponse($response), true)).''); - $tempResponse = http_chunked_decode(implode('', removeHttpHeaderFromResponse($response))); - - // We got a string back from http_chunked_decode(), so we need to convert it back to an array - //* DEBUG: */ die('tempResponse['.strlen($tempResponse).']=
'.replaceReturnNewLine(htmlentities($tempResponse)).''); - - // Re-add the headers - $response = merge_array($GLOBALS['http_headers'], stringToArray("\n", $tempResponse)); - } // END - if - - // Return the unchunked array - return $response; -} - -// Removes HTTP header lines from a response array (e.g. output from send
'.print_r($args,true).',ret='.print_r($ret,true).''); } else { // One parameter call $ret = call_user_func($filterFunction, $value); @@ -1852,7 +1466,7 @@ function handleExtraValues ($filterFunction, $value, $extraValue) { } // Converts timestamp selections into a timestamp -function convertSelectionsToTimestamp (&$postData, &$DATA, &$id, &$skip) { +function convertSelectionsToEpocheTime (array &$postData, array &$DATA, &$id, &$skip) { // Init test variable $skip = false; $test2 = ''; @@ -1866,7 +1480,7 @@ function convertSelectionsToTimestamp (&$postData, &$DATA, &$id, &$skip) { $test = substr($id, 0, -3); if ((isset($postData[$test.'_ye'])) && (isset($postData[$test.'_mo'])) && (isset($postData[$test.'_we'])) && (isset($postData[$test.'_da'])) && (isset($postData[$test.'_ho'])) && (isset($postData[$test.'_mi'])) && (isset($postData[$test.'_se'])) && ($test != $test2)) { // Generate timestamp - $postData[$test] = createTimestampFromSelections($test, $postData); + $postData[$test] = createEpocheTimeFromSelections($test, $postData); $DATA[] = sprintf("`%s`='%s'", $test, $postData[$test]); $GLOBALS['skip_config'][$test] = true; @@ -1958,7 +1572,7 @@ function rebuildCache ($cache, $inc = '', $force = false) { // Is the include there? if (isIncludeReadable($inc)) { // And rebuild it from scratch - //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "inc={$inc} - LOADED!
"); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'inc=' . $inc . ' - LOADED!'); loadInclude($inc); } else { // Include not found @@ -2039,60 +1653,87 @@ function determineReferalId () { } // END - if // Check if refid is set - if ((isset($GLOBALS['refid'])) && ($GLOBALS['refid'] > 0)) { + if (isReferalIdValid()) { // This is fine... + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using refid from GLOBALS (' . getReferalId() . ')'); } elseif (isPostRequestParameterSet('refid')) { // Get referal id from POST element refid - $GLOBALS['refid'] = secureString(postRequestParameter('refid')); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using refid from POST data (' . postRequestParameter('refid') . ')'); + setReferalId(secureString(postRequestParameter('refid'))); } elseif (isGetRequestParameterSet('refid')) { // Get referal id from GET parameter refid - $GLOBALS['refid'] = secureString(getRequestParameter('refid')); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using refid from GET data (' . getRequestParameter('refid') . ')'); + setReferalId(secureString(getRequestParameter('refid'))); } elseif (isGetRequestParameterSet('ref')) { // Set refid=ref (the referal link uses such variable) - $GLOBALS['refid'] = secureString(getRequestParameter('ref')); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using ref from GET data (' . getRequestParameter('refid') . ')'); + setReferalId(secureString(getRequestParameter('ref'))); } elseif ((isGetRequestParameterSet('user')) && (basename($_SERVER['PHP_SELF']) == 'click.php')) { // The variable user comes from click.php - $GLOBALS['refid'] = bigintval(getRequestParameter('user')); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using user from GET data (' . getRequestParameter('user') . ')'); + setReferalId(bigintval(getRequestParameter('user'))); } elseif ((isSessionVariableSet('refid')) && (isValidUserId(getSession('refid')))) { - // Set session refid als global - $GLOBALS['refid'] = bigintval(getSession('refid')); + // Set session refid as global + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using refid from SESSION data (' . getSession('refid') . ')'); + setReferalId(bigintval(getSession('refid'))); } elseif (isRandomReferalIdEnabled()) { // Select a random user which has confirmed enougth mails - $GLOBALS['refid'] = determineRandomReferalId(); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Checking random referal id'); + setReferalId(determineRandomReferalId()); } elseif ((isExtensionInstalledAndNewer('sql_patches', '0.1.2')) && (isValidUserId(getDefRefid()))) { // Set default refid as refid in URL - $GLOBALS['refid'] = getDefRefid(); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using default refid (' . getDefRefid() . ')'); + setReferalId(getDefRefid()); } else { // No default id when sql_patches is not installed or none set - $GLOBALS['refid'] = null; + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using NULL as refid'); + setReferalId(NULL); } // Set cookie when default refid > 0 - if (!isSessionVariableSet('refid') || (isValidUserId($GLOBALS['refid'])) || ((!isValidUserId(getSession('refid'))) && (isExtensionInstalledAndNewer('sql_patches', '0.1.2')) && (isValidUserId(getDefRefid())))) { + if (!isSessionVariableSet('refid') || (!isValidUserId(getReferalId())) || ((!isValidUserId(getSession('refid'))) && (isExtensionInstalledAndNewer('sql_patches', '0.1.2')) && (isValidUserId(getDefRefid())))) { // Default is not found $found = false; // Do we have nickname or userid set? - if ((isExtensionActive('nickname')) && (isNicknameUsed($GLOBALS['refid']))) { + if ((isExtensionActive('nickname')) && (isNicknameUsed(getReferalId()))) { // Nickname in URL, so load the id - $found = fetchUserData($GLOBALS['refid'], 'nickname'); - } elseif (isValidUserId($GLOBALS['refid'])) { + $found = fetchUserData(getReferalId(), 'nickname'); + + // If we found it, use the userid as referal id + if ($found === true) { + // Set the userid as 'refid' + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using refid from user account by nickname (' . getUserData('userid') . ')'); + setReferalId(getUserData('userid')); + } // END - if + } elseif (isValidUserId(getReferalId())) { // Direct userid entered - $found = fetchUserData($GLOBALS['refid']); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using direct userid (' . getReferalId() . ')'); + $found = fetchUserData(getReferalId()); } // Is the record valid? if ((($found === false) || (!isUserDataValid())) && (isExtensionInstalledAndNewer('sql_patches', '0.1.2'))) { // No, then reset referal id - $GLOBALS['refid'] = getDefRefid(); + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using default refid (' . getDefRefid() . ')'); + setReferalId(getDefRefid()); } // END - if // Set cookie - setSession('refid', $GLOBALS['refid']); - } // END - if + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Saving refid to session (' . getReferalId() . ') #1'); + setSession('refid', getReferalId()); + } elseif (!isReferalIdValid()) { + // Not valid! + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Not valid referal id (' . getReferalId() . '), setting NULL in session'); + setSession('refid', NULL); + } elseif ((!isSessionVariableSet('refid')) && (isValidUserId(getReferalId()))) { + // Set it from GLOBALS array in session + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Saving refid to session (' . getReferalId() . ') #2'); + setSession('refid', getReferalId()); + } // Return determined refid - return $GLOBALS['refid']; + return getReferalId(); } // Enables the reset mode and runs it @@ -2124,7 +1765,7 @@ function shutdown () { SQL_CLOSE(__FUNCTION__, __LINE__); } elseif (!isInstallationPhase()) { // No database link - addFatalMessage(__FUNCTION__, __LINE__, '{--NO_DB_LINK_SHUTDOWN--}'); + debug_report_bug(__FUNCTION__, __LINE__, 'Database link is already down, while shutdown is running.'); } // Stop executing here @@ -2368,7 +2009,7 @@ function initCacheInstance () { // Did it work? if ($GLOBALS['cache_instance']->getStatusCode() != 'done') { // Failed to initialize cache sustem - addFatalMessage(__FUNCTION__, __LINE__, '(' . __LINE__ . '): {--CACHE_CANNOT_INITIALIZE--}'); + debug_report_bug(__FUNCTION__, __LINE__, 'Cache system returned with unexpected error. getStatusCode()=' . $GLOBALS['cache_instance']->getStatusCode()); } // END - if } @@ -2529,19 +2170,31 @@ function handleFieldWithBraces ($field) { return $field; } -// Converts a userid so it can be used in SQL queries -function makeDatabaseUserId ($userid) { +// Converts a zero or NULL to word 'NULL' +function makeZeroToNull ($number) { // Is it a valid username? - if (isValidUserId($userid)) { + if ((!is_null($number)) && ($number > 0)) { // Always secure it - $userid = bigintval($userid); + $number = bigintval($number); } else { // Is not valid or zero - $userid = 'NULL'; + $number = 'NULL'; } // Return it - return $userid; + return $number; +} + +// Converts NULL into number zero +function makeNullToZero ($number) { + // Is this a NULL? + if ((is_null($number)) || (empty($number))) { + // Simply set it + $number = '0'; + } // END - if + + // Return it + return $number; } // Capitalizes a string with underscores, e.g.: some_foo_string will become SomeFooString @@ -2599,14 +2252,27 @@ function generateAdminMailLinks ($mailType, $mailId) { // Is the mail type supported? if (!empty($table)) { // Query for the mail - $result = SQL_QUERY_ESC("SELECT `id`, `%s` AS `mail_status` FROM `{?_MYSQL_PREFIX?}_%s` WHERE `id`=%s LIMIT 1", - array($statusColumn, $table, bigintval($mailId)), __FILE__, __LINE__); + $result = SQL_QUERY_ESC("SELECT `id`,`%s` AS `mail_status` FROM `{?_MYSQL_PREFIX?}_%s` WHERE `id`=%s LIMIT 1", + array( + $statusColumn, + $table, + bigintval($mailId) + ), __FILE__, __LINE__); // Do we have one entry there? if (SQL_NUMROWS($result) == 1) { // Load the entry $content = SQL_FETCHARRAY($result); - die(__FUNCTION__.':
content='.print_r($content, true).''); + + // Add output and type + $content['type'] = $mailType; + $content['__output'] = ''; + + // Filter all data + $content = runFilterChain('generate_admin_mail_links', $content); + + // Get output back + $OUT = $content['__output']; } // END - if // Free result @@ -2619,7 +2285,7 @@ function generateAdminMailLinks ($mailType, $mailId) { /** - * determine if a string can represent a number in hexadecimal + * Determine if a string can represent a number in hexadecimal * * @param $hex A string to check if it is hex-encoded * @return $foo True if the string is a hex, otherwise false @@ -2639,9 +2305,14 @@ function isHexadecimal ($hex) { return ($hex == dechex(hexdec($hex))); } -// Replace "\r" with "[r]" and "\n" with "[n]" and add a final new-line to make -// them visible to the developer. Use this function to debug e.g. buggy HTTP -// response handler functions. +/** + * Replace "\r" with "[r]" and "\n" with "[n]" and add a final new-line to make + * them visible to the developer. Use this function to debug e.g. buggy HTTP + * response handler functions. + * + * @param $str String to overwork + * @return $str Overworked string + */ function replaceReturnNewLine ($str) { return str_replace("\r", '[r]', str_replace("\n", '[n] ', $str)); @@ -2663,142 +2334,181 @@ function stringToArray ($delimiter, $string) { return $strArray; } -//----------------------------------------------------------------------------- -// Automatically re-created functions, all taken from user comments on www.php.net -//----------------------------------------------------------------------------- -if (!function_exists('html_entity_decode')) { - // Taken from documentation on www.php.net - function html_entity_decode ($string) { - $trans_tbl = get_html_translation_table(HTML_ENTITIES); - $trans_tbl = array_flip($trans_tbl); - return strtr($string, $trans_tbl); - } -} // END - if +// Detects the prefix 'mb_' if a multi-byte string is given +function detectMultiBytePrefix ($str) { + // Default is without multi-byte + $mbPrefix = ''; -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 = '') { - $ret = array(); - foreach ((array) $data as $k => $v) { - if (is_int($k) && $prefix != null) { - $k = urlencode($prefix . $k); - } // END - if + // Detect multi-byte (strictly) + if (mb_detect_encoding($str, 'auto', true) !== false) { + // With multi-byte encoded string + $mbPrefix = 'mb_'; + } // END - if - if ((!empty($key)) || ($key === 0)) { - $k = $key . '[' . urlencode($k) . ']'; - } // END - if + // Return the prefix + return $mbPrefix; +} - if (is_array($v) || is_object($v)) { - array_push($ret, http_build_query($v, '', $sep, $k)); - } else { - array_push($ret, $k.'='.urlencode($v)); - } - } // END - foreach +// Searches the given array for a sub-string match and returns all found keys in an array +function getArrayKeysFromSubStrArray ($heystack, $needles, $offset = 0) { + // Init array for all found keys + $keys = array(); - if (empty($sep)) { - $sep = ini_get('arg_separator.output'); + // Now check all entries + foreach ($needles as $key => $needle) { + // Do we have found a partial string? + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'heystack='.$heystack.',key='.$key.',needle='.$needle.',offset='.$offset); + if (strpos($heystack, $needle, $offset) !== false) { + // Add the found key + $keys[] = $key; } // END - if + } // END - foreach - return implode($sep, $ret); - } -} // END - if + // Return the array + return $keys; +} -if (!function_exists('http_chunked_decode')) { - /** - * dechunk an http 'transfer-encoding: chunked' message. - * - * @param $chunk The encoded message - * @return $dechunk The decoded message. If $chunk wasn't encoded properly debug_report_bug() is being called - * @author Marques Johansson - * @link http://php.net/manual/en/function.http-chunked-decode.php#89786 - */ - function http_chunked_decode ($chunk) { - // Init some variables - $offset = 0; - $len = mb_strlen($chunk); - $dechunk = ''; - - // Walk through all chunks - while ($offset < $len) { - // Where does the \r\n begin? - $lineEndAt = mb_strpos($chunk, getConfig('HTTP_EOL'), $offset); - - /* DEBUG: * - print 'lineEndAt['.__LINE__.']='.$lineEndAt.'
-offset['.__LINE__.']='.$offset.'
-len='.$len.'
-next[offset]='.replaceReturnNewLine(htmlentities(mb_substr($chunk, $offset, 10))).''; - /* DEBUG: */ - - // Get next hex-coded chunk length - $chunkLenHex = mb_substr($chunk, $offset, ($lineEndAt - $offset)); - - /* DEBUG: * - print 'chunkLenHex['.__LINE__.']='.replaceReturnNewLine(htmlentities($chunkLenHex)).'
-'; - /* DEBUG: */ - - // Validation if it is hexadecimal - if (!isHexadecimal($chunkLenHex)) { - // Please help debugging this - //* DEBUG: */ die('ABORT:chunkLenHex='.replaceReturnNewLine(htmlentities($chunkLenHex)).''); - debug_report_bug(__FUNCTION__, __LINE__, 'Value ' . $chunkLenHex . ' is not properly chunk encoded.'); - - // This won't be reached - return $chunk; - } // END - if +// Determines database column name from given subject and locked +function determinePointsColumnFromSubjectLocked ($subject, $locked) { + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'subject=' . $subject . ',locked=' . intval($locked) . ' - ENTERED!'); + // Default is 'normal' points + $pointsColumn = 'points'; - // Position of next chunk is right after \r\n - $offset = $offset + strlen($chunkLenHex) + strlen(getConfig('HTTP_EOL')); - $chunkLen = hexdec(rtrim($chunkLenHex, getConfig('HTTP_EOL'))); - - /* DEBUG: * - print 'chunkLen='.$chunkLen.'
-offset['.__LINE__.']='.$offset.'
'; - /* DEBUG: */ - - // Moved out for debugging - $next = mb_substr($chunk, $offset, $chunkLen); - //* DEBUG: */ print 'next='.replaceReturnNewLine(htmlentities($next)).''; - - // Count occurrences of \r\n - $count = mb_substr_count($next, getConfig('HTTP_EOL')); - - // Correct it because we need to subtract occurrences of \r\n - $chunkLen = hexdec(rtrim($chunkLenHex, getConfig('HTTP_EOL'))) - ($count * strlen(getConfig('HTTP_EOL'))); - - $dechunk .= mb_substr($chunk, $offset, $chunkLen); - - /* DEBUG: * - print('offset['.__LINE__.']='.$offset.'
-lineEndAt['.__LINE__.']='.$lineEndAt.'
-len='.$len.'
-count='.$count.'
-chunkLen='.$chunkLen.'
-chunkLenHex='.$chunkLenHex.'
-dechunk='.replaceReturnNewLine(htmlentities($dechunk)).'-chunk='.replaceReturnNewLine(htmlentities($chunk)).''); - /* DEBUG: */ - - // Is $offset + $chunkLen larger than or equal $len? - if (($offset + $chunkLen) >= $len) { - // Then stop processing here - break; - } // END - if + // Which points, locked or normal? + if ($locked === true) { + $pointsColumn = 'locked_points'; + } // END - if + + // Prepare array for filter + $filterData = array( + 'subject' => $subject, + 'locked' => $locked, + 'column' => $pointsColumn + ); - // Calculate next offset of chunk - $offset = mb_strpos($chunk, getConfig('HTTP_EOL'), $offset + $chunkLen) + 2; + // Run the filter + $filterData = runFilterChain('determine_points_column_name', $filterData); - /* DEBUG: * - print('offset['.__LINE__.']='.$offset.'
-next[100]='.replaceReturnNewLine(htmlentities(mb_substr($chunk, $offset, 100))).'----:---:---:---:---:---:---:---:---
-'); - /* DEBUG: */ - } // END - while + // Extract column name from array + $pointsColumn = $filterData['column']; + + // Return it + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'subject=' . $subject . ',locked=' . intval($locked) . ',pointsColumn=' . $pointsColumn . ' - EXIT!'); + return $pointsColumn; +} + +// Setter for referal id (no bigintval, or nicknames will fail!) +function setReferalId ($refid) { + $GLOBALS['refid'] = $refid; +} + +// Checks if 'refid' is valid +function isReferalIdValid () { + return ((isset($GLOBALS['refid'])) && (getReferalId() !== NULL) && (getReferalId() > 0)); +} + +// Getter for referal id +function getReferalId () { + return $GLOBALS['refid']; +} - // Return de-chunked string - return $dechunk; +// Converts a boolean variable into 'Y' for true and 'N' for false +function convertBooleanToYesNo ($boolean) { + // Default is 'N' + $converted = 'N'; + if ($boolean === true) { + // Set 'Y' + $converted = 'Y'; + } // END - if + + // Return it + return $converted; +} + +// Translates task type to a human-readable version +function translateTaskType ($taskType) { + // Construct message id + $messageId = 'ADMIN_TASK_TYPE_' . strtoupper($taskType) . ''; + + // Is the message id there? + if (isMessageIdValid($messageId)) { + // Then construct message + $message = '{--' . $messageId . '--}'; + } else { + // Else it is an unknown task type + $message = '{%message,ADMIN_TASK_TYPE_UNKNOWN=' . $taskType . '%}'; + } // END - if + + // Return message + return $message; +} + +// Translates points subject to human-readable +function translatePointsSubject ($subject) { + // Construct message id + $messageId = 'POINTS_SUBJECT_' . strtoupper($subject) . ''; + + // Is the message id there? + if (isMessageIdValid($messageId)) { + // Then construct message + $message = '{--' . $messageId . '--}'; + } else { + // Else it is an unknown task type + $message = '{%message,POINTS_SUBJECT_UNKNOWN=' . $subject . '%}'; + } // END - if + + // Return message + return $message; +} + +// "Translates" 'true' to true and 'false' to false +function convertStringToBoolean ($str) { + // Trim it lower-case for validation + $str = trim(strtolower($str)); + + // Is it valid? + if (!in_array($str, array('true', 'false'))) { + // Not valid! + debug_report_bug(__FUNCTION__, __LINE__, 'str=' . $str . ' is not true/false'); + } // END - if + + // Return it + return (($str == 'true') ? true : false); +} + +/** + * "Makes" a variable in given string parseable, this function will throw an + * error if the first character is not a dollar sign. + * + * @param $varString String which contains a variable + * @return $return String with added single quotes for better parsing + */ +function makeParseableVariable ($varString) { + // The first character must be a dollar sign + if (substr($varString, 0, 1) != '$') { + // Please report this + debug_report_bug(__FUNCTION__, __LINE__, 'varString=' . $varString . ' - No dollar sign detected, will not parse it.'); + } // END - if + + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__][$varString])) { + // Snap them in, if [,] are there + $GLOBALS[__FUNCTION__][$varString] = str_replace('[', "['", str_replace(']', "']", $varString)); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__][$varString]; +} + +//----------------------------------------------------------------------------- +// Automatically re-created functions, all taken from user comments on www.php.net +//----------------------------------------------------------------------------- +if (!function_exists('html_entity_decode')) { + // Taken from documentation on www.php.net + function html_entity_decode ($string) { + $trans_tbl = get_html_translation_table(HTML_ENTITIES); + $trans_tbl = array_flip($trans_tbl); + return strtr($string, $trans_tbl); } } // END - if