forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
badgeslib.php
1340 lines (1166 loc) · 44.3 KB
/
badgeslib.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Contains classes, functions and constants used in badges.
*
* @package core
* @subpackage badges
* @copyright 2012 onwards Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @author Yuliya Bozhko <yuliya.bozhko@totaralms.com>
*/
defined('MOODLE_INTERNAL') || die();
/* Include required award criteria library. */
require_once($CFG->dirroot . '/badges/criteria/award_criteria.php');
/*
* Number of records per page.
*/
define('BADGE_PERPAGE', 50);
/*
* Badge award criteria aggregation method.
*/
define('BADGE_CRITERIA_AGGREGATION_ALL', 1);
/*
* Badge award criteria aggregation method.
*/
define('BADGE_CRITERIA_AGGREGATION_ANY', 2);
/*
* Inactive badge means that this badge cannot be earned and has not been awarded
* yet. Its award criteria can be changed.
*/
define('BADGE_STATUS_INACTIVE', 0);
/*
* Active badge means that this badge can we earned, but it has not been awarded
* yet. Can be deactivated for the purpose of changing its criteria.
*/
define('BADGE_STATUS_ACTIVE', 1);
/*
* Inactive badge can no longer be earned, but it has been awarded in the past and
* therefore its criteria cannot be changed.
*/
define('BADGE_STATUS_INACTIVE_LOCKED', 2);
/*
* Active badge means that it can be earned and has already been awarded to users.
* Its criteria cannot be changed any more.
*/
define('BADGE_STATUS_ACTIVE_LOCKED', 3);
/*
* Archived badge is considered deleted and can no longer be earned and is not
* displayed in the list of all badges.
*/
define('BADGE_STATUS_ARCHIVED', 4);
/*
* Badge type for site badges.
*/
define('BADGE_TYPE_SITE', 1);
/*
* Badge type for course badges.
*/
define('BADGE_TYPE_COURSE', 2);
/*
* Badge messaging schedule options.
*/
define('BADGE_MESSAGE_NEVER', 0);
define('BADGE_MESSAGE_ALWAYS', 1);
define('BADGE_MESSAGE_DAILY', 2);
define('BADGE_MESSAGE_WEEKLY', 3);
define('BADGE_MESSAGE_MONTHLY', 4);
/**
* Class that represents badge.
*
*/
class badge {
/** @var int Badge id */
public $id;
/** Values from the table 'badge' */
public $name;
public $description;
public $timecreated;
public $timemodified;
public $usercreated;
public $usermodified;
public $image;
public $issuername;
public $issuerurl;
public $issuercontact;
public $expiredate;
public $expireperiod;
public $type;
public $courseid;
public $message;
public $messagesubject;
public $attachment;
public $notification;
public $status = 0;
public $nextcron;
/** @var array Badge criteria */
public $criteria = array();
/**
* Constructs with badge details.
*
* @param int $badgeid badge ID.
*/
public function __construct($badgeid) {
global $DB;
$this->id = $badgeid;
$data = $DB->get_record('badge', array('id' => $badgeid));
if (empty($data)) {
print_error('error:nosuchbadge', 'badges', $badgeid);
}
foreach ((array)$data as $field => $value) {
if (property_exists($this, $field)) {
$this->{$field} = $value;
}
}
$this->criteria = self::get_criteria();
}
/**
* Use to get context instance of a badge.
* @return context instance.
*/
public function get_context() {
if ($this->type == BADGE_TYPE_SITE) {
return context_system::instance();
} else if ($this->type == BADGE_TYPE_COURSE) {
return context_course::instance($this->courseid);
} else {
debugging('Something is wrong...');
}
}
/**
* Return array of aggregation methods
* @return array
*/
public static function get_aggregation_methods() {
return array(
BADGE_CRITERIA_AGGREGATION_ALL => get_string('all', 'badges'),
BADGE_CRITERIA_AGGREGATION_ANY => get_string('any', 'badges'),
);
}
/**
* Return array of accepted criteria types for this badge
* @return array
*/
public function get_accepted_criteria() {
$criteriatypes = array();
if ($this->type == BADGE_TYPE_COURSE) {
$criteriatypes = array(
BADGE_CRITERIA_TYPE_OVERALL,
BADGE_CRITERIA_TYPE_MANUAL,
BADGE_CRITERIA_TYPE_COURSE,
BADGE_CRITERIA_TYPE_ACTIVITY
);
} else if ($this->type == BADGE_TYPE_SITE) {
$criteriatypes = array(
BADGE_CRITERIA_TYPE_OVERALL,
BADGE_CRITERIA_TYPE_MANUAL,
BADGE_CRITERIA_TYPE_COURSESET,
BADGE_CRITERIA_TYPE_PROFILE,
);
}
return $criteriatypes;
}
/**
* Save/update badge information in 'badge' table only.
* Cannot be used for updating awards and criteria settings.
*
* @return bool Returns true on success.
*/
public function save() {
global $DB;
$fordb = new stdClass();
foreach (get_object_vars($this) as $k => $v) {
$fordb->{$k} = $v;
}
unset($fordb->criteria);
$fordb->timemodified = time();
if ($DB->update_record_raw('badge', $fordb)) {
return true;
} else {
throw new moodle_exception('error:save', 'badges');
return false;
}
}
/**
* Creates and saves a clone of badge with all its properties.
* Clone is not active by default and has 'Copy of' attached to its name.
*
* @return int ID of new badge.
*/
public function make_clone() {
global $DB, $USER;
$fordb = new stdClass();
foreach (get_object_vars($this) as $k => $v) {
$fordb->{$k} = $v;
}
$fordb->name = get_string('copyof', 'badges', $this->name);
$fordb->status = BADGE_STATUS_INACTIVE;
$fordb->image = 0;
$fordb->usercreated = $USER->id;
$fordb->usermodified = $USER->id;
$fordb->timecreated = time();
$fordb->timemodified = time();
unset($fordb->id);
if ($fordb->notification > 1) {
$fordb->nextcron = badges_calculate_message_schedule($fordb->notification);
}
$criteria = $fordb->criteria;
unset($fordb->criteria);
if ($new = $DB->insert_record('badge', $fordb, true)) {
$newbadge = new badge($new);
// Copy badge image.
$fs = get_file_storage();
if ($file = $fs->get_file($this->get_context()->id, 'badges', 'badgeimage', $this->id, '/', 'f1.png')) {
if ($imagefile = $file->copy_content_to_temp()) {
badges_process_badge_image($newbadge, $imagefile);
}
}
// Copy badge criteria.
foreach ($this->criteria as $crit) {
$crit->make_clone($new);
}
return $new;
} else {
throw new moodle_exception('error:clone', 'badges');
return false;
}
}
/**
* Checks if badges is active.
* Used in badge award.
*
* @return bool A status indicating badge is active
*/
public function is_active() {
if (($this->status == BADGE_STATUS_ACTIVE) ||
($this->status == BADGE_STATUS_ACTIVE_LOCKED)) {
return true;
}
return false;
}
/**
* Use to get the name of badge status.
*
*/
public function get_status_name() {
return get_string('badgestatus_' . $this->status, 'badges');
}
/**
* Use to set badge status.
* Only active badges can be earned/awarded/issued.
*
* @param int $status Status from BADGE_STATUS constants
*/
public function set_status($status = 0) {
$this->status = $status;
$this->save();
}
/**
* Checks if badges is locked.
* Used in badge award and editing.
*
* @return bool A status indicating badge is locked
*/
public function is_locked() {
if (($this->status == BADGE_STATUS_ACTIVE_LOCKED) ||
($this->status == BADGE_STATUS_INACTIVE_LOCKED)) {
return true;
}
return false;
}
/**
* Checks if badge has been awarded to users.
* Used in badge editing.
*
* @return bool A status indicating badge has been awarded at least once
*/
public function has_awards() {
global $DB;
if ($DB->record_exists('badge_issued', array('badgeid' => $this->id))) {
return true;
}
return false;
}
/**
* Gets list of users who have earned an instance of this badge.
*
* @return array An array of objects with information about badge awards.
*/
public function get_awards() {
global $DB;
$awards = $DB->get_records_sql(
'SELECT b.userid, b.dateissued, b.uniquehash, u.firstname, u.lastname
FROM {badge_issued} b INNER JOIN {user} u
ON b.userid = u.id
WHERE b.badgeid = :badgeid', array('badgeid' => $this->id));
return $awards;
}
/**
* Indicates whether badge has already been issued to a user.
*
*/
public function is_issued($userid) {
global $DB;
return $DB->record_exists('badge_issued', array('badgeid' => $this->id, 'userid' => $userid));
}
/**
* Issue a badge to user.
*
* @param int $userid User who earned the badge
* @param bool $nobake Not baking actual badges (for testing purposes)
*/
public function issue($userid, $nobake = false) {
global $DB, $CFG;
$now = time();
$issued = new stdClass();
$issued->badgeid = $this->id;
$issued->userid = $userid;
$issued->uniquehash = sha1(rand() . $userid . $this->id . $now);
$issued->dateissued = $now;
if ($this->can_expire()) {
$issued->dateexpire = $this->calculate_expiry($now);
} else {
$issued->dateexpire = null;
}
// Take into account user badges privacy settings.
// If none set, badges default visibility is set to public.
$issued->visible = get_user_preferences('badgeprivacysetting', 1, $userid);
$result = $DB->insert_record('badge_issued', $issued, true);
if ($result) {
// Lock the badge, so that its criteria could not be changed any more.
if ($this->status == BADGE_STATUS_ACTIVE) {
$this->set_status(BADGE_STATUS_ACTIVE_LOCKED);
}
// Update details in criteria_met table.
$compl = $this->get_criteria_completions($userid);
foreach ($compl as $c) {
$obj = new stdClass();
$obj->id = $c->id;
$obj->issuedid = $result;
$DB->update_record('badge_criteria_met', $obj, true);
}
if (!$nobake) {
// Bake a badge image.
$pathhash = badges_bake($issued->uniquehash, $this->id, $userid, true);
// Notify recipients and badge creators.
if (empty($CFG->noemailever)) {
badges_notify_badge_award($this, $userid, $issued->uniquehash, $pathhash);
}
}
}
}
/**
* Reviews all badge criteria and checks if badge can be instantly awarded.
*
* @return int Number of awards
*/
public function review_all_criteria() {
global $DB, $CFG;
$awards = 0;
// Raise timelimit as this could take a while for big web sites.
set_time_limit(0);
raise_memory_limit(MEMORY_HUGE);
// For site level badges, get all active site users who can earn this badge and haven't got it yet.
if ($this->type == BADGE_TYPE_SITE) {
$sql = 'SELECT DISTINCT u.id, bi.badgeid
FROM {user} u
LEFT JOIN {badge_issued} bi
ON u.id = bi.userid AND bi.badgeid = :badgeid
WHERE bi.badgeid IS NULL AND u.id != :guestid AND u.deleted = 0';
$toearn = $DB->get_fieldset_sql($sql, array('badgeid' => $this->id, 'guestid' => $CFG->siteguest));
} else {
// For course level badges, get users who can earn this badge in the course.
// These are all enrolled users with capability moodle/badges:earnbadge.
$earned = $DB->get_fieldset_select('badge_issued', 'userid AS id', 'badgeid = :badgeid', array('badgeid' => $this->id));
$users = get_enrolled_users($this->get_context(), 'moodle/badges:earnbadge', 0, 'u.id');
$toearn = array_diff(array_keys($users), $earned);
}
foreach ($toearn as $uid) {
$toreview = false;
foreach ($this->criteria as $crit) {
if ($crit->criteriatype != BADGE_CRITERIA_TYPE_OVERALL) {
if ($crit->review($uid)) {
$crit->mark_complete($uid);
if ($this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->method == BADGE_CRITERIA_AGGREGATION_ANY) {
$this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($uid);
$this->issue($uid);
$awards++;
break;
} else {
$toreview = true;
continue;
}
} else {
if ($this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->method == BADGE_CRITERIA_AGGREGATION_ANY) {
continue;
} else {
break;
}
}
}
}
// Review overall if it is required.
if ($toreview && $this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->review($uid)) {
$this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($uid);
$this->issue($uid);
$awards++;
}
}
return $awards;
}
/**
* Gets an array of completed criteria from 'badge_criteria_met' table.
*
* @param int $userid Completions for a user
* @return array Records of criteria completions
*/
public function get_criteria_completions($userid) {
global $DB;
$completions = array();
$sql = "SELECT bcm.id, bcm.critid
FROM {badge_criteria_met} bcm
INNER JOIN {badge_criteria} bc ON bcm.critid = bc.id
WHERE bc.badgeid = :badgeid AND bcm.userid = :userid ";
$completions = $DB->get_records_sql($sql, array('badgeid' => $this->id, 'userid' => $userid));
return $completions;
}
/**
* Checks if badges has award criteria set up.
*
* @return bool A status indicating badge has at least one criterion
*/
public function has_criteria() {
if (count($this->criteria) > 0) {
return true;
}
return false;
}
/**
* Returns badge award criteria
*
* @return array An array of badge criteria
*/
public function get_criteria() {
global $DB;
$criteria = array();
if ($records = (array)$DB->get_records('badge_criteria', array('badgeid' => $this->id))) {
foreach ($records as $record) {
$criteria[$record->criteriatype] = award_criteria::build((array)$record);
}
}
return $criteria;
}
/**
* Get aggregation method for badge criteria
*
* @param int $criteriatype If none supplied, get overall aggregation method (optional)
* @return int One of BADGE_CRITERIA_AGGREGATION_ALL or BADGE_CRITERIA_AGGREGATION_ANY
*/
public function get_aggregation_method($criteriatype = 0) {
global $DB;
$params = array('badgeid' => $this->id, 'criteriatype' => $criteriatype);
$aggregation = $DB->get_field('badge_criteria', 'method', $params, IGNORE_MULTIPLE);
if (!$aggregation) {
return BADGE_CRITERIA_AGGREGATION_ALL;
}
return $aggregation;
}
/**
* Checks if badge has expiry period or date set up.
*
* @return bool A status indicating badge can expire
*/
public function can_expire() {
if ($this->expireperiod || $this->expiredate) {
return true;
}
return false;
}
/**
* Calculates badge expiry date based on either expirydate or expiryperiod.
*
* @param int $timestamp Time of badge issue
* @return int A timestamp
*/
public function calculate_expiry($timestamp) {
$expiry = null;
if (isset($this->expiredate)) {
$expiry = $this->expiredate;
} else if (isset($this->expireperiod)) {
$expiry = $timestamp + $this->expireperiod;
}
return $expiry;
}
/**
* Checks if badge has manual award criteria set.
*
* @return bool A status indicating badge can be awarded manually
*/
public function has_manual_award_criteria() {
foreach ($this->criteria as $criterion) {
if ($criterion->criteriatype == BADGE_CRITERIA_TYPE_MANUAL) {
return true;
}
}
return false;
}
/**
* Marks the badge as archived.
* For reporting and historical purposed we cannot completely delete badges.
* We will just change their status to BADGE_STATUS_ARCHIVED.
*/
public function delete() {
$this->status = BADGE_STATUS_ARCHIVED;
$this->save();
}
}
/**
* Sends notifications to users about awarded badges.
*
* @param badge $badge Badge that was issued
* @param int $userid Recipient ID
* @param string $issued Unique hash of an issued badge
* @param string $filepathhash File path hash of an issued badge for attachments
*/
function badges_notify_badge_award(badge $badge, $userid, $issued, $filepathhash) {
global $CFG, $DB;
$admin = get_admin();
$userfrom = new stdClass();
$userfrom->id = $admin->id;
$userfrom->email = !empty($CFG->badges_defaultissuercontact) ? $CFG->badges_defaultissuercontact : $admin->email;
$userfrom->firstname = !empty($CFG->badges_defaultissuername) ? $CFG->badges_defaultissuername : $admin->firstname;
$userfrom->lastname = !empty($CFG->badges_defaultissuername) ? '' : $admin->lastname;
$userfrom->maildisplay = true;
$issuedlink = html_writer::link(new moodle_url('/badges/badge.php', array('hash' => $issued)), $badge->name);
$userto = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST);
$params = new stdClass();
$params->badgename = $badge->name;
$params->username = fullname($userto);
$params->badgelink = $issuedlink;
$message = badge_message_from_template($badge->message, $params);
$plaintext = format_text_email($message, FORMAT_HTML);
if ($badge->attachment && $filepathhash) {
$fs = get_file_storage();
$file = $fs->get_file_by_hash($filepathhash);
$attachment = $file->copy_content_to_temp();
email_to_user($userto,
$userfrom,
$badge->messagesubject,
$plaintext,
$message,
str_replace($CFG->dataroot, '', $attachment),
str_replace(' ', '_', $badge->name) . ".png"
);
@unlink($attachment);
} else {
email_to_user($userto, $userfrom, $badge->messagesubject, $plaintext, $message);
}
// Notify badge creator about the award if they receive notifications every time.
if ($badge->notification == 1) {
$creator = $DB->get_record('user', array('id' => $badge->usercreated), '*', MUST_EXIST);
$a = new stdClass();
$a->user = fullname($userto);
$a->link = $issuedlink;
$creatormessage = get_string('creatorbody', 'badges', $a);
$creatorsubject = get_string('creatorsubject', 'badges', $badge->name);
$eventdata = new stdClass();
$eventdata->component = 'moodle';
$eventdata->name = 'instantmessage';
$eventdata->userfrom = $userfrom;
$eventdata->userto = $creator;
$eventdata->notification = 1;
$eventdata->subject = $creatorsubject;
$eventdata->fullmessage = $creatormessage;
$eventdata->fullmessageformat = FORMAT_PLAIN;
$eventdata->fullmessagehtml = format_text($creatormessage, FORMAT_HTML);
$eventdata->smallmessage = '';
message_send($eventdata);
$DB->set_field('badge_issued', 'issuernotified', time(), array('badgeid' => $badge->id, 'userid' => $userid));
}
}
/**
* Caclulates date for the next message digest to badge creators.
*
* @param in $schedule Type of message schedule BADGE_MESSAGE_DAILY|BADGE_MESSAGE_WEEKLY|BADGE_MESSAGE_MONTHLY.
* @return int Timestamp for next cron
*/
function badges_calculate_message_schedule($schedule) {
$nextcron = 0;
switch ($schedule) {
case BADGE_MESSAGE_DAILY:
$nextcron = time() + 60 * 60 * 24;
break;
case BADGE_MESSAGE_WEEKLY:
$nextcron = time() + 60 * 60 * 24 * 7;
break;
case BADGE_MESSAGE_MONTHLY:
$nextcron = time() + 60 * 60 * 24 * 7 * 30;
break;
}
return $nextcron;
}
/**
* Replaces variables in a message template and returns text ready to be emailed to a user.
*
* @param string $message Message body.
* @return string Message with replaced values
*/
function badge_message_from_template($message, $params) {
$msg = $message;
foreach ($params as $key => $value) {
$msg = str_replace("%$key%", $value, $msg);
}
return $msg;
}
/**
* Get all badges.
*
* @param int Type of badges to return
* @param int Course ID for course badges
* @param string $sort An SQL field to sort by
* @param string $dir The sort direction ASC|DESC
* @param int $page The page or records to return
* @param int $perpage The number of records to return per page
* @param int $user User specific search
* @return array $badge Array of records matching criteria
*/
function badges_get_badges($type, $courseid = 0, $sort = '', $dir = '', $page = 0, $perpage = BADGE_PERPAGE, $user = 0) {
global $DB;
$records = array();
$params = array();
$where = "b.status != :deleted AND b.type = :type ";
$params['deleted'] = BADGE_STATUS_ARCHIVED;
$userfields = array('b.id, b.name, b.status');
$usersql = "";
if ($user != 0) {
$userfields[] = 'bi.dateissued';
$userfields[] = 'bi.uniquehash';
$usersql = " LEFT JOIN {badge_issued} bi ON b.id = bi.badgeid AND bi.userid = :userid ";
$params['userid'] = $user;
$where .= " AND (b.status = 1 OR b.status = 3) ";
}
$fields = implode(', ', $userfields);
if ($courseid != 0 ) {
$where .= "AND b.courseid = :courseid ";
$params['courseid'] = $courseid;
}
$sorting = (($sort != '' && $dir != '') ? 'ORDER BY ' . $sort . ' ' . $dir : '');
$params['type'] = $type;
$sql = "SELECT $fields FROM {badge} b $usersql WHERE $where $sorting";
$records = $DB->get_records_sql($sql, $params, $page * $perpage, $perpage);
$badges = array();
foreach ($records as $r) {
$badge = new badge($r->id);
$badges[$r->id] = $badge;
if ($user != 0) {
$badges[$r->id]->dateissued = $r->dateissued;
$badges[$r->id]->uniquehash = $r->uniquehash;
} else {
$badges[$r->id]->awards = $DB->count_records('badge_issued', array('badgeid' => $badge->id));
$badges[$r->id]->statstring = $badge->get_status_name();
}
}
return $badges;
}
/**
* Get badges for a specific user.
*
* @param int $userid User ID
* @param int $courseid Badges earned by a user in a specific course
* @param int $page The page or records to return
* @param int $perpage The number of records to return per page
* @param string $search A simple string to search for
* @param bool $onlypublic Return only public badges
* @return array of badges ordered by decreasing date of issue
*/
function badges_get_user_badges($userid, $courseid = 0, $page = 0, $perpage = 0, $search = '', $onlypublic = false) {
global $DB;
$badges = array();
$params[] = $userid;
$sql = 'SELECT
bi.uniquehash,
bi.dateissued,
bi.dateexpire,
bi.id as issuedid,
bi.visible,
u.email,
b.*
FROM
{badge} b,
{badge_issued} bi,
{user} u
WHERE b.id = bi.badgeid
AND u.id = bi.userid
AND bi.userid = ?';
if (!empty($search)) {
$sql .= ' AND (' . $DB->sql_like('b.name', '?', false) . ') ';
$params[] = "%$search%";
}
if ($onlypublic) {
$sql .= ' AND (bi.visible = 1) ';
}
if ($courseid != 0) {
$sql .= ' AND (b.courseid = ' . $courseid . ') ';
}
$sql .= ' ORDER BY bi.dateissued DESC';
$badges = $DB->get_records_sql($sql, $params, $page * $perpage, $perpage);
return $badges;
}
/**
* Get issued badge details for assertion URL
*
* @param string $hash
*/
function badges_get_issued_badge_info($hash) {
global $DB, $CFG;
$a = array();
$record = $DB->get_record_sql('
SELECT
bi.dateissued,
bi.dateexpire,
u.email,
b.*,
bb.email as backpackemail
FROM
{badge} b
JOIN {badge_issued} bi
ON b.id = bi.badgeid
JOIN {user} u
ON u.id = bi.userid
LEFT JOIN {badge_backpack} bb
ON bb.userid = bi.userid
WHERE ' . $DB->sql_compare_text('bi.uniquehash', 40) . ' = ' . $DB->sql_compare_text(':hash', 40),
array('hash' => $hash), IGNORE_MISSING);
if ($record) {
if ($record->type == BADGE_TYPE_SITE) {
$context = context_system::instance();
} else {
$context = context_course::instance($record->courseid);
}
$url = new moodle_url('/badges/badge.php', array('hash' => $hash));
$email = empty($record->backpackemail) ? $record->email : $record->backpackemail;
// Recipient's email is hashed: <algorithm>$<hash(email + salt)>.
$a['recipient'] = 'sha256$' . hash('sha256', $email . $CFG->badges_badgesalt);
$a['salt'] = $CFG->badges_badgesalt;
if ($record->dateexpire) {
$a['expires'] = date('Y-m-d', $record->dateexpire);
}
$a['issued_on'] = date('Y-m-d', $record->dateissued);
$a['evidence'] = $url->out(); // Issued badge URL.
$a['badge'] = array();
$a['badge']['version'] = '0.5.0'; // Version of OBI specification, 0.5.0 - current beta.
$a['badge']['name'] = $record->name;
$a['badge']['image'] = moodle_url::make_pluginfile_url($context->id, 'badges', 'badgeimage', $record->id, '/', 'f1')->out();
$a['badge']['description'] = $record->description;
$a['badge']['criteria'] = $url->out(); // Issued badge URL.
$a['badge']['issuer'] = array();
$a['badge']['issuer']['origin'] = $record->issuerurl;
$a['badge']['issuer']['name'] = $record->issuername;
$a['badge']['issuer']['contact'] = $record->issuercontact;
}
return $a;
}
/**
* Extends the course administration navigation with the Badges page
*
* @param navigation_node $coursenode
* @param object $course
*/
function badges_add_course_navigation(navigation_node $coursenode, stdClass $course) {
global $CFG, $SITE;
$coursecontext = context_course::instance($course->id);
$isfrontpage = (!$coursecontext || $course->id == $SITE->id);
if (!empty($CFG->enablebadges) && !empty($CFG->badges_allowcoursebadges) && !$isfrontpage) {
if (has_capability('moodle/badges:configuredetails', $coursecontext)) {
$coursenode->add(get_string('coursebadges', 'badges'), null,
navigation_node::TYPE_CONTAINER, null, 'coursebadges',
new pix_icon('i/badge', get_string('coursebadges', 'badges')));
if (has_capability('moodle/badges:viewawarded', $coursecontext)) {
$url = new moodle_url($CFG->wwwroot . '/badges/index.php',
array('type' => BADGE_TYPE_COURSE, 'id' => $course->id));
$coursenode->get('coursebadges')->add(get_string('managebadges', 'badges'), $url,
navigation_node::TYPE_SETTING, null, 'coursebadges');
}
if (has_capability('moodle/badges:createbadge', $coursecontext)) {
$url = new moodle_url($CFG->wwwroot . '/badges/newbadge.php',
array('type' => BADGE_TYPE_COURSE, 'id' => $course->id));
$coursenode->get('coursebadges')->add(get_string('newbadge', 'badges'), $url,
navigation_node::TYPE_SETTING, null, 'newbadge');
}
}
}
}
/**
* Triggered when 'course_completed' event happens.
*
* @param object $eventdata
* @return boolean
*/
function badges_award_handle_course_criteria_review(stdClass $eventdata) {
global $DB, $CFG;
if (!empty($CFG->enablebadges)) {
$userid = $eventdata->userid;
$courseid = $eventdata->course;
// Need to take into account that course can be a part of course_completion and courseset_completion criteria.
if ($rs = $DB->get_records('badge_criteria_param', array('name' => 'course_' . $courseid, 'value' => $courseid))) {
foreach ($rs as $r) {
$crit = $DB->get_record('badge_criteria', array('id' => $r->critid), 'badgeid, criteriatype', MUST_EXIST);
$badge = new badge($crit->badgeid);
if (!$badge->is_active() || $badge->is_issued($userid)) {
continue;
}
if ($badge->criteria[$crit->criteriatype]->review($userid)) {
$badge->criteria[$crit->criteriatype]->mark_complete($userid);
if ($badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->review($userid)) {
$badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($userid);
$badge->issue($userid);
}
}
}
}
}
return true;
}
/**
* Triggered when 'activity_completed' event happens.
*
* @param object $eventdata
* @return boolean
*/
function badges_award_handle_activity_criteria_review(stdClass $eventdata) {
global $DB, $CFG;
if (!empty($CFG->enablebadges)) {
$userid = $eventdata->userid;
$mod = $eventdata->coursemoduleid;
if ($eventdata->completionstate == COMPLETION_COMPLETE
|| $eventdata->completionstate == COMPLETION_COMPLETE_PASS
|| $eventdata->completionstate == COMPLETION_COMPLETE_FAIL) {
// Need to take into account that there can be more than one badge with the same activity in its criteria.
if ($rs = $DB->get_records('badge_criteria_param', array('name' => 'module_' . $mod, 'value' => $mod))) {
foreach ($rs as $r) {
$bid = $DB->get_field('badge_criteria', 'badgeid', array('id' => $r->critid), MUST_EXIST);
$badge = new badge($bid);
if (!$badge->is_active() || $badge->is_issued($userid)) {
continue;
}
if ($badge->criteria[BADGE_CRITERIA_TYPE_ACTIVITY]->review($userid)) {
$badge->criteria[BADGE_CRITERIA_TYPE_ACTIVITY]->mark_complete($userid);
if ($badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->review($userid)) {
$badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($userid);
$badge->issue($userid);
}
}
}
}
}
}
return true;
}