Skip to content

Commit

Permalink
Some bug fixing & mostly done with help message when an unsigned requ…
Browse files Browse the repository at this point in the history 
…est doesn't work.
  • Loading branch information
@scriby
scriby committed Nov 7, 2011
1 parent 020eea1 commit 3dd9ca2
Show file tree
Hide file tree
Showing 3 changed files with 80 additions and 32 deletions.
15 changes: 15 additions & 0 deletions mod/lti/lang/en/lti.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,21 @@

$string['return_to_course'] = 'Click <a href="{$a->link}" target="_top">here</a> to return to the course.';

$string['lti_launch_error'] = 'An error occured when launching the external tool: ';
$string['lti_launch_error_unsigned_help'] = <<<'HTML'
<p>
This error may be a result of a missing consumer key and shared secret for the tool provider.
</p>
<p>
If you have a consumer key and shared secret, you may enter it on the
<a href="{$a->instance_edit_url}" target="_top">external tool instance</a> (make sure advanced options are visible).<br />
Alternatively, you may create a course level tool provider configuration <a href="{$a->course_tool_editor}" target="_top">here</a>.
</p>
<p>
To submit a request for an administrator to complete the tool configuration, click <a href="{$a->admin_request_url}" target="_top">here</a>.
</p>
HTML;

//Instance help

$string['external_tool_type_help'] = <<<HTML
Expand Down
89 changes: 57 additions & 32 deletions mod/lti/locallib.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,23 @@ function lti_view($instance) {
$typeconfig['organizationid'] = $urlparts['host'];
}

if(!empty($instance->resourcekey)){
$key = $instance->resourcekey;
} else if(!empty($typeconfig['resourcekey'])){
$key = $typeconfig['resourcekey'];
} else {
$key = '';
}

if(!empty($instance->password)){
$secret = $instance->password;
} else if(!empty($typeconfig['password'])){
$secret = $typeconfig['password'];
} else {
$secret = '';
}

$endpoint = !empty($instance->toolurl) ? $instance->toolurl : $typeconfig['toolurl'];
$key = !empty($instance->resourcekey) ? $instance->resourcekey : $typeconfig['resourcekey'];
$secret = !empty($instance->password) ? $instance->password : $typeconfig['password'];
$orgid = $typeconfig['organizationid'];
/* Suppress this for now - Chuck
$orgdesc = $typeconfig['organizationdescr'];
Expand All @@ -122,15 +136,26 @@ function lti_view($instance) {
$course = $PAGE->course;
$requestparams = lti_build_request($instance, $typeconfig, $course);

// Make sure we let the tool know what LMS they are being called from
$requestparams["ext_lms"] = "moodle-2";

// Add oauth_callback to be compliant with the 1.0A spec
$requestparams["oauth_callback"] = "about:blank";

$submittext = get_string('press_to_submit', 'lti');
$parms = lti_sign_parameters($requestparams, $endpoint, "POST", $key, $secret, $submittext, $orgid /*, $orgdesc*/);

$launchcontainer = lti_get_launch_container($instance, $typeconfig);
$returnurlparams = array('course' => $course->id, 'launch_container' => $launchcontainer);

if ( $orgid ) {
$requestparams["tool_consumer_instance_guid"] = $orgid;
}

if(!empty($key) && !empty($secret)){
$parms = lti_sign_parameters($requestparams, $endpoint, "POST", $key, $secret);
} else {
//If no key and secret, do the launch unsigned.
$parms = $requestparams;

$returnurlparams['unsigned'] = '1';
}

//Add the return URL. We send the launch container along to help us avoid frames-within-frames when the user returns
$url = new moodle_url('/mod/lti/return.php', $returnurlparams);
$parms['launch_presentation_return_url'] = $url->out(false);

$debuglaunch = ( $instance->debuglaunch == 1 );

$content = lti_post_launch_html($parms, $endpoint, $debuglaunch);
Expand Down Expand Up @@ -229,12 +254,6 @@ function lti_build_request($instance, $typeconfig, $course) {
$url = new moodle_url('/mod/lti/service.php');
$requestparams['lis_outcome_service_url'] = $url->out();

$launchcontainer = lti_get_launch_container($instance, $typeconfig);

//Add the return URL. We send the launch container along to help us avoid frames-within-frames when the user returns
$url = new moodle_url('/mod/lti/return.php', array('course' => $course->id, 'launch_container' => $launchcontainer));
$requestparams['launch_presentation_return_url'] = $url->out(false);

// Concatenate the custom parameters from the administrator and the instructor
// Instructor parameters are only taken into consideration if the administrator
// has giver permission
Expand All @@ -261,6 +280,21 @@ function lti_build_request($instance, $typeconfig, $course) {
$requestparams = array_merge($custom, $requestparams);
}

// Make sure we let the tool know what LMS they are being called from
$requestparams["ext_lms"] = "moodle-2";

// Add oauth_callback to be compliant with the 1.0A spec
$requestparams["oauth_callback"] = "about:blank";

$submittext = get_string('press_to_submit', 'lti');
$requestparams["ext_submit"] = $submittext;

$requestparams["lti_version"] = "LTI-1p0";
$requestparams["lti_message_type"] = "basic-lti-launch-request";
/* Suppress this for now - Chuck
if ( $orgdesc ) $requestparams["tool_consumer_instance_description"] = $orgdesc;
*/

return $requestparams;
}

Expand Down Expand Up @@ -624,7 +658,7 @@ function lti_get_shared_secrets_by_key($key){
UNION
SELECT password
SELECT password AS value
FROM {lti}
WHERE resourcekey = :key2
QUERY;
Expand Down Expand Up @@ -959,18 +993,9 @@ function lti_update_config($config) {
* @param $orgid LMS name
* @param $orgdesc LMS key
*/
function lti_sign_parameters($oldparms, $endpoint, $method, $oauthconsumerkey, $oauthconsumersecret, $submittext, $orgid /*, $orgdesc*/) {
global $lastbasestring;
function lti_sign_parameters($oldparms, $endpoint, $method, $oauthconsumerkey, $oauthconsumersecret) {
//global $lastbasestring;
$parms = $oldparms;
$parms["lti_version"] = "LTI-1p0";
$parms["lti_message_type"] = "basic-lti-launch-request";
if ( $orgid ) {
$parms["tool_consumer_instance_guid"] = $orgid;
}
/* Suppress this for now - Chuck
if ( $orgdesc ) $parms["tool_consumer_instance_description"] = $orgdesc;
*/
$parms["ext_submit"] = $submittext;

$testtoken = '';

Expand All @@ -981,7 +1006,7 @@ function lti_sign_parameters($oldparms, $endpoint, $method, $oauthconsumerkey, $
$accreq->sign_request($hmacmethod, $testconsumer, $testtoken);

// Pass this back up "out of band" for debugging
$lastbasestring = $accreq->get_signature_base_string();
//$lastbasestring = $accreq->get_signature_base_string();

$newparms = $accreq->get_parameters();

Expand All @@ -996,7 +1021,7 @@ function lti_sign_parameters($oldparms, $endpoint, $method, $oauthconsumerkey, $
* @param $debug Debug (true/false)
*/
function lti_post_launch_html($newparms, $endpoint, $debug=false) {
global $lastbasestring;
//global $lastbasestring;

$r = "<form action=\"".$endpoint."\" name=\"ltiLaunchForm\" id=\"ltiLaunchForm\" method=\"post\" encType=\"application/x-www-form-urlencoded\">\n";

Expand Down Expand Up @@ -1043,7 +1068,7 @@ function lti_post_launch_html($newparms, $endpoint, $debug=false) {
$r .= "$key = $value<br/>\n";
}
$r .= "&nbsp;<br/>\n";
$r .= "<p><b>".get_string("basiclti_base_string", "lti")."</b><br/>\n".$lastbasestring."</p>\n";
//$r .= "<p><b>".get_string("basiclti_base_string", "lti")."</b><br/>\n".$lastbasestring."</p>\n";
$r .= "</div>\n";
}
$r .= "</form>\n";
Expand Down
8 changes: 8 additions & 0 deletions mod/lti/return.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

$courseid = required_param('course', PARAM_INT);
$errormsg = optional_param('lti_errormsg', '', PARAM_RAW);
$unsigned = optional_param('unsigned', '0', PARAM_INT);
$launchcontainer = optional_param('launch_container', LTI_LAUNCH_CONTAINER_WINDOW, PARAM_INT);

$course = $DB->get_record('course', array('id' => $courseid));
Expand All @@ -30,8 +31,15 @@

echo $OUTPUT->header();

echo get_string('lti_launch_error', 'lti');

//TODO: Add some help around this error message.
echo htmlspecialchars($errormsg);

if($unsigned == 1){
echo '<br /><br />';
echo get_string('lti_launch_error_unsigned_help', 'lti');
}

echo $OUTPUT->footer();
} else {
Expand Down

0 comments on commit 3dd9ca2

Please sign in to comment.