Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-11-30 16:22:00 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 1928702 - Part 3: Move more functions to NotificationUtils r=asuth

Browse Source 
Moving functions that can be called from both Notification and IPC actors, that are needed for ActorDestroy.

Differential Revision: https://phabricator.services.mozilla.com/D227688
This commit is contained in:
Kagami Sascha Rosylight 2024-11-07 17:32:04 +00:00
parent 8886918b0f
commit c2fa7e3ebb
4 changed files with 108 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
dom/notification/Notification.cpp
View File

@ -35,7 +35,6 @@
#include "mozilla/ipc/PBackgroundChild.h"
#include "Navigator.h"
#include "NotificationUtils.h"
#include "nsComponentManagerUtils.h"
#include "nsContentPermissionHelper.h"
#include "nsContentUtils.h"
#include "nsFocusManager.h"
@ -56,6 +55,8 @@
#include "nsThreadUtils.h"
#include "nsXULAppAPI.h"
using namespace mozilla::dom::notification;
namespace mozilla::dom {
using namespace notification;
@ -166,11 +167,6 @@ NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(NotificationStorageCallback)
NS_INTERFACE_MAP_ENTRY(nsISupports)
NS_INTERFACE_MAP_END
nsCOMPtr<nsINotificationStorage> GetNotificationStorage(bool isPrivate) {
return do_GetService(isPrivate ? NS_MEMORY_NOTIFICATION_STORAGE_CONTRACTID
: NS_NOTIFICATION_STORAGE_CONTRACTID);
}
class NotificationGetRunnable final : public Runnable {
bool mIsPrivate;
const nsString mOrigin;
@ -727,24 +723,7 @@ void Notification::SetAlertName() {
return;
}
nsAutoString alertName;
nsresult rv = GetOrigin(GetPrincipal(), alertName);
if (NS_WARN_IF(NS_FAILED(rv))) {
return;
}
// Get the notification name that is unique per origin + tag/ID.
// The name of the alert is of the form origin#tag/ID.
alertName.Append('#');
if (!mTag.IsEmpty()) {
alertName.AppendLiteral("tag:");
alertName.Append(mTag);
} else {
alertName.AppendLiteral("notag:");
alertName.Append(mID);
}
mAlertName = alertName;
ComputeAlertName(GetPrincipal(), mTag, mID, mAlertName);
}
// May be called on any thread.
@ -807,7 +786,7 @@ Notification::ConstructFromFields(
return notification.forget();
}
nsresult Notification::PersistNotification() {
nsresult Notification::Persist() {
AssertIsOnMainThread();
nsCOMPtr<nsINotificationStorage> notificationStorage =
@ -845,19 +824,10 @@ nsresult Notification::PersistNotification() {
return NS_OK;
}
void Notification::UnpersistNotification() {
void Notification::Unpersist() {
AssertIsOnMainThread();
if (IsStored()) {
nsCOMPtr<nsINotificationStorage> notificationStorage =
GetNotificationStorage(IsInPrivateBrowsing());
if (notificationStorage) {
nsString origin;
nsresult rv = GetOrigin(GetPrincipal(), origin);
if (NS_SUCCEEDED(rv)) {
notificationStorage->Delete(origin, mID);
}
}
SetStoredState(false);
UnpersistNotification(GetPrincipal(), mID);
}
}
@ -1149,7 +1119,7 @@ MainThreadNotificationObserver::Observe(nsISupports* aSubject,
nsFocusManager::FocusWindow(outerWindow, CallerType::System);
}
} else if (!strcmp("alertfinished", aTopic)) {
notification->UnpersistNotification();
notification->Unpersist();
notification->mIsClosed = true;
notification->DispatchTrustedEvent(u"close"_ns);
} else if (!strcmp("alertshow", aTopic)) {
@ -1192,7 +1162,7 @@ WorkerNotificationObserver::Observe(nsISupports* aSubject, const char* aTopic,
r = new NotificationClickWorkerRunnable(notification, windowHandle);
} else if (!strcmp("alertfinished", aTopic)) {
notification->UnpersistNotification();
notification->Unpersist();
notification->mIsClosed = true;
r = new NotificationEventWorkerRunnable(notification, u"close"_ns);
} else if (!strcmp("alertshow", aTopic)) {
@ -1244,7 +1214,7 @@ ServiceWorkerNotificationObserver::Observe(nsISupports* aSubject,
if (!strcmp("alertfinished", aTopic)) {
nsString origin;
nsresult rv = Notification::GetOrigin(mPrincipal, origin);
nsresult rv = GetOrigin(mPrincipal, origin);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
@ -1376,7 +1346,7 @@ void Notification::ShowInternal() {
// call the alerts service function.
// XXX(krosylight): Non-persistent notifications probably don't need this
nsresult rv = PersistNotification();
nsresult rv = Persist();
if (NS_FAILED(rv)) {
NS_WARNING("Could not persist Notification");
}
@ -1443,7 +1413,7 @@ void Notification::ShowInternal() {
w.Start();
nsAutoString origin;
Notification::GetOrigin(principal, origin);
GetOrigin(principal, origin);
w.StringProperty("origin", NS_ConvertUTF16toUTF8(origin));
w.StringProperty("id", NS_ConvertUTF16toUTF8(mID));
@ -1768,7 +1738,7 @@ class WorkerGetRunnable final : public Runnable {
return NS_ERROR_UNEXPECTED;
}
nsString origin;
nsresult rv = Notification::GetOrigin(principal, origin);
nsresult rv = GetOrigin(principal, origin);
if (NS_WARN_IF(NS_FAILED(rv))) {
callback->Done();
return rv;
@ -1844,28 +1814,15 @@ void Notification::CloseInternal(bool aContextClosed) {
UniquePtr<NotificationRef> ownership;
std::swap(ownership, mTempRef);
SetAlertName();
UnpersistNotification();
if (!mIsClosed) {
nsCOMPtr<nsIAlertsService> alertService = components::Alerts::Service();
if (alertService) {
nsAutoString alertName;
GetAlertName(alertName);
alertService->CloseAlert(alertName, aContextClosed);
}
}
}
nsresult Notification::GetOrigin(nsIPrincipal* aPrincipal, nsString& aOrigin) {
if (!aPrincipal) {
return NS_ERROR_FAILURE;
if (mIsClosed) {
return;
}
nsresult rv =
nsContentUtils::GetWebExposedOriginSerialization(aPrincipal, aOrigin);
NS_ENSURE_SUCCESS(rv, rv);
return NS_OK;
nsAutoString alertName;
GetAlertName(alertName);
UnregisterNotification(
GetPrincipal(), mID, alertName,
aContextClosed ? CloseMode::InactiveGlobal : CloseMode::CloseMethod);
}
bool Notification::RequireInteraction() const { return mRequireInteraction; }

6
dom/notification/Notification.h
View File

@ -257,8 +257,6 @@ class Notification : public DOMEventTargetHelper, public GlobalFreezeObserver {
nsPIDOMWindowInner* aWindow,
notification::PermissionCheckPurpose aPurpose, ErrorResult& rv);
static nsresult GetOrigin(nsIPrincipal* aPrincipal, nsString& aOrigin);
void GetAlertName(nsAString& aRetval) {
AssertIsOnMainThread();
if (mAlertName.IsEmpty()) {
@ -325,8 +323,8 @@ class Notification : public DOMEventTargetHelper, public GlobalFreezeObserver {
nsIPrincipal* GetPrincipal();
nsresult PersistNotification();
void UnpersistNotification();
nsresult Persist();
void Unpersist();
void SetAlertName();

66
dom/notification/NotificationUtils.cpp
View File

@ -11,7 +11,11 @@
#include "mozilla/StaticPrefs_dom.h"
#include "mozilla/dom/NotificationBinding.h"
#include "mozilla/glean/GleanMetrics.h"
#include "nsContentUtils.h"
#include "nsIAlertsService.h"
#include "nsINotificationStorage.h"
#include "nsIPermissionManager.h"
#include "nsServiceManagerUtils.h"
namespace mozilla::dom::notification {
@ -142,4 +146,66 @@ NotificationPermission GetNotificationPermission(
return GetRawNotificationPermission(aPrincipal);
}
nsresult GetOrigin(nsIPrincipal* aPrincipal, nsString& aOrigin) {
if (!aPrincipal) {
return NS_ERROR_FAILURE;
}
MOZ_TRY(
nsContentUtils::GetWebExposedOriginSerialization(aPrincipal, aOrigin));
return NS_OK;
}
void ComputeAlertName(nsIPrincipal* aPrincipal, const nsString& aTag,
const nsString& aId, nsString& aResult) {
nsAutoString alertName;
nsresult rv = GetOrigin(aPrincipal, alertName);
if (NS_WARN_IF(NS_FAILED(rv))) {
return;
}
// Get the notification name that is unique per origin + tag/ID.
// The name of the alert is of the form origin#tag/ID.
alertName.Append('#');
if (!aTag.IsEmpty()) {
alertName.AppendLiteral("tag:");
alertName.Append(aTag);
} else {
alertName.AppendLiteral("notag:");
alertName.Append(aId);
}
aResult = alertName;
}
nsCOMPtr<nsINotificationStorage> GetNotificationStorage(bool isPrivate) {
return do_GetService(isPrivate ? NS_MEMORY_NOTIFICATION_STORAGE_CONTRACTID
: NS_NOTIFICATION_STORAGE_CONTRACTID);
}
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,
const nsString& aAlertName, CloseMode aCloseMode) {
// XXX: unpersist only when explicitly closed, bug 1095073
UnpersistNotification(aPrincipal, aId);
if (nsCOMPtr<nsIAlertsService> alertService = components::Alerts::Service()) {
alertService->CloseAlert(
aAlertName,
/* aContextClosed */ aCloseMode == CloseMode::InactiveGlobal);
}
}
} // namespace mozilla::dom::notification

22
dom/notification/NotificationUtils.h
View File

@ -8,9 +8,12 @@
#define DOM_NOTIFICATION_NOTIFICATIONUTILS_H_
#include <cstdint>
#include "nsCOMPtr.h"
#include "nsStringFwd.h"
enum class nsresult : uint32_t;
class nsIPrincipal;
class nsINotificationStorage;
namespace mozilla::dom {
enum class NotificationPermission : uint8_t;
class Document;
@ -56,6 +59,23 @@ NotificationPermission GetNotificationPermission(
nsIPrincipal* aPrincipal, nsIPrincipal* aEffectiveStoragePrincipal,
bool isSecureContext, PermissionCheckPurpose aPurpose);
nsCOMPtr<nsINotificationStorage> GetNotificationStorage(bool isPrivate);
nsresult GetOrigin(nsIPrincipal* aPrincipal, nsString& aOrigin);
void ComputeAlertName(nsIPrincipal* aPrincipal, const nsString& aTag,
const nsString& aId, nsString& aResult);
nsresult UnpersistNotification(nsIPrincipal* aPrincipal, const nsString& aId);
enum class CloseMode {
CloseMethod,
// Either on global teardown or freeze
InactiveGlobal,
};
void UnregisterNotification(nsIPrincipal* aPrincipal, const nsString& aId,
const nsString& aAlertName, CloseMode aCloseMode);
} // namespace mozilla::dom::notification
#endif // DOM_NOTIFICATION_NOTIFICATIONUTILS_H_