Naming convention applied
[mailer.git] / inc / functions.php
index 9f3bf52436c76c115dd85151314abbcb292b410d..9681a3020a5f7a3b36b88aa3b41931ed41e438ed 100644 (file)
@@ -14,8 +14,6 @@
  * $Date::                                                            $ *
  * $Tag:: 0.2.1-FINAL                                                 $ *
  * $Author::                                                          $ *
- * Needs to be in all Files and every File needs "svn propset           *
- * svn:keywords Date Revision" (autoprobset!) at least!!!!!!            *
  * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
  * Copyright (c) 2009, 2010 by Mailer Developer Team                    *
@@ -131,18 +129,29 @@ function sendEmail ($toEmail, $subject, $message, $isHtml = 'N', $mailHeader = '
 
        // Check for PHPMailer or debug-mode
        if ((!checkPhpMailerUsage()) || (isDebugModeEnabled())) {
+               // Prefix is '' for text mails
+               $prefix = '';
+
+               // Is HTML?
+               if ($isHtml == 'Y') {
+                       // Set prefix
+                       $prefix = 'html_';
+               } // END - if
+
                // Not in PHPMailer-Mode
                if (empty($mailHeader)) {
                        // Load email header template
-                       $mailHeader = loadEmailTemplate('header');
+                       $mailHeader = loadEmailTemplate($prefix . 'header');
                } else {
                        // Append header
-                       $mailHeader .= loadEmailTemplate('header');
+                       $mailHeader .= loadEmailTemplate($prefix . 'header');
                }
        } // END - if
 
        // Fix HTML parameter (default is no!)
-       if (empty($isHtml)) $isHtml = 'N';
+       if (empty($isHtml)) {
+               $isHtml = 'N';
+       } // END - if
 
        // Debug mode enabled?
        if (isDebugModeEnabled()) {
@@ -156,9 +165,6 @@ Message : ' . htmlentities(utf8_decode($message)) . '
 
                // This is always fine
                return true;
-       } elseif (($isHtml == 'Y') && (isExtensionActive('html_mail'))) {
-               // Send mail as HTML away
-               return sendHtmlEmail($toEmail, $subject, $message, $mailHeader);
        } elseif (!empty($toEmail)) {
                // Send Mail away
                return sendRawEmail($toEmail, $subject, $message, $mailHeader);
@@ -255,7 +261,7 @@ function sendRawEmail ($toEmail, $subject, $message, $headers) {
 // Generate a password in a specified length or use default password length
 function generatePassword ($length = '0') {
        // Auto-fix invalid length of zero
-       if ($length == '0') $length = getConfig('pass_len');
+       if ($length == '0') $length = getPassLen();
 
        // 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,-,+,_,/,.');
@@ -353,12 +359,6 @@ function translateYesNo ($yn) {
        return $GLOBALS[__FUNCTION__][$yn];
 }
 
-// Translates the "pool type" into human-readable
-function translatePoolType ($type) {
-       // Return "translation"
-       return sprintf("{--POOL_TYPE_%s--}", $type);
-}
-
 // Translates the american decimal dot into a german comma
 function translateComma ($dotted, $cut = true, $max = '0') {
        // First, cast all to double, due to PHP changes
@@ -452,6 +452,9 @@ function translateUserStatus ($status) {
 
 // "Translates" 'visible' and 'locked' to a CSS class
 function translateMenuVisibleLocked ($content, $prefix = '') {
+       // Default is 'menu_unknown'
+       $content['visible_css'] = $prefix . 'menu_unknown';
+
        // Translate 'visible' and keep an eye on the prefix
        switch ($content['visible']) {
                // Should be visible
@@ -579,9 +582,6 @@ function redirectToUrl ($URL, $allowSpider = true) {
                // Clear own output buffer
                $GLOBALS['output'] = '';
 
-               // Set header
-               setHttpStatus('302 Found');
-
                // Load URL when headers are not sent
                sendRawRedirect(doFinalCompilation(str_replace('&', '&', $URL), false));
        } else {
@@ -648,7 +648,7 @@ function array_pk_sort (&$array, $a_sort, $primary_key = '0', $order = -1, $nums
 
 
 //
-// Deprecated : $length
+// Deprecated : $length (still has one reference in this function)
 // Optional   : $DATA
 //
 function generateRandomCode ($length, $code, $userid, $DATA = '') {
@@ -657,16 +657,24 @@ function generateRandomCode ($length, $code, $userid, $DATA = '') {
 
        // Build key string
        $keys = getConfig('SITE_KEY') . getEncryptSeperator() . getConfig('DATE_KEY');
-       if (isConfigEntrySet('secret_key'))  $keys .= getEncryptSeperator().getSecretKey();
-       if (isConfigEntrySet('file_hash'))   $keys .= getEncryptSeperator().getFileHash();
+       if (isConfigEntrySet('secret_key')) {
+               $keys .= getEncryptSeperator().getSecretKey();
+       } // END - if
+       if (isConfigEntrySet('file_hash')) {
+               $keys .= getEncryptSeperator().getFileHash();
+       } // END - if
        $keys .= getEncryptSeperator() . getDateFromPatchTime();
-       if (isConfigEntrySet('master_salt')) $keys .= getEncryptSeperator().getMasterSalt();
+       if (isConfigEntrySet('master_salt')) {
+               $keys .= getEncryptSeperator().getMasterSalt();
+       } // END - if
 
        // Build string from misc data
        $data   = $code . getEncryptSeperator() . $userid . getEncryptSeperator() . $DATA;
 
        // Add more additional data
-       if (isSessionVariableSet('u_hash'))         $data .= getEncryptSeperator() . getSession('u_hash');
+       if (isSessionVariableSet('u_hash')) {
+               $data .= getEncryptSeperator() . getSession('u_hash');
+       } // END - if
 
        // Add referal id, language, theme and userid
        $data .= getEncryptSeperator() . determineReferalId();
@@ -692,7 +700,7 @@ function generateRandomCode ($length, $code, $userid, $DATA = '') {
        }
 
        // At least 10 numbers shall be secure enought!
-       $len = getConfig('code_length');
+       $len = getCodeLength();
        if ($len == '0') $len = $length;
        if ($len == '0') $len = 10;
 
@@ -709,12 +717,15 @@ function bigintval ($num, $castValue = true, $abortOnMismatch = true) {
        $ret = preg_replace('/[^0123456789]/', '', $num);
 
        // Shall we cast?
-       if ($castValue === true) $ret = (double)$ret;
+       if ($castValue === true) {
+               // Cast to biggest numeric type
+               $ret = (double) $ret;
+       } // END - if
 
        // Has the whole value changed?
-       if (('' . $ret . '' != '' . $num . '') && ($abortOnMismatch === true)) {
+       if (('' . $ret . '' != '' . $num . '') && ($abortOnMismatch === true) && (!is_null($num))) {
                // Log the values
-               debug_report_bug(__FUNCTION__, __LINE__, 'Problem with number found. ret=' . $ret . ', num='. $num);
+               debug_report_bug(__FUNCTION__, __LINE__, 'Problem with number found. ret[' . gettype($ret) . ']=' . $ret . ', num[' . gettype($num) . ']='. $num);
        } // END - if
 
        // Return result
@@ -732,7 +743,7 @@ 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 = getConfig('ONE_DAY');
+       if ((floor($TEST) == $TEST) && ($M1 == '02') && ($postData[$prefix . '_mo'] > '02'))  $SWITCH = getOneDay();
 
        // First add years...
        $ret += $postData[$prefix . '_ye'] * (31536000 + $SWITCH);
@@ -828,20 +839,23 @@ function sendGetRequest ($script, $data = array()) {
        // Add data
        $body = http_build_query($data, '', '&');
 
-       // 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;
-       }
+       // 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;
+               // Add script data
+               $script .= $body;
 
-       // Remove trailed & to make it more conform
-       if (substr($script, -1, 1) == '&') $script = substr($script, 0, -1);
+               // Remove trailed & to make it more conform
+               if (substr($script, -1, 1) == '&') $script = substr($script, 0, -1);
+       } // END - if
 
        // Generate GET request header
        $request  = 'GET /' . trim($script) . ' HTTP/1.1' . getConfig('HTTP_EOL');
@@ -1268,11 +1282,11 @@ function genScrambleString ($len) {
        // First we need to setup randomized numbers from 0 to 31
        for ($idx = 0; $idx < $len; $idx++) {
                // Generate number
-               $rand = mt_rand(0, ($len -1));
+               $rand = mt_rand(0, ($len - 1));
 
                // Check for it by creating more numbers
                while (array_key_exists($rand, $scrambleNumbers)) {
-                       $rand = mt_rand(0, ($len -1));
+                       $rand = mt_rand(0, ($len - 1));
                } // END - while
 
                // Add number
@@ -1441,7 +1455,7 @@ function getMessageFromErrorCode ($code) {
        switch ($code) {
                case '': break;
                case getCode('LOGOUT_DONE')        : $message = '{--LOGOUT_DONE--}'; break;
-               case getCode('LOGOUT_FAILED')      : $message = '<span class="guest_failed">{--LOGOUT_FAILED--}</span>'; break;
+               case getCode('LOGOUT_FAILED')      : $message = '<span class="notice">{--LOGOUT_FAILED--}</span>'; break;
                case getCode('DATA_INVALID')       : $message = '{--MAIL_DATA_INVALID--}'; break;
                case getCode('POSSIBLE_INVALID')   : $message = '{--MAIL_POSSIBLE_INVALID--}'; break;
                case getCode('USER_404')           : $message = '{--USER_404--}'; break;
@@ -1469,12 +1483,13 @@ function getMessageFromErrorCode ($code) {
                case getCode('NO_MAIL_TYPE')       : $message = '{--MEMBER_NO_MAIL_TYPE_SELECTED--}'; break;
                case getCode('UNKNOWN_ERROR')      : $message = '{--LOGIN_UNKNOWN_ERROR--}'; break;
                case getCode('UNKNOWN_STATUS')     : $message = '{--LOGIN_UNKNOWN_STATUS--}'; break;
+               case getCode('PROFILE_UPDATED')    : $message = '{--MEMBER_PROFILE_UPDATED--}'; break;
 
                case getCode('ERROR_MAILID'):
                        if (isExtensionActive('mailid', true)) {
                                $message = '{--ERROR_CONFIRMING_MAIL--}';
                        } else {
-                               $message = getMaskedMessage('EXTENSION_PROBLEM_EXTENSION_NOT_INSTALLED', 'mailid');
+                               $message = generateExtensionInactiveNotInstalledMessage('mailid');
                        }
                        break;
 
@@ -1486,34 +1501,31 @@ function getMessageFromErrorCode ($code) {
                        }
                        break;
 
-               case getCode('URL_TLOCK'):
+               case getCode('URL_TIME_LOCK'):
                        // @TODO Move this SQL code into a function, let's say 'getTimestampFromPoolId($id) ?
                        $result = SQL_QUERY_ESC("SELECT `timestamp` FROM `{?_MYSQL_PREFIX?}_pool` WHERE `id`=%s LIMIT 1",
                                array(bigintval(getRequestParameter('id'))), __FUNCTION__, __LINE__);
 
                        // Load timestamp from last order
-                       list($timestamp) = SQL_FETCHROW($result);
+                       $content = SQL_FETCHARRAY($result);
 
                        // Free memory
                        SQL_FREERESULT($result);
 
                        // Translate it for templates
-                       $timestamp = generateDateTime($timestamp, 1);
+                       $content['timestamp'] = generateDateTime($content['timestamp'], 1);
 
                        // Calculate hours...
-                       $STD = round(getConfig('url_tlock') / 60 / 60);
+                       $content['hours'] = round(getConfig('url_tlock') / 60 / 60);
 
                        // Minutes...
-                       $MIN = round((getConfig('url_tlock') - $STD * 60 * 60) / 60);
+                       $content['minutes'] = round((getConfig('url_tlock') - $content['hours'] * 60 * 60) / 60);
 
                        // And seconds
-                       $SEC = getConfig('url_tlock') - $STD * 60 * 60 - $MIN * 60;
+                       $content['seconds'] = round(getConfig('url_tlock') - $content['hours'] * 60 * 60 - $content['minutes'] * 60);
 
                        // Finally contruct the message
-                       // @TODO Rewrite this old lost code to a template
-                       $message = '{--MEMBER_URL_TIME_LOCK--}<br />{--CONFIG_URL_TLOCK--} ' . $STD . '
-                       {--_HOURS--}, ' . $MIN . ' {--_MINUTES--} {--_AND--} ' . $SEC . ' {--_SECONDS--}<br />
-                       {--MEMBER_LAST_TLOCK--}: ' . $timestamp;
+                       $message = loadTemplate('tlock_message', true, $content);
                        break;
 
                default:
@@ -1693,9 +1705,7 @@ function logDebugMessage ($funcFile, $line, $message, $force=true) {
                $message = str_replace("\r", '', str_replace("\n", '', $message));
 
                // Log this message away
-               $fp = fopen(getCachePath() . 'debug.log', 'a') or debug_report_bug(__FUNCTION__, __LINE__, 'Cannot write logfile debug.log!');
-               fwrite($fp, generateDateTime(time(), '4') . '|' . getModule(false) . '|' . basename($funcFile) . '|' . $line . '|' . $message . "\n");
-               fclose($fp);
+               appendLineToFile(getCachePath() . 'debug.log', generateDateTime(time(), '4') . '|' . getModule(false) . '|' . basename($funcFile) . '|' . $line . '|' . $message);
        } // END - if
 }
 
@@ -1918,34 +1928,34 @@ function determineReferalId () {
        // Check if refid is set
        if ((isset($GLOBALS['refid'])) && ($GLOBALS['refid'] > 0)) {
                // This is fine...
-       } elseif ((isGetRequestParameterSet('user')) && (basename($_SERVER['PHP_SELF']) == 'click.php')) {
-               // The variable user comes from the click-counter script click.php and we only accept this here
-               $GLOBALS['refid'] = bigintval(getRequestParameter('user'));
        } elseif (isPostRequestParameterSet('refid')) {
-               // Get referal id from variable refid (so I hope this makes my script more compatible to other scripts)
+               // Get referal id from POST element refid
                $GLOBALS['refid'] = secureString(postRequestParameter('refid'));
        } elseif (isGetRequestParameterSet('refid')) {
-               // Get referal id from variable refid (so I hope this makes my script more compatible to other scripts)
+               // Get referal id from GET parameter refid
                $GLOBALS['refid'] = secureString(getRequestParameter('refid'));
        } elseif (isGetRequestParameterSet('ref')) {
                // Set refid=ref (the referal link uses such variable)
                $GLOBALS['refid'] = secureString(getRequestParameter('ref'));
+       } elseif ((isGetRequestParameterSet('user')) && (basename($_SERVER['PHP_SELF']) == 'click.php')) {
+               // The variable user comes from  click.php
+               $GLOBALS['refid'] = bigintval(getRequestParameter('user'));
        } elseif ((isSessionVariableSet('refid')) && (isValidUserId(getSession('refid')))) {
                // Set session refid als global
                $GLOBALS['refid'] = bigintval(getSession('refid'));
-       } elseif ((isExtensionInstalledAndNewer('user', '0.3.4')) && (isRandomReferalIdEnabled())) {
+       } elseif (isRandomReferalIdEnabled()) {
                // Select a random user which has confirmed enougth mails
                $GLOBALS['refid'] = determineRandomReferalId();
-       } elseif ((isExtensionInstalledAndNewer('sql_patches', '0.1.2')) && (isValidUserId(getConfig('def_refid')))) {
+       } elseif ((isExtensionInstalledAndNewer('sql_patches', '0.1.2')) && (isValidUserId(getDefRefid()))) {
                // Set default refid as refid in URL
-               $GLOBALS['refid'] = getConfig('def_refid');
+               $GLOBALS['refid'] = getDefRefid();
        } else {
                // No default id when sql_patches is not installed or none set
-               $GLOBALS['refid'] = '0';
+               $GLOBALS['refid'] = null;
        }
 
        // Set cookie when default refid > 0
-       if (!isSessionVariableSet('refid') || (!empty($GLOBALS['refid'])) || ((!isValidUserId(getSession('refid'))) && (isConfigEntrySet('def_refid')) && (isValidUserId(getConfig('def_refid'))))) {
+       if (!isSessionVariableSet('refid') || (isValidUserId($GLOBALS['refid'])) || ((!isValidUserId(getSession('refid'))) && (isExtensionInstalledAndNewer('sql_patches', '0.1.2')) && (isValidUserId(getDefRefid())))) {
                // Default is not found
                $found = false;
 
@@ -1953,15 +1963,15 @@ function determineReferalId () {
                if ((isExtensionActive('nickname')) && (isNicknameUsed($GLOBALS['refid']))) {
                        // Nickname in URL, so load the id
                        $found = fetchUserData($GLOBALS['refid'], 'nickname');
-               } elseif ($GLOBALS['refid'] > 0) {
+               } elseif (isValidUserId($GLOBALS['refid'])) {
                        // Direct userid entered
                        $found = fetchUserData($GLOBALS['refid']);
                }
 
                // Is the record valid?
-               if ((($found === false) || (!isUserDataValid())) && (isConfigEntrySet('def_refid'))) {
+               if ((($found === false) || (!isUserDataValid())) && (isExtensionInstalledAndNewer('sql_patches', '0.1.2'))) {
                        // No, then reset referal id
-                       $GLOBALS['refid'] = getConfig('def_refid');
+                       $GLOBALS['refid'] = getDefRefid();
                } // END - if
 
                // Set cookie
@@ -2007,7 +2017,9 @@ function initMemberId () {
 // Setter for member id
 function setMemberId ($memberid) {
        // We should not set member id to zero
-       if ($memberid == '0') debug_report_bug(__FUNCTION__, __LINE__, 'Userid should not be set zero.');
+       if ($memberid == '0') {
+               debug_report_bug(__FUNCTION__, __LINE__, 'Userid should not be set zero.');
+       } // END - if
 
        // Set it secured
        $GLOBALS['member_id'] = bigintval($memberid);
@@ -2128,19 +2140,13 @@ function getArrayFromDirectory ($baseDir, $prefix, $fileIncludeDirs = false, $ad
                                // Remove both for extension name
                                $extName = substr($baseFile, strlen($prefix), -4);
 
-                               // Is the extension valid and active?
-                               if (isExtensionNameValid($extName)) {
-                                       // Then add this file
-                                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Extension entry ' . $baseFile . ' added.');
+                               // Add file with or without base path
+                               if ($addBaseDir === true) {
+                                       // With base path
                                        $files[] = $fileName;
                                } else {
-                                       // Add non-extension files as well
-                                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Regular entry ' . $baseFile . ' added.');
-                                       if ($addBaseDir === true) {
-                                               $files[] = $fileName;
-                                       } else {
-                                               $files[] = $baseFile;
-                                       }
+                                       // No base path
+                                       $files[] = $baseFile;
                                }
                        } else {
                                // We found .php file but should not search for them, why?
@@ -2216,12 +2222,20 @@ function addSqlToDebug ($result, $sqlString, $timing, $F, $L) {
 
 // Initializes the cache instance
 function initCacheInstance () {
+       // Check for double-initialization
+       if (isset($GLOBALS['cache_instance'])) {
+               // This should not happen and must be fixed
+               debug_report_bug(__FUNCTION__, __LINE__, 'Double initialization of cache system detected. cache_instance[]=' . gettype($GLOBALS['cache_instance']));
+       } // END - if
+
        // Load include for CacheSystem class
        loadIncludeOnce('inc/classes/cachesystem.class.php');
 
        // Initialize cache system only when it's needed
        $GLOBALS['cache_instance'] = new CacheSystem();
-       if ($GLOBALS['cache_instance']->getStatus() != 'done') {
+
+       // 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--}');
        } // END - if
@@ -2435,7 +2449,7 @@ 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) {
+               foreach ((array) $data as $k => $v) {
                        if (is_int($k) && $prefix != null) {
                                $k = urlencode($prefix . $k);
                        } // END - if