2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2002-2012 Match Grun and the Claws Mail team
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/>.
21 * Dialog for gathering EMail addresses from mail folder.
26 #include "claws-features.h"
32 #include <glib/gi18n.h>
33 #include <gdk/gdkkeysyms.h>
40 #include "foldersel.h"
42 #include "alertpanel.h"
43 #include "manage_window.h"
46 #include "prefs_common.h"
48 #include "addrharvest.h"
49 #ifndef USE_NEW_ADDRBOOK
50 #include "addrindex.h"
53 #include "addressbook-dbus.h"
60 #define FIELDS_N_COLS 2
61 #define FIELDS_COL_WIDTH_HEADER 100
62 #define FIELDS_COL_WIDTH_COUNT 140
64 #define MIN_FOLDER_SIZE 20
65 #define DFL_FOLDER_SIZE 50
75 static struct _AddrHarvest {
78 GtkWidget *labelFolder;
80 GtkWidget *checkHeader[ NUM_FIELDS ];
81 #ifndef USE_NEW_ADDRBOOK
82 GtkWidget *spinbtnFolder;
84 GtkWidget *checkRecurse;
92 GtkWidget *clistCount;
95 #ifndef USE_NEW_ADDRBOOK
96 static AddressIndex *_harv_addressIndex_;
97 static AddressBookFile *_harv_addressBook_;
99 static gchar *_harv_headerNames_[] = {
107 static GList *_harv_messageList_;
109 static void addrgather_dlg_status_show( gchar *msg ) {
110 if( addrgather_dlg.statusbar != NULL ) {
111 gtk_statusbar_pop( GTK_STATUSBAR(addrgather_dlg.statusbar),
112 addrgather_dlg.status_cid );
115 GTK_STATUSBAR(addrgather_dlg.statusbar),
116 addrgather_dlg.status_cid, msg );
121 static gint addrgather_dlg_delete_event(
122 GtkWidget *widget, GdkEventAny *event, gpointer data )
124 addrgather_dlg.cancelled = TRUE;
129 static gboolean addrgather_dlg_key_pressed(
130 GtkWidget *widget, GdkEventKey *event, gpointer data )
132 if( event && event->keyval == GDK_KEY_Escape ) {
133 addrgather_dlg.cancelled = TRUE;
139 static void addrgather_size_allocate(
140 GtkWidget *widget, GtkAllocation *allocation )
142 cm_return_if_fail( allocation != NULL );
144 prefs_common.addrgather_width = allocation->width;
145 prefs_common.addrgather_height = allocation->height;
148 #define FMT_BUFSIZE 32
150 static gboolean addrgather_dlg_harvest() {
152 gchar *text[ FIELDS_N_COLS ];
153 AddressHarvester *harvester;
155 #ifndef USE_NEW_ADDRBOOK
156 AddressBookFile *abf;
160 ContactData* contact;
161 GError* error = NULL;
163 gchar str[ FMT_BUFSIZE ];
166 #ifndef USE_NEW_ADDRBOOK
169 name = gtk_editable_get_chars( GTK_EDITABLE(addrgather_dlg.entryBook), 0, -1 );
170 if( name == NULL || strlen( name ) < 1 ) {
171 addrgather_dlg_status_show(
172 _( "Please specify name for address book." ) );
176 name = gtk_combo_box_get_active_text(GTK_COMBO_BOX(addrgather_dlg.entryBook));
177 if( name == NULL || strlen( name ) < 1 ) {
178 addrgather_dlg_status_show(
179 _("No available address book."));
185 /* Create harvest helper */
186 harvester = addrharvest_create();
187 addrharvest_set_path( harvester, addrgather_dlg.folderPath );
189 for( i = 0; i < NUM_FIELDS; i++ ) {
190 addrharvest_set_header( harvester, _harv_headerNames_[i],
191 gtk_toggle_button_get_active(
192 GTK_TOGGLE_BUTTON(addrgather_dlg.checkHeader[i]) ) );
194 addrharvest_set_recurse( harvester,
195 gtk_toggle_button_get_active(
196 GTK_TOGGLE_BUTTON( addrgather_dlg.checkRecurse ) ) );
198 if( addrharvest_check_header( harvester ) == FALSE ) {
199 addrgather_dlg_status_show(
200 _( "Please select the mail headers to search." ) );
201 addrharvest_free( harvester );
207 addrgather_dlg_status_show( _( "Collecting addresses..." ) );
209 #ifndef USE_NEW_ADDRBOOK
210 sz = gtk_spin_button_get_value_as_int(
211 GTK_SPIN_BUTTON( addrgather_dlg.spinbtnFolder ) );
212 addrharvest_set_folder_size( harvester, sz );
215 #ifndef USE_NEW_ADDRBOOK
216 /* Create address book */
217 abf = addrbook_create_book();
218 addrbook_set_path( abf, _harv_addressIndex_->filePath );
219 newFile = addrbook_guess_next_file( abf );
220 addrbook_set_file( abf, newFile );
221 addrbook_set_name( abf, name );
226 /* Harvest addresses */
227 #ifndef USE_NEW_ADDRBOOK
229 harvester, abf->addressCache, _harv_messageList_ );
230 /* save address book */
231 addrbook_save_data( abf );
232 _harv_addressBook_ = abf;
235 harvester, NULL, _harv_messageList_ );
236 list = g_hash_table_get_values(harvester->dupTable);
237 for (; list; list = g_list_next(list)) {
238 contact = g_new0(ContactData, 1);
239 ContactEntry* person = (ContactEntry *) list->data;
240 if (person->first_name)
241 contact->name = g_strconcat(
242 person->first_name, " ", person->last_name, NULL);
244 contact->name = g_strdup(person->last_name);
245 if (! contact->name || strlen(contact->name) < 1)
246 contact->name = g_strdup(person->email);
247 contact->remarks = g_strdup(N_("address added by claws-mail"));
248 contact->email = g_strdup(person->email);
249 contact->book = g_strdup(name);
250 addressbook_dbus_add_contact(contact, &error);
251 contact_data_free(&contact);
257 /* Update summary count */
258 clist = GTK_CMCLIST(addrgather_dlg.clistCount);
259 gtk_cmclist_clear( clist );
260 for( i = 0; i < NUM_FIELDS; i++ ) {
261 cnt = addrharvest_get_count( harvester, _harv_headerNames_[i] );
266 sprintf( str, "%d", cnt );
268 text[ FIELD_COL_HEADER ] = _harv_headerNames_[i];
269 text[ FIELD_COL_COUNT ] = str;
270 gtk_cmclist_append( clist, text );
273 addrharvest_free( harvester );
275 addrgather_dlg_status_show(_("Addresses collected successfully."));
277 /* Display summary page */
278 gtk_notebook_set_current_page(
279 GTK_NOTEBOOK(addrgather_dlg.notebook), PAGE_FINISH );
280 addrgather_dlg.done = TRUE;
281 gtk_widget_set_sensitive( addrgather_dlg.btnCancel, FALSE );
282 gtk_widget_grab_default( addrgather_dlg.btnOk );
287 static void addrgather_dlg_ok( GtkWidget *widget, gpointer data ) {
288 if(addrgather_dlg.done) {
289 addrgather_dlg.done = FALSE;
293 if( addrgather_dlg_harvest() ) {
294 addrgather_dlg.cancelled = FALSE;
298 static void addrgather_dlg_cancel( GtkWidget *widget, gpointer data ) {
302 #define PACK_CHECK_BUTTON(box, checkbtn, label) \
304 checkbtn = gtk_check_button_new_with_label(label); \
305 gtk_widget_show(checkbtn); \
306 gtk_box_pack_start(GTK_BOX(box), checkbtn, FALSE, TRUE, 0); \
310 * Create notebook page for mail headers.
311 * Enter: pageNum Page number.
312 * pageLbl Page label.
314 static void addrgather_page_fields(gint pageNum, gchar *pageLbl)
320 GtkWidget *labelFolder;
321 GtkWidget *entryBook;
322 GtkWidget *frameHeader;
323 GtkWidget *checkHeader[NUM_FIELDS];
324 #ifndef USE_NEW_ADDRBOOK
326 GtkWidget *spinbtnFolder;
327 GtkWidget *adjFolder;
329 GtkWidget *checkRecurse;
332 #ifdef USE_NEW_ADDRBOOK
333 GError* error = NULL;
338 vbox = gtk_vbox_new(FALSE, 6);
339 gtk_container_add(GTK_CONTAINER(addrgather_dlg.notebook), vbox);
340 gtk_container_set_border_width(GTK_CONTAINER(vbox), 4);
343 label = gtk_label_new(pageLbl);
344 gtk_widget_show(label);
345 gtk_notebook_set_tab_label(GTK_NOTEBOOK(addrgather_dlg.notebook),
346 gtk_notebook_get_nth_page(GTK_NOTEBOOK(addrgather_dlg.notebook),
349 /* Upper area - Field list */
350 table = gtk_table_new(4, 2, FALSE);
351 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
352 gtk_table_set_row_spacings(GTK_TABLE(table), 4);
353 gtk_table_set_col_spacings(GTK_TABLE(table), 4);
357 label = gtk_label_new(_("Current folder:"));
358 gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0 );
359 gtk_misc_set_alignment( GTK_MISC(label), 1.0, 0.5 );
361 labelFolder = gtk_label_new("");
362 gtk_table_attach( GTK_TABLE(table), labelFolder, 1, 2, top, (top + 1),
363 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0 );
364 gtk_misc_set_alignment( GTK_MISC(labelFolder), 0, 0.5 );
368 label = gtk_label_new(_("Address book name:"));
369 gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0 );
370 gtk_misc_set_alignment( GTK_MISC(label), 1.0, 0.5 );
372 #ifndef USE_NEW_ADDRBOOK
373 entryBook = gtk_entry_new();
375 books = addressbook_dbus_get_books(&error);
376 entryBook = gtk_combo_box_new_text();
378 for (cur = books; cur; cur = g_slist_next(cur)) {
379 gchar* book = (gchar *) cur->data;
380 gtk_combo_box_prepend_text(GTK_COMBO_BOX(entryBook), book);
386 gtk_combo_box_prepend_text(GTK_COMBO_BOX(entryBook), "");
387 gtk_combo_box_set_active(GTK_COMBO_BOX(entryBook), 0);
389 gtk_table_attach( GTK_TABLE(table), entryBook, 1, 2, top, (top + 1),
390 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0 );
392 #ifndef USE_NEW_ADDRBOOK
395 label = gtk_label_new(_("Address book folder size:"));
396 gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0 );
397 gtk_misc_set_alignment( GTK_MISC(label), 1.0, 0.5 );
399 _("Maximum amount of entries per folder within the newly created address book"));
401 hboxs = gtk_hbox_new(FALSE, 8);
402 adjFolder = gtk_adjustment_new(DFL_FOLDER_SIZE, MIN_FOLDER_SIZE, G_MAXINT, 1, 10, 0);
403 spinbtnFolder = gtk_spin_button_new(GTK_ADJUSTMENT(adjFolder), 1, 0);
404 gtk_box_pack_start(GTK_BOX(hboxs), spinbtnFolder, FALSE, FALSE, 0);
405 gtk_widget_set_size_request(spinbtnFolder, 100, -1);
406 gtk_spin_button_set_numeric(GTK_SPIN_BUTTON(spinbtnFolder), TRUE);
407 gtk_table_attach(GTK_TABLE(table), hboxs, 1, 2, top, (top + 1), GTK_FILL, 0, 0, 0);
408 CLAWS_SET_TIP(spinbtnFolder,
409 _("Maximum amount of entries per folder within the newly created address book"));
413 frameHeader = gtk_frame_new(_("Process these mail header fields"));
414 gtk_widget_show(frameHeader);
415 gtk_table_attach(GTK_TABLE(table), frameHeader, 0, 2, top, (top + 4), GTK_FILL, 0, 0, 0);
416 gtk_frame_set_label_align(GTK_FRAME(frameHeader), 0.01, 0.5);
419 vboxf = gtk_vbox_new(FALSE, 0);
420 gtk_widget_show(vboxf);
421 gtk_container_add(GTK_CONTAINER(frameHeader), vboxf);
422 gtk_container_set_border_width(GTK_CONTAINER(vboxf), 8);
424 for (i = 0; i < NUM_FIELDS; i++) {
425 PACK_CHECK_BUTTON(vboxf, checkHeader[i],
426 prefs_common_translated_header_name(_harv_headerNames_[i]));
427 addrgather_dlg.checkHeader[i] = checkHeader[i];
430 /* Recurse folders */
432 checkRecurse = gtk_check_button_new_with_label( _("Include subfolders" ) );
433 gtk_table_attach( GTK_TABLE(table), checkRecurse, 0, 2, top, (top + 1),
434 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0 );
436 addrgather_dlg.labelFolder = labelFolder;
437 addrgather_dlg.entryBook = entryBook;
438 #ifndef USE_NEW_ADDRBOOK
439 addrgather_dlg.spinbtnFolder = spinbtnFolder;
441 addrgather_dlg.checkRecurse = checkRecurse;
445 * Create notebook page for summary counts.
446 * Enter: pageNum Page number.
447 * pageLbl Page label.
449 static void addrgather_page_finish( gint pageNum, gchar *pageLbl ) {
452 GtkWidget *clistSWin;
453 GtkWidget *clistCount;
454 gchar *titles[ FIELDS_N_COLS ];
456 titles[ FIELD_COL_HEADER ] = _("Header Name");
457 titles[ FIELD_COL_COUNT ] = _("Address Count");
459 vbox = gtk_vbox_new(FALSE, 8);
460 gtk_container_add( GTK_CONTAINER( addrgather_dlg.notebook ), vbox );
461 gtk_container_set_border_width( GTK_CONTAINER (vbox), 8 );
463 label = gtk_label_new( pageLbl );
464 gtk_widget_show( label );
465 gtk_notebook_set_tab_label(
466 GTK_NOTEBOOK( addrgather_dlg.notebook ),
467 gtk_notebook_get_nth_page( GTK_NOTEBOOK( addrgather_dlg.notebook ), pageNum ),
471 clistSWin = gtk_scrolled_window_new( NULL, NULL );
472 gtk_container_add( GTK_CONTAINER(vbox), clistSWin );
473 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(clistSWin),
474 GTK_POLICY_AUTOMATIC,
475 GTK_POLICY_AUTOMATIC);
477 clistCount = gtk_cmclist_new_with_titles( FIELDS_N_COLS, titles );
478 gtk_container_add( GTK_CONTAINER(clistSWin), clistCount );
479 gtk_cmclist_set_selection_mode( GTK_CMCLIST(clistCount), GTK_SELECTION_BROWSE );
480 gtk_cmclist_set_column_width(
481 GTK_CMCLIST(clistCount), FIELD_COL_HEADER, FIELDS_COL_WIDTH_HEADER );
482 gtk_cmclist_set_column_width(
483 GTK_CMCLIST(clistCount), FIELD_COL_COUNT, FIELDS_COL_WIDTH_COUNT );
485 for( i = 0; i < FIELDS_N_COLS; i++ )
486 gtkut_widget_set_can_focus(GTK_CMCLIST(clistCount)->column[i].button, FALSE);
488 addrgather_dlg.clistCount = clistCount;
492 * Create notebook page for warning message.
493 * Enter: pageNum Page number.
494 * pageLbl Page label.
496 static void addrgather_dlg_create(void)
501 GtkWidget *btnCancel;
502 GtkWidget *statusbar;
506 static GdkGeometry geometry;
508 window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "addrgather");
509 gtk_container_set_border_width(GTK_CONTAINER(window), 4);
510 gtk_window_set_position(GTK_WINDOW(window), GTK_WIN_POS_CENTER);
511 gtk_window_set_resizable(GTK_WINDOW(window), TRUE);
513 g_signal_connect(G_OBJECT(window), "delete_event",
514 G_CALLBACK(addrgather_dlg_delete_event), NULL);
515 g_signal_connect(G_OBJECT(window), "key_press_event",
516 G_CALLBACK(addrgather_dlg_key_pressed), NULL);
517 g_signal_connect(G_OBJECT(window), "size_allocate",
518 G_CALLBACK(addrgather_size_allocate), NULL);
520 vbox = gtk_vbox_new(FALSE, 6);
521 gtk_container_add(GTK_CONTAINER(window), vbox);
524 notebook = gtk_notebook_new();
525 gtk_notebook_set_show_tabs(GTK_NOTEBOOK(notebook), FALSE);
526 gtk_widget_show(notebook);
527 gtk_box_pack_start(GTK_BOX(vbox), notebook, TRUE, TRUE, 0);
528 gtk_container_set_border_width(GTK_CONTAINER(notebook), 6);
531 hsbox = gtk_hbox_new(FALSE, 0);
532 gtk_box_pack_end(GTK_BOX(vbox), hsbox, FALSE, FALSE, 0);
533 statusbar = gtk_statusbar_new();
534 gtk_box_pack_start(GTK_BOX(hsbox), statusbar, TRUE, TRUE, 0);
537 gtkut_stock_button_set_create(&hbbox, &btnCancel, GTK_STOCK_CANCEL,
538 &btnOk, GTK_STOCK_OK,
540 gtk_box_pack_end(GTK_BOX(vbox), hbbox, FALSE, FALSE, 0);
542 /* Signal handlers */
543 g_signal_connect(G_OBJECT(btnOk), "clicked",
544 G_CALLBACK(addrgather_dlg_ok), NULL);
545 g_signal_connect(G_OBJECT(btnCancel), "clicked",
546 G_CALLBACK(addrgather_dlg_cancel), NULL);
548 if (!geometry.min_width) {
549 geometry.min_width = 450;
550 geometry.min_height = -1;
553 gtk_window_set_geometry_hints(GTK_WINDOW(window), NULL, &geometry,
555 gtk_window_set_default_size(GTK_WINDOW(window), prefs_common.addrgather_width,
556 prefs_common.addrgather_height);
558 addrgather_dlg.window = window;
559 addrgather_dlg.notebook = notebook;
560 addrgather_dlg.btnOk = btnOk;
561 addrgather_dlg.btnCancel = btnCancel;
562 addrgather_dlg.statusbar = statusbar;
563 addrgather_dlg.status_cid = gtk_statusbar_get_context_id(GTK_STATUSBAR(statusbar),
564 "Collect Email Address Dialog");
566 /* Create notebook pages */
567 addrgather_page_fields(PAGE_FIELDS, _("Header Fields"));
568 addrgather_page_finish(PAGE_FINISH, _("Finish"));
569 gtk_widget_show_all(addrgather_dlg.window);
573 * Harvest addresses main window.
574 * Enter: folderItem Source folder.
575 * addrIndex Address index.
576 * sourceInd Source indicator: FALSE - Folder, TRUE - Messages.
577 * msgList List of message numbers, or NULL to process folder.
578 * Return: Populated address book file, or NULL if none created.
580 #ifndef USE_NEW_ADDRBOOK
581 AddressBookFile *addrgather_dlg_execute(FolderItem *folderItem, AddressIndex *addrIndex,
582 gboolean sourceInd, GList *msgList)
584 void addrgather_dlg_execute(FolderItem *folderItem, gboolean sourceInd, GList *msgList)
589 #ifndef USE_NEW_ADDRBOOK
590 _harv_addressIndex_ = addrIndex;
591 _harv_addressBook_ = NULL;
593 _harv_messageList_ = msgList;
596 if (!addrgather_dlg.window)
597 addrgather_dlg_create();
599 addrgather_dlg.done = FALSE;
601 gtk_notebook_set_current_page(GTK_NOTEBOOK(addrgather_dlg.notebook), PAGE_FIELDS);
602 addrgather_dlg.folderPath = folder_item_get_path(folderItem);
604 /* Setup some default values */
606 gtk_label_set_text(GTK_LABEL(addrgather_dlg.labelFolder), folderItem->path);
607 #ifndef USE_NEW_ADDRBOOK
608 gtk_entry_set_text(GTK_ENTRY(addrgather_dlg.entryBook), folderItem->path);
611 for (i = 0; i < NUM_FIELDS; i++) {
612 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(addrgather_dlg.checkHeader[i]),
614 if (g_utf8_collate(_harv_headerNames_[i], HEADER_FROM) == 0)
615 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(addrgather_dlg.checkHeader[i]),
619 gtk_widget_set_sensitive(addrgather_dlg.btnOk, TRUE);
620 gtk_widget_set_sensitive(addrgather_dlg.btnCancel, TRUE);
621 gtk_widget_grab_default(addrgather_dlg.btnOk);
623 /* Apply window title */
625 gtk_window_set_title(GTK_WINDOW(addrgather_dlg.window),
626 _("Collect email addresses from selected messages"));
627 gtk_widget_set_sensitive(addrgather_dlg.checkRecurse, FALSE);
629 gtk_window_set_title(GTK_WINDOW(addrgather_dlg.window),
630 _("Collect email addresses from folder"));
631 gtk_widget_set_sensitive(addrgather_dlg.checkRecurse, TRUE);
633 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(addrgather_dlg.checkRecurse), FALSE);
635 addrgather_dlg_status_show("");
636 gtk_widget_show(addrgather_dlg.window);
637 gtk_window_set_modal(GTK_WINDOW(addrgather_dlg.window), TRUE);
638 gtk_widget_grab_focus(addrgather_dlg.entryBook);
639 manage_window_set_transient(GTK_WINDOW(addrgather_dlg.window));
642 g_free(addrgather_dlg.folderPath);
643 addrgather_dlg.folderPath = NULL;
644 gtk_widget_hide(addrgather_dlg.window);
645 gtk_window_set_modal(GTK_WINDOW(addrgather_dlg.window), FALSE);
646 #ifndef USE_NEW_ADDRBOOK
647 _harv_addressIndex_ = NULL;
649 if (addrgather_dlg.cancelled == TRUE)
652 return _harv_addressBook_;