8d1bf9e5fe33f08fad9d6c738ab5a646a8c74737
[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                 badges_notify_badge_award($this, $userid, $issued->uniquehash, $pathhash);
415             }
416         }
417     }
419     /**
420      * Reviews all badge criteria and checks if badge can be instantly awarded.
421      *
422      * @return int Number of awards
423      */
424     public function review_all_criteria() {
425         global $DB, $CFG;
426         $awards = 0;
428         // Raise timelimit as this could take a while for big web sites.
429         core_php_time_limit::raise();
430         raise_memory_limit(MEMORY_HUGE);
432         foreach ($this->criteria as $crit) {
433             // Overall criterion is decided when other criteria are reviewed.
434             if ($crit->criteriatype == BADGE_CRITERIA_TYPE_OVERALL) {
435                 continue;
436             }
438             list($extrajoin, $extrawhere, $extraparams) = $crit->get_completed_criteria_sql();
439             // For site level badges, get all active site users who can earn this badge and haven't got it yet.
440             if ($this->type == BADGE_TYPE_SITE) {
441                 $sql = "SELECT DISTINCT u.id, bi.badgeid
442                         FROM {user} u
443                         {$extrajoin}
444                         LEFT JOIN {badge_issued} bi
445                             ON u.id = bi.userid AND bi.badgeid = :badgeid
446                         WHERE bi.badgeid IS NULL AND u.id != :guestid AND u.deleted = 0 " . $extrawhere;
447                 $params = array_merge(array('badgeid' => $this->id, 'guestid' => $CFG->siteguest), $extraparams);
448                 $toearn = $DB->get_fieldset_sql($sql, $params);
449             } else {
450                 // For course level badges, get all users who already earned the badge in this course.
451                 // Then find the ones who are enrolled in the course and don't have a badge yet.
452                 $earned = $DB->get_fieldset_select('badge_issued', 'userid AS id', 'badgeid = :badgeid', array('badgeid' => $this->id));
453                 $wheresql = '';
454                 $earnedparams = array();
455                 if (!empty($earned)) {
456                     list($earnedsql, $earnedparams) = $DB->get_in_or_equal($earned, SQL_PARAMS_NAMED, 'u', false);
457                     $wheresql = ' WHERE u.id ' . $earnedsql;
458                 }
459                 list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->get_context(), 'moodle/badges:earnbadge', 0, true);
460                 $sql = "SELECT u.id
461                         FROM {user} u
462                         {$extrajoin}
463                         JOIN ({$enrolledsql}) je ON je.id = u.id " . $wheresql . $extrawhere;
464                 $params = array_merge($enrolledparams, $earnedparams, $extraparams);
465                 $toearn = $DB->get_fieldset_sql($sql, $params);
466             }
468             foreach ($toearn as $uid) {
469                 $reviewoverall = false;
470                 if ($crit->review($uid, true)) {
471                     $crit->mark_complete($uid);
472                     if ($this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->method == BADGE_CRITERIA_AGGREGATION_ANY) {
473                         $this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($uid);
474                         $this->issue($uid);
475                         $awards++;
476                     } else {
477                         $reviewoverall = true;
478                     }
479                 } else {
480                     // Will be reviewed some other time.
481                     $reviewoverall = false;
482                 }
483                 // Review overall if it is required.
484                 if ($reviewoverall && $this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->review($uid)) {
485                     $this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($uid);
486                     $this->issue($uid);
487                     $awards++;
488                 }
489             }
490         }
492         return $awards;
493     }
495     /**
496      * Gets an array of completed criteria from 'badge_criteria_met' table.
497      *
498      * @param int $userid Completions for a user
499      * @return array Records of criteria completions
500      */
501     public function get_criteria_completions($userid) {
502         global $DB;
503         $completions = array();
504         $sql = "SELECT bcm.id, bcm.critid
505                 FROM {badge_criteria_met} bcm
506                     INNER JOIN {badge_criteria} bc ON bcm.critid = bc.id
507                 WHERE bc.badgeid = :badgeid AND bcm.userid = :userid ";
508         $completions = $DB->get_records_sql($sql, array('badgeid' => $this->id, 'userid' => $userid));
510         return $completions;
511     }
513     /**
514      * Checks if badges has award criteria set up.
515      *
516      * @return bool A status indicating badge has at least one criterion
517      */
518     public function has_criteria() {
519         if (count($this->criteria) > 0) {
520             return true;
521         }
522         return false;
523     }
525     /**
526      * Returns badge award criteria
527      *
528      * @return array An array of badge criteria
529      */
530     public function get_criteria() {
531         global $DB;
532         $criteria = array();
534         if ($records = (array)$DB->get_records('badge_criteria', array('badgeid' => $this->id))) {
535             foreach ($records as $record) {
536                 $criteria[$record->criteriatype] = award_criteria::build((array)$record);
537             }
538         }
540         return $criteria;
541     }
543     /**
544      * Get aggregation method for badge criteria
545      *
546      * @param int $criteriatype If none supplied, get overall aggregation method (optional)
547      * @return int One of BADGE_CRITERIA_AGGREGATION_ALL or BADGE_CRITERIA_AGGREGATION_ANY
548      */
549     public function get_aggregation_method($criteriatype = 0) {
550         global $DB;
551         $params = array('badgeid' => $this->id, 'criteriatype' => $criteriatype);
552         $aggregation = $DB->get_field('badge_criteria', 'method', $params, IGNORE_MULTIPLE);
554         if (!$aggregation) {
555             return BADGE_CRITERIA_AGGREGATION_ALL;
556         }
558         return $aggregation;
559     }
561     /**
562      * Checks if badge has expiry period or date set up.
563      *
564      * @return bool A status indicating badge can expire
565      */
566     public function can_expire() {
567         if ($this->expireperiod || $this->expiredate) {
568             return true;
569         }
570         return false;
571     }
573     /**
574      * Calculates badge expiry date based on either expirydate or expiryperiod.
575      *
576      * @param int $timestamp Time of badge issue
577      * @return int A timestamp
578      */
579     public function calculate_expiry($timestamp) {
580         $expiry = null;
582         if (isset($this->expiredate)) {
583             $expiry = $this->expiredate;
584         } else if (isset($this->expireperiod)) {
585             $expiry = $timestamp + $this->expireperiod;
586         }
588         return $expiry;
589     }
591     /**
592      * Checks if badge has manual award criteria set.
593      *
594      * @return bool A status indicating badge can be awarded manually
595      */
596     public function has_manual_award_criteria() {
597         foreach ($this->criteria as $criterion) {
598             if ($criterion->criteriatype == BADGE_CRITERIA_TYPE_MANUAL) {
599                 return true;
600             }
601         }
602         return false;
603     }
605     /**
606      * Marks the badge as archived.
607      * For reporting and historical purposed we cannot completely delete badges.
608      * We will just change their status to BADGE_STATUS_ARCHIVED.
609      */
610     public function delete() {
611         $this->status = BADGE_STATUS_ARCHIVED;
612         $this->save();
613     }
616 /**
617  * Sends notifications to users about awarded badges.
618  *
619  * @param badge $badge Badge that was issued
620  * @param int $userid Recipient ID
621  * @param string $issued Unique hash of an issued badge
622  * @param string $filepathhash File path hash of an issued badge for attachments
623  */
624 function badges_notify_badge_award(badge $badge, $userid, $issued, $filepathhash) {
625     global $CFG, $DB;
627     $admin = get_admin();
628     $userfrom = new stdClass();
629     $userfrom->id = $admin->id;
630     $userfrom->email = !empty($CFG->badges_defaultissuercontact) ? $CFG->badges_defaultissuercontact : $admin->email;
631     foreach (get_all_user_name_fields() as $addname) {
632         $userfrom->$addname = !empty($CFG->badges_defaultissuername) ? '' : $admin->$addname;
633     }
634     $userfrom->firstname = !empty($CFG->badges_defaultissuername) ? $CFG->badges_defaultissuername : $admin->firstname;
635     $userfrom->maildisplay = true;
637     $issuedlink = html_writer::link(new moodle_url('/badges/badge.php', array('hash' => $issued)), $badge->name);
638     $userto = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST);
640     $params = new stdClass();
641     $params->badgename = $badge->name;
642     $params->username = fullname($userto);
643     $params->badgelink = $issuedlink;
644     $message = badge_message_from_template($badge->message, $params);
645     $plaintext = format_text_email($message, FORMAT_HTML);
647     // Notify recipient.
648     $eventdata = new stdClass();
649     $eventdata->component         = 'moodle';
650     $eventdata->name              = 'badgerecipientnotice';
651     $eventdata->userfrom          = $userfrom;
652     $eventdata->userto            = $userto;
653     $eventdata->notification      = 1;
654     $eventdata->subject           = $badge->messagesubject;
655     $eventdata->fullmessage       = $plaintext;
656     $eventdata->fullmessageformat = FORMAT_PLAIN;
657     $eventdata->fullmessagehtml   = $message;
658     $eventdata->smallmessage      = $plaintext;
660     // Attach badge image if possible.
661     if (!empty($CFG->allowattachments) && $badge->attachment && is_string($filepathhash)) {
662         $fs = get_file_storage();
663         $file = $fs->get_file_by_hash($filepathhash);
664         $eventdata->attachment = $file;
665         $eventdata->attachname = str_replace(' ', '_', $badge->name) . ".png";
667         message_send($eventdata);
668     } else {
669         message_send($eventdata);
670     }
672     // Notify badge creator about the award if they receive notifications every time.
673     if ($badge->notification == 1) {
674         $userfrom = core_user::get_noreply_user();
675         $userfrom->maildisplay = true;
677         $creator = $DB->get_record('user', array('id' => $badge->usercreated), '*', MUST_EXIST);
678         $a = new stdClass();
679         $a->user = fullname($userto);
680         $a->link = $issuedlink;
681         $creatormessage = get_string('creatorbody', 'badges', $a);
682         $creatorsubject = get_string('creatorsubject', 'badges', $badge->name);
684         $eventdata = new stdClass();
685         $eventdata->component         = 'moodle';
686         $eventdata->name              = 'badgecreatornotice';
687         $eventdata->userfrom          = $userfrom;
688         $eventdata->userto            = $creator;
689         $eventdata->notification      = 1;
690         $eventdata->subject           = $creatorsubject;
691         $eventdata->fullmessage       = format_text_email($creatormessage, FORMAT_HTML);
692         $eventdata->fullmessageformat = FORMAT_PLAIN;
693         $eventdata->fullmessagehtml   = $creatormessage;
694         $eventdata->smallmessage      = $creatorsubject;
696         message_send($eventdata);
697         $DB->set_field('badge_issued', 'issuernotified', time(), array('badgeid' => $badge->id, 'userid' => $userid));
698     }
701 /**
702  * Caclulates date for the next message digest to badge creators.
703  *
704  * @param in $schedule Type of message schedule BADGE_MESSAGE_DAILY|BADGE_MESSAGE_WEEKLY|BADGE_MESSAGE_MONTHLY.
705  * @return int Timestamp for next cron
706  */
707 function badges_calculate_message_schedule($schedule) {
708     $nextcron = 0;
710     switch ($schedule) {
711         case BADGE_MESSAGE_DAILY:
712             $nextcron = time() + 60 * 60 * 24;
713             break;
714         case BADGE_MESSAGE_WEEKLY:
715             $nextcron = time() + 60 * 60 * 24 * 7;
716             break;
717         case BADGE_MESSAGE_MONTHLY:
718             $nextcron = time() + 60 * 60 * 24 * 7 * 30;
719             break;
720     }
722     return $nextcron;
725 /**
726  * Replaces variables in a message template and returns text ready to be emailed to a user.
727  *
728  * @param string $message Message body.
729  * @return string Message with replaced values
730  */
731 function badge_message_from_template($message, $params) {
732     $msg = $message;
733     foreach ($params as $key => $value) {
734         $msg = str_replace("%$key%", $value, $msg);
735     }
737     return $msg;
740 /**
741  * Get all badges.
742  *
743  * @param int Type of badges to return
744  * @param int Course ID for course badges
745  * @param string $sort An SQL field to sort by
746  * @param string $dir The sort direction ASC|DESC
747  * @param int $page The page or records to return
748  * @param int $perpage The number of records to return per page
749  * @param int $user User specific search
750  * @return array $badge Array of records matching criteria
751  */
752 function badges_get_badges($type, $courseid = 0, $sort = '', $dir = '', $page = 0, $perpage = BADGE_PERPAGE, $user = 0) {
753     global $DB;
754     $records = array();
755     $params = array();
756     $where = "b.status != :deleted AND b.type = :type ";
757     $params['deleted'] = BADGE_STATUS_ARCHIVED;
759     $userfields = array('b.id, b.name, b.status');
760     $usersql = "";
761     if ($user != 0) {
762         $userfields[] = 'bi.dateissued';
763         $userfields[] = 'bi.uniquehash';
764         $usersql = " LEFT JOIN {badge_issued} bi ON b.id = bi.badgeid AND bi.userid = :userid ";
765         $params['userid'] = $user;
766         $where .= " AND (b.status = 1 OR b.status = 3) ";
767     }
768     $fields = implode(', ', $userfields);
770     if ($courseid != 0 ) {
771         $where .= "AND b.courseid = :courseid ";
772         $params['courseid'] = $courseid;
773     }
775     $sorting = (($sort != '' && $dir != '') ? 'ORDER BY ' . $sort . ' ' . $dir : '');
776     $params['type'] = $type;
778     $sql = "SELECT $fields FROM {badge} b $usersql WHERE $where $sorting";
779     $records = $DB->get_records_sql($sql, $params, $page * $perpage, $perpage);
781     $badges = array();
782     foreach ($records as $r) {
783         $badge = new badge($r->id);
784         $badges[$r->id] = $badge;
785         if ($user != 0) {
786             $badges[$r->id]->dateissued = $r->dateissued;
787             $badges[$r->id]->uniquehash = $r->uniquehash;
788         } else {
789             $badges[$r->id]->awards = $DB->count_records('badge_issued', array('badgeid' => $badge->id));
790             $badges[$r->id]->statstring = $badge->get_status_name();
791         }
792     }
793     return $badges;
796 /**
797  * Get badges for a specific user.
798  *
799  * @param int $userid User ID
800  * @param int $courseid Badges earned by a user in a specific course
801  * @param int $page The page or records to return
802  * @param int $perpage The number of records to return per page
803  * @param string $search A simple string to search for
804  * @param bool $onlypublic Return only public badges
805  * @return array of badges ordered by decreasing date of issue
806  */
807 function badges_get_user_badges($userid, $courseid = 0, $page = 0, $perpage = 0, $search = '', $onlypublic = false) {
808     global $DB;
809     $badges = array();
811     $params[] = $userid;
812     $sql = 'SELECT
813                 bi.uniquehash,
814                 bi.dateissued,
815                 bi.dateexpire,
816                 bi.id as issuedid,
817                 bi.visible,
818                 u.email,
819                 b.*
820             FROM
821                 {badge} b,
822                 {badge_issued} bi,
823                 {user} u
824             WHERE b.id = bi.badgeid
825                 AND u.id = bi.userid
826                 AND bi.userid = ?';
828     if (!empty($search)) {
829         $sql .= ' AND (' . $DB->sql_like('b.name', '?', false) . ') ';
830         $params[] = "%$search%";
831     }
832     if ($onlypublic) {
833         $sql .= ' AND (bi.visible = 1) ';
834     }
836     if ($courseid != 0) {
837         $sql .= ' AND (b.courseid = ' . $courseid . ') ';
838     }
839     $sql .= ' ORDER BY bi.dateissued DESC';
840     $badges = $DB->get_records_sql($sql, $params, $page * $perpage, $perpage);
842     return $badges;
845 /**
846  * Extends the course administration navigation with the Badges page
847  *
848  * @param navigation_node $coursenode
849  * @param object $course
850  */
851 function badges_add_course_navigation(navigation_node $coursenode, stdClass $course) {
852     global $CFG, $SITE;
854     $coursecontext = context_course::instance($course->id);
855     $isfrontpage = (!$coursecontext || $course->id == $SITE->id);
856     $canmanage = has_any_capability(array('moodle/badges:viewawarded',
857                                           'moodle/badges:createbadge',
858                                           'moodle/badges:awardbadge',
859                                           'moodle/badges:configurecriteria',
860                                           'moodle/badges:configuremessages',
861                                           'moodle/badges:configuredetails',
862                                           'moodle/badges:deletebadge'), $coursecontext);
864     if (!empty($CFG->enablebadges) && !empty($CFG->badges_allowcoursebadges) && !$isfrontpage && $canmanage) {
865         $coursenode->add(get_string('coursebadges', 'badges'), null,
866                 navigation_node::TYPE_CONTAINER, null, 'coursebadges',
867                 new pix_icon('i/badge', get_string('coursebadges', 'badges')));
869         $url = new moodle_url('/badges/index.php', array('type' => BADGE_TYPE_COURSE, 'id' => $course->id));
871         $coursenode->get('coursebadges')->add(get_string('managebadges', 'badges'), $url,
872             navigation_node::TYPE_SETTING, null, 'coursebadges');
874         if (has_capability('moodle/badges:createbadge', $coursecontext)) {
875             $url = new moodle_url('/badges/newbadge.php', array('type' => BADGE_TYPE_COURSE, 'id' => $course->id));
877             $coursenode->get('coursebadges')->add(get_string('newbadge', 'badges'), $url,
878                     navigation_node::TYPE_SETTING, null, 'newbadge');
879         }
880     }
883 /**
884  * Triggered when badge is manually awarded.
885  *
886  * @param   object      $data
887  * @return  boolean
888  */
889 function badges_award_handle_manual_criteria_review(stdClass $data) {
890     $criteria = $data->crit;
891     $userid = $data->userid;
892     $badge = new badge($criteria->badgeid);
894     if (!$badge->is_active() || $badge->is_issued($userid)) {
895         return true;
896     }
898     if ($criteria->review($userid)) {
899         $criteria->mark_complete($userid);
901         if ($badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->review($userid)) {
902             $badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($userid);
903             $badge->issue($userid);
904         }
905     }
907     return true;
910 /**
911  * Process badge image from form data
912  *
913  * @param badge $badge Badge object
914  * @param string $iconfile Original file
915  */
916 function badges_process_badge_image(badge $badge, $iconfile) {
917     global $CFG, $USER;
918     require_once($CFG->libdir. '/gdlib.php');
920     if (!empty($CFG->gdversion)) {
921         process_new_icon($badge->get_context(), 'badges', 'badgeimage', $badge->id, $iconfile);
922         @unlink($iconfile);
924         // Clean up file draft area after badge image has been saved.
925         $context = context_user::instance($USER->id, MUST_EXIST);
926         $fs = get_file_storage();
927         $fs->delete_area_files($context->id, 'user', 'draft');
928     }
931 /**
932  * Print badge image.
933  *
934  * @param badge $badge Badge object
935  * @param stdClass $context
936  * @param string $size
937  */
938 function print_badge_image(badge $badge, stdClass $context, $size = 'small') {
939     $fsize = ($size == 'small') ? 'f2' : 'f1';
941     $imageurl = moodle_url::make_pluginfile_url($context->id, 'badges', 'badgeimage', $badge->id, '/', $fsize, false);
942     // Appending a random parameter to image link to forse browser reload the image.
943     $imageurl->param('refresh', rand(1, 10000));
944     $attributes = array('src' => $imageurl, 'alt' => s($badge->name), 'class' => 'activatebadge');
946     return html_writer::empty_tag('img', $attributes);
949 /**
950  * Bake issued badge.
951  *
952  * @param string $hash Unique hash of an issued badge.
953  * @param int $badgeid ID of the original badge.
954  * @param int $userid ID of badge recipient (optional).
955  * @param boolean $pathhash Return file pathhash instead of image url (optional).
956  * @return string|url Returns either new file path hash or new file URL
957  */
958 function badges_bake($hash, $badgeid, $userid = 0, $pathhash = false) {
959     global $CFG, $USER;
960     require_once(dirname(dirname(__FILE__)) . '/badges/lib/bakerlib.php');
962     $badge = new badge($badgeid);
963     $badge_context = $badge->get_context();
964     $userid = ($userid) ? $userid : $USER->id;
965     $user_context = context_user::instance($userid);
967     $fs = get_file_storage();
968     if (!$fs->file_exists($user_context->id, 'badges', 'userbadge', $badge->id, '/', $hash . '.png')) {
969         if ($file = $fs->get_file($badge_context->id, 'badges', 'badgeimage', $badge->id, '/', 'f1.png')) {
970             $contents = $file->get_content();
972             $filehandler = new PNG_MetaDataHandler($contents);
973             $assertion = new moodle_url('/badges/assertion.php', array('b' => $hash));
974             if ($filehandler->check_chunks("tEXt", "openbadges")) {
975                 // Add assertion URL tExt chunk.
976                 $newcontents = $filehandler->add_chunks("tEXt", "openbadges", $assertion->out(false));
977                 $fileinfo = array(
978                         'contextid' => $user_context->id,
979                         'component' => 'badges',
980                         'filearea' => 'userbadge',
981                         'itemid' => $badge->id,
982                         'filepath' => '/',
983                         'filename' => $hash . '.png',
984                 );
986                 // Create a file with added contents.
987                 $newfile = $fs->create_file_from_string($fileinfo, $newcontents);
988                 if ($pathhash) {
989                     return $newfile->get_pathnamehash();
990                 }
991             }
992         } else {
993             debugging('Error baking badge image!', DEBUG_DEVELOPER);
994             return;
995         }
996     }
998     // If file exists and we just need its path hash, return it.
999     if ($pathhash) {
1000         $file = $fs->get_file($user_context->id, 'badges', 'userbadge', $badge->id, '/', $hash . '.png');
1001         return $file->get_pathnamehash();
1002     }
1004     $fileurl = moodle_url::make_pluginfile_url($user_context->id, 'badges', 'userbadge', $badge->id, '/', $hash, true);
1005     return $fileurl;
1008 /**
1009  * Returns external backpack settings and badges from this backpack.
1010  *
1011  * This function first checks if badges for the user are cached and
1012  * tries to retrieve them from the cache. Otherwise, badges are obtained
1013  * through curl request to the backpack.
1014  *
1015  * @param int $userid Backpack user ID.
1016  * @param boolean $refresh Refresh badges collection in cache.
1017  * @return null|object Returns null is there is no backpack or object with backpack settings.
1018  */
1019 function get_backpack_settings($userid, $refresh = false) {
1020     global $DB;
1021     require_once(dirname(dirname(__FILE__)) . '/badges/lib/backpacklib.php');
1023     // Try to get badges from cache first.
1024     $badgescache = cache::make('core', 'externalbadges');
1025     $out = $badgescache->get($userid);
1026     if ($out !== false && !$refresh) {
1027         return $out;
1028     }
1029     // Get badges through curl request to the backpack.
1030     $record = $DB->get_record('badge_backpack', array('userid' => $userid));
1031     if ($record) {
1032         $backpack = new OpenBadgesBackpackHandler($record);
1033         $out = new stdClass();
1034         $out->backpackurl = $backpack->get_url();
1036         if ($collections = $DB->get_records('badge_external', array('backpackid' => $record->id))) {
1037             $out->totalcollections = count($collections);
1038             $out->totalbadges = 0;
1039             $out->badges = array();
1040             foreach ($collections as $collection) {
1041                 $badges = $backpack->get_badges($collection->collectionid);
1042                 if (isset($badges->badges)) {
1043                     $out->badges = array_merge($out->badges, $badges->badges);
1044                     $out->totalbadges += count($out->badges);
1045                 } else {
1046                     $out->badges = array_merge($out->badges, array());
1047                 }
1048             }
1049         } else {
1050             $out->totalbadges = 0;
1051             $out->totalcollections = 0;
1052         }
1054         $badgescache->set($userid, $out);
1055         return $out;
1056     }
1058     return null;
1061 /**
1062  * Download all user badges in zip archive.
1063  *
1064  * @param int $userid ID of badge owner.
1065  */
1066 function badges_download($userid) {
1067     global $CFG, $DB;
1068     $context = context_user::instance($userid);
1069     $records = $DB->get_records('badge_issued', array('userid' => $userid));
1071     // Get list of files to download.
1072     $fs = get_file_storage();
1073     $filelist = array();
1074     foreach ($records as $issued) {
1075         $badge = new badge($issued->badgeid);
1076         // Need to make image name user-readable and unique using filename safe characters.
1077         $name =  $badge->name . ' ' . userdate($issued->dateissued, '%d %b %Y') . ' ' . hash('crc32', $badge->id);
1078         $name = str_replace(' ', '_', $name);
1079         if ($file = $fs->get_file($context->id, 'badges', 'userbadge', $issued->badgeid, '/', $issued->uniquehash . '.png')) {
1080             $filelist[$name . '.png'] = $file;
1081         }
1082     }
1084     // Zip files and sent them to a user.
1085     $tempzip = tempnam($CFG->tempdir.'/', 'mybadges');
1086     $zipper = new zip_packer();
1087     if ($zipper->archive_to_pathname($filelist, $tempzip)) {
1088         send_temp_file($tempzip, 'badges.zip');
1089     } else {
1090         debugging("Problems with archiving the files.");
1091     }
1094 /**
1095  * Print badges on user profile page.
1096  *
1097  * @param int $userid User ID.
1098  * @param int $courseid Course if we need to filter badges (optional).
1099  */
1100 function profile_display_badges($userid, $courseid = 0) {
1101     global $CFG, $PAGE, $USER, $SITE;
1102     require_once($CFG->dirroot . '/badges/renderer.php');
1104     // Determine context.
1105     if (isloggedin()) {
1106         $context = context_user::instance($USER->id);
1107     } else {
1108         $context = context_system::instance();
1109     }
1111     if ($USER->id == $userid || has_capability('moodle/badges:viewotherbadges', $context)) {
1112         $records = badges_get_user_badges($userid, $courseid, null, null, null, true);
1113         $renderer = new core_badges_renderer($PAGE, '');
1115         // Print local badges.
1116         if ($records) {
1117             $left = get_string('localbadgesp', 'badges', format_string($SITE->fullname));
1118             $right = $renderer->print_badges_list($records, $userid, true);
1119             echo html_writer::tag('dt', $left);
1120             echo html_writer::tag('dd', $right);
1121         }
1123         // Print external badges.
1124         if ($courseid == 0 && !empty($CFG->badges_allowexternalbackpack)) {
1125             $backpack = get_backpack_settings($userid);
1126             if (isset($backpack->totalbadges) && $backpack->totalbadges !== 0) {
1127                 $left = get_string('externalbadgesp', 'badges');
1128                 $right = $renderer->print_badges_list($backpack->badges, $userid, true, true);
1129                 echo html_writer::tag('dt', $left);
1130                 echo html_writer::tag('dd', $right);
1131             }
1132         }
1133     }
1136 /**
1137  * Checks if badges can be pushed to external backpack.
1138  *
1139  * @return string Code of backpack accessibility status.
1140  */
1141 function badges_check_backpack_accessibility() {
1142     global $CFG;
1143     include_once $CFG->libdir . '/filelib.php';
1145     // Using fake assertion url to check whether backpack can access the web site.
1146     $fakeassertion = new moodle_url('/badges/assertion.php', array('b' => 'abcd1234567890'));
1148     // Curl request to http://backpack.openbadges.org/baker.
1149     $curl = new curl();
1150     $options = array(
1151         'FRESH_CONNECT' => true,
1152         'RETURNTRANSFER' => true,
1153         'HEADER' => 0,
1154         'CONNECTTIMEOUT' => 2,
1155     );
1156     $location = 'http://backpack.openbadges.org/baker';
1157     $out = $curl->get($location, array('assertion' => $fakeassertion->out(false)), $options);
1159     $data = json_decode($out);
1160     if (!empty($curl->error)) {
1161         return 'curl-request-timeout';
1162     } else {
1163         if (isset($data->code) && $data->code == 'http-unreachable') {
1164             return 'http-unreachable';
1165         } else {
1166             return 'available';
1167         }
1168     }
1170     return false;
1173 /**
1174  * Checks if user has external backpack connected.
1175  *
1176  * @param int $userid ID of a user.
1177  * @return bool True|False whether backpack connection exists.
1178  */
1179 function badges_user_has_backpack($userid) {
1180     global $DB;
1181     return $DB->record_exists('badge_backpack', array('userid' => $userid));
1184 /**
1185  * Handles what happens to the course badges when a course is deleted.
1186  *
1187  * @param int $courseid course ID.
1188  * @return void.
1189  */
1190 function badges_handle_course_deletion($courseid) {
1191     global $CFG, $DB;
1192     include_once $CFG->libdir . '/filelib.php';
1194     $systemcontext = context_system::instance();
1195     $coursecontext = context_course::instance($courseid);
1196     $fs = get_file_storage();
1198     // Move badges images to the system context.
1199     $fs->move_area_files_to_new_context($coursecontext->id, $systemcontext->id, 'badges', 'badgeimage');
1201     // Get all course badges.
1202     $badges = $DB->get_records('badge', array('type' => BADGE_TYPE_COURSE, 'courseid' => $courseid));
1203     foreach ($badges as $badge) {
1204         // Archive badges in this course.
1205         $toupdate = new stdClass();
1206         $toupdate->id = $badge->id;
1207         $toupdate->type = BADGE_TYPE_SITE;
1208         $toupdate->courseid = null;
1209         $toupdate->status = BADGE_STATUS_ARCHIVED;
1210         $DB->update_record('badge', $toupdate);
1211     }
1214 /**
1215  * Loads JS files required for backpack support.
1216  *
1217  * @uses   $CFG, $PAGE
1218  * @return void
1219  */
1220 function badges_setup_backpack_js() {
1221     global $CFG, $PAGE;
1222     if (!empty($CFG->badges_allowexternalbackpack)) {
1223         $PAGE->requires->string_for_js('error:backpackproblem', 'badges');
1224         $protocol = (strpos($CFG->wwwroot, 'https://') === 0) ? 'https://' : 'http://';
1225         $PAGE->requires->js(new moodle_url($protocol . 'backpack.openbadges.org/issuer.js'), true);
1226         $PAGE->requires->js('/badges/backpack.js', true);
1227     }