/*

 * Copyright (C) 2006, 2007, 2008 Apple Inc. All rights reserved.

 * Copyright (C) 2008 Collabora Ltd. 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 COMPUTER, INC. ``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 COMPUTER, INC. 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 "PluginView.h"

#include "Document.h"

#include "DocumentLoader.h"

#include "Element.h"

#include "FrameLoader.h"

#include "FrameTree.h"

#include "Frame.h"

#include "FrameView.h"

#include "GraphicsContext.h"

#include "Image.h"

#include "HTMLNames.h"

#include "HTMLPlugInElement.h"

#include "JSDOMWindow.h"

#include "KeyboardEvent.h"

#include "MIMETypeRegistry.h"

#include "MouseEvent.h"

#include "NotImplemented.h"

#include "Page.h"

#include "FocusController.h"

#include "PlatformMouseEvent.h"

#if PLATFORM(WIN_OS) && !PLATFORM(WX) && ENABLE(NETSCAPE_PLUGIN_API)

#include "PluginMessageThrottlerWin.h"

#endif

#include "PluginPackage.h"

#include "JSDOMBinding.h"

#include "ScriptController.h"

#include "ScriptValue.h"

#include "SecurityOrigin.h"

#include "PluginDatabase.h"

#include "PluginDebug.h"

#include "PluginMainThreadScheduler.h"

#include "PluginPackage.h"

#include "RenderBox.h"

#include "RenderObject.h"

#include "c_instance.h"

#include "npruntime_impl.h"

#include "runtime_root.h"

#include "Settings.h"

#include "runtime.h"

#include <runtime/JSLock.h>

#include <runtime/JSValue.h>

#include <wtf/ASCIICType.h>

using JSC::ExecState;

using JSC::JSLock;

using JSC::JSObject;

using JSC::JSValue;

using JSC::UString;

using std::min;

using namespace WTF;

namespace WebCore {

using namespace HTMLNames;

static int s_callingPlugin;

static String scriptStringIfJavaScriptURL(const KURL& url)

{

    if (!protocolIsJavaScript(url))

        return String();

    // This returns an unescaped string

    return decodeURLEscapeSequences(url.string().substring(11));

}

PluginView* PluginView::s_currentPluginView = 0;

void PluginView::popPopupsStateTimerFired(Timer<PluginView>*)

{

    popPopupsEnabledState();

}

IntRect PluginView::windowClipRect() const

{

    // Start by clipping to our bounds.

    IntRect clipRect(m_windowRect);

    // Take our element and get the clip rect from the enclosing layer and frame view.

    RenderLayer* layer = m_element->renderer()->enclosingLayer();

    FrameView* parentView = m_element->document()->view();

    clipRect.intersect(parentView->windowClipRectForLayer(layer, true));

    return clipRect;

}

void PluginView::setFrameRect(const IntRect& rect)

{

    if (m_element->document()->printing())

        return;

    if (rect != frameRect())

        Widget::setFrameRect(rect);

    updatePluginWidget();

#if PLATFORM(WIN_OS) || PLATFORM(SYMBIAN)

    // On Windows and Symbian, always call plugin to change geometry.

    setNPWindowRect(rect);

#elif XP_UNIX

    // On Unix, multiple calls to setNPWindow() in windowed mode causes Flash to crash

    if (m_mode == NP_FULL || !m_isWindowed)

        setNPWindowRect(rect);

#endif

}

void PluginView::frameRectsChanged()

{

    updatePluginWidget();

}

void PluginView::handleEvent(Event* event)

{

    if (!m_plugin || m_isWindowed)

        return;

    if (event->isMouseEvent())

        handleMouseEvent(static_cast<MouseEvent*>(event));

    else if (event->isKeyboardEvent())

        handleKeyboardEvent(static_cast<KeyboardEvent*>(event));

#if defined(Q_WS_X11) && ENABLE(NETSCAPE_PLUGIN_API)

    else if (event->type() == eventNames().DOMFocusOutEvent)

        handleFocusOutEvent();

    else if (event->type() == eventNames().DOMFocusInEvent)

        handleFocusInEvent();

#endif

}

void PluginView::init()

{

    if (m_haveInitialized)

        return;

    m_haveInitialized = true;

    if (!m_plugin) {

        ASSERT(m_status == PluginStatusCanNotFindPlugin);

        return;

    }

    LOG(Plugins, "PluginView::init(): Initializing plug-in '%s'", m_plugin->name().utf8().data());

    if (!m_plugin->load()) {

        m_plugin = 0;

        m_status = PluginStatusCanNotLoadPlugin;

        return;

    }

    if (!startOrAddToUnstartedList()) {

        m_status = PluginStatusCanNotLoadPlugin;

        return;

    }

    m_status = PluginStatusLoadedSuccessfully;

}

bool PluginView::startOrAddToUnstartedList()

{

    if (!m_parentFrame->page())

        return false;

    if (!m_parentFrame->page()->canStartPlugins()) {

        m_parentFrame->page()->addUnstartedPlugin(this);

        m_isWaitingToStart = true;

        return true;

    }

    return start();

}

bool PluginView::start()

{

    if (m_isStarted)

        return false;

    m_isWaitingToStart = false;

    PluginMainThreadScheduler::scheduler().registerPlugin(m_instance);

    ASSERT(m_plugin);

    ASSERT(m_plugin->pluginFuncs()->newp);

    NPError npErr;

    {

        PluginView::setCurrentPluginView(this);

        JSC::JSLock::DropAllLocks dropAllLocks(JSC::SilenceAssertionsOnly);

        setCallingPlugin(true);

        npErr = m_plugin->pluginFuncs()->newp((NPMIMEType)m_mimeType.utf8().data(), m_instance, m_mode, m_paramCount, m_paramNames, m_paramValues, NULL);

        setCallingPlugin(false);

        LOG_NPERROR(npErr);

        PluginView::setCurrentPluginView(0);

    }

    if (npErr != NPERR_NO_ERROR) {

        m_status = PluginStatusCanNotLoadPlugin;

        PluginMainThreadScheduler::scheduler().unregisterPlugin(m_instance);

        return false;

    }

    m_isStarted = true;

    if (!m_url.isEmpty() && !m_loadManually) {

        FrameLoadRequest frameLoadRequest;

        frameLoadRequest.resourceRequest().setHTTPMethod("GET");

        frameLoadRequest.resourceRequest().setURL(m_url);

        load(frameLoadRequest, false, 0);

    }

    m_status = PluginStatusLoadedSuccessfully;

    if (!platformStart())

        m_status = PluginStatusCanNotLoadPlugin;

    if (m_status != PluginStatusLoadedSuccessfully)

        return false;

    if (parentFrame()->page())

        parentFrame()->page()->didStartPlugin(this);

    return true;

}

PluginView::~PluginView()

{

    LOG(Plugins, "PluginView::~PluginView()");

    removeFromUnstartedListIfNecessary();

    stop();

    deleteAllValues(m_requests);

    freeStringArray(m_paramNames, m_paramCount);

    freeStringArray(m_paramValues, m_paramCount);

    platformDestroy();

    m_parentFrame->script()->cleanupScriptObjectsForPlugin(this);

    if (m_plugin && !(m_plugin->quirks().contains(PluginQuirkDontUnloadPlugin)))

        m_plugin->unload();

}

void PluginView::removeFromUnstartedListIfNecessary()

{

    if (!m_isWaitingToStart)

        return;

    if (!m_parentFrame->page())

        return;

    m_parentFrame->page()->removeUnstartedPlugin(this);

}

void PluginView::stop()

{

    if (!m_isStarted)

        return;

    if (parentFrame()->page())

        parentFrame()->page()->didStopPlugin(this);

    LOG(Plugins, "PluginView::stop(): Stopping plug-in '%s'", m_plugin->name().utf8().data());

    HashSet<RefPtr<PluginStream> > streams = m_streams;

    HashSet<RefPtr<PluginStream> >::iterator end = streams.end();

    for (HashSet<RefPtr<PluginStream> >::iterator it = streams.begin(); it != end; ++it) {

        (*it)->stop();

        disconnectStream((*it).get());

    }

    ASSERT(m_streams.isEmpty());

    m_isStarted = false;

    JSC::JSLock::DropAllLocks dropAllLocks(JSC::SilenceAssertionsOnly);

#if ENABLE(NETSCAPE_PLUGIN_API)

#if !PLATFORM(WX) // FIXME: Revisit this when implementing plugins for wx

#ifdef XP_WIN

    // Unsubclass the window

    if (m_isWindowed) {

#if PLATFORM(WINCE)

        WNDPROC currentWndProc = (WNDPROC)GetWindowLong(platformPluginWidget(), GWL_WNDPROC);

        if (currentWndProc == PluginViewWndProc)

            SetWindowLong(platformPluginWidget(), GWL_WNDPROC, (LONG)m_pluginWndProc);

#else

        WNDPROC currentWndProc = (WNDPROC)GetWindowLongPtr(platformPluginWidget(), GWLP_WNDPROC);

        if (currentWndProc == PluginViewWndProc)

            SetWindowLongPtr(platformPluginWidget(), GWLP_WNDPROC, (LONG)m_pluginWndProc);

#endif

    }

#endif // XP_WIN

#endif // !PLATFORM(WX)

#endif // ENABLE(NETSCAPE_PLUGIN_API)

#if !defined(XP_MACOSX)

    // Clear the window

    m_npWindow.window = 0;

    if (m_plugin->pluginFuncs()->setwindow && !m_plugin->quirks().contains(PluginQuirkDontSetNullWindowHandleOnDestroy)) {

        PluginView::setCurrentPluginView(this);

        setCallingPlugin(true);

        m_plugin->pluginFuncs()->setwindow(m_instance, &m_npWindow);

        setCallingPlugin(false);

        PluginView::setCurrentPluginView(0);

    }

#ifdef XP_UNIX

    if (m_isWindowed && m_npWindow.ws_info)

           delete (NPSetWindowCallbackStruct *)m_npWindow.ws_info;

    m_npWindow.ws_info = 0;

#endif

#endif // !defined(XP_MACOSX)

    PluginMainThreadScheduler::scheduler().unregisterPlugin(m_instance);

    NPSavedData* savedData = 0;

    PluginView::setCurrentPluginView(this);

    setCallingPlugin(true);

    NPError npErr = m_plugin->pluginFuncs()->destroy(m_instance, &savedData);

    setCallingPlugin(false);

    LOG_NPERROR(npErr);

    PluginView::setCurrentPluginView(0);

#if ENABLE(NETSCAPE_PLUGIN_API)

    if (savedData) {

        // TODO: Actually save this data instead of just discarding it

        if (savedData->buf)

            NPN_MemFree(savedData->buf);

        NPN_MemFree(savedData);

    }

#endif

    m_instance->pdata = 0;

}

void PluginView::setCurrentPluginView(PluginView* pluginView)

{

    s_currentPluginView = pluginView;

}

PluginView* PluginView::currentPluginView()

{

    return s_currentPluginView;

}

static char* createUTF8String(const String& str)

{

    CString cstr = str.utf8();

    char* result = reinterpret_cast<char*>(fastMalloc(cstr.length() + 1));

    strncpy(result, cstr.data(), cstr.length() + 1);

    return result;

}

static bool getString(ScriptController* proxy, JSValue result, String& string)

{

    if (!proxy || !result || result.isUndefined())

        return false;

    JSLock lock(JSC::SilenceAssertionsOnly);

    ExecState* exec = proxy->globalObject(pluginWorld())->globalExec();

    UString ustring = result.toString(exec);

    exec->clearException();

    string = ustring;

    return true;

}

void PluginView::performRequest(PluginRequest* request)

{

    if (!m_isStarted)

        return;

    // don't let a plugin start any loads if it is no longer part of a document that is being 

    // displayed unless the loads are in the same frame as the plugin.

    const String& targetFrameName = request->frameLoadRequest().frameName();

    if (m_parentFrame->loader()->documentLoader() != m_parentFrame->loader()->activeDocumentLoader() &&

        (targetFrameName.isNull() || m_parentFrame->tree()->find(targetFrameName) != m_parentFrame))

        return;

    KURL requestURL = request->frameLoadRequest().resourceRequest().url();

    String jsString = scriptStringIfJavaScriptURL(requestURL);

    if (jsString.isNull()) {

        // if this is not a targeted request, create a stream for it. otherwise,

        // just pass it off to the loader

        if (targetFrameName.isEmpty()) {

            RefPtr<PluginStream> stream = PluginStream::create(this, m_parentFrame, request->frameLoadRequest().resourceRequest(), request->sendNotification(), request->notifyData(), plugin()->pluginFuncs(), instance(), m_plugin->quirks());

            m_streams.add(stream);

            stream->start();

        } else {

            // If the target frame is our frame, we could destroy the

            // PluginView, so we protect it. <rdar://problem/6991251>

            RefPtr<PluginView> protect(this);

            m_parentFrame->loader()->load(request->frameLoadRequest().resourceRequest(), targetFrameName, false);

            // FIXME: <rdar://problem/4807469> This should be sent when the document has finished loading

            if (request->sendNotification()) {

                PluginView::setCurrentPluginView(this);

                JSC::JSLock::DropAllLocks dropAllLocks(JSC::SilenceAssertionsOnly);

                setCallingPlugin(true);

                m_plugin->pluginFuncs()->urlnotify(m_instance, requestURL.string().utf8().data(), NPRES_DONE, request->notifyData());

                setCallingPlugin(false);

                PluginView::setCurrentPluginView(0);

            }

        }

        return;

    }

    // Targeted JavaScript requests are only allowed on the frame that contains the JavaScript plugin

    // and this has been made sure in ::load.

    ASSERT(targetFrameName.isEmpty() || m_parentFrame->tree()->find(targetFrameName) == m_parentFrame);

    // Executing a script can cause the plugin view to be destroyed, so we keep a reference to the parent frame.

    RefPtr<Frame> parentFrame = m_parentFrame;

    JSValue result = m_parentFrame->script()->executeScript(jsString, request->shouldAllowPopups()).jsValue();

    if (targetFrameName.isNull()) {

        String resultString;

        CString cstr;

        if (getString(parentFrame->script(), result, resultString))

            cstr = resultString.utf8();

        RefPtr<PluginStream> stream = PluginStream::create(this, m_parentFrame, request->frameLoadRequest().resourceRequest(), request->sendNotification(), request->notifyData(), plugin()->pluginFuncs(), instance(), m_plugin->quirks());

        m_streams.add(stream);

        stream->sendJavaScriptStream(requestURL, cstr);

    }

}

void PluginView::requestTimerFired(Timer<PluginView>* timer)

{

    ASSERT(timer == &m_requestTimer);

    ASSERT(m_requests.size() > 0);

    ASSERT(!m_isJavaScriptPaused);

    PluginRequest* request = m_requests[0];

    m_requests.remove(0);

    // Schedule a new request before calling performRequest since the call to

    // performRequest can cause the plugin view to be deleted.

    if (m_requests.size() > 0)

        m_requestTimer.startOneShot(0);

    performRequest(request);

    delete request;

}

void PluginView::scheduleRequest(PluginRequest* request)

{

    m_requests.append(request);

    if (!m_isJavaScriptPaused)

        m_requestTimer.startOneShot(0);

}

NPError PluginView::load(const FrameLoadRequest& frameLoadRequest, bool sendNotification, void* notifyData)

{

    ASSERT(frameLoadRequest.resourceRequest().httpMethod() == "GET" || frameLoadRequest.resourceRequest().httpMethod() == "POST");

    KURL url = frameLoadRequest.resourceRequest().url();

    if (url.isEmpty())

        return NPERR_INVALID_URL;

    // Don't allow requests to be made when the document loader is stopping all loaders.

    if (m_parentFrame->loader()->documentLoader()->isStopping())

        return NPERR_GENERIC_ERROR;

    const String& targetFrameName = frameLoadRequest.frameName();

    String jsString = scriptStringIfJavaScriptURL(url);

    if (!jsString.isNull()) {

        Settings* settings = m_parentFrame->settings();

        // Return NPERR_GENERIC_ERROR if JS is disabled. This is what Mozilla does.

        if (!settings || !settings->isJavaScriptEnabled())

            return NPERR_GENERIC_ERROR;

        // For security reasons, only allow JS requests to be made on the frame that contains the plug-in.

        if (!targetFrameName.isNull() && m_parentFrame->tree()->find(targetFrameName) != m_parentFrame)

            return NPERR_INVALID_PARAM;

    } else if (!SecurityOrigin::canLoad(url, String(), m_parentFrame->document()))

            return NPERR_GENERIC_ERROR;

    PluginRequest* request = new PluginRequest(frameLoadRequest, sendNotification, notifyData, arePopupsAllowed());

    scheduleRequest(request);

    return NPERR_NO_ERROR;

}