[evolution-data-server] EServerSideSource: Add a "write-directory" property.
- From: Matthew Barnes <mbarnes src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [evolution-data-server] EServerSideSource: Add a "write-directory" property.
- Date: Tue, 12 Jun 2012 11:51:19 +0000 (UTC)
commit 5bdb4529af6df0efad71eb1e5c67c0ed22dbfab3
Author: Matthew Barnes <mbarnes redhat com>
Date: Mon Jun 11 13:26:52 2012 -0400
EServerSideSource: Add a "write-directory" property.
Defines the directory where data source changes are to be written,
which may not be the same directory as it was originally read from.
Defaults to the value returned by e_server_side_source_get_user_dir().
This allows an ECollectionBackend to override the default directory to
keep key files for backend-created data sources separate from key files
for user-created data sources.
.../reference/libebackend/libebackend-sections.txt | 2 +
libebackend/e-server-side-source.c | 101 +++++++++++++++++++-
libebackend/e-server-side-source.h | 5 +
3 files changed, 103 insertions(+), 5 deletions(-)
---
diff --git a/docs/reference/libebackend/libebackend-sections.txt b/docs/reference/libebackend/libebackend-sections.txt
index 89d1fa6..271e31d 100644
--- a/docs/reference/libebackend/libebackend-sections.txt
+++ b/docs/reference/libebackend/libebackend-sections.txt
@@ -334,6 +334,8 @@ e_server_side_source_get_node
e_server_side_source_get_server
e_server_side_source_get_allow_auth_prompt
e_server_side_source_set_allow_auth_prompt
+e_server_side_source_get_write_directory
+e_server_side_source_set_write_directory
e_server_side_source_set_removable
e_server_side_source_set_writable
<SUBSECTION Standard>
diff --git a/libebackend/e-server-side-source.c b/libebackend/e-server-side-source.c
index fefb8c3..cafa0ee 100644
--- a/libebackend/e-server-side-source.c
+++ b/libebackend/e-server-side-source.c
@@ -54,6 +54,7 @@ struct _EServerSideSourcePrivate {
gchar *file_contents;
gboolean allow_auth_prompt;
+ gchar *write_directory;
};
struct _AsyncClosure {
@@ -69,7 +70,8 @@ enum {
PROP_REMOVABLE,
PROP_SERVER,
PROP_UID,
- PROP_WRITABLE
+ PROP_WRITABLE,
+ PROP_WRITE_DIRECTORY
};
static GInitableIface *initable_parent_interface;
@@ -379,6 +381,12 @@ server_side_source_set_property (GObject *object,
E_SERVER_SIDE_SOURCE (object),
g_value_get_boolean (value));
return;
+
+ case PROP_WRITE_DIRECTORY:
+ e_server_side_source_set_write_directory (
+ E_SERVER_SIDE_SOURCE (object),
+ g_value_get_string (value));
+ return;
}
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
@@ -432,6 +440,13 @@ server_side_source_get_property (GObject *object,
e_source_get_writable (
E_SOURCE (object)));
return;
+
+ case PROP_WRITE_DIRECTORY:
+ g_value_set_string (
+ value,
+ e_server_side_source_get_write_directory (
+ E_SERVER_SIDE_SOURCE (object)));
+ return;
}
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
@@ -470,6 +485,7 @@ server_side_source_finalize (GObject *object)
g_free (priv->uid);
g_free (priv->file_contents);
+ g_free (priv->write_directory);
/* Chain up to parent's finalize() method. */
G_OBJECT_CLASS (e_server_side_source_parent_class)->finalize (object);
@@ -672,9 +688,11 @@ server_side_source_write (ESource *source,
new_data = e_source_to_string (source, NULL);
/* When writing source data to disk, we always write to the
- * user directory even if the key file was originally in the
- * system-wide directory. For that reason, we want to avoid
- * writing unmodified data from the system-wide directory. */
+ * source's specified "write-directory" even if the key file
+ * was originally read from a different directory. To avoid
+ * polluting the write directory with key files identical to
+ * the original, we check that the data has actually changed
+ * before writing a copy to disk. */
replace_file =
G_IS_FILE (priv->file) &&
@@ -682,11 +700,16 @@ server_side_source_write (ESource *source,
if (replace_file) {
GFile *file;
+ gchar *filename;
gchar *uid;
+ g_warn_if_fail (priv->write_directory != NULL);
+
uid = e_server_side_source_uid_from_file (priv->file, NULL);
g_warn_if_fail (uid != NULL); /* this should never fail */
- file = e_server_side_source_new_user_file (uid);
+ filename = g_build_filename (priv->write_directory, uid, NULL);
+ file = g_file_new_for_path (filename);
+ g_free (filename);
g_free (uid);
if (!g_file_equal (file, priv->file)) {
@@ -884,6 +907,19 @@ e_server_side_source_class_init (EServerSideSourceClass *class)
FALSE,
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
+
+ /* Do not use G_PARAM_CONSTRUCT. We initialize the
+ * property ourselves in e_server_side_source_init(). */
+ g_object_class_install_property (
+ object_class,
+ PROP_WRITE_DIRECTORY,
+ g_param_spec_string (
+ "write-directory",
+ "Write Directory",
+ "Directory in which to write changes to disk",
+ NULL,
+ G_PARAM_READWRITE |
+ G_PARAM_STATIC_STRINGS));
}
static void
@@ -897,9 +933,14 @@ e_server_side_source_initable_init (GInitableIface *interface)
static void
e_server_side_source_init (EServerSideSource *source)
{
+ const gchar *user_dir;
+
source->priv = E_SERVER_SIDE_SOURCE_GET_PRIVATE (source);
source->priv->node.data = source;
+
+ user_dir = e_server_side_source_get_user_dir ();
+ source->priv->write_directory = g_strdup (user_dir);
}
/**
@@ -1298,6 +1339,56 @@ e_server_side_source_set_allow_auth_prompt (EServerSideSource *source,
}
/**
+ * e_server_side_source_get_write_directory:
+ * @source: an #EServerSideSource
+ *
+ * Returns the local directory path where changes to @source are written.
+ *
+ * By default, changes are written to the local directory path returned by
+ * e_server_side_source_get_user_dir(), but an #ECollectionBackend may wish
+ * to override this to use its own private cache directory for data sources
+ * it creates automatically.
+ *
+ * Returns: the directory where changes are written
+ *
+ * Since: 3.6
+ **/
+const gchar *
+e_server_side_source_get_write_directory (EServerSideSource *source)
+{
+ g_return_val_if_fail (E_IS_SERVER_SIDE_SOURCE (source), NULL);
+
+ return source->priv->write_directory;
+}
+
+/**
+ * e_server_side_source_set_write_directory:
+ * @source: an #EServerSideSource
+ * @write_directory: the directory where changes are to be written
+ *
+ * Sets the local directory path where changes to @source are to be written.
+ *
+ * By default, changes are written to the local directory path returned by
+ * e_server_side_source_get_user_dir(), but an #ECollectionBackend may wish
+ * to override this to use its own private cache directory for data sources
+ * it creates automatically.
+ *
+ * Since: 3.6
+ **/
+void
+e_server_side_source_set_write_directory (EServerSideSource *source,
+ const gchar *write_directory)
+{
+ g_return_if_fail (E_IS_SERVER_SIDE_SOURCE (source));
+ g_return_if_fail (write_directory != NULL);
+
+ g_free (source->priv->write_directory);
+ source->priv->write_directory = g_strdup (write_directory);
+
+ g_object_notify (G_OBJECT (source), "write-directory");
+}
+
+/**
* e_server_side_source_set_removable:
* @source: an #EServerSideSource
* @removable: whether to export the Removable interface
diff --git a/libebackend/e-server-side-source.h b/libebackend/e-server-side-source.h
index b8ba8f5..597d782 100644
--- a/libebackend/e-server-side-source.h
+++ b/libebackend/e-server-side-source.h
@@ -96,6 +96,11 @@ gboolean e_server_side_source_get_allow_auth_prompt
void e_server_side_source_set_allow_auth_prompt
(EServerSideSource *source,
gboolean allow_auth_prompt);
+const gchar * e_server_side_source_get_write_directory
+ (EServerSideSource *source);
+void e_server_side_source_set_write_directory
+ (EServerSideSource *source,
+ const gchar *write_directory);
void e_server_side_source_set_removable
(EServerSideSource *source,
gboolean removable);
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]