ecommun / owncloud_ynh

Blame view

sources/lib/private/user/backend.php 4.36 KB
edit raw normal view history
03e52840d   Kload   Init 
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
 
  <?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
   */
a293d369c   Kload   Update sources to... 
34
35
36
37
38
39
40
41
42
 
  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);
  //more actions cannot be defined without breaking 32bit platforms!
03e52840d   Kload   Init 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
  
  /**
   * 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',
  		OC_USER_BACKEND_GET_DISPLAYNAME => 'getDisplayName',
  		OC_USER_BACKEND_SET_DISPLAYNAME => 'setDisplayName',
31b7f2792   Kload   Upgrade to ownclo... 
59
 
  		OC_USER_BACKEND_PROVIDE_AVATAR => 'canChangeAvatar',
a293d369c   Kload   Update sources to... 
60
 
  		OC_USER_BACKEND_COUNT_USERS => 'countUsers',
03e52840d   Kload   Init 
61
62
63
64
 
  	);
  
  	/**
  	* @brief Get all supported actions
31b7f2792   Kload   Upgrade to ownclo... 
65
 
  	* @return int bitwise-or'ed actions
03e52840d   Kload   Init 
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
  	*
  	* 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
31b7f2792   Kload   Upgrade to ownclo... 
83
84
 
  	* @param int $actions bitwise-or'ed actions
  	* @return boolean
03e52840d   Kload   Init 
85
86
87
88
89
90
91
92
93
 
  	*
  	* 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);
  	}
  
  	/**
31b7f2792   Kload   Upgrade to ownclo... 
94
95
96
97
98
99
 
  	 * @brief delete a user
  	 * @param string $uid The username of the user to delete
  	 * @return bool
  	 *
  	 * Deletes a user
  	 */
03e52840d   Kload   Init 
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
 
  	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;
  	}
  
  	/**
  	 * @brief get display name of the user
31b7f2792   Kload   Upgrade to ownclo... 
134
135
 
  	 * @param string $uid user ID of the user
  	 * @return string display name
03e52840d   Kload   Init 
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
162
163
 
  	 */
  	public function getDisplayName($uid) {
  		return $uid;
  	}
  
  	/**
  	 * @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) {
  		$displayNames = array();
  		$users = $this->getUsers($search, $limit, $offset);
  		foreach ( $users as $user) {
  			$displayNames[$user] = $user;
  		}
  		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;
  	}
  }