Skip to content

A platform for community discussion. Free, open, simple.

10.1 KB
Raw Blame
# frozen_string_literal: true

# mixin for all Guardian methods dealing with user permissions
module UserGuardian
  AVATAR_TYPES_WITH_UPLOAD = %w[uploaded custom gravatar current]

  def can_edit_avatar?(target_user)
    can_edit?(target_user) && !SiteSetting.auth_overrides_avatar &&
      !SiteSetting.discourse_connect_overrides_avatar
  end

  def can_pick_avatar_source?(target_user, type)
    return false unless can_edit_avatar?(target_user)

    case type
    when "system"
      return true
    when *AVATAR_TYPES_WITH_UPLOAD
      return false if type == "gravatar" && !SiteSetting.gravatar_enabled?

      return true if target_user.is_system_user?

      return target_user.in_any_groups?(SiteSetting.uploaded_avatars_allowed_groups_map)
    when "associated_account"
      unless target_user.in_any_groups?(SiteSetting.uploaded_avatars_allowed_groups_map)
        return false
      end
    else
      return false
    end

    case SiteSetting.selectable_avatars_mode
    when "no_one"
      false
    when "staff"
      target_user.staff?
    when /\Atl([1-4])\z/
      target_user.staff? || target_user.trust_level >= Regexp.last_match(1).to_i
    else
      true
    end
  end

  def can_claim_reviewable_topic?(topic, automatic = false)
    (SiteSetting.reviewable_claiming != "disabled" || automatic) && can_review_topic?(topic)
  end

  def can_pick_avatar?(user_avatar, upload)
    return false unless user
    return true if is_admin?
    # can always pick blank avatar
    return true if !upload
    return true if user_avatar.user.uploaded_avatar_id == upload.id
    return true if user_avatar.contains_upload?(upload.id)
    return true if upload.user_id == user_avatar.user_id || is_my_own?(upload)

    UserUpload.exists?(upload_id: upload.id, user_id: user.id)
  end

  def can_edit_user?(user)
    is_me?(user) || is_staff?
  end

  def can_edit_username?(user)
    return false if SiteSetting.auth_overrides_username?
    return true if is_staff?
    return false if SiteSetting.username_change_period <= 0
    return false if is_anonymous?
    is_me?(user) && user.created_at > SiteSetting.username_change_period.days.ago
  end

  def can_edit_email?(user)
    return false if SiteSetting.auth_overrides_email?
    return false unless SiteSetting.email_editable?
    return true if is_admin?
    return false if is_anonymous?
    return false if is_moderator? && !is_me?(user)

    can_edit?(user)
  end

  def can_edit_name?(user)
    return false if SiteSetting.auth_overrides_name?
    return true if is_admin?
    return false unless SiteSetting.enable_names?
    return true if is_moderator?
    return false if is_anonymous?
    can_edit?(user)
  end

  def can_see_notifications?(user)
    is_me?(user) || is_admin?
  end

  def can_see_bookmarks?(user)
    is_me?(user) || is_admin?
  end

  def can_silence_user?(user)
    user && is_staff? && not(user.staff?)
  end

  def can_unsilence_user?(user)
    user && is_staff? && (!user.staff? || is_admin?)
  end

  def can_delete_user?(user)
    return false if user.nil? || user.admin?

    if is_me?(user)
      return false if SiteSetting.enable_discourse_connect

      return !user.has_more_posts_than?(SiteSetting.delete_user_self_max_post_count)
    end

    return false unless is_staff?
    return false if user.moderator? && !is_admin?
    return true if user.first_post_created_at.nil?
    return true unless user.has_more_posts_than?(User::MAX_STAFF_DELETE_POST_COUNT)

    user.first_post_created_at > SiteSetting.delete_user_max_post_age.to_i.days.ago
  end

  def can_anonymize_user?(user)
    is_staff? && !user.nil? && !user.staff? && !user.email&.ends_with?(UserAnonymizer::EMAIL_SUFFIX)
  end

  def can_merge_user?(user)
    is_admin? && !user.nil? && !user.staff?
  end

  def can_merge_users?(source_user, target_user)
    can_merge_user?(source_user) && !target_user.nil? && source_user.id != target_user.id
  end

  def can_see_warnings?(user)
    user && (is_me?(user) || is_staff?)
  end

  def can_reset_bounce_score?(user)
    user && is_staff?
  end

  def can_check_emails?(user)
    is_admin? || (is_staff? && SiteSetting.moderators_view_emails)
  end

  def can_check_sso_details?(user)
    user && (is_admin? || (is_moderator? && SiteSetting.moderators_view_sso_details))
  end

  def can_check_sso_email?(user)
    user && is_admin?
  end

  def can_check_sso_payload?(user)
    user && is_admin?
  end

  def restrict_user_fields?(user)
    (user.trust_level == TrustLevel[0] && anonymous?) || !can_see_profile?(user)
  end

  def can_see_staff_info?(user)
    user && is_staff?
  end

  def can_see_suspension_reason?(user)
    return true unless SiteSetting.hide_suspension_reasons?
    is_me?(user) || is_staff?
  end

  def can_see_silencing_reason?(user)
    return true unless SiteSetting.hide_silencing_reasons?
    is_me?(user) || is_staff?
  end

  def can_see_user_status?(user)
    return false if user.blank?
    return false if user.user_option&.hide_profile?

    if user.silenced?
      is_me?(user) || is_staff?
    else
      true
    end
  end

  def can_disable_second_factor?(user)
    user && can_administer_user?(user)
  end

  def can_see_user?(_user)
    true
  end

  def can_search_staged_users?(user_directory_search: false)
    is_staff? || (user_directory_search == true && SiteSetting.enable_user_directory?)
  end

  def public_can_see_profiles?
    !SiteSetting.hide_user_profiles_from_public || !anonymous?
  end

  def can_see_profile?(user)
    return false if user.blank?
    return false unless public_can_see_profiles?
    return true if is_me?(user) || is_staff?

    profile_hidden = SiteSetting.allow_users_to_hide_profile && user.user_option&.hide_profile?

    return true if user.staff? && !profile_hidden

    if SiteSetting.hide_new_user_profiles && !SiteSetting.invite_only &&
         !SiteSetting.must_approve_users
      if (user.user_stat.blank? || user.user_stat.post_count == 0) &&
           !user.has_trust_level?(TrustLevel[2])
        return false if anonymous? || !@user.has_trust_level?(TrustLevel[2])
      end

      if anonymous? || !@user.has_trust_level?(TrustLevel[1])
        return user.has_trust_level?(TrustLevel[1]) && !profile_hidden
      end
    end

    !profile_hidden
  end

  def can_see_user_actions?(user, action_types = [])
    return true if !@user.anonymous? && (is_me?(user) || is_admin?)
    return false if SiteSetting.hide_user_activity_tab?
    (action_types & UserAction.private_types).empty?
  end

  def allowed_user_field_ids(user)
    @allowed_user_field_ids ||= {}

    is_staff_or_is_me = is_staff? || is_me?(user)
    cache_key = is_staff_or_is_me ? :staff_or_me : :other

    @allowed_user_field_ids[cache_key] ||= if is_staff_or_is_me
      UserField.pluck(:id)
    else
      UserField.where("show_on_profile OR show_on_user_card").pluck(:id)
    end
  end

  def can_feature_topic?(user, topic)
    return false if topic.nil?
    return false if !SiteSetting.allow_featured_topic_on_user_profiles?
    return false if !is_me?(user) && !is_staff?
    return false if !topic.visible
    return false if topic.read_restricted_category? || topic.private_message?
    true
  end

  def can_see_review_queue?
    return true if is_staff?
    return false if !category_group_moderation_allowed? || !@user.category_group_moderator?

    Reviewable
      .joins(
        "INNER JOIN category_moderation_groups ON category_moderation_groups.category_id = reviewables.category_id",
      )
      .where(
        category_id: allowed_category_ids,
        "category_moderation_groups.group_id": @user.group_users.pluck(:group_id),
      )
      .exists?
  end

  def can_see_summary_stats?(target_user)
    true
  end

  def can_upload_profile_header?(user)
    (is_me?(user) && user.in_any_groups?(SiteSetting.profile_background_allowed_groups_map)) ||
      is_staff?
  end

  def can_upload_user_card_background?(user)
    (is_me?(user) && user.in_any_groups?(SiteSetting.user_card_background_allowed_groups_map)) ||
      is_staff?
  end

  def can_upload_external?
    !ExternalUploadManager.user_banned?(user)
  end

  def can_delete_sso_record?(user)
    SiteSetting.enable_discourse_connect && user && is_admin?
  end

  def can_delete_user_associated_accounts?(user)
    user && is_admin?
  end

  def can_change_tracking_preferences?(user)
    (SiteSetting.allow_changing_staged_user_tracking || !user.staged) && can_edit_user?(user)
  end

  def can_create_theme?
    return false if !is_admin?
    # this modifier is used to further restrict theme creation, it's not
    # possible to use this modifier to open up theme creation permissions (e.g.
    # to non-admins)
    DiscoursePluginRegistry.apply_modifier(:user_guardian_can_create_theme, true, self)
  end

  def can_edit_theme?(theme)
    return false if !is_admin? || theme.blank?
    # theme imports and maintenance tasks run as the system user and have to
    # apply a theme in full, so plugin restrictions don't apply to them
    return true if @user.is_system_user?
    # like the creation modifier, this one can only further restrict which
    # themes can be changed or deleted
    DiscoursePluginRegistry.apply_modifier(:user_guardian_can_edit_theme, true, self, theme)
  end

  # Including a component in a theme, or removing it, changes where the
  # component's code runs, so both sides of the change have to be editable.
  def can_edit_theme_relations?(theme, child_theme_ids: nil, parent_theme_ids: nil)
    return false if !can_edit_theme?(theme)

    changed_ids = []
    if !child_theme_ids.nil?
      changed_ids.concat(changed_theme_ids(theme.child_theme_ids, child_theme_ids))
    end
    if !parent_theme_ids.nil?
      changed_ids.concat(changed_theme_ids(theme.parent_theme_ids, parent_theme_ids))
    end
    return true if changed_ids.empty?

    Theme.where(id: changed_ids.uniq).all? { |related| can_edit_theme?(related) }
  end

  def can_create_color_scheme?
    return false if !is_admin?
    # like the theme modifiers, this one can only further restrict palette creation
    DiscoursePluginRegistry.apply_modifier(:user_guardian_can_create_color_scheme, true, self)
  end

  private

  def changed_theme_ids(current_ids, new_ids)
    new_ids = Array(new_ids).map(&:to_i)
    (current_ids - new_ids) | (new_ids - current_ids)
  end
end