598a88e7ba3db34417b4ae06cb2f5bb94c9d970b
[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  * Class that represents badge.
98  *
99  */
100 class badge {
101     /** @var int Badge id */
102     public $id;
104     /** Values from the table 'badge' */
105     public $name;
106     public $description;
107     public $timecreated;
108     public $timemodified;
109     public $usercreated;
110     public $usermodified;
111     public $issuername;
112     public $issuerurl;
113     public $issuercontact;
114     public $expiredate;
115     public $expireperiod;
116     public $type;
117     public $courseid;
118     public $message;
119     public $messagesubject;
120     public $attachment;
121     public $notification;
122     public $status = 0;
123     public $nextcron;
125     /** @var array Badge criteria */
126     public $criteria = array();
128     /**
129      * Constructs with badge details.
130      *
131      * @param int $badgeid badge ID.
132      */
133     public function __construct($badgeid) {
134         global $DB;
135         $this->id = $badgeid;
137         $data = $DB->get_record('badge', array('id' => $badgeid));
139         if (empty($data)) {
140             print_error('error:nosuchbadge', 'badges', $badgeid);
141         }
143         foreach ((array)$data as $field => $value) {
144             if (property_exists($this, $field)) {
145                 $this->{$field} = $value;
146             }
147         }
149         $this->criteria = self::get_criteria();
150     }
152     /**
153      * Use to get context instance of a badge.
154      * @return context instance.
155      */
156     public function get_context() {
157         if ($this->type == BADGE_TYPE_SITE) {
158             return context_system::instance();
159         } else if ($this->type == BADGE_TYPE_COURSE) {
160             return context_course::instance($this->courseid);
161         } else {
162             debugging('Something is wrong...');
163         }
164     }
166     /**
167      * Return array of aggregation methods
168      * @return array
169      */
170     public static function get_aggregation_methods() {
171         return array(
172                 BADGE_CRITERIA_AGGREGATION_ALL => get_string('all', 'badges'),
173                 BADGE_CRITERIA_AGGREGATION_ANY => get_string('any', 'badges'),
174         );
175     }
177     /**
178      * Return array of accepted criteria types for this badge
179      * @return array
180      */
181     public function get_accepted_criteria() {
182         $criteriatypes = array();
184         if ($this->type == BADGE_TYPE_COURSE) {
185             $criteriatypes = array(
186                     BADGE_CRITERIA_TYPE_OVERALL,
187                     BADGE_CRITERIA_TYPE_MANUAL,
188                     BADGE_CRITERIA_TYPE_COURSE,
189                     BADGE_CRITERIA_TYPE_ACTIVITY
190             );
191         } else if ($this->type == BADGE_TYPE_SITE) {
192             $criteriatypes = array(
193                     BADGE_CRITERIA_TYPE_OVERALL,
194                     BADGE_CRITERIA_TYPE_MANUAL,
195                     BADGE_CRITERIA_TYPE_COURSESET,
196                     BADGE_CRITERIA_TYPE_PROFILE,
197             );
198         }
200         return $criteriatypes;
201     }
203     /**
204      * Save/update badge information in 'badge' table only.
205      * Cannot be used for updating awards and criteria settings.
206      *
207      * @return bool Returns true on success.
208      */
209     public function save() {
210         global $DB;
212         $fordb = new stdClass();
213         foreach (get_object_vars($this) as $k => $v) {
214             $fordb->{$k} = $v;
215         }
216         unset($fordb->criteria);
218         $fordb->timemodified = time();
219         if ($DB->update_record_raw('badge', $fordb)) {
220             return true;
221         } else {
222             throw new moodle_exception('error:save', 'badges');
223             return false;
224         }
225     }
227     /**
228      * Creates and saves a clone of badge with all its properties.
229      * Clone is not active by default and has 'Copy of' attached to its name.
230      *
231      * @return int ID of new badge.
232      */
233     public function make_clone() {
234         global $DB, $USER;
236         $fordb = new stdClass();
237         foreach (get_object_vars($this) as $k => $v) {
238             $fordb->{$k} = $v;
239         }
241         $fordb->name = get_string('copyof', 'badges', $this->name);
242         $fordb->status = BADGE_STATUS_INACTIVE;
243         $fordb->usercreated = $USER->id;
244         $fordb->usermodified = $USER->id;
245         $fordb->timecreated = time();
246         $fordb->timemodified = time();
247         unset($fordb->id);
249         if ($fordb->notification > 1) {
250             $fordb->nextcron = badges_calculate_message_schedule($fordb->notification);
251         }
253         $criteria = $fordb->criteria;
254         unset($fordb->criteria);
256         if ($new = $DB->insert_record('badge', $fordb, true)) {
257             $newbadge = new badge($new);
259             // Copy badge image.
260             $fs = get_file_storage();
261             if ($file = $fs->get_file($this->get_context()->id, 'badges', 'badgeimage', $this->id, '/', 'f1.png')) {
262                 if ($imagefile = $file->copy_content_to_temp()) {
263                     badges_process_badge_image($newbadge, $imagefile);
264                 }
265             }
267             // Copy badge criteria.
268             foreach ($this->criteria as $crit) {
269                 $crit->make_clone($new);
270             }
272             return $new;
273         } else {
274             throw new moodle_exception('error:clone', 'badges');
275             return false;
276         }
277     }
279     /**
280      * Checks if badges is active.
281      * Used in badge award.
282      *
283      * @return bool A status indicating badge is active
284      */
285     public function is_active() {
286         if (($this->status == BADGE_STATUS_ACTIVE) ||
287             ($this->status == BADGE_STATUS_ACTIVE_LOCKED)) {
288             return true;
289         }
290         return false;
291     }
293     /**
294      * Use to get the name of badge status.
295      *
296      */
297     public function get_status_name() {
298         return get_string('badgestatus_' . $this->status, 'badges');
299     }
301     /**
302      * Use to set badge status.
303      * Only active badges can be earned/awarded/issued.
304      *
305      * @param int $status Status from BADGE_STATUS constants
306      */
307     public function set_status($status = 0) {
308         $this->status = $status;
309         $this->save();
310     }
312     /**
313      * Checks if badges is locked.
314      * Used in badge award and editing.
315      *
316      * @return bool A status indicating badge is locked
317      */
318     public function is_locked() {
319         if (($this->status == BADGE_STATUS_ACTIVE_LOCKED) ||
320                 ($this->status == BADGE_STATUS_INACTIVE_LOCKED)) {
321             return true;
322         }
323         return false;
324     }
326     /**
327      * Checks if badge has been awarded to users.
328      * Used in badge editing.
329      *
330      * @return bool A status indicating badge has been awarded at least once
331      */
332     public function has_awards() {
333         global $DB;
334         if ($DB->record_exists('badge_issued', array('badgeid' => $this->id))) {
335             return true;
336         }
337         return false;
338     }
340     /**
341      * Gets list of users who have earned an instance of this badge.
342      *
343      * @return array An array of objects with information about badge awards.
344      */
345     public function get_awards() {
346         global $DB;
348         $awards = $DB->get_records_sql(
349                 'SELECT b.userid, b.dateissued, b.uniquehash, u.firstname, u.lastname
350                     FROM {badge_issued} b INNER JOIN {user} u
351                         ON b.userid = u.id
352                     WHERE b.badgeid = :badgeid', array('badgeid' => $this->id));
354         return $awards;
355     }
357     /**
358      * Indicates whether badge has already been issued to a user.
359      *
360      */
361     public function is_issued($userid) {
362         global $DB;
363         return $DB->record_exists('badge_issued', array('badgeid' => $this->id, 'userid' => $userid));
364     }
366     /**
367      * Issue a badge to user.
368      *
369      * @param int $userid User who earned the badge
370      * @param bool $nobake Not baking actual badges (for testing purposes)
371      */
372     public function issue($userid, $nobake = false) {
373         global $DB, $CFG;
375         $now = time();
376         $issued = new stdClass();
377         $issued->badgeid = $this->id;
378         $issued->userid = $userid;
379         $issued->uniquehash = sha1(rand() . $userid . $this->id . $now);
380         $issued->dateissued = $now;
382         if ($this->can_expire()) {
383             $issued->dateexpire = $this->calculate_expiry($now);
384         } else {
385             $issued->dateexpire = null;
386         }
388         // Take into account user badges privacy settings.
389         // If none set, badges default visibility is set to public.
390         $issued->visible = get_user_preferences('badgeprivacysetting', 1, $userid);
392         $result = $DB->insert_record('badge_issued', $issued, true);
394         if ($result) {
395             // Lock the badge, so that its criteria could not be changed any more.
396             if ($this->status == BADGE_STATUS_ACTIVE) {
397                 $this->set_status(BADGE_STATUS_ACTIVE_LOCKED);
398             }
400             // Update details in criteria_met table.
401             $compl = $this->get_criteria_completions($userid);
402             foreach ($compl as $c) {
403                 $obj = new stdClass();
404                 $obj->id = $c->id;
405                 $obj->issuedid = $result;
406                 $DB->update_record('badge_criteria_met', $obj, true);
407             }
409             if (!$nobake) {
410                 // Bake a badge image.
411                 $pathhash = badges_bake($issued->uniquehash, $this->id, $userid, true);
413                 // Notify recipients and badge creators.
414                 if (empty($CFG->noemailever)) {
415                     badges_notify_badge_award($this, $userid, $issued->uniquehash, $pathhash);
416                 }
417             }
418         }
419     }
421     /**
422      * Reviews all badge criteria and checks if badge can be instantly awarded.
423      *
424      * @return int Number of awards
425      */
426     public function review_all_criteria() {
427         global $DB, $CFG;
428         $awards = 0;
430         // Raise timelimit as this could take a while for big web sites.
431         set_time_limit(0);
432         raise_memory_limit(MEMORY_HUGE);
434         // For site level badges, get all active site users who can earn this badge and haven't got it yet.
435         if ($this->type == BADGE_TYPE_SITE) {
436             $sql = 'SELECT DISTINCT u.id, bi.badgeid
437                         FROM {user} u
438                         LEFT JOIN {badge_issued} bi
439                             ON u.id = bi.userid AND bi.badgeid = :badgeid
440                         WHERE bi.badgeid IS NULL AND u.id != :guestid AND u.deleted = 0';
441             $toearn = $DB->get_fieldset_sql($sql, array('badgeid' => $this->id, 'guestid' => $CFG->siteguest));
442         } else {
443             // For course level badges, get users who can earn this badge in the course.
444             // These are all enrolled users with capability moodle/badges:earnbadge.
445             $earned = $DB->get_fieldset_select('badge_issued', 'userid AS id', 'badgeid = :badgeid', array('badgeid' => $this->id));
446             $users = get_enrolled_users($this->get_context(), 'moodle/badges:earnbadge', 0, 'u.id');
447             $toearn = array_diff(array_keys($users), $earned);
448         }
450         foreach ($toearn as $uid) {
451             $toreview = false;
452             foreach ($this->criteria as $crit) {
453                 if ($crit->criteriatype != BADGE_CRITERIA_TYPE_OVERALL) {
454                     if ($crit->review($uid)) {
455                         $crit->mark_complete($uid);
456                         if ($this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->method == BADGE_CRITERIA_AGGREGATION_ANY) {
457                             $this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($uid);
458                             $this->issue($uid);
459                             $awards++;
460                             break;
461                         } else {
462                             $toreview = true;
463                             continue;
464                         }
465                     } else {
466                         if ($this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->method == BADGE_CRITERIA_AGGREGATION_ANY) {
467                             continue;
468                         } else {
469                             break;
470                         }
471                     }
472                 }
473             }
474             // Review overall if it is required.
475             if ($toreview && $this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->review($uid)) {
476                 $this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($uid);
477                 $this->issue($uid);
478                 $awards++;
479             }
480         }
482         return $awards;
483     }
485     /**
486      * Gets an array of completed criteria from 'badge_criteria_met' table.
487      *
488      * @param int $userid Completions for a user
489      * @return array Records of criteria completions
490      */
491     public function get_criteria_completions($userid) {
492         global $DB;
493         $completions = array();
494         $sql = "SELECT bcm.id, bcm.critid
495                 FROM {badge_criteria_met} bcm
496                     INNER JOIN {badge_criteria} bc ON bcm.critid = bc.id
497                 WHERE bc.badgeid = :badgeid AND bcm.userid = :userid ";
498         $completions = $DB->get_records_sql($sql, array('badgeid' => $this->id, 'userid' => $userid));
500         return $completions;
501     }
503     /**
504      * Checks if badges has award criteria set up.
505      *
506      * @return bool A status indicating badge has at least one criterion
507      */
508     public function has_criteria() {
509         if (count($this->criteria) > 0) {
510             return true;
511         }
512         return false;
513     }
515     /**
516      * Returns badge award criteria
517      *
518      * @return array An array of badge criteria
519      */
520     public function get_criteria() {
521         global $DB;
522         $criteria = array();
524         if ($records = (array)$DB->get_records('badge_criteria', array('badgeid' => $this->id))) {
525             foreach ($records as $record) {
526                 $criteria[$record->criteriatype] = award_criteria::build((array)$record);
527             }
528         }
530         return $criteria;
531     }
533     /**
534      * Get aggregation method for badge criteria
535      *
536      * @param int $criteriatype If none supplied, get overall aggregation method (optional)
537      * @return int One of BADGE_CRITERIA_AGGREGATION_ALL or BADGE_CRITERIA_AGGREGATION_ANY
538      */
539     public function get_aggregation_method($criteriatype = 0) {
540         global $DB;
541         $params = array('badgeid' => $this->id, 'criteriatype' => $criteriatype);
542         $aggregation = $DB->get_field('badge_criteria', 'method', $params, IGNORE_MULTIPLE);
544         if (!$aggregation) {
545             return BADGE_CRITERIA_AGGREGATION_ALL;
546         }
548         return $aggregation;
549     }
551     /**
552      * Checks if badge has expiry period or date set up.
553      *
554      * @return bool A status indicating badge can expire
555      */
556     public function can_expire() {
557         if ($this->expireperiod || $this->expiredate) {
558             return true;
559         }
560         return false;
561     }
563     /**
564      * Calculates badge expiry date based on either expirydate or expiryperiod.
565      *
566      * @param int $timestamp Time of badge issue
567      * @return int A timestamp
568      */
569     public function calculate_expiry($timestamp) {
570         $expiry = null;
572         if (isset($this->expiredate)) {
573             $expiry = $this->expiredate;
574         } else if (isset($this->expireperiod)) {
575             $expiry = $timestamp + $this->expireperiod;
576         }
578         return $expiry;
579     }
581     /**
582      * Checks if badge has manual award criteria set.
583      *
584      * @return bool A status indicating badge can be awarded manually
585      */
586     public function has_manual_award_criteria() {
587         foreach ($this->criteria as $criterion) {
588             if ($criterion->criteriatype == BADGE_CRITERIA_TYPE_MANUAL) {
589                 return true;
590             }
591         }
592         return false;
593     }
595     /**
596      * Marks the badge as archived.
597      * For reporting and historical purposed we cannot completely delete badges.
598      * We will just change their status to BADGE_STATUS_ARCHIVED.
599      */
600     public function delete() {
601         $this->status = BADGE_STATUS_ARCHIVED;
602         $this->save();
603     }
606 /**
607  * Sends notifications to users about awarded badges.
608  *
609  * @param badge $badge Badge that was issued
610  * @param int $userid Recipient ID
611  * @param string $issued Unique hash of an issued badge
612  * @param string $filepathhash File path hash of an issued badge for attachments
613  */
614 function badges_notify_badge_award(badge $badge, $userid, $issued, $filepathhash) {
615     global $CFG, $DB;
617     $admin = get_admin();
618     $userfrom = new stdClass();
619     $userfrom->id = $admin->id;
620     $userfrom->email = !empty($CFG->badges_defaultissuercontact) ? $CFG->badges_defaultissuercontact : $admin->email;
621     foreach (get_all_user_name_fields() as $addname) {
622         $userfrom->$addname = !empty($CFG->badges_defaultissuername) ? '' : $admin->$addname;
623     }
624     $userfrom->firstname = !empty($CFG->badges_defaultissuername) ? $CFG->badges_defaultissuername : $admin->firstname;
625     $userfrom->maildisplay = true;
627     $issuedlink = html_writer::link(new moodle_url('/badges/badge.php', array('hash' => $issued)), $badge->name);
628     $userto = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST);
630     $params = new stdClass();
631     $params->badgename = $badge->name;
632     $params->username = fullname($userto);
633     $params->badgelink = $issuedlink;
634     $message = badge_message_from_template($badge->message, $params);
635     $plaintext = format_text_email($message, FORMAT_HTML);
637     if ($badge->attachment && $filepathhash) {
638         $fs = get_file_storage();
639         $file = $fs->get_file_by_hash($filepathhash);
640         $attachment = $file->copy_content_to_temp();
641         email_to_user($userto,
642             $userfrom,
643             $badge->messagesubject,
644             $plaintext,
645             $message,
646             str_replace($CFG->dataroot, '', $attachment),
647             str_replace(' ', '_', $badge->name) . ".png"
648         );
649         @unlink($attachment);
650     } else {
651         email_to_user($userto, $userfrom, $badge->messagesubject, $plaintext, $message);
652     }
654     // Notify badge creator about the award if they receive notifications every time.
655     if ($badge->notification == 1) {
656         $creator = $DB->get_record('user', array('id' => $badge->usercreated), '*', MUST_EXIST);
657         $a = new stdClass();
658         $a->user = fullname($userto);
659         $a->link = $issuedlink;
660         $creatormessage = get_string('creatorbody', 'badges', $a);
661         $creatorsubject = get_string('creatorsubject', 'badges', $badge->name);
663         $eventdata = new stdClass();
664         $eventdata->component         = 'moodle';
665         $eventdata->name              = 'instantmessage';
666         $eventdata->userfrom          = $userfrom;
667         $eventdata->userto            = $creator;
668         $eventdata->notification      = 1;
669         $eventdata->subject           = $creatorsubject;
670         $eventdata->fullmessage       = $creatormessage;
671         $eventdata->fullmessageformat = FORMAT_PLAIN;
672         $eventdata->fullmessagehtml   = format_text($creatormessage, FORMAT_HTML);
673         $eventdata->smallmessage      = '';
675         message_send($eventdata);
676         $DB->set_field('badge_issued', 'issuernotified', time(), array('badgeid' => $badge->id, 'userid' => $userid));
677     }
680 /**
681  * Caclulates date for the next message digest to badge creators.
682  *
683  * @param in $schedule Type of message schedule BADGE_MESSAGE_DAILY|BADGE_MESSAGE_WEEKLY|BADGE_MESSAGE_MONTHLY.
684  * @return int Timestamp for next cron
685  */
686 function badges_calculate_message_schedule($schedule) {
687     $nextcron = 0;
689     switch ($schedule) {
690         case BADGE_MESSAGE_DAILY:
691             $nextcron = time() + 60 * 60 * 24;
692             break;
693         case BADGE_MESSAGE_WEEKLY:
694             $nextcron = time() + 60 * 60 * 24 * 7;
695             break;
696         case BADGE_MESSAGE_MONTHLY:
697             $nextcron = time() + 60 * 60 * 24 * 7 * 30;
698             break;
699     }
701     return $nextcron;
704 /**
705  * Replaces variables in a message template and returns text ready to be emailed to a user.
706  *
707  * @param string $message Message body.
708  * @return string Message with replaced values
709  */
710 function badge_message_from_template($message, $params) {
711     $msg = $message;
712     foreach ($params as $key => $value) {
713         $msg = str_replace("%$key%", $value, $msg);
714     }
716     return $msg;
719 /**
720  * Get all badges.
721  *
722  * @param int Type of badges to return
723  * @param int Course ID for course badges
724  * @param string $sort An SQL field to sort by
725  * @param string $dir The sort direction ASC|DESC
726  * @param int $page The page or records to return
727  * @param int $perpage The number of records to return per page
728  * @param int $user User specific search
729  * @return array $badge Array of records matching criteria
730  */
731 function badges_get_badges($type, $courseid = 0, $sort = '', $dir = '', $page = 0, $perpage = BADGE_PERPAGE, $user = 0) {
732     global $DB;
733     $records = array();
734     $params = array();
735     $where = "b.status != :deleted AND b.type = :type ";
736     $params['deleted'] = BADGE_STATUS_ARCHIVED;
738     $userfields = array('b.id, b.name, b.status');
739     $usersql = "";
740     if ($user != 0) {
741         $userfields[] = 'bi.dateissued';
742         $userfields[] = 'bi.uniquehash';
743         $usersql = " LEFT JOIN {badge_issued} bi ON b.id = bi.badgeid AND bi.userid = :userid ";
744         $params['userid'] = $user;
745         $where .= " AND (b.status = 1 OR b.status = 3) ";
746     }
747     $fields = implode(', ', $userfields);
749     if ($courseid != 0 ) {
750         $where .= "AND b.courseid = :courseid ";
751         $params['courseid'] = $courseid;
752     }
754     $sorting = (($sort != '' && $dir != '') ? 'ORDER BY ' . $sort . ' ' . $dir : '');
755     $params['type'] = $type;
757     $sql = "SELECT $fields FROM {badge} b $usersql WHERE $where $sorting";
758     $records = $DB->get_records_sql($sql, $params, $page * $perpage, $perpage);
760     $badges = array();
761     foreach ($records as $r) {
762         $badge = new badge($r->id);
763         $badges[$r->id] = $badge;
764         if ($user != 0) {
765             $badges[$r->id]->dateissued = $r->dateissued;
766             $badges[$r->id]->uniquehash = $r->uniquehash;
767         } else {
768             $badges[$r->id]->awards = $DB->count_records('badge_issued', array('badgeid' => $badge->id));
769             $badges[$r->id]->statstring = $badge->get_status_name();
770         }
771     }
772     return $badges;
775 /**
776  * Get badges for a specific user.
777  *
778  * @param int $userid User ID
779  * @param int $courseid Badges earned by a user in a specific course
780  * @param int $page The page or records to return
781  * @param int $perpage The number of records to return per page
782  * @param string $search A simple string to search for
783  * @param bool $onlypublic Return only public badges
784  * @return array of badges ordered by decreasing date of issue
785  */
786 function badges_get_user_badges($userid, $courseid = 0, $page = 0, $perpage = 0, $search = '', $onlypublic = false) {
787     global $DB;
788     $badges = array();
790     $params[] = $userid;
791     $sql = 'SELECT
792                 bi.uniquehash,
793                 bi.dateissued,
794                 bi.dateexpire,
795                 bi.id as issuedid,
796                 bi.visible,
797                 u.email,
798                 b.*
799             FROM
800                 {badge} b,
801                 {badge_issued} bi,
802                 {user} u
803             WHERE b.id = bi.badgeid
804                 AND u.id = bi.userid
805                 AND bi.userid = ?';
807     if (!empty($search)) {
808         $sql .= ' AND (' . $DB->sql_like('b.name', '?', false) . ') ';
809         $params[] = "%$search%";
810     }
811     if ($onlypublic) {
812         $sql .= ' AND (bi.visible = 1) ';
813     }
815     if ($courseid != 0) {
816         $sql .= ' AND (b.courseid = ' . $courseid . ') ';
817     }
818     $sql .= ' ORDER BY bi.dateissued DESC';
819     $badges = $DB->get_records_sql($sql, $params, $page * $perpage, $perpage);
821     return $badges;
824 /**
825  * Get issued badge details for assertion URL
826  *
827  * @param string $hash
828  */
829 function badges_get_issued_badge_info($hash) {
830     global $DB, $CFG;
832     $a = array();
834     $record = $DB->get_record_sql('
835             SELECT
836                 bi.dateissued,
837                 bi.dateexpire,
838                 u.email,
839                 b.*,
840                 bb.email as backpackemail
841             FROM
842                 {badge} b
843                 JOIN {badge_issued} bi
844                     ON b.id = bi.badgeid
845                 JOIN {user} u
846                     ON u.id = bi.userid
847                 LEFT JOIN {badge_backpack} bb
848                     ON bb.userid = bi.userid
849             WHERE ' . $DB->sql_compare_text('bi.uniquehash', 40) . ' = ' . $DB->sql_compare_text(':hash', 40),
850             array('hash' => $hash), IGNORE_MISSING);
852     if ($record) {
853         if ($record->type == BADGE_TYPE_SITE) {
854             $context = context_system::instance();
855         } else {
856             $context = context_course::instance($record->courseid);
857         }
859         $url = new moodle_url('/badges/badge.php', array('hash' => $hash));
860         $email = empty($record->backpackemail) ? $record->email : $record->backpackemail;
862         // Recipient's email is hashed: <algorithm>$<hash(email + salt)>.
863         $a['recipient'] = 'sha256$' . hash('sha256', $email . $CFG->badges_badgesalt);
864         $a['salt'] = $CFG->badges_badgesalt;
866         if ($record->dateexpire) {
867             $a['expires'] = date('Y-m-d', $record->dateexpire);
868         }
870         $a['issued_on'] = date('Y-m-d', $record->dateissued);
871         $a['evidence'] = $url->out(); // Issued badge URL.
872         $a['badge'] = array();
873         $a['badge']['version'] = '0.5.0'; // Version of OBI specification, 0.5.0 - current beta.
874         $a['badge']['name'] = $record->name;
875         $a['badge']['image'] = moodle_url::make_pluginfile_url($context->id, 'badges', 'badgeimage', $record->id, '/', 'f1')->out();
876         $a['badge']['description'] = $record->description;
877         $a['badge']['criteria'] = $url->out(); // Issued badge URL.
878         $a['badge']['issuer'] = array();
879         $a['badge']['issuer']['origin'] = $record->issuerurl;
880         $a['badge']['issuer']['name'] = $record->issuername;
881         $a['badge']['issuer']['contact'] = $record->issuercontact;
882     }
884     return $a;
887 /**
888  * Extends the course administration navigation with the Badges page
889  *
890  * @param navigation_node $coursenode
891  * @param object $course
892  */
893 function badges_add_course_navigation(navigation_node $coursenode, stdClass $course) {
894     global $CFG, $SITE;
896     $coursecontext = context_course::instance($course->id);
897     $isfrontpage = (!$coursecontext || $course->id == $SITE->id);
898     $canmanage = has_any_capability(array('moodle/badges:viewawarded',
899                                           'moodle/badges:createbadge',
900                                           'moodle/badges:awardbadge',
901                                           'moodle/badges:configurecriteria',
902                                           'moodle/badges:configuremessages',
903                                           'moodle/badges:configuredetails',
904                                           'moodle/badges:deletebadge'), $coursecontext);
906     if (!empty($CFG->enablebadges) && !empty($CFG->badges_allowcoursebadges) && !$isfrontpage && $canmanage) {
907         $coursenode->add(get_string('coursebadges', 'badges'), null,
908                 navigation_node::TYPE_CONTAINER, null, 'coursebadges',
909                 new pix_icon('i/badge', get_string('coursebadges', 'badges')));
911         $url = new moodle_url('/badges/index.php', array('type' => BADGE_TYPE_COURSE, 'id' => $course->id));
913         $coursenode->get('coursebadges')->add(get_string('managebadges', 'badges'), $url,
914             navigation_node::TYPE_SETTING, null, 'coursebadges');
916         if (has_capability('moodle/badges:createbadge', $coursecontext)) {
917             $url = new moodle_url('/badges/newbadge.php', array('type' => BADGE_TYPE_COURSE, 'id' => $course->id));
919             $coursenode->get('coursebadges')->add(get_string('newbadge', 'badges'), $url,
920                     navigation_node::TYPE_SETTING, null, 'newbadge');
921         }
922     }
925 /**
926  * Triggered when badge is manually awarded.
927  *
928  * @param   object      $data
929  * @return  boolean
930  */
931 function badges_award_handle_manual_criteria_review(stdClass $data) {
932     $criteria = $data->crit;
933     $userid = $data->userid;
934     $badge = new badge($criteria->badgeid);
936     if (!$badge->is_active() || $badge->is_issued($userid)) {
937         return true;
938     }
940     if ($criteria->review($userid)) {
941         $criteria->mark_complete($userid);
943         if ($badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->review($userid)) {
944             $badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($userid);
945             $badge->issue($userid);
946         }
947     }
949     return true;
952 /**
953  * Process badge image from form data
954  *
955  * @param badge $badge Badge object
956  * @param string $iconfile Original file
957  */
958 function badges_process_badge_image(badge $badge, $iconfile) {
959     global $CFG, $USER;
960     require_once($CFG->libdir. '/gdlib.php');
962     if (!empty($CFG->gdversion)) {
963         process_new_icon($badge->get_context(), 'badges', 'badgeimage', $badge->id, $iconfile);
964         @unlink($iconfile);
966         // Clean up file draft area after badge image has been saved.
967         $context = context_user::instance($USER->id, MUST_EXIST);
968         $fs = get_file_storage();
969         $fs->delete_area_files($context->id, 'user', 'draft');
970     }
973 /**
974  * Print badge image.
975  *
976  * @param badge $badge Badge object
977  * @param stdClass $context
978  * @param string $size
979  */
980 function print_badge_image(badge $badge, stdClass $context, $size = 'small') {
981     $fsize = ($size == 'small') ? 'f2' : 'f1';
983     $imageurl = moodle_url::make_pluginfile_url($context->id, 'badges', 'badgeimage', $badge->id, '/', $fsize, false);
984     // Appending a random parameter to image link to forse browser reload the image.
985     $imageurl->param('refresh', rand(1, 10000));
986     $attributes = array('src' => $imageurl, 'alt' => s($badge->name), 'class' => 'activatebadge');
988     return html_writer::empty_tag('img', $attributes);
991 /**
992  * Bake issued badge.
993  *
994  * @param string $hash Unique hash of an issued badge.
995  * @param int $badgeid ID of the original badge.
996  * @param int $userid ID of badge recipient (optional).
997  * @param boolean $pathhash Return file pathhash instead of image url (optional).
998  * @return string|url Returns either new file path hash or new file URL
999  */
1000 function badges_bake($hash, $badgeid, $userid = 0, $pathhash = false) {
1001     global $CFG, $USER;
1002     require_once(dirname(dirname(__FILE__)) . '/badges/lib/bakerlib.php');
1004     $badge = new badge($badgeid);
1005     $badge_context = $badge->get_context();
1006     $userid = ($userid) ? $userid : $USER->id;
1007     $user_context = context_user::instance($userid);
1009     $fs = get_file_storage();
1010     if (!$fs->file_exists($user_context->id, 'badges', 'userbadge', $badge->id, '/', $hash . '.png')) {
1011         if ($file = $fs->get_file($badge_context->id, 'badges', 'badgeimage', $badge->id, '/', 'f1.png')) {
1012             $contents = $file->get_content();
1014             $filehandler = new PNG_MetaDataHandler($contents);
1015             $assertion = new moodle_url('/badges/assertion.php', array('b' => $hash));
1016             if ($filehandler->check_chunks("tEXt", "openbadges")) {
1017                 // Add assertion URL tExt chunk.
1018                 $newcontents = $filehandler->add_chunks("tEXt", "openbadges", $assertion->out(false));
1019                 $fileinfo = array(
1020                         'contextid' => $user_context->id,
1021                         'component' => 'badges',
1022                         'filearea' => 'userbadge',
1023                         'itemid' => $badge->id,
1024                         'filepath' => '/',
1025                         'filename' => $hash . '.png',
1026                 );
1028                 // Create a file with added contents.
1029                 $newfile = $fs->create_file_from_string($fileinfo, $newcontents);
1030                 if ($pathhash) {
1031                     return $newfile->get_pathnamehash();
1032                 }
1033             }
1034         } else {
1035             debugging('Error baking badge image!');
1036         }
1037     }
1039     $fileurl = moodle_url::make_pluginfile_url($user_context->id, 'badges', 'userbadge', $badge->id, '/', $hash, true);
1040     return $fileurl;
1043 /**
1044  * Returns external backpack settings and badges from this backpack.
1045  *
1046  * This function first checks if badges for the user are cached and
1047  * tries to retrieve them from the cache. Otherwise, badges are obtained
1048  * through curl request to the backpack.
1049  *
1050  * @param int $userid Backpack user ID.
1051  * @param boolean $refresh Refresh badges collection in cache.
1052  * @return null|object Returns null is there is no backpack or object with backpack settings.
1053  */
1054 function get_backpack_settings($userid, $refresh = false) {
1055     global $DB;
1056     require_once(dirname(dirname(__FILE__)) . '/badges/lib/backpacklib.php');
1058     // Try to get badges from cache first.
1059     $badgescache = cache::make('core', 'externalbadges');
1060     $out = $badgescache->get($userid);
1061     if ($out !== false && !$refresh) {
1062         return $out;
1063     }
1064     // Get badges through curl request to the backpack.
1065     $record = $DB->get_record('badge_backpack', array('userid' => $userid));
1066     if ($record) {
1067         $backpack = new OpenBadgesBackpackHandler($record);
1068         $out = new stdClass();
1069         $out->backpackurl = $backpack->get_url();
1071         if ($collections = $DB->get_records('badge_external', array('backpackid' => $record->id))) {
1072             $out->totalcollections = count($collections);
1073             $out->totalbadges = 0;
1074             $out->badges = array();
1075             foreach ($collections as $collection) {
1076                 $badges = $backpack->get_badges($collection->collectionid);
1077                 if (isset($badges->badges)) {
1078                     $out->badges = array_merge($out->badges, $badges->badges);
1079                     $out->totalbadges += count($out->badges);
1080                 } else {
1081                     $out->badges = array_merge($out->badges, array());
1082                 }
1083             }
1084         } else {
1085             $out->totalbadges = 0;
1086             $out->totalcollections = 0;
1087         }
1089         $badgescache->set($userid, $out);
1090         return $out;
1091     }
1093     return null;
1096 /**
1097  * Download all user badges in zip archive.
1098  *
1099  * @param int $userid ID of badge owner.
1100  */
1101 function badges_download($userid) {
1102     global $CFG, $DB;
1103     $context = context_user::instance($userid);
1104     $records = $DB->get_records('badge_issued', array('userid' => $userid));
1106     // Get list of files to download.
1107     $fs = get_file_storage();
1108     $filelist = array();
1109     foreach ($records as $issued) {
1110         $badge = new badge($issued->badgeid);
1111         // Need to make image name user-readable and unique using filename safe characters.
1112         $name =  $badge->name . ' ' . userdate($issued->dateissued, '%d %b %Y') . ' ' . hash('crc32', $badge->id);
1113         $name = str_replace(' ', '_', $name);
1114         if ($file = $fs->get_file($context->id, 'badges', 'userbadge', $issued->badgeid, '/', $issued->uniquehash . '.png')) {
1115             $filelist[$name . '.png'] = $file;
1116         }
1117     }
1119     // Zip files and sent them to a user.
1120     $tempzip = tempnam($CFG->tempdir.'/', 'mybadges');
1121     $zipper = new zip_packer();
1122     if ($zipper->archive_to_pathname($filelist, $tempzip)) {
1123         send_temp_file($tempzip, 'badges.zip');
1124     } else {
1125         debugging("Problems with archiving the files.");
1126     }
1129 /**
1130  * Print badges on user profile page.
1131  *
1132  * @param int $userid User ID.
1133  * @param int $courseid Course if we need to filter badges (optional).
1134  */
1135 function profile_display_badges($userid, $courseid = 0) {
1136     global $CFG, $PAGE, $USER, $SITE;
1137     require_once($CFG->dirroot . '/badges/renderer.php');
1139     if ($USER->id == $userid || has_capability('moodle/badges:viewotherbadges', context_user::instance($USER->id))) {
1140         $records = badges_get_user_badges($userid, $courseid, null, null, null, true);
1141         $renderer = new core_badges_renderer($PAGE, '');
1143         // Print local badges.
1144         if ($records) {
1145             $left = get_string('localbadgesp', 'badges', $SITE->fullname);
1146             $right = $renderer->print_badges_list($records, $userid, true);
1147             echo html_writer::tag('dt', $left);
1148             echo html_writer::tag('dd', $right);
1149         }
1151         // Print external badges.
1152         if ($courseid == 0 && !empty($CFG->badges_allowexternalbackpack)) {
1153             $backpack = get_backpack_settings($userid);
1154             if (isset($backpack->totalbadges) && $backpack->totalbadges !== 0) {
1155                 $left = get_string('externalbadgesp', 'badges');
1156                 $right = $renderer->print_badges_list($backpack->badges, $userid, true, true);
1157                 echo html_writer::tag('dt', $left);
1158                 echo html_writer::tag('dd', $right);
1159             }
1160         }
1161     }
1164 /**
1165  * Checks if badges can be pushed to external backpack.
1166  *
1167  * @return string Code of backpack accessibility status.
1168  */
1169 function badges_check_backpack_accessibility() {
1170     global $CFG;
1171     include_once $CFG->libdir . '/filelib.php';
1173     // Using fake assertion url to check whether backpack can access the web site.
1174     $fakeassertion = new moodle_url('/badges/assertion.php', array('b' => 'abcd1234567890'));
1176     // Curl request to http://backpack.openbadges.org/baker.
1177     $curl = new curl();
1178     $options = array(
1179         'FRESH_CONNECT' => true,
1180         'RETURNTRANSFER' => true,
1181         'HEADER' => 0,
1182         'CONNECTTIMEOUT' => 2,
1183     );
1184     $location = 'http://backpack.openbadges.org/baker';
1185     $out = $curl->get($location, array('assertion' => $fakeassertion->out(false)), $options);
1187     $data = json_decode($out);
1188     if (!empty($curl->error)) {
1189         return 'curl-request-timeout';
1190     } else {
1191         if (isset($data->code) && $data->code == 'http-unreachable') {
1192             return 'http-unreachable';
1193         } else {
1194             return 'available';
1195         }
1196     }
1198     return false;
1201 /**
1202  * Checks if user has external backpack connected.
1203  *
1204  * @param int $userid ID of a user.
1205  * @return bool True|False whether backpack connection exists.
1206  */
1207 function badges_user_has_backpack($userid) {
1208     global $DB;
1209     return $DB->record_exists('badge_backpack', array('userid' => $userid));
1212 /**
1213  * Handles what happens to the course badges when a course is deleted.
1214  *
1215  * @param int $courseid course ID.
1216  * @return void.
1217  */
1218 function badges_handle_course_deletion($courseid) {
1219     global $CFG, $DB;
1220     include_once $CFG->libdir . '/filelib.php';
1222     $systemcontext = context_system::instance();
1223     $coursecontext = context_course::instance($courseid);
1224     $fs = get_file_storage();
1226     // Move badges images to the system context.
1227     $fs->move_area_files_to_new_context($coursecontext->id, $systemcontext->id, 'badges', 'badgeimage');
1229     // Get all course badges.
1230     $badges = $DB->get_records('badge', array('type' => BADGE_TYPE_COURSE, 'courseid' => $courseid));
1231     foreach ($badges as $badge) {
1232         // Archive badges in this course.
1233         $toupdate = new stdClass();
1234         $toupdate->id = $badge->id;
1235         $toupdate->type = BADGE_TYPE_SITE;
1236         $toupdate->courseid = null;
1237         $toupdate->status = BADGE_STATUS_ARCHIVED;
1238         $DB->update_record('badge', $toupdate);
1239     }
1242 /**
1243  * Loads JS files required for backpack support.
1244  *
1245  * @uses   $CFG, $PAGE
1246  * @return void
1247  */
1248 function badges_setup_backpack_js() {
1249     global $CFG, $PAGE;
1250     if (!empty($CFG->badges_allowexternalbackpack)) {
1251         $PAGE->requires->string_for_js('error:backpackproblem', 'badges');
1252         $protocol = (strpos($CFG->wwwroot, 'https://') === 0) ? 'https://' : 'http://';
1253         $PAGE->requires->js(new moodle_url($protocol . 'backpack.openbadges.org/issuer.js'), true);
1254         $PAGE->requires->js('/badges/backpack.js', true);
1255     }