modules/plugin/base/src/nsPluginNativeWindowGtk2.cpp

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim:expandtab:shiftwidth=2:tabstop=2:
   3 */
   4 /* ***** BEGIN LICENSE BLOCK *****
   5  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   6  *
   7  * The contents of this file are subject to the Mozilla Public License Version
   8  * 1.1 (the "License"); you may not use this file except in compliance with
   9  * the License. You may obtain a copy of the License at
  10  * http://www.mozilla.org/MPL/
  11  *
  12  * Software distributed under the License is distributed on an "AS IS" basis,
  13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  14  * for the specific language governing rights and limitations under the
  15  * License.
  16  *
  17  * The Original Code is mozilla.org code.
  18  *
  19  * The Initial Developer of the Original Code is
  20  * Sun Microsystems, Inc.
  21  * Portions created by the Initial Developer are Copyright (C) 2003
  22  * the Initial Developer. All Rights Reserved.
  23  *
  24  * Contributor(s):
  25  *   Robin Lu <robin.lu@sun.com>
  26  *
  27  * Alternatively, the contents of this file may be used under the terms of
  28  * either the GNU General Public License Version 2 or later (the "GPL"), or
  29  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  30  * in which case the provisions of the GPL or the LGPL are applicable instead
  31  * of those above. If you wish to allow use of your version of this file only
  32  * under the terms of either the GPL or the LGPL, and not to allow others to
  33  * use your version of this file under the terms of the MPL, indicate your
  34  * decision by deleting the provisions above and replace them with the notice
  35  * and other provisions required by the GPL or the LGPL. If you do not delete
  36  * the provisions above, a recipient may use your version of this file under
  37  * the terms of any one of the MPL, the GPL or the LGPL.
  38  *
  39  * ***** END LICENSE BLOCK ***** */
  40
  41 /**
  42  *  This file is the Gtk2 implementation of plugin native window.
  43  */
  44
  45 #include "nsDebug.h"
  46 #include "nsPluginNativeWindow.h"
  47 #include "npapi.h"
  48 #include <gtk/gtk.h>
  49 #include <gdk/gdkx.h>
  50 #include <gdk/gdk.h>
  51
  52 #ifdef MOZ_PLATFORM_HILDON
  53 #define MOZ_COMPOSITED_PLUGINS
  54 #endif
  55
  56 #ifdef MOZ_COMPOSITED_PLUGINS
  57 extern "C" {
  58 #include <X11/extensions/Xdamage.h>
  59 #include <X11/extensions/Xcomposite.h>
  60 }
  61 #endif
  62
  63 #include "gtk2xtbin.h"
  64 #ifdef OJI
  65 #include "plstr.h"
  66 #include "nsIPlugin.h"
  67 #include "nsIPluginHost.h"
  68
  69 static NS_DEFINE_CID(kPluginManagerCID, NS_PLUGINMANAGER_CID);
  70 #endif
  71
  72 class nsPluginNativeWindowGtk2 : public nsPluginNativeWindow {
  73 public:
  74   nsPluginNativeWindowGtk2();
  75   virtual ~nsPluginNativeWindowGtk2();
  76
  77   virtual nsresult CallSetWindow(nsCOMPtr<nsIPluginInstance> &aPluginInstance);
  78 private:
  79   NPSetWindowCallbackStruct mWsInfo;
  80   /**
  81    * Either a GtkSocket or a special GtkXtBin widget (derived from GtkSocket)
  82    * that encapsulates the Xt toolkit within a Gtk Application.
  83    */
  84   GtkWidget* mSocketWidget;
  85   nsresult  CreateXEmbedWindow();
  86   nsresult  CreateXtWindow();
  87   void      SetAllocation();
  88   PRBool    CanGetValueFromPlugin(nsCOMPtr<nsIPluginInstance> &aPluginInstance);
  89 #ifdef MOZ_COMPOSITED_PLUGINS
  90   nsresult  CreateXCompositedWindow();
  91   static GdkFilterReturn    plugin_composite_filter_func (GdkXEvent *xevent,
  92     GdkEvent *event,
  93     gpointer data);
  94
  95   Damage     mDamage;
  96   GtkWidget* mParentWindow;
  97 #endif
  98 };
  99
 100 static gboolean plug_removed_cb   (GtkWidget *widget, gpointer data);
 101
 102 nsPluginNativeWindowGtk2::nsPluginNativeWindowGtk2() : nsPluginNativeWindow()
 103 {
 104   // initialize the struct fields
 105   window = nsnull;
 106   x = 0;
 107   y = 0;
 108   width = 0;
 109   height = 0;
 110   memset(&clipRect, 0, sizeof(clipRect));
 111   ws_info = &mWsInfo;
 112   type = nsPluginWindowType_Window;
 113   mSocketWidget = 0;
 114   mWsInfo.type = 0;
 115   mWsInfo.display = nsnull;
 116   mWsInfo.visual = nsnull;
 117   mWsInfo.colormap = 0;
 118   mWsInfo.depth = 0;
 119 #ifdef MOZ_COMPOSITED_PLUGINS
 120   mDamage = 0;
 121   mParentWindow = 0;
 122 #endif
 123 }
 124
 125 nsPluginNativeWindowGtk2::~nsPluginNativeWindowGtk2()
 126 {
 127   if(mSocketWidget) {
 128     gtk_widget_destroy(mSocketWidget);
 129   }
 130
 131 #ifdef MOZ_COMPOSITED_PLUGINS
 132   if (mParentWindow) {
 133     gtk_widget_destroy(mParentWindow);
 134   }
 135
 136   if (mDamage) {
 137     gdk_window_remove_filter (nsnull, plugin_composite_filter_func, this);
 138   }
 139 #endif
 140 }
 141
 142 nsresult PLUG_NewPluginNativeWindow(nsPluginNativeWindow ** aPluginNativeWindow)
 143 {
 144   NS_ENSURE_ARG_POINTER(aPluginNativeWindow);
 145   *aPluginNativeWindow = new nsPluginNativeWindowGtk2();
 146   return *aPluginNativeWindow ? NS_OK : NS_ERROR_OUT_OF_MEMORY;
 147 }
 148
 149 nsresult PLUG_DeletePluginNativeWindow(nsPluginNativeWindow * aPluginNativeWindow)
 150 {
 151   NS_ENSURE_ARG_POINTER(aPluginNativeWindow);
 152   nsPluginNativeWindowGtk2 *p = (nsPluginNativeWindowGtk2 *)aPluginNativeWindow;
 153   delete p;
 154   return NS_OK;
 155 }
 156
 157 #ifdef MOZ_COMPOSITED_PLUGINS
 158 /* the base xdamage event number.*/
 159 static int xdamage_event_base;
 160
 161 GdkFilterReturn
 162 nsPluginNativeWindowGtk2::plugin_composite_filter_func (GdkXEvent *xevent,
 163     GdkEvent *event,
 164     gpointer data)
 165 {
 166   nsPluginNativeWindowGtk2 *native_window = (nsPluginNativeWindowGtk2*)data;
 167   XDamageNotifyEvent *ev;
 168   XserverRegion parts;
 169   ev = (XDamageNotifyEvent *) xevent;
 170   if (ev->type != xdamage_event_base + XDamageNotify)
 171     return GDK_FILTER_CONTINUE;
 172
 173   //printf("Damage event %d %d %d %d\n",ev->area.x, ev->area.y, ev->area.width, ev->area.height);
 174   parts = XFixesCreateRegion (GDK_DISPLAY(), 0, 0);
 175   XDamageSubtract (GDK_DISPLAY(), native_window->mDamage, None, parts);
 176
 177   /* We try to do our area invalidation here */
 178   nsPluginRect rect;
 179   rect.top = ev->area.x;
 180   rect.left = ev->area.y;
 181   rect.right = ev->area.x + ev->area.width;
 182   rect.bottom = ev->area.y + ev->area.height;
 183
 184   /* There might be a better way to do this? */
 185   if (native_window->mPluginInstance) {
 186     nsCOMPtr<nsIPluginInstancePeer> peer;
 187     if (NS_SUCCEEDED(native_window->mPluginInstance->GetPeer(getter_AddRefs(peer))) && peer) {
 188       nsCOMPtr<nsIWindowlessPluginInstancePeer> wpeer(do_QueryInterface(peer));
 189       if (wpeer) {
 190         // XXX nsRect & NPRect are structurally equivalent
 191         wpeer->InvalidateRect(&rect);
 192       }
 193     }
 194   }
 195
 196   return GDK_FILTER_REMOVE;
 197 }
 198 #endif
 199
 200 nsresult nsPluginNativeWindowGtk2::CallSetWindow(nsCOMPtr<nsIPluginInstance> &aPluginInstance)
 201 {
 202   if(aPluginInstance) {
 203     if (type == nsPluginWindowType_Window) {
 204       nsresult rv;
 205       if(!mSocketWidget) {
 206         PRBool needXEmbed = PR_FALSE;
 207         if (CanGetValueFromPlugin(aPluginInstance)) {
 208           rv = aPluginInstance->GetValue
 209             ((nsPluginInstanceVariable)NPPVpluginNeedsXEmbed, &needXEmbed);
 210 #ifdef DEBUG
 211           printf("nsPluginNativeWindowGtk2: NPPVpluginNeedsXEmbed=%d\n", needXEmbed);
 212 #endif
 213         }
 214         if(needXEmbed) {
 215 #ifdef MOZ_COMPOSITED_PLUGINS
 216           CreateXCompositedWindow();
 217 #else
 218           CreateXEmbedWindow();
 219 #endif
 220         }
 221         else {
 222           CreateXtWindow();
 223         }
 224       }
 225
 226       if(!mSocketWidget)
 227         return NS_ERROR_FAILURE;
 228
 229       // Make sure to resize and re-place the window if required.
 230       // Need to reset "window" each time as nsObjectFrame::DidReflow sets it
 231       // to the ancestor window.
 232       if(GTK_IS_XTBIN(mSocketWidget)) {
 233         gtk_xtbin_resize(mSocketWidget, width, height);
 234         // Point the NPWindow structures window to the actual X window
 235         window = (nsPluginPort *)GTK_XTBIN(mSocketWidget)->xtwindow;
 236       }
 237       else { // XEmbed
 238         SetAllocation();
 239         window = (nsPluginPort *)gtk_socket_get_id(GTK_SOCKET(mSocketWidget));
 240       }
 241 #ifdef DEBUG
 242       printf("nsPluginNativeWindowGtk2: call SetWindow with xid=%p\n", (void *)window);
 243 #endif
 244     } // nsPluginWindowType_Window
 245     aPluginInstance->SetWindow(this);
 246   }
 247   else if (mPluginInstance)
 248     mPluginInstance->SetWindow(nsnull);
 249
 250   SetPluginInstance(aPluginInstance);
 251   return NS_OK;
 252 }
 253
 254 nsresult nsPluginNativeWindowGtk2::CreateXEmbedWindow() {
 255   NS_ASSERTION(!mSocketWidget,"Already created a socket widget!");
 256
 257   GdkWindow *parent_win = gdk_window_lookup((XID)window);
 258   mSocketWidget = gtk_socket_new();
 259
 260   //attach the socket to the container widget
 261   gtk_widget_set_parent_window(mSocketWidget, parent_win);
 262
 263   // Make sure to handle the plug_removed signal.  If we don't the
 264   // socket will automatically be destroyed when the plug is
 265   // removed, which means we're destroying it more than once.
 266   // SYNTAX ERROR.
 267   g_signal_connect(mSocketWidget, "plug_removed",
 268                    G_CALLBACK(plug_removed_cb), NULL);
 269
 270   g_signal_connect(mSocketWidget, "destroy",
 271                    G_CALLBACK(gtk_widget_destroyed), &mSocketWidget);
 272
 273   gpointer user_data = NULL;
 274   gdk_window_get_user_data(parent_win, &user_data);
 275
 276   GtkContainer *container = GTK_CONTAINER(user_data);
 277   gtk_container_add(container, mSocketWidget);
 278   gtk_widget_realize(mSocketWidget);
 279
 280   // Resize before we show
 281   SetAllocation();
 282
 283   gtk_widget_show(mSocketWidget);
 284
 285   gdk_flush();
 286   window = (nsPluginPort *)gtk_socket_get_id(GTK_SOCKET(mSocketWidget));
 287
 288   // Fill out the ws_info structure.
 289   // (The windowless case is done in nsObjectFrame.cpp.)
 290   GdkWindow *gdkWindow = gdk_window_lookup((XID)window);
 291   mWsInfo.display = GDK_WINDOW_XDISPLAY(gdkWindow);
 292   mWsInfo.colormap = GDK_COLORMAP_XCOLORMAP(gdk_drawable_get_colormap(gdkWindow));
 293   GdkVisual* gdkVisual = gdk_drawable_get_visual(gdkWindow);
 294   mWsInfo.visual = GDK_VISUAL_XVISUAL(gdkVisual);
 295   mWsInfo.depth = gdkVisual->depth;
 296
 297   return NS_OK;
 298 }
 299
 300 #ifdef MOZ_COMPOSITED_PLUGINS
 301 #include <dlfcn.h>
 302 nsresult nsPluginNativeWindowGtk2::CreateXCompositedWindow() {
 303   NS_ASSERTION(!mSocketWidget,"Already created a socket widget!");
 304
 305   mParentWindow = gtk_window_new(GTK_WINDOW_POPUP);
 306   mSocketWidget = gtk_socket_new();
 307   GdkWindow *parent_win = mParentWindow->window;
 308
 309   //attach the socket to the container widget
 310   gtk_widget_set_parent_window(mSocketWidget, parent_win);
 311
 312   // Make sure to handle the plug_removed signal.  If we don't the
 313   // socket will automatically be destroyed when the plug is
 314   // removed, which means we're destroying it more than once.
 315   // SYNTAX ERROR.
 316   g_signal_connect(mSocketWidget, "plug_removed",
 317                    G_CALLBACK(plug_removed_cb), NULL);
 318
 319   g_signal_connect(mSocketWidget, "destroy",
 320                    G_CALLBACK(gtk_widget_destroyed), &mSocketWidget);
 321
 322   /*gpointer user_data = NULL;
 323   gdk_window_get_user_data(parent_win, &user_data);
 324   */
 325   GtkContainer *container = GTK_CONTAINER(mParentWindow);
 326   gtk_container_add(container, mSocketWidget);
 327   gtk_widget_realize(mSocketWidget);
 328
 329   // Resize before we show
 330   SetAllocation();
 331   gtk_widget_set_size_request (mSocketWidget, width, height);
 332   /* move offscreen */
 333   gtk_window_move (GTK_WINDOW(mParentWindow), width+1000, height+1000);
 334
 335
 336   gtk_widget_show(mSocketWidget);
 337   gtk_widget_show_all(mParentWindow);
 338
 339   /* store away a reference to the socketwidget */
 340   mPlugWindow = (mSocketWidget);
 341
 342   gdk_flush();
 343   window = (nsPluginPort *)gtk_socket_get_id(GTK_SOCKET(mSocketWidget));
 344
 345   /* This is useful if we still have the plugin window inline
 346    * i.e. firefox vs. fennec */
 347   // gdk_window_set_composited(mSocketWidget->window, TRUE);
 348
 349   if (!mDamage) {
 350     /* we install a general handler instead of one specific to a particular window
 351      * because we don't have a GdkWindow for the plugin window */
 352     gdk_window_add_filter (parent_win, plugin_composite_filter_func, this);
 353
 354     int junk;
 355     if (!XDamageQueryExtension (GDK_DISPLAY (), &xdamage_event_base, &junk))
 356       printf ("This requires the XDamage extension");
 357
 358     mDamage = XDamageCreate(GDK_DISPLAY(), (Drawable)window, XDamageReportNonEmpty);
 359     XCompositeRedirectWindow (GDK_DISPLAY(),
 360         (Drawable)window,
 361         CompositeRedirectManual);
 362
 363     /* this is a hack to avoid having flash causing a crash when it is unloaded.
 364      * libplayback sets up dbus_connection_filters. When flash is unloaded it takes
 365      * libplayback with it, however the connection filters are not removed
 366      * which causes a crash when dbus tries to execute them. dlopening libplayback
 367      * ensures that those functions stay around even after flash is gone. */
 368     static void *libplayback_handle;
 369     if (!libplayback_handle) {
 370       libplayback_handle = dlopen("libplayback-1.so.0", RTLD_NOW);
 371     }
 372
 373   }
 374
 375   // Fill out the ws_info structure.
 376   // (The windowless case is done in nsObjectFrame.cpp.)
 377   GdkWindow *gdkWindow = gdk_window_lookup((XID)window);
 378   mWsInfo.display = GDK_WINDOW_XDISPLAY(gdkWindow);
 379   mWsInfo.colormap = GDK_COLORMAP_XCOLORMAP(gdk_drawable_get_colormap(gdkWindow));
 380   GdkVisual* gdkVisual = gdk_drawable_get_visual(gdkWindow);
 381   mWsInfo.visual = GDK_VISUAL_XVISUAL(gdkVisual);
 382   mWsInfo.depth = gdkVisual->depth;
 383
 384   return NS_OK;
 385 }
 386 #endif
 387
 388 void nsPluginNativeWindowGtk2::SetAllocation() {
 389   if (!mSocketWidget)
 390     return;
 391
 392   GtkAllocation new_allocation;
 393   new_allocation.x = 0;
 394   new_allocation.y = 0;
 395   new_allocation.width = width;
 396   new_allocation.height = height;
 397   gtk_widget_size_allocate(mSocketWidget, &new_allocation);
 398 }
 399
 400 nsresult nsPluginNativeWindowGtk2::CreateXtWindow() {
 401   NS_ASSERTION(!mSocketWidget,"Already created a socket widget!");
 402
 403 #ifdef NS_DEBUG
 404   printf("About to create new xtbin of %i X %i from %p...\n",
 405          width, height, (void*)window);
 406 #endif
 407   GdkWindow *gdkWindow = gdk_window_lookup((XID)window);
 408   mSocketWidget = gtk_xtbin_new(gdkWindow, 0);
 409   // Check to see if creating the xtbin failed for some reason.
 410   // if it did, we can't go any further.
 411   if (!mSocketWidget)
 412     return NS_ERROR_FAILURE;
 413
 414   gtk_widget_set_size_request(mSocketWidget, width, height);
 415
 416 #ifdef NS_DEBUG
 417   printf("About to show xtbin(%p)...\n", (void*)mSocketWidget); fflush(NULL);
 418 #endif
 419   gtk_widget_show(mSocketWidget);
 420 #ifdef NS_DEBUG
 421   printf("completed gtk_widget_show(%p)\n", (void*)mSocketWidget); fflush(NULL);
 422 #endif
 423
 424   // Fill out the ws_info structure.
 425   GtkXtBin* xtbin = GTK_XTBIN(mSocketWidget);
 426   // The xtbin has its own Display structure.
 427   mWsInfo.display = xtbin->xtdisplay;
 428   mWsInfo.colormap = xtbin->xtclient.xtcolormap;
 429   mWsInfo.visual = xtbin->xtclient.xtvisual;
 430   mWsInfo.depth = xtbin->xtclient.xtdepth;
 431   // Leave mWsInfo.type = 0 - Who knows what this is meant to be?
 432
 433   XFlush(mWsInfo.display);
 434
 435   return NS_OK;
 436 }
 437
 438 PRBool nsPluginNativeWindowGtk2::CanGetValueFromPlugin(nsCOMPtr<nsIPluginInstance> &aPluginInstance)
 439 {
 440 #ifdef OJI
 441   if(aPluginInstance) {
 442     nsresult rv;
 443     nsCOMPtr<nsIPluginInstancePeer> peer;
 444
 445     rv = aPluginInstance->GetPeer(getter_AddRefs(peer));
 446     if (NS_SUCCEEDED(rv) && peer) {
 447       const char *aMimeType = nsnull;
 448
 449       peer->GetMIMEType((nsMIMEType*)&aMimeType);
 450       if (aMimeType &&
 451           (PL_strncasecmp(aMimeType, "application/x-java-vm", 21) == 0 ||
 452            PL_strncasecmp(aMimeType, "application/x-java-applet", 25) == 0)) {
 453         nsCOMPtr<nsIPluginHost> pluginHost = do_GetService(kPluginManagerCID, &rv);
 454         if (NS_SUCCEEDED(rv) && pluginHost) {
 455           nsIPlugin* pluginFactory = NULL;
 456
 457           rv = pluginHost->GetPluginFactory("application/x-java-vm", &pluginFactory);
 458           if (NS_SUCCEEDED(rv) && pluginFactory) {
 459             const char * jpiDescription = NULL;
 460
 461             pluginFactory->GetValue(nsPluginVariable_DescriptionString, (void*)&jpiDescription);
 462             if (!jpiDescription)
 463               return PR_FALSE;
 464
 465             /**
 466              * "Java(TM) Plug-in" is Sun's Java Plugin Trademark,
 467              * so we are sure that this is Sun 's Java Plugin if
 468              * the description start with "Java(TM) Plug-in"
 469              **/
 470             if (PL_strncasecmp(jpiDescription, "Java(TM) Plug-in", 16) == 0) {
 471               // Java Plugin support Xembed from JRE 1.5
 472               if (PL_strcasecmp(jpiDescription + 17, "1.5") < 0)
 473                 return PR_FALSE;
 474             }
 475             if (PL_strncasecmp(jpiDescription, "<a href=\"http://www.blackdown.org/java-linux.html\">", 51) == 0) {
 476               // Java Plugin support Xembed from JRE 1.5
 477               if (PL_strcasecmp(jpiDescription + 92, "1.5") < 0)
 478                 return PR_FALSE;
 479             }
 480             if (PL_strncasecmp(jpiDescription, "IBM Java(TM) Plug-in", 20) == 0) {
 481               // Java Plugin support Xembed from JRE 1.5
 482               if (PL_strcasecmp(jpiDescription + 27, "1.5") < 0)
 483                 return PR_FALSE;
 484             }
 485           }
 486         }
 487       }
 488     }
 489   }
 490 #endif
 491
 492   return PR_TRUE;
 493 }
 494
 495 /* static */
 496 gboolean
 497 plug_removed_cb (GtkWidget *widget, gpointer data)
 498 {
 499   // Gee, thanks for the info!
 500   return TRUE;
 501 }
 502
 503