Add some code so ad blocking should be more easy. Based on the fact that

2005-12-19  Jean-François Rameau  <jframeau@cvs.gnome.org>

	* embed/Makefile.am:
	* embed/ephy-adblock-manager.c:
	* embed/ephy-adblock-manager.h:
	* embed/ephy-embed-shell.c: (ephy_embed_shell_finalize):
	* embed/ephy-embed-shell.h:
	* embed/mozilla/EphyContentPolicy.cpp: (EphyContentPolicy::ShouldLoad):
	* lib/Makefile.am:
	* lib/ephy-adblock.h:
	* lib/ephy-adblock.c:
	* src/ephy-shell.c: (ephy_shell_get_extensions_manager):

	Add some code so ad blocking should be more easy. Based on the fact
	that Epiphany already has its own content policy component (EphyContentPolicy).
	The new design adds:
	- an interface, EphyAdBlock
	- a manager, EphyAdBlockManager, pointing to a blocker (possibly no one).

11 files changed, 383 insertions, 7 deletions

diff --git a/ChangeLog b/ChangeLog
index ce18682eb..e640462a2 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,22 @@
+2005-12-19  Jean-François Rameau  <jframeau@cvs.gnome.org>
+
+	* embed/Makefile.am:
+	* embed/ephy-adblock-manager.c:
+	* embed/ephy-adblock-manager.h:
+	* embed/ephy-embed-shell.c: (ephy_embed_shell_finalize):
+	* embed/ephy-embed-shell.h:
+	* embed/mozilla/EphyContentPolicy.cpp: (EphyContentPolicy::ShouldLoad):
+	* lib/Makefile.am:
+	* lib/ephy-adblock.h:
+	* lib/ephy-adblock.c:
+	* src/ephy-shell.c: (ephy_shell_get_extensions_manager):
+
+	Add some code so ad blocking should be more easy. Based on the fact
+	that Epiphany already has its own content policy component (EphyContentPolicy).
+	The new design adds:
+	- an interface, EphyAdBlock
+	- a manager, EphyAdBlockManager, pointing to a blocker (possibly no one).
+
 2005-12-16  Claudio Saavedra  <csaavedra@alumnos.utalca.cl>
 
 	* lib/egg/egg-editable-toolbar.c: (configure_item_cursor):
diff --git a/embed/Makefile.am b/embed/Makefile.am
index de5375508..b97b81d54 100644
--- a/embed/Makefile.am
+++ b/embed/Makefile.am
@@ -17,6 +17,7 @@ NOINST_H_FILES = \
 	print-dialog.h
 
 INST_H_FILES = \
+	ephy-adblock-manager.h		\
 	ephy-command-manager.h		\
 	ephy-cookie-manager.h		\
 	ephy-embed.h			\
@@ -31,6 +32,7 @@ INST_H_FILES = \
 	ephy-permission-manager.h
 
 libephyembed_la_SOURCES = \
+	ephy-adblock-manager.c		\
 	downloader-view.c		\
 	ephy-command-manager.c		\
 	ephy-cookie-manager.c		\
diff --git a/embed/ephy-adblock-manager.c b/embed/ephy-adblock-manager.c
new file mode 100644
index 000000000..cb4e6dda5
--- /dev/null
+++ b/embed/ephy-adblock-manager.c
@@ -0,0 +1,101 @@
+/*
+ *  Copyright (C) 2003 Marco Pesenti Gritti
+ *  Copyright (C) 2003 Christian Persch
+ *  Copyright (C) 2005 Jean-François Rameau
+ *
+ *  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 2, 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ *
+ *  $Id$
+ */
+
+#include "config.h"
+#include "ephy-debug.h"
+
+#include "ephy-adblock-manager.h"
+#include "ephy-adblock.h"
+
+struct _EphyAdBlockManagerPrivate
+{
+       	EphyAdBlock *blocker;
+};
+
+G_DEFINE_TYPE (EphyAdBlockManager, ephy_adblock_manager, G_TYPE_OBJECT);
+
+#define EPHY_ADBLOCK_MANAGER_GET_PRIVATE(object) \
+	(G_TYPE_INSTANCE_GET_PRIVATE ((object), \
+         EPHY_TYPE_ADBLOCK_MANAGER, EphyAdBlockManagerPrivate))
+/**
+ * ephy_adblock_manager_set_blocker:
+ * @shell: a #EphyAdBlockManager
+ * @blocker: the new blocker or NULL
+ *
+ * Set a new ad blocker. If #blocker is %NULL,
+ * ad blocking is toggled off.
+ *
+ **/
+void
+ephy_adblock_manager_set_blocker (EphyAdBlockManager *self,
+			  	  EphyAdBlock *blocker)
+{
+	self->priv->blocker = blocker;
+}
+
+/**
+ * ephy_adblock_manager_should_load:
+ * @shell: a #EphyAdBlockManager
+ * @url: the target url to be loaded or not
+ * @AdUriCheckType: what check to be applied (image, script, ...)
+ *
+ * Check if an url is to be loaded or not 
+ *
+ * ReturnValue: TRUE if the url is to be loaded
+ **/
+gboolean
+ephy_adblock_manager_should_load (EphyAdBlockManager *self,
+	    	 	    	  const char *url,
+	    	 	    	  AdUriCheckType check_type)
+{
+	if (self->priv->blocker != NULL)
+	{
+		return ephy_adblock_should_load (self->priv->blocker,	
+						 url,
+						 check_type);
+	}
+
+	/* default: let's process any url */
+	return TRUE;
+}
+
+static void
+ephy_adblock_manager_init (EphyAdBlockManager *self)
+{
+	EphyAdBlockManagerPrivate *priv;
+
+	LOG ("ephy_adblock_manager_init");
+
+	priv = EPHY_ADBLOCK_MANAGER_GET_PRIVATE(self);
+	priv->blocker = NULL;
+	self->priv = priv;
+}
+
+static void
+ephy_adblock_manager_class_init (EphyAdBlockManagerClass *klass)
+{
+	GObjectClass *object_class = G_OBJECT_CLASS (klass);
+
+	g_type_class_add_private (object_class, sizeof (EphyAdBlockManagerPrivate));
+}
+
+
diff --git a/embed/ephy-adblock-manager.h b/embed/ephy-adblock-manager.h
new file mode 100644
index 000000000..a499ad810
--- /dev/null
+++ b/embed/ephy-adblock-manager.h
@@ -0,0 +1,64 @@
+/*
+ *  Copyright (C) 2003 Marco Pesenti Gritti
+ *  Copyright (C) 2003 Christian Persch
+ *  Copyright (C) 2005 Jean-François Rameau
+ *
+ *  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 2, 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ *
+ *  $Id$
+ */
+
+#ifndef EPHY_ADBLOCK_MANAGER_H
+#define EPHY_ADBLOCK_MANAGER_H
+
+#include <glib-object.h>
+#include "ephy-adblock.h"
+
+G_BEGIN_DECLS
+
+#define EPHY_TYPE_ADBLOCK_MANAGER ephy_adblock_manager_get_type()
+#define EPHY_ADBLOCK_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), EPHY_TYPE_ADBLOCK_MANAGER, EphyAdBlockManager))
+#define EPHY_ADBLOCK_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), EPHY_TYPE_ADBLOCK_MANAGER, EphyAdBlockManagerwClass))
+#define EPHY_IS_ADBLOCK_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), EPHY_TYPE_ADBLOCK_MANAGER))
+#define EPHY_IS_ADBLOCK_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), EPHY_TYPE_ADBLOCK_MANAGER))
+#define EPHY_ADBLOCK_MANAGER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), EPHY_TYPE_ADBLOCK_MANAGER, EphyAdBlockManagerwClass))
+
+typedef struct _EphyAdBlockManager             EphyAdBlockManager;
+typedef struct _EphyAdBlockManagerClass        EphyAdBlockManagerClass;
+typedef struct _EphyAdBlockManagerPrivate      EphyAdBlockManagerPrivate;
+
+struct _EphyAdBlockManager {
+        GObject parent;
+
+	/* < private > */
+	EphyAdBlockManagerPrivate *priv;
+};
+
+struct _EphyAdBlockManagerClass {
+        GObjectClass parent_class;
+};
+
+GType 			ephy_adblock_manager_get_type (void);
+
+gboolean		ephy_adblock_manager_should_load (EphyAdBlockManager *self,
+				    	 	    	  const char *url,
+				    	 	    	  AdUriCheckType check_type);
+
+void 			ephy_adblock_manager_set_blocker (EphyAdBlockManager *self,
+							  EphyAdBlock *blocker);
+
+G_END_DECLS
+
+#endif
diff --git a/embed/ephy-embed-shell.c b/embed/ephy-embed-shell.c
index acee03562..9e50c59fc 100644
--- a/embed/ephy-embed-shell.c
+++ b/embed/ephy-embed-shell.c
@@ -31,6 +31,7 @@
 #include "downloader-view.h"
 #include "ephy-encodings.h"
 #include "ephy-debug.h"
+#include "ephy-adblock-manager.h"
 
 #define EPHY_EMBED_SHELL_GET_PRIVATE(object)(G_TYPE_INSTANCE_GET_PRIVATE ((object), EPHY_TYPE_EMBED_SHELL, EphyEmbedShellPrivate))
 
@@ -41,6 +42,7 @@ struct _EphyEmbedShellPrivate
 	EphyFaviconCache *favicon_cache;
 	EphyEmbedSingle *embed_single;
 	EphyEncodings *encodings;
+	EphyAdBlockManager *adblock_manager;
 };
 
 enum
@@ -136,6 +138,13 @@ ephy_embed_shell_finalize (GObject *object)
 		g_object_unref (G_OBJECT (shell->priv->embed_single));
 	}
 
+	if (shell->priv->adblock_manager != NULL)
+	{
+		LOG ("Unref adblock manager");
+		g_object_unref (shell->priv->adblock_manager);
+		shell->priv->adblock_manager = NULL;
+	}
+
 	G_OBJECT_CLASS (parent_class)->finalize (object);
 }
 
@@ -284,3 +293,25 @@ ephy_embed_shell_get_default (void)
 {
 	return embed_shell;
 }
+
+/**
+ * ephy_embed_shell_get_adblock_manager:
+ * @shell: the #EphyEmbedShell
+ *
+ * Returns the adblock manager.
+ *
+ * Return value: the adblock manager
+ **/
+GObject *
+ephy_embed_shell_get_adblock_manager (EphyEmbedShell *shell)
+{
+	g_return_val_if_fail (EPHY_IS_EMBED_SHELL (shell), NULL);
+
+	if (shell->priv->adblock_manager == NULL)
+	{
+		shell->priv->adblock_manager = g_object_new (EPHY_TYPE_ADBLOCK_MANAGER, NULL);
+	}
+
+	return G_OBJECT (shell->priv->adblock_manager);
+}
+
diff --git a/embed/ephy-embed-shell.h b/embed/ephy-embed-shell.h
index 3e10d1b5d..5f5a1b7df 100644
--- a/embed/ephy-embed-shell.h
+++ b/embed/ephy-embed-shell.h
@@ -71,6 +71,8 @@ GObject		  *ephy_embed_shell_get_encodings	(EphyEmbedShell *shell);
 
 GObject		  *ephy_embed_shell_get_embed_single	(EphyEmbedShell *shell);
 
+GObject        	  *ephy_embed_shell_get_adblock_manager	(EphyEmbedShell *shell);
+
 void		   ephy_embed_shell_prepare_close	(EphyEmbedShell *shell);
 
 G_END_DECLS
diff --git a/embed/mozilla/EphyContentPolicy.cpp b/embed/mozilla/EphyContentPolicy.cpp
index c2277b761..aedcc8aac 100644
--- a/embed/mozilla/EphyContentPolicy.cpp
+++ b/embed/mozilla/EphyContentPolicy.cpp
@@ -28,6 +28,7 @@
 #include "ephy-embed-shell.h"
 #include "ephy-embed-single.h"
 #include "eel-gconf-extensions.h"
+#include "ephy-adblock-manager.h"
 #include "ephy-debug.h"
 
 #include <nsCOMPtr.h>
@@ -76,17 +77,33 @@ EphyContentPolicy::ShouldLoad(PRUint32 aContentType,
 
 	*aDecision = nsIContentPolicy::ACCEPT;
 
-	PRBool isHttp = PR_FALSE, isHttps = PR_FALSE;
-	aContentLocation->SchemeIs ("http", &isHttp);
-	aContentLocation->SchemeIs ("https", &isHttps);
-	if (isHttp || isHttps) return NS_OK;
-
 	/* We have to always allow these, else forms and scrollbars break */
 	PRBool isChrome = PR_FALSE, isResource = PR_FALSE;
 	aContentLocation->SchemeIs ("chrome", &isChrome);
 	aContentLocation->SchemeIs ("resource", &isResource);
 	if (isChrome || isResource) return NS_OK;
 
+	PRBool isHttps = PR_FALSE;
+	aContentLocation->SchemeIs ("https", &isHttps);
+	if (isHttps) return NS_OK;
+
+	/* is this url allowed ? */
+	nsEmbedCString spec;
+	aContentLocation->GetSpec(spec);
+
+	EphyAdBlockManager *adblock_manager = 
+		EPHY_ADBLOCK_MANAGER (ephy_embed_shell_get_adblock_manager (embed_shell));
+
+	if (!ephy_adblock_manager_should_load (adblock_manager, spec.get (), AdUriCheckType(aContentType)))
+	{
+		*aDecision = nsIContentPolicy::REJECT_REQUEST;
+		return NS_OK;
+	}
+
+	PRBool isHttp = PR_FALSE;
+	aContentLocation->SchemeIs ("http", &isHttp);
+	if (isHttp) return NS_OK;
+
 	nsEmbedCString contentSpec;
 	aContentLocation->GetSpec (contentSpec);
 	if (strcmp (contentSpec.get(), "about:blank") == 0) return NS_OK;
@@ -155,7 +172,6 @@ NS_IMETHODIMP EphyContentPolicy::ShouldLoad(PRInt32 aContentType,
 	{
 		*_retval = PR_FALSE;
 	}
-
 	return NS_OK;
 }
 
diff --git a/lib/Makefile.am b/lib/Makefile.am
index 10a357a2e..44a9e3a7f 100644
--- a/lib/Makefile.am
+++ b/lib/Makefile.am
@@ -27,11 +27,13 @@ NOINST_H_FILES = \
 	ephy-zoom.h
 
 TYPES_H_FILES = \
+	ephy-adblock.h				\
 	ephy-dbus.h				\
 	ephy-node.h				\
 	ephy-state.h
 
 INST_H_FILES = \
+	ephy-adblock.h				\
 	ephy-dbus.h				\
 	ephy-dialog.h				\
 	ephy-loader.h				\
@@ -41,6 +43,7 @@ INST_H_FILES = \
 
 libephymisc_la_SOURCES = \
 	eel-gconf-extensions.c			\
+	ephy-adblock.c				\
 	ephy-dbus.c				\
 	ephy-debug.c				\
 	ephy-dialog.c				\
diff --git a/lib/ephy-adblock.c b/lib/ephy-adblock.c
new file mode 100644
index 000000000..ccb96ea64
--- /dev/null
+++ b/lib/ephy-adblock.c
@@ -0,0 +1,59 @@
+/*
+ *  Copyright (C) 2003 Marco Pesenti Gritti
+ *  Copyright (C) 2003 Christian Persch
+ *  Copyright (C) 2005 Jean-François Rameau
+ *
+ *  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 2, 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ *
+ *  $Id$
+ */
+
+#include "config.h"
+
+#include "ephy-adblock.h"
+
+GType
+ephy_adblock_get_type (void)
+{
+	static GType type = 0;
+
+	if (G_UNLIKELY (type == 0))
+	{
+		static const GTypeInfo our_info =
+		{
+			sizeof (EphyAdBlockIface),
+			NULL,
+			NULL,
+		};
+	
+		type = g_type_register_static (G_TYPE_INTERFACE,
+					       "EphyAdBlock",
+					       &our_info, 0);
+	}
+
+	return type;
+}
+
+gboolean
+ephy_adblock_should_load (EphyAdBlock *adblock,
+			  const char *url,
+			  AdUriCheckType check_type)
+{
+	EphyAdBlockIface *iface = EPHY_ADBLOCK_GET_IFACE (adblock);
+	if (iface->should_load)
+	{
+		return iface->should_load (adblock, url, check_type);
+	}
+}
diff --git a/lib/ephy-adblock.h b/lib/ephy-adblock.h
new file mode 100644
index 000000000..f102a1961
--- /dev/null
+++ b/lib/ephy-adblock.h
@@ -0,0 +1,79 @@
+/*
+ *  Copyright (C) 2003 Marco Pesenti Gritti
+ *  Copyright (C) 2003 Christian Persch
+ *  Copyright (C) 2005 Jean-François Rameau
+ *
+ *  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 2, 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ *
+ *  $Id$
+ */
+
+#ifndef EPHY_ADBLOCK_H
+#define EPHY_ADBLOCK_H
+
+#include <glib-object.h>
+
+G_BEGIN_DECLS
+
+#define EPHY_TYPE_ADBLOCK		(ephy_adblock_get_type ())
+#define EPHY_ADBLOCK(obj)		(G_TYPE_CHECK_INSTANCE_CAST ((obj), EPHY_TYPE_ADBLOCK, EphyAdBlock))
+#define EPHY_ADBLOCK_IFACE(klass)	(G_TYPE_CHECK_CLASS_CAST ((klass), EPHY_TYPE_ADBLOCK, EphyAdBlockIface))
+#define EPHY_IS_ADBLOCK(obj)		(G_TYPE_CHECK_INSTANCE_TYPE ((obj), EPHY_TYPE_ADBLOCK))
+#define EPHY_IS_ADBLOCK_IFACE(class)	(G_TYPE_CHECK_CLASS_TYPE ((class), EPHY_TYPE_ADBLOCK))
+#define EPHY_ADBLOCK_GET_IFACE(inst)	(G_TYPE_INSTANCE_GET_INTERFACE ((inst), EPHY_TYPE_ADBLOCK, EphyAdBlockIface))
+
+typedef enum
+{
+        AD_URI_CHECK_TYPE_OTHER       = 1U,
+        AD_URI_CHECK_TYPE_SCRIPT      = 2U, /* Indicates an executable script
+					       (such as JavaScript) */
+        AD_URI_CHECK_TYPE_IMAGE       = 3U, /* Indicates an image (e.g., IMG
+					       elements) */
+        AD_URI_CHECK_TYPE_STYLESHEET  = 4U, /* Indicates a stylesheet (e.g.,
+					       STYLE elements) */
+        AD_URI_CHECK_TYPE_OBJECT      = 5U, /* Indicates a generic object
+					       (plugin-handled content
+					       typically falls under this
+					       category) */
+        AD_URI_CHECK_TYPE_DOCUMENT    = 6U, /* Indicates a document at the
+					       top-level (i.e., in a
+					       browser) */
+	AD_URI_CHECK_TYPE_SUBDOCUMENT = 7U, /* Indicates a document contained
+					       within another document (e.g.,
+					       IFRAMEs, FRAMES, and OBJECTs) */
+        AD_URI_CHECK_TYPE_REFRESH     = 8U  /* Indicates a timed refresh */
+} AdUriCheckType;
+
+typedef struct _EphyAdBlock		EphyAdBlock;
+typedef struct _EphyAdBlockIface	EphyAdBlockIface;
+	
+struct _EphyAdBlockIface
+{
+	GTypeInterface base_iface;
+
+	gboolean	(* should_load)	(EphyAdBlock *adblock,
+				         const char *url,
+				         AdUriCheckType check_type);
+};
+
+GType		ephy_adblock_get_type		(void);
+
+gboolean	ephy_adblock_should_load 	(EphyAdBlock *adblock,
+				    	 	 const char *url,
+				    	 	 AdUriCheckType check_type);
+
+G_END_DECLS
+
+#endif
diff --git a/src/ephy-shell.c b/src/ephy-shell.c
index c7dc315c5..7c088b452 100644
--- a/src/ephy-shell.c
+++ b/src/ephy-shell.c
@@ -81,7 +81,6 @@ struct _EphyShellPrivate
 	GObject *prefs_dialog;
 	GObject *print_setup_dialog;
 	GList *del_on_exit;
-
 	gboolean embed_single_connected;
 };
 
@@ -966,6 +965,7 @@ ephy_shell_get_extensions_manager (EphyShell *es)
 
 		/* FIXME */
 		ephy_shell_get_lockdown (es);
+		ephy_embed_shell_get_adblock_manager (embed_shell);
 	}
 
 	return G_OBJECT (es->priv->extensions_manager);