2 /************************************************************************
3 * Mailer v0.2.1-FINAL Start: 06/30/2003 *
4 * =================== Last change: 11/27/2004 *
6 * -------------------------------------------------------------------- *
7 * File : admins_functions.php *
8 * -------------------------------------------------------------------- *
9 * Short description : Functions for the admins extension *
10 * -------------------------------------------------------------------- *
11 * Kurzbeschreibung : Funktionen fuer die admins-Erweiterung *
12 * -------------------------------------------------------------------- *
15 * $Tag:: 0.2.1-FINAL $ *
17 * -------------------------------------------------------------------- *
18 * Copyright (c) 2003 - 2009 by Roland Haeder *
19 * Copyright (c) 2009 - 2011 by Mailer Developer Team *
20 * For more information visit: http://mxchange.org *
22 * This program is free software; you can redistribute it and/or modify *
23 * it under the terms of the GNU General Public License as published by *
24 * the Free Software Foundation; either version 2 of the License, or *
25 * (at your option) any later version. *
27 * This program is distributed in the hope that it will be useful, *
28 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
29 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
30 * GNU General Public License for more details. *
32 * You should have received a copy of the GNU General Public License *
33 * along with this program; if not, write to the Free Software *
34 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
36 ************************************************************************/
38 // Some security stuff...
39 if (!defined('__SECURITY')) {
43 // Check ACL for menu combination
44 function isAdminsAllowedByAcl ($action, $what) {
46 $adminId = getCurrentAdminId();
48 if (($action == 'login') || ($action == 'logout')) {
49 // If action is login or logout allow allways!
51 } elseif (isset($GLOBALS[__FUNCTION__][$adminId][$action][$what])) {
52 // If we have cache, use it
53 return $GLOBALS[__FUNCTION__][$adminId][$action][$what];
56 // But default result is failed
57 $GLOBALS[__FUNCTION__][$action][$what] = false;
59 // Get admin's defult access right
60 $default = getAdminDefaultAcl($adminId);
63 // Check for parent menu:
64 // First get it's action value
65 $parent_action = getActionFromModuleWhat('admin', $what);
67 // Check with this function...
68 $parent = isAdminsAllowedByAcl($parent_action, '');
70 // Anything else is true!
74 // Shall I test for a main or sub menu? (action or what?)
76 if ((isExtensionInstalledAndNewer('cache', '0.1.2')) && (isset($GLOBALS['cache_array']['admin_acls'])) && (count($GLOBALS['cache_array']['admin_acls']) > 0)) {
78 if ((!empty($action)) && (isset($GLOBALS['cache_array']['admin_acls']['action_menu'][$adminId])) & (in_array($action, $GLOBALS['cache_array']['admin_acls']['action_menu'][$adminId]))) {
80 $key = array_search($action, $GLOBALS['cache_array']['admin_acls']['action_menu'][$adminId]);
82 // Main menu line found
83 $aclMode = $GLOBALS['cache_array']['admin_acls']['access_mode'][$adminId][$key];
86 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'action=' . $action . ',key=' . $key . ',acl_mode=' . $aclMode);
89 incrementStatsEntry('cache_hits');
90 } elseif ((!empty($what)) && (isset($GLOBALS['cache_array']['admin_acls']['what_menu'][$adminId])) && (in_array($what, $GLOBALS['cache_array']['admin_acls']['what_menu'][$adminId]))) {
92 $key = array_search($action, $GLOBALS['cache_array']['admin_acls']['what_menu'][$adminId]);
95 $aclMode = $GLOBALS['cache_array']['admin_acls']['access_mode'][$adminId][$key];
98 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'what=' . $what . ',key=' . $key . ',acl_mode=' . $aclMode);
101 incrementStatsEntry('cache_hits');
103 } elseif (!isExtensionActive('cache')) {
104 // Extension ext-cache is absent, so load it from database
106 if (!empty($action)) {
108 $result = SQL_QUERY_ESC("SELECT `access_mode` FROM `{?_MYSQL_PREFIX?}_admins_acls` WHERE `admin_id`=%s AND `action_menu`='%s' LIMIT 1",
109 array(bigintval($adminId), $action), __FUNCTION__, __LINE__);
110 } elseif (!empty($what)) {
112 $result = SQL_QUERY_ESC("SELECT `access_mode` FROM `{?_MYSQL_PREFIX?}_admins_acls` WHERE `admin_id`=%s AND `what_menu`='%s' LIMIT 1",
113 array(bigintval($adminId), $what), __FUNCTION__, __LINE__);
116 // Is an entry found?
117 if (SQL_NUMROWS($result) == 1) {
119 list($aclMode) = SQL_FETCHROW($result);
123 SQL_FREERESULT($result);
126 // Check ACL and (maybe) allow
127 //* DEBUG: */ debugOutput('default='.$default.',acl_mode='.$aclMode.',parent='.intval($parent));
128 if ((($default == 'allow') && ($aclMode != 'deny')) || (($default == 'deny') && ($aclMode == 'allow')) || ($parent === true) || (($default == 'NO-ACL') && ($aclMode == 'failed') && ($parent === false))) {
130 $GLOBALS[__FUNCTION__][$adminId][$action][$what] = true;
134 //* DEBUG: */ debugOutput(__FUNCTION__.'['.__LINE__.']:act='.$action.',wht='.$what.',default='.$default.',aclMode='.$aclMode);
135 return $GLOBALS[__FUNCTION__][$adminId][$action][$what];
138 // Create email link to admins's account
139 function generateAdminEmailLink ($email, $mod = 'admin') {
141 if (isInString('@', $email)) {
143 $result = SQL_QUERY_ESC("SELECT `id`
145 `{?_MYSQL_PREFIX?}_admins`
149 array($email), __FUNCTION__, __LINE__);
151 // Is there an entry?
152 if (SQL_NUMROWS($result) == 1) {
154 list($adminId) = SQL_FETCHROW($result);
156 // Call this function again
157 $email = generateAdminEmailLink($adminId, $mod);
161 SQL_FREERESULT($result);
162 } elseif (isValidUserId($email)) {
164 $email = '{%url=modules.php?module=' . $mod . '&what=admins_contct&id=' . bigintval($email) . '%}';
166 // This is strange and needs fixing
167 debug_report_bug(__FUNCTION__, __LINE__, 'email[' . gettype($email) . ']=' . $email . ',mod=' . $mod . ' - This should not happen.');
170 // Return rewritten (?) email address
174 // Change a lot admin account
175 function adminsChangeAdminAccount ($postData, $element = '', $displayMessage = true) {
180 foreach ($postData['login'] as $id => $login) {
182 $id = bigintval($id);
183 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'id=' . $id . ',login=' . $login);
185 // When both passwords match update admin account
186 if ((!empty($element)) && (isset($postData[$element]))) {
188 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_admins` SET `%s`='%s' WHERE `id`=%s LIMIT 1",
189 array($element, $postData[$element][$id], $id), __FUNCTION__, __LINE__);
191 // Admin account saved
192 $message = '{--ADMIN_ACCOUNT_SAVED--}';
193 } elseif ((!empty($postData['pass1'])) && (!empty($postData['pass2']))) {
194 // Update only if both passwords match
195 if (($postData['pass1'][$id] == $postData['pass2'][$id])) {
196 // Save only when both passwords are the same (also when they are empty)
197 $add = ''; $cache_update = 1;
200 $hash = generateHash($postData['pass1'][$id]);
202 // Save password when set
203 if (!empty($postData['pass1'][$id])) {
204 $add = sprintf(", `password`='%s'", SQL_ESCAPE($hash));
208 $adminId = getCurrentAdminId();
209 $salt = substr(getAdminHash(getAdminLogin($adminId)), 0, -40);
211 // Rewrite cookie when it's own account
212 if ($adminId == $id) {
213 // Set timeout cookie
214 setAdminLast(time());
216 if ($adminId != getCurrentAdminId()) {
217 // Update login cookie
218 setAdminId($adminId);
220 // Update password cookie as well?
224 } elseif (generateHash($postData['pass1'][$id], $salt) != getAdminMd5()) {
225 // Update password cookie
230 // Get default ACL from admin to check if we can allow him to change the default ACL
231 $default = getAdminDefaultAcl(getCurrentAdminId());
233 // Update admin account
234 if ($default == 'allow') {
235 // Allow changing default ACL
236 SQL_QUERY_ESC("UPDATE
237 `{?_MYSQL_PREFIX?}_admins`
239 `login`='%s'" . $add . ",
248 $postData['email'][$id],
249 $postData['mode'][$id],
250 $postData['la_mode'][$id],
252 ), __FUNCTION__, __LINE__);
254 // Do not allow it here
255 SQL_QUERY_ESC("UPDATE
256 `{?_MYSQL_PREFIX?}_admins`
258 `login`='%s'" . $add . ",
266 $postData['email'][$id],
267 $postData['la_mode'][$id],
269 ), __FUNCTION__, __LINE__);
272 // Admin account saved
273 $message = '{--ADMIN_ACCOUNT_SAVED--}';
275 // Passwords did not match
276 $message = '{--ADMIN_ADMINS_ERROR_PASS_MISMATCH--}';
279 // Update whole array
280 $SQL = 'UPDATE `{?_MYSQL_PREFIX?}_admins` SET ';
281 foreach ($postData as $entry => $value) {
282 // Skip login/id entry
283 if (in_array($entry, array('login', 'id'))) {
287 // Do we have a non-string (e.g. number, NULL, NOW() or back-tick at the beginning?
288 if (is_null($value[$id])) {
290 $SQL .= '`' . $entry . '`=NULL, ';
291 } elseif ((bigintval($value[$id], true, false) === $value[$id]) || ($value[$id] == 'NOW()') || (substr($value[$id], 0, 1) == '`')) {
292 // No need for ticks (')
293 $SQL .= '`' . $entry . '`=' . $value[$id] . ', ';
295 // Strings need ticks (') around them
296 $SQL .= '`' . $entry . "`='" . SQL_ESCAPE($value[$id]) . "', ";
300 // Remove last 2 chars and finish query
301 $SQL = substr($SQL, 0, -2) . ' WHERE `id`=%s LIMIT 1';
304 SQL_QUERY_ESC($SQL, array(bigintval($id)), __FUNCTION__, __LINE__);
307 if (SQL_AFFECTEDROWS() == 1) {
308 // Admin account saved
309 $message = '{--ADMIN_ACCOUNT_SAVED--}';
311 // Passwords did not match
312 $message = '{--ADMIN_ADMINS_ERROR_PASS_MISMATCH--}';
318 if (!empty($message)) {
319 if ($displayMessage === true) {
320 displayMessage($message);
325 runFilterChain('post_form_submited', postRequestArray());
331 // Make admin accounts editable
332 function adminsEditAdminAccount ($postData) {
333 // "Resolve" current's admin access mode
334 $currMode = getAdminDefaultAcl(getCurrentAdminId());
336 // Begin the edit loop
338 foreach ($postData['sel'] as $id => $selected) {
340 $id = bigintval($id);
342 // Get the admin's data
343 $result = SQL_QUERY_ESC("SELECT `login`,`email` FROM `{?_MYSQL_PREFIX?}_admins` WHERE `id`=%s LIMIT 1",
344 array($id), __FUNCTION__, __LINE__);
345 if ((SQL_NUMROWS($result) == 1) && ($selected == 1)) {
347 $content = SQL_FETCHARRAY($result);
349 // Prepare some more data for the template
350 $content['id'] = $id;
352 // Shall we allow changing default ACL?
353 if ($currMode == 'allow') {
355 $content['mode'] = '{%pipe,generateAdminAccessModeSelectionBox=' . $id . '%}';
358 $content['mode'] = ' ';
361 // Load row template and switch color
362 $OUT .= loadTemplate('admin_edit_admins_row', true, $content);
366 SQL_FREERESULT($result);
370 loadTemplate('admin_edit_admins', false, $OUT);
373 // Generate access mode selection box for given admin id
374 function generateAdminAccessModeSelectionBox ($adminId = NULL) {
375 // Start the selection box
376 $OUT = '<select name="mode[' . $adminId . ']" size="1" class="form_select">';
379 $OUT .= generateOptionList('/ARRAY/', array('allow', 'deny'), array('{--ADMIN_ADMINS_ACCESS_MODE_ALLOW--}', '{--ADMIN_ADMINS_ACCESS_MODE_DENY--}'), getAdminDefaultAcl($adminId));
388 // Generate menu mode selection box for given admin it
389 function generateAdminMenuModeSelectionBox ($adminId = NULL) {
390 // Start the selection box
391 $OUT = '<select name="la_mode[{%pipe,makeNullToZero=' . makeZeroToNull($adminId) . '%}]" size="1" class="form_select">';
394 $OUT .= generateOptionList('/ARRAY/', array('global', 'OLD', 'NEW'), array('{--ADMIN_ADMINS_LA_MODE_GLOBAL--}', '{--ADMIN_ADMINS_LA_MODE_OLD--}', '{--ADMIN_ADMINS_LA_MODE_NEW--}'), getAdminMenuMode($adminId));
403 // Delete given admin accounts
404 function adminsDeleteAdminAccount ($postData) {
405 // Check if this account is the last one which cannot be deleted...
406 if (countSumTotalData('', 'admins', 'id', '', true) > 1) {
409 foreach ($postData['sel'] as $id => $selected) {
411 $id = bigintval($id);
413 // Get the admin's data
414 $result = SQL_QUERY_ESC("SELECT `login`,`email`,`default_acl` AS `mode`,`la_mode` FROM `{?_MYSQL_PREFIX?}_admins` WHERE `id`=%s LIMIT 1",
415 array($id), __FUNCTION__, __LINE__);
417 // Do we have an entry?
418 if (SQL_NUMROWS($result) == 1) {
419 // Entry found, so load data
420 $content = SQL_FETCHARRAY($result);
421 $content['mode'] = '{--ADMIN_ADMINS_ACCESS_MODE_' . strtoupper($content['mode']) . '--}';
422 $content['la_mode'] = '{--ADMIN_ADMINS_LA_MODE_' . strtoupper($content['la_mode']) . '--}';
424 // Prepare some more data
425 $content['id'] = $id;
427 // Load row template and switch color
428 $OUT .= loadTemplate('admin_delete_admins_row', true, $content);
432 SQL_FREERESULT($result);
436 loadTemplate('admin_delete_admins', false, $OUT);
438 // Cannot delete last account!
439 displayMessage('{--ADMIN_ADMINS_CANNOT_DELETE_LAST--}');
443 // Remove the given accounts
444 function adminsRemoveAdminAccount ($postData) {
447 foreach ($postData['sel'] as $id => $del) {
449 $id = bigintval($id);
451 // Delete only when it's not your own account!
452 if (($del == 1) && (getCurrentAdminId() != $id)) {
453 // Rewrite his tasks to all admins
454 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_task_system` SET `assigned_admin`=NULL WHERE `assigned_admin`=%s",
455 array($id), __FUNCTION__, __LINE__);
458 SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_admins` WHERE `id`=%s LIMIT 1",
459 array($id), __FUNCTION__, __LINE__);
463 // Remove cache if cache system is activated
464 runFilterChain('post_form_deleted', postRequestArray());
467 // List all admin accounts
468 function adminsListAdminAccounts() {
469 // Select all admin accounts
470 $result = SQL_QUERY('SELECT `id`,`login`,`email`,`default_acl` AS mode, `la_mode` FROM `{?_MYSQL_PREFIX?}_admins` ORDER BY `login` ASC', __FUNCTION__, __LINE__);
472 while ($content = SQL_FETCHARRAY($result)) {
473 // Compile some variables
474 $content['mode'] = '{--ADMIN_ADMINS_ACCESS_MODE_' . strtoupper($content['mode']) . '--}';
475 $content['la_mode'] = '{--ADMIN_ADMINS_LA_MODE_' . strtoupper($content['la_mode']) . '--}';
477 // Load row template and switch color
478 $OUT .= loadTemplate('admin_list_admins_row', true, $content);
482 SQL_FREERESULT($result);
485 loadTemplate('admin_list_admins', false, $OUT);
488 // Sends out mail to all administrators
489 // IMPORTANT: Please use sendAdminNotification() instead of calling this function directly
490 function sendAdminsEmails ($subj, $template, $content, $userid) {
491 // Trim template name
492 $template = trim($template);
494 // Load email template
495 $message = loadEmailTemplate($template, $content, $userid);
497 // Check which admin shall receive this mail
498 $result = SQL_QUERY_ESC("SELECT `admin_id` FROM `{?_MYSQL_PREFIX?}_admins_mails` WHERE `mail_template`='%s' ORDER BY `admin_id` ASC",
499 array($template), __FUNCTION__, __LINE__);
502 if (SQL_HASZERONUMS($result)) {
503 // Create new entry (to all admins)
504 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_admins_mails` (`admin_id`,`mail_template`) VALUES (0, '%s')",
505 array($template), __FUNCTION__, __LINE__);
508 // @TODO This can be, somehow, rewritten
510 while ($content = SQL_FETCHARRAY($result)) {
511 $adminIds[] = $content['admin_id'];
515 SQL_FREERESULT($result);
520 // "implode" ids and query string
521 $adminId = implode(',', $adminIds);
522 if ($adminId == '-1') {
523 if (isExtensionActive('events')) {
524 // Add line to user events
525 EVENTS_ADD_LINE($subj, $message, $userid);
527 // Log error for debug
528 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Extension 'events' missing: tpl=%s,subj=%s,userid=%s",
534 } elseif (($adminId == '0') || (empty($adminId))) {
535 // Select all email adresses
536 $result = SQL_QUERY('SELECT `email` FROM `{?_MYSQL_PREFIX?}_admins` ORDER BY `id` ASC',
537 __FUNCTION__, __LINE__);
539 // If Admin-Id is not "to-all" select
540 $result = SQL_QUERY_ESC("SELECT `email` FROM `{?_MYSQL_PREFIX?}_admins` WHERE `id` IN (%s) ORDER BY `id` ASC",
541 array($adminId), __FUNCTION__, __LINE__);
545 // Load email addresses and send away
546 while ($content = SQL_FETCHARRAY($result)) {
547 sendEmail($content['email'], $subj, $message);
551 SQL_FREERESULT($result);
554 // "Getter" for current admin's expert settings
555 function getAminsExpertSettings () {
556 // Default is has not the right
557 $data['expert_settings'] = 'N';
559 // Get current admin Id
560 $adminId = getCurrentAdminId();
562 // Lookup settings in cache
563 if (isset($GLOBALS['cache_array']['admin']['expert_settings'][$adminId])) {
565 $data['expert_settings'] = $GLOBALS['cache_array']['admin']['expert_settings'][$adminId];
568 incrementStatsEntry('cache_hits');
569 } elseif (!isExtensionInstalled('cache')) {
570 // Load from database
571 $result = SQL_QUERY_ESC("SELECT `expert_settings` FROM `{?_MYSQL_PREFIX?}_admins` WHERE `id`=%s LIMIT 1",
572 array($adminId), __FUNCTION__, __LINE__);
575 if (SQL_NUMROWS($result) == 1) {
577 $data = SQL_FETCHARRAY($result);
580 $GLOBALS['cache_array']['admin']['expert_settings'][$adminId] = $data['expert_settings'];
584 SQL_FREERESULT($result);
588 return $data['expert_settings'];
591 // "Getter" for current admin's expert warning (if he wants to see them or not
592 function getAminsExpertWarning () {
593 // Default is has not the right
594 $data['expert_warning'] = 'N';
596 // Get current admin id
597 $adminId = getCurrentAdminId();
599 // Lookup warning in cache
600 if (isset($GLOBALS['cache_array']['admin']['expert_warning'][$adminId])) {
602 $data['expert_warning'] = $GLOBALS['cache_array']['admin']['expert_warning'][$adminId];
605 incrementStatsEntry('cache_hits');
606 } elseif (!isExtensionInstalled('cache')) {
607 // Load from database
608 $result = SQL_QUERY_ESC("SELECT `expert_warning` FROM `{?_MYSQL_PREFIX?}_admins` WHERE `id`=%s LIMIT 1",
609 array($adminId), __FUNCTION__, __LINE__);
612 if (SQL_NUMROWS($result) == 1) {
614 $data = SQL_FETCHARRAY($result);
617 $GLOBALS['cache_array']['admin']['expert_warning'][$adminId] = $data['expert_warning'];
621 SQL_FREERESULT($result);
625 return $data['expert_warning'];
628 // Get login_failures number from administrator's login name
629 function getAdminLoginFailures ($adminId) {
630 // Admin login should not be empty
631 if (empty($adminId)) {
632 debug_report_bug(__FUNCTION__, __LINE__, 'adminId is empty.');
635 // By default no admin is found
636 $data['login_failures'] = -1;
639 if (isset($GLOBALS['cache_array']['admin']['login_failures'][$adminId])) {
640 // Use it if found to save SQL queries
641 $data['login_failures'] = $GLOBALS['cache_array']['admin']['login_failures'][$adminId];
644 incrementStatsEntry('cache_hits');
645 } elseif (!isExtensionActive('cache')) {
646 // Load from database
647 $result = SQL_QUERY_ESC("SELECT `login_failures` FROM `{?_MYSQL_PREFIX?}_admins` WHERE `id`=%s LIMIT 1",
648 array($adminId), __FUNCTION__, __LINE__);
650 // Do we have an entry?
651 if (SQL_NUMROWS($result) == 1) {
653 $data = SQL_FETCHARRAY($result);
657 SQL_FREERESULT($result);
660 // Return the login_failures
661 return $data['login_failures'];
664 // Get last_failure number from administrator's login name
665 function getAdminLastFailure ($adminId) {
666 // Admin login should not be empty
667 if (empty($adminId)) {
668 debug_report_bug(__FUNCTION__, __LINE__, 'adminId is empty.');
671 // By default no admin is found
672 $data['last_failure'] = -1;
675 if (isset($GLOBALS['cache_array']['admin']['last_failure'][$adminId])) {
676 // Use it if found to save SQL queries
677 $data['last_failure'] = $GLOBALS['cache_array']['admin']['last_failure'][$adminId];
680 incrementStatsEntry('cache_hits');
681 } elseif (!isExtensionActive('cache')) {
682 // Load from database
683 $result = SQL_QUERY_ESC("SELECT UNIX_TIMESTAMP(`last_failure`) AS `last_failure` FROM `{?_MYSQL_PREFIX?}_admins` WHERE `id`=%s LIMIT 1",
684 array($adminId), __FUNCTION__, __LINE__);
686 // Do we have an entry?
687 if (SQL_NUMROWS($result) == 1) {
689 $data = SQL_FETCHARRAY($result);
693 SQL_FREERESULT($result);
696 // Return the last_failure
697 return $data['last_failure'];
700 //-----------------------------------------------------------------------------
702 //-----------------------------------------------------------------------------
704 // Wrapper function to check wether expert setting warning is enabled
705 function isAdminsExpertWarningEnabled () {
706 return (getAminsExpertWarning() == 'Y');