member.rb

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2024 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 Member < ApplicationRecord
  include ::Scopes::Scoped

  ALLOWED_ENTITIES = [
    "WorkPackage",
    "Queries::Projects::ProjectQuery"
  ].freeze

  extend DeprecatedAlias
  belongs_to :principal, foreign_key: "user_id", inverse_of: "members", optional: false
  belongs_to :entity, polymorphic: true, optional: true
  belongs_to :project, optional: true

  has_many :member_roles, dependent: :destroy, autosave: true, validate: false
  has_many :roles, -> { distinct }, through: :member_roles
  has_many :oauth_client_tokens, foreign_key: :user_id, primary_key: :user_id, dependent: nil # rubocop:disable Rails/InverseOf

  validates :user_id, uniqueness: { scope: %i[project_id entity_type entity_id] }
  validates :entity_type, inclusion: { in: ALLOWED_ENTITIES, allow_blank: true }

  validate :validate_presence_of_role
  validate :validate_presence_of_principal

  scopes :assignable,
         :global,
         :not_locked,
         :of_project,
         :of_any_project,
         :of_work_package,
         :of_any_work_package,
         :of_any_entity,
         :of_anything_in_project,
         :visible,
         :with_shared_work_packages_info,
         :without_inherited_roles

  delegate :name, to: :principal

  def to_s
    name
  end

  deprecated_alias :user, :principal
  deprecated_alias :user=, :principal=

  def <=>(other)
    a = roles.min
    b = other.roles.min
    a == b ? (principal <=> other.principal) : (a <=> b)
  end

  def deletable?
    member_roles.none?(&:inherited_from?)
  end

  def some_roles_deletable?
    !member_roles.all?(&:inherited_from?)
  end

  def project_role?
    entity_id.nil? && project_id.present?
  end

  def deletable_role?(role)
    member_roles
      .only_inherited
      .where(role:)
      .none?
  end

  def include?(principal)
    if user?
      self.principal == principal
    else
      !principal.nil? && principal.groups.include?(principal)
    end
  end

  ##
  # Returns true if this user can be deleted as they have no other memberships
  # and haven't been activated yet. Only applies if the member is actually a user
  # as opposed to a group.
  def disposable?
    user? && principal&.invited? && principal.memberships.none? { |m| m.project_id != project_id }
  end

  def self.can_be_member_of?(entity_or_class)
    checked_class = if entity_or_class.is_a?(Class)
                      entity_or_class.name
                    else
                      entity_or_class.class.name
                    end

    ALLOWED_ENTITIES.include?(checked_class)
  end

  protected

  attr_accessor :prune_watchers_on_destruction

  def validate_presence_of_role
    if (member_roles.empty? && roles.empty?) ||
       member_roles.all? do |member_role|
         member_role.marked_for_destruction? || member_role.destroyed?
       end

      errors.add :roles, :role_blank
    end
  end

  def validate_presence_of_principal
    errors.add :base, :principal_blank if principal.blank?
  end

  private

  def user?
    principal.is_a?(User)
  end
end