Merge branch 'develop' into refactor/discoverable_user_field
[akkoma] / lib / pleroma / web / mastodon_api / controllers / timeline_controller.ex
1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
4
5 defmodule Pleroma.Web.MastodonAPI.TimelineController do
6 use Pleroma.Web, :controller
7
8 import Pleroma.Web.ControllerHelper,
9 only: [add_link_headers: 2, add_link_headers: 3]
10
11 alias Pleroma.Config
12 alias Pleroma.Pagination
13 alias Pleroma.User
14 alias Pleroma.Web.ActivityPub.ActivityPub
15 alias Pleroma.Web.Plugs.EnsurePublicOrAuthenticatedPlug
16 alias Pleroma.Web.Plugs.OAuthScopesPlug
17 alias Pleroma.Web.Plugs.RateLimiter
18
19 plug(Pleroma.Web.ApiSpec.CastAndValidate)
20 plug(:skip_plug, EnsurePublicOrAuthenticatedPlug when action in [:public, :hashtag])
21
22 # TODO: Replace with a macro when there is a Phoenix release with the following commit in it:
23 # https://github.com/phoenixframework/phoenix/commit/2e8c63c01fec4dde5467dbbbf9705ff9e780735e
24
25 plug(RateLimiter, [name: :timeline, bucket_name: :direct_timeline] when action == :direct)
26 plug(RateLimiter, [name: :timeline, bucket_name: :public_timeline] when action == :public)
27 plug(RateLimiter, [name: :timeline, bucket_name: :home_timeline] when action == :home)
28 plug(RateLimiter, [name: :timeline, bucket_name: :hashtag_timeline] when action == :hashtag)
29 plug(RateLimiter, [name: :timeline, bucket_name: :list_timeline] when action == :list)
30
31 plug(OAuthScopesPlug, %{scopes: ["read:statuses"]} when action in [:home, :direct])
32 plug(OAuthScopesPlug, %{scopes: ["read:lists"]} when action == :list)
33
34 plug(
35 OAuthScopesPlug,
36 %{scopes: ["read:statuses"], fallback: :proceed_unauthenticated}
37 when action in [:public, :hashtag]
38 )
39
40 plug(:put_view, Pleroma.Web.MastodonAPI.StatusView)
41
42 defdelegate open_api_operation(action), to: Pleroma.Web.ApiSpec.TimelineOperation
43
44 # GET /api/v1/timelines/home
45 def home(%{assigns: %{user: user}} = conn, params) do
46 params =
47 params
48 |> Map.put(:type, ["Create", "Announce"])
49 |> Map.put(:blocking_user, user)
50 |> Map.put(:muting_user, user)
51 |> Map.put(:reply_filtering_user, user)
52 |> Map.put(:announce_filtering_user, user)
53 |> Map.put(:user, user)
54
55 activities =
56 [user.ap_id | User.following(user)]
57 |> ActivityPub.fetch_activities(params)
58 |> Enum.reverse()
59
60 conn
61 |> add_link_headers(activities)
62 |> render("index.json",
63 activities: activities,
64 for: user,
65 as: :activity
66 )
67 end
68
69 # GET /api/v1/timelines/direct
70 def direct(%{assigns: %{user: user}} = conn, params) do
71 params =
72 params
73 |> Map.put(:type, "Create")
74 |> Map.put(:blocking_user, user)
75 |> Map.put(:user, user)
76 |> Map.put(:visibility, "direct")
77
78 activities =
79 [user.ap_id]
80 |> ActivityPub.fetch_activities_query(params)
81 |> Pagination.fetch_paginated(params)
82
83 conn
84 |> add_link_headers(activities)
85 |> render("index.json",
86 activities: activities,
87 for: user,
88 as: :activity
89 )
90 end
91
92 defp restrict_unauthenticated?(true = _local_only) do
93 Config.restrict_unauthenticated_access?(:timelines, :local)
94 end
95
96 defp restrict_unauthenticated?(_) do
97 Config.restrict_unauthenticated_access?(:timelines, :federated)
98 end
99
100 # GET /api/v1/timelines/public
101 def public(%{assigns: %{user: user}} = conn, params) do
102 local_only = params[:local]
103
104 if is_nil(user) and restrict_unauthenticated?(local_only) do
105 fail_on_bad_auth(conn)
106 else
107 activities =
108 params
109 |> Map.put(:type, ["Create"])
110 |> Map.put(:local_only, local_only)
111 |> Map.put(:blocking_user, user)
112 |> Map.put(:muting_user, user)
113 |> Map.put(:reply_filtering_user, user)
114 |> ActivityPub.fetch_public_activities()
115
116 conn
117 |> add_link_headers(activities, %{"local" => local_only})
118 |> render("index.json",
119 activities: activities,
120 for: user,
121 as: :activity
122 )
123 end
124 end
125
126 defp fail_on_bad_auth(conn) do
127 render_error(conn, :unauthorized, "authorization required for timeline view")
128 end
129
130 defp hashtag_fetching(params, user, local_only) do
131 tags =
132 [params[:tag], params[:any]]
133 |> List.flatten()
134 |> Enum.uniq()
135 |> Enum.reject(&is_nil/1)
136 |> Enum.map(&String.downcase/1)
137
138 tag_all =
139 params
140 |> Map.get(:all, [])
141 |> Enum.map(&String.downcase/1)
142
143 tag_reject =
144 params
145 |> Map.get(:none, [])
146 |> Enum.map(&String.downcase/1)
147
148 _activities =
149 params
150 |> Map.put(:type, "Create")
151 |> Map.put(:local_only, local_only)
152 |> Map.put(:blocking_user, user)
153 |> Map.put(:muting_user, user)
154 |> Map.put(:user, user)
155 |> Map.put(:tag, tags)
156 |> Map.put(:tag_all, tag_all)
157 |> Map.put(:tag_reject, tag_reject)
158 |> ActivityPub.fetch_public_activities()
159 end
160
161 # GET /api/v1/timelines/tag/:tag
162 def hashtag(%{assigns: %{user: user}} = conn, params) do
163 local_only = params[:local]
164
165 if is_nil(user) and restrict_unauthenticated?(local_only) do
166 fail_on_bad_auth(conn)
167 else
168 activities = hashtag_fetching(params, user, local_only)
169
170 conn
171 |> add_link_headers(activities, %{"local" => local_only})
172 |> render("index.json",
173 activities: activities,
174 for: user,
175 as: :activity
176 )
177 end
178 end
179
180 # GET /api/v1/timelines/list/:list_id
181 def list(%{assigns: %{user: user}} = conn, %{list_id: id} = params) do
182 with %Pleroma.List{title: _title, following: following} <- Pleroma.List.get(id, user) do
183 params =
184 params
185 |> Map.put(:type, "Create")
186 |> Map.put(:blocking_user, user)
187 |> Map.put(:user, user)
188 |> Map.put(:muting_user, user)
189
190 # we must filter the following list for the user to avoid leaking statuses the user
191 # does not actually have permission to see (for more info, peruse security issue #270).
192
193 user_following = User.following(user)
194
195 activities =
196 following
197 |> Enum.filter(fn x -> x in user_following end)
198 |> ActivityPub.fetch_activities_bounded(following, params)
199 |> Enum.reverse()
200
201 render(conn, "index.json",
202 activities: activities,
203 for: user,
204 as: :activity
205 )
206 else
207 _e -> render_error(conn, :forbidden, "Error.")
208 end
209 end
210 end