on-demand release 2.6beta+
[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;
27806552
YB
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;
124
125 /** @var array Badge criteria */
126 public $criteria = array();
127
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;
136
137 $data = $DB->get_record('badge', array('id' => $badgeid));
138
139 if (empty($data)) {
140 print_error('error:nosuchbadge', 'badges', $badgeid);
141 }
142
143 foreach ((array)$data as $field => $value) {
144 if (property_exists($this, $field)) {
145 $this->{$field} = $value;
146 }
147 }
148
149 $this->criteria = self::get_criteria();
150 }
151
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 }
165
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 }
176
177 /**
178 * Return array of accepted criteria types for this badge
179 * @return array
180 */
181 public function get_accepted_criteria() {
182 $criteriatypes = array();
183
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 }
199
200 return $criteriatypes;
201 }
202
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;
211
212 $fordb = new stdClass();
213 foreach (get_object_vars($this) as $k => $v) {
214 $fordb->{$k} = $v;
215 }
216 unset($fordb->criteria);
217
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 }
226
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;
235
236 $fordb = new stdClass();
237 foreach (get_object_vars($this) as $k => $v) {
238 $fordb->{$k} = $v;
239 }
240
241 $fordb->name = get_string('copyof', 'badges', $this->name);
242 $fordb->status = BADGE_STATUS_INACTIVE;
27806552
YB
243 $fordb->usercreated = $USER->id;
244 $fordb->usermodified = $USER->id;
245 $fordb->timecreated = time();
246 $fordb->timemodified = time();
247 unset($fordb->id);
248
249 if ($fordb->notification > 1) {
250 $fordb->nextcron = badges_calculate_message_schedule($fordb->notification);
251 }
252
253 $criteria = $fordb->criteria;
254 unset($fordb->criteria);
255
256 if ($new = $DB->insert_record('badge', $fordb, true)) {
257 $newbadge = new badge($new);
258
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 }
266
267 // Copy badge criteria.
268 foreach ($this->criteria as $crit) {
269 $crit->make_clone($new);
270 }
271
272 return $new;
273 } else {
274 throw new moodle_exception('error:clone', 'badges');
275 return false;
276 }
277 }
278
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 }
292
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 }
300
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 }
311
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 }
325
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 }
339
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;
347
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));
353
354 return $awards;
355 }
356
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 }
365
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;
374
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;
381
382 if ($this->can_expire()) {
383 $issued->dateexpire = $this->calculate_expiry($now);
384 } else {
385 $issued->dateexpire = null;
386 }
387
e2805314
YB
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);
27806552
YB
391
392 $result = $DB->insert_record('badge_issued', $issued, true);
393
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 }
399
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 }
408
409 if (!$nobake) {
410 // Bake a badge image.
411 $pathhash = badges_bake($issued->uniquehash, $this->id, $userid, true);
412
413 // Notify recipients and badge creators.
f007e899 414 badges_notify_badge_award($this, $userid, $issued->uniquehash, $pathhash);
27806552
YB
415 }
416 }
417 }
418
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;
427
428 // Raise timelimit as this could take a while for big web sites.
429 set_time_limit(0);
430 raise_memory_limit(MEMORY_HUGE);
431
432 // For site level badges, get all active site users who can earn this badge and haven't got it yet.
433 if ($this->type == BADGE_TYPE_SITE) {
434 $sql = 'SELECT DISTINCT u.id, bi.badgeid
435 FROM {user} u
436 LEFT JOIN {badge_issued} bi
437 ON u.id = bi.userid AND bi.badgeid = :badgeid
438 WHERE bi.badgeid IS NULL AND u.id != :guestid AND u.deleted = 0';
439 $toearn = $DB->get_fieldset_sql($sql, array('badgeid' => $this->id, 'guestid' => $CFG->siteguest));
440 } else {
441 // For course level badges, get users who can earn this badge in the course.
442 // These are all enrolled users with capability moodle/badges:earnbadge.
443 $earned = $DB->get_fieldset_select('badge_issued', 'userid AS id', 'badgeid = :badgeid', array('badgeid' => $this->id));
444 $users = get_enrolled_users($this->get_context(), 'moodle/badges:earnbadge', 0, 'u.id');
445 $toearn = array_diff(array_keys($users), $earned);
446 }
447
448 foreach ($toearn as $uid) {
449 $toreview = false;
450 foreach ($this->criteria as $crit) {
451 if ($crit->criteriatype != BADGE_CRITERIA_TYPE_OVERALL) {
452 if ($crit->review($uid)) {
453 $crit->mark_complete($uid);
454 if ($this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->method == BADGE_CRITERIA_AGGREGATION_ANY) {
455 $this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($uid);
456 $this->issue($uid);
457 $awards++;
458 break;
459 } else {
460 $toreview = true;
461 continue;
462 }
463 } else {
464 if ($this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->method == BADGE_CRITERIA_AGGREGATION_ANY) {
465 continue;
466 } else {
467 break;
468 }
469 }
470 }
471 }
472 // Review overall if it is required.
473 if ($toreview && $this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->review($uid)) {
474 $this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($uid);
475 $this->issue($uid);
476 $awards++;
477 }
478 }
479
480 return $awards;
481 }
482
483 /**
484 * Gets an array of completed criteria from 'badge_criteria_met' table.
485 *
486 * @param int $userid Completions for a user
487 * @return array Records of criteria completions
488 */
489 public function get_criteria_completions($userid) {
490 global $DB;
491 $completions = array();
492 $sql = "SELECT bcm.id, bcm.critid
493 FROM {badge_criteria_met} bcm
494 INNER JOIN {badge_criteria} bc ON bcm.critid = bc.id
495 WHERE bc.badgeid = :badgeid AND bcm.userid = :userid ";
496 $completions = $DB->get_records_sql($sql, array('badgeid' => $this->id, 'userid' => $userid));
497
498 return $completions;
499 }
500
501 /**
502 * Checks if badges has award criteria set up.
503 *
504 * @return bool A status indicating badge has at least one criterion
505 */
506 public function has_criteria() {
507 if (count($this->criteria) > 0) {
508 return true;
509 }
510 return false;
511 }
512
513 /**
514 * Returns badge award criteria
515 *
516 * @return array An array of badge criteria
517 */
518 public function get_criteria() {
519 global $DB;
520 $criteria = array();
521
522 if ($records = (array)$DB->get_records('badge_criteria', array('badgeid' => $this->id))) {
523 foreach ($records as $record) {
524 $criteria[$record->criteriatype] = award_criteria::build((array)$record);
525 }
526 }
527
528 return $criteria;
529 }
530
531 /**
532 * Get aggregation method for badge criteria
533 *
534 * @param int $criteriatype If none supplied, get overall aggregation method (optional)
535 * @return int One of BADGE_CRITERIA_AGGREGATION_ALL or BADGE_CRITERIA_AGGREGATION_ANY
536 */
537 public function get_aggregation_method($criteriatype = 0) {
538 global $DB;
539 $params = array('badgeid' => $this->id, 'criteriatype' => $criteriatype);
540 $aggregation = $DB->get_field('badge_criteria', 'method', $params, IGNORE_MULTIPLE);
541
542 if (!$aggregation) {
543 return BADGE_CRITERIA_AGGREGATION_ALL;
544 }
545
546 return $aggregation;
547 }
548
549 /**
550 * Checks if badge has expiry period or date set up.
551 *
552 * @return bool A status indicating badge can expire
553 */
554 public function can_expire() {
555 if ($this->expireperiod || $this->expiredate) {
556 return true;
557 }
558 return false;
559 }
560
561 /**
562 * Calculates badge expiry date based on either expirydate or expiryperiod.
563 *
564 * @param int $timestamp Time of badge issue
565 * @return int A timestamp
566 */
567 public function calculate_expiry($timestamp) {
568 $expiry = null;
569
570 if (isset($this->expiredate)) {
571 $expiry = $this->expiredate;
572 } else if (isset($this->expireperiod)) {
573 $expiry = $timestamp + $this->expireperiod;
574 }
575
576 return $expiry;
577 }
578
579 /**
580 * Checks if badge has manual award criteria set.
581 *
582 * @return bool A status indicating badge can be awarded manually
583 */
584 public function has_manual_award_criteria() {
585 foreach ($this->criteria as $criterion) {
586 if ($criterion->criteriatype == BADGE_CRITERIA_TYPE_MANUAL) {
587 return true;
588 }
589 }
590 return false;
591 }
592
593 /**
594 * Marks the badge as archived.
595 * For reporting and historical purposed we cannot completely delete badges.
596 * We will just change their status to BADGE_STATUS_ARCHIVED.
597 */
598 public function delete() {
599 $this->status = BADGE_STATUS_ARCHIVED;
600 $this->save();
601 }
602}
603
604/**
605 * Sends notifications to users about awarded badges.
606 *
607 * @param badge $badge Badge that was issued
608 * @param int $userid Recipient ID
609 * @param string $issued Unique hash of an issued badge
610 * @param string $filepathhash File path hash of an issued badge for attachments
611 */
612function badges_notify_badge_award(badge $badge, $userid, $issued, $filepathhash) {
613 global $CFG, $DB;
614
615 $admin = get_admin();
616 $userfrom = new stdClass();
617 $userfrom->id = $admin->id;
618 $userfrom->email = !empty($CFG->badges_defaultissuercontact) ? $CFG->badges_defaultissuercontact : $admin->email;
a327f25e
AG
619 foreach (get_all_user_name_fields() as $addname) {
620 $userfrom->$addname = !empty($CFG->badges_defaultissuername) ? '' : $admin->$addname;
621 }
27806552 622 $userfrom->firstname = !empty($CFG->badges_defaultissuername) ? $CFG->badges_defaultissuername : $admin->firstname;
27806552
YB
623 $userfrom->maildisplay = true;
624
625 $issuedlink = html_writer::link(new moodle_url('/badges/badge.php', array('hash' => $issued)), $badge->name);
626 $userto = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST);
627
628 $params = new stdClass();
629 $params->badgename = $badge->name;
630 $params->username = fullname($userto);
631 $params->badgelink = $issuedlink;
632 $message = badge_message_from_template($badge->message, $params);
633 $plaintext = format_text_email($message, FORMAT_HTML);
634
f007e899
PS
635 // TODO: $filepathhash may be moodle_url instance too...
636
637 if ($badge->attachment && is_string($filepathhash)) {
27806552
YB
638 $fs = get_file_storage();
639 $file = $fs->get_file_by_hash($filepathhash);
640 $attachment = $file->copy_content_to_temp();
641 email_to_user($userto,
642 $userfrom,
643 $badge->messagesubject,
644 $plaintext,
645 $message,
646 str_replace($CFG->dataroot, '', $attachment),
647 str_replace(' ', '_', $badge->name) . ".png"
648 );
649 @unlink($attachment);
650 } else {
651 email_to_user($userto, $userfrom, $badge->messagesubject, $plaintext, $message);
652 }
653
654 // Notify badge creator about the award if they receive notifications every time.
655 if ($badge->notification == 1) {
656 $creator = $DB->get_record('user', array('id' => $badge->usercreated), '*', MUST_EXIST);
657 $a = new stdClass();
658 $a->user = fullname($userto);
659 $a->link = $issuedlink;
660 $creatormessage = get_string('creatorbody', 'badges', $a);
661 $creatorsubject = get_string('creatorsubject', 'badges', $badge->name);
662
663 $eventdata = new stdClass();
664 $eventdata->component = 'moodle';
665 $eventdata->name = 'instantmessage';
666 $eventdata->userfrom = $userfrom;
667 $eventdata->userto = $creator;
668 $eventdata->notification = 1;
669 $eventdata->subject = $creatorsubject;
670 $eventdata->fullmessage = $creatormessage;
671 $eventdata->fullmessageformat = FORMAT_PLAIN;
672 $eventdata->fullmessagehtml = format_text($creatormessage, FORMAT_HTML);
673 $eventdata->smallmessage = '';
674
675 message_send($eventdata);
676 $DB->set_field('badge_issued', 'issuernotified', time(), array('badgeid' => $badge->id, 'userid' => $userid));
677 }
678}
679
680/**
681 * Caclulates date for the next message digest to badge creators.
682 *
683 * @param in $schedule Type of message schedule BADGE_MESSAGE_DAILY|BADGE_MESSAGE_WEEKLY|BADGE_MESSAGE_MONTHLY.
684 * @return int Timestamp for next cron
685 */
686function badges_calculate_message_schedule($schedule) {
687 $nextcron = 0;
688
689 switch ($schedule) {
690 case BADGE_MESSAGE_DAILY:
691 $nextcron = time() + 60 * 60 * 24;
692 break;
693 case BADGE_MESSAGE_WEEKLY:
694 $nextcron = time() + 60 * 60 * 24 * 7;
695 break;
696 case BADGE_MESSAGE_MONTHLY:
697 $nextcron = time() + 60 * 60 * 24 * 7 * 30;
698 break;
699 }
700
701 return $nextcron;
702}
703
704/**
705 * Replaces variables in a message template and returns text ready to be emailed to a user.
706 *
707 * @param string $message Message body.
708 * @return string Message with replaced values
709 */
710function badge_message_from_template($message, $params) {
711 $msg = $message;
712 foreach ($params as $key => $value) {
713 $msg = str_replace("%$key%", $value, $msg);
714 }
715
716 return $msg;
717}
718
719/**
720 * Get all badges.
721 *
722 * @param int Type of badges to return
723 * @param int Course ID for course badges
724 * @param string $sort An SQL field to sort by
725 * @param string $dir The sort direction ASC|DESC
726 * @param int $page The page or records to return
727 * @param int $perpage The number of records to return per page
728 * @param int $user User specific search
729 * @return array $badge Array of records matching criteria
730 */
731function badges_get_badges($type, $courseid = 0, $sort = '', $dir = '', $page = 0, $perpage = BADGE_PERPAGE, $user = 0) {
732 global $DB;
733 $records = array();
734 $params = array();
735 $where = "b.status != :deleted AND b.type = :type ";
736 $params['deleted'] = BADGE_STATUS_ARCHIVED;
737
738 $userfields = array('b.id, b.name, b.status');
739 $usersql = "";
740 if ($user != 0) {
741 $userfields[] = 'bi.dateissued';
742 $userfields[] = 'bi.uniquehash';
743 $usersql = " LEFT JOIN {badge_issued} bi ON b.id = bi.badgeid AND bi.userid = :userid ";
744 $params['userid'] = $user;
745 $where .= " AND (b.status = 1 OR b.status = 3) ";
746 }
747 $fields = implode(', ', $userfields);
748
749 if ($courseid != 0 ) {
750 $where .= "AND b.courseid = :courseid ";
751 $params['courseid'] = $courseid;
752 }
753
754 $sorting = (($sort != '' && $dir != '') ? 'ORDER BY ' . $sort . ' ' . $dir : '');
755 $params['type'] = $type;
756
757 $sql = "SELECT $fields FROM {badge} b $usersql WHERE $where $sorting";
758 $records = $DB->get_records_sql($sql, $params, $page * $perpage, $perpage);
759
760 $badges = array();
761 foreach ($records as $r) {
762 $badge = new badge($r->id);
763 $badges[$r->id] = $badge;
764 if ($user != 0) {
765 $badges[$r->id]->dateissued = $r->dateissued;
766 $badges[$r->id]->uniquehash = $r->uniquehash;
767 } else {
768 $badges[$r->id]->awards = $DB->count_records('badge_issued', array('badgeid' => $badge->id));
769 $badges[$r->id]->statstring = $badge->get_status_name();
770 }
771 }
772 return $badges;
773}
774
775/**
776 * Get badges for a specific user.
777 *
778 * @param int $userid User ID
779 * @param int $courseid Badges earned by a user in a specific course
780 * @param int $page The page or records to return
781 * @param int $perpage The number of records to return per page
782 * @param string $search A simple string to search for
783 * @param bool $onlypublic Return only public badges
784 * @return array of badges ordered by decreasing date of issue
785 */
786function badges_get_user_badges($userid, $courseid = 0, $page = 0, $perpage = 0, $search = '', $onlypublic = false) {
787 global $DB;
788 $badges = array();
789
790 $params[] = $userid;
791 $sql = 'SELECT
792 bi.uniquehash,
793 bi.dateissued,
794 bi.dateexpire,
795 bi.id as issuedid,
796 bi.visible,
797 u.email,
798 b.*
799 FROM
800 {badge} b,
801 {badge_issued} bi,
802 {user} u
803 WHERE b.id = bi.badgeid
804 AND u.id = bi.userid
805 AND bi.userid = ?';
806
807 if (!empty($search)) {
808 $sql .= ' AND (' . $DB->sql_like('b.name', '?', false) . ') ';
809 $params[] = "%$search%";
810 }
811 if ($onlypublic) {
812 $sql .= ' AND (bi.visible = 1) ';
813 }
814
815 if ($courseid != 0) {
816 $sql .= ' AND (b.courseid = ' . $courseid . ') ';
817 }
818 $sql .= ' ORDER BY bi.dateissued DESC';
819 $badges = $DB->get_records_sql($sql, $params, $page * $perpage, $perpage);
820
821 return $badges;
822}
823
27806552
YB
824/**
825 * Extends the course administration navigation with the Badges page
826 *
827 * @param navigation_node $coursenode
828 * @param object $course
829 */
830function badges_add_course_navigation(navigation_node $coursenode, stdClass $course) {
831 global $CFG, $SITE;
832
833 $coursecontext = context_course::instance($course->id);
834 $isfrontpage = (!$coursecontext || $course->id == $SITE->id);
a72c2cd6
YB
835 $canmanage = has_any_capability(array('moodle/badges:viewawarded',
836 'moodle/badges:createbadge',
837 'moodle/badges:awardbadge',
838 'moodle/badges:configurecriteria',
839 'moodle/badges:configuremessages',
840 'moodle/badges:configuredetails',
841 'moodle/badges:deletebadge'), $coursecontext);
27806552 842
a72c2cd6
YB
843 if (!empty($CFG->enablebadges) && !empty($CFG->badges_allowcoursebadges) && !$isfrontpage && $canmanage) {
844 $coursenode->add(get_string('coursebadges', 'badges'), null,
845 navigation_node::TYPE_CONTAINER, null, 'coursebadges',
846 new pix_icon('i/badge', get_string('coursebadges', 'badges')));
27806552 847
a72c2cd6 848 $url = new moodle_url('/badges/index.php', array('type' => BADGE_TYPE_COURSE, 'id' => $course->id));
27806552 849
a72c2cd6
YB
850 $coursenode->get('coursebadges')->add(get_string('managebadges', 'badges'), $url,
851 navigation_node::TYPE_SETTING, null, 'coursebadges');
19a9f2ea 852
a72c2cd6
YB
853 if (has_capability('moodle/badges:createbadge', $coursecontext)) {
854 $url = new moodle_url('/badges/newbadge.php', array('type' => BADGE_TYPE_COURSE, 'id' => $course->id));
19a9f2ea 855
a72c2cd6
YB
856 $coursenode->get('coursebadges')->add(get_string('newbadge', 'badges'), $url,
857 navigation_node::TYPE_SETTING, null, 'newbadge');
27806552
YB
858 }
859 }
860}
861
27806552
YB
862/**
863 * Triggered when badge is manually awarded.
864 *
865 * @param object $data
866 * @return boolean
867 */
868function badges_award_handle_manual_criteria_review(stdClass $data) {
869 $criteria = $data->crit;
870 $userid = $data->userid;
871 $badge = new badge($criteria->badgeid);
872
873 if (!$badge->is_active() || $badge->is_issued($userid)) {
874 return true;
875 }
876
877 if ($criteria->review($userid)) {
878 $criteria->mark_complete($userid);
879
880 if ($badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->review($userid)) {
881 $badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($userid);
882 $badge->issue($userid);
883 }
884 }
885
886 return true;
887}
888
889/**
890 * Process badge image from form data
891 *
892 * @param badge $badge Badge object
893 * @param string $iconfile Original file
894 */
895function badges_process_badge_image(badge $badge, $iconfile) {
896 global $CFG, $USER;
897 require_once($CFG->libdir. '/gdlib.php');
898
899 if (!empty($CFG->gdversion)) {
e50220f8 900 process_new_icon($badge->get_context(), 'badges', 'badgeimage', $badge->id, $iconfile);
27806552
YB
901 @unlink($iconfile);
902
903 // Clean up file draft area after badge image has been saved.
904 $context = context_user::instance($USER->id, MUST_EXIST);
905 $fs = get_file_storage();
906 $fs->delete_area_files($context->id, 'user', 'draft');
907 }
908}
909
910/**
911 * Print badge image.
912 *
913 * @param badge $badge Badge object
914 * @param stdClass $context
915 * @param string $size
916 */
917function print_badge_image(badge $badge, stdClass $context, $size = 'small') {
918 $fsize = ($size == 'small') ? 'f2' : 'f1';
919
920 $imageurl = moodle_url::make_pluginfile_url($context->id, 'badges', 'badgeimage', $badge->id, '/', $fsize, false);
921 // Appending a random parameter to image link to forse browser reload the image.
b143259e
YB
922 $imageurl->param('refresh', rand(1, 10000));
923 $attributes = array('src' => $imageurl, 'alt' => s($badge->name), 'class' => 'activatebadge');
27806552
YB
924
925 return html_writer::empty_tag('img', $attributes);
926}
927
928/**
929 * Bake issued badge.
930 *
931 * @param string $hash Unique hash of an issued badge.
932 * @param int $badgeid ID of the original badge.
933 * @param int $userid ID of badge recipient (optional).
934 * @param boolean $pathhash Return file pathhash instead of image url (optional).
935 * @return string|url Returns either new file path hash or new file URL
936 */
937function badges_bake($hash, $badgeid, $userid = 0, $pathhash = false) {
938 global $CFG, $USER;
939 require_once(dirname(dirname(__FILE__)) . '/badges/lib/bakerlib.php');
940
941 $badge = new badge($badgeid);
942 $badge_context = $badge->get_context();
943 $userid = ($userid) ? $userid : $USER->id;
944 $user_context = context_user::instance($userid);
945
946 $fs = get_file_storage();
947 if (!$fs->file_exists($user_context->id, 'badges', 'userbadge', $badge->id, '/', $hash . '.png')) {
948 if ($file = $fs->get_file($badge_context->id, 'badges', 'badgeimage', $badge->id, '/', 'f1.png')) {
949 $contents = $file->get_content();
950
951 $filehandler = new PNG_MetaDataHandler($contents);
952 $assertion = new moodle_url('/badges/assertion.php', array('b' => $hash));
953 if ($filehandler->check_chunks("tEXt", "openbadges")) {
954 // Add assertion URL tExt chunk.
955 $newcontents = $filehandler->add_chunks("tEXt", "openbadges", $assertion->out(false));
956 $fileinfo = array(
957 'contextid' => $user_context->id,
958 'component' => 'badges',
959 'filearea' => 'userbadge',
960 'itemid' => $badge->id,
961 'filepath' => '/',
962 'filename' => $hash . '.png',
963 );
964
965 // Create a file with added contents.
966 $newfile = $fs->create_file_from_string($fileinfo, $newcontents);
967 if ($pathhash) {
968 return $newfile->get_pathnamehash();
969 }
970 }
971 } else {
972 debugging('Error baking badge image!');
973 }
974 }
975
976 $fileurl = moodle_url::make_pluginfile_url($user_context->id, 'badges', 'userbadge', $badge->id, '/', $hash, true);
977 return $fileurl;
978}
979
980/**
e2805314 981 * Returns external backpack settings and badges from this backpack.
27806552 982 *
2d3c0fae
YB
983 * This function first checks if badges for the user are cached and
984 * tries to retrieve them from the cache. Otherwise, badges are obtained
985 * through curl request to the backpack.
986 *
27806552 987 * @param int $userid Backpack user ID.
2d3c0fae 988 * @param boolean $refresh Refresh badges collection in cache.
27806552
YB
989 * @return null|object Returns null is there is no backpack or object with backpack settings.
990 */
2d3c0fae 991function get_backpack_settings($userid, $refresh = false) {
27806552
YB
992 global $DB;
993 require_once(dirname(dirname(__FILE__)) . '/badges/lib/backpacklib.php');
994
2d3c0fae
YB
995 // Try to get badges from cache first.
996 $badgescache = cache::make('core', 'externalbadges');
997 $out = $badgescache->get($userid);
998 if ($out !== false && !$refresh) {
999 return $out;
1000 }
1001 // Get badges through curl request to the backpack.
e2805314 1002 $record = $DB->get_record('badge_backpack', array('userid' => $userid));
27806552
YB
1003 if ($record) {
1004 $backpack = new OpenBadgesBackpackHandler($record);
1005 $out = new stdClass();
1006 $out->backpackurl = $backpack->get_url();
e2805314
YB
1007
1008 if ($collections = $DB->get_records('badge_external', array('backpackid' => $record->id))) {
1009 $out->totalcollections = count($collections);
1010 $out->totalbadges = 0;
1011 $out->badges = array();
1012 foreach ($collections as $collection) {
1013 $badges = $backpack->get_badges($collection->collectionid);
1014 if (isset($badges->badges)) {
1015 $out->badges = array_merge($out->badges, $badges->badges);
1016 $out->totalbadges += count($out->badges);
1017 } else {
1018 $out->badges = array_merge($out->badges, array());
1019 }
1020 }
1021 } else {
1022 $out->totalbadges = 0;
1023 $out->totalcollections = 0;
1024 }
1025
2d3c0fae 1026 $badgescache->set($userid, $out);
27806552
YB
1027 return $out;
1028 }
1029
1030 return null;
1031}
1032
1033/**
1034 * Download all user badges in zip archive.
1035 *
1036 * @param int $userid ID of badge owner.
1037 */
1038function badges_download($userid) {
1039 global $CFG, $DB;
1040 $context = context_user::instance($userid);
1041 $records = $DB->get_records('badge_issued', array('userid' => $userid));
1042
1043 // Get list of files to download.
1044 $fs = get_file_storage();
1045 $filelist = array();
1046 foreach ($records as $issued) {
1047 $badge = new badge($issued->badgeid);
1048 // Need to make image name user-readable and unique using filename safe characters.
1049 $name = $badge->name . ' ' . userdate($issued->dateissued, '%d %b %Y') . ' ' . hash('crc32', $badge->id);
1050 $name = str_replace(' ', '_', $name);
1051 if ($file = $fs->get_file($context->id, 'badges', 'userbadge', $issued->badgeid, '/', $issued->uniquehash . '.png')) {
1052 $filelist[$name . '.png'] = $file;
1053 }
1054 }
1055
1056 // Zip files and sent them to a user.
1057 $tempzip = tempnam($CFG->tempdir.'/', 'mybadges');
1058 $zipper = new zip_packer();
1059 if ($zipper->archive_to_pathname($filelist, $tempzip)) {
1060 send_temp_file($tempzip, 'badges.zip');
1061 } else {
1062 debugging("Problems with archiving the files.");
1063 }
1064}
1065
1066/**
1067 * Print badges on user profile page.
1068 *
1069 * @param int $userid User ID.
1070 * @param int $courseid Course if we need to filter badges (optional).
1071 */
1072function profile_display_badges($userid, $courseid = 0) {
1073 global $CFG, $PAGE, $USER, $SITE;
1074 require_once($CFG->dirroot . '/badges/renderer.php');
1075
497c676f
YB
1076 // Determine context.
1077 if (isloggedin()) {
1078 $context = context_user::instance($USER->id);
1079 } else {
1080 $context = context_system::instance();
1081 }
1082
1083 if ($USER->id == $userid || has_capability('moodle/badges:viewotherbadges', $context)) {
27806552
YB
1084 $records = badges_get_user_badges($userid, $courseid, null, null, null, true);
1085 $renderer = new core_badges_renderer($PAGE, '');
1086
1087 // Print local badges.
1088 if ($records) {
497c676f 1089 $left = get_string('localbadgesp', 'badges', format_string($SITE->fullname));
27806552
YB
1090 $right = $renderer->print_badges_list($records, $userid, true);
1091 echo html_writer::tag('dt', $left);
1092 echo html_writer::tag('dd', $right);
1093 }
1094
1095 // Print external badges.
60d72efb 1096 if ($courseid == 0 && !empty($CFG->badges_allowexternalbackpack)) {
27806552
YB
1097 $backpack = get_backpack_settings($userid);
1098 if (isset($backpack->totalbadges) && $backpack->totalbadges !== 0) {
1099 $left = get_string('externalbadgesp', 'badges');
1100 $right = $renderer->print_badges_list($backpack->badges, $userid, true, true);
1101 echo html_writer::tag('dt', $left);
1102 echo html_writer::tag('dd', $right);
1103 }
1104 }
1105 }
1106}
1107
1108/**
1109 * Checks if badges can be pushed to external backpack.
1110 *
1111 * @return string Code of backpack accessibility status.
1112 */
1113function badges_check_backpack_accessibility() {
1114 global $CFG;
1115 include_once $CFG->libdir . '/filelib.php';
1116
1117 // Using fake assertion url to check whether backpack can access the web site.
1118 $fakeassertion = new moodle_url('/badges/assertion.php', array('b' => 'abcd1234567890'));
1119
1120 // Curl request to http://backpack.openbadges.org/baker.
1121 $curl = new curl();
1122 $options = array(
1123 'FRESH_CONNECT' => true,
1124 'RETURNTRANSFER' => true,
27806552 1125 'HEADER' => 0,
dd4a197e 1126 'CONNECTTIMEOUT' => 2,
27806552
YB
1127 );
1128 $location = 'http://backpack.openbadges.org/baker';
1129 $out = $curl->get($location, array('assertion' => $fakeassertion->out(false)), $options);
1130
1131 $data = json_decode($out);
1132 if (!empty($curl->error)) {
1133 return 'curl-request-timeout';
1134 } else {
1135 if (isset($data->code) && $data->code == 'http-unreachable') {
1136 return 'http-unreachable';
1137 } else {
1138 return 'available';
1139 }
1140 }
1141
1142 return false;
1143}
e2805314
YB
1144
1145/**
1146 * Checks if user has external backpack connected.
1147 *
1148 * @param int $userid ID of a user.
1149 * @return bool True|False whether backpack connection exists.
1150 */
1151function badges_user_has_backpack($userid) {
1152 global $DB;
1153 return $DB->record_exists('badge_backpack', array('userid' => $userid));
1154}
7deff81f
YB
1155
1156/**
1157 * Handles what happens to the course badges when a course is deleted.
1158 *
1159 * @param int $courseid course ID.
1160 * @return void.
1161 */
1162function badges_handle_course_deletion($courseid) {
1163 global $CFG, $DB;
1164 include_once $CFG->libdir . '/filelib.php';
1165
1166 $systemcontext = context_system::instance();
1167 $coursecontext = context_course::instance($courseid);
1168 $fs = get_file_storage();
1169
1170 // Move badges images to the system context.
1171 $fs->move_area_files_to_new_context($coursecontext->id, $systemcontext->id, 'badges', 'badgeimage');
1172
1173 // Get all course badges.
1174 $badges = $DB->get_records('badge', array('type' => BADGE_TYPE_COURSE, 'courseid' => $courseid));
1175 foreach ($badges as $badge) {
1176 // Archive badges in this course.
1177 $toupdate = new stdClass();
1178 $toupdate->id = $badge->id;
1179 $toupdate->type = BADGE_TYPE_SITE;
1180 $toupdate->courseid = null;
1181 $toupdate->status = BADGE_STATUS_ARCHIVED;
1182 $DB->update_record('badge', $toupdate);
1183 }
1184}
2c910861
YB
1185
1186/**
1187 * Loads JS files required for backpack support.
1188 *
1189 * @uses $CFG, $PAGE
1190 * @return void
1191 */
1192function badges_setup_backpack_js() {
1193 global $CFG, $PAGE;
1194 if (!empty($CFG->badges_allowexternalbackpack)) {
1195 $PAGE->requires->string_for_js('error:backpackproblem', 'badges');
1196 $protocol = (strpos($CFG->wwwroot, 'https://') === 0) ? 'https://' : 'http://';
1197 $PAGE->requires->js(new moodle_url($protocol . 'backpack.openbadges.org/issuer.js'), true);
1198 $PAGE->requires->js('/badges/backpack.js', true);
1199 }
1200}