1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "extensions/browser/api/alarms/alarms_api.h"
#include <stddef.h>
#include <utility>
#include "base/functional/bind.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/stringprintf.h"
#include "base/time/clock.h"
#include "base/time/default_clock.h"
#include "base/values.h"
#include "extensions/browser/api/alarms/alarm_manager.h"
#include "extensions/browser/api/alarms/alarms_api_constants.h"
#include "extensions/common/api/alarms.h"
#include "extensions/common/error_utils.h"
#include "third_party/blink/public/mojom/devtools/console_message.mojom.h"
namespace extensions {
namespace alarms = api::alarms;
namespace {
constexpr char kDefaultAlarmName[] = "";
constexpr char kBothRelativeAndAbsoluteTime[] =
"Cannot set both when and delayInMinutes.";
constexpr char kNoScheduledTime[] =
"Must set at least one of when, delayInMinutes, or periodInMinutes.";
constexpr char kMaxAlarmsError[] =
"An extension cannot have more than %d active alarms.";
constexpr char kWarningMinimumDevDelay[] =
"Alarm %s is less than the minimum duration of %zu seconds."
" In packed extensions, alarm \"%s\" will fire after the minimum duration.";
constexpr char kWarningMinimumReleaseDelay[] =
"Alarm %s is less than the minimum duration of %zu seconds."
" Alarm \"%s\" will fire after the minimum duration.";
bool ValidateAlarmCreateInfo(const std::string& alarm_name,
const alarms::AlarmCreateInfo& create_info,
const Extension* extension,
std::string* error,
std::vector<std::string>* warnings) {
if (create_info.delay_in_minutes && create_info.when) {
*error = kBothRelativeAndAbsoluteTime;
return false;
}
if (!create_info.delay_in_minutes.has_value() &&
!create_info.when.has_value() &&
!create_info.period_in_minutes.has_value()) {
*error = kNoScheduledTime;
return false;
}
// Users can always use an absolute timeout to request an arbitrarily-short or
// negative delay. We won't honor the short timeout, but we can't check it
// and warn the user because it would introduce race conditions (say they
// compute a long-enough timeout, but then the call into the alarms interface
// gets delayed past the boundary). However, it's still worth warning about
// relative delays that are shorter than we'll honor.
// For this minimum delay, we compare to the minimum of a packed extension,
// since we want to appropriately warn developers (we take into account the
// "real" unpacked state in the phrasing of the warning).
const base::TimeDelta min_packed_delay =
alarms_api_constants::GetMinimumDelay(/*is_unpacked=*/false,
extension->manifest_version());
const bool is_unpacked = Manifest::IsUnpackedLocation(extension->location());
if (create_info.delay_in_minutes) {
if (base::Minutes(*create_info.delay_in_minutes) < min_packed_delay) {
if (is_unpacked) {
warnings->push_back(base::StringPrintf(kWarningMinimumDevDelay, "delay",
min_packed_delay.InSeconds(),
alarm_name.c_str()));
} else {
warnings->push_back(base::StringPrintf(
kWarningMinimumReleaseDelay, "delay", min_packed_delay.InSeconds(),
alarm_name.c_str()));
}
}
}
if (create_info.period_in_minutes) {
if (base::Minutes(*create_info.period_in_minutes) < min_packed_delay) {
if (is_unpacked) {
warnings->push_back(base::StringPrintf(
kWarningMinimumDevDelay, "period", min_packed_delay.InSeconds(),
alarm_name.c_str()));
} else {
warnings->push_back(base::StringPrintf(
kWarningMinimumReleaseDelay, "period", min_packed_delay.InSeconds(),
alarm_name.c_str()));
}
}
}
return true;
}
} // namespace
AlarmsCreateFunction::AlarmsCreateFunction()
: clock_(base::DefaultClock::GetInstance()) {}
AlarmsCreateFunction::AlarmsCreateFunction(base::Clock* clock)
: clock_(clock) {}
AlarmsCreateFunction::~AlarmsCreateFunction() = default;
ExtensionFunction::ResponseAction AlarmsCreateFunction::Run() {
std::optional<alarms::Create::Params> params =
alarms::Create::Params::Create(args());
EXTENSION_FUNCTION_VALIDATE(params);
AlarmManager* const alarm_manager = AlarmManager::Get(browser_context());
EXTENSION_FUNCTION_VALIDATE(alarm_manager);
if (alarm_manager->GetCountForExtension(extension_id()) >=
AlarmManager::kMaxAlarmsPerExtension) {
return RespondNow(Error(base::StringPrintf(
kMaxAlarmsError, AlarmManager::kMaxAlarmsPerExtension)));
}
const std::string& alarm_name = params->name.value_or(kDefaultAlarmName);
std::vector<std::string> warnings;
std::string error;
if (!ValidateAlarmCreateInfo(alarm_name, params->alarm_info, extension(),
&error, &warnings)) {
return RespondNow(Error(std::move(error)));
}
for (const std::string& warning : warnings) {
WriteToConsole(blink::mojom::ConsoleMessageLevel::kWarning, warning);
}
base::TimeDelta granularity = alarms_api_constants::GetMinimumDelay(
Manifest::IsUnpackedLocation(extension()->location()),
extension()->manifest_version());
Alarm alarm(alarm_name, params->alarm_info, granularity, clock_->Now());
alarm_manager->AddAlarm(
extension_id(), std::move(alarm),
base::BindOnce(&AlarmsCreateFunction::Callback, this));
// AddAlarm might have already responded.
return did_respond() ? AlreadyResponded() : RespondLater();
}
void AlarmsCreateFunction::Callback() {
Respond(NoArguments());
}
ExtensionFunction::ResponseAction AlarmsGetFunction::Run() {
std::optional<alarms::Get::Params> params =
alarms::Get::Params::Create(args());
EXTENSION_FUNCTION_VALIDATE(params);
std::string name = params->name.value_or(kDefaultAlarmName);
AlarmManager::Get(browser_context())
->GetAlarm(extension_id(), name,
base::BindOnce(&AlarmsGetFunction::Callback, this, name));
// GetAlarm might have already responded.
return did_respond() ? AlreadyResponded() : RespondLater();
}
void AlarmsGetFunction::Callback(const std::string& name,
extensions::Alarm* alarm) {
if (alarm) {
Respond(ArgumentList(alarms::Get::Results::Create(*alarm->js_alarm)));
} else {
Respond(NoArguments());
}
}
ExtensionFunction::ResponseAction AlarmsGetAllFunction::Run() {
AlarmManager::Get(browser_context())
->GetAllAlarms(extension_id(),
base::BindOnce(&AlarmsGetAllFunction::Callback, this));
// GetAllAlarms might have already responded.
return did_respond() ? AlreadyResponded() : RespondLater();
}
void AlarmsGetAllFunction::Callback(const AlarmList* alarms) {
base::Value::List alarms_value;
if (alarms) {
for (const auto& alarm : *alarms)
alarms_value.Append(alarm.js_alarm->ToValue());
}
Respond(WithArguments(std::move(alarms_value)));
}
ExtensionFunction::ResponseAction AlarmsClearFunction::Run() {
std::optional<alarms::Clear::Params> params =
alarms::Clear::Params::Create(args());
EXTENSION_FUNCTION_VALIDATE(params);
std::string name = params->name.value_or(kDefaultAlarmName);
AlarmManager::Get(browser_context())
->RemoveAlarm(extension_id(), name,
base::BindOnce(&AlarmsClearFunction::Callback, this, name));
// RemoveAlarm might have already responded.
return did_respond() ? AlreadyResponded() : RespondLater();
}
void AlarmsClearFunction::Callback(const std::string& name, bool success) {
Respond(WithArguments(success));
}
ExtensionFunction::ResponseAction AlarmsClearAllFunction::Run() {
AlarmManager::Get(browser_context())
->RemoveAllAlarms(
extension_id(),
base::BindOnce(&AlarmsClearAllFunction::Callback, this));
// RemoveAllAlarms might have already responded.
return did_respond() ? AlreadyResponded() : RespondLater();
}
void AlarmsClearAllFunction::Callback() {
Respond(WithArguments(true));
}
} // namespace extensions
|
