definitions.rb

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2021 the OpenProject GmbH
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2013 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
#
# See docs/COPYRIGHT.rdoc for more details.
#++

# The list of all defined settings that however might get extended e.g. in modules/plugins
# Contains what was formerly defined in both the settings.yml as well as in configuration.rb.
# Values from the later can typically be identified by having
#   writable: false
# set. That would not be strictly necessary since they currently don't have a UI anyway and
# that is where the value is actually used.

Settings::Definition.define do
  add :activity_days_default,
      value: 30

  add :additional_footer_content,
      format: :string,
      value: nil

  add :after_first_login_redirect_url,
      format: :string,
      value: nil,
      writable: false

  add :after_login_default_redirect_url,
      format: :string,
      value: nil,
      writable: false

  add :apiv3_cors_enabled,
      value: false

  add :apiv3_cors_origins,
      value: []

  add :apiv3_docs_enabled,
      value: true

  add :apiv3_enable_basic_auth,
      value: true,
      writable: false

  add :apiv3_max_page_size,
      value: 1000

  add :app_title,
      value: 'OpenProject'

  add :attachment_max_size,
      value: 5120

  # Existing setting
  add :attachment_whitelist,
      value: []

  ##
  # Carrierwave storage type. Possible values are, among others, :file and :fog.
  # The latter requires further configuration.
  add :attachments_storage,
      value: :file,
      format: :symbol,
      allowed: %i[file fog],
      writable: false

  add :attachments_storage_path,
      format: :string,
      value: nil,
      writable: false

  add :attachments_grace_period,
      value: 180,
      writable: false

  add :auth_source_sso,
      format: :hash,
      value: nil,
      writable: false

  # Configures the authentication capabilities supported by the instance.
  # Currently this is focused on the configuration for basic auth.
  # e.g.
  # authentication:
  #   global_basic_auth:
  #     user: admin
  #     password: 123456
  add :authentication,
      format: :hash,
      value: nil,
      writable: false

  add :autofetch_changesets,
      value: true

  # autologin duration in days
  # 0 means autologin is disabled
  add :autologin,
      value: 0

  add :autologin_cookie_name,
      value: 'autologin',
      writable: false

  add :autologin_cookie_path,
      value: '/',
      writable: false

  add :autologin_cookie_secure,
      value: false,
      writable: false

  add :available_languages,
      format: :array,
      value: %w[en de fr es pt pt-BR it zh-CN ko ru].freeze,
      allowed: -> { Redmine::I18n.all_languages }

  add :avatar_link_expiry_seconds,
      value: 24.hours.to_i,
      writable: false

  # Allow users with the required permissions to create backups via the web interface or API.
  add :backup_enabled,
      value: true,
      writable: false

  add :backup_daily_limit,
      value: 3,
      writable: false

  add :backup_initial_waiting_period,
      value: 24.hours,
      format: :integer,
      writable: false

  add :backup_include_attachments,
      value: true,
      writable: false

  add :backup_attachment_size_max_sum_mb,
      value: 1024,
      writable: false

  add :blacklisted_routes,
      value: [],
      writable: false

  add :bcc_recipients,
      value: true

  add :boards_demo_data_available,
      value: false

  add :brute_force_block_minutes,
      value: 30

  add :brute_force_block_after_failed_logins,
      value: 20

  add :cache_expires_in_seconds,
      format: :integer,
      value: nil,
      writable: false

  add :cache_formatted_text,
      value: true

  # use dalli defaults for memcache
  add :cache_memcache_server,
      format: :string,
      value: nil,
      writable: false

  add :cache_namespace,
      format: :string,
      value: nil,
      writable: false

  add :commit_fix_done_ratio,
      value: 100

  add :commit_fix_keywords,
      value: 'fixes,closes'

  add :commit_fix_status_id,
      format: :integer,
      value: nil,
      allowed: -> { Status.pluck(:id) + [nil] }

  # encoding used to convert commit logs to UTF-8
  add :commit_logs_encoding,
      value: 'UTF-8'

  add :commit_logtime_activity_id,
      format: :integer,
      value: nil,
      allowed: -> { TimeEntryActivity.pluck(:id) + [nil] }

  add :commit_logtime_enabled,
      value: false

  add :commit_ref_keywords,
      value: 'refs,references,IssueID'

  add :consent_decline_mail,
      format: :string,
      value: nil

  # Time after which users have to have consented to what ever they need to consent
  # to (depending on other settings) such as a privacy policy.
  add :consent_time,
      value: nil,
      format: :datetime

  # Additional info about what the user is consenting to (optional).
  add :consent_info,
      value: {
        en: "## Consent\n\nYou need to agree to the [privacy and security policy]" +
            "(https://www.openproject.org/data-privacy-and-security/) of this OpenProject instance."
      }

  # Indicates whether or not users need to consent to something such as privacy policy.
  add :consent_required,
      value: false

  add :cross_project_work_package_relations,
      value: true

  # Allow in-context translations to be loaded with CSP
  add :crowdin_in_context_translations,
      value: true,
      writable: false

  add :database_cipher_key,
      format: :string,
      value: nil,
      writable: false

  add :date_format,
      format: :string,
      value: nil,
      allowed: [
        '%Y-%m-%d',
        '%d/%m/%Y',
        '%d.%m.%Y',
        '%d-%m-%Y',
        '%m/%d/%Y',
        '%d %b %Y',
        '%d %B %Y',
        '%b %d, %Y',
        '%B %d, %Y'
      ].freeze

  add :default_auto_hide_popups,
      value: true

  # user configuration
  add :default_comment_sort_order,
      value: 'asc',
      writable: false

  add :default_language,
      value: 'en'

  add :default_projects_modules,
      value: %w[calendar board_view work_package_tracking news costs wiki],
      allowed: -> { OpenProject::AccessControl.available_project_modules.map(&:to_s) }

  add :default_projects_public,
      value: false

  add :demo_projects_available,
      value: false

  add :demo_view_of_type_work_packages_table_seeded,
      value: false

  add :demo_view_of_type_team_planner_seeded,
      value: false

  add :diff_max_lines_displayed,
      value: 1500

  # only applicable in conjunction with fog (effectively S3) attachments
  # which will be uploaded directly to the cloud storage rather than via OpenProject's
  # server process.
  add :direct_uploads,
      value: true,
      writable: false

  add :disable_browser_cache,
      value: true,
      writable: false

  # allow to disable default modules
  add :disabled_modules,
      value: [],
      writable: false

  add :disable_password_choice,
      value: false,
      writable: false

  add :disable_password_login,
      value: false,
      writable: false

  add :display_subprojects_work_packages,
      value: true

  # Destroy all sessions for current_user on logout
  add :drop_old_sessions_on_logout,
      value: true,
      writable: false

  # Destroy all sessions for current_user on login
  add :drop_old_sessions_on_login,
      value: false,
      writable: false

  add :edition,
      format: :string,
      value: 'standard',
      writable: false,
      allowed: %w[standard bim]

  add :ee_manager_visible,
      value: true,
      writable: false

  # Enable internal asset server
  add :enable_internal_assets_server,
      value: false,
      writable: false

  # email configuration
  add :email_delivery_configuration,
      value: 'inapp',
      allowed: %w[inapp legacy],
      writable: false,
      env_alias: 'EMAIL_DELIVERY_CONFIGURATION'

  add :email_delivery_method,
      format: :symbol,
      value: nil,
      env_alias: 'EMAIL_DELIVERY_METHOD'

  add :emails_footer,
      value: {
        'en' => ''
      }

  add :emails_header,
      value: {
        'en' => ''
      }

  # use email address as login, hide login in registration form
  add :email_login,
      value: false

  add :enabled_projects_columns,
      value: %w[project_status public created_at latest_activity_at required_disk_space],
      allowed: -> { Projects::TableCell.new(nil, current_user: User.admin.first).all_columns.map(&:first).map(&:to_s) }

  add :enabled_scm,
      value: %w[subversion git]

  # Allow connections for trial creation and booking
  add :enterprise_trial_creation_host,
      value: 'https://augur.openproject.com',
      writable: false

  add :enterprise_chargebee_site,
      value: 'openproject-enterprise',
      writable: false

  add :enterprise_plan,
      value: 'enterprise-on-premises---euro---1-year',
      writable: false

  add :feature_storages_module_active,
      value: false,
      format: :boolean

  add :feeds_enabled,
      value: true

  add :feeds_limit,
      value: 15

  # Maximum size of files that can be displayed
  # inline through the file viewer (in KB)
  add :file_max_size_displayed,
      value: 512

  add :first_week_of_year,
      value: nil,
      format: :integer,
      allowed: [1, 4]

  # Configure fog, e.g. when using an S3 uploader
  add :fog,
      value: {}

  add :fog_download_url_expires_in,
      value: 21600, # 6h by default as 6 hours is max in S3 when using IAM roles
      writable: false

  # Additional / overridden help links
  add :force_help_link,
      format: :string,
      value: nil,
      writable: false

  add :force_formatting_help_link,
      format: :string,
      value: nil,
      writable: false

  add :forced_single_page_size,
      value: 250

  add :host_name,
      value: "localhost:3000"

  # Health check configuration
  add :health_checks_authentication_password,
      format: :string,
      value: nil,
      writable: false

  # Maximum number of backed up jobs (that are not yet executed)
  # before health check fails
  add :health_checks_jobs_queue_count_threshold,
      format: :integer,
      value: 50,
      writable: false

  ## Maximum number of minutes that jobs have not yet run after their designated 'run_at' time
  add :health_checks_jobs_never_ran_minutes_ago,
      format: :integer,
      value: 5,
      writable: false

  ## Maximum number of unprocessed requests in puma's backlog.
  add :health_checks_backlog_threshold,
      format: :integer,
      value: 20,
      writable: false

  # Default gravatar image, set to something other than 404
  # to ensure a default is returned
  add :gravatar_fallback_image,
      value: '404',
      writable: false

  add :hidden_menu_items,
      value: {},
      writable: false

  # Impressum link to be set, nil by default (= hidden)
  add :impressum_link,
      format: :string,
      value: nil,
      writable: false

  add :installation_type,
      value: 'manual',
      writable: false

  add :installation_uuid,
      format: :string,
      value: nil

  add :internal_password_confirmation,
      value: true,
      writable: false

  add :invitation_expiration_days,
      value: 7

  add :journal_aggregation_time_minutes,
      value: 5

  # Allow override of LDAP options
  add :ldap_force_no_page,
      format: :string,
      value: nil,
      writable: false

  add :ldap_auth_source_tls_options,
      format: :string,
      value: nil,
      writable: false

  # Allow users to manually sync groups in a different way
  # than the provided job using their own cron
  add :ldap_groups_disable_sync_job,
      value: false,
      writable: false

  add :ldap_users_disable_sync_job,
      value: false,
      writable: false

  # Update users' status through the synchronization job
  add :ldap_users_sync_status,
      format: :boolean,
      value: true,
      writable: false

  add :ldap_tls_options,
      value: {},
      writable: false

  add :log_level,
      value: 'info',
      writable: false

  add :log_requesting_user,
      value: false

  # Use lograge to format logs, off by default
  add :lograge_formatter,
      value: nil,
      format: :string,
      writable: false

  add :login_required,
      value: false

  add :lost_password,
      value: true

  add :mail_from,
      value: 'openproject@example.net'

  add :mail_handler_api_key,
      format: :string,
      value: nil

  add :mail_handler_body_delimiters,
      value: ''

  add :mail_handler_body_delimiter_regex,
      value: ''

  add :mail_handler_ignore_filenames,
      value: 'signature.asc'

  add :mail_suffix_separators,
      value: '+'

  add :main_content_language,
      value: 'english',
      writable: false

  # Check for missing migrations in internal errors
  add :migration_check_on_exceptions,
      value: true,
      writable: false

  # Role given to a non-admin user who creates a project
  add :new_project_user_role_id,
      format: :integer,
      value: nil,
      allowed: -> { Role.pluck(:id) }

  add :oauth_allow_remapping_of_existing_users,
      value: false

  add :omniauth_direct_login_provider,
      format: :string,
      value: nil,
      writable: false

  add :override_bcrypt_cost_factor,
      format: :string,
      value: nil,
      writable: false

  add :notification_retention_period_days,
      value: 30

  add :notification_email_delay_minutes,
      value: 15

  add :notification_email_digest_time,
      value: '08:00'

  add :onboarding_video_url,
      value: 'https://player.vimeo.com/video/163426858?autoplay=1',
      writable: false

  add :onboarding_enabled,
      value: true,
      writable: false

  add :password_active_rules,
      value: %w[lowercase uppercase numeric special],
      allowed: %w[lowercase uppercase numeric special]

  add :password_count_former_banned,
      value: 0

  add :password_days_valid,
      value: 0

  add :password_min_length,
      value: 10

  add :password_min_adhered_rules,
      value: 0

  # TODO: turn into array of ints
  # Requires a migration to be written
  # replace Setting#per_page_options_array
  add :per_page_options,
      value: '20, 100'

  add :plain_text_mail,
      value: false

  add :protocol,
      value: "http",
      allowed: %w[http https]

  add :project_gantt_query,
      value: nil,
      format: :string

  add :rails_asset_host,
      format: :string,
      value: nil,
      writable: false

  add :rails_cache_store,
      format: :symbol,
      value: :file_store,
      writable: false,
      allowed: %i[file_store memcache]

  # url-path prefix
  add :rails_relative_url_root,
      value: '',
      writable: false

  add :rails_force_ssl,
      value: false,
      writable: false

  add :registration_footer,
      value: {
        'en' => ''
      },
      writable: false

  add :repositories_automatic_managed_vendor,
      value: nil,
      format: :string,
      allowed: -> { OpenProject::SCM::Manager.registered.keys.map(&:to_s) }

  # encodings used to convert repository files content to UTF-8
  # multiple values accepted, comma separated
  add :repositories_encodings,
      value: nil,
      format: :string

  add :repository_authentication_caching_enabled,
      value: true

  add :repository_checkout_data,
      value: {
        "git" => { "enabled" => 0 },
        "subversion" => { "enabled" => 0 }
      }

  add :repository_log_display_limit,
      value: 100

  add :repository_storage_cache_minutes,
      value: 720

  add :repository_truncate_at,
      value: 500

  add :rest_api_enabled,
      value: true

  add :scm,
      format: :hash,
      value: {},
      writable: false

  add :scm_git_command,
      format: :string,
      value: nil,
      writable: false

  add :scm_local_checkout_path,
      value: 'repositories', # relative to OpenProject directory
      writable: false

  add :scm_subversion_command,
      format: :string,
      value: nil,
      writable: false

  # Display update / security badge, enabled by default
  add :security_badge_displayed,
      value: true

  add :security_badge_url,
      value: "https://releases.openproject.com/v1/check.svg",
      writable: false

  add :self_registration,
      value: 2

  add :sendmail_arguments,
      format: :string,
      value: "-i",
      writable: false

  add :sendmail_location,
      format: :string,
      value: "/usr/sbin/sendmail"

  # Which breadcrumb loggers to enable
  add :sentry_breadcrumb_loggers,
      value: ['active_support_logger'],
      writable: false

  # Log errors to sentry instance
  add :sentry_dsn,
      format: :string,
      value: nil,
      writable: false

  # Allow separate error reporting for frontend errors
  add :sentry_frontend_dsn,
      format: :string,
      value: nil,
      writable: false

  add :sentry_host,
      format: :string,
      value: nil,
      writable: false

  # Allow sentry to collect tracing samples
  # set to 1 to enable default tracing samples (see sentry initializer)
  # set to n >= 1 to enable n times the default tracing
  add :sentry_trace_factor,
      value: 0,
      writable: false

  # Allow sentry to collect tracing samples on frontend
  # set to n >= 1 to enable n times the default tracing
  add :sentry_frontend_trace_factor,
      value: 0,
      writable: false

  add :session_cookie_name,
      value: '_open_project_session',
      writable: false

  # where to store session data
  add :session_store,
      value: :active_record_store,
      writable: false

  add :session_ttl_enabled,
      value: false

  add :session_ttl,
      value: 120

  add :show_community_links,
      value: true,
      writable: false

  # Show pending migrations as warning bar
  add :show_pending_migrations_warning,
      value: true,
      writable: false

  # Show mismatched protocol/hostname warning
  # in settings where they must differ this can be disabled
  add :show_setting_mismatch_warning,
      value: true,
      writable: false

  # Render storage information
  add :show_storage_information,
      value: true,
      writable: false

  # Render warning bars (pending migrations, deprecation, unsupported browsers)
  # Set to false to globally disable this for all users!
  add :show_warning_bars,
      value: true,
      writable: false

  add :smtp_authentication,
      format: :string,
      value: 'plain',
      env_alias: 'SMTP_AUTHENTICATION'

  add :smtp_enable_starttls_auto,
      format: :boolean,
      value: false,
      env_alias: 'SMTP_ENABLE_STARTTLS_AUTO'

  add :smtp_openssl_verify_mode,
      format: :string,
      value: "peer",
      allowed: %w[none peer client_once fail_if_no_peer_cert],
      writable: false

  add :smtp_ssl,
      format: :boolean,
      value: false,
      env_alias: 'SMTP_SSL'

  add :smtp_address,
      format: :string,
      value: '',
      env_alias: 'SMTP_ADDRESS'

  add :smtp_domain,
      format: :string,
      value: 'your.domain.com',
      env_alias: 'SMTP_DOMAIN'

  add :smtp_user_name,
      format: :string,
      value: '',
      env_alias: 'SMTP_USER_NAME'

  add :smtp_port,
      format: :integer,
      value: 587,
      env_alias: 'SMTP_PORT'

  add :smtp_password,
      format: :string,
      value: '',
      env_alias: 'SMTP_PASSWORD'

  add :software_name,
      value: 'OpenProject'

  add :software_url,
      value: 'https://www.openproject.org/'

  # Slow query logging threshold in ms
  add :sql_slow_query_threshold,
      value: 2000,
      writable: false

  add :start_of_week,
      value: nil,
      format: :integer,
      allowed: [1, 6, 7]

  # enable statsd metrics (currently puma only) by configuring host
  add :statsd,
      value: {
        'host' => nil,
        'port' => 8125
      },
      writable: false

  add :sys_api_enabled,
      value: false

  add :sys_api_key,
      value: nil,
      format: :string

  add :time_format,
      format: :string,
      value: nil,
      allowed: [
        '%H:%M',
        '%I:%M %p'
      ].freeze

  add :user_default_timezone,
      value: nil,
      format: :string,
      allowed: ActiveSupport::TimeZone.all + [nil]

  add :users_deletable_by_admins,
      value: false

  add :users_deletable_by_self,
      value: false

  add :user_format,
      value: :firstname_lastname,
      allowed: -> { User::USER_FORMATS_STRUCTURE.keys }

  add :web,
      value: {
        'workers' => 2,
        'timeout' => 120,
        'wait_timeout' => 10,
        'min_threads' => 4,
        'max_threads' => 16
      },
      writable: false

  add :welcome_text,
      format: :string,
      value: nil

  add :welcome_title,
      format: :string,
      value: nil

  add :welcome_on_homescreen,
      value: false

  add :work_package_done_ratio,
      value: 'field',
      allowed: %w[field status disabled]

  add :work_packages_export_limit,
      value: 500

  add :work_package_list_default_highlighted_attributes,
      value: [],
      allowed: -> {
        Query.available_columns(nil).select(&:highlightable).map(&:name).map(&:to_s)
      }

  add :work_package_list_default_highlighting_mode,
      format: :string,
      value: -> { EnterpriseToken.allows_to?(:conditional_highlighting) ? 'inline' : 'none' },
      allowed: -> { Query::QUERY_HIGHLIGHTING_MODES },
      writable: -> { EnterpriseToken.allows_to?(:conditional_highlighting) }

  add :work_package_list_default_columns,
      value: %w[id subject type status assigned_to priority],
      allowed: -> { Query.new.available_columns.map(&:name).map(&:to_s) }

  add :work_package_startdate_is_adddate,
      value: false

  add :youtube_channel,
      value: 'https://www.youtube.com/c/OpenProjectCommunity',
      writable: false
end