Skip to content

Commit

Permalink
SAK-28149
Browse files Browse the repository at this point in the history 
Finally a commit to add the base string to debug output that is merge-worthy



git-svn-id: https://source.sakaiproject.org/svn/basiclti/trunk@315820 66ffb92e-73f9-0310-93c1-f5514f145a0a
  • Loading branch information
@csev
csev committed Dec 1, 2014
1 parent c1f54bd commit c3a70c2
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 22 deletions.
25 changes: 14 additions & 11 deletions basiclti/basiclti-common/src/java/org/sakaiproject/basiclti/util/SakaiBLTIUtil.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import java.util.Properties;
import java.util.Map;
import java.util.TreeMap;
import java.util.HashMap;
import java.util.List;
import java.util.ArrayList;
import java.util.Iterator;
Expand Down Expand Up @@ -628,12 +629,12 @@ public static String[] postLaunchHTML(Map<String, Object> content, Map<String,Ob
Map<String, Object> deploy = null;

Long deployKey = getLongKey(tool.get(LTIService.LTI_DEPLOYMENT_ID));
if ( deployKey >= 0 ) {
deploy = ltiService.getDeployDao(deployKey);
}
if ( deployKey >= 0 ) {
deploy = ltiService.getDeployDao(deployKey);
}

Long toolKey = getLongKey(tool.get(LTIService.LTI_ID));
proxyBinding = ltiService.getProxyBindingDao(toolKey,context);
proxyBinding = ltiService.getProxyBindingDao(toolKey,context);

Long toolVersion = getLongNull(tool.get(LTIService.LTI_VERSION));
boolean isLTI1 = toolVersion == null || (!toolVersion.equals(LTIService.LTI_VERSION_2));
Expand Down Expand Up @@ -815,7 +816,7 @@ public static String[] postLaunchHTML(Map<String, Object> content, Map<String,Ob
return postLaunchHTML(toolProps, ltiProps, rb);
}

// An LTI 2.0 Registration launch
// An LTI 2.0 Registration launch
// This must return an HTML message as the [0] in the array
// If things are successful - the launch URL is in [1]
public static String[] postRegisterHTML(Long deployKey, Map<String,Object> tool, ResourceLoader rb, String placementId)
Expand Down Expand Up @@ -858,13 +859,13 @@ public static String[] postRegisterHTML(Long deployKey, Map<String,Object> tool,
M_log.debug("ltiProps="+ltiProps);

boolean dodebug = debug == 1;
String postData = BasicLTIUtil.postLaunchHTML(ltiProps, launch_url, dodebug);
String postData = BasicLTIUtil.postLaunchHTML(ltiProps, launch_url, dodebug, null);

String [] retval = { postData, launch_url };
return retval;
}

// An LTI 2.0 ReRegistration launch
// An LTI 2.0 ReRegistration launch
// This must return an HTML message as the [0] in the array
// If things are successful - the launch URL is in [1]
public static String[] postReRegisterHTML(Long deployKey, Map<String,Object> deploy, ResourceLoader rb, String placementId)
Expand Down Expand Up @@ -903,13 +904,14 @@ public static String[] postReRegisterHTML(Long deployKey, Map<String,Object> dep
int debug = getInt(deploy.get(LTIService.LTI_DEBUG));
debug = 1;

Map<String,String> extra = new HashMap<String,String> ();
ltiProps = BasicLTIUtil.signProperties(ltiProps, launch_url, "POST",
consumerkey, secret, null, null, null);
consumerkey, secret, null, null, null, extra);

M_log.debug("signed ltiProps="+ltiProps);

boolean dodebug = debug == 1;
String postData = BasicLTIUtil.postLaunchHTML(ltiProps, launch_url, dodebug);
String postData = BasicLTIUtil.postLaunchHTML(ltiProps, launch_url, dodebug, extra);

String [] retval = { postData, launch_url };
return retval;
Expand Down Expand Up @@ -994,15 +996,16 @@ public static String[] postLaunchHTML(Properties toolProps, Properties ltiProps,
return postError("<p>" + getRB(rb, "error.nokey", "Error - must have a secret and a key.")+"</p>");
}

Map<String,String> extra = new HashMap<String,String> ();
ltiProps = BasicLTIUtil.signProperties(ltiProps, launch_url, "POST",
key, secret, org_guid, org_desc, org_url);
key, secret, org_guid, org_desc, org_url, extra);

if ( ltiProps == null ) return postError("<p>" + getRB(rb, "error.sign", "Error signing message.")+"</p>");
dPrint("LAUNCH III="+ltiProps);

String debugProperty = toolProps.getProperty(LTIService.LTI_DEBUG);
boolean dodebug = "on".equals(debugProperty) || "1".equals(debugProperty);
String postData = BasicLTIUtil.postLaunchHTML(ltiProps, launch_url, dodebug);
String postData = BasicLTIUtil.postLaunchHTML(ltiProps, launch_url, dodebug, extra);

String [] retval = { postData, launch_url };
return retval;
Expand Down
37 changes: 29 additions & 8 deletions basiclti/basiclti-util/src/java/org/imsglobal/basiclti/BasicLTIUtil.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ public static String adaptToCustomPropertyName(final String propertyName) {
* Add the necessary fields and sign.
*
* @deprecated See:
* {@link BasicLTIUtil#signProperties(Map, String, String, String, String, String, String, String, String, String)}
* {@link BasicLTIUtil#signProperties(Map, String, String, String, String, String, String, String, String, String)}
*
* @param postProp
* @param url
Expand All @@ -332,14 +332,15 @@ public static String adaptToCustomPropertyName(final String propertyName) {
* See: {@link BasicLTIConstants#TOOL_CONSUMER_INSTANCE_DESCRIPTION}
* @param org_url
* See: {@link BasicLTIConstants#TOOL_CONSUMER_INSTANCE_URL}
* @param extra
* @return
*/
public static Properties signProperties(Properties postProp, String url,
String method, String oauth_consumer_key, String oauth_consumer_secret,
String org_id, String org_desc, String org_url) {
String org_id, String org_desc, String org_url, Map<String,String> extra) {
final Map<String, String> signedMap = signProperties(
convertToMap(postProp), url, method, oauth_consumer_key,
oauth_consumer_secret, org_id, org_desc, org_url, null, null);
oauth_consumer_secret, org_id, org_desc, org_url, null, null, extra);
return convertToProperties(signedMap);
}

Expand All @@ -362,6 +363,7 @@ public static Properties signProperties(Properties postProp, String url,
* @param tool_consumer_instance_contact_email
* See:
* {@link BasicLTIConstants#TOOL_CONSUMER_INSTANCE_CONTACT_EMAIL}
* @param extra
* @return
*/
public static Map<String, String> signProperties(
Expand All @@ -370,7 +372,9 @@ public static Map<String, String> signProperties(
String tool_consumer_instance_guid,
String tool_consumer_instance_description,
String tool_consumer_instance_url, String tool_consumer_instance_name,
String tool_consumer_instance_contact_email) {
String tool_consumer_instance_contact_email,
Map<String, String> extra) {

postProp = BasicLTIUtil.cleanupProperties(postProp);

if ( postProp.get(LTI_VERSION) == null ) postProp.put(LTI_VERSION, "LTI-1p0");
Expand Down Expand Up @@ -407,7 +411,11 @@ public static Map<String, String> signProperties(
OAuthAccessor acc = new OAuthAccessor(cons);
try {
oam.addRequiredParameters(acc);
// System.out.println("Base Message String\n"+OAuthSignatureMethod.getBaseString(oam)+"\n");
String base_string = OAuthSignatureMethod.getBaseString(oam);
M_log.fine("Base Message String\n"+base_string+"\n");
if ( extra != null ) {
extra.put("BaseString", base_string);
}

List<Map.Entry<String, String>> params = oam.getParameters();

Expand Down Expand Up @@ -511,12 +519,13 @@ public static boolean checkProperties(
* The LTI launch url.
* @param debug
* Useful for viewing the HTML before posting to end point.
* @param extra
* @return the HTML ready for IFRAME src = inclusion.
*/
public static String postLaunchHTML(final Properties cleanProperties,
String endpoint, boolean debug) {
String endpoint, boolean debug, Map<String,String> extra) {
Map<String, String> map = convertToMap(cleanProperties);
return postLaunchHTML(map, endpoint, debug);
return postLaunchHTML(map, endpoint, debug, extra);
}

/**
Expand All @@ -530,10 +539,14 @@ public static String postLaunchHTML(final Properties cleanProperties,
* The LTI launch url.
* @param debug
* Useful for viewing the HTML before posting to end point.
* @param extra
* Useful for viewing the HTML before posting to end point.
* @return the HTML ready for IFRAME src = inclusion.
*/
public static String postLaunchHTML(
final Map<String, String> cleanProperties, String endpoint, boolean debug) {
final Map<String, String> cleanProperties, String endpoint,
boolean debug, Map<String,String> extra) {

if (cleanProperties == null || cleanProperties.isEmpty()) {
throw new IllegalArgumentException(
"cleanProperties == null || cleanProperties.isEmpty()");
Expand Down Expand Up @@ -611,6 +624,14 @@ public static String postLaunchHTML(
text.append("\n");
}
text.append("</pre>\n");
if ( extra != null ) {
String base_string = extra.get("BaseString");
if ( base_string != null ) {
text.append("<!-- Base String\n");
text.append(base_string.replaceAll("-->","__>"));
text.append("\n-->\n");
}
}
} else {
// paint auto submit script
text
Expand Down
8 changes: 5 additions & 3 deletions basiclti/basiclti-util/src/java/org/imsglobal/lti2/LTI2Servlet.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.HashMap;
import java.util.Properties;
import java.util.TreeMap;

Expand Down Expand Up @@ -204,7 +205,7 @@ protected void doRegister(HttpServletRequest request, HttpServletResponse respon
System.out.println("ltiProps="+ltiProps);

boolean dodebug = true;
output = BasicLTIUtil.postLaunchHTML(ltiProps, launch_url, dodebug);
output = BasicLTIUtil.postLaunchHTML(ltiProps, launch_url, dodebug, null);
} else {
output = "<form>Register URL:<br/><input type=\"text\" name=\"launch_url\" size=\"80\"\n" +
"value=\"http://localhost:8888/sakai-api-test/tp.php\"><input type=\"submit\">\n";
Expand Down Expand Up @@ -272,11 +273,12 @@ protected void doLaunch(HttpServletRequest request, HttpServletResponse response
// Place the custom values into the launch
LTI2Util.addCustomToLaunch(ltiProps, custom);

Map<String,String> extra = new HashMap<String,String> ();
ltiProps = BasicLTIUtil.signProperties(ltiProps, launch, "POST",
TEST_KEY, shared_secret, null, null, null);
TEST_KEY, shared_secret, null, null, null, extra);

boolean dodebug = true;
output = BasicLTIUtil.postLaunchHTML(ltiProps, launch, dodebug);
output = BasicLTIUtil.postLaunchHTML(ltiProps, launch, dodebug, extra);
}

try {
Expand Down

0 comments on commit c3a70c2

Please sign in to comment.