canvas-lms/lib/brand_config_helpers.rb

# frozen_string_literal: true

#
# Copyright (C) 2015 - present Instructure, Inc.
#
# This file is part of Canvas.
#
# Canvas is free software: you can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the Free
# Software Foundation, version 3 of the License.
#
# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.

module BrandConfigHelpers
  def branding_allowed?
    root_account? || root_account.sub_account_includes?
  end

  def effective_brand_config
    md5 = Rails.cache.fetch_with_batched_keys("effective_brand_config_md5", batch_object: self, batched_keys: [:account_chain, :brand_config]) do
      brand_config_chain(include_self: true).select(&:branding_allowed?).find(&:brand_config_md5)&.brand_config_md5
    end
    # ensure the BrandConfig query hits the correct shard
    shard.activate do
      md5 && BrandConfig.find_cached_by_md5(md5)
    end
  end

  def first_parent_brand_config
    brand_config_chain(include_self: false).find(&:brand_config_md5).try(:brand_config)
  end

  private

  def brand_config_chain(include_self:)
    chain = self.account_chain(include_site_admin: true).dup
    chain.shift unless include_self
    chain.select! { |a| a.shard == self.shard }
    chain
  end
end