Merge branch 'develop' of https://github.com/pydio/pydio-core into fragementOnAccessDriver

Author: c12simple

README.md

@@ -2,15 +2,17 @@
 
 [Homepage](https://pyd.io/) |
 [GitHub-Repository](https://github.com/pydio/pydio-core) |
-[Issue-Tracker](https://github.com/pydio/pydio-core/issues)
+[Issue-Tracker](https://github.com/pydio/pydio-core/issues) |
+ [![Codacy Badge](https://api.codacy.com/project/badge/3b5cafea44e949e789d1928687e04032)](https://www.codacy.com/app/charles_3085/pydio-core)
 
 This is the main source code repository of Pydio (formerly AjaXplorer), containing all the PHP server and HTML5 Web GUI.
 
-* Latest Stable release : 6.0.5
+* Latest Stable release : 6.0.8
 * Latest Dev release : 5.3.4 (was RC4 for Pydio 6.0.0)
 * License: [AGPLv3](https://www.gnu.org/licenses/agpl.html)
 * Lead developer  : Charles du Jeu (cdujeu): [Github](https://github.com/cdujeu) | [Twitter](https://twitter.com/Pydio)
 
+
 ### Getting support
 
 Please DO NOT send emails to Charles, but use the forum located on http://pyd.io/f/ instead. Once your problem is qualified, if it's a bug, you will be asked to enter it in the GitHub issue tracker.

core/src/conf/RELEASE_NOTE

@@ -70,7 +70,7 @@
 
 // KEY-VALUE-CACHE
 define("AJXP_KVCACHE_PREFIX", "pydio-unique-id");
-define("AJXP_KVCACHE_IGNORE", false);
+define("AJXP_KVCACHE_IGNORE", true);
 
 // DEBUG OPTIONS
 define("AJXP_CLIENT_DEBUG"  ,	false);

core/src/conf/bootstrap_context.php

@@ -20,6 +20,10 @@
  */
 defined('AJXP_EXEC') or die( 'Access not allowed');
 
+/**
+ * Class AJXP_AbstractMetaSource
+ * Abstract class from which all meta.* plugins must extend.
+ */
 abstract class AJXP_AbstractMetaSource extends AJXP_Plugin {
 
     /**

core/src/core/classes/class.AJXP_AbstractMetaSource.php

@@ -27,8 +27,6 @@
  */
 class AJXP_Cache
 {
-    private static $instance;
-
     protected $cacheDir;
     protected $cacheId;
     protected $masterFile;
@@ -39,7 +37,7 @@ class AJXP_Cache
      * Create an AJXP_Cache instance
      * @param string $pluginId
      * @param string $filepath
-     * @param Function $dataCallback A function to generate the data cache. If no callback provided, will simply use the content of the master item as the cache data
+     * @param callable $dataCallback A function to generate the data cache. If no callback provided, will simply use the content of the master item as the cache data
      * @param string $idComputerCallback A function to generate the ID of the cache. If not provided, will generate a random hash
      * @return AJXP_Cache
      */

core/src/core/classes/class.AJXP_Cache.php

@@ -83,7 +83,8 @@ public static function findRestActionAndApply($actionName, $path)
         }
         $restPath = $restPathList->item(0)->nodeValue;
         $paramNames = explode("/", trim($restPath, "/"));
-        $path = array_shift(explode("?", $path));
+        $exploded = explode("?", $path);
+        $path = array_shift($exploded);
         $paramValues = array_map("urldecode", explode("/", trim($path, "/"), count($paramNames)));
         foreach ($paramNames as $i => $pName) {
             if (strpos($pName, "+") !== false) {
@@ -344,6 +345,7 @@ public static function runCommandInBackground($cmd, $logFile)
                   file_put_contents($tmpBat, $cmd);
                   pclose(popen('start /b "CLI" "'.$tmpBat.'"', 'r'));
               }
+            return null;
         } else {
             $process = new UnixProcess($cmd, (AJXP_SERVER_DEBUG?$logFile:null));
             AJXP_Logger::debug("Starting process and sending output dev null");
@@ -361,7 +363,7 @@ public static function runCommandInBackground($cmd, $logFile)
      * @param array $httpVars
      * @param array $fileVars
      * @param bool $multiple
-     * @return DOMElement|bool
+     * @return DOMElement|bool|DOMElement[]
      */
     private static function getCallbackNode($xPath, $actionNode, $query ,$actionName, $httpVars, $fileVars, $multiple = true)
     {
@@ -387,7 +389,7 @@ private static function getCallbackNode($xPath, $actionNode, $query ,$actionName
      * Check in the callback node if an applyCondition XML attribute exists, and eval its content.
      * The content must set an $apply boolean as result
      * @static
-     * @param DOMElement $callback
+     * @param DOMElement|DOMNode $callback
      * @param string $actionName
      * @param array $httpVars
      * @param array $fileVars
@@ -441,6 +443,7 @@ private static function applyCallback($callback, &$actionName, &$httpVars, &$fil
         } else {
             throw new AJXP_Exception("Cannot find method $methodName for plugin $plugId!");
         }
+        return null;
     }
 
     /**
@@ -471,6 +474,9 @@ public static function applyHook($hookName, $args, $forceNonDefer = false)
         $callbacks = $xPath->query("hooks/serverCallback[@hookName='$hookName']");
         if(!$callbacks->length) return ;
         self::$hooksCache[$hookName] = array();
+        /**
+         * @var $callback DOMElement
+         */
         foreach ($callbacks as $callback) {
             $defer = ($callback->getAttribute("defer") === "true");
             $applyCondition = $callback->getAttribute("applyCondition");

core/src/core/classes/class.AJXP_Controller.php

@@ -26,7 +26,7 @@
  */
 class AJXP_Exception extends Exception
 {
-    public function AJXP_Exception($messageString, $messageId = false)
+    public function __construct($messageString, $messageId = false)
     {
         if ($messageId !== false && class_exists("ConfService")) {
             $messages = ConfService::getMessages();

core/src/core/classes/class.AJXP_Exception.php

@@ -31,10 +31,10 @@ class AJXP_JSPacker
      * Static function for packing all js and css into big files
      * Auto detect /js/*_list.txt files and /css/*_list.txt files and pack them.
      */
-    public function pack()
+    public static function pack()
     {
         // Make sure that the gui.* plugin is loaded
-        $plug = AJXP_PluginsService::getInstance()->getPluginsByType("gui");
+        AJXP_PluginsService::getInstance()->getPluginsByType("gui");
 
         $sList = glob(CLIENT_RESOURCES_FOLDER."/js/*_list.txt");
         foreach ($sList as $list) {

core/src/core/classes/class.AJXP_JSPacker.php

@@ -21,7 +21,17 @@
 
 defined('AJXP_EXEC') or die('Access not allowed');
 
-
+/**
+ * Class AJXP_MetaStreamWrapper
+ *
+ * Global streamWrapper that encapsulates all wrappers to access a driver's resource.
+ * Registered under the "pydio" protocol, it should replace all the old ajxp.XX direct calls.
+ * The static "appendMetaWrapper" method allows to add additional wrapper that will be sequentially called until
+ * reaching the driver ajxp.XX wrapper.
+ *
+ * @package Pydio
+ * @subpackage Core
+ */
 class AJXP_MetaStreamWrapper implements AjxpWrapper
 {
     /**
@@ -40,6 +50,10 @@ class AJXP_MetaStreamWrapper implements AjxpWrapper
 
     protected static $cachedRepositoriesWrappers = array();
 
+    /**
+     * Register the stack of protocols/wrappers.
+     * @param null $registered_wrappers
+     */
     public static function register($registered_wrappers = null){
         if($registered_wrappers == null){
             $registered_wrappers = stream_get_wrappers();
@@ -51,6 +65,11 @@ public static function register($registered_wrappers = null){
         }
     }
 
+    /**
+     * Register an addition protocol/wrapper in the stack
+     * @param $name string
+     * @param $className string
+     */
     public static function appendMetaWrapper($name, $className){
         self::$metaWrappers[$name] = $className;
         self::register();
@@ -105,6 +124,12 @@ protected static function actualRepositoryWrapperData($repositoryId){
         }
     }
 
+    /**
+     * Return the final ajxp.XX wrapper class name.
+     * @param $repositoryId
+     * @return string mixed
+     * @throws Exception
+     */
     public static function actualRepositoryWrapperClass($repositoryId){
         $data = self::actualRepositoryWrapperData($repositoryId);
         return $data["classname"];

core/src/core/classes/class.AJXP_MetaStreamWrapper.php

@@ -533,7 +533,7 @@ public function __get($varName)
      * Magic setter for metadata
      * @param $metaName
      * @param $metaValue
-     * @return
+     * @return void
      */
     public function __set($metaName, $metaValue)
     {

core/src/core/classes/class.AJXP_Node.php

@@ -21,7 +21,15 @@
 
 defined('AJXP_EXEC') or die('Access not allowed');
 
-
+/**
+ * Class AJXP_Permission
+ *
+ * Atomic permission associated to a folder path. Can be initialized either with an integer
+ * value (use MASK constants) or with a string value like "r", "rw", etc.
+ *
+ * @package Pydio
+ * @subpackage Core
+ */
 class AJXP_Permission implements JsonSerializable
 {
     /**
@@ -55,25 +63,32 @@ function __construct($value = null){
         }
     }
 
+    /**
+     * Replicate this permission.
+     * @return AJXP_Permission
+     */
     function getCopy(){
         return new AJXP_Permission($this->value);
     }
 
     /**
+     * Test if the permission is readable
      * @return bool
      */
     function canRead(){
         return ($this->value & self::READ) === self::READ;
     }
 
     /**
+     * Test if the permission is writeable
      * @return bool
      */
     function canWrite(){
         return ($this->value & self::WRITE) === self::WRITE;
     }
 
     /**
+     * Test if the permission denies access, whatever happens.
      * @return bool
      */
     function denies(){
@@ -82,10 +97,20 @@ function denies(){
         return false;
     }
 
+    /**
+     * Test if the permission is just empty
+     * @return bool
+     */
     function isEmpty(){
         return $this->value === 0;
     }
 
+    /**
+     * Test permission against an integer value
+     * @param int $numPerm
+     * @return bool
+     * @throws Exception
+     */
     function testPermission($numPerm){
         if(is_integer($numPerm) && ($numPerm < self::MASK)){
             $numPerm = $numPerm & self::MASK;
@@ -99,20 +124,34 @@ function testPermission($numPerm){
         }
     }
 
+    /**
+     * Set this permission as readable
+     * @param bool|true $value
+     */
     function setRead($value = true){
         if($value)
             $this->value = $this->value | self::READ;
         else{
             $this->value = $this->value & (self::READ ^ self::MASK);
         }
     }
+
+    /**
+     * Set this permission as writeable
+     * @param bool|true $value
+     */
     function setWrite($value = true){
         if($value)
             $this->value = $this->value | self::WRITE;
         else{
             $this->value = $this->value & (self::WRITE ^ self::MASK);
         }
     }
+
+    /**
+     * Set this permission as denied
+     * @param bool|true $value
+     */
     function setDeny($value = true){
         if($value)
             $this->value = self::DENY;
@@ -122,6 +161,7 @@ function setDeny($value = true){
     }
 
     /**
+     * Override this permission value with the one passed in parameter
      * @param AJXP_Permission $perm
      * @return AJXP_Permission
      */