SWAMPy

✎ CARVE FLESH

EDITING: importer.rb

# frozen_string_literal: true

#
# Copyright (C) 2016 - present Instructure, Inc.
#
# This file is part of Canvas.
#
# Canvas is free software: you can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the Free
# Software Foundation, version 3 of the License.
#
# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.

module Lti
  module ContentMigrationService
    # Imports any external content specified by a ContextExternalTool, as detailed
    # in doc/api/tools_xml.md#Content Migration support. Import is done by POSTing
    # to the tool's content_migration.import_start_url, sending along the external
    # content that was defined during export in `./exporter.rb`. The default format
    # for the POST body is a nested query string, but is sent as JSON if the tool
    # specifies so in content_migration.import_format.
    # This code is referenced by `lib/canvas/migration/external_content/migrator.rb`
    # and eventually by `app/models/importers/course_content_importer.rb`, which
    # is called during a course copy or import.
    class Importer < Lti::ContentMigrationService::Migrator
      attr_reader :original_tool_id

def initialize(original_tool_id)
        super()
        @original_tool_id = original_tool_id
      end

def send_imported_content(course, _content_migration, content)
        @course = course
        @root_account = course.root_account
        load_tool!
        post_body = start_import_post_body(content)
        response = Canvas.retriable(on: Timeout::Error) do
          case import_format
          when JSON_FORMAT
            CanvasHttp.post(import_start_url, base_request_headers, body: post_body.to_json, content_type: "application/json")
          else
            CanvasHttp.post(import_start_url, base_request_headers, form_data: Rack::Utils.build_nested_query(post_body))
          end
        end
        case response.code.to_i
        when (200..201)
          parsed_response = JSON.parse(response.body)
          unless parsed_response.empty?
            @status_url = parsed_response["status_url"]
          end
        else
          raise "Unable to start import for external tool #{@tool.name} (#{response.code})"
        end
        self
      rescue Timeout::Error
        raise "Unable to start import for external tool #{@tool.name}, request timed out."
      end

def import_completed?
        response = Canvas.retriable(on: Timeout::Error) { CanvasHttp.get(@status_url, base_request_headers) } if @status_url
        if response&.code.to_i == 200
          parsed_response = JSON.parse(response.body)
          @export_status = parsed_response["status"]
          case @export_status
          when SUCCESSFUL_STATUS
            true
          when FAILED_STATUS
            raise parsed_response["message"]
          else
            false
          end
        end
      rescue Timeout::Error
        false
      end

private

def start_import_post_body(content)
        {
          context_id: Lti::Asset.opaque_identifier_for(@course),
          data: content,
          tool_consumer_instance_guid: @root_account.lti_guid,
        }.merge(expanded_variables)
      end

def load_tool!
        return @tool if @tool

original_tool = ContextExternalTool.find(@original_tool_id)
        @tool = ContextExternalTool.find_external_tool(original_tool.domain, @course, @original_tool_id).tap do |t|
          unless t&.content_migration_configured?
            raise "Unable to find external tool to import content."
          end
        end
      end

def import_start_url
        @import_url ||= @tool.settings.dig(:content_migration, :import_start_url)
      end

def import_format
        @tool.settings.dig(:content_migration, :import_format)
      end
    end
  end
end

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 exporter.rb	RB	4.4 KB	2023-09-24 03:36	EDIT
📄 importer.rb	RB	4.1 KB	2023-09-24 03:36	EDIT
📄 migrator.rb	RB	1.7 KB	2023-09-24 03:36	EDIT