Merge pull request #8935 from nextcloud/backend_interfaces
Backend interfaces
This commit is contained in:
commit
34cb8ea161
|
@ -302,6 +302,15 @@ return array(
|
||||||
'OCP\\Template' => $baseDir . '/lib/public/Template.php',
|
'OCP\\Template' => $baseDir . '/lib/public/Template.php',
|
||||||
'OCP\\User' => $baseDir . '/lib/public/User.php',
|
'OCP\\User' => $baseDir . '/lib/public/User.php',
|
||||||
'OCP\\UserInterface' => $baseDir . '/lib/public/UserInterface.php',
|
'OCP\\UserInterface' => $baseDir . '/lib/public/UserInterface.php',
|
||||||
|
'OCP\\User\\Backend\\ABackend' => $baseDir . '/lib/public/User/Backend/ABackend.php',
|
||||||
|
'OCP\\User\\Backend\\ICheckPasswordBackend' => $baseDir . '/lib/public/User/Backend/ICheckPasswordBackend.php',
|
||||||
|
'OCP\\User\\Backend\\ICountUsersBackend' => $baseDir . '/lib/public/User/Backend/ICountUsersBackend.php',
|
||||||
|
'OCP\\User\\Backend\\ICreateUserBackend' => $baseDir . '/lib/public/User/Backend/ICreateUserBackend.php',
|
||||||
|
'OCP\\User\\Backend\\IGetDisplayNameBackend' => $baseDir . '/lib/public/User/Backend/IGetDisplayNameBackend.php',
|
||||||
|
'OCP\\User\\Backend\\IGetHomeBackend' => $baseDir . '/lib/public/User/Backend/IGetHomeBackend.php',
|
||||||
|
'OCP\\User\\Backend\\IProvideAvatarBackend' => $baseDir . '/lib/public/User/Backend/IProvideAvatarBackend.php',
|
||||||
|
'OCP\\User\\Backend\\ISetDisplayNameBackend' => $baseDir . '/lib/public/User/Backend/ISetDisplayNameBackend.php',
|
||||||
|
'OCP\\User\\Backend\\ISetPasswordBackend' => $baseDir . '/lib/public/User/Backend/ISetPasswordBackend.php',
|
||||||
'OCP\\Util' => $baseDir . '/lib/public/Util.php',
|
'OCP\\Util' => $baseDir . '/lib/public/Util.php',
|
||||||
'OCP\\WorkflowEngine\\ICheck' => $baseDir . '/lib/public/WorkflowEngine/ICheck.php',
|
'OCP\\WorkflowEngine\\ICheck' => $baseDir . '/lib/public/WorkflowEngine/ICheck.php',
|
||||||
'OCP\\WorkflowEngine\\IManager' => $baseDir . '/lib/public/WorkflowEngine/IManager.php',
|
'OCP\\WorkflowEngine\\IManager' => $baseDir . '/lib/public/WorkflowEngine/IManager.php',
|
||||||
|
|
|
@ -332,6 +332,15 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
|
||||||
'OCP\\Template' => __DIR__ . '/../../..' . '/lib/public/Template.php',
|
'OCP\\Template' => __DIR__ . '/../../..' . '/lib/public/Template.php',
|
||||||
'OCP\\User' => __DIR__ . '/../../..' . '/lib/public/User.php',
|
'OCP\\User' => __DIR__ . '/../../..' . '/lib/public/User.php',
|
||||||
'OCP\\UserInterface' => __DIR__ . '/../../..' . '/lib/public/UserInterface.php',
|
'OCP\\UserInterface' => __DIR__ . '/../../..' . '/lib/public/UserInterface.php',
|
||||||
|
'OCP\\User\\Backend\\ABackend' => __DIR__ . '/../../..' . '/lib/public/User/Backend/ABackend.php',
|
||||||
|
'OCP\\User\\Backend\\ICheckPasswordBackend' => __DIR__ . '/../../..' . '/lib/public/User/Backend/ICheckPasswordBackend.php',
|
||||||
|
'OCP\\User\\Backend\\ICountUsersBackend' => __DIR__ . '/../../..' . '/lib/public/User/Backend/ICountUsersBackend.php',
|
||||||
|
'OCP\\User\\Backend\\ICreateUserBackend' => __DIR__ . '/../../..' . '/lib/public/User/Backend/ICreateUserBackend.php',
|
||||||
|
'OCP\\User\\Backend\\IGetDisplayNameBackend' => __DIR__ . '/../../..' . '/lib/public/User/Backend/IGetDisplayNameBackend.php',
|
||||||
|
'OCP\\User\\Backend\\IGetHomeBackend' => __DIR__ . '/../../..' . '/lib/public/User/Backend/IGetHomeBackend.php',
|
||||||
|
'OCP\\User\\Backend\\IProvideAvatarBackend' => __DIR__ . '/../../..' . '/lib/public/User/Backend/IProvideAvatarBackend.php',
|
||||||
|
'OCP\\User\\Backend\\ISetDisplayNameBackend' => __DIR__ . '/../../..' . '/lib/public/User/Backend/ISetDisplayNameBackend.php',
|
||||||
|
'OCP\\User\\Backend\\ISetPasswordBackend' => __DIR__ . '/../../..' . '/lib/public/User/Backend/ISetPasswordBackend.php',
|
||||||
'OCP\\Util' => __DIR__ . '/../../..' . '/lib/public/Util.php',
|
'OCP\\Util' => __DIR__ . '/../../..' . '/lib/public/Util.php',
|
||||||
'OCP\\WorkflowEngine\\ICheck' => __DIR__ . '/../../..' . '/lib/public/WorkflowEngine/ICheck.php',
|
'OCP\\WorkflowEngine\\ICheck' => __DIR__ . '/../../..' . '/lib/public/WorkflowEngine/ICheck.php',
|
||||||
'OCP\\WorkflowEngine\\IManager' => __DIR__ . '/../../..' . '/lib/public/WorkflowEngine/IManager.php',
|
'OCP\\WorkflowEngine\\IManager' => __DIR__ . '/../../..' . '/lib/public/WorkflowEngine/IManager.php',
|
||||||
|
|
|
@ -1,4 +1,5 @@
|
||||||
<?php
|
<?php
|
||||||
|
declare(strict_types=1);
|
||||||
/**
|
/**
|
||||||
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
||||||
*
|
*
|
||||||
|
@ -57,8 +58,14 @@
|
||||||
namespace OC\User;
|
namespace OC\User;
|
||||||
|
|
||||||
use OC\Cache\CappedMemoryCache;
|
use OC\Cache\CappedMemoryCache;
|
||||||
use OC\DB\QueryBuilder\Literal;
|
use OCP\User\Backend\ABackend;
|
||||||
use OCP\IUserBackend;
|
use OCP\User\Backend\ICheckPasswordBackend;
|
||||||
|
use OCP\User\Backend\ICountUsersBackend;
|
||||||
|
use OCP\User\Backend\ICreateUserBackend;
|
||||||
|
use OCP\User\Backend\IGetDisplayNameBackend;
|
||||||
|
use OCP\User\Backend\IGetHomeBackend;
|
||||||
|
use OCP\User\Backend\ISetDisplayNameBackend;
|
||||||
|
use OCP\User\Backend\ISetPasswordBackend;
|
||||||
use OCP\Util;
|
use OCP\Util;
|
||||||
use Symfony\Component\EventDispatcher\EventDispatcher;
|
use Symfony\Component\EventDispatcher\EventDispatcher;
|
||||||
use Symfony\Component\EventDispatcher\GenericEvent;
|
use Symfony\Component\EventDispatcher\GenericEvent;
|
||||||
|
@ -66,7 +73,14 @@ use Symfony\Component\EventDispatcher\GenericEvent;
|
||||||
/**
|
/**
|
||||||
* Class for user management in a SQL Database (e.g. MySQL, SQLite)
|
* Class for user management in a SQL Database (e.g. MySQL, SQLite)
|
||||||
*/
|
*/
|
||||||
class Database extends Backend implements IUserBackend {
|
class Database extends ABackend
|
||||||
|
implements ICreateUserBackend,
|
||||||
|
ISetPasswordBackend,
|
||||||
|
ISetDisplayNameBackend,
|
||||||
|
IGetDisplayNameBackend,
|
||||||
|
ICheckPasswordBackend,
|
||||||
|
IGetHomeBackend,
|
||||||
|
ICountUsersBackend {
|
||||||
/** @var CappedMemoryCache */
|
/** @var CappedMemoryCache */
|
||||||
private $cache;
|
private $cache;
|
||||||
|
|
||||||
|
@ -93,13 +107,13 @@ class Database extends Backend implements IUserBackend {
|
||||||
* Creates a new user. Basic checking of username is done in OC_User
|
* Creates a new user. Basic checking of username is done in OC_User
|
||||||
* itself, not in its subclasses.
|
* itself, not in its subclasses.
|
||||||
*/
|
*/
|
||||||
public function createUser($uid, $password) {
|
public function createUser(string $uid, string $password): bool {
|
||||||
if (!$this->userExists($uid)) {
|
if (!$this->userExists($uid)) {
|
||||||
$event = new GenericEvent($password);
|
$event = new GenericEvent($password);
|
||||||
$this->eventDispatcher->dispatch('OCP\PasswordPolicy::validate', $event);
|
$this->eventDispatcher->dispatch('OCP\PasswordPolicy::validate', $event);
|
||||||
$query = \OC_DB::prepare('INSERT INTO `*PREFIX*users` ( `uid`, `password` ) VALUES( ?, ? )');
|
$query = \OC_DB::prepare('INSERT INTO `*PREFIX*users` ( `uid`, `password` ) VALUES( ?, ? )');
|
||||||
try {
|
try {
|
||||||
$result = $query->execute(array($uid, \OC::$server->getHasher()->hash($password)));
|
$result = $query->execute([$uid, \OC::$server->getHasher()->hash($password)]);
|
||||||
} catch (\Exception $e) {
|
} catch (\Exception $e) {
|
||||||
$result = false;
|
$result = false;
|
||||||
}
|
}
|
||||||
|
@ -124,7 +138,7 @@ class Database extends Backend implements IUserBackend {
|
||||||
public function deleteUser($uid) {
|
public function deleteUser($uid) {
|
||||||
// Delete user-group-relation
|
// Delete user-group-relation
|
||||||
$query = \OC_DB::prepare('DELETE FROM `*PREFIX*users` WHERE `uid` = ?');
|
$query = \OC_DB::prepare('DELETE FROM `*PREFIX*users` WHERE `uid` = ?');
|
||||||
$result = $query->execute(array($uid));
|
$result = $query->execute([$uid]);
|
||||||
|
|
||||||
if (isset($this->cache[$uid])) {
|
if (isset($this->cache[$uid])) {
|
||||||
unset($this->cache[$uid]);
|
unset($this->cache[$uid]);
|
||||||
|
@ -142,12 +156,12 @@ class Database extends Backend implements IUserBackend {
|
||||||
*
|
*
|
||||||
* Change the password of a user
|
* Change the password of a user
|
||||||
*/
|
*/
|
||||||
public function setPassword($uid, $password) {
|
public function setPassword(string $uid, string $password): bool {
|
||||||
if ($this->userExists($uid)) {
|
if ($this->userExists($uid)) {
|
||||||
$event = new GenericEvent($password);
|
$event = new GenericEvent($password);
|
||||||
$this->eventDispatcher->dispatch('OCP\PasswordPolicy::validate', $event);
|
$this->eventDispatcher->dispatch('OCP\PasswordPolicy::validate', $event);
|
||||||
$query = \OC_DB::prepare('UPDATE `*PREFIX*users` SET `password` = ? WHERE `uid` = ?');
|
$query = \OC_DB::prepare('UPDATE `*PREFIX*users` SET `password` = ? WHERE `uid` = ?');
|
||||||
$result = $query->execute(array(\OC::$server->getHasher()->hash($password), $uid));
|
$result = $query->execute([\OC::$server->getHasher()->hash($password), $uid]);
|
||||||
|
|
||||||
return $result ? true : false;
|
return $result ? true : false;
|
||||||
}
|
}
|
||||||
|
@ -164,10 +178,10 @@ class Database extends Backend implements IUserBackend {
|
||||||
*
|
*
|
||||||
* Change the display name of a user
|
* Change the display name of a user
|
||||||
*/
|
*/
|
||||||
public function setDisplayName($uid, $displayName) {
|
public function setDisplayName(string $uid, string $displayName): bool {
|
||||||
if ($this->userExists($uid)) {
|
if ($this->userExists($uid)) {
|
||||||
$query = \OC_DB::prepare('UPDATE `*PREFIX*users` SET `displayname` = ? WHERE LOWER(`uid`) = LOWER(?)');
|
$query = \OC_DB::prepare('UPDATE `*PREFIX*users` SET `displayname` = ? WHERE LOWER(`uid`) = LOWER(?)');
|
||||||
$query->execute(array($displayName, $uid));
|
$query->execute([$displayName, $uid]);
|
||||||
$this->cache[$uid]['displayname'] = $displayName;
|
$this->cache[$uid]['displayname'] = $displayName;
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
|
@ -182,7 +196,7 @@ class Database extends Backend implements IUserBackend {
|
||||||
* @param string $uid user ID of the user
|
* @param string $uid user ID of the user
|
||||||
* @return string display name
|
* @return string display name
|
||||||
*/
|
*/
|
||||||
public function getDisplayName($uid) {
|
public function getDisplayName($uid): string {
|
||||||
$this->loadUser($uid);
|
$this->loadUser($uid);
|
||||||
return empty($this->cache[$uid]['displayname']) ? $uid : $this->cache[$uid]['displayname'];
|
return empty($this->cache[$uid]['displayname']) ? $uid : $this->cache[$uid]['displayname'];
|
||||||
}
|
}
|
||||||
|
@ -235,9 +249,9 @@ class Database extends Backend implements IUserBackend {
|
||||||
* Check if the password is correct without logging in the user
|
* Check if the password is correct without logging in the user
|
||||||
* returns the user id or false
|
* returns the user id or false
|
||||||
*/
|
*/
|
||||||
public function checkPassword($uid, $password) {
|
public function checkPassword(string $uid, string $password) {
|
||||||
$query = \OC_DB::prepare('SELECT `uid`, `password` FROM `*PREFIX*users` WHERE LOWER(`uid`) = LOWER(?)');
|
$query = \OC_DB::prepare('SELECT `uid`, `password` FROM `*PREFIX*users` WHERE LOWER(`uid`) = LOWER(?)');
|
||||||
$result = $query->execute(array($uid));
|
$result = $query->execute([$uid]);
|
||||||
|
|
||||||
$row = $result->fetchRow();
|
$row = $result->fetchRow();
|
||||||
if ($row) {
|
if ($row) {
|
||||||
|
@ -271,7 +285,7 @@ class Database extends Backend implements IUserBackend {
|
||||||
}
|
}
|
||||||
|
|
||||||
$query = \OC_DB::prepare('SELECT `uid`, `displayname` FROM `*PREFIX*users` WHERE LOWER(`uid`) = LOWER(?)');
|
$query = \OC_DB::prepare('SELECT `uid`, `displayname` FROM `*PREFIX*users` WHERE LOWER(`uid`) = LOWER(?)');
|
||||||
$result = $query->execute(array($uid));
|
$result = $query->execute([$uid]);
|
||||||
|
|
||||||
if ($result === false) {
|
if ($result === false) {
|
||||||
Util::writeLog('core', \OC_DB::getErrorMessage(), Util::ERROR);
|
Util::writeLog('core', \OC_DB::getErrorMessage(), Util::ERROR);
|
||||||
|
@ -326,9 +340,9 @@ class Database extends Backend implements IUserBackend {
|
||||||
* @param string $uid the username
|
* @param string $uid the username
|
||||||
* @return string|false
|
* @return string|false
|
||||||
*/
|
*/
|
||||||
public function getHome($uid) {
|
public function getHome(string $uid) {
|
||||||
if ($this->userExists($uid)) {
|
if ($this->userExists($uid)) {
|
||||||
return \OC::$server->getConfig()->getSystemValue("datadirectory", \OC::$SERVERROOT . "/data") . '/' . $uid;
|
return \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/' . $uid;
|
||||||
}
|
}
|
||||||
|
|
||||||
return false;
|
return false;
|
||||||
|
|
|
@ -0,0 +1,72 @@
|
||||||
|
<?php
|
||||||
|
declare(strict_types=1);
|
||||||
|
/**
|
||||||
|
* @copyright Copyright (c) 2018 Roeland Jago Douma <roeland@famdouma.nl>
|
||||||
|
*
|
||||||
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
||||||
|
*
|
||||||
|
* @license GNU AGPL version 3 or any later version
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program 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 program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace OCP\User\Backend;
|
||||||
|
|
||||||
|
use OC\User\Backend;
|
||||||
|
use OCP\IUserBackend;
|
||||||
|
use OCP\UserInterface;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @since 14.0.0
|
||||||
|
*/
|
||||||
|
abstract class ABackend implements IUserBackend, UserInterface {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated 14.0.0
|
||||||
|
*
|
||||||
|
* @param int $actions The action to check for
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function implementsActions($actions): bool {
|
||||||
|
$implements = 0;
|
||||||
|
|
||||||
|
if ($this instanceof ICreateUserBackend) {
|
||||||
|
$implements |= Backend::CREATE_USER;
|
||||||
|
}
|
||||||
|
if ($this instanceof ISetPasswordBackend) {
|
||||||
|
$implements |= Backend::SET_PASSWORD;
|
||||||
|
}
|
||||||
|
if ($this instanceof ICheckPasswordBackend) {
|
||||||
|
$implements |= Backend::CHECK_PASSWORD;
|
||||||
|
}
|
||||||
|
if ($this instanceof IGetHomeBackend) {
|
||||||
|
$implements |= Backend::GET_HOME;
|
||||||
|
}
|
||||||
|
if ($this instanceof IGetDisplayNameBackend) {
|
||||||
|
$implements |= Backend::GET_DISPLAYNAME;
|
||||||
|
}
|
||||||
|
if ($this instanceof ISetDisplayNameBackend) {
|
||||||
|
$implements |= Backend::SET_DISPLAYNAME;
|
||||||
|
}
|
||||||
|
if ($this instanceof IProvideAvatarBackend) {
|
||||||
|
$implements |= Backend::PROVIDE_AVATAR;
|
||||||
|
}
|
||||||
|
if ($this instanceof ICountUsersBackend) {
|
||||||
|
$implements |= Backend::COUNT_USERS;
|
||||||
|
}
|
||||||
|
|
||||||
|
return (bool)($actions & $implements);
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,39 @@
|
||||||
|
<?php
|
||||||
|
declare(strict_types=1);
|
||||||
|
/**
|
||||||
|
* @copyright Copyright (c) 2018 Roeland Jago Douma <roeland@famdouma.nl>
|
||||||
|
*
|
||||||
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
||||||
|
*
|
||||||
|
* @license GNU AGPL version 3 or any later version
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program 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 program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace OCP\User\Backend;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @since 14.0.0
|
||||||
|
*/
|
||||||
|
interface ICheckPasswordBackend {
|
||||||
|
/**
|
||||||
|
* @since 14.0.0
|
||||||
|
*
|
||||||
|
* @param string $uid The username
|
||||||
|
* @param string $password The password
|
||||||
|
* @return string|bool The uid on success false on failure
|
||||||
|
*/
|
||||||
|
public function checkPassword(string $loginName, string $password);
|
||||||
|
}
|
|
@ -0,0 +1,38 @@
|
||||||
|
<?php
|
||||||
|
declare(strict_types=1);
|
||||||
|
/**
|
||||||
|
* @copyright Copyright (c) 2018 Roeland Jago Douma <roeland@famdouma.nl>
|
||||||
|
*
|
||||||
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
||||||
|
*
|
||||||
|
* @license GNU AGPL version 3 or any later version
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program 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 program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace OCP\User\Backend;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @since 14.0.0
|
||||||
|
*/
|
||||||
|
interface ICountUsersBackend {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @since 14.0.0
|
||||||
|
*
|
||||||
|
* @return int|bool The number of users on success false on failure
|
||||||
|
*/
|
||||||
|
public function countUsers();
|
||||||
|
}
|
|
@ -0,0 +1,40 @@
|
||||||
|
<?php
|
||||||
|
declare(strict_types=1);
|
||||||
|
/**
|
||||||
|
* @copyright Copyright (c) 2018 Roeland Jago Douma <roeland@famdouma.nl>
|
||||||
|
*
|
||||||
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
||||||
|
*
|
||||||
|
* @license GNU AGPL version 3 or any later version
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program 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 program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace OCP\User\Backend;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @since 14.0.0
|
||||||
|
*/
|
||||||
|
interface ICreateUserBackend {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @since 14.0.0
|
||||||
|
*
|
||||||
|
* @param string $uid The username of the user to create
|
||||||
|
* @param string $password The password of the new user
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function createUser(string $uid, string $password): bool;
|
||||||
|
}
|
|
@ -0,0 +1,39 @@
|
||||||
|
<?php
|
||||||
|
declare(strict_types=1);
|
||||||
|
/**
|
||||||
|
* @copyright Copyright (c) 2018 Roeland Jago Douma <roeland@famdouma.nl>
|
||||||
|
*
|
||||||
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
||||||
|
*
|
||||||
|
* @license GNU AGPL version 3 or any later version
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program 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 program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace OCP\User\Backend;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @since 14.0.0
|
||||||
|
*/
|
||||||
|
interface IGetDisplayNameBackend {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @since 14.0.0
|
||||||
|
*
|
||||||
|
* @param string $uid user ID of the user
|
||||||
|
* @return string display name
|
||||||
|
*/
|
||||||
|
public function getDisplayName($uid): string;
|
||||||
|
}
|
|
@ -0,0 +1,39 @@
|
||||||
|
<?php
|
||||||
|
declare(strict_types=1);
|
||||||
|
/**
|
||||||
|
* @copyright Copyright (c) 2018 Roeland Jago Douma <roeland@famdouma.nl>
|
||||||
|
*
|
||||||
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
||||||
|
*
|
||||||
|
* @license GNU AGPL version 3 or any later version
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program 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 program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace OCP\User\Backend;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @since 14.0.0
|
||||||
|
*/
|
||||||
|
interface IGetHomeBackend {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @since 14.0.0
|
||||||
|
*
|
||||||
|
* @param string $uid the username
|
||||||
|
* @return string|bool Datadir on success false on failure
|
||||||
|
*/
|
||||||
|
public function getHome(string $uid);
|
||||||
|
}
|
|
@ -0,0 +1,39 @@
|
||||||
|
<?php
|
||||||
|
declare(strict_types=1);
|
||||||
|
/**
|
||||||
|
* @copyright Copyright (c) 2018 Roeland Jago Douma <roeland@famdouma.nl>
|
||||||
|
*
|
||||||
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
||||||
|
*
|
||||||
|
* @license GNU AGPL version 3 or any later version
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program 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 program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace OCP\User\Backend;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @since 14.0.0
|
||||||
|
*/
|
||||||
|
interface IProvideAvatarBackend {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @since 14.0.0
|
||||||
|
*
|
||||||
|
* @param string $uid
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function canChangeAvatar(string $uid): bool;
|
||||||
|
}
|
|
@ -0,0 +1,40 @@
|
||||||
|
<?php
|
||||||
|
declare(strict_types=1);
|
||||||
|
/**
|
||||||
|
* @copyright Copyright (c) 2018 Roeland Jago Douma <roeland@famdouma.nl>
|
||||||
|
*
|
||||||
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
||||||
|
*
|
||||||
|
* @license GNU AGPL version 3 or any later version
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program 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 program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace OCP\User\Backend;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @since 14.0.0
|
||||||
|
*/
|
||||||
|
interface ISetDisplayNameBackend {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @since 14.0.0
|
||||||
|
*
|
||||||
|
* @param string $uid The username
|
||||||
|
* @param string $displayName The new display name
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function setDisplayName(string $uid, string $displayName): bool;
|
||||||
|
}
|
|
@ -0,0 +1,40 @@
|
||||||
|
<?php
|
||||||
|
declare(strict_types=1);
|
||||||
|
/**
|
||||||
|
* @copyright Copyright (c) 2018 Roeland Jago Douma <roeland@famdouma.nl>
|
||||||
|
*
|
||||||
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
||||||
|
*
|
||||||
|
* @license GNU AGPL version 3 or any later version
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program 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 program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace OCP\User\Backend;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @since 14.0.0
|
||||||
|
*/
|
||||||
|
interface ISetPasswordBackend {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @since 14.0.0
|
||||||
|
*
|
||||||
|
* @param string $uid The username
|
||||||
|
* @param string $password The new password
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function setPassword(string $uid, string $password): bool;
|
||||||
|
}
|
|
@ -48,6 +48,7 @@ interface UserInterface {
|
||||||
* Returns the supported actions as int to be
|
* Returns the supported actions as int to be
|
||||||
* compared with \OC\User\Backend::CREATE_USER etc.
|
* compared with \OC\User\Backend::CREATE_USER etc.
|
||||||
* @since 4.5.0
|
* @since 4.5.0
|
||||||
|
* @deprecated 14.0.0 Switch to the interfaces from OCP\User\Backend
|
||||||
*/
|
*/
|
||||||
public function implementsActions($actions);
|
public function implementsActions($actions);
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue