MDL-41659 badges: Display course/site names through format_string()
[moodle.git] / badges / renderer.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 * Renderer for use with the badges output
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
27require_once($CFG->libdir . '/badgeslib.php');
28require_once($CFG->libdir . '/tablelib.php');
27806552
YB
29
30/**
31 * Standard HTML output renderer for badges
32 */
33class core_badges_renderer extends plugin_renderer_base {
34
35 // Outputs badges list.
36 public function print_badges_list($badges, $userid, $profile = false, $external = false) {
37 global $USER, $CFG;
38 foreach ($badges as $badge) {
39 if (!$external) {
40 $context = ($badge->type == BADGE_TYPE_SITE) ? context_system::instance() : context_course::instance($badge->courseid);
41 $bname = $badge->name;
42 $imageurl = moodle_url::make_pluginfile_url($context->id, 'badges', 'badgeimage', $badge->id, '/', 'f1', false);
43 } else {
44 $bname = $badge->assertion->badge->name;
45 $imageurl = $badge->imageUrl;
46 }
47
48 $name = html_writer::tag('span', $bname, array('class' => 'badge-name'));
49
50 $image = html_writer::empty_tag('img', array('src' => $imageurl, 'class' => 'badge-image'));
51 if (!empty($badge->dateexpire) && $badge->dateexpire < time()) {
52 $image .= $this->output->pix_icon('i/expired',
53 get_string('expireddate', 'badges', userdate($badge->dateexpire)),
54 'moodle',
55 array('class' => 'expireimage'));
56 $name .= '(' . get_string('expired', 'badges') . ')';
57 }
58
59 $download = $status = $push = '';
60 if (($userid == $USER->id) && !$profile) {
61 $url = new moodle_url('mybadges.php', array('download' => $badge->id, 'hash' => $badge->uniquehash, 'sesskey' => sesskey()));
e2805314
YB
62 $notexpiredbadge = (empty($badge->dateexpire) || $badge->dateexpire > time());
63 $backpackexists = badges_user_has_backpack($USER->id);
64 if (!empty($CFG->badges_allowexternalbackpack) && $notexpiredbadge && $backpackexists) {
27806552
YB
65 $assertion = new moodle_url('/badges/assertion.php', array('b' => $badge->uniquehash));
66 $action = new component_action('click', 'addtobackpack', array('assertion' => $assertion->out(false)));
67 $push = $this->output->action_icon(new moodle_url('#'), new pix_icon('t/backpack', get_string('addtobackpack', 'badges')), $action);
68 }
69
70 $download = $this->output->action_icon($url, new pix_icon('t/download', get_string('download')));
71 if ($badge->visible) {
72 $url = new moodle_url('mybadges.php', array('hide' => $badge->issuedid, 'sesskey' => sesskey()));
73 $status = $this->output->action_icon($url, new pix_icon('t/hide', get_string('makeprivate', 'badges')));
74 } else {
75 $url = new moodle_url('mybadges.php', array('show' => $badge->issuedid, 'sesskey' => sesskey()));
76 $status = $this->output->action_icon($url, new pix_icon('t/show', get_string('makepublic', 'badges')));
77 }
78 }
79
80 if (!$profile) {
81 $url = new moodle_url('badge.php', array('hash' => $badge->uniquehash));
82 } else {
83 if (!$external) {
2d3c0fae 84 $url = new moodle_url('/badges/badge.php', array('hash' => $badge->uniquehash));
27806552 85 } else {
2d3c0fae
YB
86 $hash = hash('md5', $badge->hostedUrl);
87 $url = new moodle_url('/badges/external.php', array('hash' => $hash, 'user' => $userid));
27806552
YB
88 }
89 }
90 $actions = html_writer::tag('div', $push . $download . $status, array('class' => 'badge-actions'));
91 $items[] = html_writer::link($url, $image . $actions . $name, array('title' => $bname));
92 }
93
94 return html_writer::alist($items, array('class' => 'badges'));
95 }
96
97 // Recipients selection form.
98 public function recipients_selection_form(user_selector_base $existinguc, user_selector_base $potentialuc) {
99 $output = '';
100 $formattributes = array();
101 $formattributes['id'] = 'recipientform';
04da1a5a 102 $formattributes['action'] = $this->page->url;
27806552
YB
103 $formattributes['method'] = 'post';
104 $output .= html_writer::start_tag('form', $formattributes);
105 $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'sesskey', 'value' => sesskey()));
106
107 $existingcell = new html_table_cell();
108 $existingcell->text = $existinguc->display(true);
109 $existingcell->attributes['class'] = 'existing';
110 $actioncell = new html_table_cell();
111 $actioncell->text = html_writer::start_tag('div', array());
112 $actioncell->text .= html_writer::empty_tag('input', array(
113 'type' => 'submit',
114 'name' => 'award',
115 'value' => $this->output->larrow() . ' ' . get_string('award', 'badges'),
116 'class' => 'actionbutton')
117 );
118 $actioncell->text .= html_writer::end_tag('div', array());
119 $actioncell->attributes['class'] = 'actions';
120 $potentialcell = new html_table_cell();
121 $potentialcell->text = $potentialuc->display(true);
122 $potentialcell->attributes['class'] = 'potential';
123
124 $table = new html_table();
125 $table->attributes['class'] = 'recipienttable boxaligncenter';
126 $table->data = array(new html_table_row(array($existingcell, $actioncell, $potentialcell)));
127 $output .= html_writer::table($table);
128
129 $output .= html_writer::end_tag('form');
130 return $output;
131 }
132
133 // Prints a badge overview infomation.
134 public function print_badge_overview($badge, $context) {
135 $display = "";
136
137 // Badge details.
138 $display .= html_writer::start_tag('fieldset', array('class' => 'generalbox'));
139 $display .= html_writer::tag('legend', get_string('badgedetails', 'badges'), array('class' => 'bold'));
140
141 $detailstable = new html_table();
142 $detailstable->attributes = array('class' => 'clearfix', 'id' => 'badgedetails');
143 $detailstable->data[] = array(get_string('name') . ":", $badge->name);
144 $detailstable->data[] = array(get_string('description', 'badges') . ":", $badge->description);
145 $detailstable->data[] = array(get_string('createdon', 'search') . ":", userdate($badge->timecreated));
146 $detailstable->data[] = array(get_string('badgeimage', 'badges') . ":",
147 print_badge_image($badge, $context, 'large'));
148 $display .= html_writer::table($detailstable);
149 $display .= html_writer::end_tag('fieldset');
150
151 // Issuer details.
152 $display .= html_writer::start_tag('fieldset', array('class' => 'generalbox'));
153 $display .= html_writer::tag('legend', get_string('issuerdetails', 'badges'), array('class' => 'bold'));
154
155 $issuertable = new html_table();
156 $issuertable->attributes = array('class' => 'clearfix', 'id' => 'badgeissuer');
157 $issuertable->data[] = array(get_string('issuername', 'badges') . ":", $badge->issuername);
158 $issuertable->data[] = array(get_string('contact', 'badges') . ":",
159 html_writer::tag('a', $badge->issuercontact, array('href' => 'mailto:' . $badge->issuercontact)));
160 $display .= html_writer::table($issuertable);
161 $display .= html_writer::end_tag('fieldset');
162
163 // Issuance details if any.
164 $display .= html_writer::start_tag('fieldset', array('class' => 'generalbox'));
165 $display .= html_writer::tag('legend', get_string('issuancedetails', 'badges'), array('class' => 'bold'));
166 if ($badge->can_expire()) {
167 if ($badge->expiredate) {
168 $display .= get_string('expiredate', 'badges', userdate($badge->expiredate));
169 } else if ($badge->expireperiod) {
170 if ($badge->expireperiod < 60) {
171 $display .= get_string('expireperiods', 'badges', round($badge->expireperiod, 2));
172 } else if ($badge->expireperiod < 60 * 60) {
173 $display .= get_string('expireperiodm', 'badges', round($badge->expireperiod / 60, 2));
174 } else if ($badge->expireperiod < 60 * 60 * 24) {
175 $display .= get_string('expireperiodh', 'badges', round($badge->expireperiod / 60 / 60, 2));
176 } else {
177 $display .= get_string('expireperiod', 'badges', round($badge->expireperiod / 60 / 60 / 24, 2));
178 }
179 }
180 } else {
181 $display .= get_string('noexpiry', 'badges');
182 }
183 $display .= html_writer::end_tag('fieldset');
184
185 // Criteria details if any.
186 $display .= html_writer::start_tag('fieldset', array('class' => 'generalbox'));
187 $display .= html_writer::tag('legend', get_string('bcriteria', 'badges'), array('class' => 'bold'));
188 if ($badge->has_criteria()) {
189 $display .= self::print_badge_criteria($badge);
190 } else {
191 $display .= get_string('nocriteria', 'badges');
192 if (has_capability('moodle/badges:configurecriteria', $context)) {
193 $display .= $this->output->single_button(
194 new moodle_url('/badges/criteria.php', array('id' => $badge->id)),
195 get_string('addcriteria', 'badges'), 'POST', array('class' => 'activatebadge'));
196 }
197 }
198 $display .= html_writer::end_tag('fieldset');
199
200 // Awards details if any.
201 if (has_capability('moodle/badges:viewawarded', $context)) {
202 $display .= html_writer::start_tag('fieldset', array('class' => 'generalbox'));
203 $display .= html_writer::tag('legend', get_string('awards', 'badges'), array('class' => 'bold'));
204 if ($badge->has_awards()) {
205 $url = new moodle_url('/badges/recipients.php', array('id' => $badge->id));
206 $a = new stdClass();
207 $a->link = $url->out();
208 $a->count = count($badge->get_awards());
209 $display .= get_string('numawards', 'badges', $a);
210 } else {
211 $display .= get_string('noawards', 'badges');
212 }
213
214 if (has_capability('moodle/badges:awardbadge', $context) &&
215 $badge->has_manual_award_criteria() &&
216 $badge->is_active()) {
217 $display .= $this->output->single_button(
218 new moodle_url('/badges/award.php', array('id' => $badge->id)),
219 get_string('award', 'badges'), 'POST', array('class' => 'activatebadge'));
220 }
221 $display .= html_writer::end_tag('fieldset');
222 }
223
224 return $display;
225 }
226
227 // Prints action icons for the badge.
228 public function print_badge_table_actions($badge, $context) {
229 $actions = "";
230
4d7d17dd 231 if (has_capability('moodle/badges:configuredetails', $context) && $badge->has_criteria()) {
27806552
YB
232 // Activate/deactivate badge.
233 if ($badge->status == BADGE_STATUS_INACTIVE || $badge->status == BADGE_STATUS_INACTIVE_LOCKED) {
4d7d17dd
YB
234 // "Activate" will go to another page and ask for confirmation.
235 $url = new moodle_url('/badges/action.php');
236 $url->param('id', $badge->id);
237 $url->param('activate', true);
c5177654 238 $url->param('sesskey', sesskey());
4d7d17dd
YB
239 $return = new moodle_url(qualified_me());
240 $url->param('return', $return->out_as_local_url(false));
27806552
YB
241 $actions .= $this->output->action_icon($url, new pix_icon('t/show', get_string('activate', 'badges'))) . " ";
242 } else {
243 $url = new moodle_url(qualified_me());
244 $url->param('lock', $badge->id);
245 $url->param('sesskey', sesskey());
246 $actions .= $this->output->action_icon($url, new pix_icon('t/hide', get_string('deactivate', 'badges'))) . " ";
247 }
248 }
249
250 // Award badge manually.
251 if ($badge->has_manual_award_criteria() &&
252 has_capability('moodle/badges:awardbadge', $context) &&
253 $badge->is_active()) {
254 $url = new moodle_url('/badges/award.php', array('id' => $badge->id));
255 $actions .= $this->output->action_icon($url, new pix_icon('t/award', get_string('award', 'badges'))) . " ";
256 }
257
258 // Edit badge.
259 if (has_capability('moodle/badges:configuredetails', $context)) {
260 $url = new moodle_url('/badges/edit.php', array('id' => $badge->id, 'action' => 'details'));
261 $actions .= $this->output->action_icon($url, new pix_icon('t/edit', get_string('edit'))) . " ";
262 }
263
264 // Duplicate badge.
265 if (has_capability('moodle/badges:createbadge', $context)) {
266 $url = new moodle_url('/badges/action.php', array('copy' => '1', 'id' => $badge->id, 'sesskey' => sesskey()));
267 $actions .= $this->output->action_icon($url, new pix_icon('t/copy', get_string('copy'))) . " ";
268 }
269
270 // Delete badge.
271 if (has_capability('moodle/badges:deletebadge', $context)) {
272 $url = new moodle_url(qualified_me());
273 $url->param('delete', $badge->id);
274 $actions .= $this->output->action_icon($url, new pix_icon('t/delete', get_string('delete'))) . " ";
275 }
276
277 return $actions;
278 }
279
280 // Outputs issued badge with actions available.
281 protected function render_issued_badge(issued_badge $ibadge) {
282 global $USER, $CFG, $DB;
283 $issued = $ibadge->issued;
737a352f 284 $userinfo = $ibadge->recipient;
27806552
YB
285 $badge = new badge($ibadge->badgeid);
286 $today_date = date('Y-m-d');
287 $today = strtotime($today_date);
288
e2805314 289 $table = new html_table();
2c910861 290 $table->id = 'issued-badge-table';
27806552 291
e2805314
YB
292 $imagetable = new html_table();
293 $imagetable->attributes = array('class' => 'clearfix badgeissuedimage');
294 $imagetable->data[] = array(html_writer::empty_tag('img', array('src' => $issued['badge']['image'])));
737a352f 295 if ($USER->id == $userinfo->id && !empty($CFG->enablebadges)) {
e2805314
YB
296 $imagetable->data[] = array($this->output->single_button(
297 new moodle_url('/badges/badge.php', array('hash' => $ibadge->hash, 'bake' => true)),
298 get_string('download'),
299 'POST'));
300 $expiration = isset($issued['expires']) ? strtotime($issued['expires']) : $today + 1;
301 if (!empty($CFG->badges_allowexternalbackpack) && ($expiration > $today) && badges_user_has_backpack($USER->id)) {
302 $assertion = new moodle_url('/badges/assertion.php', array('b' => $ibadge->hash));
2c910861 303 $action = new component_action('click', 'addtobackpack', array('assertion' => $assertion->out(false)));
e2805314 304 $attributes = array(
2c910861
YB
305 'type' => 'button',
306 'id' => 'addbutton',
307 'value' => get_string('addtobackpack', 'badges'));
e2805314 308 $tobackpack = html_writer::tag('input', '', $attributes);
2c910861 309 $this->output->add_action_handler($action, 'addbutton');
e2805314 310 $imagetable->data[] = array($tobackpack);
27806552 311 }
e2805314
YB
312 }
313 $datatable = new html_table();
314 $datatable->attributes = array('class' => 'badgeissuedinfo');
315 $datatable->colclasses = array('bfield', 'bvalue');
737a352f
YB
316
317 // Recipient information.
318 $datatable->data[] = array($this->output->heading(get_string('recipientdetails', 'badges'), 3), '');
319 $datatable->data[] = array(get_string('name'), fullname($userinfo));
320 if (empty($userinfo->backpackemail)) {
321 $datatable->data[] = array(get_string('email'), obfuscate_mailto($userinfo->accountemail));
322 } else {
323 $datatable->data[] = array(get_string('email'), obfuscate_mailto($userinfo->backpackemail));
324 }
325
e2805314
YB
326 $datatable->data[] = array($this->output->heading(get_string('issuerdetails', 'badges'), 3), '');
327 $datatable->data[] = array(get_string('issuername', 'badges'), $badge->issuername);
328 if (isset($badge->issuercontact) && !empty($badge->issuercontact)) {
737a352f 329 $datatable->data[] = array(get_string('contact', 'badges'), obfuscate_mailto($badge->issuercontact));
e2805314
YB
330 }
331 $datatable->data[] = array($this->output->heading(get_string('badgedetails', 'badges'), 3), '');
332 $datatable->data[] = array(get_string('name'), $badge->name);
333 $datatable->data[] = array(get_string('description', 'badges'), $badge->description);
27806552 334
e2805314
YB
335 if ($badge->type == BADGE_TYPE_COURSE && isset($badge->courseid)) {
336 $coursename = $DB->get_field('course', 'fullname', array('id' => $badge->courseid));
337 $datatable->data[] = array(get_string('course'), $coursename);
338 }
27806552 339
e2805314
YB
340 $datatable->data[] = array(get_string('bcriteria', 'badges'), self::print_badge_criteria($badge));
341 $datatable->data[] = array($this->output->heading(get_string('issuancedetails', 'badges'), 3), '');
342 $datatable->data[] = array(get_string('dateawarded', 'badges'), $issued['issued_on']);
343 if (isset($issued['expires'])) {
344 $expiration = strtotime($issued['expires']);
345 if ($expiration < $today) {
346 $cell = new html_table_cell($issued['expires'] . get_string('warnexpired', 'badges'));
347 $cell->attributes = array('class' => 'notifyproblem warning');
348 $datatable->data[] = array(get_string('expirydate', 'badges'), $cell);
349
350 $image = html_writer::start_tag('div', array('class' => 'badge'));
351 $image .= html_writer::empty_tag('img', array('src' => $issued['badge']['image']));
352 $image .= $this->output->pix_icon('i/expired',
353 get_string('expireddate', 'badges', $issued['expires']),
354 'moodle',
355 array('class' => 'expireimage'));
356 $image .= html_writer::end_tag('div');
357 $imagetable->data[0] = array($image);
358 } else {
359 $datatable->data[] = array(get_string('expirydate', 'badges'), $issued['expires']);
27806552 360 }
e2805314 361 }
27806552 362
e2805314
YB
363 // Print evidence.
364 $agg = $badge->get_aggregation_methods();
737a352f 365 $evidence = $badge->get_criteria_completions($userinfo->id);
e2805314
YB
366 $eids = array_map(create_function('$o', 'return $o->critid;'), $evidence);
367 unset($badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]);
368
369 $items = array();
370 foreach ($badge->criteria as $type => $c) {
371 if (in_array($c->id, $eids)) {
372 if (count($c->params) == 1) {
373 $items[] = get_string('criteria_descr_single_' . $type , 'badges') . $c->get_details();
374 } else {
375 $items[] = get_string('criteria_descr_' . $type , 'badges',
376 strtoupper($agg[$badge->get_aggregation_method($type)])) . $c->get_details();
27806552
YB
377 }
378 }
e2805314 379 }
27806552 380
e2805314
YB
381 $datatable->data[] = array(get_string('evidence', 'badges'),
382 get_string('completioninfo', 'badges') .
383 html_writer::alist($items, array(), 'ul'));
384 $table->attributes = array('class' => 'generalbox boxaligncenter issuedbadgebox');
385 $table->data[] = array(html_writer::table($imagetable), html_writer::table($datatable));
386 $htmlbadge = html_writer::table($table);
27806552 387
e2805314 388 return $htmlbadge;
27806552
YB
389 }
390
391 // Outputs external badge.
392 protected function render_external_badge(external_badge $ibadge) {
393 $issued = $ibadge->issued;
394 $assertion = $issued->assertion;
395 $issuer = $assertion->badge->issuer;
737a352f 396 $userinfo = $ibadge->recipient;
27806552
YB
397 $table = new html_table();
398
399 $imagetable = new html_table();
400 $imagetable->attributes = array('class' => 'clearfix badgeissuedimage');
401 $imagetable->data[] = array(html_writer::empty_tag('img', array('src' => $issued->imageUrl, 'width' => '100px')));
402
403 $datatable = new html_table();
404 $datatable->attributes = array('class' => 'badgeissuedinfo');
405 $datatable->colclasses = array('bfield', 'bvalue');
737a352f
YB
406
407 // Recipient information.
408 $datatable->data[] = array($this->output->heading(get_string('recipientdetails', 'badges'), 3), '');
409 // Technically, we should alway have a user at this point, but added an extra check just in case.
410 if ($userinfo) {
411 $datatable->data[] = array(get_string('name'), fullname($userinfo));
412 if (!$ibadge->valid) {
413 $notify = $this->output->notification(get_string('recipientvalidationproblem', 'badges'), 'notifynotice');
414 $datatable->data[] = array(get_string('email'), obfuscate_mailto($userinfo->email) . $notify);
415 } else {
416 $datatable->data[] = array(get_string('email'), obfuscate_mailto($userinfo->email));
417 }
418 } else {
419 $notify = $this->output->notification(get_string('recipientidentificationproblem', 'badges'), 'notifynotice');
420 $datatable->data[] = array(get_string('name'), $notify);
421 }
422
27806552
YB
423 $datatable->data[] = array($this->output->heading(get_string('issuerdetails', 'badges'), 3), '');
424 $datatable->data[] = array(get_string('issuername', 'badges'), $issuer->name);
425 $datatable->data[] = array(get_string('issuerurl', 'badges'),
426 html_writer::tag('a', $issuer->origin, array('href' => $issuer->origin)));
427 if (isset($issuer->contact)) {
737a352f 428 $datatable->data[] = array(get_string('contact', 'badges'), obfuscate_mailto($issuer->contact));
27806552
YB
429 }
430 $datatable->data[] = array($this->output->heading(get_string('badgedetails', 'badges'), 3), '');
431 $datatable->data[] = array(get_string('name'), $assertion->badge->name);
432 $datatable->data[] = array(get_string('description', 'badges'), $assertion->badge->description);
433 $datatable->data[] = array(get_string('bcriteria', 'badges'),
434 html_writer::tag('a', $assertion->badge->criteria, array('href' => $assertion->badge->criteria)));
435 $datatable->data[] = array($this->output->heading(get_string('issuancedetails', 'badges'), 3), '');
436 if (isset($assertion->issued_on)) {
437 $datatable->data[] = array(get_string('dateawarded', 'badges'), $assertion->issued_on);
438 }
439 if (isset($assertion->badge->expire)) {
440 $today_date = date('Y-m-d');
441 $today = strtotime($today_date);
442 $expiration = strtotime($assertion->badge->expire);
443 if ($expiration < $today) {
444 $cell = new html_table_cell($assertion->badge->expire . get_string('warnexpired', 'badges'));
445 $cell->attributes = array('class' => 'notifyproblem warning');
446 $datatable->data[] = array(get_string('expirydate', 'badges'), $cell);
447
448 $image = html_writer::start_tag('div', array('class' => 'badge'));
449 $image .= html_writer::empty_tag('img', array('src' => $issued['badge']['image']));
450 $image .= html_writer::start_tag('span', array('class' => 'expired'))
451 . $this->output->pix_icon('i/expired',
452 get_string('expireddate', 'badges', $assertion->badge->expire),
453 'moodle',
454 array('class' => 'expireimage'))
455 . html_writer::end_tag('span');
456 $image .= html_writer::end_tag('div');
457 $imagetable->data[0] = array($image);
458 } else {
459 $datatable->data[] = array(get_string('expirydate', 'badges'), $assertion->badge->expire);
460 }
461 }
462 if (isset($assertion->evidence)) {
463 $datatable->data[] = array(get_string('evidence', 'badges'),
464 html_writer::tag('a', $assertion->evidence, array('href' => $assertion->evidence)));
465 }
466 $table->attributes = array('class' => 'generalbox boxaligncenter issuedbadgebox');
467 $table->data[] = array(html_writer::table($imagetable), html_writer::table($datatable));
468 $htmlbadge = html_writer::table($table);
469
470 return $htmlbadge;
471 }
472
473 // Outputs table of user badges.
474 protected function render_badge_user_collection(badge_user_collection $badges) {
475 global $CFG, $USER, $SITE;
e2805314
YB
476 $backpack = $badges->backpack;
477 $mybackpack = new moodle_url('/badges/mybackpack.php');
478
27806552
YB
479 $paging = new paging_bar($badges->totalcount, $badges->page, $badges->perpage, $this->page->url, 'page');
480 $htmlpagingbar = $this->render($paging);
481
e2805314
YB
482 // Set backpack connection string.
483 $backpackconnect = '';
484 if (!empty($CFG->badges_allowexternalbackpack) && is_null($backpack)) {
485 $backpackconnect = $this->output->box(get_string('localconnectto', 'badges', $mybackpack->out()), 'noticebox');
486 }
27806552
YB
487 // Search box.
488 $searchform = $this->output->box($this->helper_search_form($badges->search), 'boxwidthwide boxaligncenter');
489
490 // Download all button.
491 $downloadall = $this->output->single_button(
492 new moodle_url('/badges/mybadges.php', array('downloadall' => true, 'sesskey' => sesskey())),
493 get_string('downloadall'), 'POST', array('class' => 'activatebadge'));
494
495 // Local badges.
2c910861 496 $localhtml = html_writer::start_tag('fieldset', array('id' => 'issued-badge-table', 'class' => 'generalbox'));
5dcda2f8
YB
497 $heading = get_string('localbadges', 'badges', format_string($SITE->fullname, true, array('context' => context_system::instance())));
498 $localhtml .= html_writer::tag('legend', $this->output->heading_with_help($heading, 'localbadgesh', 'badges'));
27806552
YB
499 if ($badges->badges) {
500 $table = new html_table();
501 $table->attributes['class'] = 'statustable';
502 $table->data[] = array($this->output->heading(get_string('badgesearned', 'badges', $badges->totalcount), 4, 'activatebadge'), $downloadall);
503 $downloadbutton = html_writer::table($table);
504
505 $htmllist = $this->print_badges_list($badges->badges, $USER->id);
e2805314 506 $localhtml .= $backpackconnect . $downloadbutton . $searchform . $htmlpagingbar . $htmllist . $htmlpagingbar;
27806552
YB
507 } else {
508 $localhtml .= $searchform . $this->output->notification(get_string('nobadges', 'badges'));
509 }
510 $localhtml .= html_writer::end_tag('fieldset');
511
512 // External badges.
27806552 513 $externalhtml = "";
60d72efb 514 if (!empty($CFG->badges_allowexternalbackpack)) {
27806552
YB
515 $externalhtml .= html_writer::start_tag('fieldset', array('class' => 'generalbox'));
516 $externalhtml .= html_writer::tag('legend', $this->output->heading_with_help(get_string('externalbadges', 'badges'), 'externalbadges', 'badges'));
517 if (!is_null($backpack)) {
e2805314
YB
518 if ($backpack->totalcollections == 0) {
519 $externalhtml .= get_string('nobackpackcollections', 'badges', $backpack);
27806552 520 } else {
e2805314
YB
521 if ($backpack->totalbadges == 0) {
522 $externalhtml .= get_string('nobackpackbadges', 'badges', $backpack);
523 } else {
524 $externalhtml .= get_string('backpackbadges', 'badges', $backpack);
525 $externalhtml .= '<br/><br/>' . $this->print_badges_list($backpack->badges, $USER->id, true, true);
526 }
27806552 527 }
27806552 528 } else {
e2805314 529 $externalhtml .= get_string('externalconnectto', 'badges', $mybackpack->out());
27806552 530 }
27806552 531
27806552
YB
532 $externalhtml .= html_writer::end_tag('fieldset');
533 }
534
535 return $localhtml . $externalhtml;
536 }
537
538 // Outputs table of available badges.
539 protected function render_badge_collection(badge_collection $badges) {
540 $paging = new paging_bar($badges->totalcount, $badges->page, $badges->perpage, $this->page->url, 'page');
541 $htmlpagingbar = $this->render($paging);
542 $table = new html_table();
f8ba185a 543 $table->attributes['class'] = 'collection';
27806552
YB
544
545 $sortbyname = $this->helper_sortable_heading(get_string('name'),
546 'name', $badges->sort, $badges->dir);
547 $sortbyawarded = $this->helper_sortable_heading(get_string('awardedtoyou', 'badges'),
548 'dateissued', $badges->sort, $badges->dir);
549 $table->head = array(
550 get_string('badgeimage', 'badges'),
551 $sortbyname,
552 get_string('description', 'badges'),
553 get_string('bcriteria', 'badges'),
554 $sortbyawarded
555 );
556 $table->colclasses = array('badgeimage', 'name', 'description', 'criteria', 'awards');
557
558 foreach ($badges->badges as $badge) {
559 $badgeimage = print_badge_image($badge, $this->page->context, 'large');
560 $name = $badge->name;
561 $description = $badge->description;
562 $criteria = self::print_badge_criteria($badge);
563 if ($badge->dateissued) {
a8dd22a7 564 $icon = new pix_icon('i/valid',
27806552
YB
565 get_string('dateearned', 'badges',
566 userdate($badge->dateissued, get_string('strftimedatefullshort', 'core_langconfig'))));
567 $badgeurl = new moodle_url('/badges/badge.php', array('hash' => $badge->uniquehash));
568 $awarded = $this->output->action_icon($badgeurl, $icon, null, null, true);
569 } else {
570 $awarded = "";
571 }
572 $row = array($badgeimage, $name, $description, $criteria, $awarded);
573 $table->data[] = $row;
574 }
575
576 $htmltable = html_writer::table($table);
577
578 return $htmlpagingbar . $htmltable . $htmlpagingbar;
579 }
580
581 // Outputs table of badges with actions available.
582 protected function render_badge_management(badge_management $badges) {
583 $paging = new paging_bar($badges->totalcount, $badges->page, $badges->perpage, $this->page->url, 'page');
584
585 // New badge button.
19a9f2ea
YB
586 $htmlnew = '';
587 if (has_capability('moodle/badges:createbadge', $this->page->context)) {
588 $n['type'] = $this->page->url->get_param('type');
589 $n['id'] = $this->page->url->get_param('id');
590 $htmlnew = $this->output->single_button(new moodle_url('newbadge.php', $n), get_string('newbadge', 'badges'));
591 }
27806552
YB
592
593 $htmlpagingbar = $this->render($paging);
594 $table = new html_table();
595 $table->attributes['class'] = 'collection';
596
597 $sortbyname = $this->helper_sortable_heading(get_string('name'),
598 'name', $badges->sort, $badges->dir);
599 $sortbystatus = $this->helper_sortable_heading(get_string('status', 'badges'),
600 'status', $badges->sort, $badges->dir);
601 $table->head = array(
602 $sortbyname,
603 $sortbystatus,
604 get_string('bcriteria', 'badges'),
605 get_string('awards', 'badges'),
606 get_string('actions')
607 );
608 $table->colclasses = array('name', 'status', 'criteria', 'awards', 'actions');
609
610 foreach ($badges->badges as $b) {
611 $style = !$b->is_active() ? array('class' => 'dimmed') : array();
612 $forlink = print_badge_image($b, $this->page->context) . ' ' .
613 html_writer::start_tag('span') . $b->name . html_writer::end_tag('span');
614 $name = html_writer::link(new moodle_url('/badges/overview.php', array('id' => $b->id)), $forlink, $style);
615 $status = $b->statstring;
616 $criteria = self::print_badge_criteria($b, 'short');
617
618 if (has_capability('moodle/badges:viewawarded', $this->page->context)) {
619 $awards = html_writer::link(new moodle_url('/badges/recipients.php', array('id' => $b->id)), $b->awards);
620 } else {
621 $awards = $b->awards;
622 }
623
624 $actions = self::print_badge_table_actions($b, $this->page->context);
625
626 $row = array($name, $status, $criteria, $awards, $actions);
627 $table->data[] = $row;
628 }
629 $htmltable = html_writer::table($table);
630
631 return $htmlnew . $htmlpagingbar . $htmltable . $htmlpagingbar;
632 }
633
634 // Prints tabs for badge editing.
635 public function print_badge_tabs($badgeid, $context, $current = 'overview') {
636 global $DB;
637
a5f82c5b 638 $row = array();
27806552
YB
639
640 $row[] = new tabobject('overview',
641 new moodle_url('/badges/overview.php', array('id' => $badgeid)),
642 get_string('boverview', 'badges')
643 );
644
645 if (has_capability('moodle/badges:configuredetails', $context)) {
646 $row[] = new tabobject('details',
647 new moodle_url('/badges/edit.php', array('id' => $badgeid, 'action' => 'details')),
648 get_string('bdetails', 'badges')
649 );
650 }
651
652 if (has_capability('moodle/badges:configurecriteria', $context)) {
653 $row[] = new tabobject('criteria',
654 new moodle_url('/badges/criteria.php', array('id' => $badgeid)),
655 get_string('bcriteria', 'badges')
656 );
657 }
658
659 if (has_capability('moodle/badges:configuremessages', $context)) {
660 $row[] = new tabobject('message',
661 new moodle_url('/badges/edit.php', array('id' => $badgeid, 'action' => 'message')),
662 get_string('bmessage', 'badges')
663 );
664 }
665
666 if (has_capability('moodle/badges:viewawarded', $context)) {
667 $awarded = $DB->count_records('badge_issued', array('badgeid' => $badgeid));
668 $row[] = new tabobject('awards',
669 new moodle_url('/badges/recipients.php', array('id' => $badgeid)),
670 get_string('bawards', 'badges', $awarded)
671 );
672 }
673
a5f82c5b 674 echo $this->tabtree($row, $current);
27806552
YB
675 }
676
36388ba8
AD
677 /**
678 * Prints badge status box.
679 * @return Either the status box html as a string or null
680 */
27806552 681 public function print_badge_status_box(badge $badge) {
27806552 682 if (has_capability('moodle/badges:configurecriteria', $badge->get_context())) {
36388ba8
AD
683 $table = new html_table();
684 $table->attributes['class'] = 'boxaligncenter statustable';
685
27806552
YB
686 if (!$badge->has_criteria()) {
687 $criteriaurl = new moodle_url('/badges/criteria.php', array('id' => $badge->id));
688 $status = get_string('nocriteria', 'badges');
689 if ($this->page->url != $criteriaurl) {
690 $action = $this->output->single_button(
691 $criteriaurl,
692 get_string('addcriteria', 'badges'), 'POST', array('class' => 'activatebadge'));
693 } else {
694 $action = '';
695 }
696 $row = array($status, $action);
697 } else {
698 $status = get_string('statusmessage_' . $badge->status, 'badges');
699 if ($badge->is_active()) {
700 $action = $this->output->single_button(new moodle_url('/badges/action.php',
701 array('id' => $badge->id, 'lock' => 1, 'sesskey' => sesskey(),
702 'return' => $this->page->url->out_as_local_url(false))),
703 get_string('deactivate', 'badges'), 'POST', array('class' => 'activatebadge'));
704 } else {
705 $action = $this->output->single_button(new moodle_url('/badges/action.php',
706 array('id' => $badge->id, 'activate' => 1, 'sesskey' => sesskey(),
707 'return' => $this->page->url->out_as_local_url(false))),
708 get_string('activate', 'badges'), 'POST', array('class' => 'activatebadge'));
709 }
710 $row = array($status . $this->output->help_icon('status', 'badges'), $action);
711 }
36388ba8 712 $table->data[] = $row;
27806552 713
36388ba8
AD
714 $style = $badge->is_active() ? 'generalbox statusbox active' : 'generalbox statusbox inactive';
715 return $this->output->box(html_writer::table($table), $style);
716 }
27806552 717
36388ba8 718 return null;
27806552
YB
719 }
720
721 // Prints badge criteria.
722 public function print_badge_criteria(badge $badge, $short = '') {
723 $output = "";
724 $agg = $badge->get_aggregation_methods();
725 if (empty($badge->criteria)) {
726 return get_string('nocriteria', 'badges');
727 } else if (count($badge->criteria) == 2) {
728 if (!$short) {
729 $output .= get_string('criteria_descr', 'badges');
730 }
731 } else {
732 $output .= get_string('criteria_descr_' . $short . BADGE_CRITERIA_TYPE_OVERALL, 'badges',
733 strtoupper($agg[$badge->get_aggregation_method()]));
734 }
735 $items = array();
736 unset($badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]);
737 foreach ($badge->criteria as $type => $c) {
738 if (count($c->params) == 1) {
739 $items[] = get_string('criteria_descr_single_' . $short . $type , 'badges') . $c->get_details($short);
740 } else {
741 $items[] = get_string('criteria_descr_' . $short . $type , 'badges',
742 strtoupper($agg[$badge->get_aggregation_method($type)])) . $c->get_details($short);
743 }
744 }
745 $output .= html_writer::alist($items, array(), 'ul');
746 return $output;
747 }
748
749 // Prints criteria actions for badge editing.
750 public function print_criteria_actions(badge $badge) {
751 $table = new html_table();
752 $table->attributes = array('class' => 'boxaligncenter', 'id' => 'badgeactions');
753 $table->colclasses = array('activatebadge');
754
755 $actions = array();
756 if (!$badge->is_active() && !$badge->is_locked()) {
757 $accepted = $badge->get_accepted_criteria();
758 $potential = array_diff($accepted, array_keys($badge->criteria));
759
760 if (!empty($potential)) {
761 foreach ($potential as $p) {
762 if ($p != 0) {
763 $select[$p] = get_string('criteria_' . $p, 'badges');
764 }
765 }
766 $actions[] = get_string('addbadgecriteria', 'badges');
767 $actions[] = $this->output->single_select(new moodle_url('/badges/criteria_settings.php',
768 array('badgeid' => $badge->id, 'add' => true)), 'type', $select);
769 } else {
770 $actions[] = $this->output->box(get_string('nothingtoadd', 'badges'), 'clearfix');
771 }
772 }
773
774 $table->data[] = $actions;
775 return html_writer::table($table);
776 }
777
778 // Renders a table with users who have earned the badge.
779 // Based on stamps collection plugin.
780 protected function render_badge_recipients(badge_recipients $recipients) {
781 $paging = new paging_bar($recipients->totalcount, $recipients->page, $recipients->perpage, $this->page->url, 'page');
782 $htmlpagingbar = $this->render($paging);
783 $table = new html_table();
f8ba185a 784 $table->attributes['class'] = 'generaltable boxaligncenter boxwidthwide';
27806552
YB
785
786 $sortbyfirstname = $this->helper_sortable_heading(get_string('firstname'),
787 'firstname', $recipients->sort, $recipients->dir);
788 $sortbylastname = $this->helper_sortable_heading(get_string('lastname'),
789 'lastname', $recipients->sort, $recipients->dir);
790 if ($this->helper_fullname_format() == 'lf') {
791 $sortbyname = $sortbylastname . ' / ' . $sortbyfirstname;
792 } else {
793 $sortbyname = $sortbyfirstname . ' / ' . $sortbylastname;
794 }
795
796 $sortbydate = $this->helper_sortable_heading(get_string('dateawarded', 'badges'),
797 'dateissued', $recipients->sort, $recipients->dir);
798
799 $table->head = array($sortbyname, $sortbydate, '');
800
801 foreach ($recipients->userids as $holder) {
802 $fullname = fullname($holder);
803 $fullname = html_writer::link(
804 new moodle_url('/user/profile.php', array('id' => $holder->userid)),
805 $fullname
806 );
807 $awarded = userdate($holder->dateissued);
808 $badgeurl = html_writer::link(
809 new moodle_url('/badges/badge.php', array('hash' => $holder->uniquehash)),
810 get_string('viewbadge', 'badges')
811 );
812
813 $row = array($fullname, $awarded, $badgeurl);
814 $table->data[] = $row;
815 }
816
817 $htmltable = html_writer::table($table);
818
819 return $htmlpagingbar . $htmltable . $htmlpagingbar;
820 }
821
822 ////////////////////////////////////////////////////////////////////////////
823 // Helper methods
824 // Reused from stamps collection plugin
825 ////////////////////////////////////////////////////////////////////////////
826
827 /**
828 * Renders a text with icons to sort by the given column
829 *
830 * This is intended for table headings.
831 *
832 * @param string $text The heading text
833 * @param string $sortid The column id used for sorting
834 * @param string $sortby Currently sorted by (column id)
835 * @param string $sorthow Currently sorted how (ASC|DESC)
836 *
837 * @return string
838 */
839 protected function helper_sortable_heading($text, $sortid = null, $sortby = null, $sorthow = null) {
840 $out = html_writer::tag('span', $text, array('class' => 'text'));
841
842 if (!is_null($sortid)) {
843 if ($sortby !== $sortid || $sorthow !== 'ASC') {
844 $url = new moodle_url($this->page->url);
845 $url->params(array('sort' => $sortid, 'dir' => 'ASC'));
846 $out .= $this->output->action_icon($url,
847 new pix_icon('t/sort_asc', get_string('sortbyx', 'core', s($text)), null, array('class' => 'iconsort')));
848 }
849 if ($sortby !== $sortid || $sorthow !== 'DESC') {
850 $url = new moodle_url($this->page->url);
851 $url->params(array('sort' => $sortid, 'dir' => 'DESC'));
852 $out .= $this->output->action_icon($url,
853 new pix_icon('t/sort_desc', get_string('sortbyxreverse', 'core', s($text)), null, array('class' => 'iconsort')));
854 }
855 }
856 return $out;
857 }
858 /**
859 * Tries to guess the fullname format set at the site
860 *
861 * @return string fl|lf
862 */
863 protected function helper_fullname_format() {
864 $fake = new stdClass();
865 $fake->lastname = 'LLLL';
866 $fake->firstname = 'FFFF';
867 $fullname = get_string('fullnamedisplay', '', $fake);
868 if (strpos($fullname, 'LLLL') < strpos($fullname, 'FFFF')) {
869 return 'lf';
870 } else {
871 return 'fl';
872 }
873 }
874 /**
875 * Renders a search form
876 *
877 * @param string $search Search string
878 * @return string HTML
879 */
880 protected function helper_search_form($search) {
881 global $CFG;
882 require_once($CFG->libdir . '/formslib.php');
883
884 $mform = new MoodleQuickForm('searchform', 'POST', $this->page->url);
885
886 $mform->addElement('hidden', 'sesskey', sesskey());
887
888 $el[] = $mform->createElement('text', 'search', get_string('search'), array('size' => 20));
889 $mform->setDefault('search', $search);
890 $el[] = $mform->createElement('submit', 'submitsearch', get_string('search'));
891 $el[] = $mform->createElement('submit', 'clearsearch', get_string('clear'));
892 $mform->addGroup($el, 'searchgroup', get_string('searchname', 'badges'), ' ', false);
893
894 ob_start();
895 $mform->display();
896 $out = ob_get_clean();
897
898 return $out;
899 }
900}
901
902/**
903 * An issued badges for badge.php page
904 */
905class issued_badge implements renderable {
906 /** @var issued badge */
907 public $issued;
908
909 /** @var badge recipient */
737a352f 910 public $recipient;
27806552
YB
911
912 /** @var badge visibility to others */
913 public $visible = 0;
914
915 /** @var badge class */
916 public $badgeid = 0;
917
918 /** @var issued badge unique hash */
919 public $hash = "";
920
921 /**
922 * Initializes the badge to display
923 *
924 * @param string $hash Issued badge hash
925 */
926 public function __construct($hash) {
927 global $DB;
928 $this->issued = badges_get_issued_badge_info($hash);
929 $this->hash = $hash;
930
931 $rec = $DB->get_record_sql('SELECT userid, visible, badgeid
932 FROM {badge_issued}
933 WHERE ' . $DB->sql_compare_text('uniquehash', 40) . ' = ' . $DB->sql_compare_text(':hash', 40),
934 array('hash' => $hash), IGNORE_MISSING);
935 if ($rec) {
737a352f
YB
936 // Get a recipient from database.
937 $user = $DB->get_record_sql('SELECT u.id, u.lastname, u.firstname,
938 u.email AS accountemail, b.email AS backpackemail
939 FROM {user} u LEFT JOIN {badge_backpack} b ON u.id = b.userid
940 WHERE u.id = :userid', array('userid' => $rec->userid));
941 $this->recipient = $user;
27806552
YB
942 $this->visible = $rec->visible;
943 $this->badgeid = $rec->badgeid;
944 }
945 }
946}
947
948/**
949 * An external badges for external.php page
950 */
951class external_badge implements renderable {
952 /** @var issued badge */
953 public $issued;
954
737a352f
YB
955 /** @var User ID */
956 public $recipient;
957
958 /** @var validation of external badge */
959 public $valid = true;
960
27806552
YB
961 /**
962 * Initializes the badge to display
963 *
2d3c0fae 964 * @param object $badge External badge information.
737a352f 965 * @param int $recipient User id.
27806552 966 */
737a352f
YB
967 public function __construct($badge, $recipient) {
968 global $DB;
969 // At this point a user has connected a backpack. So, we are going to get
970 // their backpack email rather than their account email.
971 $user = $DB->get_record_sql('SELECT u.lastname, u.firstname, b.email
972 FROM {user} u INNER JOIN {badge_backpack} b ON u.id = b.userid
973 WHERE userid = :userid', array('userid' => $recipient), IGNORE_MISSING);
974
2d3c0fae 975 $this->issued = $badge;
737a352f
YB
976 $this->recipient = $user;
977
978 // Check if recipient is valid.
979 // There is no way to be 100% sure that a badge belongs to a user.
980 // Backpack does not return any recipient information.
981 // All we can do is compare that backpack email hashed using salt
982 // provided in the assertion matches a badge recipient from the assertion.
983 if ($user) {
984 if (validate_email($badge->assertion->recipient) && $badge->assertion->recipient == $user->email) {
985 // If we have email, compare emails.
986 $this->valid = true;
987 } else if ($badge->assertion->recipient == 'sha256$' . hash('sha256', $user->email)) {
988 // If recipient is hashed, but no salt, compare hashes without salt.
989 $this->valid = true;
990 } else if ($badge->assertion->recipient == 'sha256$' . hash('sha256', $user->email . $badge->assertion->salt)) {
991 // If recipient is hashed, compare hashes.
992 $this->valid = true;
993 } else {
994 // Otherwise, we cannot be sure that this user is a recipient.
995 $this->valid = false;
996 }
997 } else {
998 $this->valid = false;
999 }
27806552
YB
1000 }
1001}
1002
1003/**
1004 * Badge recipients rendering class
1005 */
1006class badge_recipients implements renderable {
1007 /** @var string how are the data sorted */
1008 public $sort = 'lastname';
1009
1010 /** @var string how are the data sorted */
1011 public $dir = 'ASC';
1012
1013 /** @var int page number to display */
1014 public $page = 0;
1015
1016 /** @var int number of badge recipients to display per page */
1017 public $perpage = 30;
1018
1019 /** @var int the total number or badge recipients to display */
1020 public $totalcount = null;
1021
1022 /** @var array internal list of badge recipients ids */
1023 public $userids = array();
1024 /**
1025 * Initializes the list of users to display
1026 *
1027 * @param array $holders List of badge holders
1028 */
1029 public function __construct($holders) {
1030 $this->userids = $holders;
1031 }
1032}
1033
1034/**
1035 * Collection of all badges for view.php page
1036 */
1037class badge_collection implements renderable {
1038
1039 /** @var string how are the data sorted */
1040 public $sort = 'name';
1041
1042 /** @var string how are the data sorted */
1043 public $dir = 'ASC';
1044
1045 /** @var int page number to display */
1046 public $page = 0;
1047
1048 /** @var int number of badges to display per page */
1049 public $perpage = BADGE_PERPAGE;
1050
1051 /** @var int the total number of badges to display */
1052 public $totalcount = null;
1053
1054 /** @var array list of badges */
1055 public $badges = array();
1056
1057 /**
1058 * Initializes the list of badges to display
1059 *
1060 * @param array $badges Badges to render
1061 */
1062 public function __construct($badges) {
1063 $this->badges = $badges;
1064 }
1065}
1066
1067/**
1068 * Collection of badges used at the index.php page
1069 */
1070class badge_management extends badge_collection implements renderable {
1071}
1072
1073/**
1074 * Collection of user badges used at the mybadges.php page
1075 */
1076class badge_user_collection extends badge_collection implements renderable {
1077 /** @var array backpack settings */
e2805314 1078 public $backpack = null;
27806552
YB
1079
1080 /** @var string search */
1081 public $search = '';
1082
1083 /**
1084 * Initializes user badge collection.
1085 *
1086 * @param array $badges Badges to render
1087 * @param int $userid Badges owner
1088 */
1089 public function __construct($badges, $userid) {
e2805314 1090 global $CFG;
27806552 1091 parent::__construct($badges);
e2805314
YB
1092
1093 if (!empty($CFG->badges_allowexternalbackpack)) {
2d3c0fae 1094 $this->backpack = get_backpack_settings($userid, true);
e2805314 1095 }
27806552
YB
1096 }
1097}