MDL-65187 core_hub: send more important info first to moodle.net
[moodle.git] / lib / classes / hub / registration.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 registration
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 moodle_exception;
29 use moodle_url;
30 use context_system;
31 use stdClass;
32 use html_writer;
34 /**
35  * Methods to use when publishing and searching courses on moodle.net
36  *
37  * @package    core
38  * @copyright  2017 Marina Glancy
39  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  */
41 class registration {
43     /** @var array Fields used in a site registration form.
44      * IMPORTANT: any new fields with non-empty defaults have to be added to CONFIRM_NEW_FIELDS */
45     const FORM_FIELDS = ['policyagreed', 'language', 'countrycode', 'privacy',
46         'contactemail', 'contactable', 'emailalert', 'emailalertemail', 'commnews', 'commnewsemail',
47         'contactname', 'name', 'description', 'imageurl', 'contactphone', 'regioncode', 'geolocation', 'street'];
49     /** @var List of new FORM_FIELDS or siteinfo fields added indexed by the version when they were added.
50      * If site was already registered, admin will be promted to confirm new registration data manually. Until registration is manually confirmed,
51      * the scheduled task updating registration will be paused.
52      * Keys of this array are not important as long as they increment, use current date to avoid confusions.
53      */
54     const CONFIRM_NEW_FIELDS = [
55         2017092200 => [
56             'commnews', // Receive communication news. This was added in 3.4 and is "On" by default. Admin must confirm or opt-out.
57             'mobileservicesenabled', 'mobilenotificationsenabled', 'registereduserdevices', 'registeredactiveuserdevices' // Mobile stats added in 3.4.
58         ],
59         // Analytics stats added in Moodle 3.7.
60         2019022200 => ['analyticsenabledmodels', 'analyticspredictions', 'analyticsactions', 'analyticsactionsnotuseful'],
61     ];
63     /** @var Site privacy: not displayed */
64     const HUB_SITENOTPUBLISHED = 'notdisplayed';
66     /** @var Site privacy: public */
67     const HUB_SITENAMEPUBLISHED = 'named';
69     /** @var Site privacy: public and global */
70     const HUB_SITELINKPUBLISHED = 'linked';
72     /** @var stdClass cached site registration information */
73     protected static $registration = null;
75     /**
76      * Get site registration
77      *
78      * @param bool $confirmed
79      * @return stdClass|null
80      */
81     protected static function get_registration($confirmed = true) {
82         global $DB;
84         if (self::$registration === null) {
85             self::$registration = $DB->get_record('registration_hubs', ['huburl' => HUB_MOODLEORGHUBURL]) ?: null;
86         }
88         if (self::$registration && (bool)self::$registration->confirmed == (bool)$confirmed) {
89             return self::$registration;
90         }
92         return null;
93     }
95     /**
96      * Same as get_registration except it throws exception if site not registered
97      *
98      * @return stdClass
99      * @throws \moodle_exception
100      */
101     public static function require_registration() {
102         if ($registration = self::get_registration()) {
103             return $registration;
104         }
105         if (has_capability('moodle/site:config', context_system::instance())) {
106             throw new moodle_exception('registrationwarning', 'admin', new moodle_url('/admin/registration/index.php'));
107         } else {
108             throw new moodle_exception('registrationwarningcontactadmin', 'admin');
109         }
110     }
112     /**
113      * Checks if site is registered
114      *
115      * @return bool
116      */
117     public static function is_registered() {
118         return self::get_registration() ? true : false;
119     }
121     /**
122      * Returns registration token
123      *
124      * @param int $strictness if set to MUST_EXIST and site is not registered will throw an exception
125      * @return null
126      * @throws moodle_exception
127      */
128     public static function get_token($strictness = IGNORE_MISSING) {
129         if ($strictness == MUST_EXIST) {
130             $registration = self::require_registration();
131         } else if (!$registration = self::get_registration()) {
132             return null;
133         }
134         return $registration->token;
135     }
137     /**
138      * When was the registration last updated
139      *
140      * @return int|null timestamp or null if site is not registered
141      */
142     public static function get_last_updated() {
143         if ($registration = self::get_registration()) {
144             return $registration->timemodified;
145         }
146         return null;
147     }
149     /**
150      * Calculates and prepares site information to send to moodle.net as part of registration or update
151      *
152      * @param array $defaults default values for inputs in the registration form (if site was never registered before)
153      * @return array site info
154      */
155     public static function get_site_info($defaults = []) {
156         global $CFG, $DB;
157         require_once($CFG->libdir . '/badgeslib.php');
158         require_once($CFG->dirroot . "/course/lib.php");
160         $siteinfo = array();
161         $cleanhuburl = clean_param(HUB_MOODLEORGHUBURL, PARAM_ALPHANUMEXT);
162         foreach (self::FORM_FIELDS as $field) {
163             $siteinfo[$field] = get_config('hub', 'site_'.$field.'_' . $cleanhuburl);
164             if ($siteinfo[$field] === false) {
165                 $siteinfo[$field] = array_key_exists($field, $defaults) ? $defaults[$field] : null;
166             }
167         }
169         // Statistical data.
170         $siteinfo['courses'] = $DB->count_records('course') - 1;
171         $siteinfo['users'] = $DB->count_records('user', array('deleted' => 0));
172         $siteinfo['enrolments'] = $DB->count_records('role_assignments');
173         $siteinfo['posts'] = $DB->count_records('forum_posts');
174         $siteinfo['questions'] = $DB->count_records('question');
175         $siteinfo['resources'] = $DB->count_records('resource');
176         $siteinfo['badges'] = $DB->count_records_select('badge', 'status <> ' . BADGE_STATUS_ARCHIVED);
177         $siteinfo['issuedbadges'] = $DB->count_records('badge_issued');
178         $siteinfo['participantnumberaverage'] = average_number_of_participants();
179         $siteinfo['modulenumberaverage'] = average_number_of_courses_modules();
181         // Version and url.
182         $siteinfo['moodlerelease'] = $CFG->release;
183         $siteinfo['url'] = $CFG->wwwroot;
185         // Mobile related information.
186         $siteinfo['mobileservicesenabled'] = 0;
187         $siteinfo['mobilenotificationsenabled'] = 0;
188         $siteinfo['registereduserdevices'] = 0;
189         $siteinfo['registeredactiveuserdevices'] = 0;
190         if (!empty($CFG->enablewebservices) && !empty($CFG->enablemobilewebservice)) {
191             $siteinfo['mobileservicesenabled'] = 1;
192             $siteinfo['registereduserdevices'] = $DB->count_records('user_devices');
193             $airnotifierextpath = $CFG->dirroot . '/message/output/airnotifier/externallib.php';
194             if (file_exists($airnotifierextpath)) { // Maybe some one uninstalled the plugin.
195                 require_once($airnotifierextpath);
196                 $siteinfo['mobilenotificationsenabled'] = \message_airnotifier_external::is_system_configured();
197                 $siteinfo['registeredactiveuserdevices'] = $DB->count_records('message_airnotifier_devices', array('enable' => 1));
198             }
199         }
201         // Analytics related data follow.
202         $siteinfo['analyticsenabledmodels'] = \core_analytics\stats::enabled_models();
203         $siteinfo['analyticspredictions'] = \core_analytics\stats::predictions();
204         $siteinfo['analyticsactions'] = \core_analytics\stats::actions();
205         $siteinfo['analyticsactionsnotuseful'] = \core_analytics\stats::actions_not_useful();
207         // IMPORTANT: any new fields in siteinfo have to be added to the constant CONFIRM_NEW_FIELDS.
209         return $siteinfo;
210     }
212     /**
213      * Human-readable summary of data that will be sent to moodle.net
214      *
215      * @param array $siteinfo result of get_site_info()
216      * @return string
217      */
218     public static function get_stats_summary($siteinfo) {
219         $fieldsneedconfirm = self::get_new_registration_fields();
220         $summary = html_writer::tag('p', get_string('sendfollowinginfo_help', 'hub')) .
221             html_writer::start_tag('ul');
223         $mobileservicesenabled = $siteinfo['mobileservicesenabled'] ? get_string('yes') : get_string('no');
224         $mobilenotificationsenabled = $siteinfo['mobilenotificationsenabled'] ? get_string('yes') : get_string('no');
225         $moodlerelease = $siteinfo['moodlerelease'];
226         if (preg_match('/^(\d+\.\d.*?)[\. ]/', $moodlerelease, $matches)) {
227             $moodlerelease = $matches[1];
228         }
229         $senddata = [
230             'moodlerelease' => get_string('sitereleasenum', 'hub', $moodlerelease),
231             'courses' => get_string('coursesnumber', 'hub', $siteinfo['courses']),
232             'users' => get_string('usersnumber', 'hub', $siteinfo['users']),
233             'enrolments' => get_string('roleassignmentsnumber', 'hub', $siteinfo['enrolments']),
234             'posts' => get_string('postsnumber', 'hub', $siteinfo['posts']),
235             'questions' => get_string('questionsnumber', 'hub', $siteinfo['questions']),
236             'resources' => get_string('resourcesnumber', 'hub', $siteinfo['resources']),
237             'badges' => get_string('badgesnumber', 'hub', $siteinfo['badges']),
238             'issuedbadges' => get_string('issuedbadgesnumber', 'hub', $siteinfo['issuedbadges']),
239             'participantnumberaverage' => get_string('participantnumberaverage', 'hub',
240                 format_float($siteinfo['participantnumberaverage'], 2)),
241             'modulenumberaverage' => get_string('modulenumberaverage', 'hub',
242                 format_float($siteinfo['modulenumberaverage'], 2)),
243             'mobileservicesenabled' => get_string('mobileservicesenabled', 'hub', $mobileservicesenabled),
244             'mobilenotificationsenabled' => get_string('mobilenotificationsenabled', 'hub', $mobilenotificationsenabled),
245             'registereduserdevices' => get_string('registereduserdevices', 'hub', $siteinfo['registereduserdevices']),
246             'registeredactiveuserdevices' => get_string('registeredactiveuserdevices', 'hub', $siteinfo['registeredactiveuserdevices']),
247             'analyticsenabledmodels' => get_string('analyticsenabledmodels', 'hub', $siteinfo['analyticsenabledmodels']),
248             'analyticspredictions' => get_string('analyticspredictions', 'hub', $siteinfo['analyticspredictions']),
249             'analyticsactions' => get_string('analyticsactions', 'hub', $siteinfo['analyticsactions']),
250             'analyticsactionsnotuseful' => get_string('analyticsactionsnotuseful', 'hub', $siteinfo['analyticsactionsnotuseful']),
251         ];
253         foreach ($senddata as $key => $str) {
254             $class = in_array($key, $fieldsneedconfirm) ? ' needsconfirmation mark' : '';
255             $summary .= html_writer::tag('li', $str, ['class' => 'site' . $key . $class]);
256         }
257         $summary .= html_writer::end_tag('ul');
258         return $summary;
259     }
261     /**
262      * Save registration info locally so it can be retrieved when registration needs to be updated
263      *
264      * @param stdClass $formdata data from {@link site_registration_form}
265      */
266     public static function save_site_info($formdata) {
267         $cleanhuburl = clean_param(HUB_MOODLEORGHUBURL, PARAM_ALPHANUMEXT);
268         foreach (self::FORM_FIELDS as $field) {
269             set_config('site_' . $field . '_' . $cleanhuburl, $formdata->$field, 'hub');
270         }
271         // Even if the the connection with moodle.net fails, admin has manually submitted the form which means they don't need
272         // to be redirected to the site registration page any more.
273         set_config('site_regupdateversion_' . $cleanhuburl, max(array_keys(self::CONFIRM_NEW_FIELDS)), 'hub');
274     }
276     /**
277      * Updates site registration when "Update reigstration" button is clicked by admin
278      */
279     public static function update_manual() {
280         global $DB;
282         if (!$registration = self::get_registration()) {
283             return false;
284         }
286         $siteinfo = self::get_site_info();
287         try {
288             api::update_registration($siteinfo);
289         } catch (moodle_exception $e) {
290             if (!self::is_registered()) {
291                 // Token was rejected during registration update and site and locally stored token was reset,
292                 // proceed to site registration. This method will redirect away.
293                 self::register('');
294             }
295             \core\notification::add(get_string('errorregistrationupdate', 'hub', $e->getMessage()),
296                 \core\output\notification::NOTIFY_ERROR);
297             return false;
298         }
299         $DB->update_record('registration_hubs', ['id' => $registration->id, 'timemodified' => time()]);
300         \core\notification::add(get_string('siteregistrationupdated', 'hub'),
301             \core\output\notification::NOTIFY_SUCCESS);
302         self::$registration = null;
303         return true;
304     }
306     /**
307      * Updates site registration via cron
308      *
309      * @throws moodle_exception
310      */
311     public static function update_cron() {
312         global $DB;
314         if (!$registration = self::get_registration()) {
315             mtrace(get_string('registrationwarning', 'admin'));
316             return;
317         }
319         if (self::get_new_registration_fields()) {
320             mtrace(get_string('pleaserefreshregistrationnewdata', 'admin'));
321             return;
322         }
324         $siteinfo = self::get_site_info();
325         api::update_registration($siteinfo);
326         $DB->update_record('registration_hubs', ['id' => $registration->id, 'timemodified' => time()]);
327         mtrace(get_string('siteregistrationupdated', 'hub'));
328         self::$registration = null;
329     }
331     /**
332      * Confirms registration by moodle.net
333      *
334      * @param string $token
335      * @param string $newtoken
336      * @param string $hubname
337      * @throws moodle_exception
338      */
339     public static function confirm_registration($token, $newtoken, $hubname) {
340         global $DB;
342         $registration = self::get_registration(false);
343         if (!$registration || $registration->token !== $token) {
344             throw new moodle_exception('wrongtoken', 'hub', new moodle_url('/admin/registration/index.php'));
345         }
346         $record = ['id' => $registration->id];
347         $record['token'] = $newtoken;
348         $record['confirmed'] = 1;
349         $record['hubname'] = $hubname;
350         $record['timemodified'] = time();
351         $DB->update_record('registration_hubs', $record);
352         self::$registration = null;
353     }
355     /**
356      * Retrieve the options for site privacy form element to use in registration form
357      * @return array
358      */
359     public static function site_privacy_options() {
360         return [
361             self::HUB_SITENOTPUBLISHED => get_string('siteprivacynotpublished', 'hub'),
362             self::HUB_SITENAMEPUBLISHED => get_string('siteprivacypublished', 'hub'),
363             self::HUB_SITELINKPUBLISHED => get_string('siteprivacylinked', 'hub')
364         ];
365     }
367     /**
368      * Registers a site
369      *
370      * This method will make sure that unconfirmed registration record is created and then redirect to
371      * registration script on https://moodle.net
372      * Moodle.net will check that the site is accessible, register it and redirect back
373      * to /admin/registration/confirmregistration.php
374      *
375      * @param string $returnurl
376      * @throws \coding_exception
377      */
378     public static function register($returnurl) {
379         global $DB, $SESSION;
381         if (self::is_registered()) {
382             // Caller of this method must make sure that site is not registered.
383             throw new \coding_exception('Site already registered');
384         }
386         $hub = self::get_registration(false);
387         if (empty($hub)) {
388             // Create a new record in 'registration_hubs'.
389             $hub = new stdClass();
390             $hub->token = get_site_identifier();
391             $hub->secret = $hub->token;
392             $hub->huburl = HUB_MOODLEORGHUBURL;
393             $hub->hubname = 'Moodle.net';
394             $hub->confirmed = 0;
395             $hub->timemodified = time();
396             $hub->id = $DB->insert_record('registration_hubs', $hub);
397             self::$registration = null;
398         }
400         $params = ['token' => $hub->token] + self::get_site_info();
402         $SESSION->registrationredirect = $returnurl;
403         redirect(new moodle_url(HUB_MOODLEORGHUBURL . '/local/hub/siteregistration.php', $params));
404     }
406     /**
407      * Unregister site
408      *
409      * @param bool $unpublishalladvertisedcourses
410      * @param bool $unpublishalluploadedcourses
411      * @return bool
412      */
413     public static function unregister($unpublishalladvertisedcourses, $unpublishalluploadedcourses) {
414         global $DB;
416         if (!$hub = self::get_registration()) {
417             return true;
418         }
420         // Course unpublish went ok, unregister the site now.
421         try {
422             api::unregister_site();
423         } catch (moodle_exception $e) {
424             \core\notification::add(get_string('unregistrationerror', 'hub', $e->getMessage()),
425                 \core\output\notification::NOTIFY_ERROR);
426             return false;
427         }
429         $DB->delete_records('registration_hubs', array('id' => $hub->id));
430         self::$registration = null;
431         return true;
432     }
434     /**
435      * Resets the registration token without changing site identifier so site can be re-registered
436      *
437      * @return bool
438      */
439     public static function reset_token() {
440         global $DB;
441         if (!$hub = self::get_registration()) {
442             return true;
443         }
444         $DB->delete_records('registration_hubs', array('id' => $hub->id));
445         self::$registration = null;
446     }
448     /**
449      * Generate a new token for the site that is not registered
450      *
451      * @param string $token
452      * @throws moodle_exception
453      */
454     public static function reset_site_identifier($token) {
455         global $DB, $CFG;
457         $registration = self::get_registration(false);
458         if (!$registration || $registration->token != $token) {
459             throw new moodle_exception('wrongtoken', 'hub',
460                new moodle_url('/admin/registration/index.php'));
461         }
463         $DB->delete_records('registration_hubs', array('id' => $registration->id));
464         self::$registration = null;
466         $CFG->siteidentifier = null;
467         get_site_identifier();
468     }
470     /**
471      * Returns information about moodle.net
472      *
473      * Example of the return array:
474      * {
475      *     "courses": 384,
476      *     "description": "Moodle.net connects you with free content and courses shared by Moodle ...",
477      *     "downloadablecourses": 190,
478      *     "enrollablecourses": 194,
479      *     "hublogo": 1,
480      *     "language": "en",
481      *     "name": "Moodle.net",
482      *     "sites": 274175,
483      *     "url": "https://moodle.net",
484      *     "imgurl": moodle_url : "https://moodle.net/local/hub/webservice/download.php?filetype=hubscreenshot"
485      * }
486      *
487      * @return array|null
488      */
489     public static function get_moodlenet_info() {
490         try {
491             return api::get_hub_info();
492         } catch (moodle_exception $e) {
493             // Ignore error, we only need it for displaying information about moodle.net, if this request
494             // fails, it's not a big deal.
495             return null;
496         }
497     }
499     /**
500      * Does admin need to be redirected to the registration page after install?
501      *
502      * @param bool|null $markasviewed if set to true will mark the registration form as viewed and admin will not be redirected
503      *     to the registration form again (regardless of whether the site was registered or not).
504      * @return bool
505      */
506     public static function show_after_install($markasviewed = null) {
507         global $CFG;
508         if (self::is_registered()) {
509             $showregistration = false;
510             $markasviewed = true;
511         } else {
512             $showregistration = !empty($CFG->registrationpending);
513             if ($showregistration && !site_is_public()) {
514                 // If it's not a public site, don't redirect to registration, it won't work anyway.
515                 $showregistration = false;
516                 $markasviewed = true;
517             }
518         }
519         if ($markasviewed !== null) {
520             set_config('registrationpending', !$markasviewed);
521         }
522         return $showregistration;
523     }
525     /**
526      * Returns the list of the fields in the registration form that were added since registration or last manual update
527      *
528      * If this list is not empty the scheduled task will be paused and admin will be reminded to update registration manually.
529      *
530      * @return array
531      */
532     public static function get_new_registration_fields() {
533         $fieldsneedconfirm = [];
534         if (!self::is_registered()) {
535             // Nothing to update if site is not registered.
536             return $fieldsneedconfirm;
537         }
539         $cleanhuburl = clean_param(HUB_MOODLEORGHUBURL, PARAM_ALPHANUMEXT);
540         $lastupdated = (int)get_config('hub', 'site_regupdateversion_' . $cleanhuburl);
541         foreach (self::CONFIRM_NEW_FIELDS as $version => $fields) {
542             if ($version > $lastupdated) {
543                 $fieldsneedconfirm = array_merge($fieldsneedconfirm, $fields);
544             }
545         }
546         return $fieldsneedconfirm;
547     }
549     /**
550      * Redirect to the site registration form if it's a new install or registration needs updating
551      *
552      * @param string|moodle_url $url
553      */
554     public static function registration_reminder($url) {
555         if (defined('BEHAT_SITE_RUNNING') && BEHAT_SITE_RUNNING) {
556             // No redirection during behat runs.
557             return;
558         }
559         if (!has_capability('moodle/site:config', context_system::instance())) {
560             return;
561         }
562         if (self::show_after_install() || self::get_new_registration_fields()) {
563             $returnurl = new moodle_url($url);
564             redirect(new moodle_url('/admin/registration/index.php', ['returnurl' => $returnurl->out_as_local_url(false)]));
565         }
566     }