Renamed function so it might be more understandable
[mailer.git] / inc / module-functions.php
index e9ca5598c54c7da1ed6fa07f57fd052eb4ea50f6..5b520465b1c6c00b2bbe1445ee1847f0ab686b73 100644 (file)
@@ -61,7 +61,7 @@ function getModuleTitle ($module) {
                                array($module), __FUNCTION__, __LINE__);
 
                        // Is the entry there?
-                       if (SQL_NUMROWS($result)) {
+                       if (SQL_NUMROWS($result) == 1) {
                                // Get the title from database
                                $data = SQL_FETCHARRAY($result);
                        } // END - if
@@ -94,50 +94,31 @@ function getModuleTitle ($module) {
        return $data['title'];
 }
 
-// Check validity of a given module name (no file extension)
-function checkModulePermissions ($module = '') {
-       // Is it empty (default), then take the current one
-       if (empty($module)) $module = getModule();
-
-       // Do we have cache?
-       if (isset($GLOBALS['module_status'][$module])) {
-               // Then use it
-               return $GLOBALS['module_status'][$module];
-       } // END - if
-
-       // Filter module name (names with low chars and underlines are fine!)
-       $module = preg_replace('/[^a-z_]/', '', $module);
-
-       // Check for prefix is a extension...
-       $modSplit = explode('_', $module);
-       $extension = ''; $module_chk = $module;
-       //* DEBUG: */ debugOutput(__LINE__.'*'.count($modSplit).'/'.$module.'*');
-       if (count($modSplit) == 2) {
-               // Okay, there is a seperator (_) in the name so is the first part a module?
-               //* DEBUG: */ debugOutput(__LINE__.'*'.$modSplit[0].'*');
-               if (isExtensionActive($modSplit[0])) {
-                       // The prefix is an extension's name, so let's set it
-                       $extension = $modSplit[0]; $module = $modSplit[1];
-               } // END - if
-       } // END - if
+// Checks if module_status entry is there
+function isModuleStatusSet ($module) {
+       // Check it
+       return (isset($GLOBALS['module_status'][$module]));
+}
 
-       // Major error in module registry is the default
-       $ret = 'major';
+// Setter module status
+function setModuleStatus ($module, $status) {
+       $GLOBALS['module_status'][$module] = $status;
+}
 
-       // Check if script is installed if not return a 'done' to prevent some errors
-       if ((isInstallationPhase()) || (!isAdminRegistered())) {
-               // Not installed or no admin registered or in installation phase
-               return 'done';
+// Getter for module status
+function getModuleStatus ($module) {
+       // Is the module_status entry there?
+       if (!isModuleStatusSet($module)) {
+               // Abort
+               debug_report_bug('Module status not set. module=' . $module);
        } // END - if
 
-       // Init data array
-       $data = array(
-               'locked'     => 'Y',
-               'hidden'     => 'N',
-               'admin_only' => 'N',
-               'mem_only'   => 'N'
-       );
+       // Return it
+       return $GLOBALS['module_status'][$module];
+}
 
+// Checks wether the given module is registered
+function isModuleRegistered ($module) {
        // By default nothing is found
        $found  = false;
 
@@ -145,150 +126,244 @@ function checkModulePermissions ($module = '') {
        if (isExtensionInstalledAndNewer('cache', '0.1.2')) {
                // Is the cache there?
                //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using cache.');
-               if (isset($GLOBALS['cache_array']['modules']['locked'][$module_chk])) {
-                       // Check cache
-                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cache found.');
-                       $data['locked']     = $GLOBALS['cache_array']['modules']['locked'][$module_chk];
-                       $data['hidden']     = $GLOBALS['cache_array']['modules']['hidden'][$module_chk];
-                       $data['admin_only'] = $GLOBALS['cache_array']['modules']['admin_only'][$module_chk];
-                       $data['mem_only']   = $GLOBALS['cache_array']['modules']['mem_only'][$module_chk];
-
+               if (isset($GLOBALS['cache_array']['modules']['locked'][$module])) {
                        // Update cache hits
                        incrementStatsEntry('cache_hits');
+
+                       // Is found
                        $found = true;
                } else {
                        // No, then we have to update it!
-                       $ret = 'cache_miss';
+                       setModuleStatus($module, 'cache_miss');
                }
        } elseif (!isExtensionActive('cache')) {
                // Check for module in database
                //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using database.');
                $result = SQL_QUERY_ESC("SELECT `locked`, `hidden`, `admin_only`, `mem_only` FROM `{?_MYSQL_PREFIX?}_mod_reg` WHERE `module`='%s' LIMIT 1",
-                       array($module_chk), __FUNCTION__, __LINE__);
+                       array($module), __FUNCTION__, __LINE__);
                if (SQL_NUMROWS($result) == 1) {
                        // Read data
-                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Entry found.');
                        $data = SQL_FETCHARRAY($result);
+
+                       // Set all entries
+                       foreach ($data as $key=>$value) {
+                               $GLOBALS['cache_array']['modules'][$key][$module] = $value;
+                       } // END - foreach
+
+                       // Mark as found
                        $found = true;
                } elseif (isDebugModeEnabled()) {
                        // Debug message only in debug-mode...
-                       logDebugMessage(__FUNCTION__, __LINE__, 'Module ' . $module_chk . ' not found!');
+                       logDebugMessage(__FUNCTION__, __LINE__, 'Module ' . $module . ' not found!');
                }
 
                // Free result
                SQL_FREERESULT($result);
        }
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ret=' . $ret);
+
+       // Return status
+       return $found;
+}
+
+// Checks wether the given module is locked by just checking the cache
+function isModuleLocked ($module) {
+       // Determine if there a cache entry and is it set
+       $return = ((isset($GLOBALS['cache_array']['modules']['locked'][$module])) && ($GLOBALS['cache_array']['modules']['locked'][$module] == 'Y'));
+
+       // Return determined value
+       return $return;
+}
+
+// Checks wether the given module is hidden by just checking the cache
+function isModuleHidden ($module) {
+       // Determine if there a cache entry and is it set
+       $return = ((isset($GLOBALS['cache_array']['modules']['hidden'][$module])) && ($GLOBALS['cache_array']['modules']['hidden'][$module] == 'Y'));
+
+       // Return determined value
+       return $return;
+}
+
+// Checks wether the given module is mem_only by just checking the cache
+function isModuleMemberOnly ($module) {
+       // Determine if there a cache entry and is it set
+       $return = ((isset($GLOBALS['cache_array']['modules']['mem_only'][$module])) && ($GLOBALS['cache_array']['modules']['mem_only'][$module] == 'Y'));
+
+       // Return determined value
+       return $return;
+}
+
+// Checks wether the given module is admin_only by just checking the cache
+function isModuleAdminOnly ($module) {
+       // Determine if there a cache entry and is it set
+       $return = ((isset($GLOBALS['cache_array']['modules']['admin_only'][$module])) && ($GLOBALS['cache_array']['modules']['admin_only'][$module] == 'Y'));
+
+       // Return determined value
+       return $return;
+}
+
+// Check validity of a given module name (no file extension)
+function checkModulePermissions ($module = '') {
+       // Is it empty (default), then take the current one
+       if (empty($module)) {
+               // Use current module
+               $module = getModule();
+       } // END - if
+
+       // Do we have cache?
+       if (isModuleStatusSet($module)) {
+               // Then use it
+               return getModuleStatus($module);
+       } // END - if
+
+       // Filter module name (names with low chars and underlines are fine!)
+       $module = preg_replace('/[^a-z_]/', '', $module);
+
+       // Check for prefix is a extension...
+       $modSplit = explode('_', $module);
+       $extension = ''; $module_chk = $module;
+       //* DEBUG: */ debugOutput(__LINE__.'*'.count($modSplit).'/'.$module.'*');
+       if (count($modSplit) == 2) {
+               // Okay, there is a seperator (_) in the name so is the first part a module?
+               //* DEBUG: */ debugOutput(__LINE__.'*'.$modSplit[0].'*');
+               if (isExtensionActive($modSplit[0])) {
+                       // The prefix is an extension's name, so let's set it
+                       $extension = $modSplit[0]; $module = $modSplit[1];
+               } // END - if
+       } // END - if
+
+       // Major error in module registry is the default
+       setModuleStatus($module_chk, 'major');
+
+       // Check if script is installed if not return a 'done' to prevent some errors
+       if ((isInstallationPhase()) || (!isAdminRegistered())) {
+               // Not installed or no admin registered or in installation phase
+               setModuleStatus($module_chk, 'done');
+
+               // Return status
+               return 'done';
+       } // END - if
+
+       // Check if the module is registered
+       $found = isModuleRegistered($module_chk);
 
        // Is the module found?
        if ($found === true) {
                // Check returned values against current access permissions
                //
-               //  Admin access                   ----- Guest access -----                                     --- Guest   or   member? ---
-               if ((isAdmin()) || (($data['locked'] != 'Y') && ($data['admin_only'] != 'Y') && (($data['mem_only'] != 'Y') || (isMember())))) {
+               // Admin access                                                              ----- Guest access -----                                                                                                                         --- Guest   or   member? ---
+               if ((isAdmin()) || ((!isModuleLocked($module_chk)) && (!isModuleAdminOnly($module_chk)) && ((!isModuleMemberOnly($module_chk)) || (isMember())))) {
                        // If you are admin you are welcome for everything!
-                       $ret = 'done';
-               } elseif ($data['locked'] == 'Y') {
+                       setModuleStatus($module_chk, 'done');
+               } elseif (isModuleLocked($module_chk)) {
                        // Module is locked
-                       $ret = 'locked';
-               } elseif (($data['mem_only'] == 'Y') && (!isMember())) {
+                       setModuleStatus($module_chk, 'locked');
+               } elseif ((isModuleMemberOnly($module_chk)) && (!isMember())) {
                        // You have to login first!
-                       $ret = 'mem_only';
-               } elseif (($data['admin_only'] == 'Y') && (!isAdmin())) {
+                       setModuleStatus($module_chk, 'mem_only');
+               } elseif ((isModuleAdminOnly($module_chk)) && (!isAdmin())) {
                        // Only the Admin is allowed to enter this module!
-                       $ret = 'admin_only';
+                       setModuleStatus($module_chk, 'admin_only');
                } else {
                        // @TODO Nothing helped???
-                       logDebugMessage(__FUNCTION__, __LINE__, sprintf("ret=%s,locked=%s,admin=%s,mem=%s",
-                               $ret,
-                               $data['locked'],
-                               $data['admin_only'],
-                               $data['mem_only']
+                       logDebugMessage(__FUNCTION__, __LINE__, sprintf("ret=%s,locked=%d,hidden=%d,mem=%d,admin=%d",
+                               getModuleStatus($module_chk),
+                               intval(isModuleLocked($module_chk)),
+                               intval(isModuleHidden($module_chk)),
+                               intval(isModuleMemberOnly($module_chk)),
+                               intval(isModuleAdminOnly($module_chk))
                        ));
                }
        } // END - if
 
        // Still no luck or not found?
-       if (($found === false) && (!isExtensionActive('cache')) && ($ret != 'done'))  {
-               //              ----- Legacy module -----                                               ---- Module in base folder  ----                       --- Module with extension's name ---
+       if (($found === false) && (!isExtensionActive('cache')) && (getModuleStatus($module_chk) != 'done'))  {
+               //              ----- Default module -----                                  ---- Module in base folder  ----                       --- Module with extension's name ---
                if ((isIncludeReadable(sprintf("inc/modules/%s.php", $module))) || (isIncludeReadable(sprintf("%s.php", $module))) || (isIncludeReadable(sprintf("%s/%s.php", $extension, $module)))) {
                        // Data is missing so we add it
                        if (isExtensionInstalledAndNewer('sql_patches', '0.3.6')) {
-                               // Since 0.3.6 we have a has_menu column, this took me a half hour
-                               // to find a loop here... *sigh*
+                               /*
+                                * Since 0.3.6 we have a has_menu column, this took me a half
+                                * hour to find a loop here... *sigh*
+                                */
                                SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_mod_reg`
-(`module`, `locked`, `hidden`, `mem_only`, `admin_only`, `has_menu`) VALUES
+(`module`, `locked`, `hidden`, `mem_only`, `admin_only`, `has_menu`)
+VALUES
 ('%s','Y','N','N','N','N')", array($module_chk), __FUNCTION__, __LINE__);
                        } else {
                                // Wrong/missing sql_patches!
                                SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_mod_reg`
-(`module`, `locked`, `hidden`, `mem_only`, `admin_only`) VALUES
+(`module`, `locked`, `hidden`, `mem_only`, `admin_only`)
+VALUES
 ('%s','Y','N','N','N')", array($module_chk), __FUNCTION__, __LINE__);
                        }
 
                        // Everthing is fine?
-                       if (SQL_AFFECTEDROWS() < 1) {
+                       if (SQL_HASZEROAFFECTED()) {
                                // Something bad happend!
+                               setModuleStatus($module_chk, 'major');
                                return 'major';
                        } // END - if
 
                        // Destroy cache here
                        // @TODO Rewrite this to a filter
-                       if ((isHtmlOutputMode()) || (isRawOutputMode())) rebuildCache('modules', 'modules');
+                       if ((isHtmlOutputMode()) || (isRawOutputMode())) {
+                               rebuildCache('modules', 'modules');
+                       } // END - if
 
                        // And reload data
-                       unset($GLOBALS['module_status'][$module]);
-                       $ret = checkModulePermissions($module_chk);
+                       unset($GLOBALS['module_status'][$module_chk]);
+                       return checkModulePermissions($module_chk);
                } else {
                        // Module not found we don't add it to the database
-                       $ret = '404';
+                       setModuleStatus($module_chk, '404');
                }
-       } elseif (($ret == 'cache_miss') && (isHtmlOutputMode())) {
+       } elseif ((getModuleStatus($module_chk) == 'cache_miss') && (isHtmlOutputMode())) {
                // Rebuild the cache files
                rebuildCache('modules', 'modules');
        } elseif ($found === false) {
                // Problem with module detected
-               logDebugMessage(__FUNCTION__, __LINE__, sprintf("Problem in module %s detected. ret=%s, locked=%s, hidden=%s, mem=%s, admin=%s, output_mode=%s",
-                       $module,
-                       $ret,
-                       $data['locked'],
-                       $data['hidden'],
-                       $data['mem_only'],
-                       $data['admin_only'],
+               logDebugMessage(__FUNCTION__, __LINE__, sprintf("Problem in module %s detected. getModuleStatus()=%s,locked=%d,hidden=%d,mem=%d,admin=%d,output_mode=%s",
+                       $module_chk,
+                       getModuleStatus($module_chk),
+                       intval(isModuleLocked($module_chk)),
+                       intval(isModuleHidden($module_chk)),
+                       intval(isModuleMemberOnly($module_chk)),
+                       intval(isModuleAdminOnly($module_chk)),
                        getScriptOutputMode()
                ));
        }
 
+       // Debug log
+       logDebugMessage(__FUNCTION__, __LINE__, sprintf("module=%s, status=%s", $module_chk, getModuleStatus($module_chk)));
+
        // Return the value
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ret=' . $ret);
-       $GLOBALS['module_status'][$module] = $ret;
-       return $ret;
+       return getModuleStatus($module_chk);
 }
 
 // Checks if the module has a menu
-function ifModuleHasMenu ($mod, $forceDb = false) {
+function ifModuleHasMenu ($module, $forceDb = false) {
        // All is false by default
        $ret = false;
 
        // Extension installed and newer than or has version 0.1.2?
        if (isExtensionInstalledAndNewer('cache', '0.1.2')) {
                // Cache version is okay, so let's check the cache!
-               if (isset($GLOBALS['cache_array']['modules']['has_menu'][$mod])) {
+               if (isset($GLOBALS['cache_array']['modules']['has_menu'][$module])) {
                        // Check module cache and count hit
-                       $ret = ($GLOBALS['cache_array']['modules']['has_menu'][$mod] == 'Y');
+                       $ret = ($GLOBALS['cache_array']['modules']['has_menu'][$module] == 'Y');
                        incrementStatsEntry('cache_hits');
-               } elseif (isset($GLOBALS['cache_array']['extension']['ext_menu'][$mod])) {
+               } elseif (isset($GLOBALS['cache_array']['extension']['ext_menu'][$module])) {
                        // Check cache and count hit
-                       $ret = ($GLOBALS['cache_array']['extension']['ext_menu'][$mod] == 'Y');
+                       $ret = ($GLOBALS['cache_array']['extension']['ext_menu'][$module] == 'Y');
                        incrementStatsEntry('cache_hits');
                } else {
                        // Admin/guest/member/sponsor modules have always a menu!
-                       $ret = in_array($mod, array('admin', 'index', 'login', 'sponsor'));
+                       $ret = in_array($module, array('admin', 'index', 'login', 'sponsor'));
                }
        } elseif ((isExtensionInstalledAndNewer('sql_patches', '0.3.6')) && ((!isExtensionActive('cache')) || ($forceDb === true))) {
                // Check database for entry
                $result = SQL_QUERY_ESC("SELECT `has_menu` FROM `{?_MYSQL_PREFIX?}_mod_reg` WHERE `module`='%s' LIMIT 1",
-                       array($mod), __FUNCTION__, __LINE__);
+                       array($module), __FUNCTION__, __LINE__);
 
                // Entry found?
                if (SQL_NUMROWS($result) == 1) {
@@ -296,7 +371,7 @@ function ifModuleHasMenu ($mod, $forceDb = false) {
                        $data = SQL_FETCHARRAY($result);
 
                        // Fake cache... ;-)
-                       $GLOBALS['cache_array']['extension']['ext_menu'][$mod] = $data['has_menu'];
+                       $GLOBALS['cache_array']['extension']['ext_menu'][$module] = $data['has_menu'];
 
                        // Does it have a menu?
                        $ret = ($data['has_menu'] == 'Y');
@@ -306,7 +381,7 @@ function ifModuleHasMenu ($mod, $forceDb = false) {
                SQL_FREERESULT($result);
        } elseif (!isExtensionInstalled('sql_patches')) {
                // No sql_patches installed, so maybe in admin/guest/member/sponsor area or no admin registered?
-               $ret = in_array($mod, array('admin', 'index', 'login', 'sponsor')); // Then there is a menu!
+               $ret = in_array($module, array('admin', 'index', 'login', 'sponsor')); // Then there is a menu!
        } else {
                // Unsupported state!
                logDebugMessage(__FUNCTION__, __LINE__, 'This should never be reached.');
@@ -316,5 +391,23 @@ function ifModuleHasMenu ($mod, $forceDb = false) {
        return $ret;
 }
 
+// Adds a SQL for given module
+function addModuleSql ($module, $locked, $hidden, $adminOnly, $memOnly) {
+       // Is the module already registered?
+       if (!isModuleRegistered($module)) {
+               // Add it
+               addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_mod_reg` (`module`,`locked`,`hidden`,`admin_only`,`mem_only`) VALUES('" . $module . "','" . $locked . "','" . $hidden . "','" . $adminOnly . "','" . $memOnly . "')");
+       } else {
+               // Already registered
+               logDebugMessage(__FUNCTION__, __LINE__, sprintf("Already registered: module=%s,locked=%s,hidden=%s,admin=%s,mem=%s",
+                       $module,
+                       $locked,
+                       $hidden,
+                       $adminOnly,
+                       $memOnly
+               ));
+       }
+}
+
 // [EOF]
 ?>