PDO principal backend. More...

Inheritance diagram for Sabre\DAVACL\PrincipalBackend\PDO:

Collaboration diagram for Sabre\DAVACL\PrincipalBackend\PDO:

Public Member Functions
	__construct (\PDO $pdo)
	This is the users' primary email-address. More...

	getPrincipalsByPrefix ($prefixPath)
	Returns a list of principals based on a prefix. More...

	getPrincipalByPath ($path)
	Returns a specific principal, specified by it's path. More...

	updatePrincipal ($path, DAV\PropPatch $propPatch)
	Updates one ore more webdav properties on a principal. More...

	searchPrincipals ($prefixPath, array $searchProperties, $test='allof')
	This method is used to search for principals matching a set of properties. More...

	findByUri ($uri, $principalPrefix)
	Finds a principal by its URI. More...

	getGroupMemberSet ($principal)
	Returns the list of members for a group-principal. More...

	getGroupMembership ($principal)
	Returns the list of groups a principal is a member of. More...

	setGroupMemberSet ($principal, array $members)
	Updates the list of group members for a group principal. More...

	createPrincipal ($path, MkCol $mkCol)
	Creates a new principal. More...

Public Member Functions inherited from Sabre\DAVACL\PrincipalBackend\AbstractBackend
	findByUri ($uri, $principalPrefix)
	Finds a principal by its URI. More...

Public Member Functions inherited from Sabre\DAVACL\PrincipalBackend\BackendInterface
	updatePrincipal ($path, \Sabre\DAV\PropPatch $propPatch)
	Updates one ore more webdav properties on a principal. More...

Data Fields
	$tableName = 'principals'

	$groupMembersTableName = 'groupmembers'

Protected Attributes
	$pdo

	$fieldMap

Detailed Description

PDO principal backend.

This backend assumes all principals are in a single collection. The default collection is 'principals/', but this can be overridden.

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

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

Definition at line 20 of file PDO.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\DAVACL\PrincipalBackend\PDO::__construct ( \PDO $pdo )

This is the users' primary email-address.

Sets up the backend.

Parameters

\PDO $pdo

Definition at line 70 of file PDO.php.

References Sabre\DAVACL\PrincipalBackend\PDO\$pdo.

                                     {
 
         $this->pdo = $pdo;
 
     }

Member Function Documentation

◆ createPrincipal()

Sabre\DAVACL\PrincipalBackend\PDO::createPrincipal	(		$path,
		MkCol	$mkCol
	)

Creates a new principal.

This method receives a full path for the new principal. The mkCol object contains any additional webdav properties specified during the creation of the principal.

Parameters

string	$path
MkCol	$mkCol

Returns: void

Implements Sabre\DAVACL\PrincipalBackend\CreatePrincipalSupport.

Definition at line 423 of file PDO.php.

References $path, $stmt, and Sabre\DAVACL\PrincipalBackend\PDO\updatePrincipal().

                                                   {
 
         $stmt = $this->pdo->prepare('INSERT INTO ' . $this->tableName . ' (uri) VALUES (?)');
         $stmt->execute([$path]);
         $this->updatePrincipal($path, $mkCol);
 
     }

Here is the call graph for this function:

◆ findByUri()

Sabre\DAVACL\PrincipalBackend\PDO::findByUri	(	$uri,
		$principalPrefix
	)

Finds a principal by its URI.

This method may receive any type of uri, but mailto: addresses will be the most common.

Implementation of this API is optional. It is currently used by the CalDAV system to find principals based on their email addresses. If this API is not implemented, some features may not work correctly.

This method must return a relative principal path, or null, if the principal was not found or you refuse to find it.

Parameters

string	$uri
string	$principalPrefix

Returns: string

Implements Sabre\DAVACL\PrincipalBackend\BackendInterface.

Definition at line 299 of file PDO.php.

References $query, $row, $stmt, and Sabre\HTTP\URLUtil\splitPath().

                                                {
         $value = null;
         $scheme = null;
         list($scheme, $value) = explode(":", $uri, 2);
         if (empty($value)) return null;
 
         $uri = null;
         switch ($scheme){
             case "mailto":
                 $query = 'SELECT uri FROM ' . $this->tableName . ' WHERE lower(email)=lower(?)';
                 $stmt = $this->pdo->prepare($query);
                 $stmt->execute([$value]);
             
                 while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
                     // Checking if the principal is in the prefix
                     list($rowPrefix) = URLUtil::splitPath($row['uri']);
                     if ($rowPrefix !== $principalPrefix) continue;
                     
                     $uri = $row['uri'];
                     break; //Stop on first match
                 }
                 break;
             default:
                 //unsupported uri scheme
                 return null;
         }
         return $uri;
     }

Here is the call graph for this function:

◆ getGroupMemberSet()

Sabre\DAVACL\PrincipalBackend\PDO::getGroupMemberSet ( $principal )

Returns the list of members for a group-principal.

Parameters

string $principal

Returns: array

Implements Sabre\DAVACL\PrincipalBackend\BackendInterface.

Definition at line 334 of file PDO.php.

References $result, $row, $stmt, and Sabre\DAVACL\PrincipalBackend\PDO\getPrincipalByPath().

                                            {
 
         $principal = $this->getPrincipalByPath($principal);
         if (!$principal) throw new DAV\Exception('Principal not found');
 
         $stmt = $this->pdo->prepare('SELECT principals.uri as uri FROM ' . $this->groupMembersTableName . ' AS groupmembers LEFT JOIN ' . $this->tableName . ' AS principals ON groupmembers.member_id = principals.id WHERE groupmembers.principal_id = ?');
         $stmt->execute([$principal['id']]);
 
         $result = [];
         while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
             $result[] = $row['uri'];
         }
         return $result;
 
     }

Here is the call graph for this function:

◆ getGroupMembership()

Sabre\DAVACL\PrincipalBackend\PDO::getGroupMembership ( $principal )

Returns the list of groups a principal is a member of.

Parameters

string $principal

Returns: array

Implements Sabre\DAVACL\PrincipalBackend\BackendInterface.

Definition at line 356 of file PDO.php.

References $result, $row, $stmt, and Sabre\DAVACL\PrincipalBackend\PDO\getPrincipalByPath().

                                             {
 
         $principal = $this->getPrincipalByPath($principal);
         if (!$principal) throw new DAV\Exception('Principal not found');
 
         $stmt = $this->pdo->prepare('SELECT principals.uri as uri FROM ' . $this->groupMembersTableName . ' AS groupmembers LEFT JOIN ' . $this->tableName . ' AS principals ON groupmembers.principal_id = principals.id WHERE groupmembers.member_id = ?');
         $stmt->execute([$principal['id']]);
 
         $result = [];
         while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
             $result[] = $row['uri'];
         }
         return $result;
 
     }

Here is the call graph for this function:

◆ getPrincipalByPath()

Sabre\DAVACL\PrincipalBackend\PDO::getPrincipalByPath ( $path )

Returns a specific principal, specified by it's path.

The returned structure should be the exact same as from getPrincipalsByPrefix.

Parameters

string $path

Returns: array

Implements Sabre\DAVACL\PrincipalBackend\BackendInterface.

Definition at line 135 of file PDO.php.

References $key, $path, $row, and $stmt.

Referenced by Sabre\DAVACL\PrincipalBackend\PDO\getGroupMemberSet(), and Sabre\DAVACL\PrincipalBackend\PDO\getGroupMembership().

                                        {
 
         $fields = [
             'id',
             'uri',
         ];
 
         foreach ($this->fieldMap as $key => $value) {
             $fields[] = $value['dbField'];
         }
         $stmt = $this->pdo->prepare('SELECT ' . implode(',', $fields) . '  FROM ' . $this->tableName . ' WHERE uri = ?');
         $stmt->execute([$path]);
 
         $row = $stmt->fetch(\PDO::FETCH_ASSOC);
         if (!$row) return;
 
         $principal = [
             'id'  => $row['id'],
             'uri' => $row['uri'],
         ];
         foreach ($this->fieldMap as $key => $value) {
             if ($row[$value['dbField']]) {
                 $principal[$key] = $row[$value['dbField']];
             }
         }
         return $principal;
 
     }

Here is the caller graph for this function:

◆ getPrincipalsByPrefix()

Sabre\DAVACL\PrincipalBackend\PDO::getPrincipalsByPrefix ( $prefixPath )

Returns a list of principals based on a prefix.

This prefix will often contain something like 'principals'. You are only expected to return principals that are in this base path.

You are expected to return at least a 'uri' for every user, you can return any additional properties if you wish so. Common properties are: {DAV:}displayname {http://sabredav.org/ns}email-address - This is a custom SabreDAV field that's actualy injected in a number of other properties. If you have an email address, use this property.

Parameters

string $prefixPath

Returns: array

Implements Sabre\DAVACL\PrincipalBackend\BackendInterface.

Definition at line 92 of file PDO.php.

References $key, $result, $row, and Sabre\HTTP\URLUtil\splitPath().

                                                 {
 
         $fields = [
             'uri',
         ];
 
         foreach ($this->fieldMap as $key => $value) {
             $fields[] = $value['dbField'];
         }
         $result = $this->pdo->query('SELECT ' . implode(',', $fields) . '  FROM ' . $this->tableName);
 
         $principals = [];
 
         while ($row = $result->fetch(\PDO::FETCH_ASSOC)) {
 
             // Checking if the principal is in the prefix
             list($rowPrefix) = URLUtil::splitPath($row['uri']);
             if ($rowPrefix !== $prefixPath) continue;
 
             $principal = [
                 'uri' => $row['uri'],
             ];
             foreach ($this->fieldMap as $key => $value) {
                 if ($row[$value['dbField']]) {
                     $principal[$key] = $row[$value['dbField']];
                 }
             }
             $principals[] = $principal;
 
         }
 
         return $principals;
 
     }

Here is the call graph for this function:

◆ searchPrincipals()

Sabre\DAVACL\PrincipalBackend\PDO::searchPrincipals	(		$prefixPath,
		array	$searchProperties,
			$test = `'allof'`
	)

This method is used to search for principals matching a set of properties.

This search is specifically used by RFC3744's principal-property-search REPORT.

The actual search should be a unicode-non-case-sensitive search. The keys in searchProperties are the WebDAV property names, while the values are the property values to search on.

By default, if multiple properties are submitted to this method, the various properties should be combined with 'AND'. If $test is set to 'anyof', it should be combined using 'OR'.

This method should simply return an array with full principal uri's.

If somebody attempted to search on a property the backend does not support, you should simply return 0 results.

You can also just return 0 results if you choose to not support searching at all, but keep in mind that this may stop certain features from working.

Parameters

string	$prefixPath
array	$searchProperties
string	$test

Returns: array

Implements Sabre\DAVACL\PrincipalBackend\BackendInterface.

Definition at line 242 of file PDO.php.

References $query, $row, $stmt, $test, $values, and Sabre\HTTP\URLUtil\splitPath().

                                                                                      {
         if (count($searchProperties) == 0) return [];    //No criteria
 
         $query = 'SELECT uri FROM ' . $this->tableName . ' WHERE ';
         $values = [];
         foreach ($searchProperties as $property => $value) {
             switch ($property) {
                 case '{DAV:}displayname' :
                     $column = "displayname";
                     break;
                 case '{http://sabredav.org/ns}email-address' :
                     $column = "email";
                     break;
                 default :
                     // Unsupported property
                     return [];
             }
             if (count($values) > 0) $query .= (strcmp($test, "anyof") == 0 ? " OR " : " AND ");
             $query .= 'lower(' . $column . ') LIKE lower(?)';
             $values[] = '%' . $value . '%';
 
         }
         $stmt = $this->pdo->prepare($query);
         $stmt->execute($values);
 
         $principals = [];
         while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
 
             // Checking if the principal is in the prefix
             list($rowPrefix) = URLUtil::splitPath($row['uri']);
             if ($rowPrefix !== $prefixPath) continue;
 
             $principals[] = $row['uri'];
 
         }
 
         return $principals;
 
     }

Here is the call graph for this function:

◆ setGroupMemberSet()

Sabre\DAVACL\PrincipalBackend\PDO::setGroupMemberSet	(		$principal,
		array	$members
	)

Updates the list of group members for a group principal.

The principals should be passed as a list of uri's.

Parameters

string	$principal
array	$members

Returns: void

Implements Sabre\DAVACL\PrincipalBackend\BackendInterface.

Definition at line 381 of file PDO.php.

References $row, and $stmt.

                                                            {
 
         // Grabbing the list of principal id's.
         $stmt = $this->pdo->prepare('SELECT id, uri FROM ' . $this->tableName . ' WHERE uri IN (? ' . str_repeat(', ? ', count($members)) . ');');
         $stmt->execute(array_merge([$principal], $members));
 
         $memberIds = [];
         $principalId = null;
 
         while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
             if ($row['uri'] == $principal) {
                 $principalId = $row['id'];
             } else {
                 $memberIds[] = $row['id'];
             }
         }
         if (!$principalId) throw new DAV\Exception('Principal not found');
 
         // Wiping out old members
         $stmt = $this->pdo->prepare('DELETE FROM ' . $this->groupMembersTableName . ' WHERE principal_id = ?;');
         $stmt->execute([$principalId]);
 
         foreach ($memberIds as $memberId) {
 
             $stmt = $this->pdo->prepare('INSERT INTO ' . $this->groupMembersTableName . ' (principal_id, member_id) VALUES (?, ?);');
             $stmt->execute([$principalId, $memberId]);
 
         }
 
     }

◆ updatePrincipal()

Sabre\DAVACL\PrincipalBackend\PDO::updatePrincipal	(		$path,
		DAV\PropPatch	$propPatch
	)

Updates one ore more webdav properties on a principal.

The list of mutations is stored in a Sabre object. To do the actual updates, you must tell this object which properties you're going to process with the handle() method.

Calling the handle method is like telling the PropPatch object "I promise I can handle updating this property".

Read the PropPatch documentation for more info and examples.

Parameters

string	$path
DAV\PropPatch	$propPatch

Definition at line 179 of file PDO.php.

References $key, $path, $query, $stmt, and $values.

Referenced by Sabre\DAVACL\PrincipalBackend\PDO\createPrincipal().

                                                               {
 
         $propPatch->handle(array_keys($this->fieldMap), function($properties) use ($path) {
 
             $query = "UPDATE " . $this->tableName . " SET ";
             $first = true;
 
             $values = [];
 
             foreach ($properties as $key => $value) {
 
                 $dbField = $this->fieldMap[$key]['dbField'];
 
                 if (!$first) {
                     $query .= ', ';
                 }
                 $first = false;
                 $query .= $dbField . ' = :' . $dbField;
                 $values[$dbField] = $value;
 
             }
 
             $query .= " WHERE uri = :uri";
             $values['uri'] = $path;
 
             $stmt = $this->pdo->prepare($query);
             $stmt->execute($values);
 
             return true;
 
         });
 
     }

Here is the caller graph for this function:

Field Documentation

◆ $fieldMap

Sabre\DAVACL\PrincipalBackend\PDO::$fieldMap

protected

Initial value:

= [
        
        '{DAV:}displayname' => [
            'dbField' => 'displayname'

Definition at line 48 of file PDO.php.

◆ $groupMembersTableName

Sabre\DAVACL\PrincipalBackend\PDO::$groupMembersTableName = 'groupmembers'

Definition at line 34 of file PDO.php.

◆ $pdo

Sabre\DAVACL\PrincipalBackend\PDO::$pdo

protected

Definition at line 41 of file PDO.php.

Referenced by Sabre\DAVACL\PrincipalBackend\PDO\__construct().

◆ $tableName

Sabre\DAVACL\PrincipalBackend\PDO::$tableName = 'principals'

Definition at line 27 of file PDO.php.

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

libs/composer/vendor/sabre/dav/lib/DAVACL/PrincipalBackend/PDO.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createPrincipal()

◆ findByUri()

◆ getGroupMemberSet()

◆ getGroupMembership()

◆ getPrincipalByPath()

◆ getPrincipalsByPrefix()

◆ searchPrincipals()

◆ setGroupMemberSet()

◆ updatePrincipal()

Field Documentation

◆ $fieldMap

◆ $groupMembersTableName

◆ $pdo

◆ $tableName