path: root/composer/e-composer-autosave.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/>
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 */

#include "e-composer-autosave.h"

#include <errno.h>
#include <sys/stat.h>
#include <glib/gi18n.h>
#include <glib/gstdio.h>

#include <e-util/e-error.h>
#include <e-util/e-util.h>
#include <camel/camel-stream-fs.h>
#include <camel/camel-stream-mem.h>

#define AUTOSAVE_PREFIX     ".evolution-composer.autosave"
#define AUTOSAVE_SEED       AUTOSAVE_PREFIX "-XXXXXX"
#define AUTOSAVE_INTERVAL   60 /* seconds */

typedef struct _AutosaveState AutosaveState;

struct _AutosaveState {
    GFile *file;
    gboolean enabled;
    gboolean saved;
};

static GList *autosave_registry;
static guint autosave_source_id;

static EMsgComposer *
composer_autosave_registry_lookup (const gchar *basename)
{
    GList *iter;

    /* Find the composer with the given autosave filename. */
    for (iter = autosave_registry; iter != NULL; iter = iter->next) {
        EMsgComposer *composer = iter->data;
        AutosaveState *state;
        gchar *_basename;

        state = g_object_get_data (G_OBJECT (composer), "autosave");
        if (state == NULL || state->file == NULL)
            continue;

        _basename = g_file_get_basename (state->file);
        if (strcmp (_basename, basename) == 0) {
            g_free (_basename);
            return composer;
        }
        g_free (_basename);
    }

    return NULL;
}

static AutosaveState *
composer_autosave_state_new (void)
{
    AutosaveState *state;

    state = g_slice_new (AutosaveState);
    state->file = NULL;
    state->enabled = TRUE;

    return state;
}

static void
composer_autosave_state_free (AutosaveState *state)
{
    if (state->file)
        g_object_unref (state->file);
    g_slice_free (AutosaveState, state);
}

static gboolean
composer_autosave_state_open (AutosaveState *state)
{
    gchar *path;

    if (state->file != NULL)
        return TRUE;

    path = g_build_filename (
        e_get_user_data_dir (), AUTOSAVE_SEED, NULL);

    /* Since GIO doesn't have support for creating temporary files
     * from a template (and in a given directory), we have to use
     * mktemp(), which brings a small risk of overwriting another
     * autosave file.  The risk is, however, miniscule. */
    if (mktemp (path) == NULL) {
        g_free (path);
        return FALSE;
    }

    /* Create the GFile */
    state->file = g_file_new_for_path (path);
    g_free (path);

    return TRUE;
}

static void
composer_autosave_foreach (EMsgComposer *composer)
{
    /* Make sure the composer is still alive. */
    g_return_if_fail (E_IS_MSG_COMPOSER (composer));

    if (e_composer_autosave_get_enabled (composer))
        e_composer_autosave_snapshot_async (composer, NULL, NULL);
}

static gint
composer_autosave_timeout (void)
{
    g_list_foreach (
        autosave_registry, (GFunc)
        composer_autosave_foreach, NULL);

    return TRUE;
}

static void
composer_autosave_notify (gpointer unused,
                          GObject *where_the_object_was)
{
    /* Remove the dead composer from the registry. */
    autosave_registry = g_list_remove (
        autosave_registry, where_the_object_was);

    /* Cancel timeouts if the registry is now empty. */
    if (autosave_registry == NULL && autosave_source_id != 0) {
        g_source_remove (autosave_source_id);
        autosave_source_id = 0;
    }
}

GList *
e_composer_autosave_find_orphans (GError **error)
{
    GDir *dir;
    const gchar *dirname;
    const gchar *basename;
    GList *orphans = NULL;

    dirname = e_get_user_data_dir ();
    dir = g_dir_open (dirname, 0, error);
    if (dir == NULL)
        return NULL;

    /* Scan the user directory for autosave files. */
    while ((basename = g_dir_read_name (dir)) != NULL) {
        const gchar *errmsg;
        gchar *filename;
        struct stat st;

        /* Is this an autosave file? */
        if (!g_str_has_prefix (basename, AUTOSAVE_PREFIX))
            continue;

        /* Is this an orphaned autosave file? */
        if (composer_autosave_registry_lookup (basename) != NULL)
            continue;

        filename = g_build_filename (dirname, basename, NULL);

        /* Try to examine the autosave file.  Failure here
         * is non-fatal; just emit a warning and move on. */
        errno = 0;
        if (g_stat (filename, &st) < 0) {
            errmsg = g_strerror (errno);
            g_warning ("%s: %s", filename, errmsg);
            g_free (filename);
            continue;
        }

        /* If the file is empty, delete it.  Failure here
         * is non-fatal; just emit a warning and move on. */
        if (st.st_size == 0) {
            errno = 0;
            if (g_unlink (filename) < 0) {
                errmsg = g_strerror (errno);
                g_warning ("%s: %s", filename, errmsg);
            }
            g_free (filename);
            continue;
        }

        orphans = g_list_prepend (orphans, filename);
    }

    g_dir_close (dir);

    return g_list_reverse (orphans);
}

void
e_composer_autosave_register (EMsgComposer *composer)
{
    g_return_if_fail (E_IS_MSG_COMPOSER (composer));

    g_object_set_data_full (
        G_OBJECT (composer), "autosave",
        composer_autosave_state_new (),
        (GDestroyNotify) composer_autosave_state_free);

    autosave_registry = g_list_prepend (autosave_registry, composer);

    g_object_weak_ref (
        G_OBJECT (composer), (GWeakNotify)
        composer_autosave_notify, NULL);

    if (autosave_source_id == 0)
        autosave_source_id = g_timeout_add_seconds (
            AUTOSAVE_INTERVAL, (GSourceFunc)
            composer_autosave_timeout, NULL);
}

void
e_composer_autosave_unregister (EMsgComposer *composer,
                                gboolean delete_file)
{
    AutosaveState *state;

    g_return_if_fail (E_IS_MSG_COMPOSER (composer));

    state = g_object_get_data (G_OBJECT (composer), "autosave");
    if (state == NULL || state->file == NULL)
        return;

    if (delete_file)
        g_file_delete (state->file, NULL, NULL);

    g_object_set_data (G_OBJECT (composer), "autosave", NULL);
}

typedef struct {
    GSimpleAsyncResult *result;
    EMsgComposer *composer;
    AutosaveState *state;

    /* Transient data */
    GInputStream *input_stream;
} AutosaveData;

static void
autosave_data_free (AutosaveData *data)
{
    g_object_unref (data->composer);
    g_slice_free (AutosaveData, data);
}

static gboolean
autosave_snapshot_check_for_error (AutosaveData *data, GError *error)
{
    if (error == NULL)
        return FALSE;

    g_simple_async_result_set_from_error (data->result, error);
    g_simple_async_result_set_op_res_gboolean (data->result, FALSE);
    g_simple_async_result_complete (data->result);
    g_error_free (error);

    autosave_data_free (data);

    return TRUE;
}

static void
autosave_snapshot_splice_cb (GOutputStream *autosave_stream,
                             GSimpleAsyncResult *result,
                             AutosaveData *data)
{
    gssize length;
    GError *error = NULL;

    length = g_output_stream_splice_finish (
        autosave_stream, G_ASYNC_RESULT (result), &error);
    g_object_unref (data->input_stream);
    if (autosave_snapshot_check_for_error (data, error))
        return;

    /* Snapshot was successful; set various flags. */
    /* do not touch "changed" flag, this is only autosave,
     * which doesn't mean it's saved permanently */
    e_composer_autosave_set_saved (data->composer, TRUE);

    /* Tidy up */
    autosave_data_free (data);
}

static void
autosave_snapshot_cb (GFile *autosave_file,
                      GSimpleAsyncResult *result,
                      AutosaveData *data)
{
    CamelMimeMessage *message;
    GFileOutputStream *output_stream;
    GInputStream *input_stream;
    CamelStream *camel_stream;
    GByteArray *buffer;
    GError *error = NULL;

    output_stream = g_file_replace_finish (
        autosave_file, G_ASYNC_RESULT (result), &error);
    if (autosave_snapshot_check_for_error (data, error))
        return;

    /* Extract a MIME message from the composer. */
    message = e_msg_composer_get_message_draft (data->composer);
    if (message == NULL) {
        /* If we don't set an error, but return FALSE, the error message
         * in this odd case (we don't have an error domain or code)
         * will be set in the _finish() function. */
        g_simple_async_result_set_op_res_gboolean (result, FALSE);
        g_object_unref (output_stream);
        autosave_data_free (data);
        return;
    }

    /* Decode the MIME part to an in-memory buffer.  We have to do
     * this because CamelStream is synchronous-only, and using threads
     * (as we do with foo()) is dangerous because CamelDataWrapper
     * is not reentrant. */
    buffer = g_byte_array_new ();
    camel_stream = camel_stream_mem_new ();
    camel_stream_mem_set_byte_array (
        CAMEL_STREAM_MEM (camel_stream), buffer);
    camel_data_wrapper_decode_to_stream (
        CAMEL_DATA_WRAPPER (message), camel_stream);
    camel_object_unref (message);
    camel_object_unref (camel_stream);

    /* Load the buffer into a GMemoryInputStream.
     * But watch out for zero length MIME parts. */
    input_stream = g_memory_input_stream_new ();
    if (buffer->len > 0)
        g_memory_input_stream_add_data (
            G_MEMORY_INPUT_STREAM (input_stream),
            buffer->data, (gssize) buffer->len,
            (GDestroyNotify) g_free);
    g_byte_array_free (buffer, FALSE);
    data->input_stream = input_stream;

    /* Splice the input and output streams */
    g_output_stream_splice_async (
        G_OUTPUT_STREAM (output_stream), input_stream,
        G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE |
        G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET,
        G_PRIORITY_DEFAULT, NULL, (GAsyncReadyCallback)
        autosave_snapshot_splice_cb, data);
    g_object_unref (output_stream);
}

void
e_composer_autosave_snapshot_async (EMsgComposer *composer,
                                    GAsyncReadyCallback callback,
                                    gpointer user_data)
{
    AutosaveData *data;
    AutosaveState *state;
    GSimpleAsyncResult *result;

    g_return_if_fail (E_IS_MSG_COMPOSER (composer));

    result = g_simple_async_result_new (
        G_OBJECT (composer), callback, user_data,
        e_composer_autosave_snapshot_async);

    /* If the contents are unchanged, exit early. */
    if (!gtkhtml_editor_get_changed (GTKHTML_EDITOR (composer))) {
        g_simple_async_result_set_op_res_gboolean (result, TRUE);
        g_simple_async_result_complete (result);
        return;
    }

    state = g_object_get_data (G_OBJECT (composer), "autosave");
    g_return_if_fail (state != NULL);

    /* Open the autosave file on-demand. */
    errno = 0;
    if (!composer_autosave_state_open (state)) {
        g_simple_async_result_set_error (
            result, G_FILE_ERROR,
            g_file_error_from_errno (errno),
            "%s", g_strerror (errno));
        g_simple_async_result_set_op_res_gboolean (result, FALSE);
        g_simple_async_result_complete (result);
        return;
    }

    /* Overwrite the file */
    data = g_slice_new (AutosaveData);
    data->composer = composer;
    data->result = result;
    data->state = state;

    g_file_replace_async (
        state->file, NULL, FALSE, G_FILE_CREATE_PRIVATE,
        G_PRIORITY_DEFAULT, NULL, (GAsyncReadyCallback)
        autosave_snapshot_cb, data);
}

gboolean
e_composer_autosave_snapshot_finish (EMsgComposer *composer,
                                     GAsyncResult *async_result,
                                     GError **error)
{
    GSimpleAsyncResult *result;

    g_return_val_if_fail (E_IS_MSG_COMPOSER (composer), FALSE);
    g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (async_result), FALSE);
    g_return_val_if_fail (error == NULL || *error == NULL, FALSE);

    result = G_SIMPLE_ASYNC_RESULT (async_result);
    g_warn_if_fail (g_simple_async_result_get_source_tag (result) ==
            e_composer_autosave_snapshot_async);

    if (g_simple_async_result_propagate_error (result, error) ||
        !g_simple_async_result_get_op_res_gboolean (result)) {
        const gchar *errmsg;
        gchar *filename;

        /* Sort out the error message; use the GError message if
         * possible. The only case where is isn't is where we couldn't
         * get the message from the editor. */
        if (error && *error)
            errmsg = (*error)->message;
        else
            errmsg = _("Unable to retrieve message from editor");

        filename = e_composer_autosave_get_filename (composer);
        e_error_run (
            GTK_WINDOW (composer), "mail-composer:no-autosave",
            (filename != NULL) ? filename : "", errmsg, NULL);
        g_free (filename);

        return FALSE;
    }

    return TRUE;
}

gchar *
e_composer_autosave_get_filename (EMsgComposer *composer)
{
    AutosaveState *state;

    g_return_val_if_fail (E_IS_MSG_COMPOSER (composer), NULL);

    state = g_object_get_data (G_OBJECT (composer), "autosave");
    g_return_val_if_fail (state != NULL, NULL);

    return g_file_get_path (state->file);
}

gboolean
e_composer_autosave_get_enabled (EMsgComposer *composer)
{
    AutosaveState *state;

    g_return_val_if_fail (E_IS_MSG_COMPOSER (composer), FALSE);

    state = g_object_get_data (G_OBJECT (composer), "autosave");
    g_return_val_if_fail (state != NULL, FALSE);

    return state->enabled;
}

void
e_composer_autosave_set_enabled (EMsgComposer *composer,
                                 gboolean enabled)
{
    AutosaveState *state;

    g_return_if_fail (E_IS_MSG_COMPOSER (composer));

    state = g_object_get_data (G_OBJECT (composer), "autosave");
    g_return_if_fail (state != NULL);

    state->enabled = enabled;
}

gboolean
e_composer_autosave_get_saved (EMsgComposer *composer)
{
    AutosaveState *state;

    g_return_val_if_fail (E_IS_MSG_COMPOSER (composer), FALSE);

    state = g_object_get_data (G_OBJECT (composer), "autosave");
    g_return_val_if_fail (state != NULL, FALSE);

    return state->saved;
}

void
e_composer_autosave_set_saved (EMsgComposer *composer,
                               gboolean saved)
{
    AutosaveState *state;

    g_return_if_fail (E_IS_MSG_COMPOSER (composer));

    state = g_object_get_data (G_OBJECT (composer), "autosave");
    g_return_if_fail (state != NULL);

    state->saved = saved;
}