Commit cb1220af authored by Matthew Barnes's avatar Matthew Barnes
Browse files

Add 'cal-config-local' module.

Registers the "On This Computer" backend in ECalSourceConfig widgets.

Replaces the 'calendar-file' plugin.
parent 8b03b8a2
......@@ -1298,7 +1298,7 @@ AC_ARG_ENABLE([plugins],
[enable_plugins="$enableval"],[enable_plugins=all])
dnl Add any new plugins here
plugins_base_always="calendar-file calendar-http itip-formatter default-source mark-all-read publish-calendar caldav imap-features google-account-setup"
plugins_base_always="calendar-http itip-formatter default-source mark-all-read publish-calendar caldav imap-features google-account-setup"
plugins_base="$plugins_base_always"
dist_plugins_base="$plugins_base_always calendar-weather"
......@@ -1637,6 +1637,7 @@ modules/book-config-google/Makefile
modules/book-config-ldap/Makefile
modules/book-config-local/Makefile
modules/book-config-webdav/Makefile
modules/cal-config-local/Makefile
modules/composer-autosave/Makefile
modules/mailto-handler/Makefile
modules/mdn/Makefile
......@@ -1654,7 +1655,6 @@ plugins/attachment-reminder/Makefile
plugins/audio-inline/Makefile
plugins/bbdb/Makefile
plugins/caldav/Makefile
plugins/calendar-file/Makefile
plugins/calendar-http/Makefile
plugins/calendar-weather/Makefile
plugins/dbx-import/Makefile
......
......@@ -24,6 +24,7 @@ SUBDIRS = \
$(CONFIG_LDAP_DIR) \
book-config-local \
book-config-webdav \
cal-config-local \
composer-autosave \
mailto-handler \
mdn \
......
module_LTLIBRARIES = module-cal-config-local.la
module_cal_config_local_la_CPPFLAGS = \
$(AM_CPPFLAGS) \
-I$(top_srcdir) \
-I$(top_srcdir)/widgets \
-DG_LOG_DOMAIN=\"evolution-cal-config-local\" \
$(EVOLUTION_DATA_SERVER_CFLAGS) \
$(GNOME_PLATFORM_CFLAGS)
module_cal_config_local_la_SOURCES = \
evolution-cal-config-local.c \
e-source-local.c \
e-source-local.h
module_cal_config_local_la_LIBADD = \
$(top_builddir)/e-util/libeutil.la \
$(top_builddir)/widgets/misc/libemiscwidgets.la \
$(top_builddir)/calendar/gui/libevolution-calendar.la \
$(EVOLUTION_DATA_SERVER_LIBS) \
$(GNOME_PLATFORM_LIBS)
module_cal_config_local_la_LDFLAGS = \
-module -avoid-version $(NO_UNDEFINED)
-include $(top_srcdir)/git.mk
/*
* e-source-local.c
*
* This program 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 of the License, or (at your option) version 3.
*
* 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with the program; if not, see <http://www.gnu.org/licenses/>
*
*/
#include "e-source-local.h"
#define E_SOURCE_LOCAL_GET_PRIVATE(obj) \
(G_TYPE_INSTANCE_GET_PRIVATE \
((obj), E_TYPE_SOURCE_LOCAL, ESourceLocalPrivate))
struct _ESourceLocalPrivate {
GMutex *property_lock;
GFile *custom_file;
};
enum {
PROP_0,
PROP_CUSTOM_FILE
};
G_DEFINE_DYNAMIC_TYPE (
ESourceLocal,
e_source_local,
E_TYPE_SOURCE_EXTENSION)
static void
source_local_set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec)
{
switch (property_id) {
case PROP_CUSTOM_FILE:
e_source_local_set_custom_file (
E_SOURCE_LOCAL (object),
g_value_get_object (value));
return;
}
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
}
static void
source_local_get_property (GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec)
{
switch (property_id) {
case PROP_CUSTOM_FILE:
g_value_take_object (
value,
e_source_local_dup_custom_file (
E_SOURCE_LOCAL (object)));
return;
}
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
}
static void
source_local_dispose (GObject *object)
{
ESourceLocalPrivate *priv;
priv = E_SOURCE_LOCAL_GET_PRIVATE (object);
if (priv->custom_file != NULL) {
g_object_unref (priv->custom_file);
priv->custom_file = NULL;
}
/* Chain up to parent's dispose() method. */
G_OBJECT_CLASS (e_source_local_parent_class)->dispose (object);
}
static void
source_local_finalize (GObject *object)
{
ESourceLocalPrivate *priv;
priv = E_SOURCE_LOCAL_GET_PRIVATE (object);
g_mutex_free (priv->property_lock);
/* Chain up to parent's finalize() method. */
G_OBJECT_CLASS (e_source_local_parent_class)->finalize (object);
}
static void
e_source_local_class_init (ESourceLocalClass *class)
{
GObjectClass *object_class;
ESourceExtensionClass *extension_class;
g_type_class_add_private (class, sizeof (ESourceLocalPrivate));
object_class = G_OBJECT_CLASS (class);
object_class->set_property = source_local_set_property;
object_class->get_property = source_local_get_property;
object_class->dispose = source_local_dispose;
object_class->finalize = source_local_finalize;
extension_class = E_SOURCE_EXTENSION_CLASS (class);
extension_class->name = E_SOURCE_EXTENSION_LOCAL_BACKEND;
g_object_class_install_property (
object_class,
PROP_CUSTOM_FILE,
g_param_spec_object (
"custom-file",
"Custom File",
"Custom iCalendar file",
G_TYPE_FILE,
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT |
E_SOURCE_PARAM_SETTING));
}
static void
e_source_local_class_finalize (ESourceLocalClass *class)
{
}
static void
e_source_local_init (ESourceLocal *extension)
{
extension->priv = E_SOURCE_LOCAL_GET_PRIVATE (extension);
extension->priv->property_lock = g_mutex_new ();
}
void
e_source_local_type_register (GTypeModule *type_module)
{
/* XXX G_DEFINE_DYNAMIC_TYPE declares a static type registration
* function, so we have to wrap it with a public function in
* order to register types from a separate compilation unit. */
e_source_local_register_type (type_module);
}
GFile *
e_source_local_get_custom_file (ESourceLocal *extension)
{
g_return_val_if_fail (E_IS_SOURCE_LOCAL (extension), NULL);
return extension->priv->custom_file;
}
GFile *
e_source_local_dup_custom_file (ESourceLocal *extension)
{
GFile *protected;
GFile *duplicate;
g_return_val_if_fail (E_IS_SOURCE_LOCAL (extension), NULL);
g_mutex_lock (extension->priv->property_lock);
protected = e_source_local_get_custom_file (extension);
duplicate = (protected != NULL) ? g_file_dup (protected) : NULL;
g_mutex_unlock (extension->priv->property_lock);
return duplicate;
}
void
e_source_local_set_custom_file (ESourceLocal *extension,
GFile *custom_file)
{
g_return_if_fail (E_IS_SOURCE_LOCAL (extension));
if (custom_file != NULL) {
g_return_if_fail (G_IS_FILE (custom_file));
g_object_ref (custom_file);
}
g_mutex_lock (extension->priv->property_lock);
if (extension->priv->custom_file != NULL)
g_object_unref (extension->priv->custom_file);
extension->priv->custom_file = custom_file;
g_mutex_unlock (extension->priv->property_lock);
g_object_notify (G_OBJECT (extension), "custom-file");
}
/*
* e-source-local.h
*
* This program 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 of the License, or (at your option) version 3.
*
* 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with the program; if not, see <http://www.gnu.org/licenses/>
*
*/
#ifndef E_SOURCE_LOCAL_H
#define E_SOURCE_LOCAL_H
#include <libedataserver/e-source-extension.h>
/* Standard GObject macros */
#define E_TYPE_SOURCE_LOCAL \
(e_source_local_get_type ())
#define E_SOURCE_LOCAL(obj) \
(G_TYPE_CHECK_INSTANCE_CAST \
((obj), E_TYPE_SOURCE_LOCAL, ESourceLocal))
#define E_SOURCE_LOCAL_CLASS(cls) \
(G_TYPE_CHECK_CLASS_CAST \
((cls), E_TYPE_SOURCE_LOCAL, ESourceLocalClass))
#define E_IS_SOURCE_LOCAL(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE \
((obj), E_TYPE_SOURCE_LOCAL))
#define E_IS_SOURCE_LOCAL_CLASS(cls) \
(G_TYPE_CHECK_CLASS_TYPE \
((cls), E_TYPE_SOURCE_LOCAL))
#define E_SOURCE_LOCAL_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS \
((obj), E_TYPE_SOURCE_LOCAL, ESourceLocalClass))
#define E_SOURCE_EXTENSION_LOCAL_BACKEND "Local Backend"
G_BEGIN_DECLS
typedef struct _ESourceLocal ESourceLocal;
typedef struct _ESourceLocalClass ESourceLocalClass;
typedef struct _ESourceLocalPrivate ESourceLocalPrivate;
struct _ESourceLocal {
ESourceExtension parent;
ESourceLocalPrivate *priv;
};
struct _ESourceLocalClass {
ESourceExtensionClass parent_class;
};
GType e_source_local_get_type (void);
void e_source_local_type_register (GTypeModule *type_module);
GFile * e_source_local_get_custom_file (ESourceLocal *extension);
GFile * e_source_local_dup_custom_file (ESourceLocal *extension);
void e_source_local_set_custom_file (ESourceLocal *extension,
GFile *custom_file);
G_END_DECLS
#endif /* E_SOURCE_LOCAL_H */
/*
* evolution-cal-config-local.c
*
* This program 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 of the License, or (at your option) version 3.
*
* 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with the program; if not, see <http://www.gnu.org/licenses/>
*
*/
#include <config.h>
#include <glib/gi18n-lib.h>
#include <libebackend/e-extension.h>
#include <misc/e-source-config-backend.h>
#include <calendar/gui/e-cal-source-config.h>
#include "e-source-local.h"
typedef ESourceConfigBackend ECalConfigLocal;
typedef ESourceConfigBackendClass ECalConfigLocalClass;
typedef struct _Context Context;
struct _Context {
GtkWidget *custom_file_checkbox;
GtkWidget *custom_file_chooser;
GtkWidget *writable_checkbox;
};
/* Module Entry Points */
void e_module_load (GTypeModule *type_module);
void e_module_unload (GTypeModule *type_module);
/* Forward Declarations */
GType e_cal_config_local_get_type (void);
G_DEFINE_DYNAMIC_TYPE (
ECalConfigLocal,
e_cal_config_local,
E_TYPE_SOURCE_CONFIG_BACKEND)
static void
cal_config_local_context_free (Context *context)
{
g_object_unref (context->custom_file_checkbox);
g_object_unref (context->custom_file_chooser);
g_object_unref (context->writable_checkbox);
g_slice_free (Context, context);
}
static gboolean
cal_config_local_active_to_custom_file (GBinding *binding,
const GValue *source_value,
GValue *target_value,
gpointer user_data)
{
Context *context = user_data;
GtkFileChooser *file_chooser;
GFile *file = NULL;
file_chooser = GTK_FILE_CHOOSER (context->custom_file_chooser);
if (g_value_get_boolean (source_value))
file = gtk_file_chooser_get_file (file_chooser);
g_value_take_object (target_value, file);
return TRUE;
}
static gboolean
cal_config_local_custom_file_to_active (GBinding *binding,
const GValue *source_value,
GValue *target_value,
gpointer user_data)
{
Context *context = user_data;
GtkFileChooser *file_chooser;
GFile *file;
gboolean success;
file_chooser = GTK_FILE_CHOOSER (context->custom_file_chooser);
file = g_value_get_object (source_value);
if (file == NULL) {
g_value_set_boolean (target_value, FALSE);
return TRUE;
}
success = gtk_file_chooser_set_file (file_chooser, file, NULL);
g_value_set_boolean (target_value, success);
return success;
}
static void
cal_config_local_file_set_cb (GtkFileChooserButton *button,
GtkWidget *custom_file_checkbox)
{
/* This will update ESourceLocal:custom-file. */
g_object_notify (G_OBJECT (custom_file_checkbox), "active");
}
static void
cal_config_local_insert_widgets (ESourceConfigBackend *backend,
ESource *scratch_source)
{
ESourceConfig *config;
ESource *builtin_source;
ESourceRegistry *registry;
ESourceExtension *extension;
GtkFileFilter *filter;
GtkWidget *container;
GtkWidget *widget;
Context *context;
gboolean source_is_builtin = FALSE;
const gchar *extension_name;
const gchar *uid;
gchar *markup;
uid = e_source_get_uid (scratch_source);
config = e_source_config_backend_get_config (backend);
registry = e_source_config_get_registry (config);
/* The built-in sources can't use a custom file. */
builtin_source = e_source_registry_ref_builtin_calendar (registry);
source_is_builtin |= e_source_equal (scratch_source, builtin_source);
g_object_unref (builtin_source);
builtin_source = e_source_registry_ref_builtin_memo_list (registry);
source_is_builtin |= e_source_equal (scratch_source, builtin_source);
g_object_unref (builtin_source);
builtin_source = e_source_registry_ref_builtin_task_list (registry);
source_is_builtin |= e_source_equal (scratch_source, builtin_source);
g_object_unref (builtin_source);
if (source_is_builtin)
return;
context = g_slice_new (Context);
g_object_set_data_full (
G_OBJECT (backend), uid, context,
(GDestroyNotify) cal_config_local_context_free);
widget = gtk_check_button_new_with_label (
_("Use an existing iCalendar (ics) file"));
e_source_config_insert_widget (
config, scratch_source, NULL, widget);
context->custom_file_checkbox = g_object_ref (widget);
gtk_widget_show (widget);
g_signal_connect_swapped (
widget, "toggled",
G_CALLBACK (e_source_config_resize_window), config);
container = e_source_config_get_page (config, scratch_source);
/* Put some extra padding above and below the header. */
widget = gtk_alignment_new (0.0, 0.0, 1.0, 1.0);
gtk_alignment_set_padding (GTK_ALIGNMENT (widget), 12, 6, 0, 0);
gtk_box_pack_start (GTK_BOX (container), widget, FALSE, FALSE, 0);
gtk_widget_show (widget);
g_object_bind_property (
context->custom_file_checkbox, "active",
widget, "visible",
G_BINDING_SYNC_CREATE);
container = widget;
markup = g_markup_printf_escaped ("<b>%s</b>", _("iCalendar File"));
widget = gtk_label_new (markup);
gtk_label_set_use_markup (GTK_LABEL (widget), TRUE);
gtk_misc_set_alignment (GTK_MISC (widget), 0.0, 0.5);
gtk_container_add (GTK_CONTAINER (container), widget);
gtk_widget_show (widget);
g_free (markup);
filter = gtk_file_filter_new ();
gtk_file_filter_add_mime_type (filter, "text/calendar");
widget = gtk_file_chooser_button_new (
_("Choose an iCalendar file"), GTK_FILE_CHOOSER_ACTION_OPEN);
gtk_file_chooser_set_filter (GTK_FILE_CHOOSER (widget), filter);
e_source_config_insert_widget (
config, scratch_source, _("File:"), widget);
context->custom_file_chooser = g_object_ref (widget);
gtk_widget_show (widget);
g_signal_connect (
widget, "file-set",
G_CALLBACK (cal_config_local_file_set_cb),
context->custom_file_checkbox);
g_object_bind_property (
context->custom_file_checkbox, "active",
widget, "visible",
G_BINDING_SYNC_CREATE);
widget = gtk_check_button_new_with_label (
_("Allow Evolution to update the file"));
e_source_config_insert_widget (
config, scratch_source, NULL, widget);
context->writable_checkbox = g_object_ref (widget);
gtk_widget_show (widget);
g_object_bind_property (
context->custom_file_checkbox, "active",
widget, "visible",
G_BINDING_SYNC_CREATE);
extension_name = E_SOURCE_EXTENSION_LOCAL_BACKEND;
extension = e_source_get_extension (scratch_source, extension_name);
g_object_bind_property_full (
extension, "custom-file",
context->custom_file_checkbox, "active",
G_BINDING_BIDIRECTIONAL |
G_BINDING_SYNC_CREATE,
cal_config_local_custom_file_to_active,
cal_config_local_active_to_custom_file,
context, (GDestroyNotify) NULL);
}
static gboolean
cal_config_local_check_complete (ESourceConfigBackend *backend,
ESource *scratch_source)
{
ESourceLocal *extension;
GtkToggleButton *toggle_button;
Context *context;
GFile *file;
const gchar *extension_name;
const gchar *uid;
gboolean active;
uid = e_source_get_uid (scratch_source);
context = g_object_get_data (G_OBJECT (backend), uid);
/* This function might get called before we install a
* context for this ESource, in which case just return. */
if (context == NULL)
return FALSE;
extension_name = E_SOURCE_EXTENSION_LOCAL_BACKEND;
extension = e_source_get_extension (scratch_source, extension_name);
file = e_source_local_get_custom_file (extension);
toggle_button = GTK_TOGGLE_BUTTON (context->custom_file_checkbox);
active = gtk_toggle_button_get_active (toggle_button);
/* If toggle button is active we need a valid file. */
return !active || (file != NULL);
}
static void
e_cal_config_local_class_init (ESourceConfigBackendClass *class)
{
EExtensionClass *extension_class;
extension_class = E_EXTENSION_CLASS (class);
extension_class->extensible_type = E_TYPE_CAL_SOURCE_CONFIG;
class->parent_uid = "local-stub";
class->backend_name = "local";