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 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
|
// Copyright 2014 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/app_runtime/app_runtime_api.h"
#include <stddef.h>
#include <memory>
#include <utility>
#include <vector>
#include "base/time/time.h"
#include "base/types/cxx23_to_underlying.h"
#include "extensions/browser/entry_info.h"
#include "extensions/browser/event_router.h"
#include "extensions/browser/extension_prefs.h"
#include "extensions/browser/extensions_browser_client.h"
#include "extensions/browser/granted_file_entry.h"
#include "extensions/common/api/app_runtime.h"
#include "extensions/common/constants.h"
#include "extensions/common/extension_id.h"
#include "extensions/common/feature_switch.h"
#include "url/gurl.h"
using content::BrowserContext;
namespace extensions {
namespace app_runtime = api::app_runtime;
namespace {
void DispatchOnEmbedRequestedEventImpl(
const ExtensionId& extension_id,
base::Value::Dict app_embedding_request_data,
content::BrowserContext* context) {
base::Value::List args;
args.Append(std::move(app_embedding_request_data));
auto event = std::make_unique<Event>(
events::APP_RUNTIME_ON_EMBED_REQUESTED,
app_runtime::OnEmbedRequested::kEventName, std::move(args), context);
EventRouter::Get(context)->DispatchEventWithLazyListener(extension_id,
std::move(event));
ExtensionPrefs::Get(context)->SetLastLaunchTime(extension_id,
base::Time::Now());
}
void DispatchOnLaunchedEventImpl(const ExtensionId& extension_id,
app_runtime::LaunchSource source,
base::Value::Dict launch_data,
BrowserContext* context) {
launch_data.Set("isDemoSession",
ExtensionsBrowserClient::Get()->IsInDemoMode());
// "Forced app mode" is true for Chrome OS kiosk mode.
launch_data.Set("isKioskSession",
ExtensionsBrowserClient::Get()->IsRunningInForcedAppMode());
launch_data.Set("isPublicSession",
ExtensionsBrowserClient::Get()->IsLoggedInAsPublicAccount());
base::Value::List args;
args.Append(std::move(launch_data));
auto event = std::make_unique<Event>(events::APP_RUNTIME_ON_LAUNCHED,
app_runtime::OnLaunched::kEventName,
std::move(args), context);
EventRouter::Get(context)->DispatchEventWithLazyListener(extension_id,
std::move(event));
ExtensionPrefs::Get(context)->SetLastLaunchTime(extension_id,
base::Time::Now());
}
#define ASSERT_ENUM_EQUAL(Name, Name2) \
static_assert(base::to_underlying(extensions::AppLaunchSource::Name) == \
base::to_underlying(app_runtime::LaunchSource::Name2), \
"The value of extensions::" #Name \
" and app_runtime::LAUNCH_" #Name2 " should be the same");
app_runtime::LaunchSource GetLaunchSourceEnum(AppLaunchSource source) {
ASSERT_ENUM_EQUAL(kSourceNone, kNone);
ASSERT_ENUM_EQUAL(kSourceUntracked, kUntracked);
ASSERT_ENUM_EQUAL(kSourceAppLauncher, kAppLauncher);
ASSERT_ENUM_EQUAL(kSourceNewTabPage, kNewTabPage);
ASSERT_ENUM_EQUAL(kSourceReload, kReload);
ASSERT_ENUM_EQUAL(kSourceRestart, kRestart);
ASSERT_ENUM_EQUAL(kSourceLoadAndLaunch, kLoadAndLaunch);
ASSERT_ENUM_EQUAL(kSourceCommandLine, kCommandLine);
ASSERT_ENUM_EQUAL(kSourceFileHandler, kFileHandler);
ASSERT_ENUM_EQUAL(kSourceUrlHandler, kUrlHandler);
ASSERT_ENUM_EQUAL(kSourceSystemTray, kSystemTray);
ASSERT_ENUM_EQUAL(kSourceAboutPage, kAboutPage);
ASSERT_ENUM_EQUAL(kSourceKeyboard, kKeyboard);
ASSERT_ENUM_EQUAL(kSourceExtensionsPage, kExtensionsPage);
ASSERT_ENUM_EQUAL(kSourceManagementApi, kManagementApi);
ASSERT_ENUM_EQUAL(kSourceEphemeralAppDeprecated, kEphemeralApp);
ASSERT_ENUM_EQUAL(kSourceBackground, kBackground);
ASSERT_ENUM_EQUAL(kSourceKiosk, kKiosk);
ASSERT_ENUM_EQUAL(kSourceChromeInternal, kChromeInternal);
ASSERT_ENUM_EQUAL(kSourceTest, kTest);
ASSERT_ENUM_EQUAL(kSourceInstalledNotification, kInstalledNotification);
ASSERT_ENUM_EQUAL(kSourceContextMenu, kContextMenu);
ASSERT_ENUM_EQUAL(kSourceArc, kArc);
ASSERT_ENUM_EQUAL(kSourceIntentUrl, kIntentUrl);
// The +3 accounts for kSourceRunOnOsLogin, kSourceProtocolHandler and
// kSourceReparenting not having a corresponding entry in
// app_runtime::LaunchSource.
static_assert(
base::to_underlying(extensions::AppLaunchSource::kMaxValue) ==
base::to_underlying(app_runtime::LaunchSource::kMaxValue) + 3,
"");
switch (source) {
case AppLaunchSource::kSourceNone:
case AppLaunchSource::kSourceUntracked:
case AppLaunchSource::kSourceAppLauncher:
case AppLaunchSource::kSourceNewTabPage:
case AppLaunchSource::kSourceReload:
case AppLaunchSource::kSourceRestart:
case AppLaunchSource::kSourceLoadAndLaunch:
case AppLaunchSource::kSourceCommandLine:
case AppLaunchSource::kSourceFileHandler:
case AppLaunchSource::kSourceUrlHandler:
case AppLaunchSource::kSourceSystemTray:
case AppLaunchSource::kSourceAboutPage:
case AppLaunchSource::kSourceKeyboard:
case AppLaunchSource::kSourceExtensionsPage:
case AppLaunchSource::kSourceManagementApi:
case AppLaunchSource::kSourceEphemeralAppDeprecated:
case AppLaunchSource::kSourceBackground:
case AppLaunchSource::kSourceKiosk:
case AppLaunchSource::kSourceChromeInternal:
case AppLaunchSource::kSourceTest:
case AppLaunchSource::kSourceInstalledNotification:
case AppLaunchSource::kSourceContextMenu:
case AppLaunchSource::kSourceArc:
case AppLaunchSource::kSourceIntentUrl:
return static_cast<app_runtime::LaunchSource>(source);
// We don't allow extensions to launch an app specifying
// kSourceRunOnOsLogin, kSourceProtocolHandler or kSourceReparenting as the
// source. In this case we map it to LaunchSource::kChromeInternal.
case AppLaunchSource::kSourceRunOnOsLogin:
case AppLaunchSource::kSourceProtocolHandler:
case AppLaunchSource::kSourceReparenting:
return app_runtime::LaunchSource::kChromeInternal;
// New enumerators must be added here. Because the three previous entries in
// AppLaunchSource are missing entries in LaunchSource, we need to subtract
// three to remain in sync with LaunchSource.
case AppLaunchSource::kSourceAppHomePage:
case AppLaunchSource::kSourceFocusMode:
case AppLaunchSource::kSourceSparky:
return static_cast<app_runtime::LaunchSource>(
base::to_underlying(source) - 3);
}
}
} // namespace
// static
void AppRuntimeEventRouter::DispatchOnEmbedRequestedEvent(
content::BrowserContext* context,
base::Value::Dict embed_app_data,
const Extension* extension) {
DispatchOnEmbedRequestedEventImpl(extension->id(), std::move(embed_app_data),
context);
}
// static
void AppRuntimeEventRouter::DispatchOnLaunchedEvent(
BrowserContext* context,
const Extension* extension,
extensions::AppLaunchSource source,
std::optional<app_runtime::LaunchData> launch_data) {
if (!launch_data) {
launch_data.emplace();
}
app_runtime::LaunchSource source_enum = GetLaunchSourceEnum(source);
if (extensions::FeatureSwitch::trace_app_source()->IsEnabled()) {
launch_data->source = source_enum;
}
DispatchOnLaunchedEventImpl(extension->id(), source_enum,
launch_data->ToValue(), context);
}
// static
void AppRuntimeEventRouter::DispatchOnRestartedEvent(
BrowserContext* context,
const Extension* extension) {
auto event = std::make_unique<Event>(events::APP_RUNTIME_ON_RESTARTED,
app_runtime::OnRestarted::kEventName,
base::Value::List(), context);
EventRouter::Get(context)->DispatchEventToExtension(extension->id(),
std::move(event));
}
// static
void AppRuntimeEventRouter::DispatchOnLaunchedEventWithFileEntries(
BrowserContext* context,
const Extension* extension,
extensions::AppLaunchSource source,
const std::string& handler_id,
const std::vector<EntryInfo>& entries,
const std::vector<GrantedFileEntry>& file_entries) {
app_runtime::LaunchSource source_enum = GetLaunchSourceEnum(source);
// TODO(sergeygs): Use the same way of creating an event (using the generated
// boilerplate) as below in DispatchOnLaunchedEventWithUrl.
base::Value::Dict launch_data;
launch_data.Set("id", handler_id);
if (extensions::FeatureSwitch::trace_app_source()->IsEnabled()) {
launch_data.Set("source", app_runtime::ToString(source_enum));
}
base::Value::List items;
DCHECK(file_entries.size() == entries.size());
for (size_t i = 0; i < file_entries.size(); ++i) {
base::Value::Dict launch_item;
// TODO: The launch item type should be documented in the idl so that this
// entire function can be strongly typed and built using an
// app_runtime::LaunchData instance.
launch_item.Set("fileSystemId", file_entries[i].filesystem_id);
launch_item.Set("baseName", file_entries[i].registered_name);
launch_item.Set("mimeType", entries[i].mime_type);
launch_item.Set("entryId", file_entries[i].id);
launch_item.Set("isDirectory", entries[i].is_directory);
items.Append(std::move(launch_item));
}
launch_data.Set("items", std::move(items));
DispatchOnLaunchedEventImpl(extension->id(), source_enum,
std::move(launch_data), context);
}
// static
void AppRuntimeEventRouter::DispatchOnLaunchedEventWithUrl(
BrowserContext* context,
const Extension* extension,
const std::string& handler_id,
const GURL& url,
const GURL& referrer_url) {
app_runtime::LaunchData launch_data;
app_runtime::LaunchSource source_enum =
app_runtime::LaunchSource::kUrlHandler;
launch_data.id = handler_id;
launch_data.url = url.spec();
launch_data.referrer_url = referrer_url.spec();
if (extensions::FeatureSwitch::trace_app_source()->IsEnabled()) {
launch_data.source = source_enum;
}
DispatchOnLaunchedEventImpl(extension->id(), source_enum,
launch_data.ToValue(), context);
}
} // namespace extensions
|