federails 0.5.0 → 0.6.0

data/app/models/federails/following.rb

@@ -9,17 +9,21 @@ module Federails
 
     belongs_to :actor
     belongs_to :target_actor, class_name: 'Federails::Actor'
-    # FIXME: Handle this with something like undelete
     has_many :activities, as: :entity, dependent: :destroy
 
     after_create :after_follow
-    after_create :create_activity
-    after_destroy :destroy_activity
+    after_create :create_activity, if: :locally_instigated?
+    after_update :after_follow_accepted
+    after_destroy :destroy_activity, if: :locally_instigated?
+
+    define_callbacks :on_federails_delete_requested
+
+    set_callback :on_federails_delete_requested, -> { destroy! unless locally_instigated? }
 
     scope :with_actor, ->(actor) { where(actor_id: actor.id).or(where(target_actor_id: actor.id)) }
 
     def federated_url
-      attributes['federated_url'].presence || Federails::Engine.routes.url_helpers.server_actor_following_url(actor_id: actor_id, id: id)
+      attributes['federated_url'].presence || Federails::Engine.routes.url_helpers.server_actor_following_url(actor_id: actor.to_param, id: to_param)
     end
 
     def accept!
@@ -27,6 +31,10 @@ module Federails
       Activity.create! actor: target_actor, action: 'Accept', entity: self
     end
 
+    def follow_activity
+      Activity.find_by actor: actor, action: 'Follow', entity: target_actor
+    end
+
     class << self
       def new_from_account(account, actor:)
         target_actor = Actor.find_or_create_by_account account
@@ -36,18 +44,29 @@ module Federails
 
     private
 
+    def locally_instigated?
+      actor.local?
+    end
+
     def after_follow
-      target_actor&.entity&.run_callbacks :followed, :after do
-        self
-      end
+      return unless target_actor&.entity
+
+      target_actor.entity.class.send(:dispatch_callback, :after_followed, target_actor.entity, self)
+    end
+
+    def after_follow_accepted
+      return unless status_previously_changed? && status == 'accepted'
+      return unless actor&.entity
+
+      actor.entity.class.send(:dispatch_callback, :after_follow_accepted, actor.entity, self)
     end
 
     def create_activity
-      Activity.create! actor: actor, action: 'Create', entity: self
+      Activity.create! actor: actor, action: 'Follow', entity: target_actor
     end
 
     def destroy_activity
-      Activity.create! actor: actor, action: 'Undo', entity: self
+      Activity.create! actor: actor, action: 'Undo', entity: follow_activity
     end
   end
 end

data/app/views/federails/client/actors/_actor.json.jbuilder

@@ -9,6 +9,9 @@ json.extract! actor,
               :followings_url,
               :profile_url,
               :at_address,
-              :user_id,
+              :local,
+              :entity_id,
+              :entity_type,
+              :tombstoned_at,
               :created_at,
               :updated_at

data/app/views/federails/client/actors/gone.html.erb

@@ -0,0 +1 @@
+<%= t('.gone') %>

data/app/views/federails/client/actors/index.html.erb

@@ -27,7 +27,13 @@
   <% end %>
   <% @actors.each do |actor| %>
     <tr>
-      <td><%= actor.name %></td>
+      <td>
+        <% if actor.tombstoned? %>
+          <del><%= actor.name %></del>
+        <% else %>
+          <%= actor.name %>
+        <% end %>
+      </td>
       <td><%= actor.username %></td>
       <td><%= actor.at_address %></td>
       <td><%= actor.local? %></td>

data/app/views/federails/server/activities/_activity.activitypub.jbuilder

@@ -1,13 +1,18 @@
 context = true unless context == false
+addressing = true unless addressing == false
 json.set! '@context', 'https://www.w3.org/ns/activitystreams' if context
 
 json.id Federails::Engine.routes.url_helpers.server_actor_activity_url activity.actor, activity
 json.type activity.action
 json.actor activity.actor.federated_url
-json.to ['https://www.w3.org/ns/activitystreams#Public']
-json.cc [activity.actor.followers_url]
+if addressing
+  json.to ['https://www.w3.org/ns/activitystreams#Public']
+  json.cc [activity.actor.followers_url]
+end
 
-if activity.entity.respond_to? :to_activitypub_object
+if activity.entity.is_a? Federails::Activity
+  json.object { json.partial!('federails/server/activities/activity', activity: activity.entity, context: false, addressing: false) }
+elsif activity.entity.respond_to? :to_activitypub_object
   json.object activity.entity.to_activitypub_object
 elsif activity.entity.respond_to? :federated_url
   json.object activity.entity.federated_url

data/app/views/federails/server/actors/_actor.activitypub.jbuilder

@@ -1,4 +1,4 @@
-actor_data = actor.entity.to_activitypub_object
+actor_data = actor.entity&.to_activitypub_object || {}
 
 json.set! '@context', ([
   'https://www.w3.org/ns/activitystreams',
@@ -9,7 +9,7 @@ json.set! '@context', ([
 
 json.id actor.federated_url
 json.name actor.name
-json.type actor.entity_configuration[:actor_type]
+json.type actor.actor_type
 json.preferredUsername actor.username
 json.inbox actor.inbox_url
 json.outbox actor.outbox_url

data/app/views/federails/server/actors/_tombstone.activitypub.jbuilder

@@ -0,0 +1,9 @@
+json.set! '@context', [
+  'https://www.w3.org/ns/activitystreams',
+  'https://w3id.org/security/v1',
+]
+
+json.id actor.federated_url
+json.type 'Tombstone'
+json.deleted actor.tombstoned_at
+json.formerType actor.actor_type

data/app/views/federails/server/actors/show.activitypub.jbuilder

@@ -1 +1,5 @@
-json.partial! 'federails/server/actors/actor', actor: @actor
+if @actor.tombstoned?
+  json.partial! 'federails/server/actors/tombstone', actor: @actor
+else
+  json.partial! 'federails/server/actors/actor', actor: @actor
+end

data/app/views/federails/server/published/_tombstone.activitypub.jbuilder

@@ -0,0 +1,9 @@
+json.set! '@context', [
+  'https://www.w3.org/ns/activitystreams',
+  'https://w3id.org/security/v1',
+]
+
+json.id publishable.federated_url
+json.type 'Tombstone'
+json.deleted publishable.federails_tombstoned_at
+json.formerType publishable.federails_data_configuration[:handles]

data/app/views/federails/server/published/show.activitypub.jbuilder

@@ -1 +1,5 @@
-json.partial! 'federails/server/published/publishable', publishable: @publishable
+if @publishable.federails_tombstoned?
+  json.partial! 'federails/server/published/tombstone', publishable: @publishable
+else
+  json.partial! 'federails/server/published/publishable', publishable: @publishable
+end

data/db/migrate/20250122160618_add_extensions_to_federails_actors.rb

@@ -0,0 +1,5 @@
+class AddExtensionsToFederailsActors < ActiveRecord::Migration[7.1]
+  def change
+    add_column :federails_actors, :extensions, :json, default: nil, null: true
+  end
+end

data/db/migrate/20250301082500_add_local_to_actors.rb

@@ -0,0 +1,11 @@
+class AddLocalToActors < ActiveRecord::Migration[7.0]
+  def change
+    add_column :federails_actors, :local, :boolean, null: false, default: false
+
+    reversible do |dir|
+      dir.up do
+        exec_update 'UPDATE federails_actors SET local=true WHERE entity_type IS NOT NULL'
+      end
+    end
+  end
+end

data/db/migrate/20250329123939_add_actor_type_to_actors.rb

@@ -0,0 +1,5 @@
+class AddActorTypeToActors < ActiveRecord::Migration[7.2]
+  def change
+    add_column :federails_actors, :actor_type, :string, null: true
+  end
+end

data/db/migrate/20250329123940_add_tombstoned_at_to_actors.rb

@@ -0,0 +1,5 @@
+class AddTombstonedAtToActors < ActiveRecord::Migration[7.0]
+  def change
+    add_column :federails_actors, :tombstoned_at, :datetime, default: nil
+  end
+end

data/lib/federails/configuration.rb

@@ -28,8 +28,12 @@ module Federails
     @@enable_discovery = true
 
     # Does the site allow open registrations? (only used for nodeinfo reporting)
-    mattr_accessor :open_registrations
+    # Can either be a static boolean, or a Proc which will be called to get the state.
+    mattr_writer :open_registrations
     @@open_registrations = false
+    def self.open_registrations
+      @@open_registrations.is_a?(Proc) ? @@open_registrations.call : @@open_registrations
+    end
 
     # Application layout
     mattr_accessor :app_layout

data/lib/federails/data_transformer/note.rb

@@ -3,7 +3,7 @@ module Federails
     module Note
       # Renders a Note. The entity is used to determine actor and generic fields data
       #
-      # @param entity [#federail_actor] A model instance
+      # @param entity [#federail_actor, #federated_url, #created_at, #updated_at] A model instance
       # @param content [String] Note content
       # @param name [String, nil] Optional name/title
       # @param custom [Hash] Optional additional keys (e.g.: attachment, icon, ...). Defaults will override these.

data/lib/federails/maintenance/actors_updater.rb

@@ -0,0 +1,67 @@
+module Federails
+  module Maintenance
+    class ActorsUpdater
+      class << self
+        # Fetches all distant actors again and update their local copy
+        #
+        # A block can be passed with two arguments: the actor being updated and the update status
+        #
+        # @param actors [Integer, Federails::Actor, Array<Federails::Actor>, nil] Actor ID, Actor or list of actors to update.
+        #   If nothing is passed, all distant actors are processed
+        # @example
+        #   Update all distant actors
+        #     Federails::Maintenance::ActorUpdater.run
+        #   With an actor id:
+        #     Federails::Maintenance::ActorUpdater.run 1
+        #   With a federated URL:
+        #     Federails::Maintenance::ActorUpdater.run 'https://example.com/actor'
+        #   With a federated URL:
+        #     Federails::Maintenance::ActorUpdater.run ['https://example.com/actors/1', 'https://example.com/actors/1']
+        #   With actors:
+        #     Federails::Maintenance::ActorUpdater.run Federails::Actor.last(10)
+        #   Update all distant actors and puts status for each actor
+        #     Federails::Maintenance::ActorUpdater.run {|actor, status| puts "#{actor.federated_url}: #{status}"}
+        def run(actors = nil, &block)
+          actors_list(actors).each do |actor|
+            status = update(actor)
+
+            yield(actor, status) if block
+          end
+        end
+
+        private
+
+        # Make a list of actors to update from the passed attribute
+        def actors_list(param) # rubocop:disable Metrics/PerceivedComplexity, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/AbcSize
+          if param.nil?
+            Federails::Actor.distant
+          elsif param.is_a? String
+            [Federails::Actor.distant.find_by!(federated_url: param)]
+          elsif param.is_a? Integer
+            [Federails::Actor.distant.find(param)]
+          elsif param.is_a?(Federails::Actor)
+            [param]
+          elsif param.respond_to?(:pluck) && param.first.is_a?(Federails::Actor)
+            param
+          elsif param.is_a?(Array) && param.first.is_a?(String)
+            Federails::Actor.distant.where(federated_url: param)
+          else
+            raise "Cannot extract actors from #{param.class}"
+          end
+        end
+
+        # @param actor [Federails::Actor]
+        def update(actor)
+          return :ignored_local if actor.local?
+
+          response = Fediverse::Webfinger.fetch_actor_url(actor.federated_url)
+          new_attributes = response.attributes.except 'id', 'uuid', 'created_at', 'updated_at', 'local'
+
+          actor.update(new_attributes) ? :updated : :failed
+        rescue ActiveRecord::RecordNotFound
+          :not_found
+        end
+      end
+    end
+  end
+end

data/lib/federails/utils/actor.rb

@@ -0,0 +1,53 @@
+module Federails
+  module Utils
+    class Actor
+      # List of the attributes computed for local actors
+      COMPUTED_ATTRIBUTES = [
+        :federated_url,
+        :username,
+        :name,
+        :server,
+        :inbox_url,
+        :outbox_url,
+        :followers_url,
+        :followings_url,
+        :profile_url,
+      ].freeze
+
+      class << self
+        # @param actor [Federails::Actor]
+        # @return [Federails::Actor]
+        def tombstone!(actor)
+          if actor.local?
+            tombstone_local_actor actor
+          else
+            tombstone_distant_actor actor
+          end
+
+          actor
+        end
+
+        private
+
+        def tombstone_local_actor(actor)
+          Federails::Actor.transaction do
+            hash = {
+              tombstoned_at: Time.current,
+              entity:        nil,
+            }
+            # Hardcode attributes depending on the actor's entity
+            COMPUTED_ATTRIBUTES.each { |attribute| hash[attribute] = actor.send(attribute) }
+
+            actor.update! hash
+
+            Activity.create! actor: actor, action: 'Delete', entity: actor
+          end
+        end
+
+        def tombstone_distant_actor(actor)
+          actor.update! tombstoned_at: Time.current
+        end
+      end
+    end
+  end
+end

data/lib/federails/utils/object.rb

@@ -20,6 +20,31 @@ module Federails
           from_distant_server(object_or_id)
         end
 
+        # Search for a distant object in actors and configured data entities.
+        #
+        # This is useful to find something when the type is unknown, as an object from a Delete activity.
+        #
+        # @param federated_url [String] Object identifier
+        # @return [Federails::Actor, Federails::DataEntity, Federails::Following, nil]
+        def find_distant_object_in_all(federated_url)
+          # Search in actors
+          object = Federails::Actor.find_by federated_url: federated_url
+          return object if object.present?
+
+          # Search in followings
+          object = Federails::Following.find_by federated_url: federated_url
+          return object if object.present?
+
+          # Search in data entities
+          Federails.configuration.data_types.keys.sort.each do |klass|
+            object = klass.constantize.find_by federated_url: federated_url
+
+            break if object.present?
+          end
+
+          object
+        end
+
         # Finds or initializes an entity from an ActivityPub object or id
         #
         # @see .find_or_initialize

data/lib/federails/version.rb

@@ -1,3 +1,3 @@
 module Federails
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.6.0'.freeze
 end

data/lib/fediverse/inbox.rb

@@ -6,6 +6,9 @@ module Fediverse
     class << self
       # Registers a handler for incoming data
       #
+      # Unless a specific type is not implemented in Federails, you should leave the 'Delete' activity to Federails:
+      # it will dispatch a `on_federails_delete_requested` event on the right objects.
+      #
       # @param activity_type [String] Target activity type ('Create', 'Follow', 'Like', ...)
       #   See https://www.w3.org/TR/activitystreams-vocabulary/#activity-types for a list of common ones
       # @param object_type [String] Type of the related object ('Article', 'Note', ...)
@@ -22,6 +25,8 @@ module Fediverse
       #
       # @param payload [Hash] Dereferenced activity
       def dispatch_request(payload)
+        return dispatch_delete_request(payload) if payload['type'] == 'Delete'
+
         payload['object'] = Fediverse::Request.dereference(payload['object']) if payload.key? 'object'
 
         handlers = get_handlers(payload['type'], payload.dig('object', 'type'))
@@ -36,6 +41,14 @@ module Fediverse
 
       private
 
+      def dispatch_delete_request(payload)
+        payload['object'] = payload['object']['id'] unless payload['object'].is_a? String
+        object = Federails::Utils::Object.find_distant_object_in_all payload['object']
+        return if object.blank?
+
+        object.run_callbacks :on_federails_delete_requested
+      end
+
       def get_handlers(activity_type, object_type)
         {}.merge(@@handlers.dig(activity_type, object_type) || {})
           .merge(@@handlers.dig(activity_type, '*') || {})
@@ -50,7 +63,7 @@ module Fediverse
         Federails::Following.create! actor: actor, target_actor: target_actor, federated_url: activity['id']
       end
 
-      def handle_accept_request(activity)
+      def handle_accept_follow_request(activity)
         original_activity = Request.dereference(activity['object'])
 
         actor        = Federails::Actor.find_or_create_by_object original_activity['actor']
@@ -61,7 +74,7 @@ module Fediverse
         follow.accept!
       end
 
-      def handle_undo_request(activity)
+      def handle_undo_follow_request(activity)
         original_activity = activity['object']
 
         actor        = Federails::Actor.find_or_create_by_object original_activity['actor']
@@ -70,10 +83,18 @@ module Fediverse
         follow = Federails::Following.find_by actor: actor, target_actor: target_actor
         follow&.destroy
       end
+
+      def handle_delete_request(activity)
+        object = Federails::Utils::Object.find_distant_object_in_all(activity['object'])
+        return if object.blank?
+
+        object.run_callbacks :on_federails_delete_requested
+      end
     end
 
     register_handler 'Follow', '*', self, :handle_create_follow_request
-    register_handler 'Accept', 'Follow', self, :handle_accept_request
-    register_handler 'Undo', 'Follow', self, :handle_undo_request
+    register_handler 'Accept', 'Follow', self, :handle_accept_follow_request
+    register_handler 'Undo', 'Follow', self, :handle_undo_follow_request
+    register_handler 'Delete', '*', self, :handle_delete_request
   end
 end

data/lib/fediverse/webfinger.rb

@@ -9,22 +9,14 @@ module Fediverse
     class << self
       ACCOUNT_REGEX = /(?<username>[a-z0-9\-_.]+)(?:@(?<domain>.*))?/
 
-      # Extracts username and domain from a "acct:username@domain" string
-      #
-      # @param account [String] Account string
-      #
-      # @return [MatchData, nil] Matches with +:username+ and +:domain+ or +nil+
-      def split_resource_account(account)
-        /\Aacct:#{ACCOUNT_REGEX}\z/io.match account
-      end
-
-      # Extracts username and domain from a "username@domain" string
+      # Extracts username and domain from an account string.
+      # Accepts forms "user@domain", "@user@domain" and "acct:user@domain"
       #
       # @param account [String] Account string
       #
       # @return [MatchData, nil] Matches with +:username+ and +:domain+ or +nil+
       def split_account(account)
-        /\A#{ACCOUNT_REGEX}\z/io.match account
+        /\A(acct:|@)?#{ACCOUNT_REGEX}\z/io.match account
       end
 
       # Determines if a given account string should be a local account (same host as configured one)
@@ -63,7 +55,7 @@ module Fediverse
       # @return [String, nil] Federation URL if found
       def webfinger(username, domain)
         json = webfinger_response(username, domain)
-        link = json['links'].find { |l| l['type'] == 'application/activity+json' }
+        link = json['links'].find { |l| Mime::Type.lookup(l['type']).to_sym == :activitypub }
 
         link['href'] if link
       end
@@ -110,17 +102,21 @@ module Fediverse
       # Builds a +Federails::Actor+ from a Webfinger response
       # @param data [Hash] Webfinger response
       # @return [Federails::Actor]
-      def webfinger_to_actor(data)
-        Federails::Actor.new federated_url:  data['id'],
-                             username:       data['preferredUsername'],
-                             name:           data['name'],
-                             server:         server_and_port(data['id']),
-                             inbox_url:      data['inbox'],
-                             outbox_url:     data['outbox'],
-                             followers_url:  data['followers'],
-                             followings_url: data['following'],
-                             profile_url:    data['url'],
-                             public_key:     data.dig('publicKey', 'publicKeyPem')
+      def webfinger_to_actor(data) # rubocop:disable Metrics/MethodLength
+        data = data.clone
+        id = data.delete('id')
+        Federails::Actor.new federated_url:  id,
+                             username:       data.delete('preferredUsername'),
+                             actor_type:     data.delete('type'),
+                             name:           data.delete('name'),
+                             server:         server_and_port(id),
+                             inbox_url:      data.delete('inbox'),
+                             outbox_url:     data.delete('outbox'),
+                             followers_url:  data.delete('followers'),
+                             followings_url: data.delete('following'),
+                             profile_url:    data.delete('url'),
+                             public_key:     data.delete('publicKey')&.dig('publicKeyPem'),
+                             extensions:     data.except('@context')
       end
 
       # Makes a simple GET request and returns a +Hash+ from the parsed body

data/lib/tasks/federails_tasks.rake

@@ -1,4 +1,8 @@
-# desc "Explaining what the task does"
-# task :federails do
-#   # Task goes here
-# end
+namespace :federails do
+  desc 'Re-fetches every remote actors to update database'
+  task sync_actors: :environment do
+    Federails::Maintenance::ActorUpdater.run do |actor, status|
+      puts "#{actor.federated_url}: #{status}"
+    end
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: federails
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Manuel Tancoigne
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-22 00:00:00.000000000 Z
+date: 2025-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -137,6 +136,7 @@ files:
 - app/mailers/federails/application_mailer.rb
 - app/models/concerns/federails/actor_entity.rb
 - app/models/concerns/federails/data_entity.rb
+- app/models/concerns/federails/handles_delete_requests.rb
 - app/models/concerns/federails/has_uuid.rb
 - app/models/federails/activity.rb
 - app/models/federails/actor.rb
@@ -159,6 +159,7 @@ files:
 - app/views/federails/client/activities/index.json.jbuilder
 - app/views/federails/client/actors/_actor.json.jbuilder
 - app/views/federails/client/actors/_lookup_form.html.erb
+- app/views/federails/client/actors/gone.html.erb
 - app/views/federails/client/actors/index.html.erb
 - app/views/federails/client/actors/index.json.jbuilder
 - app/views/federails/client/actors/show.html.erb
@@ -177,6 +178,7 @@ files:
 - app/views/federails/server/activities/outbox.activitypub.jbuilder
 - app/views/federails/server/activities/show.activitypub.jbuilder
 - app/views/federails/server/actors/_actor.activitypub.jbuilder
+- app/views/federails/server/actors/_tombstone.activitypub.jbuilder
 - app/views/federails/server/actors/followers.activitypub.jbuilder
 - app/views/federails/server/actors/following.activitypub.jbuilder
 - app/views/federails/server/actors/show.activitypub.jbuilder
@@ -185,6 +187,7 @@ files:
 - app/views/federails/server/nodeinfo/index.nodeinfo.jbuilder
 - app/views/federails/server/nodeinfo/show.nodeinfo.jbuilder
 - app/views/federails/server/published/_publishable.activitypub.jbuilder
+- app/views/federails/server/published/_tombstone.activitypub.jbuilder
 - app/views/federails/server/published/show.activitypub.jbuilder
 - app/views/federails/server/web_finger/find.jrd.jbuilder
 - app/views/federails/server/web_finger/host_meta.xrd.erb
@@ -195,10 +198,16 @@ files:
 - db/migrate/20200712174938_create_federails_activities.rb
 - db/migrate/20241002094500_add_uuids.rb
 - db/migrate/20241002094501_add_keypair_to_actors.rb
+- db/migrate/20250122160618_add_extensions_to_federails_actors.rb
+- db/migrate/20250301082500_add_local_to_actors.rb
+- db/migrate/20250329123939_add_actor_type_to_actors.rb
+- db/migrate/20250329123940_add_tombstoned_at_to_actors.rb
 - lib/federails.rb
 - lib/federails/configuration.rb
 - lib/federails/data_transformer/note.rb
 - lib/federails/engine.rb
+- lib/federails/maintenance/actors_updater.rb
+- lib/federails/utils/actor.rb
 - lib/federails/utils/host.rb
 - lib/federails/utils/object.rb
 - lib/federails/version.rb
@@ -224,7 +233,6 @@ metadata:
   homepage_uri: https://experimentslabs.com
   source_code_uri: https://gitlab.com/experimentslabs/federails/
   changelog_uri: https://gitlab.com/experimentslabs/federails/-/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -239,8 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: An ActivityPub engine for Ruby on Rails
 test_files: []