Skip to content

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

4.3 KB
Raw Blame
# frozen_string_literal: true

class SidebarSection < ActiveRecord::Base
  include Localizable

  MAX_TITLE_LENGTH = 30
  MAX_USER_CATEGORY_LINKS = 100

  belongs_to :user
  has_many :sidebar_section_links, -> { order("position") }, dependent: :destroy

  has_many :sidebar_urls,
           through: :sidebar_section_links,
           source: :linkable,
           source_type: "SidebarUrl"

  accepts_nested_attributes_for :sidebar_urls,
                                allow_destroy: true,
                                limit: -> { SiteSetting.max_sidebar_section_links }
  accepts_nested_attributes_for :localizations, allow_destroy: true

  before_validation :set_default_locale
  before_save :set_system_user_for_public_section

  validates :title,
            presence: true,
            uniqueness: {
              scope: %i[user_id],
            },
            length: {
              maximum: MAX_TITLE_LENGTH,
            }

  validates :locale, presence: true, length: { maximum: 20 }
  validate :sidebar_urls_count_within_limit, on: :sidebar_section_update

  scope :public_sections, -> { where("public") }
  scope :custom_sections, -> { where(section_type: nil) }
  enum :section_type, { community: 0 }, scopes: false, suffix: true

  def custom_section?
    section_type.blank?
  end

  def community_section?
    section_type == "community"
  end

  def reset_community!
    ActiveRecord::Base.transaction do
      update!(title: "Community")
      sidebar_section_links.destroy_all
      community_urls =
        SidebarUrl::COMMUNITY_SECTION_LINKS.map do |url_data|
          "('#{url_data[:name]}', '#{url_data[:path]}', '#{url_data[:icon]}', '#{url_data[:segment]}', false, now(), now())"
        end

      result = DB.query <<~SQL
      INSERT INTO sidebar_urls(name, value, icon, segment, external, created_at, updated_at)
      VALUES #{community_urls.join(",")}
      RETURNING sidebar_urls.id
      SQL

      sidebar_section_links =
        result.map.with_index do |url, index|
          "(-1, #{url.id}, 'SidebarUrl', #{id}, #{index},  now(), now())"
        end

      DB.query <<~SQL
      INSERT INTO sidebar_section_links(user_id, linkable_id, linkable_type, sidebar_section_id, position, created_at, updated_at)
      VALUES #{sidebar_section_links.join(",")}
      SQL
    end
  end

  # Renumbers the section's links so they read in `ordered_linkable_ids` order.
  # Links the caller left out are pushed to the end.
  def apply_links_order!(ordered_linkable_ids)
    links = sidebar_section_links.reload.to_a
    return if links.empty?

    rank = ordered_linkable_ids.each_with_index.to_h
    reordered = links.sort_by { |link| rank.fetch(link.linkable_id, rank.size) }

    rows =
      reordered.zip(free_positions(links)).map { |link, position| link.attributes.merge(position:) }

    sidebar_section_links.upsert_all(rows, update_only: [:position])
  end

  private

  # Positions no link in the section currently holds, in ascending order.
  #
  # `upsert_all` writes every row in one statement, and a unique index covers
  # (sidebar_section_id, user_id, position). Reusing a position another link
  # still holds collides before that row is rewritten. Twice the link count
  # always leaves enough free ones.
  def free_positions(links)
    (0..links.size * 2).to_a - links.map(&:position)
  end

  def sidebar_urls_count_within_limit
    count = sidebar_urls.reject(&:marked_for_destruction?).size
    persisted_count = sidebar_urls.count(&:persisted?)
    limit = SiteSetting.max_sidebar_section_links
    return if count <= [limit, persisted_count].max

    errors.add(:base, :too_many_sidebar_urls, limit:, count:)
  end

  def set_system_user_for_public_section
    self.user_id = Discourse.system_user.id if public
  end

  def set_default_locale
    self.locale = SiteSetting.default_locale.to_s if locale.blank?
  end
end

# == Schema Information
#
# Table name: sidebar_sections
#
#  id           :bigint           not null, primary key
#  locale       :string(20)
#  public       :boolean          default(FALSE), not null
#  section_type :integer
#  title        :string(30)       not null
#  created_at   :datetime         not null
#  updated_at   :datetime         not null
#  user_id      :integer          not null
#
# Indexes
#
#  index_sidebar_sections_on_section_type       (section_type) UNIQUE
#  index_sidebar_sections_on_user_id_and_title  (user_id,title) UNIQUE
#