cvs: pear /HTTP_WebDAV_Client Client.php package.xml /HTTP_WebDAV_Client/Client Stream.php /HTTP_WebDAV_Client/Tools _parse_propfind_response.php

hholzgra Thu Dec 4 17:56:38 2003 EDT Added files: /pear/HTTP_WebDAV_Client Client.php package.xml /pear/HTTP_WebDAV_Client/Client Stream.php /pear/HTTP_WebDAV_Client/Tools _parse_propfind_response.php Log: initial release

Index: pear/HTTP_WebDAV_Client/Client.php +++ pear/HTTP_WebDAV_Client/Client.php <?php require_once "HTTP/WebDAV/Client/Stream.php"; if (!HTTP_WebDAV_Client_Stream::register()) { PEAR::raiseError("couldn't register WebDAV stream wrappers"); } ?> Index: pear/HTTP_WebDAV_Client/package.xml +++ pear/HTTP_WebDAV_Client/package.xml <?xml version="1.0" encoding="ISO-8859-1" ?> <!DOCTYPE package SYSTEM "../package.dtd"> <package version="1.0"> <name>HTTP_WebDAV_Client</name> <summary>WebDAV stream wrapper class</summary> <description> RFC2518 compliant stream wrapper that allows to use WebDAV server resources like a regular file system from within PHP. </description> <maintainers> <maintainer> <user>hholzgra</user> <name>Hartmut Holzgraefe</name> <email>hartmut@php.net</email> <role>lead</role> </maintainer> </maintainers> <release> <version>0.9.5</version> <date>2003-12-04</date> <state>beta</state> <license>PHP</license> <notes> lots of small improvements and additions, now waiting for missing pieces in the user streams interface ... </notes> <deps> <dep type="php" rel="ge" version="4.3"/> <dep type="pkg" rel="ge" version="1.0">HTTP</dep> </deps> <filelist> <dir name="/" baseinstalldir="HTTP/WebDAV"> <file role="php">Client.php</file> <dir name="Tools"> <file role="php">_parse_propfind_response.php</file> </dir> <dir name="Client"> <file role="php">Stream.php</file> </dir> </dir> </filelist> </release> <changelog> <release> <version>0.9.0</version> <date>2003-07-11</date> <state>alpha</state> <license>PHP</license> <notes> already usable but needs additional performance tuning and error checking </notes> </release> </changelog> </package> Index: pear/HTTP_WebDAV_Client/Client/Stream.php +++ pear/HTTP_WebDAV_Client/Client/Stream.php <?php require "HTTP/Request.php"; require "HTTP/WebDAV/Tools/_parse_propfind_response.php"; // WebDAV defines some addition HTTP methods define('HTTP_REQUEST_METHOD_COPY', 'COPY', true); define('HTTP_REQUEST_METHOD_MOVE', 'MOVE', true); define('HTTP_REQUEST_METHOD_MKCOL', 'MKCOL', true); define('HTTP_REQUEST_METHOD_PROPFIND', 'PROPFIND', true); define('HTTP_REQUEST_METHOD_PROPPATCH', 'PROPPATCH', true); define('HTTP_REQUEST_METHOD_LOCK', 'LOCK', true); define('HTTP_REQUEST_METHOD_UNLOCK', 'UNLOCK', true); /** * A stream wrapper class for WebDAV access * * @access public */ class HTTP_WebDAV_Client_Stream { /** * The http or https resource URL * * @access private * @var string url */ var $url = false; /** * The resource URL path * * @access private * @var string path */ var $path = false; /** * File position indicator * * @access private * @var int offset in bytes */ var $position = 0; /** * File status information cache * * @access private * @var array stat information */ var $stat = array(); /** * User name for authentication * * @access private * @var string name */ var $user = false; /** * Password for authentication * * @access private * @var string password */ var $pass = false; /** * WebDAV protocol levels supported by the server * * @access private * @var array level entries */ var $dav_level = array(); /** * HTTP methods supported by the server * * @access private * @var array method entries */ var $dav_allow = array(); /** * Directory content cache * * @access private * @var array filename entries */ var $dirfiles = false; /** * Current readdir() position * * @access private * @var int */ var $dirpos = 0; /** * Remember if end of file was reached * * @access private * @var bool */ var $eof = false; /** * Stream wrapper interface open() method * * @access public * @var string resource URL * @var string mode flags * @var array not used here * @var string return real path here if suitable * @return bool true on success */ function stream_open($path, $mode, $options, &$opened_path) { // rewrite the request URL if (!$this->_parse_url($path)) return false; // query server for WebDAV options if (!$this->_check_options()) return false; // now get the file metadata // we only need type, size, creation and modification date $req = &new HTTP_Request($this->url); $req->setMethod(HTTP_REQUEST_METHOD_PROPFIND); $req->addHeader("Depth", "0"); $req->addHeader("Content-type", "text/xml"); $req->addRawPostData('<?xml version="1.0" encoding="utf-8"?> <propfind xmlns="DAV:"> <prop> <resourcetype/> <getcontentlength/> <getlastmodified /> <creationdate/> </prop> </propfind> '); $req->sendRequest(); // check the response code, anything but 207 indicates a problem switch ($req->getResponseCode()) { case 207: // OK // now we have to parse the result to get the status info items $propinfo = &new HTTP_WebDAV_Client_parse_propfind_response($req->getResponseBody()); $this->stat = $propinfo->stat(); unset($propinfo); break; case 404: // not found is ok in write modes if (preg_match('|[aw\+]|', $mode)) { break; // write } $this->eof = true; // else fallthru default: error_log("file not found: ".$req->getResponseCode()); return false; } if (strpos($mode, "a") !== false) { $this->eof = true; } // we are done :) return true; } /** * Streap wrapper interface close() method * * @access public */ function stream_close() { // closing is simple as HTTP is stateless and WebDAV // locks are not supported yet ;) $this->url = false; } /** * Stream wrapper interface stat() method * * @access public * @return array stat entries */ function stream_stat() { // we already have collected the needed information // in stream_open() :) return $this->stat; } /** * Stream wrapper interface read() method * * @access public * @param int requested byte count * @return string read data */ function stream_read($count) { // do some math $start = $this->position; $end = $start+$count; // create a GET request with a range $req = &new HTTP_Request($this->url); $req->setMethod(HTTP_REQUEST_METHOD_GET); $req->addHeader("Range", "bytes=$start-$end"); // go! go! go! $req->sendRequest(); $data = $req->getResponseBody(); $len = strlen($data); // lets see what happened switch ($req->getResponseCode()) { case 200: // server doesn't support range requests // TODO we should add some sort of cacheing here $data = substr($data, $start, $count); break; case 206: // server supports range requests break; case 416: // reading beyond end of file is not an error $data = ""; break; default: return false; } // no data indicates end of file if (!$len) { $this->eof = true; } // update position $this->position += $len; // thats it! return $data; } /** * Stream wrapper interface write() method * * @access public * @param string data to write * @return int number of bytes actually written */ function stream_write($buffer) { // do some math $start = $this->position; $end = $this->position + strlen($buffer); // create a partial PUT request $req = &new HTTP_Request($this->url); $req->setMethod(HTTP_REQUEST_METHOD_PUT); $req->addHeader("Content-Range", "bytes $start-$end/*"); $req->addRawPostData($buffer); // go! go! go! $req->sendRequest(); // check result switch ($req->getResponseCode()) { case 200: case 201: case 204: return $end-$start; default: return false; } /* We do not cope with servers that do not support partial PUTs! And we do assume that a server does conform to the following rule from RFC 2616 Section 9.6: "The recipient of the entity MUST NOT ignore any Content-* (e.g. Content-Range) headers that it does not understand or implement and MUST return a 501 (Not Implemented) response in such cases." So the worst case scenario with a compliant server not implementing partial PUTs should be a failed request. A server simply ignoring "Content-Range" would replace file contents with the request body instead of putting the data at the requested place but we can blame it for not being compliant in this case ;) (TODO: maybe we should do a HTTP version check first?) we *could* emulate partial PUT support by adding local cacheing but for now we don't want to as it adds a lot of complexity and storage overhead to the client ... */ } /** * Stream wrapper interface eof() method * * @access public * @return bool true if end of file was reached */ function stream_eof() { // another simple one return $this->eof; } /** * Stream wrapper interface tell() method * * @access public * @return int current file position */ function stream_tell() { // just return the current position return $this->position; } /** * Stream wrapper interface seek() method * * @access public * @param int position to seek to * @param int seek mode * @return bool true on success */ function stream_seek($pos, $whence) { switch ($whence) { case SEEK_SET: // absolute position $this->position = $pos; break; case SEEK_CUR: // relative position $this->position += $pos; break; case SEEK_END: // relative position form end $this->position = $this->stat['size'] + $pos; break; default: return false; } // TODO: this is rather naive (check how libc handles this) $this->eof = false; return true; } /** * Stream wrapper interface URL stat() method * * @access public * @param string URL to get stat information for * @return array stat information */ function url_stat($url) { // we map this one to open()/stat()/close() // there won't be much gain in inlining this if (!$this->stream_open($url, "r", array(), $dummy)) { return false; } $stat = $this->stream_stat(); $this->stream_close(); return $stat; } /** * Stream wrapper interface opendir() method * * @access public * @param string directory resource URL * @param array not used here * @return bool true on success */ function dir_opendir($path, $options) { // rewrite the request URL if (!$this->_parse_url($path)) return false; // query server for WebDAV options if (!$this->_check_options()) return false; if (!isset($this->dav_allow[HTTP_REQUEST_METHOD_PROPFIND])) { return false; } // now read the directory $req = &new HTTP_Request($this->url); $req->setMethod(HTTP_REQUEST_METHOD_PROPFIND); $req->addHeader("Depth", "1"); $req->addHeader("Content-type", "text/xml"); $req->addRawPostData('<?xml version="1.0" encoding="utf-8"?> <propfind xmlns="DAV:"> <prop> <resourcetype/> <getcontentlength/> <creationdate/> <getlastmodified/> </prop> </propfind> '); $req->sendRequest(); switch ($req->getResponseCode()) { case 207: // multistatus content $this->dirfiles = array(); $this->dirpos = 0; // for all returned resource entries foreach (split("\n",$req->getResponseBody()) as $line) { // get the href URL if (ereg("href>([^<]*)", $line, $matches)) { // skip the directory itself if ($matches[1] == $this->path) { continue; } // just remember the basenames to return them later with readdir() $this->dirfiles[] = basename($matches[1]); } } return true; default: // any other response state indicates an error error_log("file not found"); return false; } } /** * Stream wrapper interface readdir() method * * @access public * @return string filename */ function dir_readdir() { // bailout if directory is empty if (!is_array($this->dirfiles)) { return false; } // bailout if we already reached end of dir if ($this->dirpos >= count($this->dirfiles)) { return false; } // return an entry and move on return $this->dirfiles[$this->dirpos++]; } /** * Stream wrapper interface rewinddir() method * * @access public */ function dir_rewinddir() { // bailout if directory content info has already // been freed if (!is_array($this->dirfiles)) { return false; } // rewind to first entry $this->dirpos = 0; } /** * Stream wrapper interface closedir() method * * @access public */ function dir_closedir() { // free stored directory content if (is_array($this->dirfiles)) { $this->dirfiles = false; $this->dirpos = 0; } } /** * Stream wrapper interface unlink() method * * @access public * @param string resource URL to be removed * @return bool true on success */ function unlink($path) { // rewrite the request URL if (!$this->_parse_url($path)) return false; // query server for WebDAV options if (!$this->_check_options()) return false; // is DELETE supported? if (!isset($this->dav_allow[HTTP_REQUEST_METHOD_DELETE])) { return false; } $req = &new HTTP_Request($this->url); $req->setMethod(HTTP_REQUEST_METHOD_DELETE); $req->sendRequest(); switch ($req->getResponseCode()) { case 204: // ok return true; default: return false; } } /** * Static helper that registers the wrappers * * @access public, static * @return bool true on success (even if SSL doesn't work) */ function register() { // check that we have the required feature if (!function_exists("stream_register_wrapper")) { return false; } // try to register the non-encrypted WebDAV wrapper if (!stream_register_wrapper("webdav", "HTTP_WebDAV_Client_Stream")) { return false; } // now try to register the SSL protocol variant // it is not critical if this fails // TODO check whether SSL is possible with HTTP_Request stream_register_wrapper("webdavs", "HTTP_WebDAV_Client_Stream"); return true; } /** * Helper function for URL analysis * * @access private * @param string original request URL * @return bool true on success else false */ function _parse_url($path) { // rewrite the WebDAV url as a plain HTTP url $url = parse_url($path); // detect whether plain or SSL-encrypted transfer is requested switch ($url['scheme']) { case "webdav": $url['scheme'] = "http"; break; case "webdavs": $url['scheme'] = "https"; break; default: error_log("only 'webdav:' and 'webdavs:' are supported, not '$url[scheme]:'"); return false; } // if a TCP port is specified we have to add it after the host if (isset($url['port'])) { $url['host'] .= ":$url[port]"; } // store the plain path for possible later use $this->path = $url["path"]; // now we can put together the new URL $this->url = "$url[scheme]://$url[host]$url[path]"; // extract authentication information if (isset($url['user'])) { $this->user = $url['user']; } if (isset($url['pass'])) { $this->pass = $url['pass']; } return true; } /** * Helper function for WebDAV OPTIONS detection * * @access private * @return bool true on success else false */ function _check_options() { // now check OPTIONS reply for WebDAV response headers $req = &new HTTP_Request($this->url); $req->setMethod(HTTP_REQUEST_METHOD_OPTIONS); if (is_string($this->user)) { $req->setBasicAuth($this->user, @$this->pass); } $req->sendRequest(); if ($req->getResponseCode() != 200) { return false; } // get the supported DAV levels and extensions $dav = $req->getResponseHeader("DAV"); $this->dav_level = array(); foreach (explode(",", $dav) as $level) { $this->dav_level[trim($level)] = true; } if (!isset($this->dav_level["1"])) { // we need at least DAV Level 1 conformance return false; } // get the supported HTTP methods // TODO these are not checked for WebDAV compliance yet $allow = $req->getResponseHeader("Allow"); $this->dav_allow = array(); foreach (explode(",", $allow) as $method) { $this->dav_allow[trim($method)] = true; } // TODO check for required WebDAV methods return true; } } ?> Index: pear/HTTP_WebDAV_Client/Tools/_parse_propfind_response.php +++ pear/HTTP_WebDAV_Client/Tools/_parse_propfind_response.php <?php // helper class for parsing PROPFIND response bodies class HTTP_WebDAV_Client_parse_propfind_response { // get requested properties as array containing name/namespace pairs function HTTP_WebDAV_Client_parse_propfind_response($response) { $this->urls = array(); $this->_depth = 0; $xml_parser = xml_parser_create_ns("UTF-8", " "); xml_set_element_handler($xml_parser, array(&$this, "_startElement"), array(&$this, "_endElement")); xml_set_character_data_handler($xml_parser, array(&$this, "_data")); xml_parser_set_option($xml_parser, XML_OPTION_CASE_FOLDING, false); $this->success = xml_parse($xml_parser, $response, true); xml_parser_free($xml_parser); unset($this->_depth); } function _startElement($parser, $name, $attrs) { if (strstr($name, " ")) { list($ns, $tag) = explode(" ", $name); if ($ns == "") $this->success = false; } else { $ns = ""; $tag = $name; } switch ($this->_depth) { case '3': switch ($tag) { case 'propstat': $this->_tmpprop = array(); break; } } $this->_depth++; } function _endElement($parser, $name) { if (strstr($name, " ")) { list($ns, $tag) = explode(" ", $name); if ($ns == "") $this->success = false; } else { $ns = ""; $tag = $name; } $this->_depth--; switch ($this->_depth) { case '1': switch ($tag) { case 'response': $this->urls[$this->_tmphref] = $this->_tmpvals; unset($this->_tmphref); unset($this->_tmpvals); break; } break; case '2': switch ($tag) { case 'href': $this->_tmphref = $this->_tmpdata; break; } case 'propstat': if (isset($this->_tmpstat) && strstr($this->_tmpstat, " 200 ")) { $this->_tmpvals = $this->_tmpprop; } unset($this->_tmpstat); unset($this->_tmpprop); break; case '3': switch ($tag) { case 'status': $this->_tmpstat = $this->_tmpdata; break; } case '4': switch ($tag) { case 'getlastmodified': $this->_tmpprop['atime'] = strtotime($this->_tmpdata); $this->_tmpprop['mtime'] = strtotime($this->_tmpdata); break; case 'creationdate': $t = split("[^[:digit:]]", $this->_tmpdata); $this->_tmpprop['ctime'] = mktime($t[3],$t[4],$t[5],$t[1],$t[2],$t[0]); unset($t); break; case 'getcontentlength': $this->_tmpprop['size'] = $this->_tmpdata; break; } } unset($this->_tmpdata); } function _data($parser, $data) { $this->_tmpdata = $data; } function stat($href=false) { if ($href) { // TODO } else { reset($this->urls); return current($this->urls); } } } ?>