summaryrefslogtreecommitdiffstats
path: root/toolkit/components/antitracking/URLQueryStringStripper.h
blob: 89466cfd124ceec487c891716c9f9582e06f49da (plain)
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
/* -*- 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 nsAString& aList);
  void PopulateAllowList(const nsACString& aList);

  nsTHashSet<nsString> 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