canvas-lms/lib/sis/abstract_course_importer.rb

94 lines
3.9 KiB
Ruby

# 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 SIS
class AbstractCourseImporter < BaseImporter
def process
importer = Work.new(@batch, @root_account, @logger)
AbstractCourse.process_as_sis(@sis_options) do
yield importer
end
importer.abstract_courses_to_update_sis_batch_id.in_groups_of(1000, false) do |batch|
AbstractCourse.where(id: batch).update_all(sis_batch_id: @batch.id)
end
SisBatchRollBackData.bulk_insert_roll_back_data(importer.roll_back_data)
importer.success_count
end
class Work
attr_accessor :success_count, :abstract_courses_to_update_sis_batch_id, :roll_back_data
def initialize(batch, root_account, logger)
@batch = batch
@root_account = root_account
@abstract_courses_to_update_sis_batch_id = []
@roll_back_data = []
@logger = logger
@success_count = 0
end
def add_abstract_course(abstract_course_id, short_name, long_name, status, term_id = nil, account_id = nil, fallback_account_id = nil)
raise ImportError, "No abstract_course_id given for an abstract course" if abstract_course_id.blank?
raise ImportError, "No short_name given for abstract course #{abstract_course_id}" if short_name.blank?
raise ImportError, "No long_name given for abstract course #{abstract_course_id}" if long_name.blank?
raise ImportError, "Improper status \"#{status}\" for abstract course #{abstract_course_id}" unless /\Aactive|\Adeleted/i.match?(status)
return if @batch.skip_deletes? && status =~ /deleted/i
course = AbstractCourse.find_by(root_account_id: @root_account, sis_source_id: abstract_course_id)
course ||= AbstractCourse.new
unless course.stuck_sis_fields.include?(:enrollment_term_id)
course.enrollment_term = @root_account.enrollment_terms.find_by(sis_source_id: term_id) || @root_account.default_enrollment_term
end
course.root_account = @root_account
account = nil
account = @root_account.all_accounts.find_by(sis_source_id: account_id) if account_id.present?
account ||= @root_account.all_accounts.find_by(sis_source_id: fallback_account_id) if fallback_account_id.present?
course.account = account if account
course.account ||= @root_account
# only update the name/short_name on new records, and ones that haven't been changed
# since the last sis import
course.name = long_name if long_name.present? && (course.new_record? || !course.stuck_sis_fields.include?(:name))
course.short_name = short_name if short_name.present? && (course.new_record? || !course.stuck_sis_fields.include?(:short_name))
course.sis_source_id = abstract_course_id
case status
when /active/i
course.workflow_state = "active"
when /deleted/i
course.workflow_state = "deleted"
end
if course.changed?
course.sis_batch_id = @batch.id
course.save!
data = SisBatchRollBackData.build_data(sis_batch: @batch, context: course)
@roll_back_data << data if data
else
@abstract_courses_to_update_sis_batch_id << course.id
end
@success_count += 1
end
end
end
end