qalam_lti_provider_engine 2.0.5 → 2.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6ccfc573b45088fcf5f6f7a2baab432a14cd2dca48f112002571d38332d8a0c
-  data.tar.gz: e6bf0833f875d030751470feed9cb6b2c6370f62ce121ff7fe86cd8e2626a8aa
+  metadata.gz: 07bc159f241d267bd6e42067a210324f18198742dc3e4965959b6b95065aebe7
+  data.tar.gz: 5f962326d293321e6d9d229c6bd7fad1c57e4155efb03e416a540afaf30cda33
 SHA512:
-  metadata.gz: c2e90003e78e5b64fe4ebd49c63de0e5fe115cde52a449e3bb3811065ca4c80f10fc121b094164befe58cf11dec3730214c831b1378b6578eaa32d766de5dbbb
-  data.tar.gz: ad8ccaf97941edabfabf5756c099c8d7cc57122ee5830adedf31377dd19fd7a0297c20bdaa644b596318afadb917ad4b7faf6af8652fe63eb69c44ba84943757
+  metadata.gz: 215e7707f1858ce5cb1c3302b324ce2b9f0e513a1b7781d171b8179f1a7d1bc5378797f268dfffd4c179445a9396f7c58b51bc976f76ff2fc9a82165ac06f54d
+  data.tar.gz: a31aeb671814a4f142ebd99ccb2e19acb11334e5f35c7cfc384f50d80c7deca978f3a104239cf1d6de1328efac50f353498d233b16c7ef414799a43ffce3b44f

data/app/controllers/lti_provider/lti_controller.rb

@@ -4,17 +4,28 @@ require 'colorize'
 module LtiProvider
   class LtiController < LtiProvider::LtiApplicationController
     skip_before_action :require_lti_launch
+    # skip_before_action :verify_authenticity_token, only: :launch
 
     def launch
-      provider = IMS::LTI::ToolProvider.new(params['oauth_consumer_key'], LtiProvider::Config.secret, params)
+      tool_key = params['oauth_consumer_key']
+      tool_secret = ((ToolLtiKey.table_exists? && ToolLtiKey.find_by(key: tool_key, canvas_url: canvas_url_domain)&.secret) or (LtiProvider::Config.secret))
+
+      # puts tool_key.inspect.green
+      # puts LtiProvider::Config.secret.inspect.red
+      # puts (ToolLtiKey.table_exists? && ToolLtiKey.find_by(key: tool_key, canvas_url: canvas_url_domain)&.secret).inspect.red
+      # puts tool_secret.inspect.green
+      
+      provider = IMS::LTI::ToolProvider.new(tool_key, tool_secret, params)
       launch = Launch.initialize_from_request(provider, request)
 
+      # puts launch.inspect.red
+      # puts request.origin.inspect.green
+      # puts request.base_url.inspect.yellow
       if !launch.valid_provider?
         msg = "#{launch.lti_errormsg} Please be sure you are launching this tool from the link provided in Qalam."
         return show_error msg
       elsif launch.save
         session[:cookie_test] = true
-
         ### QALAM ###
         if params[:timetable_date] && params[:section_room]
           redirect_to cookie_test_path(nonce: launch.nonce, timetable_date: params[:timetable_date], section_room: params[:section_room])
@@ -23,26 +34,34 @@ module LtiProvider
         end
         ### END ###
       else
-        return show_error "Unable to launch #{LtiProvider::XmlConfig.tool_title}. Please check your External Tools configuration and try again."
+        # if params[:launch_tool] && params[:launch_tool] == 'digital_library'
+        #   redirect_to main_app.root_path and return 
+        # else
+          return show_error "Unable to launch #{LtiProvider::XmlConfig.tool_title}. Please check your External Tools configuration and try again."
+        # end
       end
     end
 
     def cookie_test
+      @launch = Launch.where("created_at > ?", 5.minutes.ago).find_by_nonce(params[:nonce])
+
       if session[:cookie_test]
         # success!!! we've got a session!
         consume_launch
       else
-        render
+        # if @launch.launch_tool && @launch.launch_tool == 'digital_library'
+        #   redirect_to main_app.root_path and return 
+        # else
+          render and return
+        # end
       end
     end
 
     def consume_launch
-      launch = Launch.where("created_at > ?", 5.minutes.ago).find_by_nonce(params[:nonce])
-
-      if launch
+      if @launch
         [:account_id, :course_name, :course_id, :canvas_url, :tool_consumer_instance_guid,
          :user_id, :user_name, :user_roles, :user_avatar_url, :launch_tool].each do |attribute|
-          session[attribute] = launch.public_send(attribute)
+          session[attribute] = @launch.public_send(attribute)
         end
 
         ### QALAM ###
@@ -52,11 +71,19 @@ module LtiProvider
         end
         ### END ###
         
-        launch.destroy
+        @launch.destroy
 
-        redirect_to main_app.root_path
+        # if @launch.launch_tool && @launch.launch_tool == 'digital_library'
+        #   redirect_to main_app.root_path and return 
+        # else
+          redirect_to main_app.root_path and return
+        # end
       else
-        return show_error "The tool was not launched successfully. Please try again."
+        # if @launch.launch_tool && @launch.launch_tool == 'digital_library'
+        #   redirect_to main_app.root_path and return 
+        # else
+          return show_error "The tool was not launched successfully. Please try again."
+        # end
       end
     end
 
@@ -72,5 +99,15 @@ module LtiProvider
       def show_error(message)
         render plain: message
       end
+
+    private
+      def canvas_url_domain
+        if params['launch_presentation_return_url']
+          uri = URI.parse(params['launch_presentation_return_url'])
+          domain = "#{uri.scheme}://#{uri.host}"
+          domain += ":#{uri.port}" unless uri.port.nil? || [80, 443].include?(uri.port.to_i)
+          return domain
+        end
+      end
   end
 end

data/app/models/lti_provider/launch.rb

@@ -55,6 +55,82 @@ module LtiProvider
         tc.canvas_user_navigation!(LtiProvider::XmlConfig.user_navigation.symbolize_keys)
       end
 
+      ### QALAM ###
+
+      if LtiProvider::XmlConfig.course_home_sub_navigation
+        tc.canvas_course_home_sub_navigation!(LtiProvider::XmlConfig.course_home_sub_navigation.symbolize_keys)
+      end
+
+      if LtiProvider::XmlConfig.course_settings_sub_navigation
+        tc.canvas_course_settings_sub_navigation!(LtiProvider::XmlConfig.course_settings_sub_navigation.symbolize_keys)
+      end
+
+      if LtiProvider::XmlConfig.global_navigation
+        tc.canvas_global_navigation!(LtiProvider::XmlConfig.global_navigation.symbolize_keys)
+      end
+
+      if LtiProvider::XmlConfig.module_menu
+        tc.canvas_module_menu!(LtiProvider::XmlConfig.module_menu.symbolize_keys)
+      end
+
+      if LtiProvider::XmlConfig.module_index_menu
+        tc.canvas_module_index_menu!(LtiProvider::XmlConfig.module_index_menu.symbolize_keys)
+      end
+
+      if LtiProvider::XmlConfig.module_group_menu
+        tc.canvas_module_group_menu!(LtiProvider::XmlConfig.module_group_menu.symbolize_keys)
+      end
+
+      if LtiProvider::XmlConfig.quiz_menu
+        tc.canvas_quiz_menu!(LtiProvider::XmlConfig.quiz_menu.symbolize_keys)
+      end
+
+      if LtiProvider::XmlConfig.quiz_index_menu
+        tc.canvas_quiz_index_menu!(LtiProvider::XmlConfig.quiz_index_menu.symbolize_keys)
+      end
+
+      if LtiProvider::XmlConfig.assignment_menu
+        tc.canvas_assignment_menu!(LtiProvider::XmlConfig.assignment_menu.symbolize_keys)
+      end
+
+      if LtiProvider::XmlConfig.assignment_index_menu
+        tc.canvas_assignment_index_menu!(LtiProvider::XmlConfig.assignment_index_menu.symbolize_keys)
+      end
+
+      if LtiProvider::XmlConfig.assignment_group_menu
+        tc.canvas_assignment_group_menu!(LtiProvider::XmlConfig.assignment_group_menu.symbolize_keys)
+      end
+
+      if LtiProvider::XmlConfig.discussion_topic_menu
+        tc.canvas_discussion_topic_menu!(LtiProvider::XmlConfig.discussion_topic_menu.symbolize_keys)
+      end
+
+      if LtiProvider::XmlConfig.discussion_topic_index_menu
+        tc.canvas_discussion_topic_index_menu!(LtiProvider::XmlConfig.discussion_topic_index_menu.symbolize_keys)
+      end
+
+      if LtiProvider::XmlConfig.wiki_page_menu
+        tc.canvas_wiki_page_menu!(LtiProvider::XmlConfig.wiki_page_menu.symbolize_keys)
+      end
+
+      if LtiProvider::XmlConfig.wiki_index_menu
+        tc.canvas_wiki_index_menu!(LtiProvider::XmlConfig.wiki_index_menu.symbolize_keys)
+      end
+
+      if LtiProvider::XmlConfig.file_menu
+        tc.canvas_file_menu!(LtiProvider::XmlConfig.file_menu.symbolize_keys)
+      end
+
+      if LtiProvider::XmlConfig.file_index_menu
+        tc.canvas_file_index_menu!(LtiProvider::XmlConfig.file_index_menu.symbolize_keys)
+      end
+
+      if LtiProvider::XmlConfig.editor_button
+        tc.canvas_editor_button!(LtiProvider::XmlConfig.editor_button.symbolize_keys)
+      end
+      
+      ### END ###
+
       if LtiProvider::XmlConfig.environments
         tc.set_ext_param(platform, :environments, LtiProvider::XmlConfig.environments.symbolize_keys)
       end

data/app/models/tool_lti_key.rb

@@ -0,0 +1,4 @@
+class ToolLtiKey < ApplicationRecord
+    validates :canvas_url, :secret, presence: true
+    validates :key, presence: true, :uniqueness => {:scope=>:canvas_url}
+end

data/app/views/layouts/lti_provider/application.html.erb

@@ -1,12 +1,14 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <title>LtiProvider</title>
-  <%= csrf_meta_tags %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>
+  <head>
+    <title>QalamLtiProvider</title>
+    <%= csrf_meta_tags %>
+    <meta name="description" content="About QalamLtiProvider">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/db/migrate/20210809101126_create_tool_lti_keys.rb

@@ -0,0 +1,11 @@
+class CreateToolLtiKeys < ActiveRecord::Migration[6.0]
+  def change
+    create_table :tool_lti_keys do |t|
+      t.string :key
+      t.string :secret
+      t.string :canvas_url
+
+      t.timestamps
+    end
+  end
+end

data/lib/lti_provider/lti_application.rb

@@ -12,8 +12,13 @@ module LtiProvider
     protected
     def require_lti_launch
       if canvas_url.blank? || user_id.blank?
-        reset_session
-        prompt_for_launch
+        if session[:qalam_url]
+          reset_session
+          prompt_for_launch_authorized
+        else
+          reset_session
+          prompt_for_launch
+        end
       end
     end
 
@@ -21,6 +26,10 @@ module LtiProvider
       render plain: 'Please launch this tool from Qalam and then try again.'
     end
 
+    def prompt_for_launch_authorized
+      render plain: 'You need to be login on Qalam.'
+    end
+
     def canvas_url
       session[:canvas_url]
     end
@@ -59,19 +68,19 @@ module LtiProvider
     end
 
     def student_launch?
-      user_roles.split(',').include? 'urn:lti:role:ims/lis/Learner'
+      user_roles&.split(',')&.include? 'urn:lti:role:ims/lis/Learner'
     end
 
     def teacher_launch?
-      user_roles.split(',').include? 'urn:lti:role:ims/lis/Instructor'
+      user_roles&.split(',')&.include? 'urn:lti:role:ims/lis/Instructor'
     end
 
     def account_admin_launch?
-      user_roles.split(',').include? 'urn:lti:instrole:ims/lis/Administrator'
+      user_roles&.split(',')&.include? 'urn:lti:instrole:ims/lis/Administrator'
     end
 
     def root_admin_launch?
-      user_roles.split(',').include? 'urn:lti:sysrole:ims/lis/SysAdmin'
+      user_roles&.split(',')&.include? 'urn:lti:sysrole:ims/lis/SysAdmin'
     end
     ### END ###
 

data/lib/lti_provider/version.rb

@@ -1,3 +1,3 @@
 module LtiProvider
-  VERSION = "2.0.5"
+  VERSION = "2.0.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qalam_lti_provider_engine
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.0.9
 platform: ruby
 authors:
 - Dave Donahue
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-01 00:00:00.000000000 Z
+date: 2021-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -245,12 +245,14 @@ files:
 - app/controllers/lti_provider/lti_application_controller.rb
 - app/controllers/lti_provider/lti_controller.rb
 - app/models/lti_provider/launch.rb
+- app/models/tool_lti_key.rb
 - app/views/layouts/lti_provider/application.html.erb
 - app/views/lti_provider/lti/cookie_test.html.erb
 - config/lti.yml.example
 - config/lti_xml.yml.example
 - config/routes.rb
 - db/migrate/20130319050003_create_lti_provider_launches.rb
+- db/migrate/20210809101126_create_tool_lti_keys.rb
 - lib/lti_provider.rb
 - lib/lti_provider/config.rb
 - lib/lti_provider/engine.rb
@@ -312,7 +314,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.21
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: LtiProvider is a mountable engine for handling the LTI launch and exposing