Merge branch 'wip-MDL-41967-master' of git://github.com/abgreeve/moodle
[moodle.git] / badges / renderer.php
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/>.
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  */
27 require_once($CFG->libdir . '/badgeslib.php');
28 require_once($CFG->libdir . '/tablelib.php');
30 /**
31  * Standard HTML output renderer for badges
32  */
33 class core_badges_renderer extends plugin_renderer_base {
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             }
48             $name = html_writer::tag('span', $bname, array('class' => 'badge-name'));
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             }
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()));
62                 $notexpiredbadge = (empty($badge->dateexpire) || $badge->dateexpire > time());
63                 $backpackexists = badges_user_has_backpack($USER->id);
64                 if (!empty($CFG->badges_allowexternalbackpack) && $notexpiredbadge && $backpackexists) {
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                 }
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             }
80             if (!$profile) {
81                 $url = new moodle_url('badge.php', array('hash' => $badge->uniquehash));
82             } else {
83                 if (!$external) {
84                     $url = new moodle_url('/badges/badge.php', array('hash' => $badge->uniquehash));
85                 } else {
86                     $hash = hash('md5', $badge->hostedUrl);
87                     $url = new moodle_url('/badges/external.php', array('hash' => $hash, 'user' => $userid));
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         }
94         return html_writer::alist($items, array('class' => 'badges'));
95     }
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';
102         $formattributes['action'] = $this->page->url;
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()));
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';
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);
129         $output .= html_writer::end_tag('form');
130         return $output;
131     }
133     // Prints a badge overview infomation.
134     public function print_badge_overview($badge, $context) {
135         $display = "";
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'));
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');
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'));
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');
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');
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');
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             }
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         }
224         return $display;
225     }
227     // Prints action icons for the badge.
228     public function print_badge_table_actions($badge, $context) {
229         $actions = "";
231         if (has_capability('moodle/badges:configuredetails', $context) && $badge->has_criteria()) {
232             // Activate/deactivate badge.
233             if ($badge->status == BADGE_STATUS_INACTIVE || $badge->status == BADGE_STATUS_INACTIVE_LOCKED) {
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);
238                 $url->param('sesskey', sesskey());
239                 $return = new moodle_url(qualified_me());
240                 $url->param('return', $return->out_as_local_url(false));
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         }
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         }
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         }
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         }
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         }
277         return $actions;
278     }
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;
284         $userinfo = $ibadge->recipient;
285         $badgeclass = $ibadge->badgeclass;
286         $badge = new badge($ibadge->badgeid);
287         $now = time();
289         $table = new html_table();
290         $table->id = 'issued-badge-table';
292         $imagetable = new html_table();
293         $imagetable->attributes = array('class' => 'clearfix badgeissuedimage');
294         $imagetable->data[] = array(html_writer::empty_tag('img', array('src' => $badgeclass['image'])));
295         if ($USER->id == $userinfo->id && !empty($CFG->enablebadges)) {
296             $imagetable->data[] = array($this->output->single_button(
297                         new moodle_url('/badges/badge.php', array('hash' => $issued['uid'], 'bake' => true)),
298                         get_string('download'),
299                         'POST'));
300             $expiration = isset($issued['expires']) ? $issued['expires'] : $now + 86400;
301             if (!empty($CFG->badges_allowexternalbackpack) && ($expiration > $now) && badges_user_has_backpack($USER->id)) {
302                 $assertion = new moodle_url('/badges/assertion.php', array('b' => $issued['uid']));
303                 $action = new component_action('click', 'addtobackpack', array('assertion' => $assertion->out(false)));
304                 $attributes = array(
305                         'type'  => 'button',
306                         'id'    => 'addbutton',
307                         'value' => get_string('addtobackpack', 'badges'));
308                 $tobackpack = html_writer::tag('input', '', $attributes);
309                 $this->output->add_action_handler($action, 'addbutton');
310                 $imagetable->data[] = array($tobackpack);
311             }
312         }
313         $datatable = new html_table();
314         $datatable->attributes = array('class' => 'badgeissuedinfo');
315         $datatable->colclasses = array('bfield', 'bvalue');
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         }
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)) {
329             $datatable->data[] = array(get_string('contact', 'badges'), obfuscate_mailto($badge->issuercontact));
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);
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         }
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'), userdate($issued['issuedOn']));
343         if (isset($issued['expires'])) {
344             if ($issued['expires'] < $now) {
345                 $cell = new html_table_cell(userdate($issued['expires']) . get_string('warnexpired', 'badges'));
346                 $cell->attributes = array('class' => 'notifyproblem warning');
347                 $datatable->data[] = array(get_string('expirydate', 'badges'), $cell);
349                 $image = html_writer::start_tag('div', array('class' => 'badge'));
350                 $image .= html_writer::empty_tag('img', array('src' => $badgeclass['image']));
351                 $image .= $this->output->pix_icon('i/expired',
352                                 get_string('expireddate', 'badges', userdate($issued['expires'])),
353                                 'moodle',
354                                 array('class' => 'expireimage'));
355                 $image .= html_writer::end_tag('div');
356                 $imagetable->data[0] = array($image);
357             } else {
358                 $datatable->data[] = array(get_string('expirydate', 'badges'), userdate($issued['expires']));
359             }
360         }
362         // Print evidence.
363         $agg = $badge->get_aggregation_methods();
364         $evidence = $badge->get_criteria_completions($userinfo->id);
365         $eids = array_map(create_function('$o', 'return $o->critid;'), $evidence);
366         unset($badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]);
368         $items = array();
369         foreach ($badge->criteria as $type => $c) {
370             if (in_array($c->id, $eids)) {
371                 if (count($c->params) == 1) {
372                     $items[] = get_string('criteria_descr_single_' . $type , 'badges') . $c->get_details();
373                 } else {
374                     $items[] = get_string('criteria_descr_' . $type , 'badges',
375                             strtoupper($agg[$badge->get_aggregation_method($type)])) . $c->get_details();
376                 }
377             }
378         }
380         $datatable->data[] = array(get_string('evidence', 'badges'),
381                 get_string('completioninfo', 'badges') .
382                 html_writer::alist($items, array(), 'ul'));
383         $table->attributes = array('class' => 'generalbox boxaligncenter issuedbadgebox');
384         $table->data[] = array(html_writer::table($imagetable), html_writer::table($datatable));
385         $htmlbadge = html_writer::table($table);
387         return $htmlbadge;
388     }
390     // Outputs external badge.
391     protected function render_external_badge(external_badge $ibadge) {
392         $issued = $ibadge->issued;
393         $assertion = $issued->assertion;
394         $issuer = $assertion->badge->issuer;
395         $userinfo = $ibadge->recipient;
396         $table = new html_table();
398         $imagetable = new html_table();
399         $imagetable->attributes = array('class' => 'clearfix badgeissuedimage');
400         $imagetable->data[] = array(html_writer::empty_tag('img', array('src' => $issued->imageUrl, 'width' => '100px')));
402         $datatable = new html_table();
403         $datatable->attributes = array('class' => 'badgeissuedinfo');
404         $datatable->colclasses = array('bfield', 'bvalue');
406         // Recipient information.
407         $datatable->data[] = array($this->output->heading(get_string('recipientdetails', 'badges'), 3), '');
408         // Technically, we should alway have a user at this point, but added an extra check just in case.
409         if ($userinfo) {
410             $datatable->data[] = array(get_string('name'), fullname($userinfo));
411             if (!$ibadge->valid) {
412                 $notify = $this->output->notification(get_string('recipientvalidationproblem', 'badges'), 'notifynotice');
413                 $datatable->data[] = array(get_string('email'), obfuscate_mailto($userinfo->email) . $notify);
414             } else {
415                 $datatable->data[] = array(get_string('email'), obfuscate_mailto($userinfo->email));
416             }
417         } else {
418             $notify = $this->output->notification(get_string('recipientidentificationproblem', 'badges'), 'notifynotice');
419             $datatable->data[] = array(get_string('name'), $notify);
420         }
422         $datatable->data[] = array($this->output->heading(get_string('issuerdetails', 'badges'), 3), '');
423         $datatable->data[] = array(get_string('issuername', 'badges'), $issuer->name);
424         $datatable->data[] = array(get_string('issuerurl', 'badges'),
425                 html_writer::tag('a', $issuer->origin, array('href' => $issuer->origin)));
426         if (isset($issuer->contact)) {
427             $datatable->data[] = array(get_string('contact', 'badges'), obfuscate_mailto($issuer->contact));
428         }
429         $datatable->data[] = array($this->output->heading(get_string('badgedetails', 'badges'), 3), '');
430         $datatable->data[] = array(get_string('name'), $assertion->badge->name);
431         $datatable->data[] = array(get_string('description', 'badges'), $assertion->badge->description);
432         $datatable->data[] = array(get_string('bcriteria', 'badges'),
433                 html_writer::tag('a', $assertion->badge->criteria, array('href' => $assertion->badge->criteria)));
434         $datatable->data[] = array($this->output->heading(get_string('issuancedetails', 'badges'), 3), '');
435         if (isset($assertion->issued_on)) {
436             $datatable->data[] = array(get_string('dateawarded', 'badges'), $assertion->issued_on);
437         }
438         if (isset($assertion->badge->expire)) {
439             $today_date = date('Y-m-d');
440             $today = strtotime($today_date);
441             $expiration = strtotime($assertion->badge->expire);
442             if ($expiration < $today) {
443                 $cell = new html_table_cell($assertion->badge->expire . get_string('warnexpired', 'badges'));
444                 $cell->attributes = array('class' => 'notifyproblem warning');
445                 $datatable->data[] = array(get_string('expirydate', 'badges'), $cell);
447                 $image = html_writer::start_tag('div', array('class' => 'badge'));
448                 $image .= html_writer::empty_tag('img', array('src' => $issued['badge']['image']));
449                 $image .= html_writer::start_tag('span', array('class' => 'expired'))
450                             . $this->output->pix_icon('i/expired',
451                                 get_string('expireddate', 'badges', $assertion->badge->expire),
452                                 'moodle',
453                                 array('class' => 'expireimage'))
454                             . html_writer::end_tag('span');
455                 $image .= html_writer::end_tag('div');
456                 $imagetable->data[0] = array($image);
457             } else {
458                 $datatable->data[] = array(get_string('expirydate', 'badges'), $assertion->badge->expire);
459             }
460         }
461         if (isset($assertion->evidence)) {
462             $datatable->data[] = array(get_string('evidence', 'badges'),
463                 html_writer::tag('a', $assertion->evidence, array('href' => $assertion->evidence)));
464         }
465         $table->attributes = array('class' => 'generalbox boxaligncenter issuedbadgebox');
466         $table->data[] = array(html_writer::table($imagetable), html_writer::table($datatable));
467         $htmlbadge = html_writer::table($table);
469         return $htmlbadge;
470     }
472     // Outputs table of user badges.
473     protected function render_badge_user_collection(badge_user_collection $badges) {
474         global $CFG, $USER, $SITE;
475         $backpack = $badges->backpack;
476         $mybackpack = new moodle_url('/badges/mybackpack.php');
478         $paging = new paging_bar($badges->totalcount, $badges->page, $badges->perpage, $this->page->url, 'page');
479         $htmlpagingbar = $this->render($paging);
481         // Set backpack connection string.
482         $backpackconnect = '';
483         if (!empty($CFG->badges_allowexternalbackpack) && is_null($backpack)) {
484             $backpackconnect = $this->output->box(get_string('localconnectto', 'badges', $mybackpack->out()), 'noticebox');
485         }
486         // Search box.
487         $searchform = $this->output->box($this->helper_search_form($badges->search), 'boxwidthwide boxaligncenter');
489         // Download all button.
490         $downloadall = $this->output->single_button(
491                     new moodle_url('/badges/mybadges.php', array('downloadall' => true, 'sesskey' => sesskey())),
492                     get_string('downloadall'), 'POST', array('class' => 'activatebadge'));
494         // Local badges.
495         $localhtml = html_writer::start_tag('fieldset', array('id' => 'issued-badge-table', 'class' => 'generalbox'));
496         $localhtml .= html_writer::tag('legend',
497                     $this->output->heading_with_help(get_string('localbadges', 'badges', $SITE->fullname), 'localbadgesh', 'badges'));
498         if ($badges->badges) {
499             $table = new html_table();
500             $table->attributes['class'] = 'statustable';
501             $table->data[] = array($this->output->heading(get_string('badgesearned', 'badges', $badges->totalcount), 4, 'activatebadge'), $downloadall);
502             $downloadbutton = html_writer::table($table);
504             $htmllist = $this->print_badges_list($badges->badges, $USER->id);
505             $localhtml .= $backpackconnect . $downloadbutton . $searchform . $htmlpagingbar . $htmllist . $htmlpagingbar;
506         } else {
507             $localhtml .= $searchform . $this->output->notification(get_string('nobadges', 'badges'));
508         }
509         $localhtml .= html_writer::end_tag('fieldset');
511         // External badges.
512         $externalhtml = "";
513         if (!empty($CFG->badges_allowexternalbackpack)) {
514             $externalhtml .= html_writer::start_tag('fieldset', array('class' => 'generalbox'));
515             $externalhtml .= html_writer::tag('legend', $this->output->heading_with_help(get_string('externalbadges', 'badges'), 'externalbadges', 'badges'));
516             if (!is_null($backpack)) {
517                 if ($backpack->totalcollections == 0) {
518                     $externalhtml .= get_string('nobackpackcollections', 'badges', $backpack);
519                 } else {
520                     if ($backpack->totalbadges == 0) {
521                         $externalhtml .= get_string('nobackpackbadges', 'badges', $backpack);
522                     } else {
523                         $externalhtml .= get_string('backpackbadges', 'badges', $backpack);
524                         $externalhtml .= '<br/><br/>' . $this->print_badges_list($backpack->badges, $USER->id, true, true);
525                     }
526                 }
527             } else {
528                 $externalhtml .= get_string('externalconnectto', 'badges', $mybackpack->out());
529             }
531             $externalhtml .= html_writer::end_tag('fieldset');
532         }
534         return $localhtml . $externalhtml;
535     }
537     // Outputs table of available badges.
538     protected function render_badge_collection(badge_collection $badges) {
539         $paging = new paging_bar($badges->totalcount, $badges->page, $badges->perpage, $this->page->url, 'page');
540         $htmlpagingbar = $this->render($paging);
541         $table = new html_table();
542         $table->attributes['class'] = 'collection';
544         $sortbyname = $this->helper_sortable_heading(get_string('name'),
545                 'name', $badges->sort, $badges->dir);
546         $sortbyawarded = $this->helper_sortable_heading(get_string('awardedtoyou', 'badges'),
547                 'dateissued', $badges->sort, $badges->dir);
548         $table->head = array(
549                     get_string('badgeimage', 'badges'),
550                     $sortbyname,
551                     get_string('description', 'badges'),
552                     get_string('bcriteria', 'badges'),
553                     $sortbyawarded
554                 );
555         $table->colclasses = array('badgeimage', 'name', 'description', 'criteria', 'awards');
557         foreach ($badges->badges as $badge) {
558             $badgeimage = print_badge_image($badge, $this->page->context, 'large');
559             $name = $badge->name;
560             $description = $badge->description;
561             $criteria = self::print_badge_criteria($badge);
562             if ($badge->dateissued) {
563                 $icon = new pix_icon('i/valid',
564                             get_string('dateearned', 'badges',
565                                 userdate($badge->dateissued, get_string('strftimedatefullshort', 'core_langconfig'))));
566                 $badgeurl = new moodle_url('/badges/badge.php', array('hash' => $badge->uniquehash));
567                 $awarded = $this->output->action_icon($badgeurl, $icon, null, null, true);
568             } else {
569                 $awarded = "";
570             }
571             $row = array($badgeimage, $name, $description, $criteria, $awarded);
572             $table->data[] = $row;
573         }
575         $htmltable = html_writer::table($table);
577         return $htmlpagingbar . $htmltable . $htmlpagingbar;
578     }
580     // Outputs table of badges with actions available.
581     protected function render_badge_management(badge_management $badges) {
582         $paging = new paging_bar($badges->totalcount, $badges->page, $badges->perpage, $this->page->url, 'page');
584         // New badge button.
585         $htmlnew = '';
586         if (has_capability('moodle/badges:createbadge', $this->page->context)) {
587             $n['type'] = $this->page->url->get_param('type');
588             $n['id'] = $this->page->url->get_param('id');
589             $htmlnew = $this->output->single_button(new moodle_url('newbadge.php', $n), get_string('newbadge', 'badges'));
590         }
592         $htmlpagingbar = $this->render($paging);
593         $table = new html_table();
594         $table->attributes['class'] = 'collection';
596         $sortbyname = $this->helper_sortable_heading(get_string('name'),
597                 'name', $badges->sort, $badges->dir);
598         $sortbystatus = $this->helper_sortable_heading(get_string('status', 'badges'),
599                 'status', $badges->sort, $badges->dir);
600         $table->head = array(
601                 $sortbyname,
602                 $sortbystatus,
603                 get_string('bcriteria', 'badges'),
604                 get_string('awards', 'badges'),
605                 get_string('actions')
606             );
607         $table->colclasses = array('name', 'status', 'criteria', 'awards', 'actions');
609         foreach ($badges->badges as $b) {
610             $style = !$b->is_active() ? array('class' => 'dimmed') : array();
611             $forlink =  print_badge_image($b, $this->page->context) . ' ' .
612                         html_writer::start_tag('span') . $b->name . html_writer::end_tag('span');
613             $name = html_writer::link(new moodle_url('/badges/overview.php', array('id' => $b->id)), $forlink, $style);
614             $status = $b->statstring;
615             $criteria = self::print_badge_criteria($b, 'short');
617             if (has_capability('moodle/badges:viewawarded', $this->page->context)) {
618                 $awards = html_writer::link(new moodle_url('/badges/recipients.php', array('id' => $b->id)), $b->awards);
619             } else {
620                 $awards = $b->awards;
621             }
623             $actions = self::print_badge_table_actions($b, $this->page->context);
625             $row = array($name, $status, $criteria, $awards, $actions);
626             $table->data[] = $row;
627         }
628         $htmltable = html_writer::table($table);
630         return $htmlnew . $htmlpagingbar . $htmltable . $htmlpagingbar;
631     }
633     // Prints tabs for badge editing.
634     public function print_badge_tabs($badgeid, $context, $current = 'overview') {
635         global $DB;
637         $row = array();
639         $row[] = new tabobject('overview',
640                     new moodle_url('/badges/overview.php', array('id' => $badgeid)),
641                     get_string('boverview', 'badges')
642                 );
644         if (has_capability('moodle/badges:configuredetails', $context)) {
645             $row[] = new tabobject('details',
646                         new moodle_url('/badges/edit.php', array('id' => $badgeid, 'action' => 'details')),
647                         get_string('bdetails', 'badges')
648                     );
649         }
651         if (has_capability('moodle/badges:configurecriteria', $context)) {
652             $row[] = new tabobject('criteria',
653                         new moodle_url('/badges/criteria.php', array('id' => $badgeid)),
654                         get_string('bcriteria', 'badges')
655                     );
656         }
658         if (has_capability('moodle/badges:configuremessages', $context)) {
659             $row[] = new tabobject('message',
660                         new moodle_url('/badges/edit.php', array('id' => $badgeid, 'action' => 'message')),
661                         get_string('bmessage', 'badges')
662                     );
663         }
665         if (has_capability('moodle/badges:viewawarded', $context)) {
666             $awarded = $DB->count_records('badge_issued', array('badgeid' => $badgeid));
667             $row[] = new tabobject('awards',
668                         new moodle_url('/badges/recipients.php', array('id' => $badgeid)),
669                         get_string('bawards', 'badges', $awarded)
670                     );
671         }
673         echo $this->tabtree($row, $current);
674     }
676     /**
677      * Prints badge status box.
678      * @return Either the status box html as a string or null
679      */
680     public function print_badge_status_box(badge $badge) {
681         if (has_capability('moodle/badges:configurecriteria', $badge->get_context())) {
682             $table = new html_table();
683             $table->attributes['class'] = 'boxaligncenter statustable';
685             if (!$badge->has_criteria()) {
686                 $criteriaurl = new moodle_url('/badges/criteria.php', array('id' => $badge->id));
687                 $status = get_string('nocriteria', 'badges');
688                 if ($this->page->url != $criteriaurl) {
689                     $action = $this->output->single_button(
690                         $criteriaurl,
691                         get_string('addcriteria', 'badges'), 'POST', array('class' => 'activatebadge'));
692                 } else {
693                     $action = '';
694                 }
695                 $row = array($status, $action);
696             } else {
697                 $status = get_string('statusmessage_' . $badge->status, 'badges');
698                 if ($badge->is_active()) {
699                     $action = $this->output->single_button(new moodle_url('/badges/action.php',
700                                 array('id' => $badge->id, 'lock' => 1, 'sesskey' => sesskey(),
701                                       'return' => $this->page->url->out_as_local_url(false))),
702                             get_string('deactivate', 'badges'), 'POST', array('class' => 'activatebadge'));
703                 } else {
704                     $action = $this->output->single_button(new moodle_url('/badges/action.php',
705                                 array('id' => $badge->id, 'activate' => 1, 'sesskey' => sesskey(),
706                                       'return' => $this->page->url->out_as_local_url(false))),
707                             get_string('activate', 'badges'), 'POST', array('class' => 'activatebadge'));
708                 }
709                 $row = array($status . $this->output->help_icon('status', 'badges'), $action);
710             }
711             $table->data[] = $row;
713             $style = $badge->is_active() ? 'generalbox statusbox active' : 'generalbox statusbox inactive';
714             return $this->output->box(html_writer::table($table), $style);
715         }
717         return null;
718     }
720     // Prints badge criteria.
721     public function print_badge_criteria(badge $badge, $short = '') {
722         $output = "";
723         $agg = $badge->get_aggregation_methods();
724         if (empty($badge->criteria)) {
725             return get_string('nocriteria', 'badges');
726         } else if (count($badge->criteria) == 2) {
727             if (!$short) {
728                 $output .= get_string('criteria_descr', 'badges');
729             }
730         } else {
731             $output .= get_string('criteria_descr_' . $short . BADGE_CRITERIA_TYPE_OVERALL, 'badges',
732                                     strtoupper($agg[$badge->get_aggregation_method()]));
733         }
734         $items = array();
735         unset($badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]);
736         foreach ($badge->criteria as $type => $c) {
737             if (count($c->params) == 1) {
738                 $items[] = get_string('criteria_descr_single_' . $short . $type , 'badges') . $c->get_details($short);
739             } else {
740                 $items[] = get_string('criteria_descr_' . $short . $type , 'badges',
741                         strtoupper($agg[$badge->get_aggregation_method($type)])) . $c->get_details($short);
742             }
743         }
744         $output .= html_writer::alist($items, array(), 'ul');
745         return $output;
746     }
748     // Prints criteria actions for badge editing.
749     public function print_criteria_actions(badge $badge) {
750         $table = new html_table();
751         $table->attributes = array('class' => 'boxaligncenter', 'id' => 'badgeactions');
752         $table->colclasses = array('activatebadge');
754         $actions = array();
755         if (!$badge->is_active() && !$badge->is_locked()) {
756             $accepted = $badge->get_accepted_criteria();
757             $potential = array_diff($accepted, array_keys($badge->criteria));
759             if (!empty($potential)) {
760                 foreach ($potential as $p) {
761                     if ($p != 0) {
762                         $select[$p] = get_string('criteria_' . $p, 'badges');
763                     }
764                 }
765                 $actions[] = get_string('addbadgecriteria', 'badges');
766                 $actions[] = $this->output->single_select(new moodle_url('/badges/criteria_settings.php',
767                         array('badgeid' => $badge->id, 'add' => true)), 'type', $select);
768             } else {
769                 $actions[] = $this->output->box(get_string('nothingtoadd', 'badges'), 'clearfix');
770             }
771         }
773         $table->data[] = $actions;
774         return html_writer::table($table);
775     }
777     // Renders a table with users who have earned the badge.
778     // Based on stamps collection plugin.
779     protected function render_badge_recipients(badge_recipients $recipients) {
780         $paging = new paging_bar($recipients->totalcount, $recipients->page, $recipients->perpage, $this->page->url, 'page');
781         $htmlpagingbar = $this->render($paging);
782         $table = new html_table();
783         $table->attributes['class'] = 'generaltable boxaligncenter boxwidthwide';
785         $sortbyfirstname = $this->helper_sortable_heading(get_string('firstname'),
786                 'firstname', $recipients->sort, $recipients->dir);
787         $sortbylastname = $this->helper_sortable_heading(get_string('lastname'),
788                 'lastname', $recipients->sort, $recipients->dir);
789         if ($this->helper_fullname_format() == 'lf') {
790             $sortbyname = $sortbylastname . ' / ' . $sortbyfirstname;
791         } else {
792             $sortbyname = $sortbyfirstname . ' / ' . $sortbylastname;
793         }
795         $sortbydate = $this->helper_sortable_heading(get_string('dateawarded', 'badges'),
796                 'dateissued', $recipients->sort, $recipients->dir);
798         $table->head = array($sortbyname, $sortbydate, '');
800         foreach ($recipients->userids as $holder) {
801             $fullname = fullname($holder);
802             $fullname = html_writer::link(
803                             new moodle_url('/user/profile.php', array('id' => $holder->userid)),
804                             $fullname
805                         );
806             $awarded  = userdate($holder->dateissued);
807             $badgeurl = html_writer::link(
808                             new moodle_url('/badges/badge.php', array('hash' => $holder->uniquehash)),
809                             get_string('viewbadge', 'badges')
810                         );
812             $row = array($fullname, $awarded, $badgeurl);
813             $table->data[] = $row;
814         }
816         $htmltable = html_writer::table($table);
818         return $htmlpagingbar . $htmltable . $htmlpagingbar;
819     }
821     ////////////////////////////////////////////////////////////////////////////
822     // Helper methods
823     // Reused from stamps collection plugin
824     ////////////////////////////////////////////////////////////////////////////
826     /**
827      * Renders a text with icons to sort by the given column
828      *
829      * This is intended for table headings.
830      *
831      * @param string $text    The heading text
832      * @param string $sortid  The column id used for sorting
833      * @param string $sortby  Currently sorted by (column id)
834      * @param string $sorthow Currently sorted how (ASC|DESC)
835      *
836      * @return string
837      */
838     protected function helper_sortable_heading($text, $sortid = null, $sortby = null, $sorthow = null) {
839         $out = html_writer::tag('span', $text, array('class' => 'text'));
841         if (!is_null($sortid)) {
842             if ($sortby !== $sortid || $sorthow !== 'ASC') {
843                 $url = new moodle_url($this->page->url);
844                 $url->params(array('sort' => $sortid, 'dir' => 'ASC'));
845                 $out .= $this->output->action_icon($url,
846                         new pix_icon('t/sort_asc', get_string('sortbyx', 'core', s($text)), null, array('class' => 'iconsort')));
847             }
848             if ($sortby !== $sortid || $sorthow !== 'DESC') {
849                 $url = new moodle_url($this->page->url);
850                 $url->params(array('sort' => $sortid, 'dir' => 'DESC'));
851                 $out .= $this->output->action_icon($url,
852                         new pix_icon('t/sort_desc', get_string('sortbyxreverse', 'core', s($text)), null, array('class' => 'iconsort')));
853             }
854         }
855         return $out;
856     }
857     /**
858      * Tries to guess the fullname format set at the site
859      *
860      * @return string fl|lf
861      */
862     protected function helper_fullname_format() {
863         $fake = new stdClass();
864         $fake->lastname = 'LLLL';
865         $fake->firstname = 'FFFF';
866         $fullname = get_string('fullnamedisplay', '', $fake);
867         if (strpos($fullname, 'LLLL') < strpos($fullname, 'FFFF')) {
868             return 'lf';
869         } else {
870             return 'fl';
871         }
872     }
873     /**
874      * Renders a search form
875      *
876      * @param string $search Search string
877      * @return string HTML
878      */
879     protected function helper_search_form($search) {
880         global $CFG;
881         require_once($CFG->libdir . '/formslib.php');
883         $mform = new MoodleQuickForm('searchform', 'POST', $this->page->url);
885         $mform->addElement('hidden', 'sesskey', sesskey());
887         $el[] = $mform->createElement('text', 'search', get_string('search'), array('size' => 20));
888         $mform->setDefault('search', $search);
889         $el[] = $mform->createElement('submit', 'submitsearch', get_string('search'));
890         $el[] = $mform->createElement('submit', 'clearsearch', get_string('clear'));
891         $mform->addGroup($el, 'searchgroup', get_string('searchname', 'badges'), ' ', false);
893         ob_start();
894         $mform->display();
895         $out = ob_get_clean();
897         return $out;
898     }
901 /**
902  * An issued badges for badge.php page
903  */
904 class issued_badge implements renderable {
905     /** @var issued badge */
906     public $issued;
908     /** @var badge recipient */
909     public $recipient;
911     /** @var badge class */
912     public $badgeclass;
914     /** @var badge visibility to others */
915     public $visible = 0;
917     /** @var badge class */
918     public $badgeid = 0;
920     /**
921      * Initializes the badge to display
922      *
923      * @param string $hash Issued badge hash
924      */
925     public function __construct($hash) {
926         global $DB;
928         $assertion = new core_badges_assertion($hash);
929         $this->issued = $assertion->get_badge_assertion();
930         $this->badgeclass = $assertion->get_badge_class();
932         $rec = $DB->get_record_sql('SELECT userid, visible, badgeid
933                 FROM {badge_issued}
934                 WHERE ' . $DB->sql_compare_text('uniquehash', 40) . ' = ' . $DB->sql_compare_text(':hash', 40),
935                 array('hash' => $hash), IGNORE_MISSING);
936         if ($rec) {
937             // Get a recipient from database.
938             $user = $DB->get_record_sql('SELECT u.id, u.lastname, u.firstname,
939                                                 u.email AS accountemail, b.email AS backpackemail
940                         FROM {user} u LEFT JOIN {badge_backpack} b ON u.id = b.userid
941                         WHERE u.id = :userid', array('userid' => $rec->userid));
942             $this->recipient = $user;
943             $this->visible = $rec->visible;
944             $this->badgeid = $rec->badgeid;
945         }
946     }
949 /**
950  * An external badges for external.php page
951  */
952 class external_badge implements renderable {
953     /** @var issued badge */
954     public $issued;
956     /** @var User ID */
957     public $recipient;
959     /** @var validation of external badge */
960     public $valid = true;
962     /**
963      * Initializes the badge to display
964      *
965      * @param object $badge External badge information.
966      * @param int $recipient User id.
967      */
968     public function __construct($badge, $recipient) {
969         global $DB;
970         // At this point a user has connected a backpack. So, we are going to get
971         // their backpack email rather than their account email.
972         $user = $DB->get_record_sql('SELECT u.lastname, u.firstname, b.email
973                     FROM {user} u INNER JOIN {badge_backpack} b ON u.id = b.userid
974                     WHERE userid = :userid', array('userid' => $recipient), IGNORE_MISSING);
976         $this->issued = $badge;
977         $this->recipient = $user;
979         // Check if recipient is valid.
980         // There is no way to be 100% sure that a badge belongs to a user.
981         // Backpack does not return any recipient information.
982         // All we can do is compare that backpack email hashed using salt
983         // provided in the assertion matches a badge recipient from the assertion.
984         if ($user) {
985             if (validate_email($badge->assertion->recipient) && $badge->assertion->recipient == $user->email) {
986                 // If we have email, compare emails.
987                 $this->valid = true;
988             } else if ($badge->assertion->recipient == 'sha256$' . hash('sha256', $user->email)) {
989                 // If recipient is hashed, but no salt, compare hashes without salt.
990                 $this->valid = true;
991             } else if ($badge->assertion->recipient == 'sha256$' . hash('sha256', $user->email . $badge->assertion->salt)) {
992                 // If recipient is hashed, compare hashes.
993                 $this->valid = true;
994             } else {
995                 // Otherwise, we cannot be sure that this user is a recipient.
996                 $this->valid = false;
997             }
998         } else {
999             $this->valid = false;
1000         }
1001     }
1004 /**
1005  * Badge recipients rendering class
1006  */
1007 class badge_recipients implements renderable {
1008     /** @var string how are the data sorted */
1009     public $sort = 'lastname';
1011     /** @var string how are the data sorted */
1012     public $dir = 'ASC';
1014     /** @var int page number to display */
1015     public $page = 0;
1017     /** @var int number of badge recipients to display per page */
1018     public $perpage = 30;
1020     /** @var int the total number or badge recipients to display */
1021     public $totalcount = null;
1023     /** @var array internal list of  badge recipients ids */
1024     public $userids = array();
1025     /**
1026      * Initializes the list of users to display
1027      *
1028      * @param array $holders List of badge holders
1029      */
1030     public function __construct($holders) {
1031         $this->userids = $holders;
1032     }
1035 /**
1036  * Collection of all badges for view.php page
1037  */
1038 class badge_collection implements renderable {
1040     /** @var string how are the data sorted */
1041     public $sort = 'name';
1043     /** @var string how are the data sorted */
1044     public $dir = 'ASC';
1046     /** @var int page number to display */
1047     public $page = 0;
1049     /** @var int number of badges to display per page */
1050     public $perpage = BADGE_PERPAGE;
1052     /** @var int the total number of badges to display */
1053     public $totalcount = null;
1055     /** @var array list of badges */
1056     public $badges = array();
1058     /**
1059      * Initializes the list of badges to display
1060      *
1061      * @param array $badges Badges to render
1062      */
1063     public function __construct($badges) {
1064         $this->badges = $badges;
1065     }
1068 /**
1069  * Collection of badges used at the index.php page
1070  */
1071 class badge_management extends badge_collection implements renderable {
1074 /**
1075  * Collection of user badges used at the mybadges.php page
1076  */
1077 class badge_user_collection extends badge_collection implements renderable {
1078     /** @var array backpack settings */
1079     public $backpack = null;
1081     /** @var string search */
1082     public $search = '';
1084     /**
1085      * Initializes user badge collection.
1086      *
1087      * @param array $badges Badges to render
1088      * @param int $userid Badges owner
1089      */
1090     public function __construct($badges, $userid) {
1091         global $CFG;
1092         parent::__construct($badges);
1094         if (!empty($CFG->badges_allowexternalbackpack)) {
1095             $this->backpack = get_backpack_settings($userid, true);
1096         }
1097     }