path: root/shell/e-shell-folder-creation-dialog.c

/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
/* e-shell.c
 *
 * Copyright (C) 2000, 2001 Ximian, Inc.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 *
 * 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * Author: Ettore Perazzoli
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <string.h>
#include <glib.h>
#include <libgnome/gnome-i18n.h>
#include <libgnome/gnome-util.h>

#include <gtk/gtkentry.h>
#include <gtk/gtkdialog.h>
#include <gtk/gtkoptionmenu.h>
#include <gtk/gtkmenuitem.h>
#include <gtk/gtkscrolledwindow.h>

#include <glade/glade-xml.h>

#include <gal/util/e-util.h>
#include <gal/widgets/e-gui-utils.h>

#include "e-storage-set.h"
#include "e-storage-set-view.h"
#include "e-shell-utils.h"

#include "e-shell-folder-creation-dialog.h"


#define GLADE_FILE_NAME  EVOLUTION_GLADEDIR "/e-shell-folder-creation-dialog.glade"


/* Data for the callbacks.  */
struct _DialogData {
    GtkWidget *dialog;
    EShell *shell;

    GtkWidget *folder_name_entry;
    GtkWidget *storage_set_view;
    GtkWidget *folder_type_option_menu;

    GList *folder_types;

    char *folder_path;

    EShellFolderCreationDialogCallback result_callback;
    void *result_callback_data;

    gboolean creation_in_progress;
};
typedef struct _DialogData DialogData;

static void
dialog_data_destroy (DialogData *dialog_data)
{
    e_free_string_list (dialog_data->folder_types);
    g_free (dialog_data->folder_path);

    g_free (dialog_data);
}


/* Callback for the asynchronous folder creation function.  */

static void
async_create_cb (EStorageSet *storage_set,
         EStorageResult result,
         void *data)
{
    DialogData *dialog_data;

    dialog_data = (DialogData *) data;

    dialog_data->creation_in_progress = FALSE;

    gtk_dialog_set_response_sensitive (GTK_DIALOG (dialog_data->dialog), GTK_RESPONSE_OK, TRUE);
    gtk_dialog_set_response_sensitive (GTK_DIALOG (dialog_data->dialog), GTK_RESPONSE_CANCEL, TRUE);

    if (result == E_STORAGE_OK) {
        /* Success! Tell the callback of this, then return */
        if (dialog_data->result_callback != NULL)
            (* dialog_data->result_callback) (dialog_data->shell,
                              E_SHELL_FOLDER_CREATION_DIALOG_RESULT_SUCCESS,
                              dialog_data->folder_path,
                              dialog_data->result_callback_data);
        if (dialog_data->dialog != NULL) {
            gtk_widget_destroy (dialog_data->dialog);
        } else {
            /* If dialog_data->dialog is NULL, it means that the
               dialog has been destroyed before we were done, so we
               have to free the dialog_data ourselves.  */
            dialog_data_destroy (dialog_data);
        }
        return;
    }

    /* Tell the callback something failed, then popup a dialog
           explaining how it failed */
    if (dialog_data->result_callback != NULL)
        (* dialog_data->result_callback) (dialog_data->shell,
                          E_SHELL_FOLDER_CREATION_DIALOG_RESULT_FAIL,
                          dialog_data->folder_path,
                          dialog_data->result_callback_data);

    e_notice (GTK_WINDOW (dialog_data->dialog), GTK_MESSAGE_ERROR,
          _("Cannot create the specified folder:\n%s"),
          e_storage_result_to_string (result));

    /* If dialog_data->dialog is NULL, it means that the dialog has been
       destroyed before we were done, so we have to free the dialog_data
       ourselves.  */
    if (dialog_data->dialog == NULL)
        dialog_data_destroy (dialog_data);
}


/* Dialog signal callbacks.  */

static void
dialog_response_cb (GtkDialog *dialog,
            int response_id,
            void *data)
{
    DialogData *dialog_data;
    EStorageSet *storage_set;
    GtkWidget *folder_type_menu_item;
    const char *folder_type;
    const char *parent_path;
    const char *reason;
    const char *folder_name;
    char *path;

    dialog_data = (DialogData *) data;

    if (response_id != GTK_RESPONSE_OK) {
        if (dialog_data->result_callback != NULL)
            (* dialog_data->result_callback) (dialog_data->shell,
                              E_SHELL_FOLDER_CREATION_DIALOG_RESULT_CANCEL,
                              NULL,
                              dialog_data->result_callback_data);
        gtk_widget_destroy (GTK_WIDGET (dialog));
        return;
    }

    folder_name = gtk_entry_get_text(GTK_ENTRY (dialog_data->folder_name_entry));

    if (! e_shell_folder_name_is_valid (folder_name, &reason)) {
        e_notice (GTK_WINDOW (dialog), GTK_MESSAGE_ERROR,
              _("The specified folder name is not valid: %s"), reason);
        return;
    }

    parent_path = e_storage_set_view_get_current_folder
        (E_STORAGE_SET_VIEW (dialog_data->storage_set_view));
    if (parent_path == NULL) {
        if (dialog_data->result_callback != NULL)
            (* dialog_data->result_callback) (dialog_data->shell,
                              E_SHELL_FOLDER_CREATION_DIALOG_RESULT_CANCEL,
                              NULL,
                              dialog_data->result_callback_data);
        gtk_widget_destroy (GTK_WIDGET (dialog));
        return;
    }

    path = g_build_filename (parent_path, folder_name, NULL);

    storage_set = e_shell_get_storage_set (dialog_data->shell);

    folder_type_menu_item = GTK_OPTION_MENU (dialog_data->folder_type_option_menu)->menu_item;
    folder_type = g_object_get_data (G_OBJECT (folder_type_menu_item), "folder_type");

    if (folder_type == NULL) {
        g_warning ("Cannot get folder type for selected GtkOptionMenu item.");
        return;
    }

    g_free (dialog_data->folder_path);
    dialog_data->folder_path = path;

    gtk_dialog_set_response_sensitive (GTK_DIALOG (dialog), GTK_RESPONSE_OK, FALSE);
    gtk_dialog_set_response_sensitive (GTK_DIALOG (dialog), GTK_RESPONSE_CANCEL, FALSE);

    dialog_data->creation_in_progress = TRUE;

    e_storage_set_async_create_folder (storage_set,
                       path,
                       folder_type,
                       "", /* description */
                       async_create_cb, dialog_data);
}

static void
dialog_destroy_notify (void *data,
               GObject *where_the_dialog_was)
{
    DialogData *dialog_data;

    dialog_data = (DialogData *) data;

    if (dialog_data->creation_in_progress) {
        /* If the dialog has been closed before we are done creating
           the folder, the dialog_data will be freed after the creation
           is completed.  */
        dialog_data->dialog = NULL;
        dialog_data->folder_name_entry = NULL;
        dialog_data->storage_set_view = NULL;
        dialog_data->folder_type_option_menu = NULL;
        return;
    }

    dialog_data_destroy (dialog_data);
}

static void
folder_name_entry_activate_cb (GtkEntry *entry,
                   void *data)
{
    DialogData *dialog_data;
    const char *parent_path;
    
    dialog_data = (DialogData *) data;

    parent_path = e_storage_set_view_get_current_folder (E_STORAGE_SET_VIEW (dialog_data->storage_set_view));

    if (parent_path != NULL
        && GTK_ENTRY (dialog_data->folder_name_entry)->text_length > 0)
        gtk_dialog_response (GTK_DIALOG (dialog_data->dialog), GTK_RESPONSE_OK);    
}

static void
folder_name_entry_changed_cb (GtkEditable *editable,
                  void *data)
{
    DialogData *dialog_data;
    const char *parent_path;

    dialog_data = (DialogData *) data;

    parent_path = e_storage_set_view_get_current_folder (E_STORAGE_SET_VIEW (dialog_data->storage_set_view));

    if (parent_path != NULL
        && GTK_ENTRY (dialog_data->folder_name_entry)->text_length > 0)
        gtk_dialog_set_response_sensitive (GTK_DIALOG (dialog_data->dialog), GTK_RESPONSE_OK, TRUE);
    else
        gtk_dialog_set_response_sensitive (GTK_DIALOG (dialog_data->dialog), GTK_RESPONSE_OK, FALSE);
}

static void
storage_set_view_folder_selected_cb (EStorageSetView *storage_set_view,
                     const char *path,
                     void *data)
{
    DialogData *dialog_data;

    dialog_data = (DialogData *) data;

    if (GTK_ENTRY (dialog_data->folder_name_entry)->text_length > 0)
        gtk_dialog_set_response_sensitive (GTK_DIALOG (dialog_data->dialog), GTK_RESPONSE_OK, TRUE);
}


/* Shell signal callbacks.  */

static void
shell_destroy_notify (void *data,
              GObject *where_the_shell_was)
{
    DialogData *dialog_data = (DialogData *) data;

    dialog_data->shell = NULL;
    gtk_widget_destroy (GTK_WIDGET (dialog_data->dialog));
}


/* Dialog setup.  */

static void
setup_dialog (GtkWidget *dialog,
          GladeXML *gui,
          EShell *shell,
          GtkWindow *parent_window)
{
    if (parent_window != NULL)
        gtk_window_set_transient_for (GTK_WINDOW (dialog), parent_window);

    gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
    gtk_window_set_title (GTK_WINDOW (dialog), _("Create New Folder"));

    gtk_dialog_set_response_sensitive (GTK_DIALOG (dialog), GTK_RESPONSE_OK, FALSE);

    gtk_widget_show (dialog);
}

static void
setup_folder_name_entry (GtkWidget *dialog,
             GladeXML *gui,
             EShell *shell)
{
    GtkWidget *folder_name_entry;

    folder_name_entry = glade_xml_get_widget (gui, "folder_name_entry");
}

static GtkWidget *
add_storage_set_view (GtkWidget *dialog,
              GladeXML *gui,
              EShell *shell,
              const char *default_parent_folder)
{
    EStorageSet *storage_set;
    GtkWidget *storage_set_view;
    GtkWidget *scrolled_window;
    GtkWidget *vbox;

    storage_set = e_shell_get_storage_set (shell);
    storage_set_view = e_storage_set_create_new_view (storage_set, NULL);

    e_storage_set_view_set_allow_dnd (E_STORAGE_SET_VIEW (storage_set_view), FALSE);

    GTK_WIDGET_SET_FLAGS (storage_set_view, GTK_CAN_FOCUS);

    if (default_parent_folder != NULL)
        e_storage_set_view_set_current_folder (E_STORAGE_SET_VIEW (storage_set_view),
                               default_parent_folder);

    vbox = glade_xml_get_widget (gui, "main_vbox");

    scrolled_window = gtk_scrolled_window_new (NULL, NULL);
    gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (scrolled_window), GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
    gtk_scrolled_window_set_shadow_type (GTK_SCROLLED_WINDOW (scrolled_window), GTK_SHADOW_IN);
    gtk_box_pack_start (GTK_BOX (vbox), scrolled_window, TRUE, TRUE, 0);

    gtk_container_add (GTK_CONTAINER (scrolled_window), storage_set_view);

    gtk_widget_show (scrolled_window);
    gtk_widget_show (storage_set_view);

    return storage_set_view;
}

struct _TypeWithDisplayName {
    const char *type;
    const char *display_name;
};
typedef struct _TypeWithDisplayName TypeWithDisplayName;

static int
type_with_display_name_compare_func (const void *a, const void *b)
{
    const TypeWithDisplayName *val_a, *val_b;
    char *a_display_name_casefolded;
    char *b_display_name_casefolded;
    int retval;

    val_a = (const TypeWithDisplayName *) a;
    val_b = (const TypeWithDisplayName *) b;

    a_display_name_casefolded = g_utf8_casefold (val_a->display_name, -1);
    b_display_name_casefolded = g_utf8_casefold (val_b->display_name, -1);

    retval = g_utf8_collate (a_display_name_casefolded, b_display_name_casefolded);

    g_free (a_display_name_casefolded);
    g_free (b_display_name_casefolded);

    return retval;
}

static GList *
add_folder_types (GtkWidget *dialog,
          GladeXML *gui,
          EShell *shell,
          const char *default_type)
{
    EFolderTypeRegistry *folder_type_registry;
    GtkWidget *folder_type_option_menu;
    GtkWidget *menu;
    GList *folder_types;
    GList *types_with_display_names;
    GList *p;
    int default_item;
    int i;

    folder_type_option_menu = glade_xml_get_widget (gui, "folder_type_option_menu");

    /* KLUDGE.  So, GtkOptionMenu is badly broken.  It calculates its size
           in `gtk_option_menu_set_menu()' instead of using `size_request()' as
           any sane widget would do.  So, in order to avoid the "narrow
           GtkOptionMenu" bug, we have to destroy the existing associated menu
           and create a new one.  Life sucks.  */

    menu = gtk_option_menu_get_menu (GTK_OPTION_MENU (folder_type_option_menu));
    g_assert (menu != NULL);
    gtk_widget_destroy (menu);

    menu = gtk_menu_new ();

    folder_type_registry = e_shell_get_folder_type_registry (shell);
    g_assert (folder_type_registry != NULL);

    folder_types = e_folder_type_registry_get_type_names (folder_type_registry);
    if (folder_types == NULL)
        return NULL;        /* Uh? */

    types_with_display_names = NULL;
    for (p = folder_types; p != NULL; p = p->next) {
        TypeWithDisplayName *new;

        new = g_new (TypeWithDisplayName, 1);
        new->type = p->data;
        new->display_name = e_folder_type_registry_get_display_name_for_type (folder_type_registry, new->type);

        types_with_display_names = g_list_prepend (types_with_display_names, new);
    }

    types_with_display_names = g_list_sort (types_with_display_names, type_with_display_name_compare_func);

    /* FIXME: Add icon (I don't feel like writing an alpha-capable thingie again).  */

    default_item = 0;
    i = 0;
    for (p = types_with_display_names; p != NULL; p = p->next) {
        const TypeWithDisplayName *type;
        GtkWidget *menu_item;

        type = (const TypeWithDisplayName *) p->data;

        if (! e_folder_type_registry_type_is_user_creatable (folder_type_registry, type->type))
            continue;

        menu_item = gtk_menu_item_new_with_label (type->display_name);
        gtk_widget_show (menu_item);
        gtk_menu_shell_append(GTK_MENU_SHELL(menu), menu_item);

        g_object_set_data_full (G_OBJECT (menu_item), "folder_type", g_strdup (type->type), g_free);

        if (strcmp (type->type, default_type ? default_type : "mail") == 0)
            default_item = i;

        i ++;
    }

    for (p = types_with_display_names; p != NULL; p = p->next)
        g_free (p->data);
    g_list_free (types_with_display_names);

    gtk_option_menu_set_menu (GTK_OPTION_MENU (folder_type_option_menu), menu);
    gtk_widget_show (menu);

    gtk_option_menu_set_history (GTK_OPTION_MENU (folder_type_option_menu), default_item);
    gtk_widget_queue_resize (folder_type_option_menu);

    return folder_types;
}

static const char *
get_type_from_parent_path (EShell *shell,
               const char *path)
{
    EFolder *folder;
    const char *folder_type;
    EStorageSet *set;

    set = e_shell_get_storage_set (shell);
    folder = e_storage_set_get_folder (set, path);
    if (folder == NULL) {
        return "mail";
    }

    folder_type = e_folder_get_type_string (folder);
    if (folder_type == NULL || strcmp (folder_type, "noselect") == 0) {
        return "mail";
    } else {
        return folder_type;
    }
}


/* FIXME: Currently this is modal.  I think it's OK, but if people think it is
   not, we should change it to non-modal and make sure only one of these is
   open at once.  Currently it relies on modality for this.  */
void
e_shell_show_folder_creation_dialog (EShell *shell,
                     GtkWindow *parent_window,
                     const char *default_parent_folder,
                     const char *default_type,
                     EShellFolderCreationDialogCallback result_callback,
                     void *result_callback_data)
{
    GladeXML *gui;
    GtkWidget *dialog;
    GtkWidget *storage_set_view;
    GList *folder_types;
    DialogData *dialog_data;

    g_return_if_fail (shell != NULL);
    g_return_if_fail (E_IS_SHELL (shell));

    gui = glade_xml_new (GLADE_FILE_NAME, NULL, NULL);
    if (gui == NULL) {
        g_warning ("Cannot load Glade description file for the folder creation dialog -- %s",
               GLADE_FILE_NAME);
        return;
    }

    dialog = glade_xml_get_widget (gui, "create_folder_dialog");

    setup_dialog (dialog, gui, shell, parent_window);
    setup_folder_name_entry (dialog, gui, shell);

    storage_set_view = add_storage_set_view (dialog, gui, shell, default_parent_folder);
    if (default_type == NULL) {
        const char *dt;

        dt = get_type_from_parent_path (shell, default_parent_folder);
        folder_types = add_folder_types (dialog, gui, shell, dt);
    } else {
        folder_types = add_folder_types (dialog, gui, shell, default_type);
    }

    dialog_data = g_new (DialogData, 1);
    dialog_data->dialog                  = dialog;
    dialog_data->shell                   = shell;
    dialog_data->folder_name_entry       = glade_xml_get_widget (gui, "folder_name_entry");
    dialog_data->storage_set_view        = storage_set_view;
    dialog_data->folder_type_option_menu = glade_xml_get_widget (gui, "folder_type_option_menu");
    dialog_data->folder_types            = folder_types;
    dialog_data->folder_path             = NULL;
    dialog_data->result_callback         = result_callback;
    dialog_data->result_callback_data    = result_callback_data;
    dialog_data->creation_in_progress    = FALSE;

    g_signal_connect (dialog, "response",
              G_CALLBACK (dialog_response_cb), dialog_data);
    g_object_weak_ref (G_OBJECT (dialog), dialog_destroy_notify, dialog_data);

    g_signal_connect (dialog_data->folder_name_entry, "changed",
              G_CALLBACK (folder_name_entry_changed_cb), dialog_data);

    g_signal_connect (dialog_data->folder_name_entry, "activate",
              G_CALLBACK (folder_name_entry_activate_cb), dialog_data);

    g_signal_connect (dialog_data->storage_set_view, "folder_selected",
              G_CALLBACK (storage_set_view_folder_selected_cb), dialog_data);

    g_object_weak_ref (G_OBJECT (shell), shell_destroy_notify, dialog_data);

    g_object_unref (gui);
}