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