federails-moderation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 77a1dbaadfa4f01d0bfa8be0f60c375f058681eae11f86c7653c16287d2807a4
+  data.tar.gz: 73a7dce31e8dda52937779d0c3028d5b52996d01c77203456997715db7999ca8
+SHA512:
+  metadata.gz: dfd71ccba76ac2565aae73c3f4c884ee30c4ae9ac5daecc7db5f8ac2b4d924da599e8c260d6a111cc91341c8897e3228fad491e4230e576986109c7afcdc1530
+  data.tar.gz: 1ab673cae009ca57ab252b4cbd777f2b7e451b63f017d6a73598bba8c3e5befaab962184eb9fe88bfb9b2431f319dc0db9831f7019c167a6a667673b5b683a58

data/README.md

@@ -0,0 +1,80 @@
+# Federails::Moderation
+
+A gem that provides moderation capabilities for [Federails](https://gitlab.com/experimentslabs/federails). It adds the following features:
+
+* Handle incoming `Flag` activities, normally used for reporting content to moderators
+* Block federation with particular servers
+
+## Requirements
+
+* [Federails](https://gitlab.com/experimentslabs/federails) >= 0.4
+* Ruby >= 3.0
+
+## Installation
+Add the gem to your Rails application:
+
+```bash
+> bundle add "federails-moderation"
+```
+
+Then install the database migrations:
+
+```bash
+> bin/rails federails_moderation:install:migrations
+> bin/rails db:migrate
+```
+
+## Usage
+
+### Reports
+
+When your application receives a `Flag` activitypub message, it will create a `Federails::Moderation::Report` record with the details.
+
+```ruby
+# Find all unresolved reports
+reports = Federails::Moderation::Report.where(resolution: nil)
+r = reports.first
+
+# Reports can have a comment that was sent with them:
+puts r.content
+# "This message is spam"
+
+# It will be associated with the actor that sent it:
+puts r.actor.at_address
+# "@floppy@mastodon.me.uk"
+
+# Deal with the report in your app, then either:
+r.resolve!
+# or, you can ignore it
+r.ignore!
+
+```
+
+### Domain Blocks
+
+You can block domains that are abusive like so:
+
+```
+Federails::Moderation::DomainBlock.create(domain: "spammer.com")
+```
+
+Once the block is created, incoming messages from that domain, or from any actor on that domain, will be ignored. Also, outgoing messages to that domain will be dropped before being delivered.
+
+Actors from the blocked domain aren't currently auto-removed; this may be added in the future, but for now that's left up to your application.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/manyfold3d/federails-moderation. This project is intended to be a safe, welcoming space for collaboration; everyone interacting in the project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/manyfold3d/federails-moderation/blob/master/CODE_OF_CONDUCT.md).
+
+## Support & Community
+
+For help, join the main [Federails matrix chat room](https://matrix.to/#/#federails:matrix.org).
+
+## Acknowledgements
+
+This gem builds on top of [Federails](https://gitlab.com/experimentslabs/federails), by [Manuel Tancoigne](https://gitlab.com/mtancoigne).
+
+This gem was created as part of [Manyfold](https://manyfold.app), with funding from [NGI0 Entrust](https://nlnet.nl/entrust), a fund established by [NLnet](https://nlnet.nl) with financial support from the European Commission's [Next Generation Internet](https://ngi.eu) program.
+
+[<img src="https://nlnet.nl/logo/banner.png" alt="NLnet foundation logo" width="20%" />](https://nlnet.nl)
+[<img src="https://nlnet.nl/image/logos/NGI0_tag.svg" alt="NGI Zero Logo" width="20%" />](https://nlnet.nl/entrust)

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/models/federails/moderation/domain_block.rb

@@ -0,0 +1,9 @@
+module Federails::Moderation
+  class DomainBlock < ApplicationRecord
+    validates :domain, presence: true, uniqueness: true, "federails/moderation/domain_name": true
+
+    def self.blocked?(query)
+      self.exists?(domain: [ query, PublicSuffix.parse(query).domain ])
+    end
+  end
+end

data/app/models/federails/moderation/report.rb

@@ -0,0 +1,24 @@
+class Federails::Moderation::Report < ApplicationRecord
+  belongs_to :federails_actor, class_name: "Federails::Actor", optional: true
+  belongs_to :object, polymorphic: true, optional: true
+
+  def resolve!
+    update!(resolved_at: DateTime.now, resolution: "resolved")
+  end
+
+  def ignore!
+    update!(resolved_at: DateTime.now, resolution: "ignored")
+  end
+
+  def reporter_address
+    if federails_actor
+      federails_actor.at_address
+    else
+      URI.parse(federated_url).host
+    end
+  end
+
+  def local?
+    federails_actor&.local?
+  end
+end

data/app/services/federails/moderation/application_service.rb

@@ -0,0 +1,7 @@
+module Federails::Moderation
+  class ApplicationService
+    def self.call(*args, &block)
+      new(*args, &block).call
+    end
+  end
+end

data/app/services/federails/moderation/report_creation_service.rb

@@ -0,0 +1,40 @@
+module Federails::Moderation
+  class ReportCreationService < ApplicationService
+    def initialize(activity)
+      @activity = activity
+      Rails.logger.info "Report recieved: #{@activity.inspect}"
+    end
+
+    def call
+      Report.create!(
+        federails_actor: find_reporter,
+        object: find_objects.first,
+        federated_url: @activity["id"],
+        content: @activity["content"]
+      )
+    end
+
+    private
+
+    def find_reporter
+      Federails::Actor.find_or_create_by_federation_url(@activity["actor"])
+    rescue ActiveRecord::RecordInvalid, URI::InvalidURIError
+      # Anonymous reports will try to create invalid actors, so we end up here
+      nil
+    end
+
+    def find_objects
+      objects = Array(@activity["object"]).map { |url|
+        begin
+          # Find reported actors
+          Federails::Actor.find_by_federation_url(url)
+          # Other objects could be here too, but they will come later
+        rescue ActiveRecord::RecordNotFound
+          nil
+        end
+      }.compact
+      Rails.logger.warn "Federails::Moderation cannot currently handle multiple objects in a single report, only the first has been logged" if objects.length > 1
+      objects
+    end
+  end
+end

data/app/validators/federails/moderation/domain_name_validator.rb

@@ -0,0 +1,9 @@
+require "public_suffix"
+
+module Federails::Moderation
+  class DomainNameValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, value)
+      record.errors.add attribute, :invalid unless PublicSuffix.valid?(value, default_rule: nil)
+    end
+  end
+end

data/config/initializers/extensions.rb

@@ -0,0 +1,9 @@
+require "fediverse/inbox"
+require "federails/moderation/filtered_inbox"
+
+Fediverse::Inbox.send(:include, Federails::Moderation::FilteredInbox)
+
+require "fediverse/notifier"
+require "federails/moderation/filtered_notifier"
+
+Fediverse::Notifier.send(:include, Federails::Moderation::FilteredNotifier)

data/config/initializers/handlers.rb

@@ -0,0 +1,5 @@
+require "fediverse/inbox"
+
+Rails.application.config.after_initialize do
+  Fediverse::Inbox.register_handler "Flag", "*", Federails::Moderation::ReportCreationService, :call
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/db/migrate/20241127105043_create_federails_moderation_reports.rb

@@ -0,0 +1,13 @@
+class CreateFederailsModerationReports < ActiveRecord::Migration[7.0]
+  def change
+    create_table :federails_moderation_reports do |t|
+      t.string :federated_url
+      t.references :federails_actor, foreign_key: true
+      t.string :content
+      t.references :object, polymorphic: true
+      t.datetime :resolved_at
+      t.string :resolution
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20241128115659_create_federails_moderation_domain_blocks.rb

@@ -0,0 +1,8 @@
+class CreateFederailsModerationDomainBlocks < ActiveRecord::Migration[7.0]
+  def change
+    create_table :federails_moderation_domain_blocks do |t|
+      t.string "domain", null: false, index: { unique: true }
+      t.timestamps
+    end
+  end
+end

data/lib/federails/moderation/engine.rb

@@ -0,0 +1,9 @@
+require "federails"
+
+module Federails
+  module Moderation
+    class Engine < ::Rails::Engine
+      isolate_namespace Federails::Moderation
+    end
+  end
+end

data/lib/federails/moderation/filtered_inbox.rb

@@ -0,0 +1,18 @@
+module Federails::Moderation
+  module FilteredInbox
+    extend ActiveSupport::Concern
+
+    included do
+      class <<self
+        def filter_request(payload)
+          filtered_dispatch_request(payload) unless
+            (payload["id"] && DomainBlock.blocked?(URI.parse(payload["id"]).host)) ||
+            (payload["actor"] && DomainBlock.blocked?(URI.parse(payload["actor"]).host))
+        end
+
+        alias_method :filtered_dispatch_request, :dispatch_request
+        alias_method :dispatch_request, :filter_request
+      end
+    end
+  end
+end

data/lib/federails/moderation/filtered_notifier.rb

@@ -0,0 +1,16 @@
+module Federails::Moderation
+  module FilteredNotifier
+    extend ActiveSupport::Concern
+
+    included do
+      class <<self
+        def filter_post_to_inbox(to:, message:, from: nil)
+          filtered_post_to_inbox(to: to, message: message, from: from) unless DomainBlock.blocked?(to.server)
+        end
+
+        alias_method :filtered_post_to_inbox, :post_to_inbox
+        alias_method :post_to_inbox, :filter_post_to_inbox
+      end
+    end
+  end
+end

data/lib/federails/moderation/railtie.rb

@@ -0,0 +1,6 @@
+module Federails
+  module Moderation
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/federails/moderation/version.rb

@@ -0,0 +1,5 @@
+module Federails
+  module Moderation
+    VERSION = "0.1.0"
+  end
+end

data/lib/federails/moderation.rb

@@ -0,0 +1,10 @@
+require "federails/moderation/version"
+require "federails/moderation/engine"
+
+module Federails
+  module Moderation
+    def self.table_name_prefix
+      "federails_moderation_"
+    end
+  end
+end

data/lib/tasks/federails/moderation_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :federails_moderation do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: federails-moderation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Smith
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.2
+- !ruby/object:Gem::Dependency
+  name: federails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: public_suffix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Moderation additions for Federails; reporting, limit/suspend, server
+  blocking, etc
+email:
+- james@floppy.org.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/models/federails/moderation/domain_block.rb
+- app/models/federails/moderation/report.rb
+- app/services/federails/moderation/application_service.rb
+- app/services/federails/moderation/report_creation_service.rb
+- app/validators/federails/moderation/domain_name_validator.rb
+- config/initializers/extensions.rb
+- config/initializers/handlers.rb
+- config/routes.rb
+- db/migrate/20241127105043_create_federails_moderation_reports.rb
+- db/migrate/20241128115659_create_federails_moderation_domain_blocks.rb
+- lib/federails/moderation.rb
+- lib/federails/moderation/engine.rb
+- lib/federails/moderation/filtered_inbox.rb
+- lib/federails/moderation/filtered_notifier.rb
+- lib/federails/moderation/railtie.rb
+- lib/federails/moderation/version.rb
+- lib/tasks/federails/moderation_tasks.rake
+homepage: https://github.com/manyfold3d/federails-moderation
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/manyfold3d/federails-moderation
+  source_code_uri: https://github.com/manyfold3d/federails-moderation
+  changelog_uri: https://github.com/manyfold3d/federails-moderation/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Moderation additions for Federails.
+test_files: []