1
0
Fork 0
discourse-custom-wizard-unl.../plugin.rb

257 Zeilen
9,7 KiB
Ruby

2021-03-11 07:30:15 +01:00
# frozen_string_literal: true
2017-09-23 04:34:07 +02:00
# name: discourse-custom-wizard
2021-11-09 13:38:53 +01:00
# about: Create custom wizards for topic creation, onboarding, user surveys and much more.
# version: 0.8.1
2021-11-09 13:38:53 +01:00
# authors: Angus McLeod, Faizaan Gagan, Robert Barrow, Keegan George
# contact_emails: support@thepavilion.io
2020-11-09 05:14:45 +01:00
# url: https://github.com/paviliondev/discourse-custom-wizard
2021-11-09 13:38:53 +01:00
# tests_passed_test_url: https://plugins.discourse.pavilion.tech/w/super-mega-fun-wizard
# stable_test_url: https://stable.plugins.discourse.pavilion.tech/w/super-mega-fun-wizard
2017-09-23 04:34:07 +02:00
gem 'liquid', '5.0.1', require: true
2021-09-24 11:58:42 +02:00
register_asset 'stylesheets/admin/admin.scss', :desktop
enabled_site_setting :custom_wizard_enabled
2017-09-25 16:47:40 +02:00
config = Rails.application.config
2019-12-05 09:05:21 +01:00
plugin_asset_path = "#{Rails.root}/plugins/discourse-custom-wizard/assets"
config.assets.paths << "#{plugin_asset_path}/javascripts"
config.assets.paths << "#{plugin_asset_path}/stylesheets/wizard"
2017-09-25 16:47:40 +02:00
2017-11-01 12:47:27 +01:00
if Rails.env.production?
2017-12-03 08:57:54 +01:00
config.assets.precompile += %w{
2019-10-09 01:09:30 +02:00
wizard-custom-guest.js
2020-10-02 07:03:26 +02:00
wizard-custom-globals.js
2017-12-03 08:57:54 +01:00
wizard-custom.js
2019-01-18 01:34:52 +01:00
wizard-custom-start.js
2020-10-02 10:07:16 +02:00
wizard-plugin.js.erb
2019-01-29 01:42:23 +01:00
wizard-raw-templates.js.erb
2017-12-03 08:57:54 +01:00
}
2017-11-01 12:47:27 +01:00
end
2019-02-20 07:27:17 +01:00
if respond_to?(:register_svg_icon)
2020-03-30 01:53:28 +02:00
register_svg_icon "far-calendar"
2019-02-20 07:27:17 +01:00
register_svg_icon "chevron-right"
register_svg_icon "chevron-left"
2020-11-10 01:56:11 +01:00
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"
2021-10-05 14:54:06 +02:00
register_svg_icon "bolt"
2019-02-20 07:27:17 +01:00
end
2019-01-14 03:03:42 +01:00
class ::Sprockets::DirectiveProcessor
def process_require_tree_discourse_directive(path = ".")
raise CustomWizard::SprocketsEmptyPath, "path cannot be empty" if path == "."
discourse_asset_path = "#{Rails.root}/app/assets/javascripts/"
path = File.expand_path(path, discourse_asset_path)
stat = @environment.stat(path)
if stat && stat.directory?
require_paths(*@environment.stat_sorted_tree_with_dependencies(path))
else
raise CustomWizard::SprocketsFileNotFound, "#{path} not found in discourse core"
end
end
end
2017-09-23 04:34:07 +02:00
after_initialize do
2020-03-30 08:16:03 +02:00
%w[
../lib/custom_wizard/engine.rb
../config/routes.rb
2020-04-13 14:17:22 +02:00
../controllers/custom_wizard/admin/admin.rb
../controllers/custom_wizard/admin/wizard.rb
../controllers/custom_wizard/admin/submissions.rb
../controllers/custom_wizard/admin/api.rb
2020-04-15 02:46:44 +02:00
../controllers/custom_wizard/admin/logs.rb
../controllers/custom_wizard/admin/manager.rb
2020-10-17 03:31:07 +02:00
../controllers/custom_wizard/admin/custom_fields.rb
2021-09-24 11:58:42 +02:00
../controllers/custom_wizard/admin/subscription.rb
../controllers/custom_wizard/admin/notice.rb
2020-03-30 08:16:03 +02:00
../controllers/custom_wizard/wizard.rb
../controllers/custom_wizard/steps.rb
../controllers/custom_wizard/realtime_validations.rb
../jobs/regular/refresh_api_access_token.rb
../jobs/regular/set_after_time_wizard.rb
2021-09-24 11:58:42 +02:00
../jobs/scheduled/custom_wizard/update_subscription.rb
../jobs/scheduled/custom_wizard/update_notices.rb
../lib/custom_wizard/validators/template.rb
../lib/custom_wizard/validators/update.rb
../lib/custom_wizard/action_result.rb
2020-04-15 02:46:44 +02:00
../lib/custom_wizard/action.rb
2020-03-30 08:16:03 +02:00
../lib/custom_wizard/builder.rb
../lib/custom_wizard/cache.rb
2020-10-20 07:40:23 +02:00
../lib/custom_wizard/custom_field.rb
2020-03-30 08:16:03 +02:00
../lib/custom_wizard/field.rb
2021-01-27 06:08:26 +01:00
../lib/custom_wizard/realtime_validation.rb
../lib/custom_wizard/realtime_validations/result.rb
../lib/custom_wizard/realtime_validations/similar_topics.rb
2020-03-30 08:16:03 +02:00
../lib/custom_wizard/mapper.rb
2020-04-15 02:46:44 +02:00
../lib/custom_wizard/log.rb
2020-03-30 08:16:03 +02:00
../lib/custom_wizard/step_updater.rb
../lib/custom_wizard/step.rb
../lib/custom_wizard/submission.rb
2020-10-31 08:05:50 +01:00
../lib/custom_wizard/template.rb
2020-03-30 08:16:03 +02:00
../lib/custom_wizard/wizard.rb
2021-09-24 11:58:42 +02:00
../lib/custom_wizard/notice.rb
2021-10-05 14:54:06 +02:00
../lib/custom_wizard/notice/connection_error.rb
2021-09-24 11:58:42 +02:00
../lib/custom_wizard/subscription.rb
../lib/custom_wizard/subscription/subscription.rb
../lib/custom_wizard/subscription/authentication.rb
2020-03-30 08:16:03 +02:00
../lib/custom_wizard/api/api.rb
../lib/custom_wizard/api/authorization.rb
../lib/custom_wizard/api/endpoint.rb
../lib/custom_wizard/api/log_entry.rb
../lib/custom_wizard/liquid_extensions/first_non_empty.rb
../lib/custom_wizard/exceptions/exceptions.rb
2020-03-30 08:16:03 +02:00
../serializers/custom_wizard/api/authorization_serializer.rb
../serializers/custom_wizard/api/basic_endpoint_serializer.rb
../serializers/custom_wizard/api/endpoint_serializer.rb
../serializers/custom_wizard/api/log_serializer.rb
../serializers/custom_wizard/api_serializer.rb
../serializers/custom_wizard/basic_api_serializer.rb
2020-04-13 14:17:22 +02:00
../serializers/custom_wizard/basic_wizard_serializer.rb
2020-10-20 07:40:23 +02:00
../serializers/custom_wizard/custom_field_serializer.rb
2020-03-30 08:16:03 +02:00
../serializers/custom_wizard/wizard_field_serializer.rb
../serializers/custom_wizard/wizard_step_serializer.rb
../serializers/custom_wizard/wizard_serializer.rb
2020-04-15 02:46:44 +02:00
../serializers/custom_wizard/log_serializer.rb
../serializers/custom_wizard/submission_serializer.rb
../serializers/custom_wizard/realtime_validation/similar_topics_serializer.rb
2021-09-24 11:58:42 +02:00
../serializers/custom_wizard/subscription/authentication_serializer.rb
../serializers/custom_wizard/subscription/subscription_serializer.rb
../serializers/custom_wizard/subscription_serializer.rb
../serializers/custom_wizard/notice_serializer.rb
../extensions/extra_locales_controller.rb
2020-04-19 08:06:18 +02:00
../extensions/invites_controller.rb
../extensions/users_controller.rb
../extensions/custom_field/preloader.rb
../extensions/custom_field/serializer.rb
../extensions/custom_field/extension.rb
].each do |path|
load File.expand_path(path, __FILE__)
end
2021-03-11 07:30:15 +01:00
Liquid::Template.register_filter(::CustomWizard::LiquidFilter::FirstNonEmpty)
2019-12-05 09:05:21 +01:00
add_class_method(:wizard, :user_requires_completion?) do |user|
wizard_result = self.new(user).requires_completion?
return wizard_result if wizard_result
2019-12-05 09:05:21 +01:00
custom_redirect = false
2019-12-05 09:05:21 +01:00
if user &&
user.first_seen_at.blank? &&
2020-03-30 08:16:03 +02:00
wizard = CustomWizard::Wizard.after_signup(user)
2017-10-15 05:58:22 +02:00
2020-03-30 08:16:03 +02:00
if !wizard.completed?
2019-12-05 09:05:21 +01:00
custom_redirect = true
CustomWizard::Wizard.set_user_redirect(wizard.id, user)
end
end
2019-12-05 09:05:21 +01:00
!!custom_redirect
end
2021-03-11 07:30:15 +01:00
2019-12-05 09:05:21 +01:00
add_to_class(:users_controller, :wizard_path) do
if custom_wizard_redirect = current_user.custom_fields['redirect_to_wizard']
"#{Discourse.base_url}/w/#{custom_wizard_redirect.dasherize}"
else
"#{Discourse.base_url}/wizard"
2017-11-01 05:21:14 +01:00
end
end
2019-12-05 09:05:21 +01:00
add_to_serializer(:current_user, :redirect_to_wizard) do
object.custom_fields['redirect_to_wizard']
end
2018-01-16 08:13:50 +01:00
2020-03-30 01:53:28 +02:00
on(:user_approved) do |user|
2020-04-19 08:42:44 +02:00
if wizard = CustomWizard::Wizard.after_signup(user)
CustomWizard::Wizard.set_user_redirect(wizard.id, user)
end
end
2021-03-11 07:30:15 +01:00
2020-04-19 08:06:18 +02:00
add_to_class(:application_controller, :redirect_to_wizard_if_required) do
wizard_id = current_user.custom_fields['redirect_to_wizard']
@excluded_routes ||= SiteSetting.wizard_redirect_exclude_paths.split('|') + ['/w/']
url = request.referer || request.original_url
2021-03-11 07:30:15 +01:00
if request.format === 'text/html' && !@excluded_routes.any? { |str| /#{str}/ =~ url } && wizard_id
2020-04-19 08:06:18 +02:00
if request.referer !~ /\/w\// && request.referer !~ /\/invites\//
CustomWizard::Wizard.set_wizard_redirect(current_user, wizard_id, request.referer)
2020-04-19 08:06:18 +02:00
end
2020-11-03 01:24:20 +01:00
if CustomWizard::Template.exists?(wizard_id)
2020-04-19 08:06:18 +02:00
redirect_to "/w/#{wizard_id.dasherize}"
end
end
end
2021-03-11 07:30:15 +01:00
2020-04-19 08:06:18 +02:00
add_to_serializer(:site, :include_wizard_required?) do
scope.is_admin? && Wizard.new(scope.user).requires_completion?
end
2021-03-11 07:30:15 +01:00
2020-04-19 08:06:18 +02:00
add_to_serializer(:site, :complete_custom_wizard) do
if scope.user && requires_completion = CustomWizard::Wizard.prompt_completion(scope.user)
2021-03-11 07:30:15 +01:00
requires_completion.map { |w| { name: w[:name], url: "/w/#{w[:id]}" } }
2020-04-19 08:06:18 +02:00
end
end
add_to_serializer(:site, :include_complete_custom_wizard?) do
complete_custom_wizard.present?
end
2021-03-11 07:30:15 +01:00
2020-04-19 08:06:18 +02:00
add_model_callback(:application_controller, :before_action) do
redirect_to_wizard_if_required if current_user
end
2021-03-11 07:30:15 +01:00
::ExtraLocalesController.prepend ExtraLocalesControllerCustomWizard
::InvitesController.prepend InvitesControllerCustomWizard
::UsersController.prepend CustomWizardUsersController
2021-03-11 07:30:15 +01:00
2020-10-31 08:05:50 +01:00
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
2020-10-31 08:05:50 +01:00
end
2021-03-11 07:30:15 +01:00
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
2021-03-11 07:30:15 +01:00
class_constant.singleton_class.prepend CustomWizardCustomFieldPreloader
class_constant.singleton_class.prepend CustomWizardCustomFieldExtension
end
2021-03-11 07:30:15 +01:00
CustomWizard::CustomField.serializers.each do |serializer_klass|
"#{serializer_klass}_serializer".classify.constantize.prepend CustomWizardCustomFieldSerializer
end
2021-09-24 11:58:42 +02:00
AdminDashboardData.add_problem_check do
2021-11-01 14:52:29 +01:00
warning_notices = CustomWizard::Notice.list(
type: CustomWizard::Notice.types[:warning],
archetype: CustomWizard::Notice.archetypes[:plugin_status]
)
2021-09-24 11:58:42 +02:00
warning_notices.any? ? ActionView::Base.full_sanitizer.sanitize(warning_notices.first.message, tags: %w(a)) : nil
end
2018-01-16 08:13:50 +01:00
DiscourseEvent.trigger(:custom_wizard_ready)
2017-09-23 04:34:07 +02:00
end