SWAMPy

✎ CARVE FLESH

EDITING: lti_user_creator.rb

# frozen_string_literal: true

#
# Copyright (C) 2014 - 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
  class LtiUserCreator
    # deprecated mapping
    ENROLLMENT_MAP = {
      StudentEnrollment => LtiOutbound::LTIRoles::ContextNotNamespaced::LEARNER,
      TeacherEnrollment => LtiOutbound::LTIRoles::ContextNotNamespaced::INSTRUCTOR,
      TaEnrollment => LtiOutbound::LTIRoles::ContextNotNamespaced::TEACHING_ASSISTANT,
      DesignerEnrollment => LtiOutbound::LTIRoles::ContextNotNamespaced::CONTENT_DEVELOPER,
      ObserverEnrollment => LtiOutbound::LTIRoles::ContextNotNamespaced::OBSERVER,
      AccountUser => LtiOutbound::LTIRoles::Institution::ADMIN,
      StudentViewEnrollment => LtiOutbound::LTIRoles::ContextNotNamespaced::LEARNER
    }.freeze

def initialize(canvas_user, canvas_root_account, canvas_tool, canvas_context)
      @canvas_user = canvas_user
      @canvas_root_account = canvas_root_account
      @canvas_tool = canvas_tool
      @canvas_context = canvas_context
      @opaque_identifier = @canvas_tool.opaque_identifier_for(@canvas_user, context: @canvas_context)
    end

def convert
      lti_helper = Lti::SubstitutionsHelper.new(@canvas_context, @canvas_root_account, @canvas_user, @canvas_tool)
      user = ::LtiOutbound::LTIUser.new
      user.id = @canvas_user.id
      user.avatar_url = @canvas_user.avatar_url
      user.email = lti_helper.email
      user.first_name = @canvas_user.first_name
      user.last_name = @canvas_user.last_name
      user.name = @canvas_user.name
      user.opaque_identifier = @opaque_identifier
      user.timezone = Time.zone.tzinfo.name
      user.currently_active_in_course = -> { currently_active_in_course? }
      user.concluded_roles = -> { concluded_roles }
      user.login_id = -> { pseudonym ? pseudonym.unique_id : nil }
      user.sis_source_id = -> { pseudonym ? pseudonym.sis_user_id : nil }
      user.current_observee_ids = -> { current_course_observee_lti_context_ids }
      user.current_roles = lti_helper.current_lis_roles.split(",")

user
    end

private

def pseudonym
      @pseudonym ||= SisPseudonym.for(@canvas_user, @canvas_context, type: :trusted, require_sis: false, root_account: @canvas_root_account)
    end

def current_roles
      map_enrollments_to_roles(current_course_enrollments + current_account_enrollments)
    end

def currently_active_in_course?
      current_course_enrollments.any? { |membership| membership.state_based_on_date == :active } if @canvas_context.is_a?(Course)
    end

def concluded_roles
      map_enrollments_to_roles(concluded_course_enrollments)
    end

def map_enrollments_to_roles(enrollments)
      enrollments.map { |enrollment| ENROLLMENT_MAP[enrollment.class] }.uniq
    end

def current_course_enrollments
      return Enrollment.none unless @canvas_context.is_a?(Course)

@current_course_enrollments ||= @canvas_user.enrollments.current.where(course_id: @canvas_context).preload(:enrollment_state, :sis_pseudonym)
    end

def current_course_observee_lti_context_ids
      return [] unless @canvas_context.is_a?(Course)

@current_course_observee_lti_context_ids ||= @canvas_user.observer_enrollments
                                                               .current
                                                               .where(course_id: @canvas_context)
                                                               .preload(:associated_user)
                                                               .filter_map { |e| e.try(:associated_user).try(:lti_context_id) }
    end

def current_account_enrollments
      @current_account_enrollments ||= if @canvas_context.respond_to?(:account_chain) && !@canvas_context.account_chain.empty?
                                         @canvas_user.account_users.active.where(account_id: @canvas_context.account_chain).distinct.to_a
                                       else
                                         []
                                       end
      @current_account_enrollments
    end

def concluded_course_enrollments
      @concluded_course_enrollments ||=
        @canvas_context.is_a?(Course) ? @canvas_user.enrollments.concluded.where(course_id: @canvas_context).to_a : []
    end
  end
end

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 content_migration_service/	DIR	—	2023-09-24 03:36
📁 ims/	DIR	—	2023-09-24 03:36
📄 analytics_service.rb	RB	2.7 KB	2023-09-24 03:36	EDIT
📄 caliper_service.rb	RB	1 KB	2023-09-24 03:36	EDIT
📄 content_migration_service.rb	RB	1.7 KB	2023-09-24 03:36	EDIT
📄 launch.rb	RB	2 KB	2023-09-24 03:36	EDIT
📄 line_item.rb	RB	5 KB	2023-09-24 03:36	EDIT
📄 link.rb	RB	1.5 KB	2023-09-24 03:36	EDIT
📄 logout_service.rb	RB	3.4 KB	2023-09-24 03:36	EDIT
📄 lti_account_creator.rb	RB	1.6 KB	2023-09-24 03:36	EDIT
📄 lti_advantage_adapter.rb	RB	9 KB	2023-09-24 03:36	EDIT
📄 lti_assignment_creator.rb	RB	1.5 KB	2023-09-24 03:36	EDIT
📄 lti_context_creator.rb	RB	2.3 KB	2023-09-24 03:36	EDIT
📄 lti_outbound_adapter.rb	RB	5.9 KB	2023-09-24 03:36	EDIT
📄 lti_tool_creator.rb	RB	1.6 KB	2023-09-24 03:36	EDIT
📄 lti_user_creator.rb	RB	4.8 KB	2023-09-24 03:36	EDIT
📄 message_handler.rb	RB	4.3 KB	2023-09-24 03:36	EDIT
📄 navigation_cache.rb	RB	1.1 KB	2023-09-24 03:36	EDIT
📄 product_family.rb	RB	1.1 KB	2023-09-24 03:36	EDIT
📄 registration_request_service.rb	RB	2.1 KB	2023-09-24 03:36	EDIT
📄 resource_handler.rb	RB	2 KB	2023-09-24 03:36	EDIT
📄 resource_link.rb	RB	3.3 KB	2023-09-24 03:36	EDIT
📄 resource_placement.rb	RB	4.5 KB	2023-09-24 03:39	EDIT
📄 result.rb	RB	4.4 KB	2023-09-24 03:36	EDIT
📄 tool_configuration.rb	RB	7.7 KB	2023-09-24 03:39	EDIT
📄 tool_consumer_profile.rb	RB	4.1 KB	2023-09-24 03:36	EDIT
📄 tool_consumer_profile_creator.rb	RB	4.7 KB	2023-09-24 03:36	EDIT
📄 tool_proxy.rb	RB	9.9 KB	2023-09-24 03:36	EDIT
📄 tool_proxy_binding.rb	RB	949 B	2023-09-24 03:36	EDIT
📄 tool_proxy_service.rb	RB	8.8 KB	2023-09-24 03:36	EDIT
📄 tool_setting.rb	RB	2 KB	2023-09-24 03:36	EDIT
📄 xapi_service.rb	RB	998 B	2023-09-24 03:36	EDIT