summaryrefslogtreecommitdiffstats
path: root/toolkit/components/cookiebanners/nsCookieInjector.h
blob: 377252bffdd0ed27974bd12235152dd883e04e53 (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
/* 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_nsCookieInjector_h__
#define mozilla_nsCookieInjector_h__

#include "nsCOMPtr.h"
#include "nsICookieBannerRule.h"
#include "nsIHttpChannel.h"
#include "nsIObserver.h"

namespace mozilla {

class nsCookieInjector final : public nsIObserver {
 public:
  NS_DECL_ISUPPORTS
  NS_DECL_NSIOBSERVER

  static already_AddRefed<nsCookieInjector> GetSingleton();

  [[nodiscard]] nsresult Init();

  [[nodiscard]] nsresult Shutdown();

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

  // Whether the component is enabled and ready to inject cookies.
  bool mIsInitialized = false;

  // Check the current pref state to determine whether the component should be
  // enabled.
  static bool IsEnabledForCurrentPrefState();

  // Enables or disables the component when the relevant prefs change.
  static void OnPrefChange(const char* aPref, void* aData);

  // Called when the http observer topic is dispatched.
  nsresult MaybeInjectCookies(nsIHttpChannel* aChannel, const char* aTopic);

  // Inserts cookies via the cookie manager given a list of cookie injection
  // rules.
  nsresult InjectCookiesFromRules(const nsCString& aHostPort,
                                  const nsTArray<RefPtr<nsICookieRule>>& aRules,
                                  OriginAttributes& aOriginAttributes,
                                  bool& hasInjectedCookie);
};

}  // namespace mozilla

#endif