Merge branch 'MD-31803' of git://github.com/mouneyrac/moodle
[moodle.git] / admin / registration / forms.php
1 <?php
3 ///////////////////////////////////////////////////////////////////////////
4 //                                                                       //
5 // This file is part of Moodle - http://moodle.org/                      //
6 // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
7 //                                                                       //
8 // Moodle is free software: you can redistribute it and/or modify        //
9 // it under the terms of the GNU General Public License as published by  //
10 // the Free Software Foundation, either version 3 of the License, or     //
11 // (at your option) any later version.                                   //
12 //                                                                       //
13 // Moodle is distributed in the hope that it will be useful,             //
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of        //
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
16 // GNU General Public License for more details.                          //
17 //                                                                       //
18 // You should have received a copy of the GNU General Public License     //
19 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.       //
20 //                                                                       //
21 ///////////////////////////////////////////////////////////////////////////
23 /*
24  * @package    moodle
25  * @subpackage registration
26  * @author     Jerome Mouneyrac <jerome@mouneyrac.com>
27  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
28  * @copyright  (C) 1999 onwards Martin Dougiamas  http://dougiamas.com
29  *
30  * The forms needed by registration pages.
31  */
34 require_once($CFG->libdir . '/formslib.php');
35 require_once($CFG->dirroot . '/' . $CFG->admin . '/registration/lib.php');
37 /**
38  * This form display a unregistration form.
39  */
40 class site_unregistration_form extends moodleform {
42     public function definition() {
43         $mform = & $this->_form;
44         $mform->addElement('header', 'site', get_string('unregister', 'hub'));
46         $huburl = $this->_customdata['huburl'];
47         $hubname = $this->_customdata['hubname'];
49         $unregisterlabel = get_string('unregister', 'hub');
50         $mform->addElement('checkbox', 'unpublishalladvertisedcourses', '',
51                 ' ' . get_string('unpublishalladvertisedcourses', 'hub'));
52         $mform->addElement('checkbox', 'unpublishalluploadedcourses', '',
53                 ' ' . get_string('unpublishalluploadedcourses', 'hub'));
55         $mform->addElement('hidden', 'confirm', 1);
56         $mform->setType('confirm', PARAM_INT);
57         $mform->addElement('hidden', 'unregistration', 1);
58         $mform->setType('unregistration', PARAM_INT);
59         $mform->addElement('hidden', 'huburl', $huburl);
60         $mform->setType('huburl', PARAM_URL);
61         $mform->addElement('hidden', 'hubname', $hubname);
62         $mform->setType('hubname', PARAM_TEXT);
64         $this->add_action_buttons(true, $unregisterlabel);
65     }
67 }
69 /**
70  * This form display a clean registration data form.
71  */
72 class site_clean_registration_data_form extends moodleform {
74     public function definition() {
75         $mform = & $this->_form;
76         $mform->addElement('header', 'site', get_string('unregister', 'hub'));
78         $huburl = $this->_customdata['huburl'];
79         $hubname = $this->_customdata['hubname'];
82         $unregisterlabel = get_string('forceunregister', 'hub');
83         $mform->addElement('static', '', get_string('warning', 'hub'), get_string('forceunregisterconfirmation', 'hub', $hubname));
86         $mform->addElement('hidden', 'confirm', 1);
87         $mform->setType('confirm', PARAM_INT);
88         $mform->addElement('hidden', 'unregistration', 1);
89         $mform->setType('unregistration', PARAM_INT);
90         $mform->addElement('hidden', 'cleanregdata', 1);
91         $mform->setType('cleanregdata', PARAM_INT);
92         $mform->addElement('hidden', 'huburl', $huburl);
93         $mform->setType('huburl', PARAM_URL);
94         $mform->addElement('hidden', 'hubname', $hubname);
95         $mform->setType('hubname', PARAM_TEXT);
97         $this->add_action_buttons(true, $unregisterlabel);
98     }
102 /**
103  * This form display a hub selector.
104  * The hub list is retrieved from Moodle.org hub directory.
105  * Also displayed, a text field to enter private hub url + its password
106  */
107 class hub_selector_form extends moodleform {
109     public function definition() {
110         global $CFG, $OUTPUT;
111         $mform = & $this->_form;
112         $mform->addElement('header', 'site', get_string('selecthub', 'hub'));
114         //retrieve the hub list on the hub directory by web service
115         $function = 'hubdirectory_get_hubs';
116         $params = array();
117         $serverurl = HUB_HUBDIRECTORYURL . "/local/hubdirectory/webservice/webservices.php";
118         require_once($CFG->dirroot . "/webservice/xmlrpc/lib.php");
119         $xmlrpcclient = new webservice_xmlrpc_client($serverurl, 'publichubdirectory');
120         try {
121             $hubs = $xmlrpcclient->call($function, $params);
122         } catch (Exception $e) {
123             $error = $OUTPUT->notification(get_string('errorhublisting', 'hub', $e->getMessage()));
124             $mform->addElement('static', 'errorhub', '', $error);
125             $hubs = array();
126         }
128         //remove moodle.org from the hub list
129         foreach ($hubs as $key => $hub) {
130             if ($hub['url'] == HUB_MOODLEORGHUBURL) {
131                 unset($hubs[$key]);
132             }
133         }
135         //Public hub list
136         $options = array();
137         foreach ($hubs as $hub) {
138             //to not display a name longer than 100 character (too big)
139             if (textlib::strlen($hub['name']) > 100) {
140                 $hubname = textlib::substr($hub['name'], 0, 100);
141                 $hubname = $hubname . "...";
142             } else {
143                 $hubname = $hub['name'];
144             }
145             $options[$hub['url']] = $hubname;
146             $mform->addElement('hidden', clean_param($hub['url'], PARAM_ALPHANUMEXT), $hubname);
147             $mform->setType(clean_param($hub['url'], PARAM_ALPHANUMEXT), PARAM_ALPHANUMEXT);
148         }
149         if (!empty($hubs)) {
150             $mform->addElement('select', 'publichub', get_string('publichub', 'hub'),
151                     $options, array("size" => 15));
152         }
154         $mform->addElement('static', 'or', '', get_string('orenterprivatehub', 'hub'));
156         //Private hub
157         $mform->addElement('text', 'unlistedurl', get_string('privatehuburl', 'hub'),
158                 array('class' => 'registration_textfield'));
159         $mform->addElement('text', 'password', get_string('password'),
160                 array('class' => 'registration_textfield'));
162         $this->add_action_buttons(false, get_string('selecthub', 'hub'));
163     }
165     /**
166      * Check the unlisted URL is a URL
167      */
168     function validation($data, $files) {
169         global $CFG;
170         $errors = parent::validation($data, $files);
172         $unlistedurl = $this->_form->_submitValues['unlistedurl'];
174         if (!empty($unlistedurl)) {
175             $unlistedurltotest = clean_param($unlistedurl, PARAM_URL);
176             if (empty($unlistedurltotest)) {
177                 $errors['unlistedurl'] = get_string('badurlformat', 'hub');
178             }
179         }
181         return $errors;
182     }
186 /**
187  * The site registration form. Information will be sent to a given hub.
188  */
189 class site_registration_form extends moodleform {
191     public function definition() {
192         global $CFG, $DB;
194         $strrequired = get_string('required');
195         $mform = & $this->_form;
196         $huburl = $this->_customdata['huburl'];
197         $hubname = $this->_customdata['hubname'];
198         $password = $this->_customdata['password'];
199         $admin = get_admin();
200         $site = get_site();
202         //retrieve config for this hub and set default if they don't exist
203         $cleanhuburl = clean_param($huburl, PARAM_ALPHANUMEXT);
204         $sitename = get_config('hub', 'site_name_' . $cleanhuburl);
205         if ($sitename === false) {
206             $sitename = format_string($site->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, SITEID)));
207         }
208         $sitedescription = get_config('hub', 'site_description_' . $cleanhuburl);
209         if ($sitedescription === false) {
210             $sitedescription = $site->summary;
211         }
212         $contactname = get_config('hub', 'site_contactname_' . $cleanhuburl);
213         if ($contactname === false) {
214             $contactname = fullname($admin, true);
215         }
216         $contactemail = get_config('hub', 'site_contactemail_' . $cleanhuburl);
217         if ($contactemail === false) {
218             $contactemail = $admin->email;
219         }
220         $contactphone = get_config('hub', 'site_contactphone_' . $cleanhuburl);
221         if ($contactphone === false) {
222             $contactphone = $admin->phone1;
223         }
224         $imageurl = get_config('hub', 'site_imageurl_' . $cleanhuburl);
225         $privacy = get_config('hub', 'site_privacy_' . $cleanhuburl);
226         $address = get_config('hub', 'site_address_' . $cleanhuburl);
227         $region = get_config('hub', 'site_region_' . $cleanhuburl);
228         $country = get_config('hub', 'site_country_' . $cleanhuburl);
229         if ($country === false) {
230             $country = $admin->country;
231         }
232         $language = get_config('hub', 'site_language_' . $cleanhuburl);
233         if ($language === false) {
234             $language = current_language();
235         }
236         $geolocation = get_config('hub', 'site_geolocation_' . $cleanhuburl);
237         $contactable = get_config('hub', 'site_contactable_' . $cleanhuburl);
238         $emailalert = get_config('hub', 'site_emailalert_' . $cleanhuburl);
239         $emailalert = ($emailalert === 0) ? 0 : 1;
240         $coursesnumber = get_config('hub', 'site_coursesnumber_' . $cleanhuburl);
241         $usersnumber = get_config('hub', 'site_usersnumber_' . $cleanhuburl);
242         $roleassignmentsnumber = get_config('hub', 'site_roleassignmentsnumber_' . $cleanhuburl);
243         $postsnumber = get_config('hub', 'site_postsnumber_' . $cleanhuburl);
244         $questionsnumber = get_config('hub', 'site_questionsnumber_' . $cleanhuburl);
245         $resourcesnumber = get_config('hub', 'site_resourcesnumber_' . $cleanhuburl);
246         $mediancoursesize = get_config('hub', 'site_mediancoursesize_' . $cleanhuburl);
248         //hidden parameters
249         $mform->addElement('hidden', 'huburl', $huburl);
250         $mform->setType('huburl', PARAM_URL);
251         $mform->addElement('hidden', 'hubname', $hubname);
252         $mform->setType('hubname', PARAM_TEXT);
253         $mform->addElement('hidden', 'password', $password);
254         $mform->setType('password', PARAM_RAW);
256         //the input parameters
257         $mform->addElement('header', 'moodle', get_string('registrationinfo', 'hub'));
259         $mform->addElement('text', 'name', get_string('sitename', 'hub'),
260                 array('class' => 'registration_textfield'));
261         $mform->addRule('name', $strrequired, 'required', null, 'client');
262         $mform->setType('name', PARAM_TEXT);
263         $mform->setDefault('name', $sitename);
264         $mform->addHelpButton('name', 'sitename', 'hub');
266         $options = array();
267         $registrationmanager = new registration_manager();
268         $options[HUB_SITENOTPUBLISHED] = $registrationmanager->get_site_privacy_string(HUB_SITENOTPUBLISHED);
269         $options[HUB_SITENAMEPUBLISHED] = $registrationmanager->get_site_privacy_string(HUB_SITENAMEPUBLISHED);
270         $options[HUB_SITELINKPUBLISHED] = $registrationmanager->get_site_privacy_string(HUB_SITELINKPUBLISHED);
271         $mform->addElement('select', 'privacy', get_string('siteprivacy', 'hub'), $options);
272         $mform->setDefault('privacy', $privacy);
273         $mform->addHelpButton('privacy', 'privacy', 'hub');
274         unset($options);
276         $mform->addElement('textarea', 'description', get_string('sitedesc', 'hub'),
277                 array('rows' => 8, 'cols' => 41));
278         $mform->addRule('description', $strrequired, 'required', null, 'client');
279         $mform->setDefault('description', $sitedescription);
280         $mform->setType('description', PARAM_TEXT);
281         $mform->addHelpButton('description', 'sitedesc', 'hub');
283         $languages = get_string_manager()->get_list_of_languages();
284         collatorlib::asort($languages);
285         $mform->addElement('select', 'language', get_string('sitelang', 'hub'),
286                 $languages);
287         $mform->setType('language', PARAM_ALPHANUMEXT);
288         $mform->addHelpButton('language', 'sitelang', 'hub');
289         $mform->setDefault('language', $language);
291         $mform->addElement('textarea', 'address', get_string('postaladdress', 'hub'),
292                 array('rows' => 4, 'cols' => 41));
293         $mform->setType('address', PARAM_TEXT);
294         $mform->setDefault('address', $address);
295         $mform->addHelpButton('address', 'postaladdress', 'hub');
297         //TODO: use the region array I generated
298 //        $mform->addElement('select', 'region', get_string('selectaregion'), array('-' => '-'));
299 //        $mform->setDefault('region', $region);
300         $mform->addElement('hidden', 'regioncode', '-');
301         $mform->setType('regioncode', PARAM_ALPHANUMEXT);
303         $countries = get_string_manager()->get_list_of_countries();
304         $mform->addElement('select', 'countrycode', get_string('sitecountry', 'hub'), $countries);
305         $mform->setDefault('countrycode', $country);
306         $mform->addHelpButton('countrycode', 'sitecountry', 'hub');
308         $mform->addElement('text', 'geolocation', get_string('sitegeolocation', 'hub'),
309                 array('class' => 'registration_textfield'));
310         $mform->setDefault('geolocation', $geolocation);
311         $mform->addHelpButton('geolocation', 'sitegeolocation', 'hub');
313         $mform->addElement('text', 'contactname', get_string('siteadmin', 'hub'),
314                 array('class' => 'registration_textfield'));
315         $mform->addRule('contactname', $strrequired, 'required', null, 'client');
316         $mform->setType('contactname', PARAM_TEXT);
317         $mform->setDefault('contactname', $contactname);
318         $mform->addHelpButton('contactname', 'siteadmin', 'hub');
320         $mform->addElement('text', 'contactphone', get_string('sitephone', 'hub'),
321                 array('class' => 'registration_textfield'));
322         $mform->setType('contactphone', PARAM_TEXT);
323         $mform->addHelpButton('contactphone', 'sitephone', 'hub');
325         $mform->addElement('text', 'contactemail', get_string('siteemail', 'hub'),
326                 array('class' => 'registration_textfield'));
327         $mform->addRule('contactemail', $strrequired, 'required', null, 'client');
328         $mform->setType('contactemail', PARAM_TEXT);
329         $mform->setDefault('contactemail', $contactemail);
330         $mform->addHelpButton('contactemail', 'siteemail', 'hub');
332         $options = array();
333         $options[0] = get_string("registrationcontactno");
334         $options[1] = get_string("registrationcontactyes");
335         $mform->addElement('select', 'contactable', get_string('siteregistrationcontact', 'hub'), $options);
336         $mform->setDefault('contactable', $contactable);
337         $mform->addHelpButton('contactable', 'siteregistrationcontact', 'hub');
338         unset($options);
340         $options = array();
341         $options[0] = get_string("registrationno");
342         $options[1] = get_string("registrationyes");
343         $mform->addElement('select', 'emailalert', get_string('siteregistrationemail', 'hub'), $options);
344         $mform->setDefault('emailalert', $emailalert);
345         $mform->addHelpButton('emailalert', 'siteregistrationemail', 'hub');
346         unset($options);
348         //TODO site logo
349         $mform->addElement('hidden', 'imageurl', ''); //TODO: temporary
350         $mform->setType('imageurl', PARAM_URL);
352         $mform->addElement('static', 'urlstring', get_string('siteurl', 'hub'), $CFG->wwwroot);
353         $mform->addHelpButton('urlstring', 'siteurl', 'hub');
355         $mform->addElement('static', 'versionstring', get_string('siteversion', 'hub'), $CFG->version);
356         $mform->addElement('hidden', 'moodleversion', $CFG->version);
357         $mform->setType('moodleversion', PARAM_INT);
358         $mform->addHelpButton('versionstring', 'siteversion', 'hub');
360         $mform->addElement('static', 'releasestring', get_string('siterelease', 'hub'), $CFG->release);
361         $mform->addElement('hidden', 'moodlerelease', $CFG->release);
362         $mform->setType('moodlerelease', PARAM_TEXT);
363         $mform->addHelpButton('releasestring', 'siterelease', 'hub');
365         /// Display statistic that are going to be retrieve by the hub
366         $coursecount = $DB->count_records('course') - 1;
367         $usercount = $DB->count_records('user', array('deleted' => 0));
368         $roleassigncount = $DB->count_records('role_assignments');
369         $postcount = $DB->count_records('forum_posts');
370         $questioncount = $DB->count_records('question');
371         $resourcecount = $DB->count_records('resource');
372         require_once($CFG->dirroot . "/course/lib.php");
373         $participantnumberaverage = number_format(average_number_of_participants(), 2);
374         $modulenumberaverage = number_format(average_number_of_courses_modules(), 2);
376         if (HUB_MOODLEORGHUBURL != $huburl) {
377             $mform->addElement('checkbox', 'courses', get_string('sendfollowinginfo', 'hub'),
378                     " " . get_string('coursesnumber', 'hub', $coursecount));
379             $mform->setDefault('courses', true);
380             $mform->addHelpButton('courses', 'sendfollowinginfo', 'hub');
382             $mform->addElement('checkbox', 'users', '',
383                     " " . get_string('usersnumber', 'hub', $usercount));
384             $mform->setDefault('users', true);
386             $mform->addElement('checkbox', 'roleassignments', '',
387                     " " . get_string('roleassignmentsnumber', 'hub', $roleassigncount));
388             $mform->setDefault('roleassignments', true);
390             $mform->addElement('checkbox', 'posts', '',
391                     " " . get_string('postsnumber', 'hub', $postcount));
392             $mform->setDefault('posts', true);
394             $mform->addElement('checkbox', 'questions', '',
395                     " " . get_string('questionsnumber', 'hub', $questioncount));
396             $mform->setDefault('questions', true);
398             $mform->addElement('checkbox', 'resources', '',
399                     " " . get_string('resourcesnumber', 'hub', $resourcecount));
400             $mform->setDefault('resources', true);
402             $mform->addElement('checkbox', 'participantnumberaverage', '',
403                     " " . get_string('participantnumberaverage', 'hub', $participantnumberaverage));
404             $mform->setDefault('participantnumberaverage', true);
406             $mform->addElement('checkbox', 'modulenumberaverage', '',
407                     " " . get_string('modulenumberaverage', 'hub', $modulenumberaverage));
408             $mform->setDefault('modulenumberaverage', true);
409         } else {
410             $mform->addElement('static', 'courseslabel', get_string('sendfollowinginfo', 'hub'),
411                     " " . get_string('coursesnumber', 'hub', $coursecount));
412             $mform->addElement('hidden', 'courses', true);
413             $mform->setType('courses', PARAM_FLOAT);
414             $mform->addHelpButton('courseslabel', 'sendfollowinginfo', 'hub');
416             $mform->addElement('static', 'userslabel', '',
417                     " " . get_string('usersnumber', 'hub', $usercount));
418             $mform->addElement('hidden', 'users', true);
419             $mform->setType('users', PARAM_FLOAT);
421             $mform->addElement('static', 'roleassignmentslabel', '',
422                     " " . get_string('roleassignmentsnumber', 'hub', $roleassigncount));
423             $mform->addElement('hidden', 'roleassignments', true);
424             $mform->setType('roleassignments', PARAM_FLOAT);
426             $mform->addElement('static', 'postslabel', '',
427                     " " . get_string('postsnumber', 'hub', $postcount));
428             $mform->addElement('hidden', 'posts', true);
429             $mform->setType('posts', PARAM_FLOAT);
431             $mform->addElement('static', 'questionslabel', '',
432                     " " . get_string('questionsnumber', 'hub', $questioncount));
433             $mform->addElement('hidden', 'questions', true);
434             $mform->setType('questions', PARAM_FLOAT);
436             $mform->addElement('static', 'resourceslabel', '',
437                     " " . get_string('resourcesnumber', 'hub', $resourcecount));
438             $mform->addElement('hidden', 'resources', true);
439             $mform->setType('resources', PARAM_FLOAT);
441             $mform->addElement('static', 'participantnumberaveragelabel', '',
442                     " " . get_string('participantnumberaverage', 'hub', $participantnumberaverage));
443             $mform->addElement('hidden', 'participantnumberaverage', true);
444             $mform->setType('participantnumberaverage', PARAM_FLOAT);
446             $mform->addElement('static', 'modulenumberaveragelabel', '',
447                     " " . get_string('modulenumberaverage', 'hub', $modulenumberaverage));
448             $mform->addElement('hidden', 'modulenumberaverage', true);
449             $mform->setType('modulenumberaverage', PARAM_FLOAT);
450         }
452         //check if it's a first registration or update
453         $hubregistered = $registrationmanager->get_registeredhub($huburl);
455         if (!empty($hubregistered)) {
456             $buttonlabel = get_string('updatesite', 'hub',
457                             !empty($hubname) ? $hubname : $huburl);
458             $mform->addElement('hidden', 'update', true);
459             $mform->setType('update', PARAM_BOOL);
460         } else {
461             $buttonlabel = get_string('registersite', 'hub',
462                             !empty($hubname) ? $hubname : $huburl);
463         }
465         $this->add_action_buttons(false, $buttonlabel);
466     }