File: URLQueryStringStripper.h

package info (click to toggle)
thunderbird 1%3A91.13.0-1~deb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 2,953,400 kB
  • sloc: cpp: 6,084,049; javascript: 4,790,441; ansic: 3,341,496; python: 862,958; asm: 366,542; xml: 204,277; java: 152,477; sh: 111,436; makefile: 21,388; perl: 15,312; yacc: 4,583; objc: 3,026; lex: 1,720; exp: 762; pascal: 635; awk: 564; sql: 453; php: 436; lisp: 432; ruby: 99; sed: 69; csh: 45
file content (63 lines) | stat: -rw-r--r-- 2,140 bytes parent folder | download | duplicates (4)
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
/* -*- 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 "nsIURLQueryStrippingListService.h"

#include "nsStringFwd.h"
#include "nsTHashSet.h"

class nsIURI;

namespace mozilla {

// URLQueryStringStripper 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 URLQueryStringStripper and URLDecorationStripper are doing
//       similar things. We could somehow combine these two modules into one.
//       We will improve this in the future.

class URLQueryStringStripper final : public nsIURLQueryStrippingListObserver {
 public:
  NS_DECL_ISUPPORTS
  NS_DECL_NSIURLQUERYSTRIPPINGLISTOBSERVER

  // Strip the query parameters that are in the strip list. Return true if there
  // is any query parameter has been stripped. Otherwise, false.
  static bool Strip(nsIURI* aURI, nsCOMPtr<nsIURI>& aOutput);

 private:
  URLQueryStringStripper() = default;

  ~URLQueryStringStripper() = default;

  static URLQueryStringStripper* GetOrCreate();

  void Init();
  void Shutdown();

  bool StripQueryString(nsIURI* aURI, nsCOMPtr<nsIURI>& aOutput);

  bool CheckAllowList(nsIURI* aURI);

  void PopulateStripList(const nsAString& aList);
  void PopulateAllowList(const nsACString& aList);

  nsTHashSet<nsString> mList;
  nsTHashSet<nsCString> mAllowList;
  nsCOMPtr<nsIURLQueryStrippingListService> mService;
};

}  // namespace mozilla

#endif  // mozilla_URLQueryStringStripper_h