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, truthy_param?: 1, skip_relationships?: 1]
11 alias Pleroma.Pagination
12 alias Pleroma.Plugs.OAuthScopesPlug
13 alias Pleroma.Plugs.RateLimiter
15 alias Pleroma.Web.ActivityPub.ActivityPub
17 # TODO: Replace with a macro when there is a Phoenix release with the following commit in it:
18 # https://github.com/phoenixframework/phoenix/commit/2e8c63c01fec4dde5467dbbbf9705ff9e780735e
20 plug(RateLimiter, [name: :timeline, bucket_name: :direct_timeline] when action == :direct)
21 plug(RateLimiter, [name: :timeline, bucket_name: :public_timeline] when action == :public)
22 plug(RateLimiter, [name: :timeline, bucket_name: :home_timeline] when action == :home)
23 plug(RateLimiter, [name: :timeline, bucket_name: :hashtag_timeline] when action == :hashtag)
24 plug(RateLimiter, [name: :timeline, bucket_name: :list_timeline] when action == :list)
26 plug(OAuthScopesPlug, %{scopes: ["read:statuses"]} when action in [:home, :direct])
27 plug(OAuthScopesPlug, %{scopes: ["read:lists"]} when action == :list)
29 plug(Pleroma.Plugs.EnsurePublicOrAuthenticatedPlug when action != :public)
31 plug(:put_view, Pleroma.Web.MastodonAPI.StatusView)
33 # GET /api/v1/timelines/home
34 def home(%{assigns: %{user: user}} = conn, params) do
37 |> Map.put("type", ["Create", "Announce"])
38 |> Map.put("blocking_user", user)
39 |> Map.put("muting_user", user)
40 |> Map.put("user", user)
42 recipients = [user.ap_id | User.following(user)]
46 |> ActivityPub.fetch_activities(params)
50 |> add_link_headers(activities)
51 |> render("index.json",
52 activities: activities,
55 skip_relationships: skip_relationships?(params)
59 # GET /api/v1/timelines/direct
60 def direct(%{assigns: %{user: user}} = conn, params) do
63 |> Map.put("type", "Create")
64 |> Map.put("blocking_user", user)
65 |> Map.put("user", user)
66 |> Map.put(:visibility, "direct")
70 |> ActivityPub.fetch_activities_query(params)
71 |> Pagination.fetch_paginated(params)
74 |> add_link_headers(activities)
75 |> render("index.json",
76 activities: activities,
79 skip_relationships: skip_relationships?(params)
83 # GET /api/v1/timelines/public
84 def public(%{assigns: %{user: user}} = conn, params) do
85 local_only = truthy_param?(params["local"])
94 restrict? = Pleroma.Config.get([:restrict_unauthenticated, :timelines, cfg_key])
96 if not (restrict? and is_nil(user)) do
99 |> Map.put("type", ["Create", "Announce"])
100 |> Map.put("local_only", local_only)
101 |> Map.put("blocking_user", user)
102 |> Map.put("muting_user", user)
103 |> ActivityPub.fetch_public_activities()
106 |> add_link_headers(activities, %{"local" => local_only})
107 |> render("index.json",
108 activities: activities,
111 skip_relationships: skip_relationships?(params)
114 render_error(conn, :unauthorized, "authorization required for timeline view")
118 def hashtag_fetching(params, user, local_only) do
120 [params["tag"], params["any"]]
124 |> Enum.map(&String.downcase(&1))
128 |> Map.get("all", [])
129 |> Enum.map(&String.downcase(&1))
133 |> Map.get("none", [])
134 |> Enum.map(&String.downcase(&1))
138 |> Map.put("type", "Create")
139 |> Map.put("local_only", local_only)
140 |> Map.put("blocking_user", user)
141 |> Map.put("muting_user", user)
142 |> Map.put("user", user)
143 |> Map.put("tag", tags)
144 |> Map.put("tag_all", tag_all)
145 |> Map.put("tag_reject", tag_reject)
146 |> ActivityPub.fetch_public_activities()
149 # GET /api/v1/timelines/tag/:tag
150 def hashtag(%{assigns: %{user: user}} = conn, params) do
151 local_only = truthy_param?(params["local"])
153 activities = hashtag_fetching(params, user, local_only)
156 |> add_link_headers(activities, %{"local" => local_only})
157 |> render("index.json",
158 activities: activities,
161 skip_relationships: skip_relationships?(params)
165 # GET /api/v1/timelines/list/:list_id
166 def list(%{assigns: %{user: user}} = conn, %{"list_id" => id} = params) do
167 with %Pleroma.List{title: _title, following: following} <- Pleroma.List.get(id, user) do
170 |> Map.put("type", "Create")
171 |> Map.put("blocking_user", user)
172 |> Map.put("user", user)
173 |> Map.put("muting_user", user)
175 # we must filter the following list for the user to avoid leaking statuses the user
176 # does not actually have permission to see (for more info, peruse security issue #270).
178 user_following = User.following(user)
182 |> Enum.filter(fn x -> x in user_following end)
183 |> ActivityPub.fetch_activities_bounded(following, params)
186 render(conn, "index.json",
187 activities: activities,
190 skip_relationships: skip_relationships?(params)
193 _e -> render_error(conn, :forbidden, "Error.")