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