4 # Copyright (c) 1999-2006 The SquirrelMail Project Team
5 # Licensed under the GNU GPL. For full terms see COPYING.
7 # A simple configure script to configure SquirrelMail
10 ############################################################
11 $conf_pl_version = "1.4.0";
13 ############################################################
14 # Check what directory we're supposed to be running in, and
15 # change there if necessary. File::Basename has been in
16 # Perl since at least 5.003_7, and nobody sane runs anything
17 # before that, but just in case.
18 ############################################################
20 if ( eval q{require "File/Basename.pm"} ) {
21 $dir = File
::Basename
::dirname
($0);
25 ############################################################
26 # Some people try to run this as a CGI. That's wrong!
27 ############################################################
28 if ( defined( $ENV{'PATH_INFO'} )
29 || defined( $ENV{'QUERY_STRING'} )
30 || defined( $ENV{'REQUEST_METHOD'} ) ) {
31 print "Content-Type: text/html\n\n";
32 print "You must run this script from the command line.";
36 ############################################################
37 # If we got here, use Cwd to get the full directory path
38 # (the Basename stuff above will sometimes return '.' as
39 # the base directory, which is not helpful here).
40 ############################################################
45 ############################################################
46 # First, lets read in the data already in there...
47 ############################################################
48 if ( -e
"config.php" ) {
49 open( FILE
, "config.php" );
50 while ( $line = <FILE
> ) {
56 if ( $var =~ /^([a-z])/i ) {
57 @o = split ( /\s*EQUALS\s*/, $var );
58 if ( $o[0] eq "config_version" ) {
60 $o[1] =~ s/[\'\"];\s*$//;
64 $config_version = $o[1];
71 if ( $config_version ne $conf_pl_version ) {
73 print $WHT. "WARNING:\n" . $NRM;
74 print " The file \"config/config.php\" was found, but it is for\n";
75 print " an older version of SquirrelMail. It is possible to still\n";
76 print " read the defaults from this file but be warned that many\n";
77 print " preferences change between versions. It is recommended that\n";
78 print " you start with a clean config.php for each upgrade that you\n";
79 print " do. To do this, just move config/config.php out of the way.\n";
81 print "Continue loading with the old config.php [y/N]? ";
84 if ( ( $ctu !~ /^y\n/i ) || ( $ctu =~ /^\n/ ) ) {
88 print "\nDo you want me to stop warning you [y/N]? ";
90 if ( $ctu =~ /^y\n/i ) {
91 $print_config_version = $conf_pl_version;
93 $print_config_version = $config_version;
96 $print_config_version = $config_version;
100 open( FILE
, "config.php" );
101 } elsif ( -e
"config_default.php" ) {
102 open( FILE
, "config_default.php" );
103 while ( $line = <FILE
> ) {
109 if ( $var =~ /^([a-z])/i ) {
110 @o = split ( /\s*EQUALS\s*/, $var );
111 if ( $o[0] eq "config_version" ) {
112 $o[1] =~ s/[\n\r]//g;
113 $o[1] =~ s/[\'\"];\s*$//;
115 $o[1] =~ s/^[\'\"]//;
117 $config_version = $o[1];
124 if ( $config_version ne $conf_pl_version ) {
126 print $WHT. "WARNING:\n" . $NRM;
127 print " You are trying to use a 'config_default.php' from an older\n";
128 print " version of SquirrelMail. This is HIGHLY unrecommended. You\n";
129 print " should get the 'config_default.php' that matches the version\n";
130 print " of SquirrelMail that you are running. You can get this from\n";
131 print " the SquirrelMail web page by going to the following URL:\n";
132 print " http://www.squirrelmail.org.\n";
134 print "Continue loading with old config_default.php (a bad idea) [y/N]? ";
137 if ( ( $ctu !~ /^y\n/i ) || ( $ctu =~ /^\n/ ) ) {
141 print "\nDo you want me to stop warning you [y/N]? ";
143 if ( $ctu =~ /^y\n/i ) {
144 $print_config_version = $conf_pl_version;
146 $print_config_version = $config_version;
149 $print_config_version = $config_version;
152 open( FILE
, "config_default.php" );
154 print "No configuration file found. Please get config_default.php\n";
155 print "or config.php before running this again. This program needs\n";
156 print "a default config file to get default values.\n";
160 # Read and parse the current configuration file
161 # (either config.php or config_default.php).
162 while ( $line = <FILE
> ) {
168 if ( $var =~ /^([a-z])/i ) {
169 @options = split ( /\s*EQUALS\s*/, $var );
170 $options[1] =~ s/[\n\r]//g;
171 $options[1] =~ s/[\'\"];\s*$//;
172 $options[1] =~ s/;$//;
173 $options[1] =~ s/^[\'\"]//;
174 # de-escape escaped strings
175 $options[1] =~ s/\\'/'/g;
176 $options[1] =~ s/\\\\/\\/g;
178 if ( $options[0] =~ /^theme\[[0-9]+\]\[['"]PATH['"]\]/ ) {
180 $sub =~ s/\]\[['"]PATH['"]\]//;
182 if ( -e
"../themes" ) {
183 $options[1] =~ s/^\.\.\/config/\
.\
.\
/themes/;
185 $theme_path[$sub] = &change_to_rel_path
($options[1]);
186 } elsif ( $options[0] =~ /^theme\[[0-9]+\]\[['"]NAME['"]\]/ ) {
188 $sub =~ s/\]\[['"]NAME['"]\]//;
190 $theme_name[$sub] = $options[1];
191 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]PATH['"]\]/ ) {
193 $sub =~ s/\]\[['"]PATH['"]\]//;
195 if ( -e
"../templates" ) {
196 $options[1] =~ s/^\.\.\/config/\
.\
.\
/templates/;
198 $templateset_path[$sub] = &change_to_rel_path
($options[1]);
199 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]NAME['"]\]/ ) {
201 $sub =~ s/\]\[['"]NAME['"]\]//;
203 $templateset_name[$sub] = $options[1];
204 } elsif ( $options[0] =~ /^plugins\[[0-9]*\]/ ) {
207 $sub =~ s/^plugins\[//;
209 push @plugins, $options[1];
211 $plugins[$sub] = $options[1];
213 } elsif ($options[0] =~ /^fontsets\[\'[a-z]*\'\]/) {
214 # parse associative $fontsets array
217 $sub =~ s/^fontsets\[\'//;
218 $fontsets{$sub} = $options[1];
219 } elsif ( $options[0] =~ /^ldap_server\[[0-9]+\]/ ) {
222 $sub =~ s/^ldap_server\[//;
224 while ( ( $tmp = <FILE
> ) && ( $continue != 1 ) ) {
225 if ( $tmp =~ /\);\s*$/ ) {
229 if ( $tmp =~ /^\s*[\'\"]host[\'\"]/i ) {
230 $tmp =~ s/^\s*[\'\"]host[\'\"]\s*=>\s*[\'\"]//i;
231 $tmp =~ s/[\'\"],?\s*$//;
232 $tmp =~ s/[\'\"]\);\s*$//;
234 } elsif ( $tmp =~ /^\s*[\'\"]base[\'\"]/i ) {
235 $tmp =~ s/^\s*[\'\"]base[\'\"]\s*=>\s*[\'\"]//i;
236 $tmp =~ s/[\'\"],?\s*$//;
237 $tmp =~ s/[\'\"]\);\s*$//;
239 } elsif ( $tmp =~ /^\s*[\'\"]charset[\'\"]/i ) {
240 $tmp =~ s/^\s*[\'\"]charset[\'\"]\s*=>\s*[\'\"]//i;
241 $tmp =~ s/[\'\"],?\s*$//;
242 $tmp =~ s/[\'\"]\);\s*$//;
244 } elsif ( $tmp =~ /^\s*[\'\"]port[\'\"]/i ) {
245 $tmp =~ s/^\s*[\'\"]port[\'\"]\s*=>\s*[\'\"]?//i;
246 $tmp =~ s/[\'\"]?,?\s*$//;
247 $tmp =~ s/[\'\"]?\);\s*$//;
249 } elsif ( $tmp =~ /^\s*[\'\"]maxrows[\'\"]/i ) {
250 $tmp =~ s/^\s*[\'\"]maxrows[\'\"]\s*=>\s*[\'\"]?//i;
251 $tmp =~ s/[\'\"]?,?\s*$//;
252 $tmp =~ s/[\'\"]?\);\s*$//;
254 } elsif ( $tmp =~ /^\s*[\'\"]filter[\'\"]/i ) {
255 $tmp =~ s/^\s*[\'\"]filter[\'\"]\s*=>\s*[\'\"]?//i;
256 $tmp =~ s/[\'\"]?,?\s*$//;
257 $tmp =~ s/[\'\"]?\);\s*$//;
259 } elsif ( $tmp =~ /^\s*[\'\"]name[\'\"]/i ) {
260 $tmp =~ s/^\s*[\'\"]name[\'\"]\s*=>\s*[\'\"]//i;
261 $tmp =~ s/[\'\"],?\s*$//;
262 $tmp =~ s/[\'\"]\);\s*$//;
264 } elsif ( $tmp =~ /^\s*[\'\"]binddn[\'\"]/i ) {
265 $tmp =~ s/^\s*[\'\"]binddn[\'\"]\s*=>\s*[\'\"]//i;
266 $tmp =~ s/[\'\"],?\s*$//;
267 $tmp =~ s/[\'\"]\);\s*$//;
269 } elsif ( $tmp =~ /^\s*[\'\"]bindpw[\'\"]/i ) {
270 $tmp =~ s/^\s*[\'\"]bindpw[\'\"]\s*=>\s*[\'\"]//i;
271 $tmp =~ s/[\'\"],?\s*$//;
272 $tmp =~ s/[\'\"]\);\s*$//;
274 } elsif ( $tmp =~ /^\s*[\'\"]protocol[\'\"]/i ) {
275 $tmp =~ s/^\s*[\'\"]protocol[\'\"]\s*=>\s*[\'\"]?//i;
276 $tmp =~ s/[\'\"]?,?\s*$//;
277 $tmp =~ s/[\'\"]?\);\s*$//;
279 } elsif ( $tmp =~ /^\s*[\'\"]limit_scope[\'\"]/i ) {
280 $tmp =~ s/^\s*[\'\"]limit_scope[\'\"]\s*=>\s*[\'\"]?//i;
281 $tmp =~ s/[\'\"]?,?\s*$//;
282 $tmp =~ s/[\'\"]?\);\s*$//;
284 } elsif ( $tmp =~ /^\s*[\'\"]listing[\'\"]/i ) {
285 $tmp =~ s/^\s*[\'\"]listing[\'\"]\s*=>\s*[\'\"]?//i;
286 $tmp =~ s/[\'\"]?,?\s*$//;
287 $tmp =~ s/[\'\"]?\);\s*$//;
289 } elsif ( $tmp =~ /^\s*[\'\"]writeable[\'\"]/i ) {
290 $tmp =~ s/^\s*[\'\"]writeable[\'\"]\s*=>\s*[\'\"]?//i;
291 $tmp =~ s/[\'\"]?,?\s*$//;
292 $tmp =~ s/[\'\"]?\);\s*$//;
294 } elsif ( $tmp =~ /^\s*[\'\"]search_tree[\'\"]/i ) {
295 $tmp =~ s/^\s*[\'\"]search_tree[\'\"]\s*=>\s*[\'\"]?//i;
296 $tmp =~ s/[\'\"]?,?\s*$//;
297 $tmp =~ s/[\'\"]?\);\s*$//;
299 } elsif ( $tmp =~ /^\s*[\'\"]starttls[\'\"]/i ) {
300 $tmp =~ s/^\s*[\'\"]starttls[\'\"]\s*=>\s*[\'\"]?//i;
301 $tmp =~ s/[\'\"]?,?\s*$//;
302 $tmp =~ s/[\'\"]?\);\s*$//;
306 $ldap_host[$sub] = $host;
307 $ldap_base[$sub] = $base;
308 $ldap_name[$sub] = $name;
309 $ldap_port[$sub] = $port;
310 $ldap_maxrows[$sub] = $maxrows;
311 $ldap_filter[$sub] = $filter;
312 $ldap_charset[$sub] = $charset;
313 $ldap_binddn[$sub] = $binddn;
314 $ldap_bindpw[$sub] = $bindpw;
315 $ldap_protocol[$sub] = $protocol;
316 $ldap_limit_scope[$sub] = $limit_scope;
317 $ldap_listing[$sub] = $listing;
318 $ldap_writeable[$sub] = $writeable;
319 $ldap_search_tree[$sub] = $search_tree;
320 $ldap_starttls[$sub] = $starttls;
321 } elsif ( $options[0] =~ /^(data_dir|attachment_dir|theme_css|org_logo|signout_page)$/ ) {
322 ${ $options[0] } = &change_to_rel_path
($options[1]);
324 ${ $options[0] } = $options[1];
330 # FIXME: unknown introduction date
331 $useSendmail = 'false' if ( lc($useSendmail) ne 'true' );
332 $sendmail_path = "/usr/sbin/sendmail" if ( !$sendmail_path );
333 $pop_before_smtp = 'false' if ( !$pop_before_smtp );
334 $default_unseen_notify = 2 if ( !$default_unseen_notify );
335 $default_unseen_type = 1 if ( !$default_unseen_type );
336 $config_use_color = 0 if ( !$config_use_color );
337 $invert_time = 'false' if ( !$invert_time );
338 $force_username_lowercase = 'false' if ( !$force_username_lowercase );
339 $optional_delimiter = "detect" if ( !$optional_delimiter );
340 $auto_create_special = 'false' if ( !$auto_create_special );
341 $default_use_priority = 'true' if ( !$default_use_priority );
342 $default_use_mdn = 'true' if ( !$default_use_mdn );
343 $delete_folder = 'false' if ( !$delete_folder );
344 $noselect_fix_enable = 'false' if ( !$noselect_fix_enable );
345 $frame_top = "_top" if ( !$frame_top );
346 $provider_uri = '' if ( !$provider_uri );
347 $provider_name = '' if ( !$provider_name );
348 $edit_identity = 'true' if ( !$edit_identity );
349 $edit_name = 'true' if ( !$edit_name );
350 $no_list_for_subscribe = 'false' if ( !$no_list_for_subscribe );
351 $allow_charset_search = 'true' if ( !$allow_charset_search );
352 $allow_advanced_search = 0 if ( !$allow_advanced_search) ;
353 $prefs_user_field = 'user' if ( !$prefs_user_field );
354 $prefs_key_field = 'prefkey' if ( !$prefs_key_field );
355 $prefs_val_field = 'prefval' if ( !$prefs_val_field );
356 $session_name = 'SQMSESSID' if ( !$session_name );
357 $skip_SM_header = 'false' if ( !$skip_SM_header );
358 $default_use_javascript_addr_book = 'false' if (! $default_use_javascript_addr_book);
361 $hide_sm_attributions = 'false' if ( !$hide_sm_attributions );
364 $use_smtp_tls= 'false' if ( !$use_smtp_tls);
365 $smtp_auth_mech = 'none' if ( !$smtp_auth_mech );
366 $use_imap_tls = 'false' if ( !$use_imap_tls );
367 $imap_auth_mech = 'login' if ( !$imap_auth_mech );
370 $show_alternative_names = 'false' if ( !$show_alternative_names );
371 # $available_languages option available only in 1.5.0. removed due to $languages
372 # implementation changes. options are provided by limit_languages plugin
373 # $available_languages = 'all' if ( !$available_languages );
374 $aggressive_decoding = 'false' if ( !$aggressive_decoding );
375 # available only in 1.5.0 and 1.5.1
376 # $advanced_tree = 'false' if ( !$advanced_tree );
377 $use_php_recode = 'false' if ( !$use_php_recode );
378 $use_php_iconv = 'false' if ( !$use_php_iconv );
381 $use_icons = 'false' if ( !$use_icons );
382 $use_iframe = 'false' if ( !$use_iframe );
383 $lossy_encoding = 'false' if ( !$lossy_encoding );
384 $allow_remote_configtest = 'false' if ( !$allow_remote_configtest );
385 $addrbook_global_table = 'global_abook' if ( !$addrbook_global_table );
386 $addrbook_global_writeable = 'false' if ( !$addrbook_global_writeable );
387 $addrbook_global_listing = 'false' if ( !$addrbook_global_listing );
388 $abook_global_file = '' if ( !$abook_global_file);
389 $abook_global_file_writeable = 'false' if ( !$abook_global_file_writeable);
390 $abook_global_file_listing = 'true' if ( !$abook_global_file_listing );
391 $encode_header_key = '' if ( !$encode_header_key );
392 $hide_auth_header = 'false' if ( !$hide_auth_header );
393 $time_zone_type = '0' if ( !$time_zone_type );
394 $prefs_user_size = 128 if ( !$prefs_user_size );
395 $prefs_key_size = 64 if ( !$prefs_key_size );
396 $prefs_val_size = 65536 if ( !$prefs_val_size );
398 # add qmail-inject test here for backwards compatibility
399 if ( !$sendmail_args && $sendmail_path =~ /qmail-inject/ ) {
401 } elsif ( !$sendmail_args ) {
402 $sendmail_args = '-i -t';
405 $default_fontsize = '' if ( !$default_fontsize);
406 $default_fontset = '' if ( !$default_fontset);
408 %fontsets = ('serif', 'serif',
409 'sans', 'helvetica,arial,sans-serif',
410 'comicsans', 'comic sans ms,sans-serif',
411 'tahoma', 'tahoma,sans-serif',
412 'verasans', 'bitstream vera sans,verdana,sans-serif');
415 # $use_imap_tls and $use_smtp_tls are switched to integer since 1.5.1
416 $use_imap_tls = 0 if ( $use_imap_tls eq 'false');
417 $use_imap_tls = 1 if ( $use_imap_tls eq 'true');
418 $use_smtp_tls = 0 if ( $use_smtp_tls eq 'false');
419 $use_smtp_tls = 1 if ( $use_smtp_tls eq 'true');
420 # sorting options changed names and reversed values in 1.5.1
421 $disable_thread_sort = 'false' if ( !$disable_thread_sort );
422 $disable_server_sort = 'false' if ( !$disable_server_sort );
425 $abook_file_line_length = 2048 if ( !$abook_file_line_length );
427 if ( $ARGV[0] eq '--install-plugin' ) {
428 print "Activating plugin " . $ARGV[1] . "\n";
429 push @plugins, $ARGV[1];
432 } elsif ( $ARGV[0] eq '--remove-plugin' ) {
433 print "Removing plugin " . $ARGV[1] . "\n";
434 foreach $plugin (@plugins) {
435 if ( $plugin ne $ARGV[1] ) {
436 push @newplugins, $plugin;
439 @plugins = @newplugins;
444 #####################################################################################
445 if ( $config_use_color == 1 ) {
451 $config_use_color = 2;
454 while ( ( $command ne "q" ) && ( $command ne "Q" ) && ( $command ne ":q" ) ) {
456 print $WHT. "SquirrelMail Configuration : " . $NRM;
457 if ( $config == 1 ) { print "Read: config.php"; }
458 elsif ( $config == 2 ) { print "Read: config_default.php"; }
459 print " ($print_config_version)\n";
460 print "---------------------------------------------------------\n";
463 print $WHT. "Main Menu --\n" . $NRM;
464 print "1. Organization Preferences\n";
465 print "2. Server Settings\n";
466 print "3. Folder Defaults\n";
467 print "4. General Options\n";
468 print "5. Templates\n";
469 print "6. Address Books\n";
470 print "7. Message of the Day (MOTD)\n";
471 print "8. Plugins\n";
472 print "9. Database\n";
473 print "10. Language settings\n";
474 print "11. Tweaks\n";
476 print "D. Set pre-defined settings for specific IMAP servers\n";
478 } elsif ( $menu == 1 ) {
479 print $WHT. "Organization Preferences\n" . $NRM;
480 print "1. Organization Name : $WHT$org_name$NRM\n";
481 print "2. Organization Logo : $WHT$org_logo$NRM\n";
482 print "3. Org. Logo Width/Height : $WHT($org_logo_width/$org_logo_height)$NRM\n";
483 print "4. Organization Title : $WHT$org_title$NRM\n";
484 print "5. Signout Page : $WHT$signout_page$NRM\n";
485 print "6. Top Frame : $WHT$frame_top$NRM\n";
486 print "7. Provider link : $WHT$provider_uri$NRM\n";
487 print "8. Provider name : $WHT$provider_name$NRM\n";
490 print "R Return to Main Menu\n";
491 } elsif ( $menu == 2 ) {
492 print $WHT. "Server Settings\n\n" . $NRM;
493 print $WHT . "General" . $NRM . "\n";
495 print "1. Domain : $WHT$domain$NRM\n";
496 print "2. Invert Time : $WHT$invert_time$NRM\n";
497 print "3. Sendmail or SMTP : $WHT";
498 if ( lc($useSendmail) eq 'true' ) {
506 if ( $show_imap_settings ) {
507 print $WHT . "IMAP Settings". $NRM . "\n--------------\n";
508 print "4. IMAP Server : $WHT$imapServerAddress$NRM\n";
509 print "5. IMAP Port : $WHT$imapPort$NRM\n";
510 print "6. Authentication type : $WHT$imap_auth_mech$NRM\n";
511 print "7. Secure IMAP (TLS) : $WHT" . display_use_tls
($use_imap_tls) . "$NRM\n";
512 print "8. Server software : $WHT$imap_server_type$NRM\n";
513 print "9. Delimiter : $WHT$optional_delimiter$NRM\n";
515 } elsif ( $show_smtp_settings ) {
516 if ( lc($useSendmail) eq 'true' ) {
517 print $WHT . "Sendmail" . $NRM . "\n--------\n";
518 print "4. Sendmail Path : $WHT$sendmail_path$NRM\n";
519 print "5. Sendmail arguments : $WHT$sendmail_args$NRM\n";
520 print "6. Header encryption key : $WHT$encode_header_key$NRM\n";
523 print $WHT . "SMTP Settings" . $NRM . "\n-------------\n";
524 print "4. SMTP Server : $WHT$smtpServerAddress$NRM\n";
525 print "5. SMTP Port : $WHT$smtpPort$NRM\n";
526 print "6. POP before SMTP : $WHT$pop_before_smtp$NRM\n";
527 print "7. SMTP Authentication : $WHT$smtp_auth_mech$NRM\n";
528 print "8. Secure SMTP (TLS) : $WHT" . display_use_tls
($use_smtp_tls) . "$NRM\n";
529 print "9. Header encryption key : $WHT$encode_header_key$NRM\n";
534 if ($show_imap_settings == 0) {
535 print "A. Update IMAP Settings : ";
536 print "$WHT$imapServerAddress$NRM:";
537 print "$WHT$imapPort$NRM ";
538 print "($WHT$imap_server_type$NRM)\n";
540 if ($show_smtp_settings == 0) {
541 if ( lc($useSendmail) eq 'true' ) {
542 print "B. Change Sendmail Config : $WHT$sendmail_path$NRM\n";
544 print "B. Update SMTP Settings : ";
545 print "$WHT$smtpServerAddress$NRM:";
546 print "$WHT$smtpPort$NRM\n";
549 if ( $show_smtp_settings || $show_imap_settings )
552 ($show_imap_settings ?
"IMAP Server" :
553 (lc($useSendmail) eq 'true') ?
"Sendmail" : "SMTP") . " Settings\n";
557 print "R Return to Main Menu\n";
558 } elsif ( $menu == 3 ) {
559 print $WHT. "Folder Defaults\n" . $NRM;
560 print "1. Default Folder Prefix : $WHT$default_folder_prefix$NRM\n";
561 print "2. Show Folder Prefix Option : $WHT$show_prefix_option$NRM\n";
562 print "3. Trash Folder : $WHT$trash_folder$NRM\n";
563 print "4. Sent Folder : $WHT$sent_folder$NRM\n";
564 print "5. Drafts Folder : $WHT$draft_folder$NRM\n";
565 print "6. By default, move to trash : $WHT$default_move_to_trash$NRM\n";
566 print "7. By default, move to sent : $WHT$default_move_to_sent$NRM\n";
567 print "8. By default, save as draft : $WHT$default_save_as_draft$NRM\n";
568 print "9. List Special Folders First : $WHT$list_special_folders_first$NRM\n";
569 print "10. Show Special Folders Color : $WHT$use_special_folder_color$NRM\n";
570 print "11. Auto Expunge : $WHT$auto_expunge$NRM\n";
571 print "12. Default Sub. of INBOX : $WHT$default_sub_of_inbox$NRM\n";
572 print "13. Show 'Contain Sub.' Option : $WHT$show_contain_subfolders_option$NRM\n";
573 print "14. Default Unseen Notify : $WHT$default_unseen_notify$NRM\n";
574 print "15. Default Unseen Type : $WHT$default_unseen_type$NRM\n";
575 print "16. Auto Create Special Folders : $WHT$auto_create_special$NRM\n";
576 print "17. Folder Delete Bypasses Trash : $WHT$delete_folder$NRM\n";
577 print "18. Enable /NoSelect folder fix : $WHT$noselect_fix_enable$NRM\n";
579 print "R Return to Main Menu\n";
580 } elsif ( $menu == 4 ) {
581 print $WHT. "General Options\n" . $NRM;
582 print "1. Data Directory : $WHT$data_dir$NRM\n";
583 print "2. Attachment Directory : $WHT$attachment_dir$NRM\n";
584 print "3. Directory Hash Level : $WHT$dir_hash_level$NRM\n";
585 print "4. Default Left Size : $WHT$default_left_size$NRM\n";
586 print "5. Usernames in Lowercase : $WHT$force_username_lowercase$NRM\n";
587 print "6. Allow use of priority : $WHT$default_use_priority$NRM\n";
588 print "7. Hide SM attributions : $WHT$hide_sm_attributions$NRM\n";
589 print "8. Allow use of receipts : $WHT$default_use_mdn$NRM\n";
590 print "9. Allow editing of identity : $WHT$edit_identity$NRM\n";
591 print " Allow editing of name : $WHT$edit_name$NRM\n";
592 print " Remove username from header : $WHT$hide_auth_header$NRM\n";
593 print "10. Disable server thread sort : $WHT$disable_thread_sort$NRM\n";
594 print "11. Disable server-side sorting : $WHT$disable_server_sort$NRM\n";
595 print "12. Allow server charset search : $WHT$allow_charset_search$NRM\n";
596 print "13. Allow advanced search : $WHT$allow_advanced_search$NRM\n";
597 print "14. PHP session name : $WHT$session_name$NRM\n";
598 print "15. Time zone configuration : $WHT$time_zone_type$NRM\n";
600 print "R Return to Main Menu\n";
601 } elsif ( $menu == 5 ) {
602 print $WHT. "Themes\n" . $NRM;
603 print "1. Change Template set\n";
604 # for ( $count = 0 ; $count <= $#theme_name/2 ; $count++ ) {
605 # $temp_name = $theme_name[$count*2];
606 # printf " %s%*s %s\n", $temp_name,
607 # 40 - length($temp_name), " ",
608 # $theme_name[($count*2)+1];
610 print "2. CSS File : $WHT$theme_css$NRM\n";
611 print "3. Default font size: $WHT$default_fontsize$NRM\n";
612 print "4. Change available font sets\n";
613 print "5. Change Themes\n";
616 print "R Return to Main Menu\n";
617 } elsif ( $menu == 6 ) {
618 print $WHT. "Address Books\n" . $NRM;
619 print "1. Change LDAP Servers\n";
620 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
621 print " > $ldap_host[$count]\n";
623 print "2. Use Javascript address book search : $WHT$default_use_javascript_addr_book$NRM\n";
624 print "3. Global address book file : $WHT$abook_global_file$NRM\n";
625 print "4. Allow writing into global file address book : $WHT$abook_global_file_writeable$NRM\n";
626 print "5. Allow listing of global file address book : $WHT$abook_global_file_listing$NRM\n";
627 print "6. Allowed address book line length : $WHT$abook_file_line_length$NRM\n";
629 print "R Return to Main Menu\n";
630 } elsif ( $menu == 7 ) {
631 print $WHT. "Message of the Day (MOTD)\n" . $NRM;
634 print "1 Edit the MOTD\n";
636 print "R Return to Main Menu\n";
637 } elsif ( $menu == 8 ) {
638 print $WHT. "Plugins\n" . $NRM;
639 print " Installed Plugins\n";
641 for ( $count = 0 ; $count <= $#plugins ; $count++ ) {
643 print " $num. $plugins[$count]\n";
645 print "\n Available Plugins:\n";
646 opendir( DIR
, "../plugins" );
647 @files = readdir(DIR
);
649 @unused_plugins = ();
650 for ( $i = 0 ; $i <= $#files ; $i++ ) {
651 if ( -d
"../plugins/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne "CVS" ) {
653 for ( $k = 0 ; $k <= $#plugins ; $k++ ) {
654 if ( $plugins[$k] eq $files[$i] ) {
659 $unused_plugins[$pos] = $files[$i];
665 for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
667 print " $num. $unused_plugins[$i]\n";
672 print "R Return to Main Menu\n";
673 } elsif ( $menu == 9 ) {
674 print $WHT. "Database\n" . $NRM;
675 print "1. DSN for Address Book : $WHT$addrbook_dsn$NRM\n";
676 print "2. Table for Address Book : $WHT$addrbook_table$NRM\n";
678 print "3. DSN for Preferences : $WHT$prefs_dsn$NRM\n";
679 print "4. Table for Preferences : $WHT$prefs_table$NRM\n";
680 print "5. Field for username : $WHT$prefs_user_field$NRM ($prefs_user_size)\n";
681 print "6. Field for prefs key : $WHT$prefs_key_field$NRM ($prefs_key_size)\n";
682 print "7. Field for prefs value : $WHT$prefs_val_field$NRM ($prefs_val_size)\n";
684 print "8. DSN for Global Address Book : $WHT$addrbook_global_dsn$NRM\n";
685 print "9. Table for Global Address Book : $WHT$addrbook_global_table$NRM\n";
686 print "10. Allow writing into Global Address Book : $WHT$addrbook_global_writeable$NRM\n";
687 print "11. Allow listing of Global Address Book : $WHT$addrbook_global_listing$NRM\n";
689 print "R Return to Main Menu\n";
690 } elsif ( $menu == 10 ) {
691 print $WHT. "Language settings\n" . $NRM;
692 print "1. Default Language : $WHT$squirrelmail_default_language$NRM\n";
693 print "2. Default Charset : $WHT$default_charset$NRM\n";
694 print "3. Show alternative language names : $WHT$show_alternative_names$NRM\n";
695 print "4. Enable aggressive decoding : $WHT$aggressive_decoding$NRM\n";
696 print "5. Enable lossy encoding : $WHT$lossy_encoding$NRM\n";
698 print "R Return to Main Menu\n";
699 } elsif ( $menu == 11 ) {
700 print $WHT. "Interface tweaks\n" . $NRM;
701 print "1. Display html mails in iframe : $WHT$use_iframe$NRM\n";
702 print "2. Use Icons : $WHT$use_icons$NRM\n";
704 print $WHT. "PHP tweaks\n" . $NRM;
705 print "3. Use php recode functions : $WHT$use_php_recode$NRM\n";
706 print "4. Use php iconv functions : $WHT$use_php_iconv$NRM\n";
708 print $WHT. "Configuration tweaks\n" . $NRM;
709 print "5. Allow remote configtest : $WHT$allow_remote_configtest$NRM\n";
711 print "R Return to Main Menu\n";
713 if ( $config_use_color == 1 ) {
714 print "C Turn color off\n";
716 print "C Turn color on\n";
718 print "S Save data\n";
722 print "Command >> " . $WHT;
724 $command =~ s/[\n\r]//g;
725 $command =~ tr/A-Z/a-z/;
728 # Read the commands they entered.
729 if ( $command eq "r" ) {
731 } elsif ( $command eq "s" ) {
733 print "Press enter to continue...";
736 } elsif ( ( $command eq "q" ) && ( $saved == 0 ) ) {
737 print "You have not saved your data.\n";
738 print "Save? [" . $WHT . "Y" . $NRM . "/n]: ";
740 if ( ( $save =~ /^y/i ) || ( $save =~ /^\s*$/ ) ) {
743 } elsif ( $command eq "c" ) {
744 if ( $config_use_color == 1 ) {
745 $config_use_color = 2;
749 $config_use_color = 1;
753 } elsif ( $command eq "d" && $menu == 0 ) {
758 if ( ( $command > 0 ) && ( $command < 12 ) ) {
761 } elsif ( $menu == 1 ) {
762 if ( $command == 1 ) { $org_name = command1
(); }
763 elsif ( $command == 2 ) { $org_logo = command2
(); }
764 elsif ( $command == 3 ) { ($org_logo_width,$org_logo_height) = command2a
(); }
765 elsif ( $command == 4 ) { $org_title = command3
(); }
766 elsif ( $command == 5 ) { $signout_page = command4
(); }
767 elsif ( $command == 6 ) { $frame_top = command6
(); }
768 elsif ( $command == 7 ) { $provider_uri = command7
(); }
769 elsif ( $command == 8 ) { $provider_name = command8
(); }
771 } elsif ( $menu == 2 ) {
772 if ( $command eq "a" ) { $show_imap_settings = 1; $show_smtp_settings = 0; }
773 elsif ( $command eq "b" ) { $show_imap_settings = 0; $show_smtp_settings = 1; }
774 elsif ( $command eq "h" ) { $show_imap_settings = 0; $show_smtp_settings = 0; }
775 elsif ( $command <= 3 ) {
776 if ( $command == 1 ) { $domain = command11
(); }
777 elsif ( $command == 2 ) { $invert_time = command110
(); }
778 elsif ( $command == 3 ) { $useSendmail = command14
(); }
779 $show_imap_settings = 0; $show_smtp_settings = 0;
780 } elsif ( $show_imap_settings ) {
781 if ( $command == 4 ) { $imapServerAddress = command12
(); }
782 elsif ( $command == 5 ) { $imapPort = command13
(); }
783 elsif ( $command == 6 ) { $imap_auth_mech = command112a
(); }
784 elsif ( $command == 7 ) { $use_imap_tls = command_use_tls
("IMAP",$use_imap_tls); }
785 elsif ( $command == 8 ) { $imap_server_type = command19
(); }
786 elsif ( $command == 9 ) { $optional_delimiter = command111
(); }
787 } elsif ( $show_smtp_settings && lc($useSendmail) eq 'true' ) {
788 if ( $command == 4 ) { $sendmail_path = command15
(); }
789 elsif ( $command == 5 ) { $sendmail_args = command_sendmail_args
(); }
790 elsif ( $command == 6 ) { $encode_header_key = command114
(); }
791 } elsif ( $show_smtp_settings ) {
792 if ( $command == 4 ) { $smtpServerAddress = command16
(); }
793 elsif ( $command == 5 ) { $smtpPort = command17
(); }
794 elsif ( $command == 6 ) { $pop_before_smtp = command18a
(); }
795 elsif ( $command == 7 ) { $smtp_auth_mech = command112b
(); }
796 elsif ( $command == 8 ) { $use_smtp_tls = command_use_tls
("SMTP",$use_smtp_tls); }
797 elsif ( $command == 9 ) { $encode_header_key = command114
(); }
799 } elsif ( $menu == 3 ) {
800 if ( $command == 1 ) { $default_folder_prefix = command21
(); }
801 elsif ( $command == 2 ) { $show_prefix_option = command22
(); }
802 elsif ( $command == 3 ) { $trash_folder = command23a
(); }
803 elsif ( $command == 4 ) { $sent_folder = command23b
(); }
804 elsif ( $command == 5 ) { $draft_folder = command23c
(); }
805 elsif ( $command == 6 ) { $default_move_to_trash = command24a
(); }
806 elsif ( $command == 7 ) { $default_move_to_sent = command24b
(); }
807 elsif ( $command == 8 ) { $default_save_as_draft = command24c
(); }
808 elsif ( $command == 9 ) { $list_special_folders_first = command27
(); }
809 elsif ( $command == 10 ) { $use_special_folder_color = command28
(); }
810 elsif ( $command == 11 ) { $auto_expunge = command29
(); }
811 elsif ( $command == 12 ) { $default_sub_of_inbox = command210
(); }
812 elsif ( $command == 13 ) { $show_contain_subfolders_option = command211
(); }
813 elsif ( $command == 14 ) { $default_unseen_notify = command212
(); }
814 elsif ( $command == 15 ) { $default_unseen_type = command213
(); }
815 elsif ( $command == 16 ) { $auto_create_special = command214
(); }
816 elsif ( $command == 17 ) { $delete_folder = command215
(); }
817 elsif ( $command == 18 ) { $noselect_fix_enable = command216
(); }
818 } elsif ( $menu == 4 ) {
819 if ( $command == 1 ) { $data_dir = command33a
(); }
820 elsif ( $command == 2 ) { $attachment_dir = command33b
(); }
821 elsif ( $command == 3 ) { $dir_hash_level = command33c
(); }
822 elsif ( $command == 4 ) { $default_left_size = command35
(); }
823 elsif ( $command == 5 ) { $force_username_lowercase = command36
(); }
824 elsif ( $command == 6 ) { $default_use_priority = command37
(); }
825 elsif ( $command == 7 ) { $hide_sm_attributions = command38
(); }
826 elsif ( $command == 8 ) { $default_use_mdn = command39
(); }
827 elsif ( $command == 9 ) { $edit_identity = command310
(); }
828 elsif ( $command == 10 ) { $disable_thread_sort = command312
(); }
829 elsif ( $command == 11 ) { $disable_server_sort = command313
(); }
830 elsif ( $command == 12 ) { $allow_charset_search = command314
(); }
831 elsif ( $command == 13 ) { $allow_advanced_search = command316
(); }
832 elsif ( $command == 14 ) { $session_name = command317
(); }
833 elsif ( $command == 15 ) { $time_zone_type = command318
(); }
834 } elsif ( $menu == 5 ) {
835 if ( $command == 1 ) { $templateset_default = command_templates
(); }
836 elsif ( $command == 2 ) { $theme_css = command42
(); }
837 elsif ( $command == 3 ) { $default_fontsize = command_default_fontsize
(); }
838 elsif ( $command == 4 ) { command_fontsets
(); }
839 elsif ( $command == 5 ) { command41
(); }
840 } elsif ( $menu == 6 ) {
841 if ( $command == 1 ) { command61
(); }
842 elsif ( $command == 2 ) { command62
(); }
843 elsif ( $command == 3 ) { $abook_global_file=command63
(); }
844 elsif ( $command == 4 ) { command64
(); }
845 elsif ( $command == 5 ) { command65
(); }
846 elsif ( $command == 6 ) { command_abook_file_line_length
(); }
847 } elsif ( $menu == 7 ) {
848 if ( $command == 1 ) { $motd = command71
(); }
849 } elsif ( $menu == 8 ) {
850 if ( $command =~ /^[0-9]+/ ) { @plugins = command81
(); }
851 } elsif ( $menu == 9 ) {
852 if ( $command == 1 ) { $addrbook_dsn = command91
(); }
853 elsif ( $command == 2 ) { $addrbook_table = command92
(); }
854 elsif ( $command == 3 ) { $prefs_dsn = command93
(); }
855 elsif ( $command == 4 ) { $prefs_table = command94
(); }
856 elsif ( $command == 5 ) { $prefs_user_field = command95
(); }
857 elsif ( $command == 6 ) { $prefs_key_field = command96
(); }
858 elsif ( $command == 7 ) { $prefs_val_field = command97
(); }
859 elsif ( $command == 8 ) { $addrbook_global_dsn = command98
(); }
860 elsif ( $command == 9 ) { $addrbook_global_table = command99
(); }
861 elsif ( $command == 10 ) { $addrbook_global_writeable = command910
(); }
862 elsif ( $command == 11 ) { $addrbook_global_listing = command911
(); }
863 } elsif ( $menu == 10 ) {
864 if ( $command == 1 ) { $squirrelmail_default_language = commandA1
(); }
865 elsif ( $command == 2 ) { $default_charset = commandA2
(); }
866 elsif ( $command == 3 ) { $show_alternative_names = commandA3
(); }
867 elsif ( $command == 4 ) { $aggressive_decoding = commandA4
(); }
868 elsif ( $command == 5 ) { $lossy_encoding = commandA5
(); }
869 } elsif ( $menu == 11 ) {
870 if ( $command == 1 ) { $use_iframe = commandB2
(); }
871 elsif ( $command == 2 ) { $use_icons = commandB3
(); }
872 elsif ( $command == 3 ) { $use_php_recode = commandB4
(); }
873 elsif ( $command == 4 ) { $use_php_iconv = commandB5
(); }
874 elsif ( $command == 5 ) { $allow_remote_configtest = commandB6
(); }
880 print "\nExiting conf.pl.\n".
881 "You might want to test your configuration by browsing to\n".
882 "http://your-squirrelmail-location/src/configtest.php\n".
883 "Happy SquirrelMailing!\n\n";
886 ####################################################################################
890 print "We have tried to make the name SquirrelMail as transparent as\n";
891 print "possible. If you set up an organization name, most places where\n";
892 print "SquirrelMail would take credit will be credited to your organization.\n";
894 print "If your Organization Name includes a '\$', please precede it with a \\. \n";
895 print "Other '\$' will be considered the beginning of a variable that\n";
896 print "must be defined before the \$org_name is printed.\n";
898 print "[$WHT$org_name$NRM]: $WHT";
899 $new_org_name = <STDIN
>;
900 if ( $new_org_name eq "\n" ) {
901 $new_org_name = $org_name;
903 $new_org_name =~ s/[\r\n]//g;
904 $new_org_name =~ s/\"/"/g;
906 return $new_org_name;
911 print "Your organization's logo is an image that will be displayed at\n";
912 print "different times throughout SquirrelMail. ";
914 print "Please be aware of the following: \n";
915 print " - Relative URLs are relative to the config dir\n";
916 print " to use the default logo, use ../images/sm_logo.png\n";
917 print " - To specify a logo defined outside the SquirrelMail source tree\n";
918 print " use the absolute URL the webserver would use to include the file\n";
919 print " e.g. http://www.example.com/images/mylogo.gif or /images/mylogo.jpg\n";
921 print "[$WHT$org_logo$NRM]: $WHT";
922 $new_org_logo = <STDIN
>;
923 if ( $new_org_logo eq "\n" ) {
924 $new_org_logo = $org_logo;
926 $new_org_logo =~ s/[\r\n]//g;
928 return $new_org_logo;
933 print "Your organization's logo is an image that will be displayed at\n";
934 print "different times throughout SquirrelMail. Width\n";
935 print "and Height of your logo image. Use '0' to disable.\n";
937 print "Width: [$WHT$org_logo_width$NRM]: $WHT";
938 $new_org_logo_width = <STDIN
>;
939 $new_org_logo_width =~ tr/0-9//cd; # only want digits!
940 if ( $new_org_logo_width eq '' ) {
941 $new_org_logo_width = $org_logo_width;
943 if ( $new_org_logo_width > 0 ) {
944 print "Height: [$WHT$org_logo_height$NRM]: $WHT";
945 $new_org_logo_height = <STDIN
>;
946 $new_org_logo_height =~ tr/0-9//cd; # only want digits!
947 if( $new_org_logo_height eq '' ) {
948 $new_org_logo_height = $org_logo_height;
951 $new_org_logo_height = 0;
953 return ($new_org_logo_width, $new_org_logo_height);
958 print "A title is what is displayed at the top of the browser window in\n";
959 print "the titlebar. Usually this will end up looking something like:\n";
960 print "\"Netscape: $org_title\"\n";
962 print "If your Organization Title includes a '\$', please precede it with a \\. \n";
963 print "Other '\$' will be considered the beginning of a variable that\n";
964 print "must be defined before the \$org_title is printed.\n";
965 print "\$version, for example can be used, and will print the\n";
966 print "string representing the current SquirrelMail version.\n";
968 print "[$WHT$org_title$NRM]: $WHT";
969 $new_org_title = <STDIN
>;
970 if ( $new_org_title eq "\n" ) {
971 $new_org_title = $org_title;
973 $new_org_title =~ s/[\r\n]//g;
974 $new_org_title =~ s/\"/\'/g;
976 return $new_org_title;
981 print "When users click the Sign Out button they will be logged out and\n";
982 print "then sent to signout_page. If signout_page is left empty,\n";
983 print "(hit space and then return) they will be taken, as normal,\n";
984 print "to the default and rather sparse SquirrelMail signout page.\n";
986 print "[$WHT$signout_page$NRM]: $WHT";
987 $new_signout_page = <STDIN
>;
988 if ( $new_signout_page eq "\n" ) {
989 $new_signout_page = $signout_page;
991 $new_signout_page =~ s/[\r\n]//g;
992 $new_signout_page =~ s/^\s+$//g;
994 return $new_signout_page;
999 print "SquirrelMail defaults to using the whole of the browser window.\n";
1000 print "This allows you to keep it within a specified frame. The default\n";
1001 print "is '_top'\n";
1003 print "[$WHT$frame_top$NRM]: $WHT";
1004 $new_frame_top = <STDIN
>;
1005 if ( $new_frame_top eq "\n" ) {
1006 $new_frame_top = '_top';
1008 $new_frame_top =~ s/[\r\n]//g;
1009 $new_frame_top =~ s/^\s+$//g;
1011 return $new_frame_top;
1014 # Default link to provider
1016 print "Here you can set the link on the right of the page.\n";
1017 print "If empty, it will link to the SquirrelMail About page.\n";
1019 print "[$WHT$provider_uri$NRM]: $WHT";
1020 $new_provider_uri = <STDIN
>;
1021 if ( $new_provider_uri eq "\n" ) {
1022 $new_provider_uri = '';
1024 $new_provider_uri =~ s/[\r\n]//g;
1025 $new_provider_uri =~ s/^\s+$//g;
1027 return $new_provider_uri;
1031 print "Here you can set the name of the link on the right of the page.\n";
1032 print "The default is 'SquirrelMail'\n";
1034 print "[$WHT$provider_name$NRM]: $WHT";
1035 $new_provider_name = <STDIN
>;
1036 if ( $new_provider_name eq "\n" ) {
1037 $new_provider_name = 'SquirrelMail';
1039 $new_provider_name =~ s/[\r\n]//g;
1040 $new_provider_name =~ s/^\s+$//g;
1041 $new_provider_name =~ s/\'/\\'/g;
1043 return $new_provider_name;
1046 ####################################################################################
1050 print "The domain name is the suffix at the end of all email addresses. If\n";
1051 print "for example, your email address is jdoe\@example.com, then your domain\n";
1052 print "would be example.com.\n";
1054 print "[$WHT$domain$NRM]: $WHT";
1055 $new_domain = <STDIN
>;
1056 if ( $new_domain eq "\n" ) {
1057 $new_domain = $domain;
1059 $new_domain =~ s/[\r\n]//g;
1066 print "This is the hostname where your IMAP server can be contacted.\n";
1067 print "[$WHT$imapServerAddress$NRM]: $WHT";
1068 $new_imapServerAddress = <STDIN
>;
1069 if ( $new_imapServerAddress eq "\n" ) {
1070 $new_imapServerAddress = $imapServerAddress;
1072 $new_imapServerAddress =~ s/[\r\n]//g;
1074 return $new_imapServerAddress;
1079 print "This is the port that your IMAP server is on. Usually this is 143.\n";
1080 print "[$WHT$imapPort$NRM]: $WHT";
1081 $new_imapPort = <STDIN
>;
1082 if ( $new_imapPort eq "\n" ) {
1083 $new_imapPort = $imapPort;
1085 $new_imapPort =~ s/[\r\n]//g;
1087 return $new_imapPort;
1092 print "You now need to choose the method that you will use for sending\n";
1093 print "messages in SquirrelMail. You can either connect to an SMTP server\n";
1094 print "or use sendmail directly.\n";
1095 if ( lc($useSendmail) eq 'true' ) {
1096 $default_value = "1";
1098 $default_value = "2";
1101 print " 1. Sendmail\n";
1103 print "Your choice [1/2] [$WHT$default_value$NRM]: $WHT";
1104 $use_sendmail = <STDIN
>;
1105 if ( ( $use_sendmail =~ /^1\n/i )
1106 || ( ( $use_sendmail =~ /^\n/ ) && ( $default_value eq "1" ) ) ) {
1107 $useSendmail = 'true';
1109 $useSendmail = 'false';
1111 return $useSendmail;
1116 print "Specify where the sendmail executable is located. Usually /usr/sbin/sendmail\n";
1117 print "[$WHT$sendmail_path$NRM]: $WHT";
1118 $new_sendmail_path = <STDIN
>;
1119 if ( $new_sendmail_path eq "\n" ) {
1120 $new_sendmail_path = $sendmail_path;
1122 $new_sendmail_path =~ s/[\r\n]//g;
1124 return $new_sendmail_path;
1127 # Extra sendmail arguments
1128 sub command_sendmail_args
{
1129 print "Specify additional sendmail program arguments.\n";
1131 print "Make sure that arguments are supported by your sendmail program. -f argument \n";
1132 print "is added automatically by SquirrelMail scripts. Variable defaults to standard\n";
1133 print "/usr/sbin/sendmail arguments. If you use qmail-inject, nbsmtp or any other \n";
1134 print "sendmail wrapper, which does not support -i and -t arguments, set variable to\n";
1135 print "empty string or use arguments suitable for your mailer.\n";
1137 print "[$WHT$sendmail_args$NRM]: $WHT";
1138 $new_sendmail_args = <STDIN
>;
1139 if ( $new_sendmail_args eq "\n" ) {
1140 $new_sendmail_args = $sendmail_args;
1142 # strip linefeeds and crs.
1143 $new_sendmail_args =~ s/[\r\n]//g;
1145 return trim
($new_sendmail_args);
1150 print "This is the hostname of your SMTP server.\n";
1151 print "[$WHT$smtpServerAddress$NRM]: $WHT";
1152 $new_smtpServerAddress = <STDIN
>;
1153 if ( $new_smtpServerAddress eq "\n" ) {
1154 $new_smtpServerAddress = $smtpServerAddress;
1156 $new_smtpServerAddress =~ s/[\r\n]//g;
1158 return $new_smtpServerAddress;
1163 print "This is the port to connect to for SMTP. Usually 25.\n";
1164 print "[$WHT$smtpPort$NRM]: $WHT";
1165 $new_smtpPort = <STDIN
>;
1166 if ( $new_smtpPort eq "\n" ) {
1167 $new_smtpPort = $smtpPort;
1169 $new_smtpPort =~ s/[\r\n]//g;
1171 return $new_smtpPort;
1174 # authenticated server
1177 # This sub disabled by tassium - it has been replaced with smtp_auth_mech
1178 print "Do you wish to use an authenticated SMTP server? Your server must\n";
1179 print "support this in order for SquirrelMail to work with it. We implemented\n";
1180 print "it according to RFC 2554.\n";
1183 $YesNo = 'y' if ( lc($use_authenticated_smtp) eq 'true' );
1185 print "Use authenticated SMTP server (y/n) [$WHT$YesNo$NRM]: $WHT";
1187 $new_use_authenticated_smtp = <STDIN
>;
1188 $new_use_authenticated_smtp =~ tr/yn//cd;
1189 return 'true' if ( $new_use_authenticated_smtp eq "y" );
1190 return 'false' if ( $new_use_authenticated_smtp eq "n" );
1191 return $use_authenticated_smtp;
1196 print "Do you wish to use POP3 before SMTP? Your server must\n";
1197 print "support this in order for SquirrelMail to work with it.\n";
1200 $YesNo = 'y' if ( lc($pop_before_smtp) eq 'true' );
1202 print "Use pop before SMTP (y/n) [$WHT$YesNo$NRM]: $WHT";
1204 $new_pop_before_smtp = <STDIN
>;
1205 $new_pop_before_smtp =~ tr/yn//cd;
1206 return 'true' if ( $new_pop_before_smtp eq "y" );
1207 return 'false' if ( $new_pop_before_smtp eq "n" );
1208 return $pop_before_smtp;
1213 print "Each IMAP server has its own quirks. As much as we tried to stick\n";
1214 print "to standards, it doesn't help much if the IMAP server doesn't follow\n";
1215 print "the same principles. We have made some work-arounds for some of\n";
1216 print "these servers. If you would like to use them, please select your\n";
1217 print "IMAP server. If you do not wish to use these work-arounds, you can\n";
1218 print "set this to \"other\", and none will be used.\n";
1219 print " courier = Courier IMAP server\n";
1220 print " cyrus = Cyrus IMAP server\n";
1221 print " dovecot = Dovecot Secure IMAP server\n";
1222 print " exchange = Microsoft Exchange IMAP server\n";
1223 print " hmailserver = hMailServer\n";
1224 print " macosx = Mac OS X Mailserver\n";
1225 print " mercury32 = Mercury Mail Transport System\n";
1226 print " uw = University of Washington's IMAP server\n";
1228 print " other = Not one of the above servers\n";
1230 print "[$WHT$imap_server_type$NRM]: $WHT";
1231 $new_imap_server_type = <STDIN
>;
1233 if ( $new_imap_server_type eq "\n" ) {
1234 $new_imap_server_type = $imap_server_type;
1236 $new_imap_server_type =~ s/[\r\n]//g;
1238 return $new_imap_server_type;
1243 print "Sometimes the date of messages sent is messed up (off by a few hours\n";
1244 print "on some machines). Typically this happens if the system doesn't support\n";
1245 print "tm_gmtoff. It will happen only if your time zone is \"negative\".\n";
1246 print "This most often occurs on Solaris 7 machines in the United States.\n";
1247 print "By default, this is off. It should be kept off unless problems surface\n";
1248 print "about the time that messages are sent.\n";
1249 print " no = Do NOT fix time -- almost always correct\n";
1250 print " yes = Fix the time for this system\n";
1253 $YesNo = 'y' if ( lc($invert_time) eq 'true' );
1255 print "Fix the time for this system (y/n) [$WHT$YesNo$NRM]: $WHT";
1257 $new_invert_time = <STDIN
>;
1258 $new_invert_time =~ tr/yn//cd;
1259 return 'true' if ( $new_invert_time eq "y" );
1260 return 'false' if ( $new_invert_time eq "n" );
1261 return $invert_time;
1265 print "This is the delimiter that your IMAP server uses to distinguish between\n";
1266 print "folders. For example, Cyrus uses '.' as the delimiter and a complete\n";
1267 print "folder would look like 'INBOX.Friends.Bob', while UW uses '/' and would\n";
1268 print "look like 'INBOX/Friends/Bob'. Normally this should be left at 'detect'\n";
1269 print "but if you are sure you know what delimiter your server uses, you can\n";
1270 print "specify it here.\n";
1271 print "\nTo have it autodetect the delimiter, set it to 'detect'.\n\n";
1272 print "[$WHT$optional_delimiter$NRM]: $WHT";
1273 $new_optional_delimiter = <STDIN
>;
1275 if ( $new_optional_delimiter eq "\n" ) {
1276 $new_optional_delimiter = $optional_delimiter;
1278 $new_optional_delimiter =~ s/[\r\n]//g;
1280 return $new_optional_delimiter;
1282 # IMAP authentication type
1283 # Possible values: login, plain, cram-md5, digest-md5
1284 # Now offers to detect supported mechs, assuming server & port are set correctly
1287 if ($use_imap_tls =~ /^true\b/i) {
1288 print "Auto-detection of login methods is unavailable when using TLS.\n";
1290 print "If you have already set the hostname and port number, I can try to\n";
1291 print "detect the mechanisms your IMAP server supports.\n";
1292 print "I will try to detect CRAM-MD5 and DIGEST-MD5 support. I can't test\n";
1293 print "for \"login\" or \"plain\" without knowing a username and password.\n";
1294 print "Auto-detecting is optional - you can safely say \"n\" here.\n";
1295 print "\nTry to detect supported mechanisms? [y/N]: ";
1298 if ($inval =~ /^y\b/i) {
1299 # Yes, let's try to detect.
1300 print "Trying to detect IMAP capabilities...\n";
1301 my $host = $imapServerAddress . ':'. $imapPort;
1302 print "CRAM-MD5:\t";
1303 my $tmp = detect_auth_support
('IMAP',$host,'CRAM-MD5');
1304 if (defined($tmp)) {
1305 if ($tmp eq 'YES') {
1306 print "$WHT SUPPORTED$NRM\n";
1308 print "$WHT NOT SUPPORTED$NRM\n";
1311 print $WHT . " ERROR DETECTING$NRM\n";
1314 print "DIGEST-MD5:\t";
1315 $tmp = detect_auth_support
('IMAP',$host,'DIGEST-MD5');
1316 if (defined($tmp)) {
1317 if ($tmp eq 'YES') {
1318 print "$WHT SUPPORTED$NRM\n";
1320 print "$WHT NOT SUPPORTED$NRM\n";
1323 print $WHT . " ERROR DETECTING$NRM\n";
1328 print "\nWhat authentication mechanism do you want to use for IMAP connections?\n\n";
1329 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1330 print $WHT . "plain" . $NRM . " - SASL PLAIN. If you need this, you already know it.\n";
1331 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext methods.\n";
1332 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1333 print "\n*** YOUR IMAP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n";
1334 print "If you don't understand or are unsure, you probably want \"login\"\n\n";
1335 print "login, plain, cram-md5, or digest-md5 [$WHT$imap_auth_mech$NRM]: $WHT";
1338 if ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) || ($inval =~ /^login\b/i) || ($inval =~ /^plain\b/i)) {
1341 # user entered garbage or default value so nothing needs to be set
1342 return $imap_auth_mech;
1347 # SMTP authentication type
1348 # Possible choices: none, plain, cram-md5, digest-md5
1350 if ($use_smtp_tls =~ /^true\b/i) {
1351 print "Auto-detection of login methods is unavailable when using TLS.\n";
1353 print "If you have already set the hostname and port number, I can try to\n";
1354 print "automatically detect some of the mechanisms your SMTP server supports.\n";
1355 print "Auto-detection is *optional* - you can safely say \"n\" here.\n";
1356 print "\nTry to detect auth mechanisms? [y/N]: ";
1359 if ($inval =~ /^y\b/i) {
1360 # Yes, let's try to detect.
1361 print "Trying to detect supported methods (SMTP)...\n";
1364 # Check none by trying to relay to junk@microsoft.com
1365 $host = $smtpServerAddress . ':' . $smtpPort;
1367 my $sock = IO
::Socket
::INET
->new($host);
1368 print "Testing none:\t\t$WHT";
1369 if (!defined($sock)) {
1370 print " ERROR TESTING\n";
1373 print $sock "HELO $domain\r\n";
1374 $got = <$sock>; # Discard
1375 print $sock "MAIL FROM:<tester\@squirrelmail.org>\r\n";
1376 $got = <$sock>; # Discard
1377 print $sock "RCPT TO:<junk\@microsoft.com\r\n";
1378 $got = <$sock>; # This is the important line
1379 if ($got =~ /^250\b/) { # SMTP will relay without auth
1380 print "SUPPORTED$NRM\n";
1382 print "NOT SUPPORTED$NRM\n";
1384 print $sock "RSET\r\n";
1385 print $sock "QUIT\r\n";
1388 # Try login (SquirrelMail default)
1389 print "Testing login:\t\t";
1390 $tmp=detect_auth_support
('SMTP',$host,'LOGIN');
1391 if (defined($tmp)) {
1392 if ($tmp eq 'YES') {
1393 print $WHT . "SUPPORTED$NRM\n";
1395 print $WHT . "NOT SUPPORTED$NRM\n";
1398 print $WHT . "ERROR DETECTING$NRM\n";
1402 print "Testing CRAM-MD5:\t";
1403 $tmp=detect_auth_support
('SMTP',$host,'CRAM-MD5');
1404 if (defined($tmp)) {
1405 if ($tmp eq 'YES') {
1406 print $WHT . "SUPPORTED$NRM\n";
1408 print $WHT . "NOT SUPPORTED$NRM\n";
1411 print $WHT . "ERROR DETECTING$NRM\n";
1415 print "Testing DIGEST-MD5:\t";
1416 $tmp=detect_auth_support
('SMTP',$host,'DIGEST-MD5');
1417 if (defined($tmp)) {
1418 if ($tmp eq 'YES') {
1419 print $WHT . "SUPPORTED$NRM\n";
1421 print $WHT . "NOT SUPPORTED$NRM\n";
1424 print $WHT . "ERROR DETECTING$NRM\n";
1428 print "\nWhat authentication mechanism do you want to use for SMTP connections?\n";
1429 print $WHT . "none" . $NRM . " - Your SMTP server does not require authorization.\n";
1430 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1431 print $WHT . "plain" . $NRM . " - SASL PLAIN. You already know it if you need this.\n";
1432 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext.\n";
1433 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1434 print $WHT . "\n*** YOUR SMTP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n" . $NRM;
1435 print "If you don't understand or are unsure, you probably want \"none\"\n\n";
1436 print "none, login, cram-md5, or digest-md5 [$WHT$smtp_auth_mech$NRM]: $WHT";
1439 if ($inval =~ /^none\b/i) {
1440 # SMTP doesn't necessarily require logins
1443 if ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) ||
1444 ($inval =~ /^login\b/i) || ($inval =~/^plain\b/i)) {
1447 # user entered garbage, or default value so nothing needs to be set
1448 return $smtp_auth_mech;
1453 # This sub is reused for IMAP and SMTP
1454 # Args: service name, default value
1455 sub command_use_tls
{
1456 my($default_val,$service,$inval);
1459 print "TLS (Transport Layer Security) encrypts the traffic between server and client.\n";
1460 print "STARTTLS extensions allow to start encryption on existing plain text connection.\n";
1461 print "These options add specific PHP and IMAP server configuration requirements.\n";
1462 print "See SquirrelMail documentation about connection security.\n";
1464 print "If your " . $service . " server is localhost, you can safely disable this.\n";
1465 print "If it is remote, you may wish to seriously consider enabling this.\n";
1467 while ($valid_input eq 0) {
1468 print "\nSelect connection security model:\n";
1469 print " 0 - Use plain text connection\n";
1470 print " 1 - Use TLS connection\n";
1471 print " 2 - Use STARTTLS extension\n";
1472 print "Select [$default_val]: ";
1474 $inval=trim
($inval);
1475 if ($inval =~ /^[012]$/ || $inval eq '') {
1479 if ($inval ne '') {$default_val = $inval};
1480 return $default_val;
1483 # This sub is used to display human readable text for
1484 # $use_imap_tls and $use_smtp_tls values in conf.pl menu
1485 sub display_use_tls
($) {
1486 my $val = shift(@_);
1487 my $ret = 'disabled';
1490 } elsif ($val eq '1') {
1496 # $encode_header_key
1498 print "Encryption key allows to hide SquirrelMail Received: headers\n";
1499 print "in outbound messages. Interface uses encryption key to encode\n";
1500 print "username, remote address and proxied address, then stores encoded\n";
1501 print "information in X-Squirrel-* headers.\n";
1503 print "Warning: used encryption function is not bulletproof. When used\n";
1504 print "with static encryption keys, it provides only minimal security\n";
1505 print "measures and information can be decoded quickly.\n";
1507 print "Encoded information can be decoded with decrypt_headers.php script\n";
1508 print "from SquirrelMail contrib/ directory.\n";
1510 print "Enter encryption key: ";
1511 $new_encode_header_key = <STDIN
>;
1512 if ( $new_encode_header_key eq "\n" ) {
1513 $new_encode_header_key = $encode_header_key;
1515 $new_encode_header_key =~ s/[\r\n]//g;
1517 return $new_encode_header_key;
1522 print "\nYou can now create the welcome message that is displayed\n";
1523 print "every time a user logs on. You can use HTML or just plain\n";
1525 "text. If you do not wish to have one, just make it blank.\n\n(Type @ on a blank line to exit)\n";
1531 $line =~ s/[\r\n]//g;
1532 if ( $line ne "@" ) {
1533 $line =~ s/ /\ \ /g;
1534 $line =~ s/\t/\ \ \ \ /g;
1536 $line =~ s/\"/\\\"/g;
1538 $new_motd = $new_motd . $line;
1540 } while ( $line ne "@" );
1544 ################# PLUGINS ###################
1547 $command =~ s/[\s\n\r]*//g;
1548 if ( $command > 0 ) {
1549 $command = $command - 1;
1550 if ( $command <= $#plugins ) {
1553 while ( $ct <= $#plugins ) {
1554 if ( $ct != $command ) {
1555 @newplugins = ( @newplugins, $plugins[$ct] );
1559 @plugins = @newplugins;
1560 } elsif ( $command <= $#plugins + $#unused_plugins + 1 ) {
1561 $num = $command - $#plugins - 1;
1562 @newplugins = @plugins;
1564 while ( $ct <= $#unused_plugins ) {
1565 if ( $ct == $num ) {
1566 @newplugins = ( @newplugins, $unused_plugins[$ct] );
1570 @plugins = @newplugins;
1576 ################# FOLDERS ###################
1578 # default_folder_prefix
1580 print "Some IMAP servers (UW, for example) store mail and folders in\n";
1581 print "your user space in a separate subdirectory. This is where you\n";
1582 print "specify what that directory is.\n";
1584 print "EXAMPLE: mail/";
1586 print "NOTE: If you use Cyrus, or some server that would not use this\n";
1587 print " option, you must set this to 'none'.\n";
1589 print "[$WHT$default_folder_prefix$NRM]: $WHT";
1590 $new_default_folder_prefix = <STDIN
>;
1592 if ( $new_default_folder_prefix eq "\n" ) {
1593 $new_default_folder_prefix = $default_folder_prefix;
1595 $new_default_folder_prefix =~ s/[\r\n]//g;
1597 if ( ( $new_default_folder_prefix =~ /^\s*$/ ) || ( $new_default_folder_prefix =~ m/^none$/i ) ) {
1598 $new_default_folder_prefix = "";
1600 # add the trailing delimiter only if we know what the server is.
1601 if (($imap_server_type eq 'cyrus' and
1602 $optional_delimiter eq 'detect') or
1603 ($imap_server_type eq 'courier' and
1604 $optional_delimiter eq 'detect')) {
1605 $new_default_folder_prefix =~ s/\.*$/\./;
1606 } elsif ($imap_server_type eq 'uw' and
1607 $optional_delimiter eq 'detect') {
1608 $new_default_folder_prefix =~ s/\/*$/\
//;
1611 return $new_default_folder_prefix;
1614 # Show Folder Prefix
1616 print "It is possible to set up the default folder prefix as a user\n";
1617 print "specific option, where each user can specify what their mail\n";
1618 print "folder is. If you set this to false, they will never see the\n";
1619 print "option, but if it is true, this option will appear in the\n";
1620 print "'options' section.\n";
1622 print "NOTE: You set the default folder prefix in option '1' of this\n";
1623 print " section. That will be the default if the user doesn't\n";
1624 print " specify anything different.\n";
1627 if ( lc($show_prefix_option) eq 'true' ) {
1628 $default_value = "y";
1630 $default_value = "n";
1633 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
1634 $new_show = <STDIN
>;
1635 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1636 $show_prefix_option = 'true';
1638 $show_prefix_option = 'false';
1640 return $show_prefix_option;
1645 print "You can now specify where the default trash folder is located.\n";
1646 print "On servers where you do not want this, you can set it to anything\n";
1647 print "and set option 6 to false.\n";
1649 print "This is relative to where the rest of your email is kept. You do\n";
1650 print "not need to worry about their mail directory. If this folder\n";
1651 print "would be ~/mail/trash on the filesystem, you only need to specify\n";
1652 print "that this is 'trash', and be sure to put 'mail/' in option 1.\n";
1655 print "[$WHT$trash_folder$NRM]: $WHT";
1656 $new_trash_folder = <STDIN
>;
1657 if ( $new_trash_folder eq "\n" ) {
1658 $new_trash_folder = $trash_folder;
1660 if (check_imap_folder
($new_trash_folder)) {
1661 $new_trash_folder =~ s/[\r\n]//g;
1663 $new_trash_folder = $trash_folder;
1666 return $new_trash_folder;
1671 print "This is where messages that are sent will be stored. SquirrelMail\n";
1672 print "by default puts a copy of all outgoing messages in this folder.\n";
1674 print "This is relative to where the rest of your email is kept. You do\n";
1675 print "not need to worry about their mail directory. If this folder\n";
1676 print "would be ~/mail/sent on the filesystem, you only need to specify\n";
1677 print "that this is 'sent', and be sure to put 'mail/' in option 1.\n";
1680 print "[$WHT$sent_folder$NRM]: $WHT";
1681 $new_sent_folder = <STDIN
>;
1682 if ( $new_sent_folder eq "\n" ) {
1683 $new_sent_folder = $sent_folder;
1685 if (check_imap_folder
($new_sent_folder)) {
1686 $new_sent_folder =~ s/[\r\n]//g;
1688 $new_sent_folder = $sent_folder;
1691 return $new_sent_folder;
1696 print "You can now specify where the default draft folder is located.\n";
1697 print "On servers where you do not want this, you can set it to anything\n";
1698 print "and set option 9 to false.\n";
1700 print "This is relative to where the rest of your email is kept. You do\n";
1701 print "not need to worry about their mail directory. If this folder\n";
1702 print "would be ~/mail/drafts on the filesystem, you only need to specify\n";
1703 print "that this is 'drafts', and be sure to put 'mail/' in option 1.\n";
1706 print "[$WHT$draft_folder$NRM]: $WHT";
1707 $new_draft_folder = <STDIN
>;
1708 if ( $new_draft_folder eq "\n" ) {
1709 $new_draft_folder = $draft_folder;
1711 if (check_imap_folder
($new_draft_folder)) {
1712 $new_draft_folder =~ s/[\r\n]//g;
1714 $new_draft_folder = $draft_folder;
1717 return $new_draft_folder;
1720 # default move to trash
1722 print "By default, should messages get moved to the trash folder? You\n";
1723 print "can specify the default trash folder in option 3. If this is set\n";
1724 print "to false, messages will get deleted immediately without moving\n";
1725 print "to the trash folder.\n";
1727 print "Trash folder is currently: $trash_folder\n";
1730 if ( lc($default_move_to_trash) eq 'true' ) {
1731 $default_value = "y";
1733 $default_value = "n";
1735 print "By default, move to trash (y/n) [$WHT$default_value$NRM]: $WHT";
1736 $new_show = <STDIN
>;
1737 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1738 $default_move_to_trash = 'true';
1740 $default_move_to_trash = 'false';
1742 return $default_move_to_trash;
1745 # default move to sent
1747 print "By default, should messages get moved to the sent folder? You\n";
1748 print "can specify the default sent folder in option 4. If this is set\n";
1749 print "to false, messages will get sent and no copy will be made.\n";
1751 print "Sent folder is currently: $sent_folder\n";
1754 if ( lc($default_move_to_sent) eq 'true' ) {
1755 $default_value = "y";
1757 $default_value = "n";
1759 print "By default, move to sent (y/n) [$WHT$default_value$NRM]: $WHT";
1760 $new_show = <STDIN
>;
1761 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1762 $default_move_to_sent = 'true';
1764 $default_move_to_sent = 'false';
1766 return $default_move_to_sent;
1769 # default save as draft
1771 print "By default, should the save to draft option be shown? You can\n";
1772 print "specify the default drafts folder in option 5. If this is set\n";
1773 print "to false, users will not be shown the save to draft option.\n";
1775 print "Drafts folder is currently: $draft_folder\n";
1778 if ( lc($default_move_to_draft) eq 'true' ) {
1779 $default_value = "y";
1781 $default_value = "n";
1783 print "By default, save as draft (y/n) [$WHT$default_value$NRM]: $WHT";
1784 $new_show = <STDIN
>;
1785 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1786 $default_save_as_draft = 'true';
1788 $default_save_as_draft = 'false';
1790 return $default_save_as_draft;
1793 # List special folders first
1795 print "SquirrelMail has what we call 'special folders' that are not\n";
1796 print "manipulated and viewed like normal folders. Some examples of\n";
1797 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
1798 print "Simply asks if you want these folders listed first in the folder\n";
1802 if ( lc($list_special_folders_first) eq 'true' ) {
1803 $default_value = "y";
1805 $default_value = "n";
1808 print "List first (y/n) [$WHT$default_value$NRM]: $WHT";
1809 $new_show = <STDIN
>;
1810 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1811 $list_special_folders_first = 'true';
1813 $list_special_folders_first = 'false';
1815 return $list_special_folders_first;
1818 # Show special folders color
1820 print "SquirrelMail has what we call 'special folders' that are not\n";
1821 print "manipulated and viewed like normal folders. Some examples of\n";
1822 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
1823 print "wants to know if we should display special folders in a\n";
1824 print "color than the other folders.\n";
1827 if ( lc($use_special_folder_color) eq 'true' ) {
1828 $default_value = "y";
1830 $default_value = "n";
1833 print "Show color (y/n) [$WHT$default_value$NRM]: $WHT";
1834 $new_show = <STDIN
>;
1835 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1836 $use_special_folder_color = 'true';
1838 $use_special_folder_color = 'false';
1840 return $use_special_folder_color;
1845 print "The way that IMAP handles deleting messages is as follows. You\n";
1846 print "mark the message as deleted, and then to 'really' delete it, you\n";
1847 print "expunge it. This option asks if you want to just have messages\n";
1848 print "marked as deleted, or if you want SquirrelMail to expunge the \n";
1849 print "messages too.\n";
1852 if ( lc($auto_expunge) eq 'true' ) {
1853 $default_value = "y";
1855 $default_value = "n";
1857 print "Auto expunge (y/n) [$WHT$default_value$NRM]: $WHT";
1858 $new_show = <STDIN
>;
1859 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1860 $auto_expunge = 'true';
1862 $auto_expunge = 'false';
1864 return $auto_expunge;
1867 # Default sub of inbox
1869 print "Some IMAP servers (Cyrus) have all folders as subfolders of INBOX.\n";
1870 print "This can cause some confusion in folder creation for users when\n";
1871 print "they try to create folders and don't put it as a subfolder of INBOX\n";
1872 print "and get permission errors. This option asks if you want folders\n";
1873 print "to be subfolders of INBOX by default.\n";
1876 if ( lc($default_sub_of_inbox) eq 'true' ) {
1877 $default_value = "y";
1879 $default_value = "n";
1881 print "Default sub of INBOX (y/n) [$WHT$default_value$NRM]: $WHT";
1882 $new_show = <STDIN
>;
1883 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1884 $default_sub_of_inbox = 'true';
1886 $default_sub_of_inbox = 'false';
1888 return $default_sub_of_inbox;
1891 # Show contain subfolder option
1893 print "Some IMAP servers (UW) make it so that there are two types of\n";
1894 print "folders. Those that contain messages, and those that contain\n";
1895 print "subfolders. If this is the case for your server, set this to\n";
1896 print "true, and it will ask the user whether the folder they are\n";
1897 print "creating contains subfolders or messages.\n";
1900 if ( lc($show_contain_subfolders_option) eq 'true' ) {
1901 $default_value = "y";
1903 $default_value = "n";
1905 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
1906 $new_show = <STDIN
>;
1907 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1908 $show_contain_subfolders_option = 'true';
1910 $show_contain_subfolders_option = 'false';
1912 return $show_contain_subfolders_option;
1915 # Default Unseen Notify
1917 print "This option specifies where the users will receive notification\n";
1918 print "about unseen messages by default. This is of course an option that\n";
1919 print "can be changed on a user level.\n";
1920 print " 1 = No notification\n";
1921 print " 2 = Only on the INBOX\n";
1922 print " 3 = On all folders\n";
1925 print "Which one should be default (1,2,3)? [$WHT$default_unseen_notify$NRM]: $WHT";
1926 $new_show = <STDIN
>;
1927 if ( $new_show =~ /^[123]\n/i ) {
1928 $default_unseen_notify = $new_show;
1930 $default_unseen_notify =~ s/[\r\n]//g;
1931 return $default_unseen_notify;
1934 # Default Unseen Type
1936 print "Here you can define the default way that unseen messages will be displayed\n";
1937 print "to the user in the folder listing on the left side.\n";
1938 print " 1 = Only unseen messages (4)\n";
1939 print " 2 = Unseen and Total messages (4/27)\n";
1942 print "Which one should be default (1,2)? [$WHT$default_unseen_type$NRM]: $WHT";
1943 $new_show = <STDIN
>;
1944 if ( $new_show =~ /^[12]\n/i ) {
1945 $default_unseen_type = $new_show;
1947 $default_unseen_type =~ s/[\r\n]//g;
1948 return $default_unseen_type;
1951 # Auto create special folders
1953 print "Would you like the Sent, Trash, and Drafts folders to be created\n";
1954 print "automatically print for you when a user logs in? If the user\n";
1955 print "accidentally deletes their special folders, this option will\n";
1956 print "automatically create it again for them.\n";
1959 if ( lc($auto_create_special) eq 'true' ) {
1960 $default_value = "y";
1962 $default_value = "n";
1964 print "Auto create special folders? (y/n) [$WHT$default_value$NRM]: $WHT";
1965 $new_show = <STDIN
>;
1966 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1967 $auto_create_special = 'true';
1969 $auto_create_special = 'false';
1971 return $auto_create_special;
1974 # Automatically delete folders
1976 if ( $imap_server_type eq "uw" ) {
1977 print "UW IMAP servers will not allow folders containing mail to also contain folders.\n";
1978 print "Deleting folders will bypass the trash folder and be immediately deleted\n\n";
1979 print "If this is not the correct value for your server,\n";
1980 print "please use option D on the Main Menu to configure your server correctly.\n\n";
1981 print "Press any key to continue...\n";
1982 $new_delete = <STDIN
>;
1983 $delete_folder = 'true';
1985 if ( $imap_server_type eq "courier" ) {
1986 print "Courier (or Courier-IMAP) IMAP servers may not support ";
1987 print "subfolders of Trash. \n";
1988 print "Specifically, if Courier is set to always move messages to Trash, \n";
1989 print "Trash will be treated by Courier as a special folder that does not \n";
1990 print "allow subfolders. \n\n";
1991 print "Please verify your Courier configuration, and test folder deletion \n";
1992 print "when changing this setting.\n\n";
1995 print "Are subfolders of the Trash supported by your IMAP server?\n";
1996 print "If so, should deleted folders be sent to Trash?\n";
1997 print "If not, say no (deleted folders should not be sent to Trash)\n\n";
1998 # reversal of logic.
1999 # question was: Should folders be automatically deleted instead of sent to trash..
2000 # we've changed the question to make it more clear,
2001 # and are here handling that to avoid changing the answers..
2002 if ( lc($delete_folder) eq 'true' ) {
2003 $default_value = "n";
2005 $default_value = "y";
2007 print "Send deleted folders to Trash? (y/n) [$WHT$default_value$NRM]: $WHT";
2008 $new_delete = <STDIN
>;
2009 if ( ( $new_delete =~ /^y\n/i ) || ( ( $new_delete =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2010 $delete_folder = 'false';
2012 $delete_folder = 'true';
2015 return $delete_folder;
2020 print "Some IMAP server allow subfolders to exist even if the parent\n";
2021 print "folders do not. This fixes some problems with the folder list\n";
2022 print "when this is the case, causing the /NoSelect folders to be displayed\n";
2025 if ( lc($noselect_fix_enable) eq 'true' ) {
2026 $default_value = "y";
2028 $default_value = "n";
2030 print "enable noselect fix? (y/n) [$WHT$noselect_fix_enable$NRM]: $WHT";
2031 $noselect_fix_enable = <STDIN
>;
2032 if ( ( $noselect_fix_enable =~ /^y\n/i ) || ( ( $noselect_fix_enable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2033 $noselect_fix_enable = 'true';
2035 $noselect_fix_enable = 'false';
2037 return $noselect_fix_enable;
2039 ############# GENERAL OPTIONS #####################
2043 print "Specify the location for your data directory.\n";
2044 print "You need to create this directory yourself.\n";
2045 print "The path name can be absolute or relative (to the config directory).\n";
2046 print "Here are two examples:\n";
2047 print " Absolute: /var/local/squirrelmail/data/\n";
2048 print " Relative: ../data/\n";
2049 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2050 print "will be converted to their absolute path equivalents in config.php.\n\n";
2051 print "Note: There are potential security risks with having a writeable directory\n";
2052 print "under the web server's root directory (ex: /home/httpd/html).\n";
2053 print "For this reason, it is recommended to put the data directory\n";
2054 print "in an alternate location of your choice. \n";
2057 print "[$WHT$data_dir$NRM]: $WHT";
2058 $new_data_dir = <STDIN
>;
2059 if ( $new_data_dir eq "\n" ) {
2060 $new_data_dir = $data_dir;
2062 $new_data_dir =~ s/[\r\n]//g;
2064 if ( $new_data_dir =~ /^\s*$/ ) {
2067 $new_data_dir =~ s/\/*$//g
;
2068 $new_data_dir =~ s/$/\//g
;
2070 return $new_data_dir;
2073 # Attachment directory
2075 print "Path to directory used for storing attachments while a mail is\n";
2076 print "being composed. The path name can be absolute or relative (to the\n";
2077 print "config directory). Here are two examples:\n";
2078 print " Absolute: /var/local/squirrelmail/attach/\n";
2079 print " Relative: ../attach/\n";
2080 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2081 print "will be converted to their absolute path equivalents in config.php.\n\n";
2082 print "Note: There are a few security considerations regarding this\n";
2083 print "directory:\n";
2084 print " 1. It should have the permission 733 (rwx-wx-wx) to make it\n";
2085 print " impossible for a random person with access to the webserver\n";
2086 print " to list files in this directory. Confidential data might\n";
2087 print " be laying around in there.\n";
2088 print " Depending on your user:group assignments, 730 (rwx-wx---)\n";
2089 print " may be possible, and more secure (e.g. root:apache)\n";
2090 print " 2. Since the webserver is not able to list the files in the\n";
2091 print " content is also impossible for the webserver to delete files\n";
2092 print " lying around there for too long.\n";
2093 print " 3. It should probably be another directory than the data\n";
2094 print " directory specified in option 3.\n";
2097 print "[$WHT$attachment_dir$NRM]: $WHT";
2098 $new_attachment_dir = <STDIN
>;
2099 if ( $new_attachment_dir eq "\n" ) {
2100 $new_attachment_dir = $attachment_dir;
2102 $new_attachment_dir =~ s/[\r\n]//g;
2104 if ( $new_attachment_dir =~ /^\s*$/ ) {
2105 $new_attachment_dir = "";
2107 $new_attachment_dir =~ s/\/*$//g
;
2108 $new_attachment_dir =~ s/$/\//g
;
2110 return $new_attachment_dir;
2114 print "The directory hash level setting allows you to configure the level\n";
2115 print "of hashing that SquirrelMail employs in your data and attachment\n";
2116 print "directories. This value must be an integer ranging from 0 to 4.\n";
2117 print "When this value is set to 0, SquirrelMail will simply store all\n";
2118 print "files as normal in the data and attachment directories. However,\n";
2119 print "when set to a value from 1 to 4, a simple hashing scheme will be\n";
2120 print "used to organize the files in this directory. In short, the crc32\n";
2121 print "value for a username will be computed. Then, up to the first 4\n";
2122 print "digits of the hash, as set by this configuration value, will be\n";
2123 print "used to directory hash the files for that user in the data and\n";
2124 print "attachment directory. This allows for better performance on\n";
2125 print "servers with larger numbers of users.\n";
2128 print "[$WHT$dir_hash_level$NRM]: $WHT";
2129 $new_dir_hash_level = <STDIN
>;
2130 if ( $new_dir_hash_level eq "\n" ) {
2131 $new_dir_hash_level = $dir_hash_level;
2133 $new_dir_hash_level =~ s/[\r\n]//g;
2135 if ( ( int($new_dir_hash_level) < 0 )
2136 || ( int($new_dir_hash_level) > 4 )
2137 || !( int($new_dir_hash_level) eq $new_dir_hash_level ) ) {
2138 print "Invalid Directory Hash Level.\n";
2139 print "Value must be an integer ranging from 0 to 4\n";
2140 print "Hit enter to continue.\n";
2141 $enter_key = <STDIN
>;
2143 $new_dir_hash_level = $dir_hash_level;
2146 return $new_dir_hash_level;
2150 print "This is the default size (in pixels) of the left folder list.\n";
2151 print "Default is 200, but you can set it to whatever you wish. This\n";
2152 print "is a user preference, so this will only show up as their default.\n";
2154 print "[$WHT$default_left_size$NRM]: $WHT";
2155 $new_default_left_size = <STDIN
>;
2156 if ( $new_default_left_size eq "\n" ) {
2157 $new_default_left_size = $default_left_size;
2159 $new_default_left_size =~ s/[\r\n]//g;
2161 return $new_default_left_size;
2165 print "Some IMAP servers only have lowercase letters in the usernames\n";
2166 print "but they still allow people with uppercase to log in. This\n";
2167 print "causes a problem with the user's preference files. This option\n";
2168 print "transparently changes all usernames to lowercase.";
2171 if ( lc($force_username_lowercase) eq 'true' ) {
2172 $default_value = "y";
2174 $default_value = "n";
2176 print "Convert usernames to lowercase (y/n) [$WHT$default_value$NRM]: $WHT";
2177 $new_show = <STDIN
>;
2178 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2188 if ( lc($default_use_priority) eq 'true' ) {
2189 $default_value = "y";
2191 $default_value = "n";
2194 print "Allow users to specify priority of outgoing mail (y/n) [$WHT$default_value$NRM]: $WHT";
2195 $new_show = <STDIN
>;
2196 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2206 if ( lc($default_hide_attribution) eq 'true' ) {
2207 $default_value = "y";
2209 $default_value = "n";
2212 print "Hide SM attributions (y/n) [$WHT$default_value$NRM]: $WHT";
2213 $new_show = <STDIN
>;
2214 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2224 if ( lc($default_use_mdn) eq 'true' ) {
2225 $default_value = "y";
2227 $default_value = "n";
2230 print "Enable support for read/delivery receipt support (y/n) [$WHT$default_value$NRM]: $WHT";
2231 $new_show = <STDIN
>;
2232 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2240 print " In loosely managed environments, you may want to allow users
2241 to edit their full name and email address. In strictly managed
2242 environments, you may want to force users to use the name
2243 and email address assigned to them.
2245 'y' - allow a user to edit their full name and email address,
2246 'n' - users must use the assigned values.
2250 if ( lc($edit_identity) eq 'true' ) {
2251 $default_value = "y";
2253 $default_value = "n";
2255 print "Allow editing of user's identity? (y/n) [$WHT$default_value$NRM]: $WHT";
2256 $new_edit = <STDIN
>;
2257 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2258 $edit_identity = 'true';
2259 $edit_name = 'true';
2260 $hide_auth_header = command311b
();
2262 $edit_identity = 'false';
2263 $edit_name = command311
();
2264 $hide_auth_header = command311b
();
2266 return $edit_identity;
2270 print " Given that users are not allowed to modify their
2271 email address, can they edit their full name?
2275 if ( lc($edit_name) eq 'true' ) {
2276 $default_value = "y";
2278 $default_value = "n";
2280 print "Allow the user to edit their full name? (y/n) [$WHT$default_value$NRM]: $WHT";
2281 $new_edit = <STDIN
>;
2282 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2283 $edit_name = 'true';
2285 $edit_name = 'false';
2291 print " SquirrelMail adds username information to every sent email
2292 in order to prevent possible sender forging when users are allowed
2293 to change their email and/or full name.
2295 You can remove user information from this header (y), if you think that
2296 it violates privacy or security.
2298 Note: If users are allowed to change their email addresses,
2299 this setting will make it difficult to determine who sent what where.
2300 Use at your own risk.
2304 if ( lc($hide_auth_header) eq "true" ) {
2305 $default_value = "y";
2307 $default_value = "n";
2309 print "Remove username from email headers? (y/n) [$WHT$default_value$NRM]: $WHT";
2310 $new_header = <STDIN
>;
2311 if ( ( $new_header =~ /^y\n/i ) || ( ( $new_header =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2312 $hide_auth_header = "true";
2314 $hide_auth_header = "false";
2316 return $hide_auth_header;
2320 print "This option allows you to disable server side thread sorting if your server \n";
2321 print "declares THREAD support, but you don't want to provide threading options \n";
2322 print "to end users or THREAD extension is broken or extension does not work with \n";
2323 print "options used by SquirrelMail. Option is not used, if THREAD extension is \n";
2324 print "not declared in IMAP CAPABILITY.\n";
2327 if ( lc($disable_thread_sort) eq 'true' ) {
2328 $default_value = "y";
2330 $default_value = "n";
2332 print "Disable server side thread sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2333 $disable_thread_sort = <STDIN
>;
2334 if ( ( $disable_thread_sort =~ /^y\n/i ) || ( ( $disable_thread_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2335 $disable_thread_sort = 'true';
2337 $disable_thread_sort = 'false';
2339 return $disable_thread_sort;
2343 print "This option allows you to disable server side sorting if your server declares \n";
2344 print "SORT support, but SORT extension is broken or does not work with options \n";
2345 print "used by SquirrelMail. Option is not used, if SORT extension is not declared \n";
2346 print "in IMAP CAPABILITY.\n";
2348 print "It is strongly recommended to keep server side sorting enabled, if your ";
2349 print "IMAP server supports it.";
2352 if ( lc($disable_server_sort) eq 'true' ) {
2353 $default_value = "y";
2355 $default_value = "n";
2357 print "Disable server-side sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2358 $disable_server_sort = <STDIN
>;
2359 if ( ( $disable_server_sort =~ /^y\n/i ) || ( ( $disable_server_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2360 $disable_server_sort = 'true';
2362 $disable_server_sort = 'false';
2364 return $disable_server_sort;
2368 print "This option allows you to choose if SM uses charset search\n";
2369 print "Your IMAP server must support the SEARCH CHARSET command for this to work\n";
2372 if ( lc($allow_charset_search) eq 'true' ) {
2373 $default_value = "y";
2375 $default_value = "n";
2377 print "Allow charset searching? (y/n) [$WHT$default_value$NRM]: $WHT";
2378 $allow_charset_search = <STDIN
>;
2379 if ( ( $allow_charset_search =~ /^y\n/i ) || ( ( $allow_charset_search =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2380 $allow_charset_search = 'true';
2382 $allow_charset_search = 'false';
2384 return $allow_charset_search;
2387 # command315 (UID support) obsoleted.
2389 # advanced search option
2391 print "This option allows you to control the use of advanced search form.\n";
2392 print " 0 = enable basic search only\n";
2393 print " 1 = enable advanced search only\n";
2394 print " 2 = enable both\n";
2397 print "Allowed search (0,1,2)? [$WHT$allow_advanced_search$NRM]: $WHT";
2398 $new_allow_advanced_search = <STDIN
>;
2399 if ( $new_allow_advanced_search =~ /^[012]\n/i ) {
2400 $allow_advanced_search = $new_allow_advanced_search;
2402 $allow_advanced_search =~ s/[\r\n]//g;
2403 return $allow_advanced_search;
2408 print "This option allows you to change the name of the PHP session used\n";
2409 print "by SquirrelMail. Unless you know what you are doing, you probably\n";
2410 print "don't need or want to change this from the default of SQMSESSID.\n";
2411 print "[$WHT$session_name$NRM]: $WHT";
2412 $new_session_name = <STDIN
>;
2413 chomp($new_session_name);
2414 if ( $new_session_name eq "" ) {
2415 $new_session_name = $session_name;
2417 return $new_session_name;
2420 # time zone config (since 1.5.1)
2422 print "This option allows you to control the use of time zones.\n";
2423 print " 0 = (default) standard, GNU C time zone names\n";
2424 print " 1 = strict, generic time zone codes with offsets\n";
2425 print " 2 = custom, GNU C time zones loaded from config/timezones.php\n";
2426 print " 3 = custom strict, generic time zone codes with offsets loaded \n";
2427 print " from config/timezones.php\n";
2428 print "See SquirrelMail documentation about format of config/timezones.php file.\n";
2431 print "Used time zone configuration (0,1,2,3)? [$WHT$time_zone_type$NRM]: $WHT";
2432 $new_time_zone_type = <STDIN
>;
2433 if ( $new_time_zone_type =~ /^[0123]\n/i ) {
2434 $time_zone_type = $new_time_zone_type;
2436 print "\nInvalid configuration value.\n";
2437 print "\nPress enter to continue...";
2440 $time_zone_type =~ s/[\r\n]//g;
2441 return $time_zone_type;
2446 print "\nDefine the themes that you wish to use. If you have added ";
2447 print "a theme of your own, just follow the instructions (?) about how to add ";
2448 print "them. You can also change the default theme.\n";
2449 print "[theme] command (?=help) > ";
2451 $input =~ s/[\r\n]//g;
2452 while ( $input ne "d" ) {
2453 if ( $input =~ /^\s*l\s*/i ) {
2455 while ( $count <= $#theme_name ) {
2456 if ( $count == $theme_default ) {
2461 if ( $count < 10 ) {
2464 $name = $theme_name[$count];
2465 $num_spaces = 35 - length($name);
2466 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2467 $name = $name . " ";
2470 print " $count. $name";
2471 print "($theme_path[$count])\n";
2475 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2476 $old_def = $theme_default;
2477 $theme_default = $input;
2478 $theme_default =~ s/^\s*m\s*//;
2479 if ( ( $theme_default > $#theme_name ) || ( $theme_default < 0 ) ) {
2480 print "Cannot set default theme to $theme_default. That theme does not exist.\n";
2481 $theme_default = $old_def;
2483 } elsif ( $input =~ /^\s*\+/ ) {
2484 print "What is the name of this theme: ";
2486 $name =~ s/[\r\n]//g;
2487 $theme_name[ $#theme_name + 1 ] = $name;
2488 print "Be sure to put ../themes/ before the filename.\n";
2489 print "What file is this stored in (ex: ../themes/default_theme.php): ";
2491 $name =~ s/[\r\n]//g;
2492 $theme_path[ $#theme_path + 1 ] = $name;
2493 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2494 if ( $input =~ /[0-9]+\s*$/ ) {
2496 $rem_num =~ s/^\s*-\s*//g;
2497 $rem_num =~ s/\s*$//;
2499 $rem_num = $#theme_name;
2501 if ( $rem_num == $theme_default ) {
2502 print "You cannot remove the default theme!\n";
2505 @new_theme_name = ();
2506 @new_theme_path = ();
2507 while ( $count <= $#theme_name ) {
2508 if ( $count != $rem_num ) {
2509 @new_theme_name = ( @new_theme_name, $theme_name[$count] );
2510 @new_theme_path = ( @new_theme_path, $theme_path[$count] );
2514 @theme_name = @new_theme_name;
2515 @theme_path = @new_theme_path;
2516 if ( $theme_default > $rem_num ) {
2520 } elsif ( $input =~ /^\s*t\s*/i ) {
2521 print "\nStarting detection...\n\n";
2523 opendir( DIR
, "../themes" );
2524 @files = grep { /\.php$/i } readdir(DIR
);
2526 while ( $cnt <= $#files ) {
2527 $filename = "../themes/" . $files[$cnt];
2528 if ( $filename ne "../themes/index.php" ) {
2530 for ( $x = 0 ; $x <= $#theme_path ; $x++ ) {
2531 if ( $theme_path[$x] eq $filename ) {
2535 if ( $found != 1 ) {
2536 print "** Found theme: $filename\n";
2537 print " What is its name? ";
2540 $theme_name[ $#theme_name + 1 ] = $nm;
2541 $theme_path[ $#theme_path + 1 ] = $filename;
2547 for ( $cnt = 0 ; $cnt <= $#theme_path ; $cnt++ ) {
2548 $filename = $theme_path[$cnt];
2549 if ( !( -e
$filename ) ) {
2550 print " Removing $filename (file not found)\n";
2552 @new_theme_name = ();
2553 @new_theme_path = ();
2554 for ( $x = 0 ; $x < $#theme_path ; $x++ ) {
2555 if ( $theme_path[$x] eq $filename ) {
2558 if ( $offset == 1 ) {
2559 $new_theme_name[$x] = $theme_name[ $x + 1 ];
2560 $new_theme_path[$x] = $theme_path[ $x + 1 ];
2562 $new_theme_name[$x] = $theme_name[$x];
2563 $new_theme_path[$x] = $theme_path[$x];
2566 @theme_name = @new_theme_name;
2567 @theme_path = @new_theme_path;
2570 print "\nDetection complete!\n\n";
2573 } elsif ( $input =~ /^\s*\?\s*/ ) {
2574 print ".-------------------------.\n";
2575 print "| t (detect themes) |\n";
2576 print "| + (add theme) |\n";
2577 print "| - N (remove theme) |\n";
2578 print "| m N (mark default) |\n";
2579 print "| l (list themes) |\n";
2580 print "| d (done) |\n";
2581 print "`-------------------------'\n";
2583 print "[theme] command (?=help) > ";
2585 $input =~ s/[\r\n]//g;
2589 sub command_templates
{
2590 print "\nDefine the template sets that you wish to use. If you have added ";
2591 print "a template set of your own, just follow the instructions (?) about how to add ";
2592 print "them. You can also change the default template.\n";
2594 print "\n Available Templates:\n";
2597 while ( $count <= $#templateset_name ) {
2598 if ( $count == $templateset_default ) {
2603 if ( $count < 10 ) {
2606 $name = $templateset_name[$count];
2607 $num_spaces = 35 - length($name);
2608 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2609 $name = $name . " ";
2612 print " $count. $name";
2613 print "($templateset_path[$count])\n";
2618 # opendir( DIR, "../templates" );
2619 # @files = readdir(DIR);
2622 # while ( $cnt <= $#files ) {
2623 # if ( -d "../templates/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne "CVS" ) {
2624 # $filename = "../templates/" . $files[$cnt];
2626 # for ( $x = 0 ; $x <= $#templateset_path ; $x++ ) {
2627 # if ( $theme_path[$x] eq $filename ) {
2634 # for ( $i = 0 ; $i <= $#files ; $i++ ) {
2635 # if ( -d "../templates/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne "CVS" ) {
2637 # for ( $k = 0 ; $k <= $#aTemplateSets ; $k++ ) {
2638 # if ( $aTemplateSets[$chosen] eq $files[$i] ) {
2642 # if ( $match == 0 ) {
2643 # $unused_plugins[$pos] = $files[$i];
2649 # for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
2651 # print " $num. $unused_plugins[$i]\n";
2656 print ".--------------------------------.\n";
2657 print "| t (detect templates set) |\n";
2658 print "| + (add template set) |\n";
2659 print "| - N (remove template set) |\n";
2660 print "| m N (mark template set) |\n";
2661 print "| l (list template set) |\n";
2662 print "| d (done) |\n";
2663 print "`--------------------------------'\n";
2664 print "\n[template set] command (?=help) > ";
2667 $input =~ s/[\r\n]//g;
2668 while ( $input ne "d" ) {
2669 if ( $input =~ /^\s*l\s*/i ) {
2671 while ( $count <= $#templateset_name ) {
2672 if ( $count == $templateset_default ) {
2677 if ( $count < 10 ) {
2680 $name = $templateset_name[$count];
2681 $num_spaces = 35 - length($name);
2682 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2683 $name = $name . " ";
2686 print " $count. $name";
2687 print "($templateset_path[$count])\n";
2691 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2692 $old_def = $templateset_default;
2693 $templateset_default = $input;
2694 $templateset_default =~ s/^\s*m\s*//;
2695 if ( ( $templateset_default > $#templateset_name ) || ( $templateset_default < 0 ) ) {
2696 print "Cannot set default template set to $templateset_default. That template set does not exist.\n";
2697 $templateset_default = $old_def;
2699 } elsif ( $input =~ /^\s*\+/ ) {
2700 print "What is the name of this template: ";
2702 $name =~ s/[\r\n]//g;
2703 $templateset_name[ $#templateset_name + 1 ] = $name;
2704 print "Be sure to put ../templates/ before the dirname.\n";
2705 print "What file is this stored in (ex: ../templates/default/): ";
2707 $name =~ s/[\r\n]//g;
2708 $templateset_path[ $#templateset_path + 1 ] = $name;
2709 } elsif ( $input =~ /^\s*t\s*/i ) {
2710 print "\nStarting detection...\n\n";
2711 opendir( DIR
, "../templates" );
2712 @files = readdir(DIR
);
2715 while ( $cnt <= $#files ) {
2716 if ( -d
"../templates/" . $files[$cnt] && $files[$cnt] !~ /^\./ && $files[$cnt] ne "CVS" ) {
2717 $filename = "../templates/" . $files[$cnt]. "/";
2719 for ( $x = 0 ; $x <= $#templateset_path ; $x++ ) {
2720 if ( $templateset_path[$x] eq $filename ) {
2724 if ( $found != 1 && $detected == 0) {
2725 $templateset_path[ $#templateset_path + 1 ] = $filename;
2726 $templateset_name[ $#templateset_name + 1 ] = "Default template";
2727 $aTemplateSet[ $#templateset_name + 1 ] = "Default template";
2728 $aTemplateSet[ $#templateset_path + 1 ] = $filename;
2729 } elsif ( $found != 1) {
2730 print "** Found template set: $filename\n";
2731 print " What is it's name? ";
2734 $templateset_path[ $#templateset_path + 1 ] = $filename;
2735 $templateset_name[ $#templateset_name + 1 ] = $nm;
2737 $aTemplateSet[ $#templateset_name + 1 ] = $nm;
2738 $aTemplateSet[ $#templateset_path + 1 ] = $filename;
2745 for ( $cnt = 0 ; $cnt <= $#templateset_path ; $cnt++ ) {
2746 $filename = $templateset_path[$cnt];
2747 if ( !(-d
$filename) ) {
2748 print " Removing $filename (file not found)\n";
2750 @new_templateset_name = ();
2751 @new_templateset_path = ();
2752 for ( $x = 0 ; $x < $#templateset_path ; $x++ ) {
2753 if ( $templateset_path[$x] eq $filename ) {
2756 if ( $offset == 1 ) {
2757 $new_templateset_name[$x] = $templateset_name[ $x + 1 ];
2758 $new_theme_path[$x] = $templateset_path[ $x + 1 ];
2760 $new_templateset_name[$x] = $templateset_name[$x];
2761 $new_templateset_path[$x] = $templateset_path[$x];
2764 @templateset_name = @new_templateset_name;
2765 @templateset_path = @new_templateset_path;
2768 print "\nDetection complete!\n\n";
2771 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2772 if ( $input =~ /[0-9]+\s*$/ ) {
2774 $rem_num =~ s/^\s*-\s*//g;
2775 $rem_num =~ s/\s*$//;
2777 $rem_num = $#templateset_name;
2779 if ( $rem_num == $templateset_default ) {
2780 print "You cannot remove the default template set!\n";
2783 @new_templateset_name = ();
2784 @new_templateset_path = ();
2785 while ( $count <= $#templateset_name ) {
2786 if ( $count != $rem_num ) {
2787 @new_templateset_name = ( @new_templateset_name, $templateset_name[$count] );
2788 @new_templateset_path = ( @new_templateset_path, $templateset_path[$count] );
2792 @templateset_name = @new_templateset_name;
2793 @templateset_path = @new_templateset_path;
2794 if ( $templateset_default > $rem_num ) {
2795 $templateset_default--;
2798 } elsif ( $input =~ /^\s*\?\s*/ ) {
2799 print ".--------------------------------.\n";
2800 print "| t (detect templates set) |\n";
2801 print "| + (add template set) |\n";
2802 print "| - N (remove template set) |\n";
2803 print "| m N (mark template set) |\n";
2804 print "| l (list template set) |\n";
2805 print "| d (done) |\n";
2806 print "`--------------------------------'\n";
2808 print "[template set] command (?=help) > ";
2810 $input =~ s/[\r\n]//g;
2812 return $templateset_default;
2818 print "You may specify a cascading style-sheet (CSS) file to be included\n";
2819 print "on each html page generated by SquirrelMail. The CSS file is useful\n";
2820 print "for specifying a site-wide font. If you're not familiar with CSS\n";
2821 print "files, leave this blank.\n";
2823 print "To clear out an existing value, just type a space for the input.\n";
2825 print "Please be aware of the following: \n";
2826 print " - Relative URLs are relative to the config dir\n";
2827 print " to use the themes directory, use ../themes/css/newdefault.css\n";
2828 print " - To specify a css file defined outside the SquirrelMail source tree\n";
2829 print " use the absolute URL the webserver would use to include the file\n";
2830 print " e.g. http://some.host.com/css/mystyle.css or /css/mystyle.css\n";
2832 print "[$WHT$theme_css$NRM]: $WHT";
2833 $new_theme_css = <STDIN
>;
2835 if ( $new_theme_css eq "\n" ) {
2836 $new_theme_css = $theme_css;
2838 $new_theme_css =~ s/[\r\n]//g;
2840 $new_theme_css =~ s/^\s*//;
2841 return $new_theme_css;
2844 # sets default font size option
2845 sub command_default_fontsize
{
2846 print "Enter default font size [$WHT$$default_fontsize$NRM]: $WHT";
2847 $new_size = <STDIN
>;
2848 if ( $new_size eq "\n" ) {
2851 $new_size =~ s/[\r\n]//g;
2856 # controls available fontsets
2857 sub command_fontsets
{
2859 print "You can control fontsets available to end users here.\n";
2860 # set initial $input value
2862 while ( $input ne "x" ) {
2863 if ( $input =~ /^\s*a\s*/i ) {
2865 print "\nFontset name: ";
2867 if (! $fontsets{trim
($name)}) {
2868 print "Fontset string: ";
2870 $fontsets{trim
($name)} = trim
($value);
2872 print "\nERROR: Such fontset already exists.\n";
2874 } elsif ( $input =~ /^\s*e\s*/i ) {
2875 # edit existing fontset
2876 print "\nFontset name: ";
2878 if (! $fontsets{trim
($name)}) {
2879 print "\nERROR: No such fontset.\n";
2881 print "Fontset string [$fontsets{trim($name)}]: ";
2883 $fontsets{trim
($name)} = trim
($value);
2885 } elsif ( $input =~ /^\s*d\s*/ ) {
2886 # delete existing fontset
2887 print "\nFontset name: ";
2889 if (! $fontsets{trim
($name)}) {
2890 print "\nERROR: No such fontset.\n";
2892 delete $fontsets{trim
($name)};
2894 } elsif ( $input =~ /^\s*l\s*/ ) {
2896 print "\nConfigured fontsets:\n";
2897 while (($fontset_name, $fontset_string) = each(%fontsets)) {
2898 print " $fontset_name = $fontset_string\n";
2900 print "Default fontset: $default_fontset\n";
2901 } elsif ( $input =~ /^\s*m\s*/ ) {
2902 # set default fontset
2903 print "\nSet default fontset [$default_fontset]: ";
2905 if (trim
($name) ne '' and ! $fontsets{trim
($name)}) {
2906 print "\nERROR: No such fontset.\n";
2908 $default_fontset = trim
($name);
2911 # print available commands on any other input
2912 print "\nAvailable commands:\n";
2913 print " a - Adds new fontset.\n";
2914 print " d - Deletes existing fontset.\n";
2915 print " e - Edits existing fontset.\n";
2916 print " h or ? - Shows this help screen.\n";
2917 print " l - Lists available fontsets.\n";
2918 print " m - Sets default fontset.\n";
2919 print " x - Exits fontset editor mode.\n";
2921 print "\nCommand [fontsets] (a,d,e,h,?=help,l,m,x)> ";
2923 $input =~ s/[\r\n]//g;
2928 print "You can now define different LDAP servers.\n";
2929 print "Please ensure proper permissions for config.php when including\n";
2930 print "sensitive passwords.\n\n";
2931 print "[ldap] command (?=help) > ";
2933 $input =~ s/[\r\n]//g;
2934 while ( $input ne "d" ) {
2935 if ( $input =~ /^\s*l\s*/i ) {
2937 while ( $count <= $#ldap_host ) {
2938 print "$count. $ldap_host[$count]\n";
2939 print " base: $ldap_base[$count]\n";
2940 if ( $ldap_charset[$count] ) {
2941 print " charset: $ldap_charset[$count]\n";
2943 if ( $ldap_port[$count] ) {
2944 print " port: $ldap_port[$count]\n";
2946 if ( $ldap_name[$count] ) {
2947 print " name: $ldap_name[$count]\n";
2949 if ( $ldap_maxrows[$count] ) {
2950 print " maxrows: $ldap_maxrows[$count]\n";
2952 if ( $ldap_filter[$count] ) {
2953 print " filter: $ldap_filter[$count]\n";
2955 if ( $ldap_binddn[$count] ) {
2956 print " binddn: $ldap_binddn[$count]\n";
2957 if ( $ldap_bindpw[$count] ) {
2958 print " bindpw: $ldap_bindpw[$count]\n";
2961 if ( $ldap_protocol[$count] ) {
2962 print " protocol: $ldap_protocol[$count]\n";
2964 if ( $ldap_limit_scope[$count] ) {
2965 print " limit_scope: $ldap_limit_scope[$count]\n";
2967 if ( $ldap_listing[$count] ) {
2968 print " listing: $ldap_listing[$count]\n";
2970 if ( $ldap_writeable[$count] ) {
2971 print " writeable: $ldap_writeable[$count]\n";
2973 if ( $ldap_search_tree[$count] ) {
2974 print " search_tree: $ldap_search_tree[$count]\n";
2976 if ( $ldap_starttls[$count] ) {
2977 print " starttls: $ldap_starttls[$count]\n";
2983 } elsif ( $input =~ /^\s*\+/ ) {
2984 $sub = $#ldap_host + 1;
2986 print "First, we need to have the hostname or the IP address where\n";
2987 print "this LDAP server resides. Example: ldap.bigfoot.com\n";
2990 $name =~ s/[\r\n]//g;
2991 $ldap_host[$sub] = $name;
2995 print "Next, we need the server root (base dn). For this, an empty\n";
2996 print "string is allowed.\n";
2997 print "Example: ou=member_directory,o=netcenter.com\n";
3000 $name =~ s/[\r\n]//g;
3001 $ldap_base[$sub] = $name;
3005 print "This is the TCP/IP port number for the LDAP server. Default\n";
3006 print "port is 389. This is optional. Press ENTER for default.\n";
3009 $name =~ s/[\r\n]//g;
3010 $ldap_port[$sub] = $name;
3014 print "This is the charset for the server. Default is utf-8. This\n";
3015 print "is also optional. Press ENTER for default.\n";
3018 $name =~ s/[\r\n]//g;
3019 $ldap_charset[$sub] = $name;
3023 print "This is the name for the server, used to tag the results of\n";
3024 print "the search. Default it \"LDAP: hostname\". Press ENTER for default\n";
3027 $name =~ s/[\r\n]//g;
3028 $ldap_name[$sub] = $name;
3032 print "You can specify the maximum number of rows in the search result.\n";
3033 print "Default value is equal to 250 rows. Press ENTER for default.\n";
3036 $name =~ s/[\r\n]//g;
3037 $ldap_maxrows[$sub] = $name;
3042 print "If your LDAP server does not like anonymous logins, you can specify bind DN.\n";
3043 print "Default is none, anonymous bind. Press ENTER for default.\n";
3046 $name =~ s/[\r\n]//g;
3047 $ldap_binddn[$sub] = $name;
3051 if ( $ldap_binddn[$sub] ne '' ) {
3053 print "Now, please specify password for that DN.\n";
3056 $name =~ s/[\r\n]//g;
3057 $ldap_bindpw[$sub] = $name;
3062 print "You can specify bind protocol version here.\n";
3063 print "Default protocol version depends on your php ldap settings.\n";
3064 print "Press ENTER for default.\n";
3067 $name =~ s/[\r\n]//g;
3068 $ldap_protocol[$sub] = $name;
3072 print "This configuration section allows to set some rarely used\n";
3073 print "options and options specific to some LDAP implementations.\n";
3075 print "Do you want to set advanced LDAP directory settings? (y/N):";
3076 $ldap_advanced_settings = <STDIN
>;
3077 if ( $ldap_advanced_settings =~ /^y\n/i ) {
3078 $ldap_advanced_settings = 'true';
3080 $ldap_advanced_settings = 'false';
3083 if ($ldap_advanced_settings eq 'true') {
3086 print "You can control LDAP directory listing here. This option can\n";
3087 print "be useful if you run small LDAP server and want to provide listing\n";
3088 print "of all addresses stored in LDAP to users of webmail interface.\n";
3089 print "Number of displayed entries is limited by maxrows setting.\n";
3091 print "Don't enable this option for public LDAP directories.\n";
3093 print "Allow listing of LDAP directory? (y/N):";
3095 if ( $name =~ /^y\n/i ) {
3100 $ldap_listing[$sub] = $name;
3104 print "You can control write access to LDAP address book here. This option can\n";
3105 print "be useful if you run small LDAP server and want to provide writable\n";
3106 print "shared address book stored in LDAP to users of webmail interface.\n";
3108 print "Don't enable this option for public LDAP directories.\n";
3110 print "Allow writing to LDAP directory? (y/N):";