commit: fb72f2034a5d6d434b7fcdc428d559bf9312b163
parent 66f411fba0ecb350a2cd80293aabdecf402abaf9
Author: Maksim Pechnikov <parallel588@gmail.com>
Date: Wed, 25 Nov 2020 16:44:11 +0300
fix spec
Diffstat:
2 files changed, 110 insertions(+), 234 deletions(-)
diff --git a/lib/pleroma/moderation_log.ex b/lib/pleroma/moderation_log.ex
@@ -12,6 +12,26 @@ defmodule Pleroma.ModerationLog do
import Ecto.Query
+ @type t :: %__MODULE__{}
+ @type log_subject :: Activity.t() | User.t() | list(User.t())
+ @type log_params :: %{
+ required(:actor) => User.t(),
+ required(:action) => String.t(),
+ optional(:subject) => log_subject(),
+ optional(:subject_actor) => User.t(),
+ optional(:subject_id) => String.t(),
+ optional(:subjects) => list(User.t()),
+ optional(:permission) => String.t(),
+ optional(:text) => String.t(),
+ optional(:sensitive) => String.t(),
+ optional(:visibility) => String.t(),
+ optional(:followed) => User.t(),
+ optional(:follower) => User.t(),
+ optional(:nicknames) => list(String.t()),
+ optional(:tags) => list(String.t()),
+ optional(:target) => String.t()
+ }
+
schema "moderation_log" do
field(:data, :map)
@@ -90,212 +110,105 @@ defmodule Pleroma.ModerationLog do
parsed_datetime
end
- @spec insert_log(%{actor: User, subject: [User], action: String.t(), permission: String.t()}) ::
- {:ok, ModerationLog} | {:error, any}
- def insert_log(%{
- actor: %User{} = actor,
- subject: subjects,
- action: action,
- permission: permission
- }) do
- %ModerationLog{
- data: %{
- "actor" => user_to_map(actor),
- "subject" => user_to_map(subjects),
- "action" => action,
- "permission" => permission,
- "message" => ""
- }
+ defp prepare_log_data(%{actor: actor, action: action} = attrs) do
+ %{
+ "actor" => user_to_map(actor),
+ "action" => action,
+ "message" => ""
}
- |> insert_log_entry_with_message()
+ |> Pleroma.Maps.put_if_present("subject_actor", user_to_map(attrs[:subject_actor]))
end
- @spec insert_log(%{actor: User, subject: User, action: String.t()}) ::
- {:ok, ModerationLog} | {:error, any}
- def insert_log(
- %{
- actor: %User{} = actor,
- action: "report_update",
- subject: %Activity{data: %{"type" => "Flag"}} = subject
- } = attrs
- ) do
- %ModerationLog{
- data: %{
- "actor" => user_to_map(actor),
- "action" => "report_update",
- "subject" => report_to_map(subject),
- "subject_actor" => user_to_map(attrs[:subject_actor]),
- "message" => ""
- }
- }
- |> insert_log_entry_with_message()
+ defp prepare_log_data(attrs), do: attrs
+
+ @spec insert_log(log_params()) :: {:ok, ModerationLog} | {:error, any}
+ def insert_log(%{actor: %User{}, subject: subjects, permission: permission} = attrs) do
+ data =
+ attrs
+ |> prepare_log_data
+ |> Map.merge(%{"subject" => user_to_map(subjects), "permission" => permission})
+
+ insert_log_entry_with_message(%ModerationLog{data: data})
end
- @spec insert_log(%{actor: User, subject: Activity, action: String.t(), text: String.t()}) ::
- {:ok, ModerationLog} | {:error, any}
- def insert_log(
- %{
- actor: %User{} = actor,
- action: "report_note",
- subject: %Activity{} = subject,
- text: text
- } = attrs
- ) do
- %ModerationLog{
- data: %{
- "actor" => user_to_map(actor),
- "action" => "report_note",
- "subject" => report_to_map(subject),
- "subject_actor" => user_to_map(attrs[:subject_actor]),
- "text" => text
- }
- }
- |> insert_log_entry_with_message()
+ def insert_log(%{actor: %User{}, action: action, subject: %Activity{} = subject} = attrs)
+ when action in ["report_note_delete", "report_update", "report_note"] do
+ data =
+ attrs
+ |> prepare_log_data
+ |> Pleroma.Maps.put_if_present("text", attrs[:text])
+ |> Map.merge(%{"subject" => report_to_map(subject)})
+
+ insert_log_entry_with_message(%ModerationLog{data: data})
end
- @spec insert_log(%{actor: User, subject: Activity, action: String.t(), text: String.t()}) ::
- {:ok, ModerationLog} | {:error, any}
def insert_log(
%{
- actor: %User{} = actor,
- action: "report_note_delete",
+ actor: %User{},
+ action: action,
subject: %Activity{} = subject,
- text: text
+ sensitive: sensitive,
+ visibility: visibility
} = attrs
- ) do
- %ModerationLog{
- data: %{
- "actor" => user_to_map(actor),
- "action" => "report_note_delete",
- "subject" => report_to_map(subject),
- "subject_actor" => user_to_map(attrs[:subject_actor]),
- "text" => text
- }
- }
- |> insert_log_entry_with_message()
- end
-
- @spec insert_log(%{
- actor: User,
- subject: Activity,
- action: String.t(),
- sensitive: String.t(),
- visibility: String.t()
- }) :: {:ok, ModerationLog} | {:error, any}
- def insert_log(%{
- actor: %User{} = actor,
- action: "status_update",
- subject: %Activity{} = subject,
- sensitive: sensitive,
- visibility: visibility
- }) do
- %ModerationLog{
- data: %{
- "actor" => user_to_map(actor),
- "action" => "status_update",
+ )
+ when action == "status_update" do
+ data =
+ attrs
+ |> prepare_log_data
+ |> Map.merge(%{
"subject" => status_to_map(subject),
"sensitive" => sensitive,
- "visibility" => visibility,
- "message" => ""
- }
- }
- |> insert_log_entry_with_message()
- end
+ "visibility" => visibility
+ })
- @spec insert_log(%{actor: User, action: String.t(), subject_id: String.t()}) ::
- {:ok, ModerationLog} | {:error, any}
- def insert_log(%{
- actor: %User{} = actor,
- action: "status_delete",
- subject_id: subject_id
- }) do
- %ModerationLog{
- data: %{
- "actor" => user_to_map(actor),
- "action" => "status_delete",
- "subject_id" => subject_id,
- "message" => ""
- }
- }
- |> insert_log_entry_with_message()
+ insert_log_entry_with_message(%ModerationLog{data: data})
end
- @spec insert_log(%{actor: User, subject: User, action: String.t()}) ::
- {:ok, ModerationLog} | {:error, any}
- def insert_log(%{actor: %User{} = actor, subject: subject, action: action}) do
- %ModerationLog{
- data: %{
- "actor" => user_to_map(actor),
- "action" => action,
- "subject" => user_to_map(subject),
- "message" => ""
- }
- }
- |> insert_log_entry_with_message()
+ def insert_log(%{actor: %User{}, action: action, subject_id: subject_id} = attrs)
+ when action == "status_delete" do
+ data =
+ attrs
+ |> prepare_log_data
+ |> Map.merge(%{"subject_id" => subject_id})
+
+ insert_log_entry_with_message(%ModerationLog{data: data})
end
- @spec insert_log(%{actor: User, subjects: [User], action: String.t()}) ::
- {:ok, ModerationLog} | {:error, any}
- def insert_log(%{actor: %User{} = actor, subjects: subjects, action: action}) do
- subjects = Enum.map(subjects, &user_to_map/1)
+ def insert_log(%{actor: %User{}, subject: subject, action: _action} = attrs) do
+ data =
+ attrs
+ |> prepare_log_data
+ |> Map.merge(%{"subject" => user_to_map(subject)})
- %ModerationLog{
- data: %{
- "actor" => user_to_map(actor),
- "action" => action,
- "subjects" => subjects,
- "message" => ""
- }
- }
- |> insert_log_entry_with_message()
+ insert_log_entry_with_message(%ModerationLog{data: data})
end
- @spec insert_log(%{actor: User, action: String.t(), followed: User, follower: User}) ::
- {:ok, ModerationLog} | {:error, any}
- def insert_log(%{
- actor: %User{} = actor,
- followed: %User{} = followed,
- follower: %User{} = follower,
- action: "follow"
- }) do
- %ModerationLog{
- data: %{
- "actor" => user_to_map(actor),
- "action" => "follow",
- "followed" => user_to_map(followed),
- "follower" => user_to_map(follower),
- "message" => ""
- }
- }
- |> insert_log_entry_with_message()
+ def insert_log(%{actor: %User{}, subjects: subjects, action: _action} = attrs) do
+ data =
+ attrs
+ |> prepare_log_data
+ |> Map.merge(%{"subjects" => user_to_map(subjects)})
+
+ insert_log_entry_with_message(%ModerationLog{data: data})
end
- @spec insert_log(%{actor: User, action: String.t(), followed: User, follower: User}) ::
- {:ok, ModerationLog} | {:error, any}
- def insert_log(%{
- actor: %User{} = actor,
- followed: %User{} = followed,
- follower: %User{} = follower,
- action: "unfollow"
- }) do
- %ModerationLog{
- data: %{
- "actor" => user_to_map(actor),
- "action" => "unfollow",
- "followed" => user_to_map(followed),
- "follower" => user_to_map(follower),
- "message" => ""
- }
- }
- |> insert_log_entry_with_message()
+ def insert_log(
+ %{
+ actor: %User{},
+ followed: %User{} = followed,
+ follower: %User{} = follower,
+ action: action
+ } = attrs
+ )
+ when action in ["unfollow", "follow"] do
+ data =
+ attrs
+ |> prepare_log_data
+ |> Map.merge(%{"followed" => user_to_map(followed), "follower" => user_to_map(follower)})
+
+ insert_log_entry_with_message(%ModerationLog{data: data})
end
- @spec insert_log(%{
- actor: User,
- action: String.t(),
- nicknames: [String.t()],
- tags: [String.t()]
- }) :: {:ok, ModerationLog} | {:error, any}
def insert_log(%{
actor: %User{} = actor,
nicknames: nicknames,
@@ -314,27 +227,16 @@ defmodule Pleroma.ModerationLog do
|> insert_log_entry_with_message()
end
- @spec insert_log(%{actor: User, action: String.t(), target: String.t()}) ::
- {:ok, ModerationLog} | {:error, any}
- def insert_log(%{
- actor: %User{} = actor,
- action: action,
- target: target
- })
+ def insert_log(%{actor: %User{}, action: action, target: target} = attrs)
when action in ["relay_follow", "relay_unfollow"] do
- %ModerationLog{
- data: %{
- "actor" => user_to_map(actor),
- "action" => action,
- "target" => target,
- "message" => ""
- }
- }
- |> insert_log_entry_with_message()
+ data =
+ attrs
+ |> prepare_log_data
+ |> Map.merge(%{"target" => target})
+
+ insert_log_entry_with_message(%ModerationLog{data: data})
end
- @spec insert_log(%{actor: User, action: String.t(), subject_id: String.t()}) ::
- {:ok, ModerationLog} | {:error, any}
def insert_log(%{actor: %User{} = actor, action: "chat_message_delete", subject_id: subject_id}) do
%ModerationLog{
data: %{
@@ -367,20 +269,14 @@ defmodule Pleroma.ModerationLog do
defp user_to_map(_), do: nil
defp report_to_map(%Activity{} = report) do
- %{
- "type" => "report",
- "id" => report.id,
- "state" => report.data["state"]
- }
+ %{"type" => "report", "id" => report.id, "state" => report.data["state"]}
end
defp status_to_map(%Activity{} = status) do
- %{
- "type" => "status",
- "id" => status.id
- }
+ %{"type" => "status", "id" => status.id}
end
+ @spec get_log_entry_message(ModerationLog.t()) :: String.t()
def get_log_entry_message(%ModerationLog{
data: %{
"actor" => %{"nickname" => actor_nickname},
@@ -392,7 +288,6 @@ defmodule Pleroma.ModerationLog do
"@#{actor_nickname} made @#{follower_nickname} #{action} @#{followed_nickname}"
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(%ModerationLog{
data: %{
"actor" => %{"nickname" => actor_nickname},
@@ -403,7 +298,6 @@ defmodule Pleroma.ModerationLog do
"@#{actor_nickname} deleted users: #{users_to_nicknames_string(subjects)}"
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(%ModerationLog{
data: %{
"actor" => %{"nickname" => actor_nickname},
@@ -414,7 +308,6 @@ defmodule Pleroma.ModerationLog do
"@#{actor_nickname} created users: #{users_to_nicknames_string(subjects)}"
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(%ModerationLog{
data: %{
"actor" => %{"nickname" => actor_nickname},
@@ -425,7 +318,6 @@ defmodule Pleroma.ModerationLog do
"@#{actor_nickname} activated users: #{users_to_nicknames_string(users)}"
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(%ModerationLog{
data: %{
"actor" => %{"nickname" => actor_nickname},
@@ -436,7 +328,6 @@ defmodule Pleroma.ModerationLog do
"@#{actor_nickname} deactivated users: #{users_to_nicknames_string(users)}"
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(%ModerationLog{
data: %{
"actor" => %{"nickname" => actor_nickname},
@@ -447,7 +338,6 @@ defmodule Pleroma.ModerationLog do
"@#{actor_nickname} approved users: #{users_to_nicknames_string(users)}"
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(%ModerationLog{
data: %{
"actor" => %{"nickname" => actor_nickname},
@@ -461,7 +351,6 @@ defmodule Pleroma.ModerationLog do
"@#{actor_nickname} added tags: #{tags_string} to users: #{nicknames_to_string(nicknames)}"
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(%ModerationLog{
data: %{
"actor" => %{"nickname" => actor_nickname},
@@ -475,7 +364,6 @@ defmodule Pleroma.ModerationLog do
"@#{actor_nickname} removed tags: #{tags_string} from users: #{nicknames_to_string(nicknames)}"
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(%ModerationLog{
data: %{
"actor" => %{"nickname" => actor_nickname},
@@ -487,7 +375,6 @@ defmodule Pleroma.ModerationLog do
"@#{actor_nickname} made #{users_to_nicknames_string(users)} #{permission}"
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(%ModerationLog{
data: %{
"actor" => %{"nickname" => actor_nickname},
@@ -499,7 +386,6 @@ defmodule Pleroma.ModerationLog do
"@#{actor_nickname} revoked #{permission} role from #{users_to_nicknames_string(users)}"
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(%ModerationLog{
data: %{
"actor" => %{"nickname" => actor_nickname},
@@ -510,7 +396,6 @@ defmodule Pleroma.ModerationLog do
"@#{actor_nickname} followed relay: #{target}"
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(%ModerationLog{
data: %{
"actor" => %{"nickname" => actor_nickname},
@@ -521,7 +406,6 @@ defmodule Pleroma.ModerationLog do
"@#{actor_nickname} unfollowed relay: #{target}"
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(
%ModerationLog{
data: %{
@@ -536,7 +420,6 @@ defmodule Pleroma.ModerationLog do
" with '#{state}' state"
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(
%ModerationLog{
data: %{
@@ -551,7 +434,6 @@ defmodule Pleroma.ModerationLog do
subject_actor_nickname(log, " on user ")
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(
%ModerationLog{
data: %{
@@ -566,7 +448,6 @@ defmodule Pleroma.ModerationLog do
subject_actor_nickname(log, " on user ")
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(%ModerationLog{
data: %{
"actor" => %{"nickname" => actor_nickname},
@@ -579,7 +460,6 @@ defmodule Pleroma.ModerationLog do
"@#{actor_nickname} updated status ##{subject_id}, set visibility: '#{visibility}'"
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(%ModerationLog{
data: %{
"actor" => %{"nickname" => actor_nickname},
@@ -592,7 +472,6 @@ defmodule Pleroma.ModerationLog do
"@#{actor_nickname} updated status ##{subject_id}, set sensitive: '#{sensitive}'"
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(%ModerationLog{
data: %{
"actor" => %{"nickname" => actor_nickname},
@@ -607,7 +486,6 @@ defmodule Pleroma.ModerationLog do
}'"
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(%ModerationLog{
data: %{
"actor" => %{"nickname" => actor_nickname},
@@ -618,7 +496,6 @@ defmodule Pleroma.ModerationLog do
"@#{actor_nickname} deleted status ##{subject_id}"
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(%ModerationLog{
data: %{
"actor" => %{"nickname" => actor_nickname},
@@ -629,7 +506,6 @@ defmodule Pleroma.ModerationLog do
"@#{actor_nickname} forced password reset for users: #{users_to_nicknames_string(subjects)}"
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(%ModerationLog{
data: %{
"actor" => %{"nickname" => actor_nickname},
@@ -640,7 +516,6 @@ defmodule Pleroma.ModerationLog do
"@#{actor_nickname} confirmed email for users: #{users_to_nicknames_string(subjects)}"
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(%ModerationLog{
data: %{
"actor" => %{"nickname" => actor_nickname},
@@ -653,7 +528,6 @@ defmodule Pleroma.ModerationLog do
}"
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(%ModerationLog{
data: %{
"actor" => %{"nickname" => actor_nickname},
@@ -664,7 +538,6 @@ defmodule Pleroma.ModerationLog do
"@#{actor_nickname} updated users: #{users_to_nicknames_string(subjects)}"
end
- @spec get_log_entry_message(ModerationLog) :: String.t()
def get_log_entry_message(%ModerationLog{
data: %{
"actor" => %{"nickname" => actor_nickname},
diff --git a/test/pleroma/moderation_log_test.exs b/test/pleroma/moderation_log_test.exs
@@ -182,12 +182,14 @@ defmodule Pleroma.ModerationLogTest do
end
test "logging report update", %{moderator: moderator} do
+ user = insert(:user)
+
report = %Activity{
id: "9m9I1F4p8ftrTP6QTI",
data: %{
"type" => "Flag",
"state" => "resolved",
- "actor" => "http://localhost:4000/users/max"
+ "actor" => user.ap_id
}
}
@@ -195,13 +197,14 @@ defmodule Pleroma.ModerationLogTest do
ModerationLog.insert_log(%{
actor: moderator,
action: "report_update",
- subject: report
+ subject: report,
+ subject_actor: user
})
log = Repo.one(ModerationLog)
assert log.data["message"] ==
- "@#{moderator.nickname} updated report ##{report.id} with 'resolved' state"
+ "@#{moderator.nickname} updated report ##{report.id} (on user @#{user.nickname}) with 'resolved' state"
end
test "logging report response", %{moderator: moderator} do
