[Night Light] CL4: Automatic schedule backend.

ash/system/night_light/night_light_controller.h

 // Copyright 2017 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 ASH_SYSTEM_NIGHT_LIGHT_NIGHT_LIGHT_CONTROLLER_H_
 #define ASH_SYSTEM_NIGHT_LIGHT_NIGHT_LIGHT_CONTROLLER_H_
 
 #include <memory>
 
 #include "ash/ash_export.h"
 #include "ash/session/session_observer.h"
+#include "ash/system/night_light/night_light_time.h"
 #include "base/observer_list.h"
+#include "base/time/time.h"
+#include "base/timer/timer.h"
 #include "components/prefs/pref_change_registrar.h"
 
 class PrefRegistrySimple;
 class PrefService;
 
 namespace ash {
 
 class SessionController;
 
 // Controls the NightLight feature that adjusts the color temperature of the
 // screen.
 class ASH_EXPORT NightLightController : public SessionObserver {
  public:
+  enum class ScheduleType : int {
+    // Automatic toggling of NightLight is turned off.
+    kNever = 0,
+
+    // Turned automatically on at the user's local sunset time, and off at the
+    // user's local sunrise time.
+    kSunsetToSunrise = 1,
+
+    // Toggled automatically based on the custom set start and end times
+    // selected by the user from the system settings.
+    kCustom = 2,
+  };
+
+  enum class AnimationDurationType {
+    // Short animation (2 seconds) used for manual changes of NightLight status
+    // and temperature by the user.
+    kShort,
+
+    // Long animation (20 seconds) used for applying the color temperature
+    // gradually as a result of getting into or out of the automatically
+    // scheduled NightLight mode. This gives the user a smooth transition.
+    kLong,
+  };
+
+  // This class enables us to inject fake values for "Now" as well as the sunset
+  // and sunrise times, so that we can reliably test the behavior in various
+  // schedule types and times.
+  class Delegate {
+   public:
+    // NightLightController owns the delegate.
+    virtual ~Delegate() {}
+
+    // Gets the current time.
+    virtual base::Time GetNow() const = 0;
+
+    // Gets the sunset and sunrise times.
+    virtual base::Time GetSunsetTime() const = 0;
+    virtual base::Time GetSunriseTime() const = 0;
+  };
+
   class Observer {
    public:
     // Emitted when the NightLight status is changed.
     virtual void OnNightLightEnabledChanged(bool enabled) = 0;
 
    protected:
     virtual ~Observer() {}
   };
 
   explicit NightLightController(SessionController* session_controller);
   ~NightLightController() override;
 
   static void RegisterPrefs(PrefRegistrySimple* registry);
 
+  AnimationDurationType animation_type() const { return animation_type_; }
+  AnimationDurationType consumed_animation_type() const {
+    return consumed_animation_type_;
+  }
+  const base::OneShotTimer& timer() const { return timer_; }
+
   void AddObserver(Observer* observer);
   void RemoveObserver(Observer* observer);
 
   // Get the NightLight settings stored in the current active user prefs.
   bool GetEnabled() const;
   float GetColorTemperature() const;
+  ScheduleType GetScheduleType() const;
+  NightLightTime GetCustomStartTime() const;
+  NightLightTime GetCustomEndTime() const;
 
   // Set the desired NightLight settings in the current active user prefs.
-  void SetEnabled(bool enabled);
+  void SetEnabled(bool enabled, AnimationDurationType animation_type);
   void SetColorTemperature(float temperature);
+  void SetScheduleType(ScheduleType type);
+  void SetCustomStartTime(NightLightTime start_time);
+  void SetCustomEndTime(NightLightTime end_time);
 
+  // This is always called as a result of a user action and will always use the
+  // AnimationDurationType::kShort.
   void Toggle();
 
   // ash::SessionObserver:
   void OnActiveUserSessionChanged(const AccountId& account_id) override;
 
+  void OverrideDelegateForTesting(std::unique_ptr<Delegate> delegate);

[James Cook, 2017/05/23 16:34:58]

optional: SetDelegateForTesting() is a more common name

[afakhry, 2017/05/24 04:21:10]

Done.

+
  private:
-  void Refresh();
+  void RefreshLayersTemperature();
 
   void StartWatchingPrefsChanges();
 
   void InitFromUserPrefs();
 
   void NotifyStatusChanged();
 
   // Called when the user pref for the enabled status of NightLight is changed.
   void OnEnabledPrefChanged();
 
   // Called when the user pref for the color temperature is changed.
   void OnColorTemperaturePrefChanged();
 
+  // Called when any of the schedule related prefs (schedule type, custom start
+  // and end times) are changed.
+  void OnScheduleParamsPrefsChanged();
+
+  // Refreshes the state of NightLight according to the currently set
+  // parameters. |did_schedule_change| is true when Refresh() is called as a
+  // result of a change in one of the schedule related prefs, and false
+  // otherwise.
+  void Refresh(bool did_schedule_change);
+
+  void RefreshScheduleTimer(base::Time start_time,

[James Cook, 2017/05/23 16:34:58]

nit: docs?

[afakhry, 2017/05/24 04:21:10]

Done.

+                            base::Time end_time,
+                            bool did_schedule_change);
+
+  // Schedule the upcoming next toggle of NightLight mode. This is used for the
+  // automatic status changes of NightLight which always use an
+  // AnimationDurationType::kLong.
+  void ScheduleNextToggle(base::TimeDelta delay);
+
   // The observed session controller instance from which we know when to
   // initialize the NightLight settings from the user preferences.
   SessionController* const session_controller_;
 
+  std::unique_ptr<Delegate> delegate_;
+
   // The pref service of the currently active user. Can be null in
   // ash_unittests.
   PrefService* active_user_pref_service_ = nullptr;
 
+  // The animation type for any upcoming future change.
+  AnimationDurationType animation_type_ = AnimationDurationType::kShort;
+  // The animation type of the change that was just performed.
+  AnimationDurationType consumed_animation_type_ =

[James Cook, 2017/05/23 16:34:58]

optional: |last_animation_type_|? I'm a little confused about "consumed".

[afakhry, 2017/05/24 04:21:10]

Done.

+      AnimationDurationType::kShort;
+
+  // The timer that schedules the start and end of NightLight when the schedule
+  // type is either kSunsetToSunrise or kCustom.
+  base::OneShotTimer timer_;
+
   // The registrar used to watch NightLight prefs changes in the above
   // |active_user_pref_service_| from outside ash.
   // NOTE: Prefs are how Chrome communicates changes to the NightLight settings
   // controlled by this class from the WebUI settings.
   std::unique_ptr<PrefChangeRegistrar> pref_change_registrar_;
 
   base::ObserverList<Observer> observers_;
 
   DISALLOW_COPY_AND_ASSIGN(NightLightController);
 };
 
 }  // namespace ash
 
 #endif  // ASH_SYSTEM_NIGHT_LIGHT_NIGHT_LIGHT_CONTROLLER_H_