Initial implementation of an Advertisement blocker
The dialog isn't finished, you have to add URIs to the config file by hand.
This commit is contained in:
Christian Dywan
parent
c9550d36e3
commit
d90f3d7680
1 changed files with 385 additions and 0 deletions
385
extensions/adblock.c
Normal file
385
extensions/adblock.c
Normal file
|
|
@ -0,0 +1,385 @@
|
||||||
|
/*
|
||||||
|
Copyright (C) 2009 Christian Dywan <christian@twotoasts.de>
|
||||||
|
|
||||||
|
This library is free software; you can redistribute it and/or
|
||||||
|
modify it under the terms of the GNU Lesser General Public
|
||||||
|
License as published by the Free Software Foundation; either
|
||||||
|
version 2.1 of the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
See the file COPYING for the full license text.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include <midori/midori.h>
|
||||||
|
|
||||||
|
#include <midori/sokoke.h>
|
||||||
|
#include "config.h"
|
||||||
|
|
||||||
|
#include <glib/gstdio.h>
|
||||||
|
|
||||||
|
static void
|
||||||
|
adblock_app_add_browser_cb (MidoriApp* app,
|
||||||
|
MidoriBrowser* browser,
|
||||||
|
MidoriExtension* extension);
|
||||||
|
|
||||||
|
static void
|
||||||
|
adblock_deactivate_cb (MidoriExtension* extension,
|
||||||
|
GtkWidget* menuitem)
|
||||||
|
{
|
||||||
|
MidoriApp* app = midori_extension_get_app (extension);
|
||||||
|
|
||||||
|
gtk_widget_destroy (menuitem);
|
||||||
|
g_signal_handlers_disconnect_by_func (
|
||||||
|
extension, adblock_deactivate_cb, menuitem);
|
||||||
|
g_signal_handlers_disconnect_by_func (
|
||||||
|
app, adblock_app_add_browser_cb, extension);
|
||||||
|
/* FIXME: Disconnect session callbacks */
|
||||||
|
}
|
||||||
|
|
||||||
|
static void
|
||||||
|
adblock_preferences_render_text (GtkTreeViewColumn* column,
|
||||||
|
GtkCellRenderer* renderer,
|
||||||
|
GtkTreeModel* model,
|
||||||
|
GtkTreeIter* iter,
|
||||||
|
MidoriExtension* extension)
|
||||||
|
{
|
||||||
|
gchar* uri;
|
||||||
|
|
||||||
|
gtk_tree_model_get (model, iter, 0, &uri, -1);
|
||||||
|
g_object_set (renderer, "text", uri, NULL);
|
||||||
|
g_free (uri);
|
||||||
|
}
|
||||||
|
|
||||||
|
static GtkWidget*
|
||||||
|
adblock_get_preferences_dialog (MidoriExtension* extension)
|
||||||
|
{
|
||||||
|
MidoriApp* app;
|
||||||
|
GtkWidget* browser;
|
||||||
|
const gchar* dialog_title;
|
||||||
|
GtkWidget* dialog;
|
||||||
|
gint width, height;
|
||||||
|
GtkWidget* xfce_heading;
|
||||||
|
GtkWidget* hbox;
|
||||||
|
GtkListStore* liststore;
|
||||||
|
GtkWidget* treeview;
|
||||||
|
GtkTreeViewColumn* column;
|
||||||
|
GtkCellRenderer* renderer_text;
|
||||||
|
GtkCellRenderer* renderer_pixbuf;
|
||||||
|
GtkWidget* scrolled;
|
||||||
|
gchar** filters;
|
||||||
|
GtkWidget* vbox;
|
||||||
|
GtkWidget* button;
|
||||||
|
#if HAVE_OSX
|
||||||
|
GtkWidget* icon;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
app = midori_extension_get_app (extension);
|
||||||
|
browser = katze_object_get_object (app, "browser");
|
||||||
|
|
||||||
|
dialog_title = _("Configure Advertisement filters");
|
||||||
|
dialog = gtk_dialog_new_with_buttons (dialog_title, GTK_WINDOW (browser),
|
||||||
|
GTK_DIALOG_DESTROY_WITH_PARENT | GTK_DIALOG_NO_SEPARATOR,
|
||||||
|
#if !HAVE_OSX
|
||||||
|
GTK_STOCK_HELP, GTK_RESPONSE_HELP,
|
||||||
|
GTK_STOCK_CLOSE, GTK_RESPONSE_CLOSE,
|
||||||
|
#endif
|
||||||
|
NULL);
|
||||||
|
g_signal_connect (dialog, "destroy",
|
||||||
|
G_CALLBACK (gtk_widget_destroyed), &dialog);
|
||||||
|
gtk_window_set_icon_name (GTK_WINDOW (dialog), GTK_STOCK_PROPERTIES);
|
||||||
|
/* TODO: Implement some kind of help function */
|
||||||
|
gtk_dialog_set_response_sensitive (GTK_DIALOG (dialog),
|
||||||
|
GTK_RESPONSE_HELP, FALSE);
|
||||||
|
sokoke_widget_get_text_size (dialog, "M", &width, &height);
|
||||||
|
gtk_window_set_default_size (GTK_WINDOW (dialog), width * 52, -1);
|
||||||
|
g_signal_connect (dialog, "response",
|
||||||
|
G_CALLBACK (gtk_widget_destroy), dialog);
|
||||||
|
/* TODO: We need mnemonics */
|
||||||
|
if ((xfce_heading = sokoke_xfce_header_new (
|
||||||
|
gtk_window_get_icon_name (GTK_WINDOW (dialog)), dialog_title)))
|
||||||
|
gtk_box_pack_start (GTK_BOX (GTK_DIALOG (dialog)->vbox),
|
||||||
|
xfce_heading, FALSE, FALSE, 0);
|
||||||
|
hbox = gtk_hbox_new (FALSE, 0);
|
||||||
|
gtk_box_pack_start (GTK_BOX (GTK_DIALOG (dialog)->vbox), hbox,
|
||||||
|
TRUE, TRUE, 12);
|
||||||
|
liststore = gtk_list_store_new (1, G_TYPE_STRING);
|
||||||
|
treeview = gtk_tree_view_new_with_model (GTK_TREE_MODEL (liststore));
|
||||||
|
gtk_tree_view_set_headers_visible (GTK_TREE_VIEW (treeview), FALSE);
|
||||||
|
column = gtk_tree_view_column_new ();
|
||||||
|
renderer_pixbuf = gtk_cell_renderer_pixbuf_new ();
|
||||||
|
gtk_tree_view_column_pack_start (column, renderer_pixbuf, FALSE);
|
||||||
|
/* gtk_tree_view_column_set_cell_data_func (column, renderer_pixbuf,
|
||||||
|
(GtkTreeCellDataFunc)adblock_preferences_render_icon_cb,
|
||||||
|
treeview, NULL); */
|
||||||
|
renderer_text = gtk_cell_renderer_text_new ();
|
||||||
|
gtk_tree_view_column_pack_start (column, renderer_text, TRUE);
|
||||||
|
gtk_tree_view_column_set_cell_data_func (column, renderer_text,
|
||||||
|
(GtkTreeCellDataFunc)adblock_preferences_render_text,
|
||||||
|
extension, NULL);
|
||||||
|
gtk_tree_view_append_column (GTK_TREE_VIEW (treeview), column);
|
||||||
|
scrolled = gtk_scrolled_window_new (NULL, NULL);
|
||||||
|
gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (scrolled),
|
||||||
|
GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
|
||||||
|
gtk_container_add (GTK_CONTAINER (scrolled), treeview);
|
||||||
|
gtk_scrolled_window_set_shadow_type (GTK_SCROLLED_WINDOW (scrolled),
|
||||||
|
GTK_SHADOW_IN);
|
||||||
|
gtk_box_pack_start (GTK_BOX (hbox), scrolled, TRUE, TRUE, 5);
|
||||||
|
|
||||||
|
filters = midori_extension_get_string_list (extension, "filters", NULL);
|
||||||
|
if (filters != NULL)
|
||||||
|
{
|
||||||
|
gsize i = 0;
|
||||||
|
while (filters[i++] != NULL)
|
||||||
|
gtk_list_store_insert_with_values (GTK_LIST_STORE (liststore),
|
||||||
|
NULL, i - 1, 0, filters[i -1], -1);
|
||||||
|
}
|
||||||
|
g_strfreev (filters);
|
||||||
|
|
||||||
|
g_object_unref (liststore);
|
||||||
|
vbox = gtk_vbox_new (FALSE, 4);
|
||||||
|
gtk_box_pack_start (GTK_BOX (hbox), vbox, FALSE, FALSE, 4);
|
||||||
|
button = gtk_button_new_from_stock (GTK_STOCK_ADD);
|
||||||
|
/* g_signal_connect (button, "clicked",
|
||||||
|
G_CALLBACK (adblock_preferences_add_cb), extension); */
|
||||||
|
gtk_box_pack_start (GTK_BOX (vbox), button, FALSE, FALSE, 0);
|
||||||
|
gtk_widget_set_sensitive (button, FALSE);
|
||||||
|
button = gtk_button_new_from_stock (GTK_STOCK_EDIT);
|
||||||
|
gtk_box_pack_start (GTK_BOX (vbox), button, FALSE, FALSE, 0);
|
||||||
|
gtk_widget_set_sensitive (button, FALSE);
|
||||||
|
button = gtk_button_new_from_stock (GTK_STOCK_REMOVE);
|
||||||
|
/* g_signal_connect (button, "clicked",
|
||||||
|
G_CALLBACK (adblock_preferences_remove_cb), extension); */
|
||||||
|
gtk_box_pack_start (GTK_BOX (vbox), button, FALSE, FALSE, 0);
|
||||||
|
gtk_widget_set_sensitive (button, FALSE);
|
||||||
|
button = gtk_label_new (""); /* This is an invisible separator */
|
||||||
|
gtk_box_pack_start (GTK_BOX (vbox), button, TRUE, TRUE, 8);
|
||||||
|
gtk_widget_set_sensitive (button, FALSE);
|
||||||
|
button = gtk_label_new (""); /* This is an invisible separator */
|
||||||
|
gtk_box_pack_start (GTK_BOX (vbox), button, TRUE, TRUE, 12);
|
||||||
|
button = gtk_button_new_from_stock (GTK_STOCK_GO_DOWN);
|
||||||
|
gtk_widget_set_sensitive (button, FALSE);
|
||||||
|
gtk_box_pack_end (GTK_BOX (vbox), button, FALSE, FALSE, 0);
|
||||||
|
button = gtk_button_new_from_stock (GTK_STOCK_GO_UP);
|
||||||
|
gtk_widget_set_sensitive (button, FALSE);
|
||||||
|
gtk_box_pack_end (GTK_BOX (vbox), button, FALSE, FALSE, 0);
|
||||||
|
|
||||||
|
#if HAVE_OSX
|
||||||
|
hbox = gtk_hbox_new (FALSE, 0);
|
||||||
|
button = gtk_button_new ();
|
||||||
|
icon = gtk_image_new_from_stock (GTK_STOCK_HELP, GTK_ICON_SIZE_BUTTON);
|
||||||
|
gtk_button_set_image (GTK_BUTTON (button), icon);
|
||||||
|
/* TODO: Implement some kind of help function */
|
||||||
|
gtk_widget_set_sensitive (button, FALSE);
|
||||||
|
/* g_signal_connect (button, "clicked",
|
||||||
|
G_CALLBACK (adblock_preferences_help_clicked_cb), dialog); */
|
||||||
|
gtk_box_pack_end (GTK_BOX (hbox),
|
||||||
|
button, FALSE, FALSE, 4);
|
||||||
|
gtk_box_pack_end (GTK_BOX (GTK_DIALOG (dialog)->vbox),
|
||||||
|
hbox, FALSE, FALSE, 0);
|
||||||
|
#endif
|
||||||
|
gtk_widget_show_all (GTK_DIALOG (dialog)->vbox);
|
||||||
|
|
||||||
|
g_object_unref (browser);
|
||||||
|
|
||||||
|
return dialog;
|
||||||
|
}
|
||||||
|
|
||||||
|
static void
|
||||||
|
adblock_menu_configure_filters_activate_cb (GtkWidget* menuitem,
|
||||||
|
MidoriExtension* extension)
|
||||||
|
{
|
||||||
|
static GtkWidget* dialog = NULL;
|
||||||
|
|
||||||
|
if (!dialog)
|
||||||
|
{
|
||||||
|
dialog = adblock_get_preferences_dialog (extension);
|
||||||
|
g_signal_connect (dialog, "destroy",
|
||||||
|
G_CALLBACK (gtk_widget_destroyed), &dialog);
|
||||||
|
gtk_widget_show (dialog);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
gtk_window_present (GTK_WINDOW (dialog));
|
||||||
|
}
|
||||||
|
|
||||||
|
static void
|
||||||
|
adblock_app_add_browser_cb (MidoriApp* app,
|
||||||
|
MidoriBrowser* browser,
|
||||||
|
MidoriExtension* extension)
|
||||||
|
{
|
||||||
|
GtkWidget* panel;
|
||||||
|
GtkWidget* menu;
|
||||||
|
GtkWidget* menuitem;
|
||||||
|
|
||||||
|
panel = katze_object_get_object (browser, "panel");
|
||||||
|
menu = katze_object_get_object (panel, "menu");
|
||||||
|
menuitem = gtk_menu_item_new_with_mnemonic (_("Configure _Advertisement filters..."));
|
||||||
|
g_signal_connect (menuitem, "activate",
|
||||||
|
G_CALLBACK (adblock_menu_configure_filters_activate_cb), extension);
|
||||||
|
gtk_widget_show (menuitem);
|
||||||
|
gtk_menu_shell_insert (GTK_MENU_SHELL (menu), menuitem, 3);
|
||||||
|
g_object_unref (menu);
|
||||||
|
g_object_unref (panel);
|
||||||
|
|
||||||
|
g_signal_connect (extension, "deactivate",
|
||||||
|
G_CALLBACK (adblock_deactivate_cb), menuitem);
|
||||||
|
}
|
||||||
|
|
||||||
|
static void
|
||||||
|
adblock_session_request_queued_cb (SoupSession* session,
|
||||||
|
SoupMessage* msg,
|
||||||
|
GRegex* regex)
|
||||||
|
{
|
||||||
|
SoupURI* soup_uri = soup_message_get_uri (msg);
|
||||||
|
gchar* uri = soup_uri ? soup_uri_to_string (soup_uri, FALSE) : g_strdup ("");
|
||||||
|
if (g_regex_match_full (regex, uri, -1, 0, 0, NULL, NULL))
|
||||||
|
{
|
||||||
|
/* g_debug ("match! '%s'", uri); */
|
||||||
|
/* FIXME: This leads to funny error pages if frames are blocked */
|
||||||
|
soup_message_set_response (msg, "text/plain", SOUP_MEMORY_STATIC, "adblock", 7);
|
||||||
|
}
|
||||||
|
g_free (uri);
|
||||||
|
}
|
||||||
|
|
||||||
|
static void
|
||||||
|
adblock_session_add_filter (SoupSession* session,
|
||||||
|
gchar* path)
|
||||||
|
{
|
||||||
|
FILE* file;
|
||||||
|
|
||||||
|
if ((file = g_fopen (path, "r")))
|
||||||
|
{
|
||||||
|
/* We assume filter lists found on the web are commonly very long */
|
||||||
|
GString* pattern = g_string_sized_new (1000 * 200);
|
||||||
|
gchar line[255];
|
||||||
|
GRegex* regex;
|
||||||
|
GError* error;
|
||||||
|
|
||||||
|
while (fgets (line, 255, file))
|
||||||
|
{
|
||||||
|
/* Ignore comments and new lines */
|
||||||
|
if (line[0] == '!')
|
||||||
|
continue;
|
||||||
|
/* FIXME: No support for whitelisting */
|
||||||
|
if (line[0] == '@' && line[1] == '@')
|
||||||
|
continue;
|
||||||
|
/* FIXME: Differentiate # comments from element hiding */
|
||||||
|
/* FIXME: No support for element hiding */
|
||||||
|
if (line[0] == '#' && line[1] == '#')
|
||||||
|
continue;
|
||||||
|
/* FIXME: No support for [include] and [exclude] tags */
|
||||||
|
if (line[0] == '[')
|
||||||
|
continue;
|
||||||
|
g_strchomp (line);
|
||||||
|
g_string_append (pattern, line);
|
||||||
|
g_string_append_c (pattern, '|');
|
||||||
|
}
|
||||||
|
|
||||||
|
error = NULL;
|
||||||
|
if (pattern->len > 2 &&
|
||||||
|
(regex = g_regex_new (pattern->str, G_REGEX_OPTIMIZE,
|
||||||
|
G_REGEX_MATCH_NOTEMPTY, &error)))
|
||||||
|
{
|
||||||
|
/* g_debug ("%s: '%s'", G_STRFUNC, pattern->str); */
|
||||||
|
g_signal_connect_data (session, "request-queued",
|
||||||
|
G_CALLBACK (adblock_session_request_queued_cb),
|
||||||
|
regex, (GClosureNotify)g_regex_unref, 0);
|
||||||
|
}
|
||||||
|
else if (error)
|
||||||
|
{
|
||||||
|
/* g_warning ("%s: %s", G_STRFUNC, error->message); */
|
||||||
|
g_error_free (error);
|
||||||
|
}
|
||||||
|
g_string_free (pattern, TRUE);
|
||||||
|
fclose (file);
|
||||||
|
}
|
||||||
|
/* FIXME: This should presumably be freed, but there's a possible crash
|
||||||
|
g_free (path); */
|
||||||
|
}
|
||||||
|
|
||||||
|
#if WEBKIT_CHECK_VERSION (1, 1, 3)
|
||||||
|
static void
|
||||||
|
adblock_download_notify_status_cb (WebKitDownload* download,
|
||||||
|
GParamSpec* pspec,
|
||||||
|
gchar* path)
|
||||||
|
{
|
||||||
|
SoupSession* session = webkit_get_default_session ();
|
||||||
|
adblock_session_add_filter (session, path);
|
||||||
|
/* g_object_unref (download); */
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
static void
|
||||||
|
adblock_activate_cb (MidoriExtension* extension,
|
||||||
|
MidoriApp* app)
|
||||||
|
{
|
||||||
|
KatzeArray* browsers;
|
||||||
|
MidoriBrowser* browser;
|
||||||
|
guint i;
|
||||||
|
gchar* folder;
|
||||||
|
gchar** filters;
|
||||||
|
SoupSession* session;
|
||||||
|
|
||||||
|
browsers = katze_object_get_object (app, "browsers");
|
||||||
|
i = 0;
|
||||||
|
while ((browser = katze_array_get_nth_item (browsers, i++)))
|
||||||
|
adblock_app_add_browser_cb (app, browser, extension);
|
||||||
|
g_signal_connect (app, "add-browser",
|
||||||
|
G_CALLBACK (adblock_app_add_browser_cb), extension);
|
||||||
|
g_object_unref (browsers);
|
||||||
|
|
||||||
|
session = webkit_get_default_session ();
|
||||||
|
folder = g_build_filename (g_get_user_cache_dir (), PACKAGE_NAME,
|
||||||
|
"adblock", NULL);
|
||||||
|
g_mkdir_with_parents (folder, 0700);
|
||||||
|
filters = midori_extension_get_string_list (extension, "filters", NULL);
|
||||||
|
if (filters != NULL)
|
||||||
|
{
|
||||||
|
i = 0;
|
||||||
|
while (filters[i++] != NULL)
|
||||||
|
{
|
||||||
|
gchar* filename = g_compute_checksum_for_string (G_CHECKSUM_MD5,
|
||||||
|
filters[i - 1], -1);
|
||||||
|
gchar* path = g_build_filename (folder, filename, NULL);
|
||||||
|
if (!g_file_test (path, G_FILE_TEST_EXISTS))
|
||||||
|
{
|
||||||
|
#if WEBKIT_CHECK_VERSION (1, 1, 3)
|
||||||
|
WebKitNetworkRequest* request;
|
||||||
|
WebKitDownload* download;
|
||||||
|
gchar* destination = g_filename_to_uri (path, NULL, NULL);
|
||||||
|
|
||||||
|
request = webkit_network_request_new (filters[i -1]);
|
||||||
|
download = webkit_download_new (request);
|
||||||
|
g_object_unref (request);
|
||||||
|
webkit_download_set_destination_uri (download, destination);
|
||||||
|
g_free (destination);
|
||||||
|
g_signal_connect (download, "notify::status",
|
||||||
|
G_CALLBACK (adblock_download_notify_status_cb), path);
|
||||||
|
webkit_download_start (download);
|
||||||
|
#else
|
||||||
|
/* FIXME: Is it worth to rewrite this without WebKitDownload? */
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
else
|
||||||
|
adblock_session_add_filter (session, path);
|
||||||
|
g_free (filename);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
g_strfreev (filters);
|
||||||
|
g_free (folder);
|
||||||
|
}
|
||||||
|
|
||||||
|
MidoriExtension*
|
||||||
|
extension_init (void)
|
||||||
|
{
|
||||||
|
MidoriExtension* extension = g_object_new (MIDORI_TYPE_EXTENSION,
|
||||||
|
"name", _("Advertisement blocker"),
|
||||||
|
"description", _("Block advertisements according to a filter list"),
|
||||||
|
"version", "0.1",
|
||||||
|
"authors", "Christian Dywan <christian@twotoasts.de>",
|
||||||
|
NULL);
|
||||||
|
midori_extension_install_string_list (extension, "filters", NULL, G_MAXSIZE);
|
||||||
|
|
||||||
|
g_signal_connect (extension, "activate",
|
||||||
|
G_CALLBACK (adblock_activate_cb), NULL);
|
||||||
|
|
||||||
|
return extension;
|
||||||
|
}
|
||||||
Loading…
Reference in a new issue