| /* |
| * Copyright (C) 2017 Apple Inc. All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in the |
| * documentation and/or other materials provided with the distribution. |
| * |
| * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' |
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, |
| * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
| * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS |
| * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF |
| * THE POSSIBILITY OF SUCH DAMAGE. |
| */ |
| |
| #include "config.h" |
| #include "WebSWClientConnection.h" |
| |
| #if ENABLE(SERVICE_WORKER) |
| |
| #include "DataReference.h" |
| #include "FormDataReference.h" |
| #include "Logging.h" |
| #include "NetworkConnectionToWebProcessMessages.h" |
| #include "NetworkProcessConnection.h" |
| #include "NetworkProcessMessages.h" |
| #include "WebCoreArgumentCoders.h" |
| #include "WebProcess.h" |
| #include "WebProcessPoolMessages.h" |
| #include "WebSWOriginTable.h" |
| #include "WebSWServerConnectionMessages.h" |
| #include <WebCore/Document.h> |
| #include <WebCore/DocumentLoader.h> |
| #include <WebCore/ProcessIdentifier.h> |
| #include <WebCore/SecurityOrigin.h> |
| #include <WebCore/SerializedScriptValue.h> |
| #include <WebCore/ServiceWorkerClientData.h> |
| #include <WebCore/ServiceWorkerFetchResult.h> |
| #include <WebCore/ServiceWorkerJobData.h> |
| #include <WebCore/ServiceWorkerRegistrationData.h> |
| #include <WebCore/ServiceWorkerRegistrationKey.h> |
| |
| namespace WebKit { |
| using namespace PAL; |
| using namespace WebCore; |
| |
| |
| WebSWClientConnection::WebSWClientConnection() |
| : m_identifier(Process::identifier()) |
| , m_swOriginTable(makeUniqueRef<WebSWOriginTable>()) |
| { |
| } |
| |
| WebSWClientConnection::~WebSWClientConnection() |
| { |
| clear(); |
| } |
| |
| IPC::Connection* WebSWClientConnection::messageSenderConnection() const |
| { |
| return &WebProcess::singleton().ensureNetworkProcessConnection().connection(); |
| } |
| |
| void WebSWClientConnection::scheduleJobInServer(const ServiceWorkerJobData& jobData) |
| { |
| runOrDelayTaskForImport([this, jobData] { |
| send(Messages::WebSWServerConnection::ScheduleJobInServer { jobData }); |
| }); |
| } |
| |
| void WebSWClientConnection::finishFetchingScriptInServer(const ServiceWorkerFetchResult& result) |
| { |
| send(Messages::WebSWServerConnection::FinishFetchingScriptInServer { result }); |
| } |
| |
| void WebSWClientConnection::addServiceWorkerRegistrationInServer(ServiceWorkerRegistrationIdentifier identifier) |
| { |
| // FIXME: We should send the message to network process only if this is a new registration, once we correctly handle recovery upon network process crash. |
| WebProcess::singleton().addServiceWorkerRegistration(identifier); |
| send(Messages::WebSWServerConnection::AddServiceWorkerRegistrationInServer { identifier }); |
| } |
| |
| void WebSWClientConnection::removeServiceWorkerRegistrationInServer(ServiceWorkerRegistrationIdentifier identifier) |
| { |
| if (WebProcess::singleton().removeServiceWorkerRegistration(identifier)) |
| send(Messages::WebSWServerConnection::RemoveServiceWorkerRegistrationInServer { identifier }); |
| } |
| |
| void WebSWClientConnection::scheduleUnregisterJobInServer(ServiceWorkerRegistrationIdentifier registrationIdentifier, WebCore::ServiceWorkerOrClientIdentifier documentIdentifier, CompletionHandler<void(ExceptionOr<bool>&&)>&& completionHandler) |
| { |
| sendWithAsyncReply(Messages::WebSWServerConnection::ScheduleUnregisterJobInServer { ServiceWorkerJobIdentifier::generateThreadSafe(), registrationIdentifier, documentIdentifier }, [completionHandler = WTFMove(completionHandler)](auto&& result) mutable { |
| if (!result.has_value()) |
| return completionHandler(result.error().toException()); |
| completionHandler(result.value()); |
| }); |
| } |
| |
| void WebSWClientConnection::postMessageToServiceWorker(ServiceWorkerIdentifier destinationIdentifier, MessageWithMessagePorts&& message, const ServiceWorkerOrClientIdentifier& sourceIdentifier) |
| { |
| send(Messages::WebSWServerConnection::PostMessageToServiceWorker { destinationIdentifier, WTFMove(message), sourceIdentifier }); |
| } |
| |
| void WebSWClientConnection::registerServiceWorkerClient(const SecurityOrigin& topOrigin, const WebCore::ServiceWorkerClientData& data, const std::optional<WebCore::ServiceWorkerRegistrationIdentifier>& controllingServiceWorkerRegistrationIdentifier, const String& userAgent) |
| { |
| send(Messages::WebSWServerConnection::RegisterServiceWorkerClient { topOrigin.data(), data, controllingServiceWorkerRegistrationIdentifier, userAgent }); |
| } |
| |
| void WebSWClientConnection::unregisterServiceWorkerClient(ScriptExecutionContextIdentifier contextIdentifier) |
| { |
| send(Messages::WebSWServerConnection::UnregisterServiceWorkerClient { contextIdentifier }); |
| } |
| |
| void WebSWClientConnection::didResolveRegistrationPromise(const ServiceWorkerRegistrationKey& key) |
| { |
| send(Messages::WebSWServerConnection::DidResolveRegistrationPromise { key }); |
| } |
| |
| bool WebSWClientConnection::mayHaveServiceWorkerRegisteredForOrigin(const SecurityOriginData& origin) const |
| { |
| if (!m_swOriginTable->isImported()) |
| return true; |
| |
| return m_swOriginTable->contains(origin); |
| } |
| |
| void WebSWClientConnection::setSWOriginTableSharedMemory(const SharedMemory::IPCHandle& ipcHandle) |
| { |
| m_swOriginTable->setSharedMemory(ipcHandle.handle); |
| } |
| |
| void WebSWClientConnection::setSWOriginTableIsImported() |
| { |
| m_swOriginTable->setIsImported(); |
| while (!m_tasksPendingOriginImport.isEmpty()) |
| m_tasksPendingOriginImport.takeFirst()(); |
| } |
| |
| void WebSWClientConnection::matchRegistration(SecurityOriginData&& topOrigin, const URL& clientURL, RegistrationCallback&& callback) |
| { |
| ASSERT(isMainRunLoop()); |
| |
| if (!mayHaveServiceWorkerRegisteredForOrigin(topOrigin)) { |
| callback(std::nullopt); |
| return; |
| } |
| |
| runOrDelayTaskForImport([this, callback = WTFMove(callback), topOrigin = WTFMove(topOrigin), clientURL]() mutable { |
| sendWithAsyncReply(Messages::WebSWServerConnection::MatchRegistration { topOrigin, clientURL }, WTFMove(callback)); |
| }); |
| } |
| |
| void WebSWClientConnection::runOrDelayTaskForImport(Function<void()>&& task) |
| { |
| if (m_swOriginTable->isImported()) { |
| task(); |
| return; |
| } |
| m_tasksPendingOriginImport.append(WTFMove(task)); |
| } |
| |
| void WebSWClientConnection::whenRegistrationReady(const SecurityOriginData& topOrigin, const URL& clientURL, WhenRegistrationReadyCallback&& callback) |
| { |
| sendWithAsyncReply(Messages::WebSWServerConnection::WhenRegistrationReady { topOrigin, clientURL }, [callback = WTFMove(callback)](auto result) mutable { |
| if (result) |
| callback(*WTFMove(result)); |
| }); |
| } |
| |
| void WebSWClientConnection::setDocumentIsControlled(ScriptExecutionContextIdentifier documentIdentifier, ServiceWorkerRegistrationData&& data, CompletionHandler<void(bool)>&& completionHandler) |
| { |
| auto* documentLoader = DocumentLoader::fromScriptExecutionContextIdentifier(documentIdentifier); |
| bool result = documentLoader ? documentLoader->setControllingServiceWorkerRegistration(WTFMove(data)) : false; |
| completionHandler(result); |
| } |
| |
| void WebSWClientConnection::getRegistrations(SecurityOriginData&& topOrigin, const URL& clientURL, GetRegistrationsCallback&& callback) |
| { |
| ASSERT(isMainRunLoop()); |
| |
| if (!mayHaveServiceWorkerRegisteredForOrigin(topOrigin)) { |
| callback({ }); |
| return; |
| } |
| |
| runOrDelayTaskForImport([this, callback = WTFMove(callback), topOrigin = WTFMove(topOrigin), clientURL]() mutable { |
| sendWithAsyncReply(Messages::WebSWServerConnection::GetRegistrations { topOrigin, clientURL }, WTFMove(callback)); |
| }); |
| } |
| |
| void WebSWClientConnection::connectionToServerLost() |
| { |
| setIsClosed(); |
| clear(); |
| } |
| |
| void WebSWClientConnection::clear() |
| { |
| clearPendingJobs(); |
| } |
| |
| void WebSWClientConnection::terminateWorkerForTesting(ServiceWorkerIdentifier identifier, CompletionHandler<void()>&& callback) |
| { |
| sendWithAsyncReply(Messages::WebSWServerConnection::TerminateWorkerFromClient { identifier }, WTFMove(callback)); |
| } |
| |
| void WebSWClientConnection::whenServiceWorkerIsTerminatedForTesting(ServiceWorkerIdentifier identifier, CompletionHandler<void()>&& callback) |
| { |
| sendWithAsyncReply(Messages::WebSWServerConnection::WhenServiceWorkerIsTerminatedForTesting { identifier }, WTFMove(callback)); |
| } |
| |
| void WebSWClientConnection::updateThrottleState() |
| { |
| m_isThrottleable = WebProcess::singleton().areAllPagesThrottleable(); |
| send(Messages::WebSWServerConnection::SetThrottleState { m_isThrottleable }); |
| } |
| |
| void WebSWClientConnection::storeRegistrationsOnDiskForTesting(CompletionHandler<void()>&& callback) |
| { |
| sendWithAsyncReply(Messages::WebSWServerConnection::StoreRegistrationsOnDisk { }, WTFMove(callback)); |
| } |
| |
| void WebSWClientConnection::subscribeToPushService(WebCore::ServiceWorkerRegistrationIdentifier registrationIdentifier, const Vector<uint8_t>& applicationServerKey, SubscribeToPushServiceCallback&& callback) |
| { |
| sendWithAsyncReply(Messages::WebSWServerConnection::SubscribeToPushService { registrationIdentifier, applicationServerKey }, [callback = WTFMove(callback)](auto&& result) mutable { |
| if (!result.has_value()) |
| return callback(result.error().toException()); |
| callback(WTFMove(*result)); |
| }); |
| } |
| |
| void WebSWClientConnection::unsubscribeFromPushService(WebCore::ServiceWorkerRegistrationIdentifier registrationIdentifier, WebCore::PushSubscriptionIdentifier subscriptionIdentifier, UnsubscribeFromPushServiceCallback&& callback) |
| { |
| sendWithAsyncReply(Messages::WebSWServerConnection::UnsubscribeFromPushService { registrationIdentifier, subscriptionIdentifier }, [callback = WTFMove(callback)](auto&& result) mutable { |
| if (!result.has_value()) |
| return callback(result.error().toException()); |
| callback(*result); |
| }); |
| } |
| |
| void WebSWClientConnection::getPushSubscription(WebCore::ServiceWorkerRegistrationIdentifier registrationIdentifier, GetPushSubscriptionCallback&& callback) |
| { |
| sendWithAsyncReply(Messages::WebSWServerConnection::GetPushSubscription { registrationIdentifier }, [callback = WTFMove(callback)](auto&& result) mutable { |
| if (!result.has_value()) |
| return callback(result.error().toException()); |
| callback(WTFMove(*result)); |
| }); |
| } |
| |
| void WebSWClientConnection::getPushPermissionState(WebCore::ServiceWorkerRegistrationIdentifier registrationIdentifier, GetPushPermissionStateCallback&& callback) |
| { |
| sendWithAsyncReply(Messages::WebSWServerConnection::GetPushPermissionState { registrationIdentifier }, [callback = WTFMove(callback)](auto&& result) mutable { |
| if (!result.has_value()) |
| return callback(result.error().toException()); |
| callback(static_cast<PushPermissionState>(*result)); |
| }); |
| } |
| |
| void WebSWClientConnection::enableNavigationPreload(WebCore::ServiceWorkerRegistrationIdentifier registrationIdentifier, ExceptionOrVoidCallback&& callback) |
| { |
| sendWithAsyncReply(Messages::WebSWServerConnection::EnableNavigationPreload { registrationIdentifier }, [callback = WTFMove(callback)](auto&& error) mutable { |
| if (error) |
| return callback(error->toException()); |
| callback({ }); |
| }); |
| } |
| |
| void WebSWClientConnection::disableNavigationPreload(WebCore::ServiceWorkerRegistrationIdentifier registrationIdentifier, ExceptionOrVoidCallback&& callback) |
| { |
| sendWithAsyncReply(Messages::WebSWServerConnection::DisableNavigationPreload { registrationIdentifier }, [callback = WTFMove(callback)](auto&& error) mutable { |
| if (error) |
| return callback(error->toException()); |
| callback({ }); |
| }); |
| } |
| |
| void WebSWClientConnection::setNavigationPreloadHeaderValue(WebCore::ServiceWorkerRegistrationIdentifier registrationIdentifier, String&& headerValue, ExceptionOrVoidCallback&& callback) |
| { |
| sendWithAsyncReply(Messages::WebSWServerConnection::SetNavigationPreloadHeaderValue { registrationIdentifier, headerValue }, [callback = WTFMove(callback)](auto&& error) mutable { |
| if (error) |
| return callback(error->toException()); |
| callback({ }); |
| }); |
| } |
| |
| void WebSWClientConnection::getNavigationPreloadState(WebCore::ServiceWorkerRegistrationIdentifier registrationIdentifier, ExceptionOrNavigationPreloadStateCallback&& callback) |
| { |
| sendWithAsyncReply(Messages::WebSWServerConnection::GetNavigationPreloadState { registrationIdentifier }, [callback = WTFMove(callback)](auto&& result) mutable { |
| if (!result.has_value()) |
| return callback(result.error().toException()); |
| callback(WTFMove(*result)); |
| }); |
| } |
| |
| } // namespace WebKit |
| |
| #endif // ENABLE(SERVICE_WORKER) |