summaryrefslogtreecommitdiffstats
path: root/lib/api/kolab_api_service_user.php
blob: ae3b4428c8c457479e4c32a56201a32ba35c7343 (plain)
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
<?php
/*
 +--------------------------------------------------------------------------+
 | This file is part of the Kolab Web Admin Panel                           |
 |                                                                          |
 | Copyright (C) 2011-2012, Kolab Systems AG                                |
 |                                                                          |
 | This program is free software: you can redistribute it and/or modify     |
 | it under the terms of the GNU Affero General Public License as published |
 | by the Free Software Foundation, either version 3 of the License, or     |
 | (at your option) any later version.                                      |
 |                                                                          |
 | This program 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 program. If not, see <http://www.gnu.org/licenses/>      |
 +--------------------------------------------------------------------------+
 | Author: Aleksander Machniak <machniak@kolabsys.com>                      |
 | Author: Jeroen van Meeuwen <vanmeeuwen@kolabsys.com>                     |
 +--------------------------------------------------------------------------+
*/

/**
 * Service providing user data management
 */
class kolab_api_service_user extends kolab_api_service
{
    /**
     * Returns service capabilities.
     *
     * @param string $domain Domain name
     *
     * @return array Capabilities list
     */
    public function capabilities($domain)
    {
        $auth = Auth::get_instance($domain);

        $effective_rights = $auth->list_rights('user');

        $rights = array();

        if (in_array('add', $effective_rights['entrylevelrights'])) {
            $rights['add'] = "w";
        }

        if (in_array('delete', $effective_rights['entrylevelrights'])) {
            $rights['delete'] = "w";
        }

        if (in_array('modrdn', $effective_rights['entrylevelrights'])) {
            $rights['edit']     = "w";
            $rights['password'] = "w";
        }

        if (in_array('read', $effective_rights['entrylevelrights'])) {
            $rights['info'] = "r";
            $rights['find'] = "r";
        }

        $rights['effective_rights'] = "r";

        return $rights;
    }

    /**
     * Create user.
     *
     * @param array $get   GET parameters
     * @param array $post  POST parameters
     *
     * @return array|bool User attributes or False on error.
     */
    public function user_add($getdata, $postdata)
    {
        Log::trace("user_add()", $postdata);

        $attributes = $this->parse_input_attributes('user', $postdata);

        password_policy::validate_password($attributes['userpassword']);

        Log::trace("user_add()", $attributes);

        $auth   = Auth::get_instance();
        $result = $auth->user_add($attributes, $postdata['type_id']);

        if ($result) {
            if ($id = $this->unique_attribute_value($result)) {
                $attributes['id'] = $id;
            }

            return $attributes;
        }

        return false;
    }

    /**
     * Delete user.
     *
     * @param array $get   GET parameters
     * @param array $post  POST parameters
     *
     * @return bool True on success, False on failure
     */
    public function user_delete($getdata, $postdata)
    {
        if (!isset($postdata['id'])) {
            return false;
        }

        // TODO: Input validation
        $auth   = Auth::get_instance();
        $result = $auth->user_delete($postdata['id']);

        return $result;
    }

    /**
     * Update user.
     *
     * @param array $get  GET parameters
     * @param array $post POST parameters
     *
     * @return array|bool User attributes or False on error.
     */
    public function user_edit($getdata, $postdata)
    {
        Log::trace("\$postdata to user_edit()", $postdata);

        $user_attributes = $this->parse_input_attributes('user', $postdata);

        Log::trace("\$user_attributes as result from parse_input_attributes", $user_attributes);

        if (!empty($user_attributes['userpassword'])) {
            password_policy::validate_password($user_attributes['userpassword']);
        }

        $auth   = Auth::get_instance();
        $result = $auth->user_edit($postdata['id'], $user_attributes, $postdata['type_id']);

        // Return the $mod_array
        if ($result) {
            return $result;
        }

        return false;
    }

    /**
     * Update user password.
     *
     * @param array $get  GET parameters
     * @param array $post POST parameters
     *
     * @return bool True on success, False on failure
     */
    public function user_password($getdata, $postdata)
    {
        $password = $postdata['password'];
        $user_id  = $postdata['id'];

        if (empty($user_id) || !is_string($password) || !strlen($password)) {
            return false;
        }

        if ($user_id === 'me') {
            $user_id = $_SESSION['user']->get_userid();
        }

        password_policy::validate_password($password);

        $auth   = Auth::get_instance();
        $result = $auth->user_edit($user_id, array('userpassword' => $password));

        return $result !== false;
    }

    /**
     * Effective rights on user record.
     *
     * @param array $get  GET parameters
     * @param array $post POST parameters
     *
     * @return array Effective rights
     */
    public function user_effective_rights($getdata, $postdata)
    {
        $auth = Auth::get_instance();
        $effective_rights = $auth->list_rights(empty($getdata['id']) ? 'user' : $getdata['id']);

        return $effective_rights;
    }

    /**
     * User information.
     *
     * @param array $get   GET parameters
     * @param array $post  POST parameters
     *
     * @return array|bool User attributes, False on error
     */
    public function user_info($getdata, $postdata)
    {
        if (!isset($getdata['id'])) {
            return false;
        }

        $auth   = Auth::get_instance();
        $attrs  = $this->object_attributes('user');
        $result = $auth->user_info($getdata['id'], $attrs);

        // normalize result
        $result = $this->parse_result_attributes('user', $result);

        Log::trace("user.info on " . $getdata['id'] . " parsed result: " . var_export($result, TRUE));

        if ($result) {
            return $result;
        }

        return false;
    }

    /**
     * Find user and return his data.
     * It is a combination of user.info and users.list with search capabilities
     * If the search returns only one record we'll return user data.
     *
     * @param array $get   GET parameters
     * @param array $post  POST parameters
     *
     * @return array|bool User attributes, False on error
     */
    public function user_find($get, $post)
    {
        $auth       = Auth::get_instance();
        $attributes = array('');
        $params     = array('page_size' => 2);
        $search     = $this->parse_list_search($post);

        // find user(s)
        $users = $auth->list_users(null, $attributes, $search, $params);

        if (empty($users) || empty($users['list'])) {
            return Array();
        }

        if ($users['count'] > 1) {
            throw new Exception("More than a single entry found.", 942);
        }

        // get user data
        $attrs  = $this->object_attributes('user');
        $result = $auth->user_info(key($users['list']), $attrs);

        // normalize result
        $result = $this->parse_result_attributes('user', $result);

        if ($result) {
            return $result;
        }

        return false;
    }
}