federails 0.1.0 → 0.3.0

data/app/policies/federails/client/activity_policy.rb

@@ -1,6 +1,9 @@
 module Federails
   module Client
     class ActivityPolicy < Federails::FederailsPolicy
+      def feed?
+        user_with_actor?
+      end
     end
   end
 end

data/app/policies/federails/client/actor_policy.rb

@@ -7,7 +7,7 @@ module Federails
 
       class Scope < Scope
         def resolve
-          scope.local
+          scope
         end
       end
     end

data/app/policies/federails/client/following_policy.rb

@@ -26,9 +26,9 @@ module Federails
       private
 
       def in_following?
-        return false if @user.blank?
+        return false unless user_with_actor?
 
-        @record.actor_id == @user.actor.id || @record.target_actor_id == @user.actor.id
+        @record.actor_id == @user.actor&.id || @record.target_actor_id == @user.actor&.id
       end
     end
   end

data/app/policies/federails/federails_policy.rb

@@ -55,5 +55,9 @@ module Federails
 
       @record.actor_id == @user.actor.id
     end
+
+    def user_with_actor?
+      @user && Federails.actor_entity?(@user) && !!@user.actor
+    end
   end
 end

data/app/policies/federails/server/activity_policy.rb

@@ -1,6 +1,9 @@
 module Federails
   module Server
     class ActivityPolicy < Federails::FederailsPolicy
+      def outbox?
+        true
+      end
     end
   end
 end

data/app/views/federails/client/activities/_activity.html.erb

@@ -1,5 +1,5 @@
 <div>
-  <b><%= activity.actor.name %></b>
+  <b><%= link_to activity.actor.name, federails.client_actor_url(activity.actor) %></b>
   <code><%= activity.action %></code>
   <!-- < %= link_to activity.entity_type, activity.entity %>-->
 </div>

data/app/views/federails/client/activities/feed.html.erb

@@ -1,4 +1,11 @@
-<h1>Your feed !</h1>
+<h1>Your feed</h1>
+<p>
+  This is the list of activities from actors you follow.
+</p>
+
+<% if @activities.size.zero? %>
+  <p>There is nothing to display. Start following things!</p>
+<% end %>
 <% @activities.each do |activity| %>
   <%= render 'activity', activity: activity %>
 <% end %>

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

@@ -1,5 +1,5 @@
 <h1>Listing activities</h1>
 
-<%= @activities.each do |activity| %>
+<% @activities.each do |activity| %>
   <%= render 'activity', activity: activity %>
 <% end %>

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

@@ -1,5 +1,14 @@
 <h1>Listing actors</h1>
 
+<section>
+  Filters:
+  <% if params[:local_only] %>
+    <%= link_to 'All actors', federails.client_actors_url %>
+  <% else %>
+    <%= link_to 'Only local actors', federails.client_actors_url(local_only: true) %>
+  <% end %>
+</section>
+
 <table>
   <thead>
   <tr>
@@ -11,6 +20,11 @@
   </tr>
   </thead>
   <tbody>
+  <% if @actors.size.zero? %>
+    <tr>
+      <td colspan="5">There are no actors to display</td>
+    </tr>
+  <% end %>
   <% @actors.each do |actor| %>
     <tr>
       <td><%= actor.name %></td>

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

@@ -1,100 +1,112 @@
-<h2><%= @actor.name %></h2>
+<h1><%= @actor.name %></h1>
+
+<section>
+  <%= render 'federails/client/followings/follow_actions', user: current_user, actor: @actor %>
+</section>
+
+<section>
+  <% if @actor.local? %>
+    <%= link_to 'All activities', federails.client_actor_activities_path(@actor) %>
+  <% elsif @actor.profile_url %>
+    <%= link_to 'Visit profile', @actor.profile_url %>
+  <% end %>
+</section>
+
+<section>
+  <h2>Actor details</h2>
+
+  <p>
+    <b>Federated url:</b>
+    <%= @actor.federated_url %>
+  </p>
+
+  <p>
+    <b>Username:</b>
+    <%= @actor.username %>
+  </p>
+
+  <p>
+    <b>Inbox URL:</b>
+    <%= @actor.inbox_url %>
+  </p>
+
+  <p>
+    <b>Outbox URL:</b>
+    <%= @actor.outbox_url %>
+  </p>
+
+  <p>
+    <b>Followers URL:</b>
+    <%= @actor.followers_url %>
+  </p>
+
+  <p>
+    <b>Followings URL:</b>
+    <%= @actor.followings_url %>
+  </p>
+
+  <p>
+    <b>Profile url:</b>
+    <% if @actor.profile_url %>
+      <%= link_to 'Profile', @actor.profile_url %>
+    <% end %>
+  </p>
 
-<% if Federails::Client::FollowingPolicy.new(current_user, Federails::Following).create? %>
   <p>
-    <%
-      follow = current_user.actor.follows? @actor
-      if @actor.entity == current_user
-    %>
-      <button role="button" disabled="disabled">That's you</button>
-    <% elsif follow %>
-      Already following (<%= follow.status %>)
-      <%= button_to 'Revoke', federails.client_following_path(follow), method: :delete %>
+    <b>Federation address:</b>
+    <%= @actor.at_address %>
+  </p>
+
+  <p>
+    <% if @actor.local? && @actor.entity_configuration[:profile_url_method] %>
+      <b>Home page:</b>
+      <%= link_to @actor.entity.send(@actor.entity_configuration[:username_field]),
+                  Rails.application.routes.url_helpers.send(@actor.entity_configuration[:profile_url_method], @actor.entity)
+      %>
+    <% elsif @actor.profile_url %>
+      <b>Federation profile URL (JSON):</b>
+      <%= link_to @actor.name, @actor.profile_url %>
     <% else %>
-      <%= button_to 'Follow!', federails.follow_client_followings_path, params: { account: @actor.at_address }, method: :post %>
+      (No homepage)
     <% end %>
   </p>
-<% end %>
-
-<p>
-  <b>Federated url:</b>
-  <%= @actor.federated_url %>
-</p>
-
-<p>
-  <b>Username:</b>
-  <%= @actor.username %>
-</p>
-
-<p>
-  <b>Inbox URL:</b>
-  <%= @actor.inbox_url %>
-</p>
-
-<p>
-  <b>Outbox URL:</b>
-  <%= @actor.outbox_url %>
-</p>
-
-<p>
-  <b>Followers URL:</b>
-  <%= @actor.followers_url %>
-</p>
-
-<p>
-  <b>Followings URL:</b>
-  <%= @actor.followings_url %>
-</p>
-
-<p>
-  <b>Profile url:</b>
-  <% if @actor.profile_url %>
-    <%= link_to 'Profile', @actor.profile_url %>
+</section>
+
+<hr>
+
+<section>
+  <h2>Follows <small>(<em>Who is followed?</em>)</small></h2>
+
+  <% if @actor.following_follows.size.zero? %>
+    <p><%= @actor.username %> follows nothing</p>
   <% end %>
-</p>
 
-<p>
-  <b>Federation address:</b>
-  <%= @actor.at_address %>
-</p>
+  <% @actor.following_follows.each do |following| %>
+    <%= render 'federails/client/followings/follow', following: following %>
+  <% end %>
+</section>
 
-<p>
-  <b>Home page:</b>
-  <% if @actor.local? && Federails::Configuration.user_profile_url_method %>
-    <%= link_to @actor.send(Federails::Configuration.user_username_field), send(Federails::Configuration.user_profile_url_method, @actor.user) %>
-  <% elsif @actor.profile_url %>
-    <%= link_to @actor.name, @actor.profile_url %>
-  <% else %>
-    (No homepage)
+<section>
+  <h2>Followers <small>(<em>Who follows?</em>)</small></h2>
+
+  <% if @actor.following_followers.size.zero? %>
+    <p>Nothing follows <%= @actor.username %></p>
   <% end %>
-</p>
 
-<hr>
+  <% @actor.following_followers.each do |following| %>
+    <%= render 'federails/client/followings/follower', following: following %>
+  <% end %>
+</section>
+
+<section>
+  <%# FIXME: Fetch distant content somehow  %>
+  <h2>10 last activities</h2>
 
-<h2>Follows</h2>
-<% if current_user && current_user == @actor.entity %>
-  <%= render 'federails/client/followings/form', following: Federails::Following.new %>
-<% end %>
-
-<% @actor.following_follows.each do |following| %>
-  <%= render 'federails/client/followings/follow', following: following %>
-<% end %>
-
-<h2>Followers</h2>
-<% @actor.following_followers.each do |following| %>
-  <%= render 'federails/client/followings/follower', following: following %>
-<% end %>
-
-<%= link_to 'Back', federails.client_actors_url %>
-
-<!-- FIXME: Fetch distant content somehow -->
-<h2>10 last activities</h2>
-<% if @actor.local? %>
-  <%= link_to 'All', federails.client_actor_activities_path(@actor) %>
-<% elsif @actor.profile_url %>
-  <%= link_to 'Visit profile', @actor.profile_url %>
-<% end %>
-
-<% @actor.activities.last(10).each do |activity| %>
-  <%= render 'federails/client/activities/activity', activity: activity %>
-<% end %>
+  <% activities = @actor.activities.last(10) %>
+  <% if activities.size.zero? %>
+    <p>No activity to display</p>
+  <% end %>
+  <% activities.each do |activity| %>
+    <%= render 'federails/client/activities/activity', activity: activity %>
+  <% end %>
+</section>

data/app/views/federails/client/common/_client_links.html.erb

@@ -0,0 +1,24 @@
+Federation:
+
+<ul>
+  <%# Available publicly %>
+  <li><%= link_to 'Actors', federails.client_actors_url %></li>
+  <li><%= link_to 'Activities', federails.client_activities_url %></li>
+
+  <%# Available when user has an associated actor %>
+  <% if Federails::Client::ActivityPolicy.new(user, nil).feed? %>
+    <li><%= link_to 'Feed', federails.client_feed_url %></li>
+  <%end %>
+
+  <%# Available when user has an associated actor. The actor must exist to create the link %>
+  <% if Federails.actor_entity?(user) && user.actor.present? %>
+    <li><%= link_to "You (#{user.actor.username})", federails.client_actor_path(user.actor) %></li>
+  <% end %>
+</ul>
+
+<%# Debug information%>
+<% if !Federails::actor_entity?(user) %>
+  <p><%= user.class.name %> is not configured to have an associated actor; you won't be allowed to follow or be followed</p>
+<% elsif !user.actor.present? %>
+  <p>Your account does not have an associated actor; you won't be allowed to follow or be followed</p>
+<% end %>

data/app/views/federails/client/followings/_follow_actions.html.erb

@@ -0,0 +1,32 @@
+<%#
+  Displays buttons to follow/revoke following on a given actor.
+  Requires variables:
+    - user (usually user)
+    - actor (target actor)
+%>
+<p>
+  <% if Federails::Client::FollowingPolicy.new(user, Federails::Following).create? %>
+    <% follow = user.actor.follows? actor %>
+    <% if actor.entity == user %>
+      <button type="button" role="button" disabled="disabled">That's you</button>
+    <% elsif follow %>
+      Already following (<%= follow.status %>)
+      <%= button_to 'Cancel', federails.client_following_path(follow), method: :delete %>
+    <% else %>
+      <%= button_to "Follow #{actor.username}", federails.follow_client_followings_path, params: { account: actor.at_address }, method: :post %>
+    <% end %>
+
+    <% followed = actor.follows? user.actor %>
+    <% if followed %>
+      <% if followed.pending? %>
+        <%= actor.username %> wants to follow you.
+        <%= button_to 'Accept request', federails.accept_client_following_path(followed), method: :put %>
+      <% else %>
+        <%= actor.username %> follows you.
+        <%= button_to 'Revoke', federails.client_following_path(followed), method: :delete %>
+      <% end %>
+    <% end %>
+  <% else %>
+    <%= user.class.name %> is not configured to follow/be followed, or has no associated actor.
+  <% end %>
+</p>

data/app/views/federails/client/followings/_form.html.erb

@@ -1,4 +1,5 @@
 <%= form_for following, url: federails.client_following_url do |f| %>
+  <h1>DELETE ME</h1>
   <% if following.errors.any? %>
     <div class="error_explanation">
       <h2><%= pluralize(following.errors.count, 'error') %> prohibited this following from being saved:</h2>

data/app/views/federails/server/activities/{_activity.json.jbuilder → _activity.activitypub.jbuilder}

@@ -6,4 +6,9 @@ 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]
-json.object activity.entity.federated_url
+
+if 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
+end

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

@@ -0,0 +1,26 @@
+actor_data = actor.entity.to_activitypub_object
+
+json.set! '@context', ([
+  'https://www.w3.org/ns/activitystreams',
+  'https://w3id.org/security/v1',
+] + [
+  actor_data&.delete(:@context),
+].flatten).compact
+
+json.id actor.federated_url
+json.name actor.name
+json.type actor.entity_configuration[:actor_type]
+json.preferredUsername actor.username
+json.inbox actor.inbox_url
+json.outbox actor.outbox_url
+json.followers actor.followers_url
+json.following actor.followings_url
+json.url actor.profile_url
+if actor.public_key
+  json.publicKey do
+    json.id actor.key_id
+    json.owner actor.federated_url
+    json.publicKeyPem actor.public_key
+  end
+end
+json.merge! actor_data

data/app/views/federails/server/nodeinfo/{show.json.jbuilder → show.nodeinfo.jbuilder}

@@ -9,11 +9,12 @@ json.protocols [
 # http://nodeinfo.diaspora.software/ns/schema/2.0 for possible values
 json.services inbound:  [],
               outbound: []
-# FIXME: Don't hardcode this
-json.openRegistrations true
-json.usage users: {
-  total:          @total,
-  activeMonth:    @active_month,
-  activeHalfyear: @active_halfyear,
-}
+json.openRegistrations Federails::Configuration.open_registrations
+if @has_user_counts
+  json.usage users: {
+    total:          @total,
+    activeMonth:    @active_month,
+    activeHalfyear: @active_halfyear,
+  }
+end
 json.metadata({})

data/app/views/federails/server/web_finger/{find.json.jbuilder → find.jrd.jbuilder}

@@ -4,7 +4,7 @@ links = [
   # Federation actor URL
   {
     rel:  'self',
-    type: 'application/activity+json',
+    type: Mime[:activitypub].to_s,
     href: @user.actor.federated_url,
   },
 ]
@@ -17,4 +17,8 @@ if @user.actor.profile_url
              href: @user.actor.profile_url
 end
 
+# Remote following
+links.push rel:      'http://ostatus.org/schema/1.0/subscribe',
+           template: "#{remote_follow_url}?uri={uri}"
+
 json.links links

data/config/initializers/mime_types.rb

@@ -0,0 +1,21 @@
+# Webfinger: https://datatracker.ietf.org/doc/html/rfc7033
+Mime::Type.register 'application/jrd+json', :jrd
+Mime::Type.register 'application/xrd+xml', :xrd
+
+# ActivityPub: https://www.w3.org/TR/activitypub/#retrieving-objects
+Mime::Type.register 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"', :activitypub, ['application/activity+json']
+
+# Nodeinfo: https://github.com/jhass/nodeinfo/blob/main/PROTOCOL.md#retrieval
+Mime::Type.register 'application/json; profile="http://nodeinfo.diaspora.software/ns/schema/2.0#"', :nodeinfo
+
+# Get current request parsers. Apparently we need to do it this way and can't add in-place, see
+# https://api.rubyonrails.org/classes/ActionDispatch/Http/Parameters/ClassMethods.html#method-i-parameter_parsers-3D
+parsers = ActionDispatch::Request.parameter_parsers
+# Copy the default JSON parsing for JSON types
+[:jrd, :activitypub, :nodeinfo].each do |mime_type|
+  parsers[Mime[mime_type].symbol] = parsers[:json]
+end
+# XRD just needs a simple XML parser
+parsers[Mime[:xrd].symbol] = ->(raw_post) { Hash.from_xml(raw_post) || {} }
+# Store updated parsers
+ActionDispatch::Request.parameter_parsers = parsers

data/config/routes.rb

@@ -10,7 +10,11 @@ Federails::Engine.routes.draw do
 
   if Federails.configuration.client_routes_path
     scope Federails.configuration.client_routes_path, module: :client, as: :client do
-      resources :activities, only: [:index, :feed]
+      resources :activities, only: [:index] do
+        collection do
+          get :feed, to: 'activities#feed'
+        end
+      end
       resources :actors, only: [:index, :show] do
         collection do
           get :lookup, to: 'actors#lookup'
@@ -18,7 +22,7 @@ Federails::Engine.routes.draw do
         resources :activities, only: [:index]
       end
       get :feed, to: 'activities#feed'
-      resources :followings, only: [:create, :destroy] do
+      resources :followings, only: [:new, :create, :destroy] do
         collection do
           post :follow, to: 'followings#follow'
         end
@@ -30,7 +34,7 @@ Federails::Engine.routes.draw do
     end
   end
 
-  scope Federails.configuration.server_routes_path, module: :server, as: :server do
+  scope Federails.configuration.server_routes_path, module: :server, as: :server, defaults: { format: :activitypub } do
     resources :actors, only: [:show] do
       member do
         get :followers

data/db/migrate/20200712133150_create_federails_actors.rb

@@ -11,14 +11,12 @@ class CreateFederailsActors < ActiveRecord::Migration[7.0]
       t.string :followings_url
       t.string :profile_url
 
-      t.references :user, null: true, foreign_key: { to_table: Federails.configuration.user_table }
+      t.integer :entity_id, null: true
+      t.string :entity_type, null: true
 
       t.timestamps
       t.index :federated_url, unique: true
+      t.index [:entity_type, :entity_id], name: 'index_federails_actors_on_entity', unique: true
     end
-    remove_foreign_key :federails_actors, :users if foreign_key_exists?(:federails_actors, :users)
-    remove_index :federails_actors, :user_id
-    add_index :federails_actors, :user_id, unique: true
-    add_foreign_key :federails_actors, :users
   end
 end

data/db/migrate/20241002094500_add_uuids.rb

@@ -0,0 +1,13 @@
+class AddUuids < ActiveRecord::Migration[7.0]
+  def change
+    [
+      :federails_actors,
+      :federails_activities,
+      :federails_followings,
+    ].each do |table|
+      change_table table do |t|
+        t.string :uuid, default: nil, index: { unique: true }
+      end
+    end
+  end
+end

data/db/migrate/20241002094501_add_keypair_to_actors.rb

@@ -0,0 +1,8 @@
+class AddKeypairToActors < ActiveRecord::Migration[7.0]
+  def change
+    change_table :federails_actors do |t|
+      t.text :public_key
+      t.text :private_key
+    end
+  end
+end

data/lib/federails/configuration.rb

@@ -25,15 +25,14 @@ module Federails
     mattr_accessor :enable_discovery
     @@enable_discovery = true
 
-    # Site port
+    # Does the site allow open registrations? (only used for nodeinfo reporting)
+    mattr_accessor :open_registrations
+    @@open_registrations = false
+
+    # Application layout
     mattr_accessor :app_layout
     @@app_layout = nil
 
-    # User class name
-    # @deprecated Kept for upgrade compatibility only
-    mattr_accessor :user_class
-    @@user_class = '::User'
-
     # Route path for the federation URLs (to "Federails::Server::*" controllers)
     mattr_accessor :server_routes_path
     @@server_routes_path = :federation
@@ -42,29 +41,13 @@ module Federails
     mattr_accessor :client_routes_path
     @@client_routes_path = :app
 
-    # Method to use for links to user profiles
-    # @deprecated Set profile_url_method option on acts_as_federails_actor instead
-    mattr_accessor :user_profile_url_method
-    @@user_profile_url_method = nil
+    # Default controller to use as base for client controllers
+    mattr_accessor :base_client_controller
+    @@base_client_controller = 'ActionController::Base'
 
-    # Attribute in the user model to use as the user's name
-    # @deprecated Set name_field option on acts_as_federails_actor instead
-    #
-    # It only have sense if you have a separate username attribute
-    mattr_accessor :user_name_field
-    @@user_name_field = nil
-
-    # Attribute in the user model to use as the username for local actors
-    # @deprecated Set username_field option on acts_as_federails_actor instead
-    mattr_accessor :user_username_field
-    @@user_username_field = :id
-
-    ##
-    # @return [String] Table used for user model
-    # @deprecated Kept for upgrade compatibility only
-    def self.user_table
-      @@user_class&.constantize&.table_name
-    end
+    # Route method for remote-following requests
+    mattr_accessor :remote_follow_url_method
+    @@remote_follow_url_method = 'federails.new_client_following_url'
 
     def self.site_host=(value)
       @@site_host = value

data/lib/federails/version.rb

@@ -1,3 +1,3 @@
 module Federails
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/federails.rb

@@ -23,14 +23,22 @@ module Federails
       :site_host,
       :site_port,
       :enable_discovery,
+      :open_registrations,
       :app_layout,
-      :user_class, # @deprecated
       :server_routes_path,
       :client_routes_path,
-      :user_profile_url_method, # @deprecated
-      :user_name_field, # @deprecated
-      :user_username_field, # @deprecated
-    ].each { |key| Configuration.send :"#{key}=", config[key] }
+      :remote_follow_url_method,
+      :base_client_controller,
+    ].each { |key| Configuration.send :"#{key}=", config[key] if config.key?(key) }
+  end
+
+  # @return [Boolean] True if the given model is a possible entity
+  #
+  # @example
+  #   puts "Follow #{some_actor.name}" if actor_entity? current_user
+  def self.actor_entity?(class_or_instance)
+    klass = class_or_instance.is_a?(Class) ? class_or_instance.name : class_or_instance.class.name
+    Configuration.entity_types.key? klass
   end
 end
 # rubocop:enable Style/ClassVars