lib/badgeslib.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  * Contains classes, functions and constants used in badges.
  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 defined('MOODLE_INTERNAL') || die();
  28
  29 /* Include required award criteria library. */
  30 require_once($CFG->dirroot . '/badges/criteria/award_criteria.php');
  31
  32 /*
  33  * Number of records per page.
  34 */
  35 define('BADGE_PERPAGE', 50);
  36
  37 /*
  38  * Badge award criteria aggregation method.
  39  */
  40 define('BADGE_CRITERIA_AGGREGATION_ALL', 1);
  41
  42 /*
  43  * Badge award criteria aggregation method.
  44  */
  45 define('BADGE_CRITERIA_AGGREGATION_ANY', 2);
  46
  47 /*
  48  * Inactive badge means that this badge cannot be earned and has not been awarded
  49  * yet. Its award criteria can be changed.
  50  */
  51 define('BADGE_STATUS_INACTIVE', 0);
  52
  53 /*
  54  * Active badge means that this badge can we earned, but it has not been awarded
  55  * yet. Can be deactivated for the purpose of changing its criteria.
  56  */
  57 define('BADGE_STATUS_ACTIVE', 1);
  58
  59 /*
  60  * Inactive badge can no longer be earned, but it has been awarded in the past and
  61  * therefore its criteria cannot be changed.
  62  */
  63 define('BADGE_STATUS_INACTIVE_LOCKED', 2);
  64
  65 /*
  66  * Active badge means that it can be earned and has already been awarded to users.
  67  * Its criteria cannot be changed any more.
  68  */
  69 define('BADGE_STATUS_ACTIVE_LOCKED', 3);
  70
  71 /*
  72  * Archived badge is considered deleted and can no longer be earned and is not
  73  * displayed in the list of all badges.
  74  */
  75 define('BADGE_STATUS_ARCHIVED', 4);
  76
  77 /*
  78  * Badge type for site badges.
  79  */
  80 define('BADGE_TYPE_SITE', 1);
  81
  82 /*
  83  * Badge type for course badges.
  84  */
  85 define('BADGE_TYPE_COURSE', 2);
  86
  87 /*
  88  * Badge messaging schedule options.
  89  */
  90 define('BADGE_MESSAGE_NEVER', 0);
  91 define('BADGE_MESSAGE_ALWAYS', 1);
  92 define('BADGE_MESSAGE_DAILY', 2);
  93 define('BADGE_MESSAGE_WEEKLY', 3);
  94 define('BADGE_MESSAGE_MONTHLY', 4);
  95
  96 /**
  97  * Class that represents badge.
  98  *
  99  */
 100 class badge {
 101     /** @var int Badge id */
 102     public $id;
 103
 104     /** Values from the table 'badge' */
 105     public $name;
 106     public $description;
 107     public $timecreated;
 108     public $timemodified;
 109     public $usercreated;
 110     public $usermodified;
 111     public $image;
 112     public $issuername;
 113     public $issuerurl;
 114     public $issuercontact;
 115     public $expiredate;
 116     public $expireperiod;
 117     public $type;
 118     public $courseid;
 119     public $message;
 120     public $messagesubject;
 121     public $attachment;
 122     public $notification;
 123     public $status = 0;
 124     public $nextcron;
 125
 126     /** @var array Badge criteria */
 127     public $criteria = array();
 128
 129     /**
 130      * Constructs with badge details.
 131      *
 132      * @param int $badgeid badge ID.
 133      */
 134     public function __construct($badgeid) {
 135         global $DB;
 136         $this->id = $badgeid;
 137
 138         $data = $DB->get_record('badge', array('id' => $badgeid));
 139
 140         if (empty($data)) {
 141             print_error('error:nosuchbadge', 'badges', $badgeid);
 142         }
 143
 144         foreach ((array)$data as $field => $value) {
 145             if (property_exists($this, $field)) {
 146                 $this->{$field} = $value;
 147             }
 148         }
 149
 150         $this->criteria = self::get_criteria();
 151     }
 152
 153     /**
 154      * Use to get context instance of a badge.
 155      * @return context instance.
 156      */
 157     public function get_context() {
 158         if ($this->type == BADGE_TYPE_SITE) {
 159             return context_system::instance();
 160         } else if ($this->type == BADGE_TYPE_COURSE) {
 161             return context_course::instance($this->courseid);
 162         } else {
 163             debugging('Something is wrong...');
 164         }
 165     }
 166
 167     /**
 168      * Return array of aggregation methods
 169      * @return array
 170      */
 171     public static function get_aggregation_methods() {
 172         return array(
 173                 BADGE_CRITERIA_AGGREGATION_ALL => get_string('all', 'badges'),
 174                 BADGE_CRITERIA_AGGREGATION_ANY => get_string('any', 'badges'),
 175         );
 176     }
 177
 178     /**
 179      * Return array of accepted criteria types for this badge
 180      * @return array
 181      */
 182     public function get_accepted_criteria() {
 183         $criteriatypes = array();
 184
 185         if ($this->type == BADGE_TYPE_COURSE) {
 186             $criteriatypes = array(
 187                     BADGE_CRITERIA_TYPE_OVERALL,
 188                     BADGE_CRITERIA_TYPE_MANUAL,
 189                     BADGE_CRITERIA_TYPE_COURSE,
 190                     BADGE_CRITERIA_TYPE_ACTIVITY
 191             );
 192         } else if ($this->type == BADGE_TYPE_SITE) {
 193             $criteriatypes = array(
 194                     BADGE_CRITERIA_TYPE_OVERALL,
 195                     BADGE_CRITERIA_TYPE_MANUAL,
 196                     BADGE_CRITERIA_TYPE_COURSESET,
 197                     BADGE_CRITERIA_TYPE_PROFILE,
 198             );
 199         }
 200
 201         return $criteriatypes;
 202     }
 203
 204     /**
 205      * Save/update badge information in 'badge' table only.
 206      * Cannot be used for updating awards and criteria settings.
 207      *
 208      * @return bool Returns true on success.
 209      */
 210     public function save() {
 211         global $DB;
 212
 213         $fordb = new stdClass();
 214         foreach (get_object_vars($this) as $k => $v) {
 215             $fordb->{$k} = $v;
 216         }
 217         unset($fordb->criteria);
 218
 219         $fordb->timemodified = time();
 220         if ($DB->update_record_raw('badge', $fordb)) {
 221             return true;
 222         } else {
 223             throw new moodle_exception('error:save', 'badges');
 224             return false;
 225         }
 226     }
 227
 228     /**
 229      * Creates and saves a clone of badge with all its properties.
 230      * Clone is not active by default and has 'Copy of' attached to its name.
 231      *
 232      * @return int ID of new badge.
 233      */
 234     public function make_clone() {
 235         global $DB, $USER;
 236
 237         $fordb = new stdClass();
 238         foreach (get_object_vars($this) as $k => $v) {
 239             $fordb->{$k} = $v;
 240         }
 241
 242         $fordb->name = get_string('copyof', 'badges', $this->name);
 243         $fordb->status = BADGE_STATUS_INACTIVE;
 244         $fordb->image = 0;
 245         $fordb->usercreated = $USER->id;
 246         $fordb->usermodified = $USER->id;
 247         $fordb->timecreated = time();
 248         $fordb->timemodified = time();
 249         unset($fordb->id);
 250
 251         if ($fordb->notification > 1) {
 252             $fordb->nextcron = badges_calculate_message_schedule($fordb->notification);
 253         }
 254
 255         $criteria = $fordb->criteria;
 256         unset($fordb->criteria);
 257
 258         if ($new = $DB->insert_record('badge', $fordb, true)) {
 259             $newbadge = new badge($new);
 260
 261             // Copy badge image.
 262             $fs = get_file_storage();
 263             if ($file = $fs->get_file($this->get_context()->id, 'badges', 'badgeimage', $this->id, '/', 'f1.png')) {
 264                 if ($imagefile = $file->copy_content_to_temp()) {
 265                     badges_process_badge_image($newbadge, $imagefile);
 266                 }
 267             }
 268
 269             // Copy badge criteria.
 270             foreach ($this->criteria as $crit) {
 271                 $crit->make_clone($new);
 272             }
 273
 274             return $new;
 275         } else {
 276             throw new moodle_exception('error:clone', 'badges');
 277             return false;
 278         }
 279     }
 280
 281     /**
 282      * Checks if badges is active.
 283      * Used in badge award.
 284      *
 285      * @return bool A status indicating badge is active
 286      */
 287     public function is_active() {
 288         if (($this->status == BADGE_STATUS_ACTIVE) ||
 289             ($this->status == BADGE_STATUS_ACTIVE_LOCKED)) {
 290             return true;
 291         }
 292         return false;
 293     }
 294
 295     /**
 296      * Use to get the name of badge status.
 297      *
 298      */
 299     public function get_status_name() {
 300         return get_string('badgestatus_' . $this->status, 'badges');
 301     }
 302
 303     /**
 304      * Use to set badge status.
 305      * Only active badges can be earned/awarded/issued.
 306      *
 307      * @param int $status Status from BADGE_STATUS constants
 308      */
 309     public function set_status($status = 0) {
 310         $this->status = $status;
 311         $this->save();
 312     }
 313
 314     /**
 315      * Checks if badges is locked.
 316      * Used in badge award and editing.
 317      *
 318      * @return bool A status indicating badge is locked
 319      */
 320     public function is_locked() {
 321         if (($this->status == BADGE_STATUS_ACTIVE_LOCKED) ||
 322                 ($this->status == BADGE_STATUS_INACTIVE_LOCKED)) {
 323             return true;
 324         }
 325         return false;
 326     }
 327
 328     /**
 329      * Checks if badge has been awarded to users.
 330      * Used in badge editing.
 331      *
 332      * @return bool A status indicating badge has been awarded at least once
 333      */
 334     public function has_awards() {
 335         global $DB;
 336         if ($DB->record_exists('badge_issued', array('badgeid' => $this->id))) {
 337             return true;
 338         }
 339         return false;
 340     }
 341
 342     /**
 343      * Gets list of users who have earned an instance of this badge.
 344      *
 345      * @return array An array of objects with information about badge awards.
 346      */
 347     public function get_awards() {
 348         global $DB;
 349
 350         $awards = $DB->get_records_sql(
 351                 'SELECT b.userid, b.dateissued, b.uniquehash, u.firstname, u.lastname
 352                     FROM {badge_issued} b INNER JOIN {user} u
 353                         ON b.userid = u.id
 354                     WHERE b.badgeid = :badgeid', array('badgeid' => $this->id));
 355
 356         return $awards;
 357     }
 358
 359     /**
 360      * Indicates whether badge has already been issued to a user.
 361      *
 362      */
 363     public function is_issued($userid) {
 364         global $DB;
 365         return $DB->record_exists('badge_issued', array('badgeid' => $this->id, 'userid' => $userid));
 366     }
 367
 368     /**
 369      * Issue a badge to user.
 370      *
 371      * @param int $userid User who earned the badge
 372      * @param bool $nobake Not baking actual badges (for testing purposes)
 373      */
 374     public function issue($userid, $nobake = false) {
 375         global $DB, $CFG;
 376
 377         $now = time();
 378         $issued = new stdClass();
 379         $issued->badgeid = $this->id;
 380         $issued->userid = $userid;
 381         $issued->uniquehash = sha1(rand() . $userid . $this->id . $now);
 382         $issued->dateissued = $now;
 383
 384         if ($this->can_expire()) {
 385             $issued->dateexpire = $this->calculate_expiry($now);
 386         } else {
 387             $issued->dateexpire = null;
 388         }
 389
 390         // Take into account user badges privacy settings.
 391         // If none set, badges default visibility is set to public.
 392         $issued->visible = get_user_preferences('badgeprivacysetting', 1, $userid);
 393
 394         $result = $DB->insert_record('badge_issued', $issued, true);
 395
 396         if ($result) {
 397             // Lock the badge, so that its criteria could not be changed any more.
 398             if ($this->status == BADGE_STATUS_ACTIVE) {
 399                 $this->set_status(BADGE_STATUS_ACTIVE_LOCKED);
 400             }
 401
 402             // Update details in criteria_met table.
 403             $compl = $this->get_criteria_completions($userid);
 404             foreach ($compl as $c) {
 405                 $obj = new stdClass();
 406                 $obj->id = $c->id;
 407                 $obj->issuedid = $result;
 408                 $DB->update_record('badge_criteria_met', $obj, true);
 409             }
 410
 411             if (!$nobake) {
 412                 // Bake a badge image.
 413                 $pathhash = badges_bake($issued->uniquehash, $this->id, $userid, true);
 414
 415                 // Notify recipients and badge creators.
 416                 if (empty($CFG->noemailever)) {
 417                     badges_notify_badge_award($this, $userid, $issued->uniquehash, $pathhash);
 418                 }
 419             }
 420         }
 421     }
 422
 423     /**
 424      * Reviews all badge criteria and checks if badge can be instantly awarded.
 425      *
 426      * @return int Number of awards
 427      */
 428     public function review_all_criteria() {
 429         global $DB, $CFG;
 430         $awards = 0;
 431
 432         // Raise timelimit as this could take a while for big web sites.
 433         set_time_limit(0);
 434         raise_memory_limit(MEMORY_HUGE);
 435
 436         // For site level badges, get all active site users who can earn this badge and haven't got it yet.
 437         if ($this->type == BADGE_TYPE_SITE) {
 438             $sql = 'SELECT DISTINCT u.id, bi.badgeid
 439                         FROM {user} u
 440                         LEFT JOIN {badge_issued} bi
 441                             ON u.id = bi.userid AND bi.badgeid = :badgeid
 442                         WHERE bi.badgeid IS NULL AND u.id != :guestid AND u.deleted = 0';
 443             $toearn = $DB->get_fieldset_sql($sql, array('badgeid' => $this->id, 'guestid' => $CFG->siteguest));
 444         } else {
 445             // For course level badges, get users who can earn this badge in the course.
 446             // These are all enrolled users with capability moodle/badges:earnbadge.
 447             $earned = $DB->get_fieldset_select('badge_issued', 'userid AS id', 'badgeid = :badgeid', array('badgeid' => $this->id));
 448             $users = get_enrolled_users($this->get_context(), 'moodle/badges:earnbadge', 0, 'u.id');
 449             $toearn = array_diff(array_keys($users), $earned);
 450         }
 451
 452         foreach ($toearn as $uid) {
 453             $toreview = false;
 454             foreach ($this->criteria as $crit) {
 455                 if ($crit->criteriatype != BADGE_CRITERIA_TYPE_OVERALL) {
 456                     if ($crit->review($uid)) {
 457                         $crit->mark_complete($uid);
 458                         if ($this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->method == BADGE_CRITERIA_AGGREGATION_ANY) {
 459                             $this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($uid);
 460                             $this->issue($uid);
 461                             $awards++;
 462                             break;
 463                         } else {
 464                             $toreview = true;
 465                             continue;
 466                         }
 467                     } else {
 468                         if ($this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->method == BADGE_CRITERIA_AGGREGATION_ANY) {
 469                             continue;
 470                         } else {
 471                             break;
 472                         }
 473                     }
 474                 }
 475             }
 476             // Review overall if it is required.
 477             if ($toreview && $this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->review($uid)) {
 478                 $this->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($uid);
 479                 $this->issue($uid);
 480                 $awards++;
 481             }
 482         }
 483
 484         return $awards;
 485     }
 486
 487     /**
 488      * Gets an array of completed criteria from 'badge_criteria_met' table.
 489      *
 490      * @param int $userid Completions for a user
 491      * @return array Records of criteria completions
 492      */
 493     public function get_criteria_completions($userid) {
 494         global $DB;
 495         $completions = array();
 496         $sql = "SELECT bcm.id, bcm.critid
 497                 FROM {badge_criteria_met} bcm
 498                     INNER JOIN {badge_criteria} bc ON bcm.critid = bc.id
 499                 WHERE bc.badgeid = :badgeid AND bcm.userid = :userid ";
 500         $completions = $DB->get_records_sql($sql, array('badgeid' => $this->id, 'userid' => $userid));
 501
 502         return $completions;
 503     }
 504
 505     /**
 506      * Checks if badges has award criteria set up.
 507      *
 508      * @return bool A status indicating badge has at least one criterion
 509      */
 510     public function has_criteria() {
 511         if (count($this->criteria) > 0) {
 512             return true;
 513         }
 514         return false;
 515     }
 516
 517     /**
 518      * Returns badge award criteria
 519      *
 520      * @return array An array of badge criteria
 521      */
 522     public function get_criteria() {
 523         global $DB;
 524         $criteria = array();
 525
 526         if ($records = (array)$DB->get_records('badge_criteria', array('badgeid' => $this->id))) {
 527             foreach ($records as $record) {
 528                 $criteria[$record->criteriatype] = award_criteria::build((array)$record);
 529             }
 530         }
 531
 532         return $criteria;
 533     }
 534
 535     /**
 536      * Get aggregation method for badge criteria
 537      *
 538      * @param int $criteriatype If none supplied, get overall aggregation method (optional)
 539      * @return int One of BADGE_CRITERIA_AGGREGATION_ALL or BADGE_CRITERIA_AGGREGATION_ANY
 540      */
 541     public function get_aggregation_method($criteriatype = 0) {
 542         global $DB;
 543         $params = array('badgeid' => $this->id, 'criteriatype' => $criteriatype);
 544         $aggregation = $DB->get_field('badge_criteria', 'method', $params, IGNORE_MULTIPLE);
 545
 546         if (!$aggregation) {
 547             return BADGE_CRITERIA_AGGREGATION_ALL;
 548         }
 549
 550         return $aggregation;
 551     }
 552
 553     /**
 554      * Checks if badge has expiry period or date set up.
 555      *
 556      * @return bool A status indicating badge can expire
 557      */
 558     public function can_expire() {
 559         if ($this->expireperiod || $this->expiredate) {
 560             return true;
 561         }
 562         return false;
 563     }
 564
 565     /**
 566      * Calculates badge expiry date based on either expirydate or expiryperiod.
 567      *
 568      * @param int $timestamp Time of badge issue
 569      * @return int A timestamp
 570      */
 571     public function calculate_expiry($timestamp) {
 572         $expiry = null;
 573
 574         if (isset($this->expiredate)) {
 575             $expiry = $this->expiredate;
 576         } else if (isset($this->expireperiod)) {
 577             $expiry = $timestamp + $this->expireperiod;
 578         }
 579
 580         return $expiry;
 581     }
 582
 583     /**
 584      * Checks if badge has manual award criteria set.
 585      *
 586      * @return bool A status indicating badge can be awarded manually
 587      */
 588     public function has_manual_award_criteria() {
 589         foreach ($this->criteria as $criterion) {
 590             if ($criterion->criteriatype == BADGE_CRITERIA_TYPE_MANUAL) {
 591                 return true;
 592             }
 593         }
 594         return false;
 595     }
 596
 597     /**
 598      * Marks the badge as archived.
 599      * For reporting and historical purposed we cannot completely delete badges.
 600      * We will just change their status to BADGE_STATUS_ARCHIVED.
 601      */
 602     public function delete() {
 603         $this->status = BADGE_STATUS_ARCHIVED;
 604         $this->save();
 605     }
 606 }
 607
 608 /**
 609  * Sends notifications to users about awarded badges.
 610  *
 611  * @param badge $badge Badge that was issued
 612  * @param int $userid Recipient ID
 613  * @param string $issued Unique hash of an issued badge
 614  * @param string $filepathhash File path hash of an issued badge for attachments
 615  */
 616 function badges_notify_badge_award(badge $badge, $userid, $issued, $filepathhash) {
 617     global $CFG, $DB;
 618
 619     $admin = get_admin();
 620     $userfrom = new stdClass();
 621     $userfrom->id = $admin->id;
 622     $userfrom->email = !empty($CFG->badges_defaultissuercontact) ? $CFG->badges_defaultissuercontact : $admin->email;
 623     $userfrom->firstname = !empty($CFG->badges_defaultissuername) ? $CFG->badges_defaultissuername : $admin->firstname;
 624     $userfrom->lastname = !empty($CFG->badges_defaultissuername) ? '' : $admin->lastname;
 625     $userfrom->maildisplay = true;
 626
 627     $issuedlink = html_writer::link(new moodle_url('/badges/badge.php', array('hash' => $issued)), $badge->name);
 628     $userto = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST);
 629
 630     $params = new stdClass();
 631     $params->badgename = $badge->name;
 632     $params->username = fullname($userto);
 633     $params->badgelink = $issuedlink;
 634     $message = badge_message_from_template($badge->message, $params);
 635     $plaintext = format_text_email($message, FORMAT_HTML);
 636
 637     if ($badge->attachment && $filepathhash) {
 638         $fs = get_file_storage();
 639         $file = $fs->get_file_by_hash($filepathhash);
 640         $attachment = $file->copy_content_to_temp();
 641         email_to_user($userto,
 642             $userfrom,
 643             $badge->messagesubject,
 644             $plaintext,
 645             $message,
 646             str_replace($CFG->dataroot, '', $attachment),
 647             str_replace(' ', '_', $badge->name) . ".png"
 648         );
 649         @unlink($attachment);
 650     } else {
 651         email_to_user($userto, $userfrom, $badge->messagesubject, $plaintext, $message);
 652     }
 653
 654     // Notify badge creator about the award if they receive notifications every time.
 655     if ($badge->notification == 1) {
 656         $creator = $DB->get_record('user', array('id' => $badge->usercreated), '*', MUST_EXIST);
 657         $a = new stdClass();
 658         $a->user = fullname($userto);
 659         $a->link = $issuedlink;
 660         $creatormessage = get_string('creatorbody', 'badges', $a);
 661         $creatorsubject = get_string('creatorsubject', 'badges', $badge->name);
 662
 663         $eventdata = new stdClass();
 664         $eventdata->component         = 'moodle';
 665         $eventdata->name              = 'instantmessage';
 666         $eventdata->userfrom          = $userfrom;
 667         $eventdata->userto            = $creator;
 668         $eventdata->notification      = 1;
 669         $eventdata->subject           = $creatorsubject;
 670         $eventdata->fullmessage       = $creatormessage;
 671         $eventdata->fullmessageformat = FORMAT_PLAIN;
 672         $eventdata->fullmessagehtml   = format_text($creatormessage, FORMAT_HTML);
 673         $eventdata->smallmessage      = '';
 674
 675         message_send($eventdata);
 676         $DB->set_field('badge_issued', 'issuernotified', time(), array('badgeid' => $badge->id, 'userid' => $userid));
 677     }
 678 }
 679
 680 /**
 681  * Caclulates date for the next message digest to badge creators.
 682  *
 683  * @param in $schedule Type of message schedule BADGE_MESSAGE_DAILY|BADGE_MESSAGE_WEEKLY|BADGE_MESSAGE_MONTHLY.
 684  * @return int Timestamp for next cron
 685  */
 686 function badges_calculate_message_schedule($schedule) {
 687     $nextcron = 0;
 688
 689     switch ($schedule) {
 690         case BADGE_MESSAGE_DAILY:
 691             $nextcron = time() + 60 * 60 * 24;
 692             break;
 693         case BADGE_MESSAGE_WEEKLY:
 694             $nextcron = time() + 60 * 60 * 24 * 7;
 695             break;
 696         case BADGE_MESSAGE_MONTHLY:
 697             $nextcron = time() + 60 * 60 * 24 * 7 * 30;
 698             break;
 699     }
 700
 701     return $nextcron;
 702 }
 703
 704 /**
 705  * Replaces variables in a message template and returns text ready to be emailed to a user.
 706  *
 707  * @param string $message Message body.
 708  * @return string Message with replaced values
 709  */
 710 function badge_message_from_template($message, $params) {
 711     $msg = $message;
 712     foreach ($params as $key => $value) {
 713         $msg = str_replace("%$key%", $value, $msg);
 714     }
 715
 716     return $msg;
 717 }
 718
 719 /**
 720  * Get all badges.
 721  *
 722  * @param int Type of badges to return
 723  * @param int Course ID for course badges
 724  * @param string $sort An SQL field to sort by
 725  * @param string $dir The sort direction ASC|DESC
 726  * @param int $page The page or records to return
 727  * @param int $perpage The number of records to return per page
 728  * @param int $user User specific search
 729  * @return array $badge Array of records matching criteria
 730  */
 731 function badges_get_badges($type, $courseid = 0, $sort = '', $dir = '', $page = 0, $perpage = BADGE_PERPAGE, $user = 0) {
 732     global $DB;
 733     $records = array();
 734     $params = array();
 735     $where = "b.status != :deleted AND b.type = :type ";
 736     $params['deleted'] = BADGE_STATUS_ARCHIVED;
 737
 738     $userfields = array('b.id, b.name, b.status');
 739     $usersql = "";
 740     if ($user != 0) {
 741         $userfields[] = 'bi.dateissued';
 742         $userfields[] = 'bi.uniquehash';
 743         $usersql = " LEFT JOIN {badge_issued} bi ON b.id = bi.badgeid AND bi.userid = :userid ";
 744         $params['userid'] = $user;
 745         $where .= " AND (b.status = 1 OR b.status = 3) ";
 746     }
 747     $fields = implode(', ', $userfields);
 748
 749     if ($courseid != 0 ) {
 750         $where .= "AND b.courseid = :courseid ";
 751         $params['courseid'] = $courseid;
 752     }
 753
 754     $sorting = (($sort != '' && $dir != '') ? 'ORDER BY ' . $sort . ' ' . $dir : '');
 755     $params['type'] = $type;
 756
 757     $sql = "SELECT $fields FROM {badge} b $usersql WHERE $where $sorting";
 758     $records = $DB->get_records_sql($sql, $params, $page * $perpage, $perpage);
 759
 760     $badges = array();
 761     foreach ($records as $r) {
 762         $badge = new badge($r->id);
 763         $badges[$r->id] = $badge;
 764         if ($user != 0) {
 765             $badges[$r->id]->dateissued = $r->dateissued;
 766             $badges[$r->id]->uniquehash = $r->uniquehash;
 767         } else {
 768             $badges[$r->id]->awards = $DB->count_records('badge_issued', array('badgeid' => $badge->id));
 769             $badges[$r->id]->statstring = $badge->get_status_name();
 770         }
 771     }
 772     return $badges;
 773 }
 774
 775 /**
 776  * Get badges for a specific user.
 777  *
 778  * @param int $userid User ID
 779  * @param int $courseid Badges earned by a user in a specific course
 780  * @param int $page The page or records to return
 781  * @param int $perpage The number of records to return per page
 782  * @param string $search A simple string to search for
 783  * @param bool $onlypublic Return only public badges
 784  * @return array of badges ordered by decreasing date of issue
 785  */
 786 function badges_get_user_badges($userid, $courseid = 0, $page = 0, $perpage = 0, $search = '', $onlypublic = false) {
 787     global $DB;
 788     $badges = array();
 789
 790     $params[] = $userid;
 791     $sql = 'SELECT
 792                 bi.uniquehash,
 793                 bi.dateissued,
 794                 bi.dateexpire,
 795                 bi.id as issuedid,
 796                 bi.visible,
 797                 u.email,
 798                 b.*
 799             FROM
 800                 {badge} b,
 801                 {badge_issued} bi,
 802                 {user} u
 803             WHERE b.id = bi.badgeid
 804                 AND u.id = bi.userid
 805                 AND bi.userid = ?';
 806
 807     if (!empty($search)) {
 808         $sql .= ' AND (' . $DB->sql_like('b.name', '?', false) . ') ';
 809         $params[] = "%$search%";
 810     }
 811     if ($onlypublic) {
 812         $sql .= ' AND (bi.visible = 1) ';
 813     }
 814
 815     if ($courseid != 0) {
 816         $sql .= ' AND (b.courseid = ' . $courseid . ') ';
 817     }
 818     $sql .= ' ORDER BY bi.dateissued DESC';
 819     $badges = $DB->get_records_sql($sql, $params, $page * $perpage, $perpage);
 820
 821     return $badges;
 822 }
 823
 824 /**
 825  * Get issued badge details for assertion URL
 826  *
 827  * @param string $hash
 828  */
 829 function badges_get_issued_badge_info($hash) {
 830     global $DB, $CFG;
 831
 832     $a = array();
 833
 834     $record = $DB->get_record_sql('
 835             SELECT
 836                 bi.dateissued,
 837                 bi.dateexpire,
 838                 u.email,
 839                 b.*,
 840                 bb.email as backpackemail
 841             FROM
 842                 {badge} b
 843                 JOIN {badge_issued} bi
 844                     ON b.id = bi.badgeid
 845                 JOIN {user} u
 846                     ON u.id = bi.userid
 847                 LEFT JOIN {badge_backpack} bb
 848                     ON bb.userid = bi.userid
 849             WHERE ' . $DB->sql_compare_text('bi.uniquehash', 40) . ' = ' . $DB->sql_compare_text(':hash', 40),
 850             array('hash' => $hash), IGNORE_MISSING);
 851
 852     if ($record) {
 853         if ($record->type == BADGE_TYPE_SITE) {
 854             $context = context_system::instance();
 855         } else {
 856             $context = context_course::instance($record->courseid);
 857         }
 858
 859         $url = new moodle_url('/badges/badge.php', array('hash' => $hash));
 860         $email = empty($record->backpackemail) ? $record->email : $record->backpackemail;
 861
 862         // Recipient's email is hashed: <algorithm>$<hash(email + salt)>.
 863         $a['recipient'] = 'sha256$' . hash('sha256', $email . $CFG->badges_badgesalt);
 864         $a['salt'] = $CFG->badges_badgesalt;
 865
 866         if ($record->dateexpire) {
 867             $a['expires'] = date('Y-m-d', $record->dateexpire);
 868         }
 869
 870         $a['issued_on'] = date('Y-m-d', $record->dateissued);
 871         $a['evidence'] = $url->out(); // Issued badge URL.
 872         $a['badge'] = array();
 873         $a['badge']['version'] = '0.5.0'; // Version of OBI specification, 0.5.0 - current beta.
 874         $a['badge']['name'] = $record->name;
 875         $a['badge']['image'] = moodle_url::make_pluginfile_url($context->id, 'badges', 'badgeimage', $record->id, '/', 'f1')->out();
 876         $a['badge']['description'] = $record->description;
 877         $a['badge']['criteria'] = $url->out(); // Issued badge URL.
 878         $a['badge']['issuer'] = array();
 879         $a['badge']['issuer']['origin'] = $record->issuerurl;
 880         $a['badge']['issuer']['name'] = $record->issuername;
 881         $a['badge']['issuer']['contact'] = $record->issuercontact;
 882     }
 883
 884     return $a;
 885 }
 886
 887 /**
 888  * Extends the course administration navigation with the Badges page
 889  *
 890  * @param navigation_node $coursenode
 891  * @param object $course
 892  */
 893 function badges_add_course_navigation(navigation_node $coursenode, stdClass $course) {
 894     global $CFG, $SITE;
 895
 896     $coursecontext = context_course::instance($course->id);
 897     $isfrontpage = (!$coursecontext || $course->id == $SITE->id);
 898
 899     if (!empty($CFG->enablebadges) && !empty($CFG->badges_allowcoursebadges) && !$isfrontpage) {
 900         if (has_capability('moodle/badges:configuredetails', $coursecontext)) {
 901             $coursenode->add(get_string('coursebadges', 'badges'), null,
 902                     navigation_node::TYPE_CONTAINER, null, 'coursebadges',
 903                     new pix_icon('i/badge', get_string('coursebadges', 'badges')));
 904
 905             if (has_capability('moodle/badges:viewawarded', $coursecontext)) {
 906                 $url = new moodle_url($CFG->wwwroot . '/badges/index.php',
 907                         array('type' => BADGE_TYPE_COURSE, 'id' => $course->id));
 908
 909                 $coursenode->get('coursebadges')->add(get_string('managebadges', 'badges'), $url,
 910                     navigation_node::TYPE_SETTING, null, 'coursebadges');
 911             }
 912
 913             if (has_capability('moodle/badges:createbadge', $coursecontext)) {
 914                 $url = new moodle_url($CFG->wwwroot . '/badges/newbadge.php',
 915                         array('type' => BADGE_TYPE_COURSE, 'id' => $course->id));
 916
 917                 $coursenode->get('coursebadges')->add(get_string('newbadge', 'badges'), $url,
 918                         navigation_node::TYPE_SETTING, null, 'newbadge');
 919             }
 920         }
 921     }
 922 }
 923
 924 /**
 925  * Triggered when 'course_completed' event happens.
 926  *
 927  * @param   object $eventdata
 928  * @return  boolean
 929  */
 930 function badges_award_handle_course_criteria_review(stdClass $eventdata) {
 931     global $DB, $CFG;
 932
 933     if (!empty($CFG->enablebadges)) {
 934         $userid = $eventdata->userid;
 935         $courseid = $eventdata->course;
 936
 937         // Need to take into account that course can be a part of course_completion and courseset_completion criteria.
 938         if ($rs = $DB->get_records('badge_criteria_param', array('name' => 'course_' . $courseid, 'value' => $courseid))) {
 939             foreach ($rs as $r) {
 940                 $crit = $DB->get_record('badge_criteria', array('id' => $r->critid), 'badgeid, criteriatype', MUST_EXIST);
 941                 $badge = new badge($crit->badgeid);
 942                 if (!$badge->is_active() || $badge->is_issued($userid)) {
 943                     continue;
 944                 }
 945
 946                 if ($badge->criteria[$crit->criteriatype]->review($userid)) {
 947                     $badge->criteria[$crit->criteriatype]->mark_complete($userid);
 948
 949                     if ($badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->review($userid)) {
 950                         $badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($userid);
 951                         $badge->issue($userid);
 952                     }
 953                 }
 954             }
 955         }
 956     }
 957
 958     return true;
 959 }
 960
 961 /**
 962  * Triggered when 'activity_completed' event happens.
 963  *
 964  * @param   object $eventdata
 965  * @return  boolean
 966  */
 967 function badges_award_handle_activity_criteria_review(stdClass $eventdata) {
 968     global $DB, $CFG;
 969
 970     if (!empty($CFG->enablebadges)) {
 971         $userid = $eventdata->userid;
 972         $mod = $eventdata->coursemoduleid;
 973
 974         if ($eventdata->completionstate == COMPLETION_COMPLETE
 975             || $eventdata->completionstate == COMPLETION_COMPLETE_PASS
 976             || $eventdata->completionstate == COMPLETION_COMPLETE_FAIL) {
 977             // Need to take into account that there can be more than one badge with the same activity in its criteria.
 978             if ($rs = $DB->get_records('badge_criteria_param', array('name' => 'module_' . $mod, 'value' => $mod))) {
 979                 foreach ($rs as $r) {
 980                     $bid = $DB->get_field('badge_criteria', 'badgeid', array('id' => $r->critid), MUST_EXIST);
 981                     $badge = new badge($bid);
 982                     if (!$badge->is_active() || $badge->is_issued($userid)) {
 983                         continue;
 984                     }
 985
 986                     if ($badge->criteria[BADGE_CRITERIA_TYPE_ACTIVITY]->review($userid)) {
 987                         $badge->criteria[BADGE_CRITERIA_TYPE_ACTIVITY]->mark_complete($userid);
 988
 989                         if ($badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->review($userid)) {
 990                             $badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($userid);
 991                             $badge->issue($userid);
 992                         }
 993                     }
 994                 }
 995             }
 996         }
 997     }
 998
 999     return true;
1000 }
1001
1002 /**
1003  * Triggered when 'user_updated' event happens.
1004  *
1005  * @param   object $eventdata Holds all information about a user.
1006  * @return  boolean
1007  */
1008 function badges_award_handle_profile_criteria_review(stdClass $eventdata) {
1009     global $DB, $CFG;
1010
1011     if (!empty($CFG->enablebadges)) {
1012         $userid = $eventdata->id;
1013
1014         if ($rs = $DB->get_records('badge_criteria', array('criteriatype' => BADGE_CRITERIA_TYPE_PROFILE))) {
1015             foreach ($rs as $r) {
1016                 $badge = new badge($r->badgeid);
1017                 if (!$badge->is_active() || $badge->is_issued($userid)) {
1018                     continue;
1019                 }
1020
1021                 if ($badge->criteria[BADGE_CRITERIA_TYPE_PROFILE]->review($userid)) {
1022                     $badge->criteria[BADGE_CRITERIA_TYPE_PROFILE]->mark_complete($userid);
1023
1024                     if ($badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->review($userid)) {
1025                         $badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($userid);
1026                         $badge->issue($userid);
1027                     }
1028                 }
1029             }
1030         }
1031     }
1032
1033     return true;
1034 }
1035
1036 /**
1037  * Triggered when badge is manually awarded.
1038  *
1039  * @param   object      $data
1040  * @return  boolean
1041  */
1042 function badges_award_handle_manual_criteria_review(stdClass $data) {
1043     $criteria = $data->crit;
1044     $userid = $data->userid;
1045     $badge = new badge($criteria->badgeid);
1046
1047     if (!$badge->is_active() || $badge->is_issued($userid)) {
1048         return true;
1049     }
1050
1051     if ($criteria->review($userid)) {
1052         $criteria->mark_complete($userid);
1053
1054         if ($badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->review($userid)) {
1055             $badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->mark_complete($userid);
1056             $badge->issue($userid);
1057         }
1058     }
1059
1060     return true;
1061 }
1062
1063 /**
1064  * Process badge image from form data
1065  *
1066  * @param badge $badge Badge object
1067  * @param string $iconfile Original file
1068  */
1069 function badges_process_badge_image(badge $badge, $iconfile) {
1070     global $CFG, $USER;
1071     require_once($CFG->libdir. '/gdlib.php');
1072
1073     if (!empty($CFG->gdversion)) {
1074         if ($fileid = (int)process_new_icon($badge->get_context(), 'badges', 'badgeimage', $badge->id, $iconfile)) {
1075             $badge->image = $fileid;
1076             $badge->save();
1077         }
1078         @unlink($iconfile);
1079
1080         // Clean up file draft area after badge image has been saved.
1081         $context = context_user::instance($USER->id, MUST_EXIST);
1082         $fs = get_file_storage();
1083         $fs->delete_area_files($context->id, 'user', 'draft');
1084     }
1085 }
1086
1087 /**
1088  * Print badge image.
1089  *
1090  * @param badge $badge Badge object
1091  * @param stdClass $context
1092  * @param string $size
1093  */
1094 function print_badge_image(badge $badge, stdClass $context, $size = 'small') {
1095     $fsize = ($size == 'small') ? 'f2' : 'f1';
1096
1097     $imageurl = moodle_url::make_pluginfile_url($context->id, 'badges', 'badgeimage', $badge->id, '/', $fsize, false);
1098     // Appending a random parameter to image link to forse browser reload the image.
1099     $attributes = array('src' => $imageurl . '?' . rand(1, 10000), 'alt' => s($badge->name), 'class' => 'activatebadge');
1100
1101     return html_writer::empty_tag('img', $attributes);
1102 }
1103
1104 /**
1105  * Bake issued badge.
1106  *
1107  * @param string $hash Unique hash of an issued badge.
1108  * @param int $badgeid ID of the original badge.
1109  * @param int $userid ID of badge recipient (optional).
1110  * @param boolean $pathhash Return file pathhash instead of image url (optional).
1111  * @return string|url Returns either new file path hash or new file URL
1112  */
1113 function badges_bake($hash, $badgeid, $userid = 0, $pathhash = false) {
1114     global $CFG, $USER;
1115     require_once(dirname(dirname(__FILE__)) . '/badges/lib/bakerlib.php');
1116
1117     $badge = new badge($badgeid);
1118     $badge_context = $badge->get_context();
1119     $userid = ($userid) ? $userid : $USER->id;
1120     $user_context = context_user::instance($userid);
1121
1122     $fs = get_file_storage();
1123     if (!$fs->file_exists($user_context->id, 'badges', 'userbadge', $badge->id, '/', $hash . '.png')) {
1124         if ($file = $fs->get_file($badge_context->id, 'badges', 'badgeimage', $badge->id, '/', 'f1.png')) {
1125             $contents = $file->get_content();
1126
1127             $filehandler = new PNG_MetaDataHandler($contents);
1128             $assertion = new moodle_url('/badges/assertion.php', array('b' => $hash));
1129             if ($filehandler->check_chunks("tEXt", "openbadges")) {
1130                 // Add assertion URL tExt chunk.
1131                 $newcontents = $filehandler->add_chunks("tEXt", "openbadges", $assertion->out(false));
1132                 $fileinfo = array(
1133                         'contextid' => $user_context->id,
1134                         'component' => 'badges',
1135                         'filearea' => 'userbadge',
1136                         'itemid' => $badge->id,
1137                         'filepath' => '/',
1138                         'filename' => $hash . '.png',
1139                 );
1140
1141                 // Create a file with added contents.
1142                 $newfile = $fs->create_file_from_string($fileinfo, $newcontents);
1143                 if ($pathhash) {
1144                     return $newfile->get_pathnamehash();
1145                 }
1146             }
1147         } else {
1148             debugging('Error baking badge image!');
1149         }
1150     }
1151
1152     $fileurl = moodle_url::make_pluginfile_url($user_context->id, 'badges', 'userbadge', $badge->id, '/', $hash, true);
1153     return $fileurl;
1154 }
1155
1156 /**
1157  * Returns external backpack settings and badges from this backpack.
1158  *
1159  * @param int $userid Backpack user ID.
1160  * @return null|object Returns null is there is no backpack or object with backpack settings.
1161  */
1162 function get_backpack_settings($userid) {
1163     global $DB;
1164     require_once(dirname(dirname(__FILE__)) . '/badges/lib/backpacklib.php');
1165
1166     $record = $DB->get_record('badge_backpack', array('userid' => $userid));
1167     if ($record) {
1168         $backpack = new OpenBadgesBackpackHandler($record);
1169         $out = new stdClass();
1170         $out->backpackurl = $backpack->get_url();
1171
1172         if ($collections = $DB->get_records('badge_external', array('backpackid' => $record->id))) {
1173             $out->totalcollections = count($collections);
1174             $out->totalbadges = 0;
1175             $out->badges = array();
1176             foreach ($collections as $collection) {
1177                 $badges = $backpack->get_badges($collection->collectionid);
1178                 if (isset($badges->badges)) {
1179                     $out->badges = array_merge($out->badges, $badges->badges);
1180                     $out->totalbadges += count($out->badges);
1181                 } else {
1182                     $out->badges = array_merge($out->badges, array());
1183                 }
1184             }
1185         } else {
1186             $out->totalbadges = 0;
1187             $out->totalcollections = 0;
1188         }
1189
1190         return $out;
1191     }
1192
1193     return null;
1194 }
1195
1196 /**
1197  * Download all user badges in zip archive.
1198  *
1199  * @param int $userid ID of badge owner.
1200  */
1201 function badges_download($userid) {
1202     global $CFG, $DB;
1203     $context = context_user::instance($userid);
1204     $records = $DB->get_records('badge_issued', array('userid' => $userid));
1205
1206     // Get list of files to download.
1207     $fs = get_file_storage();
1208     $filelist = array();
1209     foreach ($records as $issued) {
1210         $badge = new badge($issued->badgeid);
1211         // Need to make image name user-readable and unique using filename safe characters.
1212         $name =  $badge->name . ' ' . userdate($issued->dateissued, '%d %b %Y') . ' ' . hash('crc32', $badge->id);
1213         $name = str_replace(' ', '_', $name);
1214         if ($file = $fs->get_file($context->id, 'badges', 'userbadge', $issued->badgeid, '/', $issued->uniquehash . '.png')) {
1215             $filelist[$name . '.png'] = $file;
1216         }
1217     }
1218
1219     // Zip files and sent them to a user.
1220     $tempzip = tempnam($CFG->tempdir.'/', 'mybadges');
1221     $zipper = new zip_packer();
1222     if ($zipper->archive_to_pathname($filelist, $tempzip)) {
1223         send_temp_file($tempzip, 'badges.zip');
1224     } else {
1225         debugging("Problems with archiving the files.");
1226     }
1227 }
1228
1229 /**
1230  * Print badges on user profile page.
1231  *
1232  * @param int $userid User ID.
1233  * @param int $courseid Course if we need to filter badges (optional).
1234  */
1235 function profile_display_badges($userid, $courseid = 0) {
1236     global $CFG, $PAGE, $USER, $SITE;
1237     require_once($CFG->dirroot . '/badges/renderer.php');
1238
1239     if ($USER->id == $userid || has_capability('moodle/badges:viewotherbadges', context_user::instance($USER->id))) {
1240         $records = badges_get_user_badges($userid, $courseid, null, null, null, true);
1241         $renderer = new core_badges_renderer($PAGE, '');
1242
1243         // Print local badges.
1244         if ($records) {
1245             $left = get_string('localbadgesp', 'badges', $SITE->fullname);
1246             $right = $renderer->print_badges_list($records, $userid, true);
1247             echo html_writer::tag('dt', $left);
1248             echo html_writer::tag('dd', $right);
1249         }
1250
1251         // Print external badges.
1252         if ($courseid == 0 && !empty($CFG->badges_allowexternalbackpack)) {
1253             $backpack = get_backpack_settings($userid);
1254             if (isset($backpack->totalbadges) && $backpack->totalbadges !== 0) {
1255                 $left = get_string('externalbadgesp', 'badges');
1256                 $right = $renderer->print_badges_list($backpack->badges, $userid, true, true);
1257                 echo html_writer::tag('dt', $left);
1258                 echo html_writer::tag('dd', $right);
1259             }
1260         }
1261     }
1262 }
1263
1264 /**
1265  * Checks if badges can be pushed to external backpack.
1266  *
1267  * @return string Code of backpack accessibility status.
1268  */
1269 function badges_check_backpack_accessibility() {
1270     global $CFG;
1271     include_once $CFG->libdir . '/filelib.php';
1272
1273     // Using fake assertion url to check whether backpack can access the web site.
1274     $fakeassertion = new moodle_url('/badges/assertion.php', array('b' => 'abcd1234567890'));
1275
1276     // Curl request to http://backpack.openbadges.org/baker.
1277     $curl = new curl();
1278     $options = array(
1279         'FRESH_CONNECT' => true,
1280         'RETURNTRANSFER' => true,
1281         'HEADER' => 0,
1282         'CONNECTTIMEOUT' => 2,
1283     );
1284     $location = 'http://backpack.openbadges.org/baker';
1285     $out = $curl->get($location, array('assertion' => $fakeassertion->out(false)), $options);
1286
1287     $data = json_decode($out);
1288     if (!empty($curl->error)) {
1289         return 'curl-request-timeout';
1290     } else {
1291         if (isset($data->code) && $data->code == 'http-unreachable') {
1292             return 'http-unreachable';
1293         } else {
1294             return 'available';
1295         }
1296     }
1297
1298     return false;
1299 }
1300
1301 /**
1302  * Checks if user has external backpack connected.
1303  *
1304  * @param int $userid ID of a user.
1305  * @return bool True|False whether backpack connection exists.
1306  */
1307 function badges_user_has_backpack($userid) {
1308     global $DB;
1309     return $DB->record_exists('badge_backpack', array('userid' => $userid));
1310 }
1311
1312 /**
1313  * Handles what happens to the course badges when a course is deleted.
1314  *
1315  * @param int $courseid course ID.
1316  * @return void.
1317  */
1318 function badges_handle_course_deletion($courseid) {
1319     global $CFG, $DB;
1320     include_once $CFG->libdir . '/filelib.php';
1321
1322     $systemcontext = context_system::instance();
1323     $coursecontext = context_course::instance($courseid);
1324     $fs = get_file_storage();
1325
1326     // Move badges images to the system context.
1327     $fs->move_area_files_to_new_context($coursecontext->id, $systemcontext->id, 'badges', 'badgeimage');
1328
1329     // Get all course badges.
1330     $badges = $DB->get_records('badge', array('type' => BADGE_TYPE_COURSE, 'courseid' => $courseid));
1331     foreach ($badges as $badge) {
1332         // Archive badges in this course.
1333         $toupdate = new stdClass();
1334         $toupdate->id = $badge->id;
1335         $toupdate->type = BADGE_TYPE_SITE;
1336         $toupdate->courseid = null;
1337         $toupdate->status = BADGE_STATUS_ARCHIVED;
1338         $DB->update_record('badge', $toupdate);
1339     }
1340 }