[epiphany] ephy-web-view: move the file monitoring code to its own class, EphyFileMonitor.
- From: Xan Lopez <xan src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [epiphany] ephy-web-view: move the file monitoring code to its own class, EphyFileMonitor.
- Date: Wed, 27 Jun 2012 10:48:49 +0000 (UTC)
commit 8118e5fb00fc3514940ce629ca6e1a7aeb5a3b1d
Author: Xan Lopez <xan igalia com>
Date: Wed Jun 27 12:47:18 2012 +0200
ephy-web-view: move the file monitoring code to its own class, EphyFileMonitor.
Since the vast majority of the code was really independent from
EphyWebView.
embed/Makefile.am | 2 +
embed/ephy-file-monitor.c | 301 +++++++++++++++++++++++++++++++++++++++++++++
embed/ephy-file-monitor.h | 64 ++++++++++
embed/ephy-web-view.c | 192 ++---------------------------
4 files changed, 376 insertions(+), 183 deletions(-)
---
diff --git a/embed/Makefile.am b/embed/Makefile.am
index db2123e..63e15fd 100644
--- a/embed/Makefile.am
+++ b/embed/Makefile.am
@@ -12,6 +12,7 @@ NOINST_H_FILES = \
ephy-embed-dialog.h \
ephy-embed-private.h \
ephy-encodings.h \
+ ephy-file-monitor.h \
ephy-request-about.h
INST_H_FILES = \
@@ -46,6 +47,7 @@ libephyembed_la_SOURCES = \
ephy-embed-shell.c \
ephy-embed-utils.c \
ephy-encodings.c \
+ ephy-file-monitor.c \
ephy-permission-manager.c \
ephy-request-about.c \
ephy-embed-prefs.c \
diff --git a/embed/ephy-file-monitor.c b/embed/ephy-file-monitor.c
new file mode 100644
index 0000000..3580e3d
--- /dev/null
+++ b/embed/ephy-file-monitor.c
@@ -0,0 +1,301 @@
+/* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set sw=2 ts=2 sts=2 et: */
+/*
+ * Copyright  2012 Igalia S.L.
+ *
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ */
+
+#include "config.h"
+#include "ephy-file-monitor.h"
+
+#include "ephy-debug.h"
+
+#include <string.h>
+
+#define RELOAD_DELAY 250 /* ms */
+#define RELOAD_DELAY_MAX_TICKS 40 /* RELOAD_DELAY * RELOAD_DELAY_MAX_TICKS = 10 s */
+
+struct _EphyFileMonitorPrivate {
+ GFileMonitor *monitor;
+ gboolean monitor_directory;
+ guint reload_scheduled_id;
+ guint reload_delay_ticks;
+
+ EphyWebView *view;
+};
+
+enum {
+ PROP_0,
+
+ PROP_VIEW
+};
+
+#define EPHY_FILE_MONITOR_GET_PRIVATE(object) (G_TYPE_INSTANCE_GET_PRIVATE ((object), EPHY_TYPE_FILE_MONITOR, EphyFileMonitorPrivate))
+
+G_DEFINE_TYPE (EphyFileMonitor, ephy_file_monitor, G_TYPE_OBJECT)
+
+static void
+ephy_file_monitor_cancel (EphyFileMonitor *monitor)
+{
+ EphyFileMonitorPrivate *priv;
+
+ g_return_if_fail (EPHY_IS_FILE_MONITOR (monitor));
+
+ priv = monitor->priv;
+
+ if (priv->monitor != NULL) {
+ LOG ("Cancelling file monitor");
+
+ g_file_monitor_cancel (G_FILE_MONITOR (priv->monitor));
+ g_object_unref (priv->monitor);
+ priv->monitor = NULL;
+ }
+
+ if (priv->reload_scheduled_id != 0) {
+ LOG ("Cancelling scheduled reload");
+
+ g_source_remove (priv->reload_scheduled_id);
+ priv->reload_scheduled_id = 0;
+ }
+
+ priv->reload_delay_ticks = 0;
+}
+
+static gboolean
+ephy_file_monitor_reload_cb (EphyFileMonitor *monitor)
+{
+ EphyFileMonitorPrivate *priv = monitor->priv;
+
+ if (priv->reload_delay_ticks > 0) {
+ priv->reload_delay_ticks--;
+
+ /* Run again. */
+ return TRUE;
+ }
+
+ if (ephy_web_view_is_loading (priv->view)) {
+ /* Wait a bit to reload if we're still loading! */
+ priv->reload_delay_ticks = RELOAD_DELAY_MAX_TICKS / 2;
+
+ /* Run again. */
+ return TRUE;
+ }
+
+ priv->reload_scheduled_id = 0;
+
+ LOG ("Reloading file '%s'", ephy_web_view_get_address (priv->view));
+ webkit_web_view_reload (WEBKIT_WEB_VIEW (priv->view));
+
+ /* Don't run again. */
+ return FALSE;
+}
+
+static void
+ephy_file_monitor_changed_cb (GFileMonitor *monitor,
+ GFile *file,
+ GFile *other_file,
+ GFileMonitorEvent event_type,
+ EphyFileMonitor *file_monitor)
+{
+ gboolean should_reload;
+ EphyFileMonitorPrivate *priv = file_monitor->priv;
+
+ switch (event_type) {
+ /* These events will always trigger a reload: */
+ case G_FILE_MONITOR_EVENT_CHANGED:
+ case G_FILE_MONITOR_EVENT_CREATED:
+ should_reload = TRUE;
+ break;
+
+ /* These events will only trigger a reload for directories: */
+ case G_FILE_MONITOR_EVENT_DELETED:
+ case G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED:
+ should_reload = priv->monitor_directory;
+ break;
+
+ /* These events don't trigger a reload: */
+ case G_FILE_MONITOR_EVENT_PRE_UNMOUNT:
+ case G_FILE_MONITOR_EVENT_UNMOUNTED:
+ case G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT:
+ default:
+ should_reload = FALSE;
+ break;
+ }
+
+ if (should_reload) {
+ /* We make a lot of assumptions here, but basically we know
+ * that we just have to reload, by construction.
+ * Delay the reload a little bit so we don't endlessly
+ * reload while a file is written.
+ */
+ if (priv->reload_delay_ticks == 0)
+ priv->reload_delay_ticks = 1;
+ else {
+ /* Exponential backoff. */
+ priv->reload_delay_ticks = MIN (priv->reload_delay_ticks * 2,
+ RELOAD_DELAY_MAX_TICKS);
+ }
+
+ if (priv->reload_scheduled_id == 0) {
+ priv->reload_scheduled_id =
+ g_timeout_add (RELOAD_DELAY,
+ (GSourceFunc)ephy_file_monitor_reload_cb, file_monitor);
+ }
+ }
+}
+
+void
+ephy_file_monitor_update_location (EphyFileMonitor *file_monitor,
+ const char *address)
+{
+ EphyFileMonitorPrivate *priv;
+ gboolean local;
+ char *anchor;
+ char *url;
+ GFile *file;
+ GFileType file_type;
+ GFileInfo *file_info;
+
+ g_return_if_fail (EPHY_IS_FILE_MONITOR (file_monitor));
+ g_return_if_fail (address != NULL);
+
+ priv = file_monitor->priv;
+
+ ephy_file_monitor_cancel (file_monitor);
+
+ local = g_str_has_prefix (address, "file://");
+ if (local == FALSE)
+ return;
+
+ /* strip off anchors */
+ anchor = strchr (address, '#');
+ if (anchor != NULL)
+ url = g_strndup (address, anchor - address);
+ else
+ url = g_strdup (address);
+
+ file = g_file_new_for_uri (url);
+ file_info = g_file_query_info (file,
+ G_FILE_ATTRIBUTE_STANDARD_TYPE,
+ 0, NULL, NULL);
+ if (file_info == NULL) {
+ g_object_unref (file);
+ g_free (url);
+ return;
+ }
+
+ file_type = g_file_info_get_file_type (file_info);
+ g_object_unref (file_info);
+
+ if (file_type == G_FILE_TYPE_DIRECTORY) {
+ priv->monitor = g_file_monitor_directory (file, 0, NULL, NULL);
+ g_signal_connect (priv->monitor, "changed",
+ G_CALLBACK (ephy_file_monitor_changed_cb),
+ file_monitor);
+ priv->monitor_directory = TRUE;
+ LOG ("Installed monitor for directory '%s'", url);
+ }
+ else if (file_type == G_FILE_TYPE_REGULAR) {
+ priv->monitor = g_file_monitor_file (file, 0, NULL, NULL);
+ g_signal_connect (priv->monitor, "changed",
+ G_CALLBACK (ephy_file_monitor_changed_cb),
+ file_monitor);
+ priv->monitor_directory = FALSE;
+ LOG ("Installed monitor for file '%s'", url);
+ }
+
+ g_object_unref (file);
+ g_free (url);
+}
+
+static void
+ephy_file_monitor_dispose (GObject *object)
+{
+ ephy_file_monitor_cancel (EPHY_FILE_MONITOR (object));
+
+ G_OBJECT_CLASS (ephy_file_monitor_parent_class)->dispose (object);
+}
+
+static void
+ephy_file_monitor_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec)
+{
+ EphyFileMonitorPrivate *priv = EPHY_FILE_MONITOR (object)->priv;
+
+ switch (prop_id) {
+ case PROP_VIEW:
+ g_value_set_object (value, priv->view);
+ break;
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
+ }
+}
+
+static void
+ephy_file_monitor_set_property (GObject *object,
+ guint prop_id,
+ const GValue *value,
+ GParamSpec *pspec)
+{
+ EphyFileMonitorPrivate *priv = EPHY_FILE_MONITOR (object)->priv;
+
+ switch (prop_id) {
+ case PROP_VIEW:
+ priv->view = g_value_get_object (value);
+ break;
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
+ }
+}
+
+static void
+ephy_file_monitor_class_init (EphyFileMonitorClass *klass)
+{
+ GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
+
+ gobject_class->dispose = ephy_file_monitor_dispose;
+ gobject_class->get_property = ephy_file_monitor_get_property;
+ gobject_class->set_property = ephy_file_monitor_set_property;
+
+ g_object_class_install_property (gobject_class,
+ PROP_VIEW,
+ g_param_spec_object ("view",
+ "View",
+ "The file monitor's associated view",
+ EPHY_TYPE_WEB_VIEW,
+ G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB | G_PARAM_CONSTRUCT_ONLY));
+
+ g_type_class_add_private (gobject_class, sizeof (EphyFileMonitorPrivate));
+}
+
+static void
+ephy_file_monitor_init (EphyFileMonitor *monitor)
+{
+ monitor->priv = EPHY_FILE_MONITOR_GET_PRIVATE (monitor);
+}
+
+EphyFileMonitor *
+ephy_file_monitor_new (EphyWebView *view)
+{
+ return g_object_new (EPHY_TYPE_FILE_MONITOR,
+ "view", view,
+ NULL);
+}
diff --git a/embed/ephy-file-monitor.h b/embed/ephy-file-monitor.h
new file mode 100644
index 0000000..1187649
--- /dev/null
+++ b/embed/ephy-file-monitor.h
@@ -0,0 +1,64 @@
+/* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set sw=2 ts=2 sts=2 et: */
+/*
+ * Copyright  2012 Igalia S.L.
+ *
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ */
+
+#if !defined (__EPHY_EPIPHANY_H_INSIDE__) && !defined (EPIPHANY_COMPILATION)
+#error "Only <epiphany/epiphany.h> can be included directly."
+#endif
+
+#ifndef EPHY_FILE_MONITOR_H
+#define EPHY_FILE_MONITOR_H
+
+#include "ephy-web-view.h"
+
+G_BEGIN_DECLS
+
+#define EPHY_TYPE_FILE_MONITOR (ephy_file_monitor_get_type ())
+#define EPHY_FILE_MONITOR(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), EPHY_TYPE_FILE_MONITOR, EphyFileMonitor))
+#define EPHY_FILE_MONITOR_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), EPHY_TYPE_FILE_MONITOR, EphyFileMonitorClass))
+#define EPHY_IS_FILE_MONITOR(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), EPHY_TYPE_FILE_MONITOR))
+#define EPHY_IS_FILE_MONITOR_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), EPHY_TYPE_FILE_MONITOR))
+#define EPHY_FILE_MONITOR_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), EPHY_TYPE_FILE_MONITOR, EphyFileMonitorClass))
+
+typedef struct _EphyFileMonitorClass EphyFileMonitorClass;
+typedef struct _EphyFileMonitor EphyFileMonitor;
+typedef struct _EphyFileMonitorPrivate EphyFileMonitorPrivate;
+
+struct _EphyFileMonitor
+{
+ GObject parent;
+
+ /*< private >*/
+ EphyFileMonitorPrivate *priv;
+};
+
+struct _EphyFileMonitorClass
+{
+ GObjectClass parent_class;
+};
+
+GType ephy_file_monitor_get_type (void);
+EphyFileMonitor * ephy_file_monitor_new (EphyWebView *view);
+void ephy_file_monitor_update_location (EphyFileMonitor *monitor,
+ const char *address);
+
+G_END_DECLS
+
+#endif
diff --git a/embed/ephy-web-view.c b/embed/ephy-web-view.c
index a1e7b73..ffd3f68 100644
--- a/embed/ephy-web-view.c
+++ b/embed/ephy-web-view.c
@@ -33,6 +33,7 @@
#include "ephy-embed-utils.h"
#include "ephy-embed.h"
#include "ephy-file-helpers.h"
+#include "ephy-file-monitor.h"
#include "ephy-history-service.h"
#include "ephy-permission-manager.h"
#include "ephy-prefs.h"
@@ -64,8 +65,6 @@ static void ephy_web_view_init (EphyWebView *gs);
#define MAX_HIDDEN_POPUPS 5
#define MAX_TITLE_LENGTH 512 /* characters */
-#define RELOAD_DELAY 250 /* ms */
-#define RELOAD_DELAY_MAX_TICKS 40 /* RELOAD_DELAY * RELOAD_DELAY_MAX_TICKS = 10 s */
#define EMPTY_PAGE _("Blank page") /* Title for the empty page */
struct _EphyWebViewPrivate {
@@ -95,11 +94,8 @@ struct _EphyWebViewPrivate {
GdkPixbuf *icon;
gboolean expire_address_now;
- /* File watch */
- GFileMonitor *monitor;
- gboolean monitor_directory;
- guint reload_scheduled_id;
- guint reload_delay_ticks;
+ /* Local file watch. */
+ EphyFileMonitor *file_monitor;
/* Regex to figure out if we're dealing with a wanna-be URI */
GRegex *non_search_regex;
@@ -499,28 +495,6 @@ ephy_web_view_set_property (GObject *object,
}
}
-static void
-ephy_web_view_file_monitor_cancel (EphyWebView *view)
-{
- EphyWebViewPrivate *priv = view->priv;
-
- if (priv->monitor != NULL) {
- LOG ("Cancelling file monitor");
-
- g_file_monitor_cancel (G_FILE_MONITOR (priv->monitor));
- priv->monitor = NULL;
- }
-
- if (priv->reload_scheduled_id != 0) {
- LOG ("Cancelling scheduled reload");
-
- g_source_remove (priv->reload_scheduled_id);
- priv->reload_scheduled_id = 0;
- }
-
- priv->reload_delay_ticks = 0;
-}
-
static gboolean
ephy_web_view_key_press_event (GtkWidget *widget, GdkEventKey *event)
{
@@ -556,7 +530,7 @@ ephy_web_view_dispose (GObject *object)
{
EphyWebViewPrivate *priv = EPHY_WEB_VIEW (object)->priv;
- ephy_web_view_file_monitor_cancel (EPHY_WEB_VIEW (object));
+ g_clear_object (&priv->file_monitor);
if (priv->history_service_cancellable) {
g_cancellable_cancel (priv->history_service_cancellable);
@@ -2674,7 +2648,8 @@ ephy_web_view_init (EphyWebView *web_view)
priv->title = g_strdup (EMPTY_PAGE);
priv->document_type = EPHY_WEB_VIEW_DOCUMENT_HTML;
priv->security_level = EPHY_WEB_VIEW_STATE_IS_UNKNOWN;
- priv->monitor_directory = FALSE;
+
+ priv->file_monitor = ephy_file_monitor_new (web_view);
priv->non_search_regex = g_regex_new (EPHY_WEB_VIEW_NON_SEARCH_REGEX,
G_REGEX_OPTIMIZE, G_REGEX_MATCH_NOTEMPTY, NULL);
@@ -3213,156 +3188,6 @@ ephy_web_view_set_loading_title (EphyWebView *view,
g_free (freeme);
}
-static gboolean
-ephy_web_view_file_monitor_reload_cb (EphyWebView *view)
-{
- EphyWebViewPrivate *priv = view->priv;
-
- if (priv->reload_delay_ticks > 0) {
- priv->reload_delay_ticks--;
-
- /* Run again */
- return TRUE;
- }
-
- if (ephy_web_view_is_loading (view)) {
- /* Wait a bit to reload if we're still loading! */
- priv->reload_delay_ticks = RELOAD_DELAY_MAX_TICKS / 2;
-
- /* Run again */
- return TRUE;
- }
-
- priv->reload_scheduled_id = 0;
-
- LOG ("Reloading file '%s'", ephy_web_view_get_address (view));
- webkit_web_view_reload (WEBKIT_WEB_VIEW (view));
-
- /* don't run again */
- return FALSE;
-}
-
-static void
-ephy_web_view_file_monitor_cb (GFileMonitor *monitor,
- GFile *file,
- GFile *other_file,
- GFileMonitorEvent event_type,
- EphyWebView *view)
-{
- gboolean should_reload;
- EphyWebViewPrivate *priv = view->priv;
-
- switch (event_type) {
- /* These events will always trigger a reload: */
- case G_FILE_MONITOR_EVENT_CHANGED:
- case G_FILE_MONITOR_EVENT_CREATED:
- should_reload = TRUE;
- break;
-
- /* These events will only trigger a reload for directories: */
- case G_FILE_MONITOR_EVENT_DELETED:
- case G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED:
- should_reload = priv->monitor_directory;
- break;
-
- /* These events don't trigger a reload: */
- case G_FILE_MONITOR_EVENT_PRE_UNMOUNT:
- case G_FILE_MONITOR_EVENT_UNMOUNTED:
- case G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT:
- default:
- should_reload = FALSE;
- break;
- }
-
- if (should_reload) {
- /* We make a lot of assumptions here, but basically we know
- * that we just have to reload, by construction.
- * Delay the reload a little bit so we don't endlessly
- * reload while a file is written.
- */
- if (priv->reload_delay_ticks == 0) {
- priv->reload_delay_ticks = 1;
- } else {
- /* Exponential backoff */
- priv->reload_delay_ticks = MIN (priv->reload_delay_ticks * 2,
- RELOAD_DELAY_MAX_TICKS);
- }
-
- if (priv->reload_scheduled_id == 0) {
- priv->reload_scheduled_id =
- g_timeout_add (RELOAD_DELAY,
- (GSourceFunc)ephy_web_view_file_monitor_reload_cb, view);
- }
- }
-}
-
-static void
-ephy_web_view_update_file_monitor (EphyWebView *view,
- const char *address)
-{
- EphyWebViewPrivate *priv = view->priv;
- gboolean local;
- char *anchor;
- char *url;
- GFile *file;
- GFileType file_type;
- GFileInfo *file_info;
- GFileMonitor *monitor = NULL;
-
- if (priv->monitor != NULL &&
- priv->address != NULL && address != NULL &&
- strcmp (priv->address, address) == 0) {
- /* same address, no change needed */
- return;
- }
-
- ephy_web_view_file_monitor_cancel (view);
-
- local = g_str_has_prefix (address, "file://");
- if (local == FALSE) return;
-
- /* strip off anchors */
- anchor = strchr (address, '#');
- if (anchor != NULL) {
- url = g_strndup (address, anchor - address);
- } else {
- url = g_strdup (address);
- }
-
- file = g_file_new_for_uri (url);
- file_info = g_file_query_info (file,
- G_FILE_ATTRIBUTE_STANDARD_TYPE,
- 0, NULL, NULL);
- if (file_info == NULL) {
- g_object_unref (file);
- g_free (url);
- return;
- }
-
- file_type = g_file_info_get_file_type (file_info);
- g_object_unref (file_info);
-
- if (file_type == G_FILE_TYPE_DIRECTORY) {
- monitor = g_file_monitor_directory (file, 0, NULL, NULL);
- g_signal_connect (monitor, "changed",
- G_CALLBACK (ephy_web_view_file_monitor_cb),
- view);
- priv->monitor_directory = TRUE;
- LOG ("Installed monitor for directory '%s'", url);
- }
- else if (file_type == G_FILE_TYPE_REGULAR) {
- monitor = g_file_monitor_file (file, 0, NULL, NULL);
- g_signal_connect (monitor, "changed",
- G_CALLBACK (ephy_web_view_file_monitor_cb),
- view);
- priv->monitor_directory = FALSE;
- LOG ("Installed monitor for file '%s'", url);
- }
- priv->monitor = monitor;
- g_object_unref (file);
- g_free (url);
-}
-
/**
* ephy_web_view_location_changed:
* @view: an #EphyWebView
@@ -3376,11 +3201,12 @@ ephy_web_view_location_changed (EphyWebView *view,
const char *location)
{
GObject *object = G_OBJECT (view);
+ EphyWebViewPrivate *priv = view->priv;
g_object_freeze_notify (object);
- /* do this up here so we still have the old address around */
- ephy_web_view_update_file_monitor (view, location);
+ /* Do this up here so we still have the old address around. */
+ ephy_file_monitor_update_location (priv->file_monitor, location);
/* Do not expose about:blank to the user, an empty address
bar will do better */
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
