Skip to content

Commit

Permalink
Merge backpack-add and backpack-export
Browse files Browse the repository at this point in the history
  • Loading branch information
@sarjona
sarjona committed Jan 10, 2025
1 parent 016613a commit 8211535
Show file tree
Hide file tree
Showing 6 changed files with 223 additions and 118 deletions.
142 changes: 25 additions & 117 deletions badges/backpack-add.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,130 +29,38 @@

require_login();

$userbackpack = badges_get_user_backpack();
if (badges_open_badges_backpack_api($userbackpack->id) != OPEN_BADGES_V2) {
throw new coding_exception('No backpacks support Open Badges V2.');
// Check if badges and the external backpack are enabled.
if (empty($CFG->badges_allowexternalbackpack) || empty($CFG->enablebadges)) {
redirect($CFG->wwwroot);
}

$id = required_param('hash', PARAM_ALPHANUM);

$PAGE->set_url('/badges/backpack-add.php', array('hash' => $id));
$PAGE->set_context(context_system::instance());
$output = $PAGE->get_renderer('core', 'badges');

$issuedbadge = new \core_badges\output\issued_badge($id);
if (!empty($issuedbadge->recipient->id)) {
// The flow for issuing a badge is:
// * Create issuer
// * Create badge
// * Create assertion (Award the badge!)

// With the introduction OBv2.1 and MDL-65959 to allow cross region Badgr imports the above (old) procedure will
// only be completely performed if both the site and user backpacks conform to the same apiversion.
// Else we will attempt at pushing the assertion to the user's backpack. In this case, the id set against the assertion
// has to be a publicly accessible resource.
// Check the user has a backpack.
$backpack = \core_badges\backpack::get_user_backpack();
if (empty($backpack)) {
throw new coding_exception('This user has no backpack associated with their account.');
}

// Get the backpack.
$badgeid = $issuedbadge->badgeid;
$badge = new badge($badgeid);
$backpack = $DB->get_record('badge_backpack', array('userid' => $USER->id));
$userbackpack = badges_get_site_backpack($backpack->externalbackpackid, $USER->id);
$assertion = new core_badges_assertion($id, OPEN_BADGES_V2);
$assertiondata = $assertion->get_badge_assertion(false, false);
$assertionid = $assertion->get_assertion_hash();
$assertionentityid = $assertiondata['id'];
$badgeadded = false;
if (badges_open_badges_backpack_api() == OPEN_BADGES_V2) {
$sitebackpack = badges_get_site_primary_backpack();
$api = backpackapi_base::create_from_externalbackpack($userbackpack);
$response = $api->authenticate();
$hash = required_param('hash', PARAM_ALPHANUM);

// A numeric response indicates a valid successful authentication. Else an error object will be returned.
if (is_numeric($response)) {
// Create issuer.
$issuer = $assertion->get_issuer();
if (!($issuerentityid = badges_external_get_mapping($sitebackpack->id, OPEN_BADGES_V2_TYPE_ISSUER, $issuer['email']))) {
$response = $api->put_issuer($issuer);
if (!$response) {
throw new moodle_exception('invalidrequest', 'error');
}
$issuerentityid = $response->id;
badges_external_create_mapping($sitebackpack->id, OPEN_BADGES_V2_TYPE_ISSUER, $issuer['email'],
$issuerentityid);
}
// Create badge.
$badge = $assertion->get_badge_class(false);
$badgeid = $assertion->get_badge_id();
if (!($badgeentityid = badges_external_get_mapping($sitebackpack->id, OPEN_BADGES_V2_TYPE_BADGE, $badgeid))) {
$response = $api->put_badgeclass($issuerentityid, $badge);
if (!$response) {
throw new moodle_exception('invalidrequest', 'error');
}
$badgeentityid = $response->id;
badges_external_create_mapping($sitebackpack->id, OPEN_BADGES_V2_TYPE_BADGE, $badgeid,
$badgeentityid);
}
$PAGE->set_url('/badges/backpack-add.php', ['hash' => $hash]);
$PAGE->set_context(context_system::instance()); // TODO: System or user context?
$output = $PAGE->get_renderer('core', 'badges');

// Create assertion (Award the badge!).
$assertionentityid = badges_external_get_mapping(
$sitebackpack->id,
OPEN_BADGES_V2_TYPE_ASSERTION,
$assertionid
);
// Check the assertion belongs to the current user.
$assertion = new core_badges_assertion($hash, $backpack->apiversion);
if ($assertion->get_userid() != $USER->id) {
throw new coding_exception('This assertion does not belong to the current user.');
}

if ($assertionentityid && strpos($sitebackpack->backpackapiurl, 'badgr')) {
$assertionentityid = badges_generate_badgr_open_url(
$sitebackpack,
OPEN_BADGES_V2_TYPE_ASSERTION,
$assertionentityid
);
}

// Create an assertion for the recipient in the issuer's account.
if (!$assertionentityid) {
$response = $api->put_badgeclass_assertion($badgeentityid, $assertiondata);
if (!$response) {
throw new moodle_exception('invalidrequest', 'error');
}
$assertionentityid = badges_generate_badgr_open_url($sitebackpack, OPEN_BADGES_V2_TYPE_ASSERTION, $response->id);
$badgeadded = true;
badges_external_create_mapping($sitebackpack->id, OPEN_BADGES_V2_TYPE_ASSERTION, $assertionid,
$response->id);
} else {
// An assertion already exists. Make sure it's up to date.
$internalid = badges_external_get_mapping(
$sitebackpack->id,
OPEN_BADGES_V2_TYPE_ASSERTION,
$assertionid,
'externalid'
);
$response = $api->update_assertion($internalid, $assertiondata);
if (!$response) {
throw new moodle_exception('invalidrequest', 'error');
}
}
}
}
// TODO: Improve code for OBv2.0. It's not working (or maybe it is but needs to be tested with ngrok) because I copied the code from the old version. OBv2.1 is working.

// Now award/upload the badge to the user's account.
// - If a user and site backpack have the same provider we can skip this as Badgr automatically maps recipients
// based on email address.
// - This is only needed when the backpacks are from different regions.
if ($assertionentityid && !badges_external_get_mapping($userbackpack->id, OPEN_BADGES_V2_TYPE_ASSERTION, $assertionid)) {
$userapi = backpackapi_base::create_from_externalbackpack($userbackpack);
$userapi->authenticate();
$response = $userapi->import_badge_assertion($assertionentityid);
if (!$response) {
throw new moodle_exception('invalidrequest', 'error');
}
$assertionentityid = $response->id;
$badgeadded = true;
badges_external_create_mapping($userbackpack->id, OPEN_BADGES_V2_TYPE_ASSERTION, $assertionid,
$assertionentityid);
}
// Send the assertion to the backpack.
$api = backpackapi_base::create_from_externalbackpack($backpack);
$notify = $api->put_assertions($hash);

$response = $badgeadded ? ['success' => 'addedtobackpack'] : ['warning' => 'existsinbackpack'];
redirect(new moodle_url('/badges/mybadges.php', $response));
} else {
redirect(new moodle_url('/badges/mybadges.php'));
$redirecturl = new moodle_url('/badges/mybadges.php');
if (!empty($notify['status'])) {
redirect($redirecturl, $notify['message'], null, $notify['status']);
}
redirect($redirecturl);
5 changes: 5 additions & 0 deletions badges/classes/assertion.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ public function __construct($hash, $obversion = OPEN_BADGES_V2) {
bi.dateexpire,
bi.uniquehash,
u.email,
u.id as userid,
b.*,
bb.email as backpackemail
FROM
Expand Down Expand Up @@ -401,4 +402,8 @@ protected function embed_data_badge_version2(&$json, $type = OPEN_BADGES_V2_TYPE
public function get_tags(): array {
return array_values(\core_tag_tag::get_item_tags_array('core_badges', 'badge', $this->get_badge_id()));
}

public function get_userid(): int {
return $this->_data->userid;
}
}
58 changes: 58 additions & 0 deletions badges/classes/backpack.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.

namespace core_badges;

/**
* Class that represents a backpack.
*
* @package core_badges
* @copyright 2024 Sara Arjona <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class backpack {

/**
* Constructs with badge details.
*
* @param int $badgeid badge ID.
*/
public function __construct(string $hash) {
}


/**
* Get the user backpack for the currently logged in user OR the provided user
*
* @param int|null $userid The user whose backpack you're requesting for. If null, get the logged in user's backpack
* @return mixed The user's backpack or none.
*/
public static function get_user_backpack(?int $userid = 0) {
global $DB;

if (!$userid) {
global $USER;
$userid = $USER->id;
}

$sql = "SELECT beb.*, bb.id AS badgebackpack, bb.password, bb.email AS backpackemail
FROM {badge_external_backpack} beb
JOIN {badge_backpack} bb ON bb.externalbackpackid = beb.id AND bb.userid=:userid";

return $DB->get_record_sql($sql, ['userid' => $userid]);
}

}
126 changes: 126 additions & 0 deletions badges/classes/backpackapi_2p0.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -510,4 +510,130 @@ public function get_badges($collection, $expanded = false) {

return [];
}

/**
* Send an assertion to the backpack.
*
* @param string $hash The assertion hash
* @return array
*/
public function put_assertions(string $hash): array {
global $USER, $DB;

$issuedbadge = new \core_badges\output\issued_badge($hash);
if (!empty($issuedbadge->recipient->id)) {
// The flow for issuing a badge is:
// * Create issuer
// * Create badge
// * Create assertion (Award the badge!)

// With the introduction OBv2.1 and MDL-65959 to allow cross region Badgr imports the above (old) procedure will
// only be completely performed if both the site and user backpacks conform to the same apiversion.
// Else we will attempt at pushing the assertion to the user's backpack. In this case, the id set against the assertion
// has to be a publicly accessible resource.

// Get the backpack.
$badgeid = $issuedbadge->badgeid;
$badge = new badge($badgeid);
$backpack = $DB->get_record('badge_backpack', array('userid' => $USER->id));
$userbackpack = badges_get_site_backpack($backpack->externalbackpackid, $USER->id);
$assertion = new \core_badges_assertion($hash, OPEN_BADGES_V2);
$assertiondata = $assertion->get_badge_assertion(false, false);
$assertionid = $assertion->get_assertion_hash();
$assertionentityid = $assertiondata['id'];
$badgeadded = false;
if (badges_open_badges_backpack_api() == OPEN_BADGES_V2) {
$sitebackpack = badges_get_site_primary_backpack();
$api = backpackapi_base::create_from_externalbackpack($userbackpack);
$response = $api->authenticate();

// A numeric response indicates a valid successful authentication. Else an error object will be returned.
if (is_numeric($response)) {
// Create issuer.
$issuer = $assertion->get_issuer();
if (!($issuerentityid = badges_external_get_mapping($sitebackpack->id, OPEN_BADGES_V2_TYPE_ISSUER, $issuer['email']))) {
$response = $api->put_issuer($issuer);
if (!$response) {
throw new \moodle_exception('invalidrequest', 'error');
}
$issuerentityid = $response->id;
badges_external_create_mapping($sitebackpack->id, OPEN_BADGES_V2_TYPE_ISSUER, $issuer['email'],
$issuerentityid);
}
// Create badge.
$badge = $assertion->get_badge_class(false);
$badgeid = $assertion->get_badge_id();
if (!($badgeentityid = badges_external_get_mapping($sitebackpack->id, OPEN_BADGES_V2_TYPE_BADGE, $badgeid))) {
$response = $api->put_badgeclass($issuerentityid, $badge);
if (!$response) {
throw new \moodle_exception('invalidrequest', 'error');
}
$badgeentityid = $response->id;
badges_external_create_mapping($sitebackpack->id, OPEN_BADGES_V2_TYPE_BADGE, $badgeid,
$badgeentityid);
}

// Create assertion (Award the badge!).
$assertionentityid = badges_external_get_mapping(
$sitebackpack->id,
OPEN_BADGES_V2_TYPE_ASSERTION,
$assertionid
);

if ($assertionentityid && strpos($sitebackpack->backpackapiurl, 'badgr')) {
$assertionentityid = badges_generate_badgr_open_url(
$sitebackpack,
OPEN_BADGES_V2_TYPE_ASSERTION,
$assertionentityid
);
}

// Create an assertion for the recipient in the issuer's account.
if (!$assertionentityid) {
$response = $api->put_badgeclass_assertion($badgeentityid, $assertiondata);
if (!$response) {
throw new \moodle_exception('invalidrequest', 'error');
}
$assertionentityid = badges_generate_badgr_open_url($sitebackpack, OPEN_BADGES_V2_TYPE_ASSERTION, $response->id);
$badgeadded = true;
badges_external_create_mapping($sitebackpack->id, OPEN_BADGES_V2_TYPE_ASSERTION, $assertionid,
$response->id);
} else {
// An assertion already exists. Make sure it's up to date.
$internalid = badges_external_get_mapping(
$sitebackpack->id,
OPEN_BADGES_V2_TYPE_ASSERTION,
$assertionid,
'externalid'
);
$response = $api->update_assertion($internalid, $assertiondata);
if (!$response) {
throw new \moodle_exception('invalidrequest', 'error');
}
}
}
}

// Now award/upload the badge to the user's account.
// - If a user and site backpack have the same provider we can skip this as Badgr automatically maps recipients
// based on email address.
// - This is only needed when the backpacks are from different regions.
if ($assertionentityid && !badges_external_get_mapping($userbackpack->id, OPEN_BADGES_V2_TYPE_ASSERTION, $assertionid)) {
$userapi = backpackapi_base::create_from_externalbackpack($userbackpack);
$userapi->authenticate();
$response = $userapi->import_badge_assertion($assertionentityid);
if (!$response) {
throw new \moodle_exception('invalidrequest', 'error');
}
$assertionentityid = $response->id;
$badgeadded = true;
badges_external_create_mapping($userbackpack->id, OPEN_BADGES_V2_TYPE_ASSERTION, $assertionid,
$assertionentityid);
}

$response = $badgeadded ? ['success' => 'addedtobackpack'] : ['warning' => 'existsinbackpack'];
}

return $response;
}
}
2 changes: 1 addition & 1 deletion badges/classes/backpackapi_2p1.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ private function get_clientid($issuerid) {
* @throws \moodle_exception
* @throws coding_exception
*/
public function put_assertions($hash) {
public function put_assertions(string $hash): array {
$data = [];
if (!$hash) {
return false;
Expand Down
8 changes: 8 additions & 0 deletions badges/classes/backpackapi_base.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,14 @@ abstract protected function get_mappings(): array;
*/
abstract public function disconnect_backpack(): bool;

/**
* Send an assertion to the backpack.
*
* @param string $hash The assertion hash
* @return array
*/
abstract public function put_assertions(string $hash): array;

/**
* Create a new backpackapi instance from an external backpack record.
*
Expand Down

0 comments on commit 8211535

Please sign in to comment.