Blame view

sources/lib/private/user/user.php 4.73 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
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
  <?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\User;
  
  use OC\Hooks\Emitter;
  
  class User {
  	/**
  	 * @var string $uid
  	 */
  	private $uid;
  
  	/**
  	 * @var string $displayName
  	 */
  	private $displayName;
  
  	/**
  	 * @var \OC_User_Backend $backend
  	 */
  	private $backend;
  
  	/**
  	 * @var bool $enabled
  	 */
  	private $enabled;
  
  	/**
  	 * @var Emitter | Manager $emitter
  	 */
  	private $emitter;
  
  	/**
a293d369c   Kload   Update sources to...
41
42
43
44
45
46
47
48
49
50
  	 * @var string $home
  	 */
  	private $home;
  
  	/**
  	 * @var \OC\AllConfig $config
  	 */
  	private $config;
  
  	/**
31b7f2792   Kload   Upgrade to ownclo...
51
52
  	 * @param string $uid
  	 * @param \OC_User_Backend $backend
a293d369c   Kload   Update sources to...
53
54
  	 * @param \OC\Hooks\Emitter $emitter
  	 * @param \OC\AllConfig $config
31b7f2792   Kload   Upgrade to ownclo...
55
  	 */
a293d369c   Kload   Update sources to...
56
  	public function __construct($uid, $backend, $emitter = null, $config = null) {
31b7f2792   Kload   Upgrade to ownclo...
57
58
59
60
61
62
63
64
  		$this->uid = $uid;
  		if ($backend and $backend->implementsActions(OC_USER_BACKEND_GET_DISPLAYNAME)) {
  			$this->displayName = $backend->getDisplayName($uid);
  		} else {
  			$this->displayName = $uid;
  		}
  		$this->backend = $backend;
  		$this->emitter = $emitter;
a293d369c   Kload   Update sources to...
65
66
67
68
69
70
71
  		$this->config = $config;
  		if ($this->config) {
  			$enabled = $this->config->getUserValue($uid, 'core', 'enabled', 'true');
  			$this->enabled = ($enabled === 'true');
  		} else {
  			$this->enabled = true;
  		}
31b7f2792   Kload   Upgrade to ownclo...
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
  	}
  
  	/**
  	 * get the user id
  	 *
  	 * @return string
  	 */
  	public function getUID() {
  		return $this->uid;
  	}
  
  	/**
  	 * get the displayname for the user, if no specific displayname is set it will fallback to the user id
  	 *
  	 * @return string
  	 */
  	public function getDisplayName() {
  		return $this->displayName;
  	}
  
  	/**
  	 * set the displayname for the user
  	 *
  	 * @param string $displayName
  	 * @return bool
  	 */
  	public function setDisplayName($displayName) {
  		if ($this->canChangeDisplayName()) {
  			$this->displayName = $displayName;
  			$result = $this->backend->setDisplayName($this->uid, $displayName);
  			return $result !== false;
  		} else {
  			return false;
  		}
  	}
  
  	/**
  	 * Delete the user
  	 *
  	 * @return bool
  	 */
  	public function delete() {
  		if ($this->emitter) {
  			$this->emitter->emit('\OC\User', 'preDelete', array($this));
  		}
  		$result = $this->backend->deleteUser($this->uid);
  		if ($this->emitter) {
  			$this->emitter->emit('\OC\User', 'postDelete', array($this));
  		}
  		return !($result === false);
  	}
  
  	/**
  	 * Set the password of the user
  	 *
  	 * @param string $password
  	 * @param string $recoveryPassword for the encryption app to reset encryption keys
  	 * @return bool
  	 */
  	public function setPassword($password, $recoveryPassword) {
  		if ($this->emitter) {
  			$this->emitter->emit('\OC\User', 'preSetPassword', array($this, $password, $recoveryPassword));
  		}
  		if ($this->backend->implementsActions(\OC_USER_BACKEND_SET_PASSWORD)) {
  			$result = $this->backend->setPassword($this->uid, $password);
  			if ($this->emitter) {
  				$this->emitter->emit('\OC\User', 'postSetPassword', array($this, $password, $recoveryPassword));
  			}
  			return !($result === false);
  		} else {
  			return false;
  		}
  	}
  
  	/**
  	 * get the users home folder to mount
  	 *
  	 * @return string
  	 */
  	public function getHome() {
a293d369c   Kload   Update sources to...
152
153
154
155
156
157
158
159
  		if (!$this->home) {
  			if ($this->backend->implementsActions(\OC_USER_BACKEND_GET_HOME) and $home = $this->backend->getHome($this->uid)) {
  				$this->home = $home;
  			} elseif ($this->config) {
  				$this->home = $this->config->getSystemValue('datadirectory') . '/' . $this->uid;
  			} else {
  				$this->home = \OC::$SERVERROOT . '/data/' . $this->uid;
  			}
31b7f2792   Kload   Upgrade to ownclo...
160
  		}
a293d369c   Kload   Update sources to...
161
  		return $this->home;
31b7f2792   Kload   Upgrade to ownclo...
162
163
164
165
166
167
168
169
  	}
  
  	/**
  	 * check if the backend allows the user to change his avatar on Personal page
  	 *
  	 * @return bool
  	 */
  	public function canChangeAvatar() {
a293d369c   Kload   Update sources to...
170
  		if ($this->backend->implementsActions(\OC_USER_BACKEND_PROVIDE_AVATAR)) {
31b7f2792   Kload   Upgrade to ownclo...
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
  			return $this->backend->canChangeAvatar($this->uid);
  		}
  		return true;
  	}
  
  	/**
  	 * check if the backend supports changing passwords
  	 *
  	 * @return bool
  	 */
  	public function canChangePassword() {
  		return $this->backend->implementsActions(\OC_USER_BACKEND_SET_PASSWORD);
  	}
  
  	/**
  	 * check if the backend supports changing display names
  	 *
  	 * @return bool
  	 */
  	public function canChangeDisplayName() {
a293d369c   Kload   Update sources to...
191
192
193
194
195
  		if ($this->config and $this->config->getSystemValue('allow_user_to_change_display_name') === false) {
  			return false;
  		} else {
  			return $this->backend->implementsActions(\OC_USER_BACKEND_SET_DISPLAYNAME);
  		}
31b7f2792   Kload   Upgrade to ownclo...
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
  	}
  
  	/**
  	 * check if the user is enabled
  	 *
  	 * @return bool
  	 */
  	public function isEnabled() {
  		return $this->enabled;
  	}
  
  	/**
  	 * set the enabled status for the user
  	 *
  	 * @param bool $enabled
  	 */
  	public function setEnabled($enabled) {
  		$this->enabled = $enabled;
a293d369c   Kload   Update sources to...
214
215
216
217
  		if ($this->config) {
  			$enabled = ($enabled) ? 'true' : 'false';
  			$this->config->setUserValue($this->uid, 'core', 'enabled', $enabled);
  		}
31b7f2792   Kload   Upgrade to ownclo...
218
219
  	}
  }