Rewrote some parts:
[mailer.git] / inc / libs / theme_functions.php
index 2fb7de3b7f8a9b8d1a36c7c8bd45c2767fed3609..74894b99564c3dabaf3dcb7dfa47b0220f913540 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                    *
- * For more information visit: http://www.mxchange.org                  *
+ * Copyright (c) 2009 - 2013 by Mailer Developer Team                   *
+ * For more information visit: http://mxchange.org                      *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
  * it under the terms of the GNU General Public License as published by *
@@ -49,9 +47,8 @@ function generateThemeSelectionBox () {
        $mod = getModule();
 
        // Construction URL
-       $formAction = '{%url=modules.php?module='. $mod;
+       $formAction = 'modules.php?module='. $mod;
        if (!empty($what)) $formAction .= '&what=' . $what;
-       $formAction .= '%}';
 
        // Initialize array
        $themesArray = array(
@@ -62,41 +59,43 @@ function generateThemeSelectionBox () {
        // Only activated themes for the user
        $add = " WHERE `theme_active`='Y'";
 
-       // Do we have admin?
-       if (isAdmin()) $add = '';
+       // Is there admin?
+       if (isAdmin()) {
+               // Then display all themes
+               $add = '';
+       } // END - if
 
        // Select all themes we want
-       $result = SQL_QUERY("SELECT
-       `theme_path`, `theme_name`
+       $result = sqlQuery('SELECT
+       `theme_path`,
+       `theme_name`
 FROM
        `{?_MYSQL_PREFIX?}_themes`
-".$add."
+' . $add . '
 ORDER BY
-       `theme_name` ASC", __FILE__, __LINE__);
+       `theme_name` ASC', __FUNCTION__, __LINE__);
 
        // Load all themes
-       while ($content = SQL_FETCHARRAY($result)) {
-               // Construct relative include file name
-               $inc = sprintf("theme/%s/theme.php", secureString($content['theme_path']));
-
+       while ($row = sqlFetchArray($result)) {
                // Load it's theme.php file if found
-               if (isIncludeReadable($inc)) {
+               if (isThemeReadable($row['theme_path'])) {
                        // And save all data in array
-                       loadInclude($inc);
-                       $themesArray['theme_unix'][] = $content['theme_path'];
-                       $themesArray['theme_name'][] = $GLOBALS['theme_data']['name'];
+                       loadInclude(sprintf('theme/%s/theme.php', secureString($row['theme_path'])));
+                       array_push($themesArray['theme_unix'], $row['theme_path']);
+                       array_push($themesArray['theme_name'], $row['theme_name']);
                } // END - if
        } // END - while
 
        // Free the result
-       SQL_FREERESULT($result);
+       sqlFreeResult($result);
 
        // Construct selection form for the box template
+       // @TODO Can't this be rewritten to an API function?
        $OUT = '';
        foreach ($themesArray['theme_unix'] as $key => $theme) {
-               $OUT .= "  <option value=\"".$theme."\"";
+               $OUT .= '  <option value="' . $theme . '"';
                if ($theme == getCurrentTheme()) $OUT .= ' selected="selected"';
-               $OUT .= ">".$themesArray['theme_name'][$key]."</option>\n";
+               $OUT .= '>' . $themesArray['theme_name'][$key] . '</option>';
        } // END - foreach
 
        // Remember content
@@ -105,8 +104,11 @@ ORDER BY
                'selection'   => $OUT
        );
 
+       // Load template
+       $out = loadTemplate('theme_select_form', TRUE, $content);
+
        // Return generated selection
-       return loadTemplate('theme_select_form', true, $content);
+       return $out;
 }
 
 // Get version from name
@@ -121,35 +123,35 @@ function getThemeVersion ($name) {
        $cver = '?.?';
 
        // Is the cache entry there?
-       if (isset($GLOBALS['cache_array']['themes']['theme_ver'][$name])) {
+       if (isset($GLOBALS['cache_array']['themes']['theme_version'][$name])) {
                // Get the version from cache
-               $cver = $GLOBALS['cache_array']['themes']['theme_ver'][$name];
+               $cver = $GLOBALS['cache_array']['themes']['theme_version'][$name];
 
                // Count up
                incrementStatsEntry('cache_hits');
-       } elseif (getExtensionVersion('cache') != '0.1.8') {
+       } elseif (isExtensionInstalledAndNewer('cache', '0.1.8')) {
                // Load version from database
-               $result = SQL_QUERY_ESC("SELECT `theme_ver` FROM `{?_MYSQL_PREFIX?}_themes` WHERE `theme_path`='%s' LIMIT 1",
+               $result = sqlQueryEscaped("SELECT `theme_ver` FROM `{?_MYSQL_PREFIX?}_themes` WHERE `theme_path`='%s' LIMIT 1",
                        array($name), __FUNCTION__, __LINE__);
 
                // Entry found?
-               if (SQL_NUMROWS($result) == 1) {
+               if (sqlNumRows($result) == 1) {
                        // Fetch data
-                       list($cver) = SQL_FETCHROW($result);
+                       list($cver) = sqlFetchRow($result);
                } // END - if
 
                // Free result
-               SQL_FREERESULT($result);
+               sqlFreeResult($result);
        }
 
        // Return version
        return $cver;
 }
 
-// Checks wether a theme is found in db
+// Checks whether a theme is found in db
 function ifThemeExists ($name) {
        // Get theme and is it not nul?
-       return ((isExtensionActive('theme')) && (getThemeId($name) > 0));
+       return (((isExtensionActive('theme')) || (getModule() == 'admin')) && (isValidId(getThemeId($name))));
 }
 
 // Checks if a theme is active
@@ -157,11 +159,11 @@ function isThemeActive ($name) {
        // Is the extension 'theme' installed?
        if (!isExtensionActive('theme')) {
                // Then abort here
-               return false;
+               return FALSE;
        } // END - if
 
        // Default is nothing active
-       $active = false;
+       $active = FALSE;
 
        // Is the cache entry there?
        if (isset($GLOBALS['cache_array']['themes']['theme_active'][$name])) {
@@ -170,16 +172,16 @@ function isThemeActive ($name) {
 
                // Count up
                incrementStatsEntry('cache_hits');
-       } elseif (getExtensionVersion('cache') != '0.1.8') {
+       } elseif (isExtensionInstalledAndNewer('cache', '0.1.8')) {
                // Check if current theme is already imported or not
-               $result = SQL_QUERY_ESC("SELECT `theme_active` FROM `{?_MYSQL_PREFIX?}_themes` WHERE `theme_path`='%s' AND `theme_active`='Y' LIMIT 1",
+               $result = sqlQueryEscaped("SELECT `theme_active` FROM `{?_MYSQL_PREFIX?}_themes` WHERE `theme_path`='%s' AND `theme_active`='Y' LIMIT 1",
                        array($name), __FUNCTION__, __LINE__);
 
                // Is the theme active and installed?
-               $active = (SQL_NUMROWS($result) == 1);
+               $active = (sqlNumRows($result) == 1);
 
                // Free result
-               SQL_FREERESULT($result);
+               sqlFreeResult($result);
        }
 
        // Return result
@@ -204,16 +206,16 @@ function getCurrentThemeName () {
 
                // Count up
                incrementStatsEntry('cache_hits');
-       } elseif (getExtensionVersion('cache') != '0.1.8') {
+       } elseif (isExtensionInstalledAndNewer('cache', '0.1.8')) {
                // Check if current theme is already imported or not
-               $result = SQL_QUERY_ESC("SELECT `theme_name` FROM `{?_MYSQL_PREFIX?}_themes` WHERE `theme_path`='%s' AND `theme_active`='Y' LIMIT 1",
+               $result = sqlQueryEscaped("SELECT `theme_name` FROM `{?_MYSQL_PREFIX?}_themes` WHERE `theme_path`='%s' AND `theme_active`='Y' LIMIT 1",
                        array($name), __FUNCTION__, __LINE__);
 
                // Load theme name
-               list($name) = SQL_FETCHROW($result);
+               list($name) = sqlFetchRow($result);
 
                // Free result
-               SQL_FREERESULT($result);
+               sqlFreeResult($result);
        }
 
        // Return name
@@ -226,50 +228,47 @@ function getActualTheme () {
        $ret = 'default';
 
        // Load default theme if not empty from configuration
-       if ((isConfigEntrySet('default_theme')) && (getConfig('default_theme') != '')) $ret = getConfig('default_theme');
+       if ((isConfigEntrySet('default_theme')) && (getConfig('default_theme') != '')) {
+               $ret = getConfig('default_theme');
+       } // END - if
 
-       if (!isSessionVariableSet('mxchange_theme')) {
+       if (!isMailerThemeSet()) {
                // Set default theme
-               setTheme($ret);
-       } elseif ((isSessionVariableSet('mxchange_theme')) && (isExtensionInstalledAndNewer('sql_patches', '0.1.4'))) {
-               //die("<pre>".print_r($GLOBALS['cache_array']['themes'], true)."</pre>");
+               setMailerTheme($ret);
+       } elseif ((isMailerThemeSet()) && (isExtensionInstalledAndNewer('sql_patches', '0.1.4'))) {
+               //die("<pre>".print_r($GLOBALS['cache_array']['themes'], TRUE)."</pre>");
                // Get theme from cookie
-               $ret = getSession('mxchange_theme');
+               $ret = getSession('mailer_theme');
 
                // Is it valid?
                if ((!isExtensionActive('theme')) || (getThemeId($ret) == '0')) {
                        // Fix it to default
                        $ret = 'default';
                } // END - if
-       } elseif ((!isInstalled()) && ((isInstalling()) || (getOutputMode() == true)) && ((isGetRequestParameterSet('theme')) || (isPostRequestParameterSet('theme')))) {
+       } elseif ((!isInstalled()) && ((isInstalling()) || (isHtmlOutputMode())) && ((isGetRequestElementSet('theme')) || (isPostRequestElementSet('theme')))) {
                // Prepare filename for checking
-               $themeFile = sprintf("theme/%s/theme.php", getRequestParameter('theme'));
+               $themeFile = sprintf('theme/%s/theme.php', getRequestElement('theme'));
 
                // Installation mode active
-               if ((isGetRequestParameterSet('theme')) && (isIncludeReadable($theme))) {
+               if ((isGetRequestElementSet('theme')) && (isThemeReadable(getRequestElement('theme')))) {
                        // Set cookie from URL data
-                       setTheme(getRequestParameter('theme'));
-               } elseif (isIncludeReadable(sprintf("theme/%s/theme.php", secureString(postRequestParameter('theme'))))) {
+                       setMailerTheme(getRequestElement('theme'));
+               } elseif ((isPostRequestElementSet('theme')) && (isThemeReadable(postRequestElement('theme')))) {
                        // Set cookie from posted data
-                       setTheme(secureString(postRequestParameter('theme')));
+                       setMailerTheme(postRequestElement('theme'));
                }
 
                // Set return value
-               $ret = getSession('mxchange_theme');
+               $ret = getSession('mailer_theme');
        } else {
                // Invalid design, reset cookie
-               setTheme($ret);
+               setMailerTheme($ret);
        }
 
        // Return theme value
        return $ret;
 }
 
-// Setter for theme in session
-function setTheme ($newTheme) {
-       setSession('mxchange_theme', $newTheme);
-}
-
 // Get id from theme
 function getThemeId ($name) {
        // Default id
@@ -284,59 +283,22 @@ function getThemeId ($name) {
                incrementStatsEntry('cache_hits');
        } elseif (isExtensionInstalledAndNewer('cache', '0.1.8')) {
                // Check if current theme is already imported or not
-               $result = SQL_QUERY_ESC("SELECT `id` FROM `{?_MYSQL_PREFIX?}_themes` WHERE `theme_path`='%s' LIMIT 1",
+               $result = sqlQueryEscaped("SELECT `id` FROM `{?_MYSQL_PREFIX?}_themes` WHERE `theme_path`='%s' LIMIT 1",
                        array($name), __FUNCTION__, __LINE__);
 
                // Entry found?
-               if (SQL_NUMROWS($result) == 1) {
+               if (sqlNumRows($result) == 1) {
                        // Fetch data
-                       list($id) = SQL_FETCHROW($result);
+                       list($id) = sqlFetchRow($result);
                } // END - if
 
                // Free result
-               SQL_FREERESULT($result);
+               sqlFreeResult($result);
        }
 
        // Return id
        return $id;
 }
 
-///////////////////////////////////////////////////////////////////////////////
-//                              Only filter functions
-///////////////////////////////////////////////////////////////////////////////
-
-// Filter for generic handling of theme change
-function FILTER_HANDLE_THEME_CHANGE () {
-       // Check if new theme is selcted
-       if ((isPostRequestParameterSet('new_theme')) && (postRequestParameter('new_theme') != getCurrentTheme())) {
-               // Set new theme for guests
-               $newTheme = postRequestParameter('new_theme');
-
-               // Change to new theme
-               setTheme($newTheme);
-
-               // Remove current from array
-               removeIncludeFromPool('theme', sprintf("theme/%s/theme.php", getCurrentTheme()));
-
-               // Add new theme
-               addIncludeToPool('theme', sprintf("theme/%s/theme.php", $newTheme));
-
-               // Redirect to same URL
-               redirectToRequestUri();
-       } // END - if
-}
-
-// Filter for settings theme from user profile, must be executed only if FILTER_FETCH_USER_DATA() ran before
-function FILTER_SET_USERS_THEME () {
-       // Is the user data valid?
-       if (!isMember()) {
-               // Do only run for logged in members
-               debug_report_bug('Please only run this filter for logged in users.');
-       } // END - if
-
-       // Change to new theme
-       setTheme(getUserData('curr_theme'));
-}
-
 // [EOF]
 ?>