2018-12-24 05:04:54 +09:00
# Pleroma: A lightweight social networking server
2020-03-02 14:08:45 +09:00
# Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
2018-12-24 05:04:54 +09:00
# SPDX-License-Identifier: AGPL-3.0-only
2017-03-18 01:09:58 +09:00
defmodule Pleroma.Application do
use Application
2020-02-11 16:12:57 +09:00
import Cachex.Spec
alias Pleroma.Config
2019-12-09 21:11:54 +09:00
require Logger
2017-03-18 01:09:58 +09:00
2019-02-02 02:11:23 +09:00
@name Mix.Project . config ( ) [ :name ]
2018-11-21 01:55:03 +09:00
@version Mix.Project . config ( ) [ :version ]
2019-02-02 02:11:23 +09:00
@repository Mix.Project . config ( ) [ :source_url ]
2019-08-15 00:55:17 +09:00
@env Mix . env ( )
2018-11-21 01:55:03 +09:00
def name , do : @name
def version , do : @version
2019-03-05 12:18:43 +09:00
def named_version , do : @name <> " " <> @version
2019-02-01 15:55:10 +09:00
def repository , do : @repository
2018-11-21 01:55:03 +09:00
2019-03-05 12:18:43 +09:00
def user_agent do
2020-09-02 21:45:47 +09:00
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 "
2019-11-25 18:53:11 +09:00
end
2018-11-24 01:40:45 +09:00
end
2017-03-18 01:09:58 +09:00
# See http://elixir-lang.org/docs/stable/elixir/Application.html
# for more information on OTP Applications
def start ( _type , _args ) do
2020-07-14 17:41:30 +09:00
# 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 )
2020-09-01 15:08:54 +09:00
# Disable warnings_as_errors at runtime, it breaks Phoenix live reload
# due to protocol consolidation warnings
Code . compiler_options ( warnings_as_errors : false )
2020-07-15 21:26:25 +09:00
Pleroma.Telemetry.Logger . attach ( )
2020-07-10 00:53:51 +09:00
Config.Holder . save_default ( )
2019-12-09 01:42:40 +09:00
Pleroma.HTML . compile_scrubbers ( )
2020-09-06 18:13:26 +09:00
Pleroma.Config.Oban . warn ( )
2020-02-11 16:12:57 +09:00
Config.DeprecationWarnings . warn ( )
2020-01-28 23:04:13 +09:00
Pleroma.Plugs.HTTPSecurityPlug . warn_if_disabled ( )
2020-06-22 23:27:49 +09:00
Pleroma.ApplicationRequirements . verify! ( )
2019-01-31 00:32:30 +09:00
setup_instrumenters ( )
2019-12-05 22:18:25 +09:00
load_custom_modules ( )
2020-08-06 01:38:55 +09:00
check_system_commands ( )
2020-07-13 00:23:33 +09:00
Pleroma.Docs.JSON . compile ( )
2019-01-28 20:09:41 +09:00
2020-03-13 00:28:54 +09:00
adapter = Application . get_env ( :tesla , :adapter )
if adapter == Tesla.Adapter.Gun do
2020-03-04 15:23:42 +09: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 ! ! !
2020-05-12 23:30:39 +09:00
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 15:23:42 +09:00
"
end
else
raise "
! ! ! OTP VERSION WARNING ! ! !
To support correct handling of unordered certificates chains - OTP version must be > 22.2 .
"
end
2020-03-03 19:24:19 +09:00
end
2017-03-18 01:09:58 +09:00
# Define workers and child supervisors to be supervised
2018-03-30 22:01:53 +09:00
children =
[
2019-08-15 00:55:17 +09:00
Pleroma.Repo ,
2020-02-11 16:12:57 +09:00
Config.TransferTask ,
2019-08-15 00:55:17 +09:00
Pleroma.Emoji ,
2019-11-11 21:13:06 +09:00
Pleroma.Plugs.RateLimiter.Supervisor
2018-03-30 22:01:53 +09:00
] ++
2019-08-15 00:55:17 +09:00
cachex_children ( ) ++
2020-03-13 00:28:54 +09:00
http_children ( adapter , @env ) ++
2019-01-30 20:38:38 +09:00
[
2019-08-15 00:55:17 +09:00
Pleroma.Stats ,
2019-09-26 20:49:57 +09:00
Pleroma.JobQueueMonitor ,
2020-02-11 16:12:57 +09:00
{ Oban , Config . get ( Oban ) }
2019-01-30 20:38:38 +09:00
] ++
2019-09-17 23:44:52 +09:00
task_children ( @env ) ++
2019-08-15 00:55:17 +09:00
streamer_child ( @env ) ++
chat_child ( @env , chat_enabled? ( ) ) ++
2018-11-20 04:58:12 +09:00
[
2019-08-15 00:55:17 +09:00
Pleroma.Web.Endpoint ,
Pleroma.Gopher.Server
2018-11-20 04:58:12 +09:00
]
2017-03-18 01:09:58 +09: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 ]
2019-08-24 00:28:23 +09:00
Supervisor . start_link ( children , opts )
2017-03-18 01:09:58 +09:00
end
2018-02-02 02:23:26 +09:00
2019-12-05 22:29:17 +09:00
def load_custom_modules do
2020-02-11 16:12:57 +09:00
dir = Config . get ( [ :modules , :runtime_dir ] )
2019-12-05 22:18:25 +09:00
if dir && File . exists? ( dir ) do
dir
2019-12-09 20:23:07 +09:00
|> Pleroma.Utils . compile_dir ( )
2019-12-05 22:18:25 +09:00
|> case do
{ :error , _errors , _warnings } ->
raise " Invalid custom modules "
{ :ok , modules , _warnings } ->
2019-12-06 19:05:09 +09:00
if @env != :test do
Enum . each ( modules , fn mod ->
2019-12-09 21:11:54 +09:00
Logger . info ( " Custom module loaded: #{ inspect ( mod ) } " )
2019-12-06 19:05:09 +09:00
end )
end
2019-12-05 22:18:25 +09:00
:ok
end
end
end
2019-04-05 02:36:57 +09:00
defp setup_instrumenters do
2019-03-25 17:29:04 +09:00
require Prometheus.Registry
2019-05-21 08:30:18 +09:00
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 17:29:04 +09:00
Pleroma.Web.Endpoint.MetricsExporter . setup ( )
Pleroma.Web.Endpoint.PipelineInstrumenter . setup ( )
Pleroma.Web.Endpoint.Instrumenter . setup ( )
end
2019-08-15 00:55:17 +09: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-10 03:53:08 +09:00
build_cachex ( " idempotency " , expiration : idempotency_expiration ( ) , limit : 2500 ) ,
2019-08-12 19:13:01 +09:00
build_cachex ( " web_resp " , limit : 2500 ) ,
2019-10-02 05:00:27 +09:00
build_cachex ( " emoji_packs " , expiration : emoji_packs_expiration ( ) , limit : 10 ) ,
2020-06-15 03:02:57 +09:00
build_cachex ( " failed_proxy_url " , limit : 2500 ) ,
2020-06-18 03:13:55 +09:00
build_cachex ( " banned_urls " , default_ttl : :timer . hours ( 24 * 30 ) , limit : 5_000 )
2019-08-15 00:55:17 +09:00
]
end
2018-11-20 04:58:12 +09:00
2019-08-12 19:13:01 +09:00
defp emoji_packs_expiration ,
do : expiration ( default : :timer . seconds ( 5 * 60 ) , interval : :timer . seconds ( 60 ) )
2019-08-15 00:55:17 +09:00
defp idempotency_expiration ,
2019-08-15 03:01:11 +09:00
do : expiration ( default : :timer . seconds ( 6 * 60 * 60 ) , interval : :timer . seconds ( 60 ) )
2019-08-15 00:55:17 +09:00
defp seconds_valid_interval ,
2020-02-11 16:12:57 +09:00
do : :timer . seconds ( Config . get! ( [ Pleroma.Captcha , :seconds_valid ] ) )
2019-08-15 00:55:17 +09:00
2020-07-04 01:18:08 +09:00
@spec build_cachex ( String . t ( ) , keyword ( ) ) :: map ( )
def build_cachex ( type , opts ) ,
2019-08-15 03:01:11 +09:00
do : %{
id : String . to_atom ( " cachex_ " <> type ) ,
start : { Cachex , :start_link , [ String . to_atom ( type <> " _cache " ) , opts ] } ,
type : :worker
}
2019-08-15 00:55:17 +09:00
2020-02-11 16:12:57 +09:00
defp chat_enabled? , do : Config . get ( [ :chat , :enabled ] )
2019-08-15 00:55:17 +09:00
2020-01-14 20:42:30 +09:00
defp streamer_child ( env ) when env in [ :test , :benchmark ] , do : [ ]
2019-08-15 00:55:17 +09:00
defp streamer_child ( _ ) do
2020-05-07 18:13:32 +09:00
[
{ Registry ,
[
name : Pleroma.Web.Streamer . registry ( ) ,
keys : :duplicate ,
partitions : System . schedulers_online ( )
] }
]
2018-02-02 02:23:26 +09:00
end
2019-01-30 20:38:38 +09:00
2019-08-15 00:55:17 +09:00
defp chat_child ( _env , true ) do
[ Pleroma.Web.ChatChannel.ChatChannelState ]
end
defp chat_child ( _ , _ ) , do : [ ]
2019-09-17 23:44:52 +09: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 16:12:57 +09:00
# start hackney and gun pools in tests
2020-03-13 00:28:54 +09:00
defp http_children ( _ , :test ) do
2020-05-06 07:51:10 +09:00
http_children ( Tesla.Adapter.Hackney , nil ) ++ http_children ( Tesla.Adapter.Gun , nil )
2020-02-11 16:12:57 +09:00
end
2020-03-13 00:28:54 +09:00
defp http_children ( Tesla.Adapter.Hackney , _ ) do
2020-02-11 16:12:57 +09: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
2020-05-06 07:51:10 +09:00
defp http_children ( Tesla.Adapter.Gun , _ ) do
2020-05-18 04:16:02 +09:00
Pleroma.Gun.ConnectionPool . children ( ) ++
[ { Task , & Pleroma.HTTP.AdapterHelper.Gun . limiter_setup / 0 } ]
2020-05-06 07:51:10 +09:00
end
2020-03-03 18:19:29 +09:00
2020-03-13 00:28:54 +09:00
defp http_children ( _ , _ ) , do : [ ]
2020-08-06 01:38:55 +09:00
defp check_system_commands do
filters = Config . get ( [ Pleroma.Upload , :filters ] )
check_filter = fn filter , command_required ->
with true <- filter in filters ,
false <- Pleroma.Utils . command_available? ( command_required ) do
Logger . error (
" #{ filter } is specified in list of Pleroma.Upload filters, but the #{ command_required } command is not found "
)
end
end
check_filter . ( Pleroma.Upload.Filters.Exiftool , " exiftool " )
check_filter . ( Pleroma.Upload.Filters.Mogrify , " mogrify " )
check_filter . ( Pleroma.Upload.Filters.Mogrifun , " mogrify " )
end
2017-03-18 01:09:58 +09:00
end