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, gboolean abort,
168 gchar *contents, CommandDataGetScript *cmd_data)
170 SieveManagerPage *page = cmd_data->page;
171 SieveEditorPage *editor;
173 if (abort || !contents) {
174 g_free(cmd_data->filter_name);
177 } else if (contents == (void *)-1) {
178 got_session_error(session, _("Unable to get script contents"), page);
182 if (cmd_data->first_line) {
183 cmd_data->first_line = FALSE;
184 editor = sieve_editor_new(session, cmd_data->filter_name);
185 cmd_data->editor_page = editor;
187 editor = cmd_data->editor_page;
188 sieve_editor_append_text(editor, "\n", 1);
190 sieve_editor_append_text(editor, contents, strlen(contents));
193 static void filter_edit(GtkWidget *widget, SieveManagerPage *page)
195 SieveEditorPage *editor;
196 CommandDataGetScript *cmd_data;
197 SieveSession *session = page->active_session;
200 gchar *filter_name = filters_list_get_selected_filter(page->filters_list);
204 editor = sieve_editor_get(session, filter_name);
206 sieve_editor_present(editor);
208 cmd_data = g_new0(CommandDataGetScript, 1);
209 cmd_data->first_line = TRUE;
210 cmd_data->filter_name = filter_name;
211 cmd_data->page = page;
213 sieve_session_get_script(session, filter_name,
214 (sieve_session_data_cb_fn)filter_got_data, cmd_data);
218 static void filter_renamed(SieveSession *session, gboolean abort,
219 gboolean success, CommandDataRename *data)
221 SieveManagerPage *page = data->page;
225 } else if (!success) {
226 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,
233 g_free(data->name_old);
234 g_free(data->name_new);
238 static void filter_rename(GtkWidget *widget, SieveManagerPage *page)
240 CommandDataRename *cmd_data;
241 gchar *name_old, *name_new;
242 SieveSession *session;
244 name_old = filters_list_get_selected_filter(page->filters_list);
248 session = page->active_session;
252 name_new = input_dialog(_("Add Sieve script"),
253 _("Enter new name for the script."), name_old);
257 cmd_data = g_new(CommandDataRename, 1);
258 cmd_data->name_new = name_new;
259 cmd_data->name_old = name_old;
260 cmd_data->page = page;
261 sieve_session_rename_script(session, name_old, name_new,
262 (sieve_session_data_cb_fn)filter_renamed, (gpointer)cmd_data);
265 static void filter_activated(SieveSession *session, gboolean abort,
266 gboolean success, CommandDataName *cmd_data)
268 SieveManagerPage *page = cmd_data->page;
272 } else if (!success) {
273 got_session_error(session, "Unable to set active script", page);
275 manager_sessions_foreach(cur, session, page) {
276 filter_set_active(page, cmd_data->filter_name);
279 g_free(cmd_data->filter_name);
283 static void sieve_set_active_filter(SieveManagerPage *page, gchar *filter_name)
285 SieveSession *session;
286 CommandDataName *cmd_data;
288 session = page->active_session;
289 cmd_data = g_new(CommandDataName, 1);
290 cmd_data->filter_name = filter_name;
291 cmd_data->page = page;
293 sieve_session_set_active_script(session, filter_name,
294 (sieve_session_data_cb_fn)filter_activated, cmd_data);
297 static void filter_deleted(SieveSession *session, gboolean abort,
298 const gchar *err_msg,
299 CommandDataName *cmd_data)
301 SieveManagerPage *page = cmd_data->page;
305 } else if (err_msg) {
306 got_session_error(session, err_msg, page);
308 manager_sessions_foreach(cur, session, page) {
309 filters_list_delete_filter(page,
310 cmd_data->filter_name);
313 g_free(cmd_data->filter_name);
318 static void filter_delete(GtkWidget *widget, SieveManagerPage *page)
322 SieveSession *session;
323 CommandDataName *cmd_data;
325 filter_name = filters_list_get_selected_filter(page->filters_list);
326 if (filter_name == NULL)
329 session = page->active_session;
333 g_snprintf(buf, sizeof(buf),
334 _("Do you really want to delete the filter '%s'?"), filter_name);
335 if (alertpanel_full(_("Delete filter"), buf,
336 GTK_STOCK_CANCEL, GTK_STOCK_DELETE, NULL, FALSE,
337 NULL, ALERT_WARNING, G_ALERTDEFAULT) != G_ALERTALTERNATE)
340 cmd_data = g_new(CommandDataName, 1);
341 cmd_data->filter_name = filter_name;
342 cmd_data->page = page;
344 sieve_session_delete_script(session, filter_name,
345 (sieve_session_data_cb_fn)filter_deleted, cmd_data);
349 * select a filter in the list
351 * return TRUE is successfully selected, FALSE otherwise
354 static gboolean filter_select (GtkWidget *list_view, GtkTreeModel *model,
357 GtkTreeSelection *selection;
360 selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(list_view));
361 gtk_tree_selection_select_iter(selection, iter);
362 path = gtk_tree_model_get_path(model, iter);
363 if (path == NULL) return FALSE;
364 gtk_tree_view_set_cursor(GTK_TREE_VIEW(list_view), path, NULL, FALSE);
365 gtk_tree_path_free(path);
370 * find matching filter. return FALSE on match
372 static gboolean filter_search_equal_fn (GtkTreeModel *model, gint column,
373 const gchar *key, GtkTreeIter *iter, gpointer search_data)
375 SieveManagerPage *page = (SieveManagerPage *)search_data;
378 if (!key) return TRUE;
380 gtk_tree_model_get (model, iter, FILTER_NAME, &filter_name, -1);
382 if (strncmp (key, filter_name, strlen(key)) != 0) return TRUE;
383 return !filter_select(page->filters_list, model, iter);
387 * search for a filter row by its name. return true if found.
389 gboolean filter_find_by_name (GtkTreeModel *model, GtkTreeIter *iter,
394 if (!gtk_tree_model_get_iter_first (model, iter))
398 gtk_tree_model_get (model, iter, FILTER_NAME, &name, -1);
399 if (strcmp(filter_name, name) == 0) {
402 } while (gtk_tree_model_iter_next (model, iter));
406 static gboolean filter_set_inactive(GtkTreeModel *model,
407 GtkTreePath *path, GtkTreeIter *iter, gpointer data)
409 gtk_list_store_set(GTK_LIST_STORE(model), iter,
410 FILTER_ACTIVE, FALSE,
416 * Set the active filter in the table.
417 * @param filter_name The filter to make active (may be null)
419 static void filter_set_active(SieveManagerPage *page, gchar *filter_name)
422 GtkTreeModel *model = gtk_tree_view_get_model(GTK_TREE_VIEW(page->filters_list));
424 /* Deactivate all filters */
425 gtk_tree_model_foreach(model, filter_set_inactive, NULL);
427 /* Set active filter */
429 if (!filter_find_by_name (model, &iter, filter_name))
432 gtk_list_store_set(GTK_LIST_STORE(model), &iter,
438 static void filter_active_toggled(GtkCellRendererToggle *widget,
440 SieveManagerPage *page)
445 GtkTreeModel *model = gtk_tree_view_get_model(GTK_TREE_VIEW(page->filters_list));
447 if (!gtk_tree_model_get_iter_from_string(model, &iter, path))
450 /* get existing value */
451 gtk_tree_model_get(model, &iter,
452 FILTER_NAME, &filter_name,
453 FILTER_ACTIVE, &active,
456 sieve_set_active_filter(page, active ? NULL : filter_name);
459 static void filter_double_clicked(GtkTreeView *list_view,
460 GtkTreePath *path, GtkTreeViewColumn *column,
461 SieveManagerPage *page)
463 filter_edit(GTK_WIDGET(list_view), page);
466 static void filters_create_list_view_columns(SieveManagerPage *page,
467 GtkWidget *list_view)
469 GtkTreeViewColumn *column;
470 GtkCellRenderer *renderer;
473 renderer = gtk_cell_renderer_text_new();
474 column = gtk_tree_view_column_new_with_attributes
475 (_("Name"), renderer,
478 gtk_tree_view_append_column(GTK_TREE_VIEW(list_view), column);
479 gtk_tree_view_column_set_expand(column, TRUE);
482 renderer = gtk_cell_renderer_toggle_new();
483 g_object_set(renderer,
487 column = gtk_tree_view_column_new_with_attributes
488 (_("Active"), renderer,
489 "active", FILTER_ACTIVE,
491 gtk_tree_view_append_column(GTK_TREE_VIEW(list_view), column);
492 gtk_tree_view_column_set_alignment (column, 0.5);
493 CLAWS_SET_TIP(gtk_tree_view_column_get_widget(column),
494 _("An account can only have one active script at a time."));
495 g_signal_connect(G_OBJECT(renderer), "toggled",
496 G_CALLBACK(filter_active_toggled), page);
498 gtk_tree_view_set_search_column(GTK_TREE_VIEW(list_view), FILTER_NAME);
499 gtk_tree_view_set_search_equal_func(GTK_TREE_VIEW(list_view),
500 filter_search_equal_fn, page, NULL);
504 static GtkListStore* filters_create_data_store(void)
506 return gtk_list_store_new(N_FILTER_COLUMNS,
507 G_TYPE_STRING, /* FILTER_NAME */
508 G_TYPE_BOOLEAN, /* FILTER_ACTIVE */
512 static GtkWidget *filters_list_view_create(SieveManagerPage *page)
514 GtkTreeView *list_view;
515 GtkTreeSelection *selector;
516 GtkListStore *store = filters_create_data_store();
518 list_view = GTK_TREE_VIEW(gtk_tree_view_new_with_model(GTK_TREE_MODEL(store)));
519 g_object_unref(G_OBJECT(store));
521 selector = gtk_tree_view_get_selection(list_view);
522 gtk_tree_selection_set_mode(selector, GTK_SELECTION_BROWSE);
524 /* create the columns */
525 filters_create_list_view_columns(page, GTK_WIDGET(list_view));
527 /* set a double click listener */
528 g_signal_connect(G_OBJECT(list_view), "row_activated",
529 G_CALLBACK(filter_double_clicked),
532 return GTK_WIDGET(list_view);
535 static gboolean manager_key_pressed(GtkWidget *widget, GdkEventKey *event,
538 SieveManagerPage* page = (SieveManagerPage *) data;
540 if (event && event->keyval == GDK_KEY_Escape)
541 sieve_manager_done(page);
546 static void size_allocate_cb(GtkWidget *widget, GtkAllocation *allocation)
548 cm_return_if_fail(allocation != NULL);
550 sieve_config.manager_win_width = allocation->width;
551 sieve_config.manager_win_height = allocation->height;
554 static void got_session_error(SieveSession *session, const gchar *msg,
555 SieveManagerPage *page)
557 if (!g_slist_find(manager_pages, page))
559 if (page->active_session != session)
561 gtk_label_set_text(GTK_LABEL(page->status_text), msg);
564 static void sieve_manager_on_error(SieveSession *session,
565 const gchar *msg, gpointer user_data)
567 SieveManagerPage *page = (SieveManagerPage *)user_data;
568 got_session_error(session, msg, page);
571 static void sieve_manager_on_connected(SieveSession *session,
572 gboolean connected, gpointer user_data)
574 SieveManagerPage *page = (SieveManagerPage *)user_data;
575 if (page->active_session != session)
578 gtk_widget_set_sensitive(GTK_WIDGET(page->vbox_buttons), FALSE);
579 gtk_label_set_text(GTK_LABEL(page->status_text),
580 _("Unable to connect"));
584 static void got_filter_listed(SieveSession *session, gboolean abort,
585 SieveScript *script, SieveManagerPage *page)
590 got_session_error(session, "Unable to list scripts", page);
594 /* done receiving list */
595 page->got_list = TRUE;
596 gtk_widget_set_sensitive(GTK_WIDGET(page->vbox_buttons), TRUE);
597 gtk_label_set_text(GTK_LABEL(page->status_text), "");
600 filters_list_insert_filter(page, script);
604 * An account was selected from the menu. Get its list of scripts.
606 static void account_changed(GtkWidget *widget, SieveManagerPage *page)
609 PrefsAccount *account;
610 SieveSession *session;
612 account_id = combobox_get_active_data(GTK_COMBO_BOX(page->accounts_menu));
613 account = account_find_from_id(account_id);
616 session = page->active_session = sieve_session_get_for_account(account);
617 sieve_session_handle_status(session,
618 sieve_manager_on_error,
619 sieve_manager_on_connected,
621 filters_list_clear(page);
622 if (session_is_connected(SESSION(session))) {
623 gtk_label_set_text(GTK_LABEL(page->status_text),
624 _("Listing scripts..."));
626 gtk_label_set_text(GTK_LABEL(page->status_text),
629 sieve_session_list_scripts(session,
630 (sieve_session_data_cb_fn)got_filter_listed, (gpointer)page);
633 static SieveManagerPage *sieve_manager_page_new()
635 SieveManagerPage *page;
637 GtkWidget *hbox, *vbox, *vbox_buttons;
638 GtkWidget *accounts_menu;
640 GtkWidget *scrolledwin;
641 GtkWidget *list_view;
643 GtkWidget *status_text;
646 GList *account_list, *cur;
648 SieveAccountConfig *config;
649 PrefsAccount *default_account = NULL;
651 static GdkGeometry geometry;
653 page = g_new0(SieveManagerPage, 1);
657 window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "sievemanager");
658 gtk_container_set_border_width (GTK_CONTAINER (window), 8);
659 gtk_window_set_title (GTK_WINDOW (window), _("Manage Sieve Filters"));
660 MANAGE_WINDOW_SIGNALS_CONNECT (window);
662 g_signal_connect (G_OBJECT (window), "key_press_event",
663 G_CALLBACK (manager_key_pressed), page);
664 g_signal_connect (G_OBJECT(window), "size_allocate",
665 G_CALLBACK (size_allocate_cb), NULL);
667 if (!geometry.min_height) {
668 geometry.min_width = 350;
669 geometry.min_height = 280;
672 gtk_window_set_geometry_hints(GTK_WINDOW(window), NULL, &geometry,
674 gtk_widget_set_size_request(window, sieve_config.manager_win_width,
675 sieve_config.manager_win_height);
677 vbox = gtk_vbox_new (FALSE, 10);
678 gtk_container_add (GTK_CONTAINER (window), vbox);
680 hbox = gtk_hbox_new (FALSE, 8);
681 gtk_box_pack_start (GTK_BOX (vbox), hbox, FALSE, FALSE, 0);
685 label = gtk_label_new (_("Account"));
686 gtk_box_pack_start (GTK_BOX (hbox), label, FALSE, FALSE, 0);
688 accounts_menu = gtkut_sc_combobox_create(NULL, FALSE);
689 menu = GTK_LIST_STORE(gtk_combo_box_get_model(GTK_COMBO_BOX(accounts_menu)));
690 gtk_box_pack_start (GTK_BOX (hbox), accounts_menu, FALSE, FALSE, 0);
691 g_signal_connect (G_OBJECT(accounts_menu), "changed",
692 G_CALLBACK (account_changed), page);
694 account_list = account_get_list();
695 for (cur = account_list; cur != NULL; cur = cur->next) {
696 ap = (PrefsAccount *)cur->data;
697 config = sieve_prefs_account_get_config(ap);
698 if (config->enable) {
699 COMBOBOX_ADD (menu, ap->account_name, ap->account_id);
700 if (!default_account || ap->is_default)
701 default_account = ap;
705 if (!default_account) {
706 gtk_widget_destroy(label);
707 gtk_widget_destroy(accounts_menu);
711 status_text = gtk_label_new ("");
712 gtk_box_pack_start (GTK_BOX (hbox), status_text, FALSE, FALSE, 0);
713 gtk_label_set_justify (GTK_LABEL (status_text), GTK_JUSTIFY_LEFT);
717 hbox = gtk_hbox_new (FALSE, 8);
718 gtk_box_pack_start (GTK_BOX (vbox), hbox, TRUE, TRUE, 0);
719 gtk_container_set_border_width (GTK_CONTAINER (hbox), 2);
723 scrolledwin = gtk_scrolled_window_new (NULL, NULL);
724 gtk_box_pack_start (GTK_BOX (hbox), scrolledwin, TRUE, TRUE, 0);
725 gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (scrolledwin),
726 GTK_POLICY_AUTOMATIC,
727 GTK_POLICY_AUTOMATIC);
729 list_view = filters_list_view_create(page);
730 gtk_container_add(GTK_CONTAINER(scrolledwin), list_view);
734 vbox_buttons = gtk_vbox_new (FALSE, 8);
735 gtk_widget_set_sensitive(vbox_buttons, FALSE);
736 gtk_box_pack_start (GTK_BOX (hbox), vbox_buttons, FALSE, FALSE, 0);
739 btn = gtk_button_new_from_stock(GTK_STOCK_NEW);
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_add), page);
745 btn = gtk_button_new_from_stock (GTK_STOCK_EDIT);
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_edit), page);
751 btn = gtk_button_new_from_stock(GTK_STOCK_DELETE);
752 gtk_box_pack_start (GTK_BOX (vbox_buttons), btn, FALSE, FALSE, 0);
753 g_signal_connect (G_OBJECT(btn), "clicked",
754 G_CALLBACK (filter_delete), page);
757 btn = gtk_button_new_with_label("Rename");
758 gtk_box_pack_start (GTK_BOX (vbox_buttons), btn, FALSE, FALSE, 0);
759 g_signal_connect (G_OBJECT(btn), "clicked",
760 G_CALLBACK (filter_rename), page);
763 btn = gtk_button_new_from_stock(GTK_STOCK_REFRESH);
764 gtk_box_pack_end (GTK_BOX (vbox_buttons), btn, FALSE, FALSE, 0);
765 g_signal_connect (G_OBJECT(btn), "clicked",
766 G_CALLBACK (account_changed), page);
768 /* bottom area stuff */
770 gtkut_stock_button_set_create(&hbox,
771 &btn, GTK_STOCK_CLOSE,
772 NULL, NULL, NULL, NULL);
775 gtk_box_pack_end (GTK_BOX (vbox), hbox, FALSE, FALSE, 0);
776 gtk_widget_grab_default (btn);
777 g_signal_connect (G_OBJECT (btn), "clicked",
778 G_CALLBACK (sieve_manager_close), page);
780 page->window = window;
781 page->accounts_menu = accounts_menu;
782 page->filters_list = list_view;
783 page->status_text = status_text;
784 page->vbox_buttons = vbox_buttons;
786 /* select default (first) account */
787 if (default_account) {
788 combobox_select_by_data(GTK_COMBO_BOX(accounts_menu),
789 default_account->account_id);
791 gtk_label_set_text(GTK_LABEL(status_text),
792 _("To use Sieve, enable it in an account's preferences."));
798 void sieve_manager_close(GtkWidget *widget, SieveManagerPage *page)
800 sieve_manager_done(page);
803 void sieve_manager_done(SieveManagerPage *page)
805 manager_pages = g_slist_remove(manager_pages, page);
806 gtk_widget_destroy(page->window);
810 void sieve_manager_show()
812 SieveManagerPage *page = sieve_manager_page_new();
813 manager_pages = g_slist_prepend(manager_pages, page);
814 gtk_widget_show_all(page->window);