zammad/app/helpers/knowledge_base_helper.rb

# Copyright (C) 2012-2024 Zammad Foundation, https://zammad-foundation.org/

module KnowledgeBaseHelper
  def effective_layout_name(knowledge_base, object)
    layout_prefix = object.present? ? :category : :homepage

    knowledge_base.send(:"#{layout_prefix}_layout")
  end

  def custom_path_if_needed(path, knowledge_base, full: false)
    return path if !knowledge_base.custom_address_matches?(request)

    custom_path(path, knowledge_base, full:)
  end

  def custom_path(path, knowledge_base, full: false)
    custom_address = knowledge_base.custom_address_uri
    return path if !custom_address

    custom_path = knowledge_base.custom_address_path(path)
    prefix      = full ? knowledge_base.custom_address_prefix(request) : ''

    "#{prefix}#{custom_path}"
  end

  def translation_locale_code(translation)
    translation.kb_locale.system_locale.locale
  end

  def edit_kb_link_label(object)
    suffix = case object
             when KnowledgeBase::Answer
               'answer'
             when KnowledgeBase::Category
               'category'
             when KnowledgeBase
               'knowledge base'
             end

    "edit #{suffix}"
  end

  def build_kb_link(object)
    locale = params.fetch(:locale, object.translation.kb_locale)

    path = case object
           when KnowledgeBase::Answer
             "knowledge_base/#{object.category.knowledge_base.id}/locale/#{locale}/answer/#{object.id}/edit"
           when KnowledgeBase::Category
             "knowledge_base/#{object.knowledge_base.id}/locale/#{locale}/category/#{object.id}/edit"
           when KnowledgeBase
             "knowledge_base/#{object.id}/locale/#{locale}/edit"
           end

    build_zammad_link path
  end

  def build_zammad_link(path)
    host, port = Setting.get('fqdn').split ':'
    scheme     = Setting.get('http_type')

    URI::Generic
      .build(host: host, scheme: scheme, port: port, fragment: path)
      .to_s
  end

  def dropdown_menu_direction
    system_locale_via_uri.dir == 'ltr' ? 'right' : 'left'
  end

  def canonical_link_tag(knowledge_base, *objects)
    path = kb_public_system_path(*objects)

    tag.link(rel: 'canonical', href: knowledge_base.canonical_url(path))
  end

  def kb_public_system_path(*objects)
    objects
      .compact
      .map { |elem| elem.is_a?(HasTranslations) ? elem.translation.to_param : elem }
      .unshift(help_root_path)
      .join('/')
  end

  def feeds_available(knowledge_base, parent_category, current_object)
    feeds = [{
      title: knowledge_base.translations.first.title,
      url:   custom_path_if_needed(help_root_feed_url, knowledge_base)
    }]

    effective_category = [current_object, parent_category].find { |elem| elem.is_a? KnowledgeBase::Category }

    if effective_category
      feeds << {
        title: effective_category.translations.first.title,
        url:   custom_path_if_needed(help_category_feed_url(system_locale_via_uri.locale, effective_category), knowledge_base)
      }
    end

    feeds
  end
end