Merge branch 'master_MDL-43247' of git://github.com/danmarsden/moodle
[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         $awarded = $DB->record_exists_sql('SELECT b.uniquehash
335                     FROM {badge_issued} b INNER JOIN {user} u ON b.userid = u.id
336                     WHERE b.badgeid = :badgeid AND u.deleted = 0', array('badgeid' => $this->id));
338         return $awarded;
339     }
341     /**
342      * Gets list of users who have earned an instance of this badge.
343      *
344      * @return array An array of objects with information about badge awards.
345      */
346     public function get_awards() {
347         global $DB;
349         $awards = $DB->get_records_sql(
350                 'SELECT b.userid, b.dateissued, b.uniquehash, u.firstname, u.lastname
351                     FROM {badge_issued} b INNER JOIN {user} u
352                         ON b.userid = u.id
353                     WHERE b.badgeid = :badgeid AND u.deleted = 0', array('badgeid' => $this->id));
355         return $awards;
356     }
358     /**
359      * Indicates whether badge has already been issued to a user.
360      *
361      */
362     public function is_issued($userid) {
363         global $DB;
364         return $DB->record_exists('badge_issued', array('badgeid' => $this->id, 'userid' => $userid));
365     }
367     /**
368      * Issue a badge to user.
369      *
370      * @param int $userid User who earned the badge
371      * @param bool $nobake Not baking actual badges (for testing purposes)
372      */
373     public function issue($userid, $nobake = false) {
374         global $DB, $CFG;
376         $now = time();
377         $issued = new stdClass();
378         $issued->badgeid = $this->id;
379         $issued->userid = $userid;
380         $issued->uniquehash = sha1(rand() . $userid . $this->id . $now);
381         $issued->dateissued = $now;
383         if ($this->can_expire()) {
384             $issued->dateexpire = $this->calculate_expiry($now);
385         } else {
386             $issued->dateexpire = null;
387         }
389         // Take into account user badges privacy settings.
390         // If none set, badges default visibility is set to public.
391         $issued->visible = get_user_preferences('badgeprivacysetting', 1, $userid);
393         $result = $DB->insert_record('badge_issued', $issued, true);
395         if ($result) {
396             // Lock the badge, so that its criteria could not be changed any more.
397             if ($this->status == BADGE_STATUS_ACTIVE) {
398                 $this->set_status(BADGE_STATUS_ACTIVE_LOCKED);
399             }
401             // Update details in criteria_met table.
402             $compl = $this->get_criteria_completions($userid);
403             foreach ($compl as $c) {
404                 $obj = new stdClass();
405                 $obj->id = $c->id;
406                 $obj->issuedid = $result;
407                 $DB->update_record('badge_criteria_met', $obj, true);
408             }
410             if (!$nobake) {
411                 // Bake a badge image.
412                 $pathhash = badges_bake($issued->uniquehash, $this->id, $userid, true);
414                 // Notify recipients and badge creators.
415                 badges_notify_badge_award($this, $userid, $issued->uniquehash, $pathhash);
416             }
417         }
418     }
420     /**
421      * Reviews all badge criteria and checks if badge can be instantly awarded.
422      *
423      * @return int Number of awards
424      */
425     public function review_all_criteria() {
426         global $DB, $CFG;
427         $awards = 0;
429         // Raise timelimit as this could take a while for big web sites.
430         core_php_time_limit::raise();
431         raise_memory_limit(MEMORY_HUGE);
433         foreach ($this->criteria as $crit) {
434             // Overall criterion is decided when other criteria are reviewed.
435             if ($crit->criteriatype == BADGE_CRITERIA_TYPE_OVERALL) {
436                 continue;
437             }
439             list($extrajoin, $extrawhere, $extraparams) = $crit->get_completed_criteria_sql();
440             // For site level badges, get all active site users who can earn this badge and haven't got it yet.
441             if ($this->type == BADGE_TYPE_SITE) {
442                 $sql = "SELECT DISTINCT u.id, bi.badgeid
443                         FROM {user} u
444                         {$extrajoin}
445                         LEFT JOIN {badge_issued} bi
446                             ON u.id = bi.userid AND bi.badgeid = :badgeid
447                         WHERE bi.badgeid IS NULL AND u.id != :guestid AND u.deleted = 0 " . $extrawhere;
448                 $params = array_merge(array('badgeid' => $this->id, 'guestid' => $CFG->siteguest), $extraparams);
449                 $toearn = $DB->get_fieldset_sql($sql, $params);
450             } else {
451                 // For course level badges, get all users who already earned the badge in this course.
452                 // Then find the ones who are enrolled in the course and don't have a badge yet.
453                 $earned = $DB->get_fieldset_select('badge_issued', 'userid AS id', 'badgeid = :badgeid', array('badgeid' => $this->id));
454                 $wheresql = '';
455                 $earnedparams = array();
456                 if (!empty($earned)) {
457                     list($earnedsql, $earnedparams) = $DB->get_in_or_equal($earned, SQL_PARAMS_NAMED, 'u', false);
458                     $wheresql = ' WHERE u.id ' . $earnedsql;
459                 }
460                 list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->get_context(), 'moodle/badges:earnbadge', 0, true);
461                 $sql = "SELECT u.id
462                         FROM {user} u
463                         {$extrajoin}
464                         JOIN ({$enrolledsql}) je ON je.id = u.id " . $wheresql . $extrawhere;
465                 $params = array_merge($enrolledparams, $earnedparams, $extraparams);
466                 $toearn = $DB->get_fieldset_sql($sql, $params);
467             }
469             foreach ($toearn as $uid) {
470                 $reviewoverall = false;
471                 if ($crit->review($uid, true)) {
472                     $crit->mark_complete($uid);
473                     if ($this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->method == BADGE_CRITERIA_AGGREGATION_ANY) {
474                         $this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($uid);
475                         $this->issue($uid);
476                         $awards++;
477                     } else {
478                         $reviewoverall = true;
479                     }
480                 } else {
481                     // Will be reviewed some other time.
482                     $reviewoverall = false;
483                 }
484                 // Review overall if it is required.
485                 if ($reviewoverall && $this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->review($uid)) {
486                     $this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($uid);
487                     $this->issue($uid);
488                     $awards++;
489                 }
490             }
491         }
493         return $awards;
494     }
496     /**
497      * Gets an array of completed criteria from 'badge_criteria_met' table.
498      *
499      * @param int $userid Completions for a user
500      * @return array Records of criteria completions
501      */
502     public function get_criteria_completions($userid) {
503         global $DB;
504         $completions = array();
505         $sql = "SELECT bcm.id, bcm.critid
506                 FROM {badge_criteria_met} bcm
507                     INNER JOIN {badge_criteria} bc ON bcm.critid = bc.id
508                 WHERE bc.badgeid = :badgeid AND bcm.userid = :userid ";
509         $completions = $DB->get_records_sql($sql, array('badgeid' => $this->id, 'userid' => $userid));
511         return $completions;
512     }
514     /**
515      * Checks if badges has award criteria set up.
516      *
517      * @return bool A status indicating badge has at least one criterion
518      */
519     public function has_criteria() {
520         if (count($this->criteria) > 0) {
521             return true;
522         }
523         return false;
524     }
526     /**
527      * Returns badge award criteria
528      *
529      * @return array An array of badge criteria
530      */
531     public function get_criteria() {
532         global $DB;
533         $criteria = array();
535         if ($records = (array)$DB->get_records('badge_criteria', array('badgeid' => $this->id))) {
536             foreach ($records as $record) {
537                 $criteria[$record->criteriatype] = award_criteria::build((array)$record);
538             }
539         }
541         return $criteria;
542     }
544     /**
545      * Get aggregation method for badge criteria
546      *
547      * @param int $criteriatype If none supplied, get overall aggregation method (optional)
548      * @return int One of BADGE_CRITERIA_AGGREGATION_ALL or BADGE_CRITERIA_AGGREGATION_ANY
549      */
550     public function get_aggregation_method($criteriatype = 0) {
551         global $DB;
552         $params = array('badgeid' => $this->id, 'criteriatype' => $criteriatype);
553         $aggregation = $DB->get_field('badge_criteria', 'method', $params, IGNORE_MULTIPLE);
555         if (!$aggregation) {
556             return BADGE_CRITERIA_AGGREGATION_ALL;
557         }
559         return $aggregation;
560     }
562     /**
563      * Checks if badge has expiry period or date set up.
564      *
565      * @return bool A status indicating badge can expire
566      */
567     public function can_expire() {
568         if ($this->expireperiod || $this->expiredate) {
569             return true;
570         }
571         return false;
572     }
574     /**
575      * Calculates badge expiry date based on either expirydate or expiryperiod.
576      *
577      * @param int $timestamp Time of badge issue
578      * @return int A timestamp
579      */
580     public function calculate_expiry($timestamp) {
581         $expiry = null;
583         if (isset($this->expiredate)) {
584             $expiry = $this->expiredate;
585         } else if (isset($this->expireperiod)) {
586             $expiry = $timestamp + $this->expireperiod;
587         }
589         return $expiry;
590     }
592     /**
593      * Checks if badge has manual award criteria set.
594      *
595      * @return bool A status indicating badge can be awarded manually
596      */
597     public function has_manual_award_criteria() {
598         foreach ($this->criteria as $criterion) {
599             if ($criterion->criteriatype == BADGE_CRITERIA_TYPE_MANUAL) {
600                 return true;
601             }
602         }
603         return false;
604     }
606     /**
607      * Fully deletes the badge or marks it as archived.
608      *
609      * @param $archive bool Achive a badge without actual deleting of any data.
610      */
611     public function delete($archive = true) {
612         global $DB;
614         if ($archive) {
615             $this->status = BADGE_STATUS_ARCHIVED;
616             $this->save();
617             return;
618         }
620         $fs = get_file_storage();
622         // Remove all issued badge image files and badge awards.
623         // Cannot bulk remove area files here because they are issued in user context.
624         $awards = $this->get_awards();
625         foreach ($awards as $award) {
626             $usercontext = context_user::instance($award->userid);
627             $fs->delete_area_files($usercontext->id, 'badges', 'userbadge', $this->id);
628         }
629         $DB->delete_records('badge_issued', array('badgeid' => $this->id));
631         // Remove all badge criteria.
632         $criteria = $this->get_criteria();
633         foreach ($criteria as $criterion) {
634             $criterion->delete();
635         }
637         // Delete badge images.
638         $badgecontext = $this->get_context();
639         $fs->delete_area_files($badgecontext->id, 'badges', 'badgeimage', $this->id);
641         // Finally, remove badge itself.
642         $DB->delete_records('badge', array('id' => $this->id));
643     }
646 /**
647  * Sends notifications to users about awarded badges.
648  *
649  * @param badge $badge Badge that was issued
650  * @param int $userid Recipient ID
651  * @param string $issued Unique hash of an issued badge
652  * @param string $filepathhash File path hash of an issued badge for attachments
653  */
654 function badges_notify_badge_award(badge $badge, $userid, $issued, $filepathhash) {
655     global $CFG, $DB;
657     $admin = get_admin();
658     $userfrom = new stdClass();
659     $userfrom->id = $admin->id;
660     $userfrom->email = !empty($CFG->badges_defaultissuercontact) ? $CFG->badges_defaultissuercontact : $admin->email;
661     foreach (get_all_user_name_fields() as $addname) {
662         $userfrom->$addname = !empty($CFG->badges_defaultissuername) ? '' : $admin->$addname;
663     }
664     $userfrom->firstname = !empty($CFG->badges_defaultissuername) ? $CFG->badges_defaultissuername : $admin->firstname;
665     $userfrom->maildisplay = true;
667     $issuedlink = html_writer::link(new moodle_url('/badges/badge.php', array('hash' => $issued)), $badge->name);
668     $userto = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST);
670     $params = new stdClass();
671     $params->badgename = $badge->name;
672     $params->username = fullname($userto);
673     $params->badgelink = $issuedlink;
674     $message = badge_message_from_template($badge->message, $params);
675     $plaintext = format_text_email($message, FORMAT_HTML);
677     // Notify recipient.
678     $eventdata = new stdClass();
679     $eventdata->component         = 'moodle';
680     $eventdata->name              = 'badgerecipientnotice';
681     $eventdata->userfrom          = $userfrom;
682     $eventdata->userto            = $userto;
683     $eventdata->notification      = 1;
684     $eventdata->subject           = $badge->messagesubject;
685     $eventdata->fullmessage       = $plaintext;
686     $eventdata->fullmessageformat = FORMAT_PLAIN;
687     $eventdata->fullmessagehtml   = $message;
688     $eventdata->smallmessage      = $plaintext;
690     // Attach badge image if possible.
691     if (!empty($CFG->allowattachments) && $badge->attachment && is_string($filepathhash)) {
692         $fs = get_file_storage();
693         $file = $fs->get_file_by_hash($filepathhash);
694         $eventdata->attachment = $file;
695         $eventdata->attachname = str_replace(' ', '_', $badge->name) . ".png";
697         message_send($eventdata);
698     } else {
699         message_send($eventdata);
700     }
702     // Notify badge creator about the award if they receive notifications every time.
703     if ($badge->notification == 1) {
704         $userfrom = core_user::get_noreply_user();
705         $userfrom->maildisplay = true;
707         $creator = $DB->get_record('user', array('id' => $badge->usercreated), '*', MUST_EXIST);
708         $a = new stdClass();
709         $a->user = fullname($userto);
710         $a->link = $issuedlink;
711         $creatormessage = get_string('creatorbody', 'badges', $a);
712         $creatorsubject = get_string('creatorsubject', 'badges', $badge->name);
714         $eventdata = new stdClass();
715         $eventdata->component         = 'moodle';
716         $eventdata->name              = 'badgecreatornotice';
717         $eventdata->userfrom          = $userfrom;
718         $eventdata->userto            = $creator;
719         $eventdata->notification      = 1;
720         $eventdata->subject           = $creatorsubject;
721         $eventdata->fullmessage       = format_text_email($creatormessage, FORMAT_HTML);
722         $eventdata->fullmessageformat = FORMAT_PLAIN;
723         $eventdata->fullmessagehtml   = $creatormessage;
724         $eventdata->smallmessage      = $creatorsubject;
726         message_send($eventdata);
727         $DB->set_field('badge_issued', 'issuernotified', time(), array('badgeid' => $badge->id, 'userid' => $userid));
728     }
731 /**
732  * Caclulates date for the next message digest to badge creators.
733  *
734  * @param in $schedule Type of message schedule BADGE_MESSAGE_DAILY|BADGE_MESSAGE_WEEKLY|BADGE_MESSAGE_MONTHLY.
735  * @return int Timestamp for next cron
736  */
737 function badges_calculate_message_schedule($schedule) {
738     $nextcron = 0;
740     switch ($schedule) {
741         case BADGE_MESSAGE_DAILY:
742             $nextcron = time() + 60 * 60 * 24;
743             break;
744         case BADGE_MESSAGE_WEEKLY:
745             $nextcron = time() + 60 * 60 * 24 * 7;
746             break;
747         case BADGE_MESSAGE_MONTHLY:
748             $nextcron = time() + 60 * 60 * 24 * 7 * 30;
749             break;
750     }
752     return $nextcron;
755 /**
756  * Replaces variables in a message template and returns text ready to be emailed to a user.
757  *
758  * @param string $message Message body.
759  * @return string Message with replaced values
760  */
761 function badge_message_from_template($message, $params) {
762     $msg = $message;
763     foreach ($params as $key => $value) {
764         $msg = str_replace("%$key%", $value, $msg);
765     }
767     return $msg;
770 /**
771  * Get all badges.
772  *
773  * @param int Type of badges to return
774  * @param int Course ID for course badges
775  * @param string $sort An SQL field to sort by
776  * @param string $dir The sort direction ASC|DESC
777  * @param int $page The page or records to return
778  * @param int $perpage The number of records to return per page
779  * @param int $user User specific search
780  * @return array $badge Array of records matching criteria
781  */
782 function badges_get_badges($type, $courseid = 0, $sort = '', $dir = '', $page = 0, $perpage = BADGE_PERPAGE, $user = 0) {
783     global $DB;
784     $records = array();
785     $params = array();
786     $where = "b.status != :deleted AND b.type = :type ";
787     $params['deleted'] = BADGE_STATUS_ARCHIVED;
789     $userfields = array('b.id, b.name, b.status');
790     $usersql = "";
791     if ($user != 0) {
792         $userfields[] = 'bi.dateissued';
793         $userfields[] = 'bi.uniquehash';
794         $usersql = " LEFT JOIN {badge_issued} bi ON b.id = bi.badgeid AND bi.userid = :userid ";
795         $params['userid'] = $user;
796         $where .= " AND (b.status = 1 OR b.status = 3) ";
797     }
798     $fields = implode(', ', $userfields);
800     if ($courseid != 0 ) {
801         $where .= "AND b.courseid = :courseid ";
802         $params['courseid'] = $courseid;
803     }
805     $sorting = (($sort != '' && $dir != '') ? 'ORDER BY ' . $sort . ' ' . $dir : '');
806     $params['type'] = $type;
808     $sql = "SELECT $fields FROM {badge} b $usersql WHERE $where $sorting";
809     $records = $DB->get_records_sql($sql, $params, $page * $perpage, $perpage);
811     $badges = array();
812     foreach ($records as $r) {
813         $badge = new badge($r->id);
814         $badges[$r->id] = $badge;
815         if ($user != 0) {
816             $badges[$r->id]->dateissued = $r->dateissued;
817             $badges[$r->id]->uniquehash = $r->uniquehash;
818         } else {
819             $badges[$r->id]->awards = $DB->count_records_sql('SELECT COUNT(b.userid)
820                                         FROM {badge_issued} b INNER JOIN {user} u ON b.userid = u.id
821                                         WHERE b.badgeid = :badgeid AND u.deleted = 0', array('badgeid' => $badge->id));
822             $badges[$r->id]->statstring = $badge->get_status_name();
823         }
824     }
825     return $badges;
828 /**
829  * Get badges for a specific user.
830  *
831  * @param int $userid User ID
832  * @param int $courseid Badges earned by a user in a specific course
833  * @param int $page The page or records to return
834  * @param int $perpage The number of records to return per page
835  * @param string $search A simple string to search for
836  * @param bool $onlypublic Return only public badges
837  * @return array of badges ordered by decreasing date of issue
838  */
839 function badges_get_user_badges($userid, $courseid = 0, $page = 0, $perpage = 0, $search = '', $onlypublic = false) {
840     global $DB;
841     $badges = array();
843     $params[] = $userid;
844     $sql = 'SELECT
845                 bi.uniquehash,
846                 bi.dateissued,
847                 bi.dateexpire,
848                 bi.id as issuedid,
849                 bi.visible,
850                 u.email,
851                 b.*
852             FROM
853                 {badge} b,
854                 {badge_issued} bi,
855                 {user} u
856             WHERE b.id = bi.badgeid
857                 AND u.id = bi.userid
858                 AND bi.userid = ?';
860     if (!empty($search)) {
861         $sql .= ' AND (' . $DB->sql_like('b.name', '?', false) . ') ';
862         $params[] = "%$search%";
863     }
864     if ($onlypublic) {
865         $sql .= ' AND (bi.visible = 1) ';
866     }
868     if ($courseid != 0) {
869         $sql .= ' AND (b.courseid = ' . $courseid . ') ';
870     }
871     $sql .= ' ORDER BY bi.dateissued DESC';
872     $badges = $DB->get_records_sql($sql, $params, $page * $perpage, $perpage);
874     return $badges;
877 /**
878  * Extends the course administration navigation with the Badges page
879  *
880  * @param navigation_node $coursenode
881  * @param object $course
882  */
883 function badges_add_course_navigation(navigation_node $coursenode, stdClass $course) {
884     global $CFG, $SITE;
886     $coursecontext = context_course::instance($course->id);
887     $isfrontpage = (!$coursecontext || $course->id == $SITE->id);
888     $canmanage = has_any_capability(array('moodle/badges:viewawarded',
889                                           'moodle/badges:createbadge',
890                                           'moodle/badges:awardbadge',
891                                           'moodle/badges:configurecriteria',
892                                           'moodle/badges:configuremessages',
893                                           'moodle/badges:configuredetails',
894                                           'moodle/badges:deletebadge'), $coursecontext);
896     if (!empty($CFG->enablebadges) && !empty($CFG->badges_allowcoursebadges) && !$isfrontpage && $canmanage) {
897         $coursenode->add(get_string('coursebadges', 'badges'), null,
898                 navigation_node::TYPE_CONTAINER, null, 'coursebadges',
899                 new pix_icon('i/badge', get_string('coursebadges', 'badges')));
901         $url = new moodle_url('/badges/index.php', array('type' => BADGE_TYPE_COURSE, 'id' => $course->id));
903         $coursenode->get('coursebadges')->add(get_string('managebadges', 'badges'), $url,
904             navigation_node::TYPE_SETTING, null, 'coursebadges');
906         if (has_capability('moodle/badges:createbadge', $coursecontext)) {
907             $url = new moodle_url('/badges/newbadge.php', array('type' => BADGE_TYPE_COURSE, 'id' => $course->id));
909             $coursenode->get('coursebadges')->add(get_string('newbadge', 'badges'), $url,
910                     navigation_node::TYPE_SETTING, null, 'newbadge');
911         }
912     }
915 /**
916  * Triggered when badge is manually awarded.
917  *
918  * @param   object      $data
919  * @return  boolean
920  */
921 function badges_award_handle_manual_criteria_review(stdClass $data) {
922     $criteria = $data->crit;
923     $userid = $data->userid;
924     $badge = new badge($criteria->badgeid);
926     if (!$badge->is_active() || $badge->is_issued($userid)) {
927         return true;
928     }
930     if ($criteria->review($userid)) {
931         $criteria->mark_complete($userid);
933         if ($badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->review($userid)) {
934             $badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($userid);
935             $badge->issue($userid);
936         }
937     }
939     return true;
942 /**
943  * Process badge image from form data
944  *
945  * @param badge $badge Badge object
946  * @param string $iconfile Original file
947  */
948 function badges_process_badge_image(badge $badge, $iconfile) {
949     global $CFG, $USER;
950     require_once($CFG->libdir. '/gdlib.php');
952     if (!empty($CFG->gdversion)) {
953         process_new_icon($badge->get_context(), 'badges', 'badgeimage', $badge->id, $iconfile);
954         @unlink($iconfile);
956         // Clean up file draft area after badge image has been saved.
957         $context = context_user::instance($USER->id, MUST_EXIST);
958         $fs = get_file_storage();
959         $fs->delete_area_files($context->id, 'user', 'draft');
960     }
963 /**
964  * Print badge image.
965  *
966  * @param badge $badge Badge object
967  * @param stdClass $context
968  * @param string $size
969  */
970 function print_badge_image(badge $badge, stdClass $context, $size = 'small') {
971     $fsize = ($size == 'small') ? 'f2' : 'f1';
973     $imageurl = moodle_url::make_pluginfile_url($context->id, 'badges', 'badgeimage', $badge->id, '/', $fsize, false);
974     // Appending a random parameter to image link to forse browser reload the image.
975     $imageurl->param('refresh', rand(1, 10000));
976     $attributes = array('src' => $imageurl, 'alt' => s($badge->name), 'class' => 'activatebadge');
978     return html_writer::empty_tag('img', $attributes);
981 /**
982  * Bake issued badge.
983  *
984  * @param string $hash Unique hash of an issued badge.
985  * @param int $badgeid ID of the original badge.
986  * @param int $userid ID of badge recipient (optional).
987  * @param boolean $pathhash Return file pathhash instead of image url (optional).
988  * @return string|url Returns either new file path hash or new file URL
989  */
990 function badges_bake($hash, $badgeid, $userid = 0, $pathhash = false) {
991     global $CFG, $USER;
992     require_once(dirname(dirname(__FILE__)) . '/badges/lib/bakerlib.php');
994     $badge = new badge($badgeid);
995     $badge_context = $badge->get_context();
996     $userid = ($userid) ? $userid : $USER->id;
997     $user_context = context_user::instance($userid);
999     $fs = get_file_storage();
1000     if (!$fs->file_exists($user_context->id, 'badges', 'userbadge', $badge->id, '/', $hash . '.png')) {
1001         if ($file = $fs->get_file($badge_context->id, 'badges', 'badgeimage', $badge->id, '/', 'f1.png')) {
1002             $contents = $file->get_content();
1004             $filehandler = new PNG_MetaDataHandler($contents);
1005             $assertion = new moodle_url('/badges/assertion.php', array('b' => $hash));
1006             if ($filehandler->check_chunks("tEXt", "openbadges")) {
1007                 // Add assertion URL tExt chunk.
1008                 $newcontents = $filehandler->add_chunks("tEXt", "openbadges", $assertion->out(false));
1009                 $fileinfo = array(
1010                         'contextid' => $user_context->id,
1011                         'component' => 'badges',
1012                         'filearea' => 'userbadge',
1013                         'itemid' => $badge->id,
1014                         'filepath' => '/',
1015                         'filename' => $hash . '.png',
1016                 );
1018                 // Create a file with added contents.
1019                 $newfile = $fs->create_file_from_string($fileinfo, $newcontents);
1020                 if ($pathhash) {
1021                     return $newfile->get_pathnamehash();
1022                 }
1023             }
1024         } else {
1025             debugging('Error baking badge image!', DEBUG_DEVELOPER);
1026             return;
1027         }
1028     }
1030     // If file exists and we just need its path hash, return it.
1031     if ($pathhash) {
1032         $file = $fs->get_file($user_context->id, 'badges', 'userbadge', $badge->id, '/', $hash . '.png');
1033         return $file->get_pathnamehash();
1034     }
1036     $fileurl = moodle_url::make_pluginfile_url($user_context->id, 'badges', 'userbadge', $badge->id, '/', $hash, true);
1037     return $fileurl;
1040 /**
1041  * Returns external backpack settings and badges from this backpack.
1042  *
1043  * This function first checks if badges for the user are cached and
1044  * tries to retrieve them from the cache. Otherwise, badges are obtained
1045  * through curl request to the backpack.
1046  *
1047  * @param int $userid Backpack user ID.
1048  * @param boolean $refresh Refresh badges collection in cache.
1049  * @return null|object Returns null is there is no backpack or object with backpack settings.
1050  */
1051 function get_backpack_settings($userid, $refresh = false) {
1052     global $DB;
1053     require_once(dirname(dirname(__FILE__)) . '/badges/lib/backpacklib.php');
1055     // Try to get badges from cache first.
1056     $badgescache = cache::make('core', 'externalbadges');
1057     $out = $badgescache->get($userid);
1058     if ($out !== false && !$refresh) {
1059         return $out;
1060     }
1061     // Get badges through curl request to the backpack.
1062     $record = $DB->get_record('badge_backpack', array('userid' => $userid));
1063     if ($record) {
1064         $backpack = new OpenBadgesBackpackHandler($record);
1065         $out = new stdClass();
1066         $out->backpackurl = $backpack->get_url();
1068         if ($collections = $DB->get_records('badge_external', array('backpackid' => $record->id))) {
1069             $out->totalcollections = count($collections);
1070             $out->totalbadges = 0;
1071             $out->badges = array();
1072             foreach ($collections as $collection) {
1073                 $badges = $backpack->get_badges($collection->collectionid);
1074                 if (isset($badges->badges)) {
1075                     $out->badges = array_merge($out->badges, $badges->badges);
1076                     $out->totalbadges += count($out->badges);
1077                 } else {
1078                     $out->badges = array_merge($out->badges, array());
1079                 }
1080             }
1081         } else {
1082             $out->totalbadges = 0;
1083             $out->totalcollections = 0;
1084         }
1086         $badgescache->set($userid, $out);
1087         return $out;
1088     }
1090     return null;
1093 /**
1094  * Download all user badges in zip archive.
1095  *
1096  * @param int $userid ID of badge owner.
1097  */
1098 function badges_download($userid) {
1099     global $CFG, $DB;
1100     $context = context_user::instance($userid);
1101     $records = $DB->get_records('badge_issued', array('userid' => $userid));
1103     // Get list of files to download.
1104     $fs = get_file_storage();
1105     $filelist = array();
1106     foreach ($records as $issued) {
1107         $badge = new badge($issued->badgeid);
1108         // Need to make image name user-readable and unique using filename safe characters.
1109         $name =  $badge->name . ' ' . userdate($issued->dateissued, '%d %b %Y') . ' ' . hash('crc32', $badge->id);
1110         $name = str_replace(' ', '_', $name);
1111         if ($file = $fs->get_file($context->id, 'badges', 'userbadge', $issued->badgeid, '/', $issued->uniquehash . '.png')) {
1112             $filelist[$name . '.png'] = $file;
1113         }
1114     }
1116     // Zip files and sent them to a user.
1117     $tempzip = tempnam($CFG->tempdir.'/', 'mybadges');
1118     $zipper = new zip_packer();
1119     if ($zipper->archive_to_pathname($filelist, $tempzip)) {
1120         send_temp_file($tempzip, 'badges.zip');
1121     } else {
1122         debugging("Problems with archiving the files.");
1123     }
1126 /**
1127  * Print badges on user profile page.
1128  *
1129  * @param int $userid User ID.
1130  * @param int $courseid Course if we need to filter badges (optional).
1131  */
1132 function profile_display_badges($userid, $courseid = 0) {
1133     global $CFG, $PAGE, $USER, $SITE;
1134     require_once($CFG->dirroot . '/badges/renderer.php');
1136     // Determine context.
1137     if (isloggedin()) {
1138         $context = context_user::instance($USER->id);
1139     } else {
1140         $context = context_system::instance();
1141     }
1143     if ($USER->id == $userid || has_capability('moodle/badges:viewotherbadges', $context)) {
1144         $records = badges_get_user_badges($userid, $courseid, null, null, null, true);
1145         $renderer = new core_badges_renderer($PAGE, '');
1147         // Print local badges.
1148         if ($records) {
1149             $left = get_string('localbadgesp', 'badges', format_string($SITE->fullname));
1150             $right = $renderer->print_badges_list($records, $userid, true);
1151             echo html_writer::tag('dt', $left);
1152             echo html_writer::tag('dd', $right);
1153         }
1155         // Print external badges.
1156         if ($courseid == 0 && !empty($CFG->badges_allowexternalbackpack)) {
1157             $backpack = get_backpack_settings($userid);
1158             if (isset($backpack->totalbadges) && $backpack->totalbadges !== 0) {
1159                 $left = get_string('externalbadgesp', 'badges');
1160                 $right = $renderer->print_badges_list($backpack->badges, $userid, true, true);
1161                 echo html_writer::tag('dt', $left);
1162                 echo html_writer::tag('dd', $right);
1163             }
1164         }
1165     }
1168 /**
1169  * Checks if badges can be pushed to external backpack.
1170  *
1171  * @return string Code of backpack accessibility status.
1172  */
1173 function badges_check_backpack_accessibility() {
1174     global $CFG;
1175     include_once $CFG->libdir . '/filelib.php';
1177     // Using fake assertion url to check whether backpack can access the web site.
1178     $fakeassertion = new moodle_url('/badges/assertion.php', array('b' => 'abcd1234567890'));
1180     // Curl request to http://backpack.openbadges.org/baker.
1181     $curl = new curl();
1182     $options = array(
1183         'FRESH_CONNECT' => true,
1184         'RETURNTRANSFER' => true,
1185         'HEADER' => 0,
1186         'CONNECTTIMEOUT' => 2,
1187     );
1188     $location = 'http://backpack.openbadges.org/baker';
1189     $out = $curl->get($location, array('assertion' => $fakeassertion->out(false)), $options);
1191     $data = json_decode($out);
1192     if (!empty($curl->error)) {
1193         return 'curl-request-timeout';
1194     } else {
1195         if (isset($data->code) && $data->code == 'http-unreachable') {
1196             return 'http-unreachable';
1197         } else {
1198             return 'available';
1199         }
1200     }
1202     return false;
1205 /**
1206  * Checks if user has external backpack connected.
1207  *
1208  * @param int $userid ID of a user.
1209  * @return bool True|False whether backpack connection exists.
1210  */
1211 function badges_user_has_backpack($userid) {
1212     global $DB;
1213     return $DB->record_exists('badge_backpack', array('userid' => $userid));
1216 /**
1217  * Handles what happens to the course badges when a course is deleted.
1218  *
1219  * @param int $courseid course ID.
1220  * @return void.
1221  */
1222 function badges_handle_course_deletion($courseid) {
1223     global $CFG, $DB;
1224     include_once $CFG->libdir . '/filelib.php';
1226     $systemcontext = context_system::instance();
1227     $coursecontext = context_course::instance($courseid);
1228     $fs = get_file_storage();
1230     // Move badges images to the system context.
1231     $fs->move_area_files_to_new_context($coursecontext->id, $systemcontext->id, 'badges', 'badgeimage');
1233     // Get all course badges.
1234     $badges = $DB->get_records('badge', array('type' => BADGE_TYPE_COURSE, 'courseid' => $courseid));
1235     foreach ($badges as $badge) {
1236         // Archive badges in this course.
1237         $toupdate = new stdClass();
1238         $toupdate->id = $badge->id;
1239         $toupdate->type = BADGE_TYPE_SITE;
1240         $toupdate->courseid = null;
1241         $toupdate->status = BADGE_STATUS_ARCHIVED;
1242         $DB->update_record('badge', $toupdate);
1243     }
1246 /**
1247  * Loads JS files required for backpack support.
1248  *
1249  * @uses   $CFG, $PAGE
1250  * @return void
1251  */
1252 function badges_setup_backpack_js() {
1253     global $CFG, $PAGE;
1254     if (!empty($CFG->badges_allowexternalbackpack)) {
1255         $PAGE->requires->string_for_js('error:backpackproblem', 'badges');
1256         $protocol = (strpos($CFG->wwwroot, 'https://') === 0) ? 'https://' : 'http://';
1257         $PAGE->requires->js(new moodle_url($protocol . 'backpack.openbadges.org/issuer.js'), true);
1258         $PAGE->requires->js('/badges/backpack.js', true);
1259     }