nextcloud/lib/private/user/backend.php

163 lines
4.3 KiB
PHP
Raw Normal View History

<?php
/**
* ownCloud
*
* @author Frank Karlitschek
* @author Dominik Schmidt
2012-05-26 21:14:24 +04:00
* @copyright 2012 Frank Karlitschek frank@owncloud.org
* @copyright 2011 Dominik Schmidt dev@dominik-schmidt.de
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
/**
* error code for functions not provided by the user backend
*/
define('OC_USER_BACKEND_NOT_IMPLEMENTED', -501);
/**
* actions that user backends can define
*/
define('OC_USER_BACKEND_CREATE_USER', 0x00000001);
define('OC_USER_BACKEND_SET_PASSWORD', 0x00000010);
define('OC_USER_BACKEND_CHECK_PASSWORD', 0x00000100);
define('OC_USER_BACKEND_GET_HOME', 0x00001000);
define('OC_USER_BACKEND_GET_DISPLAYNAME', 0x00010000);
define('OC_USER_BACKEND_SET_DISPLAYNAME', 0x00100000);
define('OC_USER_BACKEND_PROVIDE_AVATAR', 0x01000000);
define('OC_USER_BACKEND_COUNT_USERS', 0x10000000);
/**
2012-06-01 19:46:18 +04:00
* Abstract base class for user management. Provides methods for querying backend
* capabilities.
*
* Subclass this for your own backends, and see OC_User_Example for descriptions
*/
abstract class OC_User_Backend implements OC_User_Interface {
protected $possibleActions = array(
OC_USER_BACKEND_CREATE_USER => 'createUser',
OC_USER_BACKEND_SET_PASSWORD => 'setPassword',
OC_USER_BACKEND_CHECK_PASSWORD => 'checkPassword',
2012-08-26 18:24:25 +04:00
OC_USER_BACKEND_GET_HOME => 'getHome',
OC_USER_BACKEND_GET_DISPLAYNAME => 'getDisplayName',
OC_USER_BACKEND_SET_DISPLAYNAME => 'setDisplayName',
OC_USER_BACKEND_PROVIDE_AVATAR => 'canChangeAvatar',
OC_USER_BACKEND_COUNT_USERS => 'countUsers',
);
/**
* @brief Get all supported actions
2013-05-29 01:46:57 +04:00
* @return int bitwise-or'ed actions
*
* Returns the supported actions as int to be
* compared with OC_USER_BACKEND_CREATE_USER etc.
*/
2012-09-07 17:22:01 +04:00
public function getSupportedActions() {
$actions = 0;
2012-09-07 17:22:01 +04:00
foreach($this->possibleActions AS $action => $methodName) {
if(method_exists($this, $methodName)) {
$actions |= $action;
}
}
return $actions;
}
/**
* @brief Check if backend implements actions
2013-05-29 01:46:57 +04:00
* @param int $actions bitwise-or'ed actions
* @return boolean
*
* Returns the supported actions as int to be
* compared with OC_USER_BACKEND_CREATE_USER etc.
*/
2012-09-07 17:22:01 +04:00
public function implementsActions($actions) {
return (bool)($this->getSupportedActions() & $actions);
}
/**
2013-05-29 01:46:57 +04:00
* @brief delete a user
* @param string $uid The username of the user to delete
* @return bool
*
* Deletes a user
*/
2012-09-07 17:22:01 +04:00
public function deleteUser( $uid ) {
return false;
}
/**
* @brief Get a list of all users
* @returns array with all uids
*
* Get a list of all users.
*/
public function getUsers($search = '', $limit = null, $offset = null) {
return array();
}
/**
* @brief check if a user exists
* @param string $uid the username
* @return boolean
*/
2012-09-07 17:22:01 +04:00
public function userExists($uid) {
return false;
}
2012-08-26 18:24:25 +04:00
/**
* @brief get the user's home directory
* @param string $uid the username
* @return boolean
*/
2012-09-07 17:22:01 +04:00
public function getHome($uid) {
2012-08-26 18:24:25 +04:00
return false;
}
2013-02-22 20:21:57 +04:00
/**
* @brief get display name of the user
2013-05-29 01:46:57 +04:00
* @param string $uid user ID of the user
* @return string display name
*/
public function getDisplayName($uid) {
return $uid;
}
2013-02-22 20:21:57 +04:00
/**
* @brief Get a list of all display names
* @returns array with all displayNames (value) and the corresponding uids (key)
*
* Get a list of all display names and user ids.
*/
public function getDisplayNames($search = '', $limit = null, $offset = null) {
2013-01-25 14:05:00 +04:00
$displayNames = array();
$users = $this->getUsers($search, $limit, $offset);
foreach ( $users as $user) {
2013-01-30 00:01:59 +04:00
$displayNames[$user] = $user;
2013-01-25 14:05:00 +04:00
}
return $displayNames;
}
/**
* @brief Check if a user list is available or not
* @return boolean if users can be listed or not
*/
public function hasUserListings() {
return false;
2013-01-25 14:05:00 +04:00
}
}