4b54cb6b7f3da5e8ea9a397deefd8093b60ff1ac
[moodle.git] / lib / badgeslib.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  * Contains classes, functions and constants used in badges.
19  *
20  * @package    core
21  * @subpackage badges
22  * @copyright  2012 onwards Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  * @author     Yuliya Bozhko <yuliya.bozhko@totaralms.com>
25  */
27 defined('MOODLE_INTERNAL') || die();
29 /* Include required award criteria library. */
30 require_once($CFG->dirroot . '/badges/criteria/award_criteria.php');
32 /*
33  * Number of records per page.
34 */
35 define('BADGE_PERPAGE', 50);
37 /*
38  * Badge award criteria aggregation method.
39  */
40 define('BADGE_CRITERIA_AGGREGATION_ALL', 1);
42 /*
43  * Badge award criteria aggregation method.
44  */
45 define('BADGE_CRITERIA_AGGREGATION_ANY', 2);
47 /*
48  * Inactive badge means that this badge cannot be earned and has not been awarded
49  * yet. Its award criteria can be changed.
50  */
51 define('BADGE_STATUS_INACTIVE', 0);
53 /*
54  * Active badge means that this badge can we earned, but it has not been awarded
55  * yet. Can be deactivated for the purpose of changing its criteria.
56  */
57 define('BADGE_STATUS_ACTIVE', 1);
59 /*
60  * Inactive badge can no longer be earned, but it has been awarded in the past and
61  * therefore its criteria cannot be changed.
62  */
63 define('BADGE_STATUS_INACTIVE_LOCKED', 2);
65 /*
66  * Active badge means that it can be earned and has already been awarded to users.
67  * Its criteria cannot be changed any more.
68  */
69 define('BADGE_STATUS_ACTIVE_LOCKED', 3);
71 /*
72  * Archived badge is considered deleted and can no longer be earned and is not
73  * displayed in the list of all badges.
74  */
75 define('BADGE_STATUS_ARCHIVED', 4);
77 /*
78  * Badge type for site badges.
79  */
80 define('BADGE_TYPE_SITE', 1);
82 /*
83  * Badge type for course badges.
84  */
85 define('BADGE_TYPE_COURSE', 2);
87 /*
88  * Badge messaging schedule options.
89  */
90 define('BADGE_MESSAGE_NEVER', 0);
91 define('BADGE_MESSAGE_ALWAYS', 1);
92 define('BADGE_MESSAGE_DAILY', 2);
93 define('BADGE_MESSAGE_WEEKLY', 3);
94 define('BADGE_MESSAGE_MONTHLY', 4);
96 /*
97  * URL of backpack. Custom ones can be added.
98  */
99 define('BADGRIO_BACKPACKAPIURL', 'https://api.badgr.io/v2');
100 define('BADGRIO_BACKPACKWEBURL', 'https://badgr.io');
102 /*
103  * @deprecated since 3.7. Use the urls in the badge_external_backpack table instead.
104  */
105 define('BADGE_BACKPACKURL', 'https://backpack.openbadges.org');
107 /*
108  * @deprecated since 3.9 (MDL-66357).
109  */
110 define('BADGE_BACKPACKAPIURL', 'https://backpack.openbadges.org');
111 define('BADGE_BACKPACKWEBURL', 'https://backpack.openbadges.org');
113 /*
114  * Open Badges specifications.
115  */
116 define('OPEN_BADGES_V1', 1);
117 define('OPEN_BADGES_V2', 2);
118 define('OPEN_BADGES_V2P1', 2.1);
120 /*
121  * Only use for Open Badges 2.0 specification
122  */
123 define('OPEN_BADGES_V2_CONTEXT', 'https://w3id.org/openbadges/v2');
124 define('OPEN_BADGES_V2_TYPE_ASSERTION', 'Assertion');
125 define('OPEN_BADGES_V2_TYPE_BADGE', 'BadgeClass');
126 define('OPEN_BADGES_V2_TYPE_ISSUER', 'Issuer');
127 define('OPEN_BADGES_V2_TYPE_ENDORSEMENT', 'Endorsement');
128 define('OPEN_BADGES_V2_TYPE_AUTHOR', 'Author');
130 // Global badge class has been moved to the component namespace.
131 class_alias('\core_badges\badge', 'badge');
133 /**
134  * Sends notifications to users about awarded badges.
135  *
136  * @param badge $badge Badge that was issued
137  * @param int $userid Recipient ID
138  * @param string $issued Unique hash of an issued badge
139  * @param string $filepathhash File path hash of an issued badge for attachments
140  */
141 function badges_notify_badge_award(badge $badge, $userid, $issued, $filepathhash) {
142     global $CFG, $DB;
144     $admin = get_admin();
145     $userfrom = new stdClass();
146     $userfrom->id = $admin->id;
147     $userfrom->email = !empty($CFG->badges_defaultissuercontact) ? $CFG->badges_defaultissuercontact : $admin->email;
148     foreach (get_all_user_name_fields() as $addname) {
149         $userfrom->$addname = !empty($CFG->badges_defaultissuername) ? '' : $admin->$addname;
150     }
151     $userfrom->firstname = !empty($CFG->badges_defaultissuername) ? $CFG->badges_defaultissuername : $admin->firstname;
152     $userfrom->maildisplay = true;
154     $issuedlink = html_writer::link(new moodle_url('/badges/badge.php', array('hash' => $issued)), $badge->name);
155     $userto = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST);
157     $params = new stdClass();
158     $params->badgename = $badge->name;
159     $params->username = fullname($userto);
160     $params->badgelink = $issuedlink;
161     $message = badge_message_from_template($badge->message, $params);
162     $plaintext = html_to_text($message);
164     // Notify recipient.
165     $eventdata = new \core\message\message();
166     $eventdata->courseid          = is_null($badge->courseid) ? SITEID : $badge->courseid; // Profile/site come with no courseid.
167     $eventdata->component         = 'moodle';
168     $eventdata->name              = 'badgerecipientnotice';
169     $eventdata->userfrom          = $userfrom;
170     $eventdata->userto            = $userto;
171     $eventdata->notification      = 1;
172     $eventdata->subject           = $badge->messagesubject;
173     $eventdata->fullmessage       = $plaintext;
174     $eventdata->fullmessageformat = FORMAT_HTML;
175     $eventdata->fullmessagehtml   = $message;
176     $eventdata->smallmessage      = '';
177     $eventdata->customdata        = [
178         'notificationiconurl' => moodle_url::make_pluginfile_url(
179             $badge->get_context()->id, 'badges', 'badgeimage', $badge->id, '/', 'f1')->out(),
180         'hash' => $issued,
181     ];
183     // Attach badge image if possible.
184     if (!empty($CFG->allowattachments) && $badge->attachment && is_string($filepathhash)) {
185         $fs = get_file_storage();
186         $file = $fs->get_file_by_hash($filepathhash);
187         $eventdata->attachment = $file;
188         $eventdata->attachname = str_replace(' ', '_', $badge->name) . ".png";
190         message_send($eventdata);
191     } else {
192         message_send($eventdata);
193     }
195     // Notify badge creator about the award if they receive notifications every time.
196     if ($badge->notification == 1) {
197         $userfrom = core_user::get_noreply_user();
198         $userfrom->maildisplay = true;
200         $creator = $DB->get_record('user', array('id' => $badge->usercreated), '*', MUST_EXIST);
201         $a = new stdClass();
202         $a->user = fullname($userto);
203         $a->link = $issuedlink;
204         $creatormessage = get_string('creatorbody', 'badges', $a);
205         $creatorsubject = get_string('creatorsubject', 'badges', $badge->name);
207         $eventdata = new \core\message\message();
208         $eventdata->courseid          = $badge->courseid;
209         $eventdata->component         = 'moodle';
210         $eventdata->name              = 'badgecreatornotice';
211         $eventdata->userfrom          = $userfrom;
212         $eventdata->userto            = $creator;
213         $eventdata->notification      = 1;
214         $eventdata->subject           = $creatorsubject;
215         $eventdata->fullmessage       = html_to_text($creatormessage);
216         $eventdata->fullmessageformat = FORMAT_HTML;
217         $eventdata->fullmessagehtml   = $creatormessage;
218         $eventdata->smallmessage      = '';
219         $eventdata->customdata        = [
220             'notificationiconurl' => moodle_url::make_pluginfile_url(
221                 $badge->get_context()->id, 'badges', 'badgeimage', $badge->id, '/', 'f1')->out(),
222             'hash' => $issued,
223         ];
225         message_send($eventdata);
226         $DB->set_field('badge_issued', 'issuernotified', time(), array('badgeid' => $badge->id, 'userid' => $userid));
227     }
230 /**
231  * Caclulates date for the next message digest to badge creators.
232  *
233  * @param in $schedule Type of message schedule BADGE_MESSAGE_DAILY|BADGE_MESSAGE_WEEKLY|BADGE_MESSAGE_MONTHLY.
234  * @return int Timestamp for next cron
235  */
236 function badges_calculate_message_schedule($schedule) {
237     $nextcron = 0;
239     switch ($schedule) {
240         case BADGE_MESSAGE_DAILY:
241             $tomorrow = new DateTime("1 day", core_date::get_server_timezone_object());
242             $nextcron = $tomorrow->getTimestamp();
243             break;
244         case BADGE_MESSAGE_WEEKLY:
245             $nextweek = new DateTime("1 week", core_date::get_server_timezone_object());
246             $nextcron = $nextweek->getTimestamp();
247             break;
248         case BADGE_MESSAGE_MONTHLY:
249             $nextmonth = new DateTime("1 month", core_date::get_server_timezone_object());
250             $nextcron = $nextmonth->getTimestamp();
251             break;
252     }
254     return $nextcron;
257 /**
258  * Replaces variables in a message template and returns text ready to be emailed to a user.
259  *
260  * @param string $message Message body.
261  * @return string Message with replaced values
262  */
263 function badge_message_from_template($message, $params) {
264     $msg = $message;
265     foreach ($params as $key => $value) {
266         $msg = str_replace("%$key%", $value, $msg);
267     }
269     return $msg;
272 /**
273  * Get all badges.
274  *
275  * @param int Type of badges to return
276  * @param int Course ID for course badges
277  * @param string $sort An SQL field to sort by
278  * @param string $dir The sort direction ASC|DESC
279  * @param int $page The page or records to return
280  * @param int $perpage The number of records to return per page
281  * @param int $user User specific search
282  * @return array $badge Array of records matching criteria
283  */
284 function badges_get_badges($type, $courseid = 0, $sort = '', $dir = '', $page = 0, $perpage = BADGE_PERPAGE, $user = 0) {
285     global $DB;
286     $records = array();
287     $params = array();
288     $where = "b.status != :deleted AND b.type = :type ";
289     $params['deleted'] = BADGE_STATUS_ARCHIVED;
291     $userfields = array('b.id, b.name, b.status');
292     $usersql = "";
293     if ($user != 0) {
294         $userfields[] = 'bi.dateissued';
295         $userfields[] = 'bi.uniquehash';
296         $usersql = " LEFT JOIN {badge_issued} bi ON b.id = bi.badgeid AND bi.userid = :userid ";
297         $params['userid'] = $user;
298         $where .= " AND (b.status = 1 OR b.status = 3) ";
299     }
300     $fields = implode(', ', $userfields);
302     if ($courseid != 0 ) {
303         $where .= "AND b.courseid = :courseid ";
304         $params['courseid'] = $courseid;
305     }
307     $sorting = (($sort != '' && $dir != '') ? 'ORDER BY ' . $sort . ' ' . $dir : '');
308     $params['type'] = $type;
310     $sql = "SELECT $fields FROM {badge} b $usersql WHERE $where $sorting";
311     $records = $DB->get_records_sql($sql, $params, $page * $perpage, $perpage);
313     $badges = array();
314     foreach ($records as $r) {
315         $badge = new badge($r->id);
316         $badges[$r->id] = $badge;
317         if ($user != 0) {
318             $badges[$r->id]->dateissued = $r->dateissued;
319             $badges[$r->id]->uniquehash = $r->uniquehash;
320         } else {
321             $badges[$r->id]->awards = $DB->count_records_sql('SELECT COUNT(b.userid)
322                                         FROM {badge_issued} b INNER JOIN {user} u ON b.userid = u.id
323                                         WHERE b.badgeid = :badgeid AND u.deleted = 0', array('badgeid' => $badge->id));
324             $badges[$r->id]->statstring = $badge->get_status_name();
325         }
326     }
327     return $badges;
330 /**
331  * Get badges for a specific user.
332  *
333  * @param int $userid User ID
334  * @param int $courseid Badges earned by a user in a specific course
335  * @param int $page The page or records to return
336  * @param int $perpage The number of records to return per page
337  * @param string $search A simple string to search for
338  * @param bool $onlypublic Return only public badges
339  * @return array of badges ordered by decreasing date of issue
340  */
341 function badges_get_user_badges($userid, $courseid = 0, $page = 0, $perpage = 0, $search = '', $onlypublic = false) {
342     global $CFG, $DB;
344     $params = array(
345         'userid' => $userid
346     );
347     $sql = 'SELECT
348                 bi.uniquehash,
349                 bi.dateissued,
350                 bi.dateexpire,
351                 bi.id as issuedid,
352                 bi.visible,
353                 u.email,
354                 b.*
355             FROM
356                 {badge} b,
357                 {badge_issued} bi,
358                 {user} u
359             WHERE b.id = bi.badgeid
360                 AND u.id = bi.userid
361                 AND bi.userid = :userid';
363     if (!empty($search)) {
364         $sql .= ' AND (' . $DB->sql_like('b.name', ':search', false) . ') ';
365         $params['search'] = '%'.$DB->sql_like_escape($search).'%';
366     }
367     if ($onlypublic) {
368         $sql .= ' AND (bi.visible = 1) ';
369     }
371     if (empty($CFG->badges_allowcoursebadges)) {
372         $sql .= ' AND b.courseid IS NULL';
373     } else if ($courseid != 0) {
374         $sql .= ' AND (b.courseid = :courseid) ';
375         $params['courseid'] = $courseid;
376     }
377     $sql .= ' ORDER BY bi.dateissued DESC';
378     $badges = $DB->get_records_sql($sql, $params, $page * $perpage, $perpage);
380     return $badges;
383 /**
384  * Extends the course administration navigation with the Badges page
385  *
386  * @param navigation_node $coursenode
387  * @param object $course
388  */
389 function badges_add_course_navigation(navigation_node $coursenode, stdClass $course) {
390     global $CFG, $SITE;
392     $coursecontext = context_course::instance($course->id);
393     $isfrontpage = (!$coursecontext || $course->id == $SITE->id);
394     $canmanage = has_any_capability(array('moodle/badges:viewawarded',
395                                           'moodle/badges:createbadge',
396                                           'moodle/badges:awardbadge',
397                                           'moodle/badges:configurecriteria',
398                                           'moodle/badges:configuremessages',
399                                           'moodle/badges:configuredetails',
400                                           'moodle/badges:deletebadge'), $coursecontext);
402     if (!empty($CFG->enablebadges) && !empty($CFG->badges_allowcoursebadges) && !$isfrontpage && $canmanage) {
403         $coursenode->add(get_string('coursebadges', 'badges'), null,
404                 navigation_node::TYPE_CONTAINER, null, 'coursebadges',
405                 new pix_icon('i/badge', get_string('coursebadges', 'badges')));
407         $url = new moodle_url('/badges/index.php', array('type' => BADGE_TYPE_COURSE, 'id' => $course->id));
409         $coursenode->get('coursebadges')->add(get_string('managebadges', 'badges'), $url,
410             navigation_node::TYPE_SETTING, null, 'coursebadges');
412         if (has_capability('moodle/badges:createbadge', $coursecontext)) {
413             $url = new moodle_url('/badges/newbadge.php', array('type' => BADGE_TYPE_COURSE, 'id' => $course->id));
415             $coursenode->get('coursebadges')->add(get_string('newbadge', 'badges'), $url,
416                     navigation_node::TYPE_SETTING, null, 'newbadge');
417         }
418     }
421 /**
422  * Triggered when badge is manually awarded.
423  *
424  * @param   object      $data
425  * @return  boolean
426  */
427 function badges_award_handle_manual_criteria_review(stdClass $data) {
428     $criteria = $data->crit;
429     $userid = $data->userid;
430     $badge = new badge($criteria->badgeid);
432     if (!$badge->is_active() || $badge->is_issued($userid)) {
433         return true;
434     }
436     if ($criteria->review($userid)) {
437         $criteria->mark_complete($userid);
439         if ($badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->review($userid)) {
440             $badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($userid);
441             $badge->issue($userid);
442         }
443     }
445     return true;
448 /**
449  * Process badge image from form data
450  *
451  * @param badge $badge Badge object
452  * @param string $iconfile Original file
453  */
454 function badges_process_badge_image(badge $badge, $iconfile) {
455     global $CFG, $USER;
456     require_once($CFG->libdir. '/gdlib.php');
458     if (!empty($CFG->gdversion)) {
459         process_new_icon($badge->get_context(), 'badges', 'badgeimage', $badge->id, $iconfile, true);
460         @unlink($iconfile);
462         // Clean up file draft area after badge image has been saved.
463         $context = context_user::instance($USER->id, MUST_EXIST);
464         $fs = get_file_storage();
465         $fs->delete_area_files($context->id, 'user', 'draft');
466     }
469 /**
470  * Print badge image.
471  *
472  * @param badge $badge Badge object
473  * @param stdClass $context
474  * @param string $size
475  */
476 function print_badge_image(badge $badge, stdClass $context, $size = 'small') {
477     $fsize = ($size == 'small') ? 'f2' : 'f1';
479     $imageurl = moodle_url::make_pluginfile_url($context->id, 'badges', 'badgeimage', $badge->id, '/', $fsize, false);
480     // Appending a random parameter to image link to forse browser reload the image.
481     $imageurl->param('refresh', rand(1, 10000));
482     $attributes = array('src' => $imageurl, 'alt' => s($badge->name), 'class' => 'activatebadge');
484     return html_writer::empty_tag('img', $attributes);
487 /**
488  * Bake issued badge.
489  *
490  * @param string $hash Unique hash of an issued badge.
491  * @param int $badgeid ID of the original badge.
492  * @param int $userid ID of badge recipient (optional).
493  * @param boolean $pathhash Return file pathhash instead of image url (optional).
494  * @return string|url Returns either new file path hash or new file URL
495  */
496 function badges_bake($hash, $badgeid, $userid = 0, $pathhash = false) {
497     global $CFG, $USER;
498     require_once(__DIR__ . '/../badges/lib/bakerlib.php');
500     $badge = new badge($badgeid);
501     $badge_context = $badge->get_context();
502     $userid = ($userid) ? $userid : $USER->id;
503     $user_context = context_user::instance($userid);
505     $fs = get_file_storage();
506     if (!$fs->file_exists($user_context->id, 'badges', 'userbadge', $badge->id, '/', $hash . '.png')) {
507         if ($file = $fs->get_file($badge_context->id, 'badges', 'badgeimage', $badge->id, '/', 'f3.png')) {
508             $contents = $file->get_content();
510             $filehandler = new PNG_MetaDataHandler($contents);
511             // For now, the site backpack OB version will be used as default.
512             $obversion = badges_open_badges_backpack_api();
513             $assertion = new core_badges_assertion($hash, $obversion);
514             $assertionjson = json_encode($assertion->get_badge_assertion());
515             if ($filehandler->check_chunks("iTXt", "openbadges")) {
516                 // Add assertion URL iTXt chunk.
517                 $newcontents = $filehandler->add_chunks("iTXt", "openbadges", $assertionjson);
518                 $fileinfo = array(
519                         'contextid' => $user_context->id,
520                         'component' => 'badges',
521                         'filearea' => 'userbadge',
522                         'itemid' => $badge->id,
523                         'filepath' => '/',
524                         'filename' => $hash . '.png',
525                 );
527                 // Create a file with added contents.
528                 $newfile = $fs->create_file_from_string($fileinfo, $newcontents);
529                 if ($pathhash) {
530                     return $newfile->get_pathnamehash();
531                 }
532             }
533         } else {
534             debugging('Error baking badge image!', DEBUG_DEVELOPER);
535             return;
536         }
537     }
539     // If file exists and we just need its path hash, return it.
540     if ($pathhash) {
541         $file = $fs->get_file($user_context->id, 'badges', 'userbadge', $badge->id, '/', $hash . '.png');
542         return $file->get_pathnamehash();
543     }
545     $fileurl = moodle_url::make_pluginfile_url($user_context->id, 'badges', 'userbadge', $badge->id, '/', $hash, true);
546     return $fileurl;
549 /**
550  * Returns external backpack settings and badges from this backpack.
551  *
552  * This function first checks if badges for the user are cached and
553  * tries to retrieve them from the cache. Otherwise, badges are obtained
554  * through curl request to the backpack.
555  *
556  * @param int $userid Backpack user ID.
557  * @param boolean $refresh Refresh badges collection in cache.
558  * @return null|object Returns null is there is no backpack or object with backpack settings.
559  */
560 function get_backpack_settings($userid, $refresh = false) {
561     global $DB;
563     // Try to get badges from cache first.
564     $badgescache = cache::make('core', 'externalbadges');
565     $out = $badgescache->get($userid);
566     if ($out !== false && !$refresh) {
567         return $out;
568     }
569     // Get badges through curl request to the backpack.
570     $record = $DB->get_record('badge_backpack', array('userid' => $userid));
571     if ($record) {
572         $sitebackpack = badges_get_site_backpack($record->externalbackpackid);
573         $backpack = new \core_badges\backpack_api($sitebackpack, $record);
574         $out = new stdClass();
575         $out->backpackid = $sitebackpack->id;
577         if ($collections = $DB->get_records('badge_external', array('backpackid' => $record->id))) {
578             $out->totalcollections = count($collections);
579             $out->totalbadges = 0;
580             $out->badges = array();
581             foreach ($collections as $collection) {
582                 $badges = $backpack->get_badges($collection, true);
583                 if (!empty($badges)) {
584                     $out->badges = array_merge($out->badges, $badges);
585                     $out->totalbadges += count($badges);
586                 } else {
587                     $out->badges = array_merge($out->badges, array());
588                 }
589             }
590         } else {
591             $out->totalbadges = 0;
592             $out->totalcollections = 0;
593         }
595         $badgescache->set($userid, $out);
596         return $out;
597     }
599     return null;
602 /**
603  * Download all user badges in zip archive.
604  *
605  * @param int $userid ID of badge owner.
606  */
607 function badges_download($userid) {
608     global $CFG, $DB;
609     $context = context_user::instance($userid);
610     $records = $DB->get_records('badge_issued', array('userid' => $userid));
612     // Get list of files to download.
613     $fs = get_file_storage();
614     $filelist = array();
615     foreach ($records as $issued) {
616         $badge = new badge($issued->badgeid);
617         // Need to make image name user-readable and unique using filename safe characters.
618         $name =  $badge->name . ' ' . userdate($issued->dateissued, '%d %b %Y') . ' ' . hash('crc32', $badge->id);
619         $name = str_replace(' ', '_', $name);
620         $name = clean_param($name, PARAM_FILE);
621         if ($file = $fs->get_file($context->id, 'badges', 'userbadge', $issued->badgeid, '/', $issued->uniquehash . '.png')) {
622             $filelist[$name . '.png'] = $file;
623         }
624     }
626     // Zip files and sent them to a user.
627     $tempzip = tempnam($CFG->tempdir.'/', 'mybadges');
628     $zipper = new zip_packer();
629     if ($zipper->archive_to_pathname($filelist, $tempzip)) {
630         send_temp_file($tempzip, 'badges.zip');
631     } else {
632         debugging("Problems with archiving the files.", DEBUG_DEVELOPER);
633         die;
634     }
637 /**
638  * Checks if badges can be pushed to external backpack.
639  *
640  * @return string Code of backpack accessibility status.
641  */
642 function badges_check_backpack_accessibility() {
643     if (defined('BEHAT_SITE_RUNNING') && BEHAT_SITE_RUNNING) {
644         // For behat sites, do not poll the remote badge site.
645         // Behat sites should not be available, but we should pretend as though they are.
646         return 'available';
647     }
649     if (badges_open_badges_backpack_api() == OPEN_BADGES_V2) {
650         return 'available';
651     }
653     global $CFG;
654     include_once $CFG->libdir . '/filelib.php';
656     // Using fake assertion url to check whether backpack can access the web site.
657     $fakeassertion = new moodle_url('/badges/assertion.php', array('b' => 'abcd1234567890'));
659     // Curl request to backpack baker.
660     $curl = new curl();
661     $options = array(
662         'FRESH_CONNECT' => true,
663         'RETURNTRANSFER' => true,
664         'HEADER' => 0,
665         'CONNECTTIMEOUT' => 2,
666     );
667     // BADGE_BACKPACKURL and the "baker" API is deprecated and should never be used in future.
668     $location = BADGE_BACKPACKURL . '/baker';
669     $out = $curl->get($location, array('assertion' => $fakeassertion->out(false)), $options);
671     $data = json_decode($out);
672     if (!empty($curl->error)) {
673         return 'curl-request-timeout';
674     } else {
675         if (isset($data->code) && $data->code == 'http-unreachable') {
676             return 'http-unreachable';
677         } else {
678             return 'available';
679         }
680     }
682     return false;
685 /**
686  * Checks if user has external backpack connected.
687  *
688  * @param int $userid ID of a user.
689  * @return bool True|False whether backpack connection exists.
690  */
691 function badges_user_has_backpack($userid) {
692     global $DB;
693     return $DB->record_exists('badge_backpack', array('userid' => $userid));
696 /**
697  * Handles what happens to the course badges when a course is deleted.
698  *
699  * @param int $courseid course ID.
700  * @return void.
701  */
702 function badges_handle_course_deletion($courseid) {
703     global $CFG, $DB;
704     include_once $CFG->libdir . '/filelib.php';
706     $systemcontext = context_system::instance();
707     $coursecontext = context_course::instance($courseid);
708     $fs = get_file_storage();
710     // Move badges images to the system context.
711     $fs->move_area_files_to_new_context($coursecontext->id, $systemcontext->id, 'badges', 'badgeimage');
713     // Get all course badges.
714     $badges = $DB->get_records('badge', array('type' => BADGE_TYPE_COURSE, 'courseid' => $courseid));
715     foreach ($badges as $badge) {
716         // Archive badges in this course.
717         $toupdate = new stdClass();
718         $toupdate->id = $badge->id;
719         $toupdate->type = BADGE_TYPE_SITE;
720         $toupdate->courseid = null;
721         $toupdate->status = BADGE_STATUS_ARCHIVED;
722         $DB->update_record('badge', $toupdate);
723     }
726 /**
727  * Loads JS files required for backpack support.
728  *
729  * @uses   $CFG, $PAGE
730  * @return void
731  */
732 function badges_setup_backpack_js() {
733     global $CFG, $PAGE;
734     if (!empty($CFG->badges_allowexternalbackpack)) {
735         if (badges_open_badges_backpack_api() == OPEN_BADGES_V1) {
736             $PAGE->requires->string_for_js('error:backpackproblem', 'badges');
737             // The issuer.js API is deprecated and should not be used in future.
738             $PAGE->requires->js(new moodle_url(BADGE_BACKPACKURL . '/issuer.js'), true);
739             // The backpack.js file is deprecated and should not be used in future.
740             $PAGE->requires->js('/badges/backpack.js', true);
741         }
742     }
745 /**
746  * No js files are required for backpack support.
747  * This only exists to directly support the custom V1 backpack api.
748  *
749  * @param boolean $checksite Call check site function.
750  * @return void
751  */
752 function badges_local_backpack_js($checksite = false) {
753     global $CFG, $PAGE;
754     if (!empty($CFG->badges_allowexternalbackpack)) {
755         if (badges_open_badges_backpack_api() == OPEN_BADGES_V1) {
756             $PAGE->requires->js('/badges/backpack.js', true);
757             if ($checksite) {
758                 $PAGE->requires->js_init_call('check_site_access', null, false);
759             }
760         }
761     }
764 /**
765  * Create the site backpack with this data.
766  *
767  * @param stdClass $data The new backpack data.
768  * @return boolean
769  */
770 function badges_create_site_backpack($data) {
771     global $DB;
772     $context = context_system::instance();
773     require_capability('moodle/badges:manageglobalsettings', $context);
775     $count = $DB->count_records('badge_external_backpack');
776     $data->sortorder = $count;
777     return badges_save_external_backpack($data);
780 /**
781  * Update the backpack with this id.
782  *
783  * @param integer $id The backpack to edit
784  * @param stdClass $data The new backpack data.
785  * @return boolean
786  */
787 function badges_update_site_backpack($id, $data) {
788     global $DB;
789     $context = context_system::instance();
790     require_capability('moodle/badges:manageglobalsettings', $context);
792     if ($backpack = badges_get_site_backpack($id)) {
793         $data->id = $id;
794         return badges_save_external_backpack($data);
795     }
796     return false;
800 /**
801  * Delete the backpack with this id.
802  *
803  * @param integer $id The backpack to delete.
804  * @return boolean
805  */
806 function badges_delete_site_backpack($id) {
807     global $DB, $CFG;
809     $context = context_system::instance();
810     require_capability('moodle/badges:manageglobalsettings', $context);
812     // Only remove site backpack if it's not the default one.
813     if ($CFG->badges_site_backpack != $id && $DB->record_exists('badge_external_backpack', ['id' => $id])) {
814         $transaction = $DB->start_delegated_transaction();
816         // Remove connections for users to this backpack.
817         $sql = "SELECT DISTINCT bb.id
818                   FROM {badge_backpack} bb
819                  WHERE bb.externalbackpackid = :backpackid";
820         $params = ['backpackid' => $id];
821         $userbackpacks = $DB->get_fieldset_sql($sql, $params);
822         if ($userbackpacks) {
823             // Delete user external collections references to this backpack.
824             list($insql, $params) = $DB->get_in_or_equal($userbackpacks);
825             $DB->delete_records_select('badge_external', "backpackid $insql", $params);
826         }
827         $DB->delete_records('badge_backpack', ['externalbackpackid' => $id]);
829         // Delete backpack entry.
830         $result = $DB->delete_records('badge_external_backpack', ['id' => $id]);
832         $transaction->allow_commit();
834         return $result;
835     }
837     return false;
840 /**
841  * Perform the actual create/update of external bakpacks. Any checks on the validity of the id will need to be
842  * performed before it reaches this function.
843  *
844  * @param stdClass $data The backpack data we are updating/inserting
845  * @return int Returns the id of the new/updated record
846  */
847 function badges_save_external_backpack(stdClass $data) {
848     global $DB;
849     $backpack = new stdClass();
851     $backpack->apiversion = $data->apiversion;
852     $backpack->backpackweburl = $data->backpackweburl;
853     $backpack->backpackapiurl = $data->backpackapiurl;
854     $backpack->backpackemail = $data->backpackemail;
855     $backpack->password = !empty($data->password) ? $data->password : '';
856     $backpack->oauth2_issuerid = !empty($data->oauth2_issuerid) ? $data->oauth2_issuerid : '';
857     if (isset($data->sortorder)) {
858         $backpack->sortorder = $data->sortorder;
859     }
861     $method = 'insert_record';
862     if (isset($data->id) && $data->id) {
863         $backpack->id = $data->id;
864         $method = 'update_record';
865     }
866     $record = $DB->$method('badge_external_backpack', $backpack, true);
867     $data->externalbackpackid = $data->id ?? $record;
869     unset($data->id);
870     badges_save_backpack_credentials($data);
872     return $data->externalbackpackid;
875 /**
876  * Create a backpack with the provided details. Stores the auth details of the backpack
877  *
878  * @param stdClass $data Backpack specific data.
879  * @return int The id of the external backpack that the credentials correspond to
880  */
881 function badges_save_backpack_credentials(stdClass $data) {
882     global $DB;
884     if (isset($data->backpackemail) && isset($data->password)) {
885         $backpack = new stdClass();
887         $backpack->email = $data->backpackemail;
888         $backpack->password = !empty($data->password) ? $data->password : '';
889         $backpack->externalbackpackid = $data->externalbackpackid;
890         $backpack->userid = $data->userid ?? 0;
891         $backpack->backpackuid = $data->backpackuid ?? 0;
892         $backpack->autosync = $data->autosync ?? 0;
894         $id = null;
895         if (isset($data->badgebackpack) && $data->badgebackpack) {
896             $id = $data->badgebackpack;
897         } else if (isset($data->id) && $data->id) {
898             $id = $data->id;
899         }
901         $method = $id ? 'update_record' : 'insert_record';
902         if ($id) {
903             $backpack->id = $id;
904         }
906         $DB->$method('badge_backpack', $backpack);
907         return $backpack->externalbackpackid;
908     }
910     return $data->externalbackpackid ?? 0;
913 /**
914  * Is any backpack enabled that supports open badges V1?
915  * @return boolean
916  */
917 function badges_open_badges_backpack_api() {
918     global $CFG;
920     $backpack = badges_get_site_backpack($CFG->badges_site_backpack);
921     if (empty($backpack->apiversion)) {
922         return OPEN_BADGES_V2;
923     }
924     return $backpack->apiversion;
927 /**
928  * Get a site backpacks by id or url.
929  *
930  * @param int $id The backpack id.
931  * @return array(stdClass)
932  */
933 function badges_get_site_backpack($id) {
934     global $DB;
936     return $DB->get_record('badge_external_backpack', ['id' => $id]);
939 /**
940  * List the backpacks at site level.
941  *
942  * @return array(stdClass)
943  */
944 function badges_get_site_backpacks() {
945     global $DB, $CFG;
947     $sql = "SELECT beb.*
948             FROM {badge_external_backpack} beb
949             LEFT JOIN {badge_backpack} bb ON bb.externalbackpackid = beb.id
950             WHERE bb.id IS NULL";
951     $all = $DB->get_records_sql($sql);
953     foreach ($all as $key => $bp) {
954         if ($bp->id == $CFG->badges_site_backpack) {
955             $all[$key]->sitebackpack = true;
956         } else {
957             $all[$key]->sitebackpack = false;
958         }
959     }
960     return $all;
963 /**
964  * List the supported badges api versions.
965  *
966  * @return array(version)
967  */
968 function badges_get_badge_api_versions() {
969     return [
970         (string)OPEN_BADGES_V1 => get_string('openbadgesv1', 'badges'),
971         (string)OPEN_BADGES_V2 => get_string('openbadgesv2', 'badges'),
972         (string)OPEN_BADGES_V2P1 => get_string('openbadgesv2p1', 'badges')
973     ];
976 /**
977  * Get the default issuer for a badge from this site.
978  *
979  * @return array
980  */
981 function badges_get_default_issuer() {
982     global $CFG, $SITE;
984     $issuer = array();
985     $issuerurl = new moodle_url('/');
986     $issuer['name'] = $CFG->badges_defaultissuername;
987     if (empty($issuer['name'])) {
988         $issuer['name'] = $SITE->fullname ? $SITE->fullname : $SITE->shortname;
989     }
990     $issuer['url'] = $issuerurl->out(false);
991     $issuer['email'] = $CFG->badges_defaultissuercontact;
992     $issuer['@context'] = OPEN_BADGES_V2_CONTEXT;
993     $issuerid = new moodle_url('/badges/issuer_json.php');
994     $issuer['id'] = $issuerid->out(false);
995     $issuer['type'] = OPEN_BADGES_V2_TYPE_ISSUER;
996     return $issuer;
999 /**
1000  * Disconnect from the user backpack by deleting the user preferences.
1001  *
1002  * @param integer $userid The user to diconnect.
1003  * @return boolean
1004  */
1005 function badges_disconnect_user_backpack($userid) {
1006     global $USER;
1008     // We can only change backpack settings for our own real backpack.
1009     if ($USER->id != $userid ||
1010             \core\session\manager::is_loggedinas()) {
1012         return false;
1013     }
1015     unset_user_preference('badges_email_verify_secret');
1016     unset_user_preference('badges_email_verify_address');
1017     unset_user_preference('badges_email_verify_backpackid');
1018     unset_user_preference('badges_email_verify_password');
1020     return true;
1023 /**
1024  * Used to remember which objects we connected with a backpack before.
1025  *
1026  * @param integer $sitebackpackid The site backpack to connect to.
1027  * @param string $type The type of this remote object.
1028  * @param string $internalid The id for this object on the Moodle site.
1029  * @return mixed The id or false if it doesn't exist.
1030  */
1031 function badges_external_get_mapping($sitebackpackid, $type, $internalid) {
1032     global $DB;
1033     // Return externalid if it exists.
1034     $params = [
1035         'sitebackpackid' => $sitebackpackid,
1036         'type' => $type,
1037         'internalid' => $internalid
1038     ];
1040     $record = $DB->get_record('badge_external_identifier', $params, 'externalid', IGNORE_MISSING);
1041     if ($record) {
1042         return $record->externalid;
1043     }
1044     return false;
1047 /**
1048  * Save the info about which objects we connected with a backpack before.
1049  *
1050  * @param integer $sitebackpackid The site backpack to connect to.
1051  * @param string $type The type of this remote object.
1052  * @param string $internalid The id for this object on the Moodle site.
1053  * @param string $externalid The id of this object on the remote site.
1054  * @return boolean
1055  */
1056 function badges_external_create_mapping($sitebackpackid, $type, $internalid, $externalid) {
1057     global $DB;
1059     $params = [
1060         'sitebackpackid' => $sitebackpackid,
1061         'type' => $type,
1062         'internalid' => $internalid,
1063         'externalid' => $externalid
1064     ];
1066     return $DB->insert_record('badge_external_identifier', $params);
1069 /**
1070  * Delete all external mapping information for a backpack.
1071  *
1072  * @param integer $sitebackpackid The site backpack to connect to.
1073  * @return boolean
1074  */
1075 function badges_external_delete_mappings($sitebackpackid) {
1076     global $DB;
1078     $params = ['sitebackpackid' => $sitebackpackid];
1080     return $DB->delete_records('badge_external_identifier', $params);
1083 /**
1084  * Delete a specific external mapping information for a backpack.
1085  *
1086  * @param integer $sitebackpackid The site backpack to connect to.
1087  * @param string $type The type of this remote object.
1088  * @param string $internalid The id for this object on the Moodle site.
1089  * @return boolean
1090  */
1091 function badges_external_delete_mapping($sitebackpackid, $type, $internalid) {
1092     global $DB;
1094     $params = [
1095         'sitebackpackid' => $sitebackpackid,
1096         'type' => $type,
1097         'internalid' => $internalid
1098     ];
1100     $DB->delete_record('badge_external_identifier', $params);
1103 /**
1104  * Create and send a verification email to the email address supplied.
1105  *
1106  * Since we're not sending this email to a user, email_to_user can't be used
1107  * but this function borrows largely the code from that process.
1108  *
1109  * @param string $email the email address to send the verification email to.
1110  * @param int $backpackid the id of the backpack to connect to
1111  * @param string $backpackpassword the user entered password to connect to this backpack
1112  * @return true if the email was sent successfully, false otherwise.
1113  */
1114 function badges_send_verification_email($email, $backpackid, $backpackpassword) {
1115     global $DB, $USER;
1117     // Store a user secret (badges_email_verify_secret) and the address (badges_email_verify_address) as users prefs.
1118     // The address will be used by edit_backpack_form for display during verification and to facilitate the resending
1119     // of verification emails to said address.
1120     $secret = random_string(15);
1121     set_user_preference('badges_email_verify_secret', $secret);
1122     set_user_preference('badges_email_verify_address', $email);
1123     set_user_preference('badges_email_verify_backpackid', $backpackid);
1124     set_user_preference('badges_email_verify_password', $backpackpassword);
1126     // To, from.
1127     $tempuser = $DB->get_record('user', array('id' => $USER->id), '*', MUST_EXIST);
1128     $tempuser->email = $email;
1129     $noreplyuser = core_user::get_noreply_user();
1131     // Generate the verification email body.
1132     $verificationurl = '/badges/backpackemailverify.php';
1133     $verificationurl = new moodle_url($verificationurl);
1134     $verificationpath = $verificationurl->out(false);
1136     $site = get_site();
1137     $args = new stdClass();
1138     $args->link = $verificationpath . '?data='. $secret;
1139     $args->sitename = $site->fullname;
1140     $args->admin = generate_email_signoff();
1142     $messagesubject = get_string('backpackemailverifyemailsubject', 'badges', $site->fullname);
1143     $messagetext = get_string('backpackemailverifyemailbody', 'badges', $args);
1144     $messagehtml = text_to_html($messagetext, false, false, true);
1146     return email_to_user($tempuser, $noreplyuser, $messagesubject, $messagetext, $messagehtml);
1149 /**
1150  * Return all the enabled criteria types for this site.
1151  *
1152  * @param boolean $enabled
1153  * @return array
1154  */
1155 function badges_list_criteria($enabled = true) {
1156     global $CFG;
1158     $types = array(
1159         BADGE_CRITERIA_TYPE_OVERALL    => 'overall',
1160         BADGE_CRITERIA_TYPE_ACTIVITY   => 'activity',
1161         BADGE_CRITERIA_TYPE_MANUAL     => 'manual',
1162         BADGE_CRITERIA_TYPE_SOCIAL     => 'social',
1163         BADGE_CRITERIA_TYPE_COURSE     => 'course',
1164         BADGE_CRITERIA_TYPE_COURSESET  => 'courseset',
1165         BADGE_CRITERIA_TYPE_PROFILE    => 'profile',
1166         BADGE_CRITERIA_TYPE_BADGE      => 'badge',
1167         BADGE_CRITERIA_TYPE_COHORT     => 'cohort',
1168         BADGE_CRITERIA_TYPE_COMPETENCY => 'competency',
1169     );
1170     if ($enabled) {
1171         foreach ($types as $key => $type) {
1172             $class = 'award_criteria_' . $type;
1173             $file = $CFG->dirroot . '/badges/criteria/' . $class . '.php';
1174             if (file_exists($file)) {
1175                 require_once($file);
1177                 if (!$class::is_enabled()) {
1178                     unset($types[$key]);
1179                 }
1180             }
1181         }
1182     }
1183     return $types;
1186 /**
1187  * Check if any badge has records for competencies.
1188  *
1189  * @param array $competencyids Array of competencies ids.
1190  * @return boolean Return true if competencies were found in any badge.
1191  */
1192 function badge_award_criteria_competency_has_records_for_competencies($competencyids) {
1193     global $DB;
1195     list($insql, $params) = $DB->get_in_or_equal($competencyids, SQL_PARAMS_NAMED);
1197     $sql = "SELECT DISTINCT bc.badgeid
1198                 FROM {badge_criteria} bc
1199                 JOIN {badge_criteria_param} bcp ON bc.id = bcp.critid
1200                 WHERE bc.criteriatype = :criteriatype AND bcp.value $insql";
1201     $params['criteriatype'] = BADGE_CRITERIA_TYPE_COMPETENCY;
1203     return $DB->record_exists_sql($sql, $params);
1206 /**
1207  * Creates single message for all notification and sends it out
1208  *
1209  * @param object $badge A badge which is notified about.
1210  */
1211 function badge_assemble_notification(stdClass $badge) {
1212     global $DB;
1214     $userfrom = core_user::get_noreply_user();
1215     $userfrom->maildisplay = true;
1217     if ($msgs = $DB->get_records_select('badge_issued', 'issuernotified IS NULL AND badgeid = ?', array($badge->id))) {
1218         // Get badge creator.
1219         $creator = $DB->get_record('user', array('id' => $badge->creator), '*', MUST_EXIST);
1220         $creatorsubject = get_string('creatorsubject', 'badges', $badge->name);
1221         $creatormessage = '';
1223         // Put all messages in one digest.
1224         foreach ($msgs as $msg) {
1225             $issuedlink = html_writer::link(new moodle_url('/badges/badge.php', array('hash' => $msg->uniquehash)), $badge->name);
1226             $recipient = $DB->get_record('user', array('id' => $msg->userid), '*', MUST_EXIST);
1228             $a = new stdClass();
1229             $a->user = fullname($recipient);
1230             $a->link = $issuedlink;
1231             $creatormessage .= get_string('creatorbody', 'badges', $a);
1232             $DB->set_field('badge_issued', 'issuernotified', time(), array('badgeid' => $msg->badgeid, 'userid' => $msg->userid));
1233         }
1235         // Create a message object.
1236         $eventdata = new \core\message\message();
1237         $eventdata->courseid          = SITEID;
1238         $eventdata->component         = 'moodle';
1239         $eventdata->name              = 'badgecreatornotice';
1240         $eventdata->userfrom          = $userfrom;
1241         $eventdata->userto            = $creator;
1242         $eventdata->notification      = 1;
1243         $eventdata->subject           = $creatorsubject;
1244         $eventdata->fullmessage       = format_text_email($creatormessage, FORMAT_HTML);
1245         $eventdata->fullmessageformat = FORMAT_PLAIN;
1246         $eventdata->fullmessagehtml   = $creatormessage;
1247         $eventdata->smallmessage      = $creatorsubject;
1249         message_send($eventdata);
1250     }
1253 /**
1254  * Attempt to authenticate with the site backpack credentials and return an error
1255  * if the authentication fails. If external backpacks are not enabled, this will
1256  * not perform any test.
1257  *
1258  * @return string
1259  */
1260 function badges_verify_site_backpack() {
1261     global $CFG;
1263     return badges_verify_backpack($CFG->badges_site_backpack);
1266 /**
1267  * Attempt to authenticate with a backpack credentials and return an error
1268  * if the authentication fails.
1269  * If external backpacks are not enabled or the backpack version is different
1270  * from OBv2, this will not perform any test.
1271  *
1272  * @param int $backpackid Backpack identifier to verify.
1273  * @return string The result of the verification process.
1274  */
1275 function badges_verify_backpack(int $backpackid) {
1276     global $OUTPUT, $CFG;
1278     if (empty($CFG->badges_allowexternalbackpack)) {
1279         return '';
1280     }
1282     $backpack = badges_get_site_backpack($backpackid);
1283     if (empty($backpack->apiversion) || ($backpack->apiversion == OPEN_BADGES_V2)) {
1284         $backpackapi = new \core_badges\backpack_api($backpack);
1286         // Clear any cached access tokens in the session.
1287         $backpackapi->clear_system_user_session();
1289         // Now attempt a login with these credentials.
1290         $result = $backpackapi->authenticate();
1291         if (empty($result) || !empty($result->error)) {
1292             $warning = $backpackapi->get_authentication_error();
1294             $params = ['id' => $backpack->id, 'action' => 'edit'];
1295             $backpackurl = (new moodle_url('/badges/backpacks.php', $params))->out(false);
1297             $message = get_string('sitebackpackwarning', 'badges', ['url' => $backpackurl, 'warning' => $warning]);
1298             $icon = $OUTPUT->pix_icon('i/warning', get_string('warning', 'moodle'));
1299             return $OUTPUT->container($icon . $message, 'text-danger');
1300         }
1301     }
1303     return '';
1306 /**
1307  * Get OAuth2 services for the external backpack.
1308  *
1309  * @return array
1310  * @throws coding_exception
1311  */
1312 function badges_get_oauth2_service_options() {
1313     global $DB;
1315     $issuers = core\oauth2\api::get_all_issuers();
1316     $options = ['' => 'None'];
1317     foreach ($issuers as $issuer) {
1318         $options[$issuer->get('id')] = $issuer->get('name');
1319     }
1321     return $options;