Add the web-page plug-in

configure.ac

@@ -1278,12 +1278,14 @@ AC_ARG_WITH(webkit, [  --without-webkit        don't build the help-browser plug
 have_webkit=no
 if test "x$with_webkit" != xno; then
   PKG_CHECK_MODULES(WEBKIT, webkit-1.0 >= webkit_required_version,
+    WEB_PAGE='web-page$(EXEEXT)'
     have_webkit=yes,
     have_webkit="no (WebKit not found)")
 else
   have_webkit="no (WebKit support disabled)"
 fi
 
+AC_SUBST(WEB_PAGE)
 AM_CONDITIONAL(HAVE_WEBKIT, test "x$have_webkit" = xyes)
 
 
@@ -2265,7 +2267,8 @@ Optional Plug-Ins:
   TWAIN (MacOS X):     $mac_twain_ok
   TWAIN (Win32):       $os_win32
   URI:                 $uri_plugin
-  Windows ICO          $have_libpng
+  Webpage:             $have_webkit
+  Windows ICO:         $have_libpng
   WMF:                 $have_libwmf
   XJT:                 $have_xjt
   X11 Mouse Cursor:    $have_xmc

plug-ins/common/.gitignore

@@ -288,6 +288,8 @@
 /waves.exe
 /web-browser
 /web-browser.exe
+/web-page
+/web-page.exe
 /whirl-pinch
 /whirl-pinch.exe
 /wind

plug-ins/common/Makefile.am

@@ -186,6 +186,7 @@ libexec_PROGRAMS = \
 	warp \
 	waves \
 	web-browser \
+	$(WEB_PAGE) \
 	whirl-pinch \
 	wind
 
@@ -205,7 +206,8 @@ EXTRA_PROGRAMS = \
 	file-xpm \
 	lcms \
 	mail \
-	screenshot
+	screenshot \
+	web-page
 
 install-%: %
 	@$(NORMAL_INSTALL)
@@ -2623,6 +2625,26 @@ web_browser_LDADD = \
 	$(INTLLIBS)		\
 	$(web_browser_RC)
 
+web_page_CFLAGS = $(WEBKIT_CFLAGS)
+
+web_page_SOURCES = \
+	web-page.c
+
+web_page_LDADD = \
+	$(libgimpui)		\
+	$(libgimpwidgets)	\
+	$(libgimpmodule)	\
+	$(libgimp)		\
+	$(libgimpmath)		\
+	$(libgimpconfig)	\
+	$(libgimpcolor)		\
+	$(libgimpbase)		\
+	$(GTK_LIBS)		\
+	$(WEBKIT_LIBS)		\
+	$(RT_LIBS)		\
+	$(INTLLIBS)		\
+	$(web_page_RC)
+
 whirl_pinch_SOURCES = \
 	whirl-pinch.c
 

plug-ins/common/gimprc.common

@@ -141,5 +141,6 @@ video_RC = video.rc.o
 warp_RC = warp.rc.o
 waves_RC = waves.rc.o
 web_browser_RC = web-browser.rc.o
+web_page_RC = web-page.rc.o
 whirl_pinch_RC = whirl-pinch.rc.o
 wind_RC = wind.rc.o

plug-ins/common/plugin-defs.pl

@@ -142,6 +142,7 @@
     'warp' => { ui => 1 },
     'waves' => { ui => 1 },
     'web-browser' => { ui => 1 },
+    'web-page' => { ui => 1, optional => 1, libs => 'WEBKIT_LIBS', cflags => 'WEBKIT_CFLAGS' },
     'whirl-pinch' => { ui => 1 },
     'wind' => { ui => 1 }
 );

plug-ins/common/web-page.c

@@ -0,0 +1,350 @@
+/* GIMP - The GNU Image Manipulation Program
+ * Copyright (C) 1995 Spencer Kimball and Peter Mattis
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/* Webpage plug-in.
+ * Copyright (C) 2011 Mukund Sivaraman <muks@banu.com>.
+ * Portions are copyright of the author of the
+ * file-open-location-dialog.c code.
+ *
+ * TODO:
+ * - Add progress bar
+ * - Add width entry widget
+ * - Set GIMP as user agent
+ */
+
+#include "config.h"
+
+#include <libgimp/gimp.h>
+#include <libgimp/gimpui.h>
+
+#include <webkit/webkit.h>
+
+#include "libgimp/stdplugins-intl.h"
+
+/* Defines */
+#define PLUG_IN_PROC   "plug-in-web-page"
+#define PLUG_IN_BINARY "web-page"
+
+typedef struct
+{
+  char   *url;
+  gint32  width;
+} WebpageVals;
+
+static WebpageVals webpagevals =
+  {
+    NULL,
+    1024
+  };
+
+static GdkPixbuf *webpixbuf;
+
+static void     query           (void);
+static void     run             (const gchar      *name,
+                                 gint              nparams,
+                                 const GimpParam  *param,
+                                 gint             *nreturn_vals,
+                                 GimpParam       **return_vals);
+static gboolean webpage_dialog  (void);
+static gint32   webpage_capture (void);
+
+
+/* Global Variables */
+const GimpPlugInInfo PLUG_IN_INFO =
+{
+  NULL,  /* init_proc  */
+  NULL,  /* quit_proc  */
+  query, /* query_proc */
+  run    /* run_proc   */
+};
+
+
+/* Functions */
+
+MAIN ()
+
+static void
+query (void)
+{
+  static const GimpParamDef args[] =
+  {
+    { GIMP_PDB_INT32, "run-mode",  "The run mode { RUN-INTERACTIVE (0), RUN-NONINTERACTIVE (1) }" },
+    { GIMP_PDB_INT32, "url",       "URL of the webpage to screenshot"                             },
+    { GIMP_PDB_INT32, "width",     "The width of the screenshot"                                  }
+  };
+
+  static const GimpParamDef return_vals[] =
+  {
+    { GIMP_PDB_IMAGE, "image", "Output image" }
+  };
+
+  gimp_install_procedure (PLUG_IN_PROC,
+                          N_("Create an image of a webpage"),
+                          "The plug-in allows you to take a screenshot "
+                          "of a webpage.",
+                          "Mukund Sivaraman <muks@banu.com>",
+                          "2011",
+                          "2011",
+                          N_("From _Webpage..."),
+                          NULL,
+                          GIMP_PLUGIN,
+                          G_N_ELEMENTS (args),
+                          G_N_ELEMENTS (return_vals),
+                          args, return_vals);
+
+  gimp_plugin_menu_register (PLUG_IN_PROC, "<Image>/File/Create/Acquire");
+}
+
+static void
+run (const gchar      *name,
+     gint             nparams,
+     const GimpParam  *param,
+     gint             *nreturn_vals,
+     GimpParam       **return_vals)
+{
+  GimpRunMode        run_mode = param[0].data.d_int32;
+  GimpPDBStatusType  status   = GIMP_PDB_EXECUTION_ERROR;
+  gint32             image_id = -1;
+
+  static GimpParam   values[2];
+
+  INIT_I18N ();
+
+  /* initialize the return of the status */
+  *nreturn_vals = 1;
+  *return_vals  = values;
+  values[0].type = GIMP_PDB_STATUS;
+
+  /* MUST call this before any RSVG funcs */
+  g_type_init ();
+
+  /* how are we running today? */
+  switch (run_mode)
+    {
+    case GIMP_RUN_INTERACTIVE:
+      if (webpage_dialog ())
+        status = GIMP_PDB_SUCCESS;
+      else
+        status = GIMP_PDB_CANCEL;
+      break;
+
+    case GIMP_RUN_WITH_LAST_VALS:
+      /* This is currently not supported. */
+      break;
+
+    case GIMP_RUN_NONINTERACTIVE:
+      webpagevals.url = param[1].data.d_string;
+      webpagevals.width = param[2].data.d_int32;
+      status = GIMP_PDB_SUCCESS;
+      break;
+
+    default:
+      break;
+    }
+
+  if (status == GIMP_PDB_SUCCESS)
+    {
+      image_id = webpage_capture ();
+
+      if (image_id == -1)
+        status = GIMP_PDB_EXECUTION_ERROR;
+    };
+
+  if (status == GIMP_PDB_SUCCESS)
+    {
+      if (run_mode == GIMP_RUN_INTERACTIVE)
+	gimp_display_new (image_id);
+
+      /* set return values */
+      *nreturn_vals = 2;
+
+      values[1].type         = GIMP_PDB_IMAGE;
+      values[1].data.d_image = image_id;
+    }
+
+  values[0].data.d_status = status;
+}
+
+static gboolean
+webpage_dialog (void)
+{
+  GtkWidget *dialog;
+  GtkWidget *hbox;
+  GtkWidget *vbox;
+  GtkWidget *image;
+  GtkWidget *label;
+  GtkWidget *entry;
+  gboolean status;
+
+  gimp_ui_init (PLUG_IN_BINARY, FALSE);
+
+  dialog = gimp_dialog_new (_("Create from webpage"), PLUG_IN_BINARY,
+                            NULL, 0,
+                            gimp_standard_help_func, PLUG_IN_PROC,
+
+                            GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
+                            _("_Create"),     GTK_RESPONSE_OK,
+
+                            NULL);
+
+  gtk_dialog_set_alternative_button_order (GTK_DIALOG (dialog),
+                                           GTK_RESPONSE_OK,
+                                           GTK_RESPONSE_CANCEL,
+                                           -1);
+  gimp_window_set_transient (GTK_WINDOW (dialog));
+
+  hbox = gtk_hbox_new (FALSE, 12);
+  gtk_container_set_border_width (GTK_CONTAINER (hbox), 12);
+  gtk_box_pack_start (GTK_BOX (gtk_dialog_get_content_area (GTK_DIALOG (dialog))),
+                      hbox, FALSE, FALSE, 0);
+  gtk_widget_show (hbox);
+
+  vbox = gtk_vbox_new (FALSE, 0);
+  gtk_box_pack_start (GTK_BOX (hbox), vbox, FALSE, FALSE, 0);
+  gtk_widget_show (vbox);
+
+  image = gtk_image_new_from_stock (GIMP_STOCK_WEB, GTK_ICON_SIZE_BUTTON);
+  gtk_box_pack_start (GTK_BOX (vbox), image, FALSE, FALSE, 0);
+  gtk_widget_show (image);
+
+  vbox = gtk_vbox_new (FALSE, 6);
+  gtk_box_pack_start (GTK_BOX (hbox), vbox, TRUE, TRUE, 0);
+  gtk_widget_show (vbox);
+
+  label = gtk_label_new (_("Enter location (URI):"));
+  gtk_misc_set_alignment (GTK_MISC (label), 0.0, 1.0);
+  gtk_box_pack_start (GTK_BOX (vbox), label, FALSE, FALSE, 0);
+  gtk_widget_show (label);
+
+  entry = gtk_entry_new ();
+  gtk_entry_set_activates_default (GTK_ENTRY (entry), TRUE);
+  gtk_widget_set_size_request (entry, 400, -1);
+  gtk_box_pack_start (GTK_BOX (vbox), entry, FALSE, FALSE, 0);
+
+  if (webpagevals.url)
+    gtk_entry_set_text (GTK_ENTRY (entry),
+                        webpagevals.url);
+  else
+    gtk_entry_set_text (GTK_ENTRY (entry),
+                        "http://www.gimp.org/");
+
+  gtk_widget_show (entry);
+
+  status = gimp_dialog_run (GIMP_DIALOG (dialog));
+  if (status == GTK_RESPONSE_OK)
+    {
+      g_free (webpagevals.url);
+      webpagevals.url = g_strdup (gtk_entry_get_text (GTK_ENTRY (entry)));
+    }
+
+  gtk_widget_destroy (dialog);
+
+  return status;
+}
+
+static void
+load_finished_cb (WebKitWebView  *view,
+                  WebKitWebFrame *frame,
+                  gpointer        user_data)
+{
+  GtkWidget *window = GTK_WIDGET (user_data);
+
+  webpixbuf = gtk_offscreen_window_get_pixbuf (GTK_OFFSCREEN_WINDOW (window));
+
+  gtk_main_quit ();
+}
+
+static gint32
+webpage_capture (void)
+{
+  gint32 image = -1;
+  GtkWidget *window;
+  GtkWidget *view;
+
+  if ((! webpagevals.url) ||
+      (strlen (webpagevals.url) == 0))
+    {
+      g_warning ("No URI was provided.");
+      return -1;
+    }
+
+  if (webpagevals.width < 32)
+    {
+      g_warning ("Width `%d' is too small. Clamped to 32.",
+                 webpagevals.width);
+      webpagevals.width = 32;
+    }
+  else if (webpagevals.width > 8192)
+    {
+      g_warning ("Width `%d' is too large. Clamped to 8192.",
+                 webpagevals.width);
+      webpagevals.width = 8192;
+    }
+
+  if (webpixbuf)
+    {
+      g_object_unref (webpixbuf);
+      webpixbuf = NULL;
+    }
+
+  window = gtk_offscreen_window_new ();
+  gtk_widget_show (window);
+
+  view = webkit_web_view_new ();
+  gtk_widget_show (view);
+
+  gtk_widget_set_size_request (view, webpagevals.width, -1);
+  gtk_container_add (GTK_CONTAINER (window), view);
+
+  g_signal_connect (view, "load-finished",
+                    G_CALLBACK (load_finished_cb),
+                    window);
+
+  webkit_web_view_open (WEBKIT_WEB_VIEW (view),
+                        webpagevals.url);
+
+  gtk_main ();
+
+  gtk_widget_destroy (window);
+
+  if (webpixbuf)
+    {
+      gint width;
+      gint height;
+      gint32 layer;
+
+      gimp_progress_init (_("Preparing webpage"));
+
+      width  = gdk_pixbuf_get_width (webpixbuf);
+      height = gdk_pixbuf_get_height (webpixbuf);
+
+      image = gimp_image_new (width, height, GIMP_RGB);
+
+      gimp_image_undo_disable (image);
+      layer = gimp_layer_new_from_pixbuf (image, _("Webpage"), webpixbuf,
+                                          100, GIMP_NORMAL_MODE, 0.0, 1.0);
+      gimp_image_insert_layer (image, layer, -1, 0);
+      gimp_image_undo_enable (image);
+
+      gimp_image_clean_all (image);
+
+      g_object_unref (webpixbuf);
+      webpixbuf = NULL;
+    }
+
+  return image;
+}