Renamed ifSqlHasZeroNums() to ifSqlHasZeroNumRows() and improved some queries.
[mailer.git] / inc / modules / admin / overview-inc.php
index 13a66c7..d356c2b 100644 (file)
@@ -16,7 +16,7 @@
  * $Author::                                                          $ *
  * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
- * Copyright (c) 2009 - 2012 by Mailer Developer Team                   *
+ * Copyright (c) 2009 - 2015 by Mailer Developer Team                   *
  * For more information visit: http://mxchange.org                      *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
@@ -43,7 +43,7 @@ if ((!defined('__SECURITY')) || (!isAdmin())) {
 // @TODO This function does also check for uncompleted tasks
 function outputStandardOverview (&$result_tasks) {
        // First check for solved and not assigned tasks and assign them to current admin
-       SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_task_system` SET `assigned_admin`=%s WHERE `assigned_admin` IS NULL AND status != 'NEW'",
+       sqlQueryEscaped("UPDATE `{?_MYSQL_PREFIX?}_task_system` SET `assigned_admin`=%s WHERE `assigned_admin` IS NULL AND status != 'NEW'",
                array(getCurrentAdminId()), __FILE__, __LINE__);
 
        // We currently don't want to install an extension so let's find out if we need...
@@ -102,7 +102,7 @@ function outputStandardOverview (&$result_tasks) {
        } // END - foreach
 
        // At last - but not least - check for own and new unassigned tasks...
-       $result_tasks = SQL_QUERY_ESC("SELECT
+       $result_tasks = sqlQueryEscaped("SELECT
        `id`,
        `assigned_admin`,
        `userid`,
@@ -121,13 +121,13 @@ ORDER BY
        `task_created` DESC",
                array(getCurrentAdminId()), __FILE__, __LINE__);
 
-       if (!SQL_HASZERONUMS($result_tasks)) {
+       if (!ifSqlHasZeroNumRows($result_tasks)) {
                // New jobs found
                $jobsDone = FALSE;
        } // END - if
 
        // Free the result
-       SQL_FREERESULT($result);
+       sqlFreeResult($result);
 
        // Return status
        return $jobsDone;
@@ -139,7 +139,7 @@ function outputSeletectedTasks ($postData, $result_tasks) {
                // Assign / do tasks
                $OUT = '';
                foreach ($postData['sel'] as $taskId => $sel) {
-                       $result_task = SQL_QUERY_ESC("SELECT
+                       $result_task = sqlQueryEscaped("SELECT
        `id`,
        `userid`,
        `task_type`,
@@ -159,13 +159,13 @@ LIMIT 1",
                                ), __FILE__, __LINE__);
 
                        // Task is found?
-                       if (SQL_NUMROWS($result_task) == 1) {
+                       if (sqlNumRows($result_task) == 1) {
                                // Task is valid so load it's data
-                               $taskData = SQL_FETCHARRAY($result_task);
+                               $taskData = sqlFetchArray($result_task);
 
                                if ($taskData['assigned_admin'] == '0') {
                                        // Assgin current admin to unassgigned task
-                                       SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_task_system` SET `assigned_admin`=%s WHERE `id`=%s AND `assigned_admin` IS NULL LIMIT 1",
+                                       sqlQueryEscaped("UPDATE `{?_MYSQL_PREFIX?}_task_system` SET `assigned_admin`=%s WHERE `id`=%s AND `assigned_admin` IS NULL LIMIT 1",
                                                array(
                                                        getCurrentAdminId(),
                                                        bigintval($taskData['id'])
@@ -181,14 +181,14 @@ LIMIT 1",
                                } // END - if
 
                                // Is a userid assign?
-                               if ($taskData['userid'] > 0) {
+                               if (isValidId($taskData['userid'])) {
                                        // Then load his data!
                                        if (fetchUserData($taskData['userid'])) {
                                                // Fetch row
                                                $content = getUserDataArray();
 
                                                // Generate HTML list entry
-                                               $add = '<li>{--ADMIN_MEMBER_USERID--}: <strong>' . generateUserProfileLink($taskData['userid'], 'user_data') . ' (<a href="' . generateEmailLink($content['email'], 'user_data') . '">{%pipe,translateGender=' . $content['gender'] . '%} ' . $content['surname'] . ' ' . $content['family'] . '</a>)</strong></li>';
+                                               $add = '<li>{--ADMIN_ASSIGNED_USERID--}: <strong>' . generateUserProfileLink($taskData['userid'], 'user_data') . ' (<a href="' . generateEmailLink($content['email'], 'user_data') . '">{%pipe,translateGender=' . $content['gender'] . '%} ' . $content['surname'] . ' ' . $content['family'] . '</a>)</strong></li>';
                                        } else {
                                                // Invalid userid, so log and zero it
                                                logDebugMessage(__FUNCTION__, __LINE__, 'fetchUserData() failed: userid=' . $taskData['userid'] . ' not found.');
@@ -203,75 +203,70 @@ LIMIT 1",
                                $taskData['text'] = loadTemplate('admin_extensions_text', TRUE, $taskData['text']);
 
                                // Initialize variables (no title for SQL commands by default)
-                               $ext_name = ''; $ext_ver = '';
-                               $title = '{--ADMIN_TASK_NO_SQL_TITLE--}';
-
-                               // Shall I list SQL commands assigned to an extension installation or update task?
-                               if ((isVerboseSqlEnabled()) || (!isExtensionInstalled('sql_patches'))) {
-                                       // Extract extension name from subject
-                                       $ext_name = substr($taskData['subject'], 1, strpos($taskData['subject'], ':') - 1);
-
-                                       // Update task or extension task?
-                                       if (($taskData['task_type'] == 'EXTENSION') && (!isExtensionInstalled($ext_name))) {
-                                               // Load SQL commands for registering in dry-run
-                                               registerExtension($ext_name, $taskId, TRUE);
-
-                                               // Is this non-productive?
-                                               if (isExtensionProductive() === FALSE) {
-                                                       // Issue warning
-                                                       $taskData['text'] = displayMessage('{%message,ADMIN_EXTENSION_IS_NON_PRODUCTIVE=' . $ext_name . '%}', TRUE) . $taskData['text'];
-                                               } // END - if
-
-                                               // Set current extension name
-                                               setCurrentExtensionName($ext_name);
+                               $ext_ver  = '';
+                               $ext_name = '';
+                               $title    = '{--ADMIN_TASK_NO_SQL_TITLE--}';
 
-                                               // Add notes to text
-                                               $taskData['text'] .= getExtensionNotes();
+                               // Extract extension name from subject (for testing)
+                               $ext_name = substr($taskData['subject'], 1, strpos($taskData['subject'], ':') - 1);
 
-                                               // Set title
-                                               $title = '{--ADMIN_SQLS_EXECUTED_ON_REGISTER--}';
-                                       } elseif ($taskData['task_type'] == 'EXTENSION_UPDATE') {
-                                               // Prepare extension name and version
-                                               $ext_name = substr($ext_name, 7);
-                                               $ext_name = substr($ext_name, 0, strpos($ext_name, '-'));
-                                               $test = '[UPDATE-' . $ext_name . '-';
-                                               $ext_ver = substr($taskData['subject'], strlen($test));
-                                               $ext_ver = substr($ext_ver, 0, strpos($ext_ver, ':'));
+                               // Update task or extension task?
+                               if (($taskData['task_type'] == 'EXTENSION') && (!isExtensionInstalled($ext_name))) {
+                                       // Load SQL commands for registering in dry-run
+                                       registerExtension($ext_name, $taskId, TRUE);
 
-                                               // Load SQLs from file
-                                               updateExtension($ext_name, $ext_ver, TRUE);
+                                       // Get current extension's version
+                                       $ext_ver = getCurrentExtensionVersion();
 
-                                               // Set current extension name
-                                               setCurrentExtensionName($ext_name);
+                                       // Is this non-productive?
+                                       if (isExtensionProductive() === FALSE) {
+                                               // Issue warning
+                                               $taskData['text'] = returnMessage('{%message,ADMIN_EXTENSION_IS_NON_PRODUCTIVE=' . $ext_name . '%}') . $taskData['text'];
+                                       } // END - if
 
-                                               // Add notes to text
-                                               $taskData['text'] .= getExtensionNotes();
+                                       // Set current extension name
+                                       setCurrentExtensionName($ext_name);
 
-                                               // Set title
-                                               $title = '{--ADMIN_SQLS_EXECUTED_ON_UPDATE--}';
-                                       } else {
-                                               // Remove extension's name
-                                               $ext_name = '';
-                                       }
+                                       // Add notes to text
+                                       $taskData['text'] .= getExtensionNotes();
 
-                                       // Add SQLs to a table
-                                       if ((!empty($ext_name)) && (isVerboseSqlEnabled())) {
-                                               // Add verbose SQL table
-                                               $taskData['text'] .= addExtensionVerboseSqlTable($title);
-                                       } // END - if
-                               } elseif ((!empty($ext_name)) && (!empty($ext_ver))) {
-                                       // Run SQL commands in dry mode but only return the notes
+                                       // Set title
+                                       $title = '{--ADMIN_SQLS_EXECUTED_ON_REGISTER--}';
+                               } elseif ($taskData['task_type'] == 'EXTENSION_UPDATE') {
+                                       // Prepare extension name and version
+                                       $ext_name = substr($ext_name, 7);
+                                       $ext_name = substr($ext_name, 0, strpos($ext_name, '-'));
+                                       $test = '[UPDATE-' . $ext_name . '-';
+                                       $ext_ver = substr($taskData['subject'], strlen($test));
+                                       $ext_ver = substr($ext_ver, 0, strpos($ext_ver, ':'));
+
+                                       // Load SQLs from file
                                        updateExtension($ext_name, $ext_ver, TRUE);
 
                                        // Set current extension name
                                        setCurrentExtensionName($ext_name);
 
-                                       // Get notes
+                                       // Add notes to text
                                        $taskData['text'] .= getExtensionNotes();
+
+                                       // Set title
+                                       $title = '{--ADMIN_SQLS_EXECUTED_ON_UPDATE--}';
                                } else {
+                                       // Remove extension's name
+                                       $ext_name = '';
+                               }
+
+                               // Add SQLs to a table
+                               if ((!empty($ext_name)) && (isVerboseSqlEnabled())) {
+                                       // Add verbose SQL table
+                                       $taskData['text'] .= addExtensionVerboseSqlTable($title);
+                               } // END - if
+
+                               // Version+extension name must be set
+                               if (((!empty($ext_name)) && (empty($ext_ver))) || ((empty($ext_name)) && (!empty($ext_ver)))) {
                                        // This should not normally happen!
                                        reportBug(__FILE__, __LINE__, 'ext_name(' . $ext_name . ') or ext_ver(' . $ext_ver . ') is empty! isVerboseSqlEnabled=' . intval(isVerboseSqlEnabled()));
-                               }
+                               } // END - if
 
                                // Prepare array for the template
                                $content = array(
@@ -279,7 +274,8 @@ LIMIT 1",
                                        'add'          => $add,
                                        'text'         => $taskData['text'],
                                        'task_created' => generateDateTime($taskData['task_created'], '1'),
-                                       'ext_name'     => $ext_name
+                                       'ext_name'     => $ext_name,
+                                       'ext_version'  => $ext_ver
                                );
 
                                // Load template
@@ -323,7 +319,7 @@ LIMIT 1",
                                                // @TODO This may also be rewritten to include files
                                                switch ($mode) {
                                                        default: // @TODO Unknown support mode
-                                                       logDebugMessage(__FILE__, __LINE__, sprintf("Unknown support mode %s detected. This part is under construction.", $mode));
+                                                       logDebugMessage(__FILE__, __LINE__, sprintf('Unknown support mode %s detected. This part is under construction.', $mode));
                                                        $OUT .= '<div class="notice medium">{%message,ADMIN_UNKNOWN_SUPPORT_MODE=' . $mode . '%}</div>';
                                                        break;
                                                } // END - switch
@@ -332,12 +328,12 @@ LIMIT 1",
                                        case 'PAYOUT_REQUEST': // Payout requests
                                                if (isExtensionActive('payout')) {
                                                        // Extension is installed so let him send a notification to the user
-                                                       $result_pay = SQL_QUERY_ESC("SELECT `id` FROM `{?_MYSQL_PREFIX?}_user_payouts` WHERE `userid`=%s AND `payout_timestamp`=%s LIMIT 1",
+                                                       $result_pay = sqlQueryEscaped("SELECT `id` FROM `{?_MYSQL_PREFIX?}_user_payouts` WHERE `userid`=%s AND `payout_timestamp`=%s LIMIT 1",
                                                                array(bigintval($taskData['userid']), bigintval($taskData['task_created'])), __FILE__, __LINE__);
-                                                       list($pid) = SQL_FETCHROW($result_pay);
-                                                       SQL_FREERESULT($result_pay);
+                                                       list($pid) = sqlFetchRow($result_pay);
+                                                       sqlFreeResult($result_pay);
 
-                                                       if ((!empty($pid)) && ($pid > 0)) {
+                                                       if (isValidId($pid)) {
                                                                // Payout id can be obtained
                                                                $content = array(
                                                                        'pid' => $pid,
@@ -359,12 +355,12 @@ LIMIT 1",
                                        case 'WERNIS_REQUEST': // Wernis requests
                                                if (isExtensionActive('wernis')) {
                                                        // Extension is installed so let him send a notification to the user
-                                                       $result_pay = SQL_QUERY_ESC("SELECT `id` FROM `{?_MYSQL_PREFIX?}_user_wernis` WHERE `userid`=%s AND wernis_timestamp=%s LIMIT 1",
+                                                       $result_pay = sqlQueryEscaped("SELECT `id` FROM `{?_MYSQL_PREFIX?}_user_wernis` WHERE `userid`=%s AND wernis_timestamp=%s LIMIT 1",
                                                                array(bigintval($taskData['userid']), bigintval($taskData['task_created'])), __FILE__, __LINE__);
-                                                       list($pid) = SQL_FETCHROW($result_pay);
-                                                       SQL_FREERESULT($result_pay);
+                                                       list($pid) = sqlFetchRow($result_pay);
+                                                       sqlFreeResult($result_pay);
 
-                                                       if ((!empty($pid)) && ($pid > 0)) {
+                                                       if (isValidId($pid)) {
                                                                // Payout id can be obtained
                                                                $content = array(
                                                                        'pid' => $pid,
@@ -390,7 +386,7 @@ LIMIT 1",
                                                break;
 
                                        default: // Unknown task type
-                                               logDebugMessage(__FILE__, __LINE__, sprintf("Unknown task type %s detected.", $taskData['task_type']));
+                                               logDebugMessage(__FILE__, __LINE__, sprintf('Unknown task type %s detected.', $taskData['task_type']));
                                                $OUT .= '<div class="notice medium">' . sprintf(getMessage('ADMIN_UNKNOWN_TASK_TYPE'), $taskData['task_type'], $taskId) . '</div>';
                                                break;
                                }
@@ -400,7 +396,7 @@ LIMIT 1",
                        } // END - if
 
                        // Free result
-                       SQL_FREERESULT($result_task);
+                       sqlFreeResult($result_task);
                } // END - foreach
 
                // Load final template
@@ -411,28 +407,28 @@ LIMIT 1",
                        if (!empty($postData['unassign'])) {
                                // Unassign from tasks
                                foreach ($postData['sel'] as $taskId => $sel) {
-                                       SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_task_system` SET `assigned_admin`=NULL WHERE `id`=%s AND `assigned_admin`=%s LIMIT 1",
+                                       sqlQueryEscaped("UPDATE `{?_MYSQL_PREFIX?}_task_system` SET `assigned_admin`=NULL WHERE `id`=%s AND `assigned_admin`=%s LIMIT 1",
                                                array(bigintval($taskId), getCurrentAdminId()), __FILE__, __LINE__);
                                } // END - foreach
                        } elseif (!empty($postData['delete'])) {
                                // Delete tasks
                                foreach ($postData['sel'] as $taskId => $sel) {
-                                       SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `id`=%s AND `assigned_admin` IN (%s,0,NULL) LIMIT 1",
+                                       sqlQueryEscaped("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `id`=%s AND `assigned_admin` IN (%s,0,NULL) LIMIT 1",
                                                array(bigintval($taskId), getCurrentAdminId()), __FILE__, __LINE__);
                                } // END - foreach
                        } else {
                                // Unknown action
-                               reportBug(__FILE__, __LINE__, sprintf("Unknown task action performed. data=<pre>%s</pre>", print_r($postData, TRUE)));
+                               reportBug(__FILE__, __LINE__, sprintf('Unknown task action performed. data=<pre>%s</pre>', print_r($postData, TRUE)));
                        }
 
                        // Update query
-                       $result_tasks = SQL_QUERY_ESC("SELECT `id`, `assigned_admin`, `userid`, `task_type`, `subject`, `text`, `task_created` FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `assigned_admin`=%s OR ((`assigned_admin`=0 OR `assigned_admin` IS NULL) AND `status`='NEW') ORDER BY `task_created` DESC",
+                       $result_tasks = sqlQueryEscaped("SELECT `id`, `assigned_admin`, `userid`, `task_type`, `subject`, `text`, `task_created` FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `assigned_admin`=%s OR ((`assigned_admin`=0 OR `assigned_admin` IS NULL) AND `status`='NEW') ORDER BY `task_created` DESC",
                                array(getCurrentAdminId()), __FILE__, __LINE__);
                } // END - if
 
                // There are uncompleted jobs!
                $OUT = '';
-               while ($content = SQL_FETCHARRAY($result_tasks)) {
+               while ($content = sqlFetchArray($result_tasks)) {
                        // Init infos
                        $content['infos'] = '';
 
@@ -445,9 +441,9 @@ LIMIT 1",
                                        break;
                        } // END - switch
 
-                       if (isValidUserId($content['userid'])) {
+                       if (isValidId($content['userid'])) {
                                // Member found otherwise it's a system task
-                               $content['userid'] = generateUserProfileLink($content['userid']);
+                               $content['userid'] = '{%pipe,generateUserProfileLink=' . $content['userid'] . '%}';
                        } else {
                                $content['userid'] = '{--ADMIN_IS_SYSTEM_TASK--}';
                        }
@@ -466,7 +462,7 @@ LIMIT 1",
                } // END - while
 
                // Free memory
-               SQL_FREERESULT($result_tasks);
+               sqlFreeResult($result_tasks);
 
                // Load footer template
                loadTemplate('admin_overview_table', FALSE, $OUT);