2019-06-04 03:40:48 +00:00
|
|
|
# Copyright (C) 2012-2016 Zammad Foundation, http://zammad-foundation.org/
|
|
|
|
class KnowledgeBase < ApplicationModel
|
|
|
|
include HasTranslations
|
|
|
|
include HasAgentAllowedParams
|
|
|
|
include ChecksKbClientNotification
|
|
|
|
|
|
|
|
AGENT_ALLOWED_NESTED_RELATIONS = %i[translations].freeze
|
|
|
|
|
|
|
|
LAYOUTS = %w[grid list].freeze
|
|
|
|
ICONSETS = %w[FontAwesome anticon material ionicons Simple-Line-Icons].freeze
|
|
|
|
|
|
|
|
has_many :kb_locales, class_name: 'KnowledgeBase::Locale',
|
|
|
|
inverse_of: :knowledge_base,
|
|
|
|
dependent: :destroy
|
|
|
|
|
|
|
|
accepts_nested_attributes_for :kb_locales, allow_destroy: true
|
|
|
|
validates :kb_locales, presence: true
|
|
|
|
validates :kb_locales, length: { maximum: 1 }, unless: :multi_lingual_support?
|
|
|
|
|
|
|
|
has_many :categories, class_name: 'KnowledgeBase::Category',
|
|
|
|
inverse_of: :knowledge_base,
|
|
|
|
dependent: :restrict_with_exception
|
|
|
|
|
|
|
|
has_many :answers, through: :categories
|
|
|
|
|
|
|
|
validates :category_layout, inclusion: { in: KnowledgeBase::LAYOUTS }
|
|
|
|
validates :homepage_layout, inclusion: { in: KnowledgeBase::LAYOUTS }
|
|
|
|
|
|
|
|
validates :color_highlight, presence: true
|
|
|
|
validates :color_header, presence: true
|
|
|
|
validates :iconset, inclusion: { in: KnowledgeBase::ICONSETS }
|
|
|
|
|
|
|
|
scope :active, -> { where(active: true) }
|
|
|
|
|
|
|
|
scope :check_active_unless_editor, lambda { |user|
|
|
|
|
return if user&.permissions? 'knowledge_base.editor'
|
|
|
|
|
|
|
|
active
|
|
|
|
}
|
|
|
|
|
|
|
|
alias assets_essential assets
|
|
|
|
|
|
|
|
def assets(data)
|
|
|
|
return data if assets_added_to?(data)
|
|
|
|
|
|
|
|
data = super(data)
|
|
|
|
ApplicationModel::CanAssets.reduce(kb_locales + translations, data)
|
|
|
|
end
|
|
|
|
|
|
|
|
# assets without unnecessary bits
|
|
|
|
def assets_public(data)
|
|
|
|
data = assets_essential(data)
|
|
|
|
|
|
|
|
data[:KnowledgeBase].each do |_, elem|
|
|
|
|
elem.delete_if do |k, _|
|
|
|
|
k.match?(/_ids$/)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
data
|
|
|
|
end
|
|
|
|
|
|
|
|
def custom_address_uri
|
|
|
|
return nil if custom_address.blank?
|
|
|
|
|
|
|
|
URI("protocol://#{custom_address}")
|
|
|
|
rescue URI::InvalidURIError
|
|
|
|
nil
|
|
|
|
end
|
|
|
|
|
|
|
|
def custom_address_matches?(request)
|
|
|
|
uri = custom_address_uri
|
|
|
|
|
|
|
|
return false if uri.blank?
|
|
|
|
|
|
|
|
given_fqdn = request.headers.env['SERVER_NAME']&.downcase
|
|
|
|
given_path = request.headers.env['HTTP_X_ORIGINAL_URL']&.downcase
|
|
|
|
|
|
|
|
# original url header not present, server not configured
|
|
|
|
return false if given_path.nil?
|
|
|
|
|
|
|
|
# path doesn't match
|
|
|
|
return false if uri.path.downcase != given_path[0, uri.path.length]
|
|
|
|
|
|
|
|
# domain present, but doesn't match
|
|
|
|
return false if uri.host.present? && uri.host.downcase != given_fqdn
|
|
|
|
|
|
|
|
true
|
|
|
|
rescue URI::InvalidURIError
|
|
|
|
false
|
|
|
|
end
|
|
|
|
|
|
|
|
def full_destroy!
|
|
|
|
ChecksKbClientNotification.disable_in_all_classes!
|
|
|
|
|
|
|
|
transaction do
|
|
|
|
# get all categories with their children and reverse to delete children first
|
|
|
|
categories.root.map(&:self_with_children).flatten.reverse.each(&:full_destroy!)
|
|
|
|
translations.each(&:destroy!)
|
|
|
|
kb_locales.each(&:destroy!)
|
|
|
|
destroy!
|
|
|
|
end
|
|
|
|
ensure
|
|
|
|
ChecksKbClientNotification.enable_in_all_classes!
|
|
|
|
end
|
|
|
|
|
|
|
|
def visible?
|
|
|
|
active?
|
|
|
|
end
|
|
|
|
|
|
|
|
def api_url
|
|
|
|
Rails.application.routes.url_helpers.knowledge_base_path(self)
|
|
|
|
end
|
|
|
|
|
|
|
|
def load_category(locale, id)
|
|
|
|
categories.localed(locale).find_by(id: id)
|
|
|
|
end
|
|
|
|
|
|
|
|
def self.with_multiple_locales_exists?
|
|
|
|
KnowledgeBase
|
|
|
|
.active
|
|
|
|
.joins(:kb_locales)
|
|
|
|
.group('knowledge_bases.id')
|
2019-10-28 15:38:14 +00:00
|
|
|
.pluck(Arel.sql('COUNT(knowledge_base_locales.id) as locales_count'))
|
2019-06-04 03:40:48 +00:00
|
|
|
.any? { |e| e > 1 }
|
|
|
|
end
|
|
|
|
|
|
|
|
private
|
|
|
|
|
|
|
|
def set_defaults
|
|
|
|
self.translations = kb_locales.map do |kb_locale|
|
|
|
|
name = Setting.get('organization').presence || Setting.get('product_name').presence || 'Zammad'
|
|
|
|
kb_suffix = ::Translation.translate kb_locale.system_locale.locale, 'Knowledge Base'
|
|
|
|
|
|
|
|
KnowledgeBase::Translation.new(
|
|
|
|
title: "#{name} #{kb_suffix}",
|
|
|
|
footer_note: "© #{name}",
|
|
|
|
kb_locale: kb_locale
|
|
|
|
)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
after_create :set_defaults
|
|
|
|
|
|
|
|
def validate_custom_address
|
|
|
|
return if custom_address.nil?
|
|
|
|
|
|
|
|
# not domain, but no leading slash
|
|
|
|
if !custom_address.include?('.') && custom_address[0] != '/'
|
2019-06-05 15:44:29 +00:00
|
|
|
errors.add(:custom_address, 'must begin with a slash ("/").')
|
2019-06-04 03:40:48 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
if custom_address.include?('://')
|
2019-06-05 15:44:29 +00:00
|
|
|
errors.add(:custom_address, 'must not include a protocol (e.g., "http://" or "https://").')
|
2019-06-04 03:40:48 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
if custom_address.last == '/'
|
2019-06-05 15:44:29 +00:00
|
|
|
errors.add(:custom_address, 'must not end with a slash ("/").')
|
2019-06-04 03:40:48 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
if custom_address == '/' # rubocop:disable Style/GuardClause
|
|
|
|
errors.add(:custom_address, 'Please enter valid path or domain')
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
validate :validate_custom_address
|
|
|
|
|
|
|
|
def patch_custom_address
|
|
|
|
self.custom_address = nil if custom_address == ''
|
|
|
|
end
|
|
|
|
|
|
|
|
before_validation :patch_custom_address
|
|
|
|
|
|
|
|
def multi_lingual_support?
|
|
|
|
Setting.get 'kb_multi_lingual_support'
|
|
|
|
end
|
|
|
|
|
|
|
|
def set_kb_active_setting
|
|
|
|
Setting.set 'kb_active', KnowledgeBase.active.exists?
|
|
|
|
CanBePublished.update_active_publicly!
|
|
|
|
end
|
|
|
|
|
|
|
|
after_save :set_kb_active_setting
|
|
|
|
after_destroy :set_kb_active_setting
|
|
|
|
end
|