user_activity_detector.cc 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. // Copyright 2014 The Chromium Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style license that can be
  3. // found in the LICENSE file.
  4. #include "ui/base/user_activity/user_activity_detector.h"
  5. #include "base/format_macros.h"
  6. #include "base/logging.h"
  7. #include "base/observer_list.h"
  8. #include "base/strings/stringprintf.h"
  9. #include "build/build_config.h"
  10. #include "ui/base/user_activity/user_activity_observer.h"
  11. #include "ui/events/event_utils.h"
  12. #include "ui/events/platform/platform_event_source.h"
  13. namespace ui {
  14. namespace {
  15. UserActivityDetector* g_instance = nullptr;
  16. // Returns a string describing |event|.
  17. std::string GetEventDebugString(const ui::Event* event) {
  18. std::string details = base::StringPrintf(
  19. "type=%d name=%s flags=%d time=%" PRId64, event->type(), event->GetName(),
  20. event->flags(),
  21. (event->time_stamp() - base::TimeTicks()).InMilliseconds());
  22. if (event->IsKeyEvent()) {
  23. details += base::StringPrintf(" key_code=%d",
  24. static_cast<const ui::KeyEvent*>(event)->key_code());
  25. } else if (event->IsMouseEvent() || event->IsTouchEvent() ||
  26. event->IsGestureEvent()) {
  27. details += base::StringPrintf(" location=%s",
  28. static_cast<const ui::LocatedEvent*>(
  29. event)->location().ToString().c_str());
  30. }
  31. return details;
  32. }
  33. } // namespace
  34. const int UserActivityDetector::kNotifyIntervalMs = 200;
  35. // Too low and mouse events generated at the tail end of reconfiguration
  36. // will be reported as user activity and turn the screen back on; too high
  37. // and we'll ignore legitimate activity.
  38. const int UserActivityDetector::kDisplayPowerChangeIgnoreMouseMs = 1000;
  39. UserActivityDetector::UserActivityDetector() {
  40. CHECK(!g_instance);
  41. g_instance = this;
  42. PlatformEventSource* platform_event_source =
  43. PlatformEventSource::GetInstance();
  44. if (platform_event_source)
  45. platform_event_source->AddPlatformEventObserver(this);
  46. }
  47. UserActivityDetector::~UserActivityDetector() {
  48. PlatformEventSource* platform_event_source =
  49. PlatformEventSource::GetInstance();
  50. if (platform_event_source)
  51. platform_event_source->RemovePlatformEventObserver(this);
  52. g_instance = nullptr;
  53. }
  54. // static
  55. UserActivityDetector* UserActivityDetector::Get() {
  56. return g_instance;
  57. }
  58. bool UserActivityDetector::HasObserver(
  59. const UserActivityObserver* observer) const {
  60. return observers_.HasObserver(observer);
  61. }
  62. void UserActivityDetector::AddObserver(UserActivityObserver* observer) {
  63. observers_.AddObserver(observer);
  64. }
  65. void UserActivityDetector::RemoveObserver(UserActivityObserver* observer) {
  66. observers_.RemoveObserver(observer);
  67. }
  68. void UserActivityDetector::OnDisplayPowerChanging() {
  69. honor_mouse_events_time_ =
  70. GetCurrentTime() + base::Milliseconds(kDisplayPowerChangeIgnoreMouseMs);
  71. }
  72. void UserActivityDetector::HandleExternalUserActivity() {
  73. HandleActivity(nullptr);
  74. }
  75. void UserActivityDetector::DidProcessEvent(
  76. const PlatformEvent& platform_event) {
  77. std::unique_ptr<ui::Event> event(ui::EventFromNative(platform_event));
  78. ProcessReceivedEvent(event.get());
  79. }
  80. base::TimeTicks UserActivityDetector::GetCurrentTime() const {
  81. return !now_for_test_.is_null() ? now_for_test_ : base::TimeTicks::Now();
  82. }
  83. void UserActivityDetector::ProcessReceivedEvent(const ui::Event* event) {
  84. if (!event)
  85. return;
  86. if (event->IsMouseEvent() || event->IsMouseWheelEvent()) {
  87. if (event->flags() & ui::EF_IS_SYNTHESIZED)
  88. return;
  89. if (!honor_mouse_events_time_.is_null()
  90. && GetCurrentTime() < honor_mouse_events_time_)
  91. return;
  92. }
  93. HandleActivity(event);
  94. }
  95. void UserActivityDetector::HandleActivity(const ui::Event* event) {
  96. base::TimeTicks now = GetCurrentTime();
  97. last_activity_time_ = now;
  98. last_activity_name_ = event ? event->GetName() : std::string();
  99. if (last_observer_notification_time_.is_null() ||
  100. (now - last_observer_notification_time_).InMillisecondsF() >=
  101. kNotifyIntervalMs) {
  102. if (VLOG_IS_ON(1) && event)
  103. VLOG(1) << "Reporting user activity: " << GetEventDebugString(event);
  104. for (UserActivityObserver& observer : observers_)
  105. observer.OnUserActivity(event);
  106. last_observer_notification_time_ = now;
  107. }
  108. }
  109. } // namespace ui