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
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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/. */
#ifndef mozilla_URLQueryStringStripper_h
#define mozilla_URLQueryStringStripper_h
#include "nsIURLQueryStringStripper.h"
#include "nsIURLQueryStrippingListService.h"
#include "nsIObserver.h"
#include "mozilla/dom/StripOnShareRuleBinding.h"
#include "nsStringFwd.h"
#include "nsTHashSet.h"
#include "nsTHashMap.h"
class nsIURI;
namespace mozilla {
class URLQueryStringStripper final : public nsIObserver,
public nsIURLQueryStringStripper,
public nsIURLQueryStrippingListObserver {
NS_DECL_ISUPPORTS
NS_DECL_NSIOBSERVER
NS_DECL_NSIURLQUERYSTRIPPINGLISTOBSERVER
NS_DECL_NSIURLQUERYSTRINGSTRIPPER
public:
static already_AddRefed<URLQueryStringStripper> GetSingleton();
private:
URLQueryStringStripper();
~URLQueryStringStripper() = default;
static void OnPrefChange(const char* aPref, void* aData);
nsresult ManageObservers();
[[nodiscard]] nsresult Init();
[[nodiscard]] nsresult Shutdown();
[[nodiscard]] nsresult StripQueryString(nsIURI* aURI, nsIURI** aOutput,
uint32_t* aStripCount);
bool CheckAllowList(nsIURI* aURI);
void PopulateStripList(const nsACString& aList);
void PopulateAllowList(const nsACString& aList);
// Returns whether there is a rule matching the host that tells us to strip
// this query parameter.
bool ShouldStripParam(const nsACString& aHost, const nsACString& aName);
// Tries parse query parameter value as url and recurse into
// `StripForCopyOrShareInternal` to strip query parameters for it. Returns how
// many params were stripped, but at most 1 in dry mode. Modifies aValue to
// the stripped value in non-dry mode.
int TryStripValue(const nsACString& aHost, nsACString& aValue, bool aDry);
// Recursive helper function that helps strip URIs of tracking parameters
// and enables the stripping of tracking paramerters that are in a URI which
// is nested in a query parameter. Dry mode won't return a strippedURI and
// will stop after the first strippable parameter was found making aStripCount
// either 0 or 1. Used to determine whether stripping is possible.
nsresult StripForCopyOrShareInternal(nsIURI* aURI, nsIURI** aStrippedURI,
int& aStripCount, bool aDry,
bool aStripNestedURIs);
nsTHashSet<nsCString> mList;
nsTHashSet<nsCString> mAllowList;
nsCOMPtr<nsIURLQueryStrippingListService> mListService;
nsTHashMap<nsCString, dom::StripRule> mStripOnShareMap;
bool mIsInitialized;
// Indicates whether or not we currently have registered an observer
// for the QPS/strip-on-share list updates
bool mObservingQPS = false;
bool mObservingStripOnShare = false;
};
} // namespace mozilla
#endif // mozilla_URLQueryStringStripper_h
|
