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!()
58 Pleroma.Docs.JSON.compile()
61 Logger.info("Starting Finch")
62 Finch.start_link(name: MyFinch)
64 # Define workers and child supervisors to be supervised
70 Pleroma.Web.Plugs.RateLimiter.Supervisor
75 Pleroma.JobQueueMonitor,
76 {Majic.Pool, [name: Pleroma.MajicPool, pool_size: Config.get([:majic_pool, :size], 2)]},
77 {Oban, Config.get(Oban)},
80 elasticsearch_children() ++
81 task_children(@mix_env) ++
82 dont_run_in_test(@mix_env) ++
83 shout_child(shout_enabled?())
85 # See http://elixir-lang.org/docs/stable/elixir/Supervisor.html
86 # for other strategies and supported options
87 opts = [strategy: :one_for_one, name: Pleroma.Supervisor]
88 result = Supervisor.start_link(children, opts)
90 set_postgres_server_version()
95 defp set_postgres_server_version do
97 with %{rows: [[version]]} <- Ecto.Adapters.SQL.query!(Pleroma.Repo, "show server_version"),
98 {num, _} <- Float.parse(version) do
103 "Could not get the postgres version: #{inspect(e)}.\nSetting the default value of 9.6"
109 :persistent_term.put({Pleroma.Repo, :postgres_version}, version)
112 def load_custom_modules do
113 dir = Config.get([:modules, :runtime_dir])
115 if dir && File.exists?(dir) do
117 |> Pleroma.Utils.compile_dir()
119 {:error, _errors, _warnings} ->
120 raise "Invalid custom modules"
122 {:ok, modules, _warnings} ->
123 if @mix_env != :test do
124 Enum.each(modules, fn mod ->
125 Logger.info("Custom module loaded: #{inspect(mod)}")
134 defp setup_instrumenters do
135 require Prometheus.Registry
137 if Application.get_env(:prometheus, Pleroma.Repo.Instrumenter) do
141 [:pleroma, :repo, :query],
142 &Pleroma.Repo.Instrumenter.handle_event/4,
146 Pleroma.Repo.Instrumenter.setup()
149 Pleroma.Web.Endpoint.MetricsExporter.setup()
150 Pleroma.Web.Endpoint.PipelineInstrumenter.setup()
152 # Note: disabled until prometheus-phx is integrated into prometheus-phoenix:
153 # Pleroma.Web.Endpoint.Instrumenter.setup()
154 PrometheusPhx.setup()
157 defp cachex_children do
159 build_cachex("used_captcha", ttl_interval: seconds_valid_interval()),
160 build_cachex("user", default_ttl: 25_000, ttl_interval: 1000, limit: 2500),
161 build_cachex("object", default_ttl: 25_000, ttl_interval: 1000, limit: 2500),
162 build_cachex("rich_media", default_ttl: :timer.minutes(120), limit: 5000),
163 build_cachex("scrubber", limit: 2500),
164 build_cachex("idempotency", expiration: idempotency_expiration(), limit: 2500),
165 build_cachex("web_resp", limit: 2500),
166 build_cachex("emoji_packs", expiration: emoji_packs_expiration(), limit: 10),
167 build_cachex("failed_proxy_url", limit: 2500),
168 build_cachex("banned_urls", default_ttl: :timer.hours(24 * 30), limit: 5_000),
169 build_cachex("chat_message_id_idempotency_key",
170 expiration: chat_message_id_idempotency_key_expiration(),
176 defp emoji_packs_expiration,
177 do: expiration(default: :timer.seconds(5 * 60), interval: :timer.seconds(60))
179 defp idempotency_expiration,
180 do: expiration(default: :timer.seconds(6 * 60 * 60), interval: :timer.seconds(60))
182 defp chat_message_id_idempotency_key_expiration,
183 do: expiration(default: :timer.minutes(2), interval: :timer.seconds(60))
185 defp seconds_valid_interval,
186 do: :timer.seconds(Config.get!([Pleroma.Captcha, :seconds_valid]))
188 @spec build_cachex(String.t(), keyword()) :: map()
189 def build_cachex(type, opts),
191 id: String.to_atom("cachex_" <> type),
192 start: {Cachex, :start_link, [String.to_atom(type <> "_cache"), opts]},
196 defp shout_enabled?, do: Config.get([:shout, :enabled])
198 defp dont_run_in_test(env) when env in [:test, :benchmark], do: []
200 defp dont_run_in_test(_) do
204 name: Pleroma.Web.Streamer.registry(),
206 partitions: System.schedulers_online()
208 ] ++ background_migrators()
211 defp background_migrators do
213 Pleroma.Migrators.HashtagsTableMigrator
217 defp shout_child(true) do
219 Pleroma.Web.ShoutChannel.ShoutChannelState,
220 {Phoenix.PubSub, [name: Pleroma.PubSub, adapter: Phoenix.PubSub.PG2]}
224 defp shout_child(_), do: []
226 defp task_children(:test) do
230 start: {Task, :start_link, [&Pleroma.Web.Push.init/0]},
236 defp task_children(_) do
240 start: {Task, :start_link, [&Pleroma.Web.Push.init/0]},
244 id: :internal_fetch_init,
245 start: {Task, :start_link, [&Pleroma.Web.ActivityPub.InternalFetchActor.init/0]},
251 def elasticsearch_children do
252 config = Config.get([Pleroma.Search, :module])
254 if config == Pleroma.Search.Elasticsearch do
255 [Pleroma.Search.Elasticsearch.Cluster]
261 @spec limiters_setup() :: :ok
262 def limiters_setup do
263 config = Config.get(ConcurrentLimiter, [])
266 Pleroma.Web.RichMedia.Helpers,
267 Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
270 |> Enum.each(fn module ->
271 mod_config = Keyword.get(config, module, [])
273 max_running = Keyword.get(mod_config, :max_running, 5)
274 max_waiting = Keyword.get(mod_config, :max_waiting, 5)
276 ConcurrentLimiter.new(module, max_running, max_waiting)