82e8fbdf01a2df08ccb75dd1e7dffb903d073637
[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'), '');
41         $mform->addElement('text', 'username', get_string('username'), 'maxlength="100" size="12" autocapitalize="none"');
42         $mform->setType('username', PARAM_RAW);
43         $mform->addRule('username', get_string('missingusername'), 'required', null, 'client');
45         if (!empty($CFG->passwordpolicy)){
46             $mform->addElement('static', 'passwordpolicyinfo', '', print_password_policy());
47         }
48         $mform->addElement('password', 'password', get_string('password'), [
49             'maxlength' => 32,
50             'size' => 12,
51             'autocomplete' => 'new-password'
52         ]);
53         $mform->setType('password', core_user::get_property_type('password'));
54         $mform->addRule('password', get_string('missingpassword'), 'required', null, 'client');
56         $mform->addElement('header', 'supplyinfo', get_string('supplyinfo'),'');
58         $mform->addElement('text', 'email', get_string('email'), 'maxlength="100" size="25"');
59         $mform->setType('email', core_user::get_property_type('email'));
60         $mform->addRule('email', get_string('missingemail'), 'required', null, 'client');
61         $mform->setForceLtr('email');
63         $mform->addElement('text', 'email2', get_string('emailagain'), 'maxlength="100" size="25"');
64         $mform->setType('email2', core_user::get_property_type('email'));
65         $mform->addRule('email2', get_string('missingemail'), 'required', null, 'client');
66         $mform->setForceLtr('email2');
68         $namefields = useredit_get_required_name_fields();
69         foreach ($namefields as $field) {
70             $mform->addElement('text', $field, get_string($field), 'maxlength="100" size="30"');
71             $mform->setType($field, core_user::get_property_type('firstname'));
72             $stringid = 'missing' . $field;
73             if (!get_string_manager()->string_exists($stringid, 'moodle')) {
74                 $stringid = 'required';
75             }
76             $mform->addRule($field, get_string($stringid), 'required', null, 'client');
77         }
79         $mform->addElement('text', 'city', get_string('city'), 'maxlength="120" size="20"');
80         $mform->setType('city', core_user::get_property_type('city'));
81         if (!empty($CFG->defaultcity)) {
82             $mform->setDefault('city', $CFG->defaultcity);
83         }
85         $country = get_string_manager()->get_list_of_countries();
86         $default_country[''] = get_string('selectacountry');
87         $country = array_merge($default_country, $country);
88         $mform->addElement('select', 'country', get_string('country'), $country);
90         if( !empty($CFG->country) ){
91             $mform->setDefault('country', $CFG->country);
92         }else{
93             $mform->setDefault('country', '');
94         }
96         profile_signup_fields($mform);
98         if (signup_captcha_enabled()) {
99             $mform->addElement('recaptcha', 'recaptcha_element', get_string('security_question', 'auth'));
100             $mform->addHelpButton('recaptcha_element', 'recaptcha', 'auth');
101             $mform->closeHeaderBefore('recaptcha_element');
102         }
104         // Hook for plugins to extend form definition.
105         core_login_extend_signup_form($mform);
107         // Add "Agree to sitepolicy" controls. By default it is a link to the policy text and a checkbox but
108         // it can be implemented differently in custom sitepolicy handlers.
109         $manager = new \core_privacy\local\sitepolicy\manager();
110         $manager->signup_form($mform);
112         // buttons
113         $this->add_action_buttons(true, get_string('createaccount'));
115     }
117     function definition_after_data(){
118         $mform = $this->_form;
119         $mform->applyFilter('username', 'trim');
121         // Trim required name fields.
122         foreach (useredit_get_required_name_fields() as $field) {
123             $mform->applyFilter($field, 'trim');
124         }
125     }
127     /**
128      * Validate user supplied data on the signup form.
129      *
130      * @param array $data array of ("fieldname"=>value) of submitted data
131      * @param array $files array of uploaded files "element_name"=>tmp_file_path
132      * @return array of "element_name"=>"error_description" if there are errors,
133      *         or an empty array if everything is OK (true allowed for backwards compatibility too).
134      */
135     public function validation($data, $files) {
136         $errors = parent::validation($data, $files);
138         // Extend validation for any form extensions from plugins.
139         $errors = array_merge($errors, core_login_validate_extend_signup_form($data));
141         if (signup_captcha_enabled()) {
142             $recaptchaelement = $this->_form->getElement('recaptcha_element');
143             if (!empty($this->_form->_submitValues['g-recaptcha-response'])) {
144                 $response = $this->_form->_submitValues['g-recaptcha-response'];
145                 if (!$recaptchaelement->verify($response)) {
146                     $errors['recaptcha_element'] = get_string('incorrectpleasetryagain', 'auth');
147                 }
148             } else {
149                 $errors['recaptcha_element'] = get_string('missingrecaptchachallengefield');
150             }
151         }
153         $errors += signup_validate_data($data, $files);
155         return $errors;
156     }
158     /**
159      * Export this data so it can be used as the context for a mustache template.
160      *
161      * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
162      * @return array
163      */
164     public function export_for_template(renderer_base $output) {
165         ob_start();
166         $this->display();
167         $formhtml = ob_get_contents();
168         ob_end_clean();
169         $context = [
170             'formhtml' => $formhtml
171         ];
172         return $context;
173     }