Chromium Code Reviews| OLD | NEW |
|---|---|
| (Empty) | |
| 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | |
|
Nikita (slow)
2012/09/25 16:23:46
Should ResourceRequestAllowedNotifier be moved to
SteveT
2012/09/25 18:49:11
Again, it used to be under chrome/browser, but an
| |
| 2 // Use of this source code is governed by a BSD-style license that can be | |
| 3 // found in the LICENSE file. | |
| 4 | |
| 5 #ifndef CHROME_BROWSER_METRICS_VARIATIONS_RESOURCE_REQUEST_ALLOWED_NOTIFIER_H_ | |
| 6 #define CHROME_BROWSER_METRICS_VARIATIONS_RESOURCE_REQUEST_ALLOWED_NOTIFIER_H_ | |
| 7 | |
| 8 #include "base/observer_list.h" | |
| 9 #include "net/base/network_change_notifier.h" | |
| 10 | |
| 11 #if defined(OS_CHROMEOS) | |
| 12 #include "content/public/browser/notification_observer.h" | |
| 13 #include "content/public/browser/notification_registrar.h" | |
| 14 #endif | |
| 15 | |
| 16 // This class informs an interested observer when resource requests over the | |
| 17 // network are permitted. | |
| 18 // | |
| 19 // Currently, the criteria for allowing resource requests include: | |
| 20 // 1. The network is currently available. | |
| 21 // 2. The EULA was accepted by the user (ChromeOS only). | |
| 22 // | |
| 23 // Interested services should add themselves as an observer of | |
| 24 // ResourceRequestAllowedNotifier and check ResourceRequestsAllowed() to see if | |
| 25 // requests are permitted. If it returns true, they can go ahead and make their | |
| 26 // request. If it returns false, ResourceRequestAllowedNotifier will notify the | |
| 27 // service when the criteria is met. | |
| 28 // | |
| 29 // If ResourceRequestsAllowed returns true the first time, | |
| 30 // ResourceRequestAllowedNotifier will not notify the service in the future. | |
| 31 // | |
| 32 // Note that this class handles the criteria state for a single service, so | |
| 33 // services should keep their own instance of this class rather than sharing a | |
| 34 // global instance. | |
| 35 class ResourceRequestAllowedNotifier : | |
| 36 #if defined(OS_CHROMEOS) | |
| 37 public content::NotificationObserver, | |
| 38 #endif | |
| 39 public net::NetworkChangeNotifier::ConnectionTypeObserver { | |
| 40 public: | |
| 41 // Observes resource request allowed state changes. | |
| 42 class Observer { | |
| 43 public: | |
| 44 virtual void OnResourceRequestsAllowed() = 0; | |
| 45 }; | |
| 46 | |
| 47 ResourceRequestAllowedNotifier(); | |
| 48 virtual ~ResourceRequestAllowedNotifier(); | |
| 49 | |
| 50 // Sets |observer| as the service to be notified by this instance, and | |
| 51 // performs initial checks on the criteria. |observer| may not be NULL. | |
| 52 // This is to be called immediately after construction of an instance of | |
| 53 // ResourceRequestAllowedNotifier to pass it the interested service. | |
| 54 void Init(Observer* observer); | |
| 55 | |
| 56 // Returns true iff all resource request criteria are met. If not, this call | |
| 57 // will set some flags so it knows to notify the observer if the criteria | |
| 58 // changes. Note that the observer will never be notified unless it calls this | |
| 59 // method first. This is virtual so it can be overriden for tests. | |
| 60 virtual bool ResourceRequestsAllowed(); | |
| 61 | |
| 62 void SetWasWaitingForNetworkForTesting(bool waiting); | |
| 63 #if defined(OS_CHROMEOS) | |
| 64 void SetWasWaitingForEulaForTesting(bool waiting); | |
| 65 #endif | |
| 66 | |
| 67 protected: | |
| 68 // Notifies the observer if all criteria needed for resource requests are met. | |
| 69 // This is protected so it can be called from subclasses for testing. | |
| 70 void MaybeNotifyObserver(); | |
| 71 | |
| 72 #if defined(OS_CHROMEOS) | |
| 73 // On official builds, returns true iff the EULA needs to be accepted. This | |
| 74 // always returns false on unofficial builds since there is no notion of a | |
| 75 // EULA. | |
| 76 // | |
| 77 // This is virtual so it can be overriden by test classes to avoid making them | |
| 78 // aware of the ChromeOS details. This is protected so it call be overriden in | |
| 79 // subclasses for testing. | |
| 80 virtual bool NeedsEulaAcceptance(); | |
| 81 #endif | |
| 82 | |
| 83 private: | |
| 84 // net::NetworkChangeNotifier::ConnectionTypeObserver overrides: | |
| 85 virtual void OnConnectionTypeChanged( | |
| 86 net::NetworkChangeNotifier::ConnectionType type) OVERRIDE; | |
| 87 | |
| 88 #if defined(OS_CHROMEOS) | |
| 89 // content::NotificationObserver overrides: | |
| 90 virtual void Observe(int type, | |
| 91 const content::NotificationSource& source, | |
| 92 const content::NotificationDetails& details) OVERRIDE; | |
| 93 #endif | |
| 94 | |
| 95 // Tracks whether or not the observer/service depending on this class actually | |
| 96 // requested permission to make a request or not. If it did not, then this | |
| 97 // class should not notify it even if the criteria is met. | |
| 98 bool observer_requested_permission_; | |
| 99 | |
| 100 // Tracks network connectivity criteria. | |
| 101 bool was_waiting_for_network_; | |
| 102 | |
| 103 #if defined(OS_CHROMEOS) | |
| 104 // Tracks EULA acceptance criteria. | |
| 105 bool was_waiting_for_user_to_accept_eula_; | |
| 106 | |
| 107 // Used to listen for the EULA accepted notification. | |
| 108 content::NotificationRegistrar registrar_; | |
| 109 #endif | |
| 110 | |
| 111 // Observing service interested in request permissions. | |
| 112 Observer* observer_; | |
| 113 | |
| 114 DISALLOW_COPY_AND_ASSIGN(ResourceRequestAllowedNotifier); | |
| 115 }; | |
| 116 | |
| 117 #endif // CHROME_BROWSER_METRICS_VARIATIONS_RESOURCE_REQUEST_ALLOWED_NOTIFIER_H _ | |
| OLD | NEW |