/*

 * Copyright (C) 2006, 2007, 2008, 2009, 2010 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.

 * 3.  Neither the name of Apple Computer, Inc. ("Apple") 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 APPLE 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 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 "LayoutTestController.h"

#include "DumpRenderTree.h"

#include "EditingDelegate.h"

#include "PolicyDelegate.h"

#include "WorkQueue.h"

#include "WorkQueueItem.h"

#include <CoreFoundation/CoreFoundation.h>

#include <JavaScriptCore/Assertions.h>

#include <JavaScriptCore/JSRetainPtr.h>

#include <JavaScriptCore/JSStringRefBSTR.h>

#include <JavaScriptCore/JavaScriptCore.h>

#include <WebCore/COMPtr.h>

#include <WebKit/WebKit.h>

#include <WebKit/WebKitCOMAPI.h>

#include <comutil.h>

#include <shlwapi.h>

#include <shlguid.h>

#include <shobjidl.h>

#include <string>

#include <wtf/Platform.h>

#include <wtf/RetainPtr.h>

#include <wtf/Vector.h>

using std::string;

using std::wstring;

static bool resolveCygwinPath(const wstring& cygwinPath, wstring& windowsPath);

LayoutTestController::~LayoutTestController()

{

    COMPtr<IWebView> webView;

    if (FAILED(frame->webView(&webView)))

        return;

    // reset webview-related states back to default values in preparation for next test

    COMPtr<IWebViewPrivate> viewPrivate;

    if (SUCCEEDED(webView->QueryInterface(&viewPrivate)))

        viewPrivate->setTabKeyCyclesThroughElements(TRUE);

    COMPtr<IWebViewEditing> viewEditing;

    if (FAILED(webView->QueryInterface(&viewEditing)))

        return;

    COMPtr<IWebEditingDelegate> delegate;

    if (FAILED(viewEditing->editingDelegate(&delegate)))

        return;

    COMPtr<EditingDelegate> editingDelegate(Query, viewEditing.get());

    if (editingDelegate)

        editingDelegate->setAcceptsEditing(TRUE);

}

void LayoutTestController::addDisallowedURL(JSStringRef url)

{

    // FIXME: Implement!

}

void LayoutTestController::clearBackForwardList()

{

    COMPtr<IWebView> webView;

    if (FAILED(frame->webView(&webView)))

        return;

    COMPtr<IWebBackForwardList> backForwardList;

    if (FAILED(webView->backForwardList(&backForwardList)))

        return;

    COMPtr<IWebHistoryItem> item;

    if (FAILED(backForwardList->currentItem(&item)))

        return;

    // We clear the history by setting the back/forward list's capacity to 0

    // then restoring it back and adding back the current item.

    int capacity;

    if (FAILED(backForwardList->capacity(&capacity)))

        return;

    backForwardList->setCapacity(0);

    backForwardList->setCapacity(capacity);

    backForwardList->addItem(item.get());

    backForwardList->goToItem(item.get());

}

bool LayoutTestController::callShouldCloseOnWebView()

{

    COMPtr<IWebView> webView;

    if (FAILED(frame->webView(&webView)))

        return false;

    COMPtr<IWebViewPrivate> viewPrivate;

    if (FAILED(webView->QueryInterface(&viewPrivate)))

        return false;

    BOOL result;

    viewPrivate->shouldClose(&result);

    return result;

}

JSStringRef LayoutTestController::copyDecodedHostName(JSStringRef name)

{

    // FIXME: Implement!

    return 0;

}

JSStringRef LayoutTestController::copyEncodedHostName(JSStringRef name)

{

    // FIXME: Implement!

    return 0;

}

void LayoutTestController::disableImageLoading()

{

    COMPtr<IWebView> webView;

    if (FAILED(frame->webView(&webView)))

        return;

    COMPtr<IWebPreferences> preferences;

    if (FAILED(webView->preferences(&preferences)))

        return;

    preferences->setLoadsImagesAutomatically(FALSE);

}

void LayoutTestController::dispatchPendingLoadRequests()

{

    // FIXME: Implement for testing fix for 6727495

}

void LayoutTestController::display()

{

    displayWebView();

}

void LayoutTestController::keepWebHistory()

{

    COMPtr<IWebHistory> history;

    if (FAILED(WebKitCreateInstance(CLSID_WebHistory, 0, __uuidof(history), reinterpret_cast<void**>(&history))))

        return;

    COMPtr<IWebHistory> sharedHistory;

    if (FAILED(WebKitCreateInstance(CLSID_WebHistory, 0, __uuidof(sharedHistory), reinterpret_cast<void**>(&sharedHistory))))

        return;

    history->setOptionalSharedHistory(sharedHistory.get());

}

JSValueRef LayoutTestController::computedStyleIncludingVisitedInfo(JSContextRef context, JSValueRef value)

{

    // FIXME: Implement this.

    return JSValueMakeUndefined(context);

}

JSRetainPtr<JSStringRef> LayoutTestController::layerTreeAsText() const

{

    COMPtr<IWebFramePrivate> framePrivate(Query, frame);

    if (!framePrivate)

        return false;

    BSTR textBSTR = 0;

    HRESULT hr = framePrivate->layerTreeAsText(&textBSTR);

    wstring text(textBSTR, SysStringLen(textBSTR));

    SysFreeString(textBSTR);

    JSRetainPtr<JSStringRef> textValueJS(Adopt, JSStringCreateWithCharacters(text.data(), text.length()));

    return textValueJS;

}

JSRetainPtr<JSStringRef> LayoutTestController::markerTextForListItem(JSContextRef context, JSValueRef nodeObject) const

{

    COMPtr<IWebView> webView;

    if (FAILED(frame->webView(&webView)))

        return 0;

    COMPtr<IWebViewPrivate> webViewPrivate(Query, webView);

    if (!webViewPrivate)

        return 0;

    COMPtr<IDOMElement> element;

    if (FAILED(webViewPrivate->elementFromJS(context, nodeObject, &element)))

        return 0;

    COMPtr<IDOMElementPrivate> elementPrivate(Query, element);

    if (!elementPrivate)

        return 0;

    BSTR textBSTR = 0;

    if (FAILED(elementPrivate->markerTextForListItem(&textBSTR)))

        return 0;

    JSRetainPtr<JSStringRef> markerText(Adopt, JSStringCreateWithBSTR(textBSTR));

    SysFreeString(textBSTR);

    return markerText;

}

void LayoutTestController::waitForPolicyDelegate()

{

    // FIXME: Implement this.

}

size_t LayoutTestController::webHistoryItemCount()

{

    COMPtr<IWebHistory> history;

    if (FAILED(WebKitCreateInstance(CLSID_WebHistory, 0, __uuidof(history), reinterpret_cast<void**>(&history))))

        return 0;

    COMPtr<IWebHistory> sharedHistory;

    if (FAILED(history->optionalSharedHistory(&sharedHistory)) || !sharedHistory)

        return 0;

    COMPtr<IWebHistoryPrivate> sharedHistoryPrivate;

    if (FAILED(sharedHistory->QueryInterface(&sharedHistoryPrivate)))

        return 0;

    int count;

    if (FAILED(sharedHistoryPrivate->allItems(&count, 0)))

        return 0;

    return count;

}

unsigned LayoutTestController::workerThreadCount() const

{

    COMPtr<IWebWorkersPrivate> workers;

    if (FAILED(WebKitCreateInstance(CLSID_WebWorkersPrivate, 0, __uuidof(workers), reinterpret_cast<void**>(&workers))))

        return 0;

    unsigned count;

    if (FAILED(workers->workerThreadCount(&count)))

        return 0;

    return count;

}

void LayoutTestController::notifyDone()

{

    // Same as on mac.  This can be shared.

    if (m_waitToDump && !topLoadingFrame && !WorkQueue::shared()->count())

        dump();

    m_waitToDump = false;

}

JSStringRef LayoutTestController::pathToLocalResource(JSContextRef context, JSStringRef url)

{

    wstring input(JSStringGetCharactersPtr(url), JSStringGetLength(url));

    wstring localPath;

    if (!resolveCygwinPath(input, localPath)) {

        printf("ERROR: Failed to resolve Cygwin path %S\n", input.c_str());

        return 0;

    }

    return JSStringCreateWithCharacters(localPath.c_str(), localPath.length());

}

static wstring jsStringRefToWString(JSStringRef jsStr)

{

    size_t length = JSStringGetLength(jsStr);

    Vector<WCHAR> buffer(length + 1);

    memcpy(buffer.data(), JSStringGetCharactersPtr(jsStr), length * sizeof(WCHAR));

    buffer[length] = '\0';

    return buffer.data();

}

void LayoutTestController::queueLoad(JSStringRef url, JSStringRef target)

{

    COMPtr<IWebDataSource> dataSource;

    if (FAILED(frame->dataSource(&dataSource)))

        return;

    COMPtr<IWebURLResponse> response;

    if (FAILED(dataSource->response(&response)) || !response)

        return;

    BSTR responseURLBSTR;

    if (FAILED(response->URL(&responseURLBSTR)))

        return;

    wstring responseURL(responseURLBSTR, SysStringLen(responseURLBSTR));

    SysFreeString(responseURLBSTR);

    // FIXME: We should do real relative URL resolution here.

    int lastSlash = responseURL.rfind('/');

    if (lastSlash != -1)

        responseURL = responseURL.substr(0, lastSlash);

    wstring wURL = jsStringRefToWString(url);

    wstring wAbsoluteURL = responseURL + TEXT("/") + wURL;

    JSRetainPtr<JSStringRef> jsAbsoluteURL(Adopt, JSStringCreateWithCharacters(wAbsoluteURL.data(), wAbsoluteURL.length()));

    WorkQueue::shared()->queue(new LoadItem(jsAbsoluteURL.get(), target));

}

void LayoutTestController::setAcceptsEditing(bool acceptsEditing)

{

    COMPtr<IWebView> webView;

    if (FAILED(frame->webView(&webView)))

        return;

    COMPtr<IWebViewEditing> viewEditing;

    if (FAILED(webView->QueryInterface(&viewEditing)))

        return;

    COMPtr<IWebEditingDelegate> delegate;

    if (FAILED(viewEditing->editingDelegate(&delegate)))

        return;

    EditingDelegate* editingDelegate = (EditingDelegate*)(IWebEditingDelegate*)delegate.get();

    editingDelegate->setAcceptsEditing(acceptsEditing);

}

void LayoutTestController::setAlwaysAcceptCookies(bool alwaysAcceptCookies)

{

    if (alwaysAcceptCookies == m_alwaysAcceptCookies)

        return;

    if (!::setAlwaysAcceptCookies(alwaysAcceptCookies))

        return;

    m_alwaysAcceptCookies = alwaysAcceptCookies;

}

void LayoutTestController::setAuthorAndUserStylesEnabled(bool flag)

{

    COMPtr<IWebView> webView;

    if (FAILED(frame->webView(&webView)))

        return;

    COMPtr<IWebPreferences> preferences;

    if (FAILED(webView->preferences(&preferences)))

        return;

    COMPtr<IWebPreferencesPrivate> prefsPrivate(Query, preferences);

    if (!prefsPrivate)

        return;

    prefsPrivate->setAuthorAndUserStylesEnabled(flag);

}

void LayoutTestController::setCustomPolicyDelegate(bool setDelegate, bool permissive)

{

    COMPtr<IWebView> webView;

    if (FAILED(frame->webView(&webView)))

        return;

    if (setDelegate) {

        policyDelegate->setPermissive(permissive);

        webView->setPolicyDelegate(policyDelegate);

    } else

        webView->setPolicyDelegate(0);

}

void LayoutTestController::setMockGeolocationPosition(double latitude, double longitude, double accuracy)

{

    // FIXME: Implement for Geolocation layout tests.

    // See https://bugs.webkit.org/show_bug.cgi?id=28264.

}

void LayoutTestController::setMockGeolocationError(int code, JSStringRef message)

{

    // FIXME: Implement for Geolocation layout tests.

    // See https://bugs.webkit.org/show_bug.cgi?id=28264.

}

void LayoutTestController::setIconDatabaseEnabled(bool iconDatabaseEnabled)

{

    // See also <rdar://problem/6480108>

    COMPtr<IWebIconDatabase> iconDatabase;

    COMPtr<IWebIconDatabase> tmpIconDatabase;

    if (FAILED(WebKitCreateInstance(CLSID_WebIconDatabase, 0, IID_IWebIconDatabase, (void**)&tmpIconDatabase)))

        return;

    if (FAILED(tmpIconDatabase->sharedIconDatabase(&iconDatabase)))

        return;

    iconDatabase->setEnabled(iconDatabaseEnabled);

}

void LayoutTestController::setMainFrameIsFirstResponder(bool flag)

{

    // FIXME: Implement!

}

void LayoutTestController::setPrivateBrowsingEnabled(bool privateBrowsingEnabled)

{

    COMPtr<IWebView> webView;

    if (FAILED(frame->webView(&webView)))

        return;

    COMPtr<IWebPreferences> preferences;

    if (FAILED(webView->preferences(&preferences)))

        return;

    preferences->setPrivateBrowsingEnabled(privateBrowsingEnabled);

}

void LayoutTestController::setXSSAuditorEnabled(bool enabled)

{

    COMPtr<IWebView> webView;

    if (FAILED(frame->webView(&webView)))

        return;

    COMPtr<IWebPreferences> preferences;

    if (FAILED(webView->preferences(&preferences)))

        return;

    COMPtr<IWebPreferencesPrivate> prefsPrivate(Query, preferences);

    if (!prefsPrivate)

        return;

    prefsPrivate->setXSSAuditorEnabled(enabled);

}

void LayoutTestController::setFrameFlatteningEnabled(bool enabled)

{

    COMPtr<IWebView> webView;

    if (FAILED(frame->webView(&webView)))

        return;

    COMPtr<IWebPreferences> preferences;

    if (FAILED(webView->preferences(&preferences)))

        return;

    COMPtr<IWebPreferencesPrivate> prefsPrivate(Query, preferences);

    if (!prefsPrivate)

        return;

    prefsPrivate->setFrameFlatteningEnabled(enabled);

}

void LayoutTestController::setSpatialNavigationEnabled(bool enabled)

{

    // FIXME: Implement for SpatialNavigation layout tests.

}

void LayoutTestController::setAllowUniversalAccessFromFileURLs(bool enabled)

{

    COMPtr<IWebView> webView;

    if (FAILED(frame->webView(&webView)))

        return;

    COMPtr<IWebPreferences> preferences;

    if (FAILED(webView->preferences(&preferences)))

        return;

    COMPtr<IWebPreferencesPrivate> prefsPrivate(Query, preferences);

    if (!prefsPrivate)

        return;

    prefsPrivate->setAllowUniversalAccessFromFileURLs(enabled);

}

void LayoutTestController::setAllowFileAccessFromFileURLs(bool enabled)

{

    COMPtr<IWebView> webView;

    if (FAILED(frame->webView(&webView)))

        return;

    COMPtr<IWebPreferences> preferences;

    if (FAILED(webView->preferences(&preferences)))

        return;

    COMPtr<IWebPreferencesPrivate> prefsPrivate(Query, preferences);

    if (!prefsPrivate)

        return;

    prefsPrivate->setAllowFileAccessFromFileURLs(enabled);

}

void LayoutTestController::setPopupBlockingEnabled(bool enabled)

{

    COMPtr<IWebView> webView;

    if (FAILED(frame->webView(&webView)))

        return;

    COMPtr<IWebPreferences> preferences;

    if (FAILED(webView->preferences(&preferences)))

        return;

    preferences->setJavaScriptCanOpenWindowsAutomatically(!enabled);

}

void LayoutTestController::setPluginsEnabled(bool flag)

{

    // FIXME: Implement

}

void LayoutTestController::setJavaScriptCanAccessClipboard(bool enabled)

{

    COMPtr<IWebView> webView;

    if (FAILED(frame->webView(&webView)))

        return;

    COMPtr<IWebPreferences> preferences;

    if (FAILED(webView->preferences(&preferences)))

        return;

    COMPtr<IWebPreferencesPrivate> prefsPrivate(Query, preferences);

    if (!prefsPrivate)

        return;

    prefsPrivate->setJavaScriptCanAccessClipboard(enabled);

}

void LayoutTestController::setTabKeyCyclesThroughElements(bool shouldCycle)