A lot more wrapper functions added, templates renamed

[mailer.git] / inc / wrapper-functions.php

diff --git a/inc/wrapper-functions.php b/inc/wrapper-functions.php
index 4a6e0e0dc9f01ea38ffd6727128eff575e8c1318..19da2ee5b6d714a03e8f1d65a37faad6da535637 100644 (file)
--- a/inc/wrapper-functions.php
+++ b/inc/wrapper-functions.php
@@ -16,7 +16,7 @@
  * $Author::                                                          $ *
  * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
- * Copyright (c) 2009, 2010 by Mailer Developer Team                    *
+ * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
  * For more information visit: http://www.mxchange.org                  *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
@@ -194,10 +194,25 @@ function isDirectory ($FQFN) {
        return $GLOBALS[__FUNCTION__][$FQFN];
 }
 
+// "Getter" for the real remote IP number
+function detectRealIpAddress () {
+       // Get remote ip from environment
+       $remoteAddr = determineRealRemoteAddress();
+
+       // Is removeip installed?
+       if (isExtensionActive('removeip')) {
+               // Then anonymize it
+               $remoteAddr = getAnonymousRemoteAddress($remoteAddr);
+       } // END - if
+
+       // Return it
+       return $remoteAddr;
+}
+
 // "Getter" for remote IP number
 function detectRemoteAddr () {
        // Get remote ip from environment
-       $remoteAddr = determineRealRemoteAddress();
+       $remoteAddr = determineRealRemoteAddress(true);
 
        // Is removeip installed?
        if (isExtensionActive('removeip')) {
@@ -271,6 +286,28 @@ function detectServerName () {
        return (getenv('SERVER_NAME'));
 }
 
+// Removes any  existing www. from SERVER_NAME. This is very silly but enough
+// for our purpose here.
+function detectDomainName () {
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Get server name
+               $domainName = detectServerName();
+
+               // Is there any www. ?
+               if (substr($domainName, 0, 4) == 'www.') {
+                       // Remove it
+                       $domainName = substr($domainName, 4);
+               } // END - if
+
+               // Set cache
+               $GLOBALS[__FUNCTION__] = $domainName;
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
 // Check wether we are installing
 function isInstalling () {
        // Determine wether we are installing
@@ -623,17 +660,23 @@ function isModuleSet ($strict =  false) {
 
 // Getter for 'output_mode' value
 function getScriptOutputMode () {
-       // Default is null
-       $output_mode = null;
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Default is null
+               $output_mode = null;
 
-       // Is the value set?
-       if (isOutputModeSet(true)) {
-               // Then use it
-               $output_mode = $GLOBALS['output_mode'];
+               // Is the value set?
+               if (isOutputModeSet(true)) {
+                       // Then use it
+                       $output_mode = $GLOBALS['output_mode'];
+               } // END - if
+
+               // Store it in cache
+               $GLOBALS[__FUNCTION__] = $output_mode;
        } // END - if
 
-       // Return it
-       return $output_mode;
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
 }
 
 // Setter for 'output_mode' value
@@ -649,7 +692,7 @@ function isOutputModeSet ($strict =  false) {
        // Should we abort here?
        if (($strict === true) && ($isset === false)) {
                // Output backtrace
-               debug_report_bug(__FUNCTION__, __LINE__, 'Output_mode is empty.');
+               debug_report_bug(__FUNCTION__, __LINE__, 'Output mode is not set.');
        } // END - if
 
        // Return it
@@ -1469,6 +1512,30 @@ function getSecretKey () {
        return $GLOBALS[__FUNCTION__];
 }
 
+// "Getter" for SITE_KEY
+function getSiteKey () {
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('SITE_KEY');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// "Getter" for DATE_KEY
+function getDayKey () {
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('DATE_KEY');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
 // "Getter" for master_salt
 function getMasterSalt () {
        // Do we have cache?
@@ -2009,6 +2076,42 @@ function getLastMonth () {
        return $GLOBALS[__FUNCTION__];
 }
 
+// "Getter" for max_send
+function getMaxSend () {
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('max_send');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// "Getter" for mails_page
+function getMailsPage () {
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('mails_page');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// "Getter" for rand_no
+function getRandNo () {
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('rand_no');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
 // "Getter" for __DB_NAME
 function getDbName () {
        // Do we have cache?
@@ -2021,6 +2124,102 @@ function getDbName () {
        return $GLOBALS[__FUNCTION__];
 }
 
+// "Getter" for DOMAIN
+function getDomain () {
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('DOMAIN');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// "Getter" for proxy_username
+function getProxyUsername () {
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('proxy_username');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// "Getter" for proxy_password
+function getProxyPassword () {
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('proxy_password');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// "Getter" for proxy_host
+function getProxyHost () {
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('proxy_host');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// "Getter" for proxy_port
+function getProxyPort () {
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('proxy_port');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// "Getter" for SMTP_HOSTNAME
+function getSmtpHostname () {
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('SMTP_HOSTNAME');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// "Getter" for SMTP_USER
+function getSmtpUser () {
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('SMTP_USER');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// "Getter" for SMTP_PASSWORD
+function getSmtpPassword() {
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('SMTP_PASSWORD');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
 // Checks wether proxy configuration is used
 function isProxyUsed () {
        // Do we have cache?
@@ -2155,7 +2354,12 @@ function changeDataInInclude ($FQFN, $comment, $prefix, $suffix, $DATA, $seek=0)
        $FQFN = getPath() . $FQFN;
 
        // Call inner function
-       changeDataInFile($FQFN, $comment, $prefix, $suffix, $DATA, $seek);
+       return changeDataInFile($FQFN, $comment, $prefix, $suffix, $DATA, $seek);
+}
+
+// Shortens ucfirst(strtolower()) calls
+function firstCharUpperCase ($str) {
+       return ucfirst(strtolower($str));
 }
 
 // [EOF]