EGroupware / egroupware

api/src/WebDAV/Server/Filesystem.php

Indentation +827 added lines, -827 removed lines

@@ -44,793 +44,793 @@ 
  */
 class HTTP_WebDAV_Server_Filesystem extends HTTP_WebDAV_Server
 {
-    /**
-     * Root directory for WebDAV access
-     *
-     * Defaults to webserver document root (set by ServeRequest)
-     *
-     * @access private
-     * @var    string
-     */
-    var $base = "";
-
-    /**
-     * MySQL Host where property and locking information is stored
-     *
-     * @access private
-     * @var    string
-     */
-    var $db_host = "localhost";
-
-    /**
-     * MySQL database for property/locking information storage
-     *
-     * @access private
-     * @var    string
-     */
-    var $db_name = "webdav";
-
-    /**
-     * MySQL table name prefix
-     *
-     * @access private
-     * @var    string
-     */
-    var $db_prefix = "";
-
-    /**
-     * MySQL user for property/locking db access
-     *
-     * @access private
-     * @var    string
-     */
-    var $db_user = "root";
-
-    /**
-     * MySQL password for property/locking db access
-     *
-     * @access private
-     * @var    string
-     */
-    var $db_passwd = "";
-
-    /**
-     * Serve a webdav request
-     *
-     * @access public
-     * @param  string
-     */
-    function ServeRequest($base = false)
-    {
-        // special treatment for litmus compliance test
-        // reply on its identifier header
-        // not needed for the test itself but eases debugging
-        if (isset($this->_SERVER['HTTP_X_LITMUS'])) {
-            error_log("Litmus test ".$this->_SERVER['HTTP_X_LITMUS']);
-            header("X-Litmus-reply: ".$this->_SERVER['HTTP_X_LITMUS']);
-        }
-
-        // set root directory, defaults to webserver document root if not set
-        if ($base) {
-            $this->base = realpath($base); // TODO throw if not a directory
-        } else if (!$this->base) {
-            $this->base = $this->_SERVER['DOCUMENT_ROOT'];
-        }
-
-        // establish connection to property/locking db
-        mysql_connect($this->db_host, $this->db_user, $this->db_passwd) or die(mysql_error());
-        mysql_select_db($this->db_name) or die(mysql_error());
-        // TODO throw on connection problems
-
-        // let the base class do all the work
-        parent::ServeRequest();
-    }
-
-    /**
-     * No authentication is needed here
-     *
-     * @access private
-     * @param  string  HTTP Authentication type (Basic, Digest, ...)
-     * @param  string  Username
-     * @param  string  Password
-     * @return bool    true on successful authentication
-     */
-    function check_auth($type, $user, $pass)
-    {
-        return true;
-    }
-
-
-    /**
-     * PROPFIND method handler
-     *
-     * @param  array  general parameter passing array
-     * @param  array  return array for file properties
-     * @return bool   true on success
-     */
-    function PROPFIND(&$options, &$files)
-    {
-        // get absolute fs path to requested resource
-        $fspath = $this->base . $options["path"];
-
-        // sanity check
-        if (!file_exists($fspath)) {
-            return false;
-        }
-
-        // prepare property array
-        $files["files"] = array();
-
-        // store information for the requested path itself
-        $files["files"][] = $this->fileinfo($options["path"]);
-
-        // information for contained resources requested?
-        if (!empty($options["depth"]) && is_dir($fspath) && $this->_is_readable($fspath)) {
-
-            // make sure path ends with '/'
-            $options["path"] = $this->_slashify($options["path"]);
-
-            // try to open directory
-            $handle = opendir($fspath);
-
-            if ($handle) {
-                // ok, now get all its contents
-                while ($filename = readdir($handle)) {
-                    if ($filename != "." && $filename != "..") {
-                        $files["files"][] = $this->fileinfo($options["path"].$filename);
-                    }
-                }
-                // TODO recursion needed if "Depth: infinite"
-            	closedir($handle);
-            }
-        }
-
-        // ok, all done
-        return true;
-    }
-
-    /**
-     * Get properties for a single file/resource
-     *
-     * @param  string  resource path
-     * @return array   resource properties
-     */
-    function fileinfo($path)
-    {
-        // map URI path to filesystem path
-        $fspath = $this->base . $path;
-
-        // create result array
-        $info = array();
-        // TODO remove slash append code when base clase is able to do it itself
-        $info["path"]  = is_dir($fspath) ? $this->_slashify($path) : $path;
-        $info["props"] = array();
-
-        // no special beautified displayname here ...
-        $info["props"][] = $this->mkprop("displayname", strtoupper($path));
-
-        // creation and modification time
-        $info["props"][] = $this->mkprop("creationdate",    filectime($fspath));
-        $info["props"][] = $this->mkprop("getlastmodified", filemtime($fspath));
-
-        // Microsoft extensions: last access time and 'hidden' status
-        $info["props"][] = $this->mkprop("lastaccessed",    fileatime($fspath));
-        $info["props"][] = $this->mkprop("ishidden", ('.' === substr(basename($fspath), 0, 1)));
-
-        // type and size (caller already made sure that path exists)
-        if (is_dir($fspath)) {
-            // directory (WebDAV collection)
-            $info["props"][] = $this->mkprop("resourcetype", "collection");
-            $info["props"][] = $this->mkprop("getcontenttype", "httpd/unix-directory");
-        } else {
-            // plain file (WebDAV resource)
-            $info["props"][] = $this->mkprop("resourcetype", "");
-            if ($this->_is_readable($fspath)) {
-                $info["props"][] = $this->mkprop("getcontenttype", $this->_mimetype($fspath));
-            } else {
-                $info["props"][] = $this->mkprop("getcontenttype", "application/x-non-readable");
-            }
-            $info["props"][] = $this->mkprop("getcontentlength", filesize($fspath));
-        }
-
-        // get additional properties from database
-        $query = "SELECT ns, name, value
+	/**
+	 * Root directory for WebDAV access
+	 *
+	 * Defaults to webserver document root (set by ServeRequest)
+	 *
+	 * @access private
+	 * @var    string
+	 */
+	var $base = "";
+
+	/**
+	 * MySQL Host where property and locking information is stored
+	 *
+	 * @access private
+	 * @var    string
+	 */
+	var $db_host = "localhost";
+
+	/**
+	 * MySQL database for property/locking information storage
+	 *
+	 * @access private
+	 * @var    string
+	 */
+	var $db_name = "webdav";
+
+	/**
+	 * MySQL table name prefix
+	 *
+	 * @access private
+	 * @var    string
+	 */
+	var $db_prefix = "";
+
+	/**
+	 * MySQL user for property/locking db access
+	 *
+	 * @access private
+	 * @var    string
+	 */
+	var $db_user = "root";
+
+	/**
+	 * MySQL password for property/locking db access
+	 *
+	 * @access private
+	 * @var    string
+	 */
+	var $db_passwd = "";
+
+	/**
+	 * Serve a webdav request
+	 *
+	 * @access public
+	 * @param  string
+	 */
+	function ServeRequest($base = false)
+	{
+		// special treatment for litmus compliance test
+		// reply on its identifier header
+		// not needed for the test itself but eases debugging
+		if (isset($this->_SERVER['HTTP_X_LITMUS'])) {
+			error_log("Litmus test ".$this->_SERVER['HTTP_X_LITMUS']);
+			header("X-Litmus-reply: ".$this->_SERVER['HTTP_X_LITMUS']);
+		}
+
+		// set root directory, defaults to webserver document root if not set
+		if ($base) {
+			$this->base = realpath($base); // TODO throw if not a directory
+		} else if (!$this->base) {
+			$this->base = $this->_SERVER['DOCUMENT_ROOT'];
+		}
+
+		// establish connection to property/locking db
+		mysql_connect($this->db_host, $this->db_user, $this->db_passwd) or die(mysql_error());
+		mysql_select_db($this->db_name) or die(mysql_error());
+		// TODO throw on connection problems
+
+		// let the base class do all the work
+		parent::ServeRequest();
+	}
+
+	/**
+	 * No authentication is needed here
+	 *
+	 * @access private
+	 * @param  string  HTTP Authentication type (Basic, Digest, ...)
+	 * @param  string  Username
+	 * @param  string  Password
+	 * @return bool    true on successful authentication
+	 */
+	function check_auth($type, $user, $pass)
+	{
+		return true;
+	}
+
+
+	/**
+	 * PROPFIND method handler
+	 *
+	 * @param  array  general parameter passing array
+	 * @param  array  return array for file properties
+	 * @return bool   true on success
+	 */
+	function PROPFIND(&$options, &$files)
+	{
+		// get absolute fs path to requested resource
+		$fspath = $this->base . $options["path"];
+
+		// sanity check
+		if (!file_exists($fspath)) {
+			return false;
+		}
+
+		// prepare property array
+		$files["files"] = array();
+
+		// store information for the requested path itself
+		$files["files"][] = $this->fileinfo($options["path"]);
+
+		// information for contained resources requested?
+		if (!empty($options["depth"]) && is_dir($fspath) && $this->_is_readable($fspath)) {
+
+			// make sure path ends with '/'
+			$options["path"] = $this->_slashify($options["path"]);
+
+			// try to open directory
+			$handle = opendir($fspath);
+
+			if ($handle) {
+				// ok, now get all its contents
+				while ($filename = readdir($handle)) {
+					if ($filename != "." && $filename != "..") {
+						$files["files"][] = $this->fileinfo($options["path"].$filename);
+					}
+				}
+				// TODO recursion needed if "Depth: infinite"
+				closedir($handle);
+			}
+		}
+
+		// ok, all done
+		return true;
+	}
+
+	/**
+	 * Get properties for a single file/resource
+	 *
+	 * @param  string  resource path
+	 * @return array   resource properties
+	 */
+	function fileinfo($path)
+	{
+		// map URI path to filesystem path
+		$fspath = $this->base . $path;
+
+		// create result array
+		$info = array();
+		// TODO remove slash append code when base clase is able to do it itself
+		$info["path"]  = is_dir($fspath) ? $this->_slashify($path) : $path;
+		$info["props"] = array();
+
+		// no special beautified displayname here ...
+		$info["props"][] = $this->mkprop("displayname", strtoupper($path));
+
+		// creation and modification time
+		$info["props"][] = $this->mkprop("creationdate",    filectime($fspath));
+		$info["props"][] = $this->mkprop("getlastmodified", filemtime($fspath));
+
+		// Microsoft extensions: last access time and 'hidden' status
+		$info["props"][] = $this->mkprop("lastaccessed",    fileatime($fspath));
+		$info["props"][] = $this->mkprop("ishidden", ('.' === substr(basename($fspath), 0, 1)));
+
+		// type and size (caller already made sure that path exists)
+		if (is_dir($fspath)) {
+			// directory (WebDAV collection)
+			$info["props"][] = $this->mkprop("resourcetype", "collection");
+			$info["props"][] = $this->mkprop("getcontenttype", "httpd/unix-directory");
+		} else {
+			// plain file (WebDAV resource)
+			$info["props"][] = $this->mkprop("resourcetype", "");
+			if ($this->_is_readable($fspath)) {
+				$info["props"][] = $this->mkprop("getcontenttype", $this->_mimetype($fspath));
+			} else {
+				$info["props"][] = $this->mkprop("getcontenttype", "application/x-non-readable");
+			}
+			$info["props"][] = $this->mkprop("getcontentlength", filesize($fspath));
+		}
+
+		// get additional properties from database
+		$query = "SELECT ns, name, value
                         FROM {$this->db_prefix}properties
                        WHERE path = '$path'";
-        $res = mysql_query($query);
-        while ($row = mysql_fetch_assoc($res)) {
-            $info["props"][] = $this->mkprop($row["ns"], $row["name"], $row["value"]);
-        }
-        mysql_free_result($res);
-
-        return $info;
-    }
-
-    /**
-     * detect if a given program is found in the search PATH
-     *
-     * helper function used by _mimetype() to detect if the
-     * external 'file' utility is available
-     *
-     * @param  string  program name
-     * @param  string  optional search path, defaults to $PATH
-     * @return bool    true if executable program found in path
-     */
-    function _can_execute($name, $path = false)
-    {
-        // path defaults to PATH from environment if not set
-        if ($path === false) {
-            $path = getenv("PATH");
-        }
-
-        // check method depends on operating system
-        if (!strncmp(PHP_OS, "WIN", 3)) {
-            // on Windows an appropriate COM or EXE file needs to exist
-            $exts     = array(".exe", ".com");
-            $check_fn = "file_exists";
-        } else {
-            // anywhere else we look for an executable file of that name
-            $exts     = array("");
-            $check_fn = "is_executable";
-        }
-
-        // now check the directories in the path for the program
-        foreach (explode(PATH_SEPARATOR, $path) as $dir) {
-            // skip invalid path entries
-            if (!file_exists($dir)) continue;
-            if (!is_dir($dir)) continue;
-
-            // and now look for the file
-            foreach ($exts as $ext) {
-                if ($check_fn("$dir/$name".$ext)) return true;
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * Check if path is readable by current user
-     *
-     * Allow extending classes to overwrite it
-     *
-     * @param string $fspath
-     * @return boolean
-     */
-    function _is_readable($fspath)
-    {
-    	return is_readable($fspath);
-    }
-
-    /**
-     * Check if path is writable by current user
-     *
-     * Allow extending classes to overwrite it
-     *
-     * @param string $fspath
-     * @return boolean
-     */
-    function _is_writable($fspath)
-    {
-    	return is_writable($fspath);
-    }
-
-    /**
-     * try to detect the mime type of a file
-     *
-     * @param  string  file path
-     * @return string  guessed mime type
-     */
-    function _mimetype($fspath)
-    {
-        if (is_dir($fspath)) {
-            // directories are easy
-            return "httpd/unix-directory";
-        } else if (function_exists("mime_content_type")) {
-            // use mime magic extension if available
-            $mime_type = mime_content_type($fspath);
-        } else if ($this->_can_execute("file")) {
-            // it looks like we have a 'file' command,
-            // lets see it it does have mime support
-            $fp    = popen("file -i '$fspath' 2>/dev/null", "r");
-            $reply = fgets($fp);
-            pclose($fp);
-
-            // popen will not return an error if the binary was not found
-            // and find may not have mime support using "-i"
-            // so we test the format of the returned string
-
-            // the reply begins with the requested filename
-            if (!strncmp($reply, "$fspath: ", strlen($fspath)+2)) {
-                $reply = substr($reply, strlen($fspath)+2);
-                // followed by the mime type (maybe including options)
-                if (preg_match('|^[[:alnum:]_-]+/[[:alnum:]_-]+;?.*|', $reply, $matches)) {
-                    $mime_type = $matches[0];
-                }
-            }
-        }
-
-        if (empty($mime_type)) {
-            // Fallback solution: try to guess the type by the file extension
-            // TODO: add more ...
-            // TODO: it has been suggested to delegate mimetype detection
-            //       to apache but this has at least three issues:
-            //       - works only with apache
-            //       - needs file to be within the document tree
-            //       - requires apache mod_magic
-            // TODO: can we use the registry for this on Windows?
-            //       OTOH if the server is Windos the clients are likely to
-            //       be Windows, too, and tend do ignore the Content-Type
-            //       anyway (overriding it with information taken from
-            //       the registry)
-            // TODO: have a seperate PEAR class for mimetype detection?
-            switch (strtolower(strrchr(basename($fspath), "."))) {
-            case ".html":
-                $mime_type = "text/html";
-                break;
-            case ".gif":
-                $mime_type = "image/gif";
-                break;
-            case ".jpg":
-                $mime_type = "image/jpeg";
-                break;
-            default:
-                $mime_type = "application/octet-stream";
-                break;
-            }
-        }
-
-        return $mime_type;
-    }
-
-    /**
-     * HEAD method handler
-     *
-     * @param  array  parameter passing array
-     * @return bool   true on success
-     */
-    function HEAD(&$options)
-    {
-        // get absolute fs path to requested resource
-        $fspath = $this->base . $options["path"];
-
-        // sanity check
-        if (!file_exists($fspath)) return false;
-
-        // detect resource type
-        $options['mimetype'] = $this->_mimetype($fspath);
-
-        // detect modification time
-        // see rfc2518, section 13.7
-        // some clients seem to treat this as a reverse rule
-        // requiering a Last-Modified header if the getlastmodified header was set
-        $options['mtime'] = filemtime($fspath);
-
-        // detect resource size
-        $options['size'] = filesize($fspath);
-
-        return true;
-    }
-
-    /**
-     * GET method handler
-     *
-     * @param  array  parameter passing array
-     * @return bool   true on success
-     */
-    function GET(&$options)
-    {
-        // get absolute fs path to requested resource
-        $fspath = $this->base . $options["path"];
-
-        // is this a collection?
-        if (is_dir($fspath)) {
-            return $this->GetDir($fspath, $options);
-        }
-
-        // the header output is the same as for HEAD
-        if (!$this->HEAD($options)) {
-            return false;
-        }
-
-        // no need to check result here, it is handled by the base class
-        $options['stream'] = fopen($fspath, "r");
-
-        return true;
-    }
-
-    /**
-     * GET method handler for directories
-     *
-     * This is a very simple mod_index lookalike.
-     * See RFC 2518, Section 8.4 on GET/HEAD for collections
-     *
-     * @param  string  directory path
-     * @return void    function has to handle HTTP response itself
-     */
-    function GetDir($fspath, &$options)
-    {
-        $path = $this->_slashify($options["path"]);
-        if ($path != $options["path"]) {
-            header("Location: ".$this->base_uri.$path);
-            exit;
-        }
-
-        // fixed width directory column format
-        $format = "%15s  %-19s  %-s\n";
-
-        if (!$this->_is_readable($fspath)) {
-            return false;
-        }
-
-        $handle = opendir($fspath);
-        if (!$handle) {
-            return false;
-        }
-
-        echo "<html><head><title>Index of ".htmlspecialchars(urldecode($options['path']))."</title></head>\n";
-
-        echo "<h1>Index of ".htmlspecialchars($options['path'])."</h1>\n";
-
-        echo "<pre>";
-        printf($format, "Size", "Last modified", "Filename");
-        echo "<hr>";
-
-        while ($filename = readdir($handle)) {
-            if ($filename != "." && $filename != "..") {
-                $fullpath = $fspath.$filename;
-                $name     = htmlspecialchars($filename);
-                printf($format,
-                       number_format(filesize($fullpath)),
-                       strftime("%Y-%m-%d %H:%M:%S", filemtime($fullpath)),
-                       '<a href="'.$name.'">'.urldecode($name).'</a>');
-            }
-        }
-
-        echo "</pre>";
-
-        closedir($handle);
-
-        echo "</html>\n";
-
-        exit;
-    }
-
-    /**
-     * PUT method handler
-     *
-     * @param  array  parameter passing array
-     * @return bool   true on success
-     */
-    function PUT(&$options)
-    {
-        $fspath = $this->base . $options["path"];
-
-        $dir = dirname($fspath);
-        if (!file_exists($dir) || !is_dir($dir)) {
-            return "409 Conflict"; // TODO right status code for both?
-        }
-
-        $options["new"] = ! file_exists($fspath);
-
-        if ($options["new"] && !$this->_is_writable($dir)) {
-            return "403 Forbidden";
-        }
-        if (!$options["new"] && !$this->_is_writable($fspath)) {
-            return "403 Forbidden";
-        }
-        if (!$options["new"] && is_dir($fspath)) {
-            return "403 Forbidden";
-        }
-
-        $fp = fopen($fspath, "w");
-
-        return $fp;
-    }
-
-
-    /**
-     * MKCOL method handler
-     *
-     * @param  array  general parameter passing array
-     * @return bool   true on success
-     */
-    function MKCOL($options)
-    {
-        $path   = $this->base .$options["path"];
-        $parent = dirname($path);
-        $name   = basename($path);
-
-        if (!file_exists($parent)) {
-            return "409 Conflict";
-        }
-
-        if (!is_dir($parent)) {
-            return "403 Forbidden";
-        }
-
-        if ( file_exists($parent."/".$name) ) {
-            return "405 Method not allowed";
-        }
-
-        if (!empty($this->_SERVER["CONTENT_LENGTH"])) { // no body parsing yet
-            return "415 Unsupported media type";
-        }
-
-        $stat = mkdir($parent."/".$name, 0777);
-        if (!$stat) {
-            return "403 Forbidden";
-        }
-
-        return ("201 Created");
-    }
-
-
-    /**
-     * DELETE method handler
-     *
-     * @param  array  general parameter passing array
-     * @return bool   true on success
-     */
-    function DELETE($options)
-    {
-        $path = $this->base . "/" .$options["path"];
-
-        if (!file_exists($path)) {
-            return "404 Not found";
-        }
-
-        if (is_dir($path)) {
-            $query = "DELETE FROM {$this->db_prefix}properties
+		$res = mysql_query($query);
+		while ($row = mysql_fetch_assoc($res)) {
+			$info["props"][] = $this->mkprop($row["ns"], $row["name"], $row["value"]);
+		}
+		mysql_free_result($res);
+
+		return $info;
+	}
+
+	/**
+	 * detect if a given program is found in the search PATH
+	 *
+	 * helper function used by _mimetype() to detect if the
+	 * external 'file' utility is available
+	 *
+	 * @param  string  program name
+	 * @param  string  optional search path, defaults to $PATH
+	 * @return bool    true if executable program found in path
+	 */
+	function _can_execute($name, $path = false)
+	{
+		// path defaults to PATH from environment if not set
+		if ($path === false) {
+			$path = getenv("PATH");
+		}
+
+		// check method depends on operating system
+		if (!strncmp(PHP_OS, "WIN", 3)) {
+			// on Windows an appropriate COM or EXE file needs to exist
+			$exts     = array(".exe", ".com");
+			$check_fn = "file_exists";
+		} else {
+			// anywhere else we look for an executable file of that name
+			$exts     = array("");
+			$check_fn = "is_executable";
+		}
+
+		// now check the directories in the path for the program
+		foreach (explode(PATH_SEPARATOR, $path) as $dir) {
+			// skip invalid path entries
+			if (!file_exists($dir)) continue;
+			if (!is_dir($dir)) continue;
+
+			// and now look for the file
+			foreach ($exts as $ext) {
+				if ($check_fn("$dir/$name".$ext)) return true;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * Check if path is readable by current user
+	 *
+	 * Allow extending classes to overwrite it
+	 *
+	 * @param string $fspath
+	 * @return boolean
+	 */
+	function _is_readable($fspath)
+	{
+		return is_readable($fspath);
+	}
+
+	/**
+	 * Check if path is writable by current user
+	 *
+	 * Allow extending classes to overwrite it
+	 *
+	 * @param string $fspath
+	 * @return boolean
+	 */
+	function _is_writable($fspath)
+	{
+		return is_writable($fspath);
+	}
+
+	/**
+	 * try to detect the mime type of a file
+	 *
+	 * @param  string  file path
+	 * @return string  guessed mime type
+	 */
+	function _mimetype($fspath)
+	{
+		if (is_dir($fspath)) {
+			// directories are easy
+			return "httpd/unix-directory";
+		} else if (function_exists("mime_content_type")) {
+			// use mime magic extension if available
+			$mime_type = mime_content_type($fspath);
+		} else if ($this->_can_execute("file")) {
+			// it looks like we have a 'file' command,
+			// lets see it it does have mime support
+			$fp    = popen("file -i '$fspath' 2>/dev/null", "r");
+			$reply = fgets($fp);
+			pclose($fp);
+
+			// popen will not return an error if the binary was not found
+			// and find may not have mime support using "-i"
+			// so we test the format of the returned string
+
+			// the reply begins with the requested filename
+			if (!strncmp($reply, "$fspath: ", strlen($fspath)+2)) {
+				$reply = substr($reply, strlen($fspath)+2);
+				// followed by the mime type (maybe including options)
+				if (preg_match('|^[[:alnum:]_-]+/[[:alnum:]_-]+;?.*|', $reply, $matches)) {
+					$mime_type = $matches[0];
+				}
+			}
+		}
+
+		if (empty($mime_type)) {
+			// Fallback solution: try to guess the type by the file extension
+			// TODO: add more ...
+			// TODO: it has been suggested to delegate mimetype detection
+			//       to apache but this has at least three issues:
+			//       - works only with apache
+			//       - needs file to be within the document tree
+			//       - requires apache mod_magic
+			// TODO: can we use the registry for this on Windows?
+			//       OTOH if the server is Windos the clients are likely to
+			//       be Windows, too, and tend do ignore the Content-Type
+			//       anyway (overriding it with information taken from
+			//       the registry)
+			// TODO: have a seperate PEAR class for mimetype detection?
+			switch (strtolower(strrchr(basename($fspath), "."))) {
+			case ".html":
+				$mime_type = "text/html";
+				break;
+			case ".gif":
+				$mime_type = "image/gif";
+				break;
+			case ".jpg":
+				$mime_type = "image/jpeg";
+				break;
+			default:
+				$mime_type = "application/octet-stream";
+				break;
+			}
+		}
+
+		return $mime_type;
+	}
+
+	/**
+	 * HEAD method handler
+	 *
+	 * @param  array  parameter passing array
+	 * @return bool   true on success
+	 */
+	function HEAD(&$options)
+	{
+		// get absolute fs path to requested resource
+		$fspath = $this->base . $options["path"];
+
+		// sanity check
+		if (!file_exists($fspath)) return false;
+
+		// detect resource type
+		$options['mimetype'] = $this->_mimetype($fspath);
+
+		// detect modification time
+		// see rfc2518, section 13.7
+		// some clients seem to treat this as a reverse rule
+		// requiering a Last-Modified header if the getlastmodified header was set
+		$options['mtime'] = filemtime($fspath);
+
+		// detect resource size
+		$options['size'] = filesize($fspath);
+
+		return true;
+	}
+
+	/**
+	 * GET method handler
+	 *
+	 * @param  array  parameter passing array
+	 * @return bool   true on success
+	 */
+	function GET(&$options)
+	{
+		// get absolute fs path to requested resource
+		$fspath = $this->base . $options["path"];
+
+		// is this a collection?
+		if (is_dir($fspath)) {
+			return $this->GetDir($fspath, $options);
+		}
+
+		// the header output is the same as for HEAD
+		if (!$this->HEAD($options)) {
+			return false;
+		}
+
+		// no need to check result here, it is handled by the base class
+		$options['stream'] = fopen($fspath, "r");
+
+		return true;
+	}
+
+	/**
+	 * GET method handler for directories
+	 *
+	 * This is a very simple mod_index lookalike.
+	 * See RFC 2518, Section 8.4 on GET/HEAD for collections
+	 *
+	 * @param  string  directory path
+	 * @return void    function has to handle HTTP response itself
+	 */
+	function GetDir($fspath, &$options)
+	{
+		$path = $this->_slashify($options["path"]);
+		if ($path != $options["path"]) {
+			header("Location: ".$this->base_uri.$path);
+			exit;
+		}
+
+		// fixed width directory column format
+		$format = "%15s  %-19s  %-s\n";
+
+		if (!$this->_is_readable($fspath)) {
+			return false;
+		}
+
+		$handle = opendir($fspath);
+		if (!$handle) {
+			return false;
+		}
+
+		echo "<html><head><title>Index of ".htmlspecialchars(urldecode($options['path']))."</title></head>\n";
+
+		echo "<h1>Index of ".htmlspecialchars($options['path'])."</h1>\n";
+
+		echo "<pre>";
+		printf($format, "Size", "Last modified", "Filename");
+		echo "<hr>";
+
+		while ($filename = readdir($handle)) {
+			if ($filename != "." && $filename != "..") {
+				$fullpath = $fspath.$filename;
+				$name     = htmlspecialchars($filename);
+				printf($format,
+					   number_format(filesize($fullpath)),
+					   strftime("%Y-%m-%d %H:%M:%S", filemtime($fullpath)),
+					   '<a href="'.$name.'">'.urldecode($name).'</a>');
+			}
+		}
+
+		echo "</pre>";
+
+		closedir($handle);
+
+		echo "</html>\n";
+
+		exit;
+	}
+
+	/**
+	 * PUT method handler
+	 *
+	 * @param  array  parameter passing array
+	 * @return bool   true on success
+	 */
+	function PUT(&$options)
+	{
+		$fspath = $this->base . $options["path"];
+
+		$dir = dirname($fspath);
+		if (!file_exists($dir) || !is_dir($dir)) {
+			return "409 Conflict"; // TODO right status code for both?
+		}
+
+		$options["new"] = ! file_exists($fspath);
+
+		if ($options["new"] && !$this->_is_writable($dir)) {
+			return "403 Forbidden";
+		}
+		if (!$options["new"] && !$this->_is_writable($fspath)) {
+			return "403 Forbidden";
+		}
+		if (!$options["new"] && is_dir($fspath)) {
+			return "403 Forbidden";
+		}
+
+		$fp = fopen($fspath, "w");
+
+		return $fp;
+	}
+
+
+	/**
+	 * MKCOL method handler
+	 *
+	 * @param  array  general parameter passing array
+	 * @return bool   true on success
+	 */
+	function MKCOL($options)
+	{
+		$path   = $this->base .$options["path"];
+		$parent = dirname($path);
+		$name   = basename($path);
+
+		if (!file_exists($parent)) {
+			return "409 Conflict";
+		}
+
+		if (!is_dir($parent)) {
+			return "403 Forbidden";
+		}
+
+		if ( file_exists($parent."/".$name) ) {
+			return "405 Method not allowed";
+		}
+
+		if (!empty($this->_SERVER["CONTENT_LENGTH"])) { // no body parsing yet
+			return "415 Unsupported media type";
+		}
+
+		$stat = mkdir($parent."/".$name, 0777);
+		if (!$stat) {
+			return "403 Forbidden";
+		}
+
+		return ("201 Created");
+	}
+
+
+	/**
+	 * DELETE method handler
+	 *
+	 * @param  array  general parameter passing array
+	 * @return bool   true on success
+	 */
+	function DELETE($options)
+	{
+		$path = $this->base . "/" .$options["path"];
+
+		if (!file_exists($path)) {
+			return "404 Not found";
+		}
+
+		if (is_dir($path)) {
+			$query = "DELETE FROM {$this->db_prefix}properties
                            WHERE path LIKE '".$this->_slashify($options["path"])."%'";
-            mysql_query($query);
-            System::rm(array("-rf", $path));
-        } else {
-            unlink($path);
-        }
-        $query = "DELETE FROM {$this->db_prefix}properties
+			mysql_query($query);
+			System::rm(array("-rf", $path));
+		} else {
+			unlink($path);
+		}
+		$query = "DELETE FROM {$this->db_prefix}properties
                        WHERE path = '$options[path]'";
-        mysql_query($query);
-
-        return "204 No Content";
-    }
-
-
-    /**
-     * MOVE method handler
-     *
-     * @param  array  general parameter passing array
-     * @return bool   true on success
-     */
-    function MOVE($options)
-    {
-        return $this->COPY($options, true);
-    }
-
-    /**
-     * COPY method handler
-     *
-     * @param  array  general parameter passing array
-     * @return bool   true on success
-     */
-    function COPY($options, $del=false)
-    {
-        // TODO Property updates still broken (Litmus should detect this?)
-
-        if (!empty($this->_SERVER["CONTENT_LENGTH"])) { // no body parsing yet
-            return "415 Unsupported media type";
-        }
-
-        // no copying to different WebDAV Servers yet
-        if (isset($options["dest_url"])) {
-            return "502 bad gateway";
-        }
-
-        $source = $this->base . $options["path"];
-        if (!file_exists($source)) {
-            return "404 Not found";
-        }
-
-        if (is_dir($source)) { // resource is a collection
-            switch ($options["depth"]) {
-            case "infinity": // valid
-                break;
-            case "0": // valid for COPY only
-                if ($del) { // MOVE?
-                    return "400 Bad request";
-                }
-                break;
-            case "1": // invalid for both COPY and MOVE
-            default:
-                return "400 Bad request";
-            }
-        }
-
-        $dest         = $this->base . $options["dest"];
-        $destdir      = dirname($dest);
-
-        if (!file_exists($destdir) || !is_dir($destdir)) {
-            return "409 Conflict";
-        }
-
-
-        $new          = !file_exists($dest);
-        $existing_col = false;
-
-        if (!$new) {
-            if ($del && is_dir($dest)) {
-                if (!$options["overwrite"]) {
-                    return "412 precondition failed";
-                }
-                $dest .= basename($source);
-                if (file_exists($dest)) {
-                    $options["dest"] .= basename($source);
-                } else {
-                    $new          = true;
-                    $existing_col = true;
-                }
-            }
-        }
-
-        if (!$new) {
-            if ($options["overwrite"]) {
-                $stat = $this->DELETE(array("path" => $options["dest"]));
-                if (($stat{0} != "2") && (substr($stat, 0, 3) != "404")) {
-                    return $stat;
-                }
-            } else {
-                return "412 precondition failed";
-            }
-        }
-
-        if ($del) {
-            if (!rename($source, $dest)) {
-                return "500 Internal server error";
-            }
-            $destpath = $this->_unslashify($options["dest"]);
-            if (is_dir($source)) {
-                $query = "UPDATE {$this->db_prefix}properties
+		mysql_query($query);
+
+		return "204 No Content";
+	}
+
+
+	/**
+	 * MOVE method handler
+	 *
+	 * @param  array  general parameter passing array
+	 * @return bool   true on success
+	 */
+	function MOVE($options)
+	{
+		return $this->COPY($options, true);
+	}
+
+	/**
+	 * COPY method handler
+	 *
+	 * @param  array  general parameter passing array
+	 * @return bool   true on success
+	 */
+	function COPY($options, $del=false)
+	{
+		// TODO Property updates still broken (Litmus should detect this?)
+
+		if (!empty($this->_SERVER["CONTENT_LENGTH"])) { // no body parsing yet
+			return "415 Unsupported media type";
+		}
+
+		// no copying to different WebDAV Servers yet
+		if (isset($options["dest_url"])) {
+			return "502 bad gateway";
+		}
+
+		$source = $this->base . $options["path"];
+		if (!file_exists($source)) {
+			return "404 Not found";
+		}
+
+		if (is_dir($source)) { // resource is a collection
+			switch ($options["depth"]) {
+			case "infinity": // valid
+				break;
+			case "0": // valid for COPY only
+				if ($del) { // MOVE?
+					return "400 Bad request";
+				}
+				break;
+			case "1": // invalid for both COPY and MOVE
+			default:
+				return "400 Bad request";
+			}
+		}
+
+		$dest         = $this->base . $options["dest"];
+		$destdir      = dirname($dest);
+
+		if (!file_exists($destdir) || !is_dir($destdir)) {
+			return "409 Conflict";
+		}
+
+
+		$new          = !file_exists($dest);
+		$existing_col = false;
+
+		if (!$new) {
+			if ($del && is_dir($dest)) {
+				if (!$options["overwrite"]) {
+					return "412 precondition failed";
+				}
+				$dest .= basename($source);
+				if (file_exists($dest)) {
+					$options["dest"] .= basename($source);
+				} else {
+					$new          = true;
+					$existing_col = true;
+				}
+			}
+		}
+
+		if (!$new) {
+			if ($options["overwrite"]) {
+				$stat = $this->DELETE(array("path" => $options["dest"]));
+				if (($stat{0} != "2") && (substr($stat, 0, 3) != "404")) {
+					return $stat;
+				}
+			} else {
+				return "412 precondition failed";
+			}
+		}
+
+		if ($del) {
+			if (!rename($source, $dest)) {
+				return "500 Internal server error";
+			}
+			$destpath = $this->_unslashify($options["dest"]);
+			if (is_dir($source)) {
+				$query = "UPDATE {$this->db_prefix}properties
                                  SET path = REPLACE(path, '".$options["path"]."', '".$destpath."')
                                WHERE path LIKE '".$this->_slashify($options["path"])."%'";
-                mysql_query($query);
-            }
+				mysql_query($query);
+			}
 
-            $query = "UPDATE {$this->db_prefix}properties
+			$query = "UPDATE {$this->db_prefix}properties
                              SET path = '".$destpath."'
                            WHERE path = '".$options["path"]."'";
-            mysql_query($query);
-        } else {
-            if (is_dir($source) && $options["depth"] == "infinity") {	// no find for depth="0"
-                $files = System::find($source);
-                $files = array_reverse($files);
-            } else {
-                $files = array($source);
-            }
-
-            if (!is_array($files) || empty($files)) {
-                return "500 Internal server error";
-            }
-
-
-            foreach ($files as $file) {
-                if (is_dir($file)) {
-                    $file = $this->_slashify($file);
-                }
-
-                $destfile = str_replace($source, $dest, $file);
-
-                if (is_dir($file)) {
-                    if (!file_exists($destfile)) {
-                        if (!$this->_is_writable(dirname($destfile))) {
-                            return "403 Forbidden";
-                        }
-                        if (!mkdir($destfile)) {
-                            return "409 Conflict";
-                        }
-                    } else if (!is_dir($destfile)) {
-                        return "409 Conflict";
-                    }
-                } else {
-
-                    if (!copy($file, $destfile)) {
-                        return "409 Conflict";
-                    }
-                }
-            }
-
-            $query = "INSERT INTO {$this->db_prefix}properties
+			mysql_query($query);
+		} else {
+			if (is_dir($source) && $options["depth"] == "infinity") {	// no find for depth="0"
+				$files = System::find($source);
+				$files = array_reverse($files);
+			} else {
+				$files = array($source);
+			}
+
+			if (!is_array($files) || empty($files)) {
+				return "500 Internal server error";
+			}
+
+
+			foreach ($files as $file) {
+				if (is_dir($file)) {
+					$file = $this->_slashify($file);
+				}
+
+				$destfile = str_replace($source, $dest, $file);
+
+				if (is_dir($file)) {
+					if (!file_exists($destfile)) {
+						if (!$this->_is_writable(dirname($destfile))) {
+							return "403 Forbidden";
+						}
+						if (!mkdir($destfile)) {
+							return "409 Conflict";
+						}
+					} else if (!is_dir($destfile)) {
+						return "409 Conflict";
+					}
+				} else {
+
+					if (!copy($file, $destfile)) {
+						return "409 Conflict";
+					}
+				}
+			}
+
+			$query = "INSERT INTO {$this->db_prefix}properties
                                SELECT *
                                  FROM {$this->db_prefix}properties
                                 WHERE path = '".$options['path']."'";
-        }
-
-        return ($new && !$existing_col) ? "201 Created" : "204 No Content";
-    }
-
-    /**
-     * PROPPATCH method handler
-     *
-     * @param  array  general parameter passing array
-     * @return bool   true on success
-     */
-    function PROPPATCH(&$options)
-    {
-        global $prefs, $tab;
-
-        $msg  = "";
-        $path = $options["path"];
-        $dir  = dirname($path)."/";
-        $base = basename($path);
-
-        foreach ($options["props"] as $key => $prop) {
-            if ($prop["ns"] == "DAV:") {
-                $options["props"][$key]['status'] = "403 Forbidden";
-            } else {
-                if (isset($prop["val"])) {
-                    $query = "REPLACE INTO {$this->db_prefix}properties
+		}
+
+		return ($new && !$existing_col) ? "201 Created" : "204 No Content";
+	}
+
+	/**
+	 * PROPPATCH method handler
+	 *
+	 * @param  array  general parameter passing array
+	 * @return bool   true on success
+	 */
+	function PROPPATCH(&$options)
+	{
+		global $prefs, $tab;
+
+		$msg  = "";
+		$path = $options["path"];
+		$dir  = dirname($path)."/";
+		$base = basename($path);
+
+		foreach ($options["props"] as $key => $prop) {
+			if ($prop["ns"] == "DAV:") {
+				$options["props"][$key]['status'] = "403 Forbidden";
+			} else {
+				if (isset($prop["val"])) {
+					$query = "REPLACE INTO {$this->db_prefix}properties
                                            SET path = '$options[path]'
                                              , name = '$prop[name]'
                                              , ns= '$prop[ns]'
                                              , value = '$prop[val]'";
-                } else {
-                    $query = "DELETE FROM {$this->db_prefix}properties
+				} else {
+					$query = "DELETE FROM {$this->db_prefix}properties
                                         WHERE path = '$options[path]'
                                           AND name = '$prop[name]'
                                           AND ns = '$prop[ns]'";
-                }
-                mysql_query($query);
-            }
-        }
-
-        return "";
-    }
-
-
-    /**
-     * LOCK method handler
-     *
-     * @param  array  general parameter passing array
-     * @return bool   true on success
-     */
-    function LOCK(&$options)
-    {
-        // get absolute fs path to requested resource
-        $fspath = $this->base . $options["path"];
-
-        // TODO recursive locks on directories not supported yet
-        // makes litmus test "32. lock_collection" fail
-        if (is_dir($fspath) && !empty($options["depth"])) {
-            return "409 Conflict";
-        }
-
-        $options["timeout"] = time()+300; // 5min. hardcoded
-
-        if (isset($options["update"])) { // Lock Update
-            $where = "WHERE path = '$options[path]' AND token = '$options[update]'";
-
-            $query = "SELECT owner, exclusivelock FROM {$this->db_prefix}locks $where";
-            $res   = mysql_query($query);
-            $row   = mysql_fetch_assoc($res);
-            mysql_free_result($res);
-
-            if (is_array($row)) {
-                $query = "UPDATE {$this->db_prefix}locks
+				}
+				mysql_query($query);
+			}
+		}
+
+		return "";
+	}
+
+
+	/**
+	 * LOCK method handler
+	 *
+	 * @param  array  general parameter passing array
+	 * @return bool   true on success
+	 */
+	function LOCK(&$options)
+	{
+		// get absolute fs path to requested resource
+		$fspath = $this->base . $options["path"];
+
+		// TODO recursive locks on directories not supported yet
+		// makes litmus test "32. lock_collection" fail
+		if (is_dir($fspath) && !empty($options["depth"])) {
+			return "409 Conflict";
+		}
+
+		$options["timeout"] = time()+300; // 5min. hardcoded
+
+		if (isset($options["update"])) { // Lock Update
+			$where = "WHERE path = '$options[path]' AND token = '$options[update]'";
+
+			$query = "SELECT owner, exclusivelock FROM {$this->db_prefix}locks $where";
+			$res   = mysql_query($query);
+			$row   = mysql_fetch_assoc($res);
+			mysql_free_result($res);
+
+			if (is_array($row)) {
+				$query = "UPDATE {$this->db_prefix}locks
                                  SET expires = '$options[timeout]'
                                    , modified = ".time()."
                               $where";
-                mysql_query($query);
+				mysql_query($query);
 
-                $options['owner'] = $row['owner'];
-                $options['scope'] = $row["exclusivelock"] ? "exclusive" : "shared";
-                $options['type']  = $row["exclusivelock"] ? "write"     : "read";
+				$options['owner'] = $row['owner'];
+				$options['scope'] = $row["exclusivelock"] ? "exclusive" : "shared";
+				$options['type']  = $row["exclusivelock"] ? "write"     : "read";
 
-                return true;
-            } else {
-                return false;
-            }
-        }
+				return true;
+			} else {
+				return false;
+			}
+		}
 
-        $query = "INSERT INTO {$this->db_prefix}locks
+		$query = "INSERT INTO {$this->db_prefix}locks
                         SET token   = '$options[locktoken]'
                           , path    = '$options[path]'
                           , created = ".time()."
@@ -838,76 +838,76 @@ 
                           , owner   = '$options[owner]'
                           , expires = '$options[timeout]'
                           , exclusivelock  = " .($options['scope'] === "exclusive" ? "1" : "0")
-            ;
-        mysql_query($query);
-
-        return mysql_affected_rows() ? "200 OK" : "409 Conflict";
-    }
-
-    /**
-     * UNLOCK method handler
-     *
-     * @param  array  general parameter passing array
-     * @return bool   true on success
-     */
-    function UNLOCK(&$options)
-    {
-        $query = "DELETE FROM {$this->db_prefix}locks
+			;
+		mysql_query($query);
+
+		return mysql_affected_rows() ? "200 OK" : "409 Conflict";
+	}
+
+	/**
+	 * UNLOCK method handler
+	 *
+	 * @param  array  general parameter passing array
+	 * @return bool   true on success
+	 */
+	function UNLOCK(&$options)
+	{
+		$query = "DELETE FROM {$this->db_prefix}locks
                       WHERE path = '$options[path]'
                         AND token = '$options[token]'";
-        mysql_query($query);
-
-        return mysql_affected_rows() ? "204 No Content" : "409 Conflict";
-    }
-
-    /**
-     * checkLock() helper
-     *
-     * @param  string resource path to check for locks
-     * @return bool   true on success
-     */
-    function checkLock($path)
-    {
-        $result = false;
-
-        $query = "SELECT owner, token, created, modified, expires, exclusivelock
+		mysql_query($query);
+
+		return mysql_affected_rows() ? "204 No Content" : "409 Conflict";
+	}
+
+	/**
+	 * checkLock() helper
+	 *
+	 * @param  string resource path to check for locks
+	 * @return bool   true on success
+	 */
+	function checkLock($path)
+	{
+		$result = false;
+
+		$query = "SELECT owner, token, created, modified, expires, exclusivelock
                   FROM {$this->db_prefix}locks
                  WHERE path = '$path'
                ";
-        $res = mysql_query($query);
-
-        if ($res) {
-            $row = mysql_fetch_array($res);
-            mysql_free_result($res);
-
-            if ($row) {
-                $result = array( "type"    => "write",
-                                 "scope"   => $row["exclusivelock"] ? "exclusive" : "shared",
-                                 "depth"   => 0,
-                                 "owner"   => $row['owner'],
-                                 "token"   => $row['token'],
-                                 "created" => $row['created'],
-                                 "modified" => $row['modified'],
-                                 "expires" => $row['expires']
-                                 );
-            }
-        }
-
-        return $result;
-    }
-
-
-    /**
-     * create database tables for property and lock storage
-     *
-     * @param  void
-     * @return bool   true on success
-     */
-    function create_database()
-    {
-        // TODO
-        return false;
-    }
+		$res = mysql_query($query);
+
+		if ($res) {
+			$row = mysql_fetch_array($res);
+			mysql_free_result($res);
+
+			if ($row) {
+				$result = array( "type"    => "write",
+								 "scope"   => $row["exclusivelock"] ? "exclusive" : "shared",
+								 "depth"   => 0,
+								 "owner"   => $row['owner'],
+								 "token"   => $row['token'],
+								 "created" => $row['created'],
+								 "modified" => $row['modified'],
+								 "expires" => $row['expires']
+								 );
+			}
+		}
+
+		return $result;
+	}
+
+
+	/**
+	 * create database tables for property and lock storage
+	 *
+	 * @param  void
+	 * @return bool   true on success
+	 */
+	function create_database()
+	{
+		// TODO
+		return false;
+	}
 }
 
 

api/src/Contacts.php

Indentation +29 added lines, -29 removed lines

@@ -145,19 +145,19 @@ 
 	var $categories;
 
 	/**
-	* Tracking changes
-	*
-	* @var Contacts\Tracking
-	*/
+	 * Tracking changes
+	 *
+	 * @var Contacts\Tracking
+	 */
 	protected $tracking;
 
 	/**
-	* Keep deleted addresses, or really delete them
-	* Set in Admin -> Addressbook -> Site Configuration
-	* ''=really delete, 'history'=keep, only admins delete, 'userpurge'=keep, users delete
- 	*
-	* @var string
- 	*/
+	 * Keep deleted addresses, or really delete them
+	 * Set in Admin -> Addressbook -> Site Configuration
+	 * ''=really delete, 'history'=keep, only admins delete, 'userpurge'=keep, users delete
+	 *
+	 * @var string
+	 */
 	protected $delete_history = '';
 
 	/**
@@ -786,13 +786,13 @@ 
 	}
 
 	/**
-	* deletes contact in db
-	*
-	* @param mixed &$contact contact array with key id or (array of) id(s)
-	* @param boolean $deny_account_delete =true if true never allow to delete accounts
-	* @param int $check_etag =null
-	* @return boolean|int true on success or false on failiure, 0 if etag does not match
-	*/
+	 * deletes contact in db
+	 *
+	 * @param mixed &$contact contact array with key id or (array of) id(s)
+	 * @param boolean $deny_account_delete =true if true never allow to delete accounts
+	 * @param int $check_etag =null
+	 * @return boolean|int true on success or false on failiure, 0 if etag does not match
+	 */
 	function delete($contact,$deny_account_delete=true,$check_etag=null)
 	{
 		if (is_array($contact) && isset($contact['id']))
@@ -844,12 +844,12 @@ 
 	}
 
 	/**
-	* saves contact to db
-	*
-	* @param array &$contact contact array from etemplate::exec
-	* @param boolean $ignore_acl =false should the acl be checked or not
-	* @return int/string/boolean id on success, false on failure, the error-message is in $this->error
-	*/
+	 * saves contact to db
+	 *
+	 * @param array &$contact contact array from etemplate::exec
+	 * @param boolean $ignore_acl =false should the acl be checked or not
+	 * @return int/string/boolean id on success, false on failure, the error-message is in $this->error
+	 */
 	function save(&$contact,$ignore_acl=false)
 	{
 		// remember if we add or update a entry
@@ -1069,12 +1069,12 @@ 
 	}
 
 	/**
-	* reads contacts matched by key and puts all cols in the data array
-	*
-	* @param int|string $contact_id
-	* @param boolean $ignore_acl =false true: no acl check
-	* @return array|boolean array with contact data, null if not found or false on no view perms
-	*/
+	 * reads contacts matched by key and puts all cols in the data array
+	 *
+	 * @param int|string $contact_id
+	 * @param boolean $ignore_acl =false true: no acl check
+	 * @return array|boolean array with contact data, null if not found or false on no view perms
+	 */
 	function read($contact_id, $ignore_acl=false)
 	{
 		// get so_sql_cf to read private customfields too, if we ignore acl

api/src/Header/Authenticate.php

Indentation +12 added lines, -12 removed lines

@@ -255,20 +255,20 @@
 	 */
 	static public function parse_digest($txt)
 	{
-	    // protect against missing data
-	    $needed_parts = array('nonce'=>1, 'nc'=>1, 'cnonce'=>1, 'qop'=>1, 'username'=>1, 'uri'=>1, 'response'=>1);
-	    $data = array();
-	    $keys = implode('|', array_keys($needed_parts));
+		// protect against missing data
+		$needed_parts = array('nonce'=>1, 'nc'=>1, 'cnonce'=>1, 'qop'=>1, 'username'=>1, 'uri'=>1, 'response'=>1);
+		$data = array();
+		$keys = implode('|', array_keys($needed_parts));
 
 		$matches = null;
-	    preg_match_all('@(' . $keys . ')=(?:([\'"])([^\2]+?)\2|([^\s,]+))@', $txt, $matches, PREG_SET_ORDER);
+		preg_match_all('@(' . $keys . ')=(?:([\'"])([^\2]+?)\2|([^\s,]+))@', $txt, $matches, PREG_SET_ORDER);
 
-	    foreach ($matches as $m)
-	    {
-	        $data[$m[1]] = $m[3] ? $m[3] : $m[4];
-	        unset($needed_parts[$m[1]]);
-	    }
-	    //error_log(__METHOD__."('$txt') returning ".array2string($needed_parts ? false : $data));
-	    return $needed_parts ? false : $data;
+		foreach ($matches as $m)
+		{
+			$data[$m[1]] = $m[3] ? $m[3] : $m[4];
+			unset($needed_parts[$m[1]]);
+		}
+		//error_log(__METHOD__."('$txt') returning ".array2string($needed_parts ? false : $data));
+		return $needed_parts ? false : $data;
 	}
 }

api/src/Etemplate/Widget/Vfs.php

Indentation +7 added lines, -7 removed lines

@@ -224,13 +224,13 @@
 	}
 
 	/**
-	* Ajax callback to receive an incoming file
-	*
-	* The incoming file is automatically placed into the appropriate VFS location.
-	* If the entry is not yet created, the file information is stored into the widget's value.
-	* When the form is submitted, the information for all files uploaded is available in the returned
-	* $content array and the application should deal with the file.
-	*/
+	 * Ajax callback to receive an incoming file
+	 *
+	 * The incoming file is automatically placed into the appropriate VFS location.
+	 * If the entry is not yet created, the file information is stored into the widget's value.
+	 * When the form is submitted, the information for all files uploaded is available in the returned
+	 * $content array and the application should deal with the file.
+	 */
 	public static function store_file($path, $file)
 	{
 		$name = $_REQUEST['widget_id'];

api/src/Etemplate/Widget/File.php

Indentation +4 added lines, -4 removed lines

@@ -238,10 +238,10 @@
 	}
 
 	/**
-	* Delete a directory RECURSIVELY
-	* @param string $dir - directory path
-	* @link http://php.net/manual/en/function.rmdir.php
-	*/
+	 * Delete a directory RECURSIVELY
+	 * @param string $dir - directory path
+	 * @link http://php.net/manual/en/function.rmdir.php
+	 */
 	private static function rrmdir($dir)
 	{
 		if (is_dir($dir))

api/src/Etemplate/Widget/HistoryLog.php

Indentation +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
 	 * while it uses select-account for owner in historylog (containing all users).
 	 *
 	 * @param string $cname
-	*/
+	 */
 	public function beforeSendToClient($cname)
 	{
 		$form_name = self::form_name($cname, $this->id);

api/src/Etemplate/Widget.php

Indentation +6 added lines, -6 removed lines

@@ -903,12 +903,12 @@
 	}
 
 	/**
-	* Check if we have not ignored validation errors
-	*
-	* @param string $ignore_validation ='' if not empty regular expression for validation-errors to ignore
-	* @param string $cname =null name-prefix, which need to be ignored, default self::$name_vars
-	* @return boolean true if there are not ignored validation errors, false otherwise
-	*/
+	 * Check if we have not ignored validation errors
+	 *
+	 * @param string $ignore_validation ='' if not empty regular expression for validation-errors to ignore
+	 * @param string $cname =null name-prefix, which need to be ignored, default self::$name_vars
+	 * @return boolean true if there are not ignored validation errors, false otherwise
+	 */
 	public static function validation_errors($ignore_validation='',$cname='')
 	{
 		// not yet used: if (is_null($cname)) $cname = self::$name_vars;

api/src/Etemplate/WidgetBrowser.php

Indentation +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
 	{
 		$GLOBALS['egw_info']['flags']['currentapp'] = 'etemplate';
 		$GLOBALS['egw_info']['flags']['app_header'] = 'et2 Widgets';
-                //'js_link_registry'      => True,
+				//'js_link_registry'      => True,
 
 		// Widget browser code
 		Api\Framework::includeJS('/api/js/etemplate/widget_browser.js');

api/src/Accounts/Ads.php

Indentation +174 added lines, -174 removed lines

@@ -807,11 +807,11 @@ 
 	}
 
 	/**
-	* Add seconds between 1601-01-01 and 1970-01-01 and multiply by 10000000
-	*
-	* @param long $unixTime
-	* @return long windowsTime
-	*/
+	 * Add seconds between 1601-01-01 and 1970-01-01 and multiply by 10000000
+	 *
+	 * @param long $unixTime
+	 * @return long windowsTime
+	 */
 	public static function convertUnixTimeToWindowsTime($unixTime)
 	{
 		return ($unixTime + 11644477200) * 10000000;
@@ -1263,10 +1263,10 @@ 
 	}
 
 	/**
-    * Convert 8bit characters e.g. accented characters to UTF8 encoded characters
-    *
-    * Extended to use mbstring to convert from arbitrary charset to utf-8
-	*/
+	 * Convert 8bit characters e.g. accented characters to UTF8 encoded characters
+	 *
+	 * Extended to use mbstring to convert from arbitrary charset to utf-8
+	 */
 	protected function encode8Bit(&$item, $key)
 	{
 		if ($this->charset != 'utf-8' && $key != 'password')
@@ -1294,29 +1294,29 @@ 
 		return $this->userClass;
 	}
 
-    /**
-    * Get the group class interface
-    *
-    * @return adLDAPGroups
-    */
-    public function group() {
-        if (!$this->groupClass) {
-            $this->groupClass = new adLDAPGroups($this);
-        }
-        return $this->groupClass;
-    }
-
-    /**
-    * Get the utils class interface
-    *
-    * @return adLDAPUtils
-    */
-    public function utilities() {
-        if (!$this->utilClass) {
-            $this->utilClass = new adLDAPUtils($this);
-        }
-        return $this->utilClass;
-    }
+	/**
+	 * Get the group class interface
+	 *
+	 * @return adLDAPGroups
+	 */
+	public function group() {
+		if (!$this->groupClass) {
+			$this->groupClass = new adLDAPGroups($this);
+		}
+		return $this->groupClass;
+	}
+
+	/**
+	 * Get the utils class interface
+	 *
+	 * @return adLDAPUtils
+	 */
+	public function utilities() {
+		if (!$this->utilClass) {
+			$this->utilClass = new adLDAPUtils($this);
+		}
+		return $this->utilClass;
+	}
 }
 
 /**
@@ -1405,45 +1405,45 @@ 
 		return true;
 	}
 
-    /**
-    * Encode a password for transmission over LDAP
-    *
-    * Extended to use mbstring to convert from arbitrary charset to UTF-16LE
-    *
-    * @param string $password The password to encode
-    * @return string
-    */
-    public function encodePassword($password)
-    {
-        $password="\"".$password."\"";
-        if (function_exists('mb_convert_encoding'))
-        {
-            return mb_convert_encoding($password, 'UTF-16LE', $this->adldap->charset);
-        }
-        $encoded="";
-        for ($i=0; $i <strlen($password); $i++){ $encoded.="{$password{$i}}\000"; }
-        return $encoded;
-    }
-
-    /**
-     * Set a password
-     *
-     * Requires "Reset password" priviledges from bind user!
-     *
+	/**
+	 * Encode a password for transmission over LDAP
+	 *
+	 * Extended to use mbstring to convert from arbitrary charset to UTF-16LE
+	 *
+	 * @param string $password The password to encode
+	 * @return string
+	 */
+	public function encodePassword($password)
+	{
+		$password="\"".$password."\"";
+		if (function_exists('mb_convert_encoding'))
+		{
+			return mb_convert_encoding($password, 'UTF-16LE', $this->adldap->charset);
+		}
+		$encoded="";
+		for ($i=0; $i <strlen($password); $i++){ $encoded.="{$password{$i}}\000"; }
+		return $encoded;
+	}
+
+	/**
+	 * Set a password
+	 *
+	 * Requires "Reset password" priviledges from bind user!
+	 *
 	 * We can NOT set password with ldap_add or ldap_modify, it needs ldap_mod_replace, at least under Win2008r2!
 	 *
-     * @param string $dn
-     * @param string $password
-     * @return boolean
-     */
-    public function setPassword($dn, $password)
-    {
-    	$result = ldap_mod_replace($ds=$this->adldap->getLdapConnection(), $dn, array(
-    		'unicodePwd' => $this->encodePassword($password),
-    	));
-    	if (!$result) error_log(__METHOD__."('$dn', '$password') ldap_mod_replace($ds, '$dn', \$password) returned FALSE: ".ldap_error($ds));
-    	return $result;
-    }
+	 * @param string $dn
+	 * @param string $password
+	 * @return boolean
+	 */
+	public function setPassword($dn, $password)
+	{
+		$result = ldap_mod_replace($ds=$this->adldap->getLdapConnection(), $dn, array(
+			'unicodePwd' => $this->encodePassword($password),
+		));
+		if (!$result) error_log(__METHOD__."('$dn', '$password') ldap_mod_replace($ds, '$dn', \$password) returned FALSE: ".ldap_error($ds));
+		return $result;
+	}
 
 	/**
 	 * Check if we can to a real password change, not just a password reset
@@ -1457,30 +1457,30 @@ 
 		return function_exists('ldap_modify_batch');
 	}
 
-    /**
-    * Set the password of a user - This must be performed over SSL
-    *
-    * @param string $username The username to modify
-    * @param string $password The new password
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-	* @param string $old_password old password for password change, if supported
-    * @return bool
-    */
-    public function password($username, $password, $isGUID = false, $old_password=null)
-    {
-        if ($username === NULL) { return false; }
-        if ($password === NULL) { return false; }
-        if (!$this->adldap->getLdapBind()) { return false; }
-        if (!$this->adldap->getUseSSL() && !$this->adldap->getUseTLS()) {
-            throw new adLDAPException('SSL must be configured on your webserver and enabled in the class to set passwords.');
-        }
-
-        $userDn = $this->dn($username, $isGUID);
-        if ($userDn === false) {
-            return false;
-        }
-
-        $add=array();
+	/**
+	 * Set the password of a user - This must be performed over SSL
+	 *
+	 * @param string $username The username to modify
+	 * @param string $password The new password
+	 * @param bool $isGUID Is the username passed a GUID or a samAccountName
+	 * @param string $old_password old password for password change, if supported
+	 * @return bool
+	 */
+	public function password($username, $password, $isGUID = false, $old_password=null)
+	{
+		if ($username === NULL) { return false; }
+		if ($password === NULL) { return false; }
+		if (!$this->adldap->getLdapBind()) { return false; }
+		if (!$this->adldap->getUseSSL() && !$this->adldap->getUseTLS()) {
+			throw new adLDAPException('SSL must be configured on your webserver and enabled in the class to set passwords.');
+		}
+
+		$userDn = $this->dn($username, $isGUID);
+		if ($userDn === false) {
+			return false;
+		}
+
+		$add=array();
 
 		if (empty($old_password) || !function_exists('ldap_modify_batch')) {
 			$add["unicodePwd"][0] = $this->encodePassword($password);
@@ -1502,76 +1502,76 @@ 
 			);
 			$result = ldap_modify_batch($this->adldap->getLdapConnection(), $userDn, $mods);
 		}
-        if ($result === false){
-            $err = ldap_errno($this->adldap->getLdapConnection());
-            if ($err) {
-                $msg = 'Error ' . $err . ': ' . ldap_err2str($err) . '.';
-                if($err == 53) {
-                    $msg .= ' Your password might not match the password policy.';
-                }
-                throw new adLDAPException($msg);
-            }
-            else {
-                return false;
-            }
-        }
-
-        return true;
-    }
-
-    /**
-    * Modify a user
-    *
-    * @param string $username The username to query
-    * @param array $attributes The attributes to modify.  Note if you set the enabled attribute you must not specify any other attributes
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
-    public function modify($username, $attributes, $isGUID = false)
-    {
-        if ($username === NULL) { return "Missing compulsory field [username]"; }
-        if (array_key_exists("password", $attributes) && !$this->adldap->getUseSSL() && !$this->adldap->getUseTLS()) {
-            throw new adLDAPException('SSL/TLS must be configured on your webserver and enabled in the class to set passwords.');
-        }
-
-        // Find the dn of the user
-        $userDn = $this->dn($username, $isGUID);
-        if ($userDn === false) {
-            return false;
-        }
-
-        // Translate the update to the LDAP schema
-        $mod = $this->adldap->adldap_schema($attributes);
-
-        // Check to see if this is an enabled status update
-        if (!$mod && !array_key_exists("enabled", $attributes)){
-            return false;
-        }
-
-        // Set the account control attribute (only if specified)
-        if (array_key_exists("enabled", $attributes)){
-            if ($attributes["enabled"]){
-                $controlOptions = array("NORMAL_ACCOUNT");
-            }
-            else {
-                $controlOptions = array("NORMAL_ACCOUNT", "ACCOUNTDISABLE");
-            }
-            $mod["userAccountControl"][0] = $this->accountControl($controlOptions);
-        }
+		if ($result === false){
+			$err = ldap_errno($this->adldap->getLdapConnection());
+			if ($err) {
+				$msg = 'Error ' . $err . ': ' . ldap_err2str($err) . '.';
+				if($err == 53) {
+					$msg .= ' Your password might not match the password policy.';
+				}
+				throw new adLDAPException($msg);
+			}
+			else {
+				return false;
+			}
+		}
+
+		return true;
+	}
+
+	/**
+	 * Modify a user
+	 *
+	 * @param string $username The username to query
+	 * @param array $attributes The attributes to modify.  Note if you set the enabled attribute you must not specify any other attributes
+	 * @param bool $isGUID Is the username passed a GUID or a samAccountName
+	 * @return bool
+	 */
+	public function modify($username, $attributes, $isGUID = false)
+	{
+		if ($username === NULL) { return "Missing compulsory field [username]"; }
+		if (array_key_exists("password", $attributes) && !$this->adldap->getUseSSL() && !$this->adldap->getUseTLS()) {
+			throw new adLDAPException('SSL/TLS must be configured on your webserver and enabled in the class to set passwords.');
+		}
+
+		// Find the dn of the user
+		$userDn = $this->dn($username, $isGUID);
+		if ($userDn === false) {
+			return false;
+		}
+
+		// Translate the update to the LDAP schema
+		$mod = $this->adldap->adldap_schema($attributes);
+
+		// Check to see if this is an enabled status update
+		if (!$mod && !array_key_exists("enabled", $attributes)){
+			return false;
+		}
+
+		// Set the account control attribute (only if specified)
+		if (array_key_exists("enabled", $attributes)){
+			if ($attributes["enabled"]){
+				$controlOptions = array("NORMAL_ACCOUNT");
+			}
+			else {
+				$controlOptions = array("NORMAL_ACCOUNT", "ACCOUNTDISABLE");
+			}
+			$mod["userAccountControl"][0] = $this->accountControl($controlOptions);
+		}
 		// we can NOT set password with ldap_add or ldap_modify, it needs ldap_mod_replace, at least under Win2008r2
 		unset($mod['unicodePwd']);
 
 		if ($mod)
 		{
-	        // Do the update
-	        $result = @ldap_modify($ds=$this->adldap->getLdapConnection(), $userDn, $mod);
-	        if ($result == false) {
+			// Do the update
+			$result = @ldap_modify($ds=$this->adldap->getLdapConnection(), $userDn, $mod);
+			if ($result == false) {
 				if (isset($mod['unicodePwd'])) $mod['unicodePwd'] = '***';
 				error_log(__METHOD__."(".array2string($attributes).") ldap_modify($ds, '$userDn', ".array2string($mod).") returned ".array2string($result)." ldap_error()=".ldap_error($ds));
-	        	return false;
-	        }
+				return false;
+			}
 		}
-        if (array_key_exists("password",$attributes) && !$this->setPassword($userDn, $attributes['password']))
+		if (array_key_exists("password",$attributes) && !$this->setPassword($userDn, $attributes['password']))
 		{
 			return false;
 		}
@@ -1636,23 +1636,23 @@ 
 		return $this->adldap->encode8bit($item, $key);
 	}
 
-    /**
-    * Escape strings for the use in LDAP filters
-    *
-    * DEVELOPERS SHOULD BE DOING PROPER FILTERING IF THEY'RE ACCEPTING USER INPUT
-    * Ported from Perl's Net::LDAP::Util escape_filter_value
-    *
-    * @param string $str The string the parse
-    * @author Port by Andreas Gohr <andi@splitbrain.org>
-    * @return string
-    */
-    public function ldapSlashes($str){
-        return preg_replace_callback(
-      		'/([\x00-\x1F\*\(\)\\\\])/',
-        	function ($matches) {
-            	return "\\".join("", unpack("H2", $matches[1]));
-        	},
-        	$str
-    	);
-    }
+	/**
+	 * Escape strings for the use in LDAP filters
+	 *
+	 * DEVELOPERS SHOULD BE DOING PROPER FILTERING IF THEY'RE ACCEPTING USER INPUT
+	 * Ported from Perl's Net::LDAP::Util escape_filter_value
+	 *
+	 * @param string $str The string the parse
+	 * @author Port by Andreas Gohr <andi@splitbrain.org>
+	 * @return string
+	 */
+	public function ldapSlashes($str){
+		return preg_replace_callback(
+	  		'/([\x00-\x1F\*\(\)\\\\])/',
+			function ($matches) {
+				return "\\".join("", unpack("H2", $matches[1]));
+			},
+			$str
+		);
+	}
 }