2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2002 Match Grun
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 2 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, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 * Dialog for gathering EMail addresses from mail folder.
31 #include <gdk/gdkkeysyms.h>
32 #include <gtk/gtkmain.h>
33 #include <gtk/gtkwidget.h>
34 #include <gtk/gtkwindow.h>
35 #include <gtk/gtkvbox.h>
36 #include <gtk/gtktable.h>
37 #include <gtk/gtklabel.h>
38 #include <gtk/gtkentry.h>
39 #include <gtk/gtkhbbox.h>
40 #include <gtk/gtkbutton.h>
41 #include <gtk/gtkfilesel.h>
42 #include <gtk/gtksignal.h>
49 #include "foldersel.h"
51 #include "alertpanel.h"
52 #include "manage_window.h"
56 #include "addrharvest.h"
57 #include "addrindex.h"
60 #define PAGE_WARNING 0
66 #define FIELDS_N_COLS 2
67 #define FIELDS_COL_WIDTH_HEADER 100
68 #define FIELDS_COL_WIDTH_COUNT 140
70 #define MIN_FOLDER_SIZE 20
71 #define DFL_FOLDER_SIZE 50
81 static struct _AddrHarvest {
84 GtkWidget *labelFolder;
86 GtkWidget *checkHeader[ NUM_FIELDS ];
87 GtkWidget *spinbtnFolder;
88 GtkWidget *checkRecurse;
95 GtkWidget *clistCount;
98 static AddressIndex *_harv_addressIndex_;
99 static AddressBookFile *_harv_addressBook_;
100 static gchar *_harv_headerNames_[] = {
108 static GList *_harv_messageList_;
110 void addrgather_dlg_status_show( gchar *msg ) {
111 if( addrgather_dlg.statusbar != NULL ) {
112 gtk_statusbar_pop( GTK_STATUSBAR(addrgather_dlg.statusbar),
113 addrgather_dlg.status_cid );
116 GTK_STATUSBAR(addrgather_dlg.statusbar),
117 addrgather_dlg.status_cid, msg );
122 static gint addrgather_dlg_delete_event(
123 GtkWidget *widget, GdkEventAny *event, gpointer data )
125 addrgather_dlg.cancelled = TRUE;
130 static void addrgather_dlg_key_pressed(
131 GtkWidget *widget, GdkEventKey *event, gpointer data )
133 if( event && event->keyval == GDK_Escape ) {
134 addrgather_dlg.cancelled = TRUE;
139 #define FMT_BUFSIZE 32
141 static gboolean addrgather_dlg_harvest() {
143 gchar *text[ FIELDS_N_COLS ];
144 AddressHarvester *harvester;
145 AddressBookFile *abf;
148 gchar str[ FMT_BUFSIZE ];
153 name = gtk_editable_get_chars( GTK_EDITABLE(addrgather_dlg.entryBook), 0, -1 );
154 if( name == NULL || strlen( name ) < 1 ) {
155 addrgather_dlg_status_show(
156 _( "Please specify name for address book." ) );
161 /* Create harvest helper */
162 harvester = addrharvest_create();
163 addrharvest_set_path( harvester, addrgather_dlg.folderPath );
165 for( i = 0; i < NUM_FIELDS; i++ ) {
166 addrharvest_set_header( harvester, _harv_headerNames_[i],
167 gtk_toggle_button_get_active(
168 GTK_TOGGLE_BUTTON(addrgather_dlg.checkHeader[i]) ) );
170 addrharvest_set_recurse( harvester,
171 gtk_toggle_button_get_active(
172 GTK_TOGGLE_BUTTON( addrgather_dlg.checkRecurse ) ) );
174 if( addrharvest_check_header( harvester ) == FALSE ) {
175 addrgather_dlg_status_show(
176 _( "Please select the mail headers to search." ) );
177 addrharvest_free( harvester );
182 addrgather_dlg_status_show( _( "Busy harvesting addresses..." ) );
183 sz = gtk_spin_button_get_value_as_int(
184 GTK_SPIN_BUTTON( addrgather_dlg.spinbtnFolder ) );
185 addrharvest_set_folder_size( harvester, sz );
187 /* Create address book */
188 abf = addrbook_create_book();
189 addrbook_set_path( abf, _harv_addressIndex_->filePath );
190 newFile = addrbook_guess_next_file( abf );
191 addrbook_set_file( abf, newFile );
192 addrbook_set_name( abf, name );
196 /* Harvest addresses */
198 harvester, abf->addressCache, _harv_messageList_ );
199 addrbook_save_data( abf );
200 _harv_addressBook_ = abf;
202 /* Update summary count */
203 clist = GTK_CLIST(addrgather_dlg.clistCount);
204 gtk_clist_clear( clist );
205 for( i = 0; i < NUM_FIELDS; i++ ) {
206 cnt = addrharvest_get_count( harvester, _harv_headerNames_[i] );
211 sprintf( str, "%d", cnt );
213 text[ FIELD_COL_HEADER ] = _harv_headerNames_[i];
214 text[ FIELD_COL_COUNT ] = str;
215 gtk_clist_append( clist, text );
218 addrharvest_free( harvester );
220 addrgather_dlg_status_show( _("Addresses gathered successfully.") );
222 /* Display summary page */
223 gtk_notebook_set_page(
224 GTK_NOTEBOOK(addrgather_dlg.notebook), PAGE_FINISH );
225 gtk_widget_set_sensitive( addrgather_dlg.btnOk, FALSE );
226 gtk_widget_grab_default( addrgather_dlg.btnCancel );
231 static void addrgather_dlg_ok( GtkWidget *widget, gpointer data ) {
232 if( addrgather_dlg_harvest() ) {
233 addrgather_dlg.cancelled = FALSE;
237 static void addrgather_dlg_cancel( GtkWidget *widget, gpointer data ) {
241 #define PACK_CHECK_BUTTON(box, chkbtn, label) \
243 chkbtn = gtk_check_button_new_with_label(label); \
244 gtk_widget_show(chkbtn); \
245 gtk_box_pack_start(GTK_BOX(box), chkbtn, FALSE, TRUE, 0); \
249 * Create notebook page for warning message.
250 * Enter: pageNum Page number.
251 * pageLbl Page label.
253 static void addrgather_page_warning( gint pageNum, gchar *pageLbl ) {
259 vbox = gtk_vbox_new(FALSE, 8);
260 gtk_container_add( GTK_CONTAINER( addrgather_dlg.notebook ), vbox );
261 gtk_container_set_border_width( GTK_CONTAINER (vbox), BORDER_WIDTH );
263 label = gtk_label_new( pageLbl );
264 gtk_widget_show( label );
265 gtk_notebook_set_tab_label(
266 GTK_NOTEBOOK( addrgather_dlg.notebook ),
267 gtk_notebook_get_nth_page( GTK_NOTEBOOK( addrgather_dlg.notebook ), pageNum ),
270 table = gtk_table_new(3, 2, FALSE);
271 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
272 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
273 gtk_table_set_row_spacings(GTK_TABLE(table), 8);
274 gtk_table_set_col_spacings(GTK_TABLE(table), 8 );
278 label = gtk_label_new(_(""));
279 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
280 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
284 label = gtk_label_new( _("No folder or message was selected." ) );
285 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
286 gtk_label_set_justify( GTK_LABEL(label), GTK_JUSTIFY_LEFT );
287 gtk_misc_set_alignment( GTK_MISC(label), 0, 0.5 );
291 label = gtk_label_new( _(
292 "Please select a folder to process from the folder\n"
293 "list. Alternatively, select one or messages from\n"
294 "the message list." ) );
296 gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
297 gtk_label_set_justify( GTK_LABEL(label), GTK_JUSTIFY_LEFT );
298 gtk_misc_set_alignment( GTK_MISC(label), 0, 0.5 );
302 * Create notebook page for mail headers.
303 * Enter: pageNum Page number.
304 * pageLbl Page label.
306 static void addrgather_page_fields( gint pageNum, gchar *pageLbl ) {
312 GtkWidget *labelFolder;
313 GtkWidget *entryBook;
314 GtkWidget *frameHeader;
315 GtkWidget *checkHeader[ NUM_FIELDS ];
316 GtkWidget *spinbtnFolder;
317 GtkObject *adjFolder;
318 GtkWidget *checkRecurse;
323 vbox = gtk_vbox_new(FALSE, 8);
324 gtk_container_add( GTK_CONTAINER( addrgather_dlg.notebook ), vbox );
325 gtk_container_set_border_width( GTK_CONTAINER (vbox), 4 );
328 label = gtk_label_new( pageLbl );
329 gtk_widget_show( label );
330 gtk_notebook_set_tab_label(
331 GTK_NOTEBOOK( addrgather_dlg.notebook ),
332 gtk_notebook_get_nth_page( GTK_NOTEBOOK( addrgather_dlg.notebook ), pageNum ),
335 /* Upper area - Field list */
336 table = gtk_table_new( 4, 2, FALSE);
337 gtk_box_pack_start( GTK_BOX(vbox), table, FALSE, FALSE, 0 );
338 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
339 gtk_table_set_row_spacings( GTK_TABLE(table), 8 );
340 gtk_table_set_col_spacings( GTK_TABLE(table), 8 );
344 label = gtk_label_new( _("Folder :") );
345 gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0 );
346 gtk_misc_set_alignment( GTK_MISC(label), 1.0, 0.5 );
348 labelFolder = gtk_label_new( "" );
349 gtk_table_attach( GTK_TABLE(table), labelFolder, 1, 2, top, (top + 1),
350 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0 );
351 gtk_misc_set_alignment( GTK_MISC(labelFolder), 0, 0.5 );
355 label = gtk_label_new( _("Address Book :") );
356 gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0 );
357 gtk_misc_set_alignment( GTK_MISC(label), 1.0, 0.5 );
359 entryBook = gtk_entry_new();
360 gtk_table_attach( GTK_TABLE(table), entryBook, 1, 2, top, (top + 1),
361 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0 );
365 label = gtk_label_new( _("Folder Size :") );
366 gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0 );
367 gtk_misc_set_alignment( GTK_MISC(label), 1.0, 0.5 );
369 hboxs = gtk_hbox_new( FALSE, 8 );
371 gtk_adjustment_new( DFL_FOLDER_SIZE, MIN_FOLDER_SIZE, G_MAXINT, 1, 10, 100 );
372 spinbtnFolder = gtk_spin_button_new( GTK_ADJUSTMENT(adjFolder), 1, 0 );
373 gtk_box_pack_start( GTK_BOX(hboxs), spinbtnFolder, FALSE, FALSE, 0);
374 gtk_widget_set_usize( spinbtnFolder, 100, -1);
375 gtk_spin_button_set_numeric( GTK_SPIN_BUTTON(spinbtnFolder), TRUE );
376 gtk_table_attach( GTK_TABLE(table), hboxs, 1, 2, top, (top + 1), GTK_FILL, 0, 0, 0 );
380 frameHeader = gtk_frame_new( _("Process these mail header fields") );
381 gtk_widget_show( frameHeader );
382 gtk_table_attach( GTK_TABLE(table), frameHeader, 0, 2, top, (top + 4), GTK_FILL, 0, 0, 0 );
383 gtk_frame_set_label_align( GTK_FRAME(frameHeader), 0.01, 0.5 );
386 vboxf = gtk_vbox_new( FALSE, 0 );
387 gtk_widget_show( vboxf );
388 gtk_container_add( GTK_CONTAINER( frameHeader ), vboxf );
389 gtk_container_set_border_width (GTK_CONTAINER( vboxf ), 8);
391 for( i = 0; i < NUM_FIELDS; i++ ) {
392 PACK_CHECK_BUTTON( vboxf, checkHeader[i], _harv_headerNames_[i] );
393 addrgather_dlg.checkHeader[i] = checkHeader[i];
396 /* Recurse folders */
398 checkRecurse = gtk_check_button_new_with_label( _("Include sub-folders" ) );
399 gtk_table_attach( GTK_TABLE(table), checkRecurse, 0, 2, top, (top + 1),
400 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0 );
402 addrgather_dlg.labelFolder = labelFolder;
403 addrgather_dlg.entryBook = entryBook;
404 addrgather_dlg.spinbtnFolder = spinbtnFolder;
405 addrgather_dlg.checkRecurse = checkRecurse;
409 * Create notebook page for summary counts.
410 * Enter: pageNum Page number.
411 * pageLbl Page label.
413 static void addrgather_page_finish( gint pageNum, gchar *pageLbl ) {
416 GtkWidget *clistSWin;
417 GtkWidget *clistCount;
418 gchar *titles[ FIELDS_N_COLS ];
421 titles[ FIELD_COL_HEADER ] = _("Header Name");
422 titles[ FIELD_COL_COUNT ] = _("Address Count");
424 vbox = gtk_vbox_new(FALSE, 8);
425 gtk_container_add( GTK_CONTAINER( addrgather_dlg.notebook ), vbox );
426 gtk_container_set_border_width( GTK_CONTAINER (vbox), 8 );
428 label = gtk_label_new( pageLbl );
429 gtk_widget_show( label );
430 gtk_notebook_set_tab_label(
431 GTK_NOTEBOOK( addrgather_dlg.notebook ),
432 gtk_notebook_get_nth_page( GTK_NOTEBOOK( addrgather_dlg.notebook ), pageNum ),
436 clistSWin = gtk_scrolled_window_new( NULL, NULL );
437 gtk_container_add( GTK_CONTAINER(vbox), clistSWin );
438 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(clistSWin),
439 GTK_POLICY_AUTOMATIC,
442 clistCount = gtk_clist_new_with_titles( FIELDS_N_COLS, titles );
443 gtk_container_add( GTK_CONTAINER(clistSWin), clistCount );
444 gtk_clist_set_selection_mode( GTK_CLIST(clistCount), GTK_SELECTION_BROWSE );
445 gtk_clist_set_column_width(
446 GTK_CLIST(clistCount), FIELD_COL_HEADER, FIELDS_COL_WIDTH_HEADER );
447 gtk_clist_set_column_width(
448 GTK_CLIST(clistCount), FIELD_COL_COUNT, FIELDS_COL_WIDTH_COUNT );
450 for( i = 0; i < FIELDS_N_COLS; i++ )
451 GTK_WIDGET_UNSET_FLAGS(GTK_CLIST(clistCount)->column[i].button, GTK_CAN_FOCUS);
453 addrgather_dlg.clistCount = clistCount;
457 * Create notebook page for warning message.
458 * Enter: pageNum Page number.
459 * pageLbl Page label.
461 static void addrgather_dlg_create( void ) {
465 GtkWidget *btnCancel;
466 GtkWidget *statusbar;
472 window = gtk_window_new( GTK_WINDOW_DIALOG );
473 gtk_widget_set_usize( window, 380, -1 );
474 gtk_container_set_border_width(GTK_CONTAINER(window), 0);
475 gtk_window_set_position( GTK_WINDOW(window), GTK_WIN_POS_CENTER );
476 gtk_window_set_modal( GTK_WINDOW(window), TRUE );
477 gtk_signal_connect( GTK_OBJECT(window), "delete_event",
478 GTK_SIGNAL_FUNC( addrgather_dlg_delete_event ), NULL );
479 gtk_signal_connect( GTK_OBJECT(window), "key_press_event",
480 GTK_SIGNAL_FUNC( addrgather_dlg_key_pressed ), NULL );
482 vbox = gtk_vbox_new( FALSE, 8 );
483 gtk_container_add( GTK_CONTAINER(window), vbox );
484 gtk_container_set_border_width( GTK_CONTAINER(vbox), 0 );
486 vnbox = gtk_vbox_new(FALSE, 4);
487 gtk_container_set_border_width(GTK_CONTAINER(vnbox), 4);
488 gtk_widget_show(vnbox);
489 gtk_box_pack_start(GTK_BOX(vbox), vnbox, TRUE, TRUE, 0);
492 notebook = gtk_notebook_new();
493 gtk_notebook_set_show_tabs( GTK_NOTEBOOK(notebook), FALSE );
494 gtk_widget_show(notebook);
495 gtk_box_pack_start(GTK_BOX(vnbox), notebook, TRUE, TRUE, 0);
496 gtk_container_set_border_width(GTK_CONTAINER(notebook), 6);
499 hsbox = gtk_hbox_new( FALSE, 0 );
500 gtk_box_pack_end( GTK_BOX(vbox), hsbox, FALSE, FALSE, BORDER_WIDTH );
501 statusbar = gtk_statusbar_new();
502 gtk_box_pack_start( GTK_BOX(hsbox), statusbar, TRUE, TRUE, BORDER_WIDTH );
505 gtkut_button_set_create( &hbbox, &btnOk, _("OK"),
506 &btnCancel, _("Cancel"), NULL, NULL );
507 gtk_box_pack_end( GTK_BOX(vbox), hbbox, FALSE, FALSE, 0 );
508 gtk_container_set_border_width( GTK_CONTAINER(hbbox), 0 );
510 /* Signal handlers */
511 gtk_signal_connect( GTK_OBJECT(btnOk), "clicked",
512 GTK_SIGNAL_FUNC(addrgather_dlg_ok), NULL );
513 gtk_signal_connect( GTK_OBJECT(btnCancel), "clicked",
514 GTK_SIGNAL_FUNC(addrgather_dlg_cancel), NULL );
516 gtk_widget_show_all( vbox );
517 addrgather_dlg.window = window;
518 addrgather_dlg.notebook = notebook;
519 addrgather_dlg.btnOk = btnOk;
520 addrgather_dlg.btnCancel = btnCancel;
521 addrgather_dlg.statusbar = statusbar;
522 addrgather_dlg.status_cid = gtk_statusbar_get_context_id(
523 GTK_STATUSBAR(statusbar), "Harvest E-Mail Address Dialog" );
525 /* Create notebook pages */
526 addrgather_page_warning( PAGE_WARNING, _( "Warning" ) );
527 addrgather_page_fields( PAGE_FIELDS, _( "Header Fields" ) );
528 addrgather_page_finish( PAGE_FINISH, _( "Finish" ) );
529 gtk_widget_show_all( addrgather_dlg.window );
533 * Harvest addresses main window.
534 * Enter: folderItem Source folder.
535 * addrIndex Address index.
536 * sourceInd Source indicator: FALSE - Folder, TRUE - Messages.
537 * msgList List of message numbers, or NULL to process folder.
538 * Return: Populated address book file, or NULL if none created.
540 AddressBookFile *addrgather_dlg_execute(
541 FolderItem *folderItem, AddressIndex *addrIndex, gboolean sourceInd,
547 _harv_addressIndex_ = addrIndex;
548 _harv_addressBook_ = NULL;
549 _harv_messageList_ = msgList;
552 if( ! addrgather_dlg.window ) {
553 addrgather_dlg_create();
557 if( folderItem && folderItem->path ) {
558 gtk_notebook_set_page(
559 GTK_NOTEBOOK(addrgather_dlg.notebook), PAGE_FIELDS );
560 addrgather_dlg.folderPath = folder_item_get_path( folderItem );
562 /* Setup some default values */
564 GTK_LABEL(addrgather_dlg.labelFolder), folderItem->path );
566 GTK_ENTRY(addrgather_dlg.entryBook), folderItem->path );
568 for( i = 0; i < NUM_FIELDS; i++ ) {
569 gtk_toggle_button_set_active(
570 GTK_TOGGLE_BUTTON(addrgather_dlg.checkHeader[i]),
572 if( g_strcasecmp( _harv_headerNames_[i], HEADER_FROM ) == 0 ) {
573 gtk_toggle_button_set_active(
574 GTK_TOGGLE_BUTTON(addrgather_dlg.checkHeader[i]),
579 gtk_widget_set_sensitive( addrgather_dlg.btnOk, TRUE );
580 gtk_widget_grab_default( addrgather_dlg.btnOk );
584 /* Apply window title */
586 gtk_window_set_title( GTK_WINDOW(addrgather_dlg.window),
587 _("Harvest E-Mail Addresses - from Selected Messages") );
588 gtk_widget_set_sensitive( addrgather_dlg.checkRecurse, FALSE );
589 if( msgList == NULL ) {
594 gtk_window_set_title( GTK_WINDOW(addrgather_dlg.window),
595 _("Harvest E-Mail Addresses - from Folder") );
596 gtk_widget_set_sensitive( addrgather_dlg.checkRecurse, TRUE );
598 gtk_toggle_button_set_active(
599 GTK_TOGGLE_BUTTON( addrgather_dlg.checkRecurse ), FALSE );
601 addrgather_dlg_status_show( "" );
602 gtk_widget_show( addrgather_dlg.window );
605 gtk_notebook_set_page(
606 GTK_NOTEBOOK(addrgather_dlg.notebook), PAGE_WARNING );
607 gtk_widget_set_sensitive( addrgather_dlg.btnOk, FALSE );
608 gtk_widget_grab_default( addrgather_dlg.btnCancel );
611 gtk_widget_grab_focus( addrgather_dlg.entryBook );
613 manage_window_set_transient( GTK_WINDOW(addrgather_dlg.window) );
617 g_free( addrgather_dlg.folderPath );
618 addrgather_dlg.folderPath = NULL;
620 gtk_widget_hide( addrgather_dlg.window );
621 _harv_addressIndex_ = NULL;
623 if( addrgather_dlg.cancelled == TRUE ) return NULL;
625 return _harv_addressBook_;