Wrapper function isAdminsExpertWarningEnabled() introduced
[mailer.git] / inc / libs / admins_functions.php
index 2b9a008104a0f62eba50c5211716320e03192b45..fad8a524ed21294c0d946ca23fa6c454bbb7c1a5 100644 (file)
  * $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                    *
+ * 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 *
@@ -169,7 +167,7 @@ function adminsChangeAdminAccount ($postData, $element = '') {
                                array($element, $postData[$element][$id], $id), __FUNCTION__, __LINE__);
 
                        // Admin account saved
-                       $message = getMessage('ADMIN_ACCOUNT_SAVED');
+                       $message = '{--ADMIN_ACCOUNT_SAVED--}';
                } elseif ((isset($postData['pass1'])) && (isset($postData['pass2']))) {
                        // Update only if both passwords match
                        if (($postData['pass1'][$id] == $postData['pass2'][$id])) {
@@ -189,17 +187,19 @@ function adminsChangeAdminAccount ($postData, $element = '') {
                                // Rewrite cookie when it's own account
                                if ($adminId == $id) {
                                        // Set timeout cookie
-                                       setSession('admin_last', time());
+                                       setAdminLast(time());
 
-                                       if ($login != getSession('admin_login')) {
+                                       if ($adminId != getCurrentAdminId()) {
                                                // Update login cookie
-                                               setSession('admin_login', $login);
+                                               setAdminId($adminId);
 
                                                // Update password cookie as well?
-                                               if (!empty($add)) setSession('admin_md5', $hash);
-                                       } elseif (generateHash($postData['pass1'][$id], $salt) != getSession('admin_md5')) {
+                                               if (!empty($add)) {
+                                                       setAdminMd5($hash);
+                                               } // END - if
+                                       } elseif (generateHash($postData['pass1'][$id], $salt) != getAdminMd5()) {
                                                // Update password cookie
-                                               setSession('admin_md5', $hash);
+                                               setAdminMd5($hash);
                                        }
                                } // END - if
 
@@ -246,10 +246,10 @@ LIMIT 1",
                                }
 
                                // Admin account saved
-                               $message = getMessage('ADMIN_ACCOUNT_SAVED');
+                               $message = '{--ADMIN_ACCOUNT_SAVED--}';
                        } else {
                                // Passwords did not match
-                               $message = getMessage('ADMINS_ERROR_PASS_MISMATCH');
+                               $message = '{--ADMINS_ERROR_PASS_MISMATCH--}';
                        }
                } else {
                        // Update whole array
@@ -258,18 +258,21 @@ LIMIT 1",
                                // Skip login/id entry
                                if (in_array($entry, array('login', 'id'))) continue;
 
-                               // Do we have a non-string (e.g. number, NOW() or back-tick at the beginning?
-                               if ((bigintval($value[$id], true, false) === $value[$id]) || ($value[$id] == 'NOW()') || (substr($value[$id], 0, 1) == '`'))  {
+                               // Do we have a non-string (e.g. number, NULL, NOW() or back-tick at the beginning?
+                               if (is_null($value[$id])) {
+                                       // NULL detected
+                                       $SQL .= '`' . $entry . '`=NULL, ';
+                               } elseif ((bigintval($value[$id], true, false) === $value[$id]) || ($value[$id] == 'NOW()') || (substr($value[$id], 0, 1) == '`'))  {
                                        // No need for ticks (')
-                                       $SQL .= '`' . $entry . '`=' . $value[$id] . ',';
+                                       $SQL .= '`' . $entry . '`=' . $value[$id] . ', ';
                                } else {
                                        // Strings need ticks (') around them
-                                       $SQL .= '`' . $entry . "`='" . SQL_ESCAPE($value[$id]) . "',";
+                                       $SQL .= '`' . $entry . "`='" . SQL_ESCAPE($value[$id]) . "', ";
                                }
                        } // END - foreach
 
-                       // Remove last tick and finish query
-                       $SQL = substr($SQL, 0, -1) . ' WHERE `id`=%s LIMIT 1';
+                       // Remove last 2 chars and finish query
+                       $SQL = substr($SQL, 0, -2) . ' WHERE `id`=%s LIMIT 1';
 
                        // Run it
                        SQL_QUERY_ESC($SQL, array(bigintval($id)), __FUNCTION__, __LINE__);
@@ -282,7 +285,7 @@ LIMIT 1",
        } // END - if
 
        // Remove cache file
-       runFilterChain('post_admin_edited', postRequestArray());
+       runFilterChain('post_form_submited', postRequestArray());
 }
 
 // Make admin accounts editable
@@ -291,7 +294,7 @@ function adminsEditAdminAccount ($postData) {
        $currMode = getAdminDefaultAcl(getCurrentAdminId());
 
        // Begin the edit loop
-       $OUT = ''; $SW = 2;
+       $OUT = '';
        foreach ($postData['sel'] as $id => $selected) {
                // Secure id number
                $id = bigintval($id);
@@ -305,24 +308,22 @@ function adminsEditAdminAccount ($postData) {
                        SQL_FREERESULT($result);
 
                        // Prepare some more data for the template
-                       $content['sw'] = $SW;
                        $content['id'] = $id;
 
                        // Shall we allow changing default ACL?
                        if ($currMode == 'allow') {
                                // Allow chaning it
-                               $content['mode']    = generateOptionList('/ARRAY/', array('allow', 'deny'), array(getMessage('ADMINS_ALLOW_MODE'), getMessage('ADMINS_DENY_MODE')), $content['mode']);
+                               $content['mode']    = generateOptionList('/ARRAY/', array('allow', 'deny'), array('{--ADMINS_ALLOW_MODE--}', '{--ADMINS_DENY_MODE--}'), $content['mode']);
                        } else {
                                // Don't allow it
                                $content['mode'] = ' ';
                        }
-                       $content['la_mode'] = generateOptionList('/ARRAY/', array('global', 'OLD', 'NEW'), array(getMessage('ADMINS_GLOBAL_LA_SETTING'), getMessage('ADMINS_OLD_LA_SETTING'), getMessage('ADMINS_NEW_LA_SETTING')), $content['la_mode']);
+                       $content['la_mode'] = generateOptionList('/ARRAY/', array('global', 'OLD', 'NEW'), array('{--ADMINS_GLOBAL_LA_SETTING--}', '{--ADMINS_OLD_LA_SETTING--}', '{--ADMINS_NEW_LA_SETTING--}'), $content['la_mode']);
 
                        // Load row template and switch color
                        $OUT .= loadTemplate('admin_edit_admins_row', true, $content);
-                       $SW = 3 - $SW;
-               }
-       }
+               } // END - if
+       } // END - foreach
 
        // Load template
        loadTemplate('admin_edit_admins', false, $OUT);
@@ -331,38 +332,37 @@ function adminsEditAdminAccount ($postData) {
 // Delete given admin accounts
 function adminsDeleteAdminAccount ($postData) {
        // Check if this account is the last one which cannot be deleted...
-       $result_main = SQL_QUERY("SELECT `id` FROM `{?_MYSQL_PREFIX?}_admins`", __FUNCTION__, __LINE__);
-       $accounts = SQL_NUMROWS($result_main);
-       SQL_FREERESULT($result_main);
-       if ($accounts > 1) {
+       if (countSumTotalData('', 'admins', 'id', '', true) > 1) {
                // Delete accounts
-               $OUT = ''; $SW = 2;
+               $OUT = '';
                foreach ($postData['sel'] as $id => $selected) {
                        // Secure id number
                        $id = bigintval($id);
 
                        // Get the admin's data
-                       $result = SQL_QUERY_ESC("SELECT login, email, default_acl AS mode, la_mode FROM `{?_MYSQL_PREFIX?}_admins` WHERE `id`=%s LIMIT 1",
+                       $result = SQL_QUERY_ESC("SELECT `login`, `email`, `default_acl` AS `mode`, `la_mode` FROM `{?_MYSQL_PREFIX?}_admins` WHERE `id`=%s LIMIT 1",
                                array($id), __FUNCTION__, __LINE__);
+
+                       // Do we have an entry?
                        if (SQL_NUMROWS($result) == 1) {
-                               // Entry found
+                               // Entry found, so load data
                                $content = SQL_FETCHARRAY($result);
-                               SQL_FREERESULT($result);
-                               $content['mode'] = getMessage('ADMINS_'.strtoupper($content['mode']).'_MODE');
-                               $content['la_mode'] = getMessage('ADMINS_'.strtoupper($content['la_mode']).'_LA_SETTING');
+                               $content['mode']    = '{--ADMINS_' . strtoupper($content['mode'])    . '_MODE--}';
+                               $content['la_mode'] = '{--ADMINS_' . strtoupper($content['la_mode']) . '_LA_SETTING--}';
 
                                // Prepare some more data
-                               $content['sw'] = $SW;
                                $content['id'] = $id;
 
                                // Load row template and switch color
-                               $OUT .= loadTemplate('admin_del_admins_row', true, $content);
-                               $SW = 3 - $SW;
-                       }
-               }
+                               $OUT .= loadTemplate('admin_delete_admins_row', true, $content);
+                       } // END - if
+
+                       // Free result
+                       SQL_FREERESULT($result);
+               } // END - foreach
 
                // Load template
-               loadTemplate('admin_del_admins', false, $OUT);
+               loadTemplate('admin_delete_admins', false, $OUT);
        } else {
                // Cannot delete last account!
                loadTemplate('admin_settings_saved', false, '{--ADMIN_ADMINS_CANNOT_DELETE_LAST--}');
@@ -380,7 +380,7 @@ function adminsRemoveAdminAccount ($postData) {
                // Delete only when it's not your own account!
                if (($del == 1) && (getCurrentAdminId() != $id)) {
                        // Rewrite his tasks to all admins
-                       SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_task_system` SET `assigned_admin`=0 WHERE `assigned_admin`=%s",
+                       SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_task_system` SET `assigned_admin`=NULL WHERE `assigned_admin`=%s",
                                array($id), __FUNCTION__, __LINE__);
 
                        // Remove account
@@ -390,27 +390,22 @@ function adminsRemoveAdminAccount ($postData) {
        }
 
        // Remove cache if cache system is activated
-       runFilterChain('post_admin_deleted', postRequestArray());
+       runFilterChain('post_form_deleted', postRequestArray());
 }
 
 // List all admin accounts
 function adminsListAdminAccounts() {
        // Select all admin accounts
-       $result = SQL_QUERY("SELECT `id`, `login`, `email`, `default_acl` AS mode, `la_mode` FROM `{?_MYSQL_PREFIX?}_admins` ORDER BY `login` ASC", __FUNCTION__, __LINE__);
-       $OUT = ''; $SW = 2;
+       $result = SQL_QUERY('SELECT `id`, `login`, `email`, `default_acl` AS mode, `la_mode` FROM `{?_MYSQL_PREFIX?}_admins` ORDER BY `login` ASC', __FUNCTION__, __LINE__);
+       $OUT = '';
        while ($content = SQL_FETCHARRAY($result)) {
                // Compile some variables
-               $content['mode'] = getMessage('ADMINS_'.strtoupper($content['mode']).'_MODE');
-               $content['la_mode'] = getMessage('ADMINS_'.strtoupper($content['la_mode']).'_LA_SETTING');
-
-               // Prepare some more data
-               $content['sw']         = $SW;
-               $content['email_link'] = generateEmailLink($content['id'], 'admins');
+               $content['mode']    = '{--ADMINS_' . strtoupper($content['mode'])    . '_MODE--}';
+               $content['la_mode'] = '{--ADMINS_' . strtoupper($content['la_mode']) . '_LA_SETTING--}';
 
                // Load row template and switch color
                $OUT .= loadTemplate('admin_list_admins_row', true, $content);
-               $SW = 3 - $SW;
-       }
+       } // END - while
 
        // Free memory
        SQL_FREERESULT($result);
@@ -465,7 +460,7 @@ function sendAdminsEmails ($subj, $template, $content, $userid) {
                        }
                } elseif (($adminId == '0') || (empty($adminId))) {
                        // Select all email adresses
-                       $result = SQL_QUERY("SELECT `email` FROM `{?_MYSQL_PREFIX?}_admins` ORDER BY `id` ASC",
+                       $result = SQL_QUERY('SELECT `email` FROM `{?_MYSQL_PREFIX?}_admins` ORDER BY `id` ASC',
                                __FUNCTION__, __LINE__);
                } else {
                        // If Admin-Id is not "to-all" select
@@ -488,20 +483,20 @@ function getAminsExpertSettings () {
        // Default is has not the right
        $data['expert_settings'] = 'N';
 
-       // Get current admin login
-       $admin = getAdminLogin(getCurrentAdminId());
+       // Get current admin Id
+       $adminId = getCurrentAdminId();
 
        // Lookup settings in cache
-       if (isset($GLOBALS['cache_array']['admin']['expert_settings'][$admin])) {
+       if (isset($GLOBALS['cache_array']['admin']['expert_settings'][$adminId])) {
                // Use cache
-               $data['expert_settings'] = $GLOBALS['cache_array']['admin']['expert_settings'][$admin];
+               $data['expert_settings'] = $GLOBALS['cache_array']['admin']['expert_settings'][$adminId];
 
                // Update cache hits
                incrementStatsEntry('cache_hits');
        } elseif (!isExtensionInstalled('cache')) {
                // Load from database
-               $result = SQL_QUERY_ESC("SELECT `expert_settings` FROM `{?_MYSQL_PREFIX?}_admins` WHERE `login`='%s' LIMIT 1",
-                       array($admin), __FUNCTION__, __LINE__);
+               $result = SQL_QUERY_ESC("SELECT `expert_settings` FROM `{?_MYSQL_PREFIX?}_admins` WHERE `id`=%s LIMIT 1",
+                       array($adminId), __FUNCTION__, __LINE__);
 
                // Entry found?
                if (SQL_NUMROWS($result) == 1) {
@@ -509,7 +504,7 @@ function getAminsExpertSettings () {
                        $data = SQL_FETCHARRAY($result);
 
                        // Set cache
-                       $GLOBALS['cache_array']['admin']['expert_settings'][$admin] = $data['expert_settings'];
+                       $GLOBALS['cache_array']['admin']['expert_settings'][$adminId] = $data['expert_settings'];
                } // END - if
 
                // Free memory
@@ -525,20 +520,20 @@ function getAminsExpertWarning () {
        // Default is has not the right
        $data['expert_warning'] = 'N';
 
-       // Get current admin login
-       $admin = getAdminLogin(getCurrentAdminId());
+       // Get current admin id
+       $adminId = getCurrentAdminId();
 
        // Lookup warning in cache
-       if (isset($GLOBALS['cache_array']['admin']['expert_warning'][$admin])) {
+       if (isset($GLOBALS['cache_array']['admin']['expert_warning'][$adminId])) {
                // Use cache
-               $data['expert_warning'] = $GLOBALS['cache_array']['admin']['expert_warning'][$admin];
+               $data['expert_warning'] = $GLOBALS['cache_array']['admin']['expert_warning'][$adminId];
 
                // Update cache hits
                incrementStatsEntry('cache_hits');
        } elseif (!isExtensionInstalled('cache')) {
                // Load from database
-               $result = SQL_QUERY_ESC("SELECT `expert_warning` FROM `{?_MYSQL_PREFIX?}_admins` WHERE `login`='%s' LIMIT 1",
-                       array($admin), __FUNCTION__, __LINE__);
+               $result = SQL_QUERY_ESC("SELECT `expert_warning` FROM `{?_MYSQL_PREFIX?}_admins` WHERE `id`=%s LIMIT 1",
+                       array($adminId), __FUNCTION__, __LINE__);
 
                // Entry found?
                if (SQL_NUMROWS($result) == 1) {
@@ -546,7 +541,7 @@ function getAminsExpertWarning () {
                        $data = SQL_FETCHARRAY($result);
 
                        // Set cache
-                       $GLOBALS['cache_array']['admin']['expert_warning'][$admin] = $data['expert_warning'];
+                       $GLOBALS['cache_array']['admin']['expert_warning'][$adminId] = $data['expert_warning'];
                } // END - if
 
                // Free memory
@@ -558,26 +553,26 @@ function getAminsExpertWarning () {
 }
 
 // Get login_failures number from administrator's login name
-function getAdminLoginFailures ($adminLogin) {
+function getAdminLoginFailures ($adminId) {
        // Admin login should not be empty
-       if (empty($adminLogin)) {
-               debug_report_bug(__FUNCTION__, __LINE__, 'adminLogin is empty.');
+       if (empty($adminId)) {
+               debug_report_bug(__FUNCTION__, __LINE__, 'adminId is empty.');
        } // END - if
 
        // By default no admin is found
        $data['login_failures'] = '-1';
 
        // Check cache
-       if (isset($GLOBALS['cache_array']['admin']['login_failures'][$adminLogin])) {
+       if (isset($GLOBALS['cache_array']['admin']['login_failures'][$adminId])) {
                // Use it if found to save SQL queries
-               $data['login_failures'] = $GLOBALS['cache_array']['admin']['login_failures'][$adminLogin];
+               $data['login_failures'] = $GLOBALS['cache_array']['admin']['login_failures'][$adminId];
 
                // Update cache hits
                incrementStatsEntry('cache_hits');
        } elseif (!isExtensionActive('cache')) {
                // Load from database
-               $result = SQL_QUERY_ESC("SELECT `login_failures` FROM `{?_MYSQL_PREFIX?}_admins` WHERE `login`='%s' LIMIT 1",
-                       array($adminLogin), __FUNCTION__, __LINE__);
+               $result = SQL_QUERY_ESC("SELECT `login_failures` FROM `{?_MYSQL_PREFIX?}_admins` WHERE `id`=%s LIMIT 1",
+                       array($adminId), __FUNCTION__, __LINE__);
 
                // Do we have an entry?
                if (SQL_NUMROWS($result) == 1) {
@@ -594,26 +589,26 @@ function getAdminLoginFailures ($adminLogin) {
 }
 
 // Get last_failure number from administrator's login name
-function getAdminLastFailure ($adminLogin) {
+function getAdminLastFailure ($adminId) {
        // Admin login should not be empty
-       if (empty($adminLogin)) {
-               debug_report_bug(__FUNCTION__, __LINE__, 'adminLogin is empty.');
+       if (empty($adminId)) {
+               debug_report_bug(__FUNCTION__, __LINE__, 'adminId is empty.');
        } // END - if
 
        // By default no admin is found
        $data['last_failure'] = '-1';
 
        // Check cache
-       if (isset($GLOBALS['cache_array']['admin']['last_failure'][$adminLogin])) {
+       if (isset($GLOBALS['cache_array']['admin']['last_failure'][$adminId])) {
                // Use it if found to save SQL queries
-               $data['last_failure'] = $GLOBALS['cache_array']['admin']['last_failure'][$adminLogin];
+               $data['last_failure'] = $GLOBALS['cache_array']['admin']['last_failure'][$adminId];
 
                // Update cache hits
                incrementStatsEntry('cache_hits');
        } elseif (!isExtensionActive('cache')) {
                // Load from database
-               $result = SQL_QUERY_ESC("SELECT UNIX_TIMESTAMP(`last_failure`) AS `last_failure` FROM `{?_MYSQL_PREFIX?}_admins` WHERE `login`='%s' LIMIT 1",
-                       array($adminLogin), __FUNCTION__, __LINE__);
+               $result = SQL_QUERY_ESC("SELECT UNIX_TIMESTAMP(`last_failure`) AS `last_failure` FROM `{?_MYSQL_PREFIX?}_admins` WHERE `id`=%s LIMIT 1",
+                       array($adminId), __FUNCTION__, __LINE__);
 
                // Do we have an entry?
                if (SQL_NUMROWS($result) == 1) {
@@ -629,9 +624,9 @@ function getAdminLastFailure ($adminLogin) {
        return $data['last_failure'];
 }
 
-//*****************************************************************************
-//                     Below only filter functions
-//*****************************************************************************
+//-----------------------------------------------------------------------------
+//                                Filter Functions
+//-----------------------------------------------------------------------------
 
 // Filter for adding extra data to the query
 function FILTER_ADD_EXTRA_SQL_DATA ($add = '') {
@@ -648,13 +643,13 @@ function FILTER_ADD_EXTRA_SQL_DATA ($add = '') {
 // Reset the login failures
 function FILTER_RESET_ADMINS_LOGIN_FAILURES ($data) {
        // Store it in session
-       setSession('mailer_admin_failures'    , getAdminLoginFailures($data['login']));
-       setSession('mailer_admin_last_failure', getAdminLastFailure($data['login']));
+       setSession('mailer_admin_failures'    , getAdminLoginFailures($data['id']));
+       setSession('mailer_admin_last_failure', getAdminLastFailure($data['id']));
 
        // Prepare update data
        $postData['login'][getCurrentAdminId()]          = $data['login'];
        $postData['login_failures'][getCurrentAdminId()] = '0';
-       $postData['last_failure'][getCurrentAdminId()]   = '0000-00-00 00:00:00';
+       $postData['last_failure'][getCurrentAdminId()]   = null;
 
        // Change it in the admin
        adminsChangeAdminAccount($postData);
@@ -696,7 +691,7 @@ function FILTER_REHASH_ADMINS_PASSWORD ($data) {
        adminsChangeAdminAccount($postData);
 
        // Update cookie/session and data array
-       setSession('admin_md5', encodeHashForCookie($newHash));
+       setAdminMd5(encodeHashForCookie($newHash));
        $data['pass_hash'] = $newHash;
 
        // Always make sure the cache is destroyed
@@ -706,5 +701,14 @@ function FILTER_REHASH_ADMINS_PASSWORD ($data) {
        return $data;
 }
 
+// ---------------------------------------------------------------------------
+//                             Wrapper functions
+// ---------------------------------------------------------------------------
+
+// Wrapper function to check wether expert setting warning is enabled
+function isAdminsExpertWarningEnabled () {
+       return (getAminsExpertWarning() == 'Y');
+}
+
 // [EOF]
 ?>