SWAMPy

✎ CARVE FLESH

EDITING: translator.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 Canvas::Migration::ExternalContent
  class Translator
    attr_reader :content_migration, :content_export

def initialize(content_migration: nil, content_export: nil)
      @content_migration = content_migration
      @content_export = content_export
    end

# recursively searches for keys matching our special format -
    #   $canvas_TYPE_id
    # e.g. $canvas_assignment_id

# this indicates that they are originally ids for objects of type TYPE
    # and we'll translate them into migration ids for export and translate back into the new ids for import

# translate_type is either :export or :import
    def translate_data(data, translate_type)
      case data
      when Array
        data.each { |item| translate_data(item, translate_type) }
      when Hash
        data.each do |key, item|
          if item.is_a?(Hash) || item.is_a?(Array)
            translate_data(item, translate_type)
          elsif (obj_class = object_class_for_translation(key))
            data[key] =
              case translate_type
              when :export
                get_migration_id_from_canvas_id(obj_class, item)
              when :import
                get_canvas_id_from_migration_id(obj_class, item)
              end
          end
        end
      end
      data
    end

# probably not a comprehensive list
    TYPES_TO_CLASSES = {
      "announcement" => Announcement,
      "assessment_question_bank" => AssessmentQuestionBank,
      "assignment" => Assignment,
      "assignment_group" => AssignmentGroup,
      "attachment" => Attachment,
      "calendar_event" => CalendarEvent,
      "context_external_tool" => ContextExternalTool,
      "context_module" => ContextModule,
      "context_module_tag" => ContentTag,
      "discussion_topic" => DiscussionTopic,
      "grading_standard" => GradingStandard,
      "learning_outcome" => LearningOutcome,
      "quiz" => Quizzes::Quiz,
      "rubric" => Rubric,
      "wiki_page" => WikiPage
    }.freeze

CLASSES_TO_TYPES = TYPES_TO_CLASSES.invert.freeze

ALIASED_TYPES = {
      "context_module_item" => "context_module_tag",
      "file" => "attachment",
      "page" => "wiki_page"
    }.freeze

def object_class_for_translation(key)
      if (match = key.to_s.match(/^\$canvas_(\w+)_id$/))
        type = match[1]
        TYPES_TO_CLASSES[ALIASED_TYPES[type] || type]
      end
    end

def get_migration_id_from_canvas_id(obj_class, canvas_id)
      if content_export&.for_master_migration?
        obj = obj_class.where(obj_class.primary_key => canvas_id).first
        obj ? content_export.create_key(obj) : NOT_FOUND
      else
        (content_export || CC::CCHelper).create_key("#{obj_class.reflection_type_name}_#{canvas_id}")
      end
    end

NOT_FOUND = "$OBJECT_NOT_FOUND"

def get_canvas_id_from_migration_id(obj_class, migration_id)
      return NOT_FOUND if migration_id == NOT_FOUND
      if (item = content_migration.find_imported_migration_item(obj_class, migration_id))
        return item.id
      end

# most of the time, the new canvas object have been imported with the current import
      # but it may have been imported earlier as a selective import
      # so we can search for it in the course just to be sure
      obj_type = TYPES_TO_CLASSES.detect { |_k, v| v == obj_class }.first
      if (item = content_migration.context.send(obj_type.pluralize).where(migration_id:).first)
        return item.id
      end

NOT_FOUND
    end
  end
end

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 migrator.rb	RB	5.6 KB	2023-09-24 03:36	EDIT
📄 service_interface.rb	RB	2.4 KB	2023-09-24 03:36	EDIT
📄 translator.rb	RB	4.1 KB	2023-09-24 03:36	EDIT