2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2002-2007 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.
31 #include <glib/gi18n.h>
32 #include <gdk/gdkkeysyms.h>
33 #include <gtk/gtkmain.h>
34 #include <gtk/gtkwidget.h>
35 #include <gtk/gtkwindow.h>
36 #include <gtk/gtkvbox.h>
37 #include <gtk/gtktable.h>
38 #include <gtk/gtklabel.h>
39 #include <gtk/gtkentry.h>
40 #include <gtk/gtkhbbox.h>
41 #include <gtk/gtkbutton.h>
42 #include <gtk/gtkfilesel.h>
43 #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
;
96 GtkWidget
*clistCount
;
99 static AddressIndex
*_harv_addressIndex_
;
100 static AddressBookFile
*_harv_addressBook_
;
101 static gchar
*_harv_headerNames_
[] = {
109 static GList
*_harv_messageList_
;
111 static void addrgather_dlg_status_show( gchar
*msg
) {
112 if( addrgather_dlg
.statusbar
!= NULL
) {
113 gtk_statusbar_pop( GTK_STATUSBAR(addrgather_dlg
.statusbar
),
114 addrgather_dlg
.status_cid
);
117 GTK_STATUSBAR(addrgather_dlg
.statusbar
),
118 addrgather_dlg
.status_cid
, msg
);
123 static gint
addrgather_dlg_delete_event(
124 GtkWidget
*widget
, GdkEventAny
*event
, gpointer data
)
126 addrgather_dlg
.cancelled
= TRUE
;
131 static gboolean
addrgather_dlg_key_pressed(
132 GtkWidget
*widget
, GdkEventKey
*event
, gpointer data
)
134 if( event
&& event
->keyval
== GDK_Escape
) {
135 addrgather_dlg
.cancelled
= TRUE
;
141 #define FMT_BUFSIZE 32
143 static gboolean
addrgather_dlg_harvest() {
145 gchar
*text
[ FIELDS_N_COLS
];
146 AddressHarvester
*harvester
;
147 AddressBookFile
*abf
;
150 gchar str
[ FMT_BUFSIZE
];
155 name
= gtk_editable_get_chars( GTK_EDITABLE(addrgather_dlg
.entryBook
), 0, -1 );
156 if( name
== NULL
|| strlen( name
) < 1 ) {
157 addrgather_dlg_status_show(
158 _( "Please specify name for address book." ) );
163 /* Create harvest helper */
164 harvester
= addrharvest_create();
165 addrharvest_set_path( harvester
, addrgather_dlg
.folderPath
);
167 for( i
= 0; i
< NUM_FIELDS
; i
++ ) {
168 addrharvest_set_header( harvester
, _harv_headerNames_
[i
],
169 gtk_toggle_button_get_active(
170 GTK_TOGGLE_BUTTON(addrgather_dlg
.checkHeader
[i
]) ) );
172 addrharvest_set_recurse( harvester
,
173 gtk_toggle_button_get_active(
174 GTK_TOGGLE_BUTTON( addrgather_dlg
.checkRecurse
) ) );
176 if( addrharvest_check_header( harvester
) == FALSE
) {
177 addrgather_dlg_status_show(
178 _( "Please select the mail headers to search." ) );
179 addrharvest_free( harvester
);
185 addrgather_dlg_status_show( _( "Harvesting addresses..." ) );
187 sz
= gtk_spin_button_get_value_as_int(
188 GTK_SPIN_BUTTON( addrgather_dlg
.spinbtnFolder
) );
189 addrharvest_set_folder_size( harvester
, sz
);
191 /* Create address book */
192 abf
= addrbook_create_book();
193 addrbook_set_path( abf
, _harv_addressIndex_
->filePath
);
194 newFile
= addrbook_guess_next_file( abf
);
195 addrbook_set_file( abf
, newFile
);
196 addrbook_set_name( abf
, name
);
200 /* Harvest addresses */
202 harvester
, abf
->addressCache
, _harv_messageList_
);
203 addrbook_save_data( abf
);
204 _harv_addressBook_
= abf
;
206 /* Update summary count */
207 clist
= GTK_CLIST(addrgather_dlg
.clistCount
);
208 gtk_clist_clear( clist
);
209 for( i
= 0; i
< NUM_FIELDS
; i
++ ) {
210 cnt
= addrharvest_get_count( harvester
, _harv_headerNames_
[i
] );
215 sprintf( str
, "%d", cnt
);
217 text
[ FIELD_COL_HEADER
] = _harv_headerNames_
[i
];
218 text
[ FIELD_COL_COUNT
] = str
;
219 gtk_clist_append( clist
, text
);
222 addrharvest_free( harvester
);
224 addrgather_dlg_status_show( _("Addresses gathered successfully.") );
226 /* Display summary page */
227 gtk_notebook_set_current_page(
228 GTK_NOTEBOOK(addrgather_dlg
.notebook
), PAGE_FINISH
);
229 addrgather_dlg
.done
= TRUE
;
230 gtk_widget_set_sensitive( addrgather_dlg
.btnCancel
, FALSE
);
231 gtk_widget_grab_default( addrgather_dlg
.btnOk
);
236 static void addrgather_dlg_ok( GtkWidget
*widget
, gpointer data
) {
237 if(addrgather_dlg
.done
) {
238 addrgather_dlg
.done
= FALSE
;
242 if( addrgather_dlg_harvest() ) {
243 addrgather_dlg
.cancelled
= FALSE
;
247 static void addrgather_dlg_cancel( GtkWidget
*widget
, gpointer data
) {
251 #define PACK_CHECK_BUTTON(box, checkbtn, label) \
253 checkbtn = gtk_check_button_new_with_label(label); \
254 gtk_widget_show(checkbtn); \
255 gtk_box_pack_start(GTK_BOX(box), checkbtn, FALSE, TRUE, 0); \
259 * Create notebook page for warning message.
260 * Enter: pageNum Page number.
261 * pageLbl Page label.
263 static void addrgather_page_warning( gint pageNum
, gchar
*pageLbl
) {
269 vbox
= gtk_vbox_new(FALSE
, 8);
270 gtk_container_add( GTK_CONTAINER( addrgather_dlg
.notebook
), vbox
);
271 gtk_container_set_border_width( GTK_CONTAINER (vbox
), BORDER_WIDTH
);
273 label
= gtk_label_new( pageLbl
);
274 gtk_widget_show( label
);
275 gtk_notebook_set_tab_label(
276 GTK_NOTEBOOK( addrgather_dlg
.notebook
),
277 gtk_notebook_get_nth_page( GTK_NOTEBOOK( addrgather_dlg
.notebook
), pageNum
),
280 table
= gtk_table_new(3, 2, FALSE
);
281 gtk_box_pack_start(GTK_BOX(vbox
), table
, FALSE
, FALSE
, 0);
282 gtk_container_set_border_width( GTK_CONTAINER(table
), 8 );
283 gtk_table_set_row_spacings(GTK_TABLE(table
), 8);
284 gtk_table_set_col_spacings(GTK_TABLE(table
), 8 );
288 label
= gtk_label_new("");
289 gtk_table_attach(GTK_TABLE(table
), label
, 0, 1, top
, (top
+ 1), GTK_FILL
, 0, 0, 0);
290 gtk_misc_set_alignment(GTK_MISC(label
), 0, 0.5);
294 label
= gtk_label_new( _("No folder or message was selected." ) );
295 gtk_table_attach(GTK_TABLE(table
), label
, 0, 1, top
, (top
+ 1), GTK_FILL
, 0, 0, 0);
296 gtk_label_set_justify( GTK_LABEL(label
), GTK_JUSTIFY_LEFT
);
297 gtk_misc_set_alignment( GTK_MISC(label
), 0, 0.5 );
301 label
= gtk_label_new( _(
302 "Please select a folder to process from the folder\n"
303 "list. Alternatively, select one or messages from\n"
304 "the message list." ) );
306 gtk_table_attach( GTK_TABLE(table
), label
, 0, 1, top
, (top
+ 1), GTK_FILL
, 0, 0, 0);
307 gtk_label_set_justify( GTK_LABEL(label
), GTK_JUSTIFY_LEFT
);
308 gtk_misc_set_alignment( GTK_MISC(label
), 0, 0.5 );
312 * Create notebook page for mail headers.
313 * Enter: pageNum Page number.
314 * pageLbl Page label.
316 static void addrgather_page_fields( gint pageNum
, gchar
*pageLbl
) {
322 GtkWidget
*labelFolder
;
323 GtkWidget
*entryBook
;
324 GtkWidget
*frameHeader
;
325 GtkWidget
*checkHeader
[ NUM_FIELDS
];
326 GtkWidget
*spinbtnFolder
;
327 GtkObject
*adjFolder
;
328 GtkWidget
*checkRecurse
;
333 vbox
= gtk_vbox_new(FALSE
, 8);
334 gtk_container_add( GTK_CONTAINER( addrgather_dlg
.notebook
), vbox
);
335 gtk_container_set_border_width( GTK_CONTAINER (vbox
), 4 );
338 label
= gtk_label_new( pageLbl
);
339 gtk_widget_show( label
);
340 gtk_notebook_set_tab_label(
341 GTK_NOTEBOOK( addrgather_dlg
.notebook
),
342 gtk_notebook_get_nth_page( GTK_NOTEBOOK( addrgather_dlg
.notebook
), pageNum
),
345 /* Upper area - Field list */
346 table
= gtk_table_new( 4, 2, FALSE
);
347 gtk_box_pack_start( GTK_BOX(vbox
), table
, FALSE
, FALSE
, 0 );
348 gtk_container_set_border_width( GTK_CONTAINER(table
), 8 );
349 gtk_table_set_row_spacings( GTK_TABLE(table
), 8 );
350 gtk_table_set_col_spacings( GTK_TABLE(table
), 8 );
354 label
= gtk_label_new( _("Folder :") );
355 gtk_table_attach( GTK_TABLE(table
), label
, 0, 1, top
, (top
+ 1), GTK_FILL
, 0, 0, 0 );
356 gtk_misc_set_alignment( GTK_MISC(label
), 1.0, 0.5 );
358 labelFolder
= gtk_label_new( "" );
359 gtk_table_attach( GTK_TABLE(table
), labelFolder
, 1, 2, top
, (top
+ 1),
360 GTK_EXPAND
|GTK_SHRINK
|GTK_FILL
, 0, 0, 0 );
361 gtk_misc_set_alignment( GTK_MISC(labelFolder
), 0, 0.5 );
365 label
= gtk_label_new( _("Address Book :") );
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 entryBook
= gtk_entry_new();
370 gtk_table_attach( GTK_TABLE(table
), entryBook
, 1, 2, top
, (top
+ 1),
371 GTK_EXPAND
|GTK_SHRINK
|GTK_FILL
, 0, 0, 0 );
375 label
= gtk_label_new( _("Folder Size :") );
376 gtk_table_attach( GTK_TABLE(table
), label
, 0, 1, top
, (top
+ 1), GTK_FILL
, 0, 0, 0 );
377 gtk_misc_set_alignment( GTK_MISC(label
), 1.0, 0.5 );
379 hboxs
= gtk_hbox_new( FALSE
, 8 );
381 gtk_adjustment_new( DFL_FOLDER_SIZE
, MIN_FOLDER_SIZE
, G_MAXINT
, 1, 10, 100 );
382 spinbtnFolder
= gtk_spin_button_new( GTK_ADJUSTMENT(adjFolder
), 1, 0 );
383 gtk_box_pack_start( GTK_BOX(hboxs
), spinbtnFolder
, FALSE
, FALSE
, 0);
384 gtk_widget_set_size_request( spinbtnFolder
, 100, -1);
385 gtk_spin_button_set_numeric( GTK_SPIN_BUTTON(spinbtnFolder
), TRUE
);
386 gtk_table_attach( GTK_TABLE(table
), hboxs
, 1, 2, top
, (top
+ 1), GTK_FILL
, 0, 0, 0 );
390 frameHeader
= gtk_frame_new( _("Process these mail header fields") );
391 gtk_widget_show( frameHeader
);
392 gtk_table_attach( GTK_TABLE(table
), frameHeader
, 0, 2, top
, (top
+ 4), GTK_FILL
, 0, 0, 0 );
393 gtk_frame_set_label_align( GTK_FRAME(frameHeader
), 0.01, 0.5 );
396 vboxf
= gtk_vbox_new( FALSE
, 0 );
397 gtk_widget_show( vboxf
);
398 gtk_container_add( GTK_CONTAINER( frameHeader
), vboxf
);
399 gtk_container_set_border_width (GTK_CONTAINER( vboxf
), 8);
401 for( i
= 0; i
< NUM_FIELDS
; i
++ ) {
402 PACK_CHECK_BUTTON( vboxf
, checkHeader
[i
], _harv_headerNames_
[i
] );
403 addrgather_dlg
.checkHeader
[i
] = checkHeader
[i
];
406 /* Recurse folders */
408 checkRecurse
= gtk_check_button_new_with_label( _("Include subfolders" ) );
409 gtk_table_attach( GTK_TABLE(table
), checkRecurse
, 0, 2, top
, (top
+ 1),
410 GTK_EXPAND
|GTK_SHRINK
|GTK_FILL
, 0, 0, 0 );
412 addrgather_dlg
.labelFolder
= labelFolder
;
413 addrgather_dlg
.entryBook
= entryBook
;
414 addrgather_dlg
.spinbtnFolder
= spinbtnFolder
;
415 addrgather_dlg
.checkRecurse
= checkRecurse
;
419 * Create notebook page for summary counts.
420 * Enter: pageNum Page number.
421 * pageLbl Page label.
423 static void addrgather_page_finish( gint pageNum
, gchar
*pageLbl
) {
426 GtkWidget
*clistSWin
;
427 GtkWidget
*clistCount
;
428 gchar
*titles
[ FIELDS_N_COLS
];
431 titles
[ FIELD_COL_HEADER
] = _("Header Name");
432 titles
[ FIELD_COL_COUNT
] = _("Address Count");
434 vbox
= gtk_vbox_new(FALSE
, 8);
435 gtk_container_add( GTK_CONTAINER( addrgather_dlg
.notebook
), vbox
);
436 gtk_container_set_border_width( GTK_CONTAINER (vbox
), 8 );
438 label
= gtk_label_new( pageLbl
);
439 gtk_widget_show( label
);
440 gtk_notebook_set_tab_label(
441 GTK_NOTEBOOK( addrgather_dlg
.notebook
),
442 gtk_notebook_get_nth_page( GTK_NOTEBOOK( addrgather_dlg
.notebook
), pageNum
),
446 clistSWin
= gtk_scrolled_window_new( NULL
, NULL
);
447 gtk_container_add( GTK_CONTAINER(vbox
), clistSWin
);
448 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(clistSWin
),
449 GTK_POLICY_AUTOMATIC
,
450 GTK_POLICY_AUTOMATIC
);
452 clistCount
= gtk_clist_new_with_titles( FIELDS_N_COLS
, titles
);
453 gtk_container_add( GTK_CONTAINER(clistSWin
), clistCount
);
454 gtk_clist_set_selection_mode( GTK_CLIST(clistCount
), GTK_SELECTION_BROWSE
);
455 gtk_clist_set_column_width(
456 GTK_CLIST(clistCount
), FIELD_COL_HEADER
, FIELDS_COL_WIDTH_HEADER
);
457 gtk_clist_set_column_width(
458 GTK_CLIST(clistCount
), FIELD_COL_COUNT
, FIELDS_COL_WIDTH_COUNT
);
460 for( i
= 0; i
< FIELDS_N_COLS
; i
++ )
461 GTK_WIDGET_UNSET_FLAGS(GTK_CLIST(clistCount
)->column
[i
].button
, GTK_CAN_FOCUS
);
463 addrgather_dlg
.clistCount
= clistCount
;
467 * Create notebook page for warning message.
468 * Enter: pageNum Page number.
469 * pageLbl Page label.
471 static void addrgather_dlg_create( void ) {
475 GtkWidget
*btnCancel
;
476 GtkWidget
*statusbar
;
482 window
= gtkut_window_new(GTK_WINDOW_TOPLEVEL
, "addrgather" );
483 gtk_widget_set_size_request( window
, 380, -1 );
484 gtk_container_set_border_width(GTK_CONTAINER(window
), 0);
485 gtk_window_set_position( GTK_WINDOW(window
), GTK_WIN_POS_CENTER
);
486 gtk_window_set_modal( GTK_WINDOW(window
), TRUE
);
487 g_signal_connect(G_OBJECT(window
), "delete_event",
488 G_CALLBACK(addrgather_dlg_delete_event
), NULL
);
489 g_signal_connect(G_OBJECT(window
), "key_press_event",
490 G_CALLBACK(addrgather_dlg_key_pressed
), NULL
);
492 vbox
= gtk_vbox_new( FALSE
, 8 );
493 gtk_container_add( GTK_CONTAINER(window
), vbox
);
494 gtk_container_set_border_width( GTK_CONTAINER(vbox
), 0 );
496 vnbox
= gtk_vbox_new(FALSE
, 4);
497 gtk_container_set_border_width(GTK_CONTAINER(vnbox
), 4);
498 gtk_widget_show(vnbox
);
499 gtk_box_pack_start(GTK_BOX(vbox
), vnbox
, TRUE
, TRUE
, 0);
502 notebook
= gtk_notebook_new();
503 gtk_notebook_set_show_tabs( GTK_NOTEBOOK(notebook
), FALSE
);
504 gtk_widget_show(notebook
);
505 gtk_box_pack_start(GTK_BOX(vnbox
), notebook
, TRUE
, TRUE
, 0);
506 gtk_container_set_border_width(GTK_CONTAINER(notebook
), 6);
509 hsbox
= gtk_hbox_new( FALSE
, 0 );
510 gtk_box_pack_end( GTK_BOX(vbox
), hsbox
, FALSE
, FALSE
, BORDER_WIDTH
);
511 statusbar
= gtk_statusbar_new();
512 gtk_box_pack_start( GTK_BOX(hsbox
), statusbar
, TRUE
, TRUE
, BORDER_WIDTH
);
515 gtkut_stock_button_set_create(&hbbox
, &btnOk
, GTK_STOCK_OK
,
516 &btnCancel
, GTK_STOCK_CANCEL
,
518 gtk_box_pack_end( GTK_BOX(vbox
), hbbox
, FALSE
, FALSE
, 0 );
519 gtk_container_set_border_width( GTK_CONTAINER(hbbox
), 10 );
521 /* Signal handlers */
522 g_signal_connect(G_OBJECT(btnOk
), "clicked",
523 G_CALLBACK(addrgather_dlg_ok
), NULL
);
524 g_signal_connect(G_OBJECT(btnCancel
), "clicked",
525 G_CALLBACK(addrgather_dlg_cancel
), NULL
);
527 gtk_widget_show_all( vbox
);
528 addrgather_dlg
.window
= window
;
529 addrgather_dlg
.notebook
= notebook
;
530 addrgather_dlg
.btnOk
= btnOk
;
531 addrgather_dlg
.btnCancel
= btnCancel
;
532 addrgather_dlg
.statusbar
= statusbar
;
533 addrgather_dlg
.status_cid
= gtk_statusbar_get_context_id(
534 GTK_STATUSBAR(statusbar
), "Harvest Email Address Dialog" );
536 /* Create notebook pages */
537 addrgather_page_warning( PAGE_WARNING
, _( "Warning" ) );
538 addrgather_page_fields( PAGE_FIELDS
, _( "Header Fields" ) );
539 addrgather_page_finish( PAGE_FINISH
, _( "Finish" ) );
540 gtk_widget_show_all( addrgather_dlg
.window
);
544 * Harvest addresses main window.
545 * Enter: folderItem Source folder.
546 * addrIndex Address index.
547 * sourceInd Source indicator: FALSE - Folder, TRUE - Messages.
548 * msgList List of message numbers, or NULL to process folder.
549 * Return: Populated address book file, or NULL if none created.
551 AddressBookFile
*addrgather_dlg_execute(
552 FolderItem
*folderItem
, AddressIndex
*addrIndex
, gboolean sourceInd
,
558 _harv_addressIndex_
= addrIndex
;
559 _harv_addressBook_
= NULL
;
560 _harv_messageList_
= msgList
;
563 if( ! addrgather_dlg
.window
) {
564 addrgather_dlg_create();
567 addrgather_dlg
.done
= FALSE
;
570 if( folderItem
&& folderItem
->path
) {
571 gtk_notebook_set_current_page(
572 GTK_NOTEBOOK(addrgather_dlg
.notebook
), PAGE_FIELDS
);
573 addrgather_dlg
.folderPath
= folder_item_get_path( folderItem
);
575 /* Setup some default values */
577 GTK_LABEL(addrgather_dlg
.labelFolder
), folderItem
->path
);
579 GTK_ENTRY(addrgather_dlg
.entryBook
), folderItem
->path
);
581 for( i
= 0; i
< NUM_FIELDS
; i
++ ) {
582 gtk_toggle_button_set_active(
583 GTK_TOGGLE_BUTTON(addrgather_dlg
.checkHeader
[i
]),
585 if( g_utf8_collate( _harv_headerNames_
[i
], HEADER_FROM
) == 0 ) {
586 gtk_toggle_button_set_active(
587 GTK_TOGGLE_BUTTON(addrgather_dlg
.checkHeader
[i
]),
592 gtk_widget_set_sensitive( addrgather_dlg
.btnOk
, TRUE
);
593 gtk_widget_grab_default( addrgather_dlg
.btnOk
);
597 /* Apply window title */
599 gtk_window_set_title( GTK_WINDOW(addrgather_dlg
.window
),
600 _("Harvest Email Addresses - from Selected Messages") );
601 gtk_widget_set_sensitive( addrgather_dlg
.checkRecurse
, FALSE
);
602 if( msgList
== NULL
) {
607 gtk_window_set_title( GTK_WINDOW(addrgather_dlg
.window
),
608 _("Harvest Email Addresses - from Folder") );
609 gtk_widget_set_sensitive( addrgather_dlg
.checkRecurse
, TRUE
);
611 gtk_toggle_button_set_active(
612 GTK_TOGGLE_BUTTON( addrgather_dlg
.checkRecurse
), FALSE
);
614 addrgather_dlg_status_show( "" );
615 gtk_widget_show( addrgather_dlg
.window
);
618 gtk_notebook_set_current_page(
619 GTK_NOTEBOOK(addrgather_dlg
.notebook
), PAGE_WARNING
);
620 gtk_widget_set_sensitive( addrgather_dlg
.btnOk
, FALSE
);
621 gtk_widget_grab_default( addrgather_dlg
.btnCancel
);
624 gtk_widget_grab_focus( addrgather_dlg
.entryBook
);
626 manage_window_set_transient( GTK_WINDOW(addrgather_dlg
.window
) );
630 g_free( addrgather_dlg
.folderPath
);
631 addrgather_dlg
.folderPath
= NULL
;
633 gtk_widget_hide( addrgather_dlg
.window
);
634 _harv_addressIndex_
= NULL
;
636 if( addrgather_dlg
.cancelled
== TRUE
) return NULL
;
638 return _harv_addressBook_
;