MDL-49684 timezones: add BC unit test first
[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;
48 $userid = $USER->id;
49
50 if (is_array($this->_customdata)) {
51 if (array_key_exists('editoroptions', $this->_customdata)) {
52 $editoroptions = $this->_customdata['editoroptions'];
53 }
54 if (array_key_exists('filemanageroptions', $this->_customdata)) {
55 $filemanageroptions = $this->_customdata['filemanageroptions'];
56 }
57 if (array_key_exists('userid', $this->_customdata)) {
58 $userid = $this->_customdata['userid'];
59 }
4e782b32 60 }
8bdc9cac 61
a2ed6e69 62 // Accessibility: "Required" is bad legend text.
c8149f0f 63 $strgeneral = get_string('general');
ad6226fb 64 $strrequired = get_string('required');
65
a2ed6e69 66 // Add some extra hidden fields.
ad6226fb 67 $mform->addElement('hidden', 'id');
d18e0fe6 68 $mform->setType('id', PARAM_INT);
d8734783 69 $mform->addElement('hidden', 'course', $COURSE->id);
d18e0fe6 70 $mform->setType('course', PARAM_INT);
ad6226fb 71
a2ed6e69 72 // Print the required moodle fields first.
c8149f0f 73 $mform->addElement('header', 'moodle', $strgeneral);
ad6226fb 74
75 $mform->addElement('text', 'username', get_string('username'), 'size="20"');
76 $mform->addRule('username', $strrequired, 'required', null, 'client');
77 $mform->setType('username', PARAM_RAW);
78
bd3b3bba 79 $auths = core_component::get_plugin_list('auth');
c5772ede
PS
80 $enabled = get_string('pluginenabled', 'core_plugin');
81 $disabled = get_string('plugindisabled', 'core_plugin');
a2ed6e69 82 $authoptions = array($enabled => array(), $disabled => array());
6513cc03 83 $cannotchangepass = array();
17da2e6f 84 foreach ($auths as $auth => $unused) {
6513cc03
AA
85 $authinst = get_auth_plugin($auth);
86 $passwordurl = $authinst->change_password_url();
87 if (!($authinst->can_change_password() && empty($passwordurl))) {
0b3bd8cb
PS
88 if (!$userid and $authinst->is_internal()) {
89 // This is unlikely but we can not create account without password
90 // when plugin uses passwords, we need to set it initially at least.
91 } else {
92 $cannotchangepass[] = $auth;
93 }
6513cc03 94 }
c5772ede 95 if (is_enabled_auth($auth)) {
a2ed6e69 96 $authoptions[$enabled][$auth] = get_string('pluginname', "auth_{$auth}");
c5772ede 97 } else {
a2ed6e69 98 $authoptions[$disabled][$auth] = get_string('pluginname', "auth_{$auth}");
c5772ede 99 }
ad6226fb 100 }
a2ed6e69 101 $mform->addElement('selectgroups', 'auth', get_string('chooseauthmethod', 'auth'), $authoptions);
f728d49b 102 $mform->addHelpButton('auth', 'chooseauthmethod', 'auth');
ad6226fb 103
a2ed6e69 104 $mform->addElement('advcheckbox', 'suspended', get_string('suspended', 'auth'));
4ad72c28
PS
105 $mform->addHelpButton('suspended', 'suspended', 'auth');
106
a2ed6e69 107 $mform->addElement('checkbox', 'createpassword', get_string('createpassword', 'auth'));
0b3bd8cb 108 $mform->disabledIf('createpassword', 'auth', 'in', $cannotchangepass);
483b6804 109
a2ed6e69 110 if (!empty($CFG->passwordpolicy)) {
3bf11ca4 111 $mform->addElement('static', 'passwordpolicyinfo', '', print_password_policy());
851481dc 112 }
54bb33eb 113 $mform->addElement('passwordunmask', 'newpassword', get_string('newpassword'), 'size="20"');
27d1a27c 114 $mform->addHelpButton('newpassword', 'newpassword');
ad6226fb 115 $mform->setType('newpassword', PARAM_RAW);
483b6804 116 $mform->disabledIf('newpassword', 'createpassword', 'checked');
ad6226fb 117
6513cc03
AA
118 $mform->disabledIf('newpassword', 'auth', 'in', $cannotchangepass);
119
fa1d88eb 120 $mform->addElement('advcheckbox', 'preference_auth_forcepasswordchange', get_string('forcepasswordchange'));
27d1a27c 121 $mform->addHelpButton('preference_auth_forcepasswordchange', 'forcepasswordchange');
483b6804
PS
122 $mform->disabledIf('preference_auth_forcepasswordchange', 'createpassword', 'checked');
123
a2ed6e69 124 // Shared fields.
4e782b32 125 useredit_shared_definition($mform, $editoroptions, $filemanageroptions);
ad6226fb 126
a2ed6e69 127 // Next the customisable profile fields.
fc3aa0fb 128 profile_definition($mform, $userid);
bb6d3d34 129
607fdfc3
AA
130 if ($userid == -1) {
131 $btnstring = get_string('createuser');
132 } else {
133 $btnstring = get_string('updatemyprofile');
134 }
135
136 $this->add_action_buttons(false, $btnstring);
ad6226fb 137 }
138
a2ed6e69
SH
139 /**
140 * Extend the form definition after data has been parsed.
141 */
142 public function definition_after_data() {
f2f085ee 143 global $USER, $CFG, $DB, $OUTPUT;
ad6226fb 144
a2ed6e69 145 $mform = $this->_form;
9122137f 146 if ($userid = $mform->getElementValue('id')) {
a2ed6e69 147 $user = $DB->get_record('user', array('id' => $userid));
9122137f 148 } else {
149 $user = false;
150 }
ad6226fb 151
a2ed6e69 152 // If language does not exist, use site default lang.
1545d7f0 153 if ($langsel = $mform->getElementValue('lang')) {
154 $lang = reset($langsel);
a2ed6e69 155 // Check lang exists.
96de38c3 156 if (!get_string_manager()->translation_exists($lang, false)) {
a2ed6e69
SH
157 $langel =& $mform->getElement('lang');
158 $langel->setValue($CFG->lang);
1545d7f0 159 }
160 }
161
a2ed6e69 162 // User can not change own auth method.
e8e0bb2d 163 if ($userid == $USER->id) {
164 $mform->hardFreeze('auth');
165 $mform->hardFreeze('preference_auth_forcepasswordchange');
ad6226fb 166 }
167
a2ed6e69 168 // Admin must choose some password and supply correct email.
ad6226fb 169 if (!empty($USER->newadminuser)) {
170 $mform->addRule('newpassword', get_string('required'), 'required', null, 'client');
4ad72c28
PS
171 if ($mform->elementExists('suspended')) {
172 $mform->removeElement('suspended');
173 }
ad6226fb 174 }
175
a2ed6e69 176 // Require password for new users.
483b6804
PS
177 if ($userid > 0) {
178 if ($mform->elementExists('createpassword')) {
179 $mform->removeElement('createpassword');
180 }
e8e0bb2d 181 }
182
4ad72c28 183 if ($user and is_mnet_remote_user($user)) {
a2ed6e69 184 // Only local accounts can be suspended.
4ad72c28
PS
185 if ($mform->elementExists('suspended')) {
186 $mform->removeElement('suspended');
187 }
188 }
189 if ($user and ($user->id == $USER->id or is_siteadmin($user))) {
a2ed6e69 190 // Prevent self and admin mess ups.
4ad72c28
PS
191 if ($mform->elementExists('suspended')) {
192 $mform->hardFreeze('suspended');
193 }
194 }
195
a2ed6e69 196 // Print picture.
689096bc 197 if (empty($USER->newadminuser)) {
4125bdc1 198 if ($user) {
43731030 199 $context = context_user::instance($user->id, MUST_EXIST);
4125bdc1 200 $fs = get_file_storage();
ed9e0cb6 201 $hasuploadedpicture = ($fs->file_exists($context->id, 'user', 'icon', 0, '/', 'f2.png') || $fs->file_exists($context->id, 'user', 'icon', 0, '/', 'f2.jpg'));
4125bdc1 202 if (!empty($user->picture) && $hasuploadedpicture) {
a2ed6e69 203 $imagevalue = $OUTPUT->user_picture($user, array('courseid' => SITEID, 'size' => 64));
4125bdc1
SH
204 } else {
205 $imagevalue = get_string('none');
206 }
e8e0bb2d 207 } else {
4125bdc1
SH
208 $imagevalue = get_string('none');
209 }
210 $imageelement = $mform->getElement('currentpicture');
211 $imageelement->setValue($imagevalue);
212
213 if ($user && $mform->elementExists('deletepicture') && !$hasuploadedpicture) {
214 $mform->removeElement('deletepicture');
e8e0bb2d 215 }
216 }
bb6d3d34 217
a2ed6e69 218 // Next the customisable profile fields.
63466095 219 profile_definition_after_data($mform, $userid);
e8e0bb2d 220 }
221
a2ed6e69
SH
222 /**
223 * Validate the form data.
224 * @param array $usernew
225 * @param array $files
226 * @return array|bool
227 */
228 public function validation($usernew, $files) {
5d910388 229 global $CFG, $DB;
e8e0bb2d 230
231 $usernew = (object)$usernew;
f728d49b
PS
232 $usernew->username = trim($usernew->username);
233
a2ed6e69 234 $user = $DB->get_record('user', array('id' => $usernew->id));
04f639a0 235 $err = array();
236
483b6804
PS
237 if (!$user and !empty($usernew->createpassword)) {
238 if ($usernew->suspended) {
239 // Show some error because we can not mail suspended users.
240 $err['suspended'] = get_string('error');
241 }
242 } else {
243 if (!empty($usernew->newpassword)) {
244 $errmsg = ''; // Prevent eclipse warning.
245 if (!check_password_policy($usernew->newpassword, $errmsg)) {
246 $err['newpassword'] = $errmsg;
247 }
248 } else if (!$user) {
0b3bd8cb
PS
249 $auth = get_auth_plugin($usernew->auth);
250 if ($auth->is_internal()) {
251 // Internal accounts require password!
252 $err['newpassword'] = get_string('required');
253 }
83022298 254 }
255 }
256
04f639a0 257 if (empty($usernew->username)) {
a2ed6e69 258 // Might be only whitespace.
04f639a0 259 $err['username'] = get_string('required');
260 } else if (!$user or $user->username !== $usernew->username) {
a2ed6e69
SH
261 // Check new username does not exist.
262 if ($DB->record_exists('user', array('username' => $usernew->username, 'mnethostid' => $CFG->mnet_localhost_id))) {
e8e0bb2d 263 $err['username'] = get_string('usernameexists');
264 }
a2ed6e69 265 // Check allowed characters.
2f1e464a 266 if ($usernew->username !== core_text::strtolower($usernew->username)) {
e8e0bb2d 267 $err['username'] = get_string('usernamelowercase');
6b8ad965
PS
268 } else {
269 if ($usernew->username !== clean_param($usernew->username, PARAM_USERNAME)) {
f4065447 270 $err['username'] = get_string('invalidusername');
e8e0bb2d 271 }
ad6226fb 272 }
273 }
e8e0bb2d 274
275 if (!$user or $user->email !== $usernew->email) {
276 if (!validate_email($usernew->email)) {
277 $err['email'] = get_string('invalidemail');
a2ed6e69 278 } else if ($DB->record_exists('user', array('email' => $usernew->email, 'mnethostid' => $CFG->mnet_localhost_id))) {
e8e0bb2d 279 $err['email'] = get_string('emailexists');
280 }
281 }
282
a2ed6e69 283 // Next the customisable profile fields.
c8969c22 284 $err += profile_validation($usernew, $files);
bb6d3d34 285
a2ed6e69 286 if (count($err) == 0) {
e8e0bb2d 287 return true;
288 } else {
289 return $err;
290 }
ad6226fb 291 }
ad6226fb 292}
293
aa6c1ced 294