openproject/app/models/project_custom_field.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.
#++

class ProjectCustomField < CustomField
  belongs_to :project_custom_field_section, class_name: "ProjectCustomFieldSection", foreign_key: :custom_field_section_id,
                                            inverse_of: :custom_fields
  has_many :project_custom_field_project_mappings, class_name: "ProjectCustomFieldProjectMapping", foreign_key: :custom_field_id,
                                                   dependent: :destroy, inverse_of: :project_custom_field
  has_many :projects, through: :project_custom_field_project_mappings

  acts_as_list column: :position_in_custom_field_section, scope: [:custom_field_section_id]

  after_save :activate_required_field_in_all_projects, if: :is_for_all?

  validates :custom_field_section_id, presence: true

  # Relevant for user fields to allow membership assignment
  has_one :custom_fields_role, foreign_key: :custom_field_id, dependent: :destroy, inverse_of: :custom_field
  has_one :role, through: :custom_fields_role
  accepts_nested_attributes_for :custom_fields_role, allow_destroy: true

  scopes :visible

  scope :user_field_with_assigned_role, -> do
    joins(:custom_fields_role)
      .where.not(custom_fields_roles: { role_id: nil })
      .where(field_format: "user")
  end

  class << self
    def visible(user = User.current, project: nil)
      if user.active_admin?
        all
      elsif user.allowed_in_any_project?(:select_project_custom_fields) || user.allowed_globally?(:add_project)
        where(admin_only: false)
      else
        where(admin_only: false).where(mappings_with_view_project_attributes_permission(user, project).exists)
      end
    end

    def toggleable_ids_in_project_settings(project, user, custom_field_section_id)
      toggleable_ids(
        project:,
        user:,
        custom_field_section_id:,
        options: { is_for_all: false }
      ).first
    end

    def toggleable_ids_in_creation_wizard_settings(project, custom_field_section_id)
      toggleable_ids(
        project:,
        custom_field_section_id:,
        options: { is_required: false },
        invert_options: { is_required: true }
      )
    end

    private

    # Returns an array with:
    # 1. a list of custom field ids that can be toggled = activated/enabled or disabled/deactivated.
    # 2. a list of custom field ids that cannot be toggled and should always be active/enabled.
    def toggleable_ids(project:, custom_field_section_id:, user: User.current, options: {}, invert_options: {})
      base_cf_query = visible(user, project:)
                        .where(custom_field_section_id:)

      # Fetch project custom field ids that can be enabled/disabled
      mutable_cf_ids = base_cf_query.where(**options).pluck(:id)

      # Consider project custom fields that are configured for the project creation wizard as immutable
      immutable_cf_ids = if project.project_creation_wizard_enabled?
                           [project.project_creation_wizard_assignee_custom_field_id]
                         else
                           []
                         end

      always_active = if invert_options.present?
                        base_cf_query.where(**invert_options).pluck(:id)
                      else
                        []
                      end

      [mutable_cf_ids - immutable_cf_ids, immutable_cf_ids + always_active]
    end

    def mappings_with_view_project_attributes_permission(user, project) # rubocop:disable Metrics/AbcSize
      allowed_projects = Project.allowed_to(user, :view_project_attributes)
      mapping_table = ProjectCustomFieldProjectMapping.arel_table

      mapping_condition = mapping_table[:custom_field_id].eq(arel_table[:id])
                          .and(mapping_table[:project_id].in(allowed_projects.select(:id).arel))

      if project&.persisted?
        mapping_condition = mapping_condition.and(mapping_table[:project_id].eq(project.id))
      end

      mapping_table.project(Arel.star).where(mapping_condition)
    end
  end

  def visible?(usr = User.current, project: nil)
    self.class.visible(usr, project:).exists?(id: id)
  end

  def type_name
    :label_project_plural
  end

  def role_id
    role&.id
  end

  def role=(role)
    self.role_id = role&.id
  end

  def role_id=(role_id)
    if role_id.present?
      build_custom_fields_role unless custom_fields_role
      custom_fields_role.role_id = role_id
    else
      custom_fields_role&.mark_for_destruction
    end
  end

  def activate_required_field_in_all_projects
    ProjectCustomFieldProjectMapping.upsert_all(
      Project.pluck(:id).map { |project_id| { project_id:, custom_field_id: id } },
      unique_by: %i[custom_field_id project_id]
    )
  end
end