annotate pidgin/gtkwebview.c @ 32080:b89351c7580b

safely execute JS scripts only after loading is done. Untested code as of now, will test it in next commit.

/*
 * @file gtkwebview.c GTK+ WebKitWebView wrapper class.
 * @ingroup pidgin
 */

/* pidgin
 *
 * Pidgin is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * This program is free software; you can redistribute it and/or modify
 * under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 *
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <ctype.h>
#include <string.h>
#include <glib.h>
#include <glib/gstdio.h>
#include <JavaScriptCore/JavaScript.h>

#include "util.h"
#include "gtkwebview.h"
#include "imgstore.h"

static WebKitWebViewClass *parent_class = NULL;

struct GtkWebViewPriv {
	GHashTable *images; /**< a map from id to temporary file for the image */
	gboolean    empty;  /**< whether anything has been appended **/

	/* JS execute queue */
	GQueue *js_queue;
	gboolean is_loading;
};

GtkWidget* gtk_webview_new ()
{
	GtkWebView* ret = GTK_WEBVIEW (g_object_new(gtk_webview_get_type(), NULL));
	return GTK_WIDGET (ret);
}

static char*
get_image_filename_from_id (GtkWebView* view, int id)
{
	char *filename = NULL;
	FILE *file;
	PurpleStoredImage* img;

	if (!view->priv->images)
		view->priv->images = g_hash_table_new_full (g_direct_hash, g_direct_equal, NULL, g_free);
	
	filename = (char*) g_hash_table_lookup (view->priv->images, GINT_TO_POINTER (id));
	if (filename) return filename;
			
	/* else get from img store */
	file = purple_mkstemp (&filename, TRUE);

	img = purple_imgstore_find_by_id (id);

	fwrite (purple_imgstore_get_data (img), purple_imgstore_get_size (img), 1, file);
	g_hash_table_insert (view->priv->images, GINT_TO_POINTER (id), filename);
	fclose (file);
	return filename;
}

static void 
clear_single_image (gpointer key, gpointer value, gpointer userdata) 
{
	g_unlink ((char*) value);
}

static void
clear_images (GtkWebView* view)
{
	if (!view->priv->images) return;
	g_hash_table_foreach (view->priv->images, clear_single_image, NULL);
	g_hash_table_unref (view->priv->images);
}

/*
 * Replace all <img id=""> tags with <img src="">. I hoped to never
 * write any HTML parsing code, but I'm forced to do this, until 
 * purple changes the way it works.
 */
static char*
replace_img_id_with_src (GtkWebView *view, const char* html)
{
	GString *buffer = g_string_sized_new (strlen (html));
	const char* cur = html;
	char *id;
	int nid;

	while (*cur) {
		const char* img = strstr (cur, "<img");
		if (!img) {
			g_string_append (buffer, cur);
			break;
		} else
			g_string_append_len (buffer, cur, img - cur);

		cur = strstr (img, "/>");
		if (!cur)
			cur = strstr (img, ">");

		if (!cur) { /* invalid html? */
			g_string_printf (buffer, "%s", html);
			break;
		}

		if (strstr (img, "src=") || !strstr (img, "id=")) {
			g_string_printf (buffer, "%s", html);
			break;
		}

		/*
		 * if this is valid HTML, then I can be sure that it
		 * has an id= and does not have an src=, since
		 * '=' cannot appear in parameters.
		 */

		id = strstr (img, "id=") + 3; 

		/* *id can't be \0, since a ">" appears after this */
		if (isdigit (*id)) 
			nid = atoi (id);
		else 
			nid = atoi (id+1);

		/* let's dump this, tag and then dump the src information */
		g_string_append_len (buffer, img, cur - img);

		g_string_append_printf (buffer, " src='file://%s' ", get_image_filename_from_id (view, nid));
	}

	return g_string_free (buffer, FALSE);
}

static void
gtk_webview_finalize (GObject *view)
{
	clear_images (GTK_WEBVIEW (view));
	g_free (GTK_WEBVIEW(view)->priv);
	G_OBJECT_CLASS (parent_class)->finalize (G_OBJECT(view));
}

static void
gtk_webview_class_init (GtkWebViewClass *klass, gpointer userdata)
{
	parent_class = g_type_class_ref (webkit_web_view_get_type ());
	G_OBJECT_CLASS (klass)->finalize = gtk_webview_finalize;
}

static gboolean
webview_link_clicked (WebKitWebView *view,
		      WebKitWebFrame *frame,
		      WebKitNetworkRequest *request,
		      WebKitWebNavigationAction *navigation_action,
		      WebKitWebPolicyDecision *policy_decision)
{
	const gchar *uri;

	uri = webkit_network_request_get_uri (request);

	/* the gtk imhtml way was to create an idle cb, not sure
	 * why, so right now just using purple_notify_uri directly */
	purple_notify_uri (NULL, uri);
	return TRUE;
}

static gboolean
process_js_script_queue (GtkWebView *view)
{
	char *script;
	if (view->priv->is_loading) return FALSE; /* we will be called when loaded */
	if (!view->priv->js_queue || g_queue_is_empty (view->priv->js_queue))
		return FALSE; /* nothing to do! */

	script = g_queue_pop_head (view->priv->js_queue);
	webkit_web_view_execute_script (WEBKIT_WEB_VIEW(view), script);
	g_free (script);

	return TRUE; /* there may be more for now */
}

static void 
webview_load_started (WebKitWebView *view,
		      WebKitWebFrame *frame,
		      gpointer userdata)
{
	/* is there a better way to test for is_loading? */
	GTK_WEBVIEW(view)->priv->is_loading = true;
}

static void
webview_load_finished (WebKitWebView *view,
		       WebKitWebFrame *frame,
		       gpointer userdata)
{
	GTK_WEBVIEW(view)->priv->is_loading = false;
	g_idle_add ((GSourceFunc) process_js_script_queue, view);
}

char*
gtk_webview_execute_script (GtkWebView *view, const char *script)
{
	JSStringRef js_script = JSStringCreateWithUTF8CString (script);
	JSContextRef ctxt = webkit_web_frame_get_global_context (
		webkit_web_view_get_main_frame (WEBKIT_WEB_VIEW (view))
		);
	JSValueRef ret = JSEvaluateScript (ctxt, js_script, NULL, NULL, 0, NULL);
	JSStringRef ret_as_str = JSValueToStringCopy (ctxt, ret, NULL);

	size_t cstr_len = JSStringGetMaximumUTF8CStringSize (ret_as_str);
	char   *cstr = g_new0(char, cstr_len + 1);

	JSStringGetUTF8CString (ret_as_str, cstr, cstr_len);

	/* TODO: I'm not sure what, if at all, I need to free here! */
	return cstr;
}

void
gtk_webview_safe_execute_script (GtkWebView *view, const char* script)
{
	g_queue_push_tail (view->priv->js_queue, g_strdup (script));
	g_idle_add ((GSourceFunc)process_js_script_queue, view);
}

static void
gtk_webview_init (GtkWebView *view, gpointer userdata)
{
	view->priv = g_new0 (struct GtkWebViewPriv, 1);
	g_signal_connect (view, "navigation-policy-decision-requested",
			  G_CALLBACK (webview_link_clicked),
			  view);

	g_signal_connect (view, "load-started", 
			  G_CALLBACK (webview_load_started),
			  view);

	g_signal_connect (view, "load-finished",
			  G_CALLBACK (webview_load_finished),
			  view);
			  
	view->priv->empty = TRUE;
}


void
gtk_webview_load_html_string_with_imgstore (GtkWebView* view, const char* html)
{
	char* html_imged;
	
	clear_images (view);
	html_imged = replace_img_id_with_src (view, html);
	printf ("%s\n", html_imged);
	webkit_web_view_load_html_string (WEBKIT_WEB_VIEW (view), html_imged, "file:///");
	g_free (html_imged);
}

char *gtk_webview_quote_js_string(const char *text)
{
        GString *str = g_string_new("\"");
        const char *cur = text;

        while (cur && *cur) {
                switch (*cur) {
                case '\\':
                        g_string_append(str, "\\\\");   
                        break;
                case '\"':
                        g_string_append(str, "\\\"");
                        break;
                case '\r':
                        g_string_append(str, "<br/>");
                        break;
                case '\n':
                        break;
                default:
			g_string_append_c(str, *cur);
		}
		cur ++;
	}
	g_string_append_c (str, '"');
	return g_string_free (str, FALSE);
}


/* this is a "hack", my plan is to eventually handle this 
 * correctly using a signals and a plugin: the plugin will have
 * the information as to what javascript function to call. It seems
 * wrong to hardcode that here.
 */
void
gtk_webview_append_html (GtkWebView* view, const char* html)
{
	char* escaped = gtk_webview_quote_js_string (html);
	char* script = g_strdup_printf ("document.write(%s)", escaped);
	printf ("script: %s\n", script);
	webkit_web_view_execute_script (WEBKIT_WEB_VIEW (view), script);
	view->priv->empty = FALSE;
	g_free (script);
	g_free (escaped);
}

char*
gtk_webview_get_markup (GtkWebView *view)
{
	return gtk_webview_execute_script (view, "document.body.innerHTML");
}

char*
gtk_webview_get_text (GtkWebView *view)
{
	return gtk_webview_execute_script (view, "document.body.textContent");
}

gboolean gtk_webview_is_empty (GtkWebView *view)
{
	return view->priv->empty;
}

GType gtk_webview_get_type ()
{
	static GType mview_type = 0;
	if (G_UNLIKELY (mview_type == 0)) {
		static const GTypeInfo mview_info = {
			sizeof (GtkWebViewClass),
			NULL,
			NULL,
			(GClassInitFunc) gtk_webview_class_init,
			NULL,
			NULL,
			sizeof (GtkWebView),
			0,
			(GInstanceInitFunc) gtk_webview_init,
			NULL
		};
		mview_type = g_type_register_static(webkit_web_view_get_type (),
				"GtkWebView", &mview_info, 0);
	}
	return mview_type;
}