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, message) do
67 should_plug_history? =
68 if function_exported?(policy, :history_awareness, 0) do
69 policy.history_awareness()
75 if not should_plug_history? do
76 policy.filter(message)
78 main_result = policy.filter(message)
80 with {_, {:ok, main_message}} <- {:main, main_result},
83 "formerRepresentations" => %{
84 "orderedItems" => [_ | _]
86 }} = {_, object} <- {:object, message["object"]},
87 {_, {:ok, new_history}} <-
89 Pleroma.Object.Updater.for_each_history_item(
90 object["formerRepresentations"],
93 with {:ok, filtered} <- policy.filter(Map.put(message, "object", item)) do
94 {:ok, filtered["object"]}
100 {:ok, put_in(main_message, ["object", "formerRepresentations"], new_history)}
102 {:main, _} -> main_result
103 {:object, _} -> main_result
109 def filter(policies, %{} = message) do
111 |> Enum.reduce({:ok, message}, fn
112 policy, {:ok, message} -> filter_one(policy, message)
117 def filter(%{} = object), do: get_policies() |> filter(object)
120 def pipeline_filter(%{} = message, meta) do
121 object = meta[:object_data]
122 ap_id = message["object"]
124 if object && ap_id do
125 with {:ok, message} <- filter(Map.put(message, "object", object)) do
126 meta = Keyword.put(meta, :object_data, message["object"])
127 {:ok, Map.put(message, "object", ap_id), meta}
129 {err, message} -> {err, message, meta}
132 {err, message} = filter(message)
139 Pleroma.Config.get([:mrf, :policies], [])
142 Pleroma.Web.ActivityPub.MRF.HashtagPolicy,
143 Pleroma.Web.ActivityPub.MRF.InlineQuotePolicy
148 defp get_policies(policy) when is_atom(policy), do: [policy]
149 defp get_policies(policies) when is_list(policies), do: policies
150 defp get_policies(_), do: []
152 # Matches the following:
153 # - https://baddomain.net
154 # - https://extra.baddomain.net/
155 # Does NOT match the following:
156 # - https://maybebaddomain.net/
157 def subdomain_regex(domain) do
158 ~r/^(.+\.)?#{Regex.escape(domain)}$/i
161 @spec subdomains_regex([String.t()]) :: [Regex.t()]
162 def subdomains_regex(domains) when is_list(domains) do
163 Enum.map(domains, &subdomain_regex/1)
166 @spec subdomain_match?([Regex.t()], String.t()) :: boolean()
167 def subdomain_match?(domains, host) do
168 Enum.any?(domains, fn domain -> Regex.match?(domain, host) end)
171 @spec instance_list_from_tuples([{String.t(), String.t()}]) :: [String.t()]
172 def instance_list_from_tuples(list) do
173 Enum.map(list, fn {instance, _} -> instance end)
176 def describe(policies) do
177 {:ok, policy_configs} =
179 |> Enum.reduce({:ok, %{}}, fn
180 policy, {:ok, data} ->
181 {:ok, policy_data} = policy.describe()
182 {:ok, Map.merge(data, policy_data)}
190 |> Enum.map(fn policy -> to_string(policy) |> String.split(".") |> List.last() end)
192 exclusions = Pleroma.Config.get([:mrf, :transparency_exclusions])
196 mrf_policies: mrf_policies,
197 exclusions: length(exclusions) > 0
199 |> Map.merge(policy_configs)
204 def describe, do: get_policies() |> describe()
206 def config_descriptions do
207 Pleroma.Web.ActivityPub.MRF.Policy
208 |> Pleroma.Docs.Generator.list_behaviour_implementations()
209 |> config_descriptions()
212 def config_descriptions(policies) do
213 Enum.reduce(policies, @mrf_config_descriptions, fn policy, acc ->
214 if function_exported?(policy, :config_description, 0) do
217 |> Map.merge(policy.config_description)
218 |> Map.put(:group, :pleroma)
219 |> Map.put(:tab, :mrf)
220 |> Map.put(:type, :group)
222 if Enum.all?(@required_description_keys, &Map.has_key?(description, &1)) do
226 "#{policy} config description doesn't have one or all required keys #{inspect(@required_description_keys)}"
233 "#{policy} is excluded from config descriptions, because does not implement `config_description/0` method."