Blame view

sources/lib/private/group/group.php 5.82 KB
31b7f2792   Kload   Upgrade to ownclo...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
  <?php
  
  /**
   * Copyright (c) 2013 Robin Appelman <icewind@owncloud.com>
   * This file is licensed under the Affero General Public License version 3 or
   * later.
   * See the COPYING-README file.
   */
  
  namespace OC\Group;
  
  class Group {
  	/**
  	 * @var string $id
  	 */
  	private $gid;
  
  	/**
  	 * @var \OC\User\User[] $users
  	 */
6d9380f96   Cédric Dupont   Update sources OC...
21
  	private $users = array();
31b7f2792   Kload   Upgrade to ownclo...
22
23
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
24
25
26
27
28
29
  	 * @var bool $usersLoaded
  	 */
  	private $usersLoaded;
  
  	/**
  	 * @var \OC_Group_Backend[]|\OC_Group_Database[] $backend
31b7f2792   Kload   Upgrade to ownclo...
30
31
32
33
  	 */
  	private $backends;
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
34
  	 * @var \OC\Hooks\PublicEmitter $emitter
31b7f2792   Kload   Upgrade to ownclo...
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
  	 */
  	private $emitter;
  
  	/**
  	 * @var \OC\User\Manager $userManager
  	 */
  	private $userManager;
  
  	/**
  	 * @param string $gid
  	 * @param \OC_Group_Backend[] $backends
  	 * @param \OC\User\Manager $userManager
  	 * @param \OC\Hooks\PublicEmitter $emitter
  	 */
  	public function __construct($gid, $backends, $userManager, $emitter = null) {
  		$this->gid = $gid;
  		$this->backends = $backends;
  		$this->userManager = $userManager;
  		$this->emitter = $emitter;
  	}
  
  	public function getGID() {
  		return $this->gid;
  	}
  
  	/**
  	 * get all users in the group
  	 *
  	 * @return \OC\User\User[]
  	 */
  	public function getUsers() {
6d9380f96   Cédric Dupont   Update sources OC...
66
  		if ($this->usersLoaded) {
31b7f2792   Kload   Upgrade to ownclo...
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
  			return $this->users;
  		}
  
  		$userIds = array();
  		foreach ($this->backends as $backend) {
  			$diff = array_diff(
  				$backend->usersInGroup($this->gid),
  				$userIds
  			);
  			if ($diff) {
  				$userIds = array_merge($userIds, $diff);
  			}
  		}
  
  		$this->users = $this->getVerifiedUsers($userIds);
6d9380f96   Cédric Dupont   Update sources OC...
82
  		$this->usersLoaded = true;
31b7f2792   Kload   Upgrade to ownclo...
83
84
85
86
87
88
89
90
91
92
  		return $this->users;
  	}
  
  	/**
  	 * check if a user is in the group
  	 *
  	 * @param \OC\User\User $user
  	 * @return bool
  	 */
  	public function inGroup($user) {
6d9380f96   Cédric Dupont   Update sources OC...
93
94
95
  		if (isset($this->users[$user->getUID()])) {
  			return true;
  		}
31b7f2792   Kload   Upgrade to ownclo...
96
97
  		foreach ($this->backends as $backend) {
  			if ($backend->inGroup($user->getUID(), $this->gid)) {
6d9380f96   Cédric Dupont   Update sources OC...
98
  				$this->users[$user->getUID()] = $user;
31b7f2792   Kload   Upgrade to ownclo...
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
162
163
164
165
166
167
168
169
170
171
172
173
174
  				return true;
  			}
  		}
  		return false;
  	}
  
  	/**
  	 * add a user to the group
  	 *
  	 * @param \OC\User\User $user
  	 */
  	public function addUser($user) {
  		if ($this->inGroup($user)) {
  			return;
  		}
  
  		if ($this->emitter) {
  			$this->emitter->emit('\OC\Group', 'preAddUser', array($this, $user));
  		}
  		foreach ($this->backends as $backend) {
  			if ($backend->implementsActions(OC_GROUP_BACKEND_ADD_TO_GROUP)) {
  				$backend->addToGroup($user->getUID(), $this->gid);
  				if ($this->users) {
  					$this->users[$user->getUID()] = $user;
  				}
  				if ($this->emitter) {
  					$this->emitter->emit('\OC\Group', 'postAddUser', array($this, $user));
  				}
  				return;
  			}
  		}
  	}
  
  	/**
  	 * remove a user from the group
  	 *
  	 * @param \OC\User\User $user
  	 */
  	public function removeUser($user) {
  		$result = false;
  		if ($this->emitter) {
  			$this->emitter->emit('\OC\Group', 'preRemoveUser', array($this, $user));
  		}
  		foreach ($this->backends as $backend) {
  			if ($backend->implementsActions(OC_GROUP_BACKEND_REMOVE_FROM_GOUP) and $backend->inGroup($user->getUID(), $this->gid)) {
  				$backend->removeFromGroup($user->getUID(), $this->gid);
  				$result = true;
  			}
  		}
  		if ($result) {
  			if ($this->emitter) {
  				$this->emitter->emit('\OC\Group', 'postRemoveUser', array($this, $user));
  			}
  			if ($this->users) {
  				foreach ($this->users as $index => $groupUser) {
  					if ($groupUser->getUID() === $user->getUID()) {
  						unset($this->users[$index]);
  						return;
  					}
  				}
  			}
  		}
  	}
  
  	/**
  	 * search for users in the group by userid
  	 *
  	 * @param string $search
  	 * @param int $limit
  	 * @param int $offset
  	 * @return \OC\User\User[]
  	 */
  	public function searchUsers($search, $limit = null, $offset = null) {
  		$users = array();
  		foreach ($this->backends as $backend) {
  			$userIds = $backend->usersInGroup($this->gid, $search, $limit, $offset);
31b7f2792   Kload   Upgrade to ownclo...
175
176
177
178
179
180
181
182
183
  			$users += $this->getVerifiedUsers($userIds);
  			if (!is_null($limit) and $limit <= 0) {
  				return array_values($users);
  			}
  		}
  		return array_values($users);
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
  	 * returns the number of users matching the search string
  	 *
  	 * @param string $search
  	 * @return int|bool
  	 */
  	public function count($search = '') {
  		$users = false;
  		foreach ($this->backends as $backend) {
  			if($backend->implementsActions(OC_GROUP_BACKEND_COUNT_USERS)) {
  				if($users === false) {
  					//we could directly add to a bool variable, but this would
  					//be ugly
  					$users = 0;
  				}
  				$users += $backend->countUsersInGroup($this->gid, $search);
  			}
  		}
  		return $users;
  	}
  
  	/**
31b7f2792   Kload   Upgrade to ownclo...
205
206
207
208
209
210
211
212
  	 * search for users in the group by displayname
  	 *
  	 * @param string $search
  	 * @param int $limit
  	 * @param int $offset
  	 * @return \OC\User\User[]
  	 */
  	public function searchDisplayName($search, $limit = null, $offset = null) {
6d9380f96   Cédric Dupont   Update sources OC...
213
  		$users = array();
31b7f2792   Kload   Upgrade to ownclo...
214
  		foreach ($this->backends as $backend) {
837968727   Kload   [enh] Upgrade to ...
215
  			$userIds = $backend->usersInGroup($this->gid, $search, $limit, $offset);
31b7f2792   Kload   Upgrade to ownclo...
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
  			$users = $this->getVerifiedUsers($userIds);
  			if (!is_null($limit) and $limit <= 0) {
  				return array_values($users);
  			}
  		}
  		return array_values($users);
  	}
  
  	/**
  	 * delete the group
  	 *
  	 * @return bool
  	 */
  	public function delete() {
  		$result = false;
  		if ($this->emitter) {
  			$this->emitter->emit('\OC\Group', 'preDelete', array($this));
  		}
  		foreach ($this->backends as $backend) {
  			if ($backend->implementsActions(OC_GROUP_BACKEND_DELETE_GROUP)) {
  				$result = true;
  				$backend->deleteGroup($this->gid);
  			}
  		}
  		if ($result and $this->emitter) {
  			$this->emitter->emit('\OC\Group', 'postDelete', array($this));
  		}
  		return $result;
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
247
248
249
  	 * returns all the Users from an array that really exists
  	 * @param string[] $userIds an array containing user IDs
  	 * @return \OC\User\User[] an Array with the userId as Key and \OC\User\User as value
31b7f2792   Kload   Upgrade to ownclo...
250
251
  	 */
  	private function getVerifiedUsers($userIds) {
6d9380f96   Cédric Dupont   Update sources OC...
252
  		if (!is_array($userIds)) {
31b7f2792   Kload   Upgrade to ownclo...
253
254
255
256
257
  			return array();
  		}
  		$users = array();
  		foreach ($userIds as $userId) {
  			$user = $this->userManager->get($userId);
6d9380f96   Cédric Dupont   Update sources OC...
258
  			if (!is_null($user)) {
31b7f2792   Kload   Upgrade to ownclo...
259
260
261
262
263
264
  				$users[$userId] = $user;
  			}
  		}
  		return $users;
  	}
  }