A lot has been rewritten, ext-teams added, ext-forced continued:
[mailer.git] / inc / functions.php
index bc397426cfbe564414d6b866e518e24d5fa68bff..e65600e13e36994bee1d1796de5e7cea09bad849 100644 (file)
@@ -85,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}<br />");
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'TO=' . $toEmail);
 
        // Check for PHPMailer or debug-mode
        if ((!checkPhpMailerUsage()) || (isDebugModeEnabled())) {
@@ -130,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
@@ -241,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++) {
@@ -268,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
@@ -293,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;
@@ -308,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;
@@ -471,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&amp;url=' . encodeString(compileUriCode($URL)) . '%}';
+               $url = '{%url=modules.php?module=loader&amp;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&amp;url=%s%%}",
-               encodeString(compileUriCode($URL))
+               encodeString(compileUriCode($url))
        );
 
        // Return the new URL
@@ -533,26 +533,28 @@ 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);
+       //* DEBUG: */ debug_report_bug(__FUNCTION__, __LINE__, 'URL=' . $url);
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'URL=' . $url);
+       //* DEBUG: */ die($url);
 
        // We should not sent a redirect if headers are already sent
        if (!headers_sent()) {
@@ -563,11 +565,11 @@ function redirectToUrl ($URL, $allowSpider = true) {
                $GLOBALS['output'] = '';
 
                // Load URL when headers are not sent
-               sendRawRedirect(doFinalCompilation(str_replace('&amp;', '&', $URL), false));
+               sendRawRedirect(doFinalCompilation(str_replace('&amp;', '&', $url), false));
        } else {
                // Output error message
                loadInclude('inc/header.php');
-               loadTemplate('redirect_url', false, str_replace('&amp;', '&', $URL));
+               loadTemplate('redirect_url', false, str_replace('&amp;', '&', $url));
                loadInclude('inc/footer.php');
        }
 
@@ -592,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
@@ -623,7 +625,7 @@ function array_pk_sort (&$array, $a_sort, $primary_key = '0', $order = -1, $nums
        } // END - while
 
        // Write back sorted array
-       $array = $dummy;
+       $array = $temporaryArray;
 }
 
 
@@ -638,14 +640,14 @@ function generateRandomCode ($length, $code, $userid, $extraData = '') {
        // 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
@@ -668,28 +670,27 @@ function generateRandomCode ($length, $code, $userid, $extraData = '') {
        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;
@@ -717,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';
 
@@ -727,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);
@@ -835,24 +838,26 @@ function isEmailValid ($email) {
 }
 
 // Function taken from user comments on www.php.net / function isInStringIgnoreCase()
-function isUrlValid ($URL, $compile=true) {
+function isUrlValid ($url, $compile=true) {
        // Trim URL a little
-       $URL = trim(urldecode($URL));
-       //* DEBUG: */ debugOutput($URL);
+       $url = trim(urldecode($url));
+       //* DEBUG: */ debugOutput($url);
 
        // Compile some chars out...
-       if ($compile === true) $URL = compileUriCode($URL, false, false, false);
-       //* DEBUG: */ debugOutput($URL);
+       if ($compile === true) {
+               $url = compileUriCode($url, false, false, false);
+       } // END - if
+       //* DEBUG: */ debugOutput($url);
 
        // Check for the extension filter
        if (isExtensionActive('filter')) {
                // Use the extension's filter set
-               return FILTER_VALIDATE_URL($URL, false);
+               return FILTER_VALIDATE_URL($url, false);
        } // END - if
 
        // If not installed, perform a simple test. Just make it sure there is always a http:// or
        // https:// in front of the URLs
-       return isUrlValidSimple($URL);
+       return isUrlValidSimple($url);
 }
 
 // Generate a hash for extra-security for all passwords
@@ -863,7 +868,7 @@ function generateHash ($plainText, $salt = '', $hash = true) {
        // Is the required extension 'sql_patches' there and a salt is not given?
        // 123                            4                      43    3     4     432    2                  3             32    2                             3                32    2      3     3      21
        if (((isExtensionInstalledAndOlder('sql_patches', '0.3.6')) && (empty($salt))) || (!isExtensionActive('sql_patches')) || (!isExtensionInstalledAndNewer('other', '0.2.5')) || (strlen($salt) == 32)) {
-               // Extension sql_patches is missing/outdated so we hash the plain text with MD5
+               // Extension ext-sql_patches is missing/outdated so we hash the plain text with MD5
                if ($hash === true) {
                        // Is plain password
                        return md5($plainText);
@@ -885,7 +890,7 @@ function generateHash ($plainText, $salt = '', $hash = true) {
                $server = $_SERVER['PHP_SELF'] . getEncryptSeperator() . detectUserAgent() . getEncryptSeperator() . getenv('SERVER_SOFTWARE') . getEncryptSeperator() . detectRealIpAddress() . getEncryptSeperator() . detectRemoteAddr();
 
                // Build key string
-               $keys   = getSiteKey() . getEncryptSeperator() . getDateKey() . getEncryptSeperator() . getSecretKey() . getEncryptSeperator() . getFileHash() . getEncryptSeperator() . getDateFromPatchTime() . getEncryptSeperator() . getMasterSalt();
+               $keys   = getSiteKey() . getEncryptSeperator() . getDateKey() . getEncryptSeperator() . getSecretKey() . getEncryptSeperator() . getFileHash() . getEncryptSeperator() . getDateFromRepository() . getEncryptSeperator() . getMasterSalt();
 
                // Additional data
                $data = $plainText . getEncryptSeperator() . uniqid(mt_rand(), true) . getEncryptSeperator() . time();
@@ -913,7 +918,7 @@ function generateHash ($plainText, $salt = '', $hash = true) {
                // Sanity check on salt
                if (strlen($salt) != getSaltLength()) {
                        // Not the same!
-                       debug_report_bug(__FUNCTION__, __LINE__, 'salt length mismatch! ('.strlen($salt).'/'.getSaltLength().')');
+                       debug_report_bug(__FUNCTION__, __LINE__, 'salt length mismatch! (' . strlen($salt) . '/' . getSaltLength() . ')');
                } // END - if
        }
 
@@ -932,7 +937,7 @@ function scrambleString ($str) {
        // Init
        $scrambled = '';
 
-       // Final check, in case of failture it will return unscrambled string
+       // Final check, in case of failure it will return unscrambled string
        if (strlen($str) > 40) {
                // The string is to long
                return $str;
@@ -1099,10 +1104,10 @@ function generateErrorCodeFromUserStatus ($status = '') {
        } // END - if
 
        // Default error code if unknown account status
-       $errorCode = getCode('ACCOUNT_STATUS_UNKNOWN');
+       $errorCode = getCode('ACCOUNT_UNKNOWN');
 
        // Generate constant name
-       $codeName = sprintf("ACCOUNT_STATUS_%s", strtoupper($status));
+       $codeName = sprintf("ACCOUNT_%s", strtoupper($status));
 
        // Is the constant there?
        if (isCodeSet($codeName)) {
@@ -1178,9 +1183,9 @@ function getMessageFromErrorCode ($code) {
                case getCode('ACCOUNT_LOCKED')     : $message = '{--LOGIN_STATUS_LOCKED--}'; break;
                case getCode('ACCOUNT_UNCONFIRMED'): $message = '{--LOGIN_STATUS_UNCONFIRMED--}'; break;
                case getCode('COOKIES_DISABLED')   : $message = '{--LOGIN_COOKIES_DISABLED--}'; break;
-               case getCode('BEG_SAME_AS_OWN')    : $message = '{--BEG_SAME_UID_AS_OWN--}'; break;
+               case getCode('BEG_SAME_AS_OWN')    : $message = '{--BEG_SAME_USERID_AS_OWN--}'; break;
                case getCode('LOGIN_FAILED')       : $message = '{--GUEST_LOGIN_FAILED_GENERAL--}'; break;
-               case getCode('MODULE_MEMBER_ONLY') : $message = getMaskedMessage('MODULE_MEMBER_ONLY', getRequestParameter('mod')); break;
+               case getCode('MODULE_MEMBER_ONLY') : $message = '{%message,MODULE_MEMBER_ONLY=' . getRequestParameter('mod') . '%}'; break;
                case getCode('OVERLENGTH')         : $message = '{--MEMBER_TEXT_OVERLENGTH--}'; break;
                case getCode('URL_FOUND')          : $message = '{--MEMBER_TEXT_CONTAINS_URL--}'; break;
                case getCode('SUBJECT_URL')        : $message = '{--MEMBER_SUBJECT_CONTAINS_URL--}'; break;
@@ -1201,13 +1206,13 @@ function getMessageFromErrorCode ($code) {
                        if (isExtensionActive('mailid', true)) {
                                $message = '{--ERROR_CONFIRMING_MAIL--}';
                        } else {
-                               $message = generateExtensionInactiveNotInstalledMessage('mailid');
+                               $message = '{%pipe,generateExtensionInactiveNotInstalledMessage=mailid%}';
                        }
                        break;
 
                case getCode('EXTENSION_PROBLEM'):
                        if (isGetRequestParameterSet('ext')) {
-                               $message = generateExtensionInactiveNotInstalledMessage(getRequestParameter('ext'));
+                               $message = '{%pipe,generateExtensionInactiveNotInstalledMessage=' . getRequestParameter('ext') . '%}';
                        } else {
                                $message = '{--EXTENSION_PROBLEM_UNSET_EXT--}';
                        }
@@ -1242,7 +1247,7 @@ function getMessageFromErrorCode ($code) {
 
                default:
                        // Missing/invalid code
-                       $message = getMaskedMessage('UNKNOWN_MAILID_CODE', $code);
+                       $message = '{%message,UNKNOWN_MAILID_CODE=' . $code . '%}';
 
                        // Log it
                        logDebugMessage(__FUNCTION__, __LINE__, $message);
@@ -1312,8 +1317,10 @@ function isUrlValidSimple ($url) {
                $reg = ($reg || preg_match(('^' . $pat . '^'), $url));
 
                // Does it match?
-               if ($reg === true) break;
-       }
+               if ($reg === true) {
+                       break;
+               } // END - if
+       } // END - foreach
 
        // Return true/false
        return $reg;
@@ -1321,7 +1328,7 @@ function isUrlValidSimple ($url) {
 
 // Wtites data to a config.php-style file
 // @TODO Rewrite this function to use readFromFile() and writeToFile()
-function changeDataInFile ($FQFN, $comment, $prefix, $suffix, $DATA, $seek=0) {
+function changeDataInFile ($FQFN, $comment, $prefix, $suffix, $inserted, $seek=0) {
        // Initialize some variables
        $done = false;
        $seek++;
@@ -1351,7 +1358,7 @@ function changeDataInFile ($FQFN, $comment, $prefix, $suffix, $DATA, $seek=0) {
                                        // Read from source file
                                        $line = fgets ($fp, 1024);
 
-                                       if (strpos($line, $search) > -1) { 
+                                       if (strpos($line, $search) > -1) {
                                                $next = '0';
                                                $found = true;
                                        } // END - if
@@ -1359,7 +1366,7 @@ function changeDataInFile ($FQFN, $comment, $prefix, $suffix, $DATA, $seek=0) {
                                        if ($next > -1) {
                                                if ($next === $seek) {
                                                        $next = -1;
-                                                       $line = $prefix . $DATA . $suffix . "\n";
+                                                       $line = $prefix . $inserted . $suffix . "\n";
                                                } else {
                                                        $next++;
                                                }
@@ -1399,7 +1406,7 @@ function changeDataInFile ($FQFN, $comment, $prefix, $suffix, $DATA, $seek=0) {
 }
 
 // Send notification to admin
-function sendAdminNotification ($subject, $templateName, $content = array(), $userid = '0') {
+function sendAdminNotification ($subject, $templateName, $content = array(), $userid = NULL) {
        if ((isExtensionInstalledAndNewer('admins', '0.4.1')) && (function_exists('sendAdminsEmails'))) {
                // Send new way
                /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'admins=Y,subject=' . $subject . ',templateName=' . $templateName);
@@ -1446,6 +1453,7 @@ function handleExtraValues ($filterFunction, $value, $extraValue) {
 
                                // Call the multi-parameter call-back
                                $ret = call_user_func_array($filterFunction, $args);
+                               die('filterFunction='.$filterFunction.',args=<pre>'.print_r($args,true).',ret=<pre>'.print_r($ret,true).'</pre>');
                        } else {
                                // One parameter call
                                $ret = call_user_func($filterFunction, $value);
@@ -1458,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 = '';
@@ -1472,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;
 
@@ -1564,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!<br />");
+                               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'inc=' . $inc . ' - LOADED!');
                                loadInclude($inc);
                        } else {
                                // Include not found
@@ -1645,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
@@ -1730,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
@@ -1974,7 +2009,7 @@ function initCacheInstance () {
        // Did it work?
        if ($GLOBALS['cache_instance']->getStatusCode() != 'done') {
                // Failed to initialize cache sustem
-               addFatalMessage(__FUNCTION__, __LINE__, '(<font color="#0000aa">' . __LINE__ . '</font>): {--CACHE_CANNOT_INITIALIZE--}');
+               debug_report_bug(__FUNCTION__, __LINE__, 'Cache system returned with unexpected error. getStatusCode()=' . $GLOBALS['cache_instance']->getStatusCode());
        } // END - if
 }
 
@@ -2135,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
@@ -2205,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('Unfinished area:<br />'.__FUNCTION__.':<br />content=<pre>'.print_r($content, true).'</pre>');
+
+                       // 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
@@ -2225,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
@@ -2245,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));
@@ -2285,7 +2350,7 @@ function detectMultiBytePrefix ($str) {
 }
 
 // Searches the given array for a sub-string match and returns all found keys in an array
-function getArrayKeysFromSubStrArray ($heystack, array $needles, $offset = 0) {
+function getArrayKeysFromSubStrArray ($heystack, $needles, $offset = 0) {
        // Init array for all found keys
        $keys = array();
 
@@ -2303,6 +2368,138 @@ function getArrayKeysFromSubStrArray ($heystack, array $needles, $offset = 0) {
        return $keys;
 }
 
+// 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';
+
+       // 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
+       );
+
+       // Run the filter
+       $filterData = runFilterChain('determine_points_column_name', $filterData);
+
+       // 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'];
+}
+
+// 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
 //-----------------------------------------------------------------------------