fune/toolkit/system/gnome/nsSystemAlertsService.cpp
Nicholas Rishel 47a9fb5513 Bug 1787004 - Fix notifications not closing when notification.close() is called. r=nalexander,geckoview-reviewers,smaug,jonalmeida
This adds context to `CloseAlert()` such that explicitly closing the notification e.g. `notification.close()` can be differentiated from a tab or window implicitly closing the notification. This is necessary as we want notifications to persist after a tab or window is closed for Windows.

This change in behavior is necessary to match user expectations. Users expect notifications to persist in the system tray and do not expect notifications to be lost due to a tab being closed. The content of the message is more important than the interaction in that lens. This change is also necessary for parity with Chrome.

Differential Revision: https://phabricator.services.mozilla.com/D161024
2023-01-06 18:36:23 +00:00

131 lines
4.6 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode:nil; c-basic-offset: 2 -*- */
/* 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 "nsComponentManagerUtils.h"
#include "nsSystemAlertsService.h"
#include "nsAlertsIconListener.h"
NS_IMPL_ADDREF(nsSystemAlertsService)
NS_IMPL_RELEASE(nsSystemAlertsService)
NS_INTERFACE_MAP_BEGIN(nsSystemAlertsService)
NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, nsIAlertsService)
NS_INTERFACE_MAP_ENTRY(nsIAlertsService)
NS_INTERFACE_MAP_ENTRY(nsIAlertsDoNotDisturb)
NS_INTERFACE_MAP_END
nsSystemAlertsService::nsSystemAlertsService() = default;
nsSystemAlertsService::~nsSystemAlertsService() = default;
nsresult nsSystemAlertsService::Init() { return NS_OK; }
NS_IMETHODIMP nsSystemAlertsService::ShowAlertNotification(
const nsAString& aImageUrl, const nsAString& aAlertTitle,
const nsAString& aAlertText, bool aAlertTextClickable,
const nsAString& aAlertCookie, nsIObserver* aAlertListener,
const nsAString& aAlertName, const nsAString& aBidi, const nsAString& aLang,
const nsAString& aData, nsIPrincipal* aPrincipal, bool aInPrivateBrowsing,
bool aRequireInteraction) {
nsCOMPtr<nsIAlertNotification> alert =
do_CreateInstance(ALERT_NOTIFICATION_CONTRACTID);
NS_ENSURE_TRUE(alert, NS_ERROR_FAILURE);
// vibrate is unused for now
nsTArray<uint32_t> vibrate;
nsresult rv = alert->Init(aAlertName, aImageUrl, aAlertTitle, aAlertText,
aAlertTextClickable, aAlertCookie, aBidi, aLang,
aData, aPrincipal, aInPrivateBrowsing,
aRequireInteraction, false, vibrate);
NS_ENSURE_SUCCESS(rv, rv);
return ShowAlert(alert, aAlertListener);
}
NS_IMETHODIMP nsSystemAlertsService::ShowPersistentNotification(
const nsAString& aPersistentData, nsIAlertNotification* aAlert,
nsIObserver* aAlertListener) {
return ShowAlert(aAlert, aAlertListener);
}
NS_IMETHODIMP nsSystemAlertsService::ShowAlert(nsIAlertNotification* aAlert,
nsIObserver* aAlertListener) {
NS_ENSURE_ARG(aAlert);
nsAutoString alertName;
nsresult rv = aAlert->GetName(alertName);
NS_ENSURE_SUCCESS(rv, rv);
RefPtr<nsAlertsIconListener> alertListener =
new nsAlertsIconListener(this, alertName);
if (!alertListener) return NS_ERROR_OUT_OF_MEMORY;
if (mSuppressForScreenSharing) {
alertListener->SendClosed();
return NS_OK;
}
AddListener(alertName, alertListener);
return alertListener->InitAlertAsync(aAlert, aAlertListener);
}
NS_IMETHODIMP nsSystemAlertsService::CloseAlert(const nsAString& aAlertName,
bool aContextClosed) {
RefPtr<nsAlertsIconListener> listener = mActiveListeners.Get(aAlertName);
if (!listener) {
return NS_OK;
}
mActiveListeners.Remove(aAlertName);
return listener->Close();
}
NS_IMETHODIMP nsSystemAlertsService::GetManualDoNotDisturb(bool* aRetVal) {
return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP nsSystemAlertsService::SetManualDoNotDisturb(bool aDoNotDisturb) {
return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP nsSystemAlertsService::GetSuppressForScreenSharing(
bool* aRetVal) {
NS_ENSURE_ARG(aRetVal);
*aRetVal = mSuppressForScreenSharing;
return NS_OK;
}
NS_IMETHODIMP nsSystemAlertsService::SetSuppressForScreenSharing(
bool aSuppress) {
mSuppressForScreenSharing = aSuppress;
return NS_OK;
}
bool nsSystemAlertsService::IsActiveListener(const nsAString& aAlertName,
nsAlertsIconListener* aListener) {
return mActiveListeners.Get(aAlertName) == aListener;
}
void nsSystemAlertsService::AddListener(const nsAString& aAlertName,
nsAlertsIconListener* aListener) {
const auto oldListener =
mActiveListeners.WithEntryHandle(aAlertName, [&](auto&& entry) {
RefPtr<nsAlertsIconListener> oldListener =
entry ? entry.Data() : nullptr;
entry.InsertOrUpdate(aListener);
return oldListener;
});
if (oldListener) {
// If an alert with this name already exists, close it.
oldListener->Close();
}
}
void nsSystemAlertsService::RemoveListener(const nsAString& aAlertName,
nsAlertsIconListener* aListener) {
auto entry = mActiveListeners.Lookup(aAlertName);
if (entry && entry.Data() == aListener) {
// The alert may have been replaced; only remove it from the active
// listeners map if it's the same.
entry.Remove();
}
}