openproject/app/controllers/scim_v2/groups_controller.rb

# frozen_string_literal: true

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) the OpenProject GmbH
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2013 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
#
# See COPYRIGHT and LICENSE files for more details.
#++

module ScimV2
  class GroupsController < Scimitar::ResourcesController
    include BaseControllerActions

    before_action :remove_breaking_fields_from_params, only: %i[create replace]

    def create
      super do |scim_resource|
        storage_class.transaction do
          group = storage_class.new
          group.from_scim!(scim_hash: scim_resource.as_json)
          call = Groups::CreateService
                   .new(user: User.current, model: group)
                   .call(group.attributes)
          raise_result_errors_for_scim(call)
          group = call.result
          members = scim_resource.members
          if members.present?
            raise_result_errors_for_scim(
              Groups::AddUsersService
                .new(group, current_user: User.system)
                .call(ids: members.map(&:value), send_notifications: false)
            )
          end

          group.to_scim(
            location: url_for(action: :show, id: group.id),
            include_attributes:
          )
        end
      end
    end

    def replace
      super do |group_id, scim_resource|
        storage_class.transaction do
          group = storage_scope.find(group_id)
          group.from_scim!(scim_hash: scim_resource.as_json)
          raise_result_errors_for_scim(
            Groups::UpdateService
              .new(user: User.current, model: group)
              .call(replace_user_ids: scim_resource.members&.map(&:value))
          )
          group.reload
          group.to_scim(
            location: url_for(action: :show, id: group.id),
            include_attributes:
          )
        end
      end
    end

    def update
      super do |group_id, patch_hash|
        storage_class.transaction do
          group = storage_scope.find(group_id)
          group.from_scim_patch!(patch_hash: patch_hash)
          user_ids = group.scim_members.map(&:id)
          raise_result_errors_for_scim(
            Groups::UpdateService
              .new(user: User.current, model: group)
              .call(replace_user_ids: user_ids)
          )
          group.reload
          group.to_scim(
            location: url_for(action: :show, id: group.id),
            include_attributes:
          )
        end
      end
    end

    def destroy
      super do |group_id|
        group = storage_scope.find(group_id)
        raise_result_errors_for_scim(
          Groups::DeleteService
            .new(user: User.current, model: group)
            .call
        )
      end
    end

    protected

    def storage_class
      Group
    end

    def storage_scope
      Group
        .left_joins(:users, :user_auth_provider_links)
        .includes(:users, :user_auth_provider_links)
        .not_builtin
    end

    private

    # There is a bug in scimitar gem.
    # When "$ref" sub-attribute is present then scim_reosource cannot be intialized
    # Firstly it fails because $ref is not part of the schema.
    # Secondly if it has been added to the schema then "$ref" cannot be a parameter for `attr_accessor` call.
    # Hopefully helpful code links:
    # 1. https://github.com/pond/scimitar/blob/09b284778340ee067df9e5140d0230386afb9992/app/controllers/scimitar/resources_controller.rb#L176C25-L176C38
    # 2. https://github.com/pond/scimitar/blob/09b284778340ee067df9e5140d0230386afb9992/app/models/scimitar/schema/derived_attributes.rb#L13C13-L13C42
    #
    # Therefore, before scimitar accepts "$ref" sub-attributes we just remove them from payload.
    def remove_breaking_fields_from_params
      params[:members]&.each { |member| member.delete("$ref") }
    end
  end
end