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.
5 #include "chrome/browser/extensions/api/copresence/copresence_translations.h"
7 #include "chrome/common/extensions/api/copresence.h"
8 #include "components/copresence/proto/data.pb.h"
9 #include "components/copresence/proto/enums.pb.h"
10 #include "components/copresence/proto/rpcs.pb.h"
12 using copresence::AUDIBLE;
13 using copresence::AUDIO_CONFIGURATION_UNKNOWN;
14 using copresence::BROADCAST_AND_SCAN;
15 using copresence::BROADCAST_ONLY;
16 using copresence::BROADCAST_SCAN_CONFIGURATION_UNKNOWN;
17 using copresence::BroadcastScanConfiguration;
18 using copresence::ReportRequest;
19 using copresence::SCAN_ONLY;
20 using copresence::TokenExchangeStrategy;
22 using extensions::api::copresence::Strategy;
26 const int kDefaultTimeToLiveMs = 5 * 60 * 1000; // 5 minutes.
27 const int kMaxTimeToLiveMs = 24 * 60 * 60 * 1000; // 24 hours.
29 // Checks and returns the ttl provided by the user. If invalid, returns -1.
30 int SanitizeTtl(int* user_ttl) {
32 ? kDefaultTimeToLiveMs
33 : (*user_ttl <= 0 || *user_ttl > kMaxTimeToLiveMs ? -1 : *user_ttl);
36 BroadcastScanConfiguration TranslateStrategy(const Strategy& strategy) {
37 bool only_broadcast = strategy.only_broadcast && *strategy.only_broadcast;
38 bool only_scan = strategy.only_scan && *strategy.only_scan;
40 if (only_broadcast && only_scan)
41 return BROADCAST_AND_SCAN;
43 return BROADCAST_ONLY;
47 return BROADCAST_SCAN_CONFIGURATION_UNKNOWN;
50 // The strategy may be null (unspecified), so we pass it as a pointer.
51 void SetTokenExchangeStrategy(const Strategy* strategy,
52 BroadcastScanConfiguration default_config,
53 TokenExchangeStrategy* strategy_proto) {
55 BroadcastScanConfiguration config = TranslateStrategy(*strategy);
56 strategy_proto->set_broadcast_scan_configuration(
57 config == BROADCAST_SCAN_CONFIGURATION_UNKNOWN ?
58 default_config : config);
59 strategy_proto->set_audio_configuration(
60 strategy->audible && *strategy->audible ?
61 AUDIBLE : AUDIO_CONFIGURATION_UNKNOWN);
63 strategy_proto->set_broadcast_scan_configuration(default_config);
64 strategy_proto->set_audio_configuration(AUDIO_CONFIGURATION_UNKNOWN);
70 namespace extensions {
72 using api::copresence::Operation;
74 // Adds a publish operation to the report request. Returns false if the
75 // publish operation was invalid.
76 bool AddPublishToRequest(const std::string& app_id,
77 const api::copresence::PublishOperation& publish,
78 ReportRequest* request) {
79 copresence::PublishedMessage* publish_proto =
80 request->mutable_manage_messages_request()->add_message_to_publish();
81 publish_proto->mutable_access_policy()->mutable_acl()->set_acl_type(
82 copresence::NO_ACL_CHECK);
83 publish_proto->set_id(publish.id);
84 publish_proto->mutable_message()->mutable_type()->set_type(
85 publish.message.type);
86 publish_proto->mutable_message()->set_payload(publish.message.payload);
88 int ttl = SanitizeTtl(publish.time_to_live_millis.get());
91 publish_proto->mutable_access_policy()->set_ttl_millis(ttl);
93 SetTokenExchangeStrategy(publish.strategies.get(),
95 publish_proto->mutable_token_exchange_strategy());
97 DVLOG(2) << "Publishing message of type " << publish.message.type << ":\n"
98 << publish.message.payload;
99 // TODO(ckehoe): Validate that required fields are non-empty, etc.
103 // Adds an unpublish operation to the report request. Returns false if the
104 // publish id was invalid.
105 bool AddUnpublishToRequest(const std::string& publish_id,
106 ReportRequest* request) {
107 if (publish_id.empty())
110 request->mutable_manage_messages_request()->add_id_to_unpublish(publish_id);
111 DVLOG(2) << "Unpublishing message \"" << publish_id << "\"";
115 // Adds a subscribe operation to the report request. Returns false if the
116 // subscription operation was invalid.
117 bool AddSubscribeToRequest(
118 const std::string& app_id,
119 const api::copresence::SubscribeOperation& subscription,
120 SubscriptionToAppMap* apps_by_subscription_id,
121 ReportRequest* request) {
122 // Associate the subscription id with the app id.
123 SubscriptionToAppMap::iterator previous_subscription =
124 apps_by_subscription_id->find(subscription.id);
125 if (previous_subscription == apps_by_subscription_id->end()) {
126 (*apps_by_subscription_id)[subscription.id] = app_id;
127 } else if (previous_subscription->second == app_id) {
128 VLOG(2) << "Overwriting subscription id \"" << subscription.id
129 << "\" for app \"" << app_id << "\"";
131 // A conflicting association exists already.
132 VLOG(1) << "Subscription id \"" << subscription.id
133 << "\" used by two apps: \"" << previous_subscription->second
134 << "\" and \"" << app_id << "\"";
138 // Convert from IDL to server subscription format.
139 copresence::Subscription* subscription_proto =
140 request->mutable_manage_subscriptions_request()->add_subscription();
141 subscription_proto->set_id(subscription.id);
142 int ttl = SanitizeTtl(subscription.time_to_live_millis.get());
145 subscription_proto->set_ttl_millis(ttl);
147 subscription_proto->mutable_message_type()->set_type(
148 subscription.filter.type);
150 SetTokenExchangeStrategy(
151 subscription.strategies.get(),
153 subscription_proto->mutable_token_exchange_strategy());
155 DVLOG(2) << "Subscribing for messages of type " << subscription.filter.type;
156 // TODO(ckehoe): Validate that required fields are non-empty, etc.
160 // Adds an unpublish operation to the report request. Returns false if the
161 // subscription id was invalid.
162 bool AddUnsubscribeToRequest(const std::string& app_id,
163 const std::string& subscription_id,
164 SubscriptionToAppMap* apps_by_subscription_id,
165 ReportRequest* request) {
166 if (subscription_id.empty())
169 // Check that this subscription id belongs to this app.
170 SubscriptionToAppMap::iterator subscription =
171 apps_by_subscription_id->find(subscription_id);
172 if (subscription == apps_by_subscription_id->end()) {
173 LOG(ERROR) << "No such subscription \"" << subscription_id
174 << "\". Cannot unsubscribe.";
176 } else if (subscription->second != app_id) {
177 LOG(ERROR) << "Subscription \"" << subscription_id
178 << "\" does not belong to app \"" << app_id
179 << "\". Cannot unsubscribe.";
182 apps_by_subscription_id->erase(subscription);
185 request->mutable_manage_subscriptions_request()->add_id_to_unsubscribe(
187 DVLOG(2) << "Cancelling subscription \"" << subscription_id << "\" for app \""
192 bool PrepareReportRequestProto(
193 const std::vector<linked_ptr<Operation>>& operations,
194 const std::string& app_id,
195 SubscriptionToAppMap* apps_by_subscription_id,
196 ReportRequest* request) {
197 for (size_t i = 0; i < operations.size(); ++i) {
198 linked_ptr<Operation> op = operations[i];
201 // Verify our object has exactly one operation.
202 if (static_cast<int>(op->publish != NULL) +
203 static_cast<int>(op->subscribe != NULL) +
204 static_cast<int>(op->unpublish != NULL) +
205 static_cast<int>(op->unsubscribe != NULL) != 1) {
210 if (!AddPublishToRequest(app_id, *(op->publish), request))
212 } else if (op->subscribe) {
213 if (!AddSubscribeToRequest(
214 app_id, *(op->subscribe), apps_by_subscription_id, request))
216 } else if (op->unpublish) {
217 if (!AddUnpublishToRequest(op->unpublish->unpublish_id, request))
219 } else { // if (op->unsubscribe)
220 if (!AddUnsubscribeToRequest(app_id,
221 op->unsubscribe->unsubscribe_id,
222 apps_by_subscription_id,
231 } // namespace extensions