File size: 10,193 Bytes
88211d3 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 | defmodule PlausibleWeb.Live.Shields.HostnameRules do
@moduledoc """
LiveView allowing hostname Rules management
"""
use PlausibleWeb, :live_component
alias PlausibleWeb.Live.Components.Modal
alias Plausible.Shields
alias Plausible.Shield
alias Plausible.Stats.QueryBuilder
def update(assigns, socket) do
socket =
socket
|> assign(
hostname_rules_count: assigns.hostname_rules_count,
site: assigns.site,
current_user: assigns.current_user,
form: new_form()
)
|> assign_new(:hostname_rules, fn %{site: site} ->
Shields.list_hostname_rules(site)
end)
|> assign_new(:redundant_rules, fn %{hostname_rules: hostname_rules} ->
detect_redundancy(hostname_rules)
end)
{:ok, socket}
end
def render(assigns) do
~H"""
<div>
<.settings_tiles>
<.tile docs="excluding#exclude-visits-by-hostname">
<:title>Hostnames allow list</:title>
<:subtitle :if={not Enum.empty?(@hostname_rules)}>
Accept incoming traffic only from familiar hostnames.
</:subtitle>
<%= if Enum.empty?(@hostname_rules) do %>
<div class="flex flex-col items-center justify-center pt-5 pb-6 max-w-md mx-auto">
<h3 class="text-center text-base font-medium text-gray-900 dark:text-gray-100 leading-7">
Allow a hostname
</h3>
<p class="text-center text-sm mt-1 text-gray-500 dark:text-gray-400 leading-5 text-pretty">
Accept incoming traffic only from familiar hostnames. Traffic from all hostnames is recorded until you add your first rule.
<.styled_link
href="https://plausible.io/docs/excluding#exclude-visits-by-hostname"
target="_blank"
>
Learn more
</.styled_link>
</p>
<.button
:if={@hostname_rules_count < Shields.maximum_hostname_rules()}
id="add-hostname-rule"
x-data
x-on:click={Modal.JS.open("hostname-rule-form-modal")}
class="mt-4"
>
Add hostname
</.button>
</div>
<% else %>
<.filter_bar
:if={@hostname_rules_count < Shields.maximum_hostname_rules()}
filtering_enabled?={false}
>
<.button
id="add-hostname-rule"
x-data
x-on:click={Modal.JS.open("hostname-rule-form-modal")}
mt?={false}
>
Add hostname
</.button>
</.filter_bar>
<.notice
:if={@hostname_rules_count >= Shields.maximum_hostname_rules()}
class="mt-4"
title="Maximum number of hostnames reached"
theme={:gray}
>
<p>
You've reached the maximum number of hostnames you can block ({Shields.maximum_hostname_rules()}). Please remove one before adding another.
</p>
</.notice>
<div class="mt-6">
<.table rows={@hostname_rules}>
<:thead>
<.th>Hostname</.th>
<.th hide_on_mobile>Status</.th>
<.th invisible>Actions</.th>
</:thead>
<:tbody :let={rule}>
<.td>
<div class="flex items-center">
<span
id={"hostname-#{rule.id}"}
class="mr-4 cursor-help text-ellipsis truncate max-w-xs"
title={"Added at #{format_added_at(rule.inserted_at, @site.timezone)} by #{rule.added_by}"}
>
{rule.hostname}
</span>
</div>
</.td>
<.td hide_on_mobile>
<div class="flex items-center">
<span :if={rule.action == :deny}>
Blocked
</span>
<span :if={rule.action == :allow}>
Allowed
</span>
<span
:if={@redundant_rules[rule.id]}
title={"This rule might be redundant because the following rules may match first:\n\n#{Enum.join(@redundant_rules[rule.id], "\n")}"}
class="pl-4 cursor-help"
>
<Heroicons.exclamation_triangle class="h-5 w-5 text-red-800" />
</span>
</div>
</.td>
<.td actions>
<.delete_button
id={"remove-hostname-rule-#{rule.id}"}
phx-target={@myself}
phx-click="remove-hostname-rule"
phx-value-rule-id={rule.id}
data-confirm="Are you sure you want to revoke this rule?"
/>
</.td>
</:tbody>
</.table>
</div>
<% end %>
<.live_component :let={modal_unique_id} module={Modal} id="hostname-rule-form-modal">
<.form
:let={f}
for={@form}
phx-submit="save-hostname-rule"
phx-target={@myself}
class="max-w-md w-full mx-auto"
>
<.title>Add hostname to allow list</.title>
<.live_component
class="mt-8"
submit_name="hostname_rule[hostname]"
submit_value={f[:hostname].value}
display_value={f[:hostname].value || ""}
module={PlausibleWeb.Live.Components.ComboBox}
suggest_fun={fn input, options -> suggest_hostnames(input, options, @site) end}
id={"#{f[:hostname].id}-#{modal_unique_id}"}
creatable
/>
<.error :for={msg <- f[:hostname].errors}>{translate_error(msg)}</.error>
<p class="mt-4 text-sm text-gray-500 dark:text-gray-400">
You can use a wildcard (<code>*</code>) to match multiple hostnames. For example,
<code>*{@site.domain}</code>
will only record traffic on your main domain and all of its subdomains.<br /><br />
<%= if @hostname_rules_count >= 1 do %>
Once added, we will start accepting traffic from this hostname within a few minutes.
<% else %>
NB: Once added, we will start rejecting traffic from non-matching hostnames within a few minutes.
<% end %>
</p>
<.button type="submit" class="w-full">
Add hostname
</.button>
</.form>
</.live_component>
</.tile>
</.settings_tiles>
</div>
"""
end
def handle_event("save-hostname-rule", %{"hostname_rule" => params}, socket) do
user = socket.assigns.current_user
case Shields.add_hostname_rule(
socket.assigns.site.id,
params,
added_by: user
) do
{:ok, rule} ->
hostname_rules = [rule | socket.assigns.hostname_rules]
socket =
socket
|> Modal.close("hostname-rule-form-modal")
|> assign(
form: new_form(),
hostname_rules: hostname_rules,
hostname_rules_count: socket.assigns.hostname_rules_count + 1,
redundant_rules: detect_redundancy(hostname_rules)
)
send_flash(
:success,
"Hostname rule added successfully. Traffic will be limited within a few minutes."
)
{:noreply, socket}
{:error, %Ecto.Changeset{} = changeset} ->
{:noreply, assign(socket, form: to_form(changeset))}
end
end
def handle_event("remove-hostname-rule", %{"rule-id" => rule_id}, socket) do
Shields.remove_hostname_rule(socket.assigns.site.id, rule_id)
send_flash(
:success,
"Hostname rule removed successfully. Traffic will be re-adjusted within a few minutes."
)
hostname_rules = Enum.reject(socket.assigns.hostname_rules, &(&1.id == rule_id))
{:noreply,
socket
|> assign(
hostname_rules_count: socket.assigns.hostname_rules_count - 1,
hostname_rules: hostname_rules,
redundant_rules: detect_redundancy(hostname_rules)
)}
end
def send_flash(kind, message) do
send(self(), {:flash, kind, message})
end
defp new_form() do
%Shield.HostnameRule{}
|> Shield.HostnameRule.changeset(%{})
|> to_form()
end
defp format_added_at(dt, tz) do
dt
|> Plausible.Timezones.to_datetime_in_timezone(tz)
|> Calendar.strftime("%Y-%m-%d %H:%M:%S")
end
def suggest_hostnames(input, _options, site) do
query =
QueryBuilder.build!(site,
input_date_range: :all,
metrics: [:pageviews]
)
site
|> Plausible.Stats.filter_suggestions(query, "hostname", input)
|> Enum.map(fn %{label: label, value: value} -> {label, value} end)
end
defp detect_redundancy(hostname_rules) do
hostname_rules
|> Enum.reduce(%{}, fn rule, acc ->
{[^rule], remaining_rules} =
Enum.split_with(
hostname_rules,
fn r -> r == rule end
)
conflicting =
remaining_rules
|> Enum.filter(fn candidate ->
rule
|> Map.fetch!(:hostname_pattern)
|> maybe_compile()
|> Regex.match?(candidate.hostname)
end)
|> Enum.map(& &1.id)
Enum.reduce(conflicting, acc, fn conflicting_rule_id, acc ->
Map.update(acc, conflicting_rule_id, [rule.hostname], fn existing ->
[rule.hostname | 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
|