2 * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2004-2015 the Claws Mail team
4 * Copyright (C) 2014-2015 Charles Lehner
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include "claws-features.h"
28 #include <glib/gi18n.h>
31 #include "gtk/gtkutils.h"
32 #include "gtk/combobox.h"
33 #include "gtk/inputdialog.h"
34 #include "gtk/manage_window.h"
35 #include "alertpanel.h"
39 #include "mainwindow.h"
40 #include "managesieve.h"
41 #include "sieve_editor.h"
42 #include "sieve_prefs.h"
43 #include "sieve_manager.h"
52 SieveManagerPage *page;
58 SieveManagerPage *page;
62 static void filter_got_load_error(SieveSession *session, gpointer data);
63 static void account_changed(GtkWidget *widget, SieveManagerPage *page);
64 static void sieve_manager_close(GtkWidget *widget, SieveManagerPage *page);
65 static gboolean sieve_manager_deleted(GtkWidget *widget, GdkEvent *event,
66 SieveManagerPage *page);
67 static void filter_set_active(SieveManagerPage *page, gchar *filter_name);
68 gboolean filter_find_by_name (GtkTreeModel *model, GtkTreeIter *iter,
70 static void got_session_error(SieveSession *session, const gchar *msg,
71 SieveManagerPage *page);
73 static GSList *manager_pages = NULL;
76 * Perform a command on all manager pages for a given session
78 #define manager_sessions_foreach(cur, session, page) \
79 for(cur = manager_pages; cur != NULL; cur = cur->next) \
80 if ((page = (SieveManagerPage *)cur->data) && \
81 page->active_session == session)
83 static void filters_list_clear(SieveManagerPage *page)
85 GtkListStore *list_store = GTK_LIST_STORE(gtk_tree_view_get_model(GTK_TREE_VIEW(page->filters_list)));
86 gtk_list_store_clear(list_store);
87 page->got_list = FALSE;
90 static void filters_list_delete_filter(SieveManagerPage *page, gchar *name)
93 GtkTreeModel *model = gtk_tree_view_get_model(GTK_TREE_VIEW(page->filters_list));
95 if (!filter_find_by_name(model, &iter, name))
98 gtk_list_store_remove(GTK_LIST_STORE(model), &iter);
102 static void filters_list_rename_filter(SieveManagerPage *page,
103 gchar *name_old, char *name_new)
106 GtkTreeModel *model = gtk_tree_view_get_model(GTK_TREE_VIEW(page->filters_list));
108 if (!filter_find_by_name(model, &iter, name_old))
111 gtk_list_store_set(GTK_LIST_STORE(model), &iter,
112 FILTER_NAME, name_new,
116 static void filters_list_insert_filter(SieveManagerPage *page,
119 GtkListStore *list_store = GTK_LIST_STORE(gtk_tree_view_get_model(GTK_TREE_VIEW(page->filters_list)));
122 gtk_list_store_append(list_store, &iter);
123 gtk_list_store_set(list_store, &iter,
124 FILTER_NAME, filter->name,
125 FILTER_ACTIVE, filter->active,
129 static gchar *filters_list_get_selected_filter(GtkWidget *list_view)
131 GtkTreeSelection *selector;
136 selector = gtk_tree_view_get_selection(GTK_TREE_VIEW(list_view));
138 if (!gtk_tree_selection_get_selected(selector, &model, &iter))
141 gtk_tree_model_get(model, &iter, FILTER_NAME, &res, -1);
146 static void filter_add(GtkWidget *widget, SieveManagerPage *page)
148 SieveSession *session = page->active_session;
149 SieveEditorPage *editor;
152 gchar *filter_name = input_dialog(_("Add Sieve script"),
153 _("Enter name for a new Sieve filter script."), "");
154 if (!filter_name || !filter_name[0])
157 editor = sieve_editor_get(session, filter_name);
159 /* TODO: show error that filter already exists */
160 sieve_editor_present(editor);
162 sieve_editor_load(editor,
163 (sieve_session_cb_fn)filter_got_load_error, page);
165 editor = sieve_editor_new(session, filter_name);
166 editor->is_new = TRUE;
167 sieve_editor_show(editor);
171 static void filter_got_load_error(SieveSession *session, gpointer data)
173 SieveManagerPage *page = data;
175 got_session_error(session, _("Unable to get script contents"), page);
178 static void filter_edit(GtkWidget *widget, SieveManagerPage *page)
180 SieveEditorPage *editor;
181 SieveSession *session = page->active_session;
186 gchar *filter_name = filters_list_get_selected_filter(page->filters_list);
190 editor = sieve_editor_get(session, filter_name);
192 sieve_editor_present(editor);
194 editor = sieve_editor_new(session, filter_name);
195 sieve_editor_load(editor,
196 (sieve_session_cb_fn)filter_got_load_error, page);
200 static void filter_renamed(SieveSession *session, gboolean abort,
201 gboolean success, CommandDataRename *data)
203 SieveManagerPage *page = data->page;
207 } else if (!success) {
208 got_session_error(session, "Unable to rename script", page);
210 manager_sessions_foreach(cur, session, page) {
211 filters_list_rename_filter(page, data->name_old,
215 g_free(data->name_old);
216 g_free(data->name_new);
220 static void filter_rename(GtkWidget *widget, SieveManagerPage *page)
222 CommandDataRename *cmd_data;
223 gchar *name_old, *name_new;
224 SieveSession *session;
226 name_old = filters_list_get_selected_filter(page->filters_list);
230 session = page->active_session;
234 name_new = input_dialog(_("Add Sieve script"),
235 _("Enter new name for the script."), name_old);
239 cmd_data = g_new(CommandDataRename, 1);
240 cmd_data->name_new = name_new;
241 cmd_data->name_old = name_old;
242 cmd_data->page = page;
243 sieve_session_rename_script(session, name_old, name_new,
244 (sieve_session_data_cb_fn)filter_renamed, (gpointer)cmd_data);
247 static void filter_activated(SieveSession *session, gboolean abort,
248 gboolean success, CommandDataName *cmd_data)
250 SieveManagerPage *page = cmd_data->page;
254 } else if (!success) {
255 got_session_error(session, "Unable to set active script", page);
257 manager_sessions_foreach(cur, session, page) {
258 filter_set_active(page, cmd_data->filter_name);
261 g_free(cmd_data->filter_name);
265 static void sieve_set_active_filter(SieveManagerPage *page, gchar *filter_name)
267 SieveSession *session;
268 CommandDataName *cmd_data;
270 session = page->active_session;
271 cmd_data = g_new(CommandDataName, 1);
272 cmd_data->filter_name = filter_name;
273 cmd_data->page = page;
275 sieve_session_set_active_script(session, filter_name,
276 (sieve_session_data_cb_fn)filter_activated, cmd_data);
279 static void filter_deleted(SieveSession *session, gboolean abort,
280 const gchar *err_msg,
281 CommandDataName *cmd_data)
283 SieveManagerPage *page = cmd_data->page;
287 } else if (err_msg) {
288 got_session_error(session, err_msg, page);
290 manager_sessions_foreach(cur, session, page) {
291 filters_list_delete_filter(page,
292 cmd_data->filter_name);
295 g_free(cmd_data->filter_name);
300 static void filter_delete(GtkWidget *widget, SieveManagerPage *page)
304 SieveSession *session;
305 CommandDataName *cmd_data;
307 filter_name = filters_list_get_selected_filter(page->filters_list);
308 if (filter_name == NULL)
311 session = page->active_session;
315 g_snprintf(buf, sizeof(buf),
316 _("Do you really want to delete the filter '%s'?"), filter_name);
317 if (alertpanel_full(_("Delete filter"), buf,
318 GTK_STOCK_CANCEL, GTK_STOCK_DELETE, NULL, FALSE,
319 NULL, ALERT_WARNING, G_ALERTDEFAULT) != G_ALERTALTERNATE)
322 cmd_data = g_new(CommandDataName, 1);
323 cmd_data->filter_name = filter_name;
324 cmd_data->page = page;
326 sieve_session_delete_script(session, filter_name,
327 (sieve_session_data_cb_fn)filter_deleted, cmd_data);
331 * select a filter in the list
333 * return TRUE is successfully selected, FALSE otherwise
336 static gboolean filter_select (GtkWidget *list_view, GtkTreeModel *model,
339 GtkTreeSelection *selection;
342 selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(list_view));
343 gtk_tree_selection_select_iter(selection, iter);
344 path = gtk_tree_model_get_path(model, iter);
345 if (path == NULL) return FALSE;
346 gtk_tree_view_set_cursor(GTK_TREE_VIEW(list_view), path, NULL, FALSE);
347 gtk_tree_path_free(path);
352 * find matching filter. return FALSE on match
354 static gboolean filter_search_equal_fn (GtkTreeModel *model, gint column,
355 const gchar *key, GtkTreeIter *iter, gpointer search_data)
357 SieveManagerPage *page = (SieveManagerPage *)search_data;
360 if (!key) return TRUE;
362 gtk_tree_model_get (model, iter, FILTER_NAME, &filter_name, -1);
364 if (strncmp (key, filter_name, strlen(key)) != 0) return TRUE;
365 return !filter_select(page->filters_list, model, iter);
369 * search for a filter row by its name. return true if found.
371 gboolean filter_find_by_name (GtkTreeModel *model, GtkTreeIter *iter,
376 if (!gtk_tree_model_get_iter_first (model, iter))
380 gtk_tree_model_get (model, iter, FILTER_NAME, &name, -1);
381 if (strcmp(filter_name, name) == 0) {
384 } while (gtk_tree_model_iter_next (model, iter));
388 static gboolean filter_set_inactive(GtkTreeModel *model,
389 GtkTreePath *path, GtkTreeIter *iter, gpointer data)
391 gtk_list_store_set(GTK_LIST_STORE(model), iter,
392 FILTER_ACTIVE, FALSE,
398 * Set the active filter in the table.
399 * @param filter_name The filter to make active (may be null)
401 static void filter_set_active(SieveManagerPage *page, gchar *filter_name)
404 GtkTreeModel *model = gtk_tree_view_get_model(GTK_TREE_VIEW(page->filters_list));
406 /* Deactivate all filters */
407 gtk_tree_model_foreach(model, filter_set_inactive, NULL);
409 /* Set active filter */
411 if (!filter_find_by_name (model, &iter, filter_name))
414 gtk_list_store_set(GTK_LIST_STORE(model), &iter,
420 static void filter_active_toggled(GtkCellRendererToggle *widget,
422 SieveManagerPage *page)
427 GtkTreeModel *model = gtk_tree_view_get_model(GTK_TREE_VIEW(page->filters_list));
429 if (!gtk_tree_model_get_iter_from_string(model, &iter, path))
432 /* get existing value */
433 gtk_tree_model_get(model, &iter,
434 FILTER_NAME, &filter_name,
435 FILTER_ACTIVE, &active,
438 sieve_set_active_filter(page, active ? NULL : filter_name);
441 static void filter_double_clicked(GtkTreeView *list_view,
442 GtkTreePath *path, GtkTreeViewColumn *column,
443 SieveManagerPage *page)
445 filter_edit(GTK_WIDGET(list_view), page);
448 static void filters_create_list_view_columns(SieveManagerPage *page,
449 GtkWidget *list_view)
451 GtkTreeViewColumn *column;
452 GtkCellRenderer *renderer;
455 renderer = gtk_cell_renderer_text_new();
456 column = gtk_tree_view_column_new_with_attributes
457 (_("Name"), renderer,
460 gtk_tree_view_append_column(GTK_TREE_VIEW(list_view), column);
461 gtk_tree_view_column_set_expand(column, TRUE);
464 renderer = gtk_cell_renderer_toggle_new();
465 g_object_set(renderer,
469 column = gtk_tree_view_column_new_with_attributes
470 (_("Active"), renderer,
471 "active", FILTER_ACTIVE,
473 gtk_tree_view_append_column(GTK_TREE_VIEW(list_view), column);
474 gtk_tree_view_column_set_alignment (column, 0.5);
475 CLAWS_SET_TIP(gtk_tree_view_column_get_widget(column),
476 _("An account can only have one active script at a time."));
477 g_signal_connect(G_OBJECT(renderer), "toggled",
478 G_CALLBACK(filter_active_toggled), page);
480 gtk_tree_view_set_search_column(GTK_TREE_VIEW(list_view), FILTER_NAME);
481 gtk_tree_view_set_search_equal_func(GTK_TREE_VIEW(list_view),
482 filter_search_equal_fn, page, NULL);
486 static GtkListStore* filters_create_data_store(void)
488 return gtk_list_store_new(N_FILTER_COLUMNS,
489 G_TYPE_STRING, /* FILTER_NAME */
490 G_TYPE_BOOLEAN, /* FILTER_ACTIVE */
494 static GtkWidget *filters_list_view_create(SieveManagerPage *page)
496 GtkTreeView *list_view;
497 GtkTreeSelection *selector;
498 GtkListStore *store = filters_create_data_store();
500 list_view = GTK_TREE_VIEW(gtk_tree_view_new_with_model(GTK_TREE_MODEL(store)));
501 g_object_unref(G_OBJECT(store));
503 selector = gtk_tree_view_get_selection(list_view);
504 gtk_tree_selection_set_mode(selector, GTK_SELECTION_BROWSE);
506 /* create the columns */
507 filters_create_list_view_columns(page, GTK_WIDGET(list_view));
509 /* set a double click listener */
510 g_signal_connect(G_OBJECT(list_view), "row_activated",
511 G_CALLBACK(filter_double_clicked),
514 return GTK_WIDGET(list_view);
517 static gboolean manager_key_pressed(GtkWidget *widget, GdkEventKey *event,
520 SieveManagerPage* page = (SieveManagerPage *) data;
522 if (event && event->keyval == GDK_KEY_Escape)
523 sieve_manager_done(page);
528 static void size_allocate_cb(GtkWidget *widget, GtkAllocation *allocation)
530 cm_return_if_fail(allocation != NULL);
532 sieve_config.manager_win_width = allocation->width;
533 sieve_config.manager_win_height = allocation->height;
536 static void got_session_error(SieveSession *session, const gchar *msg,
537 SieveManagerPage *page)
539 if (!g_slist_find(manager_pages, page))
541 if (page->active_session != session)
543 gtk_label_set_text(GTK_LABEL(page->status_text), msg);
546 static void sieve_manager_on_error(SieveSession *session,
547 const gchar *msg, gpointer user_data)
549 SieveManagerPage *page = (SieveManagerPage *)user_data;
550 got_session_error(session, msg, page);
553 static void sieve_manager_on_connected(SieveSession *session,
554 gboolean connected, gpointer user_data)
556 SieveManagerPage *page = (SieveManagerPage *)user_data;
557 if (page->active_session != session)
560 gtk_widget_set_sensitive(GTK_WIDGET(page->vbox_buttons), FALSE);
561 gtk_label_set_text(GTK_LABEL(page->status_text),
562 _("Unable to connect"));
566 static void got_filter_listed(SieveSession *session, gboolean abort,
567 SieveScript *script, SieveManagerPage *page)
572 got_session_error(session, "Unable to list scripts", page);
576 /* done receiving list */
577 page->got_list = TRUE;
578 gtk_widget_set_sensitive(GTK_WIDGET(page->vbox_buttons), TRUE);
579 gtk_label_set_text(GTK_LABEL(page->status_text), "");
582 filters_list_insert_filter(page, script);
586 * An account was selected from the menu. Get its list of scripts.
588 static void account_changed(GtkWidget *widget, SieveManagerPage *page)
591 PrefsAccount *account;
592 SieveSession *session;
594 account_id = combobox_get_active_data(GTK_COMBO_BOX(page->accounts_menu));
595 account = account_find_from_id(account_id);
598 session = page->active_session = sieve_session_get_for_account(account);
599 sieve_session_handle_status(session,
600 sieve_manager_on_error,
601 sieve_manager_on_connected,
603 filters_list_clear(page);
604 if (session_is_connected(SESSION(session))) {
605 gtk_label_set_text(GTK_LABEL(page->status_text),
606 _("Listing scripts..."));
608 gtk_label_set_text(GTK_LABEL(page->status_text),
611 sieve_session_list_scripts(session,
612 (sieve_session_data_cb_fn)got_filter_listed, (gpointer)page);
615 static SieveManagerPage *sieve_manager_page_new()
617 SieveManagerPage *page;
619 GtkWidget *hbox, *vbox, *vbox_allbuttons, *vbox_buttons;
620 GtkWidget *accounts_menu;
622 GtkWidget *scrolledwin;
623 GtkWidget *list_view;
625 GtkWidget *status_text;
628 GList *account_list, *cur;
630 SieveAccountConfig *config;
631 PrefsAccount *default_account = NULL;
633 static GdkGeometry geometry;
635 page = g_new0(SieveManagerPage, 1);
639 window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "sievemanager");
640 gtk_container_set_border_width (GTK_CONTAINER (window), 8);
641 gtk_window_set_title (GTK_WINDOW (window), _("Manage Sieve Filters"));
642 MANAGE_WINDOW_SIGNALS_CONNECT (window);
644 g_signal_connect (G_OBJECT (window), "key_press_event",
645 G_CALLBACK (manager_key_pressed), page);
646 g_signal_connect (G_OBJECT(window), "size_allocate",
647 G_CALLBACK (size_allocate_cb), NULL);
648 g_signal_connect (G_OBJECT(window), "delete_event",
649 G_CALLBACK (sieve_manager_deleted), page);
651 if (!geometry.min_height) {
652 geometry.min_width = 350;
653 geometry.min_height = 280;
656 gtk_window_set_geometry_hints(GTK_WINDOW(window), NULL, &geometry,
658 gtk_widget_set_size_request(window, sieve_config.manager_win_width,
659 sieve_config.manager_win_height);
661 vbox = gtk_vbox_new (FALSE, 10);
662 gtk_container_add (GTK_CONTAINER (window), vbox);
664 hbox = gtk_hbox_new (FALSE, 8);
665 gtk_box_pack_start (GTK_BOX (vbox), hbox, FALSE, FALSE, 0);
669 label = gtk_label_new (_("Account"));
670 gtk_box_pack_start (GTK_BOX (hbox), label, FALSE, FALSE, 0);
672 accounts_menu = gtkut_sc_combobox_create(NULL, FALSE);
673 menu = GTK_LIST_STORE(gtk_combo_box_get_model(GTK_COMBO_BOX(accounts_menu)));
674 gtk_box_pack_start (GTK_BOX (hbox), accounts_menu, FALSE, FALSE, 0);
675 g_signal_connect (G_OBJECT(accounts_menu), "changed",
676 G_CALLBACK (account_changed), page);
678 account_list = account_get_list();
679 for (cur = account_list; cur != NULL; cur = cur->next) {
680 ap = (PrefsAccount *)cur->data;
681 config = sieve_prefs_account_get_config(ap);
682 if (config->enable) {
683 COMBOBOX_ADD (menu, ap->account_name, ap->account_id);
684 if (!default_account || ap->is_default)
685 default_account = ap;
689 if (!default_account) {
690 gtk_widget_destroy(label);
691 gtk_widget_destroy(accounts_menu);
695 status_text = gtk_label_new ("");
696 gtk_box_pack_start (GTK_BOX (hbox), status_text, FALSE, FALSE, 0);
697 gtk_label_set_justify (GTK_LABEL (status_text), GTK_JUSTIFY_LEFT);
701 hbox = gtk_hbox_new (FALSE, 8);
702 gtk_box_pack_start (GTK_BOX (vbox), hbox, TRUE, TRUE, 0);
703 gtk_container_set_border_width (GTK_CONTAINER (hbox), 2);
707 scrolledwin = gtk_scrolled_window_new (NULL, NULL);
708 gtk_box_pack_start (GTK_BOX (hbox), scrolledwin, TRUE, TRUE, 0);
709 gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (scrolledwin),
710 GTK_POLICY_AUTOMATIC,
711 GTK_POLICY_AUTOMATIC);
713 list_view = filters_list_view_create(page);
714 gtk_container_add(GTK_CONTAINER(scrolledwin), list_view);
718 vbox_allbuttons = gtk_vbox_new (FALSE, 0);
719 gtk_box_pack_start (GTK_BOX (hbox), vbox_allbuttons, FALSE, FALSE, 0);
721 /* buttons that depend on there being a connection */
722 vbox_buttons = gtk_vbox_new (FALSE, 8);
723 gtk_widget_set_sensitive(vbox_buttons, FALSE);
724 gtk_box_pack_start (GTK_BOX (vbox_allbuttons), vbox_buttons, FALSE, FALSE, 0);
727 btn = gtk_button_new_from_stock(GTK_STOCK_NEW);
728 gtk_box_pack_start (GTK_BOX (vbox_buttons), btn, FALSE, FALSE, 0);
729 g_signal_connect (G_OBJECT(btn), "clicked",
730 G_CALLBACK (filter_add), page);
733 btn = gtk_button_new_from_stock (GTK_STOCK_EDIT);
734 gtk_box_pack_start (GTK_BOX (vbox_buttons), btn, FALSE, FALSE, 0);
735 g_signal_connect (G_OBJECT(btn), "clicked",
736 G_CALLBACK (filter_edit), page);
739 btn = gtk_button_new_from_stock(GTK_STOCK_DELETE);
740 gtk_box_pack_start (GTK_BOX (vbox_buttons), btn, FALSE, FALSE, 0);
741 g_signal_connect (G_OBJECT(btn), "clicked",
742 G_CALLBACK (filter_delete), page);
745 btn = gtk_button_new_with_label("Rename");
746 gtk_box_pack_start (GTK_BOX (vbox_buttons), btn, FALSE, FALSE, 0);
747 g_signal_connect (G_OBJECT(btn), "clicked",
748 G_CALLBACK (filter_rename), page);
751 btn = gtk_button_new_from_stock(GTK_STOCK_REFRESH);
752 gtk_box_pack_end (GTK_BOX (vbox_allbuttons), btn, FALSE, FALSE, 0);
753 g_signal_connect (G_OBJECT(btn), "clicked",
754 G_CALLBACK (account_changed), page);
756 /* bottom area stuff */
758 gtkut_stock_button_set_create(&hbox,
759 &btn, GTK_STOCK_CLOSE,
760 NULL, NULL, NULL, NULL);
763 gtk_box_pack_end (GTK_BOX (vbox), hbox, FALSE, FALSE, 0);
764 gtk_widget_grab_default (btn);
765 g_signal_connect (G_OBJECT (btn), "clicked",
766 G_CALLBACK (sieve_manager_close), page);
768 page->window = window;
769 page->accounts_menu = accounts_menu;
770 page->filters_list = list_view;
771 page->status_text = status_text;
772 page->vbox_buttons = vbox_buttons;
774 /* select default (first) account */
775 if (default_account) {
776 combobox_select_by_data(GTK_COMBO_BOX(accounts_menu),
777 default_account->account_id);
779 gtk_label_set_text(GTK_LABEL(status_text),
780 _("To use Sieve, enable it in an account's preferences."));
786 static gboolean sieve_manager_deleted(GtkWidget *widget, GdkEvent *event,
787 SieveManagerPage *page)
789 sieve_manager_done(page);
793 static void sieve_manager_close(GtkWidget *widget, SieveManagerPage *page)
795 sieve_manager_done(page);
798 void sieve_manager_done(SieveManagerPage *page)
800 manager_pages = g_slist_remove(manager_pages, page);
801 sieve_sessions_discard_callbacks(page);
802 gtk_widget_destroy(page->window);
806 void sieve_manager_show()
808 SieveManagerPage *page = sieve_manager_page_new();
809 manager_pages = g_slist_prepend(manager_pages, page);
810 gtk_widget_show_all(page->window);
813 void sieve_manager_script_created(SieveSession *session, const gchar *name)
815 SieveManagerPage *page;
816 SieveScript script = {.name = (gchar *)name};
819 manager_sessions_foreach(cur, session, page) {
820 filters_list_insert_filter(page, &script);