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;
63 SieveManagerPage *page;
65 SieveEditorPage *editor_page;
67 } CommandDataGetScript;
69 static void account_changed(GtkWidget *widget, SieveManagerPage *page);
70 void sieve_manager_close(GtkWidget *widget, SieveManagerPage *page);
71 static void filter_set_active(SieveManagerPage *page, gchar *filter_name);
72 gboolean filter_find_by_name (GtkTreeModel *model, GtkTreeIter *iter,
74 static void got_session_error(SieveSession *session, const gchar *msg,
75 SieveManagerPage *page);
77 static GSList *manager_pages = NULL;
80 * Perform a command on all manager pages for a given session
82 #define manager_sessions_foreach(cur, session, page) \
83 for(cur = manager_pages; cur != NULL; cur = cur->next) \
84 if ((page = (SieveManagerPage *)cur->data) && \
85 page->active_session == session)
87 static void filters_list_clear(SieveManagerPage *page)
89 GtkListStore *list_store = GTK_LIST_STORE(gtk_tree_view_get_model(GTK_TREE_VIEW(page->filters_list)));
90 gtk_list_store_clear(list_store);
91 page->got_list = FALSE;
94 static void filters_list_delete_filter(SieveManagerPage *page, gchar *name)
97 GtkTreeModel *model = gtk_tree_view_get_model(GTK_TREE_VIEW(page->filters_list));
99 if (!filter_find_by_name(model, &iter, name))
102 gtk_list_store_remove(GTK_LIST_STORE(model), &iter);
106 static void filters_list_rename_filter(SieveManagerPage *page,
107 gchar *name_old, char *name_new)
110 GtkTreeModel *model = gtk_tree_view_get_model(GTK_TREE_VIEW(page->filters_list));
112 if (!filter_find_by_name(model, &iter, name_old))
115 gtk_list_store_set(GTK_LIST_STORE(model), &iter,
116 FILTER_NAME, name_new,
120 static void filters_list_insert_filter(SieveManagerPage *page,
123 GtkListStore *list_store = GTK_LIST_STORE(gtk_tree_view_get_model(GTK_TREE_VIEW(page->filters_list)));
126 gtk_list_store_append(list_store, &iter);
127 gtk_list_store_set(list_store, &iter,
128 FILTER_NAME, filter->name,
129 FILTER_ACTIVE, filter->active,
133 static gchar *filters_list_get_selected_filter(GtkWidget *list_view)
135 GtkTreeSelection *selector;
140 selector = gtk_tree_view_get_selection(GTK_TREE_VIEW(list_view));
142 if (!gtk_tree_selection_get_selected(selector, &model, &iter))
145 gtk_tree_model_get(model, &iter, FILTER_NAME, &res, -1);
150 static void filter_add(GtkWidget *widget, SieveManagerPage *page)
152 SieveSession *session = page->active_session;
155 gchar *filter_name = input_dialog(_("Add Sieve script"),
156 _("Enter name for a new Sieve filter script."), "");
157 if (!filter_name || !filter_name[0])
160 sieve_editor_new(session, filter_name);
162 sieve_session_add_script(session, filter_name
163 (sieve_session_data_cb_fn)filter_added, (gpointer)page);
167 static void filter_got_data(SieveSession *session, gchar *contents,
168 CommandDataGetScript *cmd_data)
170 SieveManagerPage *page = cmd_data->page;
171 SieveEditorPage *editor;
176 } else if (contents == (void *)-1) {
177 got_session_error(session, _("Unable to get script contents"), page);
181 if (cmd_data->first_line) {
182 cmd_data->first_line = FALSE;
183 editor = sieve_editor_new(session, cmd_data->filter_name);
184 cmd_data->editor_page = editor;
186 editor = cmd_data->editor_page;
187 sieve_editor_append_text(editor, "\n", 1);
189 sieve_editor_append_text(editor, contents, strlen(contents));
192 static void filter_edit(GtkWidget *widget, SieveManagerPage *page)
194 SieveEditorPage *editor;
195 CommandDataGetScript *cmd_data;
196 SieveSession *session = page->active_session;
199 gchar *filter_name = filters_list_get_selected_filter(page->filters_list);
203 editor = sieve_editor_get(session, filter_name);
205 sieve_editor_present(editor);
207 cmd_data = g_new0(CommandDataGetScript, 1);
208 cmd_data->first_line = TRUE;
209 cmd_data->filter_name = filter_name;
210 cmd_data->page = page;
212 sieve_session_get_script(session, filter_name,
213 (sieve_session_data_cb_fn)filter_got_data, cmd_data);
217 static void filter_renamed(SieveSession *session, gboolean success,
218 CommandDataRename *data)
220 SieveManagerPage *page = data->page;
224 got_session_error(session, "Unable to rename script", page);
228 manager_sessions_foreach(cur, session, page) {
229 filters_list_rename_filter(page, data->name_old, data->name_new);
234 static void filter_rename(GtkWidget *widget, SieveManagerPage *page)
236 CommandDataRename *cmd_data;
237 gchar *name_old, *name_new;
238 SieveSession *session;
240 name_old = filters_list_get_selected_filter(page->filters_list);
244 session = page->active_session;
248 name_new = input_dialog(_("Add Sieve script"),
249 _("Enter new name for the script."), name_old);
253 cmd_data = g_new(CommandDataRename, 1);
254 cmd_data->name_new = name_new;
255 cmd_data->name_old = name_old;
256 cmd_data->page = page;
257 sieve_session_rename_script(session, name_old, name_new,
258 (sieve_session_data_cb_fn)filter_renamed, (gpointer)cmd_data);
261 static void filter_activated(SieveSession *session, gboolean success,
262 CommandDataName *cmd_data)
264 SieveManagerPage *page = cmd_data->page;
268 got_session_error(session, "Unable to set active script", page);
272 manager_sessions_foreach(cur, session, page) {
273 filter_set_active(page, cmd_data->filter_name);
278 static void sieve_set_active_filter(SieveManagerPage *page, gchar *filter_name)
280 SieveSession *session;
281 CommandDataName *cmd_data;
283 session = page->active_session;
284 cmd_data = g_new(CommandDataName, 1);
285 cmd_data->filter_name = filter_name;
286 cmd_data->page = page;
288 sieve_session_set_active_script(session, filter_name,
289 (sieve_session_data_cb_fn)filter_activated, cmd_data);
292 static void filter_deleted(SieveSession *session, const gchar *err_msg,
293 CommandDataName *cmd_data)
295 SieveManagerPage *page = cmd_data->page;
299 got_session_error(session, err_msg, page);
303 manager_sessions_foreach(cur, session, page) {
304 filters_list_delete_filter(page, cmd_data->filter_name);
310 static void filter_delete(GtkWidget *widget, SieveManagerPage *page)
314 SieveSession *session;
315 CommandDataName *cmd_data;
317 filter_name = filters_list_get_selected_filter(page->filters_list);
318 if (filter_name == NULL)
321 session = page->active_session;
325 g_snprintf(buf, sizeof(buf),
326 _("Do you really want to delete the filter '%s'?"), filter_name);
327 if (alertpanel_full(_("Delete filter"), buf,
328 GTK_STOCK_CANCEL, GTK_STOCK_DELETE, NULL, FALSE,
329 NULL, ALERT_WARNING, G_ALERTDEFAULT) != G_ALERTALTERNATE)
332 cmd_data = g_new(CommandDataName, 1);
333 cmd_data->filter_name = filter_name;
334 cmd_data->page = page;
336 sieve_session_delete_script(session, filter_name,
337 (sieve_session_data_cb_fn)filter_deleted, cmd_data);
341 * select a filter in the list
343 * return TRUE is successfully selected, FALSE otherwise
346 static gboolean filter_select (GtkWidget *list_view, GtkTreeModel *model,
349 GtkTreeSelection *selection;
352 selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(list_view));
353 gtk_tree_selection_select_iter(selection, iter);
354 path = gtk_tree_model_get_path(model, iter);
355 if (path == NULL) return FALSE;
356 gtk_tree_view_set_cursor(GTK_TREE_VIEW(list_view), path, NULL, FALSE);
357 gtk_tree_path_free(path);
362 * find matching filter. return FALSE on match
364 static gboolean filter_search_equal_fn (GtkTreeModel *model, gint column,
365 const gchar *key, GtkTreeIter *iter, gpointer search_data)
367 SieveManagerPage *page = (SieveManagerPage *)search_data;
370 if (!key) return TRUE;
372 gtk_tree_model_get (model, iter, FILTER_NAME, &filter_name, -1);
374 if (strncmp (key, filter_name, strlen(key)) != 0) return TRUE;
375 return !filter_select(page->filters_list, model, iter);
379 * search for a filter row by its name. return true if found.
381 gboolean filter_find_by_name (GtkTreeModel *model, GtkTreeIter *iter,
386 if (!gtk_tree_model_get_iter_first (model, iter))
390 gtk_tree_model_get (model, iter, FILTER_NAME, &name, -1);
391 if (strcmp(filter_name, name) == 0) {
394 } while (gtk_tree_model_iter_next (model, iter));
398 static gboolean filter_set_inactive(GtkTreeModel *model,
399 GtkTreePath *path, GtkTreeIter *iter, gpointer data)
401 gtk_list_store_set(GTK_LIST_STORE(model), iter,
402 FILTER_ACTIVE, FALSE,
408 * Set the active filter in the table.
409 * @param filter_name The filter to make active (may be null)
411 static void filter_set_active(SieveManagerPage *page, gchar *filter_name)
414 GtkTreeModel *model = gtk_tree_view_get_model(GTK_TREE_VIEW(page->filters_list));
416 /* Deactivate all filters */
417 gtk_tree_model_foreach(model, filter_set_inactive, NULL);
419 /* Set active filter */
421 if (!filter_find_by_name (model, &iter, filter_name))
424 gtk_list_store_set(GTK_LIST_STORE(model), &iter,
430 static void filter_active_toggled(GtkCellRendererToggle *widget,
432 SieveManagerPage *page)
437 GtkTreeModel *model = gtk_tree_view_get_model(GTK_TREE_VIEW(page->filters_list));
439 if (!gtk_tree_model_get_iter_from_string(model, &iter, path))
442 /* get existing value */
443 gtk_tree_model_get(model, &iter,
444 FILTER_NAME, &filter_name,
445 FILTER_ACTIVE, &active,
448 sieve_set_active_filter(page, active ? NULL : filter_name);
451 static void filter_double_clicked(GtkTreeView *list_view,
452 GtkTreePath *path, GtkTreeViewColumn *column,
453 SieveManagerPage *page)
455 filter_edit(GTK_WIDGET(list_view), page);
458 static void filters_create_list_view_columns(SieveManagerPage *page,
459 GtkWidget *list_view)
461 GtkTreeViewColumn *column;
462 GtkCellRenderer *renderer;
465 renderer = gtk_cell_renderer_text_new();
466 column = gtk_tree_view_column_new_with_attributes
467 (_("Name"), renderer,
470 gtk_tree_view_append_column(GTK_TREE_VIEW(list_view), column);
471 gtk_tree_view_column_set_expand(column, TRUE);
474 renderer = gtk_cell_renderer_toggle_new();
475 g_object_set(renderer,
479 column = gtk_tree_view_column_new_with_attributes
480 (_("Active"), renderer,
481 "active", FILTER_ACTIVE,
483 gtk_tree_view_append_column(GTK_TREE_VIEW(list_view), column);
484 gtk_tree_view_column_set_alignment (column, 0.5);
485 CLAWS_SET_TIP(gtk_tree_view_column_get_widget(column),
486 _("An account can only have one active script at a time."));
487 g_signal_connect(G_OBJECT(renderer), "toggled",
488 G_CALLBACK(filter_active_toggled), page);
490 gtk_tree_view_set_search_column(GTK_TREE_VIEW(list_view), FILTER_NAME);
491 gtk_tree_view_set_search_equal_func(GTK_TREE_VIEW(list_view),
492 filter_search_equal_fn, page, NULL);
496 static GtkListStore* filters_create_data_store(void)
498 return gtk_list_store_new(N_FILTER_COLUMNS,
499 G_TYPE_STRING, /* FILTER_NAME */
500 G_TYPE_BOOLEAN, /* FILTER_ACTIVE */
504 static GtkWidget *filters_list_view_create(SieveManagerPage *page)
506 GtkTreeView *list_view;
507 GtkTreeSelection *selector;
508 GtkListStore *store = filters_create_data_store();
510 list_view = GTK_TREE_VIEW(gtk_tree_view_new_with_model(GTK_TREE_MODEL(store)));
511 g_object_unref(G_OBJECT(store));
513 selector = gtk_tree_view_get_selection(list_view);
514 gtk_tree_selection_set_mode(selector, GTK_SELECTION_BROWSE);
516 /* create the columns */
517 filters_create_list_view_columns(page, GTK_WIDGET(list_view));
519 /* set a double click listener */
520 g_signal_connect(G_OBJECT(list_view), "row_activated",
521 G_CALLBACK(filter_double_clicked),
524 return GTK_WIDGET(list_view);
527 static gboolean manager_key_pressed(GtkWidget *widget, GdkEventKey *event,
530 SieveManagerPage* page = (SieveManagerPage *) data;
532 if (event && event->keyval == GDK_KEY_Escape)
533 sieve_manager_done(page);
538 static void size_allocate_cb(GtkWidget *widget, GtkAllocation *allocation)
540 cm_return_if_fail(allocation != NULL);
542 sieve_config.manager_win_width = allocation->width;
543 sieve_config.manager_win_height = allocation->height;
546 static void got_session_error(SieveSession *session, const gchar *msg,
547 SieveManagerPage *page)
549 if (page->active_session != session)
551 gtk_label_set_text(GTK_LABEL(page->status_text), msg);
554 static void sieve_manager_on_error(SieveSession *session,
555 const gchar *msg, gpointer user_data)
557 SieveManagerPage *page = (SieveManagerPage *)user_data;
558 got_session_error(session, msg, page);
561 static void sieve_manager_on_connected(SieveSession *session,
562 gboolean connected, gpointer user_data)
564 SieveManagerPage *page = (SieveManagerPage *)user_data;
565 if (page->active_session != session)
568 gtk_widget_set_sensitive(GTK_WIDGET(page->vbox_buttons), FALSE);
569 gtk_label_set_text(GTK_LABEL(page->status_text),
570 _("Unable to connect"));
574 static void got_filter_listed(SieveSession *session, SieveScript *script,
575 SieveManagerPage *page)
578 got_session_error(session, "Unable to list scripts", page);
582 /* done receiving list */
583 page->got_list = TRUE;
584 gtk_widget_set_sensitive(GTK_WIDGET(page->vbox_buttons), TRUE);
585 gtk_label_set_text(GTK_LABEL(page->status_text), "");
588 filters_list_insert_filter(page, script);
592 * An account was selected from the menu. Get its list of scripts.
594 static void account_changed(GtkWidget *widget, SieveManagerPage *page)
597 PrefsAccount *account;
598 SieveSession *session;
600 account_id = combobox_get_active_data(GTK_COMBO_BOX(page->accounts_menu));
601 account = account_find_from_id(account_id);
604 session = page->active_session = sieve_session_get_for_account(account);
605 sieve_session_handle_status(session,
606 sieve_manager_on_error,
607 sieve_manager_on_connected,
609 filters_list_clear(page);
610 if (session_is_connected(SESSION(session))) {
611 gtk_label_set_text(GTK_LABEL(page->status_text),
612 _("Listing scripts..."));
614 gtk_label_set_text(GTK_LABEL(page->status_text),
617 sieve_session_list_scripts(session,
618 (sieve_session_data_cb_fn)got_filter_listed, (gpointer)page);
621 static SieveManagerPage *sieve_manager_page_new()
623 SieveManagerPage *page;
625 GtkWidget *hbox, *vbox, *vbox_buttons;
626 GtkWidget *accounts_menu;
628 GtkWidget *scrolledwin;
629 GtkWidget *list_view;
631 GtkWidget *status_text;
634 GList *account_list, *cur;
636 SieveAccountConfig *config;
637 PrefsAccount *default_account = NULL;
639 static GdkGeometry geometry;
641 page = g_new0(SieveManagerPage, 1);
645 window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "sievemanager");
646 gtk_container_set_border_width (GTK_CONTAINER (window), 8);
647 gtk_window_set_title (GTK_WINDOW (window), _("Manage Sieve Filters"));
648 MANAGE_WINDOW_SIGNALS_CONNECT (window);
650 g_signal_connect (G_OBJECT (window), "key_press_event",
651 G_CALLBACK (manager_key_pressed), page);
652 g_signal_connect (G_OBJECT(window), "size_allocate",
653 G_CALLBACK (size_allocate_cb), NULL);
655 if (!geometry.min_height) {
656 geometry.min_width = 350;
657 geometry.min_height = 280;
660 gtk_window_set_geometry_hints(GTK_WINDOW(window), NULL, &geometry,
662 gtk_widget_set_size_request(window, sieve_config.manager_win_width,
663 sieve_config.manager_win_height);
665 vbox = gtk_vbox_new (FALSE, 10);
666 gtk_container_add (GTK_CONTAINER (window), vbox);
668 hbox = gtk_hbox_new (FALSE, 8);
669 gtk_box_pack_start (GTK_BOX (vbox), hbox, FALSE, FALSE, 0);
673 label = gtk_label_new (_("Account"));
674 gtk_box_pack_start (GTK_BOX (hbox), label, FALSE, FALSE, 0);
676 accounts_menu = gtkut_sc_combobox_create(NULL, FALSE);
677 menu = GTK_LIST_STORE(gtk_combo_box_get_model(GTK_COMBO_BOX(accounts_menu)));
678 gtk_box_pack_start (GTK_BOX (hbox), accounts_menu, FALSE, FALSE, 0);
679 g_signal_connect (G_OBJECT(accounts_menu), "changed",
680 G_CALLBACK (account_changed), page);
682 account_list = account_get_list();
683 for (cur = account_list; cur != NULL; cur = cur->next) {
684 ap = (PrefsAccount *)cur->data;
685 config = sieve_prefs_account_get_config(ap);
686 if (config->enable) {
687 COMBOBOX_ADD (menu, ap->account_name, ap->account_id);
688 if (!default_account || ap->is_default)
689 default_account = ap;
693 if (!default_account) {
694 gtk_widget_destroy(label);
695 gtk_widget_destroy(accounts_menu);
699 status_text = gtk_label_new ("");
700 gtk_box_pack_start (GTK_BOX (hbox), status_text, FALSE, FALSE, 0);
701 gtk_label_set_justify (GTK_LABEL (status_text), GTK_JUSTIFY_LEFT);
705 hbox = gtk_hbox_new (FALSE, 8);
706 gtk_box_pack_start (GTK_BOX (vbox), hbox, TRUE, TRUE, 0);
707 gtk_container_set_border_width (GTK_CONTAINER (hbox), 2);
711 scrolledwin = gtk_scrolled_window_new (NULL, NULL);
712 gtk_box_pack_start (GTK_BOX (hbox), scrolledwin, TRUE, TRUE, 0);
713 gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (scrolledwin),
714 GTK_POLICY_AUTOMATIC,
715 GTK_POLICY_AUTOMATIC);
717 list_view = filters_list_view_create(page);
718 gtk_container_add(GTK_CONTAINER(scrolledwin), list_view);
722 vbox_buttons = gtk_vbox_new (FALSE, 8);
723 gtk_widget_set_sensitive(vbox_buttons, FALSE);
724 gtk_box_pack_start (GTK_BOX (hbox), 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_buttons), 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 void sieve_manager_close(GtkWidget *widget, SieveManagerPage *page)
788 sieve_manager_done(page);
791 void sieve_manager_done(SieveManagerPage *page)
793 manager_pages = g_slist_remove(manager_pages, page);
794 gtk_widget_destroy(page->window);
798 void sieve_manager_show()
800 SieveManagerPage *page = sieve_manager_page_new();
801 manager_pages = g_slist_prepend(manager_pages, page);
802 gtk_widget_show_all(page->window);