Merge branch 'MDL-66118-master-byebyemoodlenet' of git://github.com/mudrd8mz/moodle
[moodle.git] / lib / classes / hub / site_registration_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  * Class site_registration_form
19  *
20  * @package    core
21  * @copyright  2017 Marina Glancy
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core\hub;
26 defined('MOODLE_INTERNAL') || die();
28 use context_course;
29 use stdClass;
31 global $CFG;
32 require_once($CFG->libdir . '/formslib.php');
34 /**
35  * The site registration form. Information will be sent to the sites directory.
36  *
37  * @author     Jerome Mouneyrac <jerome@mouneyrac.com>
38  * @package    core
39  * @copyright  2017 Marina Glancy
40  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41  */
42 class site_registration_form extends \moodleform {
44     /**
45      * Form definition
46      */
47     public function definition() {
48         global $CFG;
50         $strrequired = get_string('required');
51         $mform = & $this->_form;
52         $admin = get_admin();
53         $site = get_site();
55         $siteinfo = registration::get_site_info([
56             'name' => format_string($site->fullname, true, array('context' => context_course::instance(SITEID))),
57             'description' => $site->summary,
58             'contactname' => fullname($admin, true),
59             'contactemail' => $admin->email,
60             'contactphone' => $admin->phone1,
61             'street' => '',
62             'countrycode' => $admin->country ?: $CFG->country,
63             'regioncode' => '-', // Not supported yet.
64             'language' => explode('_', current_language())[0],
65             'geolocation' => '',
66             'emailalert' => 1,
67             'commnews' => 1,
68             'policyagreed' => 0
70         ]);
72         // Fields that need to be highlighted.
73         $highlightfields = registration::get_new_registration_fields();
75         $mform->addElement('header', 'moodle', get_string('registrationinfo', 'hub'));
77         $mform->addElement('text', 'name', get_string('sitename', 'hub'),
78             array('class' => 'registration_textfield', 'maxlength' => 255));
79         $mform->setType('name', PARAM_TEXT);
80         $mform->addHelpButton('name', 'sitename', 'hub');
82         $mform->addElement('select', 'privacy', get_string('siteprivacy', 'hub'), registration::site_privacy_options());
83         $mform->setType('privacy', PARAM_ALPHA);
84         $mform->addHelpButton('privacy', 'siteprivacy', 'hub');
85         unset($options);
87         $mform->addElement('textarea', 'description', get_string('sitedesc', 'hub'),
88             array('rows' => 3, 'cols' => 41));
89         $mform->setType('description', PARAM_TEXT);
90         $mform->addHelpButton('description', 'sitedesc', 'hub');
92         $languages = get_string_manager()->get_list_of_languages();
93         \core_collator::asort($languages);
94         $mform->addElement('select', 'language', get_string('sitelang', 'hub'), $languages);
95         $mform->setType('language', PARAM_ALPHANUMEXT);
96         $mform->addHelpButton('language', 'sitelang', 'hub');
98         // Postal address was part of this form before but not any more.
99         $mform->addElement('hidden', 'street');
100         $mform->setType('street', PARAM_TEXT);
101         $mform->addHelpButton('street', 'postaladdress', 'hub');
103         $mform->addElement('hidden', 'regioncode', '-');
104         $mform->setType('regioncode', PARAM_ALPHANUMEXT);
106         $countries = ['' => ''] + get_string_manager()->get_list_of_countries();
107         $mform->addElement('select', 'countrycode', get_string('sitecountry', 'hub'), $countries);
108         $mform->setType('countrycode', PARAM_ALPHANUMEXT);
109         $mform->addHelpButton('countrycode', 'sitecountry', 'hub');
110         $mform->addRule('countrycode', $strrequired, 'required', null, 'client');
112         // Geolocation was part of this form before but not any more.
113         $mform->addElement('hidden', 'geolocation');
114         $mform->setType('geolocation', PARAM_RAW);
115         $mform->addHelpButton('geolocation', 'sitegeolocation', 'hub');
117         // Admin name was part of this form before but not any more.
118         $mform->addElement('hidden', 'contactname');
119         $mform->setType('contactname', PARAM_TEXT);
120         $mform->addHelpButton('contactname', 'siteadmin', 'hub');
122         $mform->addElement('hidden', 'contactphone');
123         $mform->setType('contactphone', PARAM_TEXT);
124         $mform->addHelpButton('contactphone', 'sitephone', 'hub');
126         $mform->addElement('text', 'contactemail', get_string('siteemail', 'hub'),
127             array('class' => 'registration_textfield'));
128         $mform->addRule('contactemail', $strrequired, 'required', null, 'client');
129         $mform->setType('contactemail', PARAM_EMAIL);
130         $mform->addHelpButton('contactemail', 'siteemail', 'hub');
132         $options = array();
133         $options[0] = get_string("registrationcontactno");
134         $options[1] = get_string("registrationcontactyes");
135         $mform->addElement('select', 'contactable', get_string('siteregistrationcontact', 'hub'), $options);
136         $mform->setType('contactable', PARAM_INT);
137         $mform->addHelpButton('contactable', 'siteregistrationcontact', 'hub');
138         $mform->hideIf('contactable', 'privacy', 'eq', registration::HUB_SITENOTPUBLISHED);
139         unset($options);
141         $this->add_select_with_email('emailalert', 'siteregistrationemail', [
142             0 => get_string('registrationno'),
143             1 => get_string('registrationyes'),
144         ]);
146         $this->add_select_with_email('commnews', 'sitecommnews', [
147             0 => get_string('sitecommnewsno', 'hub'),
148             1 => get_string('sitecommnewsyes', 'hub'),
149         ], in_array('commnews', $highlightfields));
151         // TODO site logo.
152         $mform->addElement('hidden', 'imageurl', ''); // TODO: temporary.
153         $mform->setType('imageurl', PARAM_URL);
155         $mform->addElement('checkbox', 'policyagreed', get_string('policyagreed', 'hub'),
156             get_string('policyagreeddesc', 'hub', HUB_MOODLEORGHUBURL . '/privacy'));
157         $mform->addRule('policyagreed', $strrequired, 'required', null, 'client');
159         $mform->addElement('header', 'sitestats', get_string('sendfollowinginfo', 'hub'));
160         $mform->setExpanded('sitestats', !empty($highlightfields));
161         $mform->addElement('static', 'urlstring', get_string('siteurl', 'hub'), $siteinfo['url']);
162         $mform->addHelpButton('urlstring', 'siteurl', 'hub');
164         // Display statistic that are going to be retrieve by the sites directory.
165         $mform->addElement('static', 'siteinfosummary', get_string('sendfollowinginfo', 'hub'), registration::get_stats_summary($siteinfo));
167         // Check if it's a first registration or update.
168         if (registration::is_registered()) {
169             $buttonlabel = get_string('updatesiteregistration', 'core_hub');
170             $mform->addElement('hidden', 'update', true);
171             $mform->setType('update', PARAM_BOOL);
172         } else {
173             $buttonlabel = get_string('register', 'core_admin');
174         }
176         $this->add_action_buttons(false, $buttonlabel);
178         $mform->addElement('hidden', 'returnurl');
179         $mform->setType('returnurl', PARAM_LOCALURL);
181         // Prepare and set data.
182         $siteinfo['emailalertnewemail'] = !empty($siteinfo['emailalert']) && !empty($siteinfo['emailalertemail']);
183         if (empty($siteinfo['emailalertnewemail'])) {
184             $siteinfo['emailalertemail'] = '';
185         }
186         $siteinfo['commnewsnewemail'] = !empty($siteinfo['commnews']) && !empty($siteinfo['commnewsemail']);
187         if (empty($siteinfo['commnewsnewemail'])) {
188             $siteinfo['commnewsemail'] = '';
189         }
191         // Set data. Always require to check policyagreed even if it was checked earlier.
192         $this->set_data(['policyagreed' => 0] + $siteinfo);
193     }
195     /**
196      * Add yes/no select with additional checkbox allowing to specify another email
197      *
198      * @param string $elementname
199      * @param string $stridentifier
200      * @param array|null $options options for the select element
201      * @param bool $highlight highlight as a new field
202      */
203     protected function add_select_with_email($elementname, $stridentifier, $options = null, $highlight = false) {
204         $mform = $this->_form;
206         if ($options === null) {
207             $options = [0 => get_string('no'), 1 => get_string('yes')];
208         }
210         $group = [
211             $mform->createElement('select', $elementname, get_string($stridentifier, 'hub'), $options),
212             $mform->createElement('static', $elementname . 'sep', '', '<br/>'),
213             $mform->createElement('advcheckbox', $elementname . 'newemail', '', get_string('usedifferentemail', 'hub'),
214                 ['onchange' => "this.form.elements['{$elementname}email'].focus();"]),
215             $mform->createElement('text', $elementname . 'email', get_string('email'))
216         ];
218         $element = $mform->addElement('group', $elementname . 'group', get_string($stridentifier, 'hub'), $group, '', false);
219         if ($highlight) {
220             $element->setAttributes(['class' => $element->getAttribute('class') . ' needsconfirmation mark']);
221         }
222         $mform->hideIf($elementname . 'email', $elementname, 'eq', 0);
223         $mform->hideIf($elementname . 'newemail', $elementname, 'eq', 0);
224         $mform->hideIf($elementname . 'email', $elementname . 'newemail', 'notchecked');
225         $mform->setType($elementname, PARAM_INT);
226         $mform->setType($elementname . 'email', PARAM_RAW_TRIMMED); // E-mail will be validated in validation().
227         $mform->addHelpButton($elementname . 'group', $stridentifier, 'hub');
229     }
231     /**
232      * Validation of the form data
233      *
234      * @param array $data array of ("fieldname"=>value) of submitted data
235      * @param array $files array of uploaded files "element_name"=>tmp_file_path
236      * @return array of "element_name"=>"error_description" if there are errors,
237      *         or an empty array if everything is OK
238      */
239     public function validation($data, $files) {
240         $errors = parent::validation($data, $files);
241         // Validate optional emails. We do not use PARAM_EMAIL because it blindly clears the field if it is not a valid email.
242         if (!empty($data['emailalert']) && !empty($data['emailalertnewemail']) && !validate_email($data['emailalertemail'])) {
243             $errors['emailalertgroup'] = get_string('invalidemail');
244         }
245         if (!empty($data['commnews']) && !empty($data['commnewsnewemail']) && !validate_email($data['commnewsemail'])) {
246             $errors['commnewsgroup'] = get_string('invalidemail');
247         }
248         return $errors;
249     }
251     /**
252      * Returns the form data
253      *
254      * @return stdClass
255      */
256     public function get_data() {
257         if ($data = parent::get_data()) {
258             // Never return '*newemail' checkboxes, always return 'emailalertemail' and 'commnewsemail' even if not applicable.
259             if (empty($data->emailalert) || empty($data->emailalertnewemail)) {
260                 $data->emailalertemail = null;
261             }
262             unset($data->emailalertnewemail);
263             if (empty($data->commnews) || empty($data->commnewsnewemail)) {
264                 $data->commnewsemail = null;
265             }
266             unset($data->commnewsnewemail);
267             // Always return 'contactable'.
268             $data->contactable = empty($data->contactable) ? 0 : 1;
270             if (debugging('', DEBUG_DEVELOPER)) {
271                 // Display debugging message for developers who added fields to the form and forgot to add them to registration::FORM_FIELDS.
272                 $keys = array_diff(array_keys((array)$data),
273                     ['returnurl', 'mform_isexpanded_id_sitestats', 'submitbutton', 'update']);
274                 if ($extrafields = array_diff($keys, registration::FORM_FIELDS)) {
275                     debugging('Found extra fields in the form results: ' . join(', ', $extrafields), DEBUG_DEVELOPER);
276                 }
277                 if ($missingfields = array_diff(registration::FORM_FIELDS, $keys)) {
278                     debugging('Some fields are missing in the form results: ' . join(', ', $missingfields), DEBUG_DEVELOPER);
279                 }
280             }
281         }
282         return $data;
283     }