1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Application do
14 @name Mix.Project.config()[:name]
15 @version Mix.Project.config()[:version]
16 @repository Mix.Project.config()[:source_url]
20 def version, do: @version
21 def named_version, do: @name <> " " <> @version
22 def repository, do: @repository
25 if Process.whereis(Pleroma.Web.Endpoint) do
26 case Config.get([:http, :user_agent], :default) do
28 info = "#{Pleroma.Web.Endpoint.url()} <#{Config.get([:instance, :email], "")}>"
29 named_version() <> "; " <> info
35 # fallback, if endpoint is not started yet
40 # See http://elixir-lang.org/docs/stable/elixir/Application.html
41 # for more information on OTP Applications
42 def start(_type, _args) do
43 # Scrubbers are compiled at runtime and therefore will cause a conflict
44 # every time the application is restarted, so we disable module
45 # conflicts at runtime
46 Code.compiler_options(ignore_module_conflict: true)
47 # Disable warnings_as_errors at runtime, it breaks Phoenix live reload
48 # due to protocol consolidation warnings
49 Code.compiler_options(warnings_as_errors: false)
50 Config.Holder.save_default()
51 Pleroma.HTML.compile_scrubbers()
52 Pleroma.Config.Oban.warn()
53 Config.DeprecationWarnings.warn()
54 Pleroma.Web.Plugs.HTTPSecurityPlug.warn_if_disabled()
55 Pleroma.ApplicationRequirements.verify!()
57 Pleroma.Docs.JSON.compile()
60 # Define workers and child supervisors to be supervised
66 Pleroma.Web.Plugs.RateLimiter.Supervisor,
67 Pleroma.Web.Telemetry,
68 {Task.Supervisor, name: Pleroma.TaskSupervisor}
74 Pleroma.JobQueueMonitor,
75 {Majic.Pool, [name: Pleroma.MajicPool, pool_size: Config.get([:majic_pool, :size], 2)]},
76 {Oban, Config.get(Oban)},
79 elasticsearch_children() ++
80 task_children(@mix_env) ++
81 dont_run_in_test(@mix_env)
83 # See http://elixir-lang.org/docs/stable/elixir/Supervisor.html
84 # for other strategies and supported options
85 # If we have a lot of caches, default max_restarts can cause test
87 # Go for the default 3 unless we're in test
89 if @mix_env == :test do
95 opts = [strategy: :one_for_one, name: Pleroma.Supervisor, max_restarts: max_restarts]
97 with {:ok, data} <- Supervisor.start_link(children, opts) do
98 set_postgres_server_version()
102 Logger.error("Failed to start!")
103 Logger.error("#{inspect(e)}")
108 defp set_postgres_server_version do
110 with %{rows: [[version]]} <- Ecto.Adapters.SQL.query!(Pleroma.Repo, "show server_version"),
111 {num, _} <- Float.parse(version) do
116 "Could not get the postgres version: #{inspect(e)}.\nSetting the default value of 9.6"
122 :persistent_term.put({Pleroma.Repo, :postgres_version}, version)
125 def load_custom_modules do
126 dir = Config.get([:modules, :runtime_dir])
128 if dir && File.exists?(dir) do
130 |> Pleroma.Utils.compile_dir()
132 {:error, _errors, _warnings} ->
133 raise "Invalid custom modules"
135 {:ok, modules, _warnings} ->
136 if @mix_env != :test do
137 Enum.each(modules, fn mod ->
138 Logger.info("Custom module loaded: #{inspect(mod)}")
147 defp cachex_children do
149 build_cachex("used_captcha", ttl_interval: seconds_valid_interval()),
150 build_cachex("user", default_ttl: 25_000, ttl_interval: 1000, limit: 2500),
151 build_cachex("object", default_ttl: 25_000, ttl_interval: 1000, limit: 2500),
152 build_cachex("rich_media", default_ttl: :timer.minutes(120), limit: 5000),
153 build_cachex("scrubber", limit: 2500),
154 build_cachex("scrubber_management", limit: 2500),
155 build_cachex("idempotency", expiration: idempotency_expiration(), limit: 2500),
156 build_cachex("web_resp", limit: 2500),
157 build_cachex("emoji_packs", expiration: emoji_packs_expiration(), limit: 10),
158 build_cachex("failed_proxy_url", limit: 2500),
159 build_cachex("banned_urls", default_ttl: :timer.hours(24 * 30), limit: 5_000),
160 build_cachex("translations", default_ttl: :timer.hours(24 * 30), limit: 2500),
161 build_cachex("instances", default_ttl: :timer.hours(24), ttl_interval: 1000, limit: 2500),
162 build_cachex("request_signatures", default_ttl: :timer.hours(24 * 30), limit: 3000)
166 defp emoji_packs_expiration,
167 do: expiration(default: :timer.seconds(5 * 60), interval: :timer.seconds(60))
169 defp idempotency_expiration,
170 do: expiration(default: :timer.seconds(6 * 60 * 60), interval: :timer.seconds(60))
172 defp seconds_valid_interval,
173 do: :timer.seconds(Config.get!([Pleroma.Captcha, :seconds_valid]))
175 @spec build_cachex(String.t(), keyword()) :: map()
176 def build_cachex(type, opts),
178 id: String.to_atom("cachex_" <> type),
179 start: {Cachex, :start_link, [String.to_atom(type <> "_cache"), opts]},
183 defp dont_run_in_test(env) when env in [:test, :benchmark], do: []
185 defp dont_run_in_test(_) do
189 name: Pleroma.Web.Streamer.registry(),
191 partitions: System.schedulers_online()
193 ] ++ background_migrators()
196 defp background_migrators do
198 Pleroma.Migrators.HashtagsTableMigrator
202 @spec task_children(atom()) :: [map()]
204 defp task_children(:test) do
208 start: {Task, :start_link, [&Pleroma.Web.Push.init/0]},
214 defp task_children(_) do
218 start: {Task, :start_link, [&Pleroma.Web.Push.init/0]},
222 id: :internal_fetch_init,
223 start: {Task, :start_link, [&Pleroma.Web.ActivityPub.InternalFetchActor.init/0]},
229 @spec elasticsearch_children :: [Pleroma.Search.Elasticsearch.Cluster]
230 def elasticsearch_children do
231 config = Config.get([Pleroma.Search, :module])
233 if config == Pleroma.Search.Elasticsearch do
234 [Pleroma.Search.Elasticsearch.Cluster]
240 @spec limiters_setup() :: :ok
241 def limiters_setup do
242 config = Config.get(ConcurrentLimiter, [])
245 Pleroma.Web.RichMedia.Helpers,
246 Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
249 |> Enum.each(fn module ->
250 mod_config = Keyword.get(config, module, [])
252 max_running = Keyword.get(mod_config, :max_running, 5)
253 max_waiting = Keyword.get(mod_config, :max_waiting, 5)
255 ConcurrentLimiter.new(module, max_running, max_waiting)
259 defp http_children do
260 proxy_url = Config.get([:http, :proxy_url])
261 proxy = Pleroma.HTTP.AdapterHelper.format_proxy(proxy_url)
266 |> Pleroma.HTTP.AdapterHelper.maybe_add_proxy_pool(proxy)
267 |> Keyword.put(:name, MyFinch)