Blame view

sources/lib/private/group/manager.php 5.72 KB
31b7f2792   Kload   Upgrade to ownclo...
1
2
3
4
5
6
7
8
9
10
11
12
  <?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;
  
  use OC\Hooks\PublicEmitter;
f7d878ff1   kload   [enh] Update to 7...
13
  use OCP\IGroupManager;
31b7f2792   Kload   Upgrade to ownclo...
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
  
  /**
   * Class Manager
   *
   * Hooks available in scope \OC\Group:
   * - preAddUser(\OC\Group\Group $group, \OC\User\User $user)
   * - postAddUser(\OC\Group\Group $group, \OC\User\User $user)
   * - preRemoveUser(\OC\Group\Group $group, \OC\User\User $user)
   * - postRemoveUser(\OC\Group\Group $group, \OC\User\User $user)
   * - preDelete(\OC\Group\Group $group)
   * - postDelete(\OC\Group\Group $group)
   * - preCreate(string $groupId)
   * - postCreate(\OC\Group\Group $group)
   *
   * @package OC\Group
   */
f7d878ff1   kload   [enh] Update to 7...
30
  class Manager extends PublicEmitter implements IGroupManager {
31b7f2792   Kload   Upgrade to ownclo...
31
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
32
  	 * @var \OC_Group_Backend[]|\OC_Group_Database[] $backends
31b7f2792   Kload   Upgrade to ownclo...
33
34
35
36
37
38
39
40
41
42
43
  	 */
  	private $backends = array();
  
  	/**
  	 * @var \OC\User\Manager $userManager
  	 */
  	private $userManager;
  
  	/**
  	 * @var \OC\Group\Group[]
  	 */
6d9380f96   Cédric Dupont   Update sources OC...
44
45
46
47
48
49
  	private $cachedGroups = array();
  
  	/**
  	 * @var \OC\Group\Group[]
  	 */
  	private $cachedUserGroups = array();
31b7f2792   Kload   Upgrade to ownclo...
50
51
52
53
54
55
  
  	/**
  	 * @param \OC\User\Manager $userManager
  	 */
  	public function __construct($userManager) {
  		$this->userManager = $userManager;
6d9380f96   Cédric Dupont   Update sources OC...
56
57
58
  		$cachedGroups = & $this->cachedGroups;
  		$cachedUserGroups = & $this->cachedUserGroups;
  		$this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) {
31b7f2792   Kload   Upgrade to ownclo...
59
60
61
  			/**
  			 * @var \OC\Group\Group $group
  			 */
6d9380f96   Cédric Dupont   Update sources OC...
62
63
64
65
66
67
68
69
70
71
72
73
74
75
  			unset($cachedGroups[$group->getGID()]);
  			$cachedUserGroups = array();
  		});
  		$this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) {
  			/**
  			 * @var \OC\Group\Group $group
  			 */
  			$cachedUserGroups = array();
  		});
  		$this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) {
  			/**
  			 * @var \OC\Group\Group $group
  			 */
  			$cachedUserGroups = array();
31b7f2792   Kload   Upgrade to ownclo...
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
  		});
  	}
  
  	/**
  	 * @param \OC_Group_Backend $backend
  	 */
  	public function addBackend($backend) {
  		$this->backends[] = $backend;
  	}
  
  	public function clearBackends() {
  		$this->backends = array();
  		$this->cachedGroups = array();
  	}
  
  	/**
  	 * @param string $gid
  	 * @return \OC\Group\Group
  	 */
  	public function get($gid) {
  		if (isset($this->cachedGroups[$gid])) {
  			return $this->cachedGroups[$gid];
  		}
6d9380f96   Cédric Dupont   Update sources OC...
99
  		return $this->getGroupObject($gid);
31b7f2792   Kload   Upgrade to ownclo...
100
101
102
103
104
105
106
107
108
  	}
  
  	protected function getGroupObject($gid) {
  		$backends = array();
  		foreach ($this->backends as $backend) {
  			if ($backend->groupExists($gid)) {
  				$backends[] = $backend;
  			}
  		}
6d9380f96   Cédric Dupont   Update sources OC...
109
110
111
  		if (count($backends) === 0) {
  			return null;
  		}
31b7f2792   Kload   Upgrade to ownclo...
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
  		$this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this);
  		return $this->cachedGroups[$gid];
  	}
  
  	/**
  	 * @param string $gid
  	 * @return bool
  	 */
  	public function groupExists($gid) {
  		return !is_null($this->get($gid));
  	}
  
  	/**
  	 * @param string $gid
  	 * @return \OC\Group\Group
  	 */
  	public function createGroup($gid) {
f7d878ff1   kload   [enh] Update to 7...
129
  		if ($gid === '' || is_null($gid)) {
31b7f2792   Kload   Upgrade to ownclo...
130
  			return false;
6d9380f96   Cédric Dupont   Update sources OC...
131
132
  		} else if ($group = $this->get($gid)) {
  			return $group;
31b7f2792   Kload   Upgrade to ownclo...
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
  		} else {
  			$this->emit('\OC\Group', 'preCreate', array($gid));
  			foreach ($this->backends as $backend) {
  				if ($backend->implementsActions(OC_GROUP_BACKEND_CREATE_GROUP)) {
  					$backend->createGroup($gid);
  					$group = $this->getGroupObject($gid);
  					$this->emit('\OC\Group', 'postCreate', array($group));
  					return $group;
  				}
  			}
  			return null;
  		}
  	}
  
  	/**
  	 * @param string $search
  	 * @param int $limit
  	 * @param int $offset
  	 * @return \OC\Group\Group[]
  	 */
  	public function search($search, $limit = null, $offset = null) {
  		$groups = array();
  		foreach ($this->backends as $backend) {
  			$groupIds = $backend->getGroups($search, $limit, $offset);
31b7f2792   Kload   Upgrade to ownclo...
157
  			foreach ($groupIds as $groupId) {
6d9380f96   Cédric Dupont   Update sources OC...
158
  				$groups[$groupId] = $this->get($groupId);
31b7f2792   Kload   Upgrade to ownclo...
159
160
161
162
163
164
165
166
167
168
169
170
171
  			}
  			if (!is_null($limit) and $limit <= 0) {
  				return array_values($groups);
  			}
  		}
  		return array_values($groups);
  	}
  
  	/**
  	 * @param \OC\User\User $user
  	 * @return \OC\Group\Group[]
  	 */
  	public function getUserGroups($user) {
6d9380f96   Cédric Dupont   Update sources OC...
172
173
174
175
  		$uid = $user->getUID();
  		if (isset($this->cachedUserGroups[$uid])) {
  			return $this->cachedUserGroups[$uid];
  		}
31b7f2792   Kload   Upgrade to ownclo...
176
177
  		$groups = array();
  		foreach ($this->backends as $backend) {
6d9380f96   Cédric Dupont   Update sources OC...
178
  			$groupIds = $backend->getUserGroups($uid);
31b7f2792   Kload   Upgrade to ownclo...
179
  			foreach ($groupIds as $groupId) {
6d9380f96   Cédric Dupont   Update sources OC...
180
  				$groups[$groupId] = $this->get($groupId);
31b7f2792   Kload   Upgrade to ownclo...
181
182
  			}
  		}
6d9380f96   Cédric Dupont   Update sources OC...
183
184
185
186
187
188
189
190
191
192
193
194
195
196
  		$this->cachedUserGroups[$uid] = array_values($groups);
  		return $this->cachedUserGroups[$uid];
  	}
  	/**
  	 * @param \OC\User\User $user
  	 * @return array with group names
  	 */
  	public function getUserGroupIds($user) {
  		$groupIds = array();
  		foreach ($this->backends as $backend) {
  			$groupIds = array_merge($groupIds, $backend->getUserGroups($user->getUID()));
  			
  		}
  		return $groupIds;
31b7f2792   Kload   Upgrade to ownclo...
197
  	}
837968727   Kload   [enh] Upgrade to ...
198
199
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
200
  	 * get a list of all display names in a group
837968727   Kload   [enh] Upgrade to ...
201
202
203
204
  	 * @param string $gid
  	 * @param string $search
  	 * @param int $limit
  	 * @param int $offset
6d9380f96   Cédric Dupont   Update sources OC...
205
  	 * @return array an array of display names (value) and user ids (key)
837968727   Kload   [enh] Upgrade to ...
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
  	 */
  	public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
  		$group = $this->get($gid);
  		if(is_null($group)) {
  			return array();
  		}
  		// only user backends have the capability to do a complex search for users
  		$groupUsers  = $group->searchUsers('', $limit, $offset);
  		$search = trim($search);
  		if(!empty($search)) {
  			//TODO: for OC 7 earliest: user backend should get a method to check selected users against a pattern
  			$filteredUsers = $this->userManager->search($search);
  			$testUsers = true;
  		} else {
  			$filteredUsers = array();
  			$testUsers = false;
  		}
  
  		$matchingUsers = array();
  		foreach($groupUsers as $user) {
  			if(!$testUsers || isset($filteredUsers[$user->getUID()])) {
  				$matchingUsers[$user->getUID()] = $user->getDisplayName();
  			}
  		}
  		return $matchingUsers;
  	}
31b7f2792   Kload   Upgrade to ownclo...
232
  }