1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Web.MastodonAPI.StatusController do
6 use Pleroma.Web, :controller
8 import Pleroma.Web.MastodonAPI.MastodonAPIController, only: [try_render: 3]
12 alias Pleroma.Activity
13 alias Pleroma.Bookmark
15 alias Pleroma.Plugs.OAuthScopesPlug
16 alias Pleroma.Plugs.RateLimiter
18 alias Pleroma.ScheduledActivity
20 alias Pleroma.Web.ActivityPub.ActivityPub
21 alias Pleroma.Web.ActivityPub.Visibility
22 alias Pleroma.Web.CommonAPI
23 alias Pleroma.Web.MastodonAPI.AccountView
24 alias Pleroma.Web.MastodonAPI.ScheduledActivityView
26 @unauthenticated_access %{fallback: :proceed_unauthenticated, scopes: []}
30 %{@unauthenticated_access | scopes: ["read:statuses"]}
41 %{scopes: ["write:statuses"]}
52 %{scopes: ["write:favourites"]} when action in [:favourite, :unfavourite]
57 %{scopes: ["write:mutes"]} when action in [:mute_conversation, :unmute_conversation]
62 %{@unauthenticated_access | scopes: ["read:accounts"]}
63 when action in [:favourited_by, :reblogged_by]
66 plug(OAuthScopesPlug, %{scopes: ["write:accounts"]} when action in [:pin, :unpin])
68 # Note: scope not present in Mastodon: write:bookmarks
71 %{scopes: ["write:bookmarks"]} when action in [:bookmark, :unbookmark]
74 plug(Pleroma.Plugs.EnsurePublicOrAuthenticatedPlug)
76 @rate_limited_status_actions ~w(reblog unreblog favourite unfavourite create delete)a
80 {:status_id_action, bucket_name: "status_id_action:reblog_unreblog", params: ["id"]}
81 when action in ~w(reblog unreblog)a
86 {:status_id_action, bucket_name: "status_id_action:fav_unfav", params: ["id"]}
87 when action in ~w(favourite unfavourite)a
90 plug(RateLimiter, :statuses_actions when action in @rate_limited_status_actions)
92 action_fallback(Pleroma.Web.MastodonAPI.FallbackController)
95 GET `/api/v1/statuses?ids[]=1&ids[]=2`
97 `ids` query param is required
99 def index(%{assigns: %{user: user}} = conn, %{"ids" => ids}) do
105 |> Activity.all_by_ids_with_object()
106 |> Enum.filter(&Visibility.visible_for_user?(&1, user))
108 render(conn, "index.json", activities: activities, for: user, as: :activity)
112 POST /api/v1/statuses
114 Creates a scheduled status when `scheduled_at` param is present and it's far enough
117 %{assigns: %{user: user}} = conn,
118 %{"status" => _, "scheduled_at" => scheduled_at} = params
120 params = Map.put(params, "in_reply_to_status_id", params["in_reply_to_id"])
122 if ScheduledActivity.far_enough?(scheduled_at) do
123 with {:ok, scheduled_activity} <-
124 ScheduledActivity.create(user, %{"params" => params, "scheduled_at" => scheduled_at}) do
126 |> put_view(ScheduledActivityView)
127 |> render("show.json", scheduled_activity: scheduled_activity)
130 create(conn, Map.drop(params, ["scheduled_at"]))
135 POST /api/v1/statuses
137 Creates a regular status
139 def create(%{assigns: %{user: user}} = conn, %{"status" => _} = params) do
140 params = Map.put(params, "in_reply_to_status_id", params["in_reply_to_id"])
142 with {:ok, activity} <- CommonAPI.post(user, params) do
143 try_render(conn, "show.json",
147 with_direct_conversation_id: true
152 |> put_status(:unprocessable_entity)
153 |> json(%{error: message})
157 def create(%{assigns: %{user: _user}} = conn, %{"media_ids" => _} = params) do
158 create(conn, Map.put(params, "status", ""))
161 @doc "GET /api/v1/statuses/:id"
162 def show(%{assigns: %{user: user}} = conn, %{"id" => id}) do
163 with %Activity{} = activity <- Activity.get_by_id_with_object(id),
164 true <- Visibility.visible_for_user?(activity, user) do
165 try_render(conn, "show.json", activity: activity, for: user)
169 @doc "DELETE /api/v1/statuses/:id"
170 def delete(%{assigns: %{user: user}} = conn, %{"id" => id}) do
171 with {:ok, %Activity{}} <- CommonAPI.delete(id, user) do
174 _e -> render_error(conn, :forbidden, "Can't delete this post")
178 @doc "POST /api/v1/statuses/:id/reblog"
179 def reblog(%{assigns: %{user: user}} = conn, %{"id" => ap_id_or_id}) do
180 with {:ok, announce, _activity} <- CommonAPI.repeat(ap_id_or_id, user),
181 %Activity{} = announce <- Activity.normalize(announce.data) do
182 try_render(conn, "show.json", %{activity: announce, for: user, as: :activity})
186 @doc "POST /api/v1/statuses/:id/unreblog"
187 def unreblog(%{assigns: %{user: user}} = conn, %{"id" => ap_id_or_id}) do
188 with {:ok, _unannounce, %{data: %{"id" => id}}} <- CommonAPI.unrepeat(ap_id_or_id, user),
189 %Activity{} = activity <- Activity.get_create_by_object_ap_id_with_object(id) do
190 try_render(conn, "show.json", %{activity: activity, for: user, as: :activity})
194 @doc "POST /api/v1/statuses/:id/favourite"
195 def favourite(%{assigns: %{user: user}} = conn, %{"id" => ap_id_or_id}) do
196 with {:ok, _fav, %{data: %{"id" => id}}} <- CommonAPI.favorite(ap_id_or_id, user),
197 %Activity{} = activity <- Activity.get_create_by_object_ap_id(id) do
198 try_render(conn, "show.json", activity: activity, for: user, as: :activity)
202 @doc "POST /api/v1/statuses/:id/unfavourite"
203 def unfavourite(%{assigns: %{user: user}} = conn, %{"id" => ap_id_or_id}) do
204 with {:ok, _, _, %{data: %{"id" => id}}} <- CommonAPI.unfavorite(ap_id_or_id, user),
205 %Activity{} = activity <- Activity.get_create_by_object_ap_id(id) do
206 try_render(conn, "show.json", activity: activity, for: user, as: :activity)
210 @doc "POST /api/v1/statuses/:id/pin"
211 def pin(%{assigns: %{user: user}} = conn, %{"id" => ap_id_or_id}) do
212 with {:ok, activity} <- CommonAPI.pin(ap_id_or_id, user) do
213 try_render(conn, "show.json", activity: activity, for: user, as: :activity)
217 @doc "POST /api/v1/statuses/:id/unpin"
218 def unpin(%{assigns: %{user: user}} = conn, %{"id" => ap_id_or_id}) do
219 with {:ok, activity} <- CommonAPI.unpin(ap_id_or_id, user) do
220 try_render(conn, "show.json", activity: activity, for: user, as: :activity)
224 @doc "POST /api/v1/statuses/:id/bookmark"
225 def bookmark(%{assigns: %{user: user}} = conn, %{"id" => id}) do
226 with %Activity{} = activity <- Activity.get_by_id_with_object(id),
227 %User{} = user <- User.get_cached_by_nickname(user.nickname),
228 true <- Visibility.visible_for_user?(activity, user),
229 {:ok, _bookmark} <- Bookmark.create(user.id, activity.id) do
230 try_render(conn, "show.json", activity: activity, for: user, as: :activity)
234 @doc "POST /api/v1/statuses/:id/unbookmark"
235 def unbookmark(%{assigns: %{user: user}} = conn, %{"id" => id}) do
236 with %Activity{} = activity <- Activity.get_by_id_with_object(id),
237 %User{} = user <- User.get_cached_by_nickname(user.nickname),
238 true <- Visibility.visible_for_user?(activity, user),
239 {:ok, _bookmark} <- Bookmark.destroy(user.id, activity.id) do
240 try_render(conn, "show.json", activity: activity, for: user, as: :activity)
244 @doc "POST /api/v1/statuses/:id/mute"
245 def mute_conversation(%{assigns: %{user: user}} = conn, %{"id" => id}) do
246 with %Activity{} = activity <- Activity.get_by_id(id),
247 {:ok, activity} <- CommonAPI.add_mute(user, activity) do
248 try_render(conn, "show.json", activity: activity, for: user, as: :activity)
252 @doc "POST /api/v1/statuses/:id/unmute"
253 def unmute_conversation(%{assigns: %{user: user}} = conn, %{"id" => id}) do
254 with %Activity{} = activity <- Activity.get_by_id(id),
255 {:ok, activity} <- CommonAPI.remove_mute(user, activity) do
256 try_render(conn, "show.json", activity: activity, for: user, as: :activity)
260 @doc "GET /api/v1/statuses/:id/card"
261 @deprecated "https://github.com/tootsuite/mastodon/pull/11213"
262 def card(%{assigns: %{user: user}} = conn, %{"id" => status_id}) do
263 with %Activity{} = activity <- Activity.get_by_id(status_id),
264 true <- Visibility.visible_for_user?(activity, user) do
265 data = Pleroma.Web.RichMedia.Helpers.fetch_data_for_activity(activity)
266 render(conn, "card.json", data)
268 _ -> render_error(conn, :not_found, "Record not found")
272 @doc "GET /api/v1/statuses/:id/favourited_by"
273 def favourited_by(%{assigns: %{user: user}} = conn, %{"id" => id}) do
274 with %Activity{} = activity <- Activity.get_by_id_with_object(id),
275 {:visible, true} <- {:visible, Visibility.visible_for_user?(activity, user)},
276 %Object{data: %{"likes" => likes}} <- Object.normalize(activity) do
279 |> Ecto.Query.where([u], u.ap_id in ^likes)
281 |> Enum.filter(&(not User.blocks?(user, &1)))
284 |> put_view(AccountView)
285 |> render("index.json", for: user, users: users, as: :user)
287 {:visible, false} -> {:error, :not_found}
292 @doc "GET /api/v1/statuses/:id/reblogged_by"
293 def reblogged_by(%{assigns: %{user: user}} = conn, %{"id" => id}) do
294 with %Activity{} = activity <- Activity.get_by_id_with_object(id),
295 {:visible, true} <- {:visible, Visibility.visible_for_user?(activity, user)},
296 %Object{data: %{"announcements" => announces}} <- Object.normalize(activity) do
299 |> Ecto.Query.where([u], u.ap_id in ^announces)
301 |> Enum.filter(&(not User.blocks?(user, &1)))
304 |> put_view(AccountView)
305 |> render("index.json", for: user, users: users, as: :user)
307 {:visible, false} -> {:error, :not_found}
312 @doc "GET /api/v1/statuses/:id/context"
313 def context(%{assigns: %{user: user}} = conn, %{"id" => id}) do
314 with %Activity{} = activity <- Activity.get_by_id(id) do
316 ActivityPub.fetch_activities_for_context(activity.data["context"], %{
317 "blocking_user" => user,
319 "exclude_id" => activity.id
322 render(conn, "context.json", activity: activity, activities: activities, user: user)