Inheritance diagram for HTTP_WebDAV_Server:

Collaboration diagram for HTTP_WebDAV_Server:

Public Member Functions
	serveRequest ()
	Serve WebDAV HTTP request. More...

	http_OPTIONS ()
	GET implementation. More...

	http_PROPFIND ()
	PROPFIND method handler. More...

	http_PROPPATCH ()
	PROPPATCH method handler. More...

	http_MKCOL ()
	MKCOL method handler. More...

	http_GET ()
	GET method handler. More...

	_get_ranges (&$options)
	parse HTTP Range: header More...

	_multipart_byterange_header ($mimetype=false, $from=false, $to=false, $total=false)
	generate separator headers for multipart response More...

	http_HEAD ()
	HEAD method handler. More...

	http_PUT ()
	PUT method handler. More...

	http_DELETE ()
	DELETE method handler. More...

	http_COPY ()
	COPY method handler. More...

	http_MOVE ()
	MOVE method handler. More...

	http_LOCK ()
	LOCK method handler. More...

	http_UNLOCK ()
	UNLOCK method handler. More...

	_copymove ($what)

	_allow ()
	check for implemented HTTP methods More...

	mkprop ()
	helper for property element creation More...

	_check_auth ()
	check authentication if check is implemented More...

	_new_uuid ()
	generate Unique Universal IDentifier for lock token More...

	_new_locktoken ()
	create a new opaque lock token as defined in RFC2518 More...

	_if_header_lexer ($string, &$pos)

	_if_header_parser ($str)
	parse If: header More...

	_check_if_header_conditions ()
	check if conditions from "If:" headers are meat More...

	_check_uri_condition ($uri, $condition)
	Check a single URI condition parsed from an if-header. More...

	_check_lock_status ($path, $exclusive_only=false)

	lockdiscovery ($path)
	Generate lockdiscovery reply from checklock() result. More...

	http_status ($status)
	set HTTP return status and mirror it in a private header More...

	_urlencode ($url)
	private minimalistic version of PHP urlencode() More...

	_urldecode ($path)
	private version of PHP urldecode More...

	_prop_encode ($text)
	UTF-8 encode property values if not already done so. More...

	_slashify ($path)
	Slashify - make sure path ends in a slash. More...

Data Fields
	$uri

	$base_uri

	$path

	$http_auth_realm = "PHP WebDAV"

	$dav_powered_by = ""

	$_if_header_uris = array()

	$_http_status = "200 OK"

	$_prop_encoding = "utf-8"

Private Member Functions
	__construct ()
	Constructor. More...

	writelog ($message)
	Writes a message to the logfile.,. More...

Detailed Description

Definition at line 37 of file Server.php.

Constructor & Destructor Documentation

◆ __construct()

HTTP_WebDAV_Server::__construct ( )

private

Constructor.

Parameters

void

Definition at line 108 of file Server.php.

     {
         // PHP messages destroy XML output -> switch them off
         //ini_set("display_errors", 0);
     }

Member Function Documentation

◆ _allow()

HTTP_WebDAV_Server::_allow ( )

check for implemented HTTP methods

Parameters

void

Returns: array something

Definition at line 1511 of file Server.php.

References array.

Referenced by http_OPTIONS(), and serveRequest().

     {
         // OPTIONS is always there
         $allow = array("OPTIONS" =>"OPTIONS");
 
         // all other METHODS need both a http_method() wrapper
         // and a method() implementation
         // the base class supplies wrappers only
         foreach(get_class_methods($this) as $method) {
             if (!strncmp("http_", $method, 5)) {
                 $method = strtoupper(substr($method, 5));
                 if (method_exists($this, $method)) {
                     $allow[$method] = $method;
                 }
             }
         }
 
         // we can emulate a missing HEAD implemetation using GET
         if (isset($allow["GET"]))
             $allow["HEAD"] = "HEAD";
 
         // no LOCK without checklok()
         if (!method_exists($this, "checklock")) {
             unset($allow["LOCK"]);
             unset($allow["UNLOCK"]);
         }
 
         return $allow;
     }

Here is the caller graph for this function:

◆ _check_auth()

HTTP_WebDAV_Server::_check_auth ( )

check authentication if check is implemented

Parameters

void

Returns: bool true if authentication succeded or not necessary

Definition at line 1573 of file Server.php.

References $_SERVER.

Referenced by serveRequest().

     {
         if (method_exists($this, "checkAuth")) {
             // PEAR style method name
             return $this->checkAuth(@$_SERVER["AUTH_TYPE"],
                                      @$_SERVER["PHP_AUTH_USER"],
                                      @$_SERVER["PHP_AUTH_PW"]);
         } else if (method_exists($this, "check_auth")) {
             // old (pre 1.0) method name
             return $this->check_auth(@$_SERVER["AUTH_TYPE"],
                                      @$_SERVER["PHP_AUTH_USER"],
                                      @$_SERVER["PHP_AUTH_PW"]);
         } else {
             // no method found -> no authentication required
             return true;
         }
     }

Here is the caller graph for this function:

◆ _check_if_header_conditions()

HTTP_WebDAV_Server::_check_if_header_conditions ( )

check if conditions from "If:" headers are meat

the "If:" header is an extension to HTTP/1.1 defined in RFC 2518 section 9.4

Parameters

void

Returns: void

Definition at line 1786 of file Server.php.

References $_SERVER, $uri, _check_uri_condition(), and _if_header_parser().

Referenced by serveRequest().

     {
         if (isset($_SERVER["HTTP_IF"])) {
             $this->_if_header_uris =
                 $this->_if_header_parser($_SERVER["HTTP_IF"]);
 
             foreach($this->_if_header_uris as $uri => $conditions) {
                 if ($uri == "") {
                     $uri = $this->uri;
                 }
                 // all must match
                 $state = true;
                 foreach($conditions as $condition) {
                     // lock tokens may be free form (RFC2518 6.3)
                     // but if opaquelocktokens are used (RFC2518 6.4)
                     // we have to check the format (litmus tests this)
                     if (!strncmp($condition, "<opaquelocktoken:", strlen("<opaquelocktoken"))) {
                         if (!preg_match("/^<opaquelocktoken:[[:xdigit:]]{8}-[[:xdigit:]]{4}-[[:xdigit:]]{4}-[[:xdigit:]]{4}-[[:xdigit:]]{12}>$/", $condition)) {
                             return false;
                         }
                     }
                     if (!$this->_check_uri_condition($uri, $condition)) {
                         $state = false;
                         break;
                     }
                 }
 
                 // any match is ok
                 if ($state == true) {
                     return true;
                 }
             }
             return false;
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _check_lock_status()

HTTP_WebDAV_Server::_check_lock_status	(	$path,
		$exclusive_only = `false`
	)

Parameters

string	path of resource to check
bool	exclusive lock?

Definition at line 1847 of file Server.php.

References $_SERVER.

Referenced by _copymove(), http_DELETE(), http_LOCK(), http_MOVE(), http_PROPPATCH(), and http_PUT().

     {
         // FIXME depth -> ignored for now
         if (method_exists($this, "checkLock")) {
             // is locked?
             $lock = $this->checkLock($path);
 
             // ... and lock is not owned?
             if (is_array($lock) && count($lock)) {
                 // FIXME doesn't check uri restrictions yet
                 if (!strstr($_SERVER["HTTP_IF"], $lock["token"])) {
                     if (!$exclusive_only || ($lock["scope"] !== "shared"))
                         return false;
                 }
             }
         }
         return true;
     }

Here is the caller graph for this function:

◆ _check_uri_condition()

HTTP_WebDAV_Server::_check_uri_condition	(	$uri,
		$condition
	)

Check a single URI condition parsed from an if-header.

Check a single URI condition parsed from an if-header

Parameters

string	$uri	URI to check
string	$condition	Condition to check for this URI

Returns: bool Condition check result

Definition at line 1833 of file Server.php.

Referenced by _check_if_header_conditions().

     {
         // not really implemented here, 
         // implementations must override
         return true;
     }

Here is the caller graph for this function:

◆ _copymove()

HTTP_WebDAV_Server::_copymove ( $what )

Definition at line 1448 of file Server.php.

References $_SERVER, $options, $path, _check_lock_status(), _urldecode(), and http_status().

Referenced by http_COPY(), and http_MOVE().

     {
             //$this->writelog('_copymove('.$what.')');
         $options = Array();
         $options["path"] = $this->path;
 
         if (isset($_SERVER["HTTP_DEPTH"])) {
             $options["depth"] = $_SERVER["HTTP_DEPTH"];
         } else {
             $options["depth"] = "infinity";
         }
 //$this->writelog('_copymove dest='.$_SERVER["HTTP_DESTINATION"]);
         extract(parse_url($_SERVER["HTTP_DESTINATION"]));
         // BEGIN WebDAV: decode path     (bereits in PEAR CVS gefixt)
         // We must decode the target path too.
         $path = $this->_urldecode($path);
         // END Patch WebDAV: decode path     
         $http_host = $host;
         if (isset($port) && $port != 80)
             $http_host.= ":$port";
 
         list($http_header_host,$http_header_port)  = explode(":",$_SERVER["HTTP_HOST"]);
         if (isset($http_header_port) && $http_header_port != 80) { 
             $http_header_host .= ":".$http_header_port;
         }
 
         if ($http_host == $http_header_host &&
             !strncmp($_SERVER["SCRIPT_NAME"], $path,
                      strlen($_SERVER["SCRIPT_NAME"]))) {
             $options["dest"] = substr($path, strlen($_SERVER["SCRIPT_NAME"]));
             //$this->writelog('_copymove() dest='.$options['dest']);
             if (!$this->_check_lock_status($options["dest"])) {
             //$this->writelog('_copymove():423 Locked');
                 $this->http_status("423 Locked");
                 return;
             }
             //$this->writelog('_copymove() ...');
 
         } else {
             $options["dest_url"] = $_SERVER["HTTP_DESTINATION"];
         }
 
         // see RFC 2518 Sections 9.6, 8.8.4 and 8.9.3
         if (isset($_SERVER["HTTP_OVERWRITE"])) {
             $options["overwrite"] = $_SERVER["HTTP_OVERWRITE"] == "T";
         } else {
             $options["overwrite"] = true;
         }
 
         $stat = $this->$what($options);
         $this->http_status($stat);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _get_ranges()

HTTP_WebDAV_Server::_get_ranges ( & $options )

parse HTTP Range: header

Parameters

array options array to store result in

Returns: void

Definition at line 986 of file Server.php.

References $_SERVER, $options, $start, and array.

Referenced by http_GET().

     {
         // process Range: header if present
         if (isset($_SERVER['HTTP_RANGE'])) {
 
             // we only support standard "bytes" range specifications for now
             if (preg_match("/bytes[[:space:]]*=[[:space:]]*(.+)/", $_SERVER['HTTP_RANGE'], $matches)) {
                 $options["ranges"] = array();
 
                 // ranges are comma separated
                 foreach (explode(",", $matches[1]) as $range) {
                     // ranges are either from-to pairs or just end positions
                     list($start, $end) = explode("-", $range);
                     $options["ranges"][] = ($start==="") 
                                          ? array("last"=>$end) 
                                          : array("start"=>$start, "end"=>$end);
                 }
             }
         }
     }

Here is the caller graph for this function:

◆ _if_header_lexer()

HTTP_WebDAV_Server::_if_header_lexer	(		$string,
		&	$pos
	)

Parameters

string	header string to parse
int	current parsing position

Returns: array next token (type and value)

Definition at line 1647 of file Server.php.

References array.

Referenced by _if_header_parser().

     {
         // skip whitespace
         while (ctype_space($string{$pos})) {
             ++$pos;
         }
 
         // already at end of string?
         if (strlen($string) <= $pos) {
             return false;
         }
 
         // get next character
         $c = $string{$pos++};
 
         // now it depends on what we found
         switch ($c) {
             case "<":
                 // URIs are enclosed in <...>
                 $pos2 = strpos($string, ">", $pos);
                 $uri = substr($string, $pos, $pos2 - $pos);
                 $pos = $pos2 + 1;
                 return array("URI", $uri);
 
             case "[":
                 //Etags are enclosed in [...]
                 if ($string{$pos} == "W") {
                     $type = "ETAG_WEAK";
                     $pos += 2;
                 } else {
                     $type = "ETAG_STRONG";
                 }
                 $pos2 = strpos($string, "]", $pos);
                 $etag = substr($string, $pos + 1, $pos2 - $pos - 2);
                 $pos = $pos2 + 1;
                 return array($type, $etag);
 
             case "N":
                 // "N" indicates negation
                 $pos += 2;
                 return array("NOT", "Not");
 
             default:
                 // anything else is passed verbatim char by char
                 return array("CHAR", $c);
         }
     }

Here is the caller graph for this function:

◆ _if_header_parser()

HTTP_WebDAV_Server::_if_header_parser ( $str )

parse If: header

Parameters

string header string

Returns: array URIs and their conditions

Definition at line 1701 of file Server.php.

References $uri, _if_header_lexer(), and array.

Referenced by _check_if_header_conditions().

     {
         $pos = 0;
         $len = strlen($str);
 
         $uris = array();
 
         // parser loop
         while ($pos < $len) {
             // get next token
             $token = $this->_if_header_lexer($str, $pos);
 
             // check for URI
             if ($token[0] == "URI") {
                 $uri = $token[1]; // remember URI
                 $token = $this->_if_header_lexer($str, $pos); // get next token
             } else {
                 $uri = "";
             }
 
             // sanity check
             if ($token[0] != "CHAR" || $token[1] != "(") {
                 return false;
             }
 
             $list = array();
             $level = 1;
             $not = "";
             while ($level) {
                 $token = $this->_if_header_lexer($str, $pos);
                 if ($token[0] == "NOT") {
                     $not = "!";
                     continue;
                 }
                 switch ($token[0]) {
                     case "CHAR":
                         switch ($token[1]) {
                             case "(":
                                 $level++;
                                 break;
                             case ")":
                                 $level--;
                                 break;
                             default:
                                 return false;
                         }
                         break;
 
                     case "URI":
                         $list[] = $not."<$token[1]>";
                         break;
 
                     case "ETAG_WEAK":
                         $list[] = $not."[W/'$token[1]']>";
                         break;
 
                     case "ETAG_STRONG":
                         $list[] = $not."['$token[1]']>";
                         break;
 
                     default:
                         return false;
                 }
                 $not = "";
             }
 
             if (@is_array($uris[$uri])) {
                 $uris[$uri] = array_merge($uris[$uri],$list);
             } else {
                 $uris[$uri] = $list;
             }
         }
 
         return $uris;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _multipart_byterange_header()

HTTP_WebDAV_Server::_multipart_byterange_header	(	$mimetype = `false`,
		$from = `false`,
		$to = `false`,
		$total = `false`
	)

generate separator headers for multipart response

first and last call happen without parameters to generate the initial header and closing sequence, all calls inbetween require content mimetype, start and end byte position and optionaly the total byte length of the requested resource

Parameters

string	mimetype
int	start byte position
int	end byte position
int	total resource byte size

Definition at line 1020 of file Server.php.

References $total, and header.

Referenced by http_GET().

     {
         if ($mimetype === false) {
             if (!isset($this->multipart_separator)) {
                 // initial
 
                 // a little naive, this sequence *might* be part of the content
                 // but it's really not likely and rather expensive to check 
                 $this->multipart_separator = "SEPARATOR_".md5(microtime());
 
                 // generate HTTP header
                 header("Content-type: multipart/byteranges; boundary=".$this->multipart_separator);
             } else {
                 // final 
 
                 // generate closing multipart sequence
                 echo "\n--{$this->multipart_separator}--";
             }
         } else {
             // generate separator and header for next part
             echo "\n--{$this->multipart_separator}\n";
             echo "Content-type: $mimetype\n";
             echo "Content-range: $from-$to/". ($total === false ? "*" : $total);
             echo "\n\n";
         }
     }

Here is the caller graph for this function:

◆ _new_locktoken()

HTTP_WebDAV_Server::_new_locktoken ( )

create a new opaque lock token as defined in RFC2518

Parameters

void

Returns: string new RFC2518 opaque lock token

Definition at line 1631 of file Server.php.

Referenced by http_LOCK().

     {
         return "opaquelocktoken:".$this->_new_uuid();
     }

Here is the caller graph for this function:

◆ _new_uuid()

HTTP_WebDAV_Server::_new_uuid ( )

generate Unique Universal IDentifier for lock token

Parameters

void

Returns: string a new UUID

Definition at line 1601 of file Server.php.

References $n.

     {
         // use uuid extension from PECL if available
         if (function_exists("uuid_create")) {
             return uuid_create();
         }
 
         // fallback
         $uuid = md5(microtime().getmypid());    // this should be random enough for now
 
         // set variant and version fields for 'true' random uuid
         $uuid{12} = "4";
         $n = 8 + (ord($uuid{16}) & 3);
         $hex = "0123456789abcdef";
         $uuid{16} = $hex{$n};
 
         // return formated uuid
         return substr($uuid,  0, 8)."-"
             .  substr($uuid,  8, 4)."-"
             .  substr($uuid, 12, 4)."-"
             .  substr($uuid, 16, 4)."-"
             .  substr($uuid, 20);
     }

◆ _prop_encode()

HTTP_WebDAV_Server::_prop_encode ( $text )

UTF-8 encode property values if not already done so.

Parameters

string text to encode

Returns: string utf-8 encoded text

Definition at line 1984 of file Server.php.

References $text.

Referenced by http_PROPFIND(), and http_PROPPATCH().

     {
         switch (strtolower($this->_prop_encoding)) {
         case "utf-8":
             return $text;
         case "iso-8859-1":
         case "iso-8859-15":
         case "latin-1":
         default:
             return utf8_encode($text);
         }
     }

Here is the caller graph for this function:

◆ _slashify()

HTTP_WebDAV_Server::_slashify ( $path )

Slashify - make sure path ends in a slash.

Parameters

string directory path

Returns: string directory path wiht trailing slash

Definition at line 2003 of file Server.php.

References $path.

                               {
         if ($path[strlen($path)-1] != '/') {
             $path = $path."/";
         }
         return $path;
     }

◆ _urldecode()

HTTP_WebDAV_Server::_urldecode ( $path )

private version of PHP urldecode

not really needed but added for completenes

Parameters

string URL to decode

Returns: string decoded URL

Definition at line 1966 of file Server.php.

References $result.

Referenced by _copymove(), and serveRequest().

     {
         // BEGIN WebDAV
         // urldecode wrongly replaces '+' characters by ' ' characters.
         // We replace '+' into '%2b' before passing the path through urldecode.
         //return urldecode($path);
         $result =& urldecode(str_replace('+','%2b',$path));
         //$this->writelog('_urldecode('.$path.'):'.$result);
         return $result;
         // END PATCH WebDAV
     }

Here is the caller graph for this function:

◆ _urlencode()

HTTP_WebDAV_Server::_urlencode ( $url )

private minimalistic version of PHP urlencode()

only blanks and XML special chars must be encoded here full urlencode() encoding confuses some clients ...

Parameters

string URL to encode

Returns: string encoded URL

Definition at line 1949 of file Server.php.

References $url, and array.

     {
         return strtr($url, array(" "=>"%20",
                                  "&"=>"%26",
                                  "<"=>"%3C",
                                  ">"=>"%3E",
                                  ));
     }

◆ http_COPY()

HTTP_WebDAV_Server::http_COPY ( )

COPY method handler.

Parameters

void

Returns: void

Definition at line 1267 of file Server.php.

References _copymove().

     {
         // no need to check source lock status here 
         // destination lock status is always checked by the helper method
         $this->_copymove("copy");
     }

Here is the call graph for this function:

◆ http_DELETE()

HTTP_WebDAV_Server::http_DELETE ( )

DELETE method handler.

Parameters

void

Returns: void

Definition at line 1232 of file Server.php.

References $_SERVER, $options, $path, _check_lock_status(), and http_status().

     {
         // check RFC 2518 Section 9.2, last paragraph
         if (isset($_SERVER["HTTP_DEPTH"])) {
             if ($_SERVER["HTTP_DEPTH"] != "infinity") {
                 $this->http_status("400 Bad Request");
                 return;
             }
         }
 
         // check lock status
         if ($this->_check_lock_status($this->path)) {
             // ok, proceed
             $options = Array();
             $options["path"] = $this->path;
 
             $stat = $this->delete($options);
 
             $this->http_status($stat);
         } else {
             // sorry, its locked
             $this->http_status("423 Locked");
         }
     }

Here is the call graph for this function:

◆ http_GET()

HTTP_WebDAV_Server::http_GET ( )

GET method handler.

Parameters

void

Returns: void

Definition at line 851 of file Server.php.

References $options, $path, $size, $start, $total, _get_ranges(), _multipart_byterange_header(), exit, header, and http_status().

     {
         // TODO check for invalid stream
         $options = Array();
         $options["path"] = $this->path;
 
         $this->_get_ranges($options);
 
         if (true === ($status = $this->get($options))) {
             if (!headers_sent()) {
                 $status = "200 OK";
 
                 if (!isset($options['mimetype'])) {
                     $options['mimetype'] = "application/octet-stream";
                 }
                 header("Content-type: $options[mimetype]");
                 
                 if (isset($options['mtime'])) {
                     header("Last-modified:".gmdate("D, d M Y H:i:s ", $options['mtime'])."GMT");
                 }
                 
                 if (isset($options['stream'])) {
                     // GET handler returned a stream
                     if (!empty($options['ranges']) && (0===fseek($options['stream'], 0, SEEK_SET))) {
                         // partial request and stream is seekable 
                         
                         if (count($options['ranges']) === 1) {
                             $range = $options['ranges'][0];
                             
                             if (isset($range['start'])) {
                                 fseek($options['stream'], $range['start'], SEEK_SET);
                                 if (feof($options['stream'])) {
                                     $this->http_status("416 Requested range not satisfiable");
                                     exit;
                                 }
 
                                 if (isset($range['end']) && $range['end'] != '') {
                                     $size = $range['end']-$range['start']+1;
                                     $this->http_status("206 partial");
                                     header("Content-length: $size");
                                     header("Content-range: $range[start]-$range[end]/"
                                            . (isset($options['size']) ? $options['size'] : "*"));
                                     while ($size && !feof($options['stream'])) {
                                         $buffer = fread($options['stream'], 4096);
                                         $size -= strlen($buffer);
                                         echo $buffer;
                                     }
                                 } else {
                                     $this->http_status("206 partial");
                                     if (isset($options['size'])) {
                                         header("Content-length: ".($options['size'] - $range['start']));
                                         header("Content-range: $start-$end/"
                                                . (isset($options['size']) ? $options['size'] : "*"));
                                     }
                                     fpassthru($options['stream']);
                                 }
                             } else {
                                 header("Content-length: ".$range['last']);
                                 fseek($options['stream'], -$range['last'], SEEK_END);
                                 fpassthru($options['stream']);
                             }
                         } else {
                             $this->_multipart_byterange_header(); // init multipart
                             foreach ($options['ranges'] as $range) {
                                 // TODO what if size unknown? 500?
                                 if (isset($range['start'])) {
                                     $from  = $range['start'];
                                     $to    = !empty($range['end']) ? $range['end'] : $options['size']-1; 
                                 } else {
                                     $from = $options['size'] - $range['last']-1;
                                     $to = $options['size'] -1;
                                 }
                                 $total = isset($options['size']) ? $options['size'] : "*"; 
                                 $size = $to - $from + 1;
                                 $this->_multipart_byterange_header($options['mimetype'], $from, $to, $total);
 
 
                                 fseek($options['stream'], $start, SEEK_SET);
                                 while ($size && !feof($options['stream'])) {
                                     $buffer = fread($options['stream'], 4096);
                                     $size -= strlen($buffer);
                                     echo $buffer;
                                 }
                             }
                             $this->_multipart_byterange_header(); // end multipart
                         }
                     } else {
                         // normal request or stream isn't seekable, return full content
                         if (isset($options['size'])) {
                             header("Content-length: ".$options['size']);
                         }
                         
                         // BEGIN WebDAV W. Randelshofer
                         // fpassthru apparently only delivers up to 2 million bytes.
                         // use fread instead
                         //fpassthru($options['stream']);
                         while (! feof($options['stream'])) {
                                 $buffer = fread($options['stream'], 4096);
                                 echo $buffer;
                         }
                         // END PATCH WebDAV W. Randelshofer
                         
                         return; // no more headers
                     }
                 } elseif (isset($options['data']))  {
                     if (is_array($options['data'])) {
                         // reply to partial request
                     } else {
                         header("Content-length: ".strlen($options['data']));
                         echo $options['data'];
                     }
                 }
             } 
         } 
 
         if (false === $status) {
                 // BEGIN WebDAV Randelshofer
                 $status = '404 Not Found';
                 //$this->http_status("404 not found");
                 // END PATCH WebDAV Randelshofer
         }
 
         if (!headers_sent()) {
             // TODO: check setting of headers in various code pathes above
             $this->http_status("$status");
         }
     }

Here is the call graph for this function:

◆ http_HEAD()

HTTP_WebDAV_Server::http_HEAD ( )

HEAD method handler.

Parameters

void

Returns: void

Definition at line 1059 of file Server.php.

References $options, $path, and http_status().

     {
         $status = false;
         $options = Array();
         $options["path"] = $this->path;
         
         if (method_exists($this, "HEAD")) {
             $status = $this->head($options);
         } else if (method_exists($this, "GET")) {
             ob_start();
             $status = $this->GET($options);
             ob_end_clean();
         }
         
         if($status===true)  $status = "200 OK";
         if($status===false) $status = "404 Not found";
         
         $this->http_status($status);
     }

Here is the call graph for this function:

◆ http_LOCK()

HTTP_WebDAV_Server::http_LOCK ( )

LOCK method handler.

Parameters

void

Returns: void

Definition at line 1307 of file Server.php.

References $_SERVER, $options, $path, _check_lock_status(), _new_locktoken(), header, http_status(), and time.

     {
         $options = Array();
         $options["path"] = $this->path;
         
         if (isset($_SERVER['HTTP_DEPTH'])) {
             $options["depth"] = $_SERVER["HTTP_DEPTH"];
         } else {
             $options["depth"] = "infinity";
         }
         
         if (isset($_SERVER["HTTP_TIMEOUT"])) {
             $options["timeout"] = explode(",", $_SERVER["HTTP_TIMEOUT"]);
         }
         
         if(empty($_SERVER['CONTENT_LENGTH']) && !empty($_SERVER['HTTP_IF'])) {
             // check if locking is possible
             if(!$this->_check_lock_status($this->path)) {
                 $this->http_status("423 Locked");
                 return;
             }
 
             // refresh lock
             $options["update"] = substr($_SERVER['HTTP_IF'], 2, -2);
             $stat = $this->lock($options);
         } else { 
             // extract lock request information from request XML payload
             $lockinfo = new _parse_lockinfo("php://input");
             if (!$lockinfo->success) {
                 $this->http_status("400 bad request"); 
             }
 
             // check if locking is possible
             if(!$this->_check_lock_status($this->path, $lockinfo->lockscope === "shared")) {
                 $this->http_status("423 Locked");
                 return;
             }
 
             // new lock 
             $options["scope"] = $lockinfo->lockscope;
             $options["type"]  = $lockinfo->locktype;
             $options["owner"] = $lockinfo->owner;
             
             $options["locktoken"] = $this->_new_locktoken();
             
             $stat = $this->lock($options);              
         }
         
         if(is_bool($stat)) {
             $http_stat = $stat ? "200 OK" : "423 Locked";
         } else {
             $http_stat = $stat;
         }
         
         $this->http_status($http_stat);
         
         if ($http_stat{0} == 2) { // 2xx states are ok 
             if($options["timeout"]) {
                 // more than a million is considered an absolute timestamp
                 // less is more likely a relative value
                 if($options["timeout"]>1000000) {
                     $timeout = "Second-".($options['timeout']-time());
                 } else {
                     $timeout = "Second-$options[timeout]";
                 }
             } else {
                 $timeout = "Infinite";
             }
             /*
             $this->writelog(
             'Content-Type: text/xml; charset="utf-8"'
             ."Lock-Token: <$options[locktoken]>"
             . "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n"
             . "<D:prop xmlns:D=\"DAV:\">\n"
             . " <D:lockdiscovery>\n"
             . "  <D:activelock>\n"
             . "   <D:lockscope><D:$options[scope]/></D:lockscope>\n"
             . "   <D:locktype><D:$options[type]/></D:locktype>\n"
             . "   <D:depth>$options[depth]</D:depth>\n"
             . "   <D:owner>$options[owner]</D:owner>\n"
             . "   <D:timeout>$timeout</D:timeout>\n"
             . "   <D:locktoken><D:href>$options[locktoken]</D:href></D:locktoken>\n"
             . "  </D:activelock>\n"
             . " </D:lockdiscovery>\n"
             . "</D:prop>\n\n"
             );*/
             header('Content-Type: text/xml; charset="utf-8"');
             header("Lock-Token: <$options[locktoken]>");
             echo "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n";
             echo "<D:prop xmlns:D=\"DAV:\">\n";
             echo " <D:lockdiscovery>\n";
             echo "  <D:activelock>\n";
             echo "   <D:lockscope><D:$options[scope]/></D:lockscope>\n";
             echo "   <D:locktype><D:$options[type]/></D:locktype>\n";
             echo "   <D:depth>$options[depth]</D:depth>\n";
             echo "   <D:owner>$options[owner]</D:owner>\n";
             echo "   <D:timeout>$timeout</D:timeout>\n";
             echo "   <D:locktoken><D:href>$options[locktoken]</D:href></D:locktoken>\n";
             echo "  </D:activelock>\n";
             echo " </D:lockdiscovery>\n";
             echo "</D:prop>\n\n";
         }
     }

Here is the call graph for this function:

◆ http_MKCOL()

HTTP_WebDAV_Server::http_MKCOL ( )

MKCOL method handler.

Parameters

void

Returns: void

Definition at line 830 of file Server.php.

References $options, $path, and http_status().

     {
         $options = Array();
         $options["path"] = $this->path;
 
         $stat = $this->mkcol($options);
 
         $this->http_status($stat);
     }

Here is the call graph for this function:

◆ http_MOVE()

HTTP_WebDAV_Server::http_MOVE ( )

MOVE method handler.

Parameters

void

Returns: void

Definition at line 1284 of file Server.php.

References _check_lock_status(), _copymove(), and http_status().

     {
             //$this->writelog('MOVE()');
         if ($this->_check_lock_status($this->path)) {
             // destination lock status is always checked by the helper method
             $this->_copymove("move");
         } else {
             //$this->writelog('MOVE():423 Locked');
             $this->http_status("423 Locked");
         }
     }

Here is the call graph for this function:

◆ http_OPTIONS()

HTTP_WebDAV_Server::http_OPTIONS ( )

GET implementation.

overload this method to retrieve resources from your server

Parameters

array

&$params

Array of input and output parameters
input

path -

output

size -

Returns: int HTTP-Statuscode PUT implementation

PUT implementation

Parameters

array &$params

Returns: int HTTP-Statuscode COPY implementation

COPY implementation

Parameters

array &$params

Returns: int HTTP-Statuscode MOVE implementation

MOVE implementation

Parameters

array &$params

Returns: int HTTP-Statuscode DELETE implementation

DELETE implementation

Parameters

array &$params

Returns: int HTTP-Statuscode PROPFIND implementation

PROPFIND implementation

Parameters

array &$params

Returns: int HTTP-Statuscode PROPPATCH implementation

PROPPATCH implementation

Parameters

array &$params

Returns: int HTTP-Statuscode LOCK implementation

LOCK implementation

Parameters

array &$params

Returns: int HTTP-Statuscode UNLOCK implementation

UNLOCK implementation

Parameters

array &$params

Returns: int HTTP-Statuscode check authentication

overload this method to retrieve and confirm authentication information

Parameters

string	type Authentication type, e.g. "basic" or "digest"
string	username Transmitted username
string	passwort Transmitted password

Returns: bool Authentication status check lock status for a resource

overload this method to return shared and exclusive locks active for this resource

Parameters

string resource Resource path to check

Returns: array An array of lock entries each consisting of 'type' ('shared'/'exclusive'), 'token' and 'timeout' OPTIONS method handler

The OPTIONS method handler creates a valid OPTIONS reply including Dav: and Allowed: headers based on the implemented methods found in the actual instance

Parameters

void

Returns: void

Definition at line 478 of file Server.php.

References _allow(), array, header, http_status(), and writelog().

     {
         // Microsoft clients default to the Frontpage protocol 
         // unless we tell them to use WebDAV
         header("MS-Author-Via: DAV");
 
         // get allowed methods
         $allow = $this->_allow();
 
         // dav header
         $dav = array(1);        // assume we are always dav class 1 compliant
         if (isset($allow['LOCK'])) {
             $dav[] = 2;         // dav class 2 requires that locking is supported 
         }
 
         // tell clients what we found
         $this->http_status("200 OK");
         header("DAV: "  .join("," , $dav));
         header("Allow: ".join(", ", $allow));
                 $this->writelog(__METHOD__.': dav='.var_export($dav,true).' allow='.var_export($allow,true));
         header("Content-length: 0");
     }

Here is the call graph for this function:

◆ http_PROPFIND()

HTTP_WebDAV_Server::http_PROPFIND ( )

PROPFIND method handler.

Parameters

void

Returns: void

Definition at line 512 of file Server.php.

References $_SERVER, $file, $files, $options, $path, _prop_encode(), array, header, http_status(), lockdiscovery(), and mkprop().

     {
         $options = Array();
         $options["path"] = $this->path;
         
         // search depth from header (default is "infinity)
         if (isset($_SERVER['HTTP_DEPTH'])) {
             $options["depth"] = $_SERVER["HTTP_DEPTH"];
         } else {
             $options["depth"] = "infinity";
         }       
 
         // analyze request payload
         $propinfo = new _parse_propfind("php://input");
         if (!$propinfo->success) {
             $this->http_status("400 Error");
             return;
         }
         $options['props'] = $propinfo->props;
         
         // call user handler
         $files = array();
         if (!$this->propfind($options, $files)) {
             $this->http_status("404 Not Found");
             return;
         }
         
         // collect namespaces here
         $ns_hash = array();
         
         // Microsoft Clients need this special namespace for date and time values
         $ns_defs = "xmlns:ns0=\"urn:uuid:c2f41010-65b3-11d1-a29f-00aa00c14882/\"";    
     
         // now we loop over all returned file entries
         foreach($files["files"] as $filekey => $file) {
             
             // nothing to do if no properties were returend for a file
             if (!isset($file["props"]) || !is_array($file["props"])) {
                 continue;
             }
             
             // now loop over all returned properties
             foreach($file["props"] as $key => $prop) {
                 // as a convenience feature we do not require that user handlers
                 // restrict returned properties to the requested ones
                 // here we strip all unrequested entries out of the response
                 
                 switch($options['props']) {
                 case "all":
                     // nothing to remove
                     break;
                     
                 case "names":
                     // only the names of all existing properties were requested
                     // so we remove all values
                     unset($files["files"][$filekey]["props"][$key]["val"]);
                     break;
                     
                 default:
                     $found = false;
                     
                     // search property name in requested properties 
                     foreach((array)$options["props"] as $reqprop) {
                         if (   $reqprop["name"]  == $prop["name"] 
                             && $reqprop["xmlns"] == $prop["ns"]) {
                             $found = true;
                             break;
                         }
                     }
                     
                     // unset property and continue with next one if not found/requested
                     if (!$found) {
                         $files["files"][$filekey]["props"][$key]="";
                         continue(2);
                     }
                     break;
                 }
                 
                 // namespace handling 
                 if (empty($prop["ns"])) continue; // no namespace
                 $ns = $prop["ns"]; 
                 if ($ns == "DAV:") continue; // default namespace
                 if (isset($ns_hash[$ns])) continue; // already known
 
                 // register namespace 
                 $ns_name = "ns".(count($ns_hash) + 1);
                 $ns_hash[$ns] = $ns_name;
                 $ns_defs .= " xmlns:$ns_name=\"$ns\"";
             }
         
             // we also need to add empty entries for properties that were requested
             // but for which no values where returned by the user handler
             if (is_array($options['props'])) {
                 foreach($options["props"] as $reqprop) {
                     if($reqprop['name']=="") continue; // skip empty entries
                     
                     $found = false;
                     
                     // check if property exists in result
                     foreach($file["props"] as $prop) {
                         if (   $reqprop["name"]  == $prop["name"]
                             && $reqprop["xmlns"] == $prop["ns"]) {
                             $found = true;
                             break;
                         }
                     }
                     
                     if (!$found) {
                         if($reqprop["xmlns"]==="DAV:" && $reqprop["name"]==="lockdiscovery") {
                             // lockdiscovery is handled by the base class
                             $files["files"][$filekey]["props"][] 
                                 = $this->mkprop("DAV:", 
                                                 "lockdiscovery" , 
                                                 $this->lockdiscovery($files["files"][$filekey]['path']));
                         } else {
                             // add empty value for this property
                             $files["files"][$filekey]["noprops"][] =
                                 $this->mkprop($reqprop["xmlns"], $reqprop["name"], "");
 
                             // register property namespace if not known yet
                             if ($reqprop["xmlns"] != "DAV:" && !isset($ns_hash[$reqprop["xmlns"]])) {
                                 $ns_name = "ns".(count($ns_hash) + 1);
                                 $ns_hash[$reqprop["xmlns"]] = $ns_name;
                                 $ns_defs .= " xmlns:$ns_name=\"$reqprop[xmlns]\"";
                             }
                         }
                     }
                 }
             }
         }
         
         // now we generate the reply header ...
         $this->http_status("207 Multi-Status");
         header('Content-Type: text/xml; charset="utf-8"');
         
         // ... and payload
         echo "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n";
         echo "<D:multistatus xmlns:D=\"DAV:\">\n";
             
         foreach($files["files"] as $file) {
             // ignore empty or incomplete entries
             if(!is_array($file) || empty($file) || !isset($file["path"])) continue;
             $path = $file['path'];                  
             if(!is_string($path) || $path==="") continue;
  
             echo " <D:response $ns_defs>\n";
         
             // BEGIN WebDAV W. Randelshofer Don't slashify path because it confuses Mac OS X
             //$href = $this->_slashify($_SERVER['SCRIPT_NAME'] . $path);
             $href = $_SERVER['SCRIPT_NAME'] . $path;
             //END PATCH WebDAV W. Randelshofer
        
             echo "  <D:href>$href</D:href>\n";
        
             // report all found properties and their values (if any)
             if (isset($file["props"]) && is_array($file["props"])) {
                 echo "   <D:propstat>\n";
                 echo "    <D:prop>\n";
 
                 foreach($file["props"] as $key => $prop) {
                     
                     if (!is_array($prop)) continue;
                     if (!isset($prop["name"])) continue;
                     if (!isset($prop["val"]) || $prop["val"] === "" || $prop["val"] === false) {
                         // empty properties (cannot use empty() for check as "0" is a legal value here)
                         if($prop["ns"]=="DAV:") {
                             echo "     <D:$prop[name]/>\n";
                         } else if(!empty($prop["ns"])) {
                             echo "     <".$ns_hash[$prop["ns"]].":$prop[name]/>\n";
                         } else {
                             echo "     <$prop[name] xmlns=\"\"/>";
                         }
                     } else if ($prop["ns"] == "DAV:") {
                         // some WebDAV properties need special treatment
                         switch ($prop["name"]) {
                         case "creationdate":
                             echo "     <D:creationdate ns0:dt=\"dateTime.tz\">"
                                // BEGIN WebDAV W. Randelshofer
                                   . gmdate("Y-m-d\\TH:i:s\\Z",$prop['val'])
                                //   . gmdate("D, d M Y H:i:s ", $prop['val'])
                                // END PATCH WebDAV W. Randelshofer
                                 . "</D:creationdate>\n";
                             break;
                         case "getlastmodified":
                             echo "     <D:getlastmodified ns0:dt=\"dateTime.rfc1123\">"
                                 . gmdate("D, d M Y H:i:s ", $prop['val'])
                                 . "GMT</D:getlastmodified>\n";
                             break;
                         case "resourcetype":
                             echo "     <D:resourcetype><D:$prop[val]/></D:resourcetype>\n";
                             break;
                         case "supportedlock":
                             echo "     <D:supportedlock>$prop[val]</D:supportedlock>\n";
                             break;
                         case "lockdiscovery":  
                             echo "     <D:lockdiscovery>\n";
                             echo $prop["val"];
                             echo "     </D:lockdiscovery>\n";
                             break;
                         default:  
                             echo "     <D:$prop[name]>"
                                 . $this->_prop_encode(htmlspecialchars($prop['val']))
                                 .     "</D:$prop[name]>\n";                               
                             break;
                         }
                     } else {
                         // properties from namespaces != "DAV:" or without any namespace 
                         if ($prop["ns"]) {
                             echo "     <" . $ns_hash[$prop["ns"]] . ":$prop[name]>"
                                 . $this->_prop_encode(htmlspecialchars($prop['val']))
                                 . "</" . $ns_hash[$prop["ns"]] . ":$prop[name]>\n";
                         } else {
                             echo "     <$prop[name] xmlns=\"\">"
                                 . $this->_prop_encode(htmlspecialchars($prop['val']))
                                 . "</$prop[name]>\n";
                         }                               
                     }
                 }
 
                 echo "   </D:prop>\n";
                 echo "   <D:status>HTTP/1.1 200 OK</D:status>\n";
                 echo "  </D:propstat>\n";
             }
        
             // now report all properties requested but not found
             if (isset($file["noprops"])) {
                 echo "   <D:propstat>\n";
                 echo "    <D:prop>\n";
 
                 foreach($file["noprops"] as $key => $prop) {
                     if ($prop["ns"] == "DAV:") {
                         echo "     <D:$prop[name]/>\n";
                     } else if ($prop["ns"] == "") {
                         echo "     <$prop[name] xmlns=\"\"/>\n";
                     } else {
                         echo "     <" . $ns_hash[$prop["ns"]] . ":$prop[name]/>\n";
                     }
                 }
 
                 echo "   </D:prop>\n";
                 echo "   <D:status>HTTP/1.1 404 Not Found</D:status>\n";
                 echo "  </D:propstat>\n";
             }
             
             echo " </D:response>\n";
         }
         
         echo "</D:multistatus>\n";
     }

Here is the call graph for this function:

◆ http_PROPPATCH()

HTTP_WebDAV_Server::http_PROPPATCH ( )

PROPPATCH method handler.

Parameters

void

Returns: void

Definition at line 773 of file Server.php.

References $_SERVER, $options, $path, _check_lock_status(), _prop_encode(), header, and http_status().

     {
         if($this->_check_lock_status($this->path)) {
             $options = Array();
             $options["path"] = $this->path;
 
             $propinfo = new _parse_proppatch("php://input");
             
             if (!$propinfo->success) {
                 $this->http_status("400 Error");
                 return;
             }
             
             $options['props'] = $propinfo->props;
             
             $responsedescr = $this->proppatch($options);
             
             $this->http_status("207 Multi-Status");
             header('Content-Type: text/xml; charset="utf-8"');
             
             echo "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n";
 
             echo "<D:multistatus xmlns:D=\"DAV:\">\n";
             echo " <D:response>\n";
             echo "  <D:href>".$this->_urlencode($_SERVER["SCRIPT_NAME"].$this->path)."</D:href>\n";
 
             foreach($options["props"] as $prop) {
                 echo "   <D:propstat>\n";
                 echo "    <D:prop><$prop[name] xmlns=\"$prop[ns]\"/></D:prop>\n";
                 echo "    <D:status>HTTP/1.1 $prop[status]</D:status>\n";
                 echo "   </D:propstat>\n";
             }
 
             if ($responsedescr) {
                 echo "  <D:responsedescription>".
                     $this->_prop_encode(htmlspecialchars($responsedescr)).
                     "</D:responsedescription>\n";
             }
 
             echo " </D:response>\n";
             echo "</D:multistatus>\n";
         } else {
             $this->http_status("423 Locked");
         }
     }

Here is the call graph for this function:

◆ http_PUT()

HTTP_WebDAV_Server::http_PUT ( )

PUT method handler.

Parameters

void

Returns: void

Definition at line 1089 of file Server.php.

References $_SERVER, $options, $path, _check_lock_status(), array, and http_status().

     {
         if ($this->_check_lock_status($this->path)) {
             $options = Array();
             $options["path"] = $this->path;
             $options["content_length"] = $_SERVER["CONTENT_LENGTH"];
 
             // get the Content-type 
             if (isset($_SERVER["CONTENT_TYPE"])) {
                 // for now we do not support any sort of multipart requests
                 if (!strncmp($_SERVER["CONTENT_TYPE"], "multipart/", 10)) {
                     $this->http_status("501 not implemented");
                     echo "The service does not support mulipart PUT requests";
                     return;
                 }
                 $options["content_type"] = $_SERVER["CONTENT_TYPE"];
             } else {
                 // default content type if none given
                 $options["content_type"] = "application/octet-stream";
             }
 
             /* RFC 2616 2.6 says: "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."
             */ 
             foreach ($_SERVER as $key => $val) {
                 if (strncmp($key, "HTTP_CONTENT", 11)) continue;
                 switch ($key) {
                 case 'HTTP_CONTENT_ENCODING': // RFC 2616 14.11
                     // TODO support this if ext/zlib filters are available
                     $this->http_status("501 not implemented"); 
                     echo "The service does not support '$val' content encoding";
                     return;
 
                 case 'HTTP_CONTENT_LANGUAGE': // RFC 2616 14.12
                     // we assume it is not critical if this one is ignored
                     // in the actual PUT implementation ...
                     $options["content_language"] = $value;
                     break;
 
                 case 'HTTP_CONTENT_LOCATION': // RFC 2616 14.14
                     /* The meaning of the Content-Location header in PUT 
                        or POST requests is undefined; servers are free 
                        to ignore it in those cases. */
                     break;
 
                 case 'HTTP_CONTENT_RANGE':    // RFC 2616 14.16
                     // single byte range requests are supported
                     // the header format is also specified in RFC 2616 14.16
                     // TODO we have to ensure that implementations support this or send 501 instead
                     if (!preg_match('@bytes\s+(\d+)-(\d+)/((\d+)|\*)@', $value, $matches)) {
                         $this->http_status("400 bad request"); 
                         echo "The service does only support single byte ranges";
                         return;
                     }
                     
                     $range = array("start"=>$matches[1], "end"=>$matches[2]);
                     if (is_numeric($matches[3])) {
                         $range["total_length"] = $matches[3];
                     }
                     $option["ranges"][] = $range;
 
                     // TODO make sure the implementation supports partial PUT
                     // this has to be done in advance to avoid data being overwritten
                     // on implementations that do not support this ...
                     break;
 
                 case 'HTTP_CONTENT_MD5':      // RFC 2616 14.15
                     // TODO: maybe we can just pretend here?
                     $this->http_status("501 not implemented"); 
                     echo "The service does not support content MD5 checksum verification"; 
                     return;
                     
                 case 'HTTP_CONTENT_LENGTH':
                         // defined on IIS and has the same value as CONTENT_LENGTH
                         break;
 
                 default: 
                     // any other unknown Content-* headers
                     $this->http_status("501 not implemented"); 
                     echo "The service does not support '$key'"; 
                     return;
                 }
             }
 
             $options["stream"] = fopen("php://input", "r");
 
             $stat = $this->PUT($options);
 
             if ($stat == false) {
                 $stat = "403 Forbidden";
             } else if (is_resource($stat) && get_resource_type($stat) == "stream") {
                 $stream = $stat;
 
                 $stat = $options["new"] ? "201 Created" : "204 No Content";
 
                 if (!empty($options["ranges"])) {
                     // TODO multipart support is missing (see also above)
                     if (0 == fseek($stream, $range[0]["start"], SEEK_SET)) {
                         $length = $range[0]["end"]-$range[0]["start"]+1;
                         if (!fwrite($stream, fread($options["stream"], $length))) {
                             $stat = "403 Forbidden"; 
                         }
                     } else {
                         $stat = "403 Forbidden"; 
                     }
                 } else {
                     while (!feof($options["stream"])) {
                         // BEGIN WebDAV W. Randelshofer explicitly compare with false. 
                         if (false === ($written = fwrite($stream, fread($options["stream"], 4096)))) {
                         // END WebDAV W. Randelshofer explicitly compare with false. 
                             $stat = "403 Forbidden"; 
                             break;
                         }
                         $count += $written;
                     }
                 }
 
                 fclose($stream);            
                 //$this->writelog('PUT wrote '.$written.' bytes');
                 // BEGIN WebDAV W. Randelshofer finish the put-operation
                 $this->PUTfinished($options);
                 // END WebDAV W. Randelshofer finish the put-operation
             } 
 
             $this->http_status($stat);
         } else {
             $this->http_status("423 Locked");
         }
     }

Here is the call graph for this function:

◆ http_status()

HTTP_WebDAV_Server::http_status ( $status )

set HTTP return status and mirror it in a private header

Parameters

string status code and message

Returns: void

Definition at line 1924 of file Server.php.

References header.

Referenced by _copymove(), http_DELETE(), http_GET(), http_HEAD(), http_LOCK(), http_MKCOL(), http_MOVE(), http_OPTIONS(), http_PROPFIND(), http_PROPPATCH(), http_PUT(), http_UNLOCK(), serveRequest(), and ilDAVServer\serveRequest().

     {
         // simplified success case
         if($status === true) {
             $status = "200 OK";
         }
         //$this->writelog('http_status('.$status.')');
         
         // remember status
         $this->_http_status = $status;
 
         // generate HTTP status response
         header("HTTP/1.1 $status");
         header("X-WebDAV-Status: $status", true);
     }

Here is the caller graph for this function:

◆ http_UNLOCK()

HTTP_WebDAV_Server::http_UNLOCK ( )

UNLOCK method handler.

Parameters

void

Returns: void

Definition at line 1422 of file Server.php.

References $_SERVER, $options, $path, and http_status().

     {
         $options = Array();
         $options["path"] = $this->path;
 
         if (isset($_SERVER['HTTP_DEPTH'])) {
             $options["depth"] = $_SERVER["HTTP_DEPTH"];
         } else {
             $options["depth"] = "infinity";
         }
 
         // strip surrounding <>
         $options["token"] = substr(trim($_SERVER["HTTP_LOCK_TOKEN"]), 1, -1);  
 //$this->writelog('http_UNLOCK HTTP_LOCK_TOKEN='.$_SERVER["HTTP_LOCK_TOKEN"]);
         // call user method
         $stat = $this->unlock($options);
 
         $this->http_status($stat);
     }

Here is the call graph for this function:

◆ lockdiscovery()

HTTP_WebDAV_Server::lockdiscovery ( $path )

Generate lockdiscovery reply from checklock() result.

Parameters

string resource path to check

Returns: string lockdiscovery response

Definition at line 1876 of file Server.php.

References time.

Referenced by http_PROPFIND().

     {
         // no lock support without checklock() method
         if (!method_exists($this, "checklock")) {
             return "";
         }
 
         // collect response here
         $activelocks = "";
 
         // get checklock() reply
         $lock = $this->checklock($path);
 
         // generate <activelock> block for returned data
         if (is_array($lock) && count($lock)) {
             // check for 'timeout' or 'expires'
             if (!empty($lock["expires"])) {
                 $timeout = "Second-".($lock["expires"] - time());
             } else if (!empty($lock["timeout"])) {
                 $timeout = "Second-$lock[timeout]";
             } else {
                 $timeout = "Infinite";
             }
 
             // genreate response block
             $activelocks.= "
               <D:activelock>
                <D:lockscope><D:$lock[scope]/></D:lockscope>
                <D:locktype><D:$lock[type]/></D:locktype>
                <D:depth>$lock[depth]</D:depth>
                <D:owner>$lock[owner]</D:owner>
                <D:timeout>$timeout</D:timeout>
                <D:locktoken><D:href>$lock[token]</D:href></D:locktoken>
               </D:activelock>
              ";
         }
         //$this->writelog('lockdiscovery('.$path.'):'.$activeclocks);
 
         // return generated response
         return $activelocks;
     }

Here is the caller graph for this function:

◆ mkprop()

HTTP_WebDAV_Server::mkprop ( )

helper for property element creation

Parameters

string	XML namespace (optional)
string	property name
string	property value

Returns: array property array

Definition at line 1551 of file Server.php.

References array.

Referenced by ilDAVServer\fileinfo(), and http_PROPFIND().

     {
         $args = func_get_args();
         if (count($args) == 3) {
             return array("ns"   => $args[0], 
                          "name" => $args[1],
                          "val"  => $args[2]);
         } else {
             return array("ns"   => "DAV:", 
                          "name" => $args[0],
                          "val"  => $args[1]);
         }
     }

Here is the caller graph for this function:

◆ serveRequest()

HTTP_WebDAV_Server::serveRequest ( )

Serve WebDAV HTTP request.

dispatch WebDAV HTTP request to the apropriate method handler

Parameters

void

Returns: void

Definition at line 125 of file Server.php.

References $_SERVER, $uri, _allow(), _check_auth(), _check_if_header_conditions(), _urldecode(), header, http_status(), and writelog().

     {
         // default uri is the complete request uri
                 // FIXME: use ilHTTPS::isDetected
         $uri = (@$_SERVER["HTTPS"] === "on" ? "https:" : "http:");
         $uri.= "//$_SERVER[HTTP_HOST]$_SERVER[SCRIPT_NAME]";
         
         $this->base_uri = $uri;
         $this->uri      = $uri . $_SERVER[PATH_INFO];
 
         // identify ourselves
         if (empty($this->dav_powered_by)) {
             header("X-Dav-Powered-By: PHP class: ".get_class($this));
         } else {
             header("X-Dav-Powered-By: ".$this->dav_powered_by );
         }
 
                 $this->writelog(__METHOD__.': Using uri: '.$this->uri);
 
         // check authentication
         if (!$this->_check_auth()) {
             // RFC2518 says we must use Digest instead of Basic
             // but Microsoft Clients do not support Digest
             // and we don't support NTLM and Kerberos
             // so we are stuck with Basic here
             header('WWW-Authenticate: Basic realm="'.($this->http_auth_realm).'"');
 
             // Windows seems to require this being the last header sent
             // (changed according to PECL bug #3138)
             $this->http_status('401 Unauthorized');
                         $this->writelog('Check auth failed');
 
             return;
         }
         
         // check 
         if(! $this->_check_if_header_conditions()) {
                 $this->writelog(__METHOD__.': Precondition failed.');
             $this->http_status("412 Precondition failed");
             return;
         }
         
         // set path
         $this->path = $this->_urldecode($_SERVER["PATH_INFO"]);
         if (!strlen($this->path)) {
             header("Location: ".$this->base_uri."/");
                         $this->writelog('HTTP_WebDAV_Server.ServeRequest() missing path info');
                         $this->path = '/';
             //exit;
         }
         // BEGIN WebDAV: Don't strip backslashes. Backslashes are a valid part of a unix filename!
         /*
         if(ini_get("magic_quotes_gpc")) {
             $this->path = stripslashes($this->path);
         }*/
         // END PATCH WebDAV: Don't strip backslashes. Backslashes are a valid part of a unix filename!
         
         
         // detect requested method names
         $method = strtolower($_SERVER["REQUEST_METHOD"]);
         $wrapper = "http_".$method;
         
                 $this->writelog(__METHOD__.': Using request method: '.$method);
         
         // activate HEAD emulation by GET if no HEAD method found
         if ($method == "head" && !method_exists($this, "head")) 
                 {
             $method = "get";
                         $this->writelog(__METHOD__.': Using head emulation by get.');
         }
         
         if (method_exists($this, $wrapper) && ($method == "options" || method_exists($this, $method))) 
                 {
             $this->writelog(__METHOD__.': Calling wrapper: '.$wrapper);
                         $this->$wrapper();  // call method by name
         } 
                 else 
                 { // method not found/implemented
             if ($_SERVER["REQUEST_METHOD"] == "LOCK") 
                         {
                                 $this->writelog(__METHOD__.': Method not found/implemented. Sending 412');
                 $this->http_status("412 Precondition failed");
             } 
                         else 
                         {
                                 $this->writelog(__METHOD__.': Method not found/implemented. Sending allowd methods');
                 $this->http_status("405 Method not allowed");
                 header("Allow: ".join(", ", $this->_allow()));  // tell client what's allowed
             }
         }
     }

Here is the call graph for this function:

◆ writelog()

HTTP_WebDAV_Server::writelog ( $message )

private

Writes a message to the logfile.,.

Parameters

message String.

Returns: void.

Definition at line 2016 of file Server.php.

References $DIC, $ilUser, and $log.

Referenced by http_OPTIONS(), and serveRequest().

         {
                 global $DIC;
                 $log = $DIC['log'];
                 $ilUser = $DIC['ilUser'];
                 
                 $log->write(
                         $ilUser->getLogin()
                         .' DAV Server.'.str_replace("\n",";",$message)
                 );
         }

Here is the caller graph for this function:

Field Documentation

◆ $_http_status

HTTP_WebDAV_Server::$_http_status = "200 OK"

Definition at line 90 of file Server.php.

◆ $_if_header_uris

HTTP_WebDAV_Server::$_if_header_uris = array()

Definition at line 83 of file Server.php.

◆ $_prop_encoding

HTTP_WebDAV_Server::$_prop_encoding = "utf-8"

Definition at line 97 of file Server.php.

◆ $base_uri

HTTP_WebDAV_Server::$base_uri

Definition at line 54 of file Server.php.

◆ $dav_powered_by

HTTP_WebDAV_Server::$dav_powered_by = ""

Definition at line 76 of file Server.php.

◆ $http_auth_realm

HTTP_WebDAV_Server::$http_auth_realm = "PHP WebDAV"

Definition at line 69 of file Server.php.

◆ $path

HTTP_WebDAV_Server::$path

◆ $uri

HTTP_WebDAV_Server::$uri

Definition at line 46 of file Server.php.

Referenced by _check_if_header_conditions(), _if_header_parser(), ilDAVServer\getFileURI(), ilDAVServer\getFolderURI(), ilDAVServer\getMountURI(), ilDAVServer\getObjectURI(), and serveRequest().

The documentation for this class was generated from the following file:

Services/WebDAV/classes/Server.php

Public Member Functions

Data Fields

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _allow()

◆ _check_auth()

◆ _check_if_header_conditions()

◆ _check_lock_status()

◆ _check_uri_condition()

◆ _copymove()

◆ _get_ranges()

◆ _if_header_lexer()

◆ _if_header_parser()

◆ _multipart_byterange_header()

◆ _new_locktoken()

◆ _new_uuid()

◆ _prop_encode()

◆ _slashify()

◆ _urldecode()

◆ _urlencode()

◆ http_COPY()

◆ http_DELETE()

◆ http_GET()

◆ http_HEAD()

◆ http_LOCK()

◆ http_MKCOL()

◆ http_MOVE()

◆ http_OPTIONS()

◆ http_PROPFIND()

◆ http_PROPPATCH()

◆ http_PUT()

◆ http_status()

◆ http_UNLOCK()

◆ lockdiscovery()

◆ mkprop()

◆ serveRequest()

◆ writelog()

Field Documentation

◆ $_http_status

◆ $_if_header_uris

◆ $_prop_encoding

◆ $base_uri

◆ $dav_powered_by

◆ $http_auth_realm

◆ $path

◆ $uri