Refactor cache clearing methods (AJXP_PluginService::clearPluginsCache & ConfService::clearMessageCache) and use them accordingly. Add a button in settings to clear cache (close #790)

cdujeu · cdujeu · commit 66ef2072a079 · 2015-03-21T16:32:17.000+01:00
diff --git a/core/src/core/classes/class.AJXP_PluginsService.php b/core/src/core/classes/class.AJXP_PluginsService.php
@@ -187,6 +187,12 @@ public function storeToPluginQueriesCache($key, $value)
         AJXP_Utils::saveSerialFile(AJXP_PLUGINS_QUERIES_CACHE, $test);
     }
 
+    public static function clearPluginsCache(){
+        @unlink(AJXP_PLUGINS_CACHE_FILE);
+        @unlink(AJXP_PLUGINS_REQUIRES_FILE);
+        @unlink(AJXP_PLUGINS_QUERIES_CACHE);
+    }
+
     /**
      * Simply load a plugin class, without the whole dependencies et.all
      * @param string $pluginId
diff --git a/core/src/core/classes/class.ConfService.php b/core/src/core/classes/class.ConfService.php
@@ -1028,6 +1028,18 @@ public function getMessagesInst($forceRefresh = false)
         return $this->configs["MESSAGES"];
     }
 
+    /**
+     * Clear the messages cache
+     */
+    public static function clearMessagesCache(){
+        $i18nFiles = glob(dirname(AJXP_PLUGINS_MESSAGES_FILE)."/i18n/*.ser");
+        if (is_array($i18nFiles)) {
+            foreach ($i18nFiles as $file) {
+                @unlink($file);
+            }
+        }
+    }
+
     /**
      * Get all registered extensions, from both the conf/extensions.conf.php and from the plugins
      * @static
diff --git a/core/src/plugins/access.ajxp_conf/ajxp_confActions.xml b/core/src/plugins/access.ajxp_conf/ajxp_confActions.xml
@@ -556,6 +556,19 @@
                 <serverCallback methodName="switchAction"/>
             </processing>
         </action>
+        <action name="clear_plugins_cache">
+            <gui src="plugins" text="ajxp_conf.129" title="ajxp_conf.130">
+                <context dir="true" recycle="true" allowedMimes="plugins_zone" selection="false" actionBar="true" actionBarGroup="get"/>
+            </gui>
+            <processing>
+                <clientCallback><![CDATA[
+                    var conn = new Connexion();
+                    conn.setParameters($H({get_action:'clear_plugins_cache'}));
+                    conn.sendAsync();
+                ]]></clientCallback>
+                <serverCallback methodName="switchAction"/>
+            </processing>
+        </action>
 	</actions>
 	<client_configs>
 		<component_config className="InfoPanel">
diff --git a/core/src/plugins/access.ajxp_conf/class.ajxp_confAccessDriver.php b/core/src/plugins/access.ajxp_conf/class.ajxp_confAccessDriver.php
@@ -331,21 +331,25 @@ public function switchAction($action, $httpVars, $fileVars)
                         )
                     ),
                     "config" => array(
+                        "AJXP_MIME" => "plugins_zone",
                         "LABEL" => $mess["ajxp_conf.109"],
                         "ICON" => "preferences_desktop.png",
                         "DESCRIPTION" => "Global configurations of the application core and of each plugin. Enable/disable plugins",
                         "CHILDREN" => array(
                             "core"	   	   => array(
+                                "AJXP_MIME" => "plugins_zone",
                                 "LABEL" => $mess["ajxp_conf.98"],
                                 "DESCRIPTION" => "Core application parameters",
                                 "ICON" => "preferences_desktop.png",
                                 "LIST" => "listPlugins"),
                             "plugins"	   => array(
+                                "AJXP_MIME" => "plugins_zone",
                                 "LABEL" => $mess["ajxp_conf.99"],
                                 "DESCRIPTION" => "Enable/disable additional feature-oriented plugins, check if they are correctly working, set up global parameters of the plugins.",
                                 "ICON" => "folder_development.png",
                                 "LIST" => "listPlugins"),
                             "core_plugins" => array(
+                                "AJXP_MIME" => "plugins_zone",
                                 "LABEL" => $mess["ajxp_conf.123"],
                                 "DESCRIPTION" => "Enable/disable core plugins (auth, conf, mail, etc), check if they are correctly working. Configuration of these plugins are generally done through the Main Options",
                                 "ICON" => "folder_development.png",
@@ -477,6 +481,17 @@ public function switchAction($action, $httpVars, $fileVars)
 
             break;
 
+            case "clear_plugins_cache":
+                AJXP_XMLWriter::header();
+                // Clear plugins cache if they exist
+                AJXP_PluginsService::clearPluginsCache();
+                ConfService::clearMessagesCache();
+                AJXP_XMLWriter::sendMessage($mess["ajxp_conf.".(AJXP_SKIP_CACHE?"132":"131")], null);
+                AJXP_XMLWriter::reloadDataNode();
+                AJXP_XMLWriter::close();
+                break;
+
+
             case "create_group":
 
                 if (isSet($httpVars["group_path"])) {
@@ -1678,9 +1693,7 @@ public function switchAction($action, $httpVars, $fileVars)
                 $this->parseParameters($httpVars, $options, null, true);
                 $confStorage = ConfService::getConfStorageImpl();
                 $confStorage->savePluginConfig($httpVars["plugin_id"], $options);
-                @unlink(AJXP_PLUGINS_CACHE_FILE);
-                @unlink(AJXP_PLUGINS_REQUIRES_FILE);
-                @unlink(AJXP_PLUGINS_MESSAGES_FILE);
+                AJXP_PluginsService::clearPluginsCache();
                 AJXP_XMLWriter::header();
                 AJXP_XMLWriter::sendMessage($mess["ajxp_conf.97"], null);
                 AJXP_XMLWriter::close();
diff --git a/core/src/plugins/access.ajxp_conf/i18n/de.php b/core/src/plugins/access.ajxp_conf/i18n/de.php
@@ -151,4 +151,8 @@
 "126" => "Sind Sie sicher, dass Sie die ausgewählten Elemente löschen möchten?",
 "127" => "Achtung, bitte verwenden Sie keine Sonderzeichen. Benutzer würde mit Login-ID '%s' erstellt werden.",
 "128" => "Successfully deleted group",
+"129" => "Refresh plugins cache",
+"130" => "Clear plugins cache, can be necessary to see new plugins appear in the list.",
+"131" => "Plugins cache files were deleted succesfully!",
+"132" => "Cache cleared, but you are currently running in SKIP_CACHE mode (see bootstrap_context.php).",
 );
diff --git a/core/src/plugins/access.ajxp_conf/i18n/en.php b/core/src/plugins/access.ajxp_conf/i18n/en.php
@@ -149,4 +149,8 @@
 "126" => "Are you sure that you want to delete the selected element(s)?",
 "127" => "Warning, please do not use special characters, user would be created with login id '%s'",
 "128" => "Successfully deleted group",
+"129" => "Refresh plugins cache",
+"130" => "Clear plugins cache, can be necessary to see new plugins appear in the list.",
+"131" => "Plugins cache files were deleted succesfully!",
+"132" => "Cache cleared, but you are currently running in SKIP_CACHE mode (see bootstrap_context.php).",
 );
diff --git a/core/src/plugins/access.ajxp_conf/i18n/es.php b/core/src/plugins/access.ajxp_conf/i18n/es.php
@@ -149,4 +149,8 @@
 "126" => "Are you sure that you want to delete the selected element(s)?",
 "127" => "Warning, please do not use special characters, user would be created with login id '%s'",
 "128" => "Successfully deleted group",
+"129" => "Refresh plugins cache",
+"130" => "Clear plugins cache, can be necessary to see new plugins appear in the list.",
+"131" => "Plugins cache files were deleted succesfully!",
+"132" => "Cache cleared, but you are currently running in SKIP_CACHE mode (see bootstrap_context.php).",
 );
diff --git a/core/src/plugins/access.ajxp_conf/i18n/fi.php b/core/src/plugins/access.ajxp_conf/i18n/fi.php
@@ -152,5 +152,9 @@
 "126" => "Are you sure that you want to delete the selected element(s)?",
 "127" => "Warning, please do not use special characters, user would be created with login id '%s'",
 "128" => "Successfully deleted group",
+"129" => "Refresh plugins cache",
+"130" => "Clear plugins cache, can be necessary to see new plugins appear in the list.",
+"131" => "Plugins cache files were deleted succesfully!",
+"132" => "Cache cleared, but you are currently running in SKIP_CACHE mode (see bootstrap_context.php).",
 /* END SENTENCE */
 );
diff --git a/core/src/plugins/access.ajxp_conf/i18n/fr.php b/core/src/plugins/access.ajxp_conf/i18n/fr.php
@@ -149,4 +149,8 @@
 "126" => "Voulez-vous vraiment supprimer les éléments sélectionnés?",
 "127" => "Attention, veuillez ne pas utiliser de caractères spéciaux, l'utilisateur serait créé avec l'identifiant '%s'",
 "128" => "Le groupe a été supprimé",
+"129" => "Vider le cache",
+"130" => "Vider le cache des plugins peut être nécessaire pour voir les nouveaux plugins apparaître dans la liste.",
+"131" => "Le cache des plugins a été supprimé!",
+"132" => "Le cache des plugins a été supprimé, mais vous êtes actuellement en mode SKIP_CACHE (voir bootstrap_context.php).",
 );
diff --git a/core/src/plugins/access.ajxp_conf/i18n/hu.php b/core/src/plugins/access.ajxp_conf/i18n/hu.php
@@ -151,5 +151,9 @@
 "126" => "Are you sure that you want to delete the selected element(s)?",
 "127" => "Warning, please do not use special characters, user would be created with login id '%s'",
 "128" => "Successfully deleted group",
+"129" => "Refresh plugins cache",
+"130" => "Clear plugins cache, can be necessary to see new plugins appear in the list.",
+"131" => "Plugins cache files were deleted succesfully!",
+"132" => "Cache cleared, but you are currently running in SKIP_CACHE mode (see bootstrap_context.php).",
 /* END SENTENCE */
 );
diff --git a/core/src/plugins/access.ajxp_conf/i18n/it.php b/core/src/plugins/access.ajxp_conf/i18n/it.php
@@ -149,4 +149,8 @@
 "115" => "Schema",
 "127" => "Warning, please do not use special characters, user would be created with login id '%s'",
 "128" => "Successfully deleted group",
+"129" => "Refresh plugins cache",
+"130" => "Clear plugins cache, can be necessary to see new plugins appear in the list.",
+"131" => "Plugins cache files were deleted succesfully!",
+"132" => "Cache cleared, but you are currently running in SKIP_CACHE mode (see bootstrap_context.php).",
 );
diff --git a/core/src/plugins/access.ajxp_conf/i18n/nl.php b/core/src/plugins/access.ajxp_conf/i18n/nl.php
@@ -149,5 +149,9 @@
 "126" => "Weet je zeker dat je de / het geselecteerde element(en) wilt verwijderen?",
 "127" => "Waarschuwing, gebruik geen speciale karakters, gebruiker wordt aangemaakt met login ID '%s'",
 "128" => "Successfully deleted group",
+"129" => "Refresh plugins cache",
+"130" => "Clear plugins cache, can be necessary to see new plugins appear in the list.",
+"131" => "Plugins cache files were deleted succesfully!",
+"132" => "Cache cleared, but you are currently running in SKIP_CACHE mode (see bootstrap_context.php).",
 );
 
diff --git a/core/src/plugins/access.ajxp_conf/i18n/pt.php b/core/src/plugins/access.ajxp_conf/i18n/pt.php
@@ -149,4 +149,8 @@
 "126" => "Are you sure that you want to delete the selected element(s)?",
 "127" => "Warning, please do not use special characters, user would be created with login id '%s'",
 "128" => "Successfully deleted group",
+"129" => "Refresh plugins cache",
+"130" => "Clear plugins cache, can be necessary to see new plugins appear in the list.",
+"131" => "Plugins cache files were deleted succesfully!",
+"132" => "Cache cleared, but you are currently running in SKIP_CACHE mode (see bootstrap_context.php).",
 );
diff --git a/core/src/plugins/access.ajxp_conf/i18n/ru.php b/core/src/plugins/access.ajxp_conf/i18n/ru.php
@@ -149,4 +149,8 @@
 "126" => "Уверены, что хотите удалить выделенный(е) элемент(ы)?",
 "127" => "Warning, please do not use special characters, user would be created with login id '%s'",
 "128" => "Successfully deleted group",
+"129" => "Refresh plugins cache",
+"130" => "Clear plugins cache, can be necessary to see new plugins appear in the list.",
+"131" => "Plugins cache files were deleted succesfully!",
+"132" => "Cache cleared, but you are currently running in SKIP_CACHE mode (see bootstrap_context.php).",
 );
diff --git a/core/src/plugins/access.ajxp_conf/i18n/si.php b/core/src/plugins/access.ajxp_conf/i18n/si.php
@@ -150,4 +150,8 @@
 "126" => "Are you sure that you want to delete the selected element(s)?",
 "127" => "Warning, please do not use special characters, user would be created with login id '%s'",
 "128" => "Successfully deleted group",
+"129" => "Refresh plugins cache",
+"130" => "Clear plugins cache, can be necessary to see new plugins appear in the list.",
+"131" => "Plugins cache files were deleted succesfully!",
+"132" => "Cache cleared, but you are currently running in SKIP_CACHE mode (see bootstrap_context.php).",
 );
diff --git a/core/src/plugins/action.updater/class.AjaXplorerUpgrader.php b/core/src/plugins/action.updater/class.AjaXplorerUpgrader.php
@@ -385,15 +385,8 @@ public function updateVersion()
 
     public function clearCache()
     {
-        @unlink(AJXP_PLUGINS_CACHE_FILE);
-        @unlink(AJXP_PLUGINS_REQUIRES_FILE);
-        @unlink(AJXP_PLUGINS_MESSAGES_FILE);
-        $i18nFiles = glob(dirname(AJXP_PLUGINS_MESSAGES_FILE)."/i18n/*.ser");
-        if (is_array($i18nFiles)) {
-            foreach ($i18nFiles as $file) {
-                @unlink($file);
-            }
-        }
+        AJXP_PluginsService::clearPluginsCache();
+        ConfService::clearMessagesCache();
         return "Ok";
     }
 
@@ -402,6 +395,7 @@ public function displayNote()
         if (is_file($this->workingFolder."/".$this->releaseNote)) {
             return nl2br(file_get_contents($this->workingFolder."/".$this->releaseNote));
         }
+        return "";
     }
 
     public function displayUpgradeInstructions()
diff --git a/core/src/plugins/boot.conf/class.BootConfLoader.php b/core/src/plugins/boot.conf/class.BootConfLoader.php
@@ -302,9 +302,7 @@ public function applyInstallerForm($action, $httpVars, $fileVars)
         }
 
 
-        @unlink(AJXP_PLUGINS_CACHE_FILE);
-        @unlink(AJXP_PLUGINS_REQUIRES_FILE);
-        @unlink(AJXP_PLUGINS_MESSAGES_FILE);
+        AJXP_PluginsService::clearPluginsCache();
         AJXP_Utils::setApplicationFirstRunPassed();
 
         if(isSet($htAccessToUpdate)){
