All hardcoded text replaced in cmi5connector

Author: MeganBohland

classes/local/cmi5_connectors.php

@@ -29,6 +29,12 @@
 require_once ($CFG->dirroot . '/mod/cmi5launch/classes/local/errorover.php');
 class cmi5_connectors {
 
+    const CMI5LAUNCH_PLAYER_TENANT_URL = "/api/v1/tenant";
+    const CMI5LAUNCH_PLAYER_COURSE_URL = "/api/v1/course";
+    const CMI5LAUNCH_PLAYER_REGISTRATION_URL = "/api/v1/registration";
+    const CMI5LAUNCH_PLAYER_AUTH_URL = "/api/v1/auth";
+    const CMI5LAUNCH_LAUNCH_URL = "/launch-url/";
+    const CMI5LAUNCH_PLAYER_SESSION_URL = "/api/v1/session/";
     public function cmi5launch_get_create_tenant() {
         return [$this, 'cmi5launch_create_tenant'];
     }
@@ -79,7 +85,7 @@ public function cmi5launch_create_course($id, $tenanttoken, $filename) {
         $settings = cmi5launch_settings($id);
 
         // Build URL to import course to.
-        $url = $settings['cmi5launchplayerurl'] . "/api/v1/course";
+        $url = $settings['cmi5launchplayerurl'] . self::CMI5LAUNCH_PLAYER_COURSE_URL;
 
         // To determine the headers.
         $filetype = "zip";
@@ -94,24 +100,20 @@ public function cmi5launch_create_course($id, $tenanttoken, $filename) {
         // Now this will never return false, it will throw an exception if it fails, so we can just return the result
         try {
             // Check result and display message if not 200.
-            $resulttest = $this->cmi5launch_connectors_error_message($result, "creating the course");
+            $resulttest = $this->cmi5launch_connectors_error_message($result, get_string('cmi5launchcourseerror', 'cmi5launch'));
 
-        //    echo "Is it resulting?";
             if ($resulttest == true) {
                 // Return an array with course info.
                 return $result;
-                // I think this is the problem, it is coming back and throwing another error! I thought it would stop... do I need a kill in the error message hander?
-                // Its throwing BOB??? The third path is executing, THATS the problem!
-                // either way though, shouldn't the error funtion have ITS own test? like,
-                //  what we need to test here is is resulttrue is true or not
+                
             } else {
                 // This should never be false, it should throw an exception if it is, so we can just return the result
                 // But catch all else that miht go wrong
-                throw new playerException("creating the course.");
+                throw new playerException(get_string('cmi5launchcourseerror', 'cmi5launch'));
             }
         }// catch all else that might go wrong
         catch (\Throwable $e){
-            throw new playerException("creating the course" . $e);
+            throw new playerException(get_string('cmi5launchcourseerror', 'cmi5launch'). $e);
         }
 
     }
@@ -135,7 +137,7 @@ public function cmi5launch_create_tenant($newtenantname) {
         $password = $settings['cmi5launchbasepass'];
 
         // Build URL for launch URL request.
-        $url = $playerurl . "/api/v1/tenant";
+        $url = $playerurl . self::CMI5LAUNCH_PLAYER_TENANT_URL;
 
         // The body of the request must be made as array first.
         $data = array(
@@ -162,12 +164,12 @@ public function cmi5launch_create_tenant($newtenantname) {
                 return $result;
             } else {
 
-                throw new playerException("creating the tenant.");
+                throw new playerException(get_string('cmi5launchtenanterror', 'cmi5launch'));
             }
         }// catch all else that might go wrong
         catch (\Throwable $e){
 
-            throw new playerException("Uncaught error creating the tenant" . $e);
+            throw new playerException(get_string('cmi5launchtenantuncaughterror', 'cmi5launch') . $e);
         }
 
     }
@@ -195,20 +197,20 @@ public function cmi5launch_retrieve_registration_with_get($registration, $id) {
         $result = $this->cmi5launch_send_request_to_cmi5_player_get('cmi5launch_stream_and_send', $token, $url);
 
         // Check result and display message if not 200.
-        $resulttest = $this->cmi5launch_connectors_error_message($result, "retrieving the registration");
+        $resulttest = $this->cmi5launch_connectors_error_message($result, get_string('cmi5launchregistrationerror', 'cmi5launch'));
 
         // Now this will never return false, it will throw an exception if it fails, so we can just return the result
         try {
             if ($resulttest == true) {
                 return $result;
             } else {
 
-                throw new playerException("retrieving the registration information.");
+                throw new playerException(get_string('cmi5launchregistrationinfoerror', 'cmi5launch'));
             }
         }// catch all else that might go wrong
         catch (\Throwable $e){
 
-            throw new playerException("Uncaught error retrieving the registration information." . $e);
+            throw new playerException( get_string('cmi5launchregistrationuncaughterror', 'cmi5launch'). $e);
         }
 
     }
@@ -234,7 +236,7 @@ public function cmi5launch_retrieve_registration_with_post($courseid, $id) {
         global $CFG;
 
         // Build URL for launch URL request.
-        $url = $playerurl . "/api/v1/registration";
+        $url = $playerurl . self::CMI5LAUNCH_PLAYER_REGISTRATION_URL;
 
         // The body of the request must be made as array first.
         $data = array(
@@ -256,7 +258,7 @@ public function cmi5launch_retrieve_registration_with_post($courseid, $id) {
         $result = $this->cmi5launch_send_request_to_cmi5_player_post('cmi5launch_stream_and_send', $data, $url, $filetype, $token);
 
         // Check result and display message if not 200.
-        $resulttest = $this->cmi5launch_connectors_error_message($result, "retrieving the registration");
+        $resulttest = $this->cmi5launch_connectors_error_message($result, get_string('cmi5launchregistrationerror', 'cmi5launch'));
 
         // Now this will never return false, it will throw an exception if it fails, so we can just return the result
         try {
@@ -270,12 +272,12 @@ public function cmi5launch_retrieve_registration_with_post($courseid, $id) {
 
                 return $registration;
             } else {
-                throw new playerException("retrieving the registration information.");
+                throw new playerException(get_string('cmi5launchregistrationinfoerror', 'cmi5launch'));
             }
         }// catch all else that might go wrong
         catch (\Throwable $e){
 
-            throw new playerException("Uncaught error retrieving the registration information." . $e);
+            throw new playerException(get_string('cmi5launchregistrationuncaughterror', 'cmi5launch'). $e);
         }
 
     }
@@ -290,10 +292,6 @@ public function cmi5launch_retrieve_registration_with_post($courseid, $id) {
      */
     public function cmi5launch_retrieve_token($audience, $tenantid) {
 
-        // Honestly the params can be rabbbed through settings right? So I thinks we can change this whole func.
-        // but if it is called, will it need to go tooo secret back page? 
-        // and can we make it same page, like if pthere is no prompt? which is fdiff then null right? Or maybe another page just to be certain.
-        
         global $CFG, $cmi5launchid;
 
         $settings = cmi5launch_settings($cmi5launchid);
@@ -304,7 +302,7 @@ public function cmi5launch_retrieve_token($audience, $tenantid) {
         $password = $settings['cmi5launchbasepass'];
 
         // Build URL for launch URL request.
-        $url = $playerurl . "/api/v1/auth";
+        $url = $playerurl . self::CMI5LAUNCH_PLAYER_AUTH_URL;
 
         // The body of the request must be made as array first.
         $data = array(
@@ -320,7 +318,7 @@ public function cmi5launch_retrieve_token($audience, $tenantid) {
         $result = $this->cmi5launch_send_request_to_cmi5_player_post('cmi5launch_stream_and_send', $data, $url, $filetype, $username, $password);
 
         // Check result and display message if not 200.
-        $resulttest = $this->cmi5launch_connectors_error_message($result, 'retrieving the tenant token.');
+        $resulttest = $this->cmi5launch_connectors_error_message($result, get_string('cmi5launchtokenerror', 'cmi5launch'));
 
         // Now this will never return false, it will throw an exception if it fails, so we can just return the result
         try {
@@ -332,11 +330,11 @@ public function cmi5launch_retrieve_token($audience, $tenantid) {
                 return $token;
 
             } else {
-                throw new playerException("retrieving the tenant token.");
+                throw new playerException(get_string('cmi5launchtokenerror', 'cmi5launch'));
             }
         }// catch all else that might go wrong
         catch (\Throwable $e){
-            throw new playerException("Uncaught error retrieving the tenant token." . $e);
+            throw new playerException(get_string('cmi5launchtokenuncaughtterror', 'cmi5launch'). $e);
         }
     }
 
@@ -367,7 +365,7 @@ public function cmi5launch_retrieve_url($id, $auindex) {
 
 
         // Build URL for launch URL request.
-        $url = $playerurl . "/api/v1/course/" . $courseid  ."/launch-url/" . $auindex;
+        $url = $playerurl . self::CMI5LAUNCH_PLAYER_COURSE_URL . "/" . $courseid  . self::CMI5LAUNCH_LAUNCH_URL . $auindex;
 
         $data = array(
             'actor' => array(
@@ -389,7 +387,7 @@ public function cmi5launch_retrieve_url($id, $auindex) {
         $result = $this->cmi5launch_send_request_to_cmi5_player_post('cmi5launch_stream_and_send', $data, $url, $filetype, $token);
 
         // Check result and display message if not 200.
-        $resulttest = $this->cmi5launch_connectors_error_message($result, "retrieving the launch url from player.");
+        $resulttest = $this->cmi5launch_connectors_error_message($result, get_string('cmi5launchurlerror', 'cmi5launch'));
 
         // Now this will never return false, it will throw an exception if it fails, so we can just return the result
         try {
@@ -399,11 +397,11 @@ public function cmi5launch_retrieve_url($id, $auindex) {
 
             return $urldecoded;
         } else {
-            throw new playerException("retrieving the launch url from player.");
+            throw new playerException(get_string('cmi5launchurlerror', 'cmi5launch'));
         }
     }// catch all else that might go wrong
     catch (\Throwable $e){
-        throw new playerException("Uncaught error retrieving the launch url from player." . $e);
+        throw new playerException(get_string('cmi5launchurluncaughterror', 'cmi5launch') . $e);
     }
 
 
@@ -509,7 +507,7 @@ public function cmi5launch_send_request_to_cmi5_player_post($cmi5launch_stream_a
             restore_exception_handler();
             restore_error_handler();
             //
-            throw new playerException("communicating with player, sending or crafting a POST request: " . $e);
+            throw new playerException( get_string('cmi5launchposterror', 'cmi5launch') .   $e);
         }
 
     }
@@ -547,7 +545,7 @@ public function cmi5launch_send_request_to_cmi5_player_get($cmi5launch_stream_an
 
         } catch (\Throwable $e) {
           //  echo" are we here?";
-            throw new playerException("communicating with player, sending or crafting a GET request: " . $e);
+            throw new playerException(get_string('cmi5launchgeterror', 'cmi5launch'). $e);
         }
     }
 
@@ -567,13 +565,13 @@ public function cmi5launch_retrieve_session_info_from_player($sessionid, $id) {
         $playerurl = $settings['cmi5launchplayerurl'];
 
         // Build URL for launch URL request.
-        $url = $playerurl . "/api/v1/session/" . $sessionid;
+        $url = $playerurl . self::CMI5LAUNCH_PLAYER_SESSION_URL . $sessionid;
 
         // Sends the stream to the specified URL.
         $result = $this->cmi5launch_send_request_to_cmi5_player_get('cmi5launch_stream_and_send', $token, $url);
 
         // Check result and display message if not 200.
-        $resulttest = $this->cmi5launch_connectors_error_message($result, "retrieving the session information.");
+        $resulttest = $this->cmi5launch_connectors_error_message($result, get_string('cmi5launchsessioninfoerror', 'cmi5launch') );
 
            // Now this will never return false, it will throw an exception if it fails, so we can just return the result
            try {
@@ -582,12 +580,12 @@ public function cmi5launch_retrieve_session_info_from_player($sessionid, $id) {
                 return $result;
 
             } else {
-                throw new playerException("retrieving the session information.");
+                throw new playerException(get_string('cmi5launchsessioninfoerror', 'cmi5launch'));
             }
         }// catch all else that might go wrong
         catch (\Throwable $e){
 
-            throw new playerException("Uncaught error retrieving the session information." . $e);
+            throw new playerException( get_string("cmi5launchsessioninfouncaughterror", 'cmi5launch') . $e);
         }
     }
 
@@ -616,14 +614,14 @@ public  function cmi5launch_connectors_error_message($resulttotest, $type) {
         if ($resulttest === false ){
 
 
-            $errormessage =  $type . " CMI5 Player is not communicating. Is it running?";
+            $errormessage =  $type . get_string('cmi5launchcommerror', 'cmi5launch');
 
             throw new playerException($errormessage);
         }
         else if( array_key_exists("statusCode", $resulttest) && $resulttest["statusCode"] != 200) {
 
 
-            $errormessage = $type . " CMI5 Player returned " . $resulttest["statusCode"] . " error. With message '" 
+            $errormessage = $type . get_string('cmi5launchreturned', 'cmi5launch'). $resulttest["statusCode"] . get_string('cmi5launchwith', 'cmi5launch') . " '" 
             . $resulttest["message"] . "'." ;
 
          //   echo"whatt is error messae before throwing::: " . $errormessage;

cmi5PHP/tests/cmi5_connectorsTest.php

@@ -163,7 +163,7 @@ public function get_content() {
         };
         $test = false;
              // Expected exceptions
-             $exceptionmessage = "Player communication error. Something went wrong creating the course CMI5 Player returned 404 error. With message 'testmessage'." ;
+             $exceptionmessage = "Player communication error. Something went wrong creating the course. CMI5 Player returned 404 error. With message 'testmessage'." ;
 
         // Mock a cmi5 connector object but only stub ONE method, as we want to test the other methods.
         // Create a mock of the send_request class as we don't actually want
@@ -235,7 +235,7 @@ public function get_content() {
             // The string just needs to be returned as is. We do expect create_tenant to only call this once.
         $csc->expects($this->once())
         ->method('cmi5launch_connectors_error_message')
-         ->with($errormessage, 'creating the course') // for tomorrow, is thi failing because with only evaluates strings? Like do we need to string the array out> 
+         ->with($errormessage, 'creating the course.') // for tomorrow, is thi failing because with only evaluates strings? Like do we need to string the array out> 
         // IRL it returns something that needs to be json decoded, so lets pass somethin that is encoded>
         ->willReturn(false);
 
@@ -485,7 +485,7 @@ public function testcmi5launch_retrieve_registration_with_get_fail()
             ->willReturn($errormessage);
 
         // Expected exceptions
-        $exceptionmessage = "Player communication error. Something went wrong retrieving the registration CMI5 Player returned 404 error. With message 'testmessage'." ;
+        $exceptionmessage = "Player communication error. Something went wrong retrieving the registration. CMI5 Player returned 404 error. With message 'testmessage'." ;
 
         // Expected exceptions and messages
         $this->expectExceptionMessage($exceptionmessage);
@@ -533,7 +533,7 @@ public function testcmi5launch_retrieve_registration_with_get_fail_2()
 
         $mockedclass->expects($this->once())
         ->method('cmi5launch_connectors_error_message')
-        ->with($errormessage, "retrieving the registration")
+        ->with($errormessage, "retrieving the registration.")
         ->willReturn(false);
 
         // Expected exceptions
@@ -649,7 +649,7 @@ public function testcmi5launch_retrieve_registration_with_post_fail_2()
 
         $mockedclass->expects($this->once())
         ->method('cmi5launch_connectors_error_message')
-        ->with($errormessage, "retrieving the registration")
+        ->with($errormessage, "retrieving the registration.")
         ->willReturn(false);
 
    // Expected exceptions
@@ -705,7 +705,7 @@ public function testcmi5launch_retrieve_registration_with_post_fail()
             ->willReturn($errormessage);
 
    // Expected exceptions
-     $exceptionmessage = "Player communication error. Something went wrong retrieving the registration CMI5 Player returned 404 error. With message 'testmessage'" ;
+     $exceptionmessage = "Player communication error. Something went wrong retrieving the registration. CMI5 Player returned 404 error. With message 'testmessage'" ;
 
      // Expected exceptions and messages
      $this->expectExceptionMessage($exceptionmessage);

lang/en/cmi5launch.php

@@ -132,10 +132,47 @@
       ";
 
 // Info for settings warnings.
-$string['cmi5launchtenantname_warning'] = '<b>Tenant name is ';
-$string['cmi5launchtenantid_warning'] = '. Tenant ID is ';
+$string['cmi5launchtenantnameis'] = '<b>Tenant name is ';
+$string['cmi5launchtenantidis'] = '. Tenant ID is ';
 $string['cmi5launchtenant_warning'] = "</b><div><br> The tenant name and ID have been set. They cannot be changed without causing problems with existing cmi5 launch link activities. To change, plugin must be uninstalled and reinstalled.</div> <div><br></div>";
 
+// Token generation button.
+$string['cmi5launchlinktotoken'] = "</br>
+        <p id=name >
+            <div class='input-group rounded'>
+              <button class='btn btn-secondary' type='reset' name='tokenbutton' onclick='totokenpage()'>
+                <span class='button-label'>Generate new bearer token</span>
+                </button>
+            </div>
+        </p>
+          ";
+
+// Lines for error messages.
+
+
+
+
+// cmi5_connectors
+$string['cmi5launchcommerror'] = " CMI5 Player is not communicating. Is it running?";
+$string['cmi5launchreturned'] = " CMI5 Player returned ";
+$string['cmi5launchwith'] = " error. With message";
+
+$string['cmi5launchcourseerror'] = "creating the course.";
+$string['cmi5launchtenanterror'] = "creating the tenant.";
+$string['cmi5launchtenantuncaughterror'] = "creating the tenant.";
+$string['cmi5launchregistrationerror'] = "retrieving the registration.";
+$string['cmi5launchregistrationinfoerror'] = "retrieving the registration information.";
+$string['cmi5launchregistrationuncaughterror'] = "Uncaught error retrieving the registration information.";
+$string['cmi5launchtokenerror'] = "retrieving the tenant token.";
+$string['cmi5launchtokenuncaughterror'] = "Uncaught error retrieving the tenant token.";
+$string['cmi5launchurlerror'] = "retrieving the launch url from player.";
+$string['cmi5launchurluncaughterror'] = "Uncaught error retrieving the launch url from player.";
+$string['cmi5launchposterror'] = "communicating with player, sending or crafting a POST request: ";
+$string['cmi5launchgeterror'] = "communicating with player, sending or crafting a GET request: ";
+$string['cmi5launchsessioninfoerror'] = "retrieving the session information.";
+$string['cmi5launchsessioninfouncaughterror'] = "Uncaught error retrieving the session information.";
+
+
 // Grading info - MB.
 // Headers.
 $string['defaultgradesettings'] = 'Default values for cmi5 launch link activity grades';