/inc/HTTP/WebDAV/Server/Filesystem/MDB2.php
PHP | 685 lines | 357 code | 102 blank | 226 comment | 76 complexity | d7a0a9dee33f43c56b3fa27616910ac1 MD5 | raw file
Possible License(s): GPL-2.0, BSD-3-Clause, Apache-2.0, LGPL-2.1
- <?php
- require_once "HTTP/WebDAV/Server.php";
-
- /**
- * Filesystem access using WebDAV
- *
- * @access public
- */
- class HTTP_WebDAV_Server_Filesystem_MDB2 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 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
- /*
- removed by Bitflux, because, that's not needed here and
- apache_request_headers is not available everywhere
- foreach(apache_request_headers() as $key => $value) {
- if(stristr($key,"litmus")) {
- error_log("Litmus test $value");
- header("X-Litmus-reply: ".$value);
- }
- }
- */
- // 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 = $_SERVER['DOCUMENT_ROOT'];
- }
-
- // establish connection to property/locking db
- if (!$this->db) {
- $dsn = array(
- 'phptype'=>'sqlite',
- 'username' => 'dummy',
- 'password' => '',
- 'hostspec' => 'localhost',
- 'database' => 'webdavlocks'
- );
- $options = array(
- 'debug' => 10,
- 'database_path' => BX_DATA_DIR."/",
- 'database_extension' => '.db'
- );
-
- include_once("MDB2.php");
-
- $this->db = MDB2::connect($dsn,$options);
- if (MDB2::isError($this->db)) {
- die( $this->db->getMessage());
- }
- }
- //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"])) { // TODO check for is_dir() first?
-
- // make sure path ends with '/'
- if (substr($options["path"],-1) != "/") {
- $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"
- }
- }
- // 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();
- $info["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));
- // 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");
- $info["props"][] = $this->mkprop("getcontentlength", 0);
- } else {
- // plain file (WebDAV resource)
- $info["props"][] = $this->mkprop("resourcetype", "");
- if (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 properties WHERE path = '$path'";
- $res = $this->db->query($query);
- while($row = $res->fetchRow(MDB2_FETCHMODE_ASSOC)) {
- $info["props"][] = $this->mkprop($row["ns"], $row["name"], $row["value"]);
- }
- //mysql_free_result($res);
- $res->free();
- 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;
- }
-
- /**
- * 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 (ereg("^[[: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":
- case ".xhtml":
- $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;
- }
- /**
- * 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"];
- // 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);
-
- // no need to check result here, it is handled by the base class
- $options['stream'] = fopen($fspath, "r");
-
- return true;
- }
-
- /**
- * PUT method handler
- *
- * @param array parameter passing array
- * @return bool true on success
- */
- function PUT(&$options)
- {
- $fspath = $this->base . $options["path"];
- if(!@is_dir(dirname($fspath))) {
- return "409 Conflict";
- }
- $options["new"] = ! file_exists($fspath);
- $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($_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 properties WHERE path LIKE '$options[path]%'";
- $this->db->query($query);
- system("rm -rf $path");
- } else {
- unlink ($path);
- }
- $query = "DELETE FROM properties WHERE path = '$options[path]'";
- $this->db->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($_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";
- $dest = $this->base . $options["dest"];
- $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.basename($source))) {
- $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") return $stat;
- } else {
- return "412 precondition failed";
- }
- }
- if (is_dir($source)) {
- // RFC 2518 Section 9.2, last paragraph
- if ($options["depth"] != "infinity") {
- error_log("---- ".$options["depth"]);
- return "400 Bad request";
- }
- system(escapeshellcmd("cp -R ".escapeshellarg($source) ." " . escapeshellarg($dest)));
- if($del) {
- system(escapeshellcmd("rm -rf ".escapeshellarg($source)) );
- }
- } else {
- if($del) {
- @unlink($dest);
- $query = "DELETE FROM properties WHERE path = '$options[dest]'";
- $this->db->query($query);
- rename($source, $dest);
- $query = "UPDATE properties SET path = '$options[dest]' WHERE path = '$options[path]'";
- $this->db->query($query);
- } else {
- if(substr($dest,-1)=="/") $dest = substr($dest,0,-1);
- copy($source, $dest);
- }
- }
- 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($ns == "DAV:") {
- $options["props"][$key][$status] = "403 Forbidden";
- } else {
- $query = "DELETE FROM properties WHERE path = '$options[path]' AND name = '$prop[name]' AND ns = '$prop[ns]'";
- $this->db->query($query);
- if(isset($prop["val"])) {
- $query = "INSERT INTO properties (path,name,ns,value) VALUES ('$options[path]','$prop[name]','$prop[ns]', '$prop[val]')";
- }
- $this->db->query($query);
- }
- }
-
- return "";
- }
- /**
- * LOCK method handler
- *
- * @param array general parameter passing array
- * @return bool true on success
- */
- function lock(&$options)
- {
- $prefix = $GLOBALS['POOL']->config->getTablePrefix();
- if(isset($options["update"])) { // Lock Update
- $query = "UPDATE ".$prefix."locks SET expires = ".(time()+300);
- $affectedRows= $this->db->query($query);
- if( $affectedRows) {
- $options["timeout"] = 300; // 5min hardcoded
- return true;
- } else {
- return false;
- }
- }
-
- $options["timeout"] = time()+300; // 5min. hardcoded
- $query = "INSERT INTO ".$prefix."locks
- SET token = '$options[locktoken]'
- , path = '$options[path]'
- , owner = '$options[owner]'
- , expires = '$options[timeout]'
- , exclusivelock = " .($options['scope'] === "exclusive" ? "1" : "0")
- ;
-
- $affectedRows = $this->db->query($query);
- return $affectedRows > 0;
- return "200 OK";
- }
- /**
- * UNLOCK method handler
- *
- * @param array general parameter passing array
- * @return bool true on success
- */
- function unlock(&$options)
- {
- $prefix = $GLOBALS['POOL']->config->getTablePrefix();
- $query = "DELETE FROM ".$prefix."locks
- WHERE path = '$options[path]'
- AND token = '$options[token]'";
- $this->db->query($query);
-
- return $this->db->affectedRows() ? "200 OK" : "409 Conflict";
- }
- /**
- * checkLock() helper
- *
- * @param string resource path to check for locks
- * @return bool true on success
- */
- function checkLock($path)
- {
- $result = false;
- $prefix = $GLOBALS['POOL']->config->getTablePrefix();
- $query = "SELECT owner, token, expires, exclusivelock
- FROM ".$prefix."locks
- WHERE path = '$path'
- ";
- $res = $this->db->query($query);
- if($res) {
- $row =$res->fetchRow(MDB2_FETCHMODE_ASSOC);
- $res->free($res);
- if($row) {
- $result = array( "type" => "write",
- "scope" => $row["exclusivelock"] ? "exclusive" : "shared",
- "depth" => 0,
- "owner" => $row['owner'],
- "token" => $row['token'],
- "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;
- }
- }
- ?>