/*

 * Copyright (C) 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.

 *

 * THIS SOFTWARE IS PROVIDED BY APPLE 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 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. 

 */

#if USE(PLUGIN_HOST_PROCESS)

#import "NetscapePluginInstanceProxy.h"

#import "HostedNetscapePluginStream.h"

#import "NetscapePluginHostProxy.h"

#import "ProxyInstance.h"

#import "ProxyRuntimeObject.h"

#import "WebDataSourceInternal.h"

#import "WebFrameInternal.h"

#import "WebHostedNetscapePluginView.h"

#import "WebKitNSStringExtras.h"

#import "WebNSDataExtras.h"

#import "WebNSURLExtras.h"

#import "WebPluginRequest.h"

#import "WebUIDelegate.h"

#import "WebUIDelegatePrivate.h"

#import "WebViewInternal.h"

#import <JavaScriptCore/Error.h>

#import <JavaScriptCore/JSLock.h>

#import <JavaScriptCore/PropertyNameArray.h>

#import <WebCore/CookieJar.h>

#import <WebCore/DocumentLoader.h>

#import <WebCore/Frame.h>

#import <WebCore/FrameLoader.h>

#import <WebCore/FrameTree.h>

#import <WebCore/KURL.h>

#import <WebCore/SecurityOrigin.h>

#import <WebCore/ScriptController.h>

#import <WebCore/ScriptValue.h>

#import <WebCore/StringSourceProvider.h>

#import <WebCore/npruntime_impl.h>

#import <WebCore/runtime_object.h>

#import <WebKitSystemInterface.h>

#import <mach/mach.h>

#import <utility>

#import <wtf/RefCountedLeakCounter.h>

#import <wtf/text/CString.h>

extern "C" {

#import "WebKitPluginClientServer.h"

#import "WebKitPluginHost.h"

}

using namespace JSC;

using namespace JSC::Bindings;

using namespace std;

using namespace WebCore;

namespace WebKit {

class NetscapePluginInstanceProxy::PluginRequest : public RefCounted<NetscapePluginInstanceProxy::PluginRequest> {

public:

    static PassRefPtr<PluginRequest> create(uint32_t requestID, NSURLRequest* request, NSString* frameName, bool allowPopups)

    {

        return adoptRef(new PluginRequest(requestID, request, frameName, allowPopups));

    }

    uint32_t requestID() const { return m_requestID; }

    NSURLRequest* request() const { return m_request.get(); }

    NSString* frameName() const { return m_frameName.get(); }

    bool allowPopups() const { return m_allowPopups; }

private:

    PluginRequest(uint32_t requestID, NSURLRequest* request, NSString* frameName, bool allowPopups)

        : m_requestID(requestID)

        , m_request(request)

        , m_frameName(frameName)

        , m_allowPopups(allowPopups)

    {

    }

    uint32_t m_requestID;

    RetainPtr<NSURLRequest*> m_request;

    RetainPtr<NSString*> m_frameName;

    bool m_allowPopups;

};

NetscapePluginInstanceProxy::LocalObjectMap::LocalObjectMap()

    : m_objectIDCounter(0)

{

}

NetscapePluginInstanceProxy::LocalObjectMap::~LocalObjectMap()

{

}

inline bool NetscapePluginInstanceProxy::LocalObjectMap::contains(uint32_t objectID) const

{

    return m_idToJSObjectMap.contains(objectID);

}

inline JSC::JSObject* NetscapePluginInstanceProxy::LocalObjectMap::get(uint32_t objectID) const

{

    if (objectID == HashTraits<uint32_t>::emptyValue() || HashTraits<uint32_t>::isDeletedValue(objectID))

        return 0;

    return m_idToJSObjectMap.get(objectID);

}

uint32_t NetscapePluginInstanceProxy::LocalObjectMap::idForObject(JSObject* object)

{

    // This method creates objects with refcount of 1, but doesn't increase refcount when returning

    // found objects. This extra count accounts for the main "reference" kept by plugin process.

    // To avoid excessive IPC, plugin process doesn't send each NPObject release/retain call to

    // Safari. It only sends one when the last reference is removed, and it can destroy the proxy

    // NPObject.

    // However, the browser may be sending the same object out to plug-in as a function call

    // argument at the same time - neither side can know what the other one is doing. So,

    // is to make PCForgetBrowserObject call return a boolean result, making it possible for 

    // the browser to make plugin host keep the proxy with zero refcount for a little longer.

    uint32_t objectID = 0;

    HashMap<JSC::JSObject*, pair<uint32_t, uint32_t> >::iterator iter = m_jsObjectToIDMap.find(object);

    if (iter != m_jsObjectToIDMap.end())

        return iter->second.first;

    do {

        objectID = ++m_objectIDCounter;

    } while (!m_objectIDCounter || m_objectIDCounter == static_cast<uint32_t>(-1) || m_idToJSObjectMap.contains(objectID));

    m_idToJSObjectMap.set(objectID, object);

    m_jsObjectToIDMap.set(object, make_pair<uint32_t, uint32_t>(objectID, 1));

    return objectID;

}

void NetscapePluginInstanceProxy::LocalObjectMap::retain(JSC::JSObject* object)

{

    HashMap<JSC::JSObject*, pair<uint32_t, uint32_t> >::iterator iter = m_jsObjectToIDMap.find(object);

    ASSERT(iter != m_jsObjectToIDMap.end());

    iter->second.second = iter->second.second + 1;

}

void NetscapePluginInstanceProxy::LocalObjectMap::release(JSC::JSObject* object)

{

    HashMap<JSC::JSObject*, pair<uint32_t, uint32_t> >::iterator iter = m_jsObjectToIDMap.find(object);

    ASSERT(iter != m_jsObjectToIDMap.end());

    ASSERT(iter->second.second > 0);

    iter->second.second = iter->second.second - 1;

    if (!iter->second.second) {

        m_idToJSObjectMap.remove(iter->second.first);

        m_jsObjectToIDMap.remove(iter);

    }

}

void NetscapePluginInstanceProxy::LocalObjectMap::clear()

{

    m_idToJSObjectMap.clear();

    m_jsObjectToIDMap.clear();

}

bool NetscapePluginInstanceProxy::LocalObjectMap::forget(uint32_t objectID)

{

    if (objectID == HashTraits<uint32_t>::emptyValue() || HashTraits<uint32_t>::isDeletedValue(objectID)) {

        LOG_ERROR("NetscapePluginInstanceProxy::LocalObjectMap::forget: local object id %u is not valid.", objectID);

        return true;

    }

    HashMap<uint32_t, JSC::ProtectedPtr<JSC::JSObject> >::iterator iter = m_idToJSObjectMap.find(objectID);

    if (iter == m_idToJSObjectMap.end()) {

        LOG_ERROR("NetscapePluginInstanceProxy::LocalObjectMap::forget: local object %u doesn't exist.", objectID);

        return true;

    }

    HashMap<JSC::JSObject*, pair<uint32_t, uint32_t> >::iterator rIter = m_jsObjectToIDMap.find(iter->second.get());

    // If the object is being sent to plug-in right now, then it's not the time to forget.

    if (rIter->second.second != 1)

        return false;

    m_jsObjectToIDMap.remove(rIter);

    m_idToJSObjectMap.remove(iter);

    return true;

}

static uint32_t pluginIDCounter;

bool NetscapePluginInstanceProxy::m_inDestroy;

#ifndef NDEBUG

static WTF::RefCountedLeakCounter netscapePluginInstanceProxyCounter("NetscapePluginInstanceProxy");

#endif

NetscapePluginInstanceProxy::NetscapePluginInstanceProxy(NetscapePluginHostProxy* pluginHostProxy, WebHostedNetscapePluginView *pluginView, bool fullFramePlugin)

    : m_pluginHostProxy(pluginHostProxy)

    , m_pluginView(pluginView)

    , m_requestTimer(this, &NetscapePluginInstanceProxy::requestTimerFired)

    , m_currentURLRequestID(0)

    , m_renderContextID(0)

    , m_rendererType(UseSoftwareRenderer)

    , m_waitingForReply(false)

    , m_urlCheckCounter(0)

    , m_pluginFunctionCallDepth(0)

    , m_shouldStopSoon(false)

    , m_currentRequestID(0)

    , m_pluginIsWaitingForDraw(false)

{

    ASSERT(m_pluginView);

    if (fullFramePlugin) {

        // For full frame plug-ins, the first requestID will always be the one for the already

        // open stream.

        ++m_currentURLRequestID;

    }

    // Assign a plug-in ID.

    do {

        m_pluginID = ++pluginIDCounter;

    } while (pluginHostProxy->pluginInstance(m_pluginID) || !m_pluginID);

#ifndef NDEBUG

    netscapePluginInstanceProxyCounter.increment();

#endif

}

PassRefPtr<NetscapePluginInstanceProxy> NetscapePluginInstanceProxy::create(NetscapePluginHostProxy* pluginHostProxy, WebHostedNetscapePluginView *pluginView, bool fullFramePlugin)

{

    RefPtr<NetscapePluginInstanceProxy> proxy = adoptRef(new NetscapePluginInstanceProxy(pluginHostProxy, pluginView, fullFramePlugin));

    pluginHostProxy->addPluginInstance(proxy.get());

    return proxy.release();

}

NetscapePluginInstanceProxy::~NetscapePluginInstanceProxy()

{

    ASSERT(!m_pluginHostProxy);

    m_pluginID = 0;

    deleteAllValues(m_replies);

#ifndef NDEBUG

    netscapePluginInstanceProxyCounter.decrement();

#endif

}

void NetscapePluginInstanceProxy::resize(NSRect size, NSRect clipRect)

{

    uint32_t requestID = 0;

    requestID = nextRequestID();

    _WKPHResizePluginInstance(m_pluginHostProxy->port(), m_pluginID, requestID,

                              size.origin.x, size.origin.y, size.size.width, size.size.height,

                              clipRect.origin.x, clipRect.origin.y, clipRect.size.width, clipRect.size.height);

    waitForReply<NetscapePluginInstanceProxy::BooleanReply>(requestID);

}

void NetscapePluginInstanceProxy::stopAllStreams()

{

    Vector<RefPtr<HostedNetscapePluginStream> > streamsCopy;

    copyValuesToVector(m_streams, streamsCopy);

    for (size_t i = 0; i < streamsCopy.size(); i++)

        streamsCopy[i]->stop();

}

void NetscapePluginInstanceProxy::cleanup()

{

    stopAllStreams();

    m_requestTimer.stop();

    // Clear the object map, this will cause any outstanding JS objects that the plug-in had a reference to 

    // to go away when the next garbage collection takes place.

    m_localObjects.clear();

    if (Frame* frame = core([m_pluginView webFrame]))

        frame->script()->cleanupScriptObjectsForPlugin(m_pluginView);

    ProxyInstanceSet instances;

    instances.swap(m_instances);

    // Invalidate all proxy instances.

    ProxyInstanceSet::const_iterator end = instances.end();

    for (ProxyInstanceSet::const_iterator it = instances.begin(); it != end; ++it)

        (*it)->invalidate();

    m_pluginView = nil;

    m_manualStream = 0;

}

void NetscapePluginInstanceProxy::invalidate()

{

    // If the plug-in host has died, the proxy will be null.

    if (!m_pluginHostProxy)

        return;

    m_pluginHostProxy->removePluginInstance(this);

    m_pluginHostProxy = 0;

}

void NetscapePluginInstanceProxy::destroy()

{

    uint32_t requestID = nextRequestID();

    ASSERT(!m_inDestroy);

    m_inDestroy = true;

    FrameLoadMap::iterator end = m_pendingFrameLoads.end();

    for (FrameLoadMap::iterator it = m_pendingFrameLoads.begin(); it != end; ++it)

        [(it->first) _setInternalLoadDelegate:nil];

    _WKPHDestroyPluginInstance(m_pluginHostProxy->port(), m_pluginID, requestID);

    // If the plug-in host crashes while we're waiting for a reply, the last reference to the instance proxy

    // will go away. Prevent this by protecting it here.

    RefPtr<NetscapePluginInstanceProxy> protect(this);

    // We don't care about the reply here - we just want to block until the plug-in instance has been torn down.

    waitForReply<NetscapePluginInstanceProxy::BooleanReply>(requestID);

    m_inDestroy = false;

    cleanup();

    invalidate();

}

void NetscapePluginInstanceProxy::setManualStream(PassRefPtr<HostedNetscapePluginStream> manualStream) 

{

    ASSERT(!m_manualStream);

    m_manualStream = manualStream;

}

bool NetscapePluginInstanceProxy::cancelStreamLoad(uint32_t streamID, NPReason reason) 

{

    HostedNetscapePluginStream* stream = 0;

    if (m_manualStream && streamID == 1)

        stream = m_manualStream.get();

    else

        stream = m_streams.get(streamID).get();

    if (!stream)

        return false;

    stream->cancelLoad(reason);

    return true;

}

void NetscapePluginInstanceProxy::disconnectStream(HostedNetscapePluginStream* stream)

{

    if (stream == m_manualStream) {

        m_manualStream = 0;

        return;

    }

    ASSERT(m_streams.get(stream->streamID()) == stream);

    m_streams.remove(stream->streamID());

}

void NetscapePluginInstanceProxy::pluginHostDied()

{

    m_pluginHostProxy = 0;

    [m_pluginView pluginHostDied];

    cleanup();

}

void NetscapePluginInstanceProxy::focusChanged(bool hasFocus)

{

    _WKPHPluginInstanceFocusChanged(m_pluginHostProxy->port(), m_pluginID, hasFocus);

}

void NetscapePluginInstanceProxy::windowFocusChanged(bool hasFocus)

{

    _WKPHPluginInstanceWindowFocusChanged(m_pluginHostProxy->port(), m_pluginID, hasFocus);

}

void NetscapePluginInstanceProxy::windowFrameChanged(NSRect frame)

{

    _WKPHPluginInstanceWindowFrameChanged(m_pluginHostProxy->port(), m_pluginID, frame.origin.x, frame.origin.y, frame.size.width, frame.size.height,

                                          NSMaxY([[[NSScreen screens] objectAtIndex:0] frame]));

}

void NetscapePluginInstanceProxy::startTimers(bool throttleTimers)

{

    _WKPHPluginInstanceStartTimers(m_pluginHostProxy->port(), m_pluginID, throttleTimers);

}

void NetscapePluginInstanceProxy::mouseEvent(NSView *pluginView, NSEvent *event, NPCocoaEventType type)

{

    NSPoint screenPoint = [[event window] convertBaseToScreen:[event locationInWindow]];

    NSPoint pluginPoint = [pluginView convertPoint:[event locationInWindow] fromView:nil];

    int clickCount;

    if (type == NPCocoaEventMouseEntered || type == NPCocoaEventMouseExited)

        clickCount = 0;

    else

        clickCount = [event clickCount];

    _WKPHPluginInstanceMouseEvent(m_pluginHostProxy->port(), m_pluginID,

                                  [event timestamp],

                                  type, [event modifierFlags],

                                  pluginPoint.x, pluginPoint.y,

                                  screenPoint.x, screenPoint.y,

                                  NSMaxY([[[NSScreen screens] objectAtIndex:0] frame]),

                                  [event buttonNumber], clickCount, 

                                  [event deltaX], [event deltaY], [event deltaZ]);

}

void NetscapePluginInstanceProxy::keyEvent(NSView *pluginView, NSEvent *event, NPCocoaEventType type)

{

    NSData *charactersData = [[event characters] dataUsingEncoding:NSUTF8StringEncoding];

    NSData *charactersIgnoringModifiersData = [[event charactersIgnoringModifiers] dataUsingEncoding:NSUTF8StringEncoding];

    _WKPHPluginInstanceKeyboardEvent(m_pluginHostProxy->port(), m_pluginID,

                                     [event timestamp], 

                                     type, [event modifierFlags], 

                                     const_cast<char*>(reinterpret_cast<const char*>([charactersData bytes])), [charactersData length], 

                                     const_cast<char*>(reinterpret_cast<const char*>([charactersIgnoringModifiersData bytes])), [charactersIgnoringModifiersData length], 

                                     [event isARepeat], [event keyCode], WKGetNSEventKeyChar(event));

}

void NetscapePluginInstanceProxy::syntheticKeyDownWithCommandModifier(int keyCode, char character)

{

    NSData *charactersData = [NSData dataWithBytes:&character length:1];

    _WKPHPluginInstanceKeyboardEvent(m_pluginHostProxy->port(), m_pluginID, 

                                     [NSDate timeIntervalSinceReferenceDate], 

                                     NPCocoaEventKeyDown, NSCommandKeyMask,

                                     const_cast<char*>(reinterpret_cast<const char*>([charactersData bytes])), [charactersData length], 

                                     const_cast<char*>(reinterpret_cast<const char*>([charactersData bytes])), [charactersData length], 

                                     false, keyCode, character);

}

void NetscapePluginInstanceProxy::flagsChanged(NSEvent *event)

{

    _WKPHPluginInstanceKeyboardEvent(m_pluginHostProxy->port(), m_pluginID, 

                                     [event timestamp], NPCocoaEventFlagsChanged, 

                                     [event modifierFlags], 0, 0, 0, 0, false, [event keyCode], 0);

}

void NetscapePluginInstanceProxy::insertText(NSString *text)

{

    NSData *textData = [text dataUsingEncoding:NSUTF8StringEncoding];

    _WKPHPluginInstanceInsertText(m_pluginHostProxy->port(), m_pluginID,

                                  const_cast<char*>(reinterpret_cast<const char*>([textData bytes])), [textData length]);

}

bool NetscapePluginInstanceProxy::wheelEvent(NSView *pluginView, NSEvent *event)

{

    NSPoint pluginPoint = [pluginView convertPoint:[event locationInWindow] fromView:nil];

    uint32_t requestID = nextRequestID();

    _WKPHPluginInstanceWheelEvent(m_pluginHostProxy->port(), m_pluginID, requestID,

                                  [event timestamp], [event modifierFlags], 

                                  pluginPoint.x, pluginPoint.y, [event buttonNumber], 

                                  [event deltaX], [event deltaY], [event deltaZ]);

    auto_ptr<NetscapePluginInstanceProxy::BooleanReply> reply = waitForReply<NetscapePluginInstanceProxy::BooleanReply>(requestID);

    if (!reply.get() || !reply->m_result)

        return false;

    return true;

}

void NetscapePluginInstanceProxy::print(CGContextRef context, unsigned width, unsigned height)

{

    uint32_t requestID = nextRequestID();

    _WKPHPluginInstancePrint(m_pluginHostProxy->port(), m_pluginID, requestID, width, height);

    auto_ptr<NetscapePluginInstanceProxy::BooleanAndDataReply> reply = waitForReply<NetscapePluginInstanceProxy::BooleanAndDataReply>(requestID);

    if (!reply.get() || !reply->m_returnValue)

        return;

    RetainPtr<CGDataProvider> dataProvider(AdoptCF, CGDataProviderCreateWithCFData(reply->m_result.get()));

    RetainPtr<CGColorSpaceRef> colorSpace(AdoptCF, CGColorSpaceCreateDeviceRGB());

    RetainPtr<CGImageRef> image(AdoptCF, CGImageCreate(width, height, 8, 32, width * 4, colorSpace.get(), kCGImageAlphaFirst, dataProvider.get(), 0, false, kCGRenderingIntentDefault));

    // Flip the context and draw the image.

    CGContextSaveGState(context);

    CGContextTranslateCTM(context, 0.0, height);

    CGContextScaleCTM(context, 1.0, -1.0);

    CGContextDrawImage(context, CGRectMake(0, 0, width, height), image.get());

    CGContextRestoreGState(context);

}

void NetscapePluginInstanceProxy::snapshot(CGContextRef context, unsigned width, unsigned height)

{

    uint32_t requestID = nextRequestID();

    _WKPHPluginInstanceSnapshot(m_pluginHostProxy->port(), m_pluginID, requestID, width, height);

    auto_ptr<NetscapePluginInstanceProxy::BooleanAndDataReply> reply = waitForReply<NetscapePluginInstanceProxy::BooleanAndDataReply>(requestID);

    if (!reply.get() || !reply->m_returnValue)

        return;

    RetainPtr<CGDataProvider> dataProvider(AdoptCF, CGDataProviderCreateWithCFData(reply->m_result.get()));

    RetainPtr<CGColorSpaceRef> colorSpace(AdoptCF, CGColorSpaceCreateDeviceRGB());

    RetainPtr<CGImageRef> image(AdoptCF, CGImageCreate(width, height, 8, 32, width * 4, colorSpace.get(), kCGImageAlphaPremultipliedFirst | kCGBitmapByteOrder32Host, dataProvider.get(), 0, false, kCGRenderingIntentDefault));

    CGContextDrawImage(context, CGRectMake(0, 0, width, height), image.get());

}