summaryrefslogtreecommitdiffstats
path: root/toolkit/components/cookiebanners/nsCookieBannerTelemetryService.h
blob: 1236343ad910cf75a2f643039e68b49b26728006 (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
/* 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_nsCookieBannerTelemetryService_h__
#define mozilla_nsCookieBannerTelemetryService_h__

#include "nsICookieBannerTelemetryService.h"

#include "nsIObserver.h"

class nsICookie;

namespace mozilla {
class nsCookieBannerTelemetryService final
    : public nsICookieBannerTelemetryService,
      public nsIObserver {
  NS_DECL_ISUPPORTS
  NS_DECL_NSIOBSERVER

  NS_DECL_NSICOOKIEBANNERTELEMETRYSERVICE

 public:
  static already_AddRefed<nsCookieBannerTelemetryService> GetSingleton();

 private:
  nsCookieBannerTelemetryService() = default;
  ~nsCookieBannerTelemetryService() = default;

  bool mIsInitialized = false;
  bool mIsSearchServiceInitialized = false;

  [[nodiscard]] nsresult Init();

  [[nodiscard]] nsresult Shutdown();

  // Record the telemetry regarding the GDPR choice on Google Search domains.
  // We only record if the default search engine is Google. When passing no
  // cookie, we will walk through all cookies under Google Search domains.
  // Otherwise, we will report the GDPR choice according to the given cookie.
  [[nodiscard]] nsresult MaybeReportGoogleGDPRChoiceTelemetry(
      nsICookie* aCookie = nullptr, bool aReportEvent = false);
};

}  // namespace mozilla

#endif