Skip to content

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

5.6 KB
Raw Blame
# frozen_string_literal: true

class CategorySerializer < SiteCategorySerializer
  include BasicCategoryAttributes

  class CategorySettingSerializer < ApplicationSerializer
    attributes :auto_bump_cooldown_days,
               :num_auto_bump_daily,
               :require_reply_approval,
               :require_topic_approval,
               :nested_replies_default,
               :topic_posting_review_mode,
               :reply_posting_review_mode
  end

  class CategoryLocalizationSerializer < ApplicationSerializer
    attributes :id, :locale, :name, :description
  end

  attributes :locale,
             :read_restricted,
             :available_groups,
             :permission_groups,
             :allowed_tags,
             :allowed_tag_groups,
             :auto_close_hours,
             :auto_close_based_on_last_post,
             :group_permissions,
             :position,
             :email_in,
             :email_in_allow_strangers,
             :mailinglist_mirror,
             :all_topics_wiki,
             :allow_unlimited_owner_edits_on_first_post,
             :can_delete,
             :cannot_delete_reason,
             :is_special,
             :allow_badges,
             :custom_fields,
             :topic_featured_link_allowed,
             :search_priority,
             :moderating_group_ids,
             :topic_posting_review_group_ids,
             :reply_posting_review_group_ids,
             :default_slow_mode_seconds,
             :style_type,
             :emoji,
             :icon,
             :category_type_settings,
             :available_category_types

  has_one :category_setting, serializer: CategorySettingSerializer, embed: :objects
  has_many :category_localizations, serializer: CategoryLocalizationSerializer, embed: :objects

  def include_moderating_group_ids?
    SiteSetting.enable_category_group_moderation?
  end

  def include_category_setting?
    object.association(:category_setting).loaded?
  end

  def group_permissions
    @group_permissions ||=
      begin
        perms =
          object
            .category_groups
            .joins(:group)
            .includes(:group)
            .merge(
              Group.visible_groups(
                scope&.user,
                "groups.name ASC",
                include_everyone: true,
                include_pseudogroups: true,
              ),
            )
            .map do |cg|
              {
                permission_type: cg.permission_type,
                group_name: cg.group.name,
                group_id: cg.group_id,
              }
            end

        if perms.length == 0 && !object.read_restricted && !object.category_groups.exists?
          perms << {
            permission_type: CategoryGroup.permission_types[:full],
            group_name: Group[:everyone]&.name.presence || :everyone,
            group_id: Group::AUTO_GROUPS[:everyone],
          }
        end

        perms
      end
  end

  def can_edit_category?
    scope && scope.can_edit?(object)
  end

  def include_group_permissions?
    can_edit_category?
  end

  def include_available_groups?
    can_edit_category?
  end

  def include_permission_groups?
    can_edit_category?
  end

  def permission_groups
    # NOTE (martin): When we are moving category permissions fully to use ACLs,
    # or when the everyone pseudogroup permission UC becomes permanent, we will
    # need to include anonymous_users
    Group
      .visible_groups(
        scope.user,
        "groups.name ASC",
        include_everyone: true,
        include_pseudogroups: true,
      )
      .where.not(id: Group::AUTO_GROUPS[:anonymous_users])
      .pluck(:id, :name)
      .map { |id, name| { id: id, name: name } }
  end

  def available_groups
    Group.order(:name).pluck(:name) - group_permissions.map { |g| g[:group_name] }
  end

  def can_delete
    true
  end

  def include_is_special?
    object.special?
  end

  def is_special
    true
  end

  def include_can_delete?
    scope && scope.can_delete?(object)
  end

  def include_cannot_delete_reason?
    !include_can_delete? && can_edit_category?
  end

  def include_email_in?
    can_edit_category?
  end

  def include_email_in_allow_strangers?
    can_edit_category?
  end

  def include_notification_level?
    scope && scope.user
  end

  def notification_level
    user = scope && scope.user
    object.notification_level ||
      (user && CategoryUser.where(user: user, category: object).first.try(:notification_level)) ||
      CategoryUser.default_notification_level
  end

  def custom_fields
    object.custom_fields
  end

  def include_custom_fields?
    true
  end

  def name
    category_name
  end

  def description
    category_description
  end

  def include_category_type_settings?
    can_edit_category?
  end

  def category_type_settings
    Categories::TypeRegistry
      .all
      .values
      .reduce({}) do |result, type_klass|
        next result unless type_klass.category_matches?(object)
        result.merge(type_klass.read_category_settings(object))
      end
  end

  def include_available_category_types?
    can_edit_category?
  end

  def available_category_types
    Categories::TypeRegistry.list(only_visible: true, guardian: scope)
  end

  def include_allowed_tags?
    can_edit_tags?
  end

  def allowed_tags
    object.tags.map { |tag| { id: tag.id, name: tag.name, slug: tag.slug } }
  end

  def include_allowed_tag_groups?
    SiteSetting.tagging_enabled
  end

  def allowed_tag_groups
    return object.tag_groups.map(&:name) if can_edit_tags?

    TagGroup.visible(scope || Guardian.new).where(id: object.tag_groups.map(&:id)).pluck(:name)
  end
end