blob: 0cd5f41c8e7ed46f54715caa778ef12481a24ba0 [file] [log] [blame]
/*
* Copyright (C) 2009 Google 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:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * 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.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT
* OWNER OR 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 "WebWorkerBase.h"
#include "CrossThreadTask.h"
#include "DatabaseTask.h"
#include "MessagePortChannel.h"
#include "PlatformMessagePortChannel.h"
#include "WebDataSourceImpl.h"
#include "WebFileError.h"
#include "WebFrameClient.h"
#include "WebFrameImpl.h"
#include "WebMessagePortChannel.h"
#include "WebRuntimeFeatures.h"
#include "WebSettings.h"
#include "WebView.h"
#include "WebWorkerClient.h"
#include "WorkerContext.h"
#include "WorkerFileSystemCallbacksBridge.h"
#include "WorkerScriptController.h"
#include "WorkerThread.h"
#include <wtf/MainThread.h>
using namespace WebCore;
namespace WebKit {
#if ENABLE(WORKERS)
static const char allowDatabaseMode[] = "allowDatabaseMode";
static const char openFileSystemMode[] = "openFileSystemMode";
namespace {
// This class is used to route the result of the WebWorkerBase::allowDatabase
// call back to the worker context.
class AllowDatabaseMainThreadBridge : public ThreadSafeRefCounted<AllowDatabaseMainThreadBridge> {
public:
static PassRefPtr<AllowDatabaseMainThreadBridge> create(WebWorkerBase* worker, const WTF::String& mode, WebCommonWorkerClient* commonClient, WebFrame* frame, const WTF::String& name, const WTF::String& displayName, unsigned long estimatedSize)
{
return adoptRef(new AllowDatabaseMainThreadBridge(worker, mode, commonClient, frame, name, displayName, estimatedSize));
}
// These methods are invoked on the worker context.
void cancel()
{
MutexLocker locker(m_mutex);
m_worker = 0;
}
bool result()
{
return m_result;
}
// This method is invoked on the main thread.
void signalCompleted(bool result)
{
MutexLocker locker(m_mutex);
if (m_worker)
m_worker->postTaskForModeToWorkerContext(createCallbackTask(&didComplete, this, result), m_mode);
}
private:
AllowDatabaseMainThreadBridge(WebWorkerBase* worker, const WTF::String& mode, WebCommonWorkerClient* commonClient, WebFrame* frame, const WTF::String& name, const WTF::String& displayName, unsigned long estimatedSize)
: m_worker(worker)
, m_mode(mode)
{
worker->dispatchTaskToMainThread(createCallbackTask(&allowDatabaseTask, commonClient, frame, String(name), String(displayName), estimatedSize, this));
}
static void allowDatabaseTask(WebCore::ScriptExecutionContext* context, WebCommonWorkerClient* commonClient, WebFrame* frame, const WTF::String name, const WTF::String displayName, unsigned long estimatedSize, PassRefPtr<AllowDatabaseMainThreadBridge> bridge)
{
if (!commonClient)
bridge->signalCompleted(false);
else
bridge->signalCompleted(commonClient->allowDatabase(frame, name, displayName, estimatedSize));
}
static void didComplete(WebCore::ScriptExecutionContext* context, PassRefPtr<AllowDatabaseMainThreadBridge> bridge, bool result)
{
bridge->m_result = result;
}
bool m_result;
Mutex m_mutex;
WebWorkerBase* m_worker;
WTF::String m_mode;
};
}
// This function is called on the main thread to force to initialize some static
// values used in WebKit before any worker thread is started. This is because in
// our worker processs, we do not run any WebKit code in main thread and thus
// when multiple workers try to start at the same time, we might hit crash due
// to contention for initializing static values.
static void initializeWebKitStaticValues()
{
static bool initialized = false;
if (!initialized) {
initialized = true;
// Note that we have to pass a URL with valid protocol in order to follow
// the path to do static value initializations.
RefPtr<SecurityOrigin> origin =
SecurityOrigin::create(KURL(ParsedURLString, "http://localhost"));
origin.release();
}
}
WebWorkerBase::WebWorkerBase()
: m_webView(0)
, m_askedToTerminate(false)
{
initializeWebKitStaticValues();
}
WebWorkerBase::~WebWorkerBase()
{
ASSERT(m_webView);
WebFrameImpl* webFrame = static_cast<WebFrameImpl*>(m_webView->mainFrame());
if (webFrame)
webFrame->setClient(0);
m_webView->close();
}
void WebWorkerBase::stopWorkerThread()
{
if (m_askedToTerminate)
return;
m_askedToTerminate = true;
if (m_workerThread)
m_workerThread->stop();
}
void WebWorkerBase::initializeLoader(const WebURL& url)
{
// Create 'shadow page'. This page is never displayed, it is used to proxy the
// loading requests from the worker context to the rest of WebKit and Chromium
// infrastructure.
ASSERT(!m_webView);
m_webView = WebView::create(0);
m_webView->settings()->setOfflineWebApplicationCacheEnabled(WebRuntimeFeatures::isApplicationCacheEnabled());
m_webView->initializeMainFrame(this);
WebFrameImpl* webFrame = static_cast<WebFrameImpl*>(m_webView->mainFrame());
// Construct substitute data source for the 'shadow page'. We only need it
// to have same origin as the worker so the loading checks work correctly.
CString content("");
int len = static_cast<int>(content.length());
RefPtr<SharedBuffer> buf(SharedBuffer::create(content.data(), len));
SubstituteData substData(buf, String("text/html"), String("UTF-8"), KURL());
webFrame->frame()->loader()->load(ResourceRequest(url), substData, false);
// This document will be used as 'loading context' for the worker.
m_loadingDocument = webFrame->frame()->document();
}
void WebWorkerBase::dispatchTaskToMainThread(PassOwnPtr<ScriptExecutionContext::Task> task)
{
callOnMainThread(invokeTaskMethod, task.leakPtr());
}
void WebWorkerBase::invokeTaskMethod(void* param)
{
ScriptExecutionContext::Task* task =
static_cast<ScriptExecutionContext::Task*>(param);
task->performTask(0);
delete task;
}
void WebWorkerBase::didCreateDataSource(WebFrame*, WebDataSource* ds)
{
// Tell the loader to load the data into the 'shadow page' synchronously,
// so we can grab the resulting Document right after load.
static_cast<WebDataSourceImpl*>(ds)->setDeferMainResourceDataLoad(false);
}
WebApplicationCacheHost* WebWorkerBase::createApplicationCacheHost(WebFrame*, WebApplicationCacheHostClient* appcacheHostClient)
{
if (commonClient())
return commonClient()->createApplicationCacheHost(appcacheHostClient);
return 0;
}
bool WebWorkerBase::allowDatabase(WebFrame*, const WebString& name, const WebString& displayName, unsigned long estimatedSize)
{
WorkerRunLoop& runLoop = m_workerThread->runLoop();
WorkerScriptController* controller = WorkerScriptController::controllerForContext();
WorkerContext* workerContext = controller->workerContext();
// Create a unique mode just for this synchronous call.
String mode = allowDatabaseMode;
mode.append(String::number(runLoop.createUniqueId()));
RefPtr<AllowDatabaseMainThreadBridge> bridge = AllowDatabaseMainThreadBridge::create(this, mode, commonClient(), m_webView->mainFrame(), String(name), String(displayName), estimatedSize);
// Either the bridge returns, or the queue gets terminated.
if (runLoop.runInMode(workerContext, mode) == MessageQueueTerminated) {
bridge->cancel();
return false;
}
return bridge->result();
}
#if ENABLE(FILE_SYSTEM)
void WebWorkerBase::openFileSystemForWorker(WebFileSystem::Type type, long long size, bool create, WebFileSystemCallbacks* callbacks, bool synchronous)
{
WorkerRunLoop& runLoop = m_workerThread->runLoop();
WorkerScriptController* controller = WorkerScriptController::controllerForContext();
WorkerContext* workerContext = controller->workerContext();
// Create a unique mode for this openFileSystem call.
String mode = openFileSystemMode;
mode.append(String::number(runLoop.createUniqueId()));
RefPtr<WorkerFileSystemCallbacksBridge> bridge = WorkerFileSystemCallbacksBridge::create(this, workerContext, callbacks);
bridge->postOpenFileSystemToMainThread(commonClient(), type, size, create, mode);
if (synchronous) {
if (runLoop.runInMode(workerContext, mode) == MessageQueueTerminated)
bridge->stop();
}
}
#endif
// WorkerObjectProxy -----------------------------------------------------------
void WebWorkerBase::postMessageToWorkerObject(PassRefPtr<SerializedScriptValue> message,
PassOwnPtr<MessagePortChannelArray> channels)
{
dispatchTaskToMainThread(createCallbackTask(&postMessageTask, this,
message->toWireString(), channels));
}
void WebWorkerBase::postMessageTask(ScriptExecutionContext* context,
WebWorkerBase* thisPtr,
String message,
PassOwnPtr<MessagePortChannelArray> channels)
{
if (!thisPtr->client())
return;
WebMessagePortChannelArray webChannels(channels.get() ? channels->size() : 0);
for (size_t i = 0; i < webChannels.size(); ++i) {
webChannels[i] = (*channels)[i]->channel()->webChannelRelease();
webChannels[i]->setClient(0);
}
thisPtr->client()->postMessageToWorkerObject(message, webChannels);
}
void WebWorkerBase::postExceptionToWorkerObject(const String& errorMessage,
int lineNumber,
const String& sourceURL)
{
dispatchTaskToMainThread(createCallbackTask(&postExceptionTask, this,
errorMessage, lineNumber,
sourceURL));
}
void WebWorkerBase::postExceptionTask(ScriptExecutionContext* context,
WebWorkerBase* thisPtr,
const String& errorMessage,
int lineNumber, const String& sourceURL)
{
if (!thisPtr->commonClient())
return;
thisPtr->commonClient()->postExceptionToWorkerObject(errorMessage,
lineNumber,
sourceURL);
}
void WebWorkerBase::postConsoleMessageToWorkerObject(MessageSource source,
MessageType type,
MessageLevel level,
const String& message,
int lineNumber,
const String& sourceURL)
{
dispatchTaskToMainThread(createCallbackTask(&postConsoleMessageTask, this,
source, type, level,
message, lineNumber, sourceURL));
}
void WebWorkerBase::postConsoleMessageTask(ScriptExecutionContext* context,
WebWorkerBase* thisPtr,
int source,
int type, int level,
const String& message,
int lineNumber,
const String& sourceURL)
{
if (!thisPtr->commonClient())
return;
thisPtr->commonClient()->postConsoleMessageToWorkerObject(source,
type, level, message,
lineNumber, sourceURL);
}
void WebWorkerBase::confirmMessageFromWorkerObject(bool hasPendingActivity)
{
dispatchTaskToMainThread(createCallbackTask(&confirmMessageTask, this,
hasPendingActivity));
}
void WebWorkerBase::confirmMessageTask(ScriptExecutionContext* context,
WebWorkerBase* thisPtr,
bool hasPendingActivity)
{
if (!thisPtr->client())
return;
thisPtr->client()->confirmMessageFromWorkerObject(hasPendingActivity);
}
void WebWorkerBase::reportPendingActivity(bool hasPendingActivity)
{
dispatchTaskToMainThread(createCallbackTask(&reportPendingActivityTask,
this, hasPendingActivity));
}
void WebWorkerBase::reportPendingActivityTask(ScriptExecutionContext* context,
WebWorkerBase* thisPtr,
bool hasPendingActivity)
{
if (!thisPtr->client())
return;
thisPtr->client()->reportPendingActivity(hasPendingActivity);
}
void WebWorkerBase::workerContextClosed()
{
dispatchTaskToMainThread(createCallbackTask(&workerContextClosedTask,
this));
}
void WebWorkerBase::workerContextClosedTask(ScriptExecutionContext* context,
WebWorkerBase* thisPtr)
{
if (thisPtr->commonClient())
thisPtr->commonClient()->workerContextClosed();
thisPtr->stopWorkerThread();
}
void WebWorkerBase::workerContextDestroyed()
{
dispatchTaskToMainThread(createCallbackTask(&workerContextDestroyedTask,
this));
}
void WebWorkerBase::workerContextDestroyedTask(ScriptExecutionContext* context,
WebWorkerBase* thisPtr)
{
if (thisPtr->commonClient())
thisPtr->commonClient()->workerContextDestroyed();
// The lifetime of this proxy is controlled by the worker context.
delete thisPtr;
}
// WorkerLoaderProxy -----------------------------------------------------------
void WebWorkerBase::postTaskToLoader(PassOwnPtr<ScriptExecutionContext::Task> task)
{
ASSERT(m_loadingDocument->isDocument());
m_loadingDocument->postTask(task);
}
void WebWorkerBase::postTaskForModeToWorkerContext(
PassOwnPtr<ScriptExecutionContext::Task> task, const String& mode)
{
m_workerThread->runLoop().postTaskForMode(task, mode);
}
#endif // ENABLE(WORKERS)
} // namespace WebKit