124 lines
3.1 KiB
PHP
124 lines
3.1 KiB
PHP
<?php
|
|
|
|
/**
|
|
* ownCloud
|
|
*
|
|
* @author Frank Karlitschek
|
|
* @author Dominik Schmidt
|
|
* @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', 0x000001);
|
|
define('OC_USER_BACKEND_SET_PASSWORD', 0x000010);
|
|
define('OC_USER_BACKEND_CHECK_PASSWORD', 0x000100);
|
|
define('OC_USER_BACKEND_GET_HOME', 0x001000);
|
|
|
|
|
|
/**
|
|
* 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',
|
|
OC_USER_BACKEND_GET_HOME => 'getHome',
|
|
);
|
|
|
|
/**
|
|
* @brief Get all supported actions
|
|
* @returns bitwise-or'ed actions
|
|
*
|
|
* Returns the supported actions as int to be
|
|
* compared with OC_USER_BACKEND_CREATE_USER etc.
|
|
*/
|
|
public function getSupportedActions() {
|
|
$actions = 0;
|
|
foreach($this->possibleActions AS $action => $methodName) {
|
|
if(method_exists($this, $methodName)) {
|
|
$actions |= $action;
|
|
}
|
|
}
|
|
|
|
return $actions;
|
|
}
|
|
|
|
/**
|
|
* @brief Check if backend implements actions
|
|
* @param $actions bitwise-or'ed actions
|
|
* @returns boolean
|
|
*
|
|
* Returns the supported actions as int to be
|
|
* compared with OC_USER_BACKEND_CREATE_USER etc.
|
|
*/
|
|
public function implementsActions($actions) {
|
|
return (bool)($this->getSupportedActions() & $actions);
|
|
}
|
|
|
|
/**
|
|
* @brief delete a user
|
|
* @param $uid The username of the user to delete
|
|
* @returns true/false
|
|
*
|
|
* Deletes a user
|
|
*/
|
|
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
|
|
*/
|
|
public function userExists($uid) {
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @brief get the user's home directory
|
|
* @param string $uid the username
|
|
* @return boolean
|
|
*/
|
|
public function getHome($uid) {
|
|
return false;
|
|
}
|
|
}
|