Source/WebCore/loader/WorkerThreadableLoader.cpp

   1 /*
   2  * Copyright (C) 2009, 2010 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #include "config.h"
  32
  33 #if ENABLE(WORKERS)
  34
  35 #include "WorkerThreadableLoader.h"
  36
  37 #include "CrossThreadTask.h"
  38 #include "ResourceError.h"
  39 #include "ResourceRequest.h"
  40 #include "ResourceResponse.h"
  41 #include "ThreadableLoader.h"
  42 #include "WorkerContext.h"
  43 #include "WorkerLoaderProxy.h"
  44 #include "WorkerThread.h"
  45 #include <wtf/OwnPtr.h>
  46 #include <wtf/Threading.h>
  47 #include <wtf/Vector.h>
  48
  49 using namespace std;
  50
  51 namespace WebCore {
  52
  53 static const char loadResourceSynchronouslyMode[] = "loadResourceSynchronouslyMode";
  54
  55 WorkerThreadableLoader::WorkerThreadableLoader(WorkerContext* workerContext, ThreadableLoaderClient* client, const String& taskMode, const ResourceRequest& request, const ThreadableLoaderOptions& options)
  56     : m_workerContext(workerContext)
  57     , m_workerClientWrapper(ThreadableLoaderClientWrapper::create(client))
  58     , m_bridge(*(new MainThreadBridge(m_workerClientWrapper, m_workerContext->thread()->workerLoaderProxy(), taskMode, request, options)))
  59 {
  60 }
  61
  62 WorkerThreadableLoader::~WorkerThreadableLoader()
  63 {
  64     m_bridge.destroy();
  65 }
  66
  67 void WorkerThreadableLoader::loadResourceSynchronously(WorkerContext* workerContext, const ResourceRequest& request, ThreadableLoaderClient& client, const ThreadableLoaderOptions& options)
  68 {
  69     WorkerRunLoop& runLoop = workerContext->thread()->runLoop();
  70
  71     // Create a unique mode just for this synchronous resource load.
  72     String mode = loadResourceSynchronouslyMode;
  73     mode.append(String::number(runLoop.createUniqueId()));
  74
  75     RefPtr<WorkerThreadableLoader> loader = WorkerThreadableLoader::create(workerContext, &client, mode, request, options);
  76     MessageQueueWaitResult result = MessageQueueMessageReceived;
  77     while (!loader->done() && result != MessageQueueTerminated)
  78         result = runLoop.runInMode(workerContext, mode);
  79
  80     if (!loader->done() && result == MessageQueueTerminated)
  81         loader->cancel();
  82 }
  83
  84 void WorkerThreadableLoader::cancel()
  85 {
  86     m_bridge.cancel();
  87 }
  88
  89 WorkerThreadableLoader::MainThreadBridge::MainThreadBridge(PassRefPtr<ThreadableLoaderClientWrapper> workerClientWrapper, WorkerLoaderProxy& loaderProxy, const String& taskMode,
  90                                                            const ResourceRequest& request, const ThreadableLoaderOptions& options)
  91     : m_workerClientWrapper(workerClientWrapper)
  92     , m_loaderProxy(loaderProxy)
  93     , m_taskMode(taskMode.crossThreadString())
  94 {
  95     ASSERT(m_workerClientWrapper.get());
  96     m_loaderProxy.postTaskToLoader(createCallbackTask(&MainThreadBridge::mainThreadCreateLoader, this, request, options));
  97 }
  98
  99 WorkerThreadableLoader::MainThreadBridge::~MainThreadBridge()
 100 {
 101 }
 102
 103 void WorkerThreadableLoader::MainThreadBridge::mainThreadCreateLoader(ScriptExecutionContext* context, MainThreadBridge* thisPtr, PassOwnPtr<CrossThreadResourceRequestData> requestData, ThreadableLoaderOptions options)
 104 {
 105     ASSERT(isMainThread());
 106     ASSERT(context->isDocument());
 107
 108     // FIXME: the created loader has no knowledge of the origin of the worker doing the load request.
 109     // Basically every setting done in SubresourceLoader::create (including the contents of addExtraFieldsToRequest)
 110     // needs to be examined for how it should take into account a different originator.
 111     OwnPtr<ResourceRequest> request(ResourceRequest::adopt(requestData));
 112     // FIXME: If the a site requests a local resource, then this will return a non-zero value but the sync path
 113     // will return a 0 value.  Either this should return 0 or the other code path should do a callback with
 114     // a failure.
 115     thisPtr->m_mainThreadLoader = ThreadableLoader::create(context, thisPtr, *request, options);
 116     ASSERT(thisPtr->m_mainThreadLoader);
 117 }
 118
 119 void WorkerThreadableLoader::MainThreadBridge::mainThreadDestroy(ScriptExecutionContext* context, MainThreadBridge* thisPtr)
 120 {
 121     ASSERT(isMainThread());
 122     ASSERT_UNUSED(context, context->isDocument());
 123     delete thisPtr;
 124 }
 125
 126 void WorkerThreadableLoader::MainThreadBridge::destroy()
 127 {
 128     // Ensure that no more client callbacks are done in the worker context's thread.
 129     clearClientWrapper();
 130
 131     // "delete this" and m_mainThreadLoader::deref() on the worker object's thread.
 132     m_loaderProxy.postTaskToLoader(createCallbackTask(&MainThreadBridge::mainThreadDestroy, this));
 133 }
 134
 135 void WorkerThreadableLoader::MainThreadBridge::mainThreadCancel(ScriptExecutionContext* context, MainThreadBridge* thisPtr)
 136 {
 137     ASSERT(isMainThread());
 138     ASSERT_UNUSED(context, context->isDocument());
 139
 140     if (!thisPtr->m_mainThreadLoader)
 141         return;
 142     thisPtr->m_mainThreadLoader->cancel();
 143     thisPtr->m_mainThreadLoader = 0;
 144 }
 145
 146 void WorkerThreadableLoader::MainThreadBridge::cancel()
 147 {
 148     m_loaderProxy.postTaskToLoader(createCallbackTask(&MainThreadBridge::mainThreadCancel, this));
 149     ThreadableLoaderClientWrapper* clientWrapper = m_workerClientWrapper.get();
 150     if (!clientWrapper->done()) {
 151         // If the client hasn't reached a termination state, then transition it by sending a cancellation error.
 152         // Note: no more client callbacks will be done after this method -- the clearClientWrapper() call ensures that.
 153         ResourceError error(String(), 0, String(), String());
 154         error.setIsCancellation(true);
 155         clientWrapper->didFail(error);
 156     }
 157     clearClientWrapper();
 158 }
 159
 160 void WorkerThreadableLoader::MainThreadBridge::clearClientWrapper()
 161 {
 162     m_workerClientWrapper->clearClient();
 163 }
 164
 165 static void workerContextDidSendData(ScriptExecutionContext* context, RefPtr<ThreadableLoaderClientWrapper> workerClientWrapper, unsigned long long bytesSent, unsigned long long totalBytesToBeSent)
 166 {
 167     ASSERT_UNUSED(context, context->isWorkerContext());
 168     workerClientWrapper->didSendData(bytesSent, totalBytesToBeSent);
 169 }
 170
 171 void WorkerThreadableLoader::MainThreadBridge::didSendData(unsigned long long bytesSent, unsigned long long totalBytesToBeSent)
 172 {
 173     m_loaderProxy.postTaskForModeToWorkerContext(createCallbackTask(&workerContextDidSendData, m_workerClientWrapper, bytesSent, totalBytesToBeSent), m_taskMode);
 174 }
 175
 176 static void workerContextDidReceiveResponse(ScriptExecutionContext* context, RefPtr<ThreadableLoaderClientWrapper> workerClientWrapper, PassOwnPtr<CrossThreadResourceResponseData> responseData)
 177 {
 178     ASSERT_UNUSED(context, context->isWorkerContext());
 179     OwnPtr<ResourceResponse> response(ResourceResponse::adopt(responseData));
 180     workerClientWrapper->didReceiveResponse(*response);
 181 }
 182
 183 void WorkerThreadableLoader::MainThreadBridge::didReceiveResponse(const ResourceResponse& response)
 184 {
 185     m_loaderProxy.postTaskForModeToWorkerContext(createCallbackTask(&workerContextDidReceiveResponse, m_workerClientWrapper, response), m_taskMode);
 186 }
 187
 188 static void workerContextDidReceiveData(ScriptExecutionContext* context, RefPtr<ThreadableLoaderClientWrapper> workerClientWrapper, PassOwnPtr<Vector<char> > vectorData)
 189 {
 190     ASSERT_UNUSED(context, context->isWorkerContext());
 191     workerClientWrapper->didReceiveData(vectorData->data(), vectorData->size());
 192 }
 193
 194 void WorkerThreadableLoader::MainThreadBridge::didReceiveData(const char* data, int lengthReceived)
 195 {
 196     OwnPtr<Vector<char> > vector = adoptPtr(new Vector<char>(lengthReceived)); // needs to be an OwnPtr for usage with createCallbackTask.
 197     memcpy(vector->data(), data, lengthReceived);
 198     m_loaderProxy.postTaskForModeToWorkerContext(createCallbackTask(&workerContextDidReceiveData, m_workerClientWrapper, vector.release()), m_taskMode);
 199 }
 200
 201 static void workerContextDidFinishLoading(ScriptExecutionContext* context, RefPtr<ThreadableLoaderClientWrapper> workerClientWrapper, unsigned long identifier)
 202 {
 203     ASSERT_UNUSED(context, context->isWorkerContext());
 204     workerClientWrapper->didFinishLoading(identifier);
 205 }
 206
 207 void WorkerThreadableLoader::MainThreadBridge::didFinishLoading(unsigned long identifier)
 208 {
 209     m_loaderProxy.postTaskForModeToWorkerContext(createCallbackTask(&workerContextDidFinishLoading, m_workerClientWrapper, identifier), m_taskMode);
 210 }
 211
 212 static void workerContextDidFail(ScriptExecutionContext* context, RefPtr<ThreadableLoaderClientWrapper> workerClientWrapper, const ResourceError& error)
 213 {
 214     ASSERT_UNUSED(context, context->isWorkerContext());
 215     workerClientWrapper->didFail(error);
 216 }
 217
 218 void WorkerThreadableLoader::MainThreadBridge::didFail(const ResourceError& error)
 219 {
 220     m_loaderProxy.postTaskForModeToWorkerContext(createCallbackTask(&workerContextDidFail, m_workerClientWrapper, error), m_taskMode);
 221 }
 222
 223 static void workerContextDidFailRedirectCheck(ScriptExecutionContext* context, RefPtr<ThreadableLoaderClientWrapper> workerClientWrapper)
 224 {
 225     ASSERT_UNUSED(context, context->isWorkerContext());
 226     workerClientWrapper->didFailRedirectCheck();
 227 }
 228
 229 void WorkerThreadableLoader::MainThreadBridge::didFailRedirectCheck()
 230 {
 231     m_loaderProxy.postTaskForModeToWorkerContext(createCallbackTask(&workerContextDidFailRedirectCheck, m_workerClientWrapper), m_taskMode);
 232 }
 233
 234 static void workerContextDidReceiveAuthenticationCancellation(ScriptExecutionContext* context, RefPtr<ThreadableLoaderClientWrapper> workerClientWrapper, PassOwnPtr<CrossThreadResourceResponseData> responseData)
 235 {
 236     ASSERT_UNUSED(context, context->isWorkerContext());
 237     OwnPtr<ResourceResponse> response(ResourceResponse::adopt(responseData));
 238     workerClientWrapper->didReceiveAuthenticationCancellation(*response);
 239 }
 240
 241 void WorkerThreadableLoader::MainThreadBridge::didReceiveAuthenticationCancellation(const ResourceResponse& response)
 242 {
 243     m_loaderProxy.postTaskForModeToWorkerContext(createCallbackTask(&workerContextDidReceiveAuthenticationCancellation, m_workerClientWrapper, response), m_taskMode);
 244 }
 245
 246 } // namespace WebCore
 247
 248 #endif // ENABLE(WORKERS)