Refactoring of config wrapper

lib/mobilizon/actors/actor.ex

@@ -30,10 +30,11 @@ defmodule Mobilizon.Actors.Actor do
   import Ecto.Changeset
 
   alias Mobilizon.Actors
-  alias Mobilizon.Users.User
   alias Mobilizon.Actors.{Actor, Follower, Member}
+  alias Mobilizon.Config
   alias Mobilizon.Events.{Event, FeedToken}
   alias Mobilizon.Media.File
+  alias Mobilizon.Users.User
 
   alias Mobilizon.Reports.{Report, Note}
 
@@ -207,9 +208,8 @@ defmodule Mobilizon.Actors.Actor do
     pem = [entry] |> :public_key.pem_encode() |> String.trim_trailing()
 
     vars = %{
-      "name" => Mobilizon.CommonConfig.get([:instance, :name], "Mobilizon"),
-      "summary" =>
-        Mobilizon.CommonConfig.get(
+      "name" => Config.get([:instance, :name], "Mobilizon"),
+      "summary" => Config.get(
           [:instance, :description],
           "An internal service actor for this Mobilizon instance"
         ),

lib/mobilizon/application.ex

@@ -2,8 +2,12 @@ defmodule Mobilizon.Application do
   @moduledoc """
   The Mobilizon application
   """
+
   use Application
+
   import Cachex.Spec
+
+  alias Mobilizon.Config
   alias Mobilizon.Service.Export.{Feed, ICalendar}
 
   @name Mix.Project.config()[:name]
@@ -90,7 +94,7 @@ defmodule Mobilizon.Application do
 
   def user_agent do
     info =
-      "#{MobilizonWeb.Endpoint.url()} <#{Mobilizon.CommonConfig.get([:instance, :email], "")}>"
+      "#{MobilizonWeb.Endpoint.url()} <#{Config.get([:instance, :email], "")}>"
 
     named_version() <> "; " <> info
   end

lib/mobilizon/common-config.ex

@@ -1,71 +0,0 @@
-defmodule Mobilizon.CommonConfig do
-  @moduledoc """
-  Instance configuration wrapper
-  """
-
-  def registrations_open?() do
-    instance_config()
-    |> get_in([:registrations_open])
-    |> to_bool
-  end
-
-  def instance_name() do
-    instance_config()
-    |> get_in([:name])
-  end
-
-  def instance_description() do
-    instance_config()
-    |> get_in([:description])
-  end
-
-  def instance_hostname() do
-    instance_config()
-    |> get_in([:hostname])
-  end
-
-  def instance_config(), do: Application.get_env(:mobilizon, :instance)
-
-  defp to_bool(v), do: v == true or v == "true" or v == "True"
-
-  def get(key), do: get(key, nil)
-
-  def get([key], default), do: get(key, default)
-
-  def get([parent_key | keys], default) do
-    case :mobilizon
-         |> Application.get_env(parent_key)
-         |> get_in(keys) do
-      nil -> default
-      any -> any
-    end
-  end
-
-  def get(key, default) do
-    Application.get_env(:mobilizon, key, default)
-  end
-
-  def get!(key) do
-    value = get(key, nil)
-
-    if value == nil do
-      raise("Missing configuration value: #{inspect(key)}")
-    else
-      value
-    end
-  end
-
-  def put([key], value), do: put(key, value)
-
-  def put([parent_key | keys], value) do
-    parent =
-      Application.get_env(:mobilizon, parent_key)
-      |> put_in(keys, value)
-
-    Application.put_env(:mobilizon, parent_key, parent)
-  end
-
-  def put(key, value) do
-    Application.put_env(:mobilizon, key, value)
-  end
-end

lib/mobilizon/config.ex

@@ -0,0 +1,77 @@
+defmodule Mobilizon.Config do
+  @moduledoc """
+  Configuration wrapper.
+  """
+
+  @spec instance_config :: keyword
+  def instance_config, do: Application.get_env(:mobilizon, :instance)
+
+  @spec instance_url :: String.t()
+  def instance_url, do: instance_config()[:instance]
+
+  @spec instance_name :: String.t()
+  def instance_name, do: instance_config()[:name]
+
+  @spec instance_description :: String.t()
+  def instance_description, do: instance_config()[:description]
+
+  @spec instance_version :: String.t()
+  def instance_version, do: instance_config()[:version]
+
+  @spec instance_hostname :: String.t()
+  def instance_hostname, do: instance_config()[:hostname]
+
+  @spec instance_registrations_open? :: boolean
+  def instance_registrations_open?, do: to_boolean(instance_config()[:registrations_open])
+
+  @spec instance_repository :: String.t()
+  def instance_repository, do: instance_config()[:repository]
+
+  @spec instance_email_from :: String.t()
+  def instance_email_from, do: instance_config()[:email_from]
+
+  @spec instance_email_reply_to :: String.t()
+  def instance_email_reply_to, do: instance_config()[:email_reply_to]
+
+  @spec get(module | atom) :: any
+  def get(key), do: get(key, nil)
+
+  @spec get([module | atom]) :: any
+  def get([key], default), do: get(key, default)
+
+  def get([parent_key | keys], default) do
+    case get_in(Application.get_env(:mobilizon, parent_key), keys) do
+      nil -> default
+      any -> any
+    end
+  end
+
+  @spec get(module | atom, any) :: any
+  def get(key, default), do: Application.get_env(:mobilizon, key, default)
+
+  @spec get!(module | atom) :: any
+  def get!(key) do
+    value = get(key, nil)
+
+    if value == nil do
+      raise("Missing configuration value: #{inspect(key)}")
+    else
+      value
+    end
+  end
+
+  @spec put([module | atom], any) :: any
+  def put([key], value), do: put(key, value)
+
+  def put([parent_key | keys], value) do
+    parent = put_in(Application.get_env(:mobilizon, parent_key), keys, value)
+
+    Application.put_env(:mobilizon, parent_key, parent)
+  end
+
+  @spec put(module | atom, any) :: any
+  def put(key, value), do: Application.put_env(:mobilizon, key, value)
+
+  @spec to_boolean(boolean | String.t()) :: boolean
+  defp to_boolean(boolean), do: "true" == String.downcase("#{boolean}")
+end

lib/mobilizon_web/api/utils.ex

@@ -2,7 +2,9 @@ defmodule MobilizonWeb.API.Utils do
   @moduledoc """
   Utils for API
   """
+
   alias Mobilizon.Actors.Actor
+  alias Mobilizon.Config
   alias Mobilizon.Service.Formatter
 
   @doc """
@@ -125,7 +127,7 @@ defmodule MobilizonWeb.API.Utils do
   def make_report_content_html(nil), do: {:ok, {nil, [], []}}
 
   def make_report_content_html(comment) do
-    max_size = Mobilizon.CommonConfig.get([:instance, :max_report_comment_size], 1000)
+    max_size = Config.get([:instance, :max_report_comment_size], 1000)
 
     if String.length(comment) <= max_size do
       {:ok, Formatter.html_escape(comment, "text/plain")}

lib/mobilizon_web/controllers/activity_pub_controller.ex

@@ -5,11 +5,13 @@
 
 defmodule MobilizonWeb.ActivityPubController do
   use MobilizonWeb, :controller
-  alias Mobilizon.{Actors, Actors.Actor}
-  alias MobilizonWeb.ActivityPub.ActorView
+
+  alias Mobilizon.{Actors, Actors.Actor, Config}
   alias Mobilizon.Service.ActivityPub
   alias Mobilizon.Service.Federator
 
+  alias MobilizonWeb.ActivityPub.ActorView
+
   require Logger
 
   action_fallback(:errors)
@@ -17,7 +19,7 @@ defmodule MobilizonWeb.ActivityPubController do
   plug(:relay_active? when action in [:relay])
 
   def relay_active?(conn, _) do
-    if Mobilizon.CommonConfig.get([:instance, :allow_relay]) do
+    if Config.get([:instance, :allow_relay]) do
       conn
     else
       conn

lib/mobilizon_web/controllers/media_proxy_controller.ex

@@ -5,13 +5,16 @@
 
 defmodule MobilizonWeb.MediaProxyController do
   use MobilizonWeb, :controller
+
+  alias Mobilizon.Config
+
   alias MobilizonWeb.ReverseProxy
   alias MobilizonWeb.MediaProxy
 
   @default_proxy_opts [max_body_length: 25 * 1_048_576, http: [follow_redirect: true]]
 
   def remote(conn, %{"sig" => sig64, "url" => url64} = params) do
-    with config <- Mobilizon.CommonConfig.get([:media_proxy], []),
+    with config <- Config.get([:media_proxy], []),
          true <- Keyword.get(config, :enabled, false),
          {:ok, url} <- MediaProxy.decode_url(sig64, url64),
          :ok <- filename_matches(Map.has_key?(params, "filename"), conn.request_path, url) do

lib/mobilizon_web/controllers/node_info_controller.ex

@@ -6,10 +6,8 @@
 defmodule MobilizonWeb.NodeInfoController do
   use MobilizonWeb, :controller
 
-  alias Mobilizon.{Events, Users}
-  alias Mobilizon.CommonConfig
+  alias Mobilizon.{Config, Events, Users}
 
-  @instance Application.get_env(:mobilizon, :instance)
   @node_info_supported_versions ["2.0", "2.1"]
   @node_info_schema_uri "http://nodeinfo.diaspora.software/ns/schema/"
 
@@ -35,14 +33,14 @@ defmodule MobilizonWeb.NodeInfoController do
       version: version,
       software: %{
         name: "mobilizon",
-        version: Keyword.get(@instance, :version)
+        version: Config.instance_version()
       },
       protocols: ["activitypub"],
       services: %{
         inbound: [],
         outbound: ["atom1.0"]
       },
-      openRegistrations: CommonConfig.registrations_open?(),
+      openRegistrations: Config.instance_registrations_open?(),
       usage: %{
         users: %{
           total: Users.count_users()
@@ -51,14 +49,14 @@ defmodule MobilizonWeb.NodeInfoController do
         localComments: Events.count_local_comments()
       },
       metadata: %{
-        nodeName: CommonConfig.instance_name(),
-        nodeDescription: CommonConfig.instance_description()
+        nodeName: Config.instance_name(),
+        nodeDescription: Config.instance_description()
       }
     }
 
     response =
       if version == "2.1" do
-        put_in(response, [:software, :repository], Keyword.get(@instance, :repository))
+        put_in(response, [:software, :repository], Config.instance_repository())
       else
         response
       end

lib/mobilizon_web/media_proxy.ex

@@ -7,6 +7,9 @@ defmodule MobilizonWeb.MediaProxy do
   @moduledoc """
   Handles proxifying media files
   """
+
+  alias Mobilizon.Config
+
   @base64_opts [padding: false]
 
   def url(nil), do: nil
@@ -66,7 +69,7 @@ defmodule MobilizonWeb.MediaProxy do
 
   def build_url(sig_base64, url_base64, filename \\ nil) do
     [
-      Mobilizon.CommonConfig.get([:media_proxy, :base_url], MobilizonWeb.Endpoint.url()),
+      Config.get([:media_proxy, :base_url], MobilizonWeb.Endpoint.url()),
       "proxy",
       sig_base64,
       url_base64,

lib/mobilizon_web/plugs/uploaded_media.ex

@@ -8,10 +8,14 @@ defmodule MobilizonWeb.Plugs.UploadedMedia do
   Serves uploaded media files
   """
 
+  @behaviour Plug
+
   import Plug.Conn
+
+  alias Mobilizon.Config
+
   require Logger
 
-  @behaviour Plug
   # no slashes
   @path "media"
 
@@ -38,7 +42,7 @@ defmodule MobilizonWeb.Plugs.UploadedMedia do
           conn
       end
 
-    config = Mobilizon.CommonConfig.get([MobilizonWeb.Upload])
+    config = Config.get([MobilizonWeb.Upload])
 
     with uploader <- Keyword.fetch!(config, :uploader),
          proxy_remote = Keyword.get(config, :proxy_remote, false),
@@ -75,7 +79,7 @@ defmodule MobilizonWeb.Plugs.UploadedMedia do
     conn
     |> MobilizonWeb.ReverseProxy.call(
       url,
-      Mobilizon.CommonConfig.get([Mobilizon.Upload, :proxy_opts], [])
+      Config.get([Mobilizon.Upload, :proxy_opts], [])
     )
   end
 

lib/mobilizon_web/resolvers/config.ex

@@ -1,19 +1,19 @@
 defmodule MobilizonWeb.Resolvers.Config do
   @moduledoc """
-  Handles the config-related GraphQL calls
+  Handles the config-related GraphQL calls.
   """
 
-  import Mobilizon.CommonConfig
+  alias Mobilizon.Config
 
   @doc """
-  Get config
+  Gets config.
   """
   def get_config(_parent, _params, _context) do
     {:ok,
      %{
-       name: instance_name(),
-       registrations_open: registrations_open?(),
-       description: instance_description()
+       name: Config.instance_name(),
+       registrations_open: Config.instance_registrations_open?(),
+       description: Config.instance_description()
      }}
   end
 end

lib/mobilizon_web/resolvers/user.ex

@@ -2,12 +2,14 @@ defmodule MobilizonWeb.Resolvers.User do
   @moduledoc """
   Handles the user-related GraphQL calls
   """
+
+  alias Mobilizon.{Actors, Config, Users}
   alias Mobilizon.Actors.Actor
-  alias Mobilizon.CommonConfig
-  alias Mobilizon.Users.User
-  alias Mobilizon.{Actors, Users}
   alias Mobilizon.Service.Users.{ResetPassword, Activation}
+  alias Mobilizon.Users.User
+
   import Mobilizon.Users.Guards
+
   require Logger
 
   @doc """
@@ -110,7 +112,7 @@ defmodule MobilizonWeb.Resolvers.User do
   """
   @spec create_user(any(), map(), any()) :: tuple()
   def create_user(_parent, args, _resolution) do
-    with {:registrations_open, true} <- {:registrations_open, CommonConfig.registrations_open?()},
+    with {:registrations_open, true} <- {:registrations_open, Config.instance_registrations_open?()},
          {:ok, %User{} = user} <- Users.register(args) do
       Activation.send_confirmation_email(user)
       {:ok, user}

lib/mobilizon_web/upload.ex

@@ -31,7 +31,11 @@ defmodule MobilizonWeb.Upload do
   * `MobilizonWeb.Upload.Filter`
 
   """
+
   alias Ecto.UUID
+
+  alias Mobilizon.Config
+
   require Logger
 
   @type source ::
@@ -110,26 +114,26 @@ defmodule MobilizonWeb.Upload do
     {size_limit, activity_type} =
       case Keyword.get(opts, :type) do
         :banner ->
-          {Mobilizon.CommonConfig.get!([:instance, :banner_upload_limit]), "Image"}
+          {Config.get!([:instance, :banner_upload_limit]), "Image"}
 
         :avatar ->
-          {Mobilizon.CommonConfig.get!([:instance, :avatar_upload_limit]), "Image"}
+          {Config.get!([:instance, :avatar_upload_limit]), "Image"}
 
         _ ->
-          {Mobilizon.CommonConfig.get!([:instance, :upload_limit]), nil}
+          {Config.get!([:instance, :upload_limit]), nil}
       end
 
     %{
       activity_type: Keyword.get(opts, :activity_type, activity_type),
       size_limit: Keyword.get(opts, :size_limit, size_limit),
-      uploader: Keyword.get(opts, :uploader, Mobilizon.CommonConfig.get([__MODULE__, :uploader])),
-      filters: Keyword.get(opts, :filters, Mobilizon.CommonConfig.get([__MODULE__, :filters])),
+      uploader: Keyword.get(opts, :uploader, Config.get([__MODULE__, :uploader])),
+      filters: Keyword.get(opts, :filters, Config.get([__MODULE__, :filters])),
       description: Keyword.get(opts, :description),
       base_url:
         Keyword.get(
           opts,
           :base_url,
-          Mobilizon.CommonConfig.get([__MODULE__, :base_url], MobilizonWeb.Endpoint.url())
+          Config.get([__MODULE__, :base_url], MobilizonWeb.Endpoint.url())
         )
     }
   end
@@ -173,7 +177,7 @@ defmodule MobilizonWeb.Upload do
   defp url_from_spec(%__MODULE__{name: name}, base_url, {:file, path}) do
     path =
       URI.encode(path, &char_unescaped?/1) <>
-        if Mobilizon.CommonConfig.get([__MODULE__, :link_name], false) do
+        if Config.get([__MODULE__, :link_name], false) do
           "?name=#{URI.encode(name, &char_unescaped?/1)}"
         else
           ""

lib/mobilizon_web/upload/filter/anonymize_filename.ex

@@ -9,11 +9,14 @@ defmodule MobilizonWeb.Upload.Filter.AnonymizeFilename do
 
   Should be used after `MobilizonWeb.Upload.Filter.Dedupe`.
   """
+
   @behaviour MobilizonWeb.Upload.Filter
 
+  alias Mobilizon.Config
+
   def filter(upload) do
     extension = List.last(String.split(upload.name, "."))
-    name = Mobilizon.CommonConfig.get([__MODULE__, :text], random(extension))
+    name = Config.get([__MODULE__, :text], random(extension))
     {:ok, %MobilizonWeb.Upload{upload | name: name}}
   end
 

lib/mobilizon_web/upload/filter/mogrify.ex

@@ -7,13 +7,16 @@ defmodule MobilizonWeb.Upload.Filter.Mogrify do
   @moduledoc """
   Handle mogrify transformations
   """
+
   @behaviour MobilizonWeb.Upload.Filter
 
+  alias Mobilizon.Config
+
   @type conversion :: action :: String.t() | {action :: String.t(), opts :: String.t()}
   @type conversions :: conversion() | [conversion()]
 
   def filter(%MobilizonWeb.Upload{tempfile: file, content_type: "image" <> _}) do
-    filters = Mobilizon.CommonConfig.get!([__MODULE__, :args])
+    filters = Config.get!([__MODULE__, :args])
 
     file
     |> Mogrify.open()

lib/mobilizon_web/uploaders/local.ex

@@ -7,8 +7,11 @@ defmodule MobilizonWeb.Uploaders.Local do
   @moduledoc """
   Local uploader for files
   """
+
   @behaviour MobilizonWeb.Uploaders.Uploader
 
+  alias Mobilizon.Config
+
   def get_file(_) do
     {:ok, {:static_dir, upload_path()}}
   end
@@ -59,6 +62,6 @@ defmodule MobilizonWeb.Uploaders.Local do
   end
 
   def upload_path do
-    Mobilizon.CommonConfig.get!([__MODULE__, :uploads])
+    Config.get!([__MODULE__, :uploads])
   end
 end

lib/service/activity_pub/activity_pub.ex

@@ -10,6 +10,7 @@ defmodule Mobilizon.Service.ActivityPub do
   Every ActivityPub method
   """
 
+  alias Mobilizon.Config
   alias Mobilizon.Events
   alias Mobilizon.Events.{Event, Comment, Participant}
   alias Mobilizon.Service.ActivityPub.Transmogrifier
@@ -521,7 +522,7 @@ defmodule Mobilizon.Service.ActivityPub do
 
     public = is_public?(activity)
 
-    if public && Mobilizon.CommonConfig.get([:instance, :allow_relay]) do
+    if public && Config.get([:instance, :allow_relay]) do
       Logger.info(fn -> "Relaying #{activity.data["id"]} out" end)
       Mobilizon.Service.ActivityPub.Relay.publish(activity)
     end