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 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762
|
// 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/event_router.h"
#include <stddef.h>
#include <algorithm>
#include <optional>
#include <string>
#include <string_view>
#include <tuple>
#include <utility>
#include "base/atomic_sequence_num.h"
#include "base/check_is_test.h"
#include "base/containers/contains.h"
#include "base/debug/crash_logging.h"
#include "base/functional/bind.h"
#include "base/metrics/histogram_functions.h"
#include "base/metrics/histogram_macros.h"
#include "base/notreached.h"
#include "base/strings/string_util.h"
#include "components/crx_file/id_util.h"
#include "content/public/browser/browser_context.h"
#include "content/public/browser/browser_task_traits.h"
#include "content/public/browser/browser_thread.h"
#include "content/public/browser/render_process_host.h"
#include "content/public/browser/service_worker_context.h"
#include "content/public/browser/storage_partition.h"
#include "extensions/browser/api_activity_monitor.h"
#include "extensions/browser/bad_message.h"
#include "extensions/browser/browser_process_context_data.h"
#include "extensions/browser/event_router_factory.h"
#include "extensions/browser/events/lazy_event_dispatcher.h"
#include "extensions/browser/extension_host.h"
#include "extensions/browser/extension_prefs.h"
#include "extensions/browser/extension_util.h"
#include "extensions/browser/extensions_browser_client.h"
#include "extensions/browser/process_manager.h"
#include "extensions/browser/process_map.h"
#include "extensions/common/constants.h"
#include "extensions/common/extension.h"
#include "extensions/common/extension_api.h"
#include "extensions/common/extension_id.h"
#include "extensions/common/extension_urls.h"
#include "extensions/common/features/feature.h"
#include "extensions/common/features/feature_provider.h"
#include "extensions/common/manifest_handlers/background_info.h"
#include "extensions/common/manifest_handlers/incognito_info.h"
#include "extensions/common/mojom/context_type.mojom.h"
#include "extensions/common/mojom/event_dispatcher.mojom.h"
#include "extensions/common/permissions/permissions_data.h"
#include "extensions/common/utils/extension_utils.h"
#include "ipc/ipc_channel_proxy.h"
#include "url/origin.h"
using content::BrowserContext;
using content::BrowserThread;
using content::RenderProcessHost;
namespace extensions {
base::TimeDelta kEventAckMetricTimeLimit = base::Minutes(5);
namespace {
// A dictionary of event names to lists of filters that this extension has
// registered from its lazy background page.
constexpr char kFilteredEvents[] = "filtered_events";
// Similar to |kFilteredEvents|, but applies to extension service worker events.
constexpr char kFilteredServiceWorkerEvents[] =
"filtered_service_worker_events";
// A message when mojom::EventRouter::AddListenerForMainThread() is called with
// an invalid param.
constexpr char kAddEventListenerWithInvalidParam[] =
"Tried to add an event listener without a valid extension ID nor listener "
"URL";
// A message when mojom::EventRouter::AddListenerForServiceWorker() is called
// with an invalid worker scope URL.
constexpr char kAddEventListenerWithInvalidWorkerScopeURL[] =
"Tried to add an event listener for a service worker without a valid "
"worker scope URL.";
// A message when mojom::EventRouter::AddListenerForServiceWorker() is called
// with an invalid extension ID.
constexpr char kAddEventListenerWithInvalidExtensionID[] =
"Tried to add an event listener for a service worker without a valid "
"extension ID.";
// A message when mojom::EventRouter::RemoveListenerForMainThread() is called
// with an invalid param.
constexpr char kRemoveEventListenerWithInvalidParam[] =
"Tried to remove an event listener without a valid extension ID nor "
"listener URL";
// A message when mojom::EventRouter::RemoveListenerForServiceWorker() is called
// with an invalid worker scope URL.
constexpr char kRemoveEventListenerWithInvalidWorkerScopeURL[] =
"Tried to remove an event listener for a service worker without a valid "
"worker scope URL.";
// A message when mojom::EventRouter::RemoveListenerForServiceWorker() is called
// with an invalid extension ID.
constexpr char kRemoveEventListenerWithInvalidExtensionID[] =
"Tried to remove an event listener for a service worker without a valid "
"extension ID.";
// Sends a notification about an event to the API activity monitor and the
// ExtensionHost for |extension_id| on the UI thread. Can be called from any
// thread.
void NotifyEventDispatched(content::BrowserContext* browser_context,
const ExtensionId& extension_id,
const std::string& event_name,
const base::Value::List& args) {
// Notify the ApiActivityMonitor about the event dispatch.
activity_monitor::OnApiEventDispatched(browser_context, extension_id,
event_name, args);
}
// Browser context is required for lazy context id. Before adding browser
// context member to EventListener, callers must pass in the browser context as
// a parameter.
// TODO(richardzh): Once browser context is added as a member to EventListener,
// update this method to get browser_context from listener
// instead of parameter.
LazyContextId LazyContextIdForListener(const EventListener* listener,
BrowserContext* browser_context) {
auto* registry = ExtensionRegistry::Get(browser_context);
DCHECK(registry);
const Extension* extension =
registry->enabled_extensions().GetByID(listener->extension_id());
const bool is_service_worker_based_extension =
extension && BackgroundInfo::IsServiceWorkerBased(extension);
// Note: It is possible that the prefs' listener->is_for_service_worker() and
// its extension background type do not agree. This happens when one changes
// extension's manifest, typically during unpacked extension development.
// Fallback to non-Service worker based LazyContextId to avoid surprising
// ServiceWorkerTaskQueue (and crashing), see https://crbug.com/1239752 for
// details.
// TODO(lazyboy): Clean these inconsistencies across different types of event
// listener and their corresponding background types.
if (is_service_worker_based_extension && listener->is_for_service_worker()) {
return LazyContextId::ForServiceWorker(browser_context,
listener->extension_id());
}
return LazyContextId::ForBackgroundPage(browser_context,
listener->extension_id());
}
// A global identifier used to distinguish extension events.
base::AtomicSequenceNumber g_extension_event_id;
// Returns whether an event would cross the incognito boundary. e.g.
// incognito->regular or regular->incognito. This is allowed for some extensions
// that enable spanning-mode but is always disallowed for webUI.
// |context| refers to the BrowserContext of the receiver of the event.
bool CrossesIncognito(BrowserContext* context, const Event& event) {
return event.restrict_to_browser_context &&
context != event.restrict_to_browser_context;
}
base::debug::CrashKeyString* GetEventNameCrashKey() {
static auto* crash_key = base::debug::AllocateCrashKeyString(
"ext_event_name", base::debug::CrashKeySize::Size256);
return crash_key;
}
} // namespace
namespace debug {
// Helper for adding a crash keys for dispatching an extension event over mojom.
//
// It is created each time an event is sent from the browser to the renderer
// process via the EventDispatcher::DispatchEvent interface.
//
// All keys are logged every time this class is instantiated.
class ScopedOOMCrashKey {
public:
explicit ScopedOOMCrashKey(const std::string& event_name)
: event_name_crash_key_(GetEventNameCrashKey(), event_name) {}
~ScopedOOMCrashKey() = default;
private:
// Extension API event name.
base::debug::ScopedCrashKeyString event_name_crash_key_;
};
} // namespace debug
const char EventRouter::kRegisteredLazyEvents[] = "events";
const char EventRouter::kRegisteredServiceWorkerEvents[] =
"serviceworkerevents";
void EventRouter::DispatchExtensionMessage(
content::RenderProcessHost* rph,
int worker_thread_id,
content::BrowserContext* browser_context,
const mojom::HostID& host_id,
int event_id,
const std::string& event_name,
base::Value::List event_args,
UserGestureState user_gesture,
mojom::EventFilteringInfoPtr info,
mojom::EventDispatcher::DispatchEventCallback callback) {
if (host_id.type == mojom::HostID::HostType::kExtensions) {
NotifyEventDispatched(browser_context,
GenerateExtensionIdFromHostId(host_id), event_name,
event_args);
}
auto params = mojom::DispatchEventParams::New();
params->worker_thread_id = worker_thread_id;
params->host_id = host_id.Clone();
params->event_name = event_name;
params->event_id = event_id;
params->is_user_gesture = user_gesture == UserGestureState::kEnabled;
params->filtering_info = std::move(info);
RouteDispatchEvent(rph, std::move(params), std::move(event_args),
std::move(callback));
}
void EventRouter::RouteDispatchEvent(
content::RenderProcessHost* rph,
mojom::DispatchEventParamsPtr params,
base::Value::List event_args,
mojom::EventDispatcher::DispatchEventCallback callback) {
CHECK(base::Contains(observed_process_set_, rph));
int worker_thread_id = params->worker_thread_id;
mojo::AssociatedRemote<mojom::EventDispatcher>& dispatcher =
rph_dispatcher_map_[rph][worker_thread_id];
if (!dispatcher.is_bound()) {
if (worker_thread_id == kMainThreadId) {
IPC::ChannelProxy* channel = rph->GetChannel();
if (!channel) {
return;
}
channel->GetRemoteAssociatedInterface(
dispatcher.BindNewEndpointAndPassReceiver());
} else {
// EventDispatcher for worker threads should be bound at
// `BindServiceWorkerEventDispatcher`.
return;
}
}
// The RenderProcessHost might be dead, but if the RenderProcessHost
// is alive then the dispatcher must be connected.
CHECK(!rph->IsInitializedAndNotDead() || dispatcher.is_connected());
debug::ScopedOOMCrashKey oom_crash_key(params->event_name);
dispatcher->DispatchEvent(std::move(params), std::move(event_args),
std::move(callback));
}
// static
EventRouter* EventRouter::Get(content::BrowserContext* browser_context) {
return EventRouterFactory::GetForBrowserContext(browser_context);
}
// static
std::string EventRouter::GetBaseEventName(const std::string& full_event_name) {
size_t slash_sep = full_event_name.find('/');
return full_event_name.substr(0, slash_sep);
}
void EventRouter::DispatchEventToSender(
content::RenderProcessHost* rph,
content::BrowserContext* browser_context,
const mojom::HostID& host_id,
events::HistogramValue histogram_value,
const std::string& event_name,
int worker_thread_id,
int64_t service_worker_version_id,
base::Value::List event_args,
mojom::EventFilteringInfoPtr info) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
int event_id = g_extension_event_id.GetNext();
auto* registry = ExtensionRegistry::Get(browser_context);
CHECK(registry);
const Extension* extension = nullptr;
if (host_id.type == mojom::HostID::HostType::kExtensions) {
extension = registry->enabled_extensions().GetByID(host_id.id);
}
if (!extension) {
for (TestObserver& observer : test_observers_) {
observer.OnNonExtensionEventDispatched(event_name);
}
ObserveProcess(rph);
DispatchExtensionMessage(rph, worker_thread_id, browser_context, host_id,
event_id, event_name, std::move(event_args),
UserGestureState::kUnknown, std::move(info),
base::DoNothing());
// In this case, we won't log the metric for dispatch_start_time. But this
// means we aren't dispatching an event to an extension so the metric
// wouldn't be relevant anyways (e.g. would go to a web page or webUI).
return;
}
IncrementInFlightEvents(
browser_context, rph, extension, event_id, event_name,
// Currently `dispatch_start_time`, `lazy_background_active_on_dispatch`,
// and `histogram_value` args are not used for metrics recording since we
// do not include events from EventDispatchSource::kDispatchEventToSender.
/*dispatch_start_time=*/base::TimeTicks::Now(), service_worker_version_id,
EventDispatchSource::kDispatchEventToSender,
// Background script is active/started at this point.
/*lazy_background_active_on_dispatch=*/true,
events::HistogramValue::UNKNOWN);
ReportEvent(histogram_value, extension,
/*did_enqueue=*/false);
mojom::EventDispatcher::DispatchEventCallback callback;
if (worker_thread_id != kMainThreadId) {
callback = base::BindOnce(
&EventRouter::DecrementInFlightEventsForServiceWorker,
weak_factory_.GetWeakPtr(),
WorkerId{GenerateExtensionIdFromHostId(host_id), rph->GetDeprecatedID(),
service_worker_version_id, worker_thread_id},
event_id);
} else if (BackgroundInfo::HasBackgroundPage(extension)) {
// TODO(crbug.com/40909770): When creating dispatch time metrics for the
// DispatchEventToSender event flow, ensure this also handles persistent
// background pages.
// Although it's unnecessary to decrement in-flight events for non-lazy
// background pages, we use the logic for event tracking/metrics purposes.
callback =
base::BindOnce(&EventRouter::DecrementInFlightEventsForRenderFrameHost,
weak_factory_.GetWeakPtr(), rph->GetDeprecatedID(),
host_id.id, event_id);
} else {
callback = base::DoNothing();
}
ObserveProcess(rph);
DispatchExtensionMessage(rph, worker_thread_id, browser_context, host_id,
event_id, event_name, std::move(event_args),
UserGestureState::kUnknown, std::move(info),
std::move(callback));
}
// static.
bool EventRouter::CanDispatchEventToBrowserContext(BrowserContext* context,
const Extension* extension,
const Event& event) {
// Is this event from a different browser context than the renderer (ie, an
// incognito tab event sent to a normal process, or vice versa).
bool crosses_incognito = CrossesIncognito(context, event);
if (!crosses_incognito) {
return true;
}
return ExtensionsBrowserClient::Get()->CanExtensionCrossIncognito(extension,
context);
}
// static
void EventRouter::BindForRenderer(
int render_process_id,
mojo::PendingAssociatedReceiver<mojom::EventRouter> receiver) {
auto* host = RenderProcessHost::FromID(render_process_id);
if (!host) {
return;
}
// EventRouter might be null for some irregular profile, e.g. the System
// Profile.
EventRouter* event_router = EventRouter::Get(host->GetBrowserContext());
if (!event_router) {
return;
}
event_router->receivers_.Add(event_router, std::move(receiver),
render_process_id);
}
void EventRouter::SwapReceiverForTesting(int render_process_id,
mojom::EventRouter* new_impl) {
std::map<mojo::ReceiverId, int*> receiver_contexts =
receivers_.GetAllContexts();
// We don't have the ReceiverId for the receiver stored anywhere, so loop
// through existing receivers to find the ReceiverId and use it to find the
// correct receiver to swap for testing.
for (auto& [receiver_id, render_process_id_ptr] :
receivers_.GetAllContexts()) {
if (render_process_id_ptr && *render_process_id_ptr == render_process_id) {
std::ignore =
receivers_.SwapImplForTesting(receiver_id, new_impl); // IN-TEST
return;
}
}
// There was no receiver to swap, maybe it was destroyed before this method
// was called?
NOTREACHED();
}
EventRouter::EventRouter(BrowserContext* browser_context,
ExtensionPrefs* extension_prefs)
: browser_context_(browser_context),
extension_prefs_(extension_prefs),
lazy_event_dispatch_util_(browser_context_) {
extension_registry_observation_.Observe(
ExtensionRegistry::Get(browser_context_));
process_manager_observation_.Observe(ProcessManager::Get(browser_context_));
}
EventRouter::~EventRouter() {
for (content::RenderProcessHost* process : observed_process_set_) {
process->RemoveObserver(this);
}
}
content::RenderProcessHost*
EventRouter::GetRenderProcessHostForCurrentReceiver() {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
auto* process = RenderProcessHost::FromID(receivers_.current_context());
// process might be nullptr when IPC race with RenderProcessHost destruction.
// This may only happen in scenarios that are already inherently racy, so
// returning nullptr (and dropping the IPC) is okay and won't lead to any
// additional risk of data loss.
return process;
}
BrowserContext* EventRouter::GetIncognitoContextIfAccessible(
const ExtensionId& extension_id) {
DCHECK(!extension_id.empty());
const Extension* extension = ExtensionRegistry::Get(browser_context_)
->enabled_extensions()
.GetByID(extension_id);
if (!extension) {
return nullptr;
}
if (!IncognitoInfo::IsSplitMode(extension)) {
return nullptr;
}
if (!util::IsIncognitoEnabled(extension_id, browser_context_)) {
return nullptr;
}
return GetIncognitoContext();
}
BrowserContext* EventRouter::GetIncognitoContext() {
ExtensionsBrowserClient* browser_client = ExtensionsBrowserClient::Get();
if (!browser_client->HasOffTheRecordContext(browser_context_)) {
return nullptr;
}
return browser_client->GetOffTheRecordContext(browser_context_);
}
void EventRouter::AddListenerForMainThread(
mojom::EventListenerPtr event_listener) {
auto* process = GetRenderProcessHostForCurrentReceiver();
if (!process) {
return;
}
const mojom::EventListenerOwner& listener_owner =
*event_listener->listener_owner;
if (listener_owner.is_extension_id()) {
AddEventListener(event_listener->event_name, process,
listener_owner.get_extension_id());
} else if (listener_owner.is_listener_url() &&
listener_owner.get_listener_url().is_valid()) {
AddEventListenerForURL(event_listener->event_name, process,
listener_owner.get_listener_url());
} else {
mojo::ReportBadMessage(kAddEventListenerWithInvalidParam);
}
}
void EventRouter::AddListenerForServiceWorker(
mojom::EventListenerPtr event_listener) {
auto* process = GetRenderProcessHostForCurrentReceiver();
if (!process) {
return;
}
const mojom::EventListenerOwner& listener_owner =
*event_listener->listener_owner;
if (!listener_owner.is_extension_id()) {
mojo::ReportBadMessage(kAddEventListenerWithInvalidExtensionID);
return;
}
if (!event_listener->service_worker_context->scope_url.is_valid()) {
mojo::ReportBadMessage(kAddEventListenerWithInvalidWorkerScopeURL);
return;
}
AddServiceWorkerEventListener(std::move(event_listener), process);
}
void EventRouter::AddLazyListenerForMainThread(const ExtensionId& extension_id,
const std::string& event_name) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
std::unique_ptr<EventListener> listener = EventListener::CreateLazyListener(
event_name, extension_id, browser_context_, false, GURL(), std::nullopt);
AddLazyEventListenerImpl(std::move(listener), RegisteredEventType::kLazy);
}
void EventRouter::AddLazyListenerForServiceWorker(
const ExtensionId& extension_id,
const GURL& worker_scope_url,
const std::string& event_name) {
// TODO(richardzh): Passing in browser context from the process.
// Browser context is added to listener object in order to separate lazy
// listeners for regular and incognito(split) context. The first step adds
// browser context member to EventListener object. The next step is to
// assign correct browser context and use it to create both lazy
// listeners.
std::unique_ptr<EventListener> listener = EventListener::CreateLazyListener(
event_name, extension_id, browser_context_,
/*is_for_service_worker=*/true, worker_scope_url,
/*filter=*/std::nullopt);
AddLazyEventListenerImpl(std::move(listener),
RegisteredEventType::kServiceWorker);
}
void EventRouter::AddFilteredListenerForMainThread(
mojom::EventListenerOwnerPtr listener_owner,
const std::string& event_name,
base::Value::Dict filter,
bool add_lazy_listener) {
auto* process = GetRenderProcessHostForCurrentReceiver();
if (!process) {
return;
}
AddFilteredEventListener(event_name, process, std::move(listener_owner),
nullptr, std::move(filter), add_lazy_listener);
}
void EventRouter::AddFilteredListenerForServiceWorker(
const ExtensionId& extension_id,
const std::string& event_name,
mojom::ServiceWorkerContextPtr service_worker_context,
base::Value::Dict filter,
bool add_lazy_listener) {
auto* process = GetRenderProcessHostForCurrentReceiver();
if (!process) {
return;
}
AddFilteredEventListener(
event_name, process,
mojom::EventListenerOwner::NewExtensionId(extension_id),
service_worker_context.get(), std::move(filter), add_lazy_listener);
}
void EventRouter::RemoveListenerForMainThread(
mojom::EventListenerPtr event_listener) {
auto* process = GetRenderProcessHostForCurrentReceiver();
if (!process) {
return;
}
const mojom::EventListenerOwner& listener_owner =
*event_listener->listener_owner;
if (listener_owner.is_extension_id()) {
RemoveEventListener(event_listener->event_name, process,
listener_owner.get_extension_id());
} else if (listener_owner.is_listener_url() &&
listener_owner.get_listener_url().is_valid()) {
RemoveEventListenerForURL(event_listener->event_name, process,
listener_owner.get_listener_url());
} else {
mojo::ReportBadMessage(kRemoveEventListenerWithInvalidParam);
}
}
void EventRouter::RemoveListenerForServiceWorker(
mojom::EventListenerPtr event_listener) {
auto* process = GetRenderProcessHostForCurrentReceiver();
if (!process) {
return;
}
const mojom::EventListenerOwner& listener_owner =
*event_listener->listener_owner;
if (!listener_owner.is_extension_id()) {
mojo::ReportBadMessage(kRemoveEventListenerWithInvalidExtensionID);
return;
}
if (!event_listener->service_worker_context->scope_url.is_valid()) {
mojo::ReportBadMessage(kRemoveEventListenerWithInvalidWorkerScopeURL);
return;
}
RemoveServiceWorkerEventListener(std::move(event_listener), process);
}
void EventRouter::RemoveLazyListenerForMainThread(
const ExtensionId& extension_id,
const std::string& event_name) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
std::unique_ptr<EventListener> listener = EventListener::CreateLazyListener(
event_name, extension_id, browser_context_, false, GURL(), std::nullopt);
RemoveLazyEventListenerImpl(std::move(listener), RegisteredEventType::kLazy);
}
void EventRouter::RemoveLazyListenerForServiceWorker(
const ExtensionId& extension_id,
const GURL& worker_scope_url,
const std::string& event_name) {
// TODO(richardzh): Passing in browser context from the process.
// Browser context is added to listener object in order to separate lazy
// listeners for regular and incognito(split) context. The first step adds
// browser context member to EventListener object. The next step is to
// assign correct browser context and use it to create both lazy
// listeners.
std::unique_ptr<EventListener> listener = EventListener::CreateLazyListener(
event_name, extension_id, browser_context_, true, worker_scope_url,
std::nullopt);
RemoveLazyEventListenerImpl(std::move(listener),
RegisteredEventType::kServiceWorker);
}
void EventRouter::RemoveFilteredListenerForMainThread(
mojom::EventListenerOwnerPtr listener_owner,
const std::string& event_name,
base::Value::Dict filter,
bool remove_lazy_listener) {
auto* process = GetRenderProcessHostForCurrentReceiver();
if (!process) {
return;
}
RemoveFilteredEventListener(event_name, process, std::move(listener_owner),
nullptr, std::move(filter), remove_lazy_listener);
}
void EventRouter::RemoveFilteredListenerForServiceWorker(
const ExtensionId& extension_id,
const std::string& event_name,
mojom::ServiceWorkerContextPtr service_worker_context,
base::Value::Dict filter,
bool remove_lazy_listener) {
auto* process = GetRenderProcessHostForCurrentReceiver();
if (!process) {
return;
}
RemoveFilteredEventListener(
event_name, process,
mojom::EventListenerOwner::NewExtensionId(extension_id),
service_worker_context.get(), std::move(filter), remove_lazy_listener);
}
void EventRouter::AddEventListener(const std::string& event_name,
RenderProcessHost* process,
const ExtensionId& extension_id) {
listeners_.AddListener(EventListener::ForExtension(event_name, extension_id,
process, std::nullopt));
CHECK(base::Contains(observed_process_set_, process));
}
void EventRouter::AddServiceWorkerEventListener(
mojom::EventListenerPtr event_listener,
RenderProcessHost* process) {
const mojom::ServiceWorkerContext& service_worker =
*event_listener->service_worker_context;
listeners_.AddListener(EventListener::ForExtensionServiceWorker(
event_listener->event_name,
event_listener->listener_owner->get_extension_id(), process,
process->GetBrowserContext(), service_worker.scope_url,
service_worker.version_id, service_worker.thread_id, std::nullopt));
CHECK(base::Contains(observed_process_set_, process));
}
void EventRouter::RemoveEventListener(const std::string& event_name,
RenderProcessHost* process,
const ExtensionId& extension_id) {
std::unique_ptr<EventListener> listener = EventListener::ForExtension(
event_name, extension_id, process, std::nullopt);
listeners_.RemoveListener(listener.get());
}
void EventRouter::RemoveServiceWorkerEventListener(
mojom::EventListenerPtr event_listener,
RenderProcessHost* process) {
const mojom::ServiceWorkerContext& service_worker =
*event_listener->service_worker_context;
std::unique_ptr<EventListener> listener =
EventListener::ForExtensionServiceWorker(
event_listener->event_name,
event_listener->listener_owner->get_extension_id(), process,
process->GetBrowserContext(), service_worker.scope_url,
service_worker.version_id, service_worker.thread_id, std::nullopt);
listeners_.RemoveListener(listener.get());
}
void EventRouter::AddEventListenerForURL(const std::string& event_name,
RenderProcessHost* process,
const GURL& listener_url) {
listeners_.AddListener(
EventListener::ForURL(event_name, listener_url, process, std::nullopt));
CHECK(base::Contains(observed_process_set_, process));
}
void EventRouter::RemoveEventListenerForURL(const std::string& event_name,
RenderProcessHost* process,
const GURL& listener_url) {
std::unique_ptr<EventListener> listener =
EventListener::ForURL(event_name, listener_url, process, std::nullopt);
listeners_.RemoveListener(listener.get());
}
void EventRouter::RegisterObserver(Observer* observer,
const std::string& event_name) {
// Observing sub-event names like "foo.onBar/123" is not allowed.
DCHECK(!base::Contains(event_name, '/'));
auto& observers = observer_map_[event_name];
if (!observers) {
observers = std::make_unique<Observers>();
}
observers->AddObserver(observer);
}
void EventRouter::UnregisterObserver(Observer* observer) {
for (auto& it : observer_map_) {
it.second->RemoveObserver(observer);
}
}
void EventRouter::AddObserverForTesting(TestObserver* observer) {
test_observers_.AddObserver(observer);
}
void EventRouter::RemoveObserverForTesting(TestObserver* observer) {
test_observers_.RemoveObserver(observer);
}
void EventRouter::OnListenerAdded(const EventListener* listener) {
RenderProcessHost* process = listener->process();
if (process) {
ObserveProcess(process);
}
const EventListenerInfo details(
listener->event_name(), listener->extension_id(),
listener->listener_url(), listener->browser_context(),
listener->worker_thread_id(), listener->service_worker_version_id(),
listener->IsLazy());
std::string base_event_name = GetBaseEventName(listener->event_name());
auto it = observer_map_.find(base_event_name);
if (it != observer_map_.end()) {
for (auto& observer : *it->second) {
observer.OnListenerAdded(details);
}
}
}
void EventRouter::OnListenerRemoved(const EventListener* listener) {
const EventListenerInfo details(
listener->event_name(), listener->extension_id(),
listener->listener_url(), listener->browser_context(),
listener->worker_thread_id(), listener->service_worker_version_id(),
listener->IsLazy());
std::string base_event_name = GetBaseEventName(listener->event_name());
auto it = observer_map_.find(base_event_name);
if (it != observer_map_.end()) {
for (auto& observer : *it->second) {
observer.OnListenerRemoved(details);
}
}
}
void EventRouter::ObserveProcess(RenderProcessHost* process) {
CHECK(process);
bool inserted = observed_process_set_.insert(process).second;
if (inserted) {
process->AddObserver(this);
}
}
void EventRouter::RenderProcessExited(
RenderProcessHost* host,
const content::ChildProcessTerminationInfo& info) {
listeners_.RemoveListenersForProcess(host);
event_ack_data_.ClearUnackedEventsForRenderProcess(host->GetDeprecatedID());
observed_process_set_.erase(host);
rph_dispatcher_map_.erase(host);
host->RemoveObserver(this);
}
void EventRouter::RenderProcessHostDestroyed(RenderProcessHost* host) {
listeners_.RemoveListenersForProcess(host);
event_ack_data_.ClearUnackedEventsForRenderProcess(host->GetDeprecatedID());
observed_process_set_.erase(host);
rph_dispatcher_map_.erase(host);
host->RemoveObserver(this);
}
void EventRouter::AddFilteredEventListener(
const std::string& event_name,
RenderProcessHost* process,
mojom::EventListenerOwnerPtr listener_owner,
mojom::ServiceWorkerContext* service_worker_context,
const base::Value::Dict& filter,
bool add_lazy_listener) {
const bool is_for_service_worker = !!service_worker_context;
std::unique_ptr<EventListener> regular_listener;
std::unique_ptr<EventListener> lazy_listener;
if (is_for_service_worker && listener_owner->is_extension_id()) {
regular_listener = EventListener::ForExtensionServiceWorker(
event_name, listener_owner->get_extension_id(), process,
process->GetBrowserContext(), service_worker_context->scope_url,
service_worker_context->version_id, service_worker_context->thread_id,
filter.Clone());
if (add_lazy_listener) {
// TODO(richardzh): take browser context from the process instead of the
// regular browser context attached to the event router. Browser context
// is introduced to listener in order to separate lazy listeners for
// regular and incognito(split) context. The first step is adding the
// browser context as a member of EventListener object. The next step is
// to assign correct browser context and use it to create both lazy
// listeners.
lazy_listener = EventListener::CreateLazyListener(
event_name, listener_owner->get_extension_id(), browser_context_,
true, service_worker_context->scope_url, filter.Clone());
}
} else if (listener_owner->is_extension_id()) {
regular_listener = EventListener::ForExtension(
event_name, listener_owner->get_extension_id(), process,
filter.Clone());
if (add_lazy_listener) {
lazy_listener = EventListener::CreateLazyListener(
event_name, listener_owner->get_extension_id(), browser_context_,
false, GURL(), filter.Clone());
}
} else if (listener_owner->is_listener_url() && !add_lazy_listener) {
regular_listener =
EventListener::ForURL(event_name, listener_owner->get_listener_url(),
process, filter.Clone());
} else {
mojo::ReportBadMessage(kAddEventListenerWithInvalidParam);
return;
}
listeners_.AddListener(std::move(regular_listener));
CHECK(base::Contains(observed_process_set_, process));
DCHECK_EQ(add_lazy_listener, !!lazy_listener);
if (lazy_listener) {
bool added = listeners_.AddListener(std::move(lazy_listener));
if (added) {
AddFilterToEvent(event_name, listener_owner->get_extension_id(),
is_for_service_worker, filter);
}
}
}
void EventRouter::RemoveFilteredEventListener(
const std::string& event_name,
RenderProcessHost* process,
mojom::EventListenerOwnerPtr listener_owner,
mojom::ServiceWorkerContext* service_worker_context,
const base::Value::Dict& filter,
bool remove_lazy_listener) {
const bool is_for_service_worker = !!service_worker_context;
std::unique_ptr<EventListener> listener;
if (is_for_service_worker && listener_owner->is_extension_id()) {
listener = EventListener::ForExtensionServiceWorker(
event_name, listener_owner->get_extension_id(), process,
process->GetBrowserContext(), service_worker_context->scope_url,
service_worker_context->version_id, service_worker_context->thread_id,
filter.Clone());
} else if (listener_owner->is_extension_id()) {
listener = EventListener::ForExtension(event_name,
listener_owner->get_extension_id(),
process, filter.Clone());
} else if (listener_owner->is_listener_url() && !remove_lazy_listener) {
listener =
EventListener::ForURL(event_name, listener_owner->get_listener_url(),
process, filter.Clone());
} else {
mojo::ReportBadMessage(kRemoveEventListenerWithInvalidParam);
return;
}
listeners_.RemoveListener(listener.get());
if (remove_lazy_listener) {
listener->MakeLazy();
bool removed = listeners_.RemoveListener(listener.get());
if (removed) {
RemoveFilterFromEvent(event_name, listener_owner->get_extension_id(),
is_for_service_worker, filter);
}
}
}
bool EventRouter::HasEventListener(const std::string& event_name) const {
return listeners_.HasListenerForEvent(event_name);
}
bool EventRouter::ExtensionHasEventListener(
const ExtensionId& extension_id,
const std::string& event_name) const {
return listeners_.HasListenerForExtension(extension_id, event_name);
}
bool EventRouter::URLHasEventListener(const GURL& url,
const std::string& event_name) const {
return listeners_.HasListenerForURL(url, event_name);
}
std::set<std::string> EventRouter::GetRegisteredEvents(
const ExtensionId& extension_id,
RegisteredEventType type) const {
std::set<std::string> events;
if (!extension_prefs_) {
return events;
}
const char* pref_key = type == RegisteredEventType::kLazy
? kRegisteredLazyEvents
: kRegisteredServiceWorkerEvents;
const base::Value::List* events_value =
extension_prefs_->ReadPrefAsList(extension_id, pref_key);
if (!events_value) {
return events;
}
for (const base::Value& event_val : *events_value) {
const std::string* event = event_val.GetIfString();
if (event) {
events.insert(*event);
}
}
return events;
}
void EventRouter::ClearRegisteredEventsForTest(
const ExtensionId& extension_id) {
SetRegisteredEvents(extension_id, std::set<std::string>(),
RegisteredEventType::kLazy);
SetRegisteredEvents(extension_id, std::set<std::string>(),
RegisteredEventType::kServiceWorker);
}
bool EventRouter::HasLazyEventListenerForTesting(
const std::string& event_name) {
const EventListenerMap::ListenerList& listeners =
listeners_.GetEventListenersByName(event_name);
return std::ranges::any_of(
listeners, [](const std::unique_ptr<EventListener>& listener) {
return listener->IsLazy();
});
}
bool EventRouter::HasNonLazyEventListenerForTesting(
const std::string& event_name) {
const EventListenerMap::ListenerList& listeners =
listeners_.GetEventListenersByName(event_name);
return std::ranges::any_of(
listeners, [](const std::unique_ptr<EventListener>& listener) {
return !listener->IsLazy();
});
}
void EventRouter::RemoveFilterFromEvent(const std::string& event_name,
const ExtensionId& extension_id,
bool is_for_service_worker,
const base::Value::Dict& filter) {
ExtensionPrefs::ScopedDictionaryUpdate update(
extension_prefs_, extension_id,
is_for_service_worker ? kFilteredServiceWorkerEvents : kFilteredEvents);
auto filtered_events = update.Create();
base::Value::List* filter_list = nullptr;
if (!filtered_events ||
!filtered_events->GetListWithoutPathExpansion(event_name, &filter_list)) {
return;
}
const base::Value::Dict& (base::Value::*get_dict)() const =
&base::Value::GetDict;
filter_list->erase(std::ranges::find(*filter_list, filter, get_dict));
}
const base::Value::Dict* EventRouter::GetFilteredEvents(
const ExtensionId& extension_id,
RegisteredEventType type) {
const char* pref_key = type == RegisteredEventType::kLazy
? kFilteredEvents
: kFilteredServiceWorkerEvents;
return extension_prefs_->ReadPrefAsDict(extension_id, pref_key);
}
void EventRouter::BroadcastEvent(std::unique_ptr<Event> event) {
DispatchEventImpl(std::string(), GURL(), std::move(event));
}
void EventRouter::DispatchEventToExtension(const ExtensionId& extension_id,
std::unique_ptr<Event> event) {
DCHECK(!extension_id.empty());
DispatchEventImpl(extension_id, GURL(), std::move(event));
}
void EventRouter::DispatchEventToURL(const GURL& url,
std::unique_ptr<Event> event) {
DCHECK(!url.is_empty());
DispatchEventImpl(std::string(), url, std::move(event));
}
void EventRouter::DispatchEventWithLazyListener(const ExtensionId& extension_id,
std::unique_ptr<Event> event) {
// This method calls multiple mojom::EventRouter implementations. Ensure the
// id is valid before we proceed.
CHECK(crx_file::id_util::IdIsValid(extension_id));
const Extension* extension = ExtensionRegistry::Get(browser_context_)
->enabled_extensions()
.GetByID(extension_id);
if (!extension) {
return;
}
const bool is_service_worker_based_background =
BackgroundInfo::IsServiceWorkerBased(extension);
std::string event_name = event->event_name;
const bool has_listener = ExtensionHasEventListener(extension_id, event_name);
if (!has_listener) {
if (is_service_worker_based_background) {
AddLazyListenerForServiceWorker(
extension_id, Extension::GetBaseURLFromExtensionId(extension_id),
event_name);
} else {
AddLazyListenerForMainThread(extension_id, event_name);
}
}
DispatchEventToExtension(extension_id, std::move(event));
if (!has_listener) {
if (is_service_worker_based_background) {
RemoveLazyListenerForServiceWorker(
extension_id, Extension::GetBaseURLFromExtensionId(extension_id),
event_name);
} else {
RemoveLazyListenerForMainThread(extension_id, event_name);
}
}
}
void EventRouter::DispatchEventImpl(const std::string& restrict_to_extension_id,
const GURL& restrict_to_url,
std::unique_ptr<Event> event) {
event->dispatch_start_time = base::TimeTicks::Now();
DCHECK(event);
// We don't expect to get events from a completely different browser context.
DCHECK(!event->restrict_to_browser_context ||
ExtensionsBrowserClient::Get()->IsSameContext(
browser_context_, event->restrict_to_browser_context));
// Don't dispatch events to observers if the browser is shutting down.
if (browser_context_->ShutdownStarted()) {
return;
}
for (TestObserver& observer : test_observers_)
observer.OnWillDispatchEvent(*event);
std::set<const EventListener*> listeners(
listeners_.GetEventListeners(*event));
LazyEventDispatcher lazy_event_dispatcher(
browser_context_, base::BindRepeating(&EventRouter::DispatchPendingEvent,
weak_factory_.GetWeakPtr()));
// We dispatch events for lazy background pages first because attempting to do
// so will cause those that are being suspended to cancel that suspension.
// As canceling a suspension entails sending an event to the affected
// background page, and as that event needs to be delivered before we dispatch
// the event we are dispatching here, we dispatch to the lazy listeners here
// first.
for (const EventListener* listener : listeners) {
if (!restrict_to_extension_id.empty() &&
restrict_to_extension_id != listener->extension_id()) {
continue;
}
if (!restrict_to_url.is_empty() &&
!url::IsSameOriginWith(restrict_to_url, listener->listener_url())) {
continue;
}
if (!listener->IsLazy()) {
continue;
}
// TODO(richardzh): Move cross browser context check (by calling
// EventRouter::CanDispatchEventToBrowserContext) from
// LazyEventDispatcher to here. So the check happens before instead of
// during the dispatch.
// Lazy listeners don't have a process, take the stored browser context
// for lazy context.
lazy_event_dispatcher.Dispatch(
*event, LazyContextIdForListener(listener, browser_context_),
listener->filter());
// Dispatch to lazy listener in the incognito context.
// We need to use the incognito context in the case of split-mode
// extensions.
BrowserContext* incognito_context =
GetIncognitoContextIfAccessible(listener->extension_id());
if (incognito_context) {
lazy_event_dispatcher.Dispatch(
*event, LazyContextIdForListener(listener, incognito_context),
listener->filter());
}
}
for (const EventListener* listener : listeners) {
if (!restrict_to_extension_id.empty() &&
restrict_to_extension_id != listener->extension_id()) {
continue;
}
if (!restrict_to_url.is_empty() &&
!url::IsSameOriginWith(restrict_to_url, listener->listener_url())) {
continue;
}
if (listener->IsLazy()) {
continue;
}
// Non-lazy listeners take the process browser context for
// lazy context
if (lazy_event_dispatcher.HasAlreadyDispatched(LazyContextIdForListener(
listener, listener->process()->GetBrowserContext()))) {
continue;
}
DispatchEventToProcess(
listener->extension_id(), listener->listener_url(), listener->process(),
listener->service_worker_version_id(), listener->worker_thread_id(),
*event, listener->filter(), false /* did_enqueue */);
}
}
void EventRouter::DispatchEventToProcess(
const ExtensionId& extension_id,
const GURL& listener_url,
RenderProcessHost* process,
int64_t service_worker_version_id,
int worker_thread_id,
const Event& event,
const base::Value::Dict* listener_filter,
bool did_enqueue) {
BrowserContext* listener_context = process->GetBrowserContext();
ProcessMap* process_map = ProcessMap::Get(listener_context);
// NOTE: |extension| being NULL does not necessarily imply that this event
// shouldn't be dispatched. Events can be dispatched to WebUI and webviews as
// well. It all depends on what GetMostLikelyContextType returns.
const Extension* extension =
ExtensionRegistry::Get(browser_context_)->enabled_extensions().GetByID(
extension_id);
if (!extension && !extension_id.empty()) {
// Trying to dispatch an event to an extension that doesn't exist. The
// extension could have been removed, but we do not unregister it until the
// extension process is unloaded.
return;
}
if (extension) {
// Extension-specific checks.
// Firstly, if the event is for a URL, the Extension must have permission
// to access that URL.
if (!event.event_url.is_empty() &&
event.event_url.host() != extension->id() && // event for self is ok
!extension->permissions_data()
->active_permissions()
.HasEffectiveAccessToURL(event.event_url)) {
return;
}
// Secondly, if the event is for incognito mode, the Extension must be
// enabled in incognito mode.
if (!CanDispatchEventToBrowserContext(listener_context, extension, event)) {
return;
}
} else {
// Non-extension (e.g. WebUI and web pages) checks. In general we don't
// allow context-bound events to cross the incognito barrier.
if (CrossesIncognito(listener_context, event)) {
return;
}
}
// TODO(ortuno): |listener_url| is passed in from the renderer so it can't
// fully be trusted. We should retrieve the URL from the browser process.
const GURL* url =
service_worker_version_id == blink::mojom::kInvalidServiceWorkerVersionId
? &listener_url
: nullptr;
mojom::ContextType target_context = process_map->GetMostLikelyContextType(
extension, process->GetDeprecatedID(), url);
// Don't dispatch an event when target context doesn't match the restricted
// context type.
if (event.restrict_to_context_type.has_value() &&
event.restrict_to_context_type.value() != target_context) {
return;
}
// We shouldn't be dispatching an event to a webpage, since all such events
// (e.g. messaging) don't go through EventRouter. The exceptions to this are
// the new chrome webstore domain, which has permission to receive extension
// events and features with delegated availability checks, such as Controlled
// Frame which runs within Isolated Web Apps and appear as web pages.
Feature::Availability availability =
ExtensionAPI::GetSharedInstance()->IsAvailable(
event.event_name, extension, target_context, listener_url,
CheckAliasStatus::ALLOWED,
util::GetBrowserContextId(browser_context_),
BrowserProcessContextData(process));
if (!availability.is_available()) {
// TODO(crbug.com/40255138): Ideally it shouldn't be possible to reach here,
// because access is checked on registration. However, we don't always
// refresh the list of events an extension has registered when other factors
// which affect availability change (e.g. API allowlists changing). Those
// situations should be identified and addressed.
return;
}
if (target_context == mojom::ContextType::kWebPage) {
// |url| can only be null for service workers, so should never be null here.
CHECK(url);
bool is_new_webstore_origin =
url::Origin::Create(extension_urls::GetNewWebstoreLaunchURL())
.IsSameOriginWith(*url);
const Feature* feature =
ExtensionAPI::GetSharedInstance()->GetFeatureDependency(
event.event_name);
CHECK(feature->RequiresDelegatedAvailabilityCheck() ||
is_new_webstore_origin)
<< "Trying to dispatch event " << event.event_name << " to a webpage,"
<< " but this shouldn't be possible";
}
std::optional<base::Value::List> modified_event_args;
mojom::EventFilteringInfoPtr modified_event_filter_info;
if (!event.will_dispatch_callback.is_null() &&
!event.will_dispatch_callback.Run(
listener_context, target_context, extension, listener_filter,
modified_event_args, modified_event_filter_info)) {
return;
}
base::Value::List event_args_to_use = modified_event_args
? std::move(*modified_event_args)
: event.event_args.Clone();
mojom::EventFilteringInfoPtr filter_info =
modified_event_filter_info ? std::move(modified_event_filter_info)
: event.filter_info.Clone();
int event_id = g_extension_event_id.GetNext();
mojom::EventDispatcher::DispatchEventCallback callback;
// This mirrors the IncrementInFlightEvents below.
if (!extension) {
callback = base::DoNothing();
} else if (worker_thread_id != kMainThreadId) {
callback =
base::BindOnce(&EventRouter::DecrementInFlightEventsForServiceWorker,
weak_factory_.GetWeakPtr(),
WorkerId{extension_id, process->GetDeprecatedID(),
service_worker_version_id, worker_thread_id},
event_id);
} else if (BackgroundInfo::HasBackgroundPage(extension)) {
// Although it's unnecessary to decrement in-flight events for non-lazy
// background pages, we use the logic for event tracking/metrics purposes.
callback =
base::BindOnce(&EventRouter::DecrementInFlightEventsForRenderFrameHost,
weak_factory_.GetWeakPtr(), process->GetDeprecatedID(),
extension_id, event_id);
} else {
callback = base::DoNothing();
}
DispatchExtensionMessage(process, worker_thread_id, listener_context,
GenerateHostIdFromExtensionId(extension_id),
event_id, event.event_name,
std::move(event_args_to_use), event.user_gesture,
std::move(filter_info), std::move(callback));
if (!event.did_dispatch_callback.is_null()) {
event.did_dispatch_callback.Run(
EventTarget{extension_id, process->GetDeprecatedID(),
service_worker_version_id, worker_thread_id});
}
for (TestObserver& observer : test_observers_) {
observer.OnDidDispatchEventToProcess(event, process->GetDeprecatedID());
}
// TODO(lazyboy): This is wrong for extensions SW events. We need to:
// 1. Increment worker ref count
// 2. Add EventAck IPC to decrement that ref count.
if (extension) {
ReportEvent(event.histogram_value, extension, did_enqueue);
IncrementInFlightEvents(
listener_context, process, extension, event_id, event.event_name,
event.dispatch_start_time, service_worker_version_id,
EventDispatchSource::kDispatchEventToProcess,
event.lazy_background_active_on_dispatch, event.histogram_value);
}
}
void EventRouter::DecrementInFlightEventsForServiceWorker(
const WorkerId& worker_id,
int event_id,
bool event_will_run_in_lazy_background_page_script) {
auto* process = RenderProcessHost::FromID(worker_id.render_process_id);
// Check to make sure the rendered process hasn't gone away by the time
// we've gotten here. (It's possible it has crashed, etc.) If that's
// happened, we don't want to track the expected ACK, since we'll never
// get it.
if (!process) {
return;
}
if (event_will_run_in_lazy_background_page_script) {
bad_message::ReceivedBadMessage(
process, bad_message::ER_SW_INVALID_LAZY_BACKGROUND_PARAM);
}
const bool worker_stopped = !ProcessManager::Get(process->GetBrowserContext())
->HasServiceWorker(worker_id);
content::ServiceWorkerContext* service_worker_context =
process->GetStoragePartition()->GetServiceWorkerContext();
event_ack_data_.DecrementInflightEvent(
service_worker_context, process->GetDeprecatedID(), worker_id.version_id,
event_id, worker_stopped,
base::BindOnce(
[](RenderProcessHost* process) {
bad_message::ReceivedBadMessage(process,
bad_message::ESWMF_BAD_EVENT_ACK);
},
base::Unretained(process)));
}
void EventRouter::DecrementInFlightEventsForRenderFrameHost(
int render_process_host,
const ExtensionId& extension_id,
int event_id,
bool event_will_run_in_background_page_script) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
auto* process = RenderProcessHost::FromID(render_process_host);
if (!process) {
return;
}
ProcessManager* pm = ProcessManager::Get(process->GetBrowserContext());
ExtensionHost* host = pm->GetBackgroundHostForExtension(extension_id);
if (host) {
host->OnEventAck(event_id, event_will_run_in_background_page_script);
}
}
void EventRouter::IncrementInFlightEvents(
BrowserContext* context,
RenderProcessHost* process,
const Extension* extension,
int event_id,
const std::string& event_name,
base::TimeTicks dispatch_start_time,
int64_t service_worker_version_id,
EventDispatchSource dispatch_source,
bool lazy_background_active_on_dispatch,
events::HistogramValue histogram_value) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
if (BackgroundInfo::HasBackgroundPage(extension)) {
ProcessManager* pm = ProcessManager::Get(context);
ExtensionHost* host = pm->GetBackgroundHostForExtension(extension->id());
// Confirm that the event is meant to be executed in the extension process.
if (host && host->render_process_host() == process) {
// Only increment in-flight events if the lazy background page is active.
if (BackgroundInfo::HasLazyBackgroundPage(extension)) {
pm->IncrementLazyKeepaliveCount(extension, Activity::EVENT, event_name);
}
host->OnBackgroundEventDispatched(event_name, dispatch_start_time,
event_id, dispatch_source,
lazy_background_active_on_dispatch);
}
} else if (service_worker_version_id !=
blink::mojom::kInvalidServiceWorkerVersionId) {
// Check to make sure the rendered process hasn't gone away by the time
// we've gotten here. (It's possible it has crashed, etc.) If that's
// happened, we don't want to track the expected ACK, since we'll never
// get it.
if (process) {
content::ServiceWorkerContext* service_worker_context =
process->GetStoragePartition()->GetServiceWorkerContext();
event_ack_data_.IncrementInflightEvent(
service_worker_context, process->GetDeprecatedID(),
service_worker_version_id, event_id, dispatch_start_time,
dispatch_source, lazy_background_active_on_dispatch, histogram_value);
}
}
}
void EventRouter::OnEventAck(BrowserContext* context,
const ExtensionId& extension_id,
const std::string& event_name) {
ProcessManager* pm = ProcessManager::Get(context);
ExtensionHost* host = pm->GetBackgroundHostForExtension(extension_id);
// The event ACK is routed to the background host, so this should never be
// NULL.
CHECK(host);
// TODO(mpcomplete): We should never get this message unless
// HasLazyBackgroundPage is true. Find out why we're getting it anyway.
if (host->extension() &&
BackgroundInfo::HasLazyBackgroundPage(host->extension()))
pm->DecrementLazyKeepaliveCount(host->extension(), Activity::EVENT,
event_name);
}
bool EventRouter::HasRegisteredEvents(const ExtensionId& extension_id) const {
return !GetRegisteredEvents(extension_id, RegisteredEventType::kLazy)
.empty() ||
!GetRegisteredEvents(extension_id, RegisteredEventType::kServiceWorker)
.empty();
}
void EventRouter::ReportEvent(events::HistogramValue histogram_value,
const Extension* extension,
bool did_enqueue) {
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
// Record every event fired.
UMA_HISTOGRAM_ENUMERATION("Extensions.Events.Dispatch", histogram_value,
events::ENUM_BOUNDARY);
bool is_component = Manifest::IsComponentLocation(extension->location());
// Record events for component extensions. These should be kept to a minimum,
// especially if they wake its event page. Component extensions should use
// declarative APIs as much as possible.
if (is_component) {
UMA_HISTOGRAM_ENUMERATION("Extensions.Events.DispatchToComponent",
histogram_value, events::ENUM_BOUNDARY);
}
// Record events for background pages, if any. The most important statistic
// is DispatchWithSuspendedEventPage. Events reported there woke an event
// page. Implementing either filtered or declarative versions of these events
// should be prioritised.
//
// Note: all we know is that the extension *has* a persistent or event page,
// not that the event is being dispatched *to* such a page. However, this is
// academic, since extensions with any background page have that background
// page running (or in the case of suspended event pages, must be started)
// regardless of where the event is being dispatched. Events are dispatched
// to a *process* not a *frame*.
if (BackgroundInfo::HasPersistentBackgroundPage(extension)) {
UMA_HISTOGRAM_ENUMERATION(
"Extensions.Events.DispatchWithPersistentBackgroundPage",
histogram_value, events::ENUM_BOUNDARY);
} else if (BackgroundInfo::HasLazyBackgroundPage(extension)) {
if (did_enqueue) {
UMA_HISTOGRAM_ENUMERATION(
"Extensions.Events.DispatchWithSuspendedEventPage", histogram_value,
events::ENUM_BOUNDARY);
} else {
UMA_HISTOGRAM_ENUMERATION(
"Extensions.Events.DispatchWithRunningEventPage", histogram_value,
events::ENUM_BOUNDARY);
}
} else if (BackgroundInfo::IsServiceWorkerBased(extension)) {
base::UmaHistogramEnumeration(
"Extensions.Events.DispatchWithServiceWorkerBackground",
histogram_value, events::ENUM_BOUNDARY);
}
}
void EventRouter::DispatchPendingEvent(
std::unique_ptr<Event> event,
std::unique_ptr<LazyContextTaskQueue::ContextInfo> params) {
if (!params) {
return;
}
DCHECK(event);
// TODO(crbug.com/40267088): We shouldn't dispatch events to processes
// that don't have a listener for that event. Currently, we enforce this for
// the webRequest API (since a bug there can result in a request hanging
// indefinitely). We don't do this in all cases yet because extensions may be
// unknowingly relying on this behavior for listeners registered
// asynchronously (which is not supported, but may be happening).
bool check_for_specific_event =
base::StartsWith(event->event_name, "webRequest");
bool dispatch_to_process =
check_for_specific_event
? listeners_.HasProcessListenerForEvent(
params->render_process_host, params->worker_thread_id,
params->extension_id, event->event_name)
: listeners_.HasProcessListener(params->render_process_host,
params->worker_thread_id,
params->extension_id);
if (dispatch_to_process) {
DispatchEventToProcess(
params->extension_id, params->url, params->render_process_host,
params->service_worker_version_id, params->worker_thread_id, *event,
nullptr, true /* did_enqueue */);
} else if (event->cannot_dispatch_callback) {
// Even after spinning up the lazy background context, there's no registered
// event. This can happen if the extension asynchronously registers event
// listeners. In this case, notify the caller (if they subscribed via a
// callback) and drop the event.
// TODO(crbug.com/40954888): We should provide feedback to
// developers (e.g. emit a warning) when an event has no listeners.
event->cannot_dispatch_callback.Run();
}
}
void EventRouter::SetRegisteredEvents(const ExtensionId& extension_id,
const std::set<std::string>& events,
RegisteredEventType type) {
base::Value::List events_list;
for (const auto& event : events) {
events_list.Append(event);
}
const char* pref_key = type == RegisteredEventType::kLazy
? kRegisteredLazyEvents
: kRegisteredServiceWorkerEvents;
extension_prefs_->UpdateExtensionPref(extension_id, pref_key,
base::Value(std::move(events_list)));
}
void EventRouter::AddFilterToEvent(const std::string& event_name,
const ExtensionId& extension_id,
bool is_for_service_worker,
const base::Value::Dict& filter) {
ExtensionPrefs::ScopedDictionaryUpdate update(
extension_prefs_, extension_id,
is_for_service_worker ? kFilteredServiceWorkerEvents : kFilteredEvents);
auto filtered_events = update.Create();
base::Value::List* filter_list = nullptr;
if (!filtered_events->GetListWithoutPathExpansion(event_name, &filter_list)) {
filtered_events->SetKey(event_name, base::Value(base::Value::List()));
filtered_events->GetListWithoutPathExpansion(event_name, &filter_list);
}
filter_list->Append(filter.Clone());
}
void EventRouter::OnExtensionLoaded(content::BrowserContext* browser_context,
const Extension* extension) {
// TODO(richardzh): revisit here once we create separate lazy listeners for
// regular and incognito(split) context. How do we ensure lazy listeners and
// regular listeners are loaded for both browser context.
// Add all registered lazy listeners to our cache.
std::set<std::string> registered_events =
GetRegisteredEvents(extension->id(), RegisteredEventType::kLazy);
listeners_.LoadUnfilteredLazyListeners(browser_context, extension->id(),
/*is_for_service_worker=*/false,
registered_events);
std::set<std::string> registered_worker_events =
GetRegisteredEvents(extension->id(), RegisteredEventType::kServiceWorker);
listeners_.LoadUnfilteredLazyListeners(browser_context, extension->id(),
/*is_for_service_worker=*/true,
registered_worker_events);
const base::Value::Dict* filtered_events =
GetFilteredEvents(extension->id(), RegisteredEventType::kLazy);
if (filtered_events) {
listeners_.LoadFilteredLazyListeners(browser_context, extension->id(),
/*is_for_service_worker=*/false,
*filtered_events);
}
const base::Value::Dict* filtered_worker_events =
GetFilteredEvents(extension->id(), RegisteredEventType::kServiceWorker);
if (filtered_worker_events) {
listeners_.LoadFilteredLazyListeners(browser_context, extension->id(),
/*is_for_service_worker=*/true,
*filtered_worker_events);
}
}
void EventRouter::OnExtensionUnloaded(content::BrowserContext* browser_context,
const Extension* extension,
UnloadedExtensionReason reason) {
// Remove all registered listeners from our cache.
listeners_.RemoveListenersForExtension(extension->id());
}
void EventRouter::OnStoppedTrackingServiceWorkerInstance(
const WorkerId& worker_id) {
// Remove any active listeners since they are no longer guaranteed to be ready
// to receive events.
listeners_.RemoveActiveServiceWorkerListenersForExtension(worker_id);
}
void EventRouter::AddLazyEventListenerImpl(
std::unique_ptr<EventListener> listener,
RegisteredEventType type) {
const ExtensionId extension_id = listener->extension_id();
const std::string event_name = listener->event_name();
bool is_new = listeners_.AddListener(std::move(listener));
if (is_new) {
std::set<std::string> events = GetRegisteredEvents(extension_id, type);
bool prefs_is_new = events.insert(event_name).second;
if (prefs_is_new) {
SetRegisteredEvents(extension_id, events, type);
}
}
}
void EventRouter::RemoveLazyEventListenerImpl(
std::unique_ptr<EventListener> listener,
RegisteredEventType type) {
const ExtensionId extension_id = listener->extension_id();
const std::string event_name = listener->event_name();
bool did_exist = listeners_.RemoveListener(listener.get());
if (did_exist) {
std::set<std::string> events = GetRegisteredEvents(extension_id, type);
bool prefs_did_exist = events.erase(event_name) > 0;
DCHECK(prefs_did_exist);
SetRegisteredEvents(extension_id, events, type);
}
}
void EventRouter::BindServiceWorkerEventDispatcher(
int render_process_id,
int worker_thread_id,
mojo::PendingAssociatedRemote<mojom::EventDispatcher> event_dispatcher) {
auto* process = RenderProcessHost::FromID(render_process_id);
if (!process) {
return;
}
ObserveProcess(process);
mojo::AssociatedRemote<mojom::EventDispatcher>& worker_dispatcher =
rph_dispatcher_map_[process][worker_thread_id];
CHECK(!worker_dispatcher);
worker_dispatcher.Bind(std::move(event_dispatcher));
worker_dispatcher.set_disconnect_handler(
base::BindOnce(&EventRouter::UnbindServiceWorkerEventDispatcher,
weak_factory_.GetWeakPtr(), process, worker_thread_id));
}
void EventRouter::UnbindServiceWorkerEventDispatcher(RenderProcessHost* host,
int worker_thread_id) {
auto map = rph_dispatcher_map_.find(host);
if (map == rph_dispatcher_map_.end()) {
return;
}
map->second.erase(worker_thread_id);
}
Event::Event(events::HistogramValue histogram_value,
std::string_view event_name,
base::Value::List event_args)
: Event(histogram_value, event_name, std::move(event_args), nullptr) {}
Event::Event(events::HistogramValue histogram_value,
std::string_view event_name,
base::Value::List event_args,
content::BrowserContext* restrict_to_browser_context,
std::optional<mojom::ContextType> restrict_to_context_type)
: Event(histogram_value,
event_name,
std::move(event_args),
restrict_to_browser_context,
restrict_to_context_type,
GURL(),
EventRouter::UserGestureState::kUnknown,
mojom::EventFilteringInfo::New()) {}
Event::Event(events::HistogramValue histogram_value,
std::string_view event_name,
base::Value::List event_args,
content::BrowserContext* restrict_to_browser_context,
std::optional<mojom::ContextType> restrict_to_context_type,
const GURL& event_url,
EventRouter::UserGestureState user_gesture,
mojom::EventFilteringInfoPtr info,
bool lazy_background_active_on_dispatch,
base::TimeTicks dispatch_start_time)
: histogram_value(histogram_value),
event_name(event_name),
event_args(std::move(event_args)),
restrict_to_browser_context(restrict_to_browser_context),
restrict_to_context_type(restrict_to_context_type),
event_url(event_url),
dispatch_start_time(dispatch_start_time),
lazy_background_active_on_dispatch(lazy_background_active_on_dispatch),
user_gesture(user_gesture),
filter_info(std::move(info)) {
DCHECK_NE(events::UNKNOWN, histogram_value)
<< "events::UNKNOWN cannot be used as a histogram value.\n"
<< "If this is a test, use events::FOR_TEST.\n"
<< "If this is production code, it is important that you use a realistic "
<< "value so that we can accurately track event usage. "
<< "See extension_event_histogram_value.h for inspiration.";
}
Event::~Event() = default;
std::unique_ptr<Event> Event::DeepCopy() const {
auto copy = std::make_unique<Event>(
histogram_value, event_name, event_args.Clone(),
restrict_to_browser_context, restrict_to_context_type, event_url,
user_gesture, filter_info.Clone(), lazy_background_active_on_dispatch,
dispatch_start_time);
copy->will_dispatch_callback = will_dispatch_callback;
copy->did_dispatch_callback = did_dispatch_callback;
copy->cannot_dispatch_callback = cannot_dispatch_callback;
return copy;
}
// This constructor is only used by tests, for non-ServiceWorker context
// (background page, popup, tab, etc).
// is_lazy flag default to false.
EventListenerInfo::EventListenerInfo(const std::string& event_name,
const ExtensionId& extension_id,
const GURL& listener_url,
content::BrowserContext* browser_context)
: event_name(event_name),
extension_id(extension_id),
listener_url(listener_url),
browser_context(browser_context),
worker_thread_id(kMainThreadId),
service_worker_version_id(blink::mojom::kInvalidServiceWorkerVersionId),
is_lazy(false) {}
EventListenerInfo::EventListenerInfo(const std::string& event_name,
const ExtensionId& extension_id,
const GURL& listener_url,
content::BrowserContext* browser_context,
int worker_thread_id,
int64_t service_worker_version_id,
bool is_lazy)
: event_name(event_name),
extension_id(extension_id),
listener_url(listener_url),
browser_context(browser_context),
worker_thread_id(worker_thread_id),
service_worker_version_id(service_worker_version_id),
is_lazy(is_lazy) {}
} // namespace extensions
|