b4a480edae
* Move straightforward validations * Add color contrast validation to SiteConfig * Move domain and emoji validation to SiteConfig * Add specs * Update service object * Experimentally remove validation * Update spec * Fix comment
265 lines
11 KiB
Ruby
265 lines
11 KiB
Ruby
# Site configuration based on RailsSettings models,
|
|
# see <https://github.com/huacnlee/rails-settings-cached> for further info
|
|
|
|
class SiteConfig < RailsSettings::Base
|
|
self.table_name = "site_configs"
|
|
|
|
# the site configuration is cached, change this if you want to force update
|
|
# the cache, or call SiteConfig.clear_cache
|
|
cache_prefix { "v1" }
|
|
|
|
HEX_COLOR_REGEX = /\A#(\h{6}|\h{3})\z/.freeze
|
|
LIGHTNING_ICON = File.read(Rails.root.join("app/assets/images/lightning.svg")).freeze
|
|
STACK_ICON = File.read(Rails.root.join("app/assets/images/stack.svg")).freeze
|
|
VALID_URL = %r{\A(http|https)://([/|.\w\s-])*.[a-z]{2,5}(:[0-9]{1,5})?(/.*)?\z}.freeze
|
|
URL_MESSAGE = "must be a valid URL".freeze
|
|
|
|
# Meta
|
|
field :admin_action_taken_at, type: :datetime, default: Time.current
|
|
|
|
# Core setup
|
|
field :waiting_on_first_user, type: :boolean, default: !User.exists?
|
|
field :app_domain, type: :string, default: ApplicationConfig["APP_DOMAIN"]
|
|
|
|
# API Tokens
|
|
field :health_check_token, type: :string
|
|
field :video_encoder_key, type: :string
|
|
|
|
# Authentication
|
|
field :allow_email_password_registration, type: :boolean, default: false
|
|
field :allow_email_password_login, type: :boolean, default: true
|
|
field :allowed_registration_email_domains, type: :array, default: %w[], validates: {
|
|
valid_domain_csv: true
|
|
}
|
|
field :display_email_domain_allow_list_publicly, type: :boolean, default: false
|
|
field :require_captcha_for_email_password_registration, type: :boolean, default: false
|
|
field :authentication_providers, type: :array, default: %w[]
|
|
field :invite_only_mode, type: :boolean, default: false
|
|
field :twitter_key, type: :string, default: ApplicationConfig["TWITTER_KEY"]
|
|
field :twitter_secret, type: :string, default: ApplicationConfig["TWITTER_SECRET"]
|
|
field :github_key, type: :string, default: ApplicationConfig["GITHUB_KEY"]
|
|
field :github_secret, type: :string, default: ApplicationConfig["GITHUB_SECRET"]
|
|
field :facebook_key, type: :string
|
|
field :facebook_secret, type: :string
|
|
field :apple_client_id, type: :string
|
|
field :apple_key_id, type: :string
|
|
field :apple_pem, type: :string
|
|
field :apple_team_id, type: :string
|
|
|
|
# Campaign
|
|
field :campaign_call_to_action, type: :string, default: "Share your project"
|
|
field :campaign_hero_html_variant_name, type: :string, default: ""
|
|
field :campaign_featured_tags, type: :array, default: %w[]
|
|
field :campaign_sidebar_enabled, type: :boolean, default: 0
|
|
field :campaign_sidebar_image, type: :string, default: nil, validates: {
|
|
format: { with: VALID_URL, message: URL_MESSAGE }
|
|
}
|
|
field :campaign_url, type: :string, default: nil
|
|
field :campaign_articles_require_approval, type: :boolean, default: 0
|
|
field :campaign_articles_expiry_time, type: :integer, default: 4
|
|
|
|
# Community Content
|
|
field :community_name, type: :string, default: ApplicationConfig["COMMUNITY_NAME"] || "New Forem"
|
|
field :community_emoji, type: :string, default: "🌱", validates: { emoji_only: true }
|
|
# collective_noun and collective_noun_disabled have been added back temporarily for
|
|
# a data_update script, but will be removed in a future PR!
|
|
field :collective_noun, type: :string, default: "Community"
|
|
field :collective_noun_disabled, type: :boolean, default: false
|
|
field :community_description, type: :string
|
|
field :community_member_label, type: :string, default: "user"
|
|
field :tagline, type: :string
|
|
field :community_copyright_start_year,
|
|
type: :integer,
|
|
default: ApplicationConfig["COMMUNITY_COPYRIGHT_START_YEAR"] || Time.zone.today.year
|
|
field :staff_user_id, type: :integer, default: 1
|
|
field :experience_low, type: :string, default: "Total Newbies"
|
|
field :experience_high, type: :string, default: "Experienced Users"
|
|
|
|
# Emails
|
|
field :email_addresses, type: :hash, default: {
|
|
default: ApplicationConfig["DEFAULT_EMAIL"],
|
|
contact: ApplicationConfig["DEFAULT_EMAIL"],
|
|
business: ApplicationConfig["DEFAULT_EMAIL"],
|
|
privacy: ApplicationConfig["DEFAULT_EMAIL"],
|
|
members: ApplicationConfig["DEFAULT_EMAIL"]
|
|
}
|
|
|
|
# Email digest frequency
|
|
field :periodic_email_digest_max, type: :integer, default: 2
|
|
field :periodic_email_digest_min, type: :integer, default: 0
|
|
|
|
# Jobs
|
|
field :jobs_url, type: :string
|
|
field :display_jobs_banner, type: :boolean, default: false
|
|
|
|
# Google Analytics Tracking ID, e.g. UA-71991000-1
|
|
field :ga_tracking_id, type: :string, default: ApplicationConfig["GA_TRACKING_ID"]
|
|
|
|
# Google ReCATPCHA keys
|
|
field :recaptcha_site_key, type: :string, default: ApplicationConfig["RECAPTCHA_SITE"]
|
|
field :recaptcha_secret_key, type: :string, default: ApplicationConfig["RECAPTCHA_SECRET"]
|
|
|
|
# Images
|
|
field :main_social_image,
|
|
type: :string,
|
|
default: proc { URL.local_image("social-media-cover.png") },
|
|
validates: { format: { with: VALID_URL, message: URL_MESSAGE } }
|
|
|
|
field :favicon_url, type: :string, default: proc { URL.local_image("favicon.ico") }
|
|
field :logo_png,
|
|
type: :string,
|
|
default: proc { URL.local_image("icon.png") },
|
|
validates: { format: { with: VALID_URL, message: URL_MESSAGE } }
|
|
|
|
field :logo_svg, type: :string
|
|
field :secondary_logo_url, type: :string, validates: {
|
|
format: { with: VALID_URL, message: URL_MESSAGE }
|
|
}
|
|
|
|
field :left_navbar_svg_icon, type: :string, default: STACK_ICON
|
|
field :right_navbar_svg_icon, type: :string, default: LIGHTNING_ICON
|
|
field :enable_video_upload, type: :boolean, default: false
|
|
|
|
# Mascot
|
|
field :mascot_user_id, type: :integer, default: nil
|
|
field :mascot_image_url,
|
|
type: :string,
|
|
default: proc { URL.local_image("mascot.png") },
|
|
validates: { format: { with: VALID_URL, message: URL_MESSAGE } }
|
|
field :mascot_image_description, type: :string, default: "The community mascot"
|
|
field :mascot_footer_image_url, type: :string, validates: {
|
|
format: { with: VALID_URL, message: URL_MESSAGE }
|
|
}
|
|
field :mascot_footer_image_width, type: :integer, default: 52
|
|
field :mascot_footer_image_height, type: :integer, default: 120
|
|
|
|
# Meta keywords
|
|
field :meta_keywords, type: :hash, default: {
|
|
default: nil,
|
|
article: nil,
|
|
tag: nil
|
|
}
|
|
|
|
# Monetization
|
|
field :payment_pointer, type: :string
|
|
field :stripe_api_key, type: :string, default: ApplicationConfig["STRIPE_SECRET_KEY"]
|
|
field :stripe_publishable_key, type: :string, default: ApplicationConfig["STRIPE_PUBLISHABLE_KEY"]
|
|
field :shop_url, type: :string
|
|
|
|
# Newsletter
|
|
# <https://mailchimp.com/developer/>
|
|
field :mailchimp_api_key, type: :string, default: ApplicationConfig["MAILCHIMP_API_KEY"]
|
|
field :mailchimp_newsletter_id, type: :string, default: ""
|
|
field :mailchimp_sustaining_members_id, type: :string, default: ""
|
|
field :mailchimp_tag_moderators_id, type: :string, default: ""
|
|
field :mailchimp_community_moderators_id, type: :string, default: ""
|
|
# Mailchimp webhook secret. Part of the callback URL in the Mailchimp settings.
|
|
# <https://mailchimp.com/developer/guides/about-webhooks/#Webhooks_security>
|
|
field :mailchimp_incoming_webhook_secret, type: :string, default: ""
|
|
|
|
# Onboarding
|
|
field :onboarding_logo_image, type: :string, validates: {
|
|
format: { with: VALID_URL, message: URL_MESSAGE }
|
|
}
|
|
field :onboarding_background_image, type: :string, validates: {
|
|
format: { with: VALID_URL, message: URL_MESSAGE }
|
|
}
|
|
field :onboarding_taskcard_image, type: :string, validates: {
|
|
format: { with: VALID_URL, message: URL_MESSAGE }
|
|
}
|
|
field :suggested_tags, type: :array, default: %w[]
|
|
field :suggested_users, type: :array, default: %w[]
|
|
field :prefer_manual_suggested_users, type: :boolean, default: false
|
|
|
|
# Rate limits and spam prevention
|
|
field :rate_limit_follow_count_daily, type: :integer, default: 500
|
|
field :rate_limit_comment_creation, type: :integer, default: 9
|
|
field :rate_limit_listing_creation, type: :integer, default: 1
|
|
field :rate_limit_published_article_creation, type: :integer, default: 9
|
|
field :rate_limit_published_article_antispam_creation, type: :integer, default: 1
|
|
field :rate_limit_organization_creation, type: :integer, default: 1
|
|
field :rate_limit_reaction_creation, type: :integer, default: 10
|
|
field :rate_limit_image_upload, type: :integer, default: 9
|
|
field :rate_limit_email_recipient, type: :integer, default: 5
|
|
field :rate_limit_article_update, type: :integer, default: 30
|
|
field :rate_limit_send_email_confirmation, type: :integer, default: 2
|
|
field :rate_limit_feedback_message_creation, type: :integer, default: 5
|
|
field :rate_limit_user_update, type: :integer, default: 15
|
|
field :rate_limit_user_subscription_creation, type: :integer, default: 3
|
|
|
|
field :spam_trigger_terms, type: :array, default: []
|
|
|
|
# Social Media
|
|
field :social_media_handles, type: :hash, default: {
|
|
twitter: nil,
|
|
facebook: nil,
|
|
github: nil,
|
|
instagram: nil,
|
|
twitch: nil
|
|
}
|
|
field :twitter_hashtag, type: :string
|
|
|
|
# Sponsors
|
|
field :sponsor_headline, default: "Community Sponsors"
|
|
|
|
# Tags
|
|
field :sidebar_tags, type: :array, default: %w[]
|
|
|
|
# User Experience
|
|
# These are the default UX settings, which can be overridded by individual user preferences.
|
|
# basic (current default), rich (cover image on all posts), compact (more minimal)
|
|
field :feed_style, type: :string, default: "basic"
|
|
# a non-public forem will redirect all unauthenticated pages to the registration page.
|
|
# a public forem could have more fine-grained authentication (listings ar private etc.) in future
|
|
field :public, type: :boolean, default: 0
|
|
# The default font for all users that have not chosen a custom font yet
|
|
field :default_font, type: :string, default: "sans_serif"
|
|
field :primary_brand_color_hex, type: :string, default: "#3b49df", validates: {
|
|
format: {
|
|
with: HEX_COLOR_REGEX,
|
|
message: "must be be a 3 or 6 character hex (starting with #)"
|
|
},
|
|
color_contrast: true
|
|
}
|
|
field :feed_strategy, type: :string, default: "basic"
|
|
field :tag_feed_minimum_score, type: :integer, default: 0
|
|
field :home_feed_minimum_score, type: :integer, default: 0
|
|
|
|
# Broadcast
|
|
field :welcome_notifications_live_at, type: :date
|
|
|
|
# Credits
|
|
field :credit_prices_in_cents, type: :hash, default: {
|
|
small: 500,
|
|
medium: 400,
|
|
large: 300,
|
|
xlarge: 250
|
|
}
|
|
|
|
# Returns true if we are operating on a local installation, false otherwise
|
|
def self.local?
|
|
app_domain.include?("localhost")
|
|
end
|
|
|
|
# Used where we need to keep old DEV features around but don't want to/cannot
|
|
# expose them to other communities.
|
|
def self.dev_to?
|
|
app_domain == "dev.to"
|
|
end
|
|
|
|
# Apple uses different keys than the usual `PROVIDER_NAME_key` or
|
|
# `PROVIDER_NAME_secret` so these will help the generalized authentication
|
|
# code to work, i.e. https://github.com/forem/forem/blob/master/app/helpers/authentication_helper.rb#L26-L29
|
|
def self.apple_key
|
|
return unless apple_client_id.present? && apple_key_id.present? &&
|
|
apple_pem.present? && apple_team_id.present?
|
|
|
|
"present"
|
|
end
|
|
singleton_class.__send__(:alias_method, :apple_secret, :apple_key)
|
|
|
|
# To get default values
|
|
def self.get_default(field)
|
|
get_field(field)[:default]
|
|
end
|
|
end
|