File size: 13,640 Bytes
8da2481 | 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 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 | defmodule Plausible.Segments do
@moduledoc """
Module for accessing Segments.
"""
alias Plausible.Segments.Segment
alias Plausible.Repo
import Ecto.Query
@roles_with_personal_segments [:billing, :viewer, :editor, :admin, :owner, :super_admin]
@roles_with_maybe_site_segments [:editor, :admin, :owner, :super_admin]
@type error_not_enough_permissions() :: {:error, :not_enough_permissions}
@type error_segment_not_found() :: {:error, :segment_not_found}
@type error_segment_limit_reached() :: {:error, :segment_limit_reached}
@type error_invalid_segment() :: {:error, {:invalid_segment, Keyword.t()}}
@type unknown_error() :: {:error, any()}
@max_segments 500
def get_all_for_site(%Plausible.Site{} = site, site_role) do
fields = [:id, :name, :type, :inserted_at, :updated_at, :segment_data]
cond do
site_role in [:public] ->
{:ok,
Repo.all(
from(segment in Segment,
select: ^fields,
where: segment.site_id == ^site.id,
order_by: [desc: segment.updated_at, desc: segment.id]
)
)}
site_role in roles_with_personal_segments() or site_role in roles_with_maybe_site_segments() ->
fields = fields ++ [:owner_id]
{:ok,
Repo.all(
from(segment in Segment,
select: ^fields,
where: segment.site_id == ^site.id,
order_by: [desc: segment.updated_at, desc: segment.id],
preload: [:owner]
)
)}
true ->
{:error, :not_enough_permissions}
end
end
@spec get_many(Plausible.Site.t(), list(pos_integer()), Keyword.t()) ::
{:ok, [Segment.t()]}
def get_many(%Plausible.Site{} = _site, segment_ids, _opts)
when segment_ids == [] do
{:ok, []}
end
def get_many(%Plausible.Site{} = site, segment_ids, opts)
when is_list(segment_ids) do
fields = Keyword.get(opts, :fields, [:id])
query =
from(segment in Segment,
select: ^fields,
where: segment.site_id == ^site.id,
where: segment.id in ^segment_ids
)
{:ok, Repo.all(query)}
end
def search_by_name(%Plausible.Site{} = site, input) do
type = :site
fields = [:id, :name]
input_empty? = is_nil(input) or (is_binary(input) and String.trim(input) == "")
base_query =
from(segment in Segment,
where: segment.site_id == ^site.id,
where: segment.type == ^type,
limit: 20
)
query =
if input_empty? do
from([segment] in base_query,
select: ^fields,
order_by: [desc: segment.updated_at]
)
else
from([segment] in base_query,
select: %{
id: segment.id,
name: segment.name,
match_rank:
fragment(
"CASE
WHEN lower(?) = lower(?) THEN 0 -- exact match
WHEN lower(?) LIKE lower(?) || '%' THEN 1 -- starts with
WHEN lower(?) LIKE '% ' || lower(?) || '%' THEN 2 -- after a space
WHEN lower(?) ILIKE ? THEN 3 -- anywhere
END AS match_rank",
segment.name,
^input,
segment.name,
^input,
segment.name,
^input,
segment.name,
^"%#{input}%"
),
pos:
fragment(
"position(lower(?) IN lower(?)) AS pos",
^input,
segment.name
),
len_diff: fragment("abs(length(?) - length(?)) AS len_diff", segment.name, ^input)
},
where: fragment("? ilike ?", segment.name, ^"%#{input}%"),
order_by: fragment("match_rank asc, pos asc, len_diff asc, updated_at desc")
)
end
{:ok, Repo.all(query)}
end
@spec get_one(pos_integer(), Plausible.Site.t(), atom(), pos_integer() | nil) ::
{:ok, Segment.t()}
| error_not_enough_permissions()
| error_segment_not_found()
def get_one(user_id, site, site_role, segment_id) do
if site_role in roles_with_personal_segments() do
case do_get_one(user_id, site.id, segment_id) do
%Segment{} = segment -> {:ok, segment}
nil -> {:error, :segment_not_found}
end
else
{:error, :not_enough_permissions}
end
end
@spec insert_one(pos_integer(), Plausible.Site.t(), atom(), map()) ::
{:ok, Segment.t()}
| error_not_enough_permissions()
| error_invalid_segment()
| error_segment_limit_reached()
| unknown_error()
def insert_one(
user_id,
%Plausible.Site{} = site,
site_role,
%{} = params
) do
with :ok <- can_insert_one?(site, site_role, params),
%{valid?: true} = changeset <-
Segment.changeset(
%Segment{site_id: site.id},
Map.merge(params, %{"owner_id" => user_id})
),
:ok <-
Segment.validate_segment_data(site, params["segment_data"], true) do
{:ok, changeset |> Repo.insert!() |> Repo.preload(:owner)}
else
%{valid?: false, errors: errors} ->
{:error, {:invalid_segment, errors}}
{:error, {:invalid_filters, message}} ->
{:error, {:invalid_segment, segment_data: {message, []}}}
{:error, _type} = error ->
error
end
end
@spec update_one(pos_integer(), Plausible.Site.t(), atom(), pos_integer(), map()) ::
{:ok, Segment.t()}
| error_not_enough_permissions()
| error_invalid_segment()
| unknown_error()
def update_one(
user_id,
%Plausible.Site{} = site,
site_role,
segment_id,
%{} = params
) do
with {:ok, segment} <- get_one(user_id, site, site_role, segment_id),
:ok <- can_update_one?(site, site_role, params, segment.type),
%{valid?: true} = changeset <-
Segment.changeset(
segment,
Map.merge(params, %{"owner_id" => user_id})
),
:ok <-
Segment.validate_segment_data_if_exists(
site,
params["segment_data"],
true
) do
Repo.update!(changeset)
{:ok, Repo.reload!(segment) |> Repo.preload(:owner)}
else
%{valid?: false, errors: errors} ->
{:error, {:invalid_segment, errors}}
{:error, {:invalid_filters, message}} ->
{:error, {:invalid_segment, segment_data: {message, []}}}
{:error, _type} = error ->
error
end
end
def update_goal_in_segments(
%Plausible.Site{} = site,
%Plausible.Goal{} = stale_goal,
%Plausible.Goal{} = updated_goal
) do
# Looks for a pattern like ["is", "event:goal", [...<goal_name>...]] in the filters structure.
# Added a bunch of whitespace matchers to make sure it's tolerant of valid JSON formatting
goal_filter_regex =
~s(.*?\\[\s*"is",\s*"event:goal",\s*\\[.*?"#{Regex.escape(stale_goal.display_name)}".*?\\]\s*\\].*?)
segments_to_update =
from(
s in Segment,
where: s.site_id == ^site.id,
where: fragment("?['filters']::text ~ ?", s.segment_data, ^goal_filter_regex)
)
stale_goal_name = stale_goal.display_name
for segment <- Repo.all(segments_to_update) do
updated_filters =
Plausible.Stats.Filters.transform_filters(segment.segment_data["filters"], fn
["is", "event:goal", clauses] ->
new_clauses =
Enum.map(clauses, fn
^stale_goal_name -> updated_goal.display_name
clause -> clause
end)
[["is", "event:goal", new_clauses]]
_ ->
nil
end)
updated_segment_data = Map.put(segment.segment_data, "filters", updated_filters)
from(
s in Segment,
where: s.id == ^segment.id,
update: [set: [segment_data: ^updated_segment_data]]
)
|> Repo.update_all([])
end
:ok
end
def after_user_removed_from_site(site, user) do
Repo.delete_all(
from segment in Segment,
where: segment.site_id == ^site.id,
where: segment.owner_id == ^user.id,
where: segment.type == :personal
)
Repo.update_all(
from(segment in Segment,
where: segment.site_id == ^site.id,
where: segment.owner_id == ^user.id,
where: segment.type == :site,
update: [set: [owner_id: nil]]
),
[]
)
end
def after_user_removed_from_team(team, user) do
team_sites_q =
from(
site in Plausible.Site,
where: site.team_id == ^team.id,
where: parent_as(:segment).site_id == site.id
)
Repo.delete_all(
from segment in Segment,
as: :segment,
where: segment.owner_id == ^user.id,
where: segment.type == :personal,
where: exists(team_sites_q)
)
Repo.update_all(
from(segment in Segment,
as: :segment,
where: segment.owner_id == ^user.id,
where: segment.type == :site,
where: exists(team_sites_q),
update: [set: [owner_id: nil]]
),
[]
)
end
def user_removed(user) do
Repo.delete_all(
from segment in Segment,
as: :segment,
where: segment.owner_id == ^user.id,
where: segment.type == :personal
)
# Site segments are set to owner=null via ON DELETE SET NULL
end
def delete_one(user_id, %Plausible.Site{} = site, site_role, segment_id) do
with {:ok, segment} <- get_one(user_id, site, site_role, segment_id) do
cond do
segment.type == :site and site_role in roles_with_maybe_site_segments() ->
{:ok, do_delete_one(segment)}
segment.type == :personal and site_role in roles_with_personal_segments() ->
{:ok, do_delete_one(segment)}
true ->
{:error, :not_enough_permissions}
end
end
end
def get_related_shared_links(
_site,
_site_role,
nil
) do
{:error, :segment_not_found}
end
def get_related_shared_links(
%Plausible.Site{} = site,
site_role,
segment_id
) do
if site_role in roles_with_personal_segments() do
{:ok,
Repo.all(
from(shared_link in Plausible.Site.SharedLink,
select: [:name],
where: shared_link.segment_id == ^segment_id,
where: shared_link.site_id == ^site.id
)
)}
else
{:error, :not_enough_permissions}
end
end
@spec do_get_one(pos_integer(), pos_integer(), pos_integer() | nil) ::
Segment.t() | nil
defp do_get_one(user_id, site_id, segment_id)
defp do_get_one(_user_id, _site_id, nil) do
nil
end
defp do_get_one(user_id, site_id, segment_id) do
query =
from(segment in Segment,
where: segment.site_id == ^site_id,
where: segment.id == ^segment_id,
where: segment.type == :site or segment.owner_id == ^user_id,
preload: [:owner]
)
Repo.one(query)
end
defp do_delete_one(segment) do
Repo.delete!(segment)
segment
end
defp can_update_one?(%Plausible.Site{} = site, site_role, params, existing_segment_type) do
updating_to_site_segment? = params["type"] == "site"
cond do
(existing_segment_type == :site or
updating_to_site_segment?) and site_role in roles_with_maybe_site_segments() and
site_segments_available?(site) ->
:ok
existing_segment_type == :personal and not updating_to_site_segment? and
site_role in roles_with_personal_segments() ->
:ok
true ->
{:error, :not_enough_permissions}
end
end
defp can_insert_one?(%Plausible.Site{} = site, site_role, params) do
cond do
count_segments(site.id) >= @max_segments ->
{:error, :segment_limit_reached}
params["type"] == "site" and site_role in roles_with_maybe_site_segments() and
site_segments_available?(site) ->
:ok
params["type"] == "personal" and
site_role in roles_with_personal_segments() ->
:ok
true ->
{:error, :not_enough_permissions}
end
end
defp count_segments(site_id) do
from(segment in Segment,
where: segment.site_id == ^site_id
)
|> Repo.aggregate(:count, :id)
end
def to_response_map(%Segment{} = segment, %Plausible.Site{} = site) do
%{
id: segment.id,
name: segment.name,
type: segment.type,
segment_data: segment.segment_data,
owner_id: segment.owner_id,
owner_name: owner_name(segment),
inserted_at: shift_to_site_tz(segment.inserted_at, site.timezone),
updated_at: shift_to_site_tz(segment.updated_at, site.timezone)
}
end
defp owner_name(%Segment{owner_id: nil}), do: nil
defp owner_name(%Segment{owner: %Plausible.Auth.User{name: name}}), do: name
defp owner_name(%Segment{}), do: nil
defp shift_to_site_tz(%NaiveDateTime{} = naive_utc, timezone) do
naive_utc
|> DateTime.from_naive!("Etc/UTC")
|> Plausible.Times.to_naive_datetime!(timezone)
end
def roles_with_personal_segments(), do: @roles_with_personal_segments
def roles_with_maybe_site_segments(), do: @roles_with_maybe_site_segments
def site_segments_available?(%Plausible.Site{} = site),
do: Plausible.Billing.Feature.SiteSegments.check_availability(site.team) == :ok
end
|