add persistence for collapsed / expanded folder trees
[claws.git] / src / folder.c
index e1a0400594af1697e1f9ae735b6d3f2a14af2278..ae93c2ff3e46f53ce4b6f4d50008e0ad7e1a6171 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999,2000 Hiroyuki Yamamoto
+ * Copyright (C) 1999-2001 Hiroyuki Yamamoto
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -151,6 +151,9 @@ FolderItem *folder_item_new(const gchar *name, const gchar *path)
        item->unread = 0;
        item->total = 0;
        item->last_num = -1;
+       item->no_sub = FALSE;
+       item->no_select = FALSE;
+       item->collapsed = FALSE; /* default is open */
        item->parent = NULL;
        item->folder = NULL;
        item->data = NULL;
@@ -194,6 +197,15 @@ void folder_item_remove(FolderItem *item)
        g_node_destroy(node);
 }
 
+void folder_item_destroy(FolderItem *item)
+{
+       g_return_if_fail(item != NULL);
+
+       g_free(item->name);
+       g_free(item->path);
+       g_free(item);
+}
+
 void folder_set_ui_func(Folder *folder, FolderUIFunc func, gpointer data)
 {
        g_return_if_fail(folder != NULL);
@@ -236,6 +248,7 @@ void folder_destroy(Folder *folder)
                news_folder_destroy(NEWS_FOLDER(folder));
                break;
        default:
+               break;
        }
 
        folder_tree_destroy(folder);
@@ -247,6 +260,13 @@ void folder_tree_destroy(Folder *folder)
 {
        /* TODO: destroy all FolderItem before */
        g_node_destroy(folder->node);
+
+       folder->inbox = NULL;
+       folder->outbox = NULL;
+       folder->draft = NULL;
+       folder->queue = NULL;
+       folder->trash = NULL;
+       folder->node = NULL;
 }
 
 void folder_add(Folder *folder)
@@ -341,7 +361,7 @@ Folder *folder_find_from_path(const gchar *path)
 
        for (list = folder_list; list != NULL; list = list->next) {
                folder = list->data;
-               if (folder->type == F_MH &&
+               if ((folder->type == F_MH || folder->type == F_MBOX) &&
                    !path_cmp(LOCAL_FOLDER(folder)->rootpath, path))
                        return folder;
        }
@@ -666,14 +686,10 @@ gint folder_item_move_msgs_with_dest(FolderItem *dest, GSList *msglist)
        if (folder->finished_copy)
                folder->finished_copy(folder, dest);
 
-       printf("là scan\n");
-
        if (item && item->folder->scan)
                item->folder->scan(item->folder, item);
        folder->scan(folder, dest);
 
-       printf("ici scan\n");
-
        return dest->last_num;
 }
 
@@ -784,6 +800,7 @@ gint folder_item_copy_msgs_with_dest(FolderItem *dest, GSList *msglist)
 gint folder_item_remove_msg(FolderItem *item, gint num)
 {
        Folder *folder;
+       gint result;
 
        g_return_val_if_fail(item != NULL, -1);
 
@@ -792,14 +809,25 @@ gint folder_item_remove_msg(FolderItem *item, gint num)
        g_return_val_if_fail(folder->scan != NULL, -1);
        g_return_val_if_fail(folder->remove_msg != NULL, -1);
 
+       if (folder->finished_remove)
+               folder->finished_remove(folder, item);
+
+       result = folder->remove_msg(folder, item, num);
+
        if (item->last_num < 0) folder->scan(folder, item);
 
-       return folder->remove_msg(folder, item, num);
+       if (result == 0){
+               if (folder->finished_remove)
+                       folder->finished_remove(folder, item);
+       }
+
+       return result;
 }
 
 gint folder_item_remove_all_msg(FolderItem *item)
 {
        Folder *folder;
+       gint result;
 
        g_return_val_if_fail(item != NULL, -1);
 
@@ -810,7 +838,14 @@ gint folder_item_remove_all_msg(FolderItem *item)
 
        if (item->last_num < 0) folder->scan(folder, item);
 
-       return folder->remove_all_msg(folder, item);
+       result = folder->remove_all_msg(folder, item);
+
+       if (result == 0){
+               if (folder->finished_remove)
+                       folder->finished_remove(folder, item);
+       }
+
+       return result;
 }
 
 gboolean folder_item_is_msg_changed(FolderItem *item, MsgInfo *msginfo)
@@ -909,15 +944,18 @@ static void folder_init(Folder *folder, FolderType type, const gchar *name)
        case F_IMAP:
                folder->get_msg_list        = imap_get_msg_list;
                folder->fetch_msg           = imap_fetch_msg;
-               /*
+               folder->add_msg             = imap_add_msg;
                folder->move_msg            = imap_move_msg;
                folder->move_msgs_with_dest = imap_move_msgs_with_dest;
-               */
+               folder->copy_msg            = imap_copy_msg;
+               folder->copy_msgs_with_dest = imap_copy_msgs_with_dest;
                folder->remove_msg          = imap_remove_msg;
                folder->remove_all_msg      = imap_remove_all_msg;
                folder->scan                = imap_scan_folder;
+               folder->scan_tree           = imap_scan_tree;
+               folder->create_tree         = imap_create_tree;
                folder->create_folder       = imap_create_folder;
-               folder->remove_folder       = imap_remove_folder;               
+               folder->remove_folder       = imap_remove_folder;
                break;
        case F_NEWS:
                folder->get_msg_list        = news_get_article_list;
@@ -950,6 +988,7 @@ static void folder_init(Folder *folder, FolderType type, const gchar *name)
 
                break;
        default:
+               break;
        }
 
        switch (type) {
@@ -960,9 +999,10 @@ static void folder_init(Folder *folder, FolderType type, const gchar *name)
                break;
        case F_IMAP:
        case F_NEWS:
-               REMOTE_FOLDER(folder)->session   = NULL;
+               REMOTE_FOLDER(folder)->session = NULL;
                break;
        default:
+               break;
        }
 }
 
@@ -1011,6 +1051,7 @@ static gboolean folder_build_tree(GNode *node, gpointer data)
        const gchar *name = NULL;
        const gchar *path = NULL;
        PrefsAccount *account = NULL;
+       gboolean no_sub = FALSE, no_select = FALSE, collapsed = FALSE;
        gint mtime = 0, new = 0, unread = 0, total = 0;
 
        g_return_val_if_fail(node->data != NULL, FALSE);
@@ -1048,8 +1089,7 @@ static gboolean folder_build_tree(GNode *node, gpointer data)
                        account = account_find_from_id(atoi(attr->value));
                        if (!account) g_warning("account_id: %s not found\n",
                                                attr->value);
-               }
-               else if (!strcmp(attr->name, "mtime"))
+               } else if (!strcmp(attr->name, "mtime"))
                        mtime = atoi(attr->value);
                else if (!strcmp(attr->name, "new"))
                        new = atoi(attr->value);
@@ -1057,6 +1097,12 @@ static gboolean folder_build_tree(GNode *node, gpointer data)
                        unread = atoi(attr->value);
                else if (!strcmp(attr->name, "total"))
                        total = atoi(attr->value);
+               else if (!strcmp(attr->name, "no_sub"))
+                       no_sub = *attr->value == '1' ? TRUE : FALSE;
+               else if (!strcmp(attr->name, "no_select"))
+                       no_select = *attr->value == '1' ? TRUE : FALSE;
+               else if (!strcmp(attr->name, "collapsed"))
+                       collapsed = *attr->value == '1' ? TRUE : FALSE;
        }
 
        item = folder_item_new(name, path);
@@ -1066,6 +1112,9 @@ static gboolean folder_build_tree(GNode *node, gpointer data)
        item->new = new;
        item->unread = unread;
        item->total = total;
+       item->no_sub = no_sub;
+       item->no_select = no_select;
+       item->collapsed = collapsed;
        item->parent = FOLDER_ITEM(node->parent->data);
        item->folder = folder;
        switch (stype) {
@@ -1075,6 +1124,7 @@ static gboolean folder_build_tree(GNode *node, gpointer data)
        case F_QUEUE:  folder->queue  = item; break;
        case F_TRASH:  folder->trash  = item; break;
        default:
+               break;
        }
 
        prefs_folder_item_read_config(item);
@@ -1094,6 +1144,7 @@ static gboolean folder_read_folder_func(GNode *node, gpointer data)
        const gchar *name = NULL;
        const gchar *path = NULL;
        PrefsAccount *account = NULL;
+       gboolean collapsed = FALSE;
 
        if (g_node_depth(node) != 2) return FALSE;
        g_return_val_if_fail(node->data != NULL, FALSE);
@@ -1129,6 +1180,9 @@ static gboolean folder_read_folder_func(GNode *node, gpointer data)
                        if (!account) g_warning("account_id: %s not found\n",
                                                attr->value);
                }
+               else if (!strcmp(attr->name, "collapsed")) {
+                       collapsed = *(attr->value) == '1' ? 1 : 0;
+               }
        }
 
        folder = folder_new(type, name, path);
@@ -1136,14 +1190,23 @@ static gboolean folder_read_folder_func(GNode *node, gpointer data)
        folder->account = account;
        if (account && (type == F_IMAP || type == F_NEWS))
                account->folder = REMOTE_FOLDER(folder);
+               
        node->data = folder->node->data;
        g_node_destroy(folder->node);
        folder->node = node;
+
        folder_add(folder);
 
        g_node_traverse(node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
                        folder_build_tree, folder);
 
+       /* ALFONS_NOTE: after a folder_new() the folder system also created a 
+        * FolderItem for the folder (which makes insertion in the GtkCTree
+        * easier because it deals with FolderItems only). put the collapsed
+        * state for this Folder in its associated FolderItem */
+
+       FOLDER_ITEM((folder->node->data))->collapsed = collapsed; 
+
        return FALSE;
 }
 
@@ -1191,6 +1254,13 @@ static void folder_write_list_recursive(GNode *node, gpointer data)
                if (folder->account)
                        fprintf(fp, " account_id=\"%d\"",
                                folder->account->account_id);
+                               
+               /* ALFONS_NOTE: for each Folder structure, also a FolderItem is created;
+                * this is very clever, but undocumented. (it is clever because the
+                * folderview's GtkCTree only deals with FolderItems.) */
+               if (item->collapsed )
+                       fprintf(fp, " collapsed=\"1\"");
+               
        } else {
                fprintf(fp, "<folderitem type=\"%s\"",
                        folder_item_stype_str[item->stype]);
@@ -1205,8 +1275,14 @@ static void folder_write_list_recursive(GNode *node, gpointer data)
                        fputs("\"", fp);
                }
                if (item->account)
-                       fprintf(fp, " account_id = \"%d\"",
+                       fprintf(fp, " account_id=\"%d\"",
                                item->account->account_id);
+               if (item->no_sub)
+                       fputs(" no_sub=\"1\"", fp);
+               if (item->no_select)
+                       fputs(" no_select=\"1\"", fp);
+               if (item->collapsed) 
+                       fputs(" collapsed=\"1\"", fp);
                fprintf(fp,
                        " mtime=\"%ld\" new=\"%d\" unread=\"%d\" total=\"%d\"",
                        item->mtime, item->new, item->unread, item->total);
@@ -1231,3 +1307,153 @@ static void folder_write_list_recursive(GNode *node, gpointer data)
        } else
                fputs(" />\n", fp);
 }
+
+typedef struct _type_str {
+       gchar * str;
+       gint type;
+} type_str;
+
+
+static type_str type_str_table[] = 
+{
+       {"#mh", F_MH},
+       {"#mbox", F_MBOX},
+       {"#maildir", F_MAILDIR},
+       {"#imap", F_IMAP},
+       {"#news", F_NEWS}
+};
+
+
+static gchar * folder_get_type_string(gint type)
+{
+       gint i;
+
+       for(i = 0 ; i < sizeof(type_str_table) / sizeof(type_str) ; i++) {
+               if (type_str_table[i].type == type)
+                       return type_str_table[i].str;
+       }
+       return NULL;
+}
+
+static gint folder_get_type_from_string(gchar * str)
+{
+       gint i;
+
+       for(i = 0 ; i < sizeof(type_str_table) / sizeof(type_str) ; i++) {
+               if (g_strcasecmp(type_str_table[i].str, str))
+                       return type_str_table[i].type;
+       }
+       return F_UNKNOWN;
+}
+
+gchar * folder_get_identifier(Folder * folder)
+{
+       gchar * type_str;
+       type_str = folder_get_type_string(folder->type);
+
+       return g_strconcat(type_str, "/", folder->name, NULL);
+}
+
+/*
+static gchar * folder_item_get_tree_identifier(FolderItem * item)
+{
+       if (item->parent != NULL) {
+               gchar * path;
+               gchar * id;
+
+               path = folder_item_get_tree_identifier(item->parent);
+               if (path == NULL)
+                       return NULL;
+
+               id = g_strconcat(path, "/", item->name, NULL);
+               g_free(path);
+
+               return id;
+       }
+       else {
+               return g_strconcat("/", item->name, NULL);
+       }
+}
+*/
+
+gchar * folder_item_get_identifier(FolderItem * item)
+{
+       gchar * path;
+       gchar * id;
+       gchar * folder_str;
+
+       folder_str = folder_get_identifier(item->folder);
+
+       if (item->path == NULL) {
+               g_free(folder_str);
+               return NULL;
+       }
+
+       id = g_strconcat(folder_str, "/", item->path, NULL);
+
+       return id;
+}
+
+Folder * folder_find_from_name(const gchar * name)
+{
+       GList *list;
+       Folder *folder;
+
+       for (list = g_list_first(folder_list); list != NULL;
+            list = list->next) {
+               folder = list->data;
+               if (strcmp(name, folder->name) == 0)
+                       return folder;
+       }
+       return NULL;
+}
+
+FolderItem * folder_find_item_from_identifier(const gchar *identifier)
+{
+       Folder *folder;
+       gpointer d[2];
+       gchar * str;
+       gchar * p;
+       gint type;
+       gchar * name;
+       gchar * path;
+
+       Xalloca(str, strlen(identifier) + 1, return NULL);
+       strcpy(str, identifier);
+
+       /* extract box type */
+
+       p = strchr(str, '/');
+
+       if (p == NULL)
+               return NULL;
+
+       *p = '\0';
+
+       type = folder_get_type_from_string(str);
+
+       str = p + 1;
+
+       /* extract box name */
+
+       p = strchr(str, '/');
+
+       if (p == NULL)
+               return NULL;
+
+       *p = '\0';
+
+       name = str;
+
+       folder = folder_find_from_name(name);
+       if (folder == NULL)
+               return;
+
+       path = p + 1;
+
+       d[0] = (gpointer)path;
+       d[1] = NULL;
+       g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
+                       folder_item_find_func, d);
+       return d[1];
+}