Page MenuHomePhabricator
Files F1841543

HomeCollection.php
No OneTemporary
Actions

HomeCollection.php
View Options

<?php
namespace Sabre\DAVACL\FS;
use Sabre\DAV\Exception\Forbidden;
use Sabre\DAVACL\AbstractPrincipalCollection;
use Sabre\DAVACL\IACL;
use Sabre\DAVACL\PrincipalBackend\BackendInterface;
use Sabre\Uri;
/**
* This collection contains a collection for every principal.
* It is similar to /home on many unix systems.
*
* The per-user collections can only be accessed by the user who owns the
* collection.
*
* @copyright Copyright (C) 2007-2015 fruux GmbH. (https://fruux.com/)
* @author Evert Pot (http://evertpot.com/)
* @license http://sabre.io/license/ Modified BSD License
*/
class HomeCollection extends AbstractPrincipalCollection implements IACL {
/**
* Name of this collection.
*
* @var string
*/
public $collectionName = 'home';
/**
* Path to where the users' files are actually stored.
*
* @var string
*/
protected $storagePath;
/**
* Creates the home collection.
*
* @param BackendInterface $principalBackend
* @param string $storagePath Where the actual files are stored.
* @param string $principalPrefix list of principals to iterate.
*/
function __construct(BackendInterface $principalBackend, $storagePath, $principalPrefix = 'principals') {
parent::__construct($principalBackend, $principalPrefix);
$this->storagePath = $storagePath;
}
/**
* Returns the name of the node.
*
* This is used to generate the url.
*
* @return string
*/
function getName() {
return $this->collectionName;
}
/**
* Returns a principals' collection of files.
*
* The passed array contains principal information, and is guaranteed to
* at least contain a uri item. Other properties may or may not be
* supplied by the authentication backend.
*
* @param array $principalInfo
* @return void
*/
function getChildForPrincipal(array $principalInfo) {
$owner = $principalInfo['uri'];
$acl = [
[
'privilege' => '{DAV:}read',
'principal' => $owner,
'protected' => true,
],
[
'privilege' => '{DAV:}write',
'principal' => $owner,
'protected' => true,
],
];
list(, $principalBaseName) = Uri\split($owner);
$path = $this->storagePath . '/' . $principalBaseName;
if (!is_dir($path)) {
mkdir($path, 0777, true);
}
return new Collection(
$path,
$acl,
$owner
);
}
/**
* Returns the owner principal
*
* This must be a url to a principal, or null if there's no owner
*
* @return string|null
*/
function getOwner() {
return null;
}
/**
* Returns a group principal
*
* This must be a url to a principal, or null if there's no owner
*
* @return string|null
*/
function getGroup() {
return null;
}
/**
* Returns a list of ACE's for this node.
*
* Each ACE has the following properties:
* * 'privilege', a string such as {DAV:}read or {DAV:}write. These are
* currently the only supported privileges
* * 'principal', a url to the principal who owns the node
* * 'protected' (optional), indicating that this ACE is not allowed to
* be updated.
*
* @return array
*/
function getACL() {
return [
[
'principal' => '{DAV:}authenticated',
'privilege' => '{DAV:}read',
'protected' => true,
]
];
}
/**
* Updates the ACL
*
* This method will receive a list of new ACE's as an array argument.
*
* @param array $acl
* @return void
*/
function setACL(array $acl) {
throw new Forbidden('Setting ACL is not allowed here');
}
/**
* Returns the list of supported privileges for this node.
*
* The returned data structure is a list of nested privileges.
* See Sabre\DAVACL\Plugin::getDefaultSupportedPrivilegeSet for a simple
* standard structure.
*
* If null is returned from this method, the default privilege set is used,
* which is fine for most common usecases.
*
* @return array|null
*/
function getSupportedPrivilegeSet() {
return null;
}
}

File Metadata

Mime Type
text/x-php
Expires
Tue, Jan 7, 4:00 PM (2 d, 10 h ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
914325
Default Alt Text
HomeCollection.php (4 KB)

Event Timeline