forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
renderer.php
1093 lines (955 loc) · 49.7 KB
/
renderer.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/>.
/**
* Renderer for use with the badges output
*
* @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>
*/
require_once($CFG->libdir . '/badgeslib.php');
require_once($CFG->libdir . '/tablelib.php');
/**
* Standard HTML output renderer for badges
*/
class core_badges_renderer extends plugin_renderer_base {
// Outputs badges list.
public function print_badges_list($badges, $userid, $profile = false, $external = false) {
global $USER, $CFG;
foreach ($badges as $badge) {
if (!$external) {
$context = ($badge->type == BADGE_TYPE_SITE) ? context_system::instance() : context_course::instance($badge->courseid);
$bname = $badge->name;
$imageurl = moodle_url::make_pluginfile_url($context->id, 'badges', 'badgeimage', $badge->id, '/', 'f1', false);
} else {
$bname = $badge->assertion->badge->name;
$imageurl = $badge->imageUrl;
}
$name = html_writer::tag('span', $bname, array('class' => 'badge-name'));
$image = html_writer::empty_tag('img', array('src' => $imageurl, 'class' => 'badge-image'));
if (!empty($badge->dateexpire) && $badge->dateexpire < time()) {
$image .= $this->output->pix_icon('i/expired',
get_string('expireddate', 'badges', userdate($badge->dateexpire)),
'moodle',
array('class' => 'expireimage'));
$name .= '(' . get_string('expired', 'badges') . ')';
}
$download = $status = $push = '';
if (($userid == $USER->id) && !$profile) {
$url = new moodle_url('mybadges.php', array('download' => $badge->id, 'hash' => $badge->uniquehash, 'sesskey' => sesskey()));
$notexpiredbadge = (empty($badge->dateexpire) || $badge->dateexpire > time());
$backpackexists = badges_user_has_backpack($USER->id);
if (!empty($CFG->badges_allowexternalbackpack) && $notexpiredbadge && $backpackexists) {
$assertion = new moodle_url('/badges/assertion.php', array('b' => $badge->uniquehash));
$action = new component_action('click', 'addtobackpack', array('assertion' => $assertion->out(false)));
$push = $this->output->action_icon(new moodle_url('#'), new pix_icon('t/backpack', get_string('addtobackpack', 'badges')), $action);
}
$download = $this->output->action_icon($url, new pix_icon('t/download', get_string('download')));
if ($badge->visible) {
$url = new moodle_url('mybadges.php', array('hide' => $badge->issuedid, 'sesskey' => sesskey()));
$status = $this->output->action_icon($url, new pix_icon('t/hide', get_string('makeprivate', 'badges')));
} else {
$url = new moodle_url('mybadges.php', array('show' => $badge->issuedid, 'sesskey' => sesskey()));
$status = $this->output->action_icon($url, new pix_icon('t/show', get_string('makepublic', 'badges')));
}
}
if (!$profile) {
$url = new moodle_url('badge.php', array('hash' => $badge->uniquehash));
} else {
if (!$external) {
$url = new moodle_url('/badges/badge.php', array('hash' => $badge->uniquehash));
} else {
$hash = hash('md5', $badge->hostedUrl);
$url = new moodle_url('/badges/external.php', array('hash' => $hash, 'user' => $userid));
}
}
$actions = html_writer::tag('div', $push . $download . $status, array('class' => 'badge-actions'));
$items[] = html_writer::link($url, $image . $actions . $name, array('title' => $bname));
}
return html_writer::alist($items, array('class' => 'badges'));
}
// Recipients selection form.
public function recipients_selection_form(user_selector_base $existinguc, user_selector_base $potentialuc) {
$output = '';
$formattributes = array();
$formattributes['id'] = 'recipientform';
$formattributes['action'] = $this->page->url;
$formattributes['method'] = 'post';
$output .= html_writer::start_tag('form', $formattributes);
$output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'sesskey', 'value' => sesskey()));
$existingcell = new html_table_cell();
$existingcell->text = $existinguc->display(true);
$existingcell->attributes['class'] = 'existing';
$actioncell = new html_table_cell();
$actioncell->text = html_writer::start_tag('div', array());
$actioncell->text .= html_writer::empty_tag('input', array(
'type' => 'submit',
'name' => 'award',
'value' => $this->output->larrow() . ' ' . get_string('award', 'badges'),
'class' => 'actionbutton')
);
$actioncell->text .= html_writer::end_tag('div', array());
$actioncell->attributes['class'] = 'actions';
$potentialcell = new html_table_cell();
$potentialcell->text = $potentialuc->display(true);
$potentialcell->attributes['class'] = 'potential';
$table = new html_table();
$table->attributes['class'] = 'recipienttable boxaligncenter';
$table->data = array(new html_table_row(array($existingcell, $actioncell, $potentialcell)));
$output .= html_writer::table($table);
$output .= html_writer::end_tag('form');
return $output;
}
// Prints a badge overview infomation.
public function print_badge_overview($badge, $context) {
$display = "";
// Badge details.
$display .= html_writer::start_tag('fieldset', array('class' => 'generalbox'));
$display .= html_writer::tag('legend', get_string('badgedetails', 'badges'), array('class' => 'bold'));
$detailstable = new html_table();
$detailstable->attributes = array('class' => 'clearfix', 'id' => 'badgedetails');
$detailstable->data[] = array(get_string('name') . ":", $badge->name);
$detailstable->data[] = array(get_string('description', 'badges') . ":", $badge->description);
$detailstable->data[] = array(get_string('createdon', 'search') . ":", userdate($badge->timecreated));
$detailstable->data[] = array(get_string('badgeimage', 'badges') . ":",
print_badge_image($badge, $context, 'large'));
$display .= html_writer::table($detailstable);
$display .= html_writer::end_tag('fieldset');
// Issuer details.
$display .= html_writer::start_tag('fieldset', array('class' => 'generalbox'));
$display .= html_writer::tag('legend', get_string('issuerdetails', 'badges'), array('class' => 'bold'));
$issuertable = new html_table();
$issuertable->attributes = array('class' => 'clearfix', 'id' => 'badgeissuer');
$issuertable->data[] = array(get_string('issuername', 'badges') . ":", $badge->issuername);
$issuertable->data[] = array(get_string('contact', 'badges') . ":",
html_writer::tag('a', $badge->issuercontact, array('href' => 'mailto:' . $badge->issuercontact)));
$display .= html_writer::table($issuertable);
$display .= html_writer::end_tag('fieldset');
// Issuance details if any.
$display .= html_writer::start_tag('fieldset', array('class' => 'generalbox'));
$display .= html_writer::tag('legend', get_string('issuancedetails', 'badges'), array('class' => 'bold'));
if ($badge->can_expire()) {
if ($badge->expiredate) {
$display .= get_string('expiredate', 'badges', userdate($badge->expiredate));
} else if ($badge->expireperiod) {
if ($badge->expireperiod < 60) {
$display .= get_string('expireperiods', 'badges', round($badge->expireperiod, 2));
} else if ($badge->expireperiod < 60 * 60) {
$display .= get_string('expireperiodm', 'badges', round($badge->expireperiod / 60, 2));
} else if ($badge->expireperiod < 60 * 60 * 24) {
$display .= get_string('expireperiodh', 'badges', round($badge->expireperiod / 60 / 60, 2));
} else {
$display .= get_string('expireperiod', 'badges', round($badge->expireperiod / 60 / 60 / 24, 2));
}
}
} else {
$display .= get_string('noexpiry', 'badges');
}
$display .= html_writer::end_tag('fieldset');
// Criteria details if any.
$display .= html_writer::start_tag('fieldset', array('class' => 'generalbox'));
$display .= html_writer::tag('legend', get_string('bcriteria', 'badges'), array('class' => 'bold'));
if ($badge->has_criteria()) {
$display .= self::print_badge_criteria($badge);
} else {
$display .= get_string('nocriteria', 'badges');
if (has_capability('moodle/badges:configurecriteria', $context)) {
$display .= $this->output->single_button(
new moodle_url('/badges/criteria.php', array('id' => $badge->id)),
get_string('addcriteria', 'badges'), 'POST', array('class' => 'activatebadge'));
}
}
$display .= html_writer::end_tag('fieldset');
// Awards details if any.
if (has_capability('moodle/badges:viewawarded', $context)) {
$display .= html_writer::start_tag('fieldset', array('class' => 'generalbox'));
$display .= html_writer::tag('legend', get_string('awards', 'badges'), array('class' => 'bold'));
if ($badge->has_awards()) {
$url = new moodle_url('/badges/recipients.php', array('id' => $badge->id));
$a = new stdClass();
$a->link = $url->out();
$a->count = count($badge->get_awards());
$display .= get_string('numawards', 'badges', $a);
} else {
$display .= get_string('noawards', 'badges');
}
if (has_capability('moodle/badges:awardbadge', $context) &&
$badge->has_manual_award_criteria() &&
$badge->is_active()) {
$display .= $this->output->single_button(
new moodle_url('/badges/award.php', array('id' => $badge->id)),
get_string('award', 'badges'), 'POST', array('class' => 'activatebadge'));
}
$display .= html_writer::end_tag('fieldset');
}
return $display;
}
// Prints action icons for the badge.
public function print_badge_table_actions($badge, $context) {
$actions = "";
if (has_capability('moodle/badges:configuredetails', $context)) {
// Activate/deactivate badge.
if ($badge->status == BADGE_STATUS_INACTIVE || $badge->status == BADGE_STATUS_INACTIVE_LOCKED) {
$url = new moodle_url(qualified_me());
$url->param('activate', $badge->id);
$url->param('sesskey', sesskey());
$actions .= $this->output->action_icon($url, new pix_icon('t/show', get_string('activate', 'badges'))) . " ";
} else {
$url = new moodle_url(qualified_me());
$url->param('lock', $badge->id);
$url->param('sesskey', sesskey());
$actions .= $this->output->action_icon($url, new pix_icon('t/hide', get_string('deactivate', 'badges'))) . " ";
}
}
// Award badge manually.
if ($badge->has_manual_award_criteria() &&
has_capability('moodle/badges:awardbadge', $context) &&
$badge->is_active()) {
$url = new moodle_url('/badges/award.php', array('id' => $badge->id));
$actions .= $this->output->action_icon($url, new pix_icon('t/award', get_string('award', 'badges'))) . " ";
}
// Edit badge.
if (has_capability('moodle/badges:configuredetails', $context)) {
$url = new moodle_url('/badges/edit.php', array('id' => $badge->id, 'action' => 'details'));
$actions .= $this->output->action_icon($url, new pix_icon('t/edit', get_string('edit'))) . " ";
}
// Duplicate badge.
if (has_capability('moodle/badges:createbadge', $context)) {
$url = new moodle_url('/badges/action.php', array('copy' => '1', 'id' => $badge->id, 'sesskey' => sesskey()));
$actions .= $this->output->action_icon($url, new pix_icon('t/copy', get_string('copy'))) . " ";
}
// Delete badge.
if (has_capability('moodle/badges:deletebadge', $context)) {
$url = new moodle_url(qualified_me());
$url->param('delete', $badge->id);
$actions .= $this->output->action_icon($url, new pix_icon('t/delete', get_string('delete'))) . " ";
}
return $actions;
}
// Outputs issued badge with actions available.
protected function render_issued_badge(issued_badge $ibadge) {
global $USER, $CFG, $DB;
$issued = $ibadge->issued;
$userinfo = $ibadge->recipient;
$badge = new badge($ibadge->badgeid);
$today_date = date('Y-m-d');
$today = strtotime($today_date);
$table = new html_table();
$table->id = 'issued-badge-table';
$imagetable = new html_table();
$imagetable->attributes = array('class' => 'clearfix badgeissuedimage');
$imagetable->data[] = array(html_writer::empty_tag('img', array('src' => $issued['badge']['image'])));
if ($USER->id == $userinfo->id && !empty($CFG->enablebadges)) {
$imagetable->data[] = array($this->output->single_button(
new moodle_url('/badges/badge.php', array('hash' => $ibadge->hash, 'bake' => true)),
get_string('download'),
'POST'));
$expiration = isset($issued['expires']) ? strtotime($issued['expires']) : $today + 1;
if (!empty($CFG->badges_allowexternalbackpack) && ($expiration > $today) && badges_user_has_backpack($USER->id)) {
$assertion = new moodle_url('/badges/assertion.php', array('b' => $ibadge->hash));
$action = new component_action('click', 'addtobackpack', array('assertion' => $assertion->out(false)));
$attributes = array(
'type' => 'button',
'id' => 'addbutton',
'value' => get_string('addtobackpack', 'badges'));
$tobackpack = html_writer::tag('input', '', $attributes);
$this->output->add_action_handler($action, 'addbutton');
$imagetable->data[] = array($tobackpack);
}
}
$datatable = new html_table();
$datatable->attributes = array('class' => 'badgeissuedinfo');
$datatable->colclasses = array('bfield', 'bvalue');
// Recipient information.
$datatable->data[] = array($this->output->heading(get_string('recipientdetails', 'badges'), 3), '');
$datatable->data[] = array(get_string('name'), fullname($userinfo));
if (empty($userinfo->backpackemail)) {
$datatable->data[] = array(get_string('email'), obfuscate_mailto($userinfo->accountemail));
} else {
$datatable->data[] = array(get_string('email'), obfuscate_mailto($userinfo->backpackemail));
}
$datatable->data[] = array($this->output->heading(get_string('issuerdetails', 'badges'), 3), '');
$datatable->data[] = array(get_string('issuername', 'badges'), $badge->issuername);
if (isset($badge->issuercontact) && !empty($badge->issuercontact)) {
$datatable->data[] = array(get_string('contact', 'badges'), obfuscate_mailto($badge->issuercontact));
}
$datatable->data[] = array($this->output->heading(get_string('badgedetails', 'badges'), 3), '');
$datatable->data[] = array(get_string('name'), $badge->name);
$datatable->data[] = array(get_string('description', 'badges'), $badge->description);
if ($badge->type == BADGE_TYPE_COURSE && isset($badge->courseid)) {
$coursename = $DB->get_field('course', 'fullname', array('id' => $badge->courseid));
$datatable->data[] = array(get_string('course'), $coursename);
}
$datatable->data[] = array(get_string('bcriteria', 'badges'), self::print_badge_criteria($badge));
$datatable->data[] = array($this->output->heading(get_string('issuancedetails', 'badges'), 3), '');
$datatable->data[] = array(get_string('dateawarded', 'badges'), $issued['issued_on']);
if (isset($issued['expires'])) {
$expiration = strtotime($issued['expires']);
if ($expiration < $today) {
$cell = new html_table_cell($issued['expires'] . get_string('warnexpired', 'badges'));
$cell->attributes = array('class' => 'notifyproblem warning');
$datatable->data[] = array(get_string('expirydate', 'badges'), $cell);
$image = html_writer::start_tag('div', array('class' => 'badge'));
$image .= html_writer::empty_tag('img', array('src' => $issued['badge']['image']));
$image .= $this->output->pix_icon('i/expired',
get_string('expireddate', 'badges', $issued['expires']),
'moodle',
array('class' => 'expireimage'));
$image .= html_writer::end_tag('div');
$imagetable->data[0] = array($image);
} else {
$datatable->data[] = array(get_string('expirydate', 'badges'), $issued['expires']);
}
}
// Print evidence.
$agg = $badge->get_aggregation_methods();
$evidence = $badge->get_criteria_completions($userinfo->id);
$eids = array_map(create_function('$o', 'return $o->critid;'), $evidence);
unset($badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]);
$items = array();
foreach ($badge->criteria as $type => $c) {
if (in_array($c->id, $eids)) {
if (count($c->params) == 1) {
$items[] = get_string('criteria_descr_single_' . $type , 'badges') . $c->get_details();
} else {
$items[] = get_string('criteria_descr_' . $type , 'badges',
strtoupper($agg[$badge->get_aggregation_method($type)])) . $c->get_details();
}
}
}
$datatable->data[] = array(get_string('evidence', 'badges'),
get_string('completioninfo', 'badges') .
html_writer::alist($items, array(), 'ul'));
$table->attributes = array('class' => 'generalbox boxaligncenter issuedbadgebox');
$table->data[] = array(html_writer::table($imagetable), html_writer::table($datatable));
$htmlbadge = html_writer::table($table);
return $htmlbadge;
}
// Outputs external badge.
protected function render_external_badge(external_badge $ibadge) {
$issued = $ibadge->issued;
$assertion = $issued->assertion;
$issuer = $assertion->badge->issuer;
$userinfo = $ibadge->recipient;
$table = new html_table();
$imagetable = new html_table();
$imagetable->attributes = array('class' => 'clearfix badgeissuedimage');
$imagetable->data[] = array(html_writer::empty_tag('img', array('src' => $issued->imageUrl, 'width' => '100px')));
$datatable = new html_table();
$datatable->attributes = array('class' => 'badgeissuedinfo');
$datatable->colclasses = array('bfield', 'bvalue');
// Recipient information.
$datatable->data[] = array($this->output->heading(get_string('recipientdetails', 'badges'), 3), '');
// Technically, we should alway have a user at this point, but added an extra check just in case.
if ($userinfo) {
$datatable->data[] = array(get_string('name'), fullname($userinfo));
if (!$ibadge->valid) {
$notify = $this->output->notification(get_string('recipientvalidationproblem', 'badges'), 'notifynotice');
$datatable->data[] = array(get_string('email'), obfuscate_mailto($userinfo->email) . $notify);
} else {
$datatable->data[] = array(get_string('email'), obfuscate_mailto($userinfo->email));
}
} else {
$notify = $this->output->notification(get_string('recipientidentificationproblem', 'badges'), 'notifynotice');
$datatable->data[] = array(get_string('name'), $notify);
}
$datatable->data[] = array($this->output->heading(get_string('issuerdetails', 'badges'), 3), '');
$datatable->data[] = array(get_string('issuername', 'badges'), $issuer->name);
$datatable->data[] = array(get_string('issuerurl', 'badges'),
html_writer::tag('a', $issuer->origin, array('href' => $issuer->origin)));
if (isset($issuer->contact)) {
$datatable->data[] = array(get_string('contact', 'badges'), obfuscate_mailto($issuer->contact));
}
$datatable->data[] = array($this->output->heading(get_string('badgedetails', 'badges'), 3), '');
$datatable->data[] = array(get_string('name'), $assertion->badge->name);
$datatable->data[] = array(get_string('description', 'badges'), $assertion->badge->description);
$datatable->data[] = array(get_string('bcriteria', 'badges'),
html_writer::tag('a', $assertion->badge->criteria, array('href' => $assertion->badge->criteria)));
$datatable->data[] = array($this->output->heading(get_string('issuancedetails', 'badges'), 3), '');
if (isset($assertion->issued_on)) {
$datatable->data[] = array(get_string('dateawarded', 'badges'), $assertion->issued_on);
}
if (isset($assertion->badge->expire)) {
$today_date = date('Y-m-d');
$today = strtotime($today_date);
$expiration = strtotime($assertion->badge->expire);
if ($expiration < $today) {
$cell = new html_table_cell($assertion->badge->expire . get_string('warnexpired', 'badges'));
$cell->attributes = array('class' => 'notifyproblem warning');
$datatable->data[] = array(get_string('expirydate', 'badges'), $cell);
$image = html_writer::start_tag('div', array('class' => 'badge'));
$image .= html_writer::empty_tag('img', array('src' => $issued['badge']['image']));
$image .= html_writer::start_tag('span', array('class' => 'expired'))
. $this->output->pix_icon('i/expired',
get_string('expireddate', 'badges', $assertion->badge->expire),
'moodle',
array('class' => 'expireimage'))
. html_writer::end_tag('span');
$image .= html_writer::end_tag('div');
$imagetable->data[0] = array($image);
} else {
$datatable->data[] = array(get_string('expirydate', 'badges'), $assertion->badge->expire);
}
}
if (isset($assertion->evidence)) {
$datatable->data[] = array(get_string('evidence', 'badges'),
html_writer::tag('a', $assertion->evidence, array('href' => $assertion->evidence)));
}
$table->attributes = array('class' => 'generalbox boxaligncenter issuedbadgebox');
$table->data[] = array(html_writer::table($imagetable), html_writer::table($datatable));
$htmlbadge = html_writer::table($table);
return $htmlbadge;
}
// Outputs table of user badges.
protected function render_badge_user_collection(badge_user_collection $badges) {
global $CFG, $USER, $SITE;
$backpack = $badges->backpack;
$mybackpack = new moodle_url('/badges/mybackpack.php');
$paging = new paging_bar($badges->totalcount, $badges->page, $badges->perpage, $this->page->url, 'page');
$htmlpagingbar = $this->render($paging);
// Set backpack connection string.
$backpackconnect = '';
if (!empty($CFG->badges_allowexternalbackpack) && is_null($backpack)) {
$backpackconnect = $this->output->box(get_string('localconnectto', 'badges', $mybackpack->out()), 'noticebox');
}
// Search box.
$searchform = $this->output->box($this->helper_search_form($badges->search), 'boxwidthwide boxaligncenter');
// Download all button.
$downloadall = $this->output->single_button(
new moodle_url('/badges/mybadges.php', array('downloadall' => true, 'sesskey' => sesskey())),
get_string('downloadall'), 'POST', array('class' => 'activatebadge'));
// Local badges.
$localhtml = html_writer::start_tag('fieldset', array('id' => 'issued-badge-table', 'class' => 'generalbox'));
$localhtml .= html_writer::tag('legend',
$this->output->heading_with_help(get_string('localbadges', 'badges', $SITE->fullname), 'localbadgesh', 'badges'));
if ($badges->badges) {
$table = new html_table();
$table->attributes['class'] = 'statustable';
$table->data[] = array($this->output->heading(get_string('badgesearned', 'badges', $badges->totalcount), 4, 'activatebadge'), $downloadall);
$downloadbutton = html_writer::table($table);
$htmllist = $this->print_badges_list($badges->badges, $USER->id);
$localhtml .= $backpackconnect . $downloadbutton . $searchform . $htmlpagingbar . $htmllist . $htmlpagingbar;
} else {
$localhtml .= $searchform . $this->output->notification(get_string('nobadges', 'badges'));
}
$localhtml .= html_writer::end_tag('fieldset');
// External badges.
$externalhtml = "";
if (!empty($CFG->badges_allowexternalbackpack)) {
$externalhtml .= html_writer::start_tag('fieldset', array('class' => 'generalbox'));
$externalhtml .= html_writer::tag('legend', $this->output->heading_with_help(get_string('externalbadges', 'badges'), 'externalbadges', 'badges'));
if (!is_null($backpack)) {
if ($backpack->totalcollections == 0) {
$externalhtml .= get_string('nobackpackcollections', 'badges', $backpack);
} else {
if ($backpack->totalbadges == 0) {
$externalhtml .= get_string('nobackpackbadges', 'badges', $backpack);
} else {
$externalhtml .= get_string('backpackbadges', 'badges', $backpack);
$externalhtml .= '<br/><br/>' . $this->print_badges_list($backpack->badges, $USER->id, true, true);
}
}
} else {
$externalhtml .= get_string('externalconnectto', 'badges', $mybackpack->out());
}
$externalhtml .= html_writer::end_tag('fieldset');
}
return $localhtml . $externalhtml;
}
// Outputs table of available badges.
protected function render_badge_collection(badge_collection $badges) {
$paging = new paging_bar($badges->totalcount, $badges->page, $badges->perpage, $this->page->url, 'page');
$htmlpagingbar = $this->render($paging);
$table = new html_table();
$table->attributes['class'] = 'collection';
$sortbyname = $this->helper_sortable_heading(get_string('name'),
'name', $badges->sort, $badges->dir);
$sortbyawarded = $this->helper_sortable_heading(get_string('awardedtoyou', 'badges'),
'dateissued', $badges->sort, $badges->dir);
$table->head = array(
get_string('badgeimage', 'badges'),
$sortbyname,
get_string('description', 'badges'),
get_string('bcriteria', 'badges'),
$sortbyawarded
);
$table->colclasses = array('badgeimage', 'name', 'description', 'criteria', 'awards');
foreach ($badges->badges as $badge) {
$badgeimage = print_badge_image($badge, $this->page->context, 'large');
$name = $badge->name;
$description = $badge->description;
$criteria = self::print_badge_criteria($badge);
if ($badge->dateissued) {
$icon = new pix_icon('i/valid',
get_string('dateearned', 'badges',
userdate($badge->dateissued, get_string('strftimedatefullshort', 'core_langconfig'))));
$badgeurl = new moodle_url('/badges/badge.php', array('hash' => $badge->uniquehash));
$awarded = $this->output->action_icon($badgeurl, $icon, null, null, true);
} else {
$awarded = "";
}
$row = array($badgeimage, $name, $description, $criteria, $awarded);
$table->data[] = $row;
}
$htmltable = html_writer::table($table);
return $htmlpagingbar . $htmltable . $htmlpagingbar;
}
// Outputs table of badges with actions available.
protected function render_badge_management(badge_management $badges) {
$paging = new paging_bar($badges->totalcount, $badges->page, $badges->perpage, $this->page->url, 'page');
// New badge button.
$htmlnew = '';
if (has_capability('moodle/badges:createbadge', $this->page->context)) {
$n['type'] = $this->page->url->get_param('type');
$n['id'] = $this->page->url->get_param('id');
$htmlnew = $this->output->single_button(new moodle_url('newbadge.php', $n), get_string('newbadge', 'badges'));
}
$htmlpagingbar = $this->render($paging);
$table = new html_table();
$table->attributes['class'] = 'collection';
$sortbyname = $this->helper_sortable_heading(get_string('name'),
'name', $badges->sort, $badges->dir);
$sortbystatus = $this->helper_sortable_heading(get_string('status', 'badges'),
'status', $badges->sort, $badges->dir);
$table->head = array(
$sortbyname,
$sortbystatus,
get_string('bcriteria', 'badges'),
get_string('awards', 'badges'),
get_string('actions')
);
$table->colclasses = array('name', 'status', 'criteria', 'awards', 'actions');
foreach ($badges->badges as $b) {
$style = !$b->is_active() ? array('class' => 'dimmed') : array();
$forlink = print_badge_image($b, $this->page->context) . ' ' .
html_writer::start_tag('span') . $b->name . html_writer::end_tag('span');
$name = html_writer::link(new moodle_url('/badges/overview.php', array('id' => $b->id)), $forlink, $style);
$status = $b->statstring;
$criteria = self::print_badge_criteria($b, 'short');
if (has_capability('moodle/badges:viewawarded', $this->page->context)) {
$awards = html_writer::link(new moodle_url('/badges/recipients.php', array('id' => $b->id)), $b->awards);
} else {
$awards = $b->awards;
}
$actions = self::print_badge_table_actions($b, $this->page->context);
$row = array($name, $status, $criteria, $awards, $actions);
$table->data[] = $row;
}
$htmltable = html_writer::table($table);
return $htmlnew . $htmlpagingbar . $htmltable . $htmlpagingbar;
}
// Prints tabs for badge editing.
public function print_badge_tabs($badgeid, $context, $current = 'overview') {
global $DB;
$row = array();
$row[] = new tabobject('overview',
new moodle_url('/badges/overview.php', array('id' => $badgeid)),
get_string('boverview', 'badges')
);
if (has_capability('moodle/badges:configuredetails', $context)) {
$row[] = new tabobject('details',
new moodle_url('/badges/edit.php', array('id' => $badgeid, 'action' => 'details')),
get_string('bdetails', 'badges')
);
}
if (has_capability('moodle/badges:configurecriteria', $context)) {
$row[] = new tabobject('criteria',
new moodle_url('/badges/criteria.php', array('id' => $badgeid)),
get_string('bcriteria', 'badges')
);
}
if (has_capability('moodle/badges:configuremessages', $context)) {
$row[] = new tabobject('message',
new moodle_url('/badges/edit.php', array('id' => $badgeid, 'action' => 'message')),
get_string('bmessage', 'badges')
);
}
if (has_capability('moodle/badges:viewawarded', $context)) {
$awarded = $DB->count_records('badge_issued', array('badgeid' => $badgeid));
$row[] = new tabobject('awards',
new moodle_url('/badges/recipients.php', array('id' => $badgeid)),
get_string('bawards', 'badges', $awarded)
);
}
echo $this->tabtree($row, $current);
}
/**
* Prints badge status box.
* @return Either the status box html as a string or null
*/
public function print_badge_status_box(badge $badge) {
if (has_capability('moodle/badges:configurecriteria', $badge->get_context())) {
$table = new html_table();
$table->attributes['class'] = 'boxaligncenter statustable';
if (!$badge->has_criteria()) {
$criteriaurl = new moodle_url('/badges/criteria.php', array('id' => $badge->id));
$status = get_string('nocriteria', 'badges');
if ($this->page->url != $criteriaurl) {
$action = $this->output->single_button(
$criteriaurl,
get_string('addcriteria', 'badges'), 'POST', array('class' => 'activatebadge'));
} else {
$action = '';
}
$row = array($status, $action);
} else {
$status = get_string('statusmessage_' . $badge->status, 'badges');
if ($badge->is_active()) {
$action = $this->output->single_button(new moodle_url('/badges/action.php',
array('id' => $badge->id, 'lock' => 1, 'sesskey' => sesskey(),
'return' => $this->page->url->out_as_local_url(false))),
get_string('deactivate', 'badges'), 'POST', array('class' => 'activatebadge'));
} else {
$action = $this->output->single_button(new moodle_url('/badges/action.php',
array('id' => $badge->id, 'activate' => 1, 'sesskey' => sesskey(),
'return' => $this->page->url->out_as_local_url(false))),
get_string('activate', 'badges'), 'POST', array('class' => 'activatebadge'));
}
$row = array($status . $this->output->help_icon('status', 'badges'), $action);
}
$table->data[] = $row;
$style = $badge->is_active() ? 'generalbox statusbox active' : 'generalbox statusbox inactive';
return $this->output->box(html_writer::table($table), $style);
}
return null;
}
// Prints badge criteria.
public function print_badge_criteria(badge $badge, $short = '') {
$output = "";
$agg = $badge->get_aggregation_methods();
if (empty($badge->criteria)) {
return get_string('nocriteria', 'badges');
} else if (count($badge->criteria) == 2) {
if (!$short) {
$output .= get_string('criteria_descr', 'badges');
}
} else {
$output .= get_string('criteria_descr_' . $short . BADGE_CRITERIA_TYPE_OVERALL, 'badges',
strtoupper($agg[$badge->get_aggregation_method()]));
}
$items = array();
unset($badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]);
foreach ($badge->criteria as $type => $c) {
if (count($c->params) == 1) {
$items[] = get_string('criteria_descr_single_' . $short . $type , 'badges') . $c->get_details($short);
} else {
$items[] = get_string('criteria_descr_' . $short . $type , 'badges',
strtoupper($agg[$badge->get_aggregation_method($type)])) . $c->get_details($short);
}
}
$output .= html_writer::alist($items, array(), 'ul');
return $output;
}
// Prints criteria actions for badge editing.
public function print_criteria_actions(badge $badge) {
$table = new html_table();
$table->attributes = array('class' => 'boxaligncenter', 'id' => 'badgeactions');
$table->colclasses = array('activatebadge');
$actions = array();
if (!$badge->is_active() && !$badge->is_locked()) {
$accepted = $badge->get_accepted_criteria();
$potential = array_diff($accepted, array_keys($badge->criteria));
if (!empty($potential)) {
foreach ($potential as $p) {
if ($p != 0) {
$select[$p] = get_string('criteria_' . $p, 'badges');
}
}
$actions[] = get_string('addbadgecriteria', 'badges');
$actions[] = $this->output->single_select(new moodle_url('/badges/criteria_settings.php',
array('badgeid' => $badge->id, 'add' => true)), 'type', $select);
} else {
$actions[] = $this->output->box(get_string('nothingtoadd', 'badges'), 'clearfix');
}
}
$table->data[] = $actions;
return html_writer::table($table);
}
// Renders a table with users who have earned the badge.
// Based on stamps collection plugin.
protected function render_badge_recipients(badge_recipients $recipients) {
$paging = new paging_bar($recipients->totalcount, $recipients->page, $recipients->perpage, $this->page->url, 'page');
$htmlpagingbar = $this->render($paging);
$table = new html_table();
$table->attributes['class'] = 'generaltable boxaligncenter boxwidthwide';
$sortbyfirstname = $this->helper_sortable_heading(get_string('firstname'),
'firstname', $recipients->sort, $recipients->dir);
$sortbylastname = $this->helper_sortable_heading(get_string('lastname'),
'lastname', $recipients->sort, $recipients->dir);
if ($this->helper_fullname_format() == 'lf') {
$sortbyname = $sortbylastname . ' / ' . $sortbyfirstname;
} else {
$sortbyname = $sortbyfirstname . ' / ' . $sortbylastname;
}
$sortbydate = $this->helper_sortable_heading(get_string('dateawarded', 'badges'),
'dateissued', $recipients->sort, $recipients->dir);
$table->head = array($sortbyname, $sortbydate, '');
foreach ($recipients->userids as $holder) {
$fullname = fullname($holder);
$fullname = html_writer::link(
new moodle_url('/user/profile.php', array('id' => $holder->userid)),
$fullname
);
$awarded = userdate($holder->dateissued);
$badgeurl = html_writer::link(
new moodle_url('/badges/badge.php', array('hash' => $holder->uniquehash)),
get_string('viewbadge', 'badges')
);
$row = array($fullname, $awarded, $badgeurl);
$table->data[] = $row;
}
$htmltable = html_writer::table($table);
return $htmlpagingbar . $htmltable . $htmlpagingbar;
}
////////////////////////////////////////////////////////////////////////////
// Helper methods
// Reused from stamps collection plugin
////////////////////////////////////////////////////////////////////////////
/**
* Renders a text with icons to sort by the given column
*
* This is intended for table headings.
*
* @param string $text The heading text
* @param string $sortid The column id used for sorting
* @param string $sortby Currently sorted by (column id)
* @param string $sorthow Currently sorted how (ASC|DESC)
*
* @return string
*/
protected function helper_sortable_heading($text, $sortid = null, $sortby = null, $sorthow = null) {
$out = html_writer::tag('span', $text, array('class' => 'text'));
if (!is_null($sortid)) {
if ($sortby !== $sortid || $sorthow !== 'ASC') {
$url = new moodle_url($this->page->url);
$url->params(array('sort' => $sortid, 'dir' => 'ASC'));
$out .= $this->output->action_icon($url,
new pix_icon('t/sort_asc', get_string('sortbyx', 'core', s($text)), null, array('class' => 'iconsort')));
}
if ($sortby !== $sortid || $sorthow !== 'DESC') {
$url = new moodle_url($this->page->url);
$url->params(array('sort' => $sortid, 'dir' => 'DESC'));
$out .= $this->output->action_icon($url,
new pix_icon('t/sort_desc', get_string('sortbyxreverse', 'core', s($text)), null, array('class' => 'iconsort')));
}
}
return $out;
}
/**
* Tries to guess the fullname format set at the site
*
* @return string fl|lf
*/
protected function helper_fullname_format() {
$fake = new stdClass();
$fake->lastname = 'LLLL';
$fake->firstname = 'FFFF';
$fullname = get_string('fullnamedisplay', '', $fake);
if (strpos($fullname, 'LLLL') < strpos($fullname, 'FFFF')) {
return 'lf';
} else {
return 'fl';
}
}
/**
* Renders a search form
*
* @param string $search Search string
* @return string HTML
*/
protected function helper_search_form($search) {
global $CFG;
require_once($CFG->libdir . '/formslib.php');
$mform = new MoodleQuickForm('searchform', 'POST', $this->page->url);
$mform->addElement('hidden', 'sesskey', sesskey());
$el[] = $mform->createElement('text', 'search', get_string('search'), array('size' => 20));
$mform->setDefault('search', $search);
$el[] = $mform->createElement('submit', 'submitsearch', get_string('search'));
$el[] = $mform->createElement('submit', 'clearsearch', get_string('clear'));
$mform->addGroup($el, 'searchgroup', get_string('searchname', 'badges'), ' ', false);
ob_start();
$mform->display();
$out = ob_get_clean();
return $out;
}
}
/**
* An issued badges for badge.php page
*/
class issued_badge implements renderable {
/** @var issued badge */
public $issued;
/** @var badge recipient */
public $recipient;
/** @var badge visibility to others */
public $visible = 0;
/** @var badge class */
public $badgeid = 0;
/** @var issued badge unique hash */
public $hash = "";
/**
* Initializes the badge to display
*
* @param string $hash Issued badge hash
*/
public function __construct($hash) {
global $DB;
$this->issued = badges_get_issued_badge_info($hash);
$this->hash = $hash;
$rec = $DB->get_record_sql('SELECT userid, visible, badgeid
FROM {badge_issued}
WHERE ' . $DB->sql_compare_text('uniquehash', 40) . ' = ' . $DB->sql_compare_text(':hash', 40),
array('hash' => $hash), IGNORE_MISSING);
if ($rec) {
// Get a recipient from database.
$user = $DB->get_record_sql('SELECT u.id, u.lastname, u.firstname,
u.email AS accountemail, b.email AS backpackemail
FROM {user} u LEFT JOIN {badge_backpack} b ON u.id = b.userid
WHERE u.id = :userid', array('userid' => $rec->userid));
$this->recipient = $user;
$this->visible = $rec->visible;
$this->badgeid = $rec->badgeid;
}
}
}
/**
* An external badges for external.php page
*/
class external_badge implements renderable {
/** @var issued badge */
public $issued;
/** @var User ID */
public $recipient;
/** @var validation of external badge */
public $valid = true;
/**
* Initializes the badge to display
*
* @param object $badge External badge information.
* @param int $recipient User id.
*/
public function __construct($badge, $recipient) {
global $DB;
// At this point a user has connected a backpack. So, we are going to get
// their backpack email rather than their account email.
$user = $DB->get_record_sql('SELECT u.lastname, u.firstname, b.email
FROM {user} u INNER JOIN {badge_backpack} b ON u.id = b.userid
WHERE userid = :userid', array('userid' => $recipient), IGNORE_MISSING);
$this->issued = $badge;
$this->recipient = $user;
// Check if recipient is valid.
// There is no way to be 100% sure that a badge belongs to a user.
// Backpack does not return any recipient information.
// All we can do is compare that backpack email hashed using salt
// provided in the assertion matches a badge recipient from the assertion.
if ($user) {
if (validate_email($badge->assertion->recipient) && $badge->assertion->recipient == $user->email) {
// If we have email, compare emails.
$this->valid = true;
} else if ($badge->assertion->recipient == 'sha256$' . hash('sha256', $user->email)) {
// If recipient is hashed, but no salt, compare hashes without salt.
$this->valid = true;
} else if ($badge->assertion->recipient == 'sha256$' . hash('sha256', $user->email . $badge->assertion->salt)) {
// If recipient is hashed, compare hashes.
$this->valid = true;
} else {
// Otherwise, we cannot be sure that this user is a recipient.
$this->valid = false;
}
} else {
$this->valid = false;
}
}
}
/**
* Badge recipients rendering class