awesome.rb

# frozen_string_literal: true

module Decidim
  module DecidimAwesome
    include ActiveSupport::Configurable

    autoload :AwesomeHelpers, "decidim/decidim_awesome/awesome_helpers"
    autoload :RequestMemoizer, "decidim/decidim_awesome/request_memoizer"
    autoload :Config, "decidim/decidim_awesome/config"
    autoload :SystemChecker, "decidim/decidim_awesome/system_checker"
    autoload :ContextAnalyzers, "decidim/decidim_awesome/context_analyzers"
    autoload :MenuHacker, "decidim/decidim_awesome/menu_hacker"
    autoload :CustomFields, "decidim/decidim_awesome/custom_fields"
    autoload :VotingManifest, "decidim/decidim_awesome/voting_manifest"
    autoload :Lock, "decidim/decidim_awesome/lock"
    autoload :TranslatedCustomFieldsType, "decidim/decidim_awesome/api/types/translated_custom_fields_type"
    autoload :LocalizedCustomFieldsType, "decidim/decidim_awesome/api/types/localized_custom_fields_type"
    autoload :Authorizer, "decidim/decidim_awesome/authorizer"
    autoload :MenuItemsParser, "decidim/decidim_awesome/menu_items_parser"
    autoload :ParseContentBlock, "decidim/decidim_awesome/parse_content_block"

    # Awesome comes with some components for participatory spaces
    # Currently :awesome_map and :awesome_iframe, list them here
    # if you wan to disable them
    # NOTE if you have spaces with some of these components already configured
    # and then they are deactivated, it will break you application as there will be
    # references in the database
    #
    # use only symbols here
    config_accessor :disabled_components do
      [
        # :awesome_map,
        # :awesome_iframe
      ]
    end

    # Boolean configuration options
    #
    # Default values for configuration options:
    #   true  => always true but admins can still restrict its scope
    #   false => default false, admins can turn it true
    #   :disabled => false and non available, hidden from admins
    config_accessor :allow_images_in_editors do
      false
    end

    config_accessor :allow_videos_in_editors do
      false
    end

    config_accessor :allow_images_in_proposals do
      false
    end

    # used to save forms in localstorage
    config_accessor :auto_save_forms do
      true
    end

    # Live chat widget linked to Telegram account or group
    # In the admin side only
    config_accessor :intergram_for_admins do
      true
    end

    # In the public side only
    config_accessor :intergram_for_public do
      true
    end

    # Configuration options to handle different validations in proposals
    # (maybe in the future will apply to other places)
    # Set it to :disabled if you don't want to use this feature
    config_accessor :validate_title_min_length do
      15
    end

    config_accessor :validate_title_max_caps_percent do
      25
    end

    config_accessor :validate_title_max_marks_together do
      1
    end

    config_accessor :validate_title_start_with_caps do
      true
    end

    config_accessor :validate_body_min_length do
      15
    end

    config_accessor :validate_body_max_caps_percent do
      25
    end

    config_accessor :validate_body_max_marks_together do
      1
    end

    config_accessor :validate_body_start_with_caps do
      true
    end

    # This transforms the proposal voting into a weighted voting
    # Different processors can be registered and configured in the component's settings
    # Each processor must account for a cell to display how to vote and a cell to display the results
    config_accessor :weighted_proposal_voting do
      true
    end

    # Additional sorting methods for proposals
    # this setting also stores the selected sorting method in the user's session
    config_accessor :additional_proposal_sortings do
      [
        :supported_first,
        :supported_last,
        :az,
        :za
      ]
    end

    # Restricts votes to proposals in admin-selected states.
    # true = feature available per step (default). :disabled = hide entirely.
    # Per-step checkbox is always off by default (depends on `votes_enabled`).
    config_accessor :votes_by_proposal_status do
      true
    end

    # Allows admins to limit the amount of pending amendments to (currently) one per proposal before it's accepted.
    # Once a pending amendment is accepted, a new on can be created.
    # Note that this does not limit the number of amendment per se, the admin has to set the limit in the proposal's component configuration.
    # set to :disable to will prevent admins to set an amendment's limit in the proposal's component configuration.
    # if set to "true" the checkbox will be checked by default
    # if set to "false" the checkbox will be unchecked by default
    config_accessor :allow_limiting_amendments do
      false
    end

    # This is an anti-spam mechanism that uses the Hashcash algorithm to increase the cost of brute-force attacks
    # on the login and signup forms. It works by requiring a Hashcash stamp to be sent with the form.
    # See http://www.hashcash.org/docs/hashcash.html
    # This configuration enables Hashcash for the signup forms.
    # If set to :disabled, the feature will be completely removed (only on the signup form).
    config_accessor :hashcash_signup do
      false
    end

    # This configuration enables Hashcash for the login forms.
    # If set to :disabled, the feature will be completely removed (only on the login form).
    config_accessor :hashcash_login do
      false
    end

    # The Hashcash bits are the number of bits of the stamp. The higher the number, the more difficult it is to generate a valid stamp.
    # The default value is 20 bits for the signup form and 16 bits for the login form.
    config_accessor :hashcash_signup_bits do
      20
    end

    config_accessor :hashcash_login_bits do
      16
    end

    # allows admins to created specific CSS snippets affecting only some public frontend specific parts
    # Valid values differ a little from the previous convention:
    #   :disabled => false and non available, hidden from admins
    #   Hash => hash of different css text, each key will be used for the constraints
    # Admins create this hash dynamically but some pre-defined css boxes can be created here as:
    #   {
    #      some_identifier: ".wrapper { background: red; }"
    #   }
    config_accessor :scoped_styles do
      {}
    end

    # allows admins to created specific CSS snippets affecting only some admin specific parts
    # Valid values differ a little from the previous convention:
    #   :disabled => false and non available, hidden from admins
    #   Hash => hash of different css text, each key will be used for the constraints
    # Admins create this hash dynamically but some pre-defined css boxes can be created here as:
    #   {
    #      some_identifier: ".wrapper { background: red; }"
    #   }
    config_accessor :scoped_admin_styles do
      {}
    end

    # custom fields for proposals using JSON specification:
    # https://github.com/jsonform/jsonform/wiki
    # Valid values uses the same structure as :scoped_styles
    #   :disabled => false and non available, hidden from admins
    #   Hash => hash of different JSON texts, each key will be used for the constraints
    # Admins can create this hash dynamically but some pre-defined css boxes can be created here as:
    #   {
    #      some_identifier: "{ ... some definition... }"
    #   }
    config_accessor :proposal_custom_fields do
      {}
    end

    # Same as proposal_custom_fields but for generating private fields than can be read only by admins
    config_accessor :proposal_private_custom_fields do
      {}
    end

    # whether to add a select to user's profile to allow them to select their preferred time zone
    # if set to false, the select won't be shown but it can still be configured by the admins
    # if set to :disabled the feature will be completely removed
    config_accessor :user_timezone do
      false
    end

    # Allows to enforce specific authorizations to access the platform
    # Constraints can be defined for each group
    # Set to :disabled to completely remove this feature
    config_accessor :force_authorizations do
      {}
    end

    # Enables cookie consent management with customizable categories and items
    # Admins can configure cookie categories with different visibility levels (visible/hidden)
    # and manage individual cookie items within each category
    # Set to :disabled to completely remove this feature, other values will enable it and allow admins to configure it
    config_accessor :cookie_management do
      true
    end

    # Allows admins to manually authorize users with the specified methods
    # if set to an empty array, the admins will not be able to authorize users but the system admin can still configure it
    # if set to :disabled the feature will be completely removed
    config_accessor :admins_available_authorizations do
      []
    end

    # This controllers will be skipped from the authorization check
    # Included automatically: required_authorizations authorizations upload_validations timeouts editor_images locales pages tos
    config_accessor :force_authorization_allowed_controller_names do
      %w(account)
    end

    # If true, admins can automatically login into the /system admin accounts without needing their password
    # Note that a system admin MUST be a site admin too (emails must match).
    # Otherwise, the login will be denied.
    # Set to :disabled to completely remove this feature
    config_accessor :link_admin_to_system_admins do
      true
    end

    # How old must be the private data to be considered expired and therefore presented to the admins for deletion
    config_accessor :private_data_expiration_time do
      3.months
    end

    # How long must be the private data prevented from being deleted again after being scheduled for deletion
    config_accessor :lock_time do
      1.minute
    end

    # allows to keep modifications for the main menu
    # can return :disabled to completely remove this feature
    # otherwise it should be an array (some overrides can be specified by default):
    # [
    #    {
    #       url: "/a-new-link",
    #       label: { "en" => "The label to show in the menu" },
    #       position: 10
    #    }
    # ]
    config_accessor :menu do
      []
    end

    config_accessor :mobile_menu do
      []
    end

    config_accessor :home_content_block_menu do
      []
    end

    # Configurable rich text content block for landing pages.
    # Supports multi-column layouts, backgrounds, and access restrictions.
    config_accessor :rich_text_block do
      true
    end

    # Configurable anchor-based menu navigator for landing pages.
    # Supports sticky positioning and configurable alignment.
    config_accessor :landing_menu_block do
      true
    end

    # Allows admins to assign "fake" admins scoped to some admin zones using the
    # same scope editor as :scoped_styles, valid values uses the same convention:
    #   :disabled => false and non available, hidden from admins
    #   Hash => hash of different admin ids, each key will be used for the constraints
    # Admins create this hash dynamically but some pre-defined admin boxes can be created here as:
    #   {
    #      some_identifier: [1234, 5678, 90123]
    #   }
    #
    # To test this feature in development, ensure that config/environments/development.rb is configured as:
    #   config.action_dispatch.show_exceptions = true
    #   config.action_dispatch.show_detailed_exceptions = false
    #   config.consider_all_requests_local = false
    config_accessor :scoped_admins do
      {}
    end

    # Allow to configure custom redirections
    # can return :disabled to completely remove this feature
    # You can initialize some default redirection if desired as follows:
    #  {
    #    "/decidim-docs" => { destination: "http://docs.decidim.org", active: true }
    #  }
    #
    # To test this feature in development, ensure that config/environments/development.rb is configured as:
    #   config.action_dispatch.show_exceptions = true
    #   config.action_dispatch.show_detailed_exceptions = false
    #   config.consider_all_requests_local = false

    config_accessor :custom_redirects do
      {}
    end

    # these settings do not follow the :disabled convention but
    # depends on the previous intergram configurations
    config_accessor :intergram_url do
      "https://www.intergram.xyz/js/widget.js"
    end

    # no need to override these settings, there admin-configurable
    config_accessor :intergram_for_admins_settings do
      {
        chat_id: nil,
        color: nil,
        use_floating_button: false,
        title_closed: nil,
        title_open: nil,
        intro_message: nil,
        auto_response: nil,
        auto_no_response: nil
      }
    end

    config_accessor :intergram_for_public_settings do
      {
        chat_id: nil,
        require_login: true,
        color: nil,
        use_floating_button: false,
        title_closed: nil,
        title_open: nil,
        intro_message: nil,
        auto_response: nil,
        auto_no_response: nil
      }
    end

    # additional correspondences between participatory spaces manifests and routes
    # ie: /admin/assemblies and /admin/assemblies_types are both treated as a "assembly" participatory space in terms of permission scoping
    # This can be tuned in a initialized if some other hacks over routes are applied
    # if a registered participatory space is not listed here then the name manifest will be used as a default route /manifest_name /admin/manifest_name
    config_accessor :participatory_spaces_routes_context do
      {
        # route in admin is different than in the frontend: /processes, /admin/participatory_processes
        participatory_processes: [:participatory_processes, :processes],
        # both /admin/assemblies and /admin/assemblies_types are considered assemblies
        assemblies: [:assemblies, :assemblies_types],
        # route in admin is different than in the frontend: /process_groups, /admin/participatory_process_groups
        process_groups: [:processes_groups, :participatory_process_groups]
      }
    end

    # If true, enables a new section in "Participants" where to audit all the admin roles that have been enabled/disabled historically in Decidim
    # Set to :disabled to completely remove this feature
    config_accessor :admin_accountability do
      [:participatory_space_roles, :admin_roles]
    end

    # Roles for which it is necessary to show admin_accountability
    config_accessor :participatory_space_roles do
      [
        "Decidim::AssemblyUserRole",
        "Decidim::ParticipatoryProcessUserRole",
        "Decidim::ConferenceUserRole"
      ]
    end

    # Maximum number of columns allowed per RichText content block
    config_accessor :max_rich_text_columns do
      5
    end

    # Which components will be tampered to add the voting registry override
    config_accessor :voting_components do
      [:proposals, :reporting_proposals]
    end

    # Public: Stores an instance of ContentBlockRegistry
    def self.voting_registry
      @voting_registry ||= Decidim::ManifestRegistry.new("decidim_awesome/voting")
    end

    #
    # HELPERS
    #
    # pass a single config var or an array of them
    # any non disabled match will return as true
    def self.possible_additional_proposal_sortings
      return [] unless additional_proposal_sortings.is_a?(Array)

      @possible_additional_proposal_sortings ||= additional_proposal_sortings.filter_map do |sort|
        next unless sort.to_sym.in?([:az, :za, :supported_first, :supported_last])

        sort.to_s
      end
    end

    # appends to a hash a new value in a specified position so that the hash becomes:
    # { a: 1, b: 2, c: 3 } => append_hash(hash, :b, :d, 4) => { a: 1, b: 2, d: 4, c: 3 }
    # if key is not found then it will be inserted at the end
    def self.hash_append!(hash, after_key, key, value)
      insert_at = hash.to_a.index(hash.assoc(after_key))
      insert_at = insert_at.nil? ? hash.size : insert_at + 1
      hash.replace(hash.to_a.insert(insert_at, [key, value]).to_h)
    end

    # prepends to a hash a new value in a specified position so that the hash becomes:
    # { a: 1, b: 2, c: 3 } => prepend_hash(hash, :b, :d, 4) => { a: 1, d: 4, b: 2, c: 3 }
    # if key is not found then it will be inserted at the beginning
    def self.hash_prepend!(hash, before_key, key, value)
      insert_at = hash.to_a.index(hash.assoc(before_key))
      insert_at = 0 if insert_at.nil?
      hash.replace(hash.to_a.insert(insert_at, [key, value]).to_h)
    end

    def self.collation_for(locale)
      @collation_for ||= {}
      @collation_for[locale] ||= ["#{locale}-x-icu", "#{locale[0..1]}%"].filter_map do |loc|
        sql = ApplicationRecord.sanitize_sql(["SELECT collname FROM pg_collation WHERE collname LIKE ? LIMIT 1", loc])
        res = ActiveRecord::Base.connection.execute(sql).first
        res["collname"] if res
      end.first
    end

    def self.enabled?(*config_vars)
      config_vars.any? do |item|
        next unless config.has_key?(item.to_sym)

        config.send(item) != :disabled
      end
    end

    def self.registered_components
      @registered_components ||= []
    end

    # Wrap registered components to register it later, after initializing
    # so we can honor disabled_components config
    def self.register_component(manifest, &block)
      registered_components << [manifest, block]
    end

    # version 0.12 is compatible only with decidim 0.29
    def self.legacy_version?
      # Decidim.version[0..3] == "0.29"
      false
    end
  end
end