/*
*
* 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/>
*
*
* Authors:
* Michael Zucchi <notzed@ximian.com>
*
* Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
*
*/
#include "e-file-utils.h"
#include <config.h>
#include <glib/gi18n-lib.h>
typedef struct _AsyncContext AsyncContext;
struct _AsyncContext {
EActivity *activity;
gchar *new_etag;
};
static void
async_context_free (AsyncContext *context)
{
if (context->activity != NULL)
g_object_unref (context->activity);
g_free (context->new_etag);
g_slice_free (AsyncContext, context);
}
static void
file_replace_contents_cb (GFile *file,
GAsyncResult *result,
GSimpleAsyncResult *simple)
{
AsyncContext *context;
gchar *new_etag = NULL;
GError *error = NULL;
context = g_simple_async_result_get_op_res_gpointer (simple);
g_file_replace_contents_finish (file, result, &new_etag, &error);
if (!e_activity_handle_cancellation (context->activity, error))
e_activity_set_state (context->activity, E_ACTIVITY_COMPLETED);
if (error == NULL)
context->new_etag = new_etag;
else {
g_warn_if_fail (new_etag == NULL);
g_simple_async_result_take_error (simple, error);
}
g_simple_async_result_complete (simple);
g_object_unref (simple);
}
/**
* e_file_replace_contents_async:
* @file: input #GFile
* @contents: string of contents to replace the file with
* @length: the length of @contents in bytes
* @etag: a new entity tag for the @file, or %NULL
* @make_backup: %TRUE if a backup should be created
* @flags: a set of #GFileCreateFlags
* @callback: a #GAsyncReadyCallback to call when the request is satisfied
* @user_data: the data to pass to the callback function
*
* This is a wrapper for g_file_replace_contents_async() that also returns
* an #EActivity to track the file operation. Cancelling the activity will
* cancel the file operation. See g_file_replace_contents_async() for more
* details.
*
* Returns: an #EActivity for the file operation
**/
EActivity *
e_file_replace_contents_async (GFile *file,
const gchar *contents,
gsize length,
const gchar *etag,
gboolean make_backup,
GFileCreateFlags flags,
GAsyncReadyCallback callback,
gpointer user_data)
{
GSimpleAsyncResult *simple;
GCancellable *cancellable;
AsyncContext *context;
const gchar *format;
gchar *description;
gchar *basename;
gchar *filename;
gchar *hostname;
gchar *uri;
g_return_val_if_fail (G_IS_FILE (file), NULL);
g_return_val_if_fail (contents != NULL, NULL);
uri = g_file_get_uri (file);
filename = g_filename_from_uri (uri, &hostname, NULL);
if (filename != NULL)
basename = g_filename_display_basename (filename);
else
basename = g_strdup (_("(Unknown Filename)"));
if (hostname == NULL) {
/* Translators: The string value is the basename of a file. */
format = _("Writing \"%s\"");
description = g_strdup_printf (format, basename);
} else {
/* Translators: The first string value is the basename of a
* remote file, the second string value is the hostname. */
format = _("Writing \"%s\" to %s");
description = g_strdup_printf (format, basename, hostname);
}
cancellable = g_cancellable_new ();
context = g_slice_new0 (AsyncContext);
context->activity = e_activity_new ();
e_activity_set_text (context->activity, description);
e_activity_set_cancellable (context->activity, cancellable);
simple = g_simple_async_result_new (
G_OBJECT (file), callback, user_data,
e_file_replace_contents_async);
g_simple_async_result_set_check_cancellable (simple, cancellable);
g_simple_async_result_set_op_res_gpointer (
simple, context, (GDestroyNotify) async_context_free);
g_file_replace_contents_async (
file, contents, length, etag,
make_backup, flags, cancellable,
(GAsyncReadyCallback) file_replace_contents_cb,
simple);
g_object_unref (cancellable);
g_free (description);
g_free (basename);
g_free (filename);
g_free (hostname);
g_free (uri);
return context->activity;
}
/**
* e_file_replace_contents_finish:
* @file: input #GFile
* @result: a #GAsyncResult
* @new_etag: return location for a new entity tag
* @error: return location for a #GError, or %NULL
*
* Finishes an asynchronous replace of the given @file. See
* e_file_replace_contents_async(). Sets @new_etag to the new entity
* tag for the document, if present. Free it with g_free() when it is
* no longer needed.
*
* Returns: %TRUE on success, %FALSE on failure
**/
gboolean
e_file_replace_contents_finish (GFile *file,
GAsyncResult *result,
gchar **new_etag,
GError **error)
{
GSimpleAsyncResult *simple;
AsyncContext *context;
g_return_val_if_fail (G_IS_FILE (file), FALSE);
g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (result), FALSE);
simple = G_SIMPLE_ASYNC_RESULT (result);
context = g_simple_async_result_get_op_res_gpointer (simple);
if (g_simple_async_result_propagate_error (simple, error))
return FALSE;
if (new_etag != NULL)
*new_etag = g_strdup (context->new_etag);
return TRUE;
}
