Pleroma/lib/pleroma/application.ex

270 lines
7.7 KiB
Elixir
Raw Normal View History

# Pleroma: A lightweight social networking server
# Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
# SPDX-License-Identifier: AGPL-3.0-only
2017-03-17 17:09:58 +01:00
defmodule Pleroma.Application do
use Application
2020-02-11 08:12:57 +01:00
import Cachex.Spec
alias Pleroma.Config
2019-12-09 13:11:54 +01:00
require Logger
2017-03-17 17:09:58 +01:00
@name Mix.Project.config()[:name]
2018-11-20 17:55:03 +01:00
@version Mix.Project.config()[:version]
@repository Mix.Project.config()[:source_url]
2019-08-14 17:55:17 +02:00
@env Mix.env()
2018-11-20 17:55:03 +01:00
def name, do: @name
def version, do: @version
def named_version, do: @name <> " " <> @version
def repository, do: @repository
2018-11-20 17:55:03 +01:00
def user_agent do
if Process.whereis(Pleroma.Web.Endpoint) do
case Config.get([:http, :user_agent], :default) do
:default ->
info = "#{Pleroma.Web.base_url()} <#{Config.get([:instance, :email], "")}>"
named_version() <> "; " <> info
custom ->
custom
end
else
# fallback, if endpoint is not started yet
"Pleroma Data Loader"
end
2018-11-23 17:40:45 +01:00
end
2017-03-17 17:09:58 +01:00
# See http://elixir-lang.org/docs/stable/elixir/Application.html
# for more information on OTP Applications
def start(_type, _args) do
# Scrubbers are compiled at runtime and therefore will cause a conflict
# every time the application is restarted, so we disable module
# conflicts at runtime
Code.compiler_options(ignore_module_conflict: true)
# Disable warnings_as_errors at runtime, it breaks Phoenix live reload
# due to protocol consolidation warnings
Code.compiler_options(warnings_as_errors: false)
Pleroma.Telemetry.Logger.attach()
2020-07-09 17:53:51 +02:00
Config.Holder.save_default()
Pleroma.HTML.compile_scrubbers()
Pleroma.Config.Oban.warn()
2020-02-11 08:12:57 +01:00
Config.DeprecationWarnings.warn()
Pleroma.Web.Plugs.HTTPSecurityPlug.warn_if_disabled()
Pleroma.ApplicationRequirements.verify!()
2019-01-30 16:32:30 +01:00
setup_instrumenters()
2019-12-05 14:18:25 +01:00
load_custom_modules()
Pleroma.Docs.JSON.compile()
2019-01-28 12:09:41 +01:00
2020-03-12 16:28:54 +01:00
adapter = Application.get_env(:tesla, :adapter)
if adapter == Tesla.Adapter.Gun do
2020-03-04 07:23:42 +01:00
if version = Pleroma.OTPVersion.version() do
[major, minor] =
version
|> String.split(".")
|> Enum.map(&String.to_integer/1)
|> Enum.take(2)
if (major == 22 and minor < 2) or major < 22 do
raise "
!!!OTP VERSION WARNING!!!
You are using gun adapter with OTP version #{version}, which doesn't support correct handling of unordered certificates chains. Please update your Erlang/OTP to at least 22.2.
2020-03-04 07:23:42 +01:00
"
end
else
raise "
!!!OTP VERSION WARNING!!!
To support correct handling of unordered certificates chains - OTP version must be > 22.2.
"
end
end
2017-03-17 17:09:58 +01:00
# Define workers and child supervisors to be supervised
2018-03-30 15:01:53 +02:00
children =
[
2019-08-14 17:55:17 +02:00
Pleroma.Repo,
2020-02-11 08:12:57 +01:00
Config.TransferTask,
2019-08-14 17:55:17 +02:00
Pleroma.Emoji,
2020-06-24 07:38:42 +02:00
Pleroma.Web.Plugs.RateLimiter.Supervisor
2018-03-30 15:01:53 +02:00
] ++
2019-08-14 17:55:17 +02:00
cachex_children() ++
2020-03-12 16:28:54 +01:00
http_children(adapter, @env) ++
[
2019-08-14 17:55:17 +02:00
Pleroma.Stats,
2019-09-26 13:49:57 +02:00
Pleroma.JobQueueMonitor,
{Majic.Pool, [name: Pleroma.MajicPool, pool_size: Config.get([:majic_pool, :size], 2)]},
2020-02-11 08:12:57 +01:00
{Oban, Config.get(Oban)}
] ++
2019-09-17 16:44:52 +02:00
task_children(@env) ++
dont_run_in_test(@env) ++
2020-10-07 19:55:16 +02:00
chat_child(chat_enabled?()) ++
[
2019-08-14 17:55:17 +02:00
Pleroma.Web.Endpoint,
Pleroma.Gopher.Server
]
2017-03-17 17:09:58 +01:00
# See http://elixir-lang.org/docs/stable/elixir/Supervisor.html
# for other strategies and supported options
opts = [strategy: :one_for_one, name: Pleroma.Supervisor]
Supervisor.start_link(children, opts)
2017-03-17 17:09:58 +01:00
end
2019-12-05 14:29:17 +01:00
def load_custom_modules do
2020-02-11 08:12:57 +01:00
dir = Config.get([:modules, :runtime_dir])
2019-12-05 14:18:25 +01:00
if dir && File.exists?(dir) do
dir
2019-12-09 12:23:07 +01:00
|> Pleroma.Utils.compile_dir()
2019-12-05 14:18:25 +01:00
|> case do
{:error, _errors, _warnings} ->
raise "Invalid custom modules"
{:ok, modules, _warnings} ->
2019-12-06 11:05:09 +01:00
if @env != :test do
Enum.each(modules, fn mod ->
2019-12-09 13:11:54 +01:00
Logger.info("Custom module loaded: #{inspect(mod)}")
2019-12-06 11:05:09 +01:00
end)
end
2019-12-05 14:18:25 +01:00
:ok
end
end
end
2019-04-04 19:36:57 +02:00
defp setup_instrumenters do
2019-03-25 09:29:04 +01:00
require Prometheus.Registry
if Application.get_env(:prometheus, Pleroma.Repo.Instrumenter) do
:ok =
:telemetry.attach(
"prometheus-ecto",
[:pleroma, :repo, :query],
&Pleroma.Repo.Instrumenter.handle_event/4,
%{}
)
Pleroma.Repo.Instrumenter.setup()
end
2019-03-25 09:29:04 +01:00
Pleroma.Web.Endpoint.MetricsExporter.setup()
Pleroma.Web.Endpoint.PipelineInstrumenter.setup()
# Note: disabled until prometheus-phx is integrated into prometheus-phoenix:
# Pleroma.Web.Endpoint.Instrumenter.setup()
PrometheusPhx.setup()
2019-03-25 09:29:04 +01:00
end
2019-08-14 17:55:17 +02:00
defp cachex_children do
[
build_cachex("used_captcha", ttl_interval: seconds_valid_interval()),
build_cachex("user", default_ttl: 25_000, ttl_interval: 1000, limit: 2500),
build_cachex("object", default_ttl: 25_000, ttl_interval: 1000, limit: 2500),
build_cachex("rich_media", default_ttl: :timer.minutes(120), limit: 5000),
build_cachex("scrubber", limit: 2500),
2019-09-09 20:53:08 +02:00
build_cachex("idempotency", expiration: idempotency_expiration(), limit: 2500),
2019-08-12 12:13:01 +02:00
build_cachex("web_resp", limit: 2500),
build_cachex("emoji_packs", expiration: emoji_packs_expiration(), limit: 10),
2020-06-14 20:02:57 +02:00
build_cachex("failed_proxy_url", limit: 2500),
build_cachex("banned_urls", default_ttl: :timer.hours(24 * 30), limit: 5_000)
2019-08-14 17:55:17 +02:00
]
end
2019-08-12 12:13:01 +02:00
defp emoji_packs_expiration,
do: expiration(default: :timer.seconds(5 * 60), interval: :timer.seconds(60))
2019-08-14 17:55:17 +02:00
defp idempotency_expiration,
2019-08-14 20:01:11 +02:00
do: expiration(default: :timer.seconds(6 * 60 * 60), interval: :timer.seconds(60))
2019-08-14 17:55:17 +02:00
defp seconds_valid_interval,
2020-02-11 08:12:57 +01:00
do: :timer.seconds(Config.get!([Pleroma.Captcha, :seconds_valid]))
2019-08-14 17:55:17 +02:00
2020-07-03 18:18:08 +02:00
@spec build_cachex(String.t(), keyword()) :: map()
def build_cachex(type, opts),
2019-08-14 20:01:11 +02:00
do: %{
id: String.to_atom("cachex_" <> type),
start: {Cachex, :start_link, [String.to_atom(type <> "_cache"), opts]},
type: :worker
}
2019-08-14 17:55:17 +02:00
2020-02-11 08:12:57 +01:00
defp chat_enabled?, do: Config.get([:chat, :enabled])
2019-08-14 17:55:17 +02:00
defp dont_run_in_test(env) when env in [:test, :benchmark], do: []
2019-08-14 17:55:17 +02:00
defp dont_run_in_test(_) do
2020-05-07 11:13:32 +02:00
[
{Registry,
[
name: Pleroma.Web.Streamer.registry(),
keys: :duplicate,
partitions: System.schedulers_online()
]},
Pleroma.Web.FedSockets.Supervisor
2020-05-07 11:13:32 +02:00
]
end
2020-10-07 19:55:16 +02:00
defp chat_child(true) do
[
Pleroma.Web.ChatChannel.ChatChannelState,
{Phoenix.PubSub, [name: Pleroma.PubSub, adapter: Phoenix.PubSub.PG2]}
]
2019-08-14 17:55:17 +02:00
end
2020-10-07 19:55:16 +02:00
defp chat_child(_), do: []
2019-08-14 17:55:17 +02:00
2019-09-17 16:44:52 +02:00
defp task_children(:test) do
[
%{
id: :web_push_init,
start: {Task, :start_link, [&Pleroma.Web.Push.init/0]},
restart: :temporary
}
]
end
defp task_children(_) do
[
%{
id: :web_push_init,
start: {Task, :start_link, [&Pleroma.Web.Push.init/0]},
restart: :temporary
},
%{
id: :internal_fetch_init,
start: {Task, :start_link, [&Pleroma.Web.ActivityPub.InternalFetchActor.init/0]},
restart: :temporary
}
]
end
2020-02-11 08:12:57 +01:00
# start hackney and gun pools in tests
2020-03-12 16:28:54 +01:00
defp http_children(_, :test) do
http_children(Tesla.Adapter.Hackney, nil) ++ http_children(Tesla.Adapter.Gun, nil)
2020-02-11 08:12:57 +01:00
end
2020-03-12 16:28:54 +01:00
defp http_children(Tesla.Adapter.Hackney, _) do
2020-02-11 08:12:57 +01:00
pools = [:federation, :media]
pools =
if Config.get([Pleroma.Upload, :proxy_remote]) do
[:upload | pools]
else
pools
end
for pool <- pools do
options = Config.get([:hackney_pools, pool])
:hackney_pool.child_spec(pool, options)
end
end
defp http_children(Tesla.Adapter.Gun, _) do
2020-05-17 21:16:02 +02:00
Pleroma.Gun.ConnectionPool.children() ++
[{Task, &Pleroma.HTTP.AdapterHelper.Gun.limiter_setup/0}]
end
2020-03-03 10:19:29 +01:00
2020-03-12 16:28:54 +01:00
defp http_children(_, _), do: []
2017-03-17 17:09:58 +01:00
end