2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
18 * Form for editing a users profile
20 * @copyright 1999 Martin Dougiamas http://dougiamas.com
21 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25 if (!defined('MOODLE_INTERNAL')) {
26 die('Direct access to this script is forbidden.'); // It must be included from a Moodle page.
29 require_once($CFG->dirroot
.'/lib/formslib.php');
32 * Class user_editadvanced_form.
34 * @copyright 1999 Martin Dougiamas http://dougiamas.com
35 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37 class user_editadvanced_form
extends moodleform
{
42 public function definition() {
43 global $USER, $CFG, $COURSE;
45 $mform = $this->_form
;
46 $editoroptions = null;
47 $filemanageroptions = null;
49 if (!is_array($this->_customdata
)) {
50 throw new coding_exception('invalid custom data for user_edit_form');
52 $editoroptions = $this->_customdata
['editoroptions'];
53 $filemanageroptions = $this->_customdata
['filemanageroptions'];
54 $user = $this->_customdata
['user'];
57 // Accessibility: "Required" is bad legend text.
58 $strgeneral = get_string('general');
59 $strrequired = get_string('required');
61 // Add some extra hidden fields.
62 $mform->addElement('hidden', 'id');
63 $mform->setType('id', PARAM_INT
);
64 $mform->addElement('hidden', 'course', $COURSE->id
);
65 $mform->setType('course', PARAM_INT
);
67 // Print the required moodle fields first.
68 $mform->addElement('header', 'moodle', $strgeneral);
70 $auths = core_component
::get_plugin_list('auth');
71 $enabled = get_string('pluginenabled', 'core_plugin');
72 $disabled = get_string('plugindisabled', 'core_plugin');
73 $authoptions = array($enabled => array(), $disabled => array());
74 $cannotchangepass = array();
75 $cannotchangeusername = array();
76 foreach ($auths as $auth => $unused) {
77 $authinst = get_auth_plugin($auth);
79 if (!$authinst->is_internal()) {
80 $cannotchangeusername[] = $auth;
83 $passwordurl = $authinst->change_password_url();
84 if (!($authinst->can_change_password() && empty($passwordurl))) {
85 if ($userid < 1 and $authinst->is_internal()) {
86 // This is unlikely but we can not create account without password
87 // when plugin uses passwords, we need to set it initially at least.
89 $cannotchangepass[] = $auth;
92 if (is_enabled_auth($auth)) {
93 $authoptions[$enabled][$auth] = get_string('pluginname', "auth_{$auth}");
95 $authoptions[$disabled][$auth] = get_string('pluginname', "auth_{$auth}");
99 $mform->addElement('text', 'username', get_string('username'), 'size="20"');
100 $mform->addHelpButton('username', 'username', 'auth');
101 $mform->setType('username', PARAM_RAW
);
102 if ($userid !== -1) {
103 $mform->disabledIf('username', 'auth', 'in', $cannotchangeusername);
106 $mform->addElement('selectgroups', 'auth', get_string('chooseauthmethod', 'auth'), $authoptions);
107 $mform->addHelpButton('auth', 'chooseauthmethod', 'auth');
109 $mform->addElement('advcheckbox', 'suspended', get_string('suspended', 'auth'));
110 $mform->addHelpButton('suspended', 'suspended', 'auth');
112 $mform->addElement('checkbox', 'createpassword', get_string('createpassword', 'auth'));
113 $mform->disabledIf('createpassword', 'auth', 'in', $cannotchangepass);
115 if (!empty($CFG->passwordpolicy
)) {
116 $mform->addElement('static', 'passwordpolicyinfo', '', print_password_policy());
118 $mform->addElement('passwordunmask', 'newpassword', get_string('newpassword'), 'size="20"');
119 $mform->addHelpButton('newpassword', 'newpassword');
120 $mform->setType('newpassword', PARAM_RAW
);
121 $mform->disabledIf('newpassword', 'createpassword', 'checked');
123 $mform->disabledIf('newpassword', 'auth', 'in', $cannotchangepass);
125 $mform->addElement('advcheckbox', 'preference_auth_forcepasswordchange', get_string('forcepasswordchange'));
126 $mform->addHelpButton('preference_auth_forcepasswordchange', 'forcepasswordchange');
127 $mform->disabledIf('preference_auth_forcepasswordchange', 'createpassword', 'checked');
130 useredit_shared_definition($mform, $editoroptions, $filemanageroptions, $user);
132 // Next the customisable profile fields.
133 profile_definition($mform, $userid);
136 $btnstring = get_string('createuser');
138 $btnstring = get_string('updatemyprofile');
141 $this->add_action_buttons(false, $btnstring);
143 $this->set_data($user);
147 * Extend the form definition after data has been parsed.
149 public function definition_after_data() {
150 global $USER, $CFG, $DB, $OUTPUT;
152 $mform = $this->_form
;
154 // Trim required name fields.
155 foreach (useredit_get_required_name_fields() as $field) {
156 $mform->applyFilter($field, 'trim');
159 if ($userid = $mform->getElementValue('id')) {
160 $user = $DB->get_record('user', array('id' => $userid));
165 // User can not change own auth method.
166 if ($userid == $USER->id
) {
167 $mform->hardFreeze('auth');
168 $mform->hardFreeze('preference_auth_forcepasswordchange');
171 // Admin must choose some password and supply correct email.
172 if (!empty($USER->newadminuser
)) {
173 $mform->addRule('newpassword', get_string('required'), 'required', null, 'client');
174 if ($mform->elementExists('suspended')) {
175 $mform->removeElement('suspended');
179 // Require password for new users.
181 if ($mform->elementExists('createpassword')) {
182 $mform->removeElement('createpassword');
186 if ($user and is_mnet_remote_user($user)) {
187 // Only local accounts can be suspended.
188 if ($mform->elementExists('suspended')) {
189 $mform->removeElement('suspended');
192 if ($user and ($user->id
== $USER->id
or is_siteadmin($user))) {
193 // Prevent self and admin mess ups.
194 if ($mform->elementExists('suspended')) {
195 $mform->hardFreeze('suspended');
200 if (empty($USER->newadminuser
)) {
202 $context = context_user
::instance($user->id
, MUST_EXIST
);
203 $fs = get_file_storage();
204 $hasuploadedpicture = ($fs->file_exists($context->id
, 'user', 'icon', 0, '/', 'f2.png') ||
$fs->file_exists($context->id
, 'user', 'icon', 0, '/', 'f2.jpg'));
205 if (!empty($user->picture
) && $hasuploadedpicture) {
206 $imagevalue = $OUTPUT->user_picture($user, array('courseid' => SITEID
, 'size' => 64));
208 $imagevalue = get_string('none');
211 $imagevalue = get_string('none');
213 $imageelement = $mform->getElement('currentpicture');
214 $imageelement->setValue($imagevalue);
216 if ($user && $mform->elementExists('deletepicture') && !$hasuploadedpicture) {
217 $mform->removeElement('deletepicture');
221 // Next the customisable profile fields.
222 profile_definition_after_data($mform, $userid);
226 * Validate the form data.
227 * @param array $usernew
228 * @param array $files
231 public function validation($usernew, $files) {
234 $usernew = (object)$usernew;
235 $usernew->username
= trim($usernew->username
);
237 $user = $DB->get_record('user', array('id' => $usernew->id
));
240 if (!$user and !empty($usernew->createpassword
)) {
241 if ($usernew->suspended
) {
242 // Show some error because we can not mail suspended users.
243 $err['suspended'] = get_string('error');
246 if (!empty($usernew->newpassword
)) {
247 $errmsg = ''; // Prevent eclipse warning.
248 if (!check_password_policy($usernew->newpassword
, $errmsg)) {
249 $err['newpassword'] = $errmsg;
252 $auth = get_auth_plugin($usernew->auth
);
253 if ($auth->is_internal()) {
254 // Internal accounts require password!
255 $err['newpassword'] = get_string('required');
260 if (empty($usernew->username
)) {
261 // Might be only whitespace.
262 $err['username'] = get_string('required');
263 } else if (!$user or $user->username
!== $usernew->username
) {
264 // Check new username does not exist.
265 if ($DB->record_exists('user', array('username' => $usernew->username
, 'mnethostid' => $CFG->mnet_localhost_id
))) {
266 $err['username'] = get_string('usernameexists');
268 // Check allowed characters.
269 if ($usernew->username
!== core_text
::strtolower($usernew->username
)) {
270 $err['username'] = get_string('usernamelowercase');
272 if ($usernew->username
!== clean_param($usernew->username
, PARAM_USERNAME
)) {
273 $err['username'] = get_string('invalidusername');
278 if (!$user or (isset($usernew->email
) && $user->email
!== $usernew->email
)) {
279 if (!validate_email($usernew->email
)) {
280 $err['email'] = get_string('invalidemail');
281 } else if (empty($CFG->allowaccountssameemail
)
282 and $DB->record_exists('user', array('email' => $usernew->email
, 'mnethostid' => $CFG->mnet_localhost_id
))) {
283 $err['email'] = get_string('emailexists');
287 // Next the customisable profile fields.
288 $err +
= profile_validation($usernew, $files);
290 if (count($err) == 0) {