Anjing Webshells

Website : rimsha.abasa.com
: / var / canvas / lib / cc /
Filename : assignment_resources.rb
back
# frozen_string_literal: true

#
# Copyright (C) 2011 - 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 CC
  module AssignmentResources
    def add_assignments
      # @user is nil if it's kicked off by the system, like a course template
      relation = @user ? Assignments::ScopedToUser.new(@course, @user).scope : @course.active_assignments
      relation.no_submittables.each do |assignment|
        next if @course.assignments.where(id: assignment.id).type_quiz_lti.present? &&
                Account.site_admin.feature_enabled?(:new_quizzes_common_cartridge) &&
                @manifest.exporter.common_cartridge?

        next unless export_object?(assignment)
        next if @user && assignment.locked_for?(@user, check_policies: true)

        title = assignment.title || I18n.t("course_exports.unknown_titles.assignment", "Unknown assignment")

        unless assignment.can_copy?(@user)
          add_error(I18n.t("course_exports.errors.assignment_is_locked", "The assignment \"%{title}\" could not be copied because it is locked.", title:))
          next
        end

        begin
          add_assignment(assignment)
        rescue
          add_error(I18n.t("course_exports.errors.assignment", "The assignment \"%{title}\" failed to export", title:), $!)
        end
      end
    end

    VERSION_1_3 = Gem::Version.new("1.3")

    def add_assignment(assignment)
      add_exported_asset(assignment)

      # Student Annotation assignments need to include the attachment they're using
      add_item_to_export(assignment.annotatable_attachment) if assignment.annotated_document?
      if assignment.external_tool?
        add_item_to_export(ContextExternalTool.from_content_tag(assignment.external_tool_tag, assignment.context))
      end
      migration_id = create_key(assignment)

      lo_folder = File.join(@export_dir, migration_id)
      FileUtils.mkdir_p lo_folder

      file_name = "#{assignment.title.to_url}.html"
      path = File.join(lo_folder, file_name)
      html_path = File.join(migration_id, file_name)

      # Write the assignment description as an .html file
      # That way at least the content of the assignment will appear
      # for agents that support neither CC 1.3 nor Canvas assignments
      File.open(path, "w") do |file|
        file << @html_exporter.html_page(assignment.description || "", "Assignment: " + assignment.title)
      end

      if Gem::Version.new(@manifest.cc_version) >= VERSION_1_3
        add_cc_assignment(assignment, migration_id, lo_folder, html_path)
      else
        add_canvas_assignment(assignment, migration_id, lo_folder, html_path)
      end
    end

    def add_cc_assignment(assignment, migration_id, lo_folder, html_path)
      File.open(File.join(lo_folder, CCHelper::ASSIGNMENT_XML), "w") do |assignment_file|
        document = Builder::XmlMarkup.new(target: assignment_file, indent: 2)
        document.instruct!

        document.assignment("identifier" => migration_id,
                            "xmlns" => CCHelper::ASSIGNMENT_NAMESPACE,
                            "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance",
                            "xsi:schemaLocation" => "#{CCHelper::ASSIGNMENT_NAMESPACE} #{CCHelper::ASSIGNMENT_XSD_URI}") do |a|
          AssignmentResources.create_cc_assignment(a, assignment, migration_id, @html_exporter, @manifest)
        end
      end

      xml_path = File.join(migration_id, CCHelper::ASSIGNMENT_XML)
      @resources.resource(identifier: migration_id,
                          type: CCHelper::ASSIGNMENT_TYPE,
                          href: xml_path) do |res|
        res.file(href: xml_path)
      end

      @resources.resource(identifier: migration_id + "_fallback",
                          type: CCHelper::WEBCONTENT) do |res|
        res.tag!("cpx:variant",
                 identifier: migration_id + "_variant",
                 identifierref: migration_id) do |var|
          var.tag!("cpx:metadata")
        end
        res.file(href: html_path)
      end
    end

    def add_canvas_assignment(assignment, migration_id, lo_folder, html_path)
      assignment_file = File.new(File.join(lo_folder, CCHelper::ASSIGNMENT_SETTINGS), "w")
      document = Builder::XmlMarkup.new(target: assignment_file, indent: 2)
      document.instruct!

      # Save all the meta-data into a canvas-specific xml schema
      document.assignment("identifier" => migration_id,
                          "xmlns" => CCHelper::CANVAS_NAMESPACE,
                          "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance",
                          "xsi:schemaLocation" => "#{CCHelper::CANVAS_NAMESPACE} #{CCHelper::XSD_URI}") do |a|
        AssignmentResources.create_canvas_assignment(a, assignment, @manifest)
      end
      assignment_file.close

      @resources.resource(
        :identifier => migration_id,
        "type" => CCHelper::LOR,
        :href => html_path
      ) do |res|
        res.file(href: html_path)
        res.file(href: File.join(migration_id, CCHelper::ASSIGNMENT_SETTINGS))
      end
    end

    SUBMISSION_TYPE_MAP = {
      "online_text_entry" => "html",
      "online_url" => "url",
      "online_upload" => "file"
    }.freeze

    def self.create_cc_assignment(node, assignment, migration_id, html_exporter, manifest = nil)
      node.title(assignment.title)
      node.text(html_exporter.html_content(assignment.description), texttype: "text/html")
      if assignment.points_possible
        node.gradable(assignment.graded?, points_possible: assignment.points_possible)
      else
        node.gradable(assignment.graded?)
      end
      node.submission_formats do |fmt|
        assignment.submission_types.split(",").each do |st|
          if (cc_type = SUBMISSION_TYPE_MAP[st])
            fmt.format(type: cc_type)
          end
        end
      end
      node.extensions do |ext|
        ext.assignment("identifier" => migration_id + "_canvas",
                       "xmlns" => CCHelper::CANVAS_NAMESPACE,
                       "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance",
                       "xsi:schemaLocation" => "#{CCHelper::CANVAS_NAMESPACE} #{CCHelper::XSD_URI}") do |a|
          AssignmentResources.create_canvas_assignment(a, assignment, manifest)
        end
      end
    end

    def self.create_tool_setting_node(tool_setting, node)
      node.tool_setting do |ts_node|
        ts_node.tool_proxy({
                             product_code: tool_setting.product_code,
                             vendor_code: tool_setting.vendor_code,
                             tool_proxy_guid: tool_setting.tool_proxy&.guid
                           })

        if tool_setting.custom.present?
          ts_node.custom do |custom_node|
            tool_setting.custom.each do |k, v|
              custom_node.property({ name: k }, v)
            end
          end
        end

        if tool_setting.custom_parameters.present?
          ts_node.custom_parameters do |custom_params_node|
            tool_setting.custom_parameters.each do |k, v|
              custom_params_node.property({ name: k }, v)
            end
          end
        end
      end
    end

    def self.create_canvas_assignment(node, assignment, manifest = nil)
      key_generator = manifest || CCHelper
      node.title assignment.title
      node.time_zone_edited assignment.time_zone_edited unless assignment.time_zone_edited.blank?
      node.due_at CCHelper.ims_datetime(assignment.due_at, nil)
      node.lock_at CCHelper.ims_datetime(assignment.lock_at, nil)
      node.unlock_at CCHelper.ims_datetime(assignment.unlock_at, nil)
      if manifest && manifest.try(:user).present?
        node.module_locked assignment.locked_by_module_item?(manifest.user, deep_check_if_needed: true).present?
      end
      node.all_day_date CCHelper.ims_date(assignment.all_day_date) if assignment.all_day_date
      node.peer_reviews_due_at CCHelper.ims_datetime(assignment.peer_reviews_due_at) if assignment.peer_reviews_due_at
      node.assignment_group_identifierref key_generator.create_key(assignment.assignment_group) if assignment.assignment_group && (!manifest || manifest.export_object?(assignment.assignment_group))
      if assignment.grading_standard && !(Account.site_admin.feature_enabled?(:archived_grading_schemes) && !assignment.grading_standard.active?)
        if assignment.grading_standard.context == assignment.context
          node.grading_standard_identifierref key_generator.create_key(assignment.grading_standard) if !manifest || manifest.export_object?(assignment.grading_standard)
        else
          node.grading_standard_external_identifier assignment.grading_standard.id
        end
      end
      node.workflow_state assignment.workflow_state
      if assignment.rubric
        assoc = assignment.active_rubric_association? ? assignment.rubric_association : nil
        node.rubric_identifierref key_generator.create_key(assignment.rubric)
        if assignment.rubric && assignment.rubric.context != assignment.context
          node.rubric_external_identifier assignment.rubric.id
        end
        node.rubric_use_for_grading assoc.use_for_grading
        node.rubric_hide_points !!assoc.hide_points
        node.rubric_hide_outcome_results !!assoc.hide_outcome_results
        node.rubric_hide_score_total !!assoc.hide_score_total
        if assoc.summary_data && assoc.summary_data[:saved_comments]
          node.saved_rubric_comments do |sc_node|
            assoc.summary_data[:saved_comments].each_pair do |key, vals|
              vals.each do |val|
                sc_node.comment(criterion_id: key) { |a| a << val }
              end
            end
          end
        end
      end
      node.assignment_overrides do |ao_node|
        # Quizzes export their own overrides
        assignment.assignment_overrides.active.where(set_type: "Noop", quiz_id: nil).each do |o|
          override_attrs = o.slice(:set_type, :set_id, :title)
          AssignmentOverride.overridden_dates.each do |field|
            next unless o.send(:"#{field}_overridden")

            override_attrs[field] = o[field]
          end
          ao_node.override(override_attrs)
        end
      end
      node.quiz_identifierref key_generator.create_key(assignment.quiz) if assignment.quiz
      node.allowed_extensions assignment.allowed_extensions&.join(",")
      node.has_group_category assignment.has_group_category?
      node.group_category assignment.group_category.try :name if assignment.group_category
      atts = %i[points_possible
                grading_type
                all_day
                submission_types
                position
                turnitin_enabled
                vericite_enabled
                peer_review_count
                peer_reviews
                automatic_peer_reviews
                anonymous_peer_reviews
                grade_group_students_individually
                freeze_on_copy
                omit_from_final_grade
                hide_in_gradebook
                intra_group_peer_reviews
                only_visible_to_overrides
                post_to_sis
                moderated_grading
                grader_count
                grader_comments_visible_to_graders
                anonymous_grading
                graders_anonymous_to_graders
                grader_names_visible_to_final_grader
                anonymous_instructor_annotations
                allowed_attempts]
      atts.each do |att|
        node.tag!(att, assignment.send(att)) if assignment.send(att) == false || assignment.send(att).present?
      end
      if assignment.external_tool_tag
        if (content = assignment.external_tool_tag.content) && content.is_a?(ContextExternalTool)
          if content.context == assignment.context
            node.external_tool_identifierref key_generator.create_key(content)
          else
            node.external_tool_external_identifier content.id
          end
        end
        node.external_tool_url assignment.external_tool_tag.url
        node.external_tool_data_json assignment.external_tool_tag.external_data.to_json if assignment.external_tool_tag.external_data
        node.external_tool_link_settings_json assignment.external_tool_tag.link_settings.to_json if assignment.external_tool_tag.link_settings
        node.external_tool_new_tab assignment.external_tool_tag.new_tab

        # Exporting the lookup_id allows Canvas to rebind
        # the custom params to the assignment on import.
        resource_link = assignment.primary_resource_link
        node.resource_link_lookup_uuid resource_link.lookup_uuid if resource_link.present?
      end

      node.tag!(:turnitin_settings, assignment.send(:turnitin_settings).to_json) if assignment.turnitin_enabled || assignment.vericite_enabled
      if assignment.assignment_configuration_tool_lookup_ids.present?
        resource_codes = assignment.tool_settings_tool.try(:resource_codes) || {}
        node.similarity_detection_tool({
                                         resource_type_code: resource_codes[:resource_type_code],
                                         vendor_code: resource_codes[:vendor_code],
                                         product_code: resource_codes[:product_code],
                                         visibility: assignment.turnitin_settings.with_indifferent_access[:originality_report_visibility]
                                       })

        tool_setting = Lti::ToolSetting.find_by(
          resource_link_id: assignment.lti_context_id
        )

        if tool_setting.present?
          AssignmentResources.create_tool_setting_node(tool_setting, node)
        end
      end

      if assignment.post_policy.present?
        node.post_policy { |policy| policy.post_manually(assignment.post_policy.post_manually?) }
      end

      if assignment.line_items.any?
        node.line_items do |line_items_node|
          assignment.line_items.find_each do |line_item|
            add_line_item(line_items_node, line_item, assignment) if line_item.active?
          end
        end
      end

      if assignment.annotated_document? && assignment.annotatable_attachment
        node.annotatable_attachment_migration_id(key_generator.create_key(assignment.annotatable_attachment))
      end
    end

    def self.add_line_item(line_items_node, line_item, assignment)
      line_items_node.line_item do |li_node|
        li_node.coupled line_item.coupled
        li_node.tag line_item.tag if line_item.tag
        li_node.resource_id line_item.resource_id if line_item.resource_id
        li_node.extensions line_item.extensions.to_json if line_item.extensions.present?

        # Include client ID if cannot be inferred from a tool tag (happens
        # with AGS-created assignment with submission_types=none)
        if line_item.client_id && !assignment.external_tool_tag
          li_node.client_id line_item.client_id
        end

        # Include label & score_maximum if they are different from assignment's
        # (should only happen in the case of multiple line items)
        li_node.label line_item.label if line_item.label != assignment.name
        if line_item.score_maximum != assignment.points_possible
          li_node.score_maximum line_item.score_maximum
        end
      end
    end
  end
end