| // Copyright (c) 2013 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 UI_MESSAGE_CENTER_MESSAGE_CENTER_IMPL_H_ |
| #define UI_MESSAGE_CENTER_MESSAGE_CENTER_IMPL_H_ |
| |
| #include <string> |
| #include <vector> |
| |
| #include "base/memory/scoped_vector.h" |
| #include "base/memory/weak_ptr.h" |
| #include "base/stl_util.h" |
| #include "base/time/time.h" |
| #include "base/timer/timer.h" |
| #include "ui/message_center/message_center.h" |
| #include "ui/message_center/message_center_observer.h" |
| #include "ui/message_center/message_center_types.h" |
| #include "ui/message_center/notification_blocker.h" |
| |
| namespace message_center { |
| class NotificationDelegate; |
| class MessageCenterImpl; |
| |
| namespace internal { |
| class ChangeQueue; |
| class PopupTimersController; |
| |
| // A class that manages timeout behavior for notification popups. One instance |
| // is created per notification popup. |
| class PopupTimer { |
| public: |
| // Accepts a notification ID, time until callback, and a reference to the |
| // controller which will be called back. The reference is a weak pointer so |
| // that timers never cause a callback on a destructed object. |
| PopupTimer(const std::string& id, |
| base::TimeDelta timeout, |
| base::WeakPtr<PopupTimersController> controller); |
| ~PopupTimer(); |
| |
| // Starts running the timer. Barring a Pause or Reset call, the timer will |
| // call back to |controller| after |timeout| seconds. |
| void Start(); |
| |
| // Stops the timer, and retains the amount of time that has passed so that on |
| // subsequent calls to Start the timer will continue where it left off. |
| void Pause(); |
| |
| // Stops the timer, and resets the amount of time that has passed so that |
| // calling Start results in a timeout equal to the initial timeout setting. |
| void Reset(); |
| |
| base::TimeDelta get_timeout() const { return timeout_; } |
| |
| private: |
| // Notification ID for which this timer applies. |
| const std::string id_; |
| |
| // Total time that should pass while active before calling TimerFinished. |
| base::TimeDelta timeout_; |
| |
| // If paused, the amount of time that passed before pause. |
| base::TimeDelta passed_; |
| |
| // The time that the timer was last started. |
| base::Time start_time_; |
| |
| // Callback recipient. |
| base::WeakPtr<PopupTimersController> timer_controller_; |
| |
| // The actual timer. |
| scoped_ptr<base::OneShotTimer<PopupTimersController> > timer_; |
| |
| DISALLOW_COPY_AND_ASSIGN(PopupTimer); |
| }; |
| |
| // A class that manages all the timers running for individual notification popup |
| // windows. It supports weak pointers in order to allow safe callbacks when |
| // timers expire. |
| class MESSAGE_CENTER_EXPORT PopupTimersController |
| : public base::SupportsWeakPtr<PopupTimersController>, |
| public MessageCenterObserver { |
| public: |
| explicit PopupTimersController(MessageCenter* message_center); |
| virtual ~PopupTimersController(); |
| |
| // MessageCenterObserver implementation. |
| virtual void OnNotificationDisplayed(const std::string& id) OVERRIDE; |
| virtual void OnNotificationUpdated(const std::string& id) OVERRIDE; |
| virtual void OnNotificationRemoved(const std::string& id, bool by_user) |
| OVERRIDE; |
| |
| // Callback for each timer when its time is up. |
| virtual void TimerFinished(const std::string& id); |
| |
| // Pauses all running timers. |
| void PauseAll(); |
| |
| // Continues all managed timers. |
| void StartAll(); |
| |
| // Removes all managed timers. |
| void CancelAll(); |
| |
| // Starts a timer (by creating a PopupTimer) for |id|. |
| void StartTimer(const std::string& id, |
| const base::TimeDelta& timeout_in_seconds); |
| |
| // Stops a single timer, reverts it to a new timeout, and restarts it. |
| void ResetTimer(const std::string& id, |
| const base::TimeDelta& timeout_in_seconds); |
| |
| // Pauses a single timer, such that it will continue where it left off after a |
| // call to StartAll or StartTimer. |
| void PauseTimer(const std::string& id); |
| |
| // Removes and cancels a single popup timer, if it exists. |
| void CancelTimer(const std::string& id); |
| |
| private: |
| // Weak, this class is owned by MessageCenterImpl. |
| MessageCenter* message_center_; |
| |
| // The PopupTimerCollection contains all the managed timers by their ID. They |
| // are owned by this class, and deleted by |popup_deleter_| on destructon or |
| // when explicitly cancelled. |
| typedef std::map<std::string, PopupTimer*> PopupTimerCollection; |
| PopupTimerCollection popup_timers_; |
| STLValueDeleter<PopupTimerCollection> popup_deleter_; |
| |
| DISALLOW_COPY_AND_ASSIGN(PopupTimersController); |
| }; |
| |
| } // namespace internal |
| |
| // The default implementation of MessageCenter. |
| class MessageCenterImpl : public MessageCenter, |
| public NotificationBlocker::Observer { |
| public: |
| MessageCenterImpl(); |
| virtual ~MessageCenterImpl(); |
| |
| // MessageCenter overrides: |
| virtual void AddObserver(MessageCenterObserver* observer) OVERRIDE; |
| virtual void RemoveObserver(MessageCenterObserver* observer) OVERRIDE; |
| virtual void AddNotificationBlocker(NotificationBlocker* blocker) OVERRIDE; |
| virtual void RemoveNotificationBlocker(NotificationBlocker* blocker) OVERRIDE; |
| virtual void SetVisibility(Visibility visible) OVERRIDE; |
| virtual bool IsMessageCenterVisible() const OVERRIDE; |
| virtual size_t NotificationCount() const OVERRIDE; |
| virtual size_t UnreadNotificationCount() const OVERRIDE; |
| virtual bool HasPopupNotifications() const OVERRIDE; |
| virtual bool HasNotification(const std::string& id) OVERRIDE; |
| virtual bool IsQuietMode() const OVERRIDE; |
| virtual bool HasClickedListener(const std::string& id) OVERRIDE; |
| virtual const NotificationList::Notifications& GetVisibleNotifications() |
| OVERRIDE; |
| virtual NotificationList::PopupNotifications GetPopupNotifications() OVERRIDE; |
| virtual void AddNotification(scoped_ptr<Notification> notification) OVERRIDE; |
| virtual void UpdateNotification(const std::string& old_id, |
| scoped_ptr<Notification> new_notification) |
| OVERRIDE; |
| virtual void RemoveNotification(const std::string& id, bool by_user) OVERRIDE; |
| virtual void RemoveAllNotifications(bool by_user) OVERRIDE; |
| virtual void RemoveAllVisibleNotifications(bool by_user) OVERRIDE; |
| virtual void SetNotificationIcon(const std::string& notification_id, |
| const gfx::Image& image) OVERRIDE; |
| virtual void SetNotificationImage(const std::string& notification_id, |
| const gfx::Image& image) OVERRIDE; |
| virtual void SetNotificationButtonIcon(const std::string& notification_id, |
| int button_index, |
| const gfx::Image& image) OVERRIDE; |
| virtual void DisableNotificationsByNotifier( |
| const NotifierId& notifier_id) OVERRIDE; |
| virtual void ExpandNotification(const std::string& id) OVERRIDE; |
| virtual void ClickOnNotification(const std::string& id) OVERRIDE; |
| virtual void ClickOnNotificationButton(const std::string& id, |
| int button_index) OVERRIDE; |
| virtual void MarkSinglePopupAsShown(const std::string& id, |
| bool mark_notification_as_read) OVERRIDE; |
| virtual void DisplayedNotification(const std::string& id) OVERRIDE; |
| virtual void SetNotifierSettingsProvider( |
| NotifierSettingsProvider* provider) OVERRIDE; |
| virtual NotifierSettingsProvider* GetNotifierSettingsProvider() OVERRIDE; |
| virtual void SetQuietMode(bool in_quiet_mode) OVERRIDE; |
| virtual void EnterQuietModeWithExpire( |
| const base::TimeDelta& expires_in) OVERRIDE; |
| virtual void RestartPopupTimers() OVERRIDE; |
| virtual void PausePopupTimers() OVERRIDE; |
| |
| // NotificationBlocker::Observer overrides: |
| virtual void OnBlockingStateChanged(NotificationBlocker* blocker) OVERRIDE; |
| |
| protected: |
| virtual void DisableTimersForTest() OVERRIDE; |
| |
| private: |
| struct NotificationCache { |
| NotificationCache(); |
| ~NotificationCache(); |
| void Rebuild(const NotificationList::Notifications& notificaitons); |
| void RecountUnread(); |
| |
| NotificationList::Notifications visible_notifications; |
| size_t unread_count; |
| }; |
| |
| void RemoveNotifications(bool by_user, const NotificationBlockers& blockers); |
| |
| scoped_ptr<NotificationList> notification_list_; |
| NotificationCache notification_cache_; |
| ObserverList<MessageCenterObserver> observer_list_; |
| scoped_ptr<internal::PopupTimersController> popup_timers_controller_; |
| scoped_ptr<base::OneShotTimer<MessageCenterImpl> > quiet_mode_timer_; |
| NotifierSettingsProvider* settings_provider_; |
| std::vector<NotificationBlocker*> blockers_; |
| |
| // Queue for the notifications to delay the addition/updates when the message |
| // center is visible. |
| scoped_ptr<internal::ChangeQueue> notification_queue_; |
| |
| DISALLOW_COPY_AND_ASSIGN(MessageCenterImpl); |
| }; |
| |
| } // namespace message_center |
| |
| #endif // UI_MESSAGE_CENTER_MESSAGE_CENTER_H_ |