1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef EXTENSIONS_BROWSER_API_IDLE_IDLE_MANAGER_H_
#define EXTENSIONS_BROWSER_API_IDLE_IDLE_MANAGER_H_
#include <map>
#include <memory>
#include <string>
#include "base/gtest_prod_util.h"
#include "base/memory/raw_ptr.h"
#include "base/scoped_observation.h"
#include "base/threading/thread_checker.h"
#include "base/timer/timer.h"
#include "components/keyed_service/core/keyed_service.h"
#include "extensions/browser/event_router.h"
#include "extensions/browser/extension_registry.h"
#include "extensions/browser/extension_registry_observer.h"
#include "extensions/common/extension_id.h"
#include "ui/base/idle/idle.h"
namespace base {
class Value;
} // namespace base
namespace content {
class BrowserContext;
} // namespace content
namespace extensions {
struct IdleMonitor {
explicit IdleMonitor(ui::IdleState initial_state);
ui::IdleState last_state;
int listeners;
int threshold;
};
class IdleManager : public ExtensionRegistryObserver,
public EventRouter::Observer,
public KeyedService {
public:
class IdleTimeProvider {
public:
IdleTimeProvider() {}
IdleTimeProvider(const IdleTimeProvider&) = delete;
IdleTimeProvider& operator=(const IdleTimeProvider&) = delete;
virtual ~IdleTimeProvider() {}
virtual ui::IdleState CalculateIdleState(int idle_threshold) = 0;
virtual int CalculateIdleTime() = 0;
virtual bool CheckIdleStateIsLocked() = 0;
};
class EventDelegate {
public:
EventDelegate() {}
EventDelegate(const EventDelegate&) = delete;
EventDelegate& operator=(const EventDelegate&) = delete;
virtual ~EventDelegate() {}
virtual void OnStateChanged(const ExtensionId& extension_id,
ui::IdleState new_state) = 0;
virtual void RegisterObserver(EventRouter::Observer* observer) = 0;
virtual void UnregisterObserver(EventRouter::Observer* observer) = 0;
};
explicit IdleManager(content::BrowserContext* context);
IdleManager(const IdleManager&) = delete;
IdleManager& operator=(const IdleManager&) = delete;
~IdleManager() override;
void Init();
// KeyedService implementation.
void Shutdown() override;
// ExtensionRegistryObserver implementation.
void OnExtensionUnloaded(content::BrowserContext* browser_context,
const Extension* extension,
UnloadedExtensionReason reason) override;
// EventRouter::Observer implementation.
void OnListenerAdded(const EventListenerInfo& details) override;
void OnListenerRemoved(const EventListenerInfo& details) override;
ui::IdleState QueryState(int threshold);
void SetThreshold(const ExtensionId& extension_id, int threshold);
int GetThresholdForTest(const ExtensionId& extension_id) const;
// Returns the maximum time in seconds until the screen lock automatically
// when idle.
// Note: Currently supported on Chrome OS only. Returns a zero duration for
// other operating systems.
base::TimeDelta GetAutoLockDelay() const;
static base::Value CreateIdleValue(ui::IdleState idle_state);
// Override default event class. Callee assumes ownership. Used for testing.
void SetEventDelegateForTest(std::unique_ptr<EventDelegate> event_delegate);
// Override default idle time calculations. Callee assumes ownership. Used
// for testing.
void SetIdleTimeProviderForTest(
std::unique_ptr<IdleTimeProvider> idle_provider);
private:
FRIEND_TEST_ALL_PREFIXES(IdleTest, ActiveToIdle);
FRIEND_TEST_ALL_PREFIXES(IdleTest, ActiveToLocked);
FRIEND_TEST_ALL_PREFIXES(IdleTest, IdleToActive);
FRIEND_TEST_ALL_PREFIXES(IdleTest, IdleToLocked);
FRIEND_TEST_ALL_PREFIXES(IdleTest, LockedToActive);
FRIEND_TEST_ALL_PREFIXES(IdleTest, LockedToIdle);
FRIEND_TEST_ALL_PREFIXES(IdleTest, MultipleExtensions);
FRIEND_TEST_ALL_PREFIXES(IdleTest, ReAddListener);
FRIEND_TEST_ALL_PREFIXES(IdleTest, SetDetectionInterval);
FRIEND_TEST_ALL_PREFIXES(IdleTest, SetDetectionIntervalBeforeListener);
FRIEND_TEST_ALL_PREFIXES(IdleTest, SetDetectionIntervalMaximum);
FRIEND_TEST_ALL_PREFIXES(IdleTest, SetDetectionIntervalMinimum);
FRIEND_TEST_ALL_PREFIXES(IdleTest, UnloadCleanup);
typedef std::map<const std::string, IdleMonitor> MonitorMap;
IdleMonitor* GetMonitor(const ExtensionId& extension_id);
void StartPolling();
void StopPolling();
void UpdateIdleState();
const raw_ptr<content::BrowserContext> context_;
ui::IdleState last_state_;
MonitorMap monitors_;
base::RepeatingTimer poll_timer_;
std::unique_ptr<IdleTimeProvider> idle_time_provider_;
std::unique_ptr<EventDelegate> event_delegate_;
base::ThreadChecker thread_checker_;
// Listen to extension unloaded notification.
base::ScopedObservation<ExtensionRegistry, ExtensionRegistryObserver>
extension_registry_observation_{this};
};
} // namespace extensions
#endif // EXTENSIONS_BROWSER_API_IDLE_IDLE_MANAGER_H_
|