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.Web.ActivityPub.MRF do
8 @behaviour Pleroma.Web.ActivityPub.MRF.PipelineFiltering
10 @mrf_config_descriptions [
17 description: "General MRF settings",
21 type: [:module, {:list, :module}],
23 "A list of MRF policies enabled. Module names are shortened (removed leading `Pleroma.Web.ActivityPub.MRF.` part), but on adding custom module you need to use full name.",
24 suggestions: {:list_behaviour_implementations, Pleroma.Web.ActivityPub.MRF.Policy}
28 label: "MRF transparency",
31 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
34 key: :transparency_exclusions,
35 label: "MRF transparency exclusions",
36 type: {:list, :tuple},
37 key_placeholder: "instance",
38 value_placeholder: "reason",
40 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value. You can also provide a reason for excluding these instance names. The instances and reasons won't be publicly disclosed.",
46 key: :transparency_obfuscate_domains,
47 label: "MRF domain obfuscation",
48 type: {:list, :string},
50 "Obfuscate domains in MRF transparency. This is useful if the domain you're blocking contains words you don't want displayed, but still want to disclose the MRF settings.",
59 @default_description %{
64 @required_description_keys [:key, :related_policy]
66 def filter_one(policy, %{"type" => type} = message)
67 when type in ["Undo", "Block", "Delete"] and
68 policy != Pleroma.Web.ActivityPub.MRF.SimplePolicy do
72 def filter_one(policy, message) do
73 should_plug_history? =
74 if function_exported?(policy, :history_awareness, 0) do
75 policy.history_awareness()
81 if not should_plug_history? do
82 policy.filter(message)
84 main_result = policy.filter(message)
86 with {_, {:ok, main_message}} <- {:main, main_result},
89 "formerRepresentations" => %{
90 "orderedItems" => [_ | _]
92 }} = {_, object} <- {:object, message["object"]},
93 {_, {:ok, new_history}} <-
95 Pleroma.Object.Updater.for_each_history_item(
96 object["formerRepresentations"],
99 with {:ok, filtered} <- policy.filter(Map.put(message, "object", item)) do
100 {:ok, filtered["object"]}
106 {:ok, put_in(main_message, ["object", "formerRepresentations"], new_history)}
108 {:main, _} -> main_result
109 {:object, _} -> main_result
115 def filter(policies, %{} = message) do
117 |> Enum.reduce({:ok, message}, fn
118 policy, {:ok, message} -> filter_one(policy, message)
123 def filter(%{} = object), do: get_policies() |> filter(object)
126 def pipeline_filter(%{} = message, meta) do
127 object = meta[:object_data]
128 ap_id = message["object"]
130 if object && ap_id do
131 with {:ok, message} <- filter(Map.put(message, "object", object)) do
132 meta = Keyword.put(meta, :object_data, message["object"])
133 {:ok, Map.put(message, "object", ap_id), meta}
135 {err, message} -> {err, message, meta}
138 {err, message} = filter(message)
145 Pleroma.Config.get([:mrf, :policies], [])
148 Pleroma.Web.ActivityPub.MRF.HashtagPolicy,
149 Pleroma.Web.ActivityPub.MRF.InlineQuotePolicy,
150 Pleroma.Web.ActivityPub.MRF.NormalizeMarkup
155 defp get_policies(policy) when is_atom(policy), do: [policy]
156 defp get_policies(policies) when is_list(policies), do: policies
157 defp get_policies(_), do: []
159 # Matches the following:
160 # - https://baddomain.net
161 # - https://extra.baddomain.net/
162 # Does NOT match the following:
163 # - https://maybebaddomain.net/
166 def subdomain_regex("*." <> domain), do: subdomain_regex(domain)
169 def subdomain_regex(domain) do
170 if String.ends_with?(domain, ".*") do
171 ~r/^(.+\.)?#{Regex.escape(String.replace_suffix(domain, ".*", ""))}\.(.+)$/i
173 ~r/^(.+\.)?#{Regex.escape(domain)}$/i
177 @spec subdomains_regex([String.t()]) :: [Regex.t()]
178 def subdomains_regex(domains) when is_list(domains) do
179 Enum.map(domains, &subdomain_regex/1)
182 @spec subdomain_match?([Regex.t()], String.t()) :: boolean()
183 def subdomain_match?(domains, host) do
184 Enum.any?(domains, fn domain -> Regex.match?(domain, host) end)
187 @spec instance_list_from_tuples([{String.t(), String.t()}]) :: [String.t()]
188 def instance_list_from_tuples(list) do
189 Enum.map(list, fn {instance, _} -> instance end)
192 def describe(policies) do
193 {:ok, policy_configs} =
195 |> Enum.reduce({:ok, %{}}, fn
196 policy, {:ok, data} ->
197 {:ok, policy_data} = policy.describe()
198 {:ok, Map.merge(data, policy_data)}
206 |> Enum.map(fn policy -> to_string(policy) |> String.split(".") |> List.last() end)
208 exclusions = Pleroma.Config.get([:mrf, :transparency_exclusions])
212 mrf_policies: mrf_policies,
213 exclusions: length(exclusions) > 0
215 |> Map.merge(policy_configs)
220 def describe, do: get_policies() |> describe()
222 def config_descriptions do
223 Pleroma.Web.ActivityPub.MRF.Policy
224 |> Pleroma.Docs.Generator.list_behaviour_implementations()
225 |> config_descriptions()
228 def config_descriptions(policies) do
229 Enum.reduce(policies, @mrf_config_descriptions, fn policy, acc ->
230 if function_exported?(policy, :config_description, 0) do
233 |> Map.merge(policy.config_description)
234 |> Map.put(:group, :pleroma)
235 |> Map.put(:tab, :mrf)
236 |> Map.put(:type, :group)
238 if Enum.all?(@required_description_keys, &Map.has_key?(description, &1)) do
242 "#{policy} config description doesn't have one or all required keys #{inspect(@required_description_keys)}"
249 "#{policy} is excluded from config descriptions, because does not implement `config_description/0` method."