blob: fe054ef0c1f1b523b39230d4fb3c5648eb24f5cc [file] [log] [blame]
// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_PUSH_MESSAGING_PUSH_MESSAGING_NOTIFICATION_MANAGER_H_
#define CHROME_BROWSER_PUSH_MESSAGING_PUSH_MESSAGING_NOTIFICATION_MANAGER_H_
#include <stdint.h>
#include <vector>
#include "base/callback_forward.h"
#include "base/gtest_prod_util.h"
#include "base/macros.h"
#include "base/memory/weak_ptr.h"
#include "chrome/browser/push_messaging/budget_database.h"
#if defined(OS_CHROMEOS)
#include "chrome/browser/chromeos/android_sms/android_sms_app_manager.h"
#include "chromeos/services/multidevice_setup/public/cpp/multidevice_setup_client.h"
#endif
class GURL;
class Profile;
namespace content {
struct NotificationDatabaseData;
class WebContents;
} // namespace content
// Developers may be required to display a Web Notification in response to an
// incoming push message in order to clarify to the user that something has
// happened in the background. When they forget to do so, a default notification
// has to be displayed on their behalf.
//
// This class implements the heuristics for determining whether the default
// notification is necessary, as well as the functionality of displaying the
// default notification when it is.
//
// See the following document and bug for more context:
// https://docs.google.com/document/d/13VxFdLJbMwxHrvnpDm8RXnU41W2ZlcP0mdWWe9zXQT8/edit
// https://crbug.com/437277
class PushMessagingNotificationManager {
public:
explicit PushMessagingNotificationManager(Profile* profile);
~PushMessagingNotificationManager();
// Enforces the requirements implied for push subscriptions which must display
// a Web Notification in response to an incoming message.
void EnforceUserVisibleOnlyRequirements(
const GURL& origin,
int64_t service_worker_registration_id,
base::OnceClosure message_handled_closure);
private:
FRIEND_TEST_ALL_PREFIXES(PushMessagingNotificationManagerTest, IsTabVisible);
FRIEND_TEST_ALL_PREFIXES(PushMessagingNotificationManagerTest,
IsTabVisibleViewSource);
FRIEND_TEST_ALL_PREFIXES(
PushMessagingNotificationManagerTest,
SkipEnforceUserVisibleOnlyRequirementsForAndroidMessages);
void DidGetNotificationsFromDatabase(
const GURL& origin,
int64_t service_worker_registration_id,
base::OnceClosure message_handled_closure,
bool success,
const std::vector<content::NotificationDatabaseData>& data);
// Checks whether |profile| is the one owning this instance,
// |active_web_contents| exists and its main frame is visible, and the URL
// currently visible to the user is for |origin|.
bool IsTabVisible(Profile* profile,
content::WebContents* active_web_contents,
const GURL& origin);
void ProcessSilentPush(const GURL& origin,
int64_t service_worker_registration_id,
base::OnceClosure message_handled_closure,
bool silent_push_allowed);
void DidWriteNotificationData(base::OnceClosure message_handled_closure,
bool success,
const std::string& notification_id);
#if defined(OS_CHROMEOS)
bool ShouldSkipUserVisibleOnlyRequirements(const GURL& origin);
void SetTestMultiDeviceSetupClient(
chromeos::multidevice_setup::MultiDeviceSetupClient*
multidevice_setup_client);
void SetTestAndroidSmsAppManager(
chromeos::android_sms::AndroidSmsAppManager* android_sms_app_manager);
#endif
// Weak. This manager is owned by a keyed service on this profile.
Profile* profile_;
BudgetDatabase budget_database_;
#if defined(OS_CHROMEOS)
chromeos::multidevice_setup::MultiDeviceSetupClient*
test_multidevice_setup_client_ = nullptr;
chromeos::android_sms::AndroidSmsAppManager* test_android_sms_app_manager_ =
nullptr;
#endif
base::WeakPtrFactory<PushMessagingNotificationManager> weak_factory_;
DISALLOW_COPY_AND_ASSIGN(PushMessagingNotificationManager);
};
#endif // CHROME_BROWSER_PUSH_MESSAGING_PUSH_MESSAGING_NOTIFICATION_MANAGER_H_