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.TwitterAPI.Controller do
6 use Pleroma.Web, :controller
8 import Pleroma.Web.ControllerHelper, only: [json_response: 3]
10 alias Pleroma.Web.TwitterAPI.{TwitterAPI, UserView, ActivityView, NotificationView}
11 alias Pleroma.Web.CommonAPI
12 alias Pleroma.{Repo, Activity, Object, User, Notification}
13 alias Pleroma.Web.ActivityPub.ActivityPub
14 alias Pleroma.Web.ActivityPub.Utils
19 plug(:only_if_public_instance when action in [:public_timeline, :public_and_external_timeline])
20 action_fallback(:errors)
22 def verify_credentials(%{assigns: %{user: user}} = conn, _params) do
23 token = Phoenix.Token.sign(conn, "user socket", user.id)
27 |> render("show.json", %{user: user, token: token})
30 def status_update(%{assigns: %{user: user}} = conn, %{"status" => _} = status_data) do
31 with media_ids <- extract_media_ids(status_data),
33 TwitterAPI.create_status(user, Map.put(status_data, "media_ids", media_ids)) do
35 |> json(ActivityView.render("activity.json", activity: activity, for: user))
37 _ -> empty_status_reply(conn)
41 def status_update(conn, _status_data) do
42 empty_status_reply(conn)
45 defp empty_status_reply(conn) do
46 bad_request_reply(conn, "Client must provide a 'status' parameter with a value.")
49 defp extract_media_ids(status_data) do
50 with media_ids when not is_nil(media_ids) <- status_data["media_ids"],
51 split_ids <- String.split(media_ids, ","),
52 clean_ids <- Enum.reject(split_ids, fn id -> String.length(id) == 0 end) do
59 def public_and_external_timeline(%{assigns: %{user: user}} = conn, params) do
62 |> Map.put("type", ["Create", "Announce"])
63 |> Map.put("blocking_user", user)
65 activities = ActivityPub.fetch_public_activities(params)
68 |> put_view(ActivityView)
69 |> render("index.json", %{activities: activities, for: user})
72 def public_timeline(%{assigns: %{user: user}} = conn, params) do
75 |> Map.put("type", ["Create", "Announce"])
76 |> Map.put("local_only", true)
77 |> Map.put("blocking_user", user)
79 activities = ActivityPub.fetch_public_activities(params)
82 |> put_view(ActivityView)
83 |> render("index.json", %{activities: activities, for: user})
86 def friends_timeline(%{assigns: %{user: user}} = conn, params) do
89 |> Map.put("type", ["Create", "Announce", "Follow", "Like"])
90 |> Map.put("blocking_user", user)
91 |> Map.put("user", user)
94 ActivityPub.fetch_activities([user.ap_id | user.following], params)
95 |> ActivityPub.contain_timeline(user)
98 |> put_view(ActivityView)
99 |> render("index.json", %{activities: activities, for: user})
102 def show_user(conn, params) do
103 for_user = conn.assigns.user
105 with {:ok, shown} <- TwitterAPI.get_user(params),
107 User.auth_active?(shown) ||
108 (for_user && (for_user.id == shown.id || User.superuser?(for_user))) do
111 %{user: shown, for: for_user}
117 |> put_view(UserView)
118 |> render("show.json", params)
121 bad_request_reply(conn, msg)
126 |> json(%{error: "Unconfirmed user"})
130 def user_timeline(%{assigns: %{user: user}} = conn, params) do
131 case TwitterAPI.get_user(user, params) do
132 {:ok, target_user} ->
133 # Twitter and ActivityPub use a different name and sense for this parameter.
134 {include_rts, params} = Map.pop(params, "include_rts")
138 x when x == "false" or x == "0" -> Map.put(params, "exclude_reblogs", "true")
142 activities = ActivityPub.fetch_user_activities(target_user, user, params)
145 |> put_view(ActivityView)
146 |> render("index.json", %{activities: activities, for: user})
149 bad_request_reply(conn, msg)
153 def mentions_timeline(%{assigns: %{user: user}} = conn, params) do
156 |> Map.put("type", ["Create", "Announce", "Follow", "Like"])
157 |> Map.put("blocking_user", user)
159 activities = ActivityPub.fetch_activities([user.ap_id], params)
162 |> put_view(ActivityView)
163 |> render("index.json", %{activities: activities, for: user})
166 def dm_timeline(%{assigns: %{user: user}} = conn, params) do
168 ActivityPub.fetch_activities_query(
170 Map.merge(params, %{"type" => "Create", "user" => user, visibility: "direct"})
173 activities = Repo.all(query)
176 |> put_view(ActivityView)
177 |> render("index.json", %{activities: activities, for: user})
180 def notifications(%{assigns: %{user: user}} = conn, params) do
181 notifications = Notification.for_user(user, params)
184 |> put_view(NotificationView)
185 |> render("notification.json", %{notifications: notifications, for: user})
188 def notifications_read(%{assigns: %{user: user}} = conn, %{"latest_id" => latest_id} = params) do
189 Notification.set_read_up_to(user, latest_id)
191 notifications = Notification.for_user(user, params)
194 |> put_view(NotificationView)
195 |> render("notification.json", %{notifications: notifications, for: user})
198 def notifications_read(%{assigns: %{user: _user}} = conn, _) do
199 bad_request_reply(conn, "You need to specify latest_id")
202 def follow(%{assigns: %{user: user}} = conn, params) do
203 case TwitterAPI.follow(user, params) do
204 {:ok, user, followed, _activity} ->
206 |> put_view(UserView)
207 |> render("show.json", %{user: followed, for: user})
210 forbidden_json_reply(conn, msg)
214 def block(%{assigns: %{user: user}} = conn, params) do
215 case TwitterAPI.block(user, params) do
216 {:ok, user, blocked} ->
218 |> put_view(UserView)
219 |> render("show.json", %{user: blocked, for: user})
222 forbidden_json_reply(conn, msg)
226 def unblock(%{assigns: %{user: user}} = conn, params) do
227 case TwitterAPI.unblock(user, params) do
228 {:ok, user, blocked} ->
230 |> put_view(UserView)
231 |> render("show.json", %{user: blocked, for: user})
234 forbidden_json_reply(conn, msg)
238 def delete_post(%{assigns: %{user: user}} = conn, %{"id" => id}) do
239 with {:ok, activity} <- TwitterAPI.delete(user, id) do
241 |> put_view(ActivityView)
242 |> render("activity.json", %{activity: activity, for: user})
246 def unfollow(%{assigns: %{user: user}} = conn, params) do
247 case TwitterAPI.unfollow(user, params) do
248 {:ok, user, unfollowed} ->
250 |> put_view(UserView)
251 |> render("show.json", %{user: unfollowed, for: user})
254 forbidden_json_reply(conn, msg)
258 def fetch_status(%{assigns: %{user: user}} = conn, %{"id" => id}) do
259 with %Activity{} = activity <- Repo.get(Activity, id),
260 true <- ActivityPub.visible_for_user?(activity, user) do
262 |> put_view(ActivityView)
263 |> render("activity.json", %{activity: activity, for: user})
267 def fetch_conversation(%{assigns: %{user: user}} = conn, %{"id" => id}) do
268 id = String.to_integer(id)
270 with context when is_binary(context) <- TwitterAPI.conversation_id_to_context(id),
272 ActivityPub.fetch_activities_for_context(context, %{
273 "blocking_user" => user,
277 |> put_view(ActivityView)
278 |> render("index.json", %{activities: activities, for: user})
283 Updates metadata of uploaded media object.
284 Derived from [Twitter API endpoint](https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-metadata-create).
286 def update_media(%{assigns: %{user: user}} = conn, %{"media_id" => id} = data) do
287 object = Repo.get(Object, id)
288 description = get_in(data, ["alt_text", "text"]) || data["name"] || data["description"]
290 {conn, status, response_body} =
293 {halt(conn), :not_found, ""}
295 !Object.authorize_mutation(object, user) ->
296 {halt(conn), :forbidden, "You can only update your own uploads."}
298 !is_binary(description) ->
299 {conn, :not_modified, ""}
302 new_data = Map.put(object.data, "name", description)
306 |> Object.change(%{data: new_data})
309 {conn, :no_content, ""}
313 |> put_status(status)
314 |> json(response_body)
317 def upload(%{assigns: %{user: user}} = conn, %{"media" => media}) do
318 response = TwitterAPI.upload(media, user)
321 |> put_resp_content_type("application/atom+xml")
322 |> send_resp(200, response)
325 def upload_json(%{assigns: %{user: user}} = conn, %{"media" => media}) do
326 response = TwitterAPI.upload(media, user, "json")
329 |> json_reply(200, response)
332 def get_by_id_or_ap_id(id) do
333 activity = Repo.get(Activity, id) || Activity.get_create_activity_by_object_ap_id(id)
335 if activity.data["type"] == "Create" do
338 Activity.get_create_activity_by_object_ap_id(activity.data["object"])
342 def favorite(%{assigns: %{user: user}} = conn, %{"id" => id}) do
343 with {_, {:ok, id}} <- {:param_cast, Ecto.Type.cast(:integer, id)},
344 {:ok, activity} <- TwitterAPI.fav(user, id) do
346 |> put_view(ActivityView)
347 |> render("activity.json", %{activity: activity, for: user})
351 def unfavorite(%{assigns: %{user: user}} = conn, %{"id" => id}) do
352 with {_, {:ok, id}} <- {:param_cast, Ecto.Type.cast(:integer, id)},
353 {:ok, activity} <- TwitterAPI.unfav(user, id) do
355 |> put_view(ActivityView)
356 |> render("activity.json", %{activity: activity, for: user})
360 def retweet(%{assigns: %{user: user}} = conn, %{"id" => id}) do
361 with {_, {:ok, id}} <- {:param_cast, Ecto.Type.cast(:integer, id)},
362 {:ok, activity} <- TwitterAPI.repeat(user, id) do
364 |> put_view(ActivityView)
365 |> render("activity.json", %{activity: activity, for: user})
369 def unretweet(%{assigns: %{user: user}} = conn, %{"id" => id}) do
370 with {_, {:ok, id}} <- {:param_cast, Ecto.Type.cast(:integer, id)},
371 {:ok, activity} <- TwitterAPI.unrepeat(user, id) do
373 |> put_view(ActivityView)
374 |> render("activity.json", %{activity: activity, for: user})
378 def pin(%{assigns: %{user: user}} = conn, %{"id" => id}) do
379 with {_, {:ok, id}} <- {:param_cast, Ecto.Type.cast(:integer, id)},
380 {:ok, activity} <- TwitterAPI.pin(user, id) do
382 |> put_view(ActivityView)
383 |> render("activity.json", %{activity: activity, for: user})
385 {:error, message} -> bad_request_reply(conn, message)
390 def unpin(%{assigns: %{user: user}} = conn, %{"id" => id}) do
391 with {_, {:ok, id}} <- {:param_cast, Ecto.Type.cast(:integer, id)},
392 {:ok, activity} <- TwitterAPI.unpin(user, id) do
394 |> put_view(ActivityView)
395 |> render("activity.json", %{activity: activity, for: user})
397 {:error, message} -> bad_request_reply(conn, message)
402 def register(conn, params) do
403 with {:ok, user} <- TwitterAPI.register_user(params) do
405 |> put_view(UserView)
406 |> render("show.json", %{user: user})
410 |> json_reply(400, Jason.encode!(errors))
414 def password_reset(conn, params) do
415 nickname_or_email = params["email"] || params["nickname"]
417 with {:ok, _} <- TwitterAPI.password_reset(nickname_or_email) do
418 json_response(conn, :no_content, "")
422 def confirm_email(conn, %{"user_id" => uid, "token" => token}) do
423 with %User{} = user <- Repo.get(User, uid),
425 true <- user.info.confirmation_pending,
426 true <- user.info.confirmation_token == token,
427 info_change <- User.Info.confirmation_changeset(user.info, :confirmed),
428 changeset <- Changeset.change(user) |> Changeset.put_embed(:info, info_change),
429 {:ok, _} <- User.update_and_set_cache(changeset) do
435 def resend_confirmation_email(conn, params) do
436 nickname_or_email = params["email"] || params["nickname"]
438 with %User{} = user <- User.get_by_nickname_or_email(nickname_or_email),
439 {:ok, _} <- User.try_send_confirmation_email(user) do
441 |> json_response(:no_content, "")
445 def update_avatar(%{assigns: %{user: user}} = conn, params) do
446 {:ok, object} = ActivityPub.upload(params, type: :avatar)
447 change = Changeset.change(user, %{avatar: object.data})
448 {:ok, user} = User.update_and_set_cache(change)
449 CommonAPI.update(user)
452 |> put_view(UserView)
453 |> render("show.json", %{user: user, for: user})
456 def update_banner(%{assigns: %{user: user}} = conn, params) do
457 with {:ok, object} <- ActivityPub.upload(%{"img" => params["banner"]}, type: :banner),
458 new_info <- %{"banner" => object.data},
459 info_cng <- User.Info.profile_update(user.info, new_info),
460 changeset <- Ecto.Changeset.change(user) |> Ecto.Changeset.put_embed(:info, info_cng),
461 {:ok, user} <- User.update_and_set_cache(changeset) do
462 CommonAPI.update(user)
463 %{"url" => [%{"href" => href} | _]} = object.data
464 response = %{url: href} |> Jason.encode!()
467 |> json_reply(200, response)
471 def update_background(%{assigns: %{user: user}} = conn, params) do
472 with {:ok, object} <- ActivityPub.upload(params, type: :background),
473 new_info <- %{"background" => object.data},
474 info_cng <- User.Info.profile_update(user.info, new_info),
475 changeset <- Ecto.Changeset.change(user) |> Ecto.Changeset.put_embed(:info, info_cng),
476 {:ok, _user} <- User.update_and_set_cache(changeset) do
477 %{"url" => [%{"href" => href} | _]} = object.data
478 response = %{url: href} |> Jason.encode!()
481 |> json_reply(200, response)
485 def external_profile(%{assigns: %{user: current_user}} = conn, %{"profileurl" => uri}) do
486 with {:ok, user_map} <- TwitterAPI.get_external_profile(current_user, uri),
487 response <- Jason.encode!(user_map) do
489 |> json_reply(200, response)
494 |> json(%{error: "Can't find user"})
498 def followers(%{assigns: %{user: for_user}} = conn, params) do
499 {:ok, page} = Ecto.Type.cast(:integer, params["page"] || 1)
501 with {:ok, user} <- TwitterAPI.get_user(for_user, params),
502 {:ok, followers} <- User.get_followers(user, page) do
505 for_user && user.id == for_user.id -> followers
506 user.info.hide_network -> []
511 |> put_view(UserView)
512 |> render("index.json", %{users: followers, for: conn.assigns[:user]})
514 _e -> bad_request_reply(conn, "Can't get followers")
518 def friends(%{assigns: %{user: for_user}} = conn, params) do
519 {:ok, page} = Ecto.Type.cast(:integer, params["page"] || 1)
521 with {:ok, user} <- TwitterAPI.get_user(conn.assigns[:user], params),
522 {:ok, friends} <- User.get_friends(user, page) do
525 for_user && user.id == for_user.id -> friends
526 user.info.hide_network -> []
531 |> put_view(UserView)
532 |> render("index.json", %{users: friends, for: conn.assigns[:user]})
534 _e -> bad_request_reply(conn, "Can't get friends")
538 def blocks(%{assigns: %{user: user}} = conn, _params) do
539 with blocked_users <- User.blocked_users(user) do
541 |> put_view(UserView)
542 |> render("index.json", %{users: blocked_users, for: user})
546 def friend_requests(conn, params) do
547 with {:ok, user} <- TwitterAPI.get_user(conn.assigns[:user], params),
548 {:ok, friend_requests} <- User.get_follow_requests(user) do
550 |> put_view(UserView)
551 |> render("index.json", %{users: friend_requests, for: conn.assigns[:user]})
553 _e -> bad_request_reply(conn, "Can't get friend requests")
557 def approve_friend_request(conn, %{"user_id" => uid} = _params) do
558 with followed <- conn.assigns[:user],
559 uid when is_number(uid) <- String.to_integer(uid),
560 %User{} = follower <- Repo.get(User, uid),
561 {:ok, follower} <- User.maybe_follow(follower, followed),
562 %Activity{} = follow_activity <- Utils.fetch_latest_follow(follower, followed),
563 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "accept"),
565 ActivityPub.accept(%{
566 to: [follower.ap_id],
567 actor: followed.ap_id,
568 object: follow_activity.data["id"],
572 |> put_view(UserView)
573 |> render("show.json", %{user: follower, for: followed})
575 e -> bad_request_reply(conn, "Can't approve user: #{inspect(e)}")
579 def deny_friend_request(conn, %{"user_id" => uid} = _params) do
580 with followed <- conn.assigns[:user],
581 uid when is_number(uid) <- String.to_integer(uid),
582 %User{} = follower <- Repo.get(User, uid),
583 %Activity{} = follow_activity <- Utils.fetch_latest_follow(follower, followed),
584 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "reject"),
586 ActivityPub.reject(%{
587 to: [follower.ap_id],
588 actor: followed.ap_id,
589 object: follow_activity.data["id"],
593 |> put_view(UserView)
594 |> render("show.json", %{user: follower, for: followed})
596 e -> bad_request_reply(conn, "Can't deny user: #{inspect(e)}")
600 def friends_ids(%{assigns: %{user: user}} = conn, _params) do
601 with {:ok, friends} <- User.get_friends(user) do
604 |> Enum.map(fn x -> x.id end)
609 _e -> bad_request_reply(conn, "Can't get friends")
613 def empty_array(conn, _params) do
614 json(conn, Jason.encode!([]))
617 def raw_empty_array(conn, _params) do
621 defp build_info_cng(user, params) do
623 ["no_rich_text", "locked", "hide_network"]
624 |> Enum.reduce(%{}, fn key, res ->
625 if value = params[key] do
626 Map.put(res, key, value == "true")
633 if value = params["default_scope"] do
634 Map.put(info_params, "default_scope", value)
639 User.Info.profile_update(user.info, info_params)
642 defp parse_profile_bio(user, params) do
643 if bio = params["description"] do
644 Map.put(params, "bio", User.parse_bio(bio, user))
650 def update_profile(%{assigns: %{user: user}} = conn, params) do
651 params = parse_profile_bio(user, params)
652 info_cng = build_info_cng(user, params)
654 with changeset <- User.update_changeset(user, params),
655 changeset <- Ecto.Changeset.put_embed(changeset, :info, info_cng),
656 {:ok, user} <- User.update_and_set_cache(changeset) do
657 CommonAPI.update(user)
660 |> put_view(UserView)
661 |> render("user.json", %{user: user, for: user})
664 Logger.debug("Can't update user: #{inspect(error)}")
665 bad_request_reply(conn, "Can't update user")
669 def search(%{assigns: %{user: user}} = conn, %{"q" => _query} = params) do
670 activities = TwitterAPI.search(user, params)
673 |> put_view(ActivityView)
674 |> render("index.json", %{activities: activities, for: user})
677 def search_user(%{assigns: %{user: user}} = conn, %{"query" => query}) do
678 users = User.search(query, true)
681 |> put_view(UserView)
682 |> render("index.json", %{users: users, for: user})
685 defp bad_request_reply(conn, error_message) do
686 json = error_json(conn, error_message)
687 json_reply(conn, 400, json)
690 defp json_reply(conn, status, json) do
692 |> put_resp_content_type("application/json")
693 |> send_resp(status, json)
696 defp forbidden_json_reply(conn, error_message) do
697 json = error_json(conn, error_message)
698 json_reply(conn, 403, json)
701 def only_if_public_instance(%{assigns: %{user: %User{}}} = conn, _), do: conn
703 def only_if_public_instance(conn, _) do
704 if Keyword.get(Application.get_env(:pleroma, :instance), :public) do
708 |> forbidden_json_reply("Invalid credentials.")
713 defp error_json(conn, error_message) do
714 %{"error" => error_message, "request" => conn.request_path} |> Jason.encode!()
717 def errors(conn, {:param_cast, _}) do
720 |> json("Invalid parameters")
723 def errors(conn, _) do
726 |> json("Something went wrong")