ad71dde21c
We collect the rule lookup telemetry when getting cookie banner click rule because the cookie banner clicking will be called for both top-level pages and iframes. This patch adds a parameter to nsICookieBannerService.getClickRulesForDomain to indicate if the caller is in top-level context so that we can know and report the data to corresponding telemetry labels. It also instructs GetRuleForDomain() to report telemetry if it is called from GetClickRulesForDomain(). Differential Revision: https://phabricator.services.mozilla.com/D162630
111 lines
3.8 KiB
Plaintext
111 lines
3.8 KiB
Plaintext
/* 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/. */
|
|
|
|
#include "nsISupports.idl"
|
|
#include "nsIClickRule.idl"
|
|
#include "nsICookieBannerRule.idl"
|
|
#include "nsICookieRule.idl"
|
|
#include "nsIURI.idl"
|
|
|
|
/**
|
|
* Service singleton which owns the cookie banner feature.
|
|
* This service owns the cookie banner handling rules.
|
|
* It initializes both the component for importing rules
|
|
* (nsICookieBannerListService) and injecting cookies (nsICookieInjector).
|
|
*/
|
|
[scriptable, uuid(eac9cdc4-ecee-49f2-91da-7627e15c1f3c)]
|
|
interface nsICookieBannerService : nsISupports {
|
|
|
|
/**
|
|
* Modes for cookie banner handling
|
|
* MODE_DISABLED - No cookie banner handling, service disabled.
|
|
* MODE_REJECT - Only handle banners where selecting "reject all" is possible.
|
|
* MODE_REJECT_OR_ACCEPT - Prefer selecting "reject all", if not possible
|
|
* fall back to "accept all".
|
|
* MODE_DETECT_ONLY - Detect cookie banners but do not handle them. In this
|
|
* mode telemetry will still be reported and cookie banner events will be
|
|
* dispatched if a cookie banner is showing. Use MODE_DISABLED to completely
|
|
* disable the component.
|
|
* MODE_UNSET - This represents the service mode is unset, the setting should
|
|
* fall back to default setting. This is used for the per-domain preferences.
|
|
*/
|
|
cenum Modes : 8 {
|
|
MODE_DISABLED,
|
|
MODE_REJECT,
|
|
MODE_REJECT_OR_ACCEPT,
|
|
MODE_DETECT_ONLY,
|
|
MODE_UNSET,
|
|
};
|
|
|
|
/**
|
|
* Getter for a list of all cookie banner rules. This includes both opt-in and opt-out rules.
|
|
*/
|
|
readonly attribute Array<nsICookieBannerRule> rules;
|
|
|
|
/**
|
|
* Clears all imported rules. They will be imported again on startup and when
|
|
* enabling the service. This is currently only used for testing.
|
|
*
|
|
* doImport - Whether to import initial rule list after reset. Passing false
|
|
* will result in an empty rule list.
|
|
*/
|
|
void resetRules([optional] in boolean doImport);
|
|
|
|
/**
|
|
* Look up all cookie rules for a given URI. Depending on the MODE_ this will
|
|
* return none, only reject rules or accept rules if there is no reject rule
|
|
* available.
|
|
*/
|
|
Array<nsICookieRule> getCookiesForURI(in nsIURI aURI, in bool aIsPrivateBrowsing);
|
|
|
|
/**
|
|
* Look up the click rules for a given domain.
|
|
*/
|
|
Array<nsIClickRule> getClickRulesForDomain(in ACString aDomain,
|
|
in bool aIsTopLevel);
|
|
|
|
/**
|
|
* Insert a cookie banner rule for a domain. If there was previously a rule
|
|
* stored with the same domain it will be overwritten.
|
|
*/
|
|
void insertRule(in nsICookieBannerRule aRule);
|
|
|
|
/**
|
|
* Remove a cookie banner rule.
|
|
*/
|
|
void removeRule(in nsICookieBannerRule aRule);
|
|
|
|
/**
|
|
* Get the domain preference of the given top-level URI. It will return the
|
|
* service mode if there is a site preference for the given URI. Otherwise, it
|
|
* will return MODE_UNSET.
|
|
*/
|
|
nsICookieBannerService_Modes getDomainPref(in nsIURI aTopLevelURI,
|
|
in boolean aIsPrivate);
|
|
|
|
/**
|
|
* Set the domain preference of the given top-level URI.
|
|
*/
|
|
void setDomainPref(in nsIURI aTopLevelURI,
|
|
in nsICookieBannerService_Modes aMode,
|
|
in boolean aIsPrivate);
|
|
|
|
/**
|
|
* Remove the domain preference of the given top-level URI.
|
|
*/
|
|
void removeDomainPref(in nsIURI aTopLevelURI, in boolean aIsPrivate);
|
|
|
|
/**
|
|
* Remove all domain preferences.
|
|
*/
|
|
void removeAllDomainPrefs(in boolean aIsPrivate);
|
|
|
|
/**
|
|
* Clears the in-memory set that we use to maintain the domains that we have
|
|
* reported telemetry. This function will clear the entry for the given
|
|
* domain. If the domain was not given, it will clear all set.
|
|
*/
|
|
void resetDomainTelemetryRecord([optional] in ACString aDomain);
|
|
};
|