1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Web.MastodonAPI.TimelineController do
6 use Pleroma.Web, :controller
8 import Pleroma.Web.ControllerHelper,
9 only: [add_link_headers: 2, add_link_headers: 3]
11 alias Pleroma.Pagination
12 alias Pleroma.Plugs.EnsurePublicOrAuthenticatedPlug
13 alias Pleroma.Plugs.OAuthScopesPlug
14 alias Pleroma.Plugs.RateLimiter
16 alias Pleroma.Web.ActivityPub.ActivityPub
18 plug(Pleroma.Web.ApiSpec.CastAndValidate)
19 plug(:skip_plug, EnsurePublicOrAuthenticatedPlug when action in [:public, :hashtag])
21 # TODO: Replace with a macro when there is a Phoenix release with the following commit in it:
22 # https://github.com/phoenixframework/phoenix/commit/2e8c63c01fec4dde5467dbbbf9705ff9e780735e
24 plug(RateLimiter, [name: :timeline, bucket_name: :direct_timeline] when action == :direct)
25 plug(RateLimiter, [name: :timeline, bucket_name: :public_timeline] when action == :public)
26 plug(RateLimiter, [name: :timeline, bucket_name: :home_timeline] when action == :home)
27 plug(RateLimiter, [name: :timeline, bucket_name: :hashtag_timeline] when action == :hashtag)
28 plug(RateLimiter, [name: :timeline, bucket_name: :list_timeline] when action == :list)
30 plug(OAuthScopesPlug, %{scopes: ["read:statuses"]} when action in [:home, :direct])
31 plug(OAuthScopesPlug, %{scopes: ["read:lists"]} when action == :list)
35 %{scopes: ["read:statuses"], fallback: :proceed_unauthenticated}
36 when action in [:public, :hashtag]
39 plug(:put_view, Pleroma.Web.MastodonAPI.StatusView)
41 defdelegate open_api_operation(action), to: Pleroma.Web.ApiSpec.TimelineOperation
43 # GET /api/v1/timelines/home
44 def home(%{assigns: %{user: user}} = conn, params) do
47 |> Map.put(:type, ["Create", "Announce"])
48 |> Map.put(:blocking_user, user)
49 |> Map.put(:muting_user, user)
50 |> Map.put(:reply_filtering_user, user)
51 |> Map.put(:user, user)
54 [user.ap_id | User.following(user)]
55 |> ActivityPub.fetch_activities(params)
59 |> add_link_headers(activities)
60 |> render("index.json",
61 activities: activities,
67 # GET /api/v1/timelines/direct
68 def direct(%{assigns: %{user: user}} = conn, params) do
71 |> Map.put(:type, "Create")
72 |> Map.put(:blocking_user, user)
73 |> Map.put(:user, user)
74 |> Map.put(:visibility, "direct")
78 |> ActivityPub.fetch_activities_query(params)
79 |> Pagination.fetch_paginated(params)
82 |> add_link_headers(activities)
83 |> render("index.json",
84 activities: activities,
90 # GET /api/v1/timelines/public
91 def public(%{assigns: %{user: user}} = conn, params) do
92 local_only = params[:local]
101 restrict? = Pleroma.Config.get([:restrict_unauthenticated, :timelines, cfg_key])
103 if restrict? and is_nil(user) do
104 render_error(conn, :unauthorized, "authorization required for timeline view")
108 |> Map.put(:type, ["Create"])
109 |> Map.put(:local_only, local_only)
110 |> Map.put(:blocking_user, user)
111 |> Map.put(:muting_user, user)
112 |> Map.put(:reply_filtering_user, user)
113 |> ActivityPub.fetch_public_activities()
116 |> add_link_headers(activities, %{"local" => local_only})
117 |> render("index.json",
118 activities: activities,
125 defp hashtag_fetching(params, user, local_only) do
127 [params[:tag], params[:any]]
130 |> Enum.reject(&is_nil/1)
131 |> Enum.map(&String.downcase/1)
136 |> Enum.map(&String.downcase/1)
140 |> Map.get(:none, [])
141 |> Enum.map(&String.downcase/1)
145 |> Map.put(:type, "Create")
146 |> Map.put(:local_only, local_only)
147 |> Map.put(:blocking_user, user)
148 |> Map.put(:muting_user, user)
149 |> Map.put(:user, user)
150 |> Map.put(:tag, tags)
151 |> Map.put(:tag_all, tag_all)
152 |> Map.put(:tag_reject, tag_reject)
153 |> ActivityPub.fetch_public_activities()
156 # GET /api/v1/timelines/tag/:tag
157 def hashtag(%{assigns: %{user: user}} = conn, params) do
158 local_only = params[:local]
159 activities = hashtag_fetching(params, user, local_only)
162 |> add_link_headers(activities, %{"local" => local_only})
163 |> render("index.json",
164 activities: activities,
170 # GET /api/v1/timelines/list/:list_id
171 def list(%{assigns: %{user: user}} = conn, %{list_id: id} = params) do
172 with %Pleroma.List{title: _title, following: following} <- Pleroma.List.get(id, user) do
175 |> Map.new(fn {key, value} -> {to_string(key), value} end)
176 |> Map.put("type", "Create")
177 |> Map.put("blocking_user", user)
178 |> Map.put("user", user)
179 |> Map.put("muting_user", user)
181 # we must filter the following list for the user to avoid leaking statuses the user
182 # does not actually have permission to see (for more info, peruse security issue #270).
184 user_following = User.following(user)
188 |> Enum.filter(fn x -> x in user_following end)
189 |> ActivityPub.fetch_activities_bounded(following, params)
192 render(conn, "index.json",
193 activities: activities,
198 _e -> render_error(conn, :forbidden, "Error.")