decidim-spam_signal 0.3.1

data/app/controllers/decidim/spam_signal/admin/application_rules_controller.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require "securerandom"
+
+module Decidim
+  module SpamSignal
+    module Admin
+      class ApplicationRulesController < ApplicationController
+        include FormFactory
+        before_action :config
+        helper Decidim::SpamSignal::Admin::SpamSignalHelper
+        helper_method :current_config, :current_scanner, :rule_type, :available_symbols, :uuid, :current_rule
+        def new
+          @form = RuleForm.new.with_context(handler_name: rule_type)
+        end
+
+        def update
+          unless params["rules"]
+            flash[:alert] = "Can not empty a rule, delete it instead"
+            return redirect_to spam_filter_reports_path
+          end
+          rule = params.require(:rules)
+          rule_id = rule.keys.first
+          raise "No rule_id given" unless rule_id
+          prev_rule = resource_config.rule(rule_id)
+          form = RuleForm.from_params(rules: rule.require(rule_id).permit!.to_h).with_context(handler_name: prev_rule["handler_name"])
+          UpdateRuleCommand.call(
+            current_config,
+            resource_config,
+            form,
+            rule_id
+          ) do |on|
+            on(:invalid) { |e| flash[:alert] = "Can not update the rule" }
+            on(:ok) { flash[:notice] = "Rule has been updated"  }
+            redirect_to spam_filter_reports_path
+          end
+        end
+
+        def edit
+          rule = resource_config.rule(current_rule)
+          @form = RuleForm.from_params(rules: rule["rules"]).with_context(handler_name: rule["handler_name"], id: current_rule)
+        end
+
+        def destroy
+          raise "No rule found" unless current_rule
+          RemoveRuleCommand.call(
+            current_config,
+            resource_config,
+            current_rule
+          ) do |on|
+            on(:invalid) { flash[:alert] = "error on deleting rule" }
+            on(:ok) { flash[:notice] = "rule have been removed" }
+          end
+          redirect_to spam_filter_reports_path
+        end
+
+        def create
+          unless params["rules"]
+            flash[:alert] = "Can not add empty rules"
+            return redirect_to spam_filter_reports_path
+          end
+          rule = params.require(:rules)
+          rule_id = rule.keys.first
+          raise "No rule_id given" unless rule_id
+          form = RuleForm.from_params(rules: rule.require(rule_id).permit!.to_h).with_context(handler_name: rule_type)
+          AddRuleCommand.call(
+            current_config,
+            resource_config,
+            form,
+            rule_id
+          ) do |on|
+            on(:invalid) { |e| flash[:alert] = "Can not add the rule" }
+            on(:ok) { flash[:notice] = "Rule has been added"  }
+            redirect_to spam_filter_reports_path
+          end
+        end
+
+        def resource_config
+          raise Error, "Not implemented"
+        end
+
+        private
+          def current_rule
+            rule = params.permit(:id)["id"]
+          end
+
+          def available_symbols
+            taken_scanners.map do |scanKlass|
+              scanKlass.output_symbols
+            end.flatten
+          end
+
+          def taken_scanners
+            taken_scanner_names.map do |scan|
+              scan_repository.strategy scan
+            end
+          end
+
+          def taken_scanner_names
+            scan_repository.strategies.select { |scan| current_settings.scans.include?("#{scan}") }
+          end
+
+          def scan_repository
+            Decidim::SpamSignal::Scans::ScansRepository.instance
+          end
+
+          def uuid
+            uuid = SecureRandom.uuid
+          end
+
+          def current_settings
+            resource_config
+          end
+
+          def scan_key
+            params.permit(:id)["id"] || nil
+          end
+
+          def rule_type
+            params.permit(:rule)["rule"] || nil
+          end
+
+          def current_scanner
+            return nil unless scan_key
+            scan_repository.strategy(scan_key)
+          end
+          def current_config
+            @current_config ||= Decidim::SpamSignal::Config.where(
+              id: params.require(:config_id),
+              organization: current_organization
+            ).first!
+          end
+      end
+    end
+  end
+end

data/app/controllers/decidim/spam_signal/admin/application_scans_controller.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SpamSignal
+    module Admin
+      class ApplicationScansController < ApplicationController
+        include FormFactory
+        before_action :config
+        helper Decidim::SpamSignal::Admin::SpamSignalHelper
+        helper_method :available_scanners, :current_config, :current_scanner
+
+        def new
+          @form = nil
+          if current_scanner && current_scanner.form
+            @form = current_scanner.form.new(
+              **(resource_config.scan_options(current_scanner.handler_name) || {})
+            ).with_context(
+              config: current_config,
+              handler_name: current_scanner.handler_name
+            )
+          end
+        end
+
+        def update
+          raise "No scanner found" unless current_scanner
+          form = current_scanner.form.from_params(params.require("#{scan_key}".to_sym)).with_context(handler_name: current_scanner.handler_name)
+          UpdateScannerCommand.call(
+            current_config,
+            resource_config,
+            form
+          ) do |on|
+            on(:invalid) { flash[:alert] = "Can not update the scanner" }
+            on(:ok) { flash[:notice] = "Scanner has been updated"  }
+            redirect_to spam_filter_reports_path
+          end
+        end
+
+        def edit
+          raise "No scanner found" unless current_scanner
+          @form = current_scanner.form.new(
+            **(resource_config.scan_options(current_scanner.handler_name) || {})
+          ).with_context(
+            config: current_config,
+            handler_name: current_scanner.handler_name
+          )
+        end
+
+        def destroy
+          raise "No scanner found" unless current_scanner
+          RemoveScannerCommand.call(
+            current_config,
+            resource_config,
+            current_scanner.handler_name
+          ) do |on|
+            on(:invalid) { flash[:alert] = "error on deleting #{current_scanner.handler_name} scanner" }
+            on(:ok) { flash[:notice] = "#{current_scanner.handler_name} scanner have been removed" }
+          end
+          redirect_to spam_filter_reports_path
+        end
+
+        def create
+          raise "No scanner found" unless current_scanner
+          form = current_scanner.form.from_params(params.require("#{scan_key}")).with_context(handler_name: current_scanner.handler_name)
+          AddScannerCommand.call(
+            current_config,
+            resource_config,
+            form
+          ) do |on|
+            on(:invalid) { flash[:alert] = "Can not create the scanner" }
+            on(:ok) { flash[:notice] = "Scanner has been created"  }
+            redirect_to spam_filter_reports_path
+          end
+        end
+        def resource_config
+          raise Error, "Not implemented"
+        end
+        private
+          def available_scanners
+            available_scanner_names.map do |scan|
+               scan_repository.strategy scan
+             end
+          end
+          def available_scanner_names
+            scan_repository.strategies.select { |scan| !current_settings.scans.include?("#{scan}") }
+          end
+
+          def scan_repository
+            Decidim::SpamSignal::Scans::ScansRepository.instance
+          end
+
+          def current_settings
+            resource_config
+          end
+          def scan_key
+            params.permit(:id)["id"] || nil
+          end
+          def current_scanner
+            return nil unless scan_key
+            scan_repository.strategy(scan_key)
+          end
+          def current_config
+            @current_config ||= Decidim::SpamSignal::Config.where(
+              id: params.require(:config_id),
+              organization: current_organization
+            ).first!
+          end
+      end
+    end
+  end
+end

data/app/controllers/decidim/spam_signal/admin/comment_cops_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SpamSignal
+    module Admin
+      class CommentCopsController < ApplicationCopsController
+        def resource_config
+          current_config.comments
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/spam_signal/admin/comment_rules_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SpamSignal
+    module Admin
+      class CommentRulesController < ApplicationRulesController
+        def resource_config
+          current_config.comments
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/spam_signal/admin/comment_scans_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SpamSignal
+    module Admin
+      class CommentScansController < ApplicationScansController
+        def resource_config
+          current_config.comments
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/spam_signal/admin/profile_cops_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SpamSignal
+    module Admin
+      class ProfileCopsController < ApplicationCopsController
+        def resource_config
+          current_config.profiles
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/spam_signal/admin/profile_rules_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SpamSignal
+    module Admin
+      class ProfileRulesController < ApplicationRulesController
+        def resource_config
+          current_config.profiles
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/spam_signal/admin/profile_scans_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SpamSignal
+    module Admin
+      class ProfileScansController < ApplicationScansController
+        def resource_config
+          current_config.profiles
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/spam_signal/admin/spam_filter_reports_controller.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SpamSignal
+    module Admin
+      class SpamFilterReportsController < Decidim::SpamSignal::Admin::ApplicationController
+        include FormFactory
+        helper Decidim::SpamSignal::Admin::SpamSignalHelper
+        before_action :get_config
+        attr_reader :current_config
+        helper_method :available_scanners
+
+        def index
+          @comment_settings = current_config.comments
+          @profile_settings = current_config.profiles
+        end
+
+        private
+          def available_scanners(repo_name)
+            repo = current_config.comments if repo_name == "comments"
+            repo = current_config.profiles if repo_name == "profiles"
+            available_scanner_names(repo).map do |scan|
+              scan_repository.strategy scan
+            end
+          end
+
+          def available_scanner_names(repo)
+            scan_repository.strategies.select { |scan| !repo.scans.include?("#{scan}") }
+          end
+
+          def scan_repository
+            Decidim::SpamSignal::Scans::ScansRepository.instance
+          end
+
+          def get_config
+            @current_config = Decidim::SpamSignal::Config.get_config(current_organization)
+          end
+      end
+    end
+  end
+end

data/app/forms/decidim/spam_signal/cops/lock_settings_form.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SpamSignal
+    module Cops
+      class LockSettingsForm < Decidim::Form
+        include Decidim::SpamSignal::SettingsForm
+        attribute :forbid_creation_enabled, Boolean, default: true
+        attribute :sinalize_user_enabled, Boolean, default: true
+        attribute :hide_comments_enabled, Boolean, default: false
+      end
+    end
+  end
+end

data/app/forms/decidim/spam_signal/cops/no_settings_form.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SpamSignal
+    module Cops
+      class NoSettingsForm < Decidim::Form
+        include Decidim::SpamSignal::SettingsForm
+      end
+    end
+  end
+end

data/app/forms/decidim/spam_signal/cops/sinalize_settings_form.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SpamSignal
+    module Cops
+      class SinalizeSettingsForm < Decidim::Form
+        include Decidim::SpamSignal::SettingsForm
+        attribute :forbid_creation_enabled, Boolean, default: true
+        attribute :send_emails_enabled, Boolean, default: true
+      end
+    end
+  end
+end

data/app/forms/decidim/spam_signal/no_settings_form.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SpamSignal
+    class NoSettingsForm < Decidim::Form
+      include Decidim::SpamSignal::SettingsForm
+    end
+  end
+end

data/app/forms/decidim/spam_signal/rule_form.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SpamSignal
+    class RuleForm < Decidim::Form
+      include Decidim::SpamSignal::SettingsForm
+      attribute :rules, Hash
+    end
+  end
+end

data/app/forms/decidim/spam_signal/scans/allowed_tlds_form.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SpamSignal
+    module Scans
+      class AllowedTldsForm < Decidim::Form
+        include Decidim::SpamSignal::SettingsForm
+        attribute :allowed_tlds_csv, String
+        validates :allowed_tlds_csv, presence: true
+      end
+    end
+  end
+end

data/app/forms/decidim/spam_signal/scans/forbidden_tlds_form.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SpamSignal
+    module Scans
+      class ForbiddenTldsForm < Decidim::Form
+        include Decidim::SpamSignal::SettingsForm
+        attribute :forbidden_tlds_csv, String
+        validates :forbidden_tlds_csv, presence: true
+      end
+    end
+  end
+end

data/app/forms/decidim/spam_signal/scans/word_settings_form.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SpamSignal
+    module Scans
+      class WordSettingsForm < Decidim::Form
+        include Decidim::SpamSignal::SettingsForm
+        attribute :stop_list_words_csv, String
+        validates :stop_list_words_csv, presence: true
+      end
+    end
+  end
+end

data/app/forms/decidim/spam_signal/settings_form.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SpamSignal
+    module SettingsForm
+      extend ActiveSupport::Concern
+
+      included do
+        def form_attributes
+          attributes.except(:id).keys
+        end
+
+        def handler_name
+          raise Error, "no handler_name context" if context.nil? || !context.handler_name.present?
+          context.handler_name
+        end
+
+        def self.human_attribute_name(attr)
+          I18n.t("decidim.spam_signal.forms.#{self.name.demodulize.underscore}.#{attr}")
+        end
+        def model_name
+          ActiveModel::Name.new(self, Decidim::SpamSignal, handler_name)
+        end
+      end
+    end
+  end
+end

data/app/helpers/decidim/spam_signal/admin/spam_signal_helper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Decidim::SpamSignal::Admin
+  module SpamSignalHelper
+    def routes
+      Decidim::SpamSignal::AdminEngine.routes.url_helpers
+    end
+    def cops_list(selected_value)
+      options = Decidim::SpamSignal::Cops::CopsRepository.instance.strategies.map do |key, value|
+        [t("#{value.i18n_key}.name"), key]
+      end
+      selected = options.find { |value, key| "#{key}" == selected_value }.last || nil
+      options_for_select(options, selected: selected)
+    end
+    def to_ban
+      Decidim::SpamSignal::BannedUser.to_ban(@current_organization)
+    end
+    def banned
+      Decidim::SpamSignal::BannedUser.banned_users
+    end
+  end
+end

data/app/helpers/decidim/spam_signal/application_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SpamSignal
+    # Custom helpers, scoped to the spam_signal engine.
+    #
+    module ApplicationHelper
+    end
+  end
+end

data/app/models/decidim/spam_signal/config.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Decidim
+  module SpamSignal
+    class Config < ApplicationRecord
+      self.table_name = "spam_signal_config_tables"
+      belongs_to :organization, foreign_key: :decidim_organization_id, class_name: "Decidim::Organization"
+      validates :organization, presence: true
+      before_save :compute_settings
+      def self.get_config(organization)
+        Config.find_or_create_by!(organization: organization) do |conf|
+          conf.comment_settings = {}
+          conf.profile_settings = {}
+        end
+      end
+
+      def comments
+        @comment_repo ||= SpamConfigRepo.new("comments", self.comment_settings)
+      end
+
+      def profiles
+        @profile_repo ||= SpamConfigRepo.new("profiles", self.profile_settings)
+      end
+
+      def save_settings
+        comment_settings_will_change!
+        profile_settings_will_change!
+        save!
+      end
+
+      private
+        def compute_settings
+          self.comment_settings = {
+            "scans" => comments.scans,
+            "rules" => comments.rules,
+            "spam_cop" => comments.spam_cop,
+            "suspicious_cop" => comments.suspicious_cop
+          }
+          self.profile_settings = {
+            "scans" => profiles.scans,
+            "rules" => profiles.rules,
+            "spam_cop" => profiles.spam_cop,
+            "suspicious_cop" => profiles.suspicious_cop
+          }
+        end
+    end
+  end
+end

data/app/overrides/profiles_noindex.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+##
+# Snippet for insert the meta tag 'noindex' in the head section of the views listed below
+# using Deface gem
+##
+views = ["decidim/profiles/show", 
+         "decidim/user_activities/index",
+         "decidim/user_timeline/index",
+         "decidim/user_conversation/index"].freeze
+
+views.each do |view|
+  Deface::Override.new(:virtual_path => view,
+                       :name => "profiles_noindex",
+                       :insert_after => "erb[loud]:contains('cell \"decidim/profile\"')",
+                       :text => "<% content_for :header_snippets do %><meta name='robots' content='noindex,nofollow'><% end %>")
+end

data/app/packs/images/decidim/spam_signal/entrypoints/spam_signal.js

@@ -0,0 +1 @@
+require.context("../images", true);

data/app/packs/images/decidim/spam_signal/icon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 35 35"><path d="M17.5 35A17.5 17.5 0 1 1 35 17.5 17.52 17.52 0 0 1 17.5 35zm0-33.06A15.56 15.56 0 1 0 33.06 17.5 15.57 15.57 0 0 0 17.5 1.94zm9.5 13.7H8a1 1 0 0 1 0-1.94h19a1 1 0 0 1 0 1.94zm0 3.68H8a1 1 0 0 1 0-1.94h19a1 1 0 0 1 0 1.94zM22.26 23H8a1 1 0 0 1 0-1.94h14.26a1 1 0 0 1 0 1.94z"/></svg>