frenzy/lib/frenzy/pipeline/scrape_stage.ex

163 lines
4.2 KiB
Elixir

defmodule Frenzy.Pipeline.ScrapeStage do
require Logger
alias Frenzy.Network
alias Frenzy.Pipeline.Stage
@behaviour Stage
@impl Stage
def apply(opts, %{url: url} = item_params) do
case get_article_content(url, opts) do
{:ok, content} ->
{:ok, %{item_params | content: content}}
{:error, reason} ->
Logger.warn("Unable to get article content for #{url}: #{reason}")
{:ok, item_params}
end
end
@impl Stage
def validate_opts(opts) when is_map(opts) do
opts =
case opts["extractor"] do
nil ->
{:ok, Map.put(opts, "extractor", "builtin")}
extractor when not is_binary(extractor) ->
{:error, "extractor must be a string"}
"builtin" ->
{:ok, opts}
extractor ->
try do
String.to_existing_atom("Elixir." <> extractor)
{:ok, opts}
rescue
ArgumentError ->
{:error, "extractor must be \"builtin\" or a module that exists"}
end
end
case opts do
{:ok, opts} ->
case opts["convert_to_data_uris"] do
nil ->
{:ok, Map.put(opts, "convert_to_data_uris", true)}
value when is_boolean(value) ->
{:ok, opts}
_ ->
{:error, "convert_to_data_uris must be a boolean"}
end
_ ->
opts
end
end
@impl Stage
def validate_opts(_), do: {:error, "options must be a map"}
@impl Stage
def default_opts(), do: %{}
@spec get_article_content(String.t(), map()) :: {:ok, String.t()} | {:error, String.t()}
defp get_article_content(url, opts) when is_binary(url) and url != "" do
Logger.debug("Getting article from #{url}")
url
|> Network.http_get()
|> case do
{:ok, response} ->
handle_response(url, response, opts)
{:error, reason} ->
{:error, "Couldn't scrape article: #{reason}"}
end
end
defp get_article_content(_url, _opts), do: {:error, "URL must be a non-empty string"}
@spec handle_response(String.t(), Mojito.Response.t(), map()) ::
{:ok, String.t()} | {:error, String.t()}
defp handle_response(url, %Mojito.Response{body: body}, opts) do
case opts["extractor"] do
"builtin" ->
{:ok, Readability.article(body)}
module_name ->
html_tree = Floki.parse(body)
apply(String.to_existing_atom("Elixir." <> module_name), :extract, [html_tree])
end
|> case do
{:ok, html} ->
convert_to_data_uris =
case opts["convert_to_data_uris"] do
nil -> true
value -> value
end
html = Floki.map(html, rewrite_image_urls(convert_to_data_uris, URI.parse(url)))
case opts["extractor"] do
"builtin" ->
{:ok, Readability.readable_html(html)}
_ ->
{:ok, Floki.raw_html(html)}
end
res ->
res
end
end
# Generates a helper function for the article with the given URI that takes an HTML element and,
# if it's an <img> element whose src attribute does not have a hostname, adds the hostname and
# scheme to the element.
defp rewrite_image_urls(convert_to_data_uris, site_uri) do
fn
{"img", attrs} ->
new_attrs =
Enum.map(attrs, fn
{"src", src} ->
{"src", image_to_data_uri(src, site_uri, convert_to_data_uris)}
attr ->
attr
end)
{"img", new_attrs}
elem ->
elem
end
end
@content_type_allowlist ["image/jpeg", "image/png", "image/heic", "image/heif", "image/tiff"]
# convert images to data URIs so that they're stored by clients as part of the body
defp image_to_data_uri(src, site_uri, true) do
absolute_url = URI.merge(site_uri, src) |> to_string()
case Network.http_get(absolute_url) do
{:ok, %Mojito.Response{body: body, headers: headers}} ->
{"Content-Type", content_type} =
Enum.find(headers, fn {header, _value} -> header == "Content-Type" end)
if content_type in @content_type_allowlist do
"data:#{content_type};base64,#{Base.encode64(body)}"
else
src
end
_ ->
src
end
end
defp image_to_data_uri(src, _site_uri, false), do: src
end