YetiForceCompany / YetiForceCRM

libraries/nusoap/nusoapmime.php

Doc Comments +1 added lines, -1 removed lines

@@ -447,7 +447,7 @@
 	*
 	* @param	array	$headers	The HTTP headers
 	* @param	string	$data		unprocessed request data from client
-	* @return	mixed	value of the message, decoded into a PHP type
+	* @return	false|null	value of the message, decoded into a PHP type
 	* @access   private
 	*/
     function parseRequest($headers, $data) {

Spacing +2 added lines, -2 removed lines

@@ -86,7 +86,7 @@ 
 	* @access public
 	*/
 	public function addAttachment($data, $filename = '', $contenttype = 'application/octet-stream', $cid = false) {
-		if (! $cid) {
+		if (!$cid) {
 			$cid = md5(uniqid(time()));
 		}
 
@@ -316,7 +316,7 @@ 
 	* @access public
 	*/
 	public function addAttachment($data, $filename = '', $contenttype = 'application/octet-stream', $cid = false) {
-		if (! $cid) {
+		if (!$cid) {
 			$cid = md5(uniqid(time()));
 		}
 

Indentation +112 added lines, -112 removed lines

@@ -71,20 +71,20 @@ 
 	var $mimeContentType;
 	
 	/**
-	* adds a MIME attachment to the current request.
-	*
-	* If the $data parameter contains an empty string, this method will read
-	* the contents of the file named by the $filename parameter.
-	*
-	* If the $cid parameter is false, this method will generate the cid.
-	*
-	* @param string $data The data of the attachment
-	* @param string $filename The filename of the attachment (default is empty string)
-	* @param string $contenttype The MIME Content-Type of the attachment (default is application/octet-stream)
-	* @param string $cid The content-id (cid) of the attachment (default is false)
-	* @return string The content-id (cid) of the attachment
-	* @access public
-	*/
+	 * adds a MIME attachment to the current request.
+	 *
+	 * If the $data parameter contains an empty string, this method will read
+	 * the contents of the file named by the $filename parameter.
+	 *
+	 * If the $cid parameter is false, this method will generate the cid.
+	 *
+	 * @param string $data The data of the attachment
+	 * @param string $filename The filename of the attachment (default is empty string)
+	 * @param string $contenttype The MIME Content-Type of the attachment (default is application/octet-stream)
+	 * @param string $cid The content-id (cid) of the attachment (default is false)
+	 * @return string The content-id (cid) of the attachment
+	 * @access public
+	 */
 	public function addAttachment($data, $filename = '', $contenttype = 'application/octet-stream', $cid = false) {
 		if (! $cid) {
 			$cid = md5(uniqid(time()));
@@ -101,35 +101,35 @@ 
 	}
 
 	/**
-	* clears the MIME attachments for the current request.
-	*
-	* @access public
-	*/
+	 * clears the MIME attachments for the current request.
+	 *
+	 * @access public
+	 */
 	public function clearAttachments() {
 		$this->requestAttachments = array();
 	}
 
 	/**
-	* gets the MIME attachments from the current response.
-	*
-	* Each array element in the return is an associative array with keys
-	* data, filename, contenttype, cid.  These keys correspond to the parameters
-	* for addAttachment.
-	*
-	* @return array The attachments.
-	* @access public
-	*/
+	 * gets the MIME attachments from the current response.
+	 *
+	 * Each array element in the return is an associative array with keys
+	 * data, filename, contenttype, cid.  These keys correspond to the parameters
+	 * for addAttachment.
+	 *
+	 * @return array The attachments.
+	 * @access public
+	 */
 	public function getAttachments() {
 		return $this->responseAttachments;
 	}
 
 	/**
-	* gets the HTTP body for the current request.
-	*
-	* @param string $soapmsg The SOAP payload
-	* @return string The HTTP body, which includes the SOAP payload
-	* @access private
-	*/
+	 * gets the HTTP body for the current request.
+	 *
+	 * @param string $soapmsg The SOAP payload
+	 * @return string The HTTP body, which includes the SOAP payload
+	 * @access private
+	 */
 	public function getHTTPBody($soapmsg) {
 		if (count($this->requestAttachments) > 0) {
 			$params['content_type'] = 'multipart/related; type="text/xml"';
@@ -182,13 +182,13 @@ 
 	}
 	
 	/**
-	* gets the HTTP content type for the current request.
-	*
-	* Note: getHTTPBody must be called before this.
-	*
-	* @return string the HTTP content type for the current request.
-	* @access private
-	*/
+	 * gets the HTTP content type for the current request.
+	 *
+	 * Note: getHTTPBody must be called before this.
+	 *
+	 * @return string the HTTP content type for the current request.
+	 * @access private
+	 */
 	public function getHTTPContentType() {
 		if (count($this->requestAttachments) > 0) {
 			return $this->mimeContentType;
@@ -197,14 +197,14 @@ 
 	}
 	
 	/**
-	* gets the HTTP content type charset for the current request.
-	* returns false for non-text content types.
-	*
-	* Note: getHTTPBody must be called before this.
-	*
-	* @return string the HTTP content type charset for the current request.
-	* @access private
-	*/
+	 * gets the HTTP content type charset for the current request.
+	 * returns false for non-text content types.
+	 *
+	 * Note: getHTTPBody must be called before this.
+	 *
+	 * @return string the HTTP content type charset for the current request.
+	 * @access private
+	 */
 	public function getHTTPContentTypeCharset() {
 		if (count($this->requestAttachments) > 0) {
 			return false;
@@ -213,14 +213,14 @@ 
 	}
 
 	/**
-	* processes SOAP message returned from server
-	*
-	* @param	array	$headers	The HTTP headers
-	* @param	string	$data		unprocessed response data from server
-	* @return	mixed	value of the message, decoded into a PHP type
-	* @access   private
-	*/
-    public function parseResponse($headers, $data) {
+	 * processes SOAP message returned from server
+	 *
+	 * @param	array	$headers	The HTTP headers
+	 * @param	string	$data		unprocessed response data from server
+	 * @return	mixed	value of the message, decoded into a PHP type
+	 * @access   private
+	 */
+	public function parseResponse($headers, $data) {
 		$this->debug('Entering parseResponse() for payload of length ' . strlen($data) . ' and type of ' . $headers['content-type']);
 		$this->responseAttachments = array();
 		if (strstr($headers['content-type'], 'multipart/related')) {
@@ -301,20 +301,20 @@ 
 	var $mimeContentType;
 	
 	/**
-	* adds a MIME attachment to the current response.
-	*
-	* If the $data parameter contains an empty string, this method will read
-	* the contents of the file named by the $filename parameter.
-	*
-	* If the $cid parameter is false, this method will generate the cid.
-	*
-	* @param string $data The data of the attachment
-	* @param string $filename The filename of the attachment (default is empty string)
-	* @param string $contenttype The MIME Content-Type of the attachment (default is application/octet-stream)
-	* @param string $cid The content-id (cid) of the attachment (default is false)
-	* @return string The content-id (cid) of the attachment
-	* @access public
-	*/
+	 * adds a MIME attachment to the current response.
+	 *
+	 * If the $data parameter contains an empty string, this method will read
+	 * the contents of the file named by the $filename parameter.
+	 *
+	 * If the $cid parameter is false, this method will generate the cid.
+	 *
+	 * @param string $data The data of the attachment
+	 * @param string $filename The filename of the attachment (default is empty string)
+	 * @param string $contenttype The MIME Content-Type of the attachment (default is application/octet-stream)
+	 * @param string $cid The content-id (cid) of the attachment (default is false)
+	 * @return string The content-id (cid) of the attachment
+	 * @access public
+	 */
 	public function addAttachment($data, $filename = '', $contenttype = 'application/octet-stream', $cid = false) {
 		if (! $cid) {
 			$cid = md5(uniqid(time()));
@@ -331,35 +331,35 @@ 
 	}
 
 	/**
-	* clears the MIME attachments for the current response.
-	*
-	* @access public
-	*/
+	 * clears the MIME attachments for the current response.
+	 *
+	 * @access public
+	 */
 	public function clearAttachments() {
 		$this->responseAttachments = array();
 	}
 
 	/**
-	* gets the MIME attachments from the current request.
-	*
-	* Each array element in the return is an associative array with keys
-	* data, filename, contenttype, cid.  These keys correspond to the parameters
-	* for addAttachment.
-	*
-	* @return array The attachments.
-	* @access public
-	*/
+	 * gets the MIME attachments from the current request.
+	 *
+	 * Each array element in the return is an associative array with keys
+	 * data, filename, contenttype, cid.  These keys correspond to the parameters
+	 * for addAttachment.
+	 *
+	 * @return array The attachments.
+	 * @access public
+	 */
 	public function getAttachments() {
 		return $this->requestAttachments;
 	}
 
 	/**
-	* gets the HTTP body for the current response.
-	*
-	* @param string $soapmsg The SOAP payload
-	* @return string The HTTP body, which includes the SOAP payload
-	* @access private
-	*/
+	 * gets the HTTP body for the current response.
+	 *
+	 * @param string $soapmsg The SOAP payload
+	 * @return string The HTTP body, which includes the SOAP payload
+	 * @access private
+	 */
 	public function getHTTPBody($soapmsg) {
 		if (count($this->responseAttachments) > 0) {
 			$params['content_type'] = 'multipart/related; type="text/xml"';
@@ -412,13 +412,13 @@ 
 	}
 	
 	/**
-	* gets the HTTP content type for the current response.
-	*
-	* Note: getHTTPBody must be called before this.
-	*
-	* @return string the HTTP content type for the current response.
-	* @access private
-	*/
+	 * gets the HTTP content type for the current response.
+	 *
+	 * Note: getHTTPBody must be called before this.
+	 *
+	 * @return string the HTTP content type for the current response.
+	 * @access private
+	 */
 	public function getHTTPContentType() {
 		if (count($this->responseAttachments) > 0) {
 			return $this->mimeContentType;
@@ -427,14 +427,14 @@ 
 	}
 	
 	/**
-	* gets the HTTP content type charset for the current response.
-	* returns false for non-text content types.
-	*
-	* Note: getHTTPBody must be called before this.
-	*
-	* @return string the HTTP content type charset for the current response.
-	* @access private
-	*/
+	 * gets the HTTP content type charset for the current response.
+	 * returns false for non-text content types.
+	 *
+	 * Note: getHTTPBody must be called before this.
+	 *
+	 * @return string the HTTP content type charset for the current response.
+	 * @access private
+	 */
 	public function getHTTPContentTypeCharset() {
 		if (count($this->responseAttachments) > 0) {
 			return false;
@@ -443,14 +443,14 @@ 
 	}
 
 	/**
-	* processes SOAP message received from client
-	*
-	* @param	array	$headers	The HTTP headers
-	* @param	string	$data		unprocessed request data from client
-	* @return	mixed	value of the message, decoded into a PHP type
-	* @access   private
-	*/
-    public function parseRequest($headers, $data) {
+	 * processes SOAP message received from client
+	 *
+	 * @param	array	$headers	The HTTP headers
+	 * @param	string	$data		unprocessed request data from client
+	 * @return	mixed	value of the message, decoded into a PHP type
+	 * @access   private
+	 */
+	public function parseRequest($headers, $data) {
 		$this->debug('Entering parseRequest() for payload of length ' . strlen($data) . ' and type of ' . $headers['content-type']);
 		$this->requestAttachments = array();
 		if (strstr($headers['content-type'], 'multipart/related')) {

libraries/restler/restler.php

Doc Comments +21 added lines, -4 removed lines

@@ -268,9 +268,9 @@ 
      *
      * All the protected methods that do not start with _ (underscore)
      * will exposed as protected api which will require authentication
-     * @param string $class name of the service class
-     * @param string $basePath optional url prefix for mapping, uses
+     * @param string $base_path optional url prefix for mapping, uses
      * lowercase version of the class name when not specified
+     * @param string $class_name
      * @throws Exception when supplied with invalid class name
      */
     public function addAPIClass($class_name, $base_path = null)
@@ -322,8 +322,8 @@ 
 
     /**
      * Convenience method to respond with an error message
-     * @param int $statusCode http error code
-     * @param string $errorMessage optional custom error message
+     * @param int $status_code http error code
+     * @param string $error_message optional custom error message
      */
     public function handleError($status_code, $error_message = null)
     {
@@ -916,6 +916,10 @@ 
 {
 
 
+    /**
+     * @param integer $http_status_code
+     * @param string $error_message
+     */
     public function __construct($http_status_code, $error_message = null)
     {
         parent::__construct($error_message, $http_status_code);
@@ -1033,12 +1037,14 @@ 
     /**
      * Set the selected MIME type
      * @param string $mime MIME type
+     * @return void
      */
     public function setMIME($mime);
 
 
     /**
      * Get selected MIME type
+     * @return string
      */
     public function getMIME();
 
@@ -1046,6 +1052,7 @@ 
     /**
      * Set the selected file extension
      * @param string $extension file extension
+     * @return void
      */
     public function setExtension($extension);
 
@@ -1349,6 +1356,9 @@ 
     }
 
 
+    /**
+     * @param string[] $lines
+     */
     private function parseLines($lines)
     {
         foreach ($lines as $line) {
@@ -1398,6 +1408,10 @@ 
     }
 
 
+    /**
+     * @param string $param
+     * @param string $value
+     */
     private function setParam($param, $value)
     {
         if ($param == 'param' || $param == 'return') {
@@ -1454,6 +1468,9 @@ 
 //
 // ------------------------------------------------------------------
 
+/**
+ * @param string $php_doc_comment
+ */
 function parse_doc($php_doc_comment)
 {
     $p = new DocParser();

Spacing +7 added lines, -11 removed lines

@@ -472,9 +472,9 @@ 
         header('Content-Type: ' . $this->response_format->getMIME());
         //.'; charset=utf-8');
         header("X-Powered-By: Luracast Restler v" . Restler::VERSION);
-		if($this->production_mode){
+		if ($this->production_mode) {
 			die($data);
-		}else{
+		} else {
 			echo $data;
 		}
     }
@@ -649,8 +649,7 @@ 
                 $parts = explode(';q=', trim($accept));
                 $type = array_shift($parts);
                 $quality = count($parts) ? 
-                    floatval(array_shift($parts)) : 
-                    (1000 - $pos) / 1000;
+                    floatval(array_shift($parts)) : (1000 - $pos) / 1000;
                 $acceptList[$type] = $quality;
             }
             arsort($acceptList);
@@ -839,8 +838,7 @@ 
                 $position++;
             }
             $method_flag = $method->isProtected() ? 
-                (isRestlerCompatibilityModeEnabled() ? 2 : 3) : 
-                (isset($metadata['protected']) ? 1 : 0);
+                (isRestlerCompatibilityModeEnabled() ? 2 : 3) : (isset($metadata['protected']) ? 1 : 0);
 
             //take note of the order
             $call = array(
@@ -873,8 +871,7 @@ 
                     $http_method = 'GET';
                 }
                 $url = $base_path
-                    . ($method_url == 'index' || $method_url == 'default' ? '' :
-                        $method_url);
+                    . ($method_url == 'index' || $method_url == 'default' ? '' : $method_url);
                 $url = rtrim($url, '/');
                 $this->routes[$http_method][$url] = $call;
                 foreach ($params as $param) {
@@ -1198,8 +1195,7 @@ 
     public function encode($data, $human_readable = false)
     {
         return $human_readable ? 
-            $this->json_format(json_encode(object_to_array($data))) : 
-            json_encode(object_to_array($data));
+            $this->json_format(json_encode(object_to_array($data))) : json_encode(object_to_array($data));
     }
 
 
@@ -1225,7 +1221,7 @@ 
                     $message = 'malformed JSON';
                     break;
                 case JSON_ERROR_UTF8:
-                    $message = 'malformed UTF-8 characters, '.
+                    $message = 'malformed UTF-8 characters, ' .
                         'possibly incorrectly encoded';
                     break;
                 default:

Braces +1 added lines, -1 removed lines

@@ -474,7 +474,7 @@
         header("X-Powered-By: Luracast Restler v" . Restler::VERSION);
 		if($this->production_mode){
 			die($data);
-		}else{
+		} else{
 			echo $data;
 		}
     }

Indentation +1299 added lines, -1299 removed lines

@@ -16,883 +16,883 @@ 
  */
 class Restler
 {
-    // ==================================================================
-    //
-    // Public variables
-    //
-    // ------------------------------------------------------------------
-
-    const VERSION = '2.2.1';
-
-    /**
-     * URL of the currently mapped service
-     * @var string
-     */
-    public $url;
-
-    /**
-     * Http request method of the current request.
-     * Any value between [GET, PUT, POST, DELETE]
-     * @var string
-     */
-    public $request_method;
-
-    /**
-     * Requested data format. Instance of the current format class
-     * which implements the iFormat interface
-     * @var iFormat
-     * @example jsonFormat, xmlFormat, yamlFormat etc
-     */
-    public $request_format;
-
-    /**
-     * Data sent to the service
-     * @var array
-     */
-    public $request_data = array();
-
-    /**
-     * Used in production mode to store the URL Map to disk
-     * @var string
-     */
-    public $cache_dir;
-
-    /**
-     * base directory to locate format and auth files
-     * @var string
-     */
-    public $base_dir;
-
-    /**
-     * Name of an iRespond implementation class
-     * @var string
-     */
-    public $response = 'DefaultResponse';
-
-    /**
-     * Response data format. Instance of the current format class
-     * which implements the iFormat interface
-     * @var iFormat
-     * @example jsonFormat, xmlFormat, yamlFormat etc
-     */
-    public $response_format;
-
-    // ==================================================================
-    //
-    // Private & Protected variables
-    //
-    // ------------------------------------------------------------------
-
-    /**
-     * When set to false, it will run in debug mode and parse the
-     * class files every time to map it to the URL
-     * @var boolean
-     */
-    protected $production_mode;
-
-    /**
-     * Associated array that maps urls to their respective class and method
-     * @var array
-     */
-    protected $routes = array();
-
-    /**
-     * Associated array that maps formats to their respective format class name
-     * @var array
-     */
-    protected $format_map = array();
-
-    /**
-     * Instance of the current api service class
-     * @var object
-     */
-    protected $service_class_instance;
-
-    /**
-     * Name of the api method being called
-     * @var string
-     */
-    protected $service_method;
-
-    /**
-     * list of authentication classes
-     * @var array
-     */
-    protected $auth_classes = array();
-
-    /**
-     * list of error handling classes
-     * @var array
-     */
-    protected $error_classes = array();
-
-    /**
-     * HTTP status codes
-     * @var array
-     */
-    private $codes = array(
-        100 => 'Continue',
-        101 => 'Switching Protocols',
-        200 => 'OK',
-        201 => 'Created',
-        202 => 'Accepted',
-        203 => 'Non-Authoritative Information',
-        204 => 'No Content',
-        205 => 'Reset Content',
-        206 => 'Partial Content',
-        300 => 'Multiple Choices',
-        301 => 'Moved Permanently',
-        302 => 'Found',
-        303 => 'See Other',
-        304 => 'Not Modified',
-        305 => 'Use Proxy',
-        306 => '(Unused)',
-        307 => 'Temporary Redirect',
-        400 => 'Bad Request',
-        401 => 'Unauthorized',
-        402 => 'Payment Required',
-        403 => 'Forbidden',
-        404 => 'Not Found',
-        405 => 'Method Not Allowed',
-        406 => 'Not Acceptable',
-        407 => 'Proxy Authentication Required',
-        408 => 'Request Timeout',
-        409 => 'Conflict',
-        410 => 'Gone',
-        411 => 'Length Required',
-        412 => 'Precondition Failed',
-        413 => 'Request Entity Too Large',
-        414 => 'Request-URI Too Long',
-        415 => 'Unsupported Media Type',
-        416 => 'Requested Range Not Satisfiable',
-        417 => 'Expectation Failed',
-        500 => 'Internal Server Error',
-        501 => 'Not Implemented',
-        502 => 'Bad Gateway',
-        503 => 'Service Unavailable',
-        504 => 'Gateway Timeout',
-        505 => 'HTTP Version Not Supported'
-    );
-
-    /**
-     * Caching of url map is enabled or not
-     * @var boolean
-     */
-    protected $cached;
-
-    // ==================================================================
-    //
-    // Public functions
-    //
-    // ------------------------------------------------------------------
-
-
-    /**
-     * Constructor
-     * @param boolean $production_mode When set to false, it will run in
-     * debug mode and parse the class files every time to map it to the URL
-     */
-    public function __construct($production_mode = false)
-    {
-        $this->production_mode = $production_mode;
-        $this->cache_dir = getcwd();
-        $this->base_dir = RESTLER_PATH;
-    }
-
-
-    /**
-     * Store the url map cache if needed
-     */
-    public function __destruct()
-    {
-        if ($this->production_mode && !($this->cached)) {
-            $this->saveCache();
-        }
-    }
-
-
-    /**
-     * Use it in production mode to refresh the url map cache
-     */
-    public function refreshCache()
-    {
-        $this->routes = array();
-        $this->cached = false;
-    }
-
-
-    /**
-     * Call this method and pass all the formats that should be
-     * supported by the API. Accepts multiple parameters
-     * @param string class name of the format class that implements iFormat
-     * @example $restler->setSupportedFormats('JsonFormat', 'XmlFormat'...);
-     */
-    public function setSupportedFormats()
-    {
-        $args = func_get_args();
-        $extensions = array();
-        foreach ($args as $class_name) {
-            if (!is_string($class_name) || !class_exists($class_name)) {
-                throw new Exception("$class_name is not a vaild Format Class.");
-            }
-            $obj = new $class_name;
-            if (!($obj instanceof iFormat)) {
-                throw new Exception('Invalid format class; must implement '
-                    . 'iFormat interface');
-            }
-            foreach ($obj->getMIMEMap() as $extension => $mime) {
-                if (!isset($this->format_map[$extension])) {
-                    $this->format_map[$extension] = $class_name;
-                }
-                $mime = explode(',', $mime);
-                if (!is_array($mime)) {
-                    $mime = array($mime);
-                }
-                foreach ($mime as $value) {
-                    if (!isset($this->format_map[$value])) {
-                        $this->format_map[$value] = $class_name;
-                    }
-                }
-                $extensions[".$extension"] = true;
-            }
-        }
-        $this->format_map['default'] = $args[0];
-        $this->format_map['extensions'] = array_keys($extensions);
-    }
-
-
-    /**
-     * Add api classes throgh this method. All the public methods
-     * that do not start with _ (underscore) will be  will be exposed
-     * as the public api by default.
-     *
-     * All the protected methods that do not start with _ (underscore)
-     * will exposed as protected api which will require authentication
-     * @param string $class name of the service class
-     * @param string $basePath optional url prefix for mapping, uses
-     * lowercase version of the class name when not specified
-     * @throws Exception when supplied with invalid class name
-     */
-    public function addAPIClass($class_name, $base_path = null)
-    {
-        if (!class_exists($class_name)) {
-            throw new Exception("API class $class_name is missing.");
-        }
-        $this->loadCache();
-        if (!$this->cached) {
-            if (is_null($base_path)) {
-                $base_path = strtolower($class_name);
-                $index = strrpos($class_name, '\\');
-                if ($index !== false) {
-                    $base_path = substr($base_path, $index + 1);
-                }
-            } else {
-                $base_path = trim($base_path, '/');
-            }
-            if (strlen($base_path) > 0) {
-                $base_path .= '/';
-            }
-            $this->generateMap($class_name, $base_path);
-        }
-    }
-
-
-    /**
-     * protected methods will need atleast one authentication class to be set
-     * in order to allow that method to be executed
-     * @param string $class_name of the authentication class
-     * @param string $base_path optional url prefix for mapping
-     */
-    public function addAuthenticationClass($class_name, $base_path = null)
-    {
-        $this->auth_classes[] = $class_name;
-        $this->addAPIClass($class_name, $base_path);
-    }
-
-
-    /**
-     * Add class for custom error handling
-     * @param string $class_name of the error handling class
-     */
-    public function addErrorClass($class_name)
-    {
-        $this->error_classes[] = $class_name;
-    }
-
-
-    /**
-     * Convenience method to respond with an error message
-     * @param int $statusCode http error code
-     * @param string $errorMessage optional custom error message
-     */
-    public function handleError($status_code, $error_message = null)
-    {
-        $method = "handle$status_code";
-        $handled = false;
-        foreach ($this->error_classes as $class_name) {
-            if (method_exists($class_name, $method)) {
-                $obj = new $class_name();
-                $obj->restler = $this;
-                $obj->$method();
-                $handled = true;
-            }
-        }
-        if ($handled) {
-            return;
-        }
-        $message = $this->codes[$status_code]
-            . (!$error_message ? '' : ': ' . $error_message);
-        $this->setStatus($status_code);
-        $responder = new $this->response();
-        $responder->restler = $this;
-        $this->sendData($responder->__formatError($status_code, $message));
-    }
-
-
-    /**
-     * An initialize function to allow use of the restler error generation 
-     * functions for pre-processing and pre-routing of requests.
-     */
-    public function init()
-    {
-        if (empty($this->format_map)) {
-            $this->setSupportedFormats('JsonFormat');
-        }
-        $this->url = $this->getPath();
-        $this->request_method = $this->getRequestMethod();
-        $this->response_format = $this->getResponseFormat();
-        $this->request_format = $this->getRequestFormat();
-        if (is_null($this->request_format)) {
-            $this->request_format = $this->response_format;
-        }
-        if ($this->request_method == 'PUT' || $this->request_method == 'POST') {
-            $this->request_data = $this->getRequestData();
-        }
-    }
-
-
-    /**
-     * Main function for processing the api request
-     * and return the response
-     * @throws Exception when the api service class is missing
-     * @throws RestException to send error response
-     */
-    public function handle()
-    {
-        $this->init();
-        $o = $this->mapUrlToMethod();
-
-        if (!isset($o->class_name)) {
-            $this->handleError(404);
-        } else {
-            try {
-                if ($o->method_flag) {
-                    $auth_method = '__isAuthenticated';
-                    if (!count($this->auth_classes)) {
-                        throw new RestException(401);
-                    }
-                    foreach ($this->auth_classes as $auth_class) {
-                        $auth_obj = new $auth_class();
-                        $auth_obj->restler = $this;
-                        $this->applyClassMetadata($auth_class, $auth_obj, $o);
-                        if (!method_exists($auth_obj, $auth_method)) {
-                            throw new RestException(401, 'Authentication Class '
-                                . 'should implement iAuthenticate');
-                        } else if (!$auth_obj->$auth_method()) {
-                            throw new RestException(401);
-                        }
-                    }
-                }
-                $this->applyClassMetadata(get_class($this->request_format),
-                    $this->request_format, $o);
-                $pre_process = '_' . $this->request_format->getExtension() . '_'
-                    . $o->method_name;
-                $this->service_method = $o->method_name;
-                if ($o->method_flag == 2) {
-                    $o = unprotect($o);
-                }
-                $object = $this->service_class_instance = new $o->class_name();
-                $object->restler = $this;
-                if (method_exists($o->class_name, $pre_process)) {
-                    call_user_func_array(
-                        array($object, $pre_process), $o->arguments
-                    );
-                }
-                switch ($o->method_flag) {
-                    case 3:
-                        $reflection_method = new ReflectionMethod($object,
-                                $o->method_name);
-                        $reflection_method->setAccessible(true);
-                        $result = $reflection_method->invokeArgs($object,
-                            $o->arguments);
-                        break;
-                    case 2:
-                    case 1:
-                    default:
-                        $result = call_user_func_array(array(
-                            $object,
-                            $o->method_name), $o->arguments
-                        );
-                        break;
-                }
-            } catch (RestException $e) {
-                $this->handleError($e->getCode(), $e->getMessage());
-            }
-        }
-        $responder = new $this->response();
-        $responder->restler = $this;
-        $this->applyClassMetadata($this->response, $responder, $o);
-        if (isset($result) && $result !== null) {
-            $result = $responder->__formatResponse($result);
-            $this->sendData($result);
-        }
-    }
-
-
-    /**
-     * Encodes the response in the prefered format
-     * and sends back
-     * @param $data array php data
-     */
-    public function sendData($data)
-    {
-        $data = $this->response_format->encode($data, 
-            !($this->production_mode)
-        );
-        $post_process = '_' . $this->service_method . '_'
-            . $this->response_format->getExtension();
-        if (isset($this->service_class_instance)
-            && method_exists($this->service_class_instance, $post_process)
-        ) {
-            $data = call_user_func(array($this->service_class_instance,
-                $post_process), $data);
-        }
-        header("Cache-Control: no-cache, must-revalidate");
-        header("Expires: 0");
-        header('Content-Type: ' . $this->response_format->getMIME());
-        //.'; charset=utf-8');
-        header("X-Powered-By: Luracast Restler v" . Restler::VERSION);
+	// ==================================================================
+	//
+	// Public variables
+	//
+	// ------------------------------------------------------------------
+
+	const VERSION = '2.2.1';
+
+	/**
+	 * URL of the currently mapped service
+	 * @var string
+	 */
+	public $url;
+
+	/**
+	 * Http request method of the current request.
+	 * Any value between [GET, PUT, POST, DELETE]
+	 * @var string
+	 */
+	public $request_method;
+
+	/**
+	 * Requested data format. Instance of the current format class
+	 * which implements the iFormat interface
+	 * @var iFormat
+	 * @example jsonFormat, xmlFormat, yamlFormat etc
+	 */
+	public $request_format;
+
+	/**
+	 * Data sent to the service
+	 * @var array
+	 */
+	public $request_data = array();
+
+	/**
+	 * Used in production mode to store the URL Map to disk
+	 * @var string
+	 */
+	public $cache_dir;
+
+	/**
+	 * base directory to locate format and auth files
+	 * @var string
+	 */
+	public $base_dir;
+
+	/**
+	 * Name of an iRespond implementation class
+	 * @var string
+	 */
+	public $response = 'DefaultResponse';
+
+	/**
+	 * Response data format. Instance of the current format class
+	 * which implements the iFormat interface
+	 * @var iFormat
+	 * @example jsonFormat, xmlFormat, yamlFormat etc
+	 */
+	public $response_format;
+
+	// ==================================================================
+	//
+	// Private & Protected variables
+	//
+	// ------------------------------------------------------------------
+
+	/**
+	 * When set to false, it will run in debug mode and parse the
+	 * class files every time to map it to the URL
+	 * @var boolean
+	 */
+	protected $production_mode;
+
+	/**
+	 * Associated array that maps urls to their respective class and method
+	 * @var array
+	 */
+	protected $routes = array();
+
+	/**
+	 * Associated array that maps formats to their respective format class name
+	 * @var array
+	 */
+	protected $format_map = array();
+
+	/**
+	 * Instance of the current api service class
+	 * @var object
+	 */
+	protected $service_class_instance;
+
+	/**
+	 * Name of the api method being called
+	 * @var string
+	 */
+	protected $service_method;
+
+	/**
+	 * list of authentication classes
+	 * @var array
+	 */
+	protected $auth_classes = array();
+
+	/**
+	 * list of error handling classes
+	 * @var array
+	 */
+	protected $error_classes = array();
+
+	/**
+	 * HTTP status codes
+	 * @var array
+	 */
+	private $codes = array(
+		100 => 'Continue',
+		101 => 'Switching Protocols',
+		200 => 'OK',
+		201 => 'Created',
+		202 => 'Accepted',
+		203 => 'Non-Authoritative Information',
+		204 => 'No Content',
+		205 => 'Reset Content',
+		206 => 'Partial Content',
+		300 => 'Multiple Choices',
+		301 => 'Moved Permanently',
+		302 => 'Found',
+		303 => 'See Other',
+		304 => 'Not Modified',
+		305 => 'Use Proxy',
+		306 => '(Unused)',
+		307 => 'Temporary Redirect',
+		400 => 'Bad Request',
+		401 => 'Unauthorized',
+		402 => 'Payment Required',
+		403 => 'Forbidden',
+		404 => 'Not Found',
+		405 => 'Method Not Allowed',
+		406 => 'Not Acceptable',
+		407 => 'Proxy Authentication Required',
+		408 => 'Request Timeout',
+		409 => 'Conflict',
+		410 => 'Gone',
+		411 => 'Length Required',
+		412 => 'Precondition Failed',
+		413 => 'Request Entity Too Large',
+		414 => 'Request-URI Too Long',
+		415 => 'Unsupported Media Type',
+		416 => 'Requested Range Not Satisfiable',
+		417 => 'Expectation Failed',
+		500 => 'Internal Server Error',
+		501 => 'Not Implemented',
+		502 => 'Bad Gateway',
+		503 => 'Service Unavailable',
+		504 => 'Gateway Timeout',
+		505 => 'HTTP Version Not Supported'
+	);
+
+	/**
+	 * Caching of url map is enabled or not
+	 * @var boolean
+	 */
+	protected $cached;
+
+	// ==================================================================
+	//
+	// Public functions
+	//
+	// ------------------------------------------------------------------
+
+
+	/**
+	 * Constructor
+	 * @param boolean $production_mode When set to false, it will run in
+	 * debug mode and parse the class files every time to map it to the URL
+	 */
+	public function __construct($production_mode = false)
+	{
+		$this->production_mode = $production_mode;
+		$this->cache_dir = getcwd();
+		$this->base_dir = RESTLER_PATH;
+	}
+
+
+	/**
+	 * Store the url map cache if needed
+	 */
+	public function __destruct()
+	{
+		if ($this->production_mode && !($this->cached)) {
+			$this->saveCache();
+		}
+	}
+
+
+	/**
+	 * Use it in production mode to refresh the url map cache
+	 */
+	public function refreshCache()
+	{
+		$this->routes = array();
+		$this->cached = false;
+	}
+
+
+	/**
+	 * Call this method and pass all the formats that should be
+	 * supported by the API. Accepts multiple parameters
+	 * @param string class name of the format class that implements iFormat
+	 * @example $restler->setSupportedFormats('JsonFormat', 'XmlFormat'...);
+	 */
+	public function setSupportedFormats()
+	{
+		$args = func_get_args();
+		$extensions = array();
+		foreach ($args as $class_name) {
+			if (!is_string($class_name) || !class_exists($class_name)) {
+				throw new Exception("$class_name is not a vaild Format Class.");
+			}
+			$obj = new $class_name;
+			if (!($obj instanceof iFormat)) {
+				throw new Exception('Invalid format class; must implement '
+					. 'iFormat interface');
+			}
+			foreach ($obj->getMIMEMap() as $extension => $mime) {
+				if (!isset($this->format_map[$extension])) {
+					$this->format_map[$extension] = $class_name;
+				}
+				$mime = explode(',', $mime);
+				if (!is_array($mime)) {
+					$mime = array($mime);
+				}
+				foreach ($mime as $value) {
+					if (!isset($this->format_map[$value])) {
+						$this->format_map[$value] = $class_name;
+					}
+				}
+				$extensions[".$extension"] = true;
+			}
+		}
+		$this->format_map['default'] = $args[0];
+		$this->format_map['extensions'] = array_keys($extensions);
+	}
+
+
+	/**
+	 * Add api classes throgh this method. All the public methods
+	 * that do not start with _ (underscore) will be  will be exposed
+	 * as the public api by default.
+	 *
+	 * All the protected methods that do not start with _ (underscore)
+	 * will exposed as protected api which will require authentication
+	 * @param string $class name of the service class
+	 * @param string $basePath optional url prefix for mapping, uses
+	 * lowercase version of the class name when not specified
+	 * @throws Exception when supplied with invalid class name
+	 */
+	public function addAPIClass($class_name, $base_path = null)
+	{
+		if (!class_exists($class_name)) {
+			throw new Exception("API class $class_name is missing.");
+		}
+		$this->loadCache();
+		if (!$this->cached) {
+			if (is_null($base_path)) {
+				$base_path = strtolower($class_name);
+				$index = strrpos($class_name, '\\');
+				if ($index !== false) {
+					$base_path = substr($base_path, $index + 1);
+				}
+			} else {
+				$base_path = trim($base_path, '/');
+			}
+			if (strlen($base_path) > 0) {
+				$base_path .= '/';
+			}
+			$this->generateMap($class_name, $base_path);
+		}
+	}
+
+
+	/**
+	 * protected methods will need atleast one authentication class to be set
+	 * in order to allow that method to be executed
+	 * @param string $class_name of the authentication class
+	 * @param string $base_path optional url prefix for mapping
+	 */
+	public function addAuthenticationClass($class_name, $base_path = null)
+	{
+		$this->auth_classes[] = $class_name;
+		$this->addAPIClass($class_name, $base_path);
+	}
+
+
+	/**
+	 * Add class for custom error handling
+	 * @param string $class_name of the error handling class
+	 */
+	public function addErrorClass($class_name)
+	{
+		$this->error_classes[] = $class_name;
+	}
+
+
+	/**
+	 * Convenience method to respond with an error message
+	 * @param int $statusCode http error code
+	 * @param string $errorMessage optional custom error message
+	 */
+	public function handleError($status_code, $error_message = null)
+	{
+		$method = "handle$status_code";
+		$handled = false;
+		foreach ($this->error_classes as $class_name) {
+			if (method_exists($class_name, $method)) {
+				$obj = new $class_name();
+				$obj->restler = $this;
+				$obj->$method();
+				$handled = true;
+			}
+		}
+		if ($handled) {
+			return;
+		}
+		$message = $this->codes[$status_code]
+			. (!$error_message ? '' : ': ' . $error_message);
+		$this->setStatus($status_code);
+		$responder = new $this->response();
+		$responder->restler = $this;
+		$this->sendData($responder->__formatError($status_code, $message));
+	}
+
+
+	/**
+	 * An initialize function to allow use of the restler error generation 
+	 * functions for pre-processing and pre-routing of requests.
+	 */
+	public function init()
+	{
+		if (empty($this->format_map)) {
+			$this->setSupportedFormats('JsonFormat');
+		}
+		$this->url = $this->getPath();
+		$this->request_method = $this->getRequestMethod();
+		$this->response_format = $this->getResponseFormat();
+		$this->request_format = $this->getRequestFormat();
+		if (is_null($this->request_format)) {
+			$this->request_format = $this->response_format;
+		}
+		if ($this->request_method == 'PUT' || $this->request_method == 'POST') {
+			$this->request_data = $this->getRequestData();
+		}
+	}
+
+
+	/**
+	 * Main function for processing the api request
+	 * and return the response
+	 * @throws Exception when the api service class is missing
+	 * @throws RestException to send error response
+	 */
+	public function handle()
+	{
+		$this->init();
+		$o = $this->mapUrlToMethod();
+
+		if (!isset($o->class_name)) {
+			$this->handleError(404);
+		} else {
+			try {
+				if ($o->method_flag) {
+					$auth_method = '__isAuthenticated';
+					if (!count($this->auth_classes)) {
+						throw new RestException(401);
+					}
+					foreach ($this->auth_classes as $auth_class) {
+						$auth_obj = new $auth_class();
+						$auth_obj->restler = $this;
+						$this->applyClassMetadata($auth_class, $auth_obj, $o);
+						if (!method_exists($auth_obj, $auth_method)) {
+							throw new RestException(401, 'Authentication Class '
+								. 'should implement iAuthenticate');
+						} else if (!$auth_obj->$auth_method()) {
+							throw new RestException(401);
+						}
+					}
+				}
+				$this->applyClassMetadata(get_class($this->request_format),
+					$this->request_format, $o);
+				$pre_process = '_' . $this->request_format->getExtension() . '_'
+					. $o->method_name;
+				$this->service_method = $o->method_name;
+				if ($o->method_flag == 2) {
+					$o = unprotect($o);
+				}
+				$object = $this->service_class_instance = new $o->class_name();
+				$object->restler = $this;
+				if (method_exists($o->class_name, $pre_process)) {
+					call_user_func_array(
+						array($object, $pre_process), $o->arguments
+					);
+				}
+				switch ($o->method_flag) {
+					case 3:
+						$reflection_method = new ReflectionMethod($object,
+								$o->method_name);
+						$reflection_method->setAccessible(true);
+						$result = $reflection_method->invokeArgs($object,
+							$o->arguments);
+						break;
+					case 2:
+					case 1:
+					default:
+						$result = call_user_func_array(array(
+							$object,
+							$o->method_name), $o->arguments
+						);
+						break;
+				}
+			} catch (RestException $e) {
+				$this->handleError($e->getCode(), $e->getMessage());
+			}
+		}
+		$responder = new $this->response();
+		$responder->restler = $this;
+		$this->applyClassMetadata($this->response, $responder, $o);
+		if (isset($result) && $result !== null) {
+			$result = $responder->__formatResponse($result);
+			$this->sendData($result);
+		}
+	}
+
+
+	/**
+	 * Encodes the response in the prefered format
+	 * and sends back
+	 * @param $data array php data
+	 */
+	public function sendData($data)
+	{
+		$data = $this->response_format->encode($data, 
+			!($this->production_mode)
+		);
+		$post_process = '_' . $this->service_method . '_'
+			. $this->response_format->getExtension();
+		if (isset($this->service_class_instance)
+			&& method_exists($this->service_class_instance, $post_process)
+		) {
+			$data = call_user_func(array($this->service_class_instance,
+				$post_process), $data);
+		}
+		header("Cache-Control: no-cache, must-revalidate");
+		header("Expires: 0");
+		header('Content-Type: ' . $this->response_format->getMIME());
+		//.'; charset=utf-8');
+		header("X-Powered-By: Luracast Restler v" . Restler::VERSION);
 		if($this->production_mode){
 			die($data);
 		}else{
 			echo $data;
 		}
-    }
-
-
-    /**
-     * Sets the HTTP response status
-     * @param int $code response code
-     */
-    public function setStatus($code)
-    {
-        header("{$_SERVER['SERVER_PROTOCOL']} $code " . 
-            $this->codes[strval($code)]);
-    }
-
-
-    /**
-     * Compare two strings and remove the common
-     * sub string from the first string and return it
-     * @param string $first
-     * @param string $second
-     * @param string $char optional, set it as
-     * blank string for char by char comparison
-     * @return string
-     */
-    public function removeCommonPath($first, $second, $char = '/')
-    {
-        $first = explode($char, $first);
-        $second = explode($char, $second);
-        while (count($second)) {
-            if ($first[0] == $second[0]) {
-                array_shift($first);
-            } else {
-                break;
-            }
-            array_shift($second);
-        }
-        return implode($char, $first);
-    }
-
-
-    /**
-     * Save cache to file
-     */
-    public function saveCache()
-    {
-        $file = $this->cache_dir . '/routes.php';
-        $s = '$o=array();' . PHP_EOL;
-        foreach ($this->routes as $key => $value) {
-            $s .= PHP_EOL . PHP_EOL . PHP_EOL . 
-                "############### $key ###############" . PHP_EOL . PHP_EOL;
-            $s .= '$o[\'' . $key . '\']=array();';
-            foreach ($value as $ke => $va) {
-                $s .= PHP_EOL . PHP_EOL . "#==== $key $ke" . PHP_EOL . PHP_EOL;
-                $s .= '$o[\'' . $key . '\'][\'' . $ke . '\']=' . str_replace(
-                        PHP_EOL, PHP_EOL . "\t", var_export($va, true)
-                    ) . ';';
-            }
-        }
-        $s .= PHP_EOL . 'return $o;';
-        $r = @file_put_contents($file, "<?php $s");
-        @chmod($file, 0777);
-        if ($r === false) {
-            throw new Exception(
-                "The cache directory located at '$this->cache_dir' needs to "
-                . "have the permissions set to read/write/execute for everyone"
-                . " in order to save cache and improve performance.");
-        }
-    }
-
-    // ==================================================================
-    //
-    // Protected functions
-    //
-    // ------------------------------------------------------------------
-
-
-    /**
-     * Parses the requst url and get the api path
-     * @return string api path
-     */
-    protected function getPath()
-    {
-        $path = urldecode($this->removeCommonPath($_SERVER['REQUEST_URI'],
-                $_SERVER['SCRIPT_NAME']));
-        $path = preg_replace('/(\/*\?.*$)|(\/$)/', '', $path);
-        $path = str_replace($this->format_map['extensions'], '', $path);
-        return $path;
-    }
-
-
-    /**
-     * Parses the request to figure out the http request type
-     * @return string which will be one of the following
-     * [GET, POST, PUT, DELETE]
-     * @example GET
-     */
-    protected function getRequestMethod()
-    {
-        $method = $_SERVER['REQUEST_METHOD'];
-        if (isset($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'])) {
-            $method = $_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'];
-        }
-        //support for HEAD request
-        if ($method == 'HEAD') {
-            $method = 'GET';
-        }
-        return $method;
-    }
-
-
-    /**
-     * Parses the request to figure out format of the request data
-     * @return iFormat any class that implements iFormat
-     * @example JsonFormat
-     */
-    protected function getRequestFormat()
-    {
-        $format = null;
-        //check if client has sent any information on request format
-        if (isset($_SERVER['CONTENT_TYPE'])) {
-            $mime = explode(';', $_SERVER['CONTENT_TYPE']);
-            $mime = $mime[0];
-            if ($mime == UrlEncodedFormat::MIME) {
-                $format = new UrlEncodedFormat();
-            } else {
-                if (isset($this->format_map[$mime])) {
-                    $format = $this->format_map[$mime];
-                    $format = is_string($format) ? new $format : $format;
-                    $format->setMIME($mime);
-                }
-            }
-        }
-        return $format;
-    }
-
-
-    /**
-     * Parses the request to figure out the best format for response
-     * @return iFormat any class that implements iFormat
-     * @example JsonFormat
-     */
-    protected function getResponseFormat()
-    {
-        //check if client has specified an extension
-        /**
-         * @var iFormat
-         */
-        $format = null;
-        $extensions = explode('.',
-            parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH));
-        while ($extensions) {
-            $extension = array_pop($extensions);
-            $extension = explode('/', $extension);
-            $extension = array_shift($extension);
-            if ($extension && isset($this->format_map[$extension])) {
-                $format = $this->format_map[$extension];
-                $format = is_string($format) ? new $format : $format;
-                $format->setExtension($extension);
-                //echo "Extension $extension";
-                return $format;
-            }
-        }
-        //check if client has sent list of accepted data formats
-        if (isset($_SERVER['HTTP_ACCEPT'])) {
-            $acceptList = array();
-            $accepts = explode(',', strtolower($_SERVER['HTTP_ACCEPT']));
-            if (!is_array($accepts)) {
-                $accepts = array($accepts);
-            }
-            foreach ($accepts as $pos => $accept) {
-                $parts = explode(';q=', trim($accept));
-                $type = array_shift($parts);
-                $quality = count($parts) ? 
-                    floatval(array_shift($parts)) : 
-                    (1000 - $pos) / 1000;
-                $acceptList[$type] = $quality;
-            }
-            arsort($acceptList);
-            foreach ($acceptList as $accept => $quality) {
-                if (isset($this->format_map[$accept])) {
-                    $format = $this->format_map[$accept];
-                    $format = is_string($format) ? new $format : $format;
-                    $format->setMIME($accept);
-                    //echo "MIME $accept";
-                    // Tell cache content is based on Accept header
-                    header("Vary: Accept"); 
-                    return $format;
-                }
-            }
-        } else {
-            // RFC 2616: If no Accept header field is
-            // present, then it is assumed that the
-            // client accepts all media types.
-            $_SERVER['HTTP_ACCEPT'] = '*/*';
-        }
-        if (strpos($_SERVER['HTTP_ACCEPT'], '*') !== false) {
-            if (strpos($_SERVER['HTTP_ACCEPT'], 'application/*') !== false) {
-                $format = new JsonFormat;
-            } else if (strpos($_SERVER['HTTP_ACCEPT'], 'text/*') !== false) {
-                $format = new XmlFormat;
-            } else if (strpos($_SERVER['HTTP_ACCEPT'], '*/*') !== false) {
-                $format = new $this->format_map['default'];
-            }
-        }
-        if (empty($format)) {
-            // RFC 2616: If an Accept header field is present, and if the 
-            // server cannot send a response which is acceptable according to 
-            // the combined Accept field value, then the server SHOULD send 
-            // a 406 (not acceptable) response.
-            header('HTTP/1.1 406 Not Acceptable');
-            die('406 Not Acceptable: The server was unable to ' . 
-                    'negotiate content for this request.');
-        } else {
-            // Tell cache content is based ot Accept header
-            header("Vary: Accept"); 
-            return $format;
-        }
-    }
-
-
-    /**
-     * Parses the request data and returns it
-     * @return array php data
-     */
-    protected function getRequestData()
-    {
-        try {
-            $r = file_get_contents('php://input');
-            if (is_null($r)) {
-                return $_GET;
-            }
-            $r = $this->request_format->decode($r);
-            return is_null($r) ? array() : $r;
-        } catch (RestException $e) {
-            $this->handleError($e->getCode(), $e->getMessage());
-        }
-    }
-
-
-    protected function mapUrlToMethod()
-    {
-        if (!isset($this->routes[$this->request_method])) {
-            return array();
-        }
-        $urls = $this->routes[$this->request_method];
-        if (!$urls) {
-            return array();
-        }
-
-        $found = false;
-        $this->request_data += $_GET;
-        $params = array('request_data' => $this->request_data);
-        $params += $this->request_data;
-        $lc = strtolower($this->url);
-        foreach ($urls as $url => $call) {
-            //echo PHP_EOL.$url.' = '.$this->url.PHP_EOL;
-            $call = (object) $call;
-            if (strstr($url, ':')) {
-                $regex = preg_replace('/\\\:([^\/]+)/', '(?P<$1>[^/]+)',
-                    preg_quote($url));
-                if (preg_match(":^$regex$:i", $this->url, $matches)) {
-                    foreach ($matches as $arg => $match) {
-                        if (isset($call->arguments[$arg])) {
-                            //flog("$arg => $match $args[$arg]");
-                            $params[$arg] = $match;
-                        }
-                    }
-                    $found = true;
-                    break;
-                }
-            } else if ($url == $lc) {
-                $found = true;
-                break;
-            }
-        }
-        if ($found) {
-            //echo PHP_EOL."Found $url ";
-            //print_r($call);
-            $p = $call->defaults;
-            foreach ($call->arguments as $key => $value) {
-                //echo "$key => $value \n";
-                if (isset($params[$key])) {
-                    $p[$value] = $params[$key];
-                }
-            }
-            $call->arguments = $p;
-            return $call;
-        }
-    }
-
-
-    /**
-     * Apply static and non-static properties defined in
-     * the method information anotation
-     * @param String $class_name
-     * @param Object $instance instance of that class
-     * @param Object $method_info method information and metadata
-     */
-    protected function applyClassMetadata($class_name, $instance, $method_info)
-    {
-        if (isset($method_info->metadata[$class_name])
-            && is_array($method_info->metadata[$class_name])
-        ) {
-            foreach ($method_info->metadata[$class_name] as
-                    $property => $value) {
-                if (property_exists($class_name, $property)) {
-                    $reflection_property = 
-                        new ReflectionProperty($class_name, $property);
-                    $reflection_property->setValue($instance, $value);
-                }
-            }
-        }
-    }
-
-
-    protected function loadCache()
-    {
-        if ($this->cached !== null) {
-            return;
-        }
-        $file = $this->cache_dir . '/routes.php';
-        $this->cached = false;
-
-        if ($this->production_mode) {
-            if (file_exists($file)) {
-                $routes = include($file);
-            }
-            if (isset($routes) && is_array($routes)) {
-                $this->routes = $routes;
-                $this->cached = true;
-            }
-        } else {
-            //@unlink($this->cache_dir . "/$name.php");
-        }
-    }
-
-
-    /**
-     * Generates cachable url to method mapping
-     * @param string $class_name
-     * @param string $base_path
-     */
-    protected function generateMap($class_name, $base_path = '')
-    {
-        $reflection = new ReflectionClass($class_name);
-        $class_metadata = parse_doc($reflection->getDocComment());
-        $methods = $reflection->getMethods(
-            ReflectionMethod::IS_PUBLIC + ReflectionMethod::IS_PROTECTED
-        );
-        foreach ($methods as $method) {
-            $doc = $method->getDocComment();
-            $arguments = array();
-            $defaults = array();
-            $metadata = $class_metadata + parse_doc($doc);
-            $params = $method->getParameters();
-            $position = 0;
-            foreach ($params as $param) {
-                $arguments[$param->getName()] = $position;
-                $defaults[$position] = $param->isDefaultValueAvailable() ? 
-                    $param->getDefaultValue() : null;
-                $position++;
-            }
-            $method_flag = $method->isProtected() ? 
-                (isRestlerCompatibilityModeEnabled() ? 2 : 3) : 
-                (isset($metadata['protected']) ? 1 : 0);
-
-            //take note of the order
-            $call = array(
-                'class_name' => $class_name,
-                'method_name' => $method->getName(),
-                'arguments' => $arguments,
-                'defaults' => $defaults,
-                'metadata' => $metadata,
-                'method_flag' => $method_flag
-            );
-            $method_url = strtolower($method->getName());
-            if (preg_match_all(
-                '/@url\s+(GET|POST|PUT|DELETE|HEAD|OPTIONS)[ \t]*\/?(\S*)/s',
-                    $doc, $matches, PREG_SET_ORDER)
-            ) {
-                foreach ($matches as $match) {
-                    $http_method = $match[1];
-                    $url = rtrim($base_path . $match[2], '/');
-                    $this->routes[$http_method][$url] = $call;
-                }
-            } elseif ($method_url[0] != '_') { 
-                //not prefixed with underscore
-                // no configuration found so use convention
-                if (preg_match_all('/^(GET|POST|PUT|DELETE|HEAD|OPTIONS)/i',
-                        $method_url, $matches)
-                ) {
-                    $http_method = strtoupper($matches[0][0]);
-                    $method_url = substr($method_url, strlen($http_method));
-                } else {
-                    $http_method = 'GET';
-                }
-                $url = $base_path
-                    . ($method_url == 'index' || $method_url == 'default' ? '' :
-                        $method_url);
-                $url = rtrim($url, '/');
-                $this->routes[$http_method][$url] = $call;
-                foreach ($params as $param) {
-                    if ($param->getName() == 'request_data') {
-                        break;
-                    }
-                    $url .= $url == '' ? ':' : '/:';
-                    $url .= $param->getName();
-                    $this->routes[$http_method][$url] = $call;
-                }
-            }
-        }
-    }
+	}
+
+
+	/**
+	 * Sets the HTTP response status
+	 * @param int $code response code
+	 */
+	public function setStatus($code)
+	{
+		header("{$_SERVER['SERVER_PROTOCOL']} $code " . 
+			$this->codes[strval($code)]);
+	}
+
+
+	/**
+	 * Compare two strings and remove the common
+	 * sub string from the first string and return it
+	 * @param string $first
+	 * @param string $second
+	 * @param string $char optional, set it as
+	 * blank string for char by char comparison
+	 * @return string
+	 */
+	public function removeCommonPath($first, $second, $char = '/')
+	{
+		$first = explode($char, $first);
+		$second = explode($char, $second);
+		while (count($second)) {
+			if ($first[0] == $second[0]) {
+				array_shift($first);
+			} else {
+				break;
+			}
+			array_shift($second);
+		}
+		return implode($char, $first);
+	}
+
+
+	/**
+	 * Save cache to file
+	 */
+	public function saveCache()
+	{
+		$file = $this->cache_dir . '/routes.php';
+		$s = '$o=array();' . PHP_EOL;
+		foreach ($this->routes as $key => $value) {
+			$s .= PHP_EOL . PHP_EOL . PHP_EOL . 
+				"############### $key ###############" . PHP_EOL . PHP_EOL;
+			$s .= '$o[\'' . $key . '\']=array();';
+			foreach ($value as $ke => $va) {
+				$s .= PHP_EOL . PHP_EOL . "#==== $key $ke" . PHP_EOL . PHP_EOL;
+				$s .= '$o[\'' . $key . '\'][\'' . $ke . '\']=' . str_replace(
+						PHP_EOL, PHP_EOL . "\t", var_export($va, true)
+					) . ';';
+			}
+		}
+		$s .= PHP_EOL . 'return $o;';
+		$r = @file_put_contents($file, "<?php $s");
+		@chmod($file, 0777);
+		if ($r === false) {
+			throw new Exception(
+				"The cache directory located at '$this->cache_dir' needs to "
+				. "have the permissions set to read/write/execute for everyone"
+				. " in order to save cache and improve performance.");
+		}
+	}
+
+	// ==================================================================
+	//
+	// Protected functions
+	//
+	// ------------------------------------------------------------------
+
+
+	/**
+	 * Parses the requst url and get the api path
+	 * @return string api path
+	 */
+	protected function getPath()
+	{
+		$path = urldecode($this->removeCommonPath($_SERVER['REQUEST_URI'],
+				$_SERVER['SCRIPT_NAME']));
+		$path = preg_replace('/(\/*\?.*$)|(\/$)/', '', $path);
+		$path = str_replace($this->format_map['extensions'], '', $path);
+		return $path;
+	}
+
+
+	/**
+	 * Parses the request to figure out the http request type
+	 * @return string which will be one of the following
+	 * [GET, POST, PUT, DELETE]
+	 * @example GET
+	 */
+	protected function getRequestMethod()
+	{
+		$method = $_SERVER['REQUEST_METHOD'];
+		if (isset($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'])) {
+			$method = $_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'];
+		}
+		//support for HEAD request
+		if ($method == 'HEAD') {
+			$method = 'GET';
+		}
+		return $method;
+	}
+
+
+	/**
+	 * Parses the request to figure out format of the request data
+	 * @return iFormat any class that implements iFormat
+	 * @example JsonFormat
+	 */
+	protected function getRequestFormat()
+	{
+		$format = null;
+		//check if client has sent any information on request format
+		if (isset($_SERVER['CONTENT_TYPE'])) {
+			$mime = explode(';', $_SERVER['CONTENT_TYPE']);
+			$mime = $mime[0];
+			if ($mime == UrlEncodedFormat::MIME) {
+				$format = new UrlEncodedFormat();
+			} else {
+				if (isset($this->format_map[$mime])) {
+					$format = $this->format_map[$mime];
+					$format = is_string($format) ? new $format : $format;
+					$format->setMIME($mime);
+				}
+			}
+		}
+		return $format;
+	}
+
+
+	/**
+	 * Parses the request to figure out the best format for response
+	 * @return iFormat any class that implements iFormat
+	 * @example JsonFormat
+	 */
+	protected function getResponseFormat()
+	{
+		//check if client has specified an extension
+		/**
+		 * @var iFormat
+		 */
+		$format = null;
+		$extensions = explode('.',
+			parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH));
+		while ($extensions) {
+			$extension = array_pop($extensions);
+			$extension = explode('/', $extension);
+			$extension = array_shift($extension);
+			if ($extension && isset($this->format_map[$extension])) {
+				$format = $this->format_map[$extension];
+				$format = is_string($format) ? new $format : $format;
+				$format->setExtension($extension);
+				//echo "Extension $extension";
+				return $format;
+			}
+		}
+		//check if client has sent list of accepted data formats
+		if (isset($_SERVER['HTTP_ACCEPT'])) {
+			$acceptList = array();
+			$accepts = explode(',', strtolower($_SERVER['HTTP_ACCEPT']));
+			if (!is_array($accepts)) {
+				$accepts = array($accepts);
+			}
+			foreach ($accepts as $pos => $accept) {
+				$parts = explode(';q=', trim($accept));
+				$type = array_shift($parts);
+				$quality = count($parts) ? 
+					floatval(array_shift($parts)) : 
+					(1000 - $pos) / 1000;
+				$acceptList[$type] = $quality;
+			}
+			arsort($acceptList);
+			foreach ($acceptList as $accept => $quality) {
+				if (isset($this->format_map[$accept])) {
+					$format = $this->format_map[$accept];
+					$format = is_string($format) ? new $format : $format;
+					$format->setMIME($accept);
+					//echo "MIME $accept";
+					// Tell cache content is based on Accept header
+					header("Vary: Accept"); 
+					return $format;
+				}
+			}
+		} else {
+			// RFC 2616: If no Accept header field is
+			// present, then it is assumed that the
+			// client accepts all media types.
+			$_SERVER['HTTP_ACCEPT'] = '*/*';
+		}
+		if (strpos($_SERVER['HTTP_ACCEPT'], '*') !== false) {
+			if (strpos($_SERVER['HTTP_ACCEPT'], 'application/*') !== false) {
+				$format = new JsonFormat;
+			} else if (strpos($_SERVER['HTTP_ACCEPT'], 'text/*') !== false) {
+				$format = new XmlFormat;
+			} else if (strpos($_SERVER['HTTP_ACCEPT'], '*/*') !== false) {
+				$format = new $this->format_map['default'];
+			}
+		}
+		if (empty($format)) {
+			// RFC 2616: If an Accept header field is present, and if the 
+			// server cannot send a response which is acceptable according to 
+			// the combined Accept field value, then the server SHOULD send 
+			// a 406 (not acceptable) response.
+			header('HTTP/1.1 406 Not Acceptable');
+			die('406 Not Acceptable: The server was unable to ' . 
+					'negotiate content for this request.');
+		} else {
+			// Tell cache content is based ot Accept header
+			header("Vary: Accept"); 
+			return $format;
+		}
+	}
+
+
+	/**
+	 * Parses the request data and returns it
+	 * @return array php data
+	 */
+	protected function getRequestData()
+	{
+		try {
+			$r = file_get_contents('php://input');
+			if (is_null($r)) {
+				return $_GET;
+			}
+			$r = $this->request_format->decode($r);
+			return is_null($r) ? array() : $r;
+		} catch (RestException $e) {
+			$this->handleError($e->getCode(), $e->getMessage());
+		}
+	}
+
+
+	protected function mapUrlToMethod()
+	{
+		if (!isset($this->routes[$this->request_method])) {
+			return array();
+		}
+		$urls = $this->routes[$this->request_method];
+		if (!$urls) {
+			return array();
+		}
+
+		$found = false;
+		$this->request_data += $_GET;
+		$params = array('request_data' => $this->request_data);
+		$params += $this->request_data;
+		$lc = strtolower($this->url);
+		foreach ($urls as $url => $call) {
+			//echo PHP_EOL.$url.' = '.$this->url.PHP_EOL;
+			$call = (object) $call;
+			if (strstr($url, ':')) {
+				$regex = preg_replace('/\\\:([^\/]+)/', '(?P<$1>[^/]+)',
+					preg_quote($url));
+				if (preg_match(":^$regex$:i", $this->url, $matches)) {
+					foreach ($matches as $arg => $match) {
+						if (isset($call->arguments[$arg])) {
+							//flog("$arg => $match $args[$arg]");
+							$params[$arg] = $match;
+						}
+					}
+					$found = true;
+					break;
+				}
+			} else if ($url == $lc) {
+				$found = true;
+				break;
+			}
+		}
+		if ($found) {
+			//echo PHP_EOL."Found $url ";
+			//print_r($call);
+			$p = $call->defaults;
+			foreach ($call->arguments as $key => $value) {
+				//echo "$key => $value \n";
+				if (isset($params[$key])) {
+					$p[$value] = $params[$key];
+				}
+			}
+			$call->arguments = $p;
+			return $call;
+		}
+	}
+
+
+	/**
+	 * Apply static and non-static properties defined in
+	 * the method information anotation
+	 * @param String $class_name
+	 * @param Object $instance instance of that class
+	 * @param Object $method_info method information and metadata
+	 */
+	protected function applyClassMetadata($class_name, $instance, $method_info)
+	{
+		if (isset($method_info->metadata[$class_name])
+			&& is_array($method_info->metadata[$class_name])
+		) {
+			foreach ($method_info->metadata[$class_name] as
+					$property => $value) {
+				if (property_exists($class_name, $property)) {
+					$reflection_property = 
+						new ReflectionProperty($class_name, $property);
+					$reflection_property->setValue($instance, $value);
+				}
+			}
+		}
+	}
+
+
+	protected function loadCache()
+	{
+		if ($this->cached !== null) {
+			return;
+		}
+		$file = $this->cache_dir . '/routes.php';
+		$this->cached = false;
+
+		if ($this->production_mode) {
+			if (file_exists($file)) {
+				$routes = include($file);
+			}
+			if (isset($routes) && is_array($routes)) {
+				$this->routes = $routes;
+				$this->cached = true;
+			}
+		} else {
+			//@unlink($this->cache_dir . "/$name.php");
+		}
+	}
+
+
+	/**
+	 * Generates cachable url to method mapping
+	 * @param string $class_name
+	 * @param string $base_path
+	 */
+	protected function generateMap($class_name, $base_path = '')
+	{
+		$reflection = new ReflectionClass($class_name);
+		$class_metadata = parse_doc($reflection->getDocComment());
+		$methods = $reflection->getMethods(
+			ReflectionMethod::IS_PUBLIC + ReflectionMethod::IS_PROTECTED
+		);
+		foreach ($methods as $method) {
+			$doc = $method->getDocComment();
+			$arguments = array();
+			$defaults = array();
+			$metadata = $class_metadata + parse_doc($doc);
+			$params = $method->getParameters();
+			$position = 0;
+			foreach ($params as $param) {
+				$arguments[$param->getName()] = $position;
+				$defaults[$position] = $param->isDefaultValueAvailable() ? 
+					$param->getDefaultValue() : null;
+				$position++;
+			}
+			$method_flag = $method->isProtected() ? 
+				(isRestlerCompatibilityModeEnabled() ? 2 : 3) : 
+				(isset($metadata['protected']) ? 1 : 0);
+
+			//take note of the order
+			$call = array(
+				'class_name' => $class_name,
+				'method_name' => $method->getName(),
+				'arguments' => $arguments,
+				'defaults' => $defaults,
+				'metadata' => $metadata,
+				'method_flag' => $method_flag
+			);
+			$method_url = strtolower($method->getName());
+			if (preg_match_all(
+				'/@url\s+(GET|POST|PUT|DELETE|HEAD|OPTIONS)[ \t]*\/?(\S*)/s',
+					$doc, $matches, PREG_SET_ORDER)
+			) {
+				foreach ($matches as $match) {
+					$http_method = $match[1];
+					$url = rtrim($base_path . $match[2], '/');
+					$this->routes[$http_method][$url] = $call;
+				}
+			} elseif ($method_url[0] != '_') { 
+				//not prefixed with underscore
+				// no configuration found so use convention
+				if (preg_match_all('/^(GET|POST|PUT|DELETE|HEAD|OPTIONS)/i',
+						$method_url, $matches)
+				) {
+					$http_method = strtoupper($matches[0][0]);
+					$method_url = substr($method_url, strlen($http_method));
+				} else {
+					$http_method = 'GET';
+				}
+				$url = $base_path
+					. ($method_url == 'index' || $method_url == 'default' ? '' :
+						$method_url);
+				$url = rtrim($url, '/');
+				$this->routes[$http_method][$url] = $call;
+				foreach ($params as $param) {
+					if ($param->getName() == 'request_data') {
+						break;
+					}
+					$url .= $url == '' ? ':' : '/:';
+					$url .= $param->getName();
+					$this->routes[$http_method][$url] = $call;
+				}
+			}
+		}
+	}
 
 }
 
 if (version_compare(PHP_VERSION, '5.3.0') < 0) {
-    require_once 'compat.php';
+	require_once 'compat.php';
 }
 
 // ==================================================================
@@ -916,10 +916,10 @@ 
 {
 
 
-    public function __construct($http_status_code, $error_message = null)
-    {
-        parent::__construct($error_message, $http_status_code);
-    }
+	public function __construct($http_status_code, $error_message = null)
+	{
+		parent::__construct($error_message, $http_status_code);
+	}
 
 }
 
@@ -937,21 +937,21 @@ 
 {
 
 
-    /**
-     * Result of an api call is passed to this method
-     * to create a standard structure for the data
-     * @param unknown_type $result can be a primitive or array or object
-     */
-    public function __formatResponse($result);
+	/**
+	 * Result of an api call is passed to this method
+	 * to create a standard structure for the data
+	 * @param unknown_type $result can be a primitive or array or object
+	 */
+	public function __formatResponse($result);
 
 
-    /**
-     * When the api call results in RestException this method
-     * will be called to return the error message
-     * @param int $status_code
-     * @param String $message
-     */
-    public function __formatError($status_code, $message);
+	/**
+	 * When the api call results in RestException this method
+	 * will be called to return the error message
+	 * @param int $status_code
+	 * @param String $message
+	 */
+	public function __formatError($status_code, $message);
 }
 
 /**
@@ -968,21 +968,21 @@ 
 {
 
 
-    public function __formatResponse($result)
-    {
-        return $result;
-    }
+	public function __formatResponse($result)
+	{
+		return $result;
+	}
 
 
-    public function __formatError($statusCode, $message)
-    {
-        return array(
-            'error' => array(
-                'code' => $statusCode,
-                'message' => $message
-            )
-        );
-    }
+	public function __formatError($statusCode, $message)
+	{
+		return array(
+			'error' => array(
+				'code' => $statusCode,
+				'message' => $message
+			)
+		);
+	}
 
 }
 
@@ -1000,11 +1000,11 @@ 
 {
 
 
-    /**
-     * Auth function that is called when a protected method is requested
-     * @return boolean true or false
-     */
-    public function __isAuthenticated();
+	/**
+	 * Auth function that is called when a protected method is requested
+	 * @return boolean true or false
+	 */
+	public function __isAuthenticated();
 }
 
 /**
@@ -1022,60 +1022,60 @@ 
 {
 
 
-    /**
-     * Get Extension => MIME type mappings as an associative array
-     * @return array list of mime strings for the format
-     * @example array('json'=>'application/json');
-     */
-    public function getMIMEMap();
+	/**
+	 * Get Extension => MIME type mappings as an associative array
+	 * @return array list of mime strings for the format
+	 * @example array('json'=>'application/json');
+	 */
+	public function getMIMEMap();
 
 
-    /**
-     * Set the selected MIME type
-     * @param string $mime MIME type
-     */
-    public function setMIME($mime);
+	/**
+	 * Set the selected MIME type
+	 * @param string $mime MIME type
+	 */
+	public function setMIME($mime);
 
 
-    /**
-     * Get selected MIME type
-     */
-    public function getMIME();
+	/**
+	 * Get selected MIME type
+	 */
+	public function getMIME();
 
 
-    /**
-     * Set the selected file extension
-     * @param string $extension file extension
-     */
-    public function setExtension($extension);
+	/**
+	 * Set the selected file extension
+	 * @param string $extension file extension
+	 */
+	public function setExtension($extension);
 
 
-    /**
-     * Get the selected file extension
-     * @return string file extension
-     */
-    public function getExtension();
+	/**
+	 * Get the selected file extension
+	 * @return string file extension
+	 */
+	public function getExtension();
 
 
-    /**
-     * Encode the given data in the format
-     * @param array $data resulting data that needs to
-     * be encoded in the given format
-     * @param boolean $human_readable set to true when restler
-     * is not running in production mode. Formatter has to
-     * make the encoded output more human readable
-     * @return string encoded string
-     */
-    public function encode($data, $human_readable = false);
+	/**
+	 * Encode the given data in the format
+	 * @param array $data resulting data that needs to
+	 * be encoded in the given format
+	 * @param boolean $human_readable set to true when restler
+	 * is not running in production mode. Formatter has to
+	 * make the encoded output more human readable
+	 * @return string encoded string
+	 */
+	public function encode($data, $human_readable = false);
 
 
-    /**
-     * Decode the given data from the format
-     * @param string $data data sent from client to
-     * the api in the given format.
-     * @return array associative array of the parsed data
-     */
-    public function decode($data);
+	/**
+	 * Decode the given data from the format
+	 * @param string $data data sent from client to
+	 * the api in the given format.
+	 * @return array associative array of the parsed data
+	 */
+	public function decode($data);
 }
 
 /**
@@ -1091,57 +1091,57 @@ 
 class UrlEncodedFormat implements iFormat
 {
 
-    const MIME = 'application/x-www-form-urlencoded';
-    const EXTENSION = 'post';
+	const MIME = 'application/x-www-form-urlencoded';
+	const EXTENSION = 'post';
 
 
-    public function getMIMEMap()
-    {
-        return array(self::EXTENSION => self::MIME);
-    }
+	public function getMIMEMap()
+	{
+		return array(self::EXTENSION => self::MIME);
+	}
 
 
-    public function getMIME()
-    {
-        return self::MIME;
-    }
+	public function getMIME()
+	{
+		return self::MIME;
+	}
 
 
-    public function getExtension()
-    {
-        return self::EXTENSION;
-    }
+	public function getExtension()
+	{
+		return self::EXTENSION;
+	}
 
 
-    public function setMIME($mime)
-    {
-        //do nothing
-    }
+	public function setMIME($mime)
+	{
+		//do nothing
+	}
 
 
-    public function setExtension($extension)
-    {
-        //do nothing
-    }
+	public function setExtension($extension)
+	{
+		//do nothing
+	}
 
 
-    public function encode($data, $human_readable = false)
-    {
-        return http_build_query($data);
-    }
+	public function encode($data, $human_readable = false)
+	{
+		return http_build_query($data);
+	}
 
 
-    public function decode($data)
-    {
-        parse_str($data, $r);
-        return $r;
-    }
+	public function decode($data)
+	{
+		parse_str($data, $r);
+		return $r;
+	}
 
 
-    public function __toString()
-    {
-        return $this->getExtension();
-    }
+	public function __toString()
+	{
+		return $this->getExtension();
+	}
 
 }
 
@@ -1158,158 +1158,158 @@ 
 class JsonFormat implements iFormat
 {
 
-    const MIME = 'application/json,application/javascript';
-
-    static $mime = 'application/json';
-
-    const EXTENSION = 'json';
-
-
-    public function getMIMEMap()
-    {
-        return array(self::EXTENSION => self::MIME);
-    }
-
-
-    public function getMIME()
-    {
-        return self::$mime;
-    }
-
-
-    public function getExtension()
-    {
-        return self::EXTENSION;
-    }
-
-
-    public function setMIME($mime)
-    {
-        self::$mime = $mime;
-    }
-
-
-    public function setExtension($extension)
-    {
-        //do nothing
-    }
-
-
-    public function encode($data, $human_readable = false)
-    {
-        return $human_readable ? 
-            $this->json_format(json_encode(object_to_array($data))) : 
-            json_encode(object_to_array($data));
-    }
-
-
-    public function decode($data)
-    {
-        $decoded = json_decode($data);
-        if (function_exists('json_last_error')) {
-            $message = '';
-            switch (json_last_error()) {
-                case JSON_ERROR_NONE:
-                    return object_to_array($decoded);
-                    break;
-                case JSON_ERROR_DEPTH:
-                    $message = 'maximum stack depth exceeded';
-                    break;
-                case JSON_ERROR_STATE_MISMATCH:
-                    $message = 'underflow or the modes mismatch';
-                    break;
-                case JSON_ERROR_CTRL_CHAR:
-                    $message = 'unexpected control character found';
-                    break;
-                case JSON_ERROR_SYNTAX:
-                    $message = 'malformed JSON';
-                    break;
-                case JSON_ERROR_UTF8:
-                    $message = 'malformed UTF-8 characters, '.
-                        'possibly incorrectly encoded';
-                    break;
-                default:
-                    $message = 'unknown error';
-                    break;
-            }
-            throw new RestException(400, 'Error parsing JSON, ' . $message);
-        } else if (strlen($data) && $decoded === null || $decoded === $data) {
-            throw new RestException(400, 'Error parsing JSON');
-        }
-        return object_to_array($decoded);
-    }
-
-
-    /**
-     * Pretty print JSON string
-     * @param string $json
-     * @return string formated json
-     */
-    private function json_format($json)
-    {
-        $tab = "  ";
-        $new_json = "";
-        $indent_level = 0;
-        $in_string = false;
-        $len = strlen($json);
-
-        for ($c = 0; $c < $len; $c++) {
-            $char = $json[$c];
-            switch ($char) {
-                case '{':
-                case '[':
-                    if (!$in_string) {
-                        $new_json .= $char . "\n" .
-                            str_repeat($tab, $indent_level + 1);
-                        $indent_level++;
-                    } else {
-                        $new_json .= $char;
-                    }
-                    break;
-                case '}':
-                case ']':
-                    if (!$in_string) {
-                        $indent_level--;
-                        $new_json .= "\n" . str_repeat($tab, $indent_level) 
-                            . $char;
-                    } else {
-                        $new_json .= $char;
-                    }
-                    break;
-                case ',':
-                    if (!$in_string) {
-                        $new_json .= ",\n" . str_repeat($tab, $indent_level);
-                    } else {
-                        $new_json .= $char;
-                    }
-                    break;
-                case ':':
-                    if (!$in_string) {
-                        $new_json .= ": ";
-                    } else {
-                        $new_json .= $char;
-                    }
-                    break;
-                case '"':
-                    if ($c == 0) {
-                        $in_string = true;
-                    } else if ($c > 0 && $json[$c - 1] != '\\') {
-                        $in_string = !$in_string;
-                    }
-                default:
-                    $new_json .= $char;
-                    break;
-            }
-        }
-
-        return $new_json;
-    }
-
-
-    public function __toString()
-    {
-        return $this->getExtension();
-    }
+	const MIME = 'application/json,application/javascript';
+
+	static $mime = 'application/json';
+
+	const EXTENSION = 'json';
+
+
+	public function getMIMEMap()
+	{
+		return array(self::EXTENSION => self::MIME);
+	}
+
+
+	public function getMIME()
+	{
+		return self::$mime;
+	}
+
+
+	public function getExtension()
+	{
+		return self::EXTENSION;
+	}
+
+
+	public function setMIME($mime)
+	{
+		self::$mime = $mime;
+	}
+
+
+	public function setExtension($extension)
+	{
+		//do nothing
+	}
+
+
+	public function encode($data, $human_readable = false)
+	{
+		return $human_readable ? 
+			$this->json_format(json_encode(object_to_array($data))) : 
+			json_encode(object_to_array($data));
+	}
+
+
+	public function decode($data)
+	{
+		$decoded = json_decode($data);
+		if (function_exists('json_last_error')) {
+			$message = '';
+			switch (json_last_error()) {
+				case JSON_ERROR_NONE:
+					return object_to_array($decoded);
+					break;
+				case JSON_ERROR_DEPTH:
+					$message = 'maximum stack depth exceeded';
+					break;
+				case JSON_ERROR_STATE_MISMATCH:
+					$message = 'underflow or the modes mismatch';
+					break;
+				case JSON_ERROR_CTRL_CHAR:
+					$message = 'unexpected control character found';
+					break;
+				case JSON_ERROR_SYNTAX:
+					$message = 'malformed JSON';
+					break;
+				case JSON_ERROR_UTF8:
+					$message = 'malformed UTF-8 characters, '.
+						'possibly incorrectly encoded';
+					break;
+				default:
+					$message = 'unknown error';
+					break;
+			}
+			throw new RestException(400, 'Error parsing JSON, ' . $message);
+		} else if (strlen($data) && $decoded === null || $decoded === $data) {
+			throw new RestException(400, 'Error parsing JSON');
+		}
+		return object_to_array($decoded);
+	}
+
+
+	/**
+	 * Pretty print JSON string
+	 * @param string $json
+	 * @return string formated json
+	 */
+	private function json_format($json)
+	{
+		$tab = "  ";
+		$new_json = "";
+		$indent_level = 0;
+		$in_string = false;
+		$len = strlen($json);
+
+		for ($c = 0; $c < $len; $c++) {
+			$char = $json[$c];
+			switch ($char) {
+				case '{':
+				case '[':
+					if (!$in_string) {
+						$new_json .= $char . "\n" .
+							str_repeat($tab, $indent_level + 1);
+						$indent_level++;
+					} else {
+						$new_json .= $char;
+					}
+					break;
+				case '}':
+				case ']':
+					if (!$in_string) {
+						$indent_level--;
+						$new_json .= "\n" . str_repeat($tab, $indent_level) 
+							. $char;
+					} else {
+						$new_json .= $char;
+					}
+					break;
+				case ',':
+					if (!$in_string) {
+						$new_json .= ",\n" . str_repeat($tab, $indent_level);
+					} else {
+						$new_json .= $char;
+					}
+					break;
+				case ':':
+					if (!$in_string) {
+						$new_json .= ": ";
+					} else {
+						$new_json .= $char;
+					}
+					break;
+				case '"':
+					if ($c == 0) {
+						$in_string = true;
+					} else if ($c > 0 && $json[$c - 1] != '\\') {
+						$in_string = !$in_string;
+					}
+				default:
+					$new_json .= $char;
+					break;
+			}
+		}
+
+		return $new_json;
+	}
+
+
+	public function __toString()
+	{
+		return $this->getExtension();
+	}
 
 }
 
@@ -1327,123 +1327,123 @@ 
 class DocParser
 {
 
-    private $params = array();
-
-
-    public function parse($doc = '')
-    {
-        if ($doc == '') {
-            return $this->params;
-        }
-        //Get the comment
-        if (preg_match('#^/\*\*(.*)\*/#s', $doc, $comment) === false) {
-            return $this->params;
-        }
-        $comment = trim($comment[1]);
-        //Get all the lines and strip the * from the first character
-        if (preg_match_all('#^\s*\*(.*)#m', $comment, $lines) === false) {
-            return $this->params;
-        }
-        $this->parseLines($lines[1]);
-        return $this->params;
-    }
-
-
-    private function parseLines($lines)
-    {
-        foreach ($lines as $line) {
-            $parsedLine = $this->parseLine($line); //Parse the line
-
-            if ($parsedLine === false && !isset($this->params['description'])) {
-                if (isset($desc)) {
-                    //Store the first line in the short description
-                    $this->params['description'] = implode(PHP_EOL, $desc);
-                }
-                $desc = array();
-            } else if ($parsedLine !== false) {
-                $desc[] = $parsedLine; //Store the line in the long description
-            }
-        }
-        $desc = implode(' ', $desc);
-        if (!empty($desc)) {
-            $this->params['long_description'] = $desc;
-        }
-    }
-
-
-    private function parseLine($line)
-    {
-        //trim the whitespace from the line
-        $line = trim($line);
-
-        if (empty($line)) {
-            return false; //Empty line
-        }
-
-        if (strpos($line, '@') === 0) {
-            if (strpos($line, ' ') > 0) {
-                //Get the parameter name
-                $param = substr($line, 1, strpos($line, ' ') - 1);
-                $value = substr($line, strlen($param) + 2); //Get the value
-            } else {
-                $param = substr($line, 1);
-                $value = '';
-            }
-            //Parse the line and return false if the parameter is valid
-            if ($this->setParam($param, $value)) {
-                return false;
-            }
-        }
-        return $line;
-    }
-
-
-    private function setParam($param, $value)
-    {
-        if ($param == 'param' || $param == 'return') {
-            $value = $this->formatParamOrReturn($value);
-        }
-        if ($param == 'class') {
-            list($param, $value) = $this->formatClass($value);
-        }
-
-        if (empty($this->params[$param])) {
-            $this->params[$param] = $value;
-        } else if ($param == 'param') {
-            $arr = array($this->params[$param], $value);
-            $this->params[$param] = $arr;
-        } else {
-            $this->params[$param] = $value + $this->params[$param];
-        }
-        return true;
-    }
-
-
-    private function formatClass($value)
-    {
-        $r = preg_split("[\(|\)]", $value);
-        if (count($r) > 1) {
-            $param = $r[0];
-            parse_str($r[1], $value);
-            foreach ($value as $key => $val) {
-                $val = explode(',', $val);
-                if (count($val) > 1) {
-                    $value[$key] = $val;
-                }
-            }
-        } else {
-            $param = 'Unknown';
-        }
-        return array($param, $value);
-    }
-
-
-    private function formatParamOrReturn($string)
-    {
-        $pos = strpos($string, ' ');
-        $type = substr($string, 0, $pos);
-        return '(' . $type . ')' . substr($string, $pos + 1);
-    }
+	private $params = array();
+
+
+	public function parse($doc = '')
+	{
+		if ($doc == '') {
+			return $this->params;
+		}
+		//Get the comment
+		if (preg_match('#^/\*\*(.*)\*/#s', $doc, $comment) === false) {
+			return $this->params;
+		}
+		$comment = trim($comment[1]);
+		//Get all the lines and strip the * from the first character
+		if (preg_match_all('#^\s*\*(.*)#m', $comment, $lines) === false) {
+			return $this->params;
+		}
+		$this->parseLines($lines[1]);
+		return $this->params;
+	}
+
+
+	private function parseLines($lines)
+	{
+		foreach ($lines as $line) {
+			$parsedLine = $this->parseLine($line); //Parse the line
+
+			if ($parsedLine === false && !isset($this->params['description'])) {
+				if (isset($desc)) {
+					//Store the first line in the short description
+					$this->params['description'] = implode(PHP_EOL, $desc);
+				}
+				$desc = array();
+			} else if ($parsedLine !== false) {
+				$desc[] = $parsedLine; //Store the line in the long description
+			}
+		}
+		$desc = implode(' ', $desc);
+		if (!empty($desc)) {
+			$this->params['long_description'] = $desc;
+		}
+	}
+
+
+	private function parseLine($line)
+	{
+		//trim the whitespace from the line
+		$line = trim($line);
+
+		if (empty($line)) {
+			return false; //Empty line
+		}
+
+		if (strpos($line, '@') === 0) {
+			if (strpos($line, ' ') > 0) {
+				//Get the parameter name
+				$param = substr($line, 1, strpos($line, ' ') - 1);
+				$value = substr($line, strlen($param) + 2); //Get the value
+			} else {
+				$param = substr($line, 1);
+				$value = '';
+			}
+			//Parse the line and return false if the parameter is valid
+			if ($this->setParam($param, $value)) {
+				return false;
+			}
+		}
+		return $line;
+	}
+
+
+	private function setParam($param, $value)
+	{
+		if ($param == 'param' || $param == 'return') {
+			$value = $this->formatParamOrReturn($value);
+		}
+		if ($param == 'class') {
+			list($param, $value) = $this->formatClass($value);
+		}
+
+		if (empty($this->params[$param])) {
+			$this->params[$param] = $value;
+		} else if ($param == 'param') {
+			$arr = array($this->params[$param], $value);
+			$this->params[$param] = $arr;
+		} else {
+			$this->params[$param] = $value + $this->params[$param];
+		}
+		return true;
+	}
+
+
+	private function formatClass($value)
+	{
+		$r = preg_split("[\(|\)]", $value);
+		if (count($r) > 1) {
+			$param = $r[0];
+			parse_str($r[1], $value);
+			foreach ($value as $key => $val) {
+				$val = explode(',', $val);
+				if (count($val) > 1) {
+					$value[$key] = $val;
+				}
+			}
+		} else {
+			$param = 'Unknown';
+		}
+		return array($param, $value);
+	}
+
+
+	private function formatParamOrReturn($string)
+	{
+		$pos = strpos($string, ' ');
+		$type = substr($string, 0, $pos);
+		return '(' . $type . ')' . substr($string, $pos + 1);
+	}
 
 }
 
@@ -1456,30 +1456,30 @@ 
 
 function parse_doc($php_doc_comment)
 {
-    $p = new DocParser();
-    return $p->parse($php_doc_comment);
+	$p = new DocParser();
+	return $p->parse($php_doc_comment);
 
-    $p = new Parser($php_doc_comment);
-    return $p;
+	$p = new Parser($php_doc_comment);
+	return $p;
 
-    $php_doc_comment = preg_replace(
-        "/(^[\\s]*\\/\\*\\*)
+	$php_doc_comment = preg_replace(
+		"/(^[\\s]*\\/\\*\\*)
         |(^[\\s]\\*\\/)
         |(^[\\s]*\\*?\\s)
         |(^[\\s]*)
         |(^[\\t]*)/ixm",
-        "", $php_doc_comment);
-    $php_doc_comment = str_replace("\r", "", $php_doc_comment);
-    $php_doc_comment = preg_replace("/([\\t])+/", "\t", $php_doc_comment);
-    return explode("\n", $php_doc_comment);
-
-    $php_doc_comment = trim(preg_replace('/\r?\n *\* */', ' ', 
-            $php_doc_comment));
-    return $php_doc_comment;
-
-    preg_match_all('/@([a-z]+)\s+(.*?)\s*(?=$|@[a-z]+\s)/s', $php_doc_comment,
-        $matches);
-    return array_combine($matches[1], $matches[2]);
+		"", $php_doc_comment);
+	$php_doc_comment = str_replace("\r", "", $php_doc_comment);
+	$php_doc_comment = preg_replace("/([\\t])+/", "\t", $php_doc_comment);
+	return explode("\n", $php_doc_comment);
+
+	$php_doc_comment = trim(preg_replace('/\r?\n *\* */', ' ', 
+			$php_doc_comment));
+	return $php_doc_comment;
+
+	preg_match_all('/@([a-z]+)\s+(.*?)\s*(?=$|@[a-z]+\s)/s', $php_doc_comment,
+		$matches);
+	return array_combine($matches[1], $matches[2]);
 }
 
 
@@ -1498,21 +1498,21 @@ 
  */
 function object_to_array($object, $utf_encode = false)
 {
-    if (is_array($object)
-        || (is_object($object)
-        && !($object instanceof JsonSerializable))
-    ) {
-        $array = array();
-        foreach ($object as $key => $value) {
-            $value = object_to_array($value, $utf_encode);
-            if ($utf_encode && is_string($value)) {
-                $value = utf8_encode($value);
-            }
-            $array[$key] = $value;
-        }
-        return $array;
-    }
-    return $object;
+	if (is_array($object)
+		|| (is_object($object)
+		&& !($object instanceof JsonSerializable))
+	) {
+		$array = array();
+		foreach ($object as $key => $value) {
+			$value = object_to_array($value, $utf_encode);
+			if ($utf_encode && is_string($value)) {
+				$value = utf8_encode($value);
+			}
+			$array[$key] = $value;
+		}
+		return $array;
+	}
+	return $object;
 }
 
 
@@ -1522,21 +1522,21 @@ 
  */
 function autoload_formats($class_name)
 {
-    $class_name = strtolower($class_name);
+	$class_name = strtolower($class_name);
 	
-    $file = RESTLER_PATH . "../../../api/mobile_services/$class_name.php";
-    if (file_exists($file)) {
-        require_once ($file);
-    } else {
+	$file = RESTLER_PATH . "../../../api/mobile_services/$class_name.php";
+	if (file_exists($file)) {
+		require_once ($file);
+	} else {
 		$file = RESTLER_PATH . "/../../api/mobile_services/$class_name.php";
-        if (file_exists($file)) {
-            require_once ($file);
-        } elseif (file_exists(RESTLER_PATH . "/../api/mobile_services/$class_name.php")) {
-            require_once ("/../api/mobile_services/$class_name.php");
-        } elseif (file_exists("$class_name.php")) {
-            require_once ("$class_name.php");
-        }
-    }
+		if (file_exists($file)) {
+			require_once ($file);
+		} elseif (file_exists(RESTLER_PATH . "/../api/mobile_services/$class_name.php")) {
+			require_once ("/../api/mobile_services/$class_name.php");
+		} elseif (file_exists("$class_name.php")) {
+			require_once ("$class_name.php");
+		}
+	}
 }
 
 // ==================================================================
@@ -1553,10 +1553,10 @@ 
 if (!function_exists('isRestlerCompatibilityModeEnabled')) {
 
 
-    function isRestlerCompatibilityModeEnabled()
-    {
-        return false;
-    }
+	function isRestlerCompatibilityModeEnabled()
+	{
+		return false;
+	}
 
 }
 define('RESTLER_PATH', dirname(__FILE__));

libraries/SabreDAV/DAVACL/FS/HomeCollection.php

Doc Comments +1 added lines, -1 removed lines

@@ -70,7 +70,7 @@
      * supplied by the authentication backend.
      *
      * @param array $principalInfo
-     * @return void
+     * @return Collection
      */
     function getChildForPrincipal(array $principalInfo) {
 

Unused Use Statements +1 added lines, -1 removed lines

@@ -2,10 +2,10 @@
 
 namespace Sabre\DAVACL\FS;
 
-use Sabre\DAV\Exception\Forbidden;
 use Sabre\DAVACL\AbstractPrincipalCollection;
 use Sabre\DAVACL\IACL;
 use Sabre\DAVACL\PrincipalBackend\BackendInterface;
+use Sabre\DAV\Exception\Forbidden;
 use Sabre\Uri;
 
 /**

Indentation +163 added lines, -163 removed lines

@@ -21,168 +21,168 @@
  */
 class HomeCollection extends AbstractPrincipalCollection implements IACL {
 
-    /**
-     * Name of this collection.
-     *
-     * @var string
-     */
-    public $collectionName = 'home';
-
-    /**
-     * Path to where the users' files are actually stored.
-     *
-     * @var string
-     */
-    protected $storagePath;
-
-    /**
-     * Creates the home collection.
-     *
-     * @param BackendInterface $principalBackend
-     * @param string $storagePath Where the actual files are stored.
-     * @param string $principalPrefix list of principals to iterate.
-     */
-    public function __construct(BackendInterface $principalBackend, $storagePath, $principalPrefix = 'principals') {
-
-        parent::__construct($principalBackend, $principalPrefix);
-        $this->storagePath = $storagePath;
-
-    }
-
-    /**
-     * Returns the name of the node.
-     *
-     * This is used to generate the url.
-     *
-     * @return string
-     */
-    public function getName() {
-
-        return $this->collectionName;
-
-    }
-
-    /**
-     * Returns a principals' collection of files.
-     *
-     * The passed array contains principal information, and is guaranteed to
-     * at least contain a uri item. Other properties may or may not be
-     * supplied by the authentication backend.
-     *
-     * @param array $principalInfo
-     * @return void
-     */
-    public function getChildForPrincipal(array $principalInfo) {
-
-        $owner = $principalInfo['uri'];
-        $acl = [
-            [
-                'privilege' => '{DAV:}read',
-                'principal' => $owner,
-                'protected' => true,
-            ],
-            [
-                'privilege' => '{DAV:}write',
-                'principal' => $owner,
-                'protected' => true,
-            ],
-        ];
-
-        list(, $principalBaseName) = Uri\split($owner);
-
-        $path = $this->storagePath . '/' . $principalBaseName;
-
-        if (!is_dir($path)) {
-            mkdir($path, 0777, true);
-        }
-        return new Collection(
-            $path,
-            $acl,
-            $owner
-        );
-
-    }
-
-    /**
-     * Returns the owner principal
-     *
-     * This must be a url to a principal, or null if there's no owner
-     *
-     * @return string|null
-     */
-    public function getOwner() {
-
-        return null;
-
-    }
-
-    /**
-     * Returns a group principal
-     *
-     * This must be a url to a principal, or null if there's no owner
-     *
-     * @return string|null
-     */
-    public function getGroup() {
-
-        return null;
-
-    }
-
-    /**
-     * Returns a list of ACE's for this node.
-     *
-     * Each ACE has the following properties:
-     *   * 'privilege', a string such as {DAV:}read or {DAV:}write. These are
-     *     currently the only supported privileges
-     *   * 'principal', a url to the principal who owns the node
-     *   * 'protected' (optional), indicating that this ACE is not allowed to
-     *      be updated.
-     *
-     * @return array
-     */
-    public function getACL() {
-
-        return [
-            [
-                'principal' => '{DAV:}authenticated',
-                'privilege' => '{DAV:}read',
-                'protected' => true,
-            ]
-        ];
-
-    }
-
-    /**
-     * Updates the ACL
-     *
-     * This method will receive a list of new ACE's as an array argument.
-     *
-     * @param array $acl
-     * @return void
-     */
-    public function setACL(array $acl) {
-
-        throw new Forbidden('Setting ACL is not allowed here');
-
-    }
-
-    /**
-     * Returns the list of supported privileges for this node.
-     *
-     * The returned data structure is a list of nested privileges.
-     * See Sabre\DAVACL\Plugin::getDefaultSupportedPrivilegeSet for a simple
-     * standard structure.
-     *
-     * If null is returned from this method, the default privilege set is used,
-     * which is fine for most common usecases.
-     *
-     * @return array|null
-     */
-    public function getSupportedPrivilegeSet() {
-
-        return null;
-
-    }
+	/**
+	 * Name of this collection.
+	 *
+	 * @var string
+	 */
+	public $collectionName = 'home';
+
+	/**
+	 * Path to where the users' files are actually stored.
+	 *
+	 * @var string
+	 */
+	protected $storagePath;
+
+	/**
+	 * Creates the home collection.
+	 *
+	 * @param BackendInterface $principalBackend
+	 * @param string $storagePath Where the actual files are stored.
+	 * @param string $principalPrefix list of principals to iterate.
+	 */
+	public function __construct(BackendInterface $principalBackend, $storagePath, $principalPrefix = 'principals') {
+
+		parent::__construct($principalBackend, $principalPrefix);
+		$this->storagePath = $storagePath;
+
+	}
+
+	/**
+	 * Returns the name of the node.
+	 *
+	 * This is used to generate the url.
+	 *
+	 * @return string
+	 */
+	public function getName() {
+
+		return $this->collectionName;
+
+	}
+
+	/**
+	 * Returns a principals' collection of files.
+	 *
+	 * The passed array contains principal information, and is guaranteed to
+	 * at least contain a uri item. Other properties may or may not be
+	 * supplied by the authentication backend.
+	 *
+	 * @param array $principalInfo
+	 * @return void
+	 */
+	public function getChildForPrincipal(array $principalInfo) {
+
+		$owner = $principalInfo['uri'];
+		$acl = [
+			[
+				'privilege' => '{DAV:}read',
+				'principal' => $owner,
+				'protected' => true,
+			],
+			[
+				'privilege' => '{DAV:}write',
+				'principal' => $owner,
+				'protected' => true,
+			],
+		];
+
+		list(, $principalBaseName) = Uri\split($owner);
+
+		$path = $this->storagePath . '/' . $principalBaseName;
+
+		if (!is_dir($path)) {
+			mkdir($path, 0777, true);
+		}
+		return new Collection(
+			$path,
+			$acl,
+			$owner
+		);
+
+	}
+
+	/**
+	 * Returns the owner principal
+	 *
+	 * This must be a url to a principal, or null if there's no owner
+	 *
+	 * @return string|null
+	 */
+	public function getOwner() {
+
+		return null;
+
+	}
+
+	/**
+	 * Returns a group principal
+	 *
+	 * This must be a url to a principal, or null if there's no owner
+	 *
+	 * @return string|null
+	 */
+	public function getGroup() {
+
+		return null;
+
+	}
+
+	/**
+	 * Returns a list of ACE's for this node.
+	 *
+	 * Each ACE has the following properties:
+	 *   * 'privilege', a string such as {DAV:}read or {DAV:}write. These are
+	 *     currently the only supported privileges
+	 *   * 'principal', a url to the principal who owns the node
+	 *   * 'protected' (optional), indicating that this ACE is not allowed to
+	 *      be updated.
+	 *
+	 * @return array
+	 */
+	public function getACL() {
+
+		return [
+			[
+				'principal' => '{DAV:}authenticated',
+				'privilege' => '{DAV:}read',
+				'protected' => true,
+			]
+		];
+
+	}
+
+	/**
+	 * Updates the ACL
+	 *
+	 * This method will receive a list of new ACE's as an array argument.
+	 *
+	 * @param array $acl
+	 * @return void
+	 */
+	public function setACL(array $acl) {
+
+		throw new Forbidden('Setting ACL is not allowed here');
+
+	}
+
+	/**
+	 * Returns the list of supported privileges for this node.
+	 *
+	 * The returned data structure is a list of nested privileges.
+	 * See Sabre\DAVACL\Plugin::getDefaultSupportedPrivilegeSet for a simple
+	 * standard structure.
+	 *
+	 * If null is returned from this method, the default privilege set is used,
+	 * which is fine for most common usecases.
+	 *
+	 * @return array|null
+	 */
+	public function getSupportedPrivilegeSet() {
+
+		return null;
+
+	}
 
 }

libraries/SabreDAV/DAVACL/Plugin.php

Doc Comments +9 added lines, -11 removed lines

@@ -113,7 +113,7 @@ 
      *
      * This list is used in the response of a HTTP OPTIONS request.
      *
-     * @return array
+     * @return string[]
      */
     function getFeatures() {
 
@@ -125,7 +125,7 @@ 
      * Returns a list of available methods for a given url
      *
      * @param string $uri
-     * @return array
+     * @return string[]
      */
     function getMethods($uri) {
 
@@ -155,7 +155,7 @@ 
      * implement them
      *
      * @param string $uri
-     * @return array
+     * @return string[]
      */
     function getSupportedReportSet($uri) {
 
@@ -176,7 +176,7 @@ 
      * and return true otherwise.
      *
      * @param string $uri
-     * @param array|string $privileges
+     * @param string $privileges
      * @param int $recursion
      * @param bool $throwExceptions if set to false, this method won't throw exceptions.
      * @throws Sabre\DAVACL\Exception\NeedPrivileges
@@ -269,7 +269,7 @@ 
     /**
      * Returns all the principal groups the specified principal is a member of.
      *
-     * @param string $principal
+     * @param string $mainPrincipal
      * @return array
      */
     function getPrincipalMembership($mainPrincipal) {
@@ -831,10 +831,8 @@ 
      *
      * @param DAV\PropFind $propFind
      * @param DAV\INode $node
-     * @param array $requestedProperties
-     * @param array $returnedProperties
      * @TODO really should be broken into multiple methods, or even a class.
-     * @return bool
+     * @return false|null
      */
     function propFind(DAV\PropFind $propFind, DAV\INode $node) {
 
@@ -982,7 +980,7 @@ 
      * @param string $reportName
      * @param mixed $report
      * @param mixed $path
-     * @return bool
+     * @return false|null
      */
     function report($reportName, $report, $path) {
 
@@ -1133,7 +1131,7 @@ 
      * @param array $path
      * @param array $requestedProperties the list of required properties
      * @param int $depth
-     * @return array
+     * @return DAV\Xml\Element\Response[]
      */
     protected function expandProperties($path, array $requestedProperties, $depth) {
 
@@ -1278,7 +1276,7 @@ 
      *
      * @param DAV\INode $node
      * @param string $output
-     * @return bool
+     * @return null|false
      */
     function htmlActionsPanel(DAV\INode $node, &$output) {
 

Spacing +9 added lines, -9 removed lines

@@ -674,15 +674,15 @@
     function initialize(DAV\Server $server) {
 
         $this->server = $server;
-        $server->on('propFind',            [$this, 'propFind'], 20);
-        $server->on('beforeMethod',        [$this, 'beforeMethod'], 20);
-        $server->on('beforeBind',          [$this, 'beforeBind'], 20);
-        $server->on('beforeUnbind',        [$this, 'beforeUnbind'], 20);
-        $server->on('propPatch',           [$this, 'propPatch']);
-        $server->on('beforeUnlock',        [$this, 'beforeUnlock'], 20);
-        $server->on('report',              [$this, 'report']);
-        $server->on('method:ACL',          [$this, 'httpAcl']);
-        $server->on('onHTMLActionsPanel',  [$this, 'htmlActionsPanel']);
+        $server->on('propFind', [$this, 'propFind'], 20);
+        $server->on('beforeMethod', [$this, 'beforeMethod'], 20);
+        $server->on('beforeBind', [$this, 'beforeBind'], 20);
+        $server->on('beforeUnbind', [$this, 'beforeUnbind'], 20);
+        $server->on('propPatch', [$this, 'propPatch']);
+        $server->on('beforeUnlock', [$this, 'beforeUnlock'], 20);
+        $server->on('report', [$this, 'report']);
+        $server->on('method:ACL', [$this, 'httpAcl']);
+        $server->on('onHTMLActionsPanel', [$this, 'htmlActionsPanel']);
 
         array_push($server->protectedProperties,
             '{DAV:}alternate-URI-set',

Braces +49 added lines, -25 removed lines

@@ -184,7 +184,9 @@ 
      */
     function checkPrivileges($uri, $privileges, $recursion = self::R_PARENT, $throwExceptions = true) {
 
-        if (!is_array($privileges)) $privileges = [$privileges];
+        if (!is_array($privileges)) {
+        	$privileges = [$privileges];
+        }
 
         $acl = $this->getCurrentUserPrivilegeSet($uri);
 
@@ -192,10 +194,11 @@ 
             if ($this->allowAccessToNodesWithoutACL) {
                 return true;
             } else {
-                if ($throwExceptions)
-                    throw new Exception\NeedPrivileges($uri, $privileges);
-                else
-                    return false;
+                if ($throwExceptions) {
+                                    throw new Exception\NeedPrivileges($uri, $privileges);
+                } else {
+                                    return false;
+                }
 
             }
         }
@@ -210,10 +213,11 @@ 
         }
 
         if ($failed) {
-            if ($throwExceptions)
-                throw new Exception\NeedPrivileges($uri, $failed);
-            else
-                return false;
+            if ($throwExceptions) {
+                            throw new Exception\NeedPrivileges($uri, $failed);
+            } else {
+                            return false;
+            }
         }
         return true;
 
@@ -230,7 +234,9 @@ 
     function getCurrentUserPrincipal() {
 
         $authPlugin = $this->server->getPlugin('auth');
-        if (is_null($authPlugin)) return null;
+        if (is_null($authPlugin)) {
+        	return null;
+        }
         /** @var $authPlugin Sabre\DAV\Auth\Plugin */
 
         return $authPlugin->getCurrentPrincipal();
@@ -248,7 +254,9 @@ 
 
         $currentUser = $this->getCurrentUserPrincipal();
 
-        if (is_null($currentUser)) return [];
+        if (is_null($currentUser)) {
+        	return [];
+        }
 
         return array_merge(
             [$currentUser],
@@ -331,8 +339,9 @@ 
         if ($node instanceof IACL) {
             $result = $node->getSupportedPrivilegeSet();
 
-            if ($result)
-                return $result;
+            if ($result) {
+                            return $result;
+            }
         }
 
         return self::getDefaultSupportedPrivilegeSet();
@@ -506,7 +515,9 @@ 
 
         $acl = $this->getACL($node);
 
-        if (is_null($acl)) return null;
+        if (is_null($acl)) {
+        	return null;
+        }
 
         $principals = $this->getCurrentUserPrincipals();
 
@@ -730,7 +741,9 @@ 
         $exists = $this->server->tree->nodeExists($path);
 
         // If the node doesn't exists, none of these checks apply
-        if (!$exists) return;
+        if (!$exists) {
+        	return;
+        }
 
         switch ($method) {
 
@@ -891,7 +904,9 @@ 
 
             $val = $this->principalCollectionSet;
             // Ensuring all collections end with a slash
-            foreach ($val as $k => $v) $val[$k] = $v . '/';
+            foreach ($val as $k => $v) {
+            	$val[$k] = $v . '/';
+            }
             return new DAV\Xml\Property\Href($val);
 
         });
@@ -1042,7 +1057,9 @@ 
            not overwritten. */
         foreach ($oldAcl as $oldAce) {
 
-            if (!isset($oldAce['protected']) || !$oldAce['protected']) continue;
+            if (!isset($oldAce['protected']) || !$oldAce['protected']) {
+            	continue;
+            }
 
             $found = false;
             foreach ($newAcl as $newAce) {
@@ -1050,12 +1067,14 @@ 
                     $newAce['privilege'] === $oldAce['privilege'] &&
                     $newAce['principal'] === $oldAce['principal'] &&
                     $newAce['protected']
-                )
-                $found = true;
+                ) {
+                                $found = true;
+                }
             }
 
-            if (!$found)
-                throw new Exception\AceConflict('This resource contained a protected {DAV:}ace, but this privilege did not occur in the ACL request');
+            if (!$found) {
+                            throw new Exception\AceConflict('This resource contained a protected {DAV:}ace, but this privilege did not occur in the ACL request');
+            }
 
         }
 
@@ -1146,11 +1165,15 @@ 
             foreach ($requestedProperties as $propertyName => $childRequestedProperties) {
 
                 // We're only traversing if sub-properties were requested
-                if (count($childRequestedProperties) === 0) continue;
+                if (count($childRequestedProperties) === 0) {
+                	continue;
+                }
 
                 // We only have to do the expansion if the property was found
                 // and it contains an href element.
-                if (!array_key_exists($propertyName, $node[200])) continue;
+                if (!array_key_exists($propertyName, $node[200])) {
+                	continue;
+                }
 
                 if (!$node[200][$propertyName] instanceof DAV\Xml\Property\Href) {
                     continue;
@@ -1282,8 +1305,9 @@ 
      */
     function htmlActionsPanel(DAV\INode $node, &$output) {
 
-        if (!$node instanceof PrincipalCollection)
-            return;
+        if (!$node instanceof PrincipalCollection) {
+                    return;
+        }
 
         $output .= '<tr><td colspan="2"><form method="post" action="">
             <h3>Create new principal</h3>

Unused Use Statements +1 added lines, -1 removed lines

@@ -3,8 +3,8 @@
 namespace Sabre\DAVACL;
 
 use Sabre\DAV;
-use Sabre\DAV\INode;
 use Sabre\DAV\Exception\BadRequest;
+use Sabre\DAV\INode;
 use Sabre\HTTP\RequestInterface;
 use Sabre\HTTP\ResponseInterface;
 use Sabre\Uri;

Indentation +1255 added lines, -1255 removed lines

@@ -25,1265 +25,1265 @@ 
  */
 class Plugin extends DAV\ServerPlugin {
 
-    /**
-     * Recursion constants
-     *
-     * This only checks the base node
-     */
-    const R_PARENT = 1;
-
-    /**
-     * Recursion constants
-     *
-     * This checks every node in the tree
-     */
-    const R_RECURSIVE = 2;
-
-    /**
-     * Recursion constants
-     *
-     * This checks every parentnode in the tree, but not leaf-nodes.
-     */
-    const R_RECURSIVEPARENTS = 3;
-
-    /**
-     * Reference to server object.
-     *
-     * @var Sabre\DAV\Server
-     */
-    protected $server;
-
-    /**
-     * List of urls containing principal collections.
-     * Modify this if your principals are located elsewhere.
-     *
-     * @var array
-     */
-    public $principalCollectionSet = [
-        'principals',
-    ];
-
-    /**
-     * By default ACL is only enforced for nodes that have ACL support (the
-     * ones that implement IACL). For any other node, access is
-     * always granted.
-     *
-     * To override this behaviour you can turn this setting off. This is useful
-     * if you plan to fully support ACL in the entire tree.
-     *
-     * @var bool
-     */
-    public $allowAccessToNodesWithoutACL = true;
-
-    /**
-     * By default nodes that are inaccessible by the user, can still be seen
-     * in directory listings (PROPFIND on parent with Depth: 1)
-     *
-     * In certain cases it's desirable to hide inaccessible nodes. Setting this
-     * to true will cause these nodes to be hidden from directory listings.
-     *
-     * @var bool
-     */
-    public $hideNodesFromListings = false;
-
-    /**
-     * This list of properties are the properties a client can search on using
-     * the {DAV:}principal-property-search report.
-     *
-     * The keys are the property names, values are descriptions.
-     *
-     * @var array
-     */
-    public $principalSearchPropertySet = [
-        '{DAV:}displayname'                     => 'Display name',
-        '{http://sabredav.org/ns}email-address' => 'Email address',
-    ];
-
-    /**
-     * Any principal uri's added here, will automatically be added to the list
-     * of ACL's. They will effectively receive {DAV:}all privileges, as a
-     * protected privilege.
-     *
-     * @var array
-     */
-    public $adminPrincipals = [];
-
-    /**
-     * Returns a list of features added by this plugin.
-     *
-     * This list is used in the response of a HTTP OPTIONS request.
-     *
-     * @return array
-     */
-    public function getFeatures() {
-
-        return ['access-control', 'calendarserver-principal-property-search'];
-
-    }
-
-    /**
-     * Returns a list of available methods for a given url
-     *
-     * @param string $uri
-     * @return array
-     */
-    public function getMethods($uri) {
-
-        return ['ACL'];
-
-    }
-
-    /**
-     * Returns a plugin name.
-     *
-     * Using this name other plugins will be able to access other plugins
-     * using Sabre\DAV\Server::getPlugin
-     *
-     * @return string
-     */
-    public function getPluginName() {
-
-        return 'acl';
-
-    }
-
-    /**
-     * Returns a list of reports this plugin supports.
-     *
-     * This will be used in the {DAV:}supported-report-set property.
-     * Note that you still need to subscribe to the 'report' event to actually
-     * implement them
-     *
-     * @param string $uri
-     * @return array
-     */
-    public function getSupportedReportSet($uri) {
-
-        return [
-            '{DAV:}expand-property',
-            '{DAV:}principal-property-search',
-            '{DAV:}principal-search-property-set',
-        ];
-
-    }
-
-
-    /**
-     * Checks if the current user has the specified privilege(s).
-     *
-     * You can specify a single privilege, or a list of privileges.
-     * This method will throw an exception if the privilege is not available
-     * and return true otherwise.
-     *
-     * @param string $uri
-     * @param array|string $privileges
-     * @param int $recursion
-     * @param bool $throwExceptions if set to false, this method won't throw exceptions.
-     * @throws Sabre\DAVACL\Exception\NeedPrivileges
-     * @return bool
-     */
-    public function checkPrivileges($uri, $privileges, $recursion = self::R_PARENT, $throwExceptions = true) {
-
-        if (!is_array($privileges)) $privileges = [$privileges];
-
-        $acl = $this->getCurrentUserPrivilegeSet($uri);
-
-        if (is_null($acl)) {
-            if ($this->allowAccessToNodesWithoutACL) {
-                return true;
-            } else {
-                if ($throwExceptions)
-                    throw new Exception\NeedPrivileges($uri, $privileges);
-                else
-                    return false;
-
-            }
-        }
-
-        $failed = [];
-        foreach ($privileges as $priv) {
-
-            if (!in_array($priv, $acl)) {
-                $failed[] = $priv;
-            }
-
-        }
-
-        if ($failed) {
-            if ($throwExceptions)
-                throw new Exception\NeedPrivileges($uri, $failed);
-            else
-                return false;
-        }
-        return true;
+	/**
+	 * Recursion constants
+	 *
+	 * This only checks the base node
+	 */
+	const R_PARENT = 1;
+
+	/**
+	 * Recursion constants
+	 *
+	 * This checks every node in the tree
+	 */
+	const R_RECURSIVE = 2;
+
+	/**
+	 * Recursion constants
+	 *
+	 * This checks every parentnode in the tree, but not leaf-nodes.
+	 */
+	const R_RECURSIVEPARENTS = 3;
+
+	/**
+	 * Reference to server object.
+	 *
+	 * @var Sabre\DAV\Server
+	 */
+	protected $server;
+
+	/**
+	 * List of urls containing principal collections.
+	 * Modify this if your principals are located elsewhere.
+	 *
+	 * @var array
+	 */
+	public $principalCollectionSet = [
+		'principals',
+	];
+
+	/**
+	 * By default ACL is only enforced for nodes that have ACL support (the
+	 * ones that implement IACL). For any other node, access is
+	 * always granted.
+	 *
+	 * To override this behaviour you can turn this setting off. This is useful
+	 * if you plan to fully support ACL in the entire tree.
+	 *
+	 * @var bool
+	 */
+	public $allowAccessToNodesWithoutACL = true;
+
+	/**
+	 * By default nodes that are inaccessible by the user, can still be seen
+	 * in directory listings (PROPFIND on parent with Depth: 1)
+	 *
+	 * In certain cases it's desirable to hide inaccessible nodes. Setting this
+	 * to true will cause these nodes to be hidden from directory listings.
+	 *
+	 * @var bool
+	 */
+	public $hideNodesFromListings = false;
+
+	/**
+	 * This list of properties are the properties a client can search on using
+	 * the {DAV:}principal-property-search report.
+	 *
+	 * The keys are the property names, values are descriptions.
+	 *
+	 * @var array
+	 */
+	public $principalSearchPropertySet = [
+		'{DAV:}displayname'                     => 'Display name',
+		'{http://sabredav.org/ns}email-address' => 'Email address',
+	];
+
+	/**
+	 * Any principal uri's added here, will automatically be added to the list
+	 * of ACL's. They will effectively receive {DAV:}all privileges, as a
+	 * protected privilege.
+	 *
+	 * @var array
+	 */
+	public $adminPrincipals = [];
+
+	/**
+	 * Returns a list of features added by this plugin.
+	 *
+	 * This list is used in the response of a HTTP OPTIONS request.
+	 *
+	 * @return array
+	 */
+	public function getFeatures() {
+
+		return ['access-control', 'calendarserver-principal-property-search'];
+
+	}
+
+	/**
+	 * Returns a list of available methods for a given url
+	 *
+	 * @param string $uri
+	 * @return array
+	 */
+	public function getMethods($uri) {
+
+		return ['ACL'];
+
+	}
+
+	/**
+	 * Returns a plugin name.
+	 *
+	 * Using this name other plugins will be able to access other plugins
+	 * using Sabre\DAV\Server::getPlugin
+	 *
+	 * @return string
+	 */
+	public function getPluginName() {
+
+		return 'acl';
+
+	}
+
+	/**
+	 * Returns a list of reports this plugin supports.
+	 *
+	 * This will be used in the {DAV:}supported-report-set property.
+	 * Note that you still need to subscribe to the 'report' event to actually
+	 * implement them
+	 *
+	 * @param string $uri
+	 * @return array
+	 */
+	public function getSupportedReportSet($uri) {
+
+		return [
+			'{DAV:}expand-property',
+			'{DAV:}principal-property-search',
+			'{DAV:}principal-search-property-set',
+		];
+
+	}
+
+
+	/**
+	 * Checks if the current user has the specified privilege(s).
+	 *
+	 * You can specify a single privilege, or a list of privileges.
+	 * This method will throw an exception if the privilege is not available
+	 * and return true otherwise.
+	 *
+	 * @param string $uri
+	 * @param array|string $privileges
+	 * @param int $recursion
+	 * @param bool $throwExceptions if set to false, this method won't throw exceptions.
+	 * @throws Sabre\DAVACL\Exception\NeedPrivileges
+	 * @return bool
+	 */
+	public function checkPrivileges($uri, $privileges, $recursion = self::R_PARENT, $throwExceptions = true) {
+
+		if (!is_array($privileges)) $privileges = [$privileges];
+
+		$acl = $this->getCurrentUserPrivilegeSet($uri);
+
+		if (is_null($acl)) {
+			if ($this->allowAccessToNodesWithoutACL) {
+				return true;
+			} else {
+				if ($throwExceptions)
+					throw new Exception\NeedPrivileges($uri, $privileges);
+				else
+					return false;
+
+			}
+		}
+
+		$failed = [];
+		foreach ($privileges as $priv) {
+
+			if (!in_array($priv, $acl)) {
+				$failed[] = $priv;
+			}
+
+		}
+
+		if ($failed) {
+			if ($throwExceptions)
+				throw new Exception\NeedPrivileges($uri, $failed);
+			else
+				return false;
+		}
+		return true;
 
-    }
-
-    /**
-     * Returns the standard users' principal.
-     *
-     * This is one authorative principal url for the current user.
-     * This method will return null if the user wasn't logged in.
-     *
-     * @return string|null
-     */
-    public function getCurrentUserPrincipal() {
-
-        $authPlugin = $this->server->getPlugin('auth');
-        if (is_null($authPlugin)) return null;
-        /** @var $authPlugin Sabre\DAV\Auth\Plugin */
-
-        return $authPlugin->getCurrentPrincipal();
-
-    }
-
-
-    /**
-     * Returns a list of principals that's associated to the current
-     * user, either directly or through group membership.
-     *
-     * @return array
-     */
-    public function getCurrentUserPrincipals() {
-
-        $currentUser = $this->getCurrentUserPrincipal();
-
-        if (is_null($currentUser)) return [];
-
-        return array_merge(
-            [$currentUser],
-            $this->getPrincipalMembership($currentUser)
-        );
-
-    }
-
-    /**
-     * This array holds a cache for all the principals that are associated with
-     * a single principal.
-     *
-     * @var array
-     */
-    protected $principalMembershipCache = [];
-
-
-    /**
-     * Returns all the principal groups the specified principal is a member of.
-     *
-     * @param string $principal
-     * @return array
-     */
-    public function getPrincipalMembership($mainPrincipal) {
-
-        // First check our cache
-        if (isset($this->principalMembershipCache[$mainPrincipal])) {
-            return $this->principalMembershipCache[$mainPrincipal];
-        }
-
-        $check = [$mainPrincipal];
-        $principals = [];
-
-        while (count($check)) {
-
-            $principal = array_shift($check);
-
-            $node = $this->server->tree->getNodeForPath($principal);
-            if ($node instanceof IPrincipal) {
-                foreach ($node->getGroupMembership() as $groupMember) {
-
-                    if (!in_array($groupMember, $principals)) {
-
-                        $check[] = $groupMember;
-                        $principals[] = $groupMember;
-
-                    }
-
-                }
-
-            }
-
-        }
-
-        // Store the result in the cache
-        $this->principalMembershipCache[$mainPrincipal] = $principals;
-
-        return $principals;
-
-    }
-
-    /**
-     * Returns the supported privilege structure for this ACL plugin.
-     *
-     * See RFC3744 for more details. Currently we default on a simple,
-     * standard structure.
-     *
-     * You can either get the list of privileges by a uri (path) or by
-     * specifying a Node.
-     *
-     * @param string|INode $node
-     * @return array
-     */
-    public function getSupportedPrivilegeSet($node) {
-
-        if (is_string($node)) {
-            $node = $this->server->tree->getNodeForPath($node);
-        }
-
-        if ($node instanceof IACL) {
-            $result = $node->getSupportedPrivilegeSet();
-
-            if ($result)
-                return $result;
-        }
-
-        return self::getDefaultSupportedPrivilegeSet();
-
-    }
-
-    /**
-     * Returns a fairly standard set of privileges, which may be useful for
-     * other systems to use as a basis.
-     *
-     * @return array
-     */
-    static function getDefaultSupportedPrivilegeSet() {
-
-        return [
-            'privilege'  => '{DAV:}all',
-            'abstract'   => true,
-            'aggregates' => [
-                [
-                    'privilege'  => '{DAV:}read',
-                    'aggregates' => [
-                        [
-                            'privilege' => '{DAV:}read-acl',
-                            'abstract'  => false,
-                        ],
-                        [
-                            'privilege' => '{DAV:}read-current-user-privilege-set',
-                            'abstract'  => false,
-                        ],
-                    ],
-                ], // {DAV:}read
-                [
-                    'privilege'  => '{DAV:}write',
-                    'aggregates' => [
-                        [
-                            'privilege' => '{DAV:}write-acl',
-                            'abstract'  => false,
-                        ],
-                        [
-                            'privilege' => '{DAV:}write-properties',
-                            'abstract'  => false,
-                        ],
-                        [
-                            'privilege' => '{DAV:}write-content',
-                            'abstract'  => false,
-                        ],
-                        [
-                            'privilege' => '{DAV:}bind',
-                            'abstract'  => false,
-                        ],
-                        [
-                            'privilege' => '{DAV:}unbind',
-                            'abstract'  => false,
-                        ],
-                        [
-                            'privilege' => '{DAV:}unlock',
-                            'abstract'  => false,
-                        ],
-                    ],
-                ], // {DAV:}write
-            ],
-        ]; // {DAV:}all
-
-    }
-
-    /**
-     * Returns the supported privilege set as a flat list
-     *
-     * This is much easier to parse.
-     *
-     * The returned list will be index by privilege name.
-     * The value is a struct containing the following properties:
-     *   - aggregates
-     *   - abstract
-     *   - concrete
-     *
-     * @param string|INode $node
-     * @return array
-     */
-    final function getFlatPrivilegeSet($node) {
-
-        $privs = $this->getSupportedPrivilegeSet($node);
-
-        $fpsTraverse = null;
-        $fpsTraverse = function($priv, $concrete, &$flat) use (&$fpsTraverse) {
-
-            $myPriv = [
-                'privilege'  => $priv['privilege'],
-                'abstract'   => isset($priv['abstract']) && $priv['abstract'],
-                'aggregates' => [],
-                'concrete'   => isset($priv['abstract']) && $priv['abstract'] ? $concrete : $priv['privilege'],
-            ];
-
-            if (isset($priv['aggregates'])) {
-
-                foreach ($priv['aggregates'] as $subPriv) {
-
-                    $myPriv['aggregates'][] = $subPriv['privilege'];
-
-                }
-
-            }
-
-            $flat[$priv['privilege']] = $myPriv;
-
-            if (isset($priv['aggregates'])) {
-
-                foreach ($priv['aggregates'] as $subPriv) {
-
-                    $fpsTraverse($subPriv, $myPriv['concrete'], $flat);
-
-                }
-
-            }
-
-        };
-
-        $flat = [];
-        $fpsTraverse($privs, null, $flat);
-
-        return $flat;
-
-    }
-
-    /**
-     * Returns the full ACL list.
-     *
-     * Either a uri or a INode may be passed.
-     *
-     * null will be returned if the node doesn't support ACLs.
-     *
-     * @param string|DAV\INode $node
-     * @return array
-     */
-    public function getACL($node) {
-
-        if (is_string($node)) {
-            $node = $this->server->tree->getNodeForPath($node);
-        }
-        if (!$node instanceof IACL) {
-            return null;
-        }
-        $acl = $node->getACL();
-        foreach ($this->adminPrincipals as $adminPrincipal) {
-            $acl[] = [
-                'principal' => $adminPrincipal,
-                'privilege' => '{DAV:}all',
-                'protected' => true,
-            ];
-        }
-        return $acl;
+	}
+
+	/**
+	 * Returns the standard users' principal.
+	 *
+	 * This is one authorative principal url for the current user.
+	 * This method will return null if the user wasn't logged in.
+	 *
+	 * @return string|null
+	 */
+	public function getCurrentUserPrincipal() {
+
+		$authPlugin = $this->server->getPlugin('auth');
+		if (is_null($authPlugin)) return null;
+		/** @var $authPlugin Sabre\DAV\Auth\Plugin */
+
+		return $authPlugin->getCurrentPrincipal();
+
+	}
+
+
+	/**
+	 * Returns a list of principals that's associated to the current
+	 * user, either directly or through group membership.
+	 *
+	 * @return array
+	 */
+	public function getCurrentUserPrincipals() {
+
+		$currentUser = $this->getCurrentUserPrincipal();
+
+		if (is_null($currentUser)) return [];
+
+		return array_merge(
+			[$currentUser],
+			$this->getPrincipalMembership($currentUser)
+		);
+
+	}
+
+	/**
+	 * This array holds a cache for all the principals that are associated with
+	 * a single principal.
+	 *
+	 * @var array
+	 */
+	protected $principalMembershipCache = [];
+
+
+	/**
+	 * Returns all the principal groups the specified principal is a member of.
+	 *
+	 * @param string $principal
+	 * @return array
+	 */
+	public function getPrincipalMembership($mainPrincipal) {
+
+		// First check our cache
+		if (isset($this->principalMembershipCache[$mainPrincipal])) {
+			return $this->principalMembershipCache[$mainPrincipal];
+		}
+
+		$check = [$mainPrincipal];
+		$principals = [];
+
+		while (count($check)) {
+
+			$principal = array_shift($check);
+
+			$node = $this->server->tree->getNodeForPath($principal);
+			if ($node instanceof IPrincipal) {
+				foreach ($node->getGroupMembership() as $groupMember) {
+
+					if (!in_array($groupMember, $principals)) {
+
+						$check[] = $groupMember;
+						$principals[] = $groupMember;
+
+					}
+
+				}
+
+			}
+
+		}
+
+		// Store the result in the cache
+		$this->principalMembershipCache[$mainPrincipal] = $principals;
+
+		return $principals;
+
+	}
+
+	/**
+	 * Returns the supported privilege structure for this ACL plugin.
+	 *
+	 * See RFC3744 for more details. Currently we default on a simple,
+	 * standard structure.
+	 *
+	 * You can either get the list of privileges by a uri (path) or by
+	 * specifying a Node.
+	 *
+	 * @param string|INode $node
+	 * @return array
+	 */
+	public function getSupportedPrivilegeSet($node) {
+
+		if (is_string($node)) {
+			$node = $this->server->tree->getNodeForPath($node);
+		}
+
+		if ($node instanceof IACL) {
+			$result = $node->getSupportedPrivilegeSet();
+
+			if ($result)
+				return $result;
+		}
+
+		return self::getDefaultSupportedPrivilegeSet();
+
+	}
+
+	/**
+	 * Returns a fairly standard set of privileges, which may be useful for
+	 * other systems to use as a basis.
+	 *
+	 * @return array
+	 */
+	static function getDefaultSupportedPrivilegeSet() {
+
+		return [
+			'privilege'  => '{DAV:}all',
+			'abstract'   => true,
+			'aggregates' => [
+				[
+					'privilege'  => '{DAV:}read',
+					'aggregates' => [
+						[
+							'privilege' => '{DAV:}read-acl',
+							'abstract'  => false,
+						],
+						[
+							'privilege' => '{DAV:}read-current-user-privilege-set',
+							'abstract'  => false,
+						],
+					],
+				], // {DAV:}read
+				[
+					'privilege'  => '{DAV:}write',
+					'aggregates' => [
+						[
+							'privilege' => '{DAV:}write-acl',
+							'abstract'  => false,
+						],
+						[
+							'privilege' => '{DAV:}write-properties',
+							'abstract'  => false,
+						],
+						[
+							'privilege' => '{DAV:}write-content',
+							'abstract'  => false,
+						],
+						[
+							'privilege' => '{DAV:}bind',
+							'abstract'  => false,
+						],
+						[
+							'privilege' => '{DAV:}unbind',
+							'abstract'  => false,
+						],
+						[
+							'privilege' => '{DAV:}unlock',
+							'abstract'  => false,
+						],
+					],
+				], // {DAV:}write
+			],
+		]; // {DAV:}all
+
+	}
+
+	/**
+	 * Returns the supported privilege set as a flat list
+	 *
+	 * This is much easier to parse.
+	 *
+	 * The returned list will be index by privilege name.
+	 * The value is a struct containing the following properties:
+	 *   - aggregates
+	 *   - abstract
+	 *   - concrete
+	 *
+	 * @param string|INode $node
+	 * @return array
+	 */
+	final function getFlatPrivilegeSet($node) {
+
+		$privs = $this->getSupportedPrivilegeSet($node);
+
+		$fpsTraverse = null;
+		$fpsTraverse = function($priv, $concrete, &$flat) use (&$fpsTraverse) {
+
+			$myPriv = [
+				'privilege'  => $priv['privilege'],
+				'abstract'   => isset($priv['abstract']) && $priv['abstract'],
+				'aggregates' => [],
+				'concrete'   => isset($priv['abstract']) && $priv['abstract'] ? $concrete : $priv['privilege'],
+			];
+
+			if (isset($priv['aggregates'])) {
+
+				foreach ($priv['aggregates'] as $subPriv) {
+
+					$myPriv['aggregates'][] = $subPriv['privilege'];
+
+				}
+
+			}
+
+			$flat[$priv['privilege']] = $myPriv;
+
+			if (isset($priv['aggregates'])) {
+
+				foreach ($priv['aggregates'] as $subPriv) {
+
+					$fpsTraverse($subPriv, $myPriv['concrete'], $flat);
+
+				}
+
+			}
+
+		};
+
+		$flat = [];
+		$fpsTraverse($privs, null, $flat);
+
+		return $flat;
+
+	}
+
+	/**
+	 * Returns the full ACL list.
+	 *
+	 * Either a uri or a INode may be passed.
+	 *
+	 * null will be returned if the node doesn't support ACLs.
+	 *
+	 * @param string|DAV\INode $node
+	 * @return array
+	 */
+	public function getACL($node) {
+
+		if (is_string($node)) {
+			$node = $this->server->tree->getNodeForPath($node);
+		}
+		if (!$node instanceof IACL) {
+			return null;
+		}
+		$acl = $node->getACL();
+		foreach ($this->adminPrincipals as $adminPrincipal) {
+			$acl[] = [
+				'principal' => $adminPrincipal,
+				'privilege' => '{DAV:}all',
+				'protected' => true,
+			];
+		}
+		return $acl;
 
-    }
+	}
 
-    /**
-     * Returns a list of privileges the current user has
-     * on a particular node.
-     *
-     * Either a uri or a DAV\INode may be passed.
-     *
-     * null will be returned if the node doesn't support ACLs.
-     *
-     * @param string|DAV\INode $node
-     * @return array
-     */
-    public function getCurrentUserPrivilegeSet($node) {
+	/**
+	 * Returns a list of privileges the current user has
+	 * on a particular node.
+	 *
+	 * Either a uri or a DAV\INode may be passed.
+	 *
+	 * null will be returned if the node doesn't support ACLs.
+	 *
+	 * @param string|DAV\INode $node
+	 * @return array
+	 */
+	public function getCurrentUserPrivilegeSet($node) {
 
-        if (is_string($node)) {
-            $node = $this->server->tree->getNodeForPath($node);
-        }
+		if (is_string($node)) {
+			$node = $this->server->tree->getNodeForPath($node);
+		}
 
-        $acl = $this->getACL($node);
+		$acl = $this->getACL($node);
 
-        if (is_null($acl)) return null;
+		if (is_null($acl)) return null;
 
-        $principals = $this->getCurrentUserPrincipals();
+		$principals = $this->getCurrentUserPrincipals();
 
-        $collected = [];
+		$collected = [];
 
-        foreach ($acl as $ace) {
+		foreach ($acl as $ace) {
 
-            $principal = $ace['principal'];
+			$principal = $ace['principal'];
 
-            switch ($principal) {
+			switch ($principal) {
 
-                case '{DAV:}owner' :
-                    $owner = $node->getOwner();
-                    if ($owner && in_array($owner, $principals)) {
-                        $collected[] = $ace;
-                    }
-                    break;
+				case '{DAV:}owner' :
+					$owner = $node->getOwner();
+					if ($owner && in_array($owner, $principals)) {
+						$collected[] = $ace;
+					}
+					break;
 
 
-                // 'all' matches for every user
-                case '{DAV:}all' :
+				// 'all' matches for every user
+				case '{DAV:}all' :
 
-                // 'authenticated' matched for every user that's logged in.
-                // Since it's not possible to use ACL while not being logged
-                // in, this is also always true.
-                case '{DAV:}authenticated' :
-                    $collected[] = $ace;
-                    break;
-
-                // 'unauthenticated' can never occur either, so we simply
-                // ignore these.
-                case '{DAV:}unauthenticated' :
-                    break;
-
-                default :
-                    if (in_array($ace['principal'], $principals)) {
-                        $collected[] = $ace;
-                    }
-                    break;
-
-            }
-
-
-        }
-
-        // Now we deduct all aggregated privileges.
-        $flat = $this->getFlatPrivilegeSet($node);
-
-        $collected2 = [];
-        while (count($collected)) {
-
-            $current = array_pop($collected);
-            $collected2[] = $current['privilege'];
-
-            foreach ($flat[$current['privilege']]['aggregates'] as $subPriv) {
-                $collected2[] = $subPriv;
-                $collected[] = $flat[$subPriv];
-            }
-
-        }
-
-        return array_values(array_unique($collected2));
-
-    }
-
-
-    /**
-     * Returns a principal based on its uri.
-     *
-     * Returns null if the principal could not be found.
-     *
-     * @param string $uri
-     * @return null|string
-     */
-    public function getPrincipalByUri($uri) {
-
-        $result = null;
-        $collections = $this->principalCollectionSet;
-        foreach ($collections as $collection) {
-
-            $principalCollection = $this->server->tree->getNodeForPath($collection);
-            if (!$principalCollection instanceof IPrincipalCollection) {
-                // Not a principal collection, we're simply going to ignore
-                // this.
-                continue;
-            }
-
-            $result = $principalCollection->findByUri($uri);
-            if ($result) {
-                return $result;
-            }
-
-        }
-
-    }
-
-    /**
-     * Principal property search
-     *
-     * This method can search for principals matching certain values in
-     * properties.
-     *
-     * This method will return a list of properties for the matched properties.
-     *
-     * @param array $searchProperties    The properties to search on. This is a
-     *                                   key-value list. The keys are property
-     *                                   names, and the values the strings to
-     *                                   match them on.
-     * @param array $requestedProperties This is the list of properties to
-     *                                   return for every match.
-     * @param string $collectionUri      The principal collection to search on.
-     *                                   If this is ommitted, the standard
-     *                                   principal collection-set will be used.
-     * @param string $test               "allof" to use AND to search the
-     *                                   properties. 'anyof' for OR.
-     * @return array     This method returns an array structure similar to
-     *                  Sabre\DAV\Server::getPropertiesForPath. Returned
-     *                  properties are index by a HTTP status code.
-     */
-    public function principalSearch(array $searchProperties, array $requestedProperties, $collectionUri = null, $test = 'allof') {
-
-        if (!is_null($collectionUri)) {
-            $uris = [$collectionUri];
-        } else {
-            $uris = $this->principalCollectionSet;
-        }
-
-        $lookupResults = [];
-        foreach ($uris as $uri) {
-
-            $principalCollection = $this->server->tree->getNodeForPath($uri);
-            if (!$principalCollection instanceof IPrincipalCollection) {
-                // Not a principal collection, we're simply going to ignore
-                // this.
-                continue;
-            }
-
-            $results = $principalCollection->searchPrincipals($searchProperties, $test);
-            foreach ($results as $result) {
-                $lookupResults[] = rtrim($uri, '/') . '/' . $result;
-            }
-
-        }
-
-        $matches = [];
-
-        foreach ($lookupResults as $lookupResult) {
-
-            list($matches[]) = $this->server->getPropertiesForPath($lookupResult, $requestedProperties, 0);
-
-        }
-
-        return $matches;
-
-    }
-
-    /**
-     * Sets up the plugin
-     *
-     * This method is automatically called by the server class.
-     *
-     * @param DAV\Server $server
-     * @return void
-     */
-    public function initialize(DAV\Server $server) {
-
-        $this->server = $server;
-        $server->on('propFind',            [$this, 'propFind'], 20);
-        $server->on('beforeMethod',        [$this, 'beforeMethod'], 20);
-        $server->on('beforeBind',          [$this, 'beforeBind'], 20);
-        $server->on('beforeUnbind',        [$this, 'beforeUnbind'], 20);
-        $server->on('propPatch',           [$this, 'propPatch']);
-        $server->on('beforeUnlock',        [$this, 'beforeUnlock'], 20);
-        $server->on('report',              [$this, 'report']);
-        $server->on('method:ACL',          [$this, 'httpAcl']);
-        $server->on('onHTMLActionsPanel',  [$this, 'htmlActionsPanel']);
-
-        array_push($server->protectedProperties,
-            '{DAV:}alternate-URI-set',
-            '{DAV:}principal-URL',
-            '{DAV:}group-membership',
-            '{DAV:}principal-collection-set',
-            '{DAV:}current-user-principal',
-            '{DAV:}supported-privilege-set',
-            '{DAV:}current-user-privilege-set',
-            '{DAV:}acl',
-            '{DAV:}acl-restrictions',
-            '{DAV:}inherited-acl-set',
-            '{DAV:}owner',
-            '{DAV:}group'
-        );
-
-        // Automatically mapping nodes implementing IPrincipal to the
-        // {DAV:}principal resourcetype.
-        $server->resourceTypeMapping['Sabre\\DAVACL\\IPrincipal'] = '{DAV:}principal';
-
-        // Mapping the group-member-set property to the HrefList property
-        // class.
-        $server->xml->elementMap['{DAV:}group-member-set'] = 'Sabre\\DAV\\Xml\\Property\\Href';
-        $server->xml->elementMap['{DAV:}acl'] = 'Sabre\\DAVACL\\Xml\\Property\\Acl';
-        $server->xml->elementMap['{DAV:}expand-property'] = 'Sabre\\DAVACL\\Xml\\Request\\ExpandPropertyReport';
-        $server->xml->elementMap['{DAV:}principal-property-search'] = 'Sabre\\DAVACL\\Xml\\Request\\PrincipalPropertySearchReport';
-        $server->xml->elementMap['{DAV:}principal-search-property-set'] = 'Sabre\\DAVACL\\Xml\\Request\\PrincipalSearchPropertySetReport';
-
-    }
-
-    /* {{{ Event handlers */
-
-    /**
-     * Triggered before any method is handled
-     *
-     * @param RequestInterface $request
-     * @param ResponseInterface $response
-     * @return void
-     */
-    public function beforeMethod(RequestInterface $request, ResponseInterface $response) {
-
-        $method = $request->getMethod();
-        $path = $request->getPath();
-
-        $exists = $this->server->tree->nodeExists($path);
-
-        // If the node doesn't exists, none of these checks apply
-        if (!$exists) return;
-
-        switch ($method) {
-
-            case 'GET' :
-            case 'HEAD' :
-            case 'OPTIONS' :
-                // For these 3 we only need to know if the node is readable.
-                $this->checkPrivileges($path, '{DAV:}read');
-                break;
-
-            case 'PUT' :
-            case 'LOCK' :
-            case 'UNLOCK' :
-                // This method requires the write-content priv if the node
-                // already exists, and bind on the parent if the node is being
-                // created.
-                // The bind privilege is handled in the beforeBind event.
-                $this->checkPrivileges($path, '{DAV:}write-content');
-                break;
-
-
-            case 'PROPPATCH' :
-                $this->checkPrivileges($path, '{DAV:}write-properties');
-                break;
-
-            case 'ACL' :
-                $this->checkPrivileges($path, '{DAV:}write-acl');
-                break;
-
-            case 'COPY' :
-            case 'MOVE' :
-                // Copy requires read privileges on the entire source tree.
-                // If the target exists write-content normally needs to be
-                // checked, however, we're deleting the node beforehand and
-                // creating a new one after, so this is handled by the
-                // beforeUnbind event.
-                //
-                // The creation of the new node is handled by the beforeBind
-                // event.
-                //
-                // If MOVE is used beforeUnbind will also be used to check if
-                // the sourcenode can be deleted.
-                $this->checkPrivileges($path, '{DAV:}read', self::R_RECURSIVE);
-
-                break;
-
-        }
-
-    }
-
-    /**
-     * Triggered before a new node is created.
-     *
-     * This allows us to check permissions for any operation that creates a
-     * new node, such as PUT, MKCOL, MKCALENDAR, LOCK, COPY and MOVE.
-     *
-     * @param string $uri
-     * @return void
-     */
-    public function beforeBind($uri) {
-
-        list($parentUri) = Uri\split($uri);
-        $this->checkPrivileges($parentUri, '{DAV:}bind');
-
-    }
-
-    /**
-     * Triggered before a node is deleted
-     *
-     * This allows us to check permissions for any operation that will delete
-     * an existing node.
-     *
-     * @param string $uri
-     * @return void
-     */
-    public function beforeUnbind($uri) {
-
-        list($parentUri) = Uri\split($uri);
-        $this->checkPrivileges($parentUri, '{DAV:}unbind', self::R_RECURSIVEPARENTS);
-
-    }
-
-    /**
-     * Triggered before a node is unlocked.
-     *
-     * @param string $uri
-     * @param DAV\Locks\LockInfo $lock
-     * @return void
-     */
-    public function beforeUnlock($uri, DAV\Locks\LockInfo $lock) {
-
-
-    }
-
-    /**
-     * Triggered before properties are looked up in specific nodes.
-     *
-     * @param DAV\PropFind $propFind
-     * @param DAV\INode $node
-     * @param array $requestedProperties
-     * @param array $returnedProperties
-     * @return bool
-     */
-    public function propFind(DAV\PropFind $propFind, DAV\INode $node) {
-
-        $path = $propFind->getPath();
-
-        // Checking the read permission
-        if (!$this->checkPrivileges($path, '{DAV:}read', self::R_PARENT, false)) {
-            // User is not allowed to read properties
-
-            // Returning false causes the property-fetching system to pretend
-            // that the node does not exist, and will cause it to be hidden
-            // from listings such as PROPFIND or the browser plugin.
-            if ($this->hideNodesFromListings) {
-                return false;
-            }
-
-            // Otherwise we simply mark every property as 403.
-            foreach ($propFind->getRequestedProperties() as $requestedProperty) {
-                $propFind->set($requestedProperty, null, 403);
-            }
-
-            return;
-
-        }
-
-        /* Adding principal properties */
-        if ($node instanceof IPrincipal) {
-
-            $propFind->handle('{DAV:}alternate-URI-set', function() use ($node) {
-                return new DAV\Xml\Property\Href($node->getAlternateUriSet());
-            });
-            $propFind->handle('{DAV:}principal-URL', function() use ($node) {
-                return new DAV\Xml\Property\Href($node->getPrincipalUrl() . '/');
-            });
-            $propFind->handle('{DAV:}group-member-set', function() use ($node) {
-                $members = $node->getGroupMemberSet();
-                foreach ($members as $k => $member) {
-                    $members[$k] = rtrim($member, '/') . '/';
-                }
-                return new DAV\Xml\Property\Href($members);
-            });
-            $propFind->handle('{DAV:}group-membership', function() use ($node) {
-                $members = $node->getGroupMembership();
-                foreach ($members as $k => $member) {
-                    $members[$k] = rtrim($member, '/') . '/';
-                }
-                return new DAV\Xml\Property\Href($members);
-            });
-            $propFind->handle('{DAV:}displayname', [$node, 'getDisplayName']);
-
-        }
-
-        $propFind->handle('{DAV:}principal-collection-set', function() {
-
-            $val = $this->principalCollectionSet;
-            // Ensuring all collections end with a slash
-            foreach ($val as $k => $v) $val[$k] = $v . '/';
-            return new DAV\Xml\Property\Href($val);
-
-        });
-        $propFind->handle('{DAV:}current-user-principal', function() {
-            if ($url = $this->getCurrentUserPrincipal()) {
-                return new Xml\Property\Principal(Xml\Property\Principal::HREF, $url . '/');
-            } else {
-                return new Xml\Property\Principal(Xml\Property\Principal::UNAUTHENTICATED);
-            }
-        });
-        $propFind->handle('{DAV:}supported-privilege-set', function() use ($node) {
-            return new Xml\Property\SupportedPrivilegeSet($this->getSupportedPrivilegeSet($node));
-        });
-        $propFind->handle('{DAV:}current-user-privilege-set', function() use ($node, $propFind, $path) {
-            if (!$this->checkPrivileges($path, '{DAV:}read-current-user-privilege-set', self::R_PARENT, false)) {
-                $propFind->set('{DAV:}current-user-privilege-set', null, 403);
-            } else {
-                $val = $this->getCurrentUserPrivilegeSet($node);
-                if (!is_null($val)) {
-                    return new Xml\Property\CurrentUserPrivilegeSet($val);
-                }
-            }
-        });
-        $propFind->handle('{DAV:}acl', function() use ($node, $propFind, $path) {
-            /* The ACL property contains all the permissions */
-            if (!$this->checkPrivileges($path, '{DAV:}read-acl', self::R_PARENT, false)) {
-                $propFind->set('{DAV:}acl', null, 403);
-            } else {
-                $acl = $this->getACL($node);
-                if (!is_null($acl)) {
-                    return new Xml\Property\Acl($this->getACL($node));
-                }
-            }
-        });
-        $propFind->handle('{DAV:}acl-restrictions', function() {
-            return new Xml\Property\AclRestrictions();
-        });
-
-        /* Adding ACL properties */
-        if ($node instanceof IACL) {
-            $propFind->handle('{DAV:}owner', function() use ($node) {
-                return new DAV\Xml\Property\Href($node->getOwner() . '/');
-            });
-        }
-
-    }
-
-    /**
-     * This method intercepts PROPPATCH methods and make sure the
-     * group-member-set is updated correctly.
-     *
-     * @param string $path
-     * @param DAV\PropPatch $propPatch
-     * @return void
-     */
-    public function propPatch($path, DAV\PropPatch $propPatch) {
-
-        $propPatch->handle('{DAV:}group-member-set', function($value) use ($path) {
-            if (is_null($value)) {
-                $memberSet = [];
-            } elseif ($value instanceof DAV\Xml\Property\Href) {
-                $memberSet = array_map(
-                    [$this->server, 'calculateUri'],
-                    $value->getHrefs()
-                );
-            } else {
-                throw new DAV\Exception('The group-member-set property MUST be an instance of Sabre\DAV\Property\HrefList or null');
-            }
-            $node = $this->server->tree->getNodeForPath($path);
-            if (!($node instanceof IPrincipal)) {
-                // Fail
-                return false;
-            }
-
-            $node->setGroupMemberSet($memberSet);
-            // We must also clear our cache, just in case
-
-            $this->principalMembershipCache = [];
-
-            return true;
-        });
-
-    }
-
-    /**
-     * This method handles HTTP REPORT requests
-     *
-     * @param string $reportName
-     * @param mixed $report
-     * @param mixed $path
-     * @return bool
-     */
-    public function report($reportName, $report, $path) {
-
-        switch ($reportName) {
-
-            case '{DAV:}principal-property-search' :
-                $this->server->transactionType = 'report-principal-property-search';
-                $this->principalPropertySearchReport($report);
-                return false;
-            case '{DAV:}principal-search-property-set' :
-                $this->server->transactionType = 'report-principal-search-property-set';
-                $this->principalSearchPropertySetReport($report);
-                return false;
-            case '{DAV:}expand-property' :
-                $this->server->transactionType = 'report-expand-property';
-                $this->expandPropertyReport($report);
-                return false;
-
-        }
-
-    }
-
-    /**
-     * This method is responsible for handling the 'ACL' event.
-     *
-     * @param RequestInterface $request
-     * @param ResponseInterface $response
-     * @return bool
-     */
-    public function httpAcl(RequestInterface $request, ResponseInterface $response) {
-
-        $path = $request->getPath();
-        $body = $request->getBodyAsString();
-
-        if (!$body) {
-            throw new DAV\Exception\BadRequest('XML body expected in ACL request');
-        }
-
-        $acl = $this->server->xml->expect('{DAV:}acl', $body);
-        $newAcl = $acl->getPrivileges();
-
-        // Normalizing urls
-        foreach ($newAcl as $k => $newAce) {
-            $newAcl[$k]['principal'] = $this->server->calculateUri($newAce['principal']);
-        }
-        $node = $this->server->tree->getNodeForPath($path);
-
-        if (!$node instanceof IACL) {
-            throw new DAV\Exception\MethodNotAllowed('This node does not support the ACL method');
-        }
-
-        $oldAcl = $this->getACL($node);
-
-        $supportedPrivileges = $this->getFlatPrivilegeSet($node);
-
-        /* Checking if protected principals from the existing principal set are
+				// 'authenticated' matched for every user that's logged in.
+				// Since it's not possible to use ACL while not being logged
+				// in, this is also always true.
+				case '{DAV:}authenticated' :
+					$collected[] = $ace;
+					break;
+
+				// 'unauthenticated' can never occur either, so we simply
+				// ignore these.
+				case '{DAV:}unauthenticated' :
+					break;
+
+				default :
+					if (in_array($ace['principal'], $principals)) {
+						$collected[] = $ace;
+					}
+					break;
+
+			}
+
+
+		}
+
+		// Now we deduct all aggregated privileges.
+		$flat = $this->getFlatPrivilegeSet($node);
+
+		$collected2 = [];
+		while (count($collected)) {
+
+			$current = array_pop($collected);
+			$collected2[] = $current['privilege'];
+
+			foreach ($flat[$current['privilege']]['aggregates'] as $subPriv) {
+				$collected2[] = $subPriv;
+				$collected[] = $flat[$subPriv];
+			}
+
+		}
+
+		return array_values(array_unique($collected2));
+
+	}
+
+
+	/**
+	 * Returns a principal based on its uri.
+	 *
+	 * Returns null if the principal could not be found.
+	 *
+	 * @param string $uri
+	 * @return null|string
+	 */
+	public function getPrincipalByUri($uri) {
+
+		$result = null;
+		$collections = $this->principalCollectionSet;
+		foreach ($collections as $collection) {
+
+			$principalCollection = $this->server->tree->getNodeForPath($collection);
+			if (!$principalCollection instanceof IPrincipalCollection) {
+				// Not a principal collection, we're simply going to ignore
+				// this.
+				continue;
+			}
+
+			$result = $principalCollection->findByUri($uri);
+			if ($result) {
+				return $result;
+			}
+
+		}
+
+	}
+
+	/**
+	 * Principal property search
+	 *
+	 * This method can search for principals matching certain values in
+	 * properties.
+	 *
+	 * This method will return a list of properties for the matched properties.
+	 *
+	 * @param array $searchProperties    The properties to search on. This is a
+	 *                                   key-value list. The keys are property
+	 *                                   names, and the values the strings to
+	 *                                   match them on.
+	 * @param array $requestedProperties This is the list of properties to
+	 *                                   return for every match.
+	 * @param string $collectionUri      The principal collection to search on.
+	 *                                   If this is ommitted, the standard
+	 *                                   principal collection-set will be used.
+	 * @param string $test               "allof" to use AND to search the
+	 *                                   properties. 'anyof' for OR.
+	 * @return array     This method returns an array structure similar to
+	 *                  Sabre\DAV\Server::getPropertiesForPath. Returned
+	 *                  properties are index by a HTTP status code.
+	 */
+	public function principalSearch(array $searchProperties, array $requestedProperties, $collectionUri = null, $test = 'allof') {
+
+		if (!is_null($collectionUri)) {
+			$uris = [$collectionUri];
+		} else {
+			$uris = $this->principalCollectionSet;
+		}
+
+		$lookupResults = [];
+		foreach ($uris as $uri) {
+
+			$principalCollection = $this->server->tree->getNodeForPath($uri);
+			if (!$principalCollection instanceof IPrincipalCollection) {
+				// Not a principal collection, we're simply going to ignore
+				// this.
+				continue;
+			}
+
+			$results = $principalCollection->searchPrincipals($searchProperties, $test);
+			foreach ($results as $result) {
+				$lookupResults[] = rtrim($uri, '/') . '/' . $result;
+			}
+
+		}
+
+		$matches = [];
+
+		foreach ($lookupResults as $lookupResult) {
+
+			list($matches[]) = $this->server->getPropertiesForPath($lookupResult, $requestedProperties, 0);
+
+		}
+
+		return $matches;
+
+	}
+
+	/**
+	 * Sets up the plugin
+	 *
+	 * This method is automatically called by the server class.
+	 *
+	 * @param DAV\Server $server
+	 * @return void
+	 */
+	public function initialize(DAV\Server $server) {
+
+		$this->server = $server;
+		$server->on('propFind',            [$this, 'propFind'], 20);
+		$server->on('beforeMethod',        [$this, 'beforeMethod'], 20);
+		$server->on('beforeBind',          [$this, 'beforeBind'], 20);
+		$server->on('beforeUnbind',        [$this, 'beforeUnbind'], 20);
+		$server->on('propPatch',           [$this, 'propPatch']);
+		$server->on('beforeUnlock',        [$this, 'beforeUnlock'], 20);
+		$server->on('report',              [$this, 'report']);
+		$server->on('method:ACL',          [$this, 'httpAcl']);
+		$server->on('onHTMLActionsPanel',  [$this, 'htmlActionsPanel']);
+
+		array_push($server->protectedProperties,
+			'{DAV:}alternate-URI-set',
+			'{DAV:}principal-URL',
+			'{DAV:}group-membership',
+			'{DAV:}principal-collection-set',
+			'{DAV:}current-user-principal',
+			'{DAV:}supported-privilege-set',
+			'{DAV:}current-user-privilege-set',
+			'{DAV:}acl',
+			'{DAV:}acl-restrictions',
+			'{DAV:}inherited-acl-set',
+			'{DAV:}owner',
+			'{DAV:}group'
+		);
+
+		// Automatically mapping nodes implementing IPrincipal to the
+		// {DAV:}principal resourcetype.
+		$server->resourceTypeMapping['Sabre\\DAVACL\\IPrincipal'] = '{DAV:}principal';
+
+		// Mapping the group-member-set property to the HrefList property
+		// class.
+		$server->xml->elementMap['{DAV:}group-member-set'] = 'Sabre\\DAV\\Xml\\Property\\Href';
+		$server->xml->elementMap['{DAV:}acl'] = 'Sabre\\DAVACL\\Xml\\Property\\Acl';
+		$server->xml->elementMap['{DAV:}expand-property'] = 'Sabre\\DAVACL\\Xml\\Request\\ExpandPropertyReport';
+		$server->xml->elementMap['{DAV:}principal-property-search'] = 'Sabre\\DAVACL\\Xml\\Request\\PrincipalPropertySearchReport';
+		$server->xml->elementMap['{DAV:}principal-search-property-set'] = 'Sabre\\DAVACL\\Xml\\Request\\PrincipalSearchPropertySetReport';
+
+	}
+
+	/* {{{ Event handlers */
+
+	/**
+	 * Triggered before any method is handled
+	 *
+	 * @param RequestInterface $request
+	 * @param ResponseInterface $response
+	 * @return void
+	 */
+	public function beforeMethod(RequestInterface $request, ResponseInterface $response) {
+
+		$method = $request->getMethod();
+		$path = $request->getPath();
+
+		$exists = $this->server->tree->nodeExists($path);
+
+		// If the node doesn't exists, none of these checks apply
+		if (!$exists) return;
+
+		switch ($method) {
+
+			case 'GET' :
+			case 'HEAD' :
+			case 'OPTIONS' :
+				// For these 3 we only need to know if the node is readable.
+				$this->checkPrivileges($path, '{DAV:}read');
+				break;
+
+			case 'PUT' :
+			case 'LOCK' :
+			case 'UNLOCK' :
+				// This method requires the write-content priv if the node
+				// already exists, and bind on the parent if the node is being
+				// created.
+				// The bind privilege is handled in the beforeBind event.
+				$this->checkPrivileges($path, '{DAV:}write-content');
+				break;
+
+
+			case 'PROPPATCH' :
+				$this->checkPrivileges($path, '{DAV:}write-properties');
+				break;
+
+			case 'ACL' :
+				$this->checkPrivileges($path, '{DAV:}write-acl');
+				break;
+
+			case 'COPY' :
+			case 'MOVE' :
+				// Copy requires read privileges on the entire source tree.
+				// If the target exists write-content normally needs to be
+				// checked, however, we're deleting the node beforehand and
+				// creating a new one after, so this is handled by the
+				// beforeUnbind event.
+				//
+				// The creation of the new node is handled by the beforeBind
+				// event.
+				//
+				// If MOVE is used beforeUnbind will also be used to check if
+				// the sourcenode can be deleted.
+				$this->checkPrivileges($path, '{DAV:}read', self::R_RECURSIVE);
+
+				break;
+
+		}
+
+	}
+
+	/**
+	 * Triggered before a new node is created.
+	 *
+	 * This allows us to check permissions for any operation that creates a
+	 * new node, such as PUT, MKCOL, MKCALENDAR, LOCK, COPY and MOVE.
+	 *
+	 * @param string $uri
+	 * @return void
+	 */
+	public function beforeBind($uri) {
+
+		list($parentUri) = Uri\split($uri);
+		$this->checkPrivileges($parentUri, '{DAV:}bind');
+
+	}
+
+	/**
+	 * Triggered before a node is deleted
+	 *
+	 * This allows us to check permissions for any operation that will delete
+	 * an existing node.
+	 *
+	 * @param string $uri
+	 * @return void
+	 */
+	public function beforeUnbind($uri) {
+
+		list($parentUri) = Uri\split($uri);
+		$this->checkPrivileges($parentUri, '{DAV:}unbind', self::R_RECURSIVEPARENTS);
+
+	}
+
+	/**
+	 * Triggered before a node is unlocked.
+	 *
+	 * @param string $uri
+	 * @param DAV\Locks\LockInfo $lock
+	 * @return void
+	 */
+	public function beforeUnlock($uri, DAV\Locks\LockInfo $lock) {
+
+
+	}
+
+	/**
+	 * Triggered before properties are looked up in specific nodes.
+	 *
+	 * @param DAV\PropFind $propFind
+	 * @param DAV\INode $node
+	 * @param array $requestedProperties
+	 * @param array $returnedProperties
+	 * @return bool
+	 */
+	public function propFind(DAV\PropFind $propFind, DAV\INode $node) {
+
+		$path = $propFind->getPath();
+
+		// Checking the read permission
+		if (!$this->checkPrivileges($path, '{DAV:}read', self::R_PARENT, false)) {
+			// User is not allowed to read properties
+
+			// Returning false causes the property-fetching system to pretend
+			// that the node does not exist, and will cause it to be hidden
+			// from listings such as PROPFIND or the browser plugin.
+			if ($this->hideNodesFromListings) {
+				return false;
+			}
+
+			// Otherwise we simply mark every property as 403.
+			foreach ($propFind->getRequestedProperties() as $requestedProperty) {
+				$propFind->set($requestedProperty, null, 403);
+			}
+
+			return;
+
+		}
+
+		/* Adding principal properties */
+		if ($node instanceof IPrincipal) {
+
+			$propFind->handle('{DAV:}alternate-URI-set', function() use ($node) {
+				return new DAV\Xml\Property\Href($node->getAlternateUriSet());
+			});
+			$propFind->handle('{DAV:}principal-URL', function() use ($node) {
+				return new DAV\Xml\Property\Href($node->getPrincipalUrl() . '/');
+			});
+			$propFind->handle('{DAV:}group-member-set', function() use ($node) {
+				$members = $node->getGroupMemberSet();
+				foreach ($members as $k => $member) {
+					$members[$k] = rtrim($member, '/') . '/';
+				}
+				return new DAV\Xml\Property\Href($members);
+			});
+			$propFind->handle('{DAV:}group-membership', function() use ($node) {
+				$members = $node->getGroupMembership();
+				foreach ($members as $k => $member) {
+					$members[$k] = rtrim($member, '/') . '/';
+				}
+				return new DAV\Xml\Property\Href($members);
+			});
+			$propFind->handle('{DAV:}displayname', [$node, 'getDisplayName']);
+
+		}
+
+		$propFind->handle('{DAV:}principal-collection-set', function() {
+
+			$val = $this->principalCollectionSet;
+			// Ensuring all collections end with a slash
+			foreach ($val as $k => $v) $val[$k] = $v . '/';
+			return new DAV\Xml\Property\Href($val);
+
+		});
+		$propFind->handle('{DAV:}current-user-principal', function() {
+			if ($url = $this->getCurrentUserPrincipal()) {
+				return new Xml\Property\Principal(Xml\Property\Principal::HREF, $url . '/');
+			} else {
+				return new Xml\Property\Principal(Xml\Property\Principal::UNAUTHENTICATED);
+			}
+		});
+		$propFind->handle('{DAV:}supported-privilege-set', function() use ($node) {
+			return new Xml\Property\SupportedPrivilegeSet($this->getSupportedPrivilegeSet($node));
+		});
+		$propFind->handle('{DAV:}current-user-privilege-set', function() use ($node, $propFind, $path) {
+			if (!$this->checkPrivileges($path, '{DAV:}read-current-user-privilege-set', self::R_PARENT, false)) {
+				$propFind->set('{DAV:}current-user-privilege-set', null, 403);
+			} else {
+				$val = $this->getCurrentUserPrivilegeSet($node);
+				if (!is_null($val)) {
+					return new Xml\Property\CurrentUserPrivilegeSet($val);
+				}
+			}
+		});
+		$propFind->handle('{DAV:}acl', function() use ($node, $propFind, $path) {
+			/* The ACL property contains all the permissions */
+			if (!$this->checkPrivileges($path, '{DAV:}read-acl', self::R_PARENT, false)) {
+				$propFind->set('{DAV:}acl', null, 403);
+			} else {
+				$acl = $this->getACL($node);
+				if (!is_null($acl)) {
+					return new Xml\Property\Acl($this->getACL($node));
+				}
+			}
+		});
+		$propFind->handle('{DAV:}acl-restrictions', function() {
+			return new Xml\Property\AclRestrictions();
+		});
+
+		/* Adding ACL properties */
+		if ($node instanceof IACL) {
+			$propFind->handle('{DAV:}owner', function() use ($node) {
+				return new DAV\Xml\Property\Href($node->getOwner() . '/');
+			});
+		}
+
+	}
+
+	/**
+	 * This method intercepts PROPPATCH methods and make sure the
+	 * group-member-set is updated correctly.
+	 *
+	 * @param string $path
+	 * @param DAV\PropPatch $propPatch
+	 * @return void
+	 */
+	public function propPatch($path, DAV\PropPatch $propPatch) {
+
+		$propPatch->handle('{DAV:}group-member-set', function($value) use ($path) {
+			if (is_null($value)) {
+				$memberSet = [];
+			} elseif ($value instanceof DAV\Xml\Property\Href) {
+				$memberSet = array_map(
+					[$this->server, 'calculateUri'],
+					$value->getHrefs()
+				);
+			} else {
+				throw new DAV\Exception('The group-member-set property MUST be an instance of Sabre\DAV\Property\HrefList or null');
+			}
+			$node = $this->server->tree->getNodeForPath($path);
+			if (!($node instanceof IPrincipal)) {
+				// Fail
+				return false;
+			}
+
+			$node->setGroupMemberSet($memberSet);
+			// We must also clear our cache, just in case
+
+			$this->principalMembershipCache = [];
+
+			return true;
+		});
+
+	}
+
+	/**
+	 * This method handles HTTP REPORT requests
+	 *
+	 * @param string $reportName
+	 * @param mixed $report
+	 * @param mixed $path
+	 * @return bool
+	 */
+	public function report($reportName, $report, $path) {
+
+		switch ($reportName) {
+
+			case '{DAV:}principal-property-search' :
+				$this->server->transactionType = 'report-principal-property-search';
+				$this->principalPropertySearchReport($report);
+				return false;
+			case '{DAV:}principal-search-property-set' :
+				$this->server->transactionType = 'report-principal-search-property-set';
+				$this->principalSearchPropertySetReport($report);
+				return false;
+			case '{DAV:}expand-property' :
+				$this->server->transactionType = 'report-expand-property';
+				$this->expandPropertyReport($report);
+				return false;
+
+		}
+
+	}
+
+	/**
+	 * This method is responsible for handling the 'ACL' event.
+	 *
+	 * @param RequestInterface $request
+	 * @param ResponseInterface $response
+	 * @return bool
+	 */
+	public function httpAcl(RequestInterface $request, ResponseInterface $response) {
+
+		$path = $request->getPath();
+		$body = $request->getBodyAsString();
+
+		if (!$body) {
+			throw new DAV\Exception\BadRequest('XML body expected in ACL request');
+		}
+
+		$acl = $this->server->xml->expect('{DAV:}acl', $body);
+		$newAcl = $acl->getPrivileges();
+
+		// Normalizing urls
+		foreach ($newAcl as $k => $newAce) {
+			$newAcl[$k]['principal'] = $this->server->calculateUri($newAce['principal']);
+		}
+		$node = $this->server->tree->getNodeForPath($path);
+
+		if (!$node instanceof IACL) {
+			throw new DAV\Exception\MethodNotAllowed('This node does not support the ACL method');
+		}
+
+		$oldAcl = $this->getACL($node);
+
+		$supportedPrivileges = $this->getFlatPrivilegeSet($node);
+
+		/* Checking if protected principals from the existing principal set are
            not overwritten. */
-        foreach ($oldAcl as $oldAce) {
-
-            if (!isset($oldAce['protected']) || !$oldAce['protected']) continue;
-
-            $found = false;
-            foreach ($newAcl as $newAce) {
-                if (
-                    $newAce['privilege'] === $oldAce['privilege'] &&
-                    $newAce['principal'] === $oldAce['principal'] &&
-                    $newAce['protected']
-                )
-                $found = true;
-            }
-
-            if (!$found)
-                throw new Exception\AceConflict('This resource contained a protected {DAV:}ace, but this privilege did not occur in the ACL request');
-
-        }
+		foreach ($oldAcl as $oldAce) {
+
+			if (!isset($oldAce['protected']) || !$oldAce['protected']) continue;
+
+			$found = false;
+			foreach ($newAcl as $newAce) {
+				if (
+					$newAce['privilege'] === $oldAce['privilege'] &&
+					$newAce['principal'] === $oldAce['principal'] &&
+					$newAce['protected']
+				)
+				$found = true;
+			}
+
+			if (!$found)
+				throw new Exception\AceConflict('This resource contained a protected {DAV:}ace, but this privilege did not occur in the ACL request');
+
+		}
 
-        foreach ($newAcl as $newAce) {
-
-            // Do we recognize the privilege
-            if (!isset($supportedPrivileges[$newAce['privilege']])) {
-                throw new Exception\NotSupportedPrivilege('The privilege you specified (' . $newAce['privilege'] . ') is not recognized by this server');
-            }
-
-            if ($supportedPrivileges[$newAce['privilege']]['abstract']) {
-                throw new Exception\NoAbstract('The privilege you specified (' . $newAce['privilege'] . ') is an abstract privilege');
-            }
-
-            // Looking up the principal
-            try {
-                $principal = $this->server->tree->getNodeForPath($newAce['principal']);
-            } catch (DAV\Exception\NotFound $e) {
-                throw new Exception\NotRecognizedPrincipal('The specified principal (' . $newAce['principal'] . ') does not exist');
-            }
-            if (!($principal instanceof IPrincipal)) {
-                throw new Exception\NotRecognizedPrincipal('The specified uri (' . $newAce['principal'] . ') is not a principal');
-            }
+		foreach ($newAcl as $newAce) {
+
+			// Do we recognize the privilege
+			if (!isset($supportedPrivileges[$newAce['privilege']])) {
+				throw new Exception\NotSupportedPrivilege('The privilege you specified (' . $newAce['privilege'] . ') is not recognized by this server');
+			}
+
+			if ($supportedPrivileges[$newAce['privilege']]['abstract']) {
+				throw new Exception\NoAbstract('The privilege you specified (' . $newAce['privilege'] . ') is an abstract privilege');
+			}
+
+			// Looking up the principal
+			try {
+				$principal = $this->server->tree->getNodeForPath($newAce['principal']);
+			} catch (DAV\Exception\NotFound $e) {
+				throw new Exception\NotRecognizedPrincipal('The specified principal (' . $newAce['principal'] . ') does not exist');
+			}
+			if (!($principal instanceof IPrincipal)) {
+				throw new Exception\NotRecognizedPrincipal('The specified uri (' . $newAce['principal'] . ') is not a principal');
+			}
 
-        }
-        $node->setACL($newAcl);
+		}
+		$node->setACL($newAcl);
 
-        $response->setStatus(200);
-
-        // Breaking the event chain, because we handled this method.
-        return false;
-
-    }
-
-    /* }}} */
-
-    /* Reports {{{ */
-
-    /**
-     * The expand-property report is defined in RFC3253 section 3-8.
-     *
-     * This report is very similar to a standard PROPFIND. The difference is
-     * that it has the additional ability to look at properties containing a
-     * {DAV:}href element, follow that property and grab additional elements
-     * there.
-     *
-     * Other rfc's, such as ACL rely on this report, so it made sense to put
-     * it in this plugin.
-     *
-     * @param Xml\Request\ExpandPropertyReport $report
-     * @return void
-     */
-    protected function expandPropertyReport($report) {
+		$response->setStatus(200);
+
+		// Breaking the event chain, because we handled this method.
+		return false;
+
+	}
+
+	/* }}} */
+
+	/* Reports {{{ */
+
+	/**
+	 * The expand-property report is defined in RFC3253 section 3-8.
+	 *
+	 * This report is very similar to a standard PROPFIND. The difference is
+	 * that it has the additional ability to look at properties containing a
+	 * {DAV:}href element, follow that property and grab additional elements
+	 * there.
+	 *
+	 * Other rfc's, such as ACL rely on this report, so it made sense to put
+	 * it in this plugin.
+	 *
+	 * @param Xml\Request\ExpandPropertyReport $report
+	 * @return void
+	 */
+	protected function expandPropertyReport($report) {
 
-        $depth = $this->server->getHTTPDepth(0);
-        $requestUri = $this->server->getRequestUri();
+		$depth = $this->server->getHTTPDepth(0);
+		$requestUri = $this->server->getRequestUri();
 
-        $result = $this->expandProperties($requestUri, $report->properties, $depth);
+		$result = $this->expandProperties($requestUri, $report->properties, $depth);
 
-        $xml = $this->server->xml->write(
-            '{DAV:}multistatus',
-            new DAV\Xml\Response\MultiStatus($result),
-            $this->server->getBaseUri()
-        );
-        $this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8');
-        $this->server->httpResponse->setStatus(207);
-        $this->server->httpResponse->setBody($xml);
+		$xml = $this->server->xml->write(
+			'{DAV:}multistatus',
+			new DAV\Xml\Response\MultiStatus($result),
+			$this->server->getBaseUri()
+		);
+		$this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8');
+		$this->server->httpResponse->setStatus(207);
+		$this->server->httpResponse->setBody($xml);
 
-    }
+	}
 
-    /**
-     * This method expands all the properties and returns
-     * a list with property values
-     *
-     * @param array $path
-     * @param array $requestedProperties the list of required properties
-     * @param int $depth
-     * @return array
-     */
-    protected function expandProperties($path, array $requestedProperties, $depth) {
+	/**
+	 * This method expands all the properties and returns
+	 * a list with property values
+	 *
+	 * @param array $path
+	 * @param array $requestedProperties the list of required properties
+	 * @param int $depth
+	 * @return array
+	 */
+	protected function expandProperties($path, array $requestedProperties, $depth) {
 
-        $foundProperties = $this->server->getPropertiesForPath($path, array_keys($requestedProperties), $depth);
+		$foundProperties = $this->server->getPropertiesForPath($path, array_keys($requestedProperties), $depth);
 
-        $result = [];
+		$result = [];
 
-        foreach ($foundProperties as $node) {
-
-            foreach ($requestedProperties as $propertyName => $childRequestedProperties) {
-
-                // We're only traversing if sub-properties were requested
-                if (count($childRequestedProperties) === 0) continue;
-
-                // We only have to do the expansion if the property was found
-                // and it contains an href element.
-                if (!array_key_exists($propertyName, $node[200])) continue;
-
-                if (!$node[200][$propertyName] instanceof DAV\Xml\Property\Href) {
-                    continue;
-                }
-
-                $childHrefs = $node[200][$propertyName]->getHrefs();
-                $childProps = [];
-
-                foreach ($childHrefs as $href) {
-                    // Gathering the result of the children
-                    $childProps[] = [
-                        'name'  => '{DAV:}response',
-                        'value' => $this->expandProperties($href, $childRequestedProperties, 0)[0]
-                    ];
-                }
-
-                // Replacing the property with its expannded form.
-                $node[200][$propertyName] = $childProps;
-
-            }
-            $result[] = new DAV\Xml\Element\Response($node['href'], $node);
-
-        }
-
-        return $result;
-
-    }
-
-    /**
-     * principalSearchPropertySetReport
-     *
-     * This method responsible for handing the
-     * {DAV:}principal-search-property-set report. This report returns a list
-     * of properties the client may search on, using the
-     * {DAV:}principal-property-search report.
-     *
-     * @param Xml\Request\PrincipalSearchPropertySetReport $report
-     * @return void
-     */
-    protected function principalSearchPropertySetReport($report) {
-
-        $httpDepth = $this->server->getHTTPDepth(0);
-        if ($httpDepth !== 0) {
-            throw new DAV\Exception\BadRequest('This report is only defined when Depth: 0');
-        }
-
-        $writer = $this->server->xml->getWriter();
-        $writer->openMemory();
-        $writer->startDocument();
-
-        $writer->startElement('{DAV:}principal-search-property-set');
-
-        foreach ($this->principalSearchPropertySet as $propertyName => $description) {
-
-            $writer->startElement('{DAV:}principal-search-property');
-            $writer->startElement('{DAV:}prop');
-
-            $writer->writeElement($propertyName);
-
-            $writer->endElement(); // prop
-
-            if ($description) {
-                $writer->write([[
-                    'name'       => '{DAV:}description',
-                    'value'      => $description,
-                    'attributes' => ['xml:lang' => 'en']
-                ]]);
-            }
-
-            $writer->endElement(); // principal-search-property
-
-
-        }
-
-        $writer->endElement(); // principal-search-property-set
-
-        $this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8');
-        $this->server->httpResponse->setStatus(200);
-        $this->server->httpResponse->setBody($writer->outputMemory());
-
-    }
+		foreach ($foundProperties as $node) {
+
+			foreach ($requestedProperties as $propertyName => $childRequestedProperties) {
+
+				// We're only traversing if sub-properties were requested
+				if (count($childRequestedProperties) === 0) continue;
+
+				// We only have to do the expansion if the property was found
+				// and it contains an href element.
+				if (!array_key_exists($propertyName, $node[200])) continue;
+
+				if (!$node[200][$propertyName] instanceof DAV\Xml\Property\Href) {
+					continue;
+				}
+
+				$childHrefs = $node[200][$propertyName]->getHrefs();
+				$childProps = [];
+
+				foreach ($childHrefs as $href) {
+					// Gathering the result of the children
+					$childProps[] = [
+						'name'  => '{DAV:}response',
+						'value' => $this->expandProperties($href, $childRequestedProperties, 0)[0]
+					];
+				}
+
+				// Replacing the property with its expannded form.
+				$node[200][$propertyName] = $childProps;
+
+			}
+			$result[] = new DAV\Xml\Element\Response($node['href'], $node);
+
+		}
+
+		return $result;
+
+	}
+
+	/**
+	 * principalSearchPropertySetReport
+	 *
+	 * This method responsible for handing the
+	 * {DAV:}principal-search-property-set report. This report returns a list
+	 * of properties the client may search on, using the
+	 * {DAV:}principal-property-search report.
+	 *
+	 * @param Xml\Request\PrincipalSearchPropertySetReport $report
+	 * @return void
+	 */
+	protected function principalSearchPropertySetReport($report) {
+
+		$httpDepth = $this->server->getHTTPDepth(0);
+		if ($httpDepth !== 0) {
+			throw new DAV\Exception\BadRequest('This report is only defined when Depth: 0');
+		}
+
+		$writer = $this->server->xml->getWriter();
+		$writer->openMemory();
+		$writer->startDocument();
+
+		$writer->startElement('{DAV:}principal-search-property-set');
+
+		foreach ($this->principalSearchPropertySet as $propertyName => $description) {
+
+			$writer->startElement('{DAV:}principal-search-property');
+			$writer->startElement('{DAV:}prop');
+
+			$writer->writeElement($propertyName);
+
+			$writer->endElement(); // prop
+
+			if ($description) {
+				$writer->write([[
+					'name'       => '{DAV:}description',
+					'value'      => $description,
+					'attributes' => ['xml:lang' => 'en']
+				]]);
+			}
+
+			$writer->endElement(); // principal-search-property
+
+
+		}
+
+		$writer->endElement(); // principal-search-property-set
+
+		$this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8');
+		$this->server->httpResponse->setStatus(200);
+		$this->server->httpResponse->setBody($writer->outputMemory());
+
+	}
 
-    /**
-     * principalPropertySearchReport
-     *
-     * This method is responsible for handing the
-     * {DAV:}principal-property-search report. This report can be used for
-     * clients to search for groups of principals, based on the value of one
-     * or more properties.
-     *
-     * @param Xml\Request\PrincipalPropertySearchReport $report
-     * @return void
-     */
-    protected function principalPropertySearchReport($report) {
-
-        $uri = null;
-        if (!$report->applyToPrincipalCollectionSet) {
-            $uri = $this->server->httpRequest->getPath();
-        }
-        if ($this->server->getHttpDepth('0') !== 0) {
-            throw new BadRequest('Depth must be 0');
-        }
-        $result = $this->principalSearch(
-            $report->searchProperties,
-            $report->properties,
-            $uri,
-            $report->test
-        );
-
-        $prefer = $this->server->getHTTPPrefer();
-
-        $this->server->httpResponse->setStatus(207);
-        $this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8');
-        $this->server->httpResponse->setHeader('Vary', 'Brief,Prefer');
-        $this->server->httpResponse->setBody($this->server->generateMultiStatus($result, $prefer['return'] === 'minimal'));
-
-    }
-
-    /* }}} */
-
-    /**
-     * This method is used to generate HTML output for the
-     * DAV\Browser\Plugin. This allows us to generate an interface users
-     * can use to create new calendars.
-     *
-     * @param DAV\INode $node
-     * @param string $output
-     * @return bool
-     */
-    public function htmlActionsPanel(DAV\INode $node, &$output) {
-
-        if (!$node instanceof PrincipalCollection)
-            return;
-
-        $output .= '<tr><td colspan="2"><form method="post" action="">
+	/**
+	 * principalPropertySearchReport
+	 *
+	 * This method is responsible for handing the
+	 * {DAV:}principal-property-search report. This report can be used for
+	 * clients to search for groups of principals, based on the value of one
+	 * or more properties.
+	 *
+	 * @param Xml\Request\PrincipalPropertySearchReport $report
+	 * @return void
+	 */
+	protected function principalPropertySearchReport($report) {
+
+		$uri = null;
+		if (!$report->applyToPrincipalCollectionSet) {
+			$uri = $this->server->httpRequest->getPath();
+		}
+		if ($this->server->getHttpDepth('0') !== 0) {
+			throw new BadRequest('Depth must be 0');
+		}
+		$result = $this->principalSearch(
+			$report->searchProperties,
+			$report->properties,
+			$uri,
+			$report->test
+		);
+
+		$prefer = $this->server->getHTTPPrefer();
+
+		$this->server->httpResponse->setStatus(207);
+		$this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8');
+		$this->server->httpResponse->setHeader('Vary', 'Brief,Prefer');
+		$this->server->httpResponse->setBody($this->server->generateMultiStatus($result, $prefer['return'] === 'minimal'));
+
+	}
+
+	/* }}} */
+
+	/**
+	 * This method is used to generate HTML output for the
+	 * DAV\Browser\Plugin. This allows us to generate an interface users
+	 * can use to create new calendars.
+	 *
+	 * @param DAV\INode $node
+	 * @param string $output
+	 * @return bool
+	 */
+	public function htmlActionsPanel(DAV\INode $node, &$output) {
+
+		if (!$node instanceof PrincipalCollection)
+			return;
+
+		$output .= '<tr><td colspan="2"><form method="post" action="">
             <h3>Create new principal</h3>
             <input type="hidden" name="sabreAction" value="mkcol" />
             <input type="hidden" name="resourceType" value="{DAV:}principal" />
@@ -1294,28 +1294,28 @@ 
             </form>
             </td></tr>';
 
-        return false;
-
-    }
-
-    /**
-     * Returns a bunch of meta-data about the plugin.
-     *
-     * Providing this information is optional, and is mainly displayed by the
-     * Browser plugin.
-     *
-     * The description key in the returned array may contain html and will not
-     * be sanitized.
-     *
-     * @return array
-     */
-    public function getPluginInfo() {
-
-        return [
-            'name'        => $this->getPluginName(),
-            'description' => 'Adds support for WebDAV ACL (rfc3744)',
-            'link'        => 'http://sabre.io/dav/acl/',
-        ];
-
-    }
+		return false;
+
+	}
+
+	/**
+	 * Returns a bunch of meta-data about the plugin.
+	 *
+	 * Providing this information is optional, and is mainly displayed by the
+	 * Browser plugin.
+	 *
+	 * The description key in the returned array may contain html and will not
+	 * be sanitized.
+	 *
+	 * @return array
+	 */
+	public function getPluginInfo() {
+
+		return [
+			'name'        => $this->getPluginName(),
+			'description' => 'Adds support for WebDAV ACL (rfc3744)',
+			'link'        => 'http://sabre.io/dav/acl/',
+		];
+
+	}
 }

libraries/SabreDAV/DAVACL/Principal.php

Doc Comments +1 added lines, -1 removed lines

@@ -39,7 +39,7 @@
     /**
      * Creates the principal object
      *
-     * @param IPrincipalBackend $principalBackend
+     * @param PrincipalBackend\BackendInterface $principalBackend
      * @param array $principalProperties
      */
     function __construct(PrincipalBackend\BackendInterface $principalBackend, array $principalProperties = []) {

Indentation +262 added lines, -262 removed lines

@@ -22,267 +22,267 @@
  */
 class Principal extends DAV\Node implements IPrincipal, DAV\IProperties, IACL {
 
-    /**
-     * Struct with principal information.
-     *
-     * @var array
-     */
-    protected $principalProperties;
-
-    /**
-     * Principal backend
-     *
-     * @var PrincipalBackend\BackendInterface
-     */
-    protected $principalBackend;
-
-    /**
-     * Creates the principal object
-     *
-     * @param IPrincipalBackend $principalBackend
-     * @param array $principalProperties
-     */
-    public function __construct(PrincipalBackend\BackendInterface $principalBackend, array $principalProperties = []) {
-
-        if (!isset($principalProperties['uri'])) {
-            throw new DAV\Exception('The principal properties must at least contain the \'uri\' key');
-        }
-        $this->principalBackend = $principalBackend;
-        $this->principalProperties = $principalProperties;
-
-    }
-
-    /**
-     * Returns the full principal url
-     *
-     * @return string
-     */
-    public function getPrincipalUrl() {
-
-        return $this->principalProperties['uri'];
-
-    }
-
-    /**
-     * Returns a list of alternative urls for a principal
-     *
-     * This can for example be an email address, or ldap url.
-     *
-     * @return array
-     */
-    public function getAlternateUriSet() {
-
-        $uris = [];
-        if (isset($this->principalProperties['{DAV:}alternate-URI-set'])) {
-
-            $uris = $this->principalProperties['{DAV:}alternate-URI-set'];
-
-        }
-
-        if (isset($this->principalProperties['{http://sabredav.org/ns}email-address'])) {
-            $uris[] = 'mailto:' . $this->principalProperties['{http://sabredav.org/ns}email-address'];
-        }
-
-        return array_unique($uris);
-
-    }
-
-    /**
-     * Returns the list of group members
-     *
-     * If this principal is a group, this function should return
-     * all member principal uri's for the group.
-     *
-     * @return array
-     */
-    public function getGroupMemberSet() {
-
-        return $this->principalBackend->getGroupMemberSet($this->principalProperties['uri']);
-
-    }
-
-    /**
-     * Returns the list of groups this principal is member of
-     *
-     * If this principal is a member of a (list of) groups, this function
-     * should return a list of principal uri's for it's members.
-     *
-     * @return array
-     */
-    public function getGroupMembership() {
-
-        return $this->principalBackend->getGroupMemberShip($this->principalProperties['uri']);
-
-    }
-
-    /**
-     * Sets a list of group members
-     *
-     * If this principal is a group, this method sets all the group members.
-     * The list of members is always overwritten, never appended to.
-     *
-     * This method should throw an exception if the members could not be set.
-     *
-     * @param array $groupMembers
-     * @return void
-     */
-    public function setGroupMemberSet(array $groupMembers) {
-
-        $this->principalBackend->setGroupMemberSet($this->principalProperties['uri'], $groupMembers);
-
-    }
-
-    /**
-     * Returns this principals name.
-     *
-     * @return string
-     */
-    public function getName() {
-
-        $uri = $this->principalProperties['uri'];
-        list(, $name) = URLUtil::splitPath($uri);
-        return $name;
-
-    }
-
-    /**
-     * Returns the name of the user
-     *
-     * @return string
-     */
-    public function getDisplayName() {
-
-        if (isset($this->principalProperties['{DAV:}displayname'])) {
-            return $this->principalProperties['{DAV:}displayname'];
-        } else {
-            return $this->getName();
-        }
-
-    }
-
-    /**
-     * Returns a list of properties
-     *
-     * @param array $requestedProperties
-     * @return array
-     */
-    public function getProperties($requestedProperties) {
-
-        $newProperties = [];
-        foreach ($requestedProperties as $propName) {
-
-            if (isset($this->principalProperties[$propName])) {
-                $newProperties[$propName] = $this->principalProperties[$propName];
-            }
-
-        }
-
-        return $newProperties;
-
-    }
-
-    /**
-     * Updates properties on this node.
-     *
-     * This method received a PropPatch object, which contains all the
-     * information about the update.
-     *
-     * To update specific properties, call the 'handle' method on this object.
-     * Read the PropPatch documentation for more information.
-     *
-     * @param DAV\PropPatch $propPatch
-     * @return void
-     */
-    public function propPatch(DAV\PropPatch $propPatch) {
-
-        return $this->principalBackend->updatePrincipal(
-            $this->principalProperties['uri'],
-            $propPatch
-        );
-
-    }
-
-    /**
-     * Returns the owner principal
-     *
-     * This must be a url to a principal, or null if there's no owner
-     *
-     * @return string|null
-     */
-    public function getOwner() {
-
-        return $this->principalProperties['uri'];
-
-
-    }
-
-    /**
-     * Returns a group principal
-     *
-     * This must be a url to a principal, or null if there's no owner
-     *
-     * @return string|null
-     */
-    public function getGroup() {
-
-        return null;
-
-    }
-
-    /**
-     * Returns a list of ACE's for this node.
-     *
-     * Each ACE has the following properties:
-     *   * 'privilege', a string such as {DAV:}read or {DAV:}write. These are
-     *     currently the only supported privileges
-     *   * 'principal', a url to the principal who owns the node
-     *   * 'protected' (optional), indicating that this ACE is not allowed to
-     *      be updated.
-     *
-     * @return array
-     */
-    public function getACL() {
-
-        return [
-            [
-                'privilege' => '{DAV:}read',
-                'principal' => '{DAV:}authenticated',
-                'protected' => true,
-            ],
-        ];
-
-    }
-
-    /**
-     * Updates the ACL
-     *
-     * This method will receive a list of new ACE's.
-     *
-     * @param array $acl
-     * @return void
-     */
-    public function setACL(array $acl) {
-
-        throw new DAV\Exception\MethodNotAllowed('Updating ACLs is not allowed here');
-
-    }
-
-    /**
-     * Returns the list of supported privileges for this node.
-     *
-     * The returned data structure is a list of nested privileges.
-     * See Sabre\DAVACL\Plugin::getDefaultSupportedPrivilegeSet for a simple
-     * standard structure.
-     *
-     * If null is returned from this method, the default privilege set is used,
-     * which is fine for most common usecases.
-     *
-     * @return array|null
-     */
-    public function getSupportedPrivilegeSet() {
-
-        return null;
-
-    }
+	/**
+	 * Struct with principal information.
+	 *
+	 * @var array
+	 */
+	protected $principalProperties;
+
+	/**
+	 * Principal backend
+	 *
+	 * @var PrincipalBackend\BackendInterface
+	 */
+	protected $principalBackend;
+
+	/**
+	 * Creates the principal object
+	 *
+	 * @param IPrincipalBackend $principalBackend
+	 * @param array $principalProperties
+	 */
+	public function __construct(PrincipalBackend\BackendInterface $principalBackend, array $principalProperties = []) {
+
+		if (!isset($principalProperties['uri'])) {
+			throw new DAV\Exception('The principal properties must at least contain the \'uri\' key');
+		}
+		$this->principalBackend = $principalBackend;
+		$this->principalProperties = $principalProperties;
+
+	}
+
+	/**
+	 * Returns the full principal url
+	 *
+	 * @return string
+	 */
+	public function getPrincipalUrl() {
+
+		return $this->principalProperties['uri'];
+
+	}
+
+	/**
+	 * Returns a list of alternative urls for a principal
+	 *
+	 * This can for example be an email address, or ldap url.
+	 *
+	 * @return array
+	 */
+	public function getAlternateUriSet() {
+
+		$uris = [];
+		if (isset($this->principalProperties['{DAV:}alternate-URI-set'])) {
+
+			$uris = $this->principalProperties['{DAV:}alternate-URI-set'];
+
+		}
+
+		if (isset($this->principalProperties['{http://sabredav.org/ns}email-address'])) {
+			$uris[] = 'mailto:' . $this->principalProperties['{http://sabredav.org/ns}email-address'];
+		}
+
+		return array_unique($uris);
+
+	}
+
+	/**
+	 * Returns the list of group members
+	 *
+	 * If this principal is a group, this function should return
+	 * all member principal uri's for the group.
+	 *
+	 * @return array
+	 */
+	public function getGroupMemberSet() {
+
+		return $this->principalBackend->getGroupMemberSet($this->principalProperties['uri']);
+
+	}
+
+	/**
+	 * Returns the list of groups this principal is member of
+	 *
+	 * If this principal is a member of a (list of) groups, this function
+	 * should return a list of principal uri's for it's members.
+	 *
+	 * @return array
+	 */
+	public function getGroupMembership() {
+
+		return $this->principalBackend->getGroupMemberShip($this->principalProperties['uri']);
+
+	}
+
+	/**
+	 * Sets a list of group members
+	 *
+	 * If this principal is a group, this method sets all the group members.
+	 * The list of members is always overwritten, never appended to.
+	 *
+	 * This method should throw an exception if the members could not be set.
+	 *
+	 * @param array $groupMembers
+	 * @return void
+	 */
+	public function setGroupMemberSet(array $groupMembers) {
+
+		$this->principalBackend->setGroupMemberSet($this->principalProperties['uri'], $groupMembers);
+
+	}
+
+	/**
+	 * Returns this principals name.
+	 *
+	 * @return string
+	 */
+	public function getName() {
+
+		$uri = $this->principalProperties['uri'];
+		list(, $name) = URLUtil::splitPath($uri);
+		return $name;
+
+	}
+
+	/**
+	 * Returns the name of the user
+	 *
+	 * @return string
+	 */
+	public function getDisplayName() {
+
+		if (isset($this->principalProperties['{DAV:}displayname'])) {
+			return $this->principalProperties['{DAV:}displayname'];
+		} else {
+			return $this->getName();
+		}
+
+	}
+
+	/**
+	 * Returns a list of properties
+	 *
+	 * @param array $requestedProperties
+	 * @return array
+	 */
+	public function getProperties($requestedProperties) {
+
+		$newProperties = [];
+		foreach ($requestedProperties as $propName) {
+
+			if (isset($this->principalProperties[$propName])) {
+				$newProperties[$propName] = $this->principalProperties[$propName];
+			}
+
+		}
+
+		return $newProperties;
+
+	}
+
+	/**
+	 * Updates properties on this node.
+	 *
+	 * This method received a PropPatch object, which contains all the
+	 * information about the update.
+	 *
+	 * To update specific properties, call the 'handle' method on this object.
+	 * Read the PropPatch documentation for more information.
+	 *
+	 * @param DAV\PropPatch $propPatch
+	 * @return void
+	 */
+	public function propPatch(DAV\PropPatch $propPatch) {
+
+		return $this->principalBackend->updatePrincipal(
+			$this->principalProperties['uri'],
+			$propPatch
+		);
+
+	}
+
+	/**
+	 * Returns the owner principal
+	 *
+	 * This must be a url to a principal, or null if there's no owner
+	 *
+	 * @return string|null
+	 */
+	public function getOwner() {
+
+		return $this->principalProperties['uri'];
+
+
+	}
+
+	/**
+	 * Returns a group principal
+	 *
+	 * This must be a url to a principal, or null if there's no owner
+	 *
+	 * @return string|null
+	 */
+	public function getGroup() {
+
+		return null;
+
+	}
+
+	/**
+	 * Returns a list of ACE's for this node.
+	 *
+	 * Each ACE has the following properties:
+	 *   * 'privilege', a string such as {DAV:}read or {DAV:}write. These are
+	 *     currently the only supported privileges
+	 *   * 'principal', a url to the principal who owns the node
+	 *   * 'protected' (optional), indicating that this ACE is not allowed to
+	 *      be updated.
+	 *
+	 * @return array
+	 */
+	public function getACL() {
+
+		return [
+			[
+				'privilege' => '{DAV:}read',
+				'principal' => '{DAV:}authenticated',
+				'protected' => true,
+			],
+		];
+
+	}
+
+	/**
+	 * Updates the ACL
+	 *
+	 * This method will receive a list of new ACE's.
+	 *
+	 * @param array $acl
+	 * @return void
+	 */
+	public function setACL(array $acl) {
+
+		throw new DAV\Exception\MethodNotAllowed('Updating ACLs is not allowed here');
+
+	}
+
+	/**
+	 * Returns the list of supported privileges for this node.
+	 *
+	 * The returned data structure is a list of nested privileges.
+	 * See Sabre\DAVACL\Plugin::getDefaultSupportedPrivilegeSet for a simple
+	 * standard structure.
+	 *
+	 * If null is returned from this method, the default privilege set is used,
+	 * which is fine for most common usecases.
+	 *
+	 * @return array|null
+	 */
+	public function getSupportedPrivilegeSet() {
+
+		return null;
+
+	}
 
 }

libraries/SabreDAV/DAVACL/PrincipalBackend/PDO.php

Doc Comments +1 added lines, -1 removed lines

@@ -65,7 +65,7 @@
     /**
      * Sets up the backend.
      *
-     * @param PDO $pdo
+     * @param \PDO $pdo
      */
     function __construct(\PDO $pdo) {
 

Spacing +4 added lines, -4 removed lines

@@ -240,7 +240,7 @@ 
      * @return array
      */
     function searchPrincipals($prefixPath, array $searchProperties, $test = 'allof') {
-        if (count($searchProperties) == 0) return [];    //No criteria
+        if (count($searchProperties) == 0) return []; //No criteria
 
         $query = sprintf('SELECT uri FROM %s WHERE ', $this->tableName);
         $values = [];
@@ -303,11 +303,11 @@ 
         if ($value == null) return null;
 
         $uri = null;
-        switch ($scheme){
+        switch ($scheme) {
             case "mailto":
                 $query = sprintf('SELECT uri FROM %s WHERE lower(email)=lower(?)', $this->tableName);
                 $stmt = $this->pdo->prepare($query);
-                $stmt->execute([ $value ]);
+                $stmt->execute([$value]);
             
                 while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
                     // Checking if the principal is in the prefix
@@ -383,7 +383,7 @@ 
     function setGroupMemberSet($principal, array $members) {
 
         // Grabbing the list of principal id's.
-        $stmt = $this->pdo->prepare(sprintf('SELECT id, uri FROM %s WHERE uri IN (? %s);',$this->tableName, str_repeat(', ? ', count($members))));
+        $stmt = $this->pdo->prepare(sprintf('SELECT id, uri FROM %s WHERE uri IN (? %s);', $this->tableName, str_repeat(', ? ', count($members))));
         $stmt->execute(array_merge([$principal], $members));
 
         $memberIds = [];

Indentation +405 added lines, -405 removed lines

@@ -19,415 +19,415 @@
  */
 class PDO extends AbstractBackend implements CreatePrincipalSupport {
 
-    /**
-     * PDO table name for 'principals'
-     *
-     * @var string
-     */
-    public $tableName = 'principals';
-
-    /**
-     * PDO table name for 'group members'
-     *
-     * @var string
-     */
-    public $groupMembersTableName = 'groupmembers';
-
-    /**
-     * pdo
-     *
-     * @var PDO
-     */
-    protected $pdo;
-
-    /**
-     * A list of additional fields to support
-     *
-     * @var array
-     */
-    protected $fieldMap = [
-
-        /**
-         * This property can be used to display the users' real name.
-         */
-        '{DAV:}displayname' => [
-            'dbField' => 'displayname',
-        ],
-
-        /**
-         * This is the users' primary email-address.
-         */
-        '{http://sabredav.org/ns}email-address' => [
-            'dbField' => 'email',
-        ],
-    ];
-
-    /**
-     * Sets up the backend.
-     *
-     * @param PDO $pdo
-     */
-    public function __construct(\PDO $pdo) {
-
-        $this->pdo = $pdo;
-
-    }
-
-    /**
-     * Returns a list of principals based on a prefix.
-     *
-     * This prefix will often contain something like 'principals'. You are only
-     * expected to return principals that are in this base path.
-     *
-     * You are expected to return at least a 'uri' for every user, you can
-     * return any additional properties if you wish so. Common properties are:
-     *   {DAV:}displayname
-     *   {http://sabredav.org/ns}email-address - This is a custom SabreDAV
-     *     field that's actualy injected in a number of other properties. If
-     *     you have an email address, use this property.
-     *
-     * @param string $prefixPath
-     * @return array
-     */
-    public function getPrincipalsByPrefix($prefixPath) {
-
-        $fields = [
-            'uri',
-        ];
-
-        foreach ($this->fieldMap as $key => $value) {
-            $fields[] = $value['dbField'];
-        }
-        $result = $this->pdo->query(sprintf('SELECT %s FROM %s', implode(',', $fields), $this->tableName));
-
-        $principals = [];
-
-        while ($row = $result->fetch(\PDO::FETCH_ASSOC)) {
-
-            // Checking if the principal is in the prefix
-            list($rowPrefix) = URLUtil::splitPath($row['uri']);
-            if ($rowPrefix !== $prefixPath) continue;
-
-            $principal = [
-                'uri' => $row['uri'],
-            ];
-            foreach ($this->fieldMap as $key => $value) {
-                if ($row[$value['dbField']]) {
-                    $principal[$key] = $row[$value['dbField']];
-                }
-            }
-            $principals[] = $principal;
-
-        }
-
-        return $principals;
-
-    }
-
-    /**
-     * Returns a specific principal, specified by it's path.
-     * The returned structure should be the exact same as from
-     * getPrincipalsByPrefix.
-     *
-     * @param string $path
-     * @return array
-     */
-    public function getPrincipalByPath($path) {
-
-        $fields = [
-            'id',
-            'uri',
-        ];
-
-        foreach ($this->fieldMap as $key => $value) {
-            $fields[] = $value['dbField'];
-        }
-        $stmt = $this->pdo->prepare(sprintf('SELECT %s FROM %s WHERE uri = ?', implode(',', $fields), $this->tableName));
-        $stmt->execute([$path]);
-
-        $row = $stmt->fetch(\PDO::FETCH_ASSOC);
-        if (!$row) return;
-
-        $principal = [
-            'id'  => $row['id'],
-            'uri' => $row['uri'],
-        ];
-        foreach ($this->fieldMap as $key => $value) {
-            if ($row[$value['dbField']]) {
-                $principal[$key] = $row[$value['dbField']];
-            }
-        }
-        return $principal;
-
-    }
-
-    /**
-     * Updates one ore more webdav properties on a principal.
-     *
-     * The list of mutations is stored in a Sabre\DAV\PropPatch object.
-     * To do the actual updates, you must tell this object which properties
-     * you're going to process with the handle() method.
-     *
-     * Calling the handle method is like telling the PropPatch object "I
-     * promise I can handle updating this property".
-     *
-     * Read the PropPatch documenation for more info and examples.
-     *
-     * @param string $path
-     * @param DAV\PropPatch $propPatch
-     */
-    public function updatePrincipal($path, DAV\PropPatch $propPatch) {
-
-        $propPatch->handle(array_keys($this->fieldMap), function($properties) use ($path) {
-
-            $query = sprintf('UPDATE %s SET ', $this->tableName);
-            $first = true;
-
-            $values = [];
-
-            foreach ($properties as $key => $value) {
-
-                $dbField = $this->fieldMap[$key]['dbField'];
-
-                if (!$first) {
-                    $query .= ', ';
-                }
-                $first = false;
-                $query .= $dbField . ' = :' . $dbField;
-                $values[$dbField] = $value;
-
-            }
-
-            $query .= " WHERE uri = :uri";
-            $values['uri'] = $path;
-
-            $stmt = $this->pdo->prepare($query);
-            $stmt->execute($values);
-
-            return true;
-
-        });
-
-    }
-
-    /**
-     * This method is used to search for principals matching a set of
-     * properties.
-     *
-     * This search is specifically used by RFC3744's principal-property-search
-     * REPORT.
-     *
-     * The actual search should be a unicode-non-case-sensitive search. The
-     * keys in searchProperties are the WebDAV property names, while the values
-     * are the property values to search on.
-     *
-     * By default, if multiple properties are submitted to this method, the
-     * various properties should be combined with 'AND'. If $test is set to
-     * 'anyof', it should be combined using 'OR'.
-     *
-     * This method should simply return an array with full principal uri's.
-     *
-     * If somebody attempted to search on a property the backend does not
-     * support, you should simply return 0 results.
-     *
-     * You can also just return 0 results if you choose to not support
-     * searching at all, but keep in mind that this may stop certain features
-     * from working.
-     *
-     * @param string $prefixPath
-     * @param array $searchProperties
-     * @param string $test
-     * @return array
-     */
-    public function searchPrincipals($prefixPath, array $searchProperties, $test = 'allof') {
-        if (count($searchProperties) == 0) return [];    //No criteria
-
-        $query = sprintf('SELECT uri FROM %s WHERE ', $this->tableName);
-        $values = [];
-        foreach ($searchProperties as $property => $value) {
-            switch ($property) {
-                case '{DAV:}displayname' :
-                    $column = "displayname";
-                    break;
-                case '{http://sabredav.org/ns}email-address' :
-                    $column = "email";
-                    break;
-                default :
-                    // Unsupported property
-                    return [];
-            }
-            if (count($values) > 0) $query .= (strcmp($test, "anyof") == 0 ? " || " : " && ");
-            $query .= 'lower(' . $column . ') LIKE lower(?)';
-            $values[] = '%' . $value . '%';
-
-        }
-        $stmt = $this->pdo->prepare($query);
-        $stmt->execute($values);
-
-        $principals = [];
-        while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
-
-            // Checking if the principal is in the prefix
-            list($rowPrefix) = URLUtil::splitPath($row['uri']);
-            if ($rowPrefix !== $prefixPath) continue;
-
-            $principals[] = $row['uri'];
-
-        }
-
-        return $principals;
-
-    }
-
-    /**
-     * Finds a principal by its URI.
-     *
-     * This method may receive any type of uri, but mailto: addresses will be
-     * the most common.
-     *
-     * Implementation of this API is optional. It is currently used by the
-     * CalDAV system to find principals based on their email addresses. If this
-     * API is not implemented, some features may not work correctly.
-     *
-     * This method must return a relative principal path, or null, if the
-     * principal was not found or you refuse to find it.
-     *
-     * @param string $uri
-     * @param string $principalPrefix
-     * @return string
-     */
-    public function findByUri($uri, $principalPrefix) {
-        $value = null;
-        $scheme = null;
-        list($scheme, $value) = explode(":", $uri, 2);
-        if ($value === null) return null;
-
-        $uri = null;
-        switch ($scheme){
-            case "mailto":
-                $query = sprintf('SELECT uri FROM %s WHERE lower(email)=lower(?)', $this->tableName);
-                $stmt = $this->pdo->prepare($query);
-                $stmt->execute([ $value ]);
+	/**
+	 * PDO table name for 'principals'
+	 *
+	 * @var string
+	 */
+	public $tableName = 'principals';
+
+	/**
+	 * PDO table name for 'group members'
+	 *
+	 * @var string
+	 */
+	public $groupMembersTableName = 'groupmembers';
+
+	/**
+	 * pdo
+	 *
+	 * @var PDO
+	 */
+	protected $pdo;
+
+	/**
+	 * A list of additional fields to support
+	 *
+	 * @var array
+	 */
+	protected $fieldMap = [
+
+		/**
+		 * This property can be used to display the users' real name.
+		 */
+		'{DAV:}displayname' => [
+			'dbField' => 'displayname',
+		],
+
+		/**
+		 * This is the users' primary email-address.
+		 */
+		'{http://sabredav.org/ns}email-address' => [
+			'dbField' => 'email',
+		],
+	];
+
+	/**
+	 * Sets up the backend.
+	 *
+	 * @param PDO $pdo
+	 */
+	public function __construct(\PDO $pdo) {
+
+		$this->pdo = $pdo;
+
+	}
+
+	/**
+	 * Returns a list of principals based on a prefix.
+	 *
+	 * This prefix will often contain something like 'principals'. You are only
+	 * expected to return principals that are in this base path.
+	 *
+	 * You are expected to return at least a 'uri' for every user, you can
+	 * return any additional properties if you wish so. Common properties are:
+	 *   {DAV:}displayname
+	 *   {http://sabredav.org/ns}email-address - This is a custom SabreDAV
+	 *     field that's actualy injected in a number of other properties. If
+	 *     you have an email address, use this property.
+	 *
+	 * @param string $prefixPath
+	 * @return array
+	 */
+	public function getPrincipalsByPrefix($prefixPath) {
+
+		$fields = [
+			'uri',
+		];
+
+		foreach ($this->fieldMap as $key => $value) {
+			$fields[] = $value['dbField'];
+		}
+		$result = $this->pdo->query(sprintf('SELECT %s FROM %s', implode(',', $fields), $this->tableName));
+
+		$principals = [];
+
+		while ($row = $result->fetch(\PDO::FETCH_ASSOC)) {
+
+			// Checking if the principal is in the prefix
+			list($rowPrefix) = URLUtil::splitPath($row['uri']);
+			if ($rowPrefix !== $prefixPath) continue;
+
+			$principal = [
+				'uri' => $row['uri'],
+			];
+			foreach ($this->fieldMap as $key => $value) {
+				if ($row[$value['dbField']]) {
+					$principal[$key] = $row[$value['dbField']];
+				}
+			}
+			$principals[] = $principal;
+
+		}
+
+		return $principals;
+
+	}
+
+	/**
+	 * Returns a specific principal, specified by it's path.
+	 * The returned structure should be the exact same as from
+	 * getPrincipalsByPrefix.
+	 *
+	 * @param string $path
+	 * @return array
+	 */
+	public function getPrincipalByPath($path) {
+
+		$fields = [
+			'id',
+			'uri',
+		];
+
+		foreach ($this->fieldMap as $key => $value) {
+			$fields[] = $value['dbField'];
+		}
+		$stmt = $this->pdo->prepare(sprintf('SELECT %s FROM %s WHERE uri = ?', implode(',', $fields), $this->tableName));
+		$stmt->execute([$path]);
+
+		$row = $stmt->fetch(\PDO::FETCH_ASSOC);
+		if (!$row) return;
+
+		$principal = [
+			'id'  => $row['id'],
+			'uri' => $row['uri'],
+		];
+		foreach ($this->fieldMap as $key => $value) {
+			if ($row[$value['dbField']]) {
+				$principal[$key] = $row[$value['dbField']];
+			}
+		}
+		return $principal;
+
+	}
+
+	/**
+	 * Updates one ore more webdav properties on a principal.
+	 *
+	 * The list of mutations is stored in a Sabre\DAV\PropPatch object.
+	 * To do the actual updates, you must tell this object which properties
+	 * you're going to process with the handle() method.
+	 *
+	 * Calling the handle method is like telling the PropPatch object "I
+	 * promise I can handle updating this property".
+	 *
+	 * Read the PropPatch documenation for more info and examples.
+	 *
+	 * @param string $path
+	 * @param DAV\PropPatch $propPatch
+	 */
+	public function updatePrincipal($path, DAV\PropPatch $propPatch) {
+
+		$propPatch->handle(array_keys($this->fieldMap), function($properties) use ($path) {
+
+			$query = sprintf('UPDATE %s SET ', $this->tableName);
+			$first = true;
+
+			$values = [];
+
+			foreach ($properties as $key => $value) {
+
+				$dbField = $this->fieldMap[$key]['dbField'];
+
+				if (!$first) {
+					$query .= ', ';
+				}
+				$first = false;
+				$query .= $dbField . ' = :' . $dbField;
+				$values[$dbField] = $value;
+
+			}
+
+			$query .= " WHERE uri = :uri";
+			$values['uri'] = $path;
+
+			$stmt = $this->pdo->prepare($query);
+			$stmt->execute($values);
+
+			return true;
+
+		});
+
+	}
+
+	/**
+	 * This method is used to search for principals matching a set of
+	 * properties.
+	 *
+	 * This search is specifically used by RFC3744's principal-property-search
+	 * REPORT.
+	 *
+	 * The actual search should be a unicode-non-case-sensitive search. The
+	 * keys in searchProperties are the WebDAV property names, while the values
+	 * are the property values to search on.
+	 *
+	 * By default, if multiple properties are submitted to this method, the
+	 * various properties should be combined with 'AND'. If $test is set to
+	 * 'anyof', it should be combined using 'OR'.
+	 *
+	 * This method should simply return an array with full principal uri's.
+	 *
+	 * If somebody attempted to search on a property the backend does not
+	 * support, you should simply return 0 results.
+	 *
+	 * You can also just return 0 results if you choose to not support
+	 * searching at all, but keep in mind that this may stop certain features
+	 * from working.
+	 *
+	 * @param string $prefixPath
+	 * @param array $searchProperties
+	 * @param string $test
+	 * @return array
+	 */
+	public function searchPrincipals($prefixPath, array $searchProperties, $test = 'allof') {
+		if (count($searchProperties) == 0) return [];    //No criteria
+
+		$query = sprintf('SELECT uri FROM %s WHERE ', $this->tableName);
+		$values = [];
+		foreach ($searchProperties as $property => $value) {
+			switch ($property) {
+				case '{DAV:}displayname' :
+					$column = "displayname";
+					break;
+				case '{http://sabredav.org/ns}email-address' :
+					$column = "email";
+					break;
+				default :
+					// Unsupported property
+					return [];
+			}
+			if (count($values) > 0) $query .= (strcmp($test, "anyof") == 0 ? " || " : " && ");
+			$query .= 'lower(' . $column . ') LIKE lower(?)';
+			$values[] = '%' . $value . '%';
+
+		}
+		$stmt = $this->pdo->prepare($query);
+		$stmt->execute($values);
+
+		$principals = [];
+		while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
+
+			// Checking if the principal is in the prefix
+			list($rowPrefix) = URLUtil::splitPath($row['uri']);
+			if ($rowPrefix !== $prefixPath) continue;
+
+			$principals[] = $row['uri'];
+
+		}
+
+		return $principals;
+
+	}
+
+	/**
+	 * Finds a principal by its URI.
+	 *
+	 * This method may receive any type of uri, but mailto: addresses will be
+	 * the most common.
+	 *
+	 * Implementation of this API is optional. It is currently used by the
+	 * CalDAV system to find principals based on their email addresses. If this
+	 * API is not implemented, some features may not work correctly.
+	 *
+	 * This method must return a relative principal path, or null, if the
+	 * principal was not found or you refuse to find it.
+	 *
+	 * @param string $uri
+	 * @param string $principalPrefix
+	 * @return string
+	 */
+	public function findByUri($uri, $principalPrefix) {
+		$value = null;
+		$scheme = null;
+		list($scheme, $value) = explode(":", $uri, 2);
+		if ($value === null) return null;
+
+		$uri = null;
+		switch ($scheme){
+			case "mailto":
+				$query = sprintf('SELECT uri FROM %s WHERE lower(email)=lower(?)', $this->tableName);
+				$stmt = $this->pdo->prepare($query);
+				$stmt->execute([ $value ]);
             
-                while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
-                    // Checking if the principal is in the prefix
-                    list($rowPrefix) = URLUtil::splitPath($row['uri']);
-                    if ($rowPrefix !== $principalPrefix) continue;
+				while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
+					// Checking if the principal is in the prefix
+					list($rowPrefix) = URLUtil::splitPath($row['uri']);
+					if ($rowPrefix !== $principalPrefix) continue;
                     
-                    $uri = $row['uri'];
-                    break; //Stop on first match
-                }
-                break;
-            default:
-                //unsupported uri scheme
-                return null;
-        }
-        return $uri;
-    }
-
-    /**
-     * Returns the list of members for a group-principal
-     *
-     * @param string $principal
-     * @return array
-     */
-    public function getGroupMemberSet($principal) {
-
-        $principal = $this->getPrincipalByPath($principal);
-        if (!$principal) throw new DAV\Exception('Principal not found');
+					$uri = $row['uri'];
+					break; //Stop on first match
+				}
+				break;
+			default:
+				//unsupported uri scheme
+				return null;
+		}
+		return $uri;
+	}
+
+	/**
+	 * Returns the list of members for a group-principal
+	 *
+	 * @param string $principal
+	 * @return array
+	 */
+	public function getGroupMemberSet($principal) {
+
+		$principal = $this->getPrincipalByPath($principal);
+		if (!$principal) throw new DAV\Exception('Principal not found');
 
 		$query = 'SELECT principals.uri as uri FROM %s AS groupmembers LEFT JOIN %s AS principals ON groupmembers.member_id = principals.id WHERE groupmembers.principal_id = ?';
-        $query = sprintf($query, $this->groupMembersTableName, $this->tableName);
+		$query = sprintf($query, $this->groupMembersTableName, $this->tableName);
 		$stmt = $this->pdo->prepare($query);
-        $stmt->execute([$principal['id']]);
-
-        $result = [];
-        while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
-            $result[] = $row['uri'];
-        }
-        return $result;
-
-    }
-
-    /**
-     * Returns the list of groups a principal is a member of
-     *
-     * @param string $principal
-     * @return array
-     */
-    public function getGroupMembership($principal) {
-
-        $principal = $this->getPrincipalByPath($principal);
-        if (!$principal) throw new DAV\Exception('Principal not found');
-
-        $stmt = $this->pdo->prepare(sprintf('SELECT principals.uri as uri FROM %s AS groupmembers LEFT JOIN %s AS principals ON groupmembers.principal_id = principals.id WHERE groupmembers.member_id = ?', $this->groupMembersTableName, $this->tableName));
-        $stmt->execute([$principal['id']]);
-
-        $result = [];
-        while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
-            $result[] = $row['uri'];
-        }
-        return $result;
-
-    }
-
-    /**
-     * Updates the list of group members for a group principal.
-     *
-     * The principals should be passed as a list of uri's.
-     *
-     * @param string $principal
-     * @param array $members
-     * @return void
-     */
-    public function setGroupMemberSet($principal, array $members) {
-
-        // Grabbing the list of principal id's.
-        $stmt = $this->pdo->prepare(sprintf('SELECT id, uri FROM %s WHERE uri IN (? %s);',$this->tableName, str_repeat(', ? ', count($members))));
-        $stmt->execute(array_merge([$principal], $members));
-
-        $memberIds = [];
-        $principalId = null;
-
-        while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
-            if ($row['uri'] == $principal) {
-                $principalId = $row['id'];
-            } else {
-                $memberIds[] = $row['id'];
-            }
-        }
-        if (!$principalId) throw new DAV\Exception('Principal not found');
-
-        // Wiping out old members
-        $stmt = $this->pdo->prepare(sprintf('DELETE FROM %s WHERE principal_id = ?;', $this->groupMembersTableName));
-        $stmt->execute([$principalId]);
-
-        foreach ($memberIds as $memberId) {
-
-            $stmt = $this->pdo->prepare('INSERT INTO ' . $this->groupMembersTableName . ' (principal_id, member_id) VALUES (?, ?);');
-            $stmt->execute([$principalId, $memberId]);
-
-        }
-
-    }
-
-    /**
-     * Creates a new principal.
-     *
-     * This method receives a full path for the new principal. The mkCol object
-     * contains any additional webdav properties specified during the creation
-     * of the principal.
-     *
-     * @param string $path
-     * @param MkCol $mkCol
-     * @return void
-     */
-    public function createPrincipal($path, MkCol $mkCol) {
-
-        $stmt = $this->pdo->prepare('INSERT INTO ' . $this->tableName . ' (uri) VALUES (?)');
-        $stmt->execute([$path]);
-        $this->updatePrincipal($path, $mkCol);
-
-    }
+		$stmt->execute([$principal['id']]);
+
+		$result = [];
+		while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
+			$result[] = $row['uri'];
+		}
+		return $result;
+
+	}
+
+	/**
+	 * Returns the list of groups a principal is a member of
+	 *
+	 * @param string $principal
+	 * @return array
+	 */
+	public function getGroupMembership($principal) {
+
+		$principal = $this->getPrincipalByPath($principal);
+		if (!$principal) throw new DAV\Exception('Principal not found');
+
+		$stmt = $this->pdo->prepare(sprintf('SELECT principals.uri as uri FROM %s AS groupmembers LEFT JOIN %s AS principals ON groupmembers.principal_id = principals.id WHERE groupmembers.member_id = ?', $this->groupMembersTableName, $this->tableName));
+		$stmt->execute([$principal['id']]);
+
+		$result = [];
+		while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
+			$result[] = $row['uri'];
+		}
+		return $result;
+
+	}
+
+	/**
+	 * Updates the list of group members for a group principal.
+	 *
+	 * The principals should be passed as a list of uri's.
+	 *
+	 * @param string $principal
+	 * @param array $members
+	 * @return void
+	 */
+	public function setGroupMemberSet($principal, array $members) {
+
+		// Grabbing the list of principal id's.
+		$stmt = $this->pdo->prepare(sprintf('SELECT id, uri FROM %s WHERE uri IN (? %s);',$this->tableName, str_repeat(', ? ', count($members))));
+		$stmt->execute(array_merge([$principal], $members));
+
+		$memberIds = [];
+		$principalId = null;
+
+		while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
+			if ($row['uri'] == $principal) {
+				$principalId = $row['id'];
+			} else {
+				$memberIds[] = $row['id'];
+			}
+		}
+		if (!$principalId) throw new DAV\Exception('Principal not found');
+
+		// Wiping out old members
+		$stmt = $this->pdo->prepare(sprintf('DELETE FROM %s WHERE principal_id = ?;', $this->groupMembersTableName));
+		$stmt->execute([$principalId]);
+
+		foreach ($memberIds as $memberId) {
+
+			$stmt = $this->pdo->prepare('INSERT INTO ' . $this->groupMembersTableName . ' (principal_id, member_id) VALUES (?, ?);');
+			$stmt->execute([$principalId, $memberId]);
+
+		}
+
+	}
+
+	/**
+	 * Creates a new principal.
+	 *
+	 * This method receives a full path for the new principal. The mkCol object
+	 * contains any additional webdav properties specified during the creation
+	 * of the principal.
+	 *
+	 * @param string $path
+	 * @param MkCol $mkCol
+	 * @return void
+	 */
+	public function createPrincipal($path, MkCol $mkCol) {
+
+		$stmt = $this->pdo->prepare('INSERT INTO ' . $this->tableName . ' (uri) VALUES (?)');
+		$stmt->execute([$path]);
+		$this->updatePrincipal($path, $mkCol);
+
+	}
 
 }

Braces +31 added lines, -10 removed lines

@@ -106,7 +106,9 @@ 
 
             // Checking if the principal is in the prefix
             list($rowPrefix) = URLUtil::splitPath($row['uri']);
-            if ($rowPrefix !== $prefixPath) continue;
+            if ($rowPrefix !== $prefixPath) {
+            	continue;
+            }
 
             $principal = [
                 'uri' => $row['uri'],
@@ -146,7 +148,9 @@ 
         $stmt->execute([$path]);
 
         $row = $stmt->fetch(\PDO::FETCH_ASSOC);
-        if (!$row) return;
+        if (!$row) {
+        	return;
+        }
 
         $principal = [
             'id'  => $row['id'],
@@ -240,7 +244,10 @@ 
      * @return array
      */
     public function searchPrincipals($prefixPath, array $searchProperties, $test = 'allof') {
-        if (count($searchProperties) == 0) return [];    //No criteria
+        if (count($searchProperties) == 0) {
+        	return [];
+        }
+        //No criteria
 
         $query = sprintf('SELECT uri FROM %s WHERE ', $this->tableName);
         $values = [];
@@ -256,7 +263,9 @@ 
                     // Unsupported property
                     return [];
             }
-            if (count($values) > 0) $query .= (strcmp($test, "anyof") == 0 ? " || " : " && ");
+            if (count($values) > 0) {
+            	$query .= (strcmp($test, "anyof") == 0 ? " || " : " && ");
+            }
             $query .= 'lower(' . $column . ') LIKE lower(?)';
             $values[] = '%' . $value . '%';
 
@@ -269,7 +278,9 @@ 
 
             // Checking if the principal is in the prefix
             list($rowPrefix) = URLUtil::splitPath($row['uri']);
-            if ($rowPrefix !== $prefixPath) continue;
+            if ($rowPrefix !== $prefixPath) {
+            	continue;
+            }
 
             $principals[] = $row['uri'];
 
@@ -300,7 +311,9 @@ 
         $value = null;
         $scheme = null;
         list($scheme, $value) = explode(":", $uri, 2);
-        if ($value === null) return null;
+        if ($value === null) {
+        	return null;
+        }
 
         $uri = null;
         switch ($scheme){
@@ -312,7 +325,9 @@ 
                 while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
                     // Checking if the principal is in the prefix
                     list($rowPrefix) = URLUtil::splitPath($row['uri']);
-                    if ($rowPrefix !== $principalPrefix) continue;
+                    if ($rowPrefix !== $principalPrefix) {
+                    	continue;
+                    }
                     
                     $uri = $row['uri'];
                     break; //Stop on first match
@@ -334,7 +349,9 @@ 
     public function getGroupMemberSet($principal) {
 
         $principal = $this->getPrincipalByPath($principal);
-        if (!$principal) throw new DAV\Exception('Principal not found');
+        if (!$principal) {
+        	throw new DAV\Exception('Principal not found');
+        }
 
 		$query = 'SELECT principals.uri as uri FROM %s AS groupmembers LEFT JOIN %s AS principals ON groupmembers.member_id = principals.id WHERE groupmembers.principal_id = ?';
         $query = sprintf($query, $this->groupMembersTableName, $this->tableName);
@@ -358,7 +375,9 @@ 
     public function getGroupMembership($principal) {
 
         $principal = $this->getPrincipalByPath($principal);
-        if (!$principal) throw new DAV\Exception('Principal not found');
+        if (!$principal) {
+        	throw new DAV\Exception('Principal not found');
+        }
 
         $stmt = $this->pdo->prepare(sprintf('SELECT principals.uri as uri FROM %s AS groupmembers LEFT JOIN %s AS principals ON groupmembers.principal_id = principals.id WHERE groupmembers.member_id = ?', $this->groupMembersTableName, $this->tableName));
         $stmt->execute([$principal['id']]);
@@ -396,7 +415,9 @@ 
                 $memberIds[] = $row['id'];
             }
         }
-        if (!$principalId) throw new DAV\Exception('Principal not found');
+        if (!$principalId) {
+        	throw new DAV\Exception('Principal not found');
+        }
 
         // Wiping out old members
         $stmt = $this->pdo->prepare(sprintf('DELETE FROM %s WHERE principal_id = ?;', $this->groupMembersTableName));

libraries/SabreDAV/DAVACL/Xml/Property/Acl.php

Doc Comments +1 added lines, -1 removed lines

@@ -165,7 +165,7 @@
      * the next element.
      *
      * @param Reader $reader
-     * @return mixed
+     * @return Acl
      */
     static function xmlDeserialize(Reader $reader) {
 

Spacing +1 added lines, -1 removed lines

@@ -177,7 +177,7 @@
 
         $privileges = [];
 
-        foreach ((array)$reader->parseInnerTree($elementMap) as $element) {
+        foreach ((array) $reader->parseInnerTree($elementMap) as $element) {
 
             if ($element['name'] !== '{DAV:}ace') {
                 continue;

Braces +3 added lines, -1 removed lines

@@ -136,7 +136,9 @@
             }
             echo '<td>', $html->xmlName($privilege['privilege']), '</td>';
             echo '<td>';
-            if (!empty($privilege['protected'])) echo '(protected)';
+            if (!empty($privilege['protected'])) {
+            	echo '(protected)';
+            }
             echo '</td>';
             echo '</tr>';
 

Indentation +246 added lines, -246 removed lines

@@ -27,251 +27,251 @@
  */
 class Acl implements Element, HtmlOutput {
 
-    /**
-     * List of privileges
-     *
-     * @var array
-     */
-    protected $privileges;
-
-    /**
-     * Whether or not the server base url is required to be prefixed when
-     * serializing the property.
-     *
-     * @var bool
-     */
-    protected $prefixBaseUrl;
-
-    /**
-     * Constructor
-     *
-     * This object requires a structure similar to the return value from
-     * Sabre\DAVACL\Plugin::getACL().
-     *
-     * Each privilege is a an array with at least a 'privilege' property, and a
-     * 'principal' property. A privilege may have a 'protected' property as
-     * well.
-     *
-     * The prefixBaseUrl should be set to false, if the supplied principal urls
-     * are already full urls. If this is kept to true, the servers base url
-     * will automatically be prefixed.
-     *
-     * @param array $privileges
-     * @param bool $prefixBaseUrl
-     */
-    public function __construct(array $privileges, $prefixBaseUrl = true) {
-
-        $this->privileges = $privileges;
-        $this->prefixBaseUrl = $prefixBaseUrl;
-
-    }
-
-    /**
-     * Returns the list of privileges for this property
-     *
-     * @return array
-     */
-    public function getPrivileges() {
-
-        return $this->privileges;
-
-    }
-
-    /**
-     * The xmlSerialize metod is called during xml writing.
-     *
-     * Use the $writer argument to write its own xml serialization.
-     *
-     * An important note: do _not_ create a parent element. Any element
-     * implementing XmlSerializble should only ever write what's considered
-     * its 'inner xml'.
-     *
-     * The parent of the current element is responsible for writing a
-     * containing element.
-     *
-     * This allows serializers to be re-used for different element names.
-     *
-     * If you are opening new elements, you must also close them again.
-     *
-     * @param Writer $writer
-     * @return void
-     */
-    public function xmlSerialize(Writer $writer) {
-
-        foreach ($this->privileges as $ace) {
-
-            $this->serializeAce($writer, $ace);
-
-        }
-
-    }
-
-    /**
-     * Generate html representation for this value.
-     *
-     * The html output is 100% trusted, and no effort is being made to sanitize
-     * it. It's up to the implementor to sanitize user provided values.
-     *
-     * The output must be in UTF-8.
-     *
-     * The baseUri parameter is a url to the root of the application, and can
-     * be used to construct local links.
-     *
-     * @param HtmlOutputHelper $html
-     * @return string
-     */
-    public function toHtml(HtmlOutputHelper $html) {
-
-        ob_start();
-        echo "<table>";
-        echo "<tr><th>Principal</th><th>Privilege</th><th></th></tr>";
-        foreach ($this->privileges as $privilege) {
-
-            echo '<tr>';
-            // if it starts with a {, it's a special principal
-            if ($privilege['principal'][0] === '{') {
-                echo '<td>', $html->xmlName($privilege['principal']), '</td>';
-            } else {
-                echo '<td>', $html->link($privilege['principal']), '</td>';
-            }
-            echo '<td>', $html->xmlName($privilege['privilege']), '</td>';
-            echo '<td>';
-            if (!empty($privilege['protected'])) echo '(protected)';
-            echo '</td>';
-            echo '</tr>';
-
-        }
-        echo "</table>";
-        return ob_get_clean();
-
-    }
-
-    /**
-     * The deserialize method is called during xml parsing.
-     *
-     * This method is called statictly, this is because in theory this method
-     * may be used as a type of constructor, or factory method.
-     *
-     * Often you want to return an instance of the current class, but you are
-     * free to return other data as well.
-     *
-     * Important note 2: You are responsible for advancing the reader to the
-     * next element. Not doing anything will result in a never-ending loop.
-     *
-     * If you just want to skip parsing for this element altogether, you can
-     * just call $reader->next();
-     *
-     * $reader->parseInnerTree() will parse the entire sub-tree, and advance to
-     * the next element.
-     *
-     * @param Reader $reader
-     * @return mixed
-     */
-    static function xmlDeserialize(Reader $reader) {
-
-        $elementMap = [
-            '{DAV:}ace'       => 'Sabre\Xml\Element\KeyValue',
-            '{DAV:}privilege' => 'Sabre\Xml\Element\Elements',
-            '{DAV:}principal' => 'Sabre\DAVACL\Xml\Property\Principal',
-        ];
-
-        $privileges = [];
-
-        foreach ((array)$reader->parseInnerTree($elementMap) as $element) {
-
-            if ($element['name'] !== '{DAV:}ace') {
-                continue;
-            }
-            $ace = $element['value'];
-
-            if (empty($ace['{DAV:}principal'])) {
-                throw new DAV\Exception\BadRequest('Each {DAV:}ace element must have one {DAV:}principal element');
-            }
-            $principal = $ace['{DAV:}principal'];
-
-            switch ($principal->getType()) {
-                case Principal::HREF :
-                    $principal = $principal->getHref();
-                    break;
-                case Principal::AUTHENTICATED :
-                    $principal = '{DAV:}authenticated';
-                    break;
-                case Principal::UNAUTHENTICATED :
-                    $principal = '{DAV:}unauthenticated';
-                    break;
-                case Principal::ALL :
-                    $principal = '{DAV:}all';
-                    break;
-
-            }
-
-            $protected = array_key_exists('{DAV:}protected', $ace);
-
-            if (!isset($ace['{DAV:}grant'])) {
-                throw new DAV\Exception\NotImplemented('Every {DAV:}ace element must have a {DAV:}grant element. {DAV:}deny is not yet supported');
-            }
-            foreach ($ace['{DAV:}grant'] as $elem) {
-                if ($elem['name'] !== '{DAV:}privilege') {
-                    continue;
-                }
-
-                foreach ($elem['value'] as $priv) {
-                    $privileges[] = [
-                        'principal' => $principal,
-                        'protected' => $protected,
-                        'privilege' => $priv,
-                    ];
-                }
-
-            }
-
-        }
-
-        return new self($privileges);
-
-    }
-
-    /**
-     * Serializes a single access control entry.
-     *
-     * @param Writer $writer
-     * @param array $ace
-     * @return void
-     */
-    private function serializeAce(Writer $writer, array $ace) {
-
-        $writer->startElement('{DAV:}ace');
-
-        switch ($ace['principal']) {
-            case '{DAV:}authenticated' :
-                $principal = new Principal(Principal::AUTHENTICATED);
-                break;
-            case '{DAV:}unauthenticated' :
-                $principal = new Principal(Principal::UNAUTHENTICATED);
-                break;
-            case '{DAV:}all' :
-                $principal = new Principal(Principal::ALL);
-                break;
-            default:
-                $principal = new Principal(Principal::HREF, $ace['principal']);
-                break;
-        }
-
-        $writer->writeElement('{DAV:}principal', $principal);
-        $writer->startElement('{DAV:}grant');
-        $writer->startElement('{DAV:}privilege');
-
-        $writer->writeElement($ace['privilege']);
-
-        $writer->endElement(); // privilege
-        $writer->endElement(); // grant
-
-        if (!empty($ace['protected'])) {
-            $writer->writeElement('{DAV:}protected');
-        }
-
-        $writer->endElement(); // ace
-
-    }
+	/**
+	 * List of privileges
+	 *
+	 * @var array
+	 */
+	protected $privileges;
+
+	/**
+	 * Whether or not the server base url is required to be prefixed when
+	 * serializing the property.
+	 *
+	 * @var bool
+	 */
+	protected $prefixBaseUrl;
+
+	/**
+	 * Constructor
+	 *
+	 * This object requires a structure similar to the return value from
+	 * Sabre\DAVACL\Plugin::getACL().
+	 *
+	 * Each privilege is a an array with at least a 'privilege' property, and a
+	 * 'principal' property. A privilege may have a 'protected' property as
+	 * well.
+	 *
+	 * The prefixBaseUrl should be set to false, if the supplied principal urls
+	 * are already full urls. If this is kept to true, the servers base url
+	 * will automatically be prefixed.
+	 *
+	 * @param array $privileges
+	 * @param bool $prefixBaseUrl
+	 */
+	public function __construct(array $privileges, $prefixBaseUrl = true) {
+
+		$this->privileges = $privileges;
+		$this->prefixBaseUrl = $prefixBaseUrl;
+
+	}
+
+	/**
+	 * Returns the list of privileges for this property
+	 *
+	 * @return array
+	 */
+	public function getPrivileges() {
+
+		return $this->privileges;
+
+	}
+
+	/**
+	 * The xmlSerialize metod is called during xml writing.
+	 *
+	 * Use the $writer argument to write its own xml serialization.
+	 *
+	 * An important note: do _not_ create a parent element. Any element
+	 * implementing XmlSerializble should only ever write what's considered
+	 * its 'inner xml'.
+	 *
+	 * The parent of the current element is responsible for writing a
+	 * containing element.
+	 *
+	 * This allows serializers to be re-used for different element names.
+	 *
+	 * If you are opening new elements, you must also close them again.
+	 *
+	 * @param Writer $writer
+	 * @return void
+	 */
+	public function xmlSerialize(Writer $writer) {
+
+		foreach ($this->privileges as $ace) {
+
+			$this->serializeAce($writer, $ace);
+
+		}
+
+	}
+
+	/**
+	 * Generate html representation for this value.
+	 *
+	 * The html output is 100% trusted, and no effort is being made to sanitize
+	 * it. It's up to the implementor to sanitize user provided values.
+	 *
+	 * The output must be in UTF-8.
+	 *
+	 * The baseUri parameter is a url to the root of the application, and can
+	 * be used to construct local links.
+	 *
+	 * @param HtmlOutputHelper $html
+	 * @return string
+	 */
+	public function toHtml(HtmlOutputHelper $html) {
+
+		ob_start();
+		echo "<table>";
+		echo "<tr><th>Principal</th><th>Privilege</th><th></th></tr>";
+		foreach ($this->privileges as $privilege) {
+
+			echo '<tr>';
+			// if it starts with a {, it's a special principal
+			if ($privilege['principal'][0] === '{') {
+				echo '<td>', $html->xmlName($privilege['principal']), '</td>';
+			} else {
+				echo '<td>', $html->link($privilege['principal']), '</td>';
+			}
+			echo '<td>', $html->xmlName($privilege['privilege']), '</td>';
+			echo '<td>';
+			if (!empty($privilege['protected'])) echo '(protected)';
+			echo '</td>';
+			echo '</tr>';
+
+		}
+		echo "</table>";
+		return ob_get_clean();
+
+	}
+
+	/**
+	 * The deserialize method is called during xml parsing.
+	 *
+	 * This method is called statictly, this is because in theory this method
+	 * may be used as a type of constructor, or factory method.
+	 *
+	 * Often you want to return an instance of the current class, but you are
+	 * free to return other data as well.
+	 *
+	 * Important note 2: You are responsible for advancing the reader to the
+	 * next element. Not doing anything will result in a never-ending loop.
+	 *
+	 * If you just want to skip parsing for this element altogether, you can
+	 * just call $reader->next();
+	 *
+	 * $reader->parseInnerTree() will parse the entire sub-tree, and advance to
+	 * the next element.
+	 *
+	 * @param Reader $reader
+	 * @return mixed
+	 */
+	static function xmlDeserialize(Reader $reader) {
+
+		$elementMap = [
+			'{DAV:}ace'       => 'Sabre\Xml\Element\KeyValue',
+			'{DAV:}privilege' => 'Sabre\Xml\Element\Elements',
+			'{DAV:}principal' => 'Sabre\DAVACL\Xml\Property\Principal',
+		];
+
+		$privileges = [];
+
+		foreach ((array)$reader->parseInnerTree($elementMap) as $element) {
+
+			if ($element['name'] !== '{DAV:}ace') {
+				continue;
+			}
+			$ace = $element['value'];
+
+			if (empty($ace['{DAV:}principal'])) {
+				throw new DAV\Exception\BadRequest('Each {DAV:}ace element must have one {DAV:}principal element');
+			}
+			$principal = $ace['{DAV:}principal'];
+
+			switch ($principal->getType()) {
+				case Principal::HREF :
+					$principal = $principal->getHref();
+					break;
+				case Principal::AUTHENTICATED :
+					$principal = '{DAV:}authenticated';
+					break;
+				case Principal::UNAUTHENTICATED :
+					$principal = '{DAV:}unauthenticated';
+					break;
+				case Principal::ALL :
+					$principal = '{DAV:}all';
+					break;
+
+			}
+
+			$protected = array_key_exists('{DAV:}protected', $ace);
+
+			if (!isset($ace['{DAV:}grant'])) {
+				throw new DAV\Exception\NotImplemented('Every {DAV:}ace element must have a {DAV:}grant element. {DAV:}deny is not yet supported');
+			}
+			foreach ($ace['{DAV:}grant'] as $elem) {
+				if ($elem['name'] !== '{DAV:}privilege') {
+					continue;
+				}
+
+				foreach ($elem['value'] as $priv) {
+					$privileges[] = [
+						'principal' => $principal,
+						'protected' => $protected,
+						'privilege' => $priv,
+					];
+				}
+
+			}
+
+		}
+
+		return new self($privileges);
+
+	}
+
+	/**
+	 * Serializes a single access control entry.
+	 *
+	 * @param Writer $writer
+	 * @param array $ace
+	 * @return void
+	 */
+	private function serializeAce(Writer $writer, array $ace) {
+
+		$writer->startElement('{DAV:}ace');
+
+		switch ($ace['principal']) {
+			case '{DAV:}authenticated' :
+				$principal = new Principal(Principal::AUTHENTICATED);
+				break;
+			case '{DAV:}unauthenticated' :
+				$principal = new Principal(Principal::UNAUTHENTICATED);
+				break;
+			case '{DAV:}all' :
+				$principal = new Principal(Principal::ALL);
+				break;
+			default:
+				$principal = new Principal(Principal::HREF, $ace['principal']);
+				break;
+		}
+
+		$writer->writeElement('{DAV:}principal', $principal);
+		$writer->startElement('{DAV:}grant');
+		$writer->startElement('{DAV:}privilege');
+
+		$writer->writeElement($ace['privilege']);
+
+		$writer->endElement(); // privilege
+		$writer->endElement(); // grant
+
+		if (!empty($ace['protected'])) {
+			$writer->writeElement('{DAV:}protected');
+		}
+
+		$writer->endElement(); // ace
+
+	}
 
 }

libraries/SabreDAV/DAVACL/Xml/Property/CurrentUserPrivilegeSet.php

Doc Comments +1 added lines, -1 removed lines

@@ -115,7 +115,7 @@
      * the next element.
      *
      * @param Reader $reader
-     * @return mixed
+     * @return CurrentUserPrivilegeSet
      */
     static function xmlDeserialize(Reader $reader) {
 

Indentation +134 added lines, -134 removed lines

@@ -20,140 +20,140 @@
  */
 class CurrentUserPrivilegeSet implements Element, HtmlOutput {
 
-    /**
-     * List of privileges
-     *
-     * @var array
-     */
-    private $privileges;
-
-    /**
-     * Creates the object
-     *
-     * Pass the privileges in clark-notation
-     *
-     * @param array $privileges
-     */
-    public function __construct(array $privileges) {
-
-        $this->privileges = $privileges;
-
-    }
-
-    /**
-     * The xmlSerialize metod is called during xml writing.
-     *
-     * Use the $writer argument to write its own xml serialization.
-     *
-     * An important note: do _not_ create a parent element. Any element
-     * implementing XmlSerializble should only ever write what's considered
-     * its 'inner xml'.
-     *
-     * The parent of the current element is responsible for writing a
-     * containing element.
-     *
-     * This allows serializers to be re-used for different element names.
-     *
-     * If you are opening new elements, you must also close them again.
-     *
-     * @param Writer $writer
-     * @return void
-     */
-    public function xmlSerialize(Writer $writer) {
-
-        foreach ($this->privileges as $privName) {
-
-            $writer->startElement('{DAV:}privilege');
-            $writer->writeElement($privName);
-            $writer->endElement();
-
-        }
-
-
-    }
-
-    /**
-     * Returns true or false, whether the specified principal appears in the
-     * list.
-     *
-     * @param string $privilegeName
-     * @return bool
-     */
-    public function has($privilegeName) {
-
-        return in_array($privilegeName, $this->privileges);
-
-    }
-
-    /**
-     * Returns the list of privileges.
-     *
-     * @return array
-     */
-    public function getValue() {
-
-        return $this->privileges;
-
-    }
-
-    /**
-     * The deserialize method is called during xml parsing.
-     *
-     * This method is called statictly, this is because in theory this method
-     * may be used as a type of constructor, or factory method.
-     *
-     * Often you want to return an instance of the current class, but you are
-     * free to return other data as well.
-     *
-     * You are responsible for advancing the reader to the next element. Not
-     * doing anything will result in a never-ending loop.
-     *
-     * If you just want to skip parsing for this element altogether, you can
-     * just call $reader->next();
-     *
-     * $reader->parseInnerTree() will parse the entire sub-tree, and advance to
-     * the next element.
-     *
-     * @param Reader $reader
-     * @return mixed
-     */
-    static function xmlDeserialize(Reader $reader) {
-
-        $result = [];
-
-        $tree = $reader->parseInnerTree(['{DAV:}privilege' => 'Sabre\\Xml\\Element\\Elements']);
-        foreach ($tree as $element) {
-            if ($element['name'] !== '{DAV:}privilege') {
-                continue;
-            }
-            $result[] = $element['value'][0];
-        }
-        return new self($result);
-
-    }
-
-    /**
-     * Generate html representation for this value.
-     *
-     * The html output is 100% trusted, and no effort is being made to sanitize
-     * it. It's up to the implementor to sanitize user provided values.
-     *
-     * The output must be in UTF-8.
-     *
-     * The baseUri parameter is a url to the root of the application, and can
-     * be used to construct local links.
-     *
-     * @param HtmlOutputHelper $html
-     * @return string
-     */
-    public function toHtml(HtmlOutputHelper $html) {
-
-        return implode(
-            ', ',
-            array_map([$html, 'xmlName'], $this->getValue())
-        );
-
-    }
+	/**
+	 * List of privileges
+	 *
+	 * @var array
+	 */
+	private $privileges;
+
+	/**
+	 * Creates the object
+	 *
+	 * Pass the privileges in clark-notation
+	 *
+	 * @param array $privileges
+	 */
+	public function __construct(array $privileges) {
+
+		$this->privileges = $privileges;
+
+	}
+
+	/**
+	 * The xmlSerialize metod is called during xml writing.
+	 *
+	 * Use the $writer argument to write its own xml serialization.
+	 *
+	 * An important note: do _not_ create a parent element. Any element
+	 * implementing XmlSerializble should only ever write what's considered
+	 * its 'inner xml'.
+	 *
+	 * The parent of the current element is responsible for writing a
+	 * containing element.
+	 *
+	 * This allows serializers to be re-used for different element names.
+	 *
+	 * If you are opening new elements, you must also close them again.
+	 *
+	 * @param Writer $writer
+	 * @return void
+	 */
+	public function xmlSerialize(Writer $writer) {
+
+		foreach ($this->privileges as $privName) {
+
+			$writer->startElement('{DAV:}privilege');
+			$writer->writeElement($privName);
+			$writer->endElement();
+
+		}
+
+
+	}
+
+	/**
+	 * Returns true or false, whether the specified principal appears in the
+	 * list.
+	 *
+	 * @param string $privilegeName
+	 * @return bool
+	 */
+	public function has($privilegeName) {
+
+		return in_array($privilegeName, $this->privileges);
+
+	}
+
+	/**
+	 * Returns the list of privileges.
+	 *
+	 * @return array
+	 */
+	public function getValue() {
+
+		return $this->privileges;
+
+	}
+
+	/**
+	 * The deserialize method is called during xml parsing.
+	 *
+	 * This method is called statictly, this is because in theory this method
+	 * may be used as a type of constructor, or factory method.
+	 *
+	 * Often you want to return an instance of the current class, but you are
+	 * free to return other data as well.
+	 *
+	 * You are responsible for advancing the reader to the next element. Not
+	 * doing anything will result in a never-ending loop.
+	 *
+	 * If you just want to skip parsing for this element altogether, you can
+	 * just call $reader->next();
+	 *
+	 * $reader->parseInnerTree() will parse the entire sub-tree, and advance to
+	 * the next element.
+	 *
+	 * @param Reader $reader
+	 * @return mixed
+	 */
+	static function xmlDeserialize(Reader $reader) {
+
+		$result = [];
+
+		$tree = $reader->parseInnerTree(['{DAV:}privilege' => 'Sabre\\Xml\\Element\\Elements']);
+		foreach ($tree as $element) {
+			if ($element['name'] !== '{DAV:}privilege') {
+				continue;
+			}
+			$result[] = $element['value'][0];
+		}
+		return new self($result);
+
+	}
+
+	/**
+	 * Generate html representation for this value.
+	 *
+	 * The html output is 100% trusted, and no effort is being made to sanitize
+	 * it. It's up to the implementor to sanitize user provided values.
+	 *
+	 * The output must be in UTF-8.
+	 *
+	 * The baseUri parameter is a url to the root of the application, and can
+	 * be used to construct local links.
+	 *
+	 * @param HtmlOutputHelper $html
+	 * @return string
+	 */
+	public function toHtml(HtmlOutputHelper $html) {
+
+		return implode(
+			', ',
+			array_map([$html, 'xmlName'], $this->getValue())
+		);
+
+	}
 
 
 }

libraries/SabreDAV/DAVACL/Xml/Property/Principal.php

Doc Comments +1 added lines, -1 removed lines

@@ -172,7 +172,7 @@
      * the next element.
      *
      * @param Reader $reader
-     * @return mixed
+     * @return Principal
      */
     static function xmlDeserialize(Reader $reader) {
 

Indentation +172 added lines, -172 removed lines

@@ -20,177 +20,177 @@
  */
 class Principal extends DAV\Xml\Property\Href {
 
-    /**
-     * To specify a not-logged-in user, use the UNAUTHENTICATED principal
-     */
-    const UNAUTHENTICATED = 1;
-
-    /**
-     * To specify any principal that is logged in, use AUTHENTICATED
-     */
-    const AUTHENTICATED = 2;
-
-    /**
-     * Specific principals can be specified with the HREF
-     */
-    const HREF = 3;
-
-    /**
-     * Everybody, basically
-     */
-    const ALL = 4;
-
-    /**
-     * Principal-type
-     *
-     * Must be one of the UNAUTHENTICATED, AUTHENTICATED or HREF constants.
-     *
-     * @var int
-     */
-    protected $type;
-
-    /**
-     * Creates the property.
-     *
-     * The 'type' argument must be one of the type constants defined in this class.
-     *
-     * 'href' is only required for the HREF type.
-     *
-     * @param int $type
-     * @param string|null $href
-     */
-    public function __construct($type, $href = null) {
-
-        $this->type = $type;
-        if ($type === self::HREF && is_null($href)) {
-            throw new DAV\Exception('The href argument must be specified for the HREF principal type.');
-        }
-        if ($href) {
-            $href = rtrim($href, '/') . '/';
-            parent::__construct($href);
-        }
-
-    }
-
-    /**
-     * Returns the principal type
-     *
-     * @return int
-     */
-    public function getType() {
-
-        return $this->type;
-
-    }
-
-
-    /**
-     * The xmlSerialize metod is called during xml writing.
-     *
-     * Use the $writer argument to write its own xml serialization.
-     *
-     * An important note: do _not_ create a parent element. Any element
-     * implementing XmlSerializble should only ever write what's considered
-     * its 'inner xml'.
-     *
-     * The parent of the current element is responsible for writing a
-     * containing element.
-     *
-     * This allows serializers to be re-used for different element names.
-     *
-     * If you are opening new elements, you must also close them again.
-     *
-     * @param Writer $writer
-     * @return void
-     */
-    public function xmlSerialize(Writer $writer) {
-
-        switch ($this->type) {
-
-            case self::UNAUTHENTICATED :
-                $writer->writeElement('{DAV:}unauthenticated');
-                break;
-            case self::AUTHENTICATED :
-                $writer->writeElement('{DAV:}authenticated');
-                break;
-            case self::HREF :
-                parent::xmlSerialize($writer);
-                break;
-            case self::ALL :
-                $writer->writeElement('{DAV:}all');
-                break;
-        }
-
-    }
-
-    /**
-     * Generate html representation for this value.
-     *
-     * The html output is 100% trusted, and no effort is being made to sanitize
-     * it. It's up to the implementor to sanitize user provided values.
-     *
-     * The output must be in UTF-8.
-     *
-     * The baseUri parameter is a url to the root of the application, and can
-     * be used to construct local links.
-     *
-     * @param HtmlOutputHelper $html
-     * @return string
-     */
-    public function toHtml(HtmlOutputHelper $html) {
-
-        switch ($this->type) {
-
-            case self::UNAUTHENTICATED :
-                return '<em>unauthenticated</em>';
-            case self::AUTHENTICATED :
-                return '<em>authenticated</em>';
-            case self::HREF :
-                return parent::toHtml($html);
-            case self::ALL :
-                return '<em>all</em>';
-        }
-
-    }
-
-    /**
-     * The deserialize method is called during xml parsing.
-     *
-     * This method is called staticly, this is because in theory this method
-     * may be used as a type of constructor, or factory method.
-     *
-     * Often you want to return an instance of the current class, but you are
-     * free to return other data as well.
-     *
-     * Important note 2: You are responsible for advancing the reader to the
-     * next element. Not doing anything will result in a never-ending loop.
-     *
-     * If you just want to skip parsing for this element altogether, you can
-     * just call $reader->next();
-     *
-     * $reader->parseInnerTree() will parse the entire sub-tree, and advance to
-     * the next element.
-     *
-     * @param Reader $reader
-     * @return mixed
-     */
-    static function xmlDeserialize(Reader $reader) {
-
-        $tree = $reader->parseInnerTree()[0];
-
-        switch ($tree['name']) {
-            case '{DAV:}unauthenticated' :
-                return new self(self::UNAUTHENTICATED);
-            case '{DAV:}authenticated' :
-                return new self(self::AUTHENTICATED);
-            case '{DAV:}href':
-                return new self(self::HREF, $tree['value']);
-            case '{DAV:}all':
-                return new self(self::ALL);
-            default :
-                throw new BadRequest('Unknown or unsupported principal type: ' . $tree['name']);
-        }
-
-    }
+	/**
+	 * To specify a not-logged-in user, use the UNAUTHENTICATED principal
+	 */
+	const UNAUTHENTICATED = 1;
+
+	/**
+	 * To specify any principal that is logged in, use AUTHENTICATED
+	 */
+	const AUTHENTICATED = 2;
+
+	/**
+	 * Specific principals can be specified with the HREF
+	 */
+	const HREF = 3;
+
+	/**
+	 * Everybody, basically
+	 */
+	const ALL = 4;
+
+	/**
+	 * Principal-type
+	 *
+	 * Must be one of the UNAUTHENTICATED, AUTHENTICATED or HREF constants.
+	 *
+	 * @var int
+	 */
+	protected $type;
+
+	/**
+	 * Creates the property.
+	 *
+	 * The 'type' argument must be one of the type constants defined in this class.
+	 *
+	 * 'href' is only required for the HREF type.
+	 *
+	 * @param int $type
+	 * @param string|null $href
+	 */
+	public function __construct($type, $href = null) {
+
+		$this->type = $type;
+		if ($type === self::HREF && is_null($href)) {
+			throw new DAV\Exception('The href argument must be specified for the HREF principal type.');
+		}
+		if ($href) {
+			$href = rtrim($href, '/') . '/';
+			parent::__construct($href);
+		}
+
+	}
+
+	/**
+	 * Returns the principal type
+	 *
+	 * @return int
+	 */
+	public function getType() {
+
+		return $this->type;
+
+	}
+
+
+	/**
+	 * The xmlSerialize metod is called during xml writing.
+	 *
+	 * Use the $writer argument to write its own xml serialization.
+	 *
+	 * An important note: do _not_ create a parent element. Any element
+	 * implementing XmlSerializble should only ever write what's considered
+	 * its 'inner xml'.
+	 *
+	 * The parent of the current element is responsible for writing a
+	 * containing element.
+	 *
+	 * This allows serializers to be re-used for different element names.
+	 *
+	 * If you are opening new elements, you must also close them again.
+	 *
+	 * @param Writer $writer
+	 * @return void
+	 */
+	public function xmlSerialize(Writer $writer) {
+
+		switch ($this->type) {
+
+			case self::UNAUTHENTICATED :
+				$writer->writeElement('{DAV:}unauthenticated');
+				break;
+			case self::AUTHENTICATED :
+				$writer->writeElement('{DAV:}authenticated');
+				break;
+			case self::HREF :
+				parent::xmlSerialize($writer);
+				break;
+			case self::ALL :
+				$writer->writeElement('{DAV:}all');
+				break;
+		}
+
+	}
+
+	/**
+	 * Generate html representation for this value.
+	 *
+	 * The html output is 100% trusted, and no effort is being made to sanitize
+	 * it. It's up to the implementor to sanitize user provided values.
+	 *
+	 * The output must be in UTF-8.
+	 *
+	 * The baseUri parameter is a url to the root of the application, and can
+	 * be used to construct local links.
+	 *
+	 * @param HtmlOutputHelper $html
+	 * @return string
+	 */
+	public function toHtml(HtmlOutputHelper $html) {
+
+		switch ($this->type) {
+
+			case self::UNAUTHENTICATED :
+				return '<em>unauthenticated</em>';
+			case self::AUTHENTICATED :
+				return '<em>authenticated</em>';
+			case self::HREF :
+				return parent::toHtml($html);
+			case self::ALL :
+				return '<em>all</em>';
+		}
+
+	}
+
+	/**
+	 * The deserialize method is called during xml parsing.
+	 *
+	 * This method is called staticly, this is because in theory this method
+	 * may be used as a type of constructor, or factory method.
+	 *
+	 * Often you want to return an instance of the current class, but you are
+	 * free to return other data as well.
+	 *
+	 * Important note 2: You are responsible for advancing the reader to the
+	 * next element. Not doing anything will result in a never-ending loop.
+	 *
+	 * If you just want to skip parsing for this element altogether, you can
+	 * just call $reader->next();
+	 *
+	 * $reader->parseInnerTree() will parse the entire sub-tree, and advance to
+	 * the next element.
+	 *
+	 * @param Reader $reader
+	 * @return mixed
+	 */
+	static function xmlDeserialize(Reader $reader) {
+
+		$tree = $reader->parseInnerTree()[0];
+
+		switch ($tree['name']) {
+			case '{DAV:}unauthenticated' :
+				return new self(self::UNAUTHENTICATED);
+			case '{DAV:}authenticated' :
+				return new self(self::AUTHENTICATED);
+			case '{DAV:}href':
+				return new self(self::HREF, $tree['value']);
+			case '{DAV:}all':
+				return new self(self::ALL);
+			default :
+				throw new BadRequest('Unknown or unsupported principal type: ' . $tree['name']);
+		}
+
+	}
 
 }