1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
<?php
/**
* ownCloud
*
* @author Frank Karlitschek
* @copyright 2010 Frank Karlitschek karlitschek@kde.org
*
* 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/>.
*
*/
/**
* Base class for user management
*
*/
abstract class OC_USER_BACKEND {
/**
* Check if the login button is pressed and log the user in
*
*/
abstract public static function loginListener();
/**
* Try to create a new user
*
* @param string $username The username of the user to create
* @param string $password The password of the new user
*/
abstract public static function createUser($username, $password);
/**
* Try to login a user
*
* @param string $username The username of the user to log in
* @param string $password The password of the user
*/
abstract public static function login($username, $password);
/**
* Check if the logout button is pressed and logout the user
*
*/
abstract public static function logoutListener();
/**
* Check if some user is logged in
*
*/
abstract public static function isLoggedIn();
/**
* Try to create a new group
*
* @param string $groupName The name of the group to create
*/
abstract public static function createGroup($groupName);
/**
* Get the ID of a user
*
* @param string $username Name of the user to find the ID
* @param boolean $noCache If false the cache is used to find the ID
*/
abstract public static function getUserId($username, $noCache=false);
/**
* Get the ID of a group
*
* @param string $groupName Name of the group to find the ID
* @param boolean $noCache If false the cache is used to find the ID
*/
abstract public static function getGroupId($groupName, $noCache=false);
/**
* Get the name of a group
*
* @param string $groupId ID of the group
* @param boolean $noCache If false the cache is used to find the name of the group
*/
abstract public static function getGroupName($groupId, $noCache=false);
/**
* Check if a user belongs to a group
*
* @param string $username Name of the user to check
* @param string $groupName Name of the group
*/
abstract public static function inGroup($username, $groupName);
/**
* Add a user to a group
*
* @param string $username Name of the user to add to group
* @param string $groupName Name of the group in which add the user
*/
abstract public static function addToGroup($username, $groupName);
/**
* Remove a user from a group
*
* @param string $username Name of the user to remove from group
* @param string $groupName Name of the group from which remove the user
*/
abstract public static function removeFromGroup($username,$groupName);
/**
* Generate a random password
*/
abstract public static function generatePassword();
/**
* Get all groups the user belongs to
*
* @param string $username Name of the user
*/
abstract public static function getUserGroups($username);
/**
* Set the password of a user
*
* @param string $username User who password will be changed
* @param string $password The new password for the user
*/
abstract public static function setPassword($username, $password);
/**
* Check if the password of the user is correct
*
* @param string $username Name of the user
* @param string $password Password of the user
*/
abstract public static function checkPassword($username, $password);
/**
* get a list of all users
*
*/
abstract public static function getUsers();
/**
* get a list of all groups
*
*/
abstract public static function getGroups();
}
|
