OLD | NEW |
| (Empty) |
1 // Copyright (c) 2012 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 // | |
5 // A notifier that uses p2p notifications based on XMPP push | |
6 // notifications. Used only for sync integration tests. | |
7 | |
8 #ifndef SYNC_NOTIFIER_P2P_NOTIFIER_H_ | |
9 #define SYNC_NOTIFIER_P2P_NOTIFIER_H_ | |
10 | |
11 #include <string> | |
12 | |
13 #include "base/compiler_specific.h" | |
14 #include "base/memory/ref_counted.h" | |
15 #include "base/memory/scoped_ptr.h" | |
16 #include "base/memory/weak_ptr.h" | |
17 #include "base/observer_list.h" | |
18 #include "base/threading/thread_checker.h" | |
19 #include "jingle/notifier/listener/push_client_observer.h" | |
20 #include "sync/internal_api/public/base/model_type.h" | |
21 #include "sync/notifier/notifications_disabled_reason.h" | |
22 #include "sync/notifier/sync_notifier.h" | |
23 #include "sync/notifier/sync_notifier_registrar.h" | |
24 | |
25 namespace notifier { | |
26 class PushClient; | |
27 } // namespace notifier | |
28 | |
29 namespace syncer { | |
30 | |
31 // The channel to use for sync notifications. | |
32 extern const char* kSyncP2PNotificationChannel; | |
33 | |
34 // The intended recipient(s) of a P2P notification. | |
35 enum P2PNotificationTarget { | |
36 NOTIFY_SELF, | |
37 FIRST_NOTIFICATION_TARGET = NOTIFY_SELF, | |
38 NOTIFY_OTHERS, | |
39 NOTIFY_ALL, | |
40 LAST_NOTIFICATION_TARGET = NOTIFY_ALL | |
41 }; | |
42 | |
43 std::string P2PNotificationTargetToString( | |
44 P2PNotificationTarget target); | |
45 | |
46 // If |target_str| can't be parsed, assumes NOTIFY_SELF. | |
47 P2PNotificationTarget P2PNotificationTargetFromString( | |
48 const std::string& target_str); | |
49 | |
50 // Helper notification data class that can be serialized to and | |
51 // deserialized from a string. | |
52 class P2PNotificationData { | |
53 public: | |
54 // Initializes with an empty sender ID, target set to NOTIFY_SELF, | |
55 // and empty changed types. | |
56 P2PNotificationData(); | |
57 P2PNotificationData(const std::string& sender_id, | |
58 P2PNotificationTarget target, | |
59 ModelTypeSet changed_types); | |
60 | |
61 ~P2PNotificationData(); | |
62 | |
63 // Returns true if the given ID is targeted by this notification. | |
64 bool IsTargeted(const std::string& id) const; | |
65 | |
66 ModelTypeSet GetChangedTypes() const; | |
67 | |
68 bool Equals(const P2PNotificationData& other) const; | |
69 | |
70 std::string ToString() const; | |
71 | |
72 // Returns whether parsing |str| was successful. If parsing was | |
73 // unsuccessful, the state of the notification is undefined. | |
74 bool ResetFromString(const std::string& str); | |
75 | |
76 private: | |
77 // The unique ID of the client that sent the notification. | |
78 std::string sender_id_; | |
79 // The intendent recipient(s) of the notification. | |
80 P2PNotificationTarget target_; | |
81 // The types the notification is for. | |
82 ModelTypeSet changed_types_; | |
83 }; | |
84 | |
85 class P2PNotifier : public SyncNotifier, | |
86 public notifier::PushClientObserver { | |
87 public: | |
88 // The |send_notification_target| parameter was added to allow us to send | |
89 // self-notifications in some cases, but not others. The value should be | |
90 // either NOTIFY_ALL to send notifications to all clients, or NOTIFY_OTHERS | |
91 // to send notifications to all clients except for the one that triggered the | |
92 // notification. See crbug.com/97780. | |
93 P2PNotifier(scoped_ptr<notifier::PushClient> push_client, | |
94 P2PNotificationTarget send_notification_target); | |
95 | |
96 virtual ~P2PNotifier(); | |
97 | |
98 // SyncNotifier implementation | |
99 virtual void RegisterHandler(SyncNotifierObserver* handler) OVERRIDE; | |
100 virtual void UpdateRegisteredIds(SyncNotifierObserver* handler, | |
101 const ObjectIdSet& ids) OVERRIDE; | |
102 virtual void UnregisterHandler(SyncNotifierObserver* handler) OVERRIDE; | |
103 virtual void SetUniqueId(const std::string& unique_id) OVERRIDE; | |
104 virtual void SetStateDeprecated(const std::string& state) OVERRIDE; | |
105 virtual void UpdateCredentials( | |
106 const std::string& email, const std::string& token) OVERRIDE; | |
107 virtual void SendNotification(ModelTypeSet changed_types) OVERRIDE; | |
108 | |
109 // PushClientObserver implementation. | |
110 virtual void OnNotificationsEnabled() OVERRIDE; | |
111 virtual void OnNotificationsDisabled( | |
112 notifier::NotificationsDisabledReason reason) OVERRIDE; | |
113 virtual void OnIncomingNotification( | |
114 const notifier::Notification& notification) OVERRIDE; | |
115 | |
116 void SendNotificationDataForTest( | |
117 const P2PNotificationData& notification_data); | |
118 | |
119 private: | |
120 void SendNotificationData(const P2PNotificationData& notification_data); | |
121 | |
122 base::ThreadChecker thread_checker_; | |
123 | |
124 SyncNotifierRegistrar registrar_; | |
125 | |
126 // The push client. | |
127 scoped_ptr<notifier::PushClient> push_client_; | |
128 // Our unique ID. | |
129 std::string unique_id_; | |
130 // Whether we have called UpdateCredentials() yet. | |
131 bool logged_in_; | |
132 bool notifications_enabled_; | |
133 // Which set of clients should be sent notifications. | |
134 P2PNotificationTarget send_notification_target_; | |
135 | |
136 ModelTypeSet enabled_types_; | |
137 }; | |
138 | |
139 } // namespace syncer | |
140 | |
141 #endif // SYNC_NOTIFIER_P2P_NOTIFIER_H_ | |
OLD | NEW |