MDL-66173 login: Added form injection, validation and post action hooks
[moodle.git] / login / signup_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  * User sign-up form.
19  *
20  * @package    core
21  * @subpackage auth
22  * @copyright  1999 onwards Martin Dougiamas  http://dougiamas.com
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 require_once($CFG->libdir.'/formslib.php');
29 require_once($CFG->dirroot.'/user/profile/lib.php');
30 require_once($CFG->dirroot . '/user/editlib.php');
31 require_once('lib.php');
33 class login_signup_form extends moodleform implements renderable, templatable {
34     function definition() {
35         global $USER, $CFG;
37         $mform = $this->_form;
39         $mform->addElement('header', 'createuserandpass', get_string('createuserandpass'), '');
42         $mform->addElement('text', 'username', get_string('username'), 'maxlength="100" size="12" autocapitalize="none"');
43         $mform->setType('username', PARAM_RAW);
44         $mform->addRule('username', get_string('missingusername'), 'required', null, 'client');
46         if (!empty($CFG->passwordpolicy)){
47             $mform->addElement('static', 'passwordpolicyinfo', '', print_password_policy());
48         }
49         $mform->addElement('password', 'password', get_string('password'), 'maxlength="32" size="12"');
50         $mform->setType('password', core_user::get_property_type('password'));
51         $mform->addRule('password', get_string('missingpassword'), 'required', null, 'client');
53         $mform->addElement('header', 'supplyinfo', get_string('supplyinfo'),'');
55         $mform->addElement('text', 'email', get_string('email'), 'maxlength="100" size="25"');
56         $mform->setType('email', core_user::get_property_type('email'));
57         $mform->addRule('email', get_string('missingemail'), 'required', null, 'client');
58         $mform->setForceLtr('email');
60         $mform->addElement('text', 'email2', get_string('emailagain'), 'maxlength="100" size="25"');
61         $mform->setType('email2', core_user::get_property_type('email'));
62         $mform->addRule('email2', get_string('missingemail'), 'required', null, 'client');
63         $mform->setForceLtr('email2');
65         $namefields = useredit_get_required_name_fields();
66         foreach ($namefields as $field) {
67             $mform->addElement('text', $field, get_string($field), 'maxlength="100" size="30"');
68             $mform->setType($field, core_user::get_property_type('firstname'));
69             $stringid = 'missing' . $field;
70             if (!get_string_manager()->string_exists($stringid, 'moodle')) {
71                 $stringid = 'required';
72             }
73             $mform->addRule($field, get_string($stringid), 'required', null, 'client');
74         }
76         $mform->addElement('text', 'city', get_string('city'), 'maxlength="120" size="20"');
77         $mform->setType('city', core_user::get_property_type('city'));
78         if (!empty($CFG->defaultcity)) {
79             $mform->setDefault('city', $CFG->defaultcity);
80         }
82         $country = get_string_manager()->get_list_of_countries();
83         $default_country[''] = get_string('selectacountry');
84         $country = array_merge($default_country, $country);
85         $mform->addElement('select', 'country', get_string('country'), $country);
87         if( !empty($CFG->country) ){
88             $mform->setDefault('country', $CFG->country);
89         }else{
90             $mform->setDefault('country', '');
91         }
93         profile_signup_fields($mform);
95         if (signup_captcha_enabled()) {
96             $mform->addElement('recaptcha', 'recaptcha_element', get_string('security_question', 'auth'));
97             $mform->addHelpButton('recaptcha_element', 'recaptcha', 'auth');
98             $mform->closeHeaderBefore('recaptcha_element');
99         }
101         // Hook for plugins to extend form definition.
102         core_login_extend_signup_form($mform);
104         // Add "Agree to sitepolicy" controls. By default it is a link to the policy text and a checkbox but
105         // it can be implemented differently in custom sitepolicy handlers.
106         $manager = new \core_privacy\local\sitepolicy\manager();
107         $manager->signup_form($mform);
109         // buttons
110         $this->add_action_buttons(true, get_string('createaccount'));
112     }
114     function definition_after_data(){
115         $mform = $this->_form;
116         $mform->applyFilter('username', 'trim');
118         // Trim required name fields.
119         foreach (useredit_get_required_name_fields() as $field) {
120             $mform->applyFilter($field, 'trim');
121         }
122     }
124     /**
125      * Validate user supplied data on the signup form.
126      *
127      * @param array $data array of ("fieldname"=>value) of submitted data
128      * @param array $files array of uploaded files "element_name"=>tmp_file_path
129      * @return array of "element_name"=>"error_description" if there are errors,
130      *         or an empty array if everything is OK (true allowed for backwards compatibility too).
131      */
132     public function validation($data, $files) {
133         $errors = parent::validation($data, $files);
135         // Extend validation for any form extensions from plugins.
136         $errors = array_merge($errors, core_login_validate_extend_signup_form($data));
138         if (signup_captcha_enabled()) {
139             $recaptchaelement = $this->_form->getElement('recaptcha_element');
140             if (!empty($this->_form->_submitValues['g-recaptcha-response'])) {
141                 $response = $this->_form->_submitValues['g-recaptcha-response'];
142                 if (!$recaptchaelement->verify($response)) {
143                     $errors['recaptcha_element'] = get_string('incorrectpleasetryagain', 'auth');
144                 }
145             } else {
146                 $errors['recaptcha_element'] = get_string('missingrecaptchachallengefield');
147             }
148         }
150         $errors += signup_validate_data($data, $files);
152         return $errors;
153     }
155     /**
156      * Export this data so it can be used as the context for a mustache template.
157      *
158      * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
159      * @return array
160      */
161     public function export_for_template(renderer_base $output) {
162         ob_start();
163         $this->display();
164         $formhtml = ob_get_contents();
165         ob_end_clean();
166         $context = [
167             'formhtml' => $formhtml
168         ];
169         return $context;
170     }