MDL-52831 users: Automatically strip whitespace from name fields
[moodle.git] / user / editadvanced_form.php
CommitLineData
aa6c1ced 1<?php
a2ed6e69
SH
2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
17/**
18 * Form for editing a users profile
19 *
20 * @copyright 1999 Martin Dougiamas http://dougiamas.com
21 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22 * @package core_user
23 */
ad6226fb 24
bfebaf64 25if (!defined('MOODLE_INTERNAL')) {
a2ed6e69 26 die('Direct access to this script is forbidden.'); // It must be included from a Moodle page.
bfebaf64
MD
27}
28
ad6226fb 29require_once($CFG->dirroot.'/lib/formslib.php');
ad6226fb 30
a2ed6e69
SH
31/**
32 * Class user_editadvanced_form.
33 *
34 * @copyright 1999 Martin Dougiamas http://dougiamas.com
35 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36 */
ad6226fb 37class user_editadvanced_form extends moodleform {
38
a2ed6e69
SH
39 /**
40 * Define the form.
41 */
42 public function definition() {
d8734783 43 global $USER, $CFG, $COURSE;
ad6226fb 44
a2ed6e69 45 $mform = $this->_form;
fc3aa0fb
RT
46 $editoroptions = null;
47 $filemanageroptions = null;
fc3aa0fb 48
d6e7a63d
PS
49 if (!is_array($this->_customdata)) {
50 throw new coding_exception('invalid custom data for user_edit_form');
4e782b32 51 }
d6e7a63d
PS
52 $editoroptions = $this->_customdata['editoroptions'];
53 $filemanageroptions = $this->_customdata['filemanageroptions'];
54 $user = $this->_customdata['user'];
55 $userid = $user->id;
8bdc9cac 56
a2ed6e69 57 // Accessibility: "Required" is bad legend text.
c8149f0f 58 $strgeneral = get_string('general');
ad6226fb 59 $strrequired = get_string('required');
60
a2ed6e69 61 // Add some extra hidden fields.
ad6226fb 62 $mform->addElement('hidden', 'id');
d18e0fe6 63 $mform->setType('id', PARAM_INT);
d8734783 64 $mform->addElement('hidden', 'course', $COURSE->id);
d18e0fe6 65 $mform->setType('course', PARAM_INT);
ad6226fb 66
a2ed6e69 67 // Print the required moodle fields first.
c8149f0f 68 $mform->addElement('header', 'moodle', $strgeneral);
ad6226fb 69
70 $mform->addElement('text', 'username', get_string('username'), 'size="20"');
71 $mform->addRule('username', $strrequired, 'required', null, 'client');
72 $mform->setType('username', PARAM_RAW);
73
bd3b3bba 74 $auths = core_component::get_plugin_list('auth');
c5772ede
PS
75 $enabled = get_string('pluginenabled', 'core_plugin');
76 $disabled = get_string('plugindisabled', 'core_plugin');
a2ed6e69 77 $authoptions = array($enabled => array(), $disabled => array());
6513cc03 78 $cannotchangepass = array();
17da2e6f 79 foreach ($auths as $auth => $unused) {
6513cc03
AA
80 $authinst = get_auth_plugin($auth);
81 $passwordurl = $authinst->change_password_url();
82 if (!($authinst->can_change_password() && empty($passwordurl))) {
d6e7a63d 83 if ($userid < 1 and $authinst->is_internal()) {
0b3bd8cb
PS
84 // This is unlikely but we can not create account without password
85 // when plugin uses passwords, we need to set it initially at least.
86 } else {
87 $cannotchangepass[] = $auth;
88 }
6513cc03 89 }
c5772ede 90 if (is_enabled_auth($auth)) {
a2ed6e69 91 $authoptions[$enabled][$auth] = get_string('pluginname', "auth_{$auth}");
c5772ede 92 } else {
a2ed6e69 93 $authoptions[$disabled][$auth] = get_string('pluginname', "auth_{$auth}");
c5772ede 94 }
ad6226fb 95 }
a2ed6e69 96 $mform->addElement('selectgroups', 'auth', get_string('chooseauthmethod', 'auth'), $authoptions);
f728d49b 97 $mform->addHelpButton('auth', 'chooseauthmethod', 'auth');
ad6226fb 98
a2ed6e69 99 $mform->addElement('advcheckbox', 'suspended', get_string('suspended', 'auth'));
4ad72c28
PS
100 $mform->addHelpButton('suspended', 'suspended', 'auth');
101
a2ed6e69 102 $mform->addElement('checkbox', 'createpassword', get_string('createpassword', 'auth'));
0b3bd8cb 103 $mform->disabledIf('createpassword', 'auth', 'in', $cannotchangepass);
483b6804 104
a2ed6e69 105 if (!empty($CFG->passwordpolicy)) {
3bf11ca4 106 $mform->addElement('static', 'passwordpolicyinfo', '', print_password_policy());
851481dc 107 }
54bb33eb 108 $mform->addElement('passwordunmask', 'newpassword', get_string('newpassword'), 'size="20"');
27d1a27c 109 $mform->addHelpButton('newpassword', 'newpassword');
ad6226fb 110 $mform->setType('newpassword', PARAM_RAW);
483b6804 111 $mform->disabledIf('newpassword', 'createpassword', 'checked');
ad6226fb 112
6513cc03
AA
113 $mform->disabledIf('newpassword', 'auth', 'in', $cannotchangepass);
114
fa1d88eb 115 $mform->addElement('advcheckbox', 'preference_auth_forcepasswordchange', get_string('forcepasswordchange'));
27d1a27c 116 $mform->addHelpButton('preference_auth_forcepasswordchange', 'forcepasswordchange');
483b6804
PS
117 $mform->disabledIf('preference_auth_forcepasswordchange', 'createpassword', 'checked');
118
a2ed6e69 119 // Shared fields.
d6e7a63d 120 useredit_shared_definition($mform, $editoroptions, $filemanageroptions, $user);
ad6226fb 121
a2ed6e69 122 // Next the customisable profile fields.
fc3aa0fb 123 profile_definition($mform, $userid);
bb6d3d34 124
607fdfc3
AA
125 if ($userid == -1) {
126 $btnstring = get_string('createuser');
127 } else {
128 $btnstring = get_string('updatemyprofile');
129 }
130
131 $this->add_action_buttons(false, $btnstring);
d6e7a63d
PS
132
133 $this->set_data($user);
ad6226fb 134 }
135
a2ed6e69
SH
136 /**
137 * Extend the form definition after data has been parsed.
138 */
139 public function definition_after_data() {
f2f085ee 140 global $USER, $CFG, $DB, $OUTPUT;
ad6226fb 141
a2ed6e69 142 $mform = $this->_form;
e9c27d1e
DM
143
144 // Trim required name fields.
145 foreach (useredit_get_required_name_fields() as $field) {
146 $mform->applyFilter($field, 'trim');
147 }
148
9122137f 149 if ($userid = $mform->getElementValue('id')) {
a2ed6e69 150 $user = $DB->get_record('user', array('id' => $userid));
9122137f 151 } else {
152 $user = false;
153 }
ad6226fb 154
a2ed6e69 155 // User can not change own auth method.
e8e0bb2d 156 if ($userid == $USER->id) {
157 $mform->hardFreeze('auth');
158 $mform->hardFreeze('preference_auth_forcepasswordchange');
ad6226fb 159 }
160
a2ed6e69 161 // Admin must choose some password and supply correct email.
ad6226fb 162 if (!empty($USER->newadminuser)) {
163 $mform->addRule('newpassword', get_string('required'), 'required', null, 'client');
4ad72c28
PS
164 if ($mform->elementExists('suspended')) {
165 $mform->removeElement('suspended');
166 }
ad6226fb 167 }
168
a2ed6e69 169 // Require password for new users.
483b6804
PS
170 if ($userid > 0) {
171 if ($mform->elementExists('createpassword')) {
172 $mform->removeElement('createpassword');
173 }
e8e0bb2d 174 }
175
4ad72c28 176 if ($user and is_mnet_remote_user($user)) {
a2ed6e69 177 // Only local accounts can be suspended.
4ad72c28
PS
178 if ($mform->elementExists('suspended')) {
179 $mform->removeElement('suspended');
180 }
181 }
182 if ($user and ($user->id == $USER->id or is_siteadmin($user))) {
a2ed6e69 183 // Prevent self and admin mess ups.
4ad72c28
PS
184 if ($mform->elementExists('suspended')) {
185 $mform->hardFreeze('suspended');
186 }
187 }
188
a2ed6e69 189 // Print picture.
689096bc 190 if (empty($USER->newadminuser)) {
4125bdc1 191 if ($user) {
43731030 192 $context = context_user::instance($user->id, MUST_EXIST);
4125bdc1 193 $fs = get_file_storage();
ed9e0cb6 194 $hasuploadedpicture = ($fs->file_exists($context->id, 'user', 'icon', 0, '/', 'f2.png') || $fs->file_exists($context->id, 'user', 'icon', 0, '/', 'f2.jpg'));
4125bdc1 195 if (!empty($user->picture) && $hasuploadedpicture) {
a2ed6e69 196 $imagevalue = $OUTPUT->user_picture($user, array('courseid' => SITEID, 'size' => 64));
4125bdc1
SH
197 } else {
198 $imagevalue = get_string('none');
199 }
e8e0bb2d 200 } else {
4125bdc1
SH
201 $imagevalue = get_string('none');
202 }
203 $imageelement = $mform->getElement('currentpicture');
204 $imageelement->setValue($imagevalue);
205
206 if ($user && $mform->elementExists('deletepicture') && !$hasuploadedpicture) {
207 $mform->removeElement('deletepicture');
e8e0bb2d 208 }
209 }
bb6d3d34 210
a2ed6e69 211 // Next the customisable profile fields.
63466095 212 profile_definition_after_data($mform, $userid);
e8e0bb2d 213 }
214
a2ed6e69
SH
215 /**
216 * Validate the form data.
217 * @param array $usernew
218 * @param array $files
219 * @return array|bool
220 */
221 public function validation($usernew, $files) {
5d910388 222 global $CFG, $DB;
e8e0bb2d 223
224 $usernew = (object)$usernew;
f728d49b
PS
225 $usernew->username = trim($usernew->username);
226
a2ed6e69 227 $user = $DB->get_record('user', array('id' => $usernew->id));
04f639a0 228 $err = array();
229
483b6804
PS
230 if (!$user and !empty($usernew->createpassword)) {
231 if ($usernew->suspended) {
232 // Show some error because we can not mail suspended users.
233 $err['suspended'] = get_string('error');
234 }
235 } else {
236 if (!empty($usernew->newpassword)) {
237 $errmsg = ''; // Prevent eclipse warning.
238 if (!check_password_policy($usernew->newpassword, $errmsg)) {
239 $err['newpassword'] = $errmsg;
240 }
241 } else if (!$user) {
0b3bd8cb
PS
242 $auth = get_auth_plugin($usernew->auth);
243 if ($auth->is_internal()) {
244 // Internal accounts require password!
245 $err['newpassword'] = get_string('required');
246 }
83022298 247 }
248 }
249
04f639a0 250 if (empty($usernew->username)) {
a2ed6e69 251 // Might be only whitespace.
04f639a0 252 $err['username'] = get_string('required');
253 } else if (!$user or $user->username !== $usernew->username) {
a2ed6e69
SH
254 // Check new username does not exist.
255 if ($DB->record_exists('user', array('username' => $usernew->username, 'mnethostid' => $CFG->mnet_localhost_id))) {
e8e0bb2d 256 $err['username'] = get_string('usernameexists');
257 }
a2ed6e69 258 // Check allowed characters.
2f1e464a 259 if ($usernew->username !== core_text::strtolower($usernew->username)) {
e8e0bb2d 260 $err['username'] = get_string('usernamelowercase');
6b8ad965
PS
261 } else {
262 if ($usernew->username !== clean_param($usernew->username, PARAM_USERNAME)) {
f4065447 263 $err['username'] = get_string('invalidusername');
e8e0bb2d 264 }
ad6226fb 265 }
266 }
e8e0bb2d 267
b47454f6 268 if (!$user or (isset($usernew->email) && $user->email !== $usernew->email)) {
e8e0bb2d 269 if (!validate_email($usernew->email)) {
270 $err['email'] = get_string('invalidemail');
95020832 271 } else if (empty($CFG->allowaccountssameemail)
bc983724 272 and $DB->record_exists('user', array('email' => $usernew->email, 'mnethostid' => $CFG->mnet_localhost_id))) {
e8e0bb2d 273 $err['email'] = get_string('emailexists');
274 }
275 }
276
a2ed6e69 277 // Next the customisable profile fields.
c8969c22 278 $err += profile_validation($usernew, $files);
bb6d3d34 279
a2ed6e69 280 if (count($err) == 0) {
e8e0bb2d 281 return true;
282 } else {
283 return $err;
284 }
ad6226fb 285 }
ad6226fb 286}
287
aa6c1ced 288