summaryrefslogtreecommitdiffstats
path: root/toolkit/components/antitracking/nsIURLQueryStringStripper.idl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /toolkit/components/antitracking/nsIURLQueryStringStripper.idl
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esr
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'toolkit/components/antitracking/nsIURLQueryStringStripper.idl')
-rw-r--r--toolkit/components/antitracking/nsIURLQueryStringStripper.idl35
1 files changed, 35 insertions, 0 deletions
diff --git a/toolkit/components/antitracking/nsIURLQueryStringStripper.idl b/toolkit/components/antitracking/nsIURLQueryStringStripper.idl
new file mode 100644
index 0000000000..372cc0f94a
--- /dev/null
+++ b/toolkit/components/antitracking/nsIURLQueryStringStripper.idl
@@ -0,0 +1,35 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include "nsISupports.idl"
+#include "nsIURI.idl"
+
+/**
+ * nsIURLQueryStringStripper is responsible for stripping certain part of the
+ * query string of the given URI to address the bounce(redirect) tracking
+ * issues. It will strip every query parameter which matches the strip list
+ * defined in the pref 'privacy.query_stripping.strip_list'. Note that It's
+ * different from URLDecorationStripper which strips the entire query string
+ * from the referrer if there is a tracking query parameter present in the URI.
+ *
+ * TODO: Given that nsIURLQueryStringStripper and URLDecorationStripper are
+ * doing similar things. We could somehow combine these two modules into
+ * one. We will improve this in the future.
+ */
+[scriptable, uuid(6b42a890-2624-4560-99c4-b25380e8cd77)]
+interface nsIURLQueryStringStripper : nsISupports {
+
+ // Strip the query parameters that are in the strip list. Return the amount of
+ // query parameters that have been stripped. Returns 0 if no query parameters
+ // have been stripped or the feature is disabled.
+ uint32_t strip(in nsIURI aURI, in bool aIsPBM, out nsIURI aOutput);
+
+ // Strip the query parameters that are in the stripForCopy/Share strip list.
+ // Returns ether the stripped URI or null if no query parameters have been stripped
+ // Thorws NS_ERROR_NOT_AVAILABLE if the feature is disabled.
+ [must_use] nsIURI stripForCopyOrShare(in nsIURI aURI);
+
+ // Test-only method to get the current strip list.
+ ACString testGetStripList();
+};