Inheritance diagram for Sabre\DAV\Browser\Plugin:

Collaboration diagram for Sabre\DAV\Browser\Plugin:

Public Member Functions
	__construct ($enablePost=true)
	Creates the object. More...

	initialize (DAV\Server $server)
	Initializes the plugin and subscribes to events. More...

	httpGetEarly (RequestInterface $request, ResponseInterface $response)
	This method intercepts GET requests that have ?sabreAction=info appended to the URL. More...

	httpGet (RequestInterface $request, ResponseInterface $response)
	This method intercepts GET requests to collections and returns the html. More...

	httpPOST (RequestInterface $request, ResponseInterface $response)
	Handles POST requests for tree operations. More...

	escapeHTML ($value)
	Escapes a string for html. More...

	generateDirectoryIndex ($path)
	Generates the html directory index for a given url. More...

	generatePluginListing ()
	Generates the 'plugins' page. More...

	generateHeader ($title, $path=null)
	Generates the first block of HTML, including the <head> tag and page header. More...

	generateFooter ()
	Generates the page footer. More...

	htmlActionsPanel (DAV\INode $node, &$output, $path)
	This method is used to generate the 'actions panel' output for collections. More...

	getPluginName ()
	Returns a plugin name. More...

	getPluginInfo ()
	Returns a bunch of meta-data about the plugin. More...

Public Member Functions inherited from Sabre\DAV\ServerPlugin
	initialize (Server $server)
	This initializes the plugin. More...

	getFeatures ()
	This method should return a list of server-features. More...

	getHTTPMethods ($path)
	Use this method to tell the server this plugin defines additional HTTP methods. More...

	getPluginName ()
	Returns a plugin name. More...

	getSupportedReportSet ($uri)
	Returns a list of reports this plugin supports. More...

	getPluginInfo ()
	Returns a bunch of meta-data about the plugin. More...

Data Fields
	$uninterestingProperties

Protected Member Functions
	getAssetUrl ($assetName)
	This method takes a path/name of an asset and turns it into url suiteable for http access. More...

	getLocalAssetPath ($assetName)
	This method returns a local pathname to an asset. More...

	serveAsset ($assetName)
	This method reads an asset from disk and generates a full http response. More...

	compareNodes ($a, $b)
	Sort helper function: compares two directory entries based on type and display name. More...

Protected Attributes
	$server

	$enablePost = true

Private Member Functions
	mapResourceType (array $resourceTypes, $node)
	Maps a resource type to a human-readable string and icon. More...

	drawPropertyRow ($name, $value)
	Draws a table row for a property. More...

	drawPropertyValue ($html, $value)
	Draws a table row for a property. More...

Detailed Description

Browser Plugin.

This plugin provides a html representation, so that a WebDAV server may be accessed using a browser.

The class intercepts GET requests to collection resources and generates a simple html index.

Copyright: Copyright (C) fruux GmbH (https://fruux.com/)

Author: Evert Pot (http://evertpot.com/) @license http://sabre.io/license/ Modified BSD License

Definition at line 24 of file Plugin.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\DAV\Browser\Plugin::__construct ( $enablePost = true )

Creates the object.

By default it will allow file creation and uploads. Specify the first argument as false to disable this

Parameters

bool $enablePost

Definition at line 63 of file Plugin.php.

                                             {
 
        $this->enablePost = $enablePost;
 
    }

References Sabre\DAV\Browser\Plugin\$enablePost.

Member Function Documentation

◆ compareNodes()

Sabre\DAV\Browser\Plugin::compareNodes	(	$a,
		$b
	)

protected

Sort helper function: compares two directory entries based on type and display name.

Collections sort above other types.

Parameters

array	$a
array	$b

Returns: int

Definition at line 608 of file Plugin.php.

                                            {
 
        $typeA = (isset($a['{DAV:}resourcetype']))
            ? (in_array('{DAV:}collection', $a['{DAV:}resourcetype']->getValue()))
            : false;
 
        $typeB = (isset($b['{DAV:}resourcetype']))
            ? (in_array('{DAV:}collection', $b['{DAV:}resourcetype']->getValue()))
            : false;
 
        // If same type, sort alphabetically by filename:
        if ($typeA === $typeB) {
            return strnatcasecmp($a['displayPath'], $b['displayPath']);
        }
        return (($typeA < $typeB) ? 1 : -1);
 
    }

◆ drawPropertyRow()

Sabre\DAV\Browser\Plugin::drawPropertyRow	(	$name,
		$value
	)

private

Draws a table row for a property.

Parameters

string	$name
mixed	$value

Returns: string

Definition at line 726 of file Plugin.php.

                                                    {
 
        $html = new HtmlOutputHelper(
            $this->server->getBaseUri(),
            $this->server->xml->namespaceMap
        );
 
        return "<tr><th>" . $html->xmlName($name) . "</th><td>" . $this->drawPropertyValue($html, $value) . "</td></tr>";
 
    }

References $html, $name, and Sabre\DAV\Browser\Plugin\drawPropertyValue().

Referenced by Sabre\DAV\Browser\Plugin\generateDirectoryIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ drawPropertyValue()

Sabre\DAV\Browser\Plugin::drawPropertyValue	(	$html,
		$value
	)

private

Draws a table row for a property.

Parameters

HtmlOutputHelper	$html
mixed	$value

Returns: string

Definition at line 744 of file Plugin.php.

                                                      {
 
        if (is_scalar($value)) {
            return $html->h($value);
        } elseif ($value instanceof HtmlOutput) {
            return $value->toHtml($html);
        } elseif ($value instanceof \Sabre\Xml\XmlSerializable) {
 
            // There's no default html output for this property, we're going
            // to output the actual xml serialization instead.
            $xml = $this->server->xml->write('{DAV:}root', $value, $this->server->getBaseUri());
            // removing first and last line, as they contain our root
            // element.
            $xml = explode("\n", $xml);
            $xml = array_slice($xml, 2, -2);
            return "<pre>" . $html->h(implode("\n", $xml)) . "</pre>";
 
        } else {
            return "<em>unknown</em>";
        }
 
    }

References $html, and $xml.

Referenced by Sabre\DAV\Browser\Plugin\drawPropertyRow().

Here is the caller graph for this function:

◆ escapeHTML()

Sabre\DAV\Browser\Plugin::escapeHTML ( $value )

Escapes a string for html.

Parameters

string $value

Returns: string

Definition at line 253 of file Plugin.php.

                                {
 
        return htmlspecialchars($value, ENT_QUOTES, 'UTF-8');
 
    }

Referenced by Sabre\DAV\Browser\Plugin\generateDirectoryIndex(), Sabre\DAV\Browser\Plugin\generateHeader(), and Sabre\DAV\Browser\Plugin\generatePluginListing().

Here is the caller graph for this function:

◆ generateDirectoryIndex()

Sabre\DAV\Browser\Plugin::generateDirectoryIndex ( $path )

Generates the html directory index for a given url.

Parameters

string $path

Returns: string

Reimplemented in ilWebDAVSabreBrowserPlugin.

Definition at line 265 of file Plugin.php.

                                           {
 
        $html = $this->generateHeader($path ? $path : '/', $path);
 
        $node = $this->server->tree->getNodeForPath($path);
        if ($node instanceof DAV\ICollection) {
 
            $html .= "<section><h1>Nodes</h1>\n";
            $html .= "<table class=\"nodeTable\">";
 
            $subNodes = $this->server->getPropertiesForChildren($path, [
                '{DAV:}displayname',
                '{DAV:}resourcetype',
                '{DAV:}getcontenttype',
                '{DAV:}getcontentlength',
                '{DAV:}getlastmodified',
            ]);
 
            foreach ($subNodes as $subPath => $subProps) {
 
                $subNode = $this->server->tree->getNodeForPath($subPath);
                $fullPath = $this->server->getBaseUri() . URLUtil::encodePath($subPath);
                list(, $displayPath) = URLUtil::splitPath($subPath);
 
                $subNodes[$subPath]['subNode'] = $subNode;
                $subNodes[$subPath]['fullPath'] = $fullPath;
                $subNodes[$subPath]['displayPath'] = $displayPath;
            }
            uasort($subNodes, [$this, 'compareNodes']);
 
            foreach ($subNodes as $subProps) {
                $type = [
                    'string' => 'Unknown',
                    'icon'   => 'cog',
                ];
                if (isset($subProps['{DAV:}resourcetype'])) {
                    $type = $this->mapResourceType($subProps['{DAV:}resourcetype']->getValue(), $subProps['subNode']);
                }
 
                $html .= '<tr>';
                $html .= '<td class="nameColumn"><a href="' . $this->escapeHTML($subProps['fullPath']) . '"><span class="oi" data-glyph="' . $this->escapeHTML($type['icon']) . '"></span> ' . $this->escapeHTML($subProps['displayPath']) . '</a></td>';
                $html .= '<td class="typeColumn">' . $this->escapeHTML($type['string']) . '</td>';
                $html .= '<td>';
                if (isset($subProps['{DAV:}getcontentlength'])) {
                    $html .= $this->escapeHTML($subProps['{DAV:}getcontentlength'] . ' bytes');
                }
                $html .= '</td><td>';
                if (isset($subProps['{DAV:}getlastmodified'])) {
                    $lastMod = $subProps['{DAV:}getlastmodified']->getTime();
                    $html .= $this->escapeHTML($lastMod->format('F j, Y, g:i a'));
                }
                $html .= '</td>';
 
                $buttonActions = '';
                if ($subProps['subNode'] instanceof DAV\IFile) {
                    $buttonActions = '<a href="' . $this->escapeHTML($subProps['fullPath']) . '?sabreAction=info"><span class="oi" data-glyph="info"></span></a>';
                }
                $this->server->emit('browserButtonActions', [$subProps['fullPath'], $subProps['subNode'], &$buttonActions]);
 
                $html .= '<td>' . $buttonActions . '</td>';
                $html .= '</tr>';
            }
 
            $html .= '</table>';
 
        }
 
        $html .= "</section>";
        $html .= "<section><h1>Properties</h1>";
        $html .= "<table class=\"propTable\">";
 
        // Allprops request
        $propFind = new PropFindAll($path);
        $properties = $this->server->getPropertiesByNode($propFind, $node);
 
        $properties = $propFind->getResultForMultiStatus()[200];
 
        foreach ($properties as $propName => $propValue) {
            if (!in_array($propName, $this->uninterestingProperties)) {
                $html .= $this->drawPropertyRow($propName, $propValue);
            }
 
        }
 
 
        $html .= "</table>";
        $html .= "</section>";
 
        /* Start of generating actions */
 
        $output = '';
        if ($this->enablePost) {
            $this->server->emit('onHTMLActionsPanel', [$node, &$output, $path]);
        }
 
        if ($output) {
 
            $html .= "<section><h1>Actions</h1>";
            $html .= "<div class=\"actions\">\n";
            $html .= $output;
            $html .= "</div>\n";
            $html .= "</section>\n";
        }
 
        $html .= $this->generateFooter();
 
        $this->server->httpResponse->setHeader('Content-Security-Policy', "default-src 'none'; img-src 'self'; style-src 'self'; font-src 'self';");
 
        return $html;
 
    }

References $html, Sabre\VObject\$output, $path, $type, Sabre\DAV\Browser\Plugin\drawPropertyRow(), Sabre\HTTP\URLUtil\encodePath(), Sabre\DAV\Browser\Plugin\escapeHTML(), Sabre\DAV\Browser\Plugin\generateFooter(), Sabre\DAV\Browser\Plugin\generateHeader(), Sabre\DAV\Browser\Plugin\mapResourceType(), and Sabre\HTTP\URLUtil\splitPath().

Referenced by Sabre\DAV\Browser\Plugin\httpGet().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateFooter()

Sabre\DAV\Browser\Plugin::generateFooter ( )

Generates the page footer.

Returns html.

Returns: string

Definition at line 479 of file Plugin.php.

                              {
 
        $version = '';
        if (DAV\Server::$exposeVersion) {
            $version = DAV\Version::VERSION;
        }
        return <<<HTML
<footer>Generated by SabreDAV $version (c)2007-2016 <a href="http://sabre.io/">http://sabre.io/</a></footer>
</body>
</html>
HTML;
 
    }

References Sabre\DAV\Server\$exposeVersion, $version, html(), ILIAS\FileDelivery\http(), and Sabre\DAV\Version\VERSION.

Referenced by Sabre\DAV\Browser\Plugin\generateDirectoryIndex(), and Sabre\DAV\Browser\Plugin\generatePluginListing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateHeader()

Sabre\DAV\Browser\Plugin::generateHeader	(	$title,
		$path = `null`
	)

Generates the first block of HTML, including the <head> tag and page header.

Returns footer.

Parameters

string	$title
string	$path

Returns: string

Definition at line 419 of file Plugin.php.

                                                  {
 
        $version = '';
        if (DAV\Server::$exposeVersion) {
            $version = DAV\Version::VERSION;
        }
 
        $vars = [
            'title'     => $this->escapeHTML($title),
            'favicon'   => $this->escapeHTML($this->getAssetUrl('favicon.ico')),
            'style'     => $this->escapeHTML($this->getAssetUrl('sabredav.css')),
            'iconstyle' => $this->escapeHTML($this->getAssetUrl('openiconic/open-iconic.css')),
            'logo'      => $this->escapeHTML($this->getAssetUrl('sabredav.png')),
            'baseUrl'   => $this->server->getBaseUri(),
        ];
 
        $html = <<<HTML
<!DOCTYPE html>
<html>
<head>
    <title>$vars[title] - sabre/dav $version</title>
    <link rel="shortcut icon" href="$vars[favicon]"   type="image/vnd.microsoft.icon" />
    <link rel="stylesheet"    href="$vars[style]"     type="text/css" />
    <link rel="stylesheet"    href="$vars[iconstyle]" type="text/css" />
 
</head>
<body>
    <header>
        <div class="logo">
            <a href="$vars[baseUrl]"><img src="$vars[logo]" alt="sabre/dav" /> $vars[title]</a>
        </div>
    </header>
 
    <nav>
HTML;
 
        // If the path is empty, there's no parent.
        if ($path)  {
            list($parentUri) = URLUtil::splitPath($path);
            $fullPath = $this->server->getBaseUri() . URLUtil::encodePath($parentUri);
            $html .= '<a href="' . $fullPath . '" class="btn">⇤ Go to parent</a>';
        } else {
            $html .= '<span class="btn disabled">⇤ Go to parent</span>';
        }
 
        $html .= ' <a href="?sabreAction=plugins" class="btn"><span class="oi" data-glyph="puzzle-piece"></span> Plugins</a>';
 
        $html .= "</nav>";
 
        return $html;
 
    }

References Sabre\DAV\Server\$exposeVersion, $html, $path, $title, $version, Sabre\HTTP\URLUtil\encodePath(), Sabre\DAV\Browser\Plugin\escapeHTML(), Sabre\DAV\Browser\Plugin\getAssetUrl(), html(), Sabre\HTTP\URLUtil\splitPath(), and Sabre\DAV\Version\VERSION.

Referenced by Sabre\DAV\Browser\Plugin\generateDirectoryIndex(), and Sabre\DAV\Browser\Plugin\generatePluginListing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generatePluginListing()

Sabre\DAV\Browser\Plugin::generatePluginListing ( )

Generates the 'plugins' page.

Returns: string

Definition at line 382 of file Plugin.php.

                                     {
 
        $html = $this->generateHeader('Plugins');
 
        $html .= "<section><h1>Plugins</h1>";
        $html .= "<table class=\"propTable\">";
        foreach ($this->server->getPlugins() as $plugin) {
            $info = $plugin->getPluginInfo();
            $html .= '<tr><th>' . $info['name'] . '</th>';
            $html .= '<td>' . $info['description'] . '</td>';
            $html .= '<td>';
            if (isset($info['link']) && $info['link']) {
                $html .= '<a href="' . $this->escapeHTML($info['link']) . '"><span class="oi" data-glyph="book"></span></a>';
            }
            $html .= '</td></tr>';
        }
        $html .= "</table>";
        $html .= "</section>";
 
        /* Start of generating actions */
 
        $html .= $this->generateFooter();
 
        return $html;
 
    }

References $html, $info, Sabre\DAV\Browser\Plugin\escapeHTML(), Sabre\DAV\Browser\Plugin\generateFooter(), and Sabre\DAV\Browser\Plugin\generateHeader().

Referenced by Sabre\DAV\Browser\Plugin\httpGet().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssetUrl()

Sabre\DAV\Browser\Plugin::getAssetUrl ( $assetName )

protected

This method takes a path/name of an asset and turns it into url suiteable for http access.

Parameters

string $assetName

Returns: string

Definition at line 540 of file Plugin.php.

                                               {
 
        return $this->server->getBaseUri() . '?sabreAction=asset&assetName=' . urlencode($assetName);
 
    }

Referenced by Sabre\DAV\Browser\Plugin\generateHeader().

Here is the caller graph for this function:

◆ getLocalAssetPath()

Sabre\DAV\Browser\Plugin::getLocalAssetPath ( $assetName )

protected

This method returns a local pathname to an asset.

Parameters

string $assetName

Exceptions

DAV

Exception\NotFound

Returns: string

Definition at line 553 of file Plugin.php.

                                                     {
 
        $assetDir = __DIR__ . '/assets/';
        $path = $assetDir . $assetName;
 
        // Making sure people aren't trying to escape from the base path.
        $path = str_replace('\\', '/', $path);
        if (strpos($path, '/../') !== false || strrchr($path, '/') === '/..') {
            throw new DAV\Exception\NotFound('Path does not exist, or escaping from the base path was detected');
        }
        if (strpos(realpath($path), realpath($assetDir)) === 0 && file_exists($path)) {
            return $path;
        }
        throw new DAV\Exception\NotFound('Path does not exist, or escaping from the base path was detected');
    }

References $path.

Referenced by Sabre\DAV\Browser\Plugin\serveAsset().

Here is the caller graph for this function:

◆ getPluginInfo()

Sabre\DAV\Browser\Plugin::getPluginInfo ( )

Returns a bunch of meta-data about the plugin.

Providing this information is optional, and is mainly displayed by the Browser plugin.

The description key in the returned array may contain html and will not be sanitized.

Returns: array

Reimplemented from Sabre\DAV\ServerPlugin.

Definition at line 792 of file Plugin.php.

                             {
 
        return [
            'name'        => $this->getPluginName(),
            'description' => 'Generates HTML indexes and debug information for your sabre/dav server',
            'link'        => 'http://sabre.io/dav/browser-plugin/',
        ];
 
    }

References Sabre\DAV\Browser\Plugin\getPluginName().

Here is the call graph for this function:

◆ getPluginName()

Sabre\DAV\Browser\Plugin::getPluginName ( )

Returns a plugin name.

Using this name other plugins will be able to access other plugins; using \Sabre\DAV\Server::getPlugin

Returns: string

Reimplemented from Sabre\DAV\ServerPlugin.

Definition at line 775 of file Plugin.php.

                             {
 
        return 'browser';
 
    }

Referenced by Sabre\DAV\Browser\Plugin\getPluginInfo().

Here is the caller graph for this function:

◆ htmlActionsPanel()

Sabre\DAV\Browser\Plugin::htmlActionsPanel	(	DAV\INode	$node,
		&	$output,
			$path
	)

This method is used to generate the 'actions panel' output for collections.

This specifically generates the interfaces for creating new files, and creating new directories.

Parameters

DAV\INode	$node
mixed	$output
string	$path

Returns: void

Definition at line 505 of file Plugin.php.

                                                                {
 
        if (!$node instanceof DAV\ICollection)
            return;
 
        // We also know fairly certain that if an object is a non-extended
        // SimpleCollection, we won't need to show the panel either.
        if (get_class($node) === 'Sabre\\DAV\\SimpleCollection')
            return;
 
        $output .= <<<HTML
<form method="post" action="">
<h3>Create new folder</h3>
<input type="hidden" name="sabreAction" value="mkcol" />
<label>Name:</label> <input type="text" name="name" /><br />
<input type="submit" value="create" />
</form>
<form method="post" action="" enctype="multipart/form-data">
<h3>Upload file</h3>
<input type="hidden" name="sabreAction" value="put" />
<label>Name (optional):</label> <input type="text" name="name" /><br />
<label>File:</label> <input type="file" name="file" /><br />
<input type="submit" value="upload" />
</form>
HTML;
 
    }

References Sabre\VObject\$output, and input.

◆ httpGet()

Sabre\DAV\Browser\Plugin::httpGet	(	RequestInterface	$request,
		ResponseInterface	$response
	)

This method intercepts GET requests to collections and returns the html.

Parameters

RequestInterface	$request
ResponseInterface	$response

Returns: bool

Definition at line 108 of file Plugin.php.

                                                                             {
 
        // We're not using straight-up $_GET, because we want everything to be
        // unit testable.
        $getVars = $request->getQueryParameters();
 
        // CSP headers
        $response->setHeader('Content-Security-Policy', "default-src 'none'; img-src 'self'; style-src 'self'; font-src 'self';");
 
        $sabreAction = isset($getVars['sabreAction']) ? $getVars['sabreAction'] : null;
 
        switch ($sabreAction) {
 
            case 'asset' :
                // Asset handling, such as images
                $this->serveAsset(isset($getVars['assetName']) ? $getVars['assetName'] : null);
                return false;
            default :
            case 'info' :
                try {
                    $this->server->tree->getNodeForPath($request->getPath());
                } catch (DAV\Exception\NotFound $e) {
                    // We're simply stopping when the file isn't found to not interfere
                    // with other plugins.
                    return;
                }
 
                $response->setStatus(200);
                $response->setHeader('Content-Type', 'text/html; charset=utf-8');
 
                $response->setBody(
                    $this->generateDirectoryIndex($request->getPath())
                );
 
                return false;
 
            case 'plugins' :
                $response->setStatus(200);
                $response->setHeader('Content-Type', 'text/html; charset=utf-8');
 
                $response->setBody(
                    $this->generatePluginListing()
                );
 
                return false;
 
        }
 
    }

References $request, $response, Sabre\DAV\Browser\Plugin\generateDirectoryIndex(), Sabre\DAV\Browser\Plugin\generatePluginListing(), Sabre\HTTP\RequestInterface\getPath(), and Sabre\DAV\Browser\Plugin\serveAsset().

Referenced by Sabre\DAV\Browser\Plugin\httpGetEarly().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ httpGetEarly()

Sabre\DAV\Browser\Plugin::httpGetEarly	(	RequestInterface	$request,
		ResponseInterface	$response
	)

This method intercepts GET requests that have ?sabreAction=info appended to the URL.

Parameters

RequestInterface	$request
ResponseInterface	$response

Returns: bool

Definition at line 92 of file Plugin.php.

                                                                                  {
 
        $params = $request->getQueryParameters();
        if (isset($params['sabreAction']) && $params['sabreAction'] === 'info') {
            return $this->httpGet($request, $response);
        }
 
    }

References PHPMailer\PHPMailer\$params, $request, $response, and Sabre\DAV\Browser\Plugin\httpGet().

Here is the call graph for this function:

◆ httpPOST()

Sabre\DAV\Browser\Plugin::httpPOST	(	RequestInterface	$request,
		ResponseInterface	$response
	)

Handles POST requests for tree operations.

Parameters

RequestInterface	$request
ResponseInterface	$response

Returns: bool

Definition at line 165 of file Plugin.php.

                                                                              {
 
        $contentType = $request->getHeader('Content-Type');
        list($contentType) = explode(';', $contentType);
        if ($contentType !== 'application/x-www-form-urlencoded' &&
            $contentType !== 'multipart/form-data') {
                return;
        }
        $postVars = $request->getPostData();
 
        if (!isset($postVars['sabreAction']))
            return;
 
        $uri = $request->getPath();
 
        if ($this->server->emit('onBrowserPostAction', [$uri, $postVars['sabreAction'], $postVars])) {
 
            switch ($postVars['sabreAction']) {
 
                case 'mkcol' :
                    if (isset($postVars['name']) && trim($postVars['name'])) {
                        // Using basename() because we won't allow slashes
                        list(, $folderName) = URLUtil::splitPath(trim($postVars['name']));
 
                        if (isset($postVars['resourceType'])) {
                            $resourceType = explode(',', $postVars['resourceType']);
                        } else {
                            $resourceType = ['{DAV:}collection'];
                        }
 
                        $properties = [];
                        foreach ($postVars as $varName => $varValue) {
                            // Any _POST variable in clark notation is treated
                            // like a property.
                            if ($varName[0] === '{') {
                                // PHP will convert any dots to underscores.
                                // This leaves us with no way to differentiate
                                // the two.
                                // Therefore we replace the string *DOT* with a
                                // real dot. * is not allowed in uris so we
                                // should be good.
                                $varName = str_replace('*DOT*', '.', $varName);
                                $properties[$varName] = $varValue;
                            }
                        }
 
                        $mkCol = new MkCol(
                            $resourceType,
                            $properties
                        );
                        $this->server->createCollection($uri . '/' . $folderName, $mkCol);
                    }
                    break;
 
                // @codeCoverageIgnoreStart
                case 'put' :
 
                    if ($_FILES) $file = current($_FILES);
                    else break;
 
                    list(, $newName) = URLUtil::splitPath(trim($file['name']));
                    if (isset($postVars['name']) && trim($postVars['name']))
                        $newName = trim($postVars['name']);
 
                    // Making sure we only have a 'basename' component
                    list(, $newName) = URLUtil::splitPath($newName);
 
                    if (is_uploaded_file($file['tmp_name'])) {
                        $this->server->createFile($uri . '/' . $newName, fopen($file['tmp_name'], 'r'));
                    }
                    break;
                // @codeCoverageIgnoreEnd
 
            }
 
        }
        $response->setHeader('Location', $request->getUrl());
        $response->setStatus(302);
        return false;
 
    }

References $contentType, $request, $response, and Sabre\HTTP\URLUtil\splitPath().

Here is the call graph for this function:

◆ initialize()

Sabre\DAV\Browser\Plugin::initialize ( DAV\Server $server )

Initializes the plugin and subscribes to events.

Parameters

DAV\Server $server

Returns: void

Definition at line 75 of file Plugin.php.

                                            {
 
        $this->server = $server;
        $this->server->on('method:GET', [$this, 'httpGetEarly'], 90);
        $this->server->on('method:GET', [$this, 'httpGet'], 200);
        $this->server->on('onHTMLActionsPanel', [$this, 'htmlActionsPanel'], 200);
        if ($this->enablePost) $this->server->on('method:POST', [$this, 'httpPOST']);
    }

References Sabre\DAV\Browser\Plugin\$server.

◆ mapResourceType()

Sabre\DAV\Browser\Plugin::mapResourceType	(	array	$resourceTypes,
			$node
	)

private

Maps a resource type to a human-readable string and icon.

Parameters

array	$resourceTypes
DAV\INode	$node

Returns: array

Definition at line 633 of file Plugin.php.

                                                                  {
 
        if (!$resourceTypes) {
            if ($node instanceof DAV\IFile) {
                return [
                    'string' => 'File',
                    'icon'   => 'file',
                ];
            } else {
                return [
                    'string' => 'Unknown',
                    'icon'   => 'cog',
                ];
            }
        }
 
        $types = [
            '{http://calendarserver.org/ns/}calendar-proxy-write' => [
                'string' => 'Proxy-Write',
                'icon'   => 'people',
            ],
            '{http://calendarserver.org/ns/}calendar-proxy-read' => [
                'string' => 'Proxy-Read',
                'icon'   => 'people',
            ],
            '{urn:ietf:params:xml:ns:caldav}schedule-outbox' => [
                'string' => 'Outbox',
                'icon'   => 'inbox',
            ],
            '{urn:ietf:params:xml:ns:caldav}schedule-inbox' => [
                'string' => 'Inbox',
                'icon'   => 'inbox',
            ],
            '{urn:ietf:params:xml:ns:caldav}calendar' => [
                'string' => 'Calendar',
                'icon'   => 'calendar',
            ],
            '{http://calendarserver.org/ns/}shared-owner' => [
                'string' => 'Shared',
                'icon'   => 'calendar',
            ],
            '{http://calendarserver.org/ns/}subscribed' => [
                'string' => 'Subscription',
                'icon'   => 'calendar',
            ],
            '{urn:ietf:params:xml:ns:carddav}directory' => [
                'string' => 'Directory',
                'icon'   => 'globe',
            ],
            '{urn:ietf:params:xml:ns:carddav}addressbook' => [
                'string' => 'Address book',
                'icon'   => 'book',
            ],
            '{DAV:}principal' => [
                'string' => 'Principal',
                'icon'   => 'person',
            ],
            '{DAV:}collection' => [
                'string' => 'Collection',
                'icon'   => 'folder',
            ],
        ];
 
        $info = [
            'string' => [],
            'icon'   => 'cog',
        ];
        foreach ($resourceTypes as $k => $resourceType) {
            if (isset($types[$resourceType])) {
                $info['string'][] = $types[$resourceType]['string'];
            } else {
                $info['string'][] = $resourceType;
            }
        }
        foreach ($types as $key => $resourceInfo) {
            if (in_array($key, $resourceTypes)) {
                $info['icon'] = $resourceInfo['icon'];
                break;
            }
        }
        $info['string'] = implode(', ', $info['string']);
 
        return $info;
 
    }

References $info, and $key.

Referenced by Sabre\DAV\Browser\Plugin\generateDirectoryIndex().

Here is the caller graph for this function:

◆ serveAsset()

Sabre\DAV\Browser\Plugin::serveAsset ( $assetName )

protected

This method reads an asset from disk and generates a full http response.

Parameters

string $assetName

Returns: void

Definition at line 575 of file Plugin.php.

                                              {
 
        $assetPath = $this->getLocalAssetPath($assetName);
 
        // Rudimentary mime type detection
        $mime = 'application/octet-stream';
        $map = [
            'ico' => 'image/vnd.microsoft.icon',
            'png' => 'image/png',
            'css' => 'text/css',
        ];
 
        $ext = substr($assetName, strrpos($assetName, '.') + 1);
        if (isset($map[$ext])) {
            $mime = $map[$ext];
        }
 
        $this->server->httpResponse->setHeader('Content-Type', $mime);
        $this->server->httpResponse->setHeader('Content-Length', filesize($assetPath));
        $this->server->httpResponse->setHeader('Cache-Control', 'public, max-age=1209600');
        $this->server->httpResponse->setStatus(200);
        $this->server->httpResponse->setBody(fopen($assetPath, 'r'));
 
    }

References $map, and Sabre\DAV\Browser\Plugin\getLocalAssetPath().

Referenced by Sabre\DAV\Browser\Plugin\httpGet().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $enablePost

Sabre\DAV\Browser\Plugin::$enablePost = true

protected

Definition at line 39 of file Plugin.php.

Referenced by Sabre\DAV\Browser\Plugin\__construct().

◆ $server

Sabre\DAV\Browser\Plugin::$server

protected

Definition at line 31 of file Plugin.php.

Referenced by Sabre\DAV\Browser\Plugin\initialize().

◆ $uninterestingProperties

Sabre\DAV\Browser\Plugin::$uninterestingProperties

Initial value:

= [
        '{DAV:}supportedlock',
        '{DAV:}acl-restrictions',
 
        '{DAV:}supported-method-set',
    ]

Definition at line 48 of file Plugin.php.

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

libs/composer/vendor/sabre/dav/lib/DAV/Browser/Plugin.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ compareNodes()

◆ drawPropertyRow()

◆ drawPropertyValue()

◆ escapeHTML()

◆ generateDirectoryIndex()

◆ generateFooter()

◆ generateHeader()

◆ generatePluginListing()

◆ getAssetUrl()

◆ getLocalAssetPath()

◆ getPluginInfo()

◆ getPluginName()

◆ htmlActionsPanel()

◆ httpGet()

◆ httpGetEarly()

◆ httpPOST()

◆ initialize()

◆ mapResourceType()

◆ serveAsset()

Field Documentation

◆ $enablePost

◆ $server

◆ $uninterestingProperties