Home | History | Annotate | Download | only in loader
      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 "Document.h"
     38 #include "DocumentThreadableLoader.h"
     39 #include "CrossThreadTask.h"
     40 #include "ResourceError.h"
     41 #include "ResourceRequest.h"
     42 #include "ResourceResponse.h"
     43 #include "ThreadableLoader.h"
     44 #include "WorkerContext.h"
     45 #include "WorkerLoaderProxy.h"
     46 #include "WorkerThread.h"
     47 #include <wtf/OwnPtr.h>
     48 #include <wtf/Threading.h>
     49 #include <wtf/Vector.h>
     50 
     51 using namespace std;
     52 
     53 namespace WebCore {
     54 
     55 static const char loadResourceSynchronouslyMode[] = "loadResourceSynchronouslyMode";
     56 
     57 WorkerThreadableLoader::WorkerThreadableLoader(WorkerContext* workerContext, ThreadableLoaderClient* client, const String& taskMode, const ResourceRequest& request, const ThreadableLoaderOptions& options)
     58     : m_workerContext(workerContext)
     59     , m_workerClientWrapper(ThreadableLoaderClientWrapper::create(client))
     60     , m_bridge(*(new MainThreadBridge(m_workerClientWrapper, m_workerContext->thread()->workerLoaderProxy(), taskMode, request, options, workerContext->url().strippedForUseAsReferrer())))
     61 {
     62 }
     63 
     64 WorkerThreadableLoader::~WorkerThreadableLoader()
     65 {
     66     m_bridge.destroy();
     67 }
     68 
     69 void WorkerThreadableLoader::loadResourceSynchronously(WorkerContext* workerContext, const ResourceRequest& request, ThreadableLoaderClient& client, const ThreadableLoaderOptions& options)
     70 {
     71     WorkerRunLoop& runLoop = workerContext->thread()->runLoop();
     72 
     73     // Create a unique mode just for this synchronous resource load.
     74     String mode = loadResourceSynchronouslyMode;
     75     mode.append(String::number(runLoop.createUniqueId()));
     76 
     77     RefPtr<WorkerThreadableLoader> loader = WorkerThreadableLoader::create(workerContext, &client, mode, request, options);
     78     MessageQueueWaitResult result = MessageQueueMessageReceived;
     79     while (!loader->done() && result != MessageQueueTerminated)
     80         result = runLoop.runInMode(workerContext, mode);
     81 
     82     if (!loader->done() && result == MessageQueueTerminated)
     83         loader->cancel();
     84 }
     85 
     86 void WorkerThreadableLoader::cancel()
     87 {
     88     m_bridge.cancel();
     89 }
     90 
     91 WorkerThreadableLoader::MainThreadBridge::MainThreadBridge(PassRefPtr<ThreadableLoaderClientWrapper> workerClientWrapper, WorkerLoaderProxy& loaderProxy, const String& taskMode,
     92                                                            const ResourceRequest& request, const ThreadableLoaderOptions& options, const String& outgoingReferrer)
     93     : m_workerClientWrapper(workerClientWrapper)
     94     , m_loaderProxy(loaderProxy)
     95     , m_taskMode(taskMode.crossThreadString())
     96 {
     97     ASSERT(m_workerClientWrapper.get());
     98     m_loaderProxy.postTaskToLoader(createCallbackTask(&MainThreadBridge::mainThreadCreateLoader, this, request, options, outgoingReferrer));
     99 }
    100 
    101 WorkerThreadableLoader::MainThreadBridge::~MainThreadBridge()
    102 {
    103 }
    104 
    105 void WorkerThreadableLoader::MainThreadBridge::mainThreadCreateLoader(ScriptExecutionContext* context, MainThreadBridge* thisPtr, PassOwnPtr<CrossThreadResourceRequestData> requestData, ThreadableLoaderOptions options, const String& outgoingReferrer)
    106 {
    107     ASSERT(isMainThread());
    108     ASSERT(context->isDocument());
    109     Document* document = static_cast<Document*>(context);
    110 
    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 = DocumentThreadableLoader::create(document, thisPtr, *request, options, outgoingReferrer);
    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 dataLength)
    195 {
    196     OwnPtr<Vector<char> > vector = adoptPtr(new Vector<char>(dataLength)); // needs to be an OwnPtr for usage with createCallbackTask.
    197     memcpy(vector->data(), data, dataLength);
    198     m_loaderProxy.postTaskForModeToWorkerContext(createCallbackTask(&workerContextDidReceiveData, m_workerClientWrapper, vector.release()), m_taskMode);
    199 }
    200 
    201 static void workerContextDidReceiveCachedMetadata(ScriptExecutionContext* context, RefPtr<ThreadableLoaderClientWrapper> workerClientWrapper, PassOwnPtr<Vector<char> > vectorData)
    202 {
    203     ASSERT_UNUSED(context, context->isWorkerContext());
    204     workerClientWrapper->didReceiveCachedMetadata(vectorData->data(), vectorData->size());
    205 }
    206 
    207 void WorkerThreadableLoader::MainThreadBridge::didReceiveCachedMetadata(const char* data, int dataLength)
    208 {
    209     OwnPtr<Vector<char> > vector = adoptPtr(new Vector<char>(dataLength)); // needs to be an OwnPtr for usage with createCallbackTask.
    210     memcpy(vector->data(), data, dataLength);
    211     m_loaderProxy.postTaskForModeToWorkerContext(createCallbackTask(&workerContextDidReceiveCachedMetadata, m_workerClientWrapper, vector.release()), m_taskMode);
    212 }
    213 
    214 static void workerContextDidFinishLoading(ScriptExecutionContext* context, RefPtr<ThreadableLoaderClientWrapper> workerClientWrapper, unsigned long identifier, double finishTime)
    215 {
    216     ASSERT_UNUSED(context, context->isWorkerContext());
    217     workerClientWrapper->didFinishLoading(identifier, finishTime);
    218 }
    219 
    220 void WorkerThreadableLoader::MainThreadBridge::didFinishLoading(unsigned long identifier, double finishTime)
    221 {
    222     m_loaderProxy.postTaskForModeToWorkerContext(createCallbackTask(&workerContextDidFinishLoading, m_workerClientWrapper, identifier, finishTime), m_taskMode);
    223 }
    224 
    225 static void workerContextDidFail(ScriptExecutionContext* context, RefPtr<ThreadableLoaderClientWrapper> workerClientWrapper, const ResourceError& error)
    226 {
    227     ASSERT_UNUSED(context, context->isWorkerContext());
    228     workerClientWrapper->didFail(error);
    229 }
    230 
    231 void WorkerThreadableLoader::MainThreadBridge::didFail(const ResourceError& error)
    232 {
    233     m_loaderProxy.postTaskForModeToWorkerContext(createCallbackTask(&workerContextDidFail, m_workerClientWrapper, error), m_taskMode);
    234 }
    235 
    236 static void workerContextDidFailRedirectCheck(ScriptExecutionContext* context, RefPtr<ThreadableLoaderClientWrapper> workerClientWrapper)
    237 {
    238     ASSERT_UNUSED(context, context->isWorkerContext());
    239     workerClientWrapper->didFailRedirectCheck();
    240 }
    241 
    242 void WorkerThreadableLoader::MainThreadBridge::didFailRedirectCheck()
    243 {
    244     m_loaderProxy.postTaskForModeToWorkerContext(createCallbackTask(&workerContextDidFailRedirectCheck, m_workerClientWrapper), m_taskMode);
    245 }
    246 
    247 static void workerContextDidReceiveAuthenticationCancellation(ScriptExecutionContext* context, RefPtr<ThreadableLoaderClientWrapper> workerClientWrapper, PassOwnPtr<CrossThreadResourceResponseData> responseData)
    248 {
    249     ASSERT_UNUSED(context, context->isWorkerContext());
    250     OwnPtr<ResourceResponse> response(ResourceResponse::adopt(responseData));
    251     workerClientWrapper->didReceiveAuthenticationCancellation(*response);
    252 }
    253 
    254 void WorkerThreadableLoader::MainThreadBridge::didReceiveAuthenticationCancellation(const ResourceResponse& response)
    255 {
    256     m_loaderProxy.postTaskForModeToWorkerContext(createCallbackTask(&workerContextDidReceiveAuthenticationCancellation, m_workerClientWrapper, response), m_taskMode);
    257 }
    258 
    259 } // namespace WebCore
    260 
    261 #endif // ENABLE(WORKERS)
    262