Various fixes to fix bug #226, comment #562, removed extension dependency register...

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

diff --git a/inc/extensions-functions.php b/inc/extensions-functions.php
index 00722ad55fccae68cc0931c7dc683e96b3adbc17..b3e95cdcfaa43337297cb8cd09c9be58978f0cec 100644 (file)
--- a/inc/extensions-functions.php
+++ b/inc/extensions-functions.php
@@ -41,8 +41,8 @@ if (!defined('__SECURITY')) {
 } // END - if
 
 // Load the extension and maybe found language and function files.
-function loadExtension ($ext_name, $ext_mode, $ext_ver = '0.0.0', $dry_run = false) {
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_mode=' . $ext_mode . ',ext_ver=' . $ext_ver . ',dry_run=' . intval($dry_run) . ' - ENTERED!');
+function loadExtension ($ext_name, $ext_mode, $ext_ver = '0.0.0', $isDryRun = false) {
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_mode=' . $ext_mode . ',ext_ver=' . $ext_ver . ',isDryRun=' . intval($isDryRun) . ' - ENTERED!');
        // Loading an extension in same mode, but not test/update, twice is not
        // good, so is the extension $ext_name already loaded in mode $ext_mode?
        if ((isset($GLOBALS['loaded_extension'][$ext_name][$ext_mode])) && (!in_array($ext_mode, array('update', 'test')))) {
@@ -78,12 +78,12 @@ function loadExtension ($ext_name, $ext_mode, $ext_ver = '0.0.0', $dry_run = fal
                // In all but test-mode we need these messages to debug! Please report all (together, e.g.)
                if (($ext_mode != 'test') && (getCurrentExtensionVersion() == '0.0.0')) {
                        // Abort here, this must now always be set!
-                       reportBug(__FUNCTION__, __LINE__, 'Extension version is empty, setting to 0.0. ext_name=' . $ext_name . ', ext_mode=' . $ext_mode . ', dry_run=' . intval($dry_run));
+                       reportBug(__FUNCTION__, __LINE__, 'Extension version is empty, setting to 0.0.0 ext_name=' . $ext_name . ', ext_mode=' . $ext_mode . ', isDryRun=' . intval($isDryRun));
                } // END - if
        }
 
        // Set dry-run
-       enableExtensionDryRun($dry_run);
+       enableExtensionDryRun($isDryRun);
 
        // Init array
        initIncludePool('extension');
@@ -177,13 +177,13 @@ function loadExtension ($ext_name, $ext_mode, $ext_ver = '0.0.0', $dry_run = fal
 }
 
 // Registers an extension and possible update dependencies
-function registerExtension ($ext_name, $taskId, $dry_run = false, $ignoreUpdates = false) {
+function registerExtension ($ext_name, $taskId, $isDryRun = false, $ignoreUpdates = false) {
        // Set current extension name
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',task_id=' . intval($taskId) . ',dry_run=' . intval($dry_run) . ',ignoreUpdates=' . intval($ignoreUpdates) . ' - ENTERED!');
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',taskId=' . intval($taskId) . ',isDryRun=' . intval($isDryRun) . ',ignoreUpdates=' . intval($ignoreUpdates) . ' - ENTERED!');
        setCurrentExtensionName($ext_name);
 
        // Enable dry-run
-       enableExtensionDryRun($dry_run);
+       enableExtensionDryRun($isDryRun);
 
        // By default all extensions are in productive phase
        enableExtensionProductive();
@@ -198,8 +198,8 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $ignoreUpdates
        // When this extension is already in registration/update phase, all is fine
        if ((isExtensionRegistrationRunning($ext_name)) || ((isExtensionUpdateRunning($ext_name)) && ($ignoreUpdates === false))) {
                // Then abort here with 'true' becaus it is fine
-               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - already in registration/update phase, all fine,taskId=' . $taskId . ',dry_run=' . intval($dry_run) . ',ignoreUpdates=' . intval($ignoreUpdates));
-               //* BUG: */ reportBug(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',taskId=' . $taskId . ',dry_run=' . intval($dry_run) . ',ignoreUpdates=' . intval($ignoreUpdates) . ' - Please investigate!');
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - already in registration/update phase, all fine,taskId=' . $taskId . ',isDryRun=' . intval($isDryRun) . ',ignoreUpdates=' . intval($ignoreUpdates));
+               //* BUG: */ reportBug(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',taskId=' . $taskId . ',isDryRun=' . intval($isDryRun) . ',ignoreUpdates=' . intval($ignoreUpdates) . ' - Please investigate!');
                return true;
        } // END - if
 
@@ -213,17 +213,17 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $ignoreUpdates
        } // END - if
 
        // Is the task id zero? Then we need to auto-fix it here
-       if (($taskId == '0') && (!isInstallationPhase())) {
+       if (((is_null($taskId)) || ($taskId == '0')) && (!isInstallationPhase())) {
                // Try to find the task
                $taskId = determineExtensionTaskId(getCurrentExtensionName());
 
                // Still zero and not in dry-run?
-               if (($taskId == '0') && (!isExtensionDryRun())) {
+               if (((is_null($taskId)) || ($taskId == '0')) && (!isExtensionDryRun())) {
                        // Now try to create a new task
                        $taskId = createNewExtensionTask(getCurrentExtensionName());
 
                        // Is it still zero?
-                       if ($taskId == '0') {
+                       if ((is_null($taskId)) || ($taskId == '0')) {
                                // Then request a bug report
                                reportBug(__FUNCTION__, __LINE__, sprintf("%s: task_id is still zero after determineExtensionTaskId(%s)",
                                        __FUNCTION__,
@@ -288,14 +288,14 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $ignoreUpdates
                                //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_ver[' . gettype($ext_ver) . ']=' . $ext_ver . ',isInstallationPhase()=' . intval(isInstallationPhase()) . ',currName=' . getCurrentExtensionName() . ',ext_update=' . $ext_update . ' - EMPTY?');
                                if (empty($ext_ver)) {
                                        // Extension not registered so far so first load task's id...
-                                       $taskId = determineExtensionTaskId($ext_update);
+                                       $updateTaskId = determineExtensionTaskId($ext_update);
 
                                        // Entry found?
-                                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'taskId=' . $taskId . ',isInstallationPhase()=' . intval(isInstallationPhase()) . ',currName=' . getCurrentExtensionName() . ',ext_update=' . $ext_update . ' - CHECKING!');
-                                       if (($taskId > 0) || (isInstallationPhase())) {
+                                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'updateTaskId=' . $updateTaskId . ',isInstallationPhase()=' . intval(isInstallationPhase()) . ',currName=' . getCurrentExtensionName() . ',ext_update=' . $ext_update . ' - CHECKING!');
+                                       if (($updateTaskId > 0) || (isInstallationPhase())) {
                                                // Try to register the extension
-                                               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',ext_update=' . $ext_update . ',taskId=' . $taskId . ',isExtensionDryRun()=' . isExtensionDryRun());
-                                               $processResult = registerExtension($ext_update, $taskId, isExtensionDryRun(), true);
+                                               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',ext_update=' . $ext_update . ',updateTaskId=' . $updateTaskId . ',isExtensionDryRun()=' . intval(isExtensionDryRun()));
+                                               $processResult = registerExtension($ext_update, $updateTaskId, isExtensionDryRun(), true);
 
                                                // Reset extension name
                                                setCurrentExtensionName($ext_name);
@@ -332,6 +332,7 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $ignoreUpdates
                // Is there no update?
                if (countExtensionUpdateDependencies(getCurrentExtensionName()) == 0) {
                        // Then test is passed!
+                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',processResult=true,countExtensionUpdateDependencies()=0 - Test passed!');
                        $processResult = true;
                } // END - if
 
@@ -418,7 +419,7 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $ignoreUpdates
        }
 
        // @TODO This redirect is still needed to register sql_patches! Please try to avoid it
-       if (($ret === true) && ($dry_run === false) && ($ext_name == 'sql_patches') && (!isInstallationPhase())) {
+       if (($ret === true) && ($isDryRun === false) && ($ext_name == 'sql_patches') && (!isInstallationPhase())) {
                /*
                 * This is a really dirty hack to prevent an error about a missing
                 * configuration entry which should be there after registration of
@@ -428,7 +429,7 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $ignoreUpdates
        } // END - if
 
        // Return status code
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',currName=' . getCurrentExtensionName() . ',ext_name=' . $ext_name . ',processResult=' . intval($processResult) . ',ret=' . intval($ret) . ' - EXIT!');
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',currName=' . getCurrentExtensionName() . ',processResult=' . intval($processResult) . ',ret=' . intval($ret) . ' - EXIT!');
        return $ret;
 }
 
@@ -667,9 +668,9 @@ function getExtensionVersion ($ext_name, $force = false) {
 }
 
 // Updates a given extension with current extension version to latest version
-function updateExtension ($ext_name, $ext_ver, $dry_run = false, $ignoreDependencies = false) {
+function updateExtension ($ext_name, $ext_ver, $isDryRun = false, $ignoreDependencies = false) {
        // Only admins are allowed to update extensions
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_ver=' . $ext_ver . ',dry_run=' . intval($dry_run) . ',ignoreDependencies=' . intval($ignoreDependencies) . ' - ENTERED!');
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_ver=' . $ext_ver . ',isDryRun=' . intval($isDryRun) . ',ignoreDependencies=' . intval($ignoreDependencies) . ' - ENTERED!');
        if ((!isAdmin()) || (empty($ext_name))) {
                // Called as non-admin or empty extension
                reportBug(__FUNCTION__, __LINE__, 'Called as non-admin (isAdmin()=' . intval(isAdmin()) . '), or empty extension name. ext_name=' . $ext_name);
@@ -679,7 +680,7 @@ function updateExtension ($ext_name, $ext_ver, $dry_run = false, $ignoreDependen
        setCurrentExtensionName($ext_name);
 
        // Is this extension update already running?
-       if ((isExtensionUpdateRunning($ext_name, $ignoreDependencies)) && ($dry_run === false)) {
+       if ((isExtensionUpdateRunning($ext_name, $ignoreDependencies)) && ($isDryRun === false)) {
                // This is fine but needs logging ATM
                //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - already in update phase, all fine.');
                //* BUG: */ reportBug(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - already in update phase, please investigate!');
@@ -738,7 +739,7 @@ function updateExtension ($ext_name, $ext_ver, $dry_run = false, $ignoreDependen
                                                        $processResult = updateExtension($ext_depend, getExtensionVersion($ext_depend), isExtensionDryRun(), true);
                                                } else {
                                                        // Register new extension
-                                                       $processResult = registerExtension($ext_depend, 0, isExtensionDryRun());
+                                                       $processResult = registerExtension($ext_depend, NULL, isExtensionDryRun());
                                                }
                                        } // END - if
                                } // END - foreach
@@ -775,7 +776,7 @@ function updateExtension ($ext_name, $ext_ver, $dry_run = false, $ignoreDependen
                } // END - if
        } // END - if
 
-       //* DEBUG: */logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_ver=' . $ext_ver . ',dry_run=' . intval($dry_run) . ',ignoreDependencies=' . intval($ignoreDependencies) . ' - EXIT!');
+       //* DEBUG: */logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_ver=' . $ext_ver . ',isDryRun=' . intval($isDryRun) . ',ignoreDependencies=' . intval($ignoreDependencies) . ' - EXIT!');
 }
 
 // Output verbose SQL table for extension
@@ -1086,8 +1087,14 @@ function createExtensionDeactivationTask ($ext_name) {
 
 // Determines the task id for given extension
 function determineExtensionTaskId ($ext_name) {
+       // Is it installation phase and table task_system is not found?
+       if ((isInstallationPhase()) && (!ifSqlTableExists('task_system'))) {
+               // Then return NULL (not found)
+               return NULL;
+       } // END - if
+
        // Default is not found
-       $data['task_id'] = '0';
+       $data['task_id'] = NULL;
 
        // Search for extension task's id
        $result = SQL_QUERY_ESC("SELECT `id` AS task_id FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `task_type`='EXTENSION' AND `subject`='[%s:]' LIMIT 1",
@@ -1270,7 +1277,7 @@ function addExtensionDependency ($updateDepends) {
                 * Double-adding happens when the extension and an update of the same
                 * extension requires the same other extension again.
                 */
-               logDebugMessage(__FUNCTION__, __LINE__, 'updateDepends=' . $updateDepends . ',extensionMode=' . getExtensionMode() . ',currentExtension=' . getCurrentExtensionName() . ' - called twice.');
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'updateDepends=' . $updateDepends . ',extensionMode=' . getExtensionMode() . ',currentExtension=' . getCurrentExtensionName() . ' - called twice.');
                return;
        } // END - if
 
@@ -1663,14 +1670,14 @@ function getExtensionMode () {
 }
 
 // Setter for dry-run
-function enableExtensionDryRun ($dry_run = true) {
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()='.getCurrentExtensionName().',dry_run='.intval($dry_run));
-       $GLOBALS['ext_dry_run'] = (bool) $dry_run;
+function enableExtensionDryRun ($isDryRun = true) {
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()='.getCurrentExtensionName().',isDryRun='.intval($isDryRun));
+       $GLOBALS['ext_isDryRun'] = (bool) $isDryRun;
 }
 
 // Getter for dry-run
 function isExtensionDryRun () {
-       return $GLOBALS['ext_dry_run'];
+       return $GLOBALS['ext_isDryRun'];
 }
 
 // Setter for current extension version