aboutsummaryrefslogtreecommitdiff
path: root/lib/pleroma/web/metadata/providers
diff options
context:
space:
mode:
Diffstat (limited to 'lib/pleroma/web/metadata/providers')
-rw-r--r--lib/pleroma/web/metadata/providers/feed.ex23
-rw-r--r--lib/pleroma/web/metadata/providers/open_graph.ex148
-rw-r--r--lib/pleroma/web/metadata/providers/provider.ex7
-rw-r--r--lib/pleroma/web/metadata/providers/rel_me.ex19
-rw-r--r--lib/pleroma/web/metadata/providers/restrict_indexing.ex24
-rw-r--r--lib/pleroma/web/metadata/providers/twitter_card.ex134
6 files changed, 355 insertions, 0 deletions
diff --git a/lib/pleroma/web/metadata/providers/feed.ex b/lib/pleroma/web/metadata/providers/feed.ex
new file mode 100644
index 000000000..d0ab5c19e
--- /dev/null
+++ b/lib/pleroma/web/metadata/providers/feed.ex
@@ -0,0 +1,23 @@
+# Pleroma: A lightweight social networking server
+# Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
+# SPDX-License-Identifier: AGPL-3.0-only
+
+defmodule Pleroma.Web.Metadata.Providers.Feed do
+ alias Pleroma.Web.Endpoint
+ alias Pleroma.Web.Metadata.Providers.Provider
+ alias Pleroma.Web.Router.Helpers
+
+ @behaviour Provider
+
+ @impl Provider
+ def build_tags(%{user: user}) do
+ [
+ {:link,
+ [
+ rel: "alternate",
+ type: "application/atom+xml",
+ href: Helpers.user_feed_path(Endpoint, :feed, user.nickname) <> ".atom"
+ ], []}
+ ]
+ end
+end
diff --git a/lib/pleroma/web/metadata/providers/open_graph.ex b/lib/pleroma/web/metadata/providers/open_graph.ex
new file mode 100644
index 000000000..df0cca74a
--- /dev/null
+++ b/lib/pleroma/web/metadata/providers/open_graph.ex
@@ -0,0 +1,148 @@
+# Pleroma: A lightweight social networking server
+# Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
+# SPDX-License-Identifier: AGPL-3.0-only
+
+defmodule Pleroma.Web.Metadata.Providers.OpenGraph do
+ alias Pleroma.User
+ alias Pleroma.Web.MediaProxy
+ alias Pleroma.Web.Metadata
+ alias Pleroma.Web.Metadata.Providers.Provider
+ alias Pleroma.Web.Metadata.Utils
+
+ @behaviour Provider
+ @media_types ["image", "audio", "video"]
+
+ @impl Provider
+ def build_tags(%{
+ object: object,
+ url: url,
+ user: user
+ }) do
+ attachments = build_attachments(object)
+ scrubbed_content = Utils.scrub_html_and_truncate(object)
+
+ [
+ {:meta,
+ [
+ property: "og:title",
+ content: Utils.user_name_string(user)
+ ], []},
+ {:meta, [property: "og:url", content: url], []},
+ {:meta,
+ [
+ property: "og:description",
+ content: scrubbed_content
+ ], []},
+ {:meta, [property: "og:type", content: "article"], []}
+ ] ++
+ if attachments == [] or Metadata.activity_nsfw?(object) do
+ [
+ {:meta, [property: "og:image", content: MediaProxy.preview_url(User.avatar_url(user))],
+ []},
+ {:meta, [property: "og:image:width", content: 150], []},
+ {:meta, [property: "og:image:height", content: 150], []}
+ ]
+ else
+ attachments
+ end
+ end
+
+ @impl Provider
+ def build_tags(%{user: user}) do
+ with truncated_bio = Utils.scrub_html_and_truncate(user.bio) do
+ [
+ {:meta,
+ [
+ property: "og:title",
+ content: Utils.user_name_string(user)
+ ], []},
+ {:meta, [property: "og:url", content: user.uri || user.ap_id], []},
+ {:meta, [property: "og:description", content: truncated_bio], []},
+ {:meta, [property: "og:type", content: "article"], []},
+ {:meta, [property: "og:image", content: MediaProxy.preview_url(User.avatar_url(user))],
+ []},
+ {:meta, [property: "og:image:width", content: 150], []},
+ {:meta, [property: "og:image:height", content: 150], []}
+ ]
+ end
+ end
+
+ defp build_attachments(%{data: %{"attachment" => attachments}}) do
+ Enum.reduce(attachments, [], fn attachment, acc ->
+ rendered_tags =
+ Enum.reduce(attachment["url"], [], fn url, acc ->
+ # TODO: Whatsapp only wants JPEG or PNGs. It seems that if we add a second og:image
+ # object when a Video or GIF is attached it will display that in Whatsapp Rich Preview.
+ case Utils.fetch_media_type(@media_types, url["mediaType"]) do
+ "audio" ->
+ [
+ {:meta, [property: "og:audio", content: MediaProxy.url(url["href"])], []}
+ | acc
+ ]
+
+ # Not using preview_url for this. It saves bandwidth, but the image dimensions will
+ # be wrong. We generate it on the fly and have no way to capture or analyze the
+ # image to get the dimensions. This can be an issue for apps/FEs rendering images
+ # in timelines too, but you can get clever with the aspect ratio metadata as a
+ # workaround.
+ "image" ->
+ [
+ {:meta, [property: "og:image", content: MediaProxy.url(url["href"])], []},
+ {:meta, [property: "og:image:alt", content: attachment["name"]], []}
+ | acc
+ ]
+ |> maybe_add_dimensions(url)
+
+ "video" ->
+ [
+ {:meta, [property: "og:video", content: MediaProxy.url(url["href"])], []}
+ | acc
+ ]
+ |> maybe_add_dimensions(url)
+ |> maybe_add_video_thumbnail(url)
+
+ _ ->
+ acc
+ end
+ end)
+
+ acc ++ rendered_tags
+ end)
+ end
+
+ defp build_attachments(_), do: []
+
+ # We can use url["mediaType"] to dynamically fill the metadata
+ defp maybe_add_dimensions(metadata, url) do
+ type = url["mediaType"] |> String.split("/") |> List.first()
+
+ cond do
+ !is_nil(url["height"]) && !is_nil(url["width"]) ->
+ metadata ++
+ [
+ {:meta, [property: "og:#{type}:width", content: "#{url["width"]}"], []},
+ {:meta, [property: "og:#{type}:height", content: "#{url["height"]}"], []}
+ ]
+
+ true ->
+ metadata
+ end
+ end
+
+ # Media Preview Proxy makes thumbnails of videos without resizing, so we can trust the
+ # width and height of the source video.
+ defp maybe_add_video_thumbnail(metadata, url) do
+ cond do
+ Pleroma.Config.get([:media_preview_proxy, :enabled], false) ->
+ metadata ++
+ [
+ {:meta, [property: "og:image:width", content: "#{url["width"]}"], []},
+ {:meta, [property: "og:image:height", content: "#{url["height"]}"], []},
+ {:meta, [property: "og:image", content: MediaProxy.preview_url(url["href"])], []}
+ ]
+
+ true ->
+ metadata
+ end
+ end
+end
diff --git a/lib/pleroma/web/metadata/providers/provider.ex b/lib/pleroma/web/metadata/providers/provider.ex
new file mode 100644
index 000000000..c91d87c6d
--- /dev/null
+++ b/lib/pleroma/web/metadata/providers/provider.ex
@@ -0,0 +1,7 @@
+# Pleroma: A lightweight social networking server
+# Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
+# SPDX-License-Identifier: AGPL-3.0-only
+
+defmodule Pleroma.Web.Metadata.Providers.Provider do
+ @callback build_tags(map()) :: list()
+end
diff --git a/lib/pleroma/web/metadata/providers/rel_me.ex b/lib/pleroma/web/metadata/providers/rel_me.ex
new file mode 100644
index 000000000..f013def51
--- /dev/null
+++ b/lib/pleroma/web/metadata/providers/rel_me.ex
@@ -0,0 +1,19 @@
+# Pleroma: A lightweight social networking server
+# Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
+# SPDX-License-Identifier: AGPL-3.0-only
+
+defmodule Pleroma.Web.Metadata.Providers.RelMe do
+ alias Pleroma.Web.Metadata.Providers.Provider
+ @behaviour Provider
+
+ @impl Provider
+ def build_tags(%{user: user}) do
+ bio_tree = Floki.parse_fragment!(user.bio)
+
+ (Floki.attribute(bio_tree, "link[rel~=me]", "href") ++
+ Floki.attribute(bio_tree, "a[rel~=me]", "href"))
+ |> Enum.map(fn link ->
+ {:link, [rel: "me", href: link], []}
+ end)
+ end
+end
diff --git a/lib/pleroma/web/metadata/providers/restrict_indexing.ex b/lib/pleroma/web/metadata/providers/restrict_indexing.ex
new file mode 100644
index 000000000..aa6511610
--- /dev/null
+++ b/lib/pleroma/web/metadata/providers/restrict_indexing.ex
@@ -0,0 +1,24 @@
+# Pleroma: A lightweight social networking server
+# Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
+# SPDX-License-Identifier: AGPL-3.0-only
+
+defmodule Pleroma.Web.Metadata.Providers.RestrictIndexing do
+ @behaviour Pleroma.Web.Metadata.Providers.Provider
+
+ @moduledoc """
+ Restricts indexing of remote and/or non-discoverable users.
+ """
+
+ @impl true
+ def build_tags(%{user: %{local: true, is_discoverable: true}}), do: []
+
+ def build_tags(_) do
+ [
+ {:meta,
+ [
+ name: "robots",
+ content: "noindex, noarchive"
+ ], []}
+ ]
+ end
+end
diff --git a/lib/pleroma/web/metadata/providers/twitter_card.ex b/lib/pleroma/web/metadata/providers/twitter_card.ex
new file mode 100644
index 000000000..79183df86
--- /dev/null
+++ b/lib/pleroma/web/metadata/providers/twitter_card.ex
@@ -0,0 +1,134 @@
+# Pleroma: A lightweight social networking server
+
+# Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
+# SPDX-License-Identifier: AGPL-3.0-only
+
+defmodule Pleroma.Web.Metadata.Providers.TwitterCard do
+ alias Pleroma.User
+ alias Pleroma.Web.MediaProxy
+ alias Pleroma.Web.Metadata
+ alias Pleroma.Web.Metadata.Providers.Provider
+ alias Pleroma.Web.Metadata.Utils
+
+ @behaviour Provider
+ @media_types ["image", "audio", "video"]
+
+ @impl Provider
+ def build_tags(%{activity_id: id, object: object, user: user}) do
+ attachments = build_attachments(id, object)
+ scrubbed_content = Utils.scrub_html_and_truncate(object)
+
+ [
+ title_tag(user),
+ {:meta, [property: "twitter:description", content: scrubbed_content], []}
+ ] ++
+ if attachments == [] or Metadata.activity_nsfw?(object) do
+ [
+ image_tag(user),
+ {:meta, [property: "twitter:card", content: "summary"], []}
+ ]
+ else
+ attachments
+ end
+ end
+
+ @impl Provider
+ def build_tags(%{user: user}) do
+ with truncated_bio = Utils.scrub_html_and_truncate(user.bio) do
+ [
+ title_tag(user),
+ {:meta, [property: "twitter:description", content: truncated_bio], []},
+ image_tag(user),
+ {:meta, [property: "twitter:card", content: "summary"], []}
+ ]
+ end
+ end
+
+ defp title_tag(user) do
+ {:meta, [property: "twitter:title", content: Utils.user_name_string(user)], []}
+ end
+
+ def image_tag(user) do
+ {:meta, [property: "twitter:image", content: MediaProxy.preview_url(User.avatar_url(user))],
+ []}
+ end
+
+ defp build_attachments(id, %{data: %{"attachment" => attachments}}) do
+ Enum.reduce(attachments, [], fn attachment, acc ->
+ rendered_tags =
+ Enum.reduce(attachment["url"], [], fn url, acc ->
+ case Utils.fetch_media_type(@media_types, url["mediaType"]) do
+ "audio" ->
+ [
+ {:meta, [property: "twitter:card", content: "player"], []},
+ {:meta, [property: "twitter:player:width", content: "480"], []},
+ {:meta, [property: "twitter:player:height", content: "80"], []},
+ {:meta, [property: "twitter:player", content: player_url(id)], []}
+ | acc
+ ]
+
+ # Not using preview_url for this. It saves bandwidth, but the image dimensions will
+ # be wrong. We generate it on the fly and have no way to capture or analyze the
+ # image to get the dimensions. This can be an issue for apps/FEs rendering images
+ # in timelines too, but you can get clever with the aspect ratio metadata as a
+ # workaround.
+ "image" ->
+ [
+ {:meta, [property: "twitter:card", content: "summary_large_image"], []},
+ {:meta,
+ [
+ property: "twitter:player",
+ content: MediaProxy.url(url["href"])
+ ], []}
+ | acc
+ ]
+ |> maybe_add_dimensions(url)
+
+ "video" ->
+ # fallback to old placeholder values
+ height = url["height"] || 480
+ width = url["width"] || 480
+
+ [
+ {:meta, [property: "twitter:card", content: "player"], []},
+ {:meta, [property: "twitter:player", content: player_url(id)], []},
+ {:meta, [property: "twitter:player:width", content: "#{width}"], []},
+ {:meta, [property: "twitter:player:height", content: "#{height}"], []},
+ {:meta, [property: "twitter:player:stream", content: MediaProxy.url(url["href"])],
+ []},
+ {:meta,
+ [property: "twitter:player:stream:content_type", content: url["mediaType"]], []}
+ | acc
+ ]
+
+ _ ->
+ acc
+ end
+ end)
+
+ acc ++ rendered_tags
+ end)
+ end
+
+ defp build_attachments(_id, _object), do: []
+
+ defp player_url(id) do
+ Pleroma.Web.Router.Helpers.o_status_url(Pleroma.Web.Endpoint, :notice_player, id)
+ end
+
+ # Videos have problems without dimensions, but we used to not provide WxH for images.
+ # A default (read: incorrect) fallback for images is likely to cause rendering bugs.
+ defp maybe_add_dimensions(metadata, url) do
+ cond do
+ !is_nil(url["height"]) && !is_nil(url["width"]) ->
+ metadata ++
+ [
+ {:meta, [property: "twitter:player:width", content: "#{url["width"]}"], []},
+ {:meta, [property: "twitter:player:height", content: "#{url["height"]}"], []}
+ ]
+
+ true ->
+ metadata
+ end
+ end
+end