BrowserPlugin/WebView - Move plugin lifetime to DOM

Source/testing/runner/TestPlugin.cpp

 /*
  * Copyright (C) 2011 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:
  *
  * 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
@@ skipping 12 matching lines @@
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #include "TestPlugin.h"
 
 #include "TestCommon.h"
 #include "public/platform/Platform.h"
 #include "public/platform/WebCompositorSupport.h"
 #include "public/platform/WebGraphicsContext3D.h"
 #include "public/testing/WebTestDelegate.h"
+#include "public/web/WebBindings.h"
 #include "public/web/WebFrame.h"
 #include "public/web/WebInputEvent.h"
 #include "public/web/WebKit.h"
 #include "public/web/WebPluginParams.h"
 #include "public/web/WebTouchPoint.h"
 #include "public/web/WebUserGestureIndicator.h"
 
 using namespace blink;
 using namespace std;
 
 namespace WebTestRunner {
 
 namespace {
 
 // GLenum values copied from gl2.h.
 #define GL_FALSE                  0
 #define GL_TRUE                   1
 #define GL_ONE                    1
 #define GL_TRIANGLES              0x0004
 #define GL_ONE_MINUS_SRC_ALPHA    0x0303
 #define GL_DEPTH_TEST             0x0B71
 #define GL_BLEND                  0x0BE2
-#define GL_SCISSOR_TEST           0x0B90
 #define GL_TEXTURE_2D             0x0DE1
 #define GL_FLOAT                  0x1406
 #define GL_RGBA                   0x1908
 #define GL_UNSIGNED_BYTE          0x1401
 #define GL_TEXTURE_MAG_FILTER     0x2800
 #define GL_TEXTURE_MIN_FILTER     0x2801
 #define GL_TEXTURE_WRAP_S         0x2802
 #define GL_TEXTURE_WRAP_T         0x2803
 #define GL_NEAREST                0x2600
-#define GL_COLOR_BUFFER_BIT       0x4000
 #define GL_CLAMP_TO_EDGE          0x812F
 #define GL_ARRAY_BUFFER           0x8892
 #define GL_STATIC_DRAW            0x88E4
 #define GL_FRAGMENT_SHADER        0x8B30
 #define GL_VERTEX_SHADER          0x8B31
 #define GL_COMPILE_STATUS         0x8B81
 #define GL_LINK_STATUS            0x8B82
 #define GL_COLOR_ATTACHMENT0      0x8CE0
 #define GL_FRAMEBUFFER_COMPLETE   0x8CD5
 #define GL_FRAMEBUFFER            0x8D40
 
+// Mac defines these elsewhere and doesn't like duplicates.

[eseidel, 2013/12/18 18:38:18]

Why are we defining these in TestPlugin.cpp in teh first place?  There must be a
header this should have incldued instead...

[wjmaclean, 2013/12/23 23:49:53]

I'm not sure, though I would imagine that one reason would be just what is
described here, namely that some system headers duplicate them already, and
duplicated them from gl2.h as indicated earlier in the file. But including gl2.h
would cause similar collisions, and in a file that's in 3rd party and thus
harder to fix.

I'm really not sure what the right fix is here.

+#ifndef  GL_SCISSOR_TEST
+#define GL_SCISSOR_TEST           0x0B90
+#endif
+#ifndef GL_COLOR_BUFFER_BIT
+#define GL_COLOR_BUFFER_BIT       0x4000
+#endif
+
 void premultiplyAlpha(const unsigned colorIn[3], float alpha, float colorOut[4])
 {
     for (int i = 0; i < 3; ++i)
         colorOut[i] = (colorIn[i] / 255.0f) * alpha;
 
     colorOut[3] = alpha;
 }
 
 const char* pointState(WebTouchPoint::State state)
 {
@@ skipping 53 matching lines @@
 }
 
 void deferredDelete(void* context)
 {
     TestPlugin* plugin = static_cast<TestPlugin*>(context);
     delete plugin;
 }
 
 }
 
+static int s_instanceCount = 0;
 
 TestPlugin::TestPlugin(WebFrame* frame, const WebPluginParams& params, WebTestDelegate* delegate)
     : m_frame(frame)
     , m_delegate(delegate)
     , m_container(0)
     , m_context(0)
     , m_colorTexture(0)
     , m_mailboxChanged(false)
     , m_framebuffer(0)
     , m_touchEventRequest(WebPluginContainer::TouchEventRequestTypeNone)
     , m_reRequestTouchEvents(false)
     , m_printEventDetails(false)
     , m_printUserGestureStatus(false)
     , m_canProcessDrag(false)
+    , m_npObject(0)
+    , m_instanceId(++s_instanceCount)
+    , m_isPersistent(params.mimeType.utf8().find(pluginPersistsSuffix().utf8()) != std::string::npos)
+    , m_canCreateWithoutRenderer(params.mimeType.utf8().find(canCreateWithoutRendererSuffix().utf8()) != std::string::npos)

[eseidel, 2013/12/18 18:38:18]

Why all the .utf8?  Does this not have a contains()?

[wjmaclean, 2013/12/23 23:49:53]

No longer using find() 

 {
     static const WebString kAttributePrimitive = WebString::fromUTF8("primitive");
     static const WebString kAttributeBackgroundColor = WebString::fromUTF8("background-color");
     static const WebString kAttributePrimitiveColor = WebString::fromUTF8("primitive-color");
     static const WebString kAttributeOpacity = WebString::fromUTF8("opacity");
     static const WebString kAttributeAcceptsTouch = WebString::fromUTF8("accepts-touch");
     static const WebString kAttributeReRequestTouchEvents = WebString::fromUTF8("re-request-touch");
     static const WebString kAttributePrintEventDetails = WebString::fromUTF8("print-event-details");
     static const WebString kAttributeCanProcessDrag = WebString::fromUTF8("can-process-drag");
     static const WebString kAttributePrintUserGestureStatus = WebString::fromUTF8("print-user-gesture-status");
@@ skipping 44 matching lines @@
 
     m_layer = WebScopedPtr<WebExternalTextureLayer>(Platform::current()->compositorSupport()->createExternalTextureLayer(this));
     m_container = container;
     m_container->setWebLayer(m_layer->layer());
     if (m_reRequestTouchEvents) {
         m_container->requestTouchEventType(WebPluginContainer::TouchEventRequestTypeSynthesizedMouse);
         m_container->requestTouchEventType(WebPluginContainer::TouchEventRequestTypeRaw);
     }
     m_container->requestTouchEventType(m_touchEventRequest);
     m_container->setWantsWheelEvents(true);
+    m_container->allowScriptObjects();
     return true;
 }
 
 void TestPlugin::destroy()
 {
     if (m_layer.get())
         m_layer->clearTexture();
     if (m_container)
         m_container->setWebLayer(0);
     m_layer.reset();
     destroyScene();
 
     delete m_context;
     m_context = 0;
 
     m_container = 0;
     m_frame = 0;
 
     Platform::current()->callOnMainThread(deferredDelete, this);
 }
 
+class TestPluginNPObject : public NPObject {
+public:
+    TestPluginNPObject(TestPlugin* plugin): m_plugin(plugin) { }
+    ~TestPluginNPObject() { }
+
+    // This is a raw pointer; we assume this object doesn't outlive the associated
+    // plugin object.
+    TestPlugin* m_plugin;
+};
+
+NPObject* TestPluginBindingsAllocate(NPP npp, NPClass* nppClass)
+{
+    return new TestPluginNPObject(static_cast<TestPlugin*>(npp->pdata));
+}
+
+WebString NPIdentifierToString(const NPIdentifier& npIdentifier)
+{
+    NPUTF8* nputF8 = blink::WebBindings::utf8FromIdentifier(npIdentifier);
+    WebString identifier = WebString::fromUTF8(nputF8);
+    free(nputF8);

[eseidel, 2013/12/18 18:38:18]

Do we have a OwnPtr-like concept for this instead?

[wjmaclean, 2013/12/23 23:49:53]

I'm unsure ... aren't all the owned-ptr types based on new/delete?

+    return identifier;
+}
+
+static const WebString kPropertyInstanceId = WebString::fromUTF8("instanceId");
+static const WebString kPropertyIsPersistent = WebString::fromUTF8("isPersistent");
+static const WebString kPropertyCanCreateWithoutRenderer = WebString::fromUTF8("canCreateWithoutRenderer");
+
+bool TestPluginBindingsHasProperty(NPObject* npObject, NPIdentifier name)
+{
+    WebString nameString = NPIdentifierToString(name);
+    return nameString == kPropertyInstanceId || nameString == kPropertyIsPersistent || nameString == kPropertyCanCreateWithoutRenderer;
+}
+
+bool TestPluginBindingsGetProperty(NPObject* npObject, NPIdentifier name, NPVariant* result)
+{
+    if (!npObject)
+        return false;
+
+    WebString nameString = NPIdentifierToString(name);
+    if (nameString == kPropertyInstanceId)
+        INT32_TO_NPVARIANT(static_cast<TestPluginNPObject*>(npObject)->m_plugin->instanceId(), *result);

[eseidel, 2013/12/18 18:38:18]

Should we pull this cast out into a local?

[wjmaclean, 2013/12/23 23:49:53]

Done.

+
+    if (nameString == kPropertyIsPersistent)
+        BOOLEAN_TO_NPVARIANT(static_cast<TestPluginNPObject*>(npObject)->m_plugin->isPersistent(), *result);
+
+    if (nameString == kPropertyCanCreateWithoutRenderer)
+        BOOLEAN_TO_NPVARIANT(static_cast<TestPluginNPObject*>(npObject)->m_plugin->canCreateWithoutRenderer(), *result);
+
+    return true;
+}
+
+bool TestPluginBindingsSetProperty(NPObject* npObject, NPIdentifier, const NPVariant*result)
+{
+    // For now, all properties are read-only.
+    return false;
+}
+
+NPClass testPluginClass = {
+    NP_CLASS_STRUCT_VERSION,
+    &TestPluginBindingsAllocate,
+    0,
+    0,
+    0,
+    0,
+    0,
+    &TestPluginBindingsHasProperty,
+    &TestPluginBindingsGetProperty,
+    &TestPluginBindingsSetProperty,
+    0,
+    0,
+};
+
+NPObject* TestPlugin::scriptableObject()
+{
+    if (!m_npObject) {
+        m_NPP.reset(new NPP_t);
+        m_NPP->pdata = this;
+        m_NPP->ndata = 0;
+        m_npObject = blink::WebBindings::createObject(m_NPP.get(), &testPluginClass);
+        blink::WebBindings::retainObject(m_npObject);
+    }
+    return m_npObject;
+}
+
 void TestPlugin::updateGeometry(const WebRect& frameRect, const WebRect& clipRect, const WebVector<WebRect>& cutOutsRects, bool isVisible)
 {
     if (clipRect == m_rect)
         return;
     m_rect = clipRect;
     if (m_rect.isEmpty())
         return;
 
     m_context->reshapeWithScaleFactor(m_rect.width, m_rect.height, 1.f);
     m_context->viewport(0, 0, m_rect.width, m_rect.height);
@@ skipping 312 matching lines @@
 {
     return new TestPlugin(frame, params, delegate);
 }
 
 const WebString& TestPlugin::mimeType()
 {
     static const WebString kMimeType = WebString::fromUTF8("application/x-webkit-test-webplugin");
     return kMimeType;
 }
 
+const WebString& TestPlugin::canCreateWithoutRendererSuffix()
+{
+    static const WebString kCanCreateWithoutRendererSuffix =  WebString::fromUTF8("-can-create-without-renderer");
+    return kCanCreateWithoutRendererSuffix;
 }
+
+const WebString& TestPlugin::pluginPersistsSuffix()
+{
+    static const WebString kPluginPersistsSuffix = WebString::fromUTF8("-persistent");
+    return kPluginPersistsSuffix;
+}
+
+}