MDL-52831 users: Automatically strip whitespace from name fields
[moodle.git] / user / edit_form.php
1 <?php
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/>.
17 /**
18  * Form to edit 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  */
25 if (!defined('MOODLE_INTERNAL')) {
26     die('Direct access to this script is forbidden.');    //  It must be included from a Moodle page.
27 }
29 require_once($CFG->dirroot.'/lib/formslib.php');
31 /**
32  * Class user_edit_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  */
37 class user_edit_form extends moodleform {
39     /**
40      * Define the form.
41      */
42     public function definition () {
43         global $CFG, $COURSE, $USER;
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');
51         }
52         $editoroptions = $this->_customdata['editoroptions'];
53         $filemanageroptions = $this->_customdata['filemanageroptions'];
54         $user = $this->_customdata['user'];
55         $userid = $user->id;
57         if (empty($user->country)) {
58             // We must unset the value here so $CFG->country can be used as default one.
59             unset($user->country);
60         }
62         // Accessibility: "Required" is bad legend text.
63         $strgeneral  = get_string('general');
64         $strrequired = get_string('required');
66         // Add some extra hidden fields.
67         $mform->addElement('hidden', 'id');
68         $mform->setType('id', PARAM_INT);
69         $mform->addElement('hidden', 'course', $COURSE->id);
70         $mform->setType('course', PARAM_INT);
72         // Print the required moodle fields first.
73         $mform->addElement('header', 'moodle', $strgeneral);
75         // Shared fields.
76         useredit_shared_definition($mform, $editoroptions, $filemanageroptions, $user);
78         // Extra settigs.
79         if (!empty($CFG->disableuserimages)) {
80             $mform->removeElement('deletepicture');
81             $mform->removeElement('imagefile');
82             $mform->removeElement('imagealt');
83         }
85         // Next the customisable profile fields.
86         profile_definition($mform, $userid);
88         $this->add_action_buttons(false, get_string('updatemyprofile'));
90         $this->set_data($user);
91     }
93     /**
94      * Extend the form definition after the data has been parsed.
95      */
96     public function definition_after_data() {
97         global $CFG, $DB, $OUTPUT;
99         $mform = $this->_form;
100         $userid = $mform->getElementValue('id');
102         // Trim required name fields.
103         foreach (useredit_get_required_name_fields() as $field) {
104             $mform->applyFilter($field, 'trim');
105         }
107         if ($user = $DB->get_record('user', array('id' => $userid))) {
109             // Remove description.
110             if (empty($user->description) && !empty($CFG->profilesforenrolledusersonly) && !$DB->record_exists('role_assignments', array('userid' => $userid))) {
111                 $mform->removeElement('description_editor');
112             }
114             // Print picture.
115             $context = context_user::instance($user->id, MUST_EXIST);
116             $fs = get_file_storage();
117             $hasuploadedpicture = ($fs->file_exists($context->id, 'user', 'icon', 0, '/', 'f2.png') || $fs->file_exists($context->id, 'user', 'icon', 0, '/', 'f2.jpg'));
118             if (!empty($user->picture) && $hasuploadedpicture) {
119                 $imagevalue = $OUTPUT->user_picture($user, array('courseid' => SITEID, 'size' => 64));
120             } else {
121                 $imagevalue = get_string('none');
122             }
123             $imageelement = $mform->getElement('currentpicture');
124             $imageelement->setValue($imagevalue);
126             if ($mform->elementExists('deletepicture') && !$hasuploadedpicture) {
127                 $mform->removeElement('deletepicture');
128             }
130             // Disable fields that are locked by auth plugins.
131             $fields = get_user_fieldnames();
132             $authplugin = get_auth_plugin($user->auth);
133             $customfields = $authplugin->get_custom_user_profile_fields();
134             $fields = array_merge($fields, $customfields);
135             foreach ($fields as $field) {
136                 if ($field === 'description') {
137                     // Hard coded hack for description field. See MDL-37704 for details.
138                     $formfield = 'description_editor';
139                 } else {
140                     $formfield = $field;
141                 }
142                 if (!$mform->elementExists($formfield)) {
143                     continue;
144                 }
145                 $value = $mform->getElement($formfield)->exportValue($mform->getElementValue($formfield)) ?: '';
146                 $configvariable = 'field_lock_' . $field;
147                 if (isset($authplugin->config->{$configvariable})) {
148                     if ($authplugin->config->{$configvariable} === 'locked') {
149                         $mform->hardFreeze($formfield);
150                         $mform->setConstant($formfield, $value);
151                     } else if ($authplugin->config->{$configvariable} === 'unlockedifempty' and $value != '') {
152                         $mform->hardFreeze($formfield);
153                         $mform->setConstant($formfield, $value);
154                     }
155                 }
156             }
158             // Next the customisable profile fields.
159             profile_definition_after_data($mform, $user->id);
161         } else {
162             profile_definition_after_data($mform, 0);
163         }
164     }
166     /**
167      * Validate incoming form data.
168      * @param array $usernew
169      * @param array $files
170      * @return array
171      */
172     public function validation($usernew, $files) {
173         global $CFG, $DB;
175         $errors = parent::validation($usernew, $files);
177         $usernew = (object)$usernew;
178         $user    = $DB->get_record('user', array('id' => $usernew->id));
180         // Validate email.
181         if (!isset($usernew->email)) {
182             // Mail not confirmed yet.
183         } else if (!validate_email($usernew->email)) {
184             $errors['email'] = get_string('invalidemail');
185         } else if (($usernew->email !== $user->email)
186                 and empty($CFG->allowaccountssameemail)
187                 and $DB->record_exists('user', array('email' => $usernew->email, 'mnethostid' => $CFG->mnet_localhost_id))) {
188             $errors['email'] = get_string('emailexists');
189         }
191         if (isset($usernew->email) and $usernew->email === $user->email and over_bounce_threshold($user)) {
192             $errors['email'] = get_string('toomanybounces');
193         }
195         if (isset($usernew->email) and !empty($CFG->verifychangedemail) and !isset($errors['email']) and !has_capability('moodle/user:update', context_system::instance())) {
196             $errorstr = email_is_not_allowed($usernew->email);
197             if ($errorstr !== false) {
198                 $errors['email'] = $errorstr;
199             }
200         }
202         // Next the customisable profile fields.
203         $errors += profile_validation($usernew, $files);
205         return $errors;
206     }