Source code
Revision control
Copy as Markdown
Other Tools
/* -*- 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,
#include "NotificationUtils.h"
#include "mozilla/BasePrincipal.h"
#include "mozilla/Components.h"
#include "mozilla/StaticPrefs_dom.h"
#include "mozilla/dom/DOMTypes.h"
#include "mozilla/dom/NotificationBinding.h"
#include "mozilla/glean/DomNotificationMetrics.h"
#include "nsContentUtils.h"
#include "nsIAlertsService.h"
#include "nsINotificationStorage.h"
#include "nsIPermissionManager.h"
#include "nsIPushService.h"
#include "nsServiceManagerUtils.h"
namespace mozilla::dom::notification {
using GleanLabel = glean::web_notification::ShowOriginLabel;
static void ReportTelemetry(GleanLabel aLabel,
PermissionCheckPurpose aPurpose) {
switch (aPurpose) {
case PermissionCheckPurpose::PermissionAttribute:
glean::web_notification::permission_origin
.EnumGet(static_cast<glean::web_notification::PermissionOriginLabel>(
aLabel))
.Add();
return;
case PermissionCheckPurpose::PermissionRequest:
glean::web_notification::request_permission_origin
.EnumGet(static_cast<
glean::web_notification::RequestPermissionOriginLabel>(
aLabel))
.Add();
return;
case PermissionCheckPurpose::NotificationShow:
glean::web_notification::show_origin.EnumGet(aLabel).Add();
return;
default:
MOZ_CRASH("Unknown permission checker");
return;
}
}
bool IsNotificationAllowedFor(nsIPrincipal* aPrincipal) {
if (aPrincipal->IsSystemPrincipal()) {
return true;
}
// Allow files to show notifications by default.
return aPrincipal->SchemeIs("file");
}
bool IsNotificationForbiddenFor(nsIPrincipal* aPrincipal,
nsIPrincipal* aEffectiveStoragePrincipal,
bool isSecureContext,
PermissionCheckPurpose aPurpose,
Document* aRequestorDoc) {
if (aPrincipal->GetIsInPrivateBrowsing() &&
!StaticPrefs::dom_webnotifications_privateBrowsing_enabled()) {
return true;
}
if (!isSecureContext) {
if (aRequestorDoc) {
glean::web_notification::insecure_context_permission_request.Add();
nsContentUtils::ReportToConsole(
nsIScriptError::errorFlag, "DOM"_ns, aRequestorDoc,
nsContentUtils::eDOM_PROPERTIES,
"NotificationsInsecureRequestIsForbidden");
}
return true;
}
const nsString& partitionKey =
aEffectiveStoragePrincipal->OriginAttributesRef().mPartitionKey;
if (aEffectiveStoragePrincipal->OriginAttributesRef()
.mPartitionKey.IsEmpty()) {
// first party
ReportTelemetry(GleanLabel::eFirstParty, aPurpose);
return false;
}
nsString outScheme;
nsString outBaseDomain;
int32_t outPort;
bool outForeignByAncestorContext;
OriginAttributes::ParsePartitionKey(partitionKey, outScheme, outBaseDomain,
outPort, outForeignByAncestorContext);
if (outForeignByAncestorContext) {
// nested first party
ReportTelemetry(GleanLabel::eNestedFirstParty, aPurpose);
return false;
}
// third party
ReportTelemetry(GleanLabel::eThirdParty, aPurpose);
if (aRequestorDoc) {
nsContentUtils::ReportToConsole(
nsIScriptError::errorFlag, "DOM"_ns, aRequestorDoc,
nsContentUtils::eDOM_PROPERTIES,
"NotificationsCrossOriginIframeRequestIsForbidden");
}
return !StaticPrefs::dom_webnotifications_allowcrossoriginiframe();
}
NotificationPermission GetRawNotificationPermission(nsIPrincipal* aPrincipal) {
AssertIsOnMainThread();
uint32_t permission = nsIPermissionManager::UNKNOWN_ACTION;
nsCOMPtr<nsIPermissionManager> permissionManager =
components::PermissionManager::Service();
if (!permissionManager) {
return NotificationPermission::Default;
}
permissionManager->TestExactPermissionFromPrincipal(
aPrincipal, "desktop-notification"_ns, &permission);
// Convert the result to one of the enum types.
switch (permission) {
case nsIPermissionManager::ALLOW_ACTION:
return NotificationPermission::Granted;
case nsIPermissionManager::DENY_ACTION:
return NotificationPermission::Denied;
default:
return NotificationPermission::Default;
}
}
NotificationPermission GetNotificationPermission(
nsIPrincipal* aPrincipal, nsIPrincipal* aEffectiveStoragePrincipal,
bool isSecureContext, PermissionCheckPurpose aPurpose) {
if (IsNotificationAllowedFor(aPrincipal)) {
return NotificationPermission::Granted;
}
if (IsNotificationForbiddenFor(aPrincipal, aEffectiveStoragePrincipal,
isSecureContext, aPurpose)) {
return NotificationPermission::Denied;
}
return GetRawNotificationPermission(aPrincipal);
}
nsresult GetOrigin(nsIPrincipal* aPrincipal, nsString& aOrigin) {
if (!aPrincipal) {
return NS_ERROR_FAILURE;
}
nsAutoCString origin;
MOZ_TRY(aPrincipal->GetOrigin(origin));
CopyUTF8toUTF16(origin, aOrigin);
return NS_OK;
}
nsCOMPtr<nsINotificationStorage> GetNotificationStorage(bool isPrivate) {
return do_GetService(isPrivate ? NS_MEMORY_NOTIFICATION_STORAGE_CONTRACTID
: NS_NOTIFICATION_STORAGE_CONTRACTID);
}
nsresult PersistNotification(nsIPrincipal* aPrincipal,
const IPCNotification& aNotification,
const nsString& aScope) {
nsCOMPtr<nsINotificationStorage> notificationStorage =
GetNotificationStorage(aPrincipal->GetIsInPrivateBrowsing());
if (NS_WARN_IF(!notificationStorage)) {
return NS_ERROR_UNEXPECTED;
}
nsString origin;
nsresult rv = GetOrigin(aPrincipal, origin);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
RefPtr<NotificationStorageEntry> entry =
new NotificationStorageEntry(aNotification);
rv = notificationStorage->Put(origin, entry, aScope);
if (NS_FAILED(rv)) {
return rv;
}
return NS_OK;
}
nsresult UnpersistNotification(nsIPrincipal* aPrincipal, const nsString& aId) {
if (!aPrincipal) {
return NS_ERROR_FAILURE;
}
if (nsCOMPtr<nsINotificationStorage> notificationStorage =
GetNotificationStorage(aPrincipal->GetIsInPrivateBrowsing())) {
nsString origin;
MOZ_TRY(GetOrigin(aPrincipal, origin));
return notificationStorage->Delete(origin, aId);
}
return NS_ERROR_FAILURE;
}
void UnregisterNotification(nsIPrincipal* aPrincipal, const nsString& aId) {
UnpersistNotification(aPrincipal, aId);
if (nsCOMPtr<nsIAlertsService> alertService = components::Alerts::Service()) {
alertService->CloseAlert(aId, /* aContextClosed */ false);
}
}
nsresult RemovePermission(nsIPrincipal* aPrincipal) {
MOZ_ASSERT(XRE_IsParentProcess());
nsCOMPtr<nsIPermissionManager> permissionManager =
mozilla::components::PermissionManager::Service();
if (!permissionManager) {
return NS_ERROR_FAILURE;
}
permissionManager->RemoveFromPrincipal(aPrincipal, "desktop-notification"_ns);
return NS_OK;
}
nsresult OpenSettings(nsIPrincipal* aPrincipal) {
MOZ_ASSERT(XRE_IsParentProcess());
nsCOMPtr<nsIObserverService> obs = mozilla::services::GetObserverService();
if (!obs) {
return NS_ERROR_FAILURE;
}
// Notify other observers so they can show settings UI.
obs->NotifyObservers(aPrincipal, "notifications-open-settings", nullptr);
return NS_OK;
}
nsresult AdjustPushQuota(nsIPrincipal* aPrincipal,
NotificationStatusChange aChange) {
MOZ_ASSERT(XRE_IsParentProcess());
nsCOMPtr<nsIPushQuotaManager> pushQuotaManager =
do_GetService("@mozilla.org/push/Service;1");
if (!pushQuotaManager) {
return NS_ERROR_FAILURE;
}
nsAutoCString origin;
MOZ_TRY(aPrincipal->GetOrigin(origin));
if (aChange == NotificationStatusChange::Shown) {
return pushQuotaManager->NotificationForOriginShown(origin.get());
}
return pushQuotaManager->NotificationForOriginClosed(origin.get());
}
NS_IMPL_ISUPPORTS(NotificationActionStorageEntry,
nsINotificationActionStorageEntry)
NS_IMETHODIMP NotificationActionStorageEntry::GetName(nsAString& aName) {
aName = mIPCAction.name();
return NS_OK;
}
NS_IMETHODIMP NotificationActionStorageEntry::GetTitle(nsAString& aTitle) {
aTitle = mIPCAction.title();
return NS_OK;
}
Result<IPCNotificationAction, nsresult> NotificationActionStorageEntry::ToIPC(
nsINotificationActionStorageEntry& aEntry) {
IPCNotificationAction action;
MOZ_TRY(aEntry.GetName(action.name()));
MOZ_TRY(aEntry.GetTitle(action.title()));
return action;
}
NS_IMPL_ISUPPORTS(NotificationStorageEntry, nsINotificationStorageEntry)
NS_IMETHODIMP NotificationStorageEntry::GetId(nsAString& aId) {
aId = mIPCNotification.id();
return NS_OK;
}
NS_IMETHODIMP NotificationStorageEntry::GetTitle(nsAString& aTitle) {
aTitle = mIPCNotification.options().title();
return NS_OK;
}
NS_IMETHODIMP NotificationStorageEntry::GetDir(nsACString& aDir) {
aDir = GetEnumString(mIPCNotification.options().dir());
return NS_OK;
}
NS_IMETHODIMP NotificationStorageEntry::GetLang(nsAString& aLang) {
aLang = mIPCNotification.options().lang();
return NS_OK;
}
NS_IMETHODIMP NotificationStorageEntry::GetBody(nsAString& aBody) {
aBody = mIPCNotification.options().body();
return NS_OK;
}
NS_IMETHODIMP NotificationStorageEntry::GetTag(nsAString& aTag) {
aTag = mIPCNotification.options().tag();
return NS_OK;
}
NS_IMETHODIMP NotificationStorageEntry::GetIcon(nsAString& aIcon) {
aIcon = mIPCNotification.options().icon();
return NS_OK;
}
NS_IMETHODIMP NotificationStorageEntry::GetRequireInteraction(
bool* aRequireInteraction) {
*aRequireInteraction = mIPCNotification.options().requireInteraction();
return NS_OK;
}
NS_IMETHODIMP NotificationStorageEntry::GetSilent(bool* aSilent) {
*aSilent = mIPCNotification.options().silent();
return NS_OK;
}
NS_IMETHODIMP NotificationStorageEntry::GetDataSerialized(
nsAString& aDataSerialized) {
aDataSerialized = mIPCNotification.options().dataSerialized();
return NS_OK;
}
NS_IMETHODIMP NotificationStorageEntry::GetActions(
nsTArray<RefPtr<nsINotificationActionStorageEntry>>& aRetVal) {
nsTArray<RefPtr<nsINotificationActionStorageEntry>> actions(
mIPCNotification.options().actions().Length());
for (const auto& action : mIPCNotification.options().actions()) {
actions.AppendElement(new NotificationActionStorageEntry(action));
}
aRetVal = std::move(actions);
return NS_OK;
}
Result<IPCNotification, nsresult> NotificationStorageEntry::ToIPC(
nsINotificationStorageEntry& aEntry) {
IPCNotification notification;
IPCNotificationOptions& options = notification.options();
MOZ_TRY(aEntry.GetId(notification.id()));
MOZ_TRY(aEntry.GetTitle(options.title()));
nsCString dir;
MOZ_TRY(aEntry.GetDir(dir));
options.dir() = StringToEnum<NotificationDirection>(dir).valueOr(
NotificationDirection::Auto);
MOZ_TRY(aEntry.GetLang(options.lang()));
MOZ_TRY(aEntry.GetBody(options.body()));
MOZ_TRY(aEntry.GetTag(options.tag()));
MOZ_TRY(aEntry.GetIcon(options.icon()));
MOZ_TRY(aEntry.GetRequireInteraction(&options.requireInteraction()));
MOZ_TRY(aEntry.GetSilent(&options.silent()));
MOZ_TRY(aEntry.GetDataSerialized(options.dataSerialized()));
nsTArray<RefPtr<nsINotificationActionStorageEntry>> actionEntries;
MOZ_TRY(aEntry.GetActions(actionEntries));
nsTArray<IPCNotificationAction> actions(actionEntries.Length());
for (const auto& actionEntry : actionEntries) {
IPCNotificationAction action;
MOZ_TRY_VAR(action, NotificationActionStorageEntry::ToIPC(*actionEntry));
actions.AppendElement(std::move(action));
}
options.actions() = std::move(actions);
return notification;
}
} // namespace mozilla::dom::notification