Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Escape special regex characters (#3634)
Uku Tahta5e0619053e1
diff --git a/CHANGELOG.md b/CHANGELOG.mdindex e39dcba215..73ab4b6634 100644--- a/CHANGELOG.md+++ b/CHANGELOG.md@@ -44,6 +44,7 @@ All notable changes to this project will be documented in this file.- Log mailer errors plausible/analytics#3336- Allow custom event timeseries in stats API plausible/analytics#3505- Fixes for sites with UTF characters in domain plausible/analytics#3560+- Fix crash when using special characters in filter plausible/analytics#3634## v2.0.0 - 2023-07-12diff --git a/lib/plausible/stats/base.ex b/lib/plausible/stats/base.exindex 28ba40d8bf..e5cfa3ba99 100644--- a/lib/plausible/stats/base.ex+++ b/lib/plausible/stats/base.ex@@ -525,16 +525,15 @@ defmodule Plausible.Stats.Base do{first_datetime, last_datetime}end- @replaces %{- ~r/\*\*/ => ".*",- ~r/(?<!\.)\*/ => "[^/]*",- "(" => "\\(",- ")" => "\\)"- }def page_regex(expr) do- Enum.reduce(@replaces, "^#{expr}$", fn {pattern, replacement}, regex ->- String.replace(regex, pattern, replacement)- end)+ escaped =+ expr+ |> Regex.escape()+ |> String.replace("\\|", "|")+ |> String.replace("\\*\\*", ".*")+ |> String.replace("\\*", ".*")++ "^#{escaped}$"enddefp split_goals(clauses, map_fn \\ &Function.identity/1) dodiff --git a/test/plausible_web/controllers/api/external_stats_controller/aggregate_test.exs b/test/plausible_web/controllers/api/external_stats_controller/aggregate_test.exsindex 38ecfc6441..d6592a0b0a 100644--- a/test/plausible_web/controllers/api/external_stats_controller/aggregate_test.exs+++ b/test/plausible_web/controllers/api/external_stats_controller/aggregate_test.exs@@ -495,6 +495,23 @@ defmodule PlausibleWeb.Api.ExternalStatsController.AggregateTest do}end+ test "wildcard referrer filter with special regex characters", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview, referrer: "https://a.com"),+ build(:pageview, referrer: "https://a.com"),+ build(:pageview, referrer: "https://ab.com")+ ])++ conn =+ get(conn, "/api/v1/stats/aggregate", %{+ "site_id" => site.domain,+ "metrics" => "visitors",+ "filters" => "visit:referrer==**a.com**"+ })++ assert json_response(conn, 200)["results"] == %{"visitors" => %{"value" => 2}}+ end+test "can filter by utm_medium", %{conn: conn, site: site} dopopulate_stats(site, [build(:pageview,diff --git a/test/plausible_web/controllers/api/stats_controller/conversions_test.exs b/test/plausible_web/controllers/api/stats_controller/conversions_test.exsindex 98538e3c06..c76841ceff 100644--- a/test/plausible_web/controllers/api/stats_controller/conversions_test.exs+++ b/test/plausible_web/controllers/api/stats_controller/conversions_test.exs@@ -577,13 +577,10 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest doinsert(:goal, %{site: site, page_path: "/register"})insert(:goal, %{site: site, page_path: "/reg*"})insert(:goal, %{site: site, page_path: "/*/register"})- insert(:goal, %{site: site, page_path: "/billing**/success"})insert(:goal, %{site: site, page_path: "/billing*/success"})insert(:goal, %{site: site, page_path: "/signup"})insert(:goal, %{site: site, page_path: "/signup/*"})- insert(:goal, %{site: site, page_path: "/signup/**"})insert(:goal, %{site: site, page_path: "/*"})- insert(:goal, %{site: site, page_path: "/**"})populate_stats(site, [build(:pageview,@@ -630,25 +627,19 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do%{"conversion_rate" => 100.0,"visitors" => 8,- "name" => "Visit /**",+ "name" => "Visit /*","events" => 8},%{"conversion_rate" => 37.5,"visitors" => 3,- "name" => "Visit /signup/**",- "events" => 3- },- %{- "conversion_rate" => 37.5,- "visitors" => 3,- "name" => "Visit /*",+ "name" => "Visit /signup/*","events" => 3},%{"conversion_rate" => 25.0,"visitors" => 2,- "name" => "Visit /billing**/success",+ "name" => "Visit /billing*/success","events" => 2},%{@@ -657,18 +648,6 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do"name" => "Visit /reg*","events" => 2},- %{- "conversion_rate" => 12.5,- "visitors" => 1,- "name" => "Visit /signup/*",- "events" => 1- },- %{- "conversion_rate" => 12.5,- "visitors" => 1,- "name" => "Visit /billing*/success",- "events" => 1- },%{"conversion_rate" => 12.5,"visitors" => 1,