From d21230f743de72ff73ed4aa22149175346d4d6ce Mon Sep 17 00:00:00 2001 From: Matthew Barnes Date: Fri, 4 Feb 2011 08:49:12 -0500 Subject: Add 'cal-config-weather' module. Registers the "Weather" backend in ECalSourceConfig widgets. Replaces the 'calendar-weather' plugin. --- modules/cal-config-weather/Makefile.am | 28 ++ modules/cal-config-weather/e-source-weather.c | 252 +++++++++++++++++ modules/cal-config-weather/e-source-weather.h | 83 ++++++ .../evolution-cal-config-weather.c | 309 +++++++++++++++++++++ 4 files changed, 672 insertions(+) create mode 100644 modules/cal-config-weather/Makefile.am create mode 100644 modules/cal-config-weather/e-source-weather.c create mode 100644 modules/cal-config-weather/e-source-weather.h create mode 100644 modules/cal-config-weather/evolution-cal-config-weather.c (limited to 'modules/cal-config-weather') diff --git a/modules/cal-config-weather/Makefile.am b/modules/cal-config-weather/Makefile.am new file mode 100644 index 0000000000..54b6d1e0e0 --- /dev/null +++ b/modules/cal-config-weather/Makefile.am @@ -0,0 +1,28 @@ +module_LTLIBRARIES = module-cal-config-weather.la + +module_cal_config_weather_la_CPPFLAGS = \ + $(AM_CPPFLAGS) \ + -I$(top_srcdir) \ + -I$(top_srcdir)/widgets \ + -DG_LOG_DOMAIN=\"evolution-cal-config-weather\" \ + $(EVOLUTION_DATA_SERVER_CFLAGS) \ + $(GNOME_PLATFORM_CFLAGS) \ + $(GWEATHER_CFLAGS) + +module_cal_config_weather_la_SOURCES = \ + evolution-cal-config-weather.c \ + e-source-weather.c \ + e-source-weather.h + +module_cal_config_weather_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) \ + $(GWEATHER_LIBS) + +module_cal_config_weather_la_LDFLAGS = \ + -module -avoid-version $(NO_UNDEFINED) + +-include $(top_srcdir)/git.mk diff --git a/modules/cal-config-weather/e-source-weather.c b/modules/cal-config-weather/e-source-weather.c new file mode 100644 index 0000000000..0f7e581ce8 --- /dev/null +++ b/modules/cal-config-weather/e-source-weather.c @@ -0,0 +1,252 @@ +/* + * e-source-weather.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 + * + */ + +#include "e-source-weather.h" + +#include + +#define E_SOURCE_WEATHER_GET_PRIVATE(obj) \ + (G_TYPE_INSTANCE_GET_PRIVATE \ + ((obj), E_TYPE_SOURCE_WEATHER, ESourceWeatherPrivate)) + +struct _ESourceWeatherPrivate { + GMutex *property_lock; + ESourceWeatherUnits units; + gchar *location; +}; + +enum { + PROP_0, + PROP_LOCATION, + PROP_UNITS +}; + +static GType e_source_weather_units_type = G_TYPE_INVALID; + +G_DEFINE_DYNAMIC_TYPE ( + ESourceWeather, + e_source_weather, + E_TYPE_SOURCE_EXTENSION) + +static void +source_weather_set_property (GObject *object, + guint property_id, + const GValue *value, + GParamSpec *pspec) +{ + switch (property_id) { + case PROP_LOCATION: + e_source_weather_set_location ( + E_SOURCE_WEATHER (object), + g_value_get_string (value)); + return; + + case PROP_UNITS: + e_source_weather_set_units ( + E_SOURCE_WEATHER (object), + g_value_get_enum (value)); + return; + } + + G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec); +} + +static void +source_weather_get_property (GObject *object, + guint property_id, + GValue *value, + GParamSpec *pspec) +{ + switch (property_id) { + case PROP_LOCATION: + g_value_take_string ( + value, + e_source_weather_dup_location ( + E_SOURCE_WEATHER (object))); + return; + + case PROP_UNITS: + g_value_set_enum ( + value, + e_source_weather_get_units ( + E_SOURCE_WEATHER (object))); + return; + } + + G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec); +} + +static void +source_weather_finalize (GObject *object) +{ + ESourceWeatherPrivate *priv; + + priv = E_SOURCE_WEATHER_GET_PRIVATE (object); + + g_mutex_free (priv->property_lock); + + g_free (priv->location); + + /* Chain up to parent's finalize() method. */ + G_OBJECT_CLASS (e_source_weather_parent_class)->finalize (object); +} + +static void +e_source_weather_class_init (ESourceWeatherClass *class) +{ + GObjectClass *object_class; + ESourceExtensionClass *extension_class; + + g_type_class_add_private (class, sizeof (ESourceWeatherPrivate)); + + object_class = G_OBJECT_CLASS (class); + object_class->set_property = source_weather_set_property; + object_class->get_property = source_weather_get_property; + object_class->finalize = source_weather_finalize; + + extension_class = E_SOURCE_EXTENSION_CLASS (class); + extension_class->name = E_SOURCE_EXTENSION_WEATHER_BACKEND; + + g_object_class_install_property ( + object_class, + PROP_LOCATION, + g_param_spec_string ( + "location", + "Location", + "Weather location code", + NULL, + G_PARAM_READWRITE | + G_PARAM_CONSTRUCT | + E_SOURCE_PARAM_SETTING)); + + g_object_class_install_property ( + object_class, + PROP_UNITS, + g_param_spec_enum ( + "units", + "Units", + "Metric or imperial units", + E_TYPE_SOURCE_WEATHER_UNITS, + E_SOURCE_WEATHER_UNITS_METRIC, + G_PARAM_READWRITE | + G_PARAM_CONSTRUCT | + E_SOURCE_PARAM_SETTING)); +} + +static void +e_source_weather_class_finalize (ESourceWeatherClass *class) +{ +} + +static void +e_source_weather_init (ESourceWeather *extension) +{ + extension->priv = E_SOURCE_WEATHER_GET_PRIVATE (extension); + extension->priv->property_lock = g_mutex_new (); +} + +void +e_source_weather_type_register (GTypeModule *type_module) +{ + static const GEnumValue e_source_weather_units_values[] = { + { E_SOURCE_WEATHER_UNITS_METRIC, + "E_SOURCE_WEATHER_UNITS_METRIC", + "metric" }, + { E_SOURCE_WEATHER_UNITS_IMPERIAL, + "E_SOURCE_WEATHER_UNITS_IMPERIAL", + "imperial" }, + { 0, NULL, NULL } + }; + + e_source_weather_units_type = + g_type_module_register_enum ( + type_module, "ESourceWeatherUnits", + e_source_weather_units_values); + + /* 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_weather_register_type (type_module); +} + +const gchar * +e_source_weather_get_location (ESourceWeather *extension) +{ + g_return_val_if_fail (E_IS_SOURCE_WEATHER (extension), NULL); + + return extension->priv->location; +} + +gchar * +e_source_weather_dup_location (ESourceWeather *extension) +{ + const gchar *protected; + gchar *duplicate; + + g_return_val_if_fail (E_IS_SOURCE_WEATHER (extension), NULL); + + g_mutex_lock (extension->priv->property_lock); + + protected = e_source_weather_get_location (extension); + duplicate = g_strdup (protected); + + g_mutex_unlock (extension->priv->property_lock); + + return duplicate; +} + +void +e_source_weather_set_location (ESourceWeather *extension, + const gchar *location) +{ + g_return_if_fail (E_IS_SOURCE_WEATHER (extension)); + + g_mutex_lock (extension->priv->property_lock); + + g_free (extension->priv->location); + extension->priv->location = e_util_strdup_strip (location); + + g_mutex_unlock (extension->priv->property_lock); + + g_object_notify (G_OBJECT (extension), "location"); +} + +ESourceWeatherUnits +e_source_weather_get_units (ESourceWeather *extension) +{ + g_return_val_if_fail (E_IS_SOURCE_WEATHER (extension), 0); + + return extension->priv->units; +} + +void +e_source_weather_set_units (ESourceWeather *extension, + ESourceWeatherUnits units) +{ + g_return_if_fail (E_IS_SOURCE_WEATHER (extension)); + + extension->priv->units = units; + + g_object_notify (G_OBJECT (extension), "units"); +} + +ESourceWeatherUnits +e_source_weather_units_get_type (void) +{ + return e_source_weather_units_type; +} diff --git a/modules/cal-config-weather/e-source-weather.h b/modules/cal-config-weather/e-source-weather.h new file mode 100644 index 0000000000..85ad991f64 --- /dev/null +++ b/modules/cal-config-weather/e-source-weather.h @@ -0,0 +1,83 @@ +/* + * e-source-weather.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 + * + */ + +#ifndef E_SOURCE_WEATHER_H +#define E_SOURCE_WEATHER_H + +#include + +/* Standard GObject macros */ +#define E_TYPE_SOURCE_WEATHER \ + (e_source_weather_get_type ()) +#define E_SOURCE_WEATHER(obj) \ + (G_TYPE_CHECK_INSTANCE_CAST \ + ((obj), E_TYPE_SOURCE_WEATHER, ESourceWeather)) +#define E_SOURCE_WEATHER_CLASS(cls) \ + (G_TYPE_CHECK_CLASS_CAST \ + ((cls), E_TYPE_SOURCE_WEATHER, ESourceWeatherClass)) +#define E_IS_SOURCE_WEATHER(obj) \ + (G_TYPE_CHECK_INSTANCE_TYPE \ + ((obj), E_TYPE_SOURCE_WEATHER)) +#define E_IS_SOURCE_WEATHER_CLASS(cls) \ + (G_TYPE_CHECK_CLASS_TYPE \ + ((cls), E_TYPE_SOURCE_WEATHER)) +#define E_SOURCE_WEATHER_GET_CLASS(obj) \ + (G_TYPE_INSTANCE_GET_CLASS \ + ((obj), E_TYPE_SOURCE_WEATHER, ESourceWeatherClass)) + +#define E_TYPE_SOURCE_WEATHER_UNITS \ + (e_source_weather_units_get_type ()) + +#define E_SOURCE_EXTENSION_WEATHER_BACKEND "Weather Backend" + +G_BEGIN_DECLS + +typedef struct _ESourceWeather ESourceWeather; +typedef struct _ESourceWeatherClass ESourceWeatherClass; +typedef struct _ESourceWeatherPrivate ESourceWeatherPrivate; + +struct _ESourceWeather { + ESourceExtension parent; + ESourceWeatherPrivate *priv; +}; + +struct _ESourceWeatherClass { + ESourceExtensionClass parent_class; +}; + +typedef enum { + E_SOURCE_WEATHER_UNITS_METRIC, + E_SOURCE_WEATHER_UNITS_IMPERIAL +} ESourceWeatherUnits; + +GType e_source_weather_get_type (void); +void e_source_weather_type_register (GTypeModule *type_module); +const gchar * e_source_weather_get_location (ESourceWeather *extension); +gchar * e_source_weather_dup_location (ESourceWeather *extension); +void e_source_weather_set_location (ESourceWeather *extension, + const gchar *location); +ESourceWeatherUnits + e_source_weather_get_units (ESourceWeather *extension); +void e_source_weather_set_units (ESourceWeather *extension, + ESourceWeatherUnits units); + +GType e_source_weather_units_get_type (void); + +G_END_DECLS + +#endif /* E_SOURCE_WEATHER_H */ diff --git a/modules/cal-config-weather/evolution-cal-config-weather.c b/modules/cal-config-weather/evolution-cal-config-weather.c new file mode 100644 index 0000000000..c6e8c47d08 --- /dev/null +++ b/modules/cal-config-weather/evolution-cal-config-weather.c @@ -0,0 +1,309 @@ +/* + * evolution-cal-config-weather.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 + * + */ + +#include +#include + +#include + +#define GWEATHER_I_KNOW_THIS_IS_UNSTABLE +#include +#undef GWEATHER_I_KNOW_THIS_IS_UNSTABLE + +#include +#include + +#include "e-source-weather.h" + +typedef ESourceConfigBackend ECalConfigWeather; +typedef ESourceConfigBackendClass ECalConfigWeatherClass; + +/* Module Entry Points */ +void e_module_load (GTypeModule *type_module); +void e_module_unload (GTypeModule *type_module); + +typedef struct _Context Context; + +struct _Context { + GtkWidget *location_entry; + GtkWidget *units_combo; +}; + +/* Forward Declarations */ +GType e_cal_config_weather_get_type (void); + +G_DEFINE_DYNAMIC_TYPE ( + ECalConfigWeather, + e_cal_config_weather, + E_TYPE_SOURCE_CONFIG_BACKEND) + +static void +cal_config_weather_context_free (Context *context) +{ + g_object_unref (context->location_entry); + g_object_unref (context->units_combo); + + g_slice_free (Context, context); +} + +static gboolean +cal_config_weather_location_to_string (GBinding *binding, + const GValue *source_value, + GValue *target_value, + gpointer user_data) +{ + GWeatherLocation *location; + gchar *string = NULL; + + location = g_value_get_pointer (source_value); + + if (location != NULL) { + const gchar *code; + gchar *city_name; + + code = gweather_location_get_code (location); + city_name = gweather_location_get_city_name (location); + string = g_strdup_printf ("%s/%s", code, city_name); + g_free (city_name); + } + + g_value_take_string (target_value, string); + + return TRUE; +} + +/* XXX This is a private libgweather constant. + * The value may change at any time. */ +#define GWEATHER_LOCATION_ENTRY_COL_LOCATION 1 + +static gboolean +cal_config_weather_string_to_location (GBinding *binding, + const GValue *source_value, + GValue *target_value, + gpointer user_data) +{ + GObject *target; + GWeatherLocation *match = NULL; + GtkEntryCompletion *completion; + GtkTreeModel *model; + GtkTreeIter iter; + const gchar *string; + const gchar *city_name; + const gchar *code; + gchar **tokens; + + /* XXX This is a bit convoluted because libgweather lacks a + * GWeatherLocation lookup function. The algorithm is + * copied from gweather_location_entry_set_city(). */ + + string = g_value_get_string (source_value); + + if (string == NULL) + return FALSE; + + /* String is: STATION-CODE '/' CITY-NAME */ + tokens = g_strsplit (string, "/", 2); + + if (g_strv_length (tokens) != 2) { + g_strfreev (tokens); + return FALSE; + } + + code = tokens[0]; + city_name = tokens[1]; + + target = g_binding_get_target (binding); + completion = gtk_entry_get_completion (GTK_ENTRY (target)); + model = gtk_entry_completion_get_model (completion); + + gtk_tree_model_get_iter_first (model, &iter); + + do { + GWeatherLocation *location; + const gchar *cmp_code; + gchar *cmp_city_name; + + gtk_tree_model_get ( + model, &iter, + GWEATHER_LOCATION_ENTRY_COL_LOCATION, + &location, -1); + + /* Does the station code match? */ + cmp_code = gweather_location_get_code (location); + if (g_strcmp0 (code, cmp_code) != 0) + continue; + + /* Does the city name match? */ + cmp_city_name = gweather_location_get_city_name (location); + if (g_strcmp0 (city_name, cmp_city_name) != 0) { + g_free (cmp_city_name); + continue; + } + g_free (cmp_city_name); + + /* We found a match! */ + match = location; + break; + + } while (gtk_tree_model_iter_next (model, &iter)); + + g_value_set_pointer (target_value, match); + + g_strfreev (tokens); + + return TRUE; +} + +static gboolean +cal_config_weather_allow_creation (ESourceConfigBackend *backend) +{ + ESourceConfig *config; + ECalSourceConfig *cal_config; + ECalClientSourceType source_type; + + /* No such thing as weather task lists or weather memo lists. */ + + config = e_source_config_backend_get_config (backend); + + cal_config = E_CAL_SOURCE_CONFIG (config); + source_type = e_cal_source_config_get_source_type (cal_config); + + return (source_type == E_CAL_CLIENT_SOURCE_TYPE_EVENTS); +} + +static void +cal_config_weather_insert_widgets (ESourceConfigBackend *backend, + ESource *scratch_source) +{ + ESourceConfig *config; + ESourceExtension *extension; + GWeatherLocation *world; + GtkWidget *widget; + Context *context; + const gchar *extension_name; + const gchar *uid; + + context = g_slice_new (Context); + uid = e_source_get_uid (scratch_source); + config = e_source_config_backend_get_config (backend); + + g_object_set_data_full ( + G_OBJECT (backend), uid, context, + (GDestroyNotify) cal_config_weather_context_free); + + world = gweather_location_new_world (TRUE); + + e_cal_source_config_add_offline_toggle ( + E_CAL_SOURCE_CONFIG (config), scratch_source); + + widget = gweather_location_entry_new (world); + e_source_config_insert_widget ( + config, scratch_source, _("Location:"), widget); + context->location_entry = g_object_ref (widget); + gtk_widget_show (widget); + + /* This must follow the order of ESourceWeatherUnits. */ + widget = gtk_combo_box_text_new (); + gtk_combo_box_text_append_text ( + GTK_COMBO_BOX_TEXT (widget), + _("Metric (Celsius, cm, etc)")); + gtk_combo_box_text_append_text ( + GTK_COMBO_BOX_TEXT (widget), + _("Imperial (Fahrenheit, inches, etc)")); + e_source_config_insert_widget ( + config, scratch_source, _("Units:"), widget); + context->units_combo = g_object_ref (widget); + gtk_widget_show (widget); + + e_source_config_add_refresh_interval (config, scratch_source); + + gweather_location_unref (world); + + extension_name = E_SOURCE_EXTENSION_WEATHER_BACKEND; + extension = e_source_get_extension (scratch_source, extension_name); + + g_object_bind_property_full ( + extension, "location", + context->location_entry, "location", + G_BINDING_BIDIRECTIONAL | + G_BINDING_SYNC_CREATE, + cal_config_weather_string_to_location, + cal_config_weather_location_to_string, + NULL, (GDestroyNotify) NULL); + + g_object_bind_property ( + extension, "units", + context->units_combo, "active", + G_BINDING_BIDIRECTIONAL | + G_BINDING_SYNC_CREATE); +} + +static gboolean +cal_config_weather_check_complete (ESourceConfigBackend *backend, + ESource *scratch_source) +{ + ESourceWeather *extension; + const gchar *extension_name; + const gchar *location; + + extension_name = E_SOURCE_EXTENSION_WEATHER_BACKEND; + extension = e_source_get_extension (scratch_source, extension_name); + + location = e_source_weather_get_location (extension); + + g_debug ("Location: [%s]", location); + + return (location != NULL) && (*location != '\0'); +} + +static void +e_cal_config_weather_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 = "weather-stub"; + class->backend_name = "weather"; + class->allow_creation = cal_config_weather_allow_creation; + class->insert_widgets = cal_config_weather_insert_widgets; + class->check_complete = cal_config_weather_check_complete; +} + +static void +e_cal_config_weather_class_finalize (ESourceConfigBackendClass *class) +{ +} + +static void +e_cal_config_weather_init (ESourceConfigBackend *backend) +{ +} + +G_MODULE_EXPORT void +e_module_load (GTypeModule *type_module) +{ + e_source_weather_type_register (type_module); + e_cal_config_weather_register_type (type_module); +} + +G_MODULE_EXPORT void +e_module_unload (GTypeModule *type_module) +{ +} -- cgit v1.2.3