From 3e567085a8f4dfaa1d14c351a06f2e9608bd7614 Mon Sep 17 00:00:00 2001
From: Sara Arjona <sara@moodle.com>
Date: Wed, 10 Jun 2020 12:23:26 +0200
Subject: [PATCH] MDL-69002 core_badges: add methods to support backpack
 validation

A more generic method has been added to the API to validate the
backpack connection (for now, there was only one method for
validating current backpack).
Besides, a renderer has been added to display this information
depending on the backpackid.
---
 badges/renderer.php | 31 +++++++++++++++++++++++++++++++
 lang/en/badges.php  |  3 +++
 lib/badgeslib.php   | 19 +++++++++++++++++--
 3 files changed, 51 insertions(+), 2 deletions(-)

diff --git a/badges/renderer.php b/badges/renderer.php
index 2f7bad8fadec4..f268bd7dafe26 100644
--- a/badges/renderer.php
+++ b/badges/renderer.php
@@ -1368,4 +1368,35 @@ public function render_external_backpacks_page(\core_badges\output\external_back
         $data = $page->export_for_template($this);
         return parent::render_from_template('core_badges/external_backpacks_page', $data);
     }
+
+    /**
+     * Get the result of a backpack validation with its settings. It returns:
+     * - A informative message if the backpack version is different from OBv2.
+     * - A warning with the error if it's not possible to connect to this backpack.
+     * - A successful message if the connection has worked.
+     *
+     * @param  int    $backpackid The backpack identifier.
+     * @return string A message with the validation result.
+     */
+    public function render_test_backpack_result(int $backpackid): string {
+        // Get the backpack.
+        $backpack = badges_get_site_backpack($backpackid);
+
+        // Add the header to the result.
+        $result = $this->heading(get_string('testbackpack', 'badges', $backpack->backpackweburl));
+
+        if ($backpack->apiversion != OPEN_BADGES_V2) {
+            // Only OBv2 supports this validation.
+            $result .= get_string('backpackconnectionnottested', 'badges');
+        } else {
+            $message = badges_verify_backpack($backpackid);
+            if (empty($message)) {
+                $result .= get_string('backpackconnectionok', 'badges');
+            } else {
+                $result .= $message;
+            }
+        }
+
+        return $result;
+    }
 }
diff --git a/lang/en/badges.php b/lang/en/badges.php
index 7373858e79837..14f709f895225 100644
--- a/lang/en/badges.php
+++ b/lang/en/badges.php
@@ -81,6 +81,8 @@
 $string['awardoncron'] = 'Access to the badges was successfully enabled. Too many users can instantly earn this badge. To ensure site performance, this action will take some time to process.';
 $string['awards'] = 'Recipients';
 $string['backpackavailability'] = 'External badge verification';
+$string['backpackconnectionok'] = 'Backpack connection successfully established';
+$string['backpackconnectionnottested'] = 'Connection can not be tested for this backpack because only OBv2.0 backpacks support it.';
 $string['backpackneedsupdate'] = 'The backpack connected to this profile does not match the backpack for the site. You need to disconnect and reconnect the backpack.';
 $string['backpackavailability_help'] = 'For badge recipients to be able to prove they earned their badges from you, an external backpack service should be able to access your site and verify badges issued from it. Your site does not currently appear to be accessible, which means that badges you have already issued or will issue in the future cannot be verified.
 
@@ -549,6 +551,7 @@
 $string['targetframework_help'] = 'The name of the external skill or standard framework.';
 $string['targetcode'] = 'Code';
 $string['targetcode_help'] = 'A unique string identifier for referencing the external skill or standard within its framework.';
+$string['testbackpack'] = 'Test backpack \'{$a}\'';
 $string['type'] = 'Type';
 $string['variablesubstitution'] = 'Variable substitution in messages.';
 $string['variablesubstitution_help'] = 'In a badge message, certain variables can be inserted into the subject and/or body of a message so that they will be replaced with real values when the message is sent. The variables should be inserted into the text exactly as they are shown below. The following variables can be used:
diff --git a/lib/badgeslib.php b/lib/badgeslib.php
index c1d2d0f1d25cf..352a086f0c5a0 100644
--- a/lib/badgeslib.php
+++ b/lib/badgeslib.php
@@ -1194,14 +1194,28 @@ function badge_assemble_notification(stdClass $badge) {
  * @return string
  */
 function badges_verify_site_backpack() {
+    global $CFG;
+
+    return badges_verify_backpack($CFG->badges_site_backpack);
+}
+
+/**
+ * Attempt to authenticate with a backpack credentials and return an error
+ * if the authentication fails.
+ * If external backpacks are not enabled or the backpack version is different
+ * from OBv2, this will not perform any test.
+ *
+ * @param int $backpackid Backpack identifier to verify.
+ * @return string The result of the verification process.
+ */
+function badges_verify_backpack(int $backpackid) {
     global $OUTPUT, $CFG;
 
     if (empty($CFG->badges_allowexternalbackpack)) {
         return '';
     }
 
-    $backpack = badges_get_site_backpack($CFG->badges_site_backpack);
-
+    $backpack = badges_get_site_backpack($backpackid);
     if (empty($backpack->apiversion) || ($backpack->apiversion == OPEN_BADGES_V2)) {
         $backpackapi = new \core_badges\backpack_api($backpack);
 
@@ -1221,6 +1235,7 @@ function badges_verify_site_backpack() {
             return $OUTPUT->container($icon . $message, 'text-error');
         }
     }
+
     return '';
 }