Class: Theme

Inherits:
ActiveRecord::Base
  • Object
show all
Includes:
GlobalPath
Defined in:
app/models/theme.rb

Constant Summary collapse

BASE_COMPILER_VERSION = 
76

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from GlobalPath

#cdn_path, #cdn_relative_path, #full_cdn_url, #path, #upload_cdn_path

Instance Attribute Details

#child_components ⇒ Object

Returns the value of attribute child_components.



11
12
13
 
# File 'app/models/theme.rb', line 11

def child_components
  @child_components
end

Class Method Details

.allowed_remote_theme_ids ⇒ Object 



232
233
234
235
236
237
238
239
 
# File 'app/models/theme.rb', line 232

def self.allowed_remote_theme_ids
  return nil if GlobalSetting.allowed_theme_repos.blank?

  get_set_cache "allowed_remote_theme_ids" do
    urls = GlobalSetting.allowed_theme_repos.split(",").map(&:strip)
    Theme.joins(:remote_theme).where("remote_themes.remote_url in (?)", urls).pluck(:id)
  end
end

.cache ⇒ Object 



13
14
15
 
# File 'app/models/theme.rb', line 13

def self.cache
  @cache ||= DistributedCache.new("theme:compiler:#{BASE_COMPILER_VERSION}")
end

.clear_cache! ⇒ Object 



368
369
370
 
# File 'app/models/theme.rb', line 368

def self.clear_cache!
  cache.clear
end

.clear_default! ⇒ Object 



256
257
258
259
 
# File 'app/models/theme.rb', line 256

def self.clear_default!
  SiteSetting.default_theme_id = -1
  expire_site_cache!
end

.compiler_version ⇒ Object 



191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'app/models/theme.rb', line 191

def self.compiler_version
  get_set_cache "compiler_version" do
    dependencies = [
      BASE_COMPILER_VERSION,
      EmberCli.ember_version,
      GlobalSetting.cdn_url,
      GlobalSetting.s3_cdn_url,
      GlobalSetting.s3_endpoint,
      GlobalSetting.s3_bucket,
      Discourse.current_hostname,
    ]
    Digest::SHA1.hexdigest(dependencies.join)
  end
end

.components_for(theme_id) ⇒ Object 



241
242
243
244
245
 
# File 'app/models/theme.rb', line 241

def self.components_for(theme_id)
  get_set_cache "theme_components_for_#{theme_id}" do
    ChildTheme.where(parent_theme_id: theme_id).pluck(:child_theme_id)
  end
end

.expire_site_cache! ⇒ Object 



247
248
249
250
251
252
253
254
 
# File 'app/models/theme.rb', line 247

def self.expire_site_cache!
  Site.clear_anon_cache!
  clear_cache!
  ApplicationSerializer.expire_cache_fragment!("user_themes")
  ColorScheme.hex_cache.clear
  CSP::Extension.clear_theme_extensions_cache!
  SvgSprite.expire_cache
end

.get_set_cache(key, &blk) ⇒ Object 



206
207
208
 
# File 'app/models/theme.rb', line 206

def self.get_set_cache(key, &blk)
  cache.defer_get_set(key, &blk)
end

.is_parent_theme?(id) ⇒ Boolean

Returns:

  • (Boolean) 


222
223
224
 
# File 'app/models/theme.rb', line 222

def self.is_parent_theme?(id)
  self.parent_theme_ids.include?(id)
end

.list_baked_fields(theme_ids, target, name) ⇒ Object 



499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'app/models/theme.rb', line 499

def self.list_baked_fields(theme_ids, target, name)
  target = target.to_sym
  name = name&.to_sym

  if target == :translations
    fields = ThemeField.find_first_locale_fields(theme_ids, I18n.fallbacks[name])
  else
    target = :mobile if target == :mobile_theme
    target = :desktop if target == :desktop_theme
    fields =
      ThemeField.find_by_theme_ids(theme_ids).where(
        target_id: [Theme.targets[target], Theme.targets[:common]],
      )
    fields = fields.where(name: name.to_s) unless name.nil?
    fields = fields.order(:target_id)
  end

  fields.each(&:ensure_baked!)
  fields
end

.lookup_field(theme_id, target, field, skip_transformation: false) ⇒ Object 



349
350
351
352
353
354
 
# File 'app/models/theme.rb', line 349

def self.lookup_field(theme_id, target, field, skip_transformation: false)
  return "" if theme_id.blank?

  theme_ids = !skip_transformation ? transform_ids(theme_id) : [theme_id]
  (resolve_baked_field(theme_ids, target.to_sym, field) || "").html_safe
end

.lookup_modifier(theme_ids, modifier_name) ⇒ Object 



356
357
358
359
360
361
362
 
# File 'app/models/theme.rb', line 356

def self.lookup_modifier(theme_ids, modifier_name)
  theme_ids = [theme_ids] unless theme_ids.is_a?(Array)

  get_set_cache("#{theme_ids.join(",")}:modifier:#{modifier_name}:#{Theme.compiler_version}") do
    ThemeModifierSet.resolve_modifier_for_themes(theme_ids, modifier_name)
  end
end

.lookup_target(target_id) ⇒ Object 



386
387
388
 
# File 'app/models/theme.rb', line 386

def self.lookup_target(target_id)
  self.targets.invert[target_id]
end

.notify_theme_change(theme_ids, with_scheme: false, clear_manager_cache: true, all_themes: false) ⇒ Object 



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'app/models/theme.rb', line 390

def self.notify_theme_change(
  theme_ids,
  with_scheme: false,
  clear_manager_cache: true,
  all_themes: false
)
  Stylesheet::Manager.clear_theme_cache!
  targets = %i[mobile_theme desktop_theme]

  if with_scheme
    targets.prepend(:desktop, :mobile, :admin)
    targets.append(*Discourse.find_plugin_css_assets(mobile_view: true, desktop_view: true))
    Stylesheet::Manager.cache.clear if clear_manager_cache
  end

  if all_themes
    message = theme_ids.map { |id| refresh_message_for_targets(targets, id) }.flatten
  else
    message = refresh_message_for_targets(targets, theme_ids).flatten
  end

  MessageBus.publish("/file-change", message)
end

.parent_theme_ids ⇒ Object 



216
217
218
219
220
 
# File 'app/models/theme.rb', line 216

def self.parent_theme_ids
  get_set_cache "parent_theme_ids" do
    Theme.where(component: false).pluck(:id)
  end
end

.refresh_message_for_targets(targets, theme_ids) ⇒ Object 



421
422
423
424
425
426
427
428
429
 
# File 'app/models/theme.rb', line 421

def self.refresh_message_for_targets(targets, theme_ids)
  theme_ids = [theme_ids] unless theme_ids.is_a?(Array)

  targets.each_with_object([]) do |target, data|
    theme_ids.each do |theme_id|
      data << Stylesheet::Manager.new(theme_id: theme_id).stylesheet_data(target.to_sym)
    end
  end
end

.remove_from_cache! ⇒ Object 



364
365
366
 
# File 'app/models/theme.rb', line 364

def self.remove_from_cache!
  clear_cache!
end

.resolve_baked_field(theme_ids, target, name) ⇒ Object 



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'app/models/theme.rb', line 431

def self.resolve_baked_field(theme_ids, target, name)
  target = target.to_sym
  name = name&.to_sym

  target = :mobile if target == :mobile_theme
  target = :desktop if target == :desktop_theme

  case target
  when :extra_js
    get_set_cache("#{theme_ids.join(",")}:extra_js:#{Theme.compiler_version}") do
      require_rebake =
        ThemeField.where(theme_id: theme_ids, target_id: Theme.targets[:extra_js]).where(
          "compiler_version <> ?",
          Theme.compiler_version,
        )

      ActiveRecord::Base.transaction do
        require_rebake.each { |tf| tf.ensure_baked! }

        Theme.where(id: require_rebake.map(&:theme_id)).each(&:update_javascript_cache!)
      end

      caches =
        JavascriptCache
          .where(theme_id: theme_ids)
          .index_by(&:theme_id)
          .values_at(*theme_ids)
          .compact

      caches.map { |c| <<~HTML.html_safe }.join("\n")
        <link rel="preload" href="#{c.url}" as="script">
        <script defer src='#{c.url}' data-theme-id='#{c.theme_id}'></script>
      HTML
    end
  when :translations
    theme_field_values(theme_ids, :translations, I18n.fallbacks[name])
      .to_a
      .select(&:second)
      .uniq { |((theme_id, _, _), _)| theme_id }
      .flat_map(&:second)
      .join("\n")
  else
    theme_field_values(theme_ids, [:common, target], name).values.compact.flatten.join("\n")
  end
end

.targets ⇒ Object 



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'app/models/theme.rb', line 372

def self.targets
  @targets ||=
    Enum.new(
      common: 0,
      desktop: 1,
      mobile: 2,
      settings: 3,
      translations: 4,
      extra_scss: 5,
      extra_js: 6,
      tests_js: 7,
    )
end

.theme_field_values(theme_ids, targets, names) ⇒ Object 



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'app/models/theme.rb', line 477

def self.theme_field_values(theme_ids, targets, names)
  cache.defer_get_set_bulk(
    Array(theme_ids).product(Array(targets), Array(names)),
    lambda do |(theme_id, target, name)|
      "#{theme_id}:#{target}:#{name}:#{Theme.compiler_version}"
    end,
  ) do |keys|
    keys = keys.map { |theme_id, target, name| [theme_id, Theme.targets[target], name.to_s] }

    keys
      .map do |theme_id, target_id, name|
        ThemeField.where(theme_id: theme_id, target_id: target_id, name: name)
      end
      .inject { |a, b| a.or(b) }
      .each(&:ensure_baked!)
      .map { |tf| [[tf.theme_id, tf.target_id, tf.name], tf.value_baked || tf.value] }
      .group_by(&:first)
      .transform_values { |x| x.map(&:second) }
      .values_at(*keys)
  end
end

.theme_ids ⇒ Object 



210
211
212
213
214
 
# File 'app/models/theme.rb', line 210

def self.theme_ids
  get_set_cache "theme_ids" do
    Theme.pluck(:id)
  end
end

.transform_ids(id) ⇒ Object 



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'app/models/theme.rb', line 261

def self.transform_ids(id)
  return [] if id.blank?
  id = id.to_i

  get_set_cache "transformed_ids_#{id}" do
    all_ids =
      if self.is_parent_theme?(id)
        components = components_for(id).tap { |c| c.sort!.uniq! }
        [id, *components]
      else
        [id]
      end

    disabled_ids =
      Theme
        .where(id: all_ids)
        .includes(:remote_theme)
        .select { |t| !t.supported? || !t.enabled? }
        .map(&:id)

    all_ids - disabled_ids
  end
end

.user_theme_ids ⇒ Object 



226
227
228
229
230
 
# File 'app/models/theme.rb', line 226

def self.user_theme_ids
  get_set_cache "user_theme_ids" do
    Theme.user_selectable.pluck(:id)
  end
end

Instance Method Details

#add_relative_theme!(kind, theme) ⇒ Object 



596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
 
# File 'app/models/theme.rb', line 596

def add_relative_theme!(kind, theme)
  new_relation =
    if kind == :child
      child_theme_relation.new(child_theme_id: theme.id)
    else
      parent_theme_relation.new(parent_theme_id: theme.id)
    end
  if new_relation.save
    child_themes.reload
    parent_themes.reload
    save!
    Theme.clear_cache!
  else
    raise Discourse::InvalidParameters.new(new_relation.errors.full_messages.join(", "))
  end
end

#baked_js_tests_with_digest ⇒ Object 



853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
 
# File 'app/models/theme.rb', line 853

def baked_js_tests_with_digest
  tests_tree =
    theme_fields
      .where(target_id: Theme.targets[:tests_js])
      .order(name: :asc)
      .pluck(:name, :value)
      .to_h

  return nil, nil if tests_tree.blank?

  compiler = ThemeJavascriptCompiler.new(id, name)
  compiler.append_tree(tests_tree, for_tests: true)
  compiler.append_raw_script "test_setup.js", <<~JS
    (function() {
      require("discourse/lib/theme-settings-store").registerSettings(#{self.id}, #{cached_default_settings.to_json}, { force: true });
    })();
  JS
  content = compiler.content

  if compiler.source_map
    content +=
      "\n//# sourceMappingURL=data:application/json;base64,#{Base64.strict_encode64(compiler.source_map)}\n"
  end

  [content, Digest::SHA1.hexdigest(content)]
end

#build_local_theme_uploads_hash ⇒ Object 



694
695
696
697
698
699
700
 
# File 'app/models/theme.rb', line 694

def build_local_theme_uploads_hash
  hash = {}
  upload_fields.each do |field|
    hash[field.name] = field.javascript_cache.local_url if field.javascript_cache
  end
  hash
end

#build_settings_hash ⇒ Object 



673
674
675
676
677
678
679
680
681
682
683
684
 
# File 'app/models/theme.rb', line 673

def build_settings_hash
  hash = {}
  self.settings.each { |setting| hash[setting.name] = setting.value }

  theme_uploads = build_theme_uploads_hash
  hash["theme_uploads"] = theme_uploads if theme_uploads.present?

  theme_uploads_local = build_local_theme_uploads_hash
  hash["theme_uploads_local"] = theme_uploads_local if theme_uploads_local.present?

  hash
end

#build_theme_uploads_hash ⇒ Object 



686
687
688
689
690
691
692
 
# File 'app/models/theme.rb', line 686

def build_theme_uploads_hash
  hash = {}
  upload_fields.each do |field|
    hash[field.name] = Discourse.store.cdn_url(field.upload.url) if field.upload&.url
  end
  hash
end

#cached_default_settings ⇒ Object 



658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'app/models/theme.rb', line 658

def cached_default_settings
  Theme.get_set_cache "default_settings_for_theme_#{self.id}" do
    settings_hash = {}
    self.settings.each { |setting| settings_hash[setting.name] = setting.default }

    theme_uploads = build_theme_uploads_hash
    settings_hash["theme_uploads"] = theme_uploads if theme_uploads.present?

    theme_uploads_local = build_local_theme_uploads_hash
    settings_hash["theme_uploads_local"] = theme_uploads_local if theme_uploads_local.present?

    settings_hash
  end
end

#cached_settings ⇒ Object 



652
653
654
655
656
 
# File 'app/models/theme.rb', line 652

def cached_settings
  Theme.get_set_cache "settings_for_theme_#{self.id}" do
    build_settings_hash
  end
end

#changed_colors ⇒ Object 



538
539
540
 
# File 'app/models/theme.rb', line 538

def changed_colors
  @changed_colors ||= []
end

#changed_fields ⇒ Object 



534
535
536
 
# File 'app/models/theme.rb', line 534

def changed_fields
  @changed_fields ||= []
end

#changed_schemes ⇒ Object 



542
543
544
 
# File 'app/models/theme.rb', line 542

def changed_schemes
  @changed_schemes ||= Set.new
end

#child_theme_ids=(theme_ids) ⇒ Object 



586
587
588
589
 
# File 'app/models/theme.rb', line 586

def child_theme_ids=(theme_ids)
  super(theme_ids)
  Theme.clear_cache!
end

#component_validations ⇒ Object 



309
310
311
312
313
314
315
 
# File 'app/models/theme.rb', line 309

def component_validations
  return unless component

  errors.add(:base, I18n.t("themes.errors.component_no_color_scheme")) if color_scheme_id.present?
  errors.add(:base, I18n.t("themes.errors.component_no_user_selectable")) if user_selectable
  errors.add(:base, I18n.t("themes.errors.component_no_default")) if default?
end

#convert_list_to_json_schema(setting_row, setting) ⇒ Object 



830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'app/models/theme.rb', line 830

def convert_list_to_json_schema(setting_row, setting)
  schema = setting.json_schema
  return if !schema
  keys = schema["items"]["properties"].keys
  return if !keys

  current_values = CSV.parse(setting_row.value, **{ col_sep: "|" }).flatten

  new_values =
    current_values.map do |item|
      parts = CSV.parse(item, **{ col_sep: "," }).flatten
      raise "Schema validation failed" if keys.size < parts.size
      parts.zip(keys).map(&:reverse).to_h
    end

  schemer = JSONSchemer.schema(schema)
  raise "Schema validation failed" if !schemer.valid?(new_values)

  setting_row.value = new_values.to_json
  setting_row.data_type = setting.type
  setting_row.save!
end

#convert_settings ⇒ Object 



811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'app/models/theme.rb', line 811

def convert_settings
  settings.each do |setting|
    setting_row = ThemeSetting.where(theme_id: self.id, name: setting.name.to_s).first

    if setting_row && setting_row.data_type != setting.type
      if (
           setting_row.data_type == ThemeSetting.types[:list] &&
             setting.type == ThemeSetting.types[:string] && setting.json_schema.present?
         )
        convert_list_to_json_schema(setting_row, setting)
      else
        Rails.logger.warn(
          "Theme setting type has changed but cannot be converted. \n\n #{setting.inspect}",
        )
      end
    end
  end
end

#default? ⇒ Boolean

Returns:

  • (Boolean) 


293
294
295
 
# File 'app/models/theme.rb', line 293

def default?
  SiteSetting.default_theme_id == id
end

#disabled_at ⇒ Object 



772
773
774
 
# File 'app/models/theme.rb', line 772

def disabled_at
  find_disable_action_log&.created_at
end

#disabled_by ⇒ Object 



768
769
770
 
# File 'app/models/theme.rb', line 768

def disabled_by
  find_disable_action_log&.acting_user
end

#generate_metadata_hash ⇒ Object 



728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
 
# File 'app/models/theme.rb', line 728

def generate_metadata_hash
  {}.tap do |meta|
    meta[:name] = name
    meta[:component] = component

    RemoteTheme::METADATA_PROPERTIES.each do |property|
      meta[property] = remote_theme&.public_send(property)
      meta[property] = nil if meta[property] == "URL" # Clean up old discourse_theme CLI placeholders
    end

    meta[:assets] = {}.tap do |hash|
      theme_fields
        .where(type_id: ThemeField.types[:theme_upload_var])
        .each { |field| hash[field.name] = field.file_path }
    end

    meta[:color_schemes] = {}.tap do |hash|
      schemes = self.color_schemes
      # The selected color scheme may not belong to the theme, so include it anyway
      schemes = [self.color_scheme] + schemes if self.color_scheme
      schemes.uniq.each do |scheme|
        hash[scheme.name] = {}.tap do |colors|
          scheme.colors.each { |color| colors[color.name] = color.hex }
        end
      end
    end

    meta[:modifiers] = {}.tap do |hash|
      ThemeModifierSet.modifiers.keys.each do |modifier|
        value = self.theme_modifier_set.public_send(modifier)
        hash[modifier] = value if !value.nil?
      end
    end

    meta[
      :learn_more
    ] = "https://meta.discourse.org/t/beginners-guide-to-using-discourse-themes/91966"
  end
end

#internal_translations ⇒ Object 



613
614
615
 
# File 'app/models/theme.rb', line 613

def internal_translations
  @internal_translations ||= translations(internal: true)
end

#list_baked_fields(target, name) ⇒ Object 



524
525
526
527
528
 
# File 'app/models/theme.rb', line 524

def list_baked_fields(target, name)
  theme_ids = Theme.transform_ids(id)
  theme_ids = [theme_ids.first] if name != :color_definitions
  self.class.list_baked_fields(theme_ids, target, name)
end

#notify_color_change(color, scheme: nil) ⇒ Object 



86
87
88
89
90
 
# File 'app/models/theme.rb', line 86

def notify_color_change(color, scheme: nil)
  scheme ||= color.color_scheme
  changed_colors << color if color
  changed_schemes << scheme if scheme
end

#notify_theme_change(with_scheme: false) ⇒ Object 



414
415
416
417
418
419
 
# File 'app/models/theme.rb', line 414

def notify_theme_change(with_scheme: false)
  DB.after_commit do
    theme_ids = Theme.transform_ids(id)
    self.class.notify_theme_change(theme_ids, with_scheme: with_scheme)
  end
end

#parent_theme_ids=(theme_ids) ⇒ Object 



591
592
593
594
 
# File 'app/models/theme.rb', line 591

def parent_theme_ids=(theme_ids)
  super(theme_ids)
  Theme.clear_cache!
end

#remove_from_cache! ⇒ Object 



530
531
532
 
# File 'app/models/theme.rb', line 530

def remove_from_cache!
  self.class.remove_from_cache!
end

#resolve_baked_field(target, name) ⇒ Object 



520
521
522
 
# File 'app/models/theme.rb', line 520

def resolve_baked_field(target, name)
  list_baked_fields(target, name).map { |f| f.value_baked || f.value }.join("\n")
end

#scss_variables ⇒ Object 



784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'app/models/theme.rb', line 784

def scss_variables
  settings_hash = build_settings_hash
  theme_variable_fields = var_theme_fields

  return if theme_variable_fields.empty? && settings_hash.empty?

  contents = +""

  theme_variable_fields&.each do |field|
    if field.type_id == ThemeField.types[:theme_upload_var]
      if upload = field.upload
        url = upload_cdn_path(upload.url)
        contents << "$#{field.name}: unquote(\"#{url}\");"
      end
    else
      contents << to_scss_variable(field.name, field.value)
    end
  end

  settings_hash&.each do |name, value|
    next if name == "theme_uploads" || name == "theme_uploads_local"
    contents << to_scss_variable(name, value)
  end

  contents
end

#set_default! ⇒ Object 



285
286
287
288
289
290
291
 
# File 'app/models/theme.rb', line 285

def set_default!
  if component
    raise Discourse::InvalidParameters.new(I18n.t("themes.errors.component_no_default"))
  end
  SiteSetting.default_theme_id = id
  Theme.expire_site_cache!
end

#set_field(target:, name:, value: nil, type: nil, type_id: nil, upload_id: nil) ⇒ Object 



546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'app/models/theme.rb', line 546

def set_field(target:, name:, value: nil, type: nil, type_id: nil, upload_id: nil)
  name = name.to_s

  target_id = Theme.targets[target.to_sym]
  raise "Unknown target #{target} passed to set field" unless target_id

  type_id ||=
    type ? ThemeField.types[type.to_sym] : ThemeField.guess_type(name: name, target: target)
  raise "Unknown type #{type} passed to set field" unless type_id

  value ||= ""

  field = theme_fields.find_by(name: name, target_id: target_id, type_id: type_id)

  if field
    if value.blank? && !upload_id
      field.destroy
    else
      if field.value != value || field.upload_id != upload_id
        field.value = value
        field.upload_id = upload_id
        changed_fields << field
      end
    end
  else
    if value.present? || upload_id.present?
      field =
        theme_fields.build(
          target_id: target_id,
          value: value,
          name: name,
          type_id: type_id,
          upload_id: upload_id,
        )
      changed_fields << field
    end
  end
  field
end

#settings ⇒ Object 



639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'app/models/theme.rb', line 639

def settings
  field = settings_field
  return [] unless field && field.error.nil?

  settings = []
  ThemeSettingsParser
    .new(field)
    .load do |name, default, type, opts|
      settings << ThemeSettingsManager.create(name, default, type, self, opts)
    end
  settings
end

#should_refresh_development_clients? ⇒ Boolean

Returns:

  • (Boolean) 


140
141
142
 
# File 'app/models/theme.rb', line 140

def should_refresh_development_clients?
  Rails.env.development?
end

#supported? ⇒ Boolean

Returns:

  • (Boolean) 


297
298
299
300
301
302
303
304
305
306
307
 
# File 'app/models/theme.rb', line 297

def supported?
  if minimum_version = remote_theme&.minimum_discourse_version
    return false unless Discourse.has_needed_version?(Discourse::VERSION::STRING, minimum_version)
  end

  if maximum_version = remote_theme&.maximum_discourse_version
    return false unless Discourse.has_needed_version?(maximum_version, Discourse::VERSION::STRING)
  end

  true
end

#switch_to_component! ⇒ Object 



323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'app/models/theme.rb', line 323

def switch_to_component!
  return if component

  Theme.transaction do
    self.component = true

    self.color_scheme_id = nil
    self.user_selectable = false
    Theme.clear_default! if default?

    ChildTheme.where("parent_theme_id = ?", id).destroy_all
    self.save!
  end
end

#switch_to_theme! ⇒ Object 



338
339
340
341
342
343
344
345
346
347
 
# File 'app/models/theme.rb', line 338

def switch_to_theme!
  return unless component

  Theme.transaction do
    self.enabled = true
    self.component = false
    ChildTheme.where("child_theme_id = ?", id).destroy_all
    self.save!
  end
end

#theme_modifier_set ⇒ Object 



92
93
94
 
# File 'app/models/theme.rb', line 92

def theme_modifier_set
  super || build_theme_modifier_set
end

#translation_override_hash ⇒ Object 



717
718
719
720
721
722
723
724
725
726
 
# File 'app/models/theme.rb', line 717

def translation_override_hash
  hash = {}
  theme_translation_overrides.each do |override|
    cursor = hash
    path = [override.locale] + override.translation_key.split(".")
    path[0..-2].each { |key| cursor = (cursor[key] ||= {}) }
    cursor[path[-1]] = override.value
  end
  hash
end

#translations(internal: false) ⇒ Object 



617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
 
# File 'app/models/theme.rb', line 617

def translations(internal: false)
  fallbacks = I18n.fallbacks[I18n.locale]
  begin
    data =
      locale_fields.first&.translation_data(
        with_overrides: false,
        internal: internal,
        fallback_fields: locale_fields,
      )
    return {} if data.nil?
    best_translations = {}
    fallbacks.reverse.each { |locale| best_translations.deep_merge! data[locale] if data[locale] }
    ThemeTranslationManager.list_from_hash(
      theme: self,
      hash: best_translations,
      locale: I18n.locale,
    )
  rescue ThemeTranslationParser::InvalidYaml
    {}
  end
end

#update_child_components ⇒ Object 



144
145
146
147
148
149
150
151
152
153
 
# File 'app/models/theme.rb', line 144

def update_child_components
  if !component? && child_components.present?
    child_components.each do |url|
      url = ThemeStore::GitImporter.new(url.strip).url
      theme = RemoteTheme.find_by(remote_url: url)&.theme
      theme ||= RemoteTheme.import_theme(url, user)
      child_themes << theme
    end
  end
end

#update_javascript_cache! ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'app/models/theme.rb', line 155

def update_javascript_cache!
  all_extra_js =
    theme_fields
      .where(target_id: Theme.targets[:extra_js])
      .order(:name, :id)
      .pluck(:name, :value)
      .to_h

  if all_extra_js.present?
    js_compiler = ThemeJavascriptCompiler.new(id, name)
    js_compiler.append_tree(all_extra_js)
    settings_hash = build_settings_hash
    js_compiler.prepend_settings(settings_hash) if settings_hash.present?
    javascript_cache || build_javascript_cache
    javascript_cache.update!(content: js_compiler.content, source_map: js_compiler.source_map)
  else
    javascript_cache&.destroy!
  end
end

#update_setting(setting_name, new_value) ⇒ Object

Raises:



702
703
704
705
706
707
708
709
 
# File 'app/models/theme.rb', line 702

def update_setting(setting_name, new_value)
  target_setting = settings.find { |setting| setting.name == setting_name }
  raise Discourse::NotFound unless target_setting

  target_setting.value = new_value

  self.theme_setting_requests_refresh = true if target_setting.requests_refresh?
end

#update_translation(translation_key, new_value) ⇒ Object

Raises:



711
712
713
714
715
 
# File 'app/models/theme.rb', line 711

def update_translation(translation_key, new_value)
  target_translation = translations.find { |translation| translation.key == translation_key }
  raise Discourse::NotFound unless target_translation
  target_translation.value = new_value
end

#validate_theme_fields ⇒ Object 



317
318
319
320
321
 
# File 'app/models/theme.rb', line 317

def validate_theme_fields
  theme_fields.each do |field|
    field.errors.full_messages.each { |message| errors.add(:base, message) } unless field.valid?
  end
end

#with_scss_load_paths ⇒ Object 



776
777
778
779
780
781
782
 
# File 'app/models/theme.rb', line 776

def with_scss_load_paths
  return yield([]) if self.extra_scss_fields.empty?

  ThemeStore::ZipExporter
    .new(self)
    .with_export_dir(extra_scss_only: true) { |dir| yield ["#{dir}/stylesheets"] }
end