From e5f583294a03379acfc5ca0958259855b5888e7c Mon Sep 17 00:00:00 2001 From: polesye Date: Wed, 11 Dec 2013 13:26:48 +0200 Subject: [PATCH] Address comments. --- .../lib/xmodule/xmodule/js/src/lti/01_lti.js | 192 ------------------ .../lib/xmodule/xmodule/js/src/lti/02_main.js | 57 ------ common/lib/xmodule/xmodule/lti_module.py | 1 - lms/templates/lti.html | 2 +- lms/templates/lti_form.html | 2 +- 5 files changed, 2 insertions(+), 252 deletions(-) delete mode 100644 common/lib/xmodule/xmodule/js/src/lti/01_lti.js delete mode 100644 common/lib/xmodule/xmodule/js/src/lti/02_main.js diff --git a/common/lib/xmodule/xmodule/js/src/lti/01_lti.js b/common/lib/xmodule/xmodule/js/src/lti/01_lti.js deleted file mode 100644 index 4803c05e78..0000000000 --- a/common/lib/xmodule/xmodule/js/src/lti/01_lti.js +++ /dev/null @@ -1,192 +0,0 @@ -/** - * File: lti.js - * - * Purpose: LTI module constructor. Given an LTI element, we process it. - * - * - * Inside the element there is a form. If that form has a valid action - * attribute, then we do one of: - * - * 1.) Submit the form. The results will be shown on the current page in an - * iframe. - * 2.) Attach a handler function to a link which will submit the form. The - * results will be shown in a new window. - * - * The 'open_in_a_new_page' data attribute of the LTI element dictates which of - * the two actions will be performed. - */ - -/* - * So the thing to do when working on a motorcycle, as in any other task, is to - * cultivate the peace of mind which does not separate one's self from one's - * surroundings. When that is done successfully, then everything else follows - * naturally. Peace of mind produces right values, right values produce right - * thoughts. Right thoughts produce right actions and right actions produce - * work which will be a material reflection for others to see of the serenity - * at the center of it all. - * - * ~ Robert M. Pirsig - */ - -(function (requirejs, require, define) { - -// JavaScript LTI XModule -define( -'lti/01_lti.js', -[], -function () { - - var LTI = LTIConstructor; - - LTI.prototype = { - submitFormHandler: submitFormHandler, - getNewSignature: getNewSignature, - handleAjaxUpdateSignature: handleAjaxUpdateSignature - }; - - return LTI; - - // JavaScript LTI XModule constructor - function LTIConstructor(element) { - var _this = this; - - // In cms (Studio) the element is already a jQuery object. In lms it is - // a DOM object. - // - // To make sure that there is no error, we pass it through the $() - // function. This will make it a jQuery object if it isn't already so. - this.el = $(element); - - this.formEl = this.el.find('.ltiLaunchForm'); - this.formAction = this.formEl.attr('action'); - - // If action is empty string, or action is the default URL that should - // not cause a form submit. - if (!this.formAction || this.formAction === 'http://www.example.com') { - - // Nothing to do - no valid action provided. Error message will be - // displaced in browser (HTML). - return; - } - - this.ltiEl = this.el.find('.lti'); - - // We want a Boolean 'true' or 'false'. First we will retrieve the data - // attribute. - this.openInANewPage = this.ltiEl.data('open_in_a_new_page'); - // Then we will parse it via native JSON.parse(). - this.openInANewPage = JSON.parse(this.openInANewPage); - - // The URL where we can request for a new OAuth signature for form - // submission to the LTI provider. - this.ajaxUrl = this.ltiEl.data('ajax_url'); - - // The OAuth signature can only be used once (because of timestamp - // and nonce). This will be reset each time the form is submitted so - // that we know to fetch a new OAuth signature on subsequent form - // submit. - this.signatureIsNew = true; - - // If the Form's action attribute is set (i.e. we can perform a normal - // submit), then we (depending on instance settings) submit the form - // when user will click on a link, or submit the form immediately. - if (this.openInANewPage === true) { - // From the start, the button is enabled. - this.disableOpenNewWindowBtn = false; - - this.newWindowBtnEl = this.el.find('.link_lti_new_window') - .on( - 'click', - function () { - // Don't allow clicking repeatedly on this button - // if we are waiting for an AJAX response (with new - // OAuth signature). - if (_this.disableOpenNewWindowBtn === true) { - return; - } - - return _this.submitFormHandler(); - } - ); - } else { - // At this stage the form exists on the page and has a valid - // action. We are safe to submit it, even if `openInANewPage` is - // set to some weird value. - this.submitFormHandler(); - } - } - - // The form submit handler. Before the form is submitted, we must check if - // the OAuth signature is new (valid). If it is not new, block form - // submission and request for a signature. After a new signature is - // fetched, the form will be submitted. - function submitFormHandler() { - if (this.signatureIsNew) { - // Continue with submitting the form. - this.formEl.submit(); - - // If the OAuth signature is new, mark it as old. - this.signatureIsNew = false; - - // If we have an "Open LTI in a new window" button. - if (this.newWindowBtnEl) { - // Enable clicking on the button again. - this.disableOpenNewWindowBtn = false; - } - } else { - // The OAuth signature is old. Request for a new OAuth signature. - // - // Don't submit the form. It will be submitted once a new OAuth - // signature is received. - this.getNewSignature(); - } - } - - // Request form the server a new OAuth signature. - function getNewSignature() { - var _this = this; - - // If we have an "Open LTI in a new window" button. - if (this.newWindowBtnEl) { - // Make sure that while we are waiting for a new signature, the - // user can't click on the "Open LTI in a new window" button - // repeatedly. - this.disableOpenNewWindowBtn = true; - } - - $.postWithPrefix( - this.ajaxUrl + '/regenerate_signature', - {}, - function (response) { - return _this.handleAjaxUpdateSignature(response); - } - ); - } - - // When a new OAuth signature is received, and if the data received back is - // OK, update the form, and submit it. - function handleAjaxUpdateSignature(response) { - var _this = this; - - // If the response is valid, and contains expected data. - if ($.isPlainObject(response.input_fields)) { - // We received a new OAuth signature. - this.signatureIsNew = true; - - // Update the form fields with new data, and new OAuth - // signature. - $.each(response.input_fields, function (name, value) { - var inputEl = _this.formEl.find("input[name='" + name + "']"); - - inputEl.val(value); - }); - - // Submit the form. - this.submitFormHandler(); - } else { - console.log('[LTI info]: ' + response.error); - } - } -}); - -}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); diff --git a/common/lib/xmodule/xmodule/js/src/lti/02_main.js b/common/lib/xmodule/xmodule/js/src/lti/02_main.js deleted file mode 100644 index 9a6dacd83b..0000000000 --- a/common/lib/xmodule/xmodule/js/src/lti/02_main.js +++ /dev/null @@ -1,57 +0,0 @@ -(function (requirejs, require, define) { - -// In the case when the LTI constructor will be called before -// RequireJS finishes loading all of the LTI dependencies, we will have -// a mock function that will collect all the elements that must be -// initialized as LTI elements. -// -// Once RequireJS will load all of the necessary dependencies, main code -// will invoke the mock function with the second parameter set to truthy value. -// This will trigger the actual LTI constructor on all elements that -// are stored in a temporary list. -window.LTI = (function () { - // Temporary storage place for elements that must be initialized as LTI - // elements. - var tempCallStack = []; - - return function (element, processTempCallStack) { - // If mock function was called with second parameter set to truthy - // value, we invoke the real `window.LTI` on all the stored elements - // so far. - if (processTempCallStack) { - $.each(tempCallStack, function (index, element) { - // By now, `window.LTI` is the real constructor. - window.LTI(element); - }); - - return; - } - - // If normal call to `window.LTI` constructor, store the element - // for later initializing. - tempCallStack.push(element); - - // Real LTI constructor returns `undefined`. The mock constructor will - // return the same value. Making this explicit. - return undefined; - }; -}()); - -// Main module. -require( -[ - 'lti/01_lti.js' -], -function ( - LTIConstructor -) { - var oldLTI = window.LTI; - - window.LTI = LTIConstructor; - - // Invoke the mock LTI constructor so that the elements stored within - // it can be processed by the real `window.LTI` constructor. - oldLTI(null, true); -}); - -}(RequireJS.requirejs, RequireJS.require, RequireJS.define)); diff --git a/common/lib/xmodule/xmodule/lti_module.py b/common/lib/xmodule/xmodule/lti_module.py index 519a681230..edb990093a 100644 --- a/common/lib/xmodule/xmodule/lti_module.py +++ b/common/lib/xmodule/xmodule/lti_module.py @@ -181,7 +181,6 @@ class LTIModule(LTIFields, XModule): """ css = {'scss': [resource_string(__name__, 'css/lti/lti.scss')]} - js_module_name = "LTI" def get_input_fields(self): # LTI provides a list of default parameters that might be passed as diff --git a/lms/templates/lti.html b/lms/templates/lti.html index 48ea3d9a40..0018554528 100644 --- a/lms/templates/lti.html +++ b/lms/templates/lti.html @@ -12,7 +12,7 @@

${display_name} (${_('External resource')})

-

+

${_('View resource in a new window')}

diff --git a/lms/templates/lti_form.html b/lms/templates/lti_form.html index 1aa141a5a4..f325d2d066 100644 --- a/lms/templates/lti_form.html +++ b/lms/templates/lti_form.html @@ -28,7 +28,7 @@