Merged in bugfix/HOR-3275 (pull request #5682)

HOR-3275

Approved-by: Julio Cesar Laura Avendaño <contact@julio-laura.com>

workflow/engine/bin/tasks/cliFlushCache.php

@@ -36,12 +36,23 @@ EOT
 CLI::taskArg('workspace', true, true);
 CLI::taskRun('run_flush_cache');
 
+/**
+ * Flush the cache files for the specified workspace.
+ * If no workspace is specified, then the cache will be flushed in all available 
+ * workspaces.
+ * 
+ * @param array $args
+ * @param array $opts
+ */
 function run_flush_cache($args, $opts)
 {
+    if (!defined("PATH_C")) {
+        die("ERROR: seems processmaker is not properly installed (System constants are missing)." . PHP_EOL);
+    }
+    $workspaces = get_workspaces_from_args($args);
     if (count($args) === 1) {
-        flush_cache($args, $opts);
+        flush_cache($workspaces[0]);
     } else {
-        $workspaces = get_workspaces_from_args($args);
         foreach ($workspaces as $workspace) {
             passthru("./processmaker flush-cache " . $workspace->name);
         }
@@ -49,67 +60,21 @@ function run_flush_cache($args, $opts)
 }
 
 /**
- * Flush the cache files for the specified workspace(s).
+ * Flush the cache files for the specified workspace.
- * If no workspace is specified, then the cache will be flushed in all available 
- * workspaces.
  * 
- * @param type $args
+ * @param object $workspace
- * @param type $opts
  */
-function flush_cache($args, $opts)
+function flush_cache($workspace)
 {
-    $rootDir = realpath(__DIR__ . "/../../../../");
+    try {
-    $app = new Maveriks\WebApplication();
+        CLI::logging("Flush " . pakeColor::colorize("system", "INFO") . " cache ... ");
-    $app->setRootDir($rootDir);
+        echo PHP_EOL;
-    $loadConstants = false;
+        echo " Update singleton in workspace " . $workspace->name . " ... ";
-    $workspaces = get_workspaces_from_args($args);
+        echo PHP_EOL;
-
+        echo " Flush workspace " . pakeColor::colorize($workspace->name, "INFO") . " cache ... " . PHP_EOL;
-    if (!defined("PATH_C")) {
+        $status = \ProcessMaker\Util\System::flushCache($workspace);
-        die("ERROR: seems processmaker is not properly installed (System constants are missing)." . PHP_EOL);
-    }
-
-    //Update singleton file by workspace
-    foreach ($workspaces as $workspace) {
-        eprint("Update singleton in workspace " . $workspace->name . " ... ");
-        Bootstrap::setConstantsRelatedWs($workspace->name);
-        $pathSingleton = PATH_DATA . "sites" . PATH_SEP . $workspace->name . PATH_SEP . "plugin.singleton";
-        $oPluginRegistry = PMPluginRegistry::loadSingleton($pathSingleton);
-        $items = \PMPlugin::getlist($workspace->name);
-        foreach ($items as $item) {
-            if ($item["sStatusFile"] === true) {
-                $path = PATH_PLUGINS . $item["sFile"];
-                require_once($path);
-                $details = $oPluginRegistry->getPluginDetails($item["sFile"]);
-                //Only if the API directory structure is defined
-                $pathApiDirectory = PATH_PLUGINS . $details->sPluginFolder . PATH_SEP . "src" . PATH_SEP . "Services" . PATH_SEP . "Api";
-                if (is_dir($pathApiDirectory)) {
-                    if (class_exists($details->sClassName)) {
-                        $oPlugin = new $details->sClassName($details->sNamespace, $details->sFilename);
-                        $oPlugin->setup();
-                        file_put_contents($pathSingleton, $oPluginRegistry->serializeInstance());
-                    }
-                }
-            }
-        }
-        eprintln("DONE");
-    }
-
-    //flush the cache files
-    CLI::logging("Flush " . pakeColor::colorize("system", "INFO") . " cache ... ");
-    G::rm_dir(PATH_C);
-    G::mk_dir(PATH_C, 0777);
-    echo "DONE" . PHP_EOL;
-
-    foreach ($workspaces as $workspace) {
-        echo "Flush workspace " . pakeColor::colorize($workspace->name, "INFO") . " cache ... ";
-
-        G::rm_dir($workspace->path . "/cache");
-        G::mk_dir($workspace->path . "/cache", 0777);
-        G::rm_dir($workspace->path . "/cachefiles");
-        G::mk_dir($workspace->path . "/cachefiles", 0777);
-        if (file_exists($workspace->path . '/routes.php')) {
-            unlink($workspace->path . '/routes.php');
-        }
         echo "DONE" . PHP_EOL;
+    } catch (Exception $e) {
+        echo $e->getMessage() . PHP_EOL;
     }
 }

workflow/engine/classes/class.plugin.php

@@ -520,7 +520,7 @@ class PMPlugin
      * @param string $workspace
      * @return array
      */
-    public static function getList($workspace)
+    public static function getListPluginsManager($workspace)
     {
         $items = Array();
         $aPluginsPP = array();
@@ -576,6 +576,34 @@ class PMPlugin
         }
         return $items;
     }
+    
+    /**
+     * Gets a general list of all plugins within processmaker per workspace.
+     * 
+     * @param string $workspace
+     * @return array
+     */
+    public static function getListAllPlugins($workspace)
+    {
+        PMPluginRegistry::saveState();
+        $pathSingleton = PATH_DATA . "sites" . PATH_SEP . $workspace . PATH_SEP . "plugin.singleton";
+        $oPluginRegistry = PMPluginRegistry::loadSingleton($pathSingleton);
+        $items = [];
+        if ($handle = opendir(PATH_PLUGINS)) {
+            while (false !== ($file = readdir($handle))) {
+                if (strpos($file, '.php', 1) && is_file(PATH_PLUGINS . $file)) {
+                    include_once (PATH_PLUGINS . $file);
+                    $detail = $oPluginRegistry->getPluginDetails($file);
+                    if ($detail !== null) {
+                        $items[] = $detail;
+                    }
+                }
+            }
+            closedir($handle);
+        }
+        PMPluginRegistry::restoreState();
+        return $items;
+    }
 
 }
 

workflow/engine/classes/class.pluginRegistry.php

@@ -122,6 +122,7 @@ class PMPluginRegistry
     private $_restServiceEnabled = array();
 
     private static $instance = null;
+    private static $stateSaved = null;
 
     /**
      * This function is the constructor of the PMPluginRegistry class
@@ -1946,4 +1947,28 @@ class PMPluginRegistry
         }
     }
 
+    /**
+     * Saves the state of instance, in the private property 'stateSaved'. 
+     * Use the 'restoreState()' method to put the instance in the saved state.
+     */
+    public static function saveState()
+    {
+        $pluginRegistry = PMPluginRegistry::getSingleton();
+        self::$stateSaved = $pluginRegistry->serializeInstance();
+    }
+
+    /**
+     * Restores the state of the instance that is in the private variable 'stateSaved'. 
+     * You must save the state of the instacia with the method 'saveState()' 
+     * before being called.
+     */
+    public static function restoreState()
+    {
+        if (self::$stateSaved !== null) {
+            $pluginRegistry = PMPluginRegistry::getSingleton();
+            self::$instance = $pluginRegistry->unSerializeInstance(self::$stateSaved);
+            self::$stateSaved = null;
+        }
+    }
+
 }

workflow/engine/methods/setup/pluginsList.php

@@ -25,5 +25,5 @@
 $RBAC->requirePermissions('PM_SETUP_ADVANCE');
 
 G::LoadClass('plugin');
-$items = \PMPlugin::getlist(SYS_SYS);
+$items = \PMPlugin::getListPluginsManager(SYS_SYS);
 echo G::json_encode($items);

workflow/engine/src/ProcessMaker/Util/System.php

@@ -19,5 +19,53 @@ class System
             throw $e;
         }
     }
-}
 
+    /**
+     * Flush the cache files for the specified workspace.
+     * 
+     * @param object $workspace
+     */
+    public static function flushCache($workspace)
+    {
+        try {
+            //Update singleton file by workspace
+            \Bootstrap::setConstantsRelatedWs($workspace->name);
+            $pathSingleton = PATH_DATA . "sites" . PATH_SEP . $workspace->name . PATH_SEP . "plugin.singleton";
+            $oPluginRegistry = \PMPluginRegistry::loadSingleton($pathSingleton);
+            $items = \PMPlugin::getListAllPlugins($workspace->name);
+            foreach ($items as $item) {
+                if ($item->enabled === true) {
+                    require_once($item->sFilename);
+                    $details = $oPluginRegistry->getPluginDetails(basename($item->sFilename));
+                    //Only if the API directory structure is defined
+                    $pathApiDirectory = PATH_PLUGINS . $details->sPluginFolder . PATH_SEP . "src" . PATH_SEP . "Services" . PATH_SEP . "Api";
+                    if (is_dir($pathApiDirectory)) {
+                        $pluginSrcDir = PATH_PLUGINS . $details->sNamespace . PATH_SEP . 'src';
+                        $loader = \Maveriks\Util\ClassLoader::getInstance();
+                        $loader->add($pluginSrcDir);
+                        $oPluginRegistry->registerRestService($details->sNamespace);
+                        if (class_exists($details->sClassName)) {
+                            $oPlugin = new $details->sClassName($details->sNamespace, $details->sFilename);
+                            $oPlugin->setup();
+                        }
+                        file_put_contents($pathSingleton, $oPluginRegistry->serializeInstance());
+                    }
+                }
+            }
+
+            //flush the cache files
+            \G::rm_dir(PATH_C);
+            \G::mk_dir(PATH_C, 0777);
+            \G::rm_dir($workspace->path . "/cache");
+            \G::mk_dir($workspace->path . "/cache", 0777);
+            \G::rm_dir($workspace->path . "/cachefiles");
+            \G::mk_dir($workspace->path . "/cachefiles", 0777);
+            if (file_exists($workspace->path . '/routes.php')) {
+                unlink($workspace->path . '/routes.php');
+            }
+        } catch (\Exception $e) {
+            throw new \Exception("Error: cannot perform this task. " . $e->getMessage());
+        }
+    }
+
+}