discourse/plugins/discourse-adplugin/plugin.rb
Sam ede2ffbd86
FEATURE: redesign house ads admin UI with FormKit (#37799)
Modernize the house ads admin interface to align with
Discourse admin UI patterns:

- Extract HouseAdForm component using FormKit, replacing
  the controller-heavy approach with observers and buffered
  state
- Redesign index page with DPageSubheader, tabbed nav
  (Ads/Settings), d-admin-table, and empty state component
- Simplify show page to BackButton + HouseAdForm
- Harden backend controller: use Discourse::NotFound,
  derive id from URL params instead of body, remove id
  from permitted params to prevent injection, remove
  update-creates-if-missing behavior
- Add guard in route for missing house ads
- Fix group mapping to handle both object and scalar values
- Rewrite system spec as full lifecycle test with page object
- Use fab! over let in request specs, add coverage for 404
  and id injection edge cases

---------

Co-authored-by: Martin Brennan <martin@discourse.org>
2026-02-17 13:37:17 +10:00

99 lines
3.4 KiB
Ruby
Executable file

# frozen_string_literal: true
# name: discourse-adplugin
# about: Allows admins to configure advertisements, and integrates with external ad platforms.
# meta_topic_id: 33734
# version: 1.2.5
# authors: Vi and Sarah (@ladydanger and @cyberkoi)
# url: https://github.com/discourse/discourse/tree/main/plugins/discourse-adplugin
register_asset "stylesheets/adplugin.scss"
register_svg_icon "rectangle-ad"
add_admin_route "admin.adplugin.house_ads.title", "discourse-adplugin", use_new_show_route: true
enabled_site_setting :discourse_adplugin_enabled
module ::AdPlugin
PLUGIN_NAME = "discourse-adplugin"
end
require_relative "lib/adplugin/engine"
require_relative "lib/ad_plugin/ad_type"
after_initialize do
require_relative "app/controllers/ad_plugin/house_ad_settings_controller"
require_relative "app/controllers/ad_plugin/house_ads_controller"
require_relative "app/controllers/adstxt_controller"
require_relative "app/controllers/ad_plugin/ad_impressions_controller"
require_relative "app/serializers/ad_plugin/house_ad_serializer"
require_relative "app/models/ad_plugin/house_ad_setting"
require_relative "app/models/ad_plugin/house_ad"
require_relative "app/models/ad_plugin/ad_impression"
require_relative "app/models/concerns/reports/ad_plugin"
require_relative "lib/adplugin/guardian_extensions"
reloadable_patch do
Guardian.prepend AdPlugin::GuardianExtensions
Report.include(Reports::AdPlugin)
end
Discourse::Application.routes.append do
get "/ads.txt" => "adstxt#index"
post "/ad_plugin/ad_impressions/:id" => "ad_plugin/ad_impressions#update"
patch "/ad_plugin/ad_impressions/:id" => "ad_plugin/ad_impressions#update"
post "/ad_plugin/ad_impressions" => "ad_plugin/ad_impressions#create"
mount AdPlugin::Engine, at: "/admin/plugins/pluginad", constraints: AdminConstraint.new
# HTML routes for admin SPA (full page refresh support)
scope "/admin/plugins/discourse-adplugin", constraints: AdminConstraint.new do
get "/house-ads" => "ad_plugin/house_ads#index", :format => false
get "/house-ads/:id" => "ad_plugin/house_ads#show", :format => false
put "/house-ads/:id" => "ad_plugin/house_ads#update", :format => false
delete "/house-ads/:id" => "ad_plugin/house_ads#destroy", :format => false
post "/house-ads" => "ad_plugin/house_ads#create", :format => false
put "/house-settings/:id" => "ad_plugin/house_ad_settings#update", :format => false
end
end
add_to_serializer :site, :house_creatives do
AdPlugin::HouseAdSetting.settings_and_ads(for_anons: scope.anonymous?, scope: scope)
end
add_to_serializer :site, :ad_types do
AdPlugin::AdType.types
end
add_to_serializer :topic_view, :tags_disable_ads do
return false if !SiteSetting.tagging_enabled || !SiteSetting.no_ads_for_tags.present?
return false if object.topic.tags.empty?
!(SiteSetting.no_ads_for_tags.split("|") & object.topic.tags.map(&:name)).empty?
end
add_to_serializer :current_user, :show_dfp_ads do
scope.show_dfp_ads?
end
add_to_serializer :current_user, :show_adsense_ads do
scope.show_adsense_ads?
end
add_to_serializer :current_user, :show_carbon_ads do
scope.show_carbon_ads?
end
add_to_serializer :current_user, :show_amazon_ads do
scope.show_amazon_ads?
end
add_to_serializer :current_user, :show_adbutler_ads do
scope.show_adbutler_ads?
end
add_to_serializer :current_user, :show_to_groups do
scope.show_to_groups?
end
end