defmodule PlausibleWeb.Live.Shields.PageRules do @moduledoc """ LiveView allowing page Rules management """ use Phoenix.LiveComponent, global_prefixes: ~w(x-) use Phoenix.HTML alias PlausibleWeb.Live.Components.Modal alias Plausible.Shields alias Plausible.Shield import PlausibleWeb.ErrorHelpers def update(assigns, socket) do socket = socket |> assign( page_rules_count: assigns[:page_rules_count] || socket.assigns.page_rules_count, site: assigns[:site] || socket.assigns.site, current_user: assigns[:current_user] || socket.assigns.current_user, form: new_form() ) |> assign_new(:page_rules, fn %{site: site} -> Shields.list_page_rules(site) end) |> assign_new(:redundant_rules, fn %{page_rules: page_rules} -> detect_redundancy(page_rules) end) {:ok, socket} end def render(assigns) do ~H"""

Pages Block List

Reject incoming traffic for specific pages

+ Add Page
= Shields.maximum_page_rules()} class="mt-4" title="Maximum number of pages reached" >

You've reached the maximum number of pages you can block (<%= Shields.maximum_page_rules() %>). Please remove one before adding another.

<.live_component module={Modal} id="page-rule-form-modal"> <.form :let={f} for={@form} phx-submit="save-page-rule" phx-target={@myself} class="max-w-md w-full mx-auto bg-white dark:bg-gray-800" >

Add Page to Block List

<.live_component submit_name="page_rule[page_path]" submit_value={f[:page_path].value} display_value={f[:page_path].value || ""} module={PlausibleWeb.Live.Components.ComboBox} suggest_fun={fn input, options -> suggest_page_paths(input, options, @site) end} id={f[:page_path].id} creatable /> <%= error_tag(f, :page_path) %>

You can use a wildcard (*) to match multiple pages. For example, /blog/* will match /blog/post. Once added, we will start rejecting traffic from this page within a few minutes.

Add Page →

No Page Rules configured for this Site.

<%= for rule <- @page_rules do %> <% end %>
page Status Remove
<%= rule.page_path %>
Blocked Allowed
""" end def handle_event("save-page-rule", %{"page_rule" => params}, socket) do user = socket.assigns.current_user case Shields.add_page_rule( socket.assigns.site.id, params, added_by: user ) do {:ok, rule} -> page_rules = [rule | socket.assigns.page_rules] socket = socket |> Modal.close("page-rule-form-modal") |> assign( form: new_form(), page_rules: page_rules, page_rules_count: socket.assigns.page_rules_count + 1, redundant_rules: detect_redundancy(page_rules) ) # Make sure to clear the combobox input after adding a page rule, on subsequent modal reopening send_update(PlausibleWeb.Live.Components.ComboBox, id: "page_rule_page_code", display_value: "" ) send_flash( :success, "Page rule added successfully. Traffic will be rejected within a few minutes." ) {:noreply, socket} {:error, %Ecto.Changeset{} = changeset} -> {:noreply, assign(socket, form: to_form(changeset))} end end def handle_event("remove-page-rule", %{"rule-id" => rule_id}, socket) do Shields.remove_page_rule(socket.assigns.site.id, rule_id) send_flash( :success, "Page rule removed successfully. Traffic will be resumed within a few minutes." ) page_rules = Enum.reject(socket.assigns.page_rules, &(&1.id == rule_id)) {:noreply, socket |> assign( page_rules_count: socket.assigns.page_rules_count - 1, page_rules: page_rules, redundant_rules: detect_redundancy(page_rules) )} end def send_flash(kind, message) do send(self(), {:flash, kind, message}) end defp new_form() do %Shield.PageRule{} |> Shield.PageRule.changeset(%{}) |> to_form() end defp format_added_at(dt, tz) do dt |> Plausible.Timezones.to_datetime_in_timezone(tz) |> Timex.format!("{YYYY}-{0M}-{0D} {h24}:{m}:{s}") end def suggest_page_paths(input, _options, site) do query = Plausible.Stats.Query.from(site, %{}) site |> Plausible.Stats.filter_suggestions(query, "page", input) |> Enum.map(fn %{label: label, value: value} -> {label, value} end) end defp detect_redundancy(page_rules) do page_rules |> Enum.reduce(%{}, fn rule, acc -> {[^rule], remaining_rules} = Enum.split_with( page_rules, fn r -> r == rule end ) conflicting = remaining_rules |> Enum.filter(fn candidate -> rule |> Map.fetch!(:page_path_pattern) |> maybe_compile() |> Regex.match?(candidate.page_path) end) |> Enum.map(& &1.id) Enum.reduce(conflicting, acc, fn conflicting_rule_id, acc -> Map.update(acc, conflicting_rule_id, [rule.page_path], fn existing -> [rule.page_path | existing] end) end) end) end defp maybe_compile(pattern) when is_binary(pattern), do: Regex.compile!(pattern) defp maybe_compile(%Regex{} = pattern), do: pattern end