blob: d1bab560454e3114cd1521782981bbe618669dd4 [file] [log] [blame]
// Copyright 2018 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.
#include <memory>
#include "base/callback.h"
#include "base/containers/linked_list.h"
#include "base/macros.h"
#include "base/memory/weak_ptr.h"
#include "base/sequence_checker.h"
#include "base/timer/timer.h"
#include "mojo/public/cpp/bindings/binding_set.h"
#include "third_party/blink/public/platform/modules/idle/idle_manager.mojom.h"
#include "ui/base/idle/idle.h"
#include "url/origin.h"
namespace content {
class CONTENT_EXPORT IdleManager : public blink::mojom::IdleManager {
// This class adapts functions from ui:: and allows tests to
// inject custom providers.
// Adapted from: extensions/browser/api/idle/idle_manager.h
class IdleTimeProvider {
using IdleCallback = base::OnceCallback<void(blink::mojom::IdleState)>;
using IdleTimeCallback = base::OnceCallback<void(int)>;
IdleTimeProvider() {}
virtual ~IdleTimeProvider() {}
// See ui/base/idle/idle.h for the semantics of these methods.
// TODO(goto): should this be made private? Doesn't seem to be necessary
// as part of a public interface.
virtual ui::IdleState CalculateIdleState(int idle_threshold) = 0;
virtual int CalculateIdleTime() = 0;
virtual bool CheckIdleStateIsLocked() = 0;
~IdleManager() override;
// TODO: Origin for permission check; needed?
void CreateService(blink::mojom::IdleManagerRequest request,
const url::Origin& origin);
// blink.mojom.IdleManager:
void AddMonitor(uint32_t threshold,
blink::mojom::IdleMonitorPtr monitor_ptr,
AddMonitorCallback callback) override;
// Testing helpers.
void SetIdleTimeProviderForTest(
std::unique_ptr<IdleTimeProvider> idle_provider);
// Tests whether the manager is still polling for updates or not.
bool IsPollingForTest();
// A Monitor represents a client that is actively listening for state
// changes, and wraps an IdleMonitorPtr which is used to send updates. The
// class also tracks the last observed state and the threshold. Monitors are
// owned by this class and held in the |monitors_| list.
class Monitor;
// Called internally when a monitor's pipe closes to remove it from
// |monitors_|.
void RemoveMonitor(Monitor* monitor);
// Called internally when a monitor is added via AddMonitor() to maybe
// start the polling timer, if not already started.
void StartPolling();
// Called internally by the timer callback to stop the timer if there
// are no more monitors. (It is not called from RemoveMonitor() so
// that an calls can update the cached state.)
void StopPolling();
// Callback for the polling timer. Kicks off an async query for the state.
void UpdateIdleState();
// Callback for the async state query. Updates monitors as needed.
void UpdateIdleStateCallback(int idle_time);
// Cached to update newly registered clients.
blink::mojom::IdleState last_state_ = blink::mojom::IdleState::ACTIVE;
base::RepeatingTimer poll_timer_;
std::unique_ptr<IdleTimeProvider> idle_time_provider_;
// Registered clients.
mojo::BindingSet<blink::mojom::IdleManager> bindings_;
// Owns Monitor instances, added when clients call AddMonitor().
base::LinkedList<Monitor> monitors_;
base::WeakPtrFactory<IdleManager> weak_factory_;
} // namespace content