bf7b7b13bfb1223ccfa7a38463b867101dd37363
[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 (strlen($hub['name']) > 100) {
140                 $hubname = 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         $mform->addElement('text', 'password', get_string('password'));
160         $this->add_action_buttons(false, get_string('selecthub', 'hub'));
161     }
163     /**
164      * Check the unlisted URL is a URL
165      */
166     function validation($data, $files) {
167         global $CFG;
168         $errors = parent::validation($data, $files);
170         $unlistedurl = $this->_form->_submitValues['unlistedurl'];
172         if (!empty($unlistedurl)) {
173             $unlistedurltotest = clean_param($unlistedurl, PARAM_URL);
174             if (empty($unlistedurltotest)) {
175                 $errors['unlistedurl'] = get_string('badurlformat', 'hub');
176             }
177         }
179         return $errors;
180     }
184 /**
185  * The site registration form. Information will be sent to a given hub.
186  */
187 class site_registration_form extends moodleform {
189     public function definition() {
190         global $CFG, $DB;
192         $strrequired = get_string('required');
193         $mform = & $this->_form;
194         $huburl = $this->_customdata['huburl'];
195         $hubname = $this->_customdata['hubname'];
196         $password = $this->_customdata['password'];
197         $admin = get_admin();
198         $site = get_site();
200         //retrieve config for this hub and set default if they don't exist
201         $cleanhuburl = clean_param($huburl, PARAM_ALPHANUMEXT);
202         $sitename = get_config('hub', 'site_name_' . $cleanhuburl);
203         if ($sitename === false) {
204             $sitename = $site->fullname;
205         }
206         $sitedescription = get_config('hub', 'site_description_' . $cleanhuburl);
207         if ($sitedescription === false) {
208             $sitedescription = $site->summary;
209         }
210         $contactname = get_config('hub', 'site_contactname_' . $cleanhuburl);
211         if ($contactname === false) {
212             $contactname = fullname($admin, true);
213         }
214         $contactemail = get_config('hub', 'site_contactemail_' . $cleanhuburl);
215         if ($contactemail === false) {
216             $contactemail = $admin->email;
217         }
218         $contactphone = get_config('hub', 'site_contactphone_' . $cleanhuburl);
219         if ($contactphone === false) {
220             $contactphone = $admin->phone1;
221         }
222         $imageurl = get_config('hub', 'site_imageurl_' . $cleanhuburl);
223         $privacy = get_config('hub', 'site_privacy_' . $cleanhuburl);
224         $address = get_config('hub', 'site_address_' . $cleanhuburl);
225         $region = get_config('hub', 'site_region_' . $cleanhuburl);
226         $country = get_config('hub', 'site_country_' . $cleanhuburl);
227         if ($country === false) {
228             $country = $admin->country;
229         }
230         $geolocation = get_config('hub', 'site_geolocation_' . $cleanhuburl);
231         $contactable = get_config('hub', 'site_contactable_' . $cleanhuburl);
232         $emailalert = get_config('hub', 'site_emailalert_' . $cleanhuburl);
233         $coursesnumber = get_config('hub', 'site_coursesnumber_' . $cleanhuburl);
234         $usersnumber = get_config('hub', 'site_usersnumber_' . $cleanhuburl);
235         $roleassignmentsnumber = get_config('hub', 'site_roleassignmentsnumber_' . $cleanhuburl);
236         $postsnumber = get_config('hub', 'site_postsnumber_' . $cleanhuburl);
237         $questionsnumber = get_config('hub', 'site_questionsnumber_' . $cleanhuburl);
238         $resourcesnumber = get_config('hub', 'site_resourcesnumber_' . $cleanhuburl);
239         $mediancoursesize = get_config('hub', 'site_mediancoursesize_' . $cleanhuburl);
241         //hidden parameters
242         $mform->addElement('hidden', 'huburl', $huburl);
243         $mform->setType('huburl', PARAM_URL);
244         $mform->addElement('hidden', 'hubname', $hubname);
245         $mform->setType('hubname', PARAM_TEXT);
246         $mform->addElement('hidden', 'password', $password);
247         $mform->setType('password', PARAM_RAW);
249         //the input parameters
250         $mform->addElement('header', 'moodle', get_string('registrationinfo', 'hub'));
252         $mform->addElement('text', 'name', get_string('sitename', 'hub'),
253                 array('class' => 'registration_textfield'));
254         $mform->addRule('name', $strrequired, 'required', null, 'client');
255         $mform->setType('name', PARAM_TEXT);
256         $mform->setDefault('name', $sitename);
257         $mform->addHelpButton('name', 'sitename', 'hub');
259         $options = array();
260         $registrationmanager = new registration_manager();
261         $options[HUB_SITENOTPUBLISHED] = $registrationmanager->get_site_privacy_string(HUB_SITENOTPUBLISHED);
262         $options[HUB_SITENAMEPUBLISHED] = $registrationmanager->get_site_privacy_string(HUB_SITENAMEPUBLISHED);
263         $options[HUB_SITELINKPUBLISHED] = $registrationmanager->get_site_privacy_string(HUB_SITELINKPUBLISHED);
264         $mform->addElement('select', 'privacy', get_string('siteprivacy', 'hub'), $options);
265         $mform->setDefault('privacy', $privacy);
266         $mform->addHelpButton('privacy', 'privacy', 'hub');
267         unset($options);
269         $mform->addElement('textarea', 'description', get_string('sitedesc', 'hub'),
270                 array('rows' => 8, 'cols' => 41));
271         $mform->addRule('description', $strrequired, 'required', null, 'client');
272         $mform->setDefault('description', $sitedescription);
273         $mform->setType('description', PARAM_TEXT);
274         $mform->addHelpButton('description', 'sitedesc', 'hub');
276         $mform->addElement('static', 'urlstring', get_string('siteurl', 'hub'), $CFG->wwwroot);
277         $mform->addHelpButton('urlstring', 'siteurl', 'hub');
279         $languages = get_string_manager()->get_list_of_languages();
280         $mform->addElement('static', 'langstring', get_string('sitelang', 'hub'), $languages[current_language()]);
281         $mform->addElement('hidden', 'language', current_language());
282         $mform->setType('language', PARAM_ALPHANUMEXT);
283         $mform->addHelpButton('langstring', 'sitelang', 'hub');
285         $mform->addElement('static', 'versionstring', get_string('siteversion', 'hub'), $CFG->version);
286         $mform->addElement('hidden', 'moodleversion', $CFG->version);
287         $mform->setType('moodleversion', PARAM_INT);
288         $mform->addHelpButton('versionstring', 'siteversion', 'hub');
290         $mform->addElement('static', 'releasestring', get_string('siterelease', 'hub'), $CFG->release);
291         $mform->addElement('hidden', 'moodlerelease', $CFG->release);
292         $mform->setType('moodlerelease', PARAM_TEXT);
293         $mform->addHelpButton('releasestring', 'siterelease', 'hub');
295         $mform->addElement('textarea', 'address', get_string('postaladdress', 'hub'),
296                 array('rows' => 4, 'cols' => 41));
297         $mform->setType('address', PARAM_TEXT);
298         $mform->setDefault('address', $address);
299         $mform->addHelpButton('address', 'postaladdress', 'hub');
301         //TODO: use the region array I generated
302 //        $mform->addElement('select', 'region', get_string('selectaregion'), array('-' => '-'));
303 //        $mform->setDefault('region', $region);
304         $mform->addElement('hidden', 'regioncode', '-');
305         $mform->setType('regioncode', PARAM_ALPHANUMEXT);
307         $countries = get_string_manager()->get_list_of_countries();
308         $mform->addElement('select', 'countrycode', get_string('sitecountry', 'hub'), $countries);
309         $mform->setDefault('countrycode', $country);
310         $mform->addHelpButton('countrycode', 'sitecountry', 'hub');
312         $mform->addElement('text', 'geolocation', get_string('sitegeolocation', 'hub'),
313                 array('class' => 'registration_textfield'));
314         $mform->setDefault('geolocation', $geolocation);
315         $mform->addHelpButton('geolocation', 'sitegeolocation', 'hub');
317         $mform->addElement('text', 'contactname', get_string('siteadmin', 'hub'),
318                 array('class' => 'registration_textfield'));
319         $mform->addRule('contactname', $strrequired, 'required', null, 'client');
320         $mform->setType('contactname', PARAM_TEXT);
321         $mform->setDefault('contactname', $contactname);
322         $mform->addHelpButton('contactname', 'siteadmin', 'hub');
324         $mform->addElement('text', 'contactphone', get_string('sitephone', 'hub'),
325                 array('class' => 'registration_textfield'));
326         $mform->setType('contactphone', PARAM_TEXT);
327         $mform->addHelpButton('contactphone', 'sitephone', 'hub');
329         $mform->addElement('text', 'contactemail', get_string('siteemail', 'hub'),
330                 array('class' => 'registration_textfield'));
331         $mform->addRule('contactemail', $strrequired, 'required', null, 'client');
332         $mform->setType('contactemail', PARAM_TEXT);
333         $mform->setDefault('contactemail', $contactemail);
334         $mform->addHelpButton('contactemail', 'siteemail', 'hub');
336         $options = array();
337         $options[0] = get_string("registrationcontactno");
338         $options[1] = get_string("registrationcontactyes");
339         $mform->addElement('select', 'contactable', get_string('siteregistrationcontact', 'hub'), $options);
340         $mform->setDefault('contactable', $contactable);
341         $mform->addHelpButton('contactable', 'siteregistrationcontact', 'hub');
342         unset($options);
344         $options = array();
345         $options[0] = get_string("registrationno");
346         $options[1] = get_string("registrationyes");
347         $mform->addElement('select', 'emailalert', get_string('siteregistrationemail', 'hub'), $options);
348         $mform->setDefault('emailalert', $emailalert);
349         $mform->addHelpButton('emailalert', 'siteregistrationemail', 'hub');
350         unset($options);
352         //TODO site logo
353         $mform->addElement('hidden', 'imageurl', ''); //TODO: temporary
354         $mform->setType('imageurl', PARAM_URL);
355         /// Display statistic that are going to be retrieve by the hub
356         $coursecount = $DB->count_records('course') - 1;
357         $usercount = $DB->count_records('user', array('deleted' => 0));
358         $roleassigncount = $DB->count_records('role_assignments');
359         $postcount = $DB->count_records('forum_posts');
360         $questioncount = $DB->count_records('question');
361         $resourcecount = $DB->count_records('resource');
362         require_once($CFG->dirroot . "/course/lib.php");
363         $participantnumberaverage = average_number_of_participants();
364         $modulenumberaverage = average_number_of_courses_modules();
366         if (HUB_MOODLEORGHUBURL != $huburl) {
367             $mform->addElement('checkbox', 'courses', get_string('sendfollowinginfo', 'hub'),
368                     " " . get_string('coursesnumber', 'hub', $coursecount));
369             $mform->setDefault('courses', true);
370             $mform->addHelpButton('courses', 'sendfollowinginfo', 'hub');
372             $mform->addElement('checkbox', 'users', '',
373                     " " . get_string('usersnumber', 'hub', $usercount));
374             $mform->setDefault('users', true);
376             $mform->addElement('checkbox', 'roleassignments', '',
377                     " " . get_string('roleassignmentsnumber', 'hub', $roleassigncount));
378             $mform->setDefault('roleassignments', true);
380             $mform->addElement('checkbox', 'posts', '',
381                     " " . get_string('postsnumber', 'hub', $postcount));
382             $mform->setDefault('posts', true);
384             $mform->addElement('checkbox', 'questions', '',
385                     " " . get_string('questionsnumber', 'hub', $questioncount));
386             $mform->setDefault('questions', true);
388             $mform->addElement('checkbox', 'resources', '',
389                     " " . get_string('resourcesnumber', 'hub', $resourcecount));
390             $mform->setDefault('resources', true);
392             $mform->addElement('checkbox', 'participantnumberaverage', '',
393                     " " . get_string('participantnumberaverage', 'hub', $participantnumberaverage));
394             $mform->setDefault('participantnumberaverage', true);
396             $mform->addElement('checkbox', 'modulenumberaverage', '',
397                     " " . get_string('modulenumberaverage', 'hub', $modulenumberaverage));
398             $mform->setDefault('modulenumberaverage', true);
399         } else {
400             $mform->addElement('static', 'courseslabel', get_string('sendfollowinginfo', 'hub'),
401                     " " . get_string('coursesnumber', 'hub', $coursecount));
402             $mform->addElement('hidden', 'courses', true);
403             $mform->setType('courses', PARAM_FLOAT);
404             $mform->addHelpButton('courseslabel', 'sendfollowinginfo', 'hub');
406             $mform->addElement('static', 'userslabel', '',
407                     " " . get_string('usersnumber', 'hub', $usercount));
408             $mform->addElement('hidden', 'users', true);
409             $mform->setType('users', PARAM_FLOAT);
411             $mform->addElement('static', 'roleassignmentslabel', '',
412                     " " . get_string('roleassignmentsnumber', 'hub', $roleassigncount));
413             $mform->addElement('hidden', 'roleassignments', true);
414             $mform->setType('roleassignments', PARAM_FLOAT);
416             $mform->addElement('static', 'postslabel', '',
417                     " " . get_string('postsnumber', 'hub', $postcount));
418             $mform->addElement('hidden', 'posts', true);
419             $mform->setType('posts', PARAM_FLOAT);
421             $mform->addElement('static', 'questionslabel', '',
422                     " " . get_string('questionsnumber', 'hub', $questioncount));
423             $mform->addElement('hidden', 'questions', true);
424             $mform->setType('questions', PARAM_FLOAT);
426             $mform->addElement('static', 'resourceslabel', '',
427                     " " . get_string('resourcesnumber', 'hub', $resourcecount));
428             $mform->addElement('hidden', 'resources', true);
429             $mform->setType('resources', PARAM_FLOAT);
431             $mform->addElement('static', 'participantnumberaveragelabel', '',
432                     " " . get_string('participantnumberaverage', 'hub', $participantnumberaverage));
433             $mform->addElement('hidden', 'participantnumberaverage', true);
434             $mform->setType('participantnumberaverage', PARAM_FLOAT);
436             $mform->addElement('static', 'modulenumberaveragelabel', '',
437                     " " . get_string('modulenumberaverage', 'hub', $modulenumberaverage));
438             $mform->addElement('hidden', 'modulenumberaverage', true);
439             $mform->setType('modulenumberaverage', PARAM_FLOAT);
440         }
442         //check if it's a first registration or update
443         $hubregistered = $registrationmanager->get_registeredhub($huburl);
445         if (!empty($hubregistered)) {
446             $buttonlabel = get_string('updatesite', 'hub',
447                             !empty($hubname) ? $hubname : $huburl);
448             $mform->addElement('hidden', 'update', true);
449             $mform->setType('update', PARAM_BOOL);
450         } else {
451             $buttonlabel = get_string('registersite', 'hub',
452                             !empty($hubname) ? $hubname : $huburl);
453         }
455         $this->add_action_buttons(false, $buttonlabel);
456     }