discourse-custom-wizard/plugin.rb

# frozen_string_literal: true
# name: discourse-custom-wizard
# about: Forms for Discourse. Better onboarding, structured posting, data enrichment, automated actions and much more.
# version: 2.9.0
# authors: Angus McLeod, Faizaan Gagan, Robert Barrow, Keegan George, Kaitlin Maddever, Juan Marcos Gutierrez Ramos
# url: https://github.com/paviliondev/discourse-custom-wizard
# contact_emails: development@pavilion.tech
# subscription_url: https://coop.pavilion.tech
# meta_topic_id: 73345

gem "liquid", "5.5.0", require: true
gem "discourse_subscription_client", "0.1.6", require_name: "discourse_subscription_client"
gem "discourse_plugin_statistics", "0.1.0.pre7", require: true
register_asset "stylesheets/common/admin.scss"
register_asset "stylesheets/common/wizard.scss"
register_svg_icon "pavilion-logo"
register_svg_icon "hat-wizard"

enabled_site_setting :custom_wizard_enabled

if respond_to?(:register_svg_icon)
  register_svg_icon "far-calendar"
  register_svg_icon "chevron-right"
  register_svg_icon "chevron-left"
  register_svg_icon "save"
  register_svg_icon "sliders-h"
  register_svg_icon "calendar"
  register_svg_icon "check"
  register_svg_icon "times"
  register_svg_icon "clock"
  register_svg_icon "link"
  register_svg_icon "comment-alt"
  register_svg_icon "far-life-ring"
  register_svg_icon "arrow-right"
  register_svg_icon "bolt"
end

after_initialize do
  require_relative "lib/custom_wizard/engine.rb"
  require_relative "config/routes.rb"
  require_relative "app/controllers/custom_wizard/admin/admin.rb"
  require_relative "app/controllers/custom_wizard/admin/subscription.rb"
  require_relative "app/controllers/custom_wizard/admin/wizard.rb"
  require_relative "app/controllers/custom_wizard/admin/submissions.rb"
  require_relative "app/controllers/custom_wizard/admin/api.rb"
  require_relative "app/controllers/custom_wizard/admin/logs.rb"
  require_relative "app/controllers/custom_wizard/admin/manager.rb"
  require_relative "app/controllers/custom_wizard/admin/custom_fields.rb"
  require_relative "app/controllers/custom_wizard/admin/user.rb"
  require_relative "app/controllers/custom_wizard/wizard_client.rb"
  require_relative "app/controllers/custom_wizard/wizard.rb"
  require_relative "app/controllers/custom_wizard/steps.rb"
  require_relative "app/controllers/custom_wizard/realtime_validations.rb"
  require_relative "app/jobs/regular/refresh_api_access_token.rb"
  require_relative "app/jobs/regular/set_after_time_wizard.rb"
  require_relative "lib/custom_wizard/validators/template.rb"
  require_relative "lib/custom_wizard/validators/update.rb"
  require_relative "lib/custom_wizard/action_result.rb"
  require_relative "lib/custom_wizard/action.rb"
  require_relative "lib/custom_wizard/builder.rb"
  require_relative "lib/custom_wizard/cache.rb"
  require_relative "lib/custom_wizard/custom_field.rb"
  require_relative "lib/custom_wizard/field.rb"
  require_relative "lib/custom_wizard/realtime_validation.rb"
  require_relative "lib/custom_wizard/realtime_validations/result.rb"
  require_relative "lib/custom_wizard/realtime_validations/similar_topics.rb"
  require_relative "lib/custom_wizard/mapper.rb"
  require_relative "lib/custom_wizard/log.rb"
  require_relative "lib/custom_wizard/step_updater.rb"
  require_relative "lib/custom_wizard/step.rb"
  require_relative "lib/custom_wizard/submission.rb"
  require_relative "lib/custom_wizard/subscription.rb"
  require_relative "lib/custom_wizard/template.rb"
  require_relative "lib/custom_wizard/wizard.rb"
  require_relative "lib/custom_wizard/user_history.rb"
  require_relative "lib/custom_wizard/api/api.rb"
  require_relative "lib/custom_wizard/api/authorization.rb"
  require_relative "lib/custom_wizard/api/endpoint.rb"
  require_relative "lib/custom_wizard/api/log_entry.rb"
  require_relative "lib/custom_wizard/liquid_extensions/first_non_empty.rb"
  require_relative "lib/custom_wizard/exceptions/exceptions.rb"
  require_relative "lib/discourse_plugin_statistics/plugin.rb"
  require_relative "app/serializers/custom_wizard/api/authorization_serializer.rb"
  require_relative "app/serializers/custom_wizard/api/basic_endpoint_serializer.rb"
  require_relative "app/serializers/custom_wizard/api/endpoint_serializer.rb"
  require_relative "app/serializers/custom_wizard/api/log_serializer.rb"
  require_relative "app/serializers/custom_wizard/api_serializer.rb"
  require_relative "app/serializers/custom_wizard/basic_api_serializer.rb"
  require_relative "app/serializers/custom_wizard/basic_wizard_serializer.rb"
  require_relative "app/serializers/custom_wizard/custom_field_serializer.rb"
  require_relative "app/serializers/custom_wizard/wizard_field_serializer.rb"
  require_relative "app/serializers/custom_wizard/wizard_step_serializer.rb"
  require_relative "app/serializers/custom_wizard/wizard_serializer.rb"
  require_relative "app/serializers/custom_wizard/log_serializer.rb"
  require_relative "app/serializers/custom_wizard/submission_serializer.rb"
  require_relative "app/serializers/custom_wizard/realtime_validation/similar_topics_serializer.rb"
  require_relative "lib/custom_wizard/extensions/extra_locales_controller.rb"
  require_relative "lib/custom_wizard/extensions/invites_controller.rb"
  require_relative "lib/custom_wizard/extensions/users_controller.rb"
  require_relative "lib/custom_wizard/extensions/guardian.rb"
  require_relative "lib/custom_wizard/extensions/custom_field/preloader.rb"
  require_relative "lib/custom_wizard/extensions/custom_field/serializer.rb"
  require_relative "lib/custom_wizard/extensions/custom_field/extension.rb"
  require_relative "lib/custom_wizard/extensions/discourse_tagging.rb"

  Liquid::Template.error_mode = :strict

  # preloaded category custom fields
  %w[create_topic_wizard].each do |custom_field|
    Site.preloaded_category_custom_fields << custom_field
  end

  Liquid::Template.register_filter(::CustomWizard::LiquidFilter::FirstNonEmpty)

  add_to_class(:topic, :wizard_submission_id) { custom_fields["wizard_submission_id"] }

  add_class_method(:wizard, :user_requires_completion?) do |user|
    wizard_result = self.new(user).requires_completion?
    return wizard_result if wizard_result

    custom_redirect = false

    if user && user.first_seen_at.blank? && wizard = CustomWizard::Wizard.after_signup(user)
      if !wizard.completed?
        custom_redirect = true
        CustomWizard::Wizard.set_user_redirect(wizard.id, user)
      end
    end

    !!custom_redirect
  end

  add_to_class(:user, :redirect_to_wizard) do
    if custom_fields["redirect_to_wizard"].present?
      custom_fields["redirect_to_wizard"]
    else
      nil
    end
  end

  add_to_class(:users_controller, :wizard_path) do
    if custom_wizard_redirect = current_user.redirect_to_wizard
      "#{Discourse.base_url}/w/#{custom_wizard_redirect.dasherize}"
    else
      "#{Discourse.base_url}/wizard"
    end
  end

  add_to_serializer(:current_user, :redirect_to_wizard) { object.redirect_to_wizard }
  add_to_serializer(:admin_user_list, :redirect_to_wizard) { object.redirect_to_wizard }

  on(:user_approved) do |user|
    if wizard = CustomWizard::Wizard.after_signup(user)
      CustomWizard::Wizard.set_user_redirect(wizard.id, user)
    end
  end

  add_to_class(:application_controller, :redirect_to_wizard_if_required) do
    @excluded_routes ||= SiteSetting.wizard_redirect_exclude_paths.split("|") + ["/w/"]
    url = request.referer || request.original_url
    excluded_route = @excluded_routes.any? { |str| /#{str}/ =~ url }
    not_api = request.format === "text/html"

    if not_api && !excluded_route
      wizard_id = current_user.redirect_to_wizard

      if CustomWizard::Template.can_redirect_users?(wizard_id)
        if url !~ %r{/w/} && url !~ %r{/invites/}
          CustomWizard::Wizard.set_wizard_redirect(current_user, wizard_id, url)
        end

        wizard = CustomWizard::Wizard.create(wizard_id, current_user)
        redirect_to "/w/#{wizard_id.dasherize}" if wizard.should_redirect?
      end
    end
  end

  add_to_class(:site_serializer, :include_wizard_required?) do
    scope.is_admin? && Wizard.new(scope.user).requires_completion?
  end

  add_to_class(:site_serializer, :complete_custom_wizard) do
    if scope.user && requires_completion = CustomWizard::Wizard.prompt_completion(scope.user)
      requires_completion.map { |w| { name: w[:name], url: "/w/#{w[:id]}" } }
    end
  end

  add_to_class(:site_serializer, :include_complete_custom_wizard?) do
    complete_custom_wizard.present?
  end

  add_model_callback(:application_controller, :before_action) do
    redirect_to_wizard_if_required if current_user
  end

  ::ExtraLocalesController.prepend ExtraLocalesControllerCustomWizard
  ::InvitesController.prepend InvitesControllerCustomWizard
  ::UsersController.prepend CustomWizardUsersController
  ::Guardian.prepend CustomWizardGuardian

  full_path =
    "#{Rails.root}/plugins/discourse-custom-wizard/assets/stylesheets/wizard/wizard_custom.scss"
  if Stylesheet::Importer.respond_to?(:plugin_assets)
    Stylesheet::Importer.plugin_assets["wizard_custom"] = Set[full_path]
  else
    # legacy method, Discourse 2.7.0.beta5 and below
    DiscoursePluginRegistry.register_asset(full_path, {}, "wizard_custom")
    Stylesheet::Importer.register_import("wizard_custom") do
      import_files(DiscoursePluginRegistry.stylesheets["wizard_custom"])
    end
  end

  CustomWizard::CustomField::CLASSES.keys.each do |klass|
    class_constant = klass.to_s.classify.constantize

    add_model_callback(klass, :after_initialize) do
      if CustomWizard::CustomField.enabled?
        CustomWizard::CustomField
          .list_by(:klass, klass.to_s)
          .each do |field|
            class_constant.register_custom_field_type(field[:name], field[:type].to_sym)
          end
      end
    end

    class_constant.singleton_class.prepend CustomWizardCustomFieldPreloader
    class_constant.singleton_class.prepend CustomWizardCustomFieldExtension
  end

  CustomWizard::CustomField.serializers.each do |serializer_klass|
    "#{serializer_klass}_serializer".classify.constantize.prepend CustomWizardCustomFieldSerializer
  end

  reloadable_patch do |plugin|
    ::DiscourseTagging.singleton_class.prepend CustomWizardDiscourseTagging
  end

  DiscourseEvent.trigger(:custom_wizard_ready)

  on(:before_create_topic) do |topic_params, user|
    category = topic_params.category
    wizard_submission_id = topic_params.custom_fields&.[]("wizard_submission_id")
    if category&.custom_fields&.[]("create_topic_wizard").present? && wizard_submission_id.blank?
      raise Discourse::InvalidParameters.new(
              I18n.t("wizard.error_messages.wizard_replacing_composer"),
            )
    end
  end
end