2 * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2020 the Claws Mail team and Hiroyuki Yamamoto
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include <glib/gi18n.h>
23 #include <gdk/gdkkeysyms.h>
29 #include <sys/types.h>
36 #include "stock_pixmap.h"
37 #include "foldersel.h"
38 #include "alertpanel.h"
39 #include "manage_window.h"
40 #include "folderview.h"
41 #include "inputdialog.h"
43 #include "prefs_common.h"
49 FOLDERSEL_PIXBUF_OPEN,
55 typedef struct _FolderItemSearch FolderItemSearch;
57 struct _FolderItemSearch
64 static GdkPixbuf *folder_pixbuf = NULL;
65 static GdkPixbuf *folderopen_pixbuf = NULL;
66 static GdkPixbuf *foldernoselect_pixbuf = NULL;
67 static GdkPixbuf *foldernoselectopen_pixbuf = NULL;
69 static GtkWidget *window;
70 static GtkWidget *treeview;
71 static GtkWidget *statusbar;
72 static gint statusbar_cid;
73 static GtkWidget *ok_button;
74 static GtkWidget *cancel_button;
75 static GtkWidget *new_button;
76 static gboolean root_selectable;
78 static FolderItem *folder_item;
79 static FolderItem *selected_item;
81 static GtkTreeStore *tree_store;
83 static gboolean cancelled;
84 static gboolean finished;
86 static void foldersel_create (const gchar *title);
87 static void foldersel_init (void);
89 static void foldersel_append_item (GtkTreeStore *store,
94 static void foldersel_set_tree (Folder *cur_folder,
95 FolderSelectionType type);
97 static gboolean foldersel_selected (GtkTreeSelection *selection,
100 gboolean currently_selected,
103 static void foldersel_ok (GtkButton *button,
105 static void foldersel_cancel (GtkButton *button,
107 static void foldersel_new_folder (GtkButton *button,
110 static void foldersel_entry_activated (GtkEntry *entry,
113 static void foldersel_tree_activated (GtkTreeView *treeview,
115 GtkTreeViewColumn *column,
118 static gint delete_event (GtkWidget *widget,
121 static gboolean key_pressed (GtkWidget *widget,
125 static gint foldersel_folder_name_compare (GtkTreeModel *model,
130 static gboolean tree_view_folder_item_func (GtkTreeModel *model,
133 FolderItemSearch *data);
135 FolderItem *foldersel_folder_sel(Folder *cur_folder, FolderSelectionType type,
136 const gchar *default_folder, gboolean can_sel_mailbox,
139 selected_item = NULL;
140 root_selectable = can_sel_mailbox;
143 foldersel_create(title);
147 foldersel_set_tree(cur_folder, type);
151 FolderItemSearch fis;
153 fis.item = folder_item;
156 /* find matching model entry */
157 gtk_tree_model_foreach
158 (GTK_TREE_MODEL(tree_store),
159 (GtkTreeModelForeachFunc)tree_view_folder_item_func,
163 GtkTreeSelection *selection;
165 selection = gtk_tree_view_get_selection
166 (GTK_TREE_VIEW(treeview));
167 gtk_tree_selection_select_iter(selection, &fis.iter);
168 gtk_tree_view_set_cursor(GTK_TREE_VIEW(treeview),
169 fis.path, NULL, FALSE);
170 gtk_tree_view_scroll_to_cell(GTK_TREE_VIEW(treeview),
172 NULL, TRUE, 0.5, 0.0);
173 gtk_tree_path_free(fis.path);
175 gtk_tree_view_scroll_to_point
176 (GTK_TREE_VIEW(treeview), 0, 0);
178 gtk_tree_view_scroll_to_point(GTK_TREE_VIEW(treeview), 0, 0);
180 gtk_widget_grab_focus(ok_button);
181 gtk_widget_grab_focus(treeview);
183 gtk_window_present(GTK_WINDOW(window));
184 manage_window_set_transient(GTK_WINDOW(window));
185 gtk_window_set_modal(GTK_WINDOW(window), TRUE);
187 cancelled = finished = FALSE;
189 while (finished == FALSE)
190 gtk_main_iteration();
192 gtk_widget_destroy(window);
196 selected_item && (selected_item->path || root_selectable)) {
197 folder_item = selected_item;
203 static gboolean foldersel_search_name_func(GtkTreeModel *model, gint column,
204 const gchar *key, GtkTreeIter *iter, gpointer search_data)
206 gchar *store_string = NULL;
210 if (column == FOLDERSEL_FOLDERNAME) {
211 /* get the name of the FolderItem, not the displayed string */
212 gtk_tree_model_get(model, iter,
213 FOLDERSEL_FOLDERITEM, &item, -1);
214 store_string = folder_item_get_name(item);
216 gtk_tree_model_get(model, iter, column, &store_string, -1);
219 if (!store_string || !key)
222 retval = (strcasestr(store_string, key) == NULL);
224 g_free(store_string);
229 static void foldersel_size_allocate_cb(GtkWidget *widget,
230 GtkAllocation *allocation)
232 cm_return_if_fail(allocation != NULL);
234 prefs_common.folderselwin_width = allocation->width;
235 prefs_common.folderselwin_height = allocation->height;
238 static void foldersel_create(const gchar *title)
241 GtkWidget *scrolledwin;
242 GtkWidget *confirm_area;
244 GtkTreeViewColumn *column;
245 GtkCellRenderer *renderer;
246 GtkTreeSelection *selection;
247 static GdkGeometry geometry;
249 window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "foldersel");
250 gtk_window_set_title(GTK_WINDOW(window),_("Select folder"));
251 gtk_container_set_border_width(GTK_CONTAINER(window), 4);
252 gtk_window_set_position(GTK_WINDOW(window), GTK_WIN_POS_CENTER);
253 gtk_window_set_resizable(GTK_WINDOW(window), TRUE);
254 gtk_window_set_type_hint(GTK_WINDOW(window), GDK_WINDOW_TYPE_HINT_DIALOG);
256 gtk_widget_realize(window);
257 g_signal_connect(G_OBJECT(window), "delete_event",
258 G_CALLBACK(delete_event), NULL);
259 g_signal_connect(G_OBJECT(window), "key_press_event",
260 G_CALLBACK(key_pressed), NULL);
261 g_signal_connect(G_OBJECT(window), "size_allocate",
262 G_CALLBACK(foldersel_size_allocate_cb), NULL);
263 MANAGE_WINDOW_SIGNALS_CONNECT(window);
265 vbox = gtk_vbox_new(FALSE, 4);
266 gtk_container_add(GTK_CONTAINER(window), vbox);
269 label = gtk_label_new(title);
270 gtk_label_set_line_wrap(GTK_LABEL(label), TRUE);
271 gtk_box_pack_start(GTK_BOX(vbox), label, FALSE, FALSE, 0);
274 scrolledwin = gtk_scrolled_window_new(NULL, NULL);
275 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolledwin),
276 GTK_POLICY_AUTOMATIC, GTK_POLICY_ALWAYS);
277 gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(scrolledwin),
279 gtk_box_pack_start(GTK_BOX(vbox), scrolledwin, TRUE, TRUE, 0);
281 tree_store = gtk_tree_store_new(N_FOLDERSEL_COLUMNS,
288 gtk_tree_sortable_set_sort_func(GTK_TREE_SORTABLE(tree_store),
289 FOLDERSEL_FOLDERNAME,
290 foldersel_folder_name_compare,
293 treeview = gtk_tree_view_new_with_model(GTK_TREE_MODEL(tree_store));
294 g_object_unref(G_OBJECT(tree_store));
295 gtk_tree_view_set_headers_visible(GTK_TREE_VIEW(treeview), FALSE);
296 gtk_tree_view_set_rules_hint(GTK_TREE_VIEW(treeview),
297 prefs_common.use_stripes_everywhere);
298 gtk_tree_view_set_enable_tree_lines(GTK_TREE_VIEW(treeview), FALSE);
299 gtk_tree_view_set_search_column(GTK_TREE_VIEW(treeview),
300 FOLDERSEL_FOLDERNAME);
301 if (prefs_common.folder_search_wildcard)
302 gtk_tree_view_set_search_equal_func(GTK_TREE_VIEW(treeview),
303 foldersel_search_name_func, NULL, NULL);
305 selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(treeview));
306 gtk_tree_selection_set_mode(selection, GTK_SELECTION_BROWSE);
307 gtk_tree_selection_set_select_function(selection, foldersel_selected,
310 g_signal_connect(G_OBJECT(treeview), "row-activated",
311 G_CALLBACK(foldersel_tree_activated), NULL);
312 gtk_container_add(GTK_CONTAINER(scrolledwin), treeview);
314 column = gtk_tree_view_column_new();
315 gtk_tree_view_column_set_spacing(column, 2);
316 renderer = gtk_cell_renderer_pixbuf_new();
317 gtk_tree_view_column_pack_start(column, renderer, FALSE);
318 gtk_tree_view_column_set_attributes
320 "pixbuf", FOLDERSEL_PIXBUF,
321 "pixbuf-expander-open", FOLDERSEL_PIXBUF_OPEN,
322 "pixbuf-expander-closed", FOLDERSEL_PIXBUF,
325 /* create text renderer */
326 renderer = gtk_cell_renderer_text_new();
327 gtk_cell_renderer_set_padding(renderer, 0, 0);
328 gtk_tree_view_column_pack_start(column, renderer, TRUE);
329 gtk_tree_view_column_set_attributes
331 "text", FOLDERSEL_FOLDERNAME,
332 "foreground-gdk", FOLDERSEL_FOREGROUND,
333 "weight", FOLDERSEL_BOLD,
335 g_object_set(G_OBJECT(renderer), "weight", PANGO_WEIGHT_BOLD, NULL);
336 gtk_tree_view_column_set_sizing(column, GTK_TREE_VIEW_COLUMN_AUTOSIZE);
338 gtk_tree_view_append_column(GTK_TREE_VIEW(treeview), column);
340 statusbar = gtk_statusbar_new();
341 statusbar_cid = gtk_statusbar_get_context_id(
342 GTK_STATUSBAR(statusbar), "Select Folder Dialog" );
343 gtk_box_pack_start(GTK_BOX(vbox), statusbar, FALSE, FALSE, 0);
344 g_signal_connect(G_OBJECT(statusbar), "activate",
345 G_CALLBACK(foldersel_entry_activated), NULL);
347 gtkut_stock_button_set_create(&confirm_area,
348 &new_button, GTK_STOCK_NEW,
349 &cancel_button, GTK_STOCK_CANCEL,
350 &ok_button, GTK_STOCK_OK);
352 gtk_box_pack_end(GTK_BOX(vbox), confirm_area, FALSE, FALSE, 0);
353 gtk_widget_grab_default(ok_button);
355 g_signal_connect(G_OBJECT(ok_button), "clicked",
356 G_CALLBACK(foldersel_ok), NULL);
357 g_signal_connect(G_OBJECT(cancel_button), "clicked",
358 G_CALLBACK(foldersel_cancel), NULL);
359 g_signal_connect(G_OBJECT(new_button), "clicked",
360 G_CALLBACK(foldersel_new_folder), NULL);
362 if (!geometry.min_height) {
363 geometry.min_width = 300;
364 geometry.min_height = 360;
367 gtk_window_set_geometry_hints(GTK_WINDOW(window), NULL, &geometry,
369 gtk_widget_set_size_request(window, prefs_common.folderselwin_width,
370 prefs_common.folderselwin_height);
372 gtk_widget_show_all(vbox);
375 static void foldersel_init(void)
377 stock_pixbuf_gdk(STOCK_PIXMAP_DIR_CLOSE, &folder_pixbuf);
378 stock_pixbuf_gdk(STOCK_PIXMAP_DIR_OPEN, &folderopen_pixbuf);
379 stock_pixbuf_gdk(STOCK_PIXMAP_DIR_NOSELECT_CLOSE, &foldernoselect_pixbuf);
380 stock_pixbuf_gdk(STOCK_PIXMAP_DIR_NOSELECT_OPEN, &foldernoselectopen_pixbuf);
383 void foldersel_reflect_prefs_pixmap_theme(void)
386 g_object_unref(folder_pixbuf);
387 if (folderopen_pixbuf)
388 g_object_unref(folderopen_pixbuf);
389 if (foldernoselect_pixbuf)
390 g_object_unref(foldernoselect_pixbuf);
391 if (foldernoselectopen_pixbuf)
392 g_object_unref(foldernoselectopen_pixbuf);
396 static void foldersel_append_item(GtkTreeStore *store, FolderItem *item,
397 GtkTreeIter *iter, GtkTreeIter *parent)
399 gchar *name, *tmpname;
400 GdkPixbuf *pixbuf, *pixbuf_open;
402 PangoWeight weight = PANGO_WEIGHT_NORMAL;
403 GdkColor *foreground = NULL;
404 static GdkColor color_noselect = {0, COLOR_DIM, COLOR_DIM, COLOR_DIM};
405 static GdkColor color_new;
407 gtkut_convert_int_to_gdk_color(prefs_common.color[COL_NEW], &color_new);
409 name = folder_item_get_name(item);
411 if (folder_has_parent_of_type(item, F_QUEUE) && item->total_msgs > 0) {
412 tmpname = g_strdup_printf("%s (%d)", name, item->total_msgs);
413 } else if (item->unread_msgs > 0) {
414 tmpname = g_strdup_printf("%s (%d)", name, item->unread_msgs);
416 tmpname = g_strdup(name);
421 pixbuf = item->no_select ? foldernoselect_pixbuf : folder_pixbuf;
423 item->no_select ? foldernoselectopen_pixbuf : folderopen_pixbuf;
425 if (folder_has_parent_of_type(item, F_DRAFT) ||
426 folder_has_parent_of_type(item, F_OUTBOX) ||
427 folder_has_parent_of_type(item, F_TRASH)) {
429 } else if (folder_has_parent_of_type(item, F_QUEUE)) {
430 use_color = (item->total_msgs > 0);
431 if (item->total_msgs > 0)
432 weight = PANGO_WEIGHT_BOLD;
434 if (item->unread_msgs > 0)
435 weight = PANGO_WEIGHT_BOLD;
436 use_color = (item->new_msgs > 0);
440 foreground = &color_noselect;
442 foreground = &color_new;
444 /* insert this node */
445 gtk_tree_store_append(store, iter, parent);
446 gtk_tree_store_set(store, iter,
447 FOLDERSEL_FOLDERNAME, name,
448 FOLDERSEL_FOLDERITEM, item,
449 FOLDERSEL_PIXBUF, pixbuf,
450 FOLDERSEL_PIXBUF_OPEN, pixbuf_open,
451 FOLDERSEL_FOREGROUND, foreground,
452 FOLDERSEL_BOLD, weight,
458 static void foldersel_insert_gnode_in_store(GtkTreeStore *store, GNode *node,
465 cm_return_if_fail(node != NULL);
466 cm_return_if_fail(node->data != NULL);
467 cm_return_if_fail(store != NULL);
469 item = FOLDER_ITEM(node->data);
470 foldersel_append_item(store, item, &child, parent);
472 /* insert its children (this node as parent) */
473 for (iter = node->children; iter != NULL; iter = iter->next)
474 foldersel_insert_gnode_in_store(store, iter, &child);
477 static void foldersel_set_tree(Folder *cur_folder, FolderSelectionType type)
482 for (list = folder_get_list(); list != NULL; list = list->next) {
483 folder = FOLDER(list->data);
484 cm_return_if_fail(folder != NULL);
486 if (type != FOLDER_SEL_ALL) {
487 if (FOLDER_TYPE(folder) == F_NEWS)
491 if (cur_folder && (cur_folder->klass != folder->klass
492 && g_strcmp0(cur_folder->name, folder->name) != 0))
495 foldersel_insert_gnode_in_store(tree_store, folder->node, NULL);
498 gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(tree_store),
499 FOLDERSEL_FOLDERNAME,
502 gtk_tree_view_expand_all(GTK_TREE_VIEW(treeview));
505 #include "localfolder.h"
506 static gboolean foldersel_selected(GtkTreeSelection *selection,
507 GtkTreeModel *model, GtkTreePath *path,
508 gboolean currently_selected, gpointer data)
511 FolderItem *item = NULL;
513 if (currently_selected)
516 if (!gtk_tree_model_get_iter(GTK_TREE_MODEL(model), &iter, path))
519 gtk_tree_model_get(GTK_TREE_MODEL(tree_store), &iter,
520 FOLDERSEL_FOLDERITEM, &item, -1);
522 selected_item = item;
523 if (selected_item && selected_item->path) {
525 id = folder_item_get_identifier(selected_item);
526 gtk_statusbar_push(GTK_STATUSBAR(statusbar), statusbar_cid, id);
528 } else if (root_selectable && selected_item && selected_item->folder &&
529 (FOLDER_TYPE(selected_item->folder) == F_MH ||
530 FOLDER_TYPE(selected_item->folder) == F_MBOX ||
531 FOLDER_TYPE(selected_item->folder) == F_IMAP)) {
532 gchar *id = folder_get_identifier(selected_item->folder);
533 gtk_statusbar_push(GTK_STATUSBAR(statusbar), statusbar_cid, id);
536 gtk_statusbar_push(GTK_STATUSBAR(statusbar), statusbar_cid, "");
541 static void foldersel_ok(GtkButton *button, gpointer data)
546 static void foldersel_cancel(GtkButton *button, gpointer data)
552 static void foldersel_new_folder(GtkButton *button, gpointer data)
554 FolderItem *new_item;
558 GtkTreeIter selected, new_child;
559 GtkTreePath *selected_p, *new_child_p;
562 GtkTreeSelection *selection;
564 if (!selected_item || FOLDER_TYPE(selected_item->folder) == F_NEWS)
567 selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(treeview));
568 if (!gtk_tree_selection_get_selected(selection, &model, &selected))
570 store = GTK_TREE_STORE(model);
572 new_folder = input_dialog(_("New folder"),
573 _("Input the name of new folder:"),
575 if (!new_folder) return;
576 AUTORELEASE_STR(new_folder, {g_free(new_folder); return;});
578 p = strchr(new_folder, G_DIR_SEPARATOR);
579 if ((p && FOLDER_TYPE(selected_item->folder) != F_IMAP) ||
580 (p && FOLDER_TYPE(selected_item->folder) == F_IMAP &&
582 alertpanel_error(_("'%c' can't be included in folder name."),
587 if (FOLDER_TYPE(selected_item->folder) != F_IMAP &&
588 FOLDER_TYPE(selected_item->folder) != F_NEWS &&
589 !folder_local_name_ok(new_folder))
592 disp_name = trim_string(new_folder, 32);
593 AUTORELEASE_STR(disp_name, {g_free(disp_name); return;});
595 /* find whether the directory already exists */
596 if (folder_find_child_item_by_name(selected_item, new_folder)) {
597 alertpanel_error(_("The folder '%s' already exists."),
602 new_item = folder_create_folder(selected_item, new_folder);
604 alertpanel_error(_("Can't create the folder '%s'."), disp_name);
609 foldersel_append_item(store, new_item, &new_child, &selected);
611 selected_p = gtk_tree_model_get_path(GTK_TREE_MODEL(store), &selected);
612 new_child_p = gtk_tree_model_get_path(GTK_TREE_MODEL(store),
615 gtk_tree_view_expand_row(GTK_TREE_VIEW(treeview), selected_p, FALSE);
616 gtk_tree_selection_select_iter(selection, &new_child);
617 gtk_tree_view_scroll_to_cell(GTK_TREE_VIEW(treeview), new_child_p,
618 NULL, TRUE, 0.5, 0.0);
619 gtk_tree_path_free(new_child_p);
620 gtk_tree_path_free(selected_p);
625 static void foldersel_entry_activated(GtkEntry *entry, gpointer data)
627 gtk_button_clicked(GTK_BUTTON(ok_button));
630 static void foldersel_tree_activated(GtkTreeView *treeview, GtkTreePath *path,
631 GtkTreeViewColumn *column, gpointer data)
633 gtk_button_clicked(GTK_BUTTON(ok_button));
636 static gint delete_event(GtkWidget *widget, GdkEventAny *event, gpointer data)
638 foldersel_cancel(NULL, NULL);
642 static gboolean key_pressed(GtkWidget *widget, GdkEventKey *event, gpointer data)
647 if (event->keyval == GDK_KEY_Escape) {
648 foldersel_cancel(NULL, NULL);
652 GtkTreePath *path = NULL;
653 gtk_tree_view_get_cursor(GTK_TREE_VIEW(treeview), &path, NULL);
657 switch (event->keyval) {
659 if (gtk_tree_view_row_expanded(GTK_TREE_VIEW(treeview), path)) {
660 gtk_tree_view_collapse_row(GTK_TREE_VIEW(treeview), path);
662 gtk_tree_path_up(path);
663 gtk_tree_view_set_cursor(GTK_TREE_VIEW(treeview), path, NULL, FALSE);
668 if (!gtk_tree_view_row_expanded(GTK_TREE_VIEW(treeview), path)) {
669 gtk_tree_view_expand_row(GTK_TREE_VIEW(treeview), path, FALSE);
671 gtk_tree_path_down(path);
672 gtk_tree_view_set_cursor(GTK_TREE_VIEW(treeview), path, NULL, FALSE);
678 gtk_tree_path_free(path);
683 static gint foldersel_folder_name_compare(GtkTreeModel *model, GtkTreeIter *a,
684 GtkTreeIter *b, gpointer context)
686 gchar *str_a = NULL, *str_b = NULL;
688 FolderItem *item_a = NULL, *item_b = NULL;
691 gtk_tree_model_get(model, a, FOLDERSEL_FOLDERITEM, &item_a, -1);
692 gtk_tree_model_get(model, b, FOLDERSEL_FOLDERITEM, &item_b, -1);
694 /* no sort for root folder */
695 if (!gtk_tree_model_iter_parent(GTK_TREE_MODEL(model), &parent, a))
698 /* if both a and b are special folders, sort them according to
699 * their types (which is in-order). Note that this assumes that
700 * there are no multiple folders of a special type. */
701 if (item_a->stype != F_NORMAL && item_b->stype != F_NORMAL)
702 return item_a->stype - item_b->stype;
704 /* if b is normal folder, and a is not, b is smaller (ends up
705 * lower in the list) */
706 if (item_a->stype != F_NORMAL && item_b->stype == F_NORMAL)
707 return item_b->stype - item_a->stype;
709 /* if b is special folder, and a is not, b is larger (ends up
710 * higher in the list) */
711 if (item_a->stype == F_NORMAL && item_b->stype != F_NORMAL)
712 return item_b->stype - item_a->stype;
714 /* XXX g_utf8_collate_key() comparisons may speed things
715 * up when having large lists of folders */
716 gtk_tree_model_get(model, a, FOLDERSEL_FOLDERNAME, &str_a, -1);
717 gtk_tree_model_get(model, b, FOLDERSEL_FOLDERNAME, &str_b, -1);
719 /* otherwise just compare the folder names */
720 val = g_utf8_collate(str_a, str_b);
728 static gboolean tree_view_folder_item_func(GtkTreeModel *model,
731 FolderItemSearch *data)
733 FolderItem *item = NULL;
735 gtk_tree_model_get(model, iter, FOLDERSEL_FOLDERITEM, &item, -1);
737 if (data->item == item) {
738 data->path = gtk_tree_path_copy(path);