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]+\]\[['"]ID['"]\]/ ) {
193 $sub =~ s/\]\[['"]ID['"]\]//;
195 if ( -e
"../templates" ) {
196 $options[1] =~ s/^\.\.\/config/\
.\
.\
/templates/;
198 $templateset_id[$sub] = $options[1];
199 ##### FIXME: This section BELOW here so old prefs files don't blow up when running conf.pl
200 ##### Remove after a month or two
201 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]PATH['"]\]/ ) {
203 $sub =~ s/\]\[['"]PATH['"]\]//;
205 if ( -e
"../templates" ) {
206 $options[1] =~ s/^\.\.\/config/\
.\
.\
/templates/;
208 $templateset_id[$sub] = $options[1];
209 ##### FIXME: This section ABOVE here so old prefs files don't blow up when running conf.pl
210 ##### Remove after a month or two
211 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]NAME['"]\]/ ) {
213 $sub =~ s/\]\[['"]NAME['"]\]//;
215 $templateset_name[$sub] = $options[1];
216 } elsif ( $options[0] =~ /^plugins\[[0-9]*\]/ ) {
219 $sub =~ s/^plugins\[//;
221 push @plugins, $options[1];
223 $plugins[$sub] = $options[1];
225 } elsif ($options[0] =~ /^fontsets\[\'[a-z]*\'\]/) {
226 # parse associative $fontsets array
229 $sub =~ s/^fontsets\[\'//;
230 $fontsets{$sub} = $options[1];
231 } elsif ( $options[0] =~ /^ldap_server\[[0-9]+\]/ ) {
234 $sub =~ s/^ldap_server\[//;
236 while ( ( $tmp = <FILE
> ) && ( $continue != 1 ) ) {
237 if ( $tmp =~ /\);\s*$/ ) {
241 if ( $tmp =~ /^\s*[\'\"]host[\'\"]/i ) {
242 $tmp =~ s/^\s*[\'\"]host[\'\"]\s*=>\s*[\'\"]//i;
243 $tmp =~ s/[\'\"],?\s*$//;
244 $tmp =~ s/[\'\"]\);\s*$//;
246 } elsif ( $tmp =~ /^\s*[\'\"]base[\'\"]/i ) {
247 $tmp =~ s/^\s*[\'\"]base[\'\"]\s*=>\s*[\'\"]//i;
248 $tmp =~ s/[\'\"],?\s*$//;
249 $tmp =~ s/[\'\"]\);\s*$//;
251 } elsif ( $tmp =~ /^\s*[\'\"]charset[\'\"]/i ) {
252 $tmp =~ s/^\s*[\'\"]charset[\'\"]\s*=>\s*[\'\"]//i;
253 $tmp =~ s/[\'\"],?\s*$//;
254 $tmp =~ s/[\'\"]\);\s*$//;
256 } elsif ( $tmp =~ /^\s*[\'\"]port[\'\"]/i ) {
257 $tmp =~ s/^\s*[\'\"]port[\'\"]\s*=>\s*[\'\"]?//i;
258 $tmp =~ s/[\'\"]?,?\s*$//;
259 $tmp =~ s/[\'\"]?\);\s*$//;
261 } elsif ( $tmp =~ /^\s*[\'\"]maxrows[\'\"]/i ) {
262 $tmp =~ s/^\s*[\'\"]maxrows[\'\"]\s*=>\s*[\'\"]?//i;
263 $tmp =~ s/[\'\"]?,?\s*$//;
264 $tmp =~ s/[\'\"]?\);\s*$//;
266 } elsif ( $tmp =~ /^\s*[\'\"]filter[\'\"]/i ) {
267 $tmp =~ s/^\s*[\'\"]filter[\'\"]\s*=>\s*[\'\"]?//i;
268 $tmp =~ s/[\'\"]?,?\s*$//;
269 $tmp =~ s/[\'\"]?\);\s*$//;
271 } elsif ( $tmp =~ /^\s*[\'\"]name[\'\"]/i ) {
272 $tmp =~ s/^\s*[\'\"]name[\'\"]\s*=>\s*[\'\"]//i;
273 $tmp =~ s/[\'\"],?\s*$//;
274 $tmp =~ s/[\'\"]\);\s*$//;
276 } elsif ( $tmp =~ /^\s*[\'\"]binddn[\'\"]/i ) {
277 $tmp =~ s/^\s*[\'\"]binddn[\'\"]\s*=>\s*[\'\"]//i;
278 $tmp =~ s/[\'\"],?\s*$//;
279 $tmp =~ s/[\'\"]\);\s*$//;
281 } elsif ( $tmp =~ /^\s*[\'\"]bindpw[\'\"]/i ) {
282 $tmp =~ s/^\s*[\'\"]bindpw[\'\"]\s*=>\s*[\'\"]//i;
283 $tmp =~ s/[\'\"],?\s*$//;
284 $tmp =~ s/[\'\"]\);\s*$//;
286 } elsif ( $tmp =~ /^\s*[\'\"]protocol[\'\"]/i ) {
287 $tmp =~ s/^\s*[\'\"]protocol[\'\"]\s*=>\s*[\'\"]?//i;
288 $tmp =~ s/[\'\"]?,?\s*$//;
289 $tmp =~ s/[\'\"]?\);\s*$//;
291 } elsif ( $tmp =~ /^\s*[\'\"]limit_scope[\'\"]/i ) {
292 $tmp =~ s/^\s*[\'\"]limit_scope[\'\"]\s*=>\s*[\'\"]?//i;
293 $tmp =~ s/[\'\"]?,?\s*$//;
294 $tmp =~ s/[\'\"]?\);\s*$//;
296 } elsif ( $tmp =~ /^\s*[\'\"]listing[\'\"]/i ) {
297 $tmp =~ s/^\s*[\'\"]listing[\'\"]\s*=>\s*[\'\"]?//i;
298 $tmp =~ s/[\'\"]?,?\s*$//;
299 $tmp =~ s/[\'\"]?\);\s*$//;
301 } elsif ( $tmp =~ /^\s*[\'\"]writeable[\'\"]/i ) {
302 $tmp =~ s/^\s*[\'\"]writeable[\'\"]\s*=>\s*[\'\"]?//i;
303 $tmp =~ s/[\'\"]?,?\s*$//;
304 $tmp =~ s/[\'\"]?\);\s*$//;
306 } elsif ( $tmp =~ /^\s*[\'\"]search_tree[\'\"]/i ) {
307 $tmp =~ s/^\s*[\'\"]search_tree[\'\"]\s*=>\s*[\'\"]?//i;
308 $tmp =~ s/[\'\"]?,?\s*$//;
309 $tmp =~ s/[\'\"]?\);\s*$//;
311 } elsif ( $tmp =~ /^\s*[\'\"]starttls[\'\"]/i ) {
312 $tmp =~ s/^\s*[\'\"]starttls[\'\"]\s*=>\s*[\'\"]?//i;
313 $tmp =~ s/[\'\"]?,?\s*$//;
314 $tmp =~ s/[\'\"]?\);\s*$//;
318 $ldap_host[$sub] = $host;
319 $ldap_base[$sub] = $base;
320 $ldap_name[$sub] = $name;
321 $ldap_port[$sub] = $port;
322 $ldap_maxrows[$sub] = $maxrows;
323 $ldap_filter[$sub] = $filter;
324 $ldap_charset[$sub] = $charset;
325 $ldap_binddn[$sub] = $binddn;
326 $ldap_bindpw[$sub] = $bindpw;
327 $ldap_protocol[$sub] = $protocol;
328 $ldap_limit_scope[$sub] = $limit_scope;
329 $ldap_listing[$sub] = $listing;
330 $ldap_writeable[$sub] = $writeable;
331 $ldap_search_tree[$sub] = $search_tree;
332 $ldap_starttls[$sub] = $starttls;
333 } elsif ( $options[0] =~ /^(data_dir|attachment_dir|theme_css|org_logo|signout_page|icon_theme_def)$/ ) {
334 ${ $options[0] } = &change_to_rel_path
($options[1]);
336 ${ $options[0] } = $options[1];
342 # FIXME: unknown introduction date
343 $useSendmail = 'false' if ( lc($useSendmail) ne 'true' );
344 $sendmail_path = "/usr/sbin/sendmail" if ( !$sendmail_path );
345 $pop_before_smtp = 'false' if ( !$pop_before_smtp );
346 $default_unseen_notify = 2 if ( !$default_unseen_notify );
347 $default_unseen_type = 1 if ( !$default_unseen_type );
348 $config_use_color = 0 if ( !$config_use_color );
349 $invert_time = 'false' if ( !$invert_time );
350 $force_username_lowercase = 'false' if ( !$force_username_lowercase );
351 $optional_delimiter = "detect" if ( !$optional_delimiter );
352 $auto_create_special = 'false' if ( !$auto_create_special );
353 $default_use_priority = 'true' if ( !$default_use_priority );
354 $default_use_mdn = 'true' if ( !$default_use_mdn );
355 $delete_folder = 'false' if ( !$delete_folder );
356 $noselect_fix_enable = 'false' if ( !$noselect_fix_enable );
357 $frame_top = "_top" if ( !$frame_top );
358 $provider_uri = '' if ( !$provider_uri );
359 $provider_name = '' if ( !$provider_name );
360 $no_list_for_subscribe = 'false' if ( !$no_list_for_subscribe );
361 $allow_charset_search = 'true' if ( !$allow_charset_search );
362 $allow_advanced_search = 0 if ( !$allow_advanced_search) ;
363 $prefs_user_field = 'user' if ( !$prefs_user_field );
364 $prefs_key_field = 'prefkey' if ( !$prefs_key_field );
365 $prefs_val_field = 'prefval' if ( !$prefs_val_field );
366 $session_name = 'SQMSESSID' if ( !$session_name );
367 $skip_SM_header = 'false' if ( !$skip_SM_header );
368 $default_use_javascript_addr_book = 'false' if (! $default_use_javascript_addr_book);
371 $hide_sm_attributions = 'false' if ( !$hide_sm_attributions );
373 $edit_identity = 'true' if ( !$edit_identity );
374 $edit_name = 'true' if ( !$edit_name );
377 $use_smtp_tls= 'false' if ( !$use_smtp_tls);
378 $smtp_auth_mech = 'none' if ( !$smtp_auth_mech );
379 $use_imap_tls = 'false' if ( !$use_imap_tls );
380 $imap_auth_mech = 'login' if ( !$imap_auth_mech );
383 $show_alternative_names = 'false' if ( !$show_alternative_names );
384 # $available_languages option available only in 1.5.0. removed due to $languages
385 # implementation changes. options are provided by limit_languages plugin
386 # $available_languages = 'all' if ( !$available_languages );
387 $aggressive_decoding = 'false' if ( !$aggressive_decoding );
388 # available only in 1.5.0 and 1.5.1
389 # $advanced_tree = 'false' if ( !$advanced_tree );
390 $use_php_recode = 'false' if ( !$use_php_recode );
391 $use_php_iconv = 'false' if ( !$use_php_iconv );
394 $use_icons = 'false' if ( !$use_icons );
395 $use_iframe = 'false' if ( !$use_iframe );
396 $lossy_encoding = 'false' if ( !$lossy_encoding );
397 $allow_remote_configtest = 'false' if ( !$allow_remote_configtest );
398 $addrbook_global_table = 'global_abook' if ( !$addrbook_global_table );
399 $addrbook_global_writeable = 'false' if ( !$addrbook_global_writeable );
400 $addrbook_global_listing = 'false' if ( !$addrbook_global_listing );
401 $abook_global_file = '' if ( !$abook_global_file);
402 $abook_global_file_writeable = 'false' if ( !$abook_global_file_writeable);
403 $abook_global_file_listing = 'true' if ( !$abook_global_file_listing );
404 $encode_header_key = '' if ( !$encode_header_key );
405 $hide_auth_header = 'false' if ( !$hide_auth_header );
406 $time_zone_type = '0' if ( !$time_zone_type );
407 $prefs_user_size = 128 if ( !$prefs_user_size );
408 $prefs_key_size = 64 if ( !$prefs_key_size );
409 $prefs_val_size = 65536 if ( !$prefs_val_size );
412 $icon_theme_def = '' if ( !$icon_theme_def );
414 # add qmail-inject test here for backwards compatibility
415 if ( !$sendmail_args && $sendmail_path =~ /qmail-inject/ ) {
417 } elsif ( !$sendmail_args ) {
418 $sendmail_args = '-i -t';
421 $default_fontsize = '' if ( !$default_fontsize);
422 $default_fontset = '' if ( !$default_fontset);
424 %fontsets = ('serif', 'serif',
425 'sans', 'helvetica,arial,sans-serif',
426 'comicsans', 'comic sans ms,sans-serif',
427 'tahoma', 'tahoma,sans-serif',
428 'verasans', 'bitstream vera sans,verdana,sans-serif');
431 # $use_imap_tls and $use_smtp_tls are switched to integer since 1.5.1
432 $use_imap_tls = 0 if ( $use_imap_tls eq 'false');
433 $use_imap_tls = 1 if ( $use_imap_tls eq 'true');
434 $use_smtp_tls = 0 if ( $use_smtp_tls eq 'false');
435 $use_smtp_tls = 1 if ( $use_smtp_tls eq 'true');
436 # sorting options changed names and reversed values in 1.5.1
437 $disable_thread_sort = 'false' if ( !$disable_thread_sort );
438 $disable_server_sort = 'false' if ( !$disable_server_sort );
441 $abook_file_line_length = 2048 if ( !$abook_file_line_length );
442 $config_location_base = '' if ( !$config_location_base );
443 $smtp_sitewide_user = '' if ( !$smtp_sitewide_user );
444 $smtp_sitewide_pass = '' if ( !$smtp_sitewide_pass );
446 if ( $ARGV[0] eq '--install-plugin' ) {
447 print "Activating plugin " . $ARGV[1] . "\n";
448 push @plugins, $ARGV[1];
451 } elsif ( $ARGV[0] eq '--remove-plugin' ) {
452 print "Removing plugin " . $ARGV[1] . "\n";
453 foreach $plugin (@plugins) {
454 if ( $plugin ne $ARGV[1] ) {
455 push @newplugins, $plugin;
458 @plugins = @newplugins;
463 #####################################################################################
464 if ( $config_use_color == 1 ) {
470 $config_use_color = 2;
473 while ( ( $command ne "q" ) && ( $command ne "Q" ) && ( $command ne ":q" ) ) {
475 print $WHT. "SquirrelMail Configuration : " . $NRM;
476 if ( $config == 1 ) { print "Read: config.php"; }
477 elsif ( $config == 2 ) { print "Read: config_default.php"; }
478 print " ($print_config_version)\n";
479 print "---------------------------------------------------------\n";
482 print $WHT. "Main Menu --\n" . $NRM;
483 print "1. Organization Preferences\n";
484 print "2. Server Settings\n";
485 print "3. Folder Defaults\n";
486 print "4. General Options\n";
487 print "5. Templates\n";
488 print "6. Address Books\n";
489 print "7. Message of the Day (MOTD)\n";
490 print "8. Plugins\n";
491 print "9. Database\n";
492 print "10. Language settings\n";
493 print "11. Tweaks\n";
495 print "D. Set pre-defined settings for specific IMAP servers\n";
497 } elsif ( $menu == 1 ) {
498 print $WHT. "Organization Preferences\n" . $NRM;
499 print "1. Organization Name : $WHT$org_name$NRM\n";
500 print "2. Organization Logo : $WHT$org_logo$NRM\n";
501 print "3. Org. Logo Width/Height : $WHT($org_logo_width/$org_logo_height)$NRM\n";
502 print "4. Organization Title : $WHT$org_title$NRM\n";
503 print "5. Signout Page : $WHT$signout_page$NRM\n";
504 print "6. Top Frame : $WHT$frame_top$NRM\n";
505 print "7. Provider link : $WHT$provider_uri$NRM\n";
506 print "8. Provider name : $WHT$provider_name$NRM\n";
509 print "R Return to Main Menu\n";
510 } elsif ( $menu == 2 ) {
511 print $WHT. "Server Settings\n\n" . $NRM;
512 print $WHT . "General" . $NRM . "\n";
514 print "1. Domain : $WHT$domain$NRM\n";
515 print "2. Invert Time : $WHT$invert_time$NRM\n";
516 print "3. Sendmail or SMTP : $WHT";
517 if ( lc($useSendmail) eq 'true' ) {
525 if ( $show_imap_settings ) {
526 print $WHT . "IMAP Settings". $NRM . "\n--------------\n";
527 print "4. IMAP Server : $WHT$imapServerAddress$NRM\n";
528 print "5. IMAP Port : $WHT$imapPort$NRM\n";
529 print "6. Authentication type : $WHT$imap_auth_mech$NRM\n";
530 print "7. Secure IMAP (TLS) : $WHT" . display_use_tls
($use_imap_tls) . "$NRM\n";
531 print "8. Server software : $WHT$imap_server_type$NRM\n";
532 print "9. Delimiter : $WHT$optional_delimiter$NRM\n";
534 } elsif ( $show_smtp_settings ) {
535 if ( lc($useSendmail) eq 'true' ) {
536 print $WHT . "Sendmail" . $NRM . "\n--------\n";
537 print "4. Sendmail Path : $WHT$sendmail_path$NRM\n";
538 print "5. Sendmail arguments : $WHT$sendmail_args$NRM\n";
539 print "6. Header encryption key : $WHT$encode_header_key$NRM\n";
542 print $WHT . "SMTP Settings" . $NRM . "\n-------------\n";
543 print "4. SMTP Server : $WHT$smtpServerAddress$NRM\n";
544 print "5. SMTP Port : $WHT$smtpPort$NRM\n";
545 print "6. POP before SMTP : $WHT$pop_before_smtp$NRM\n";
546 print "7. SMTP Authentication : $WHT$smtp_auth_mech" . display_smtp_sitewide_userpass
() ."$NRM\n";
547 print "8. Secure SMTP (TLS) : $WHT" . display_use_tls
($use_smtp_tls) . "$NRM\n";
548 print "9. Header encryption key : $WHT$encode_header_key$NRM\n";
553 if ($show_imap_settings == 0) {
554 print "A. Update IMAP Settings : ";
555 print "$WHT$imapServerAddress$NRM:";
556 print "$WHT$imapPort$NRM ";
557 print "($WHT$imap_server_type$NRM)\n";
559 if ($show_smtp_settings == 0) {
560 if ( lc($useSendmail) eq 'true' ) {
561 print "B. Change Sendmail Config : $WHT$sendmail_path$NRM\n";
563 print "B. Update SMTP Settings : ";
564 print "$WHT$smtpServerAddress$NRM:";
565 print "$WHT$smtpPort$NRM\n";
568 if ( $show_smtp_settings || $show_imap_settings )
571 ($show_imap_settings ?
"IMAP Server" :
572 (lc($useSendmail) eq 'true') ?
"Sendmail" : "SMTP") . " Settings\n";
576 print "R Return to Main Menu\n";
577 } elsif ( $menu == 3 ) {
578 print $WHT. "Folder Defaults\n" . $NRM;
579 print "1. Default Folder Prefix : $WHT$default_folder_prefix$NRM\n";
580 print "2. Show Folder Prefix Option : $WHT$show_prefix_option$NRM\n";
581 print "3. Trash Folder : $WHT$trash_folder$NRM\n";
582 print "4. Sent Folder : $WHT$sent_folder$NRM\n";
583 print "5. Drafts Folder : $WHT$draft_folder$NRM\n";
584 print "6. By default, move to trash : $WHT$default_move_to_trash$NRM\n";
585 print "7. By default, move to sent : $WHT$default_move_to_sent$NRM\n";
586 print "8. By default, save as draft : $WHT$default_save_as_draft$NRM\n";
587 print "9. List Special Folders First : $WHT$list_special_folders_first$NRM\n";
588 print "10. Show Special Folders Color : $WHT$use_special_folder_color$NRM\n";
589 print "11. Auto Expunge : $WHT$auto_expunge$NRM\n";
590 print "12. Default Sub. of INBOX : $WHT$default_sub_of_inbox$NRM\n";
591 print "13. Show 'Contain Sub.' Option : $WHT$show_contain_subfolders_option$NRM\n";
592 print "14. Default Unseen Notify : $WHT$default_unseen_notify$NRM\n";
593 print "15. Default Unseen Type : $WHT$default_unseen_type$NRM\n";
594 print "16. Auto Create Special Folders : $WHT$auto_create_special$NRM\n";
595 print "17. Folder Delete Bypasses Trash : $WHT$delete_folder$NRM\n";
596 print "18. Enable /NoSelect folder fix : $WHT$noselect_fix_enable$NRM\n";
598 print "R Return to Main Menu\n";
599 } elsif ( $menu == 4 ) {
600 print $WHT. "General Options\n" . $NRM;
601 print "1. Data Directory : $WHT$data_dir$NRM\n";
602 print "2. Attachment Directory : $WHT$attachment_dir$NRM\n";
603 print "3. Directory Hash Level : $WHT$dir_hash_level$NRM\n";
604 print "4. Default Left Size : $WHT$default_left_size$NRM\n";
605 print "5. Usernames in Lowercase : $WHT$force_username_lowercase$NRM\n";
606 print "6. Allow use of priority : $WHT$default_use_priority$NRM\n";
607 print "7. Hide SM attributions : $WHT$hide_sm_attributions$NRM\n";
608 print "8. Allow use of receipts : $WHT$default_use_mdn$NRM\n";
609 print "9. Allow editing of identity : $WHT$edit_identity$NRM\n";
610 print " Allow editing of name : $WHT$edit_name$NRM\n";
611 print " Remove username from header : $WHT$hide_auth_header$NRM\n";
612 print "10. Disable server thread sort : $WHT$disable_thread_sort$NRM\n";
613 print "11. Disable server-side sorting : $WHT$disable_server_sort$NRM\n";
614 print "12. Allow server charset search : $WHT$allow_charset_search$NRM\n";
615 print "13. Allow advanced search : $WHT$allow_advanced_search$NRM\n";
616 print "14. PHP session name : $WHT$session_name$NRM\n";
617 print "15. Time zone configuration : $WHT$time_zone_type$NRM\n";
618 print "16. Location base : $WHT$config_location_base$NRM\n";
620 print "R Return to Main Menu\n";
621 } elsif ( $menu == 5 ) {
622 print $WHT. "Themes\n" . $NRM;
623 print "1. Change Template set\n";
624 # for ( $count = 0 ; $count <= $#theme_name/2 ; $count++ ) {
625 # $temp_name = $theme_name[$count*2];
626 # printf " %s%*s %s\n", $temp_name,
627 # 40 - length($temp_name), " ",
628 # $theme_name[($count*2)+1];
630 print "2. CSS File : $WHT$theme_css$NRM\n";
631 print "3. Default font size: $WHT$default_fontsize$NRM\n";
632 print "4. Change available font sets\n";
633 print "5. Change Themes\n";
636 print "R Return to Main Menu\n";
637 } elsif ( $menu == 6 ) {
638 print $WHT. "Address Books\n" . $NRM;
639 print "1. Change LDAP Servers\n";
640 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
641 print " > $ldap_host[$count]\n";
643 print "2. Use Javascript address book search : $WHT$default_use_javascript_addr_book$NRM\n";
644 print "3. Global address book file : $WHT$abook_global_file$NRM\n";
645 print "4. Allow writing into global file address book : $WHT$abook_global_file_writeable$NRM\n";
646 print "5. Allow listing of global file address book : $WHT$abook_global_file_listing$NRM\n";
647 print "6. Allowed address book line length : $WHT$abook_file_line_length$NRM\n";
649 print "R Return to Main Menu\n";
650 } elsif ( $menu == 7 ) {
651 print $WHT. "Message of the Day (MOTD)\n" . $NRM;
654 print "1 Edit the MOTD\n";
656 print "R Return to Main Menu\n";
657 } elsif ( $menu == 8 ) {
658 print $WHT. "Plugins\n" . $NRM;
659 print " Installed Plugins\n";
661 for ( $count = 0 ; $count <= $#plugins ; $count++ ) {
663 print " $num. $plugins[$count]\n";
665 print "\n Available Plugins:\n";
666 opendir( DIR
, "../plugins" );
667 @files = readdir(DIR
);
669 @unused_plugins = ();
670 for ( $i = 0 ; $i <= $#files ; $i++ ) {
671 if ( -d
"../plugins/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne "CVS" ) {
673 for ( $k = 0 ; $k <= $#plugins ; $k++ ) {
674 if ( $plugins[$k] eq $files[$i] ) {
679 $unused_plugins[$pos] = $files[$i];
685 for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
687 print " $num. $unused_plugins[$i]\n";
692 print "R Return to Main Menu\n";
693 } elsif ( $menu == 9 ) {
694 print $WHT. "Database\n" . $NRM;
695 print "1. DSN for Address Book : $WHT$addrbook_dsn$NRM\n";
696 print "2. Table for Address Book : $WHT$addrbook_table$NRM\n";
698 print "3. DSN for Preferences : $WHT$prefs_dsn$NRM\n";
699 print "4. Table for Preferences : $WHT$prefs_table$NRM\n";
700 print "5. Field for username : $WHT$prefs_user_field$NRM ($prefs_user_size)\n";
701 print "6. Field for prefs key : $WHT$prefs_key_field$NRM ($prefs_key_size)\n";
702 print "7. Field for prefs value : $WHT$prefs_val_field$NRM ($prefs_val_size)\n";
704 print "8. DSN for Global Address Book : $WHT$addrbook_global_dsn$NRM\n";
705 print "9. Table for Global Address Book : $WHT$addrbook_global_table$NRM\n";
706 print "10. Allow writing into Global Address Book : $WHT$addrbook_global_writeable$NRM\n";
707 print "11. Allow listing of Global Address Book : $WHT$addrbook_global_listing$NRM\n";
709 print "R Return to Main Menu\n";
710 } elsif ( $menu == 10 ) {
711 print $WHT. "Language settings\n" . $NRM;
712 print "1. Default Language : $WHT$squirrelmail_default_language$NRM\n";
713 print "2. Default Charset : $WHT$default_charset$NRM\n";
714 print "3. Show alternative language names : $WHT$show_alternative_names$NRM\n";
715 print "4. Enable aggressive decoding : $WHT$aggressive_decoding$NRM\n";
716 print "5. Enable lossy encoding : $WHT$lossy_encoding$NRM\n";
718 print "R Return to Main Menu\n";
719 } elsif ( $menu == 11 ) {
720 print $WHT. "Interface tweaks\n" . $NRM;
721 print "1. Display html mails in iframe : $WHT$use_iframe$NRM\n";
722 print "2. Use Icons : $WHT$use_icons$NRM\n";
723 print "3. Default Icon Set : $WHT$icon_theme_def$NRM\n";
725 print $WHT. "PHP tweaks\n" . $NRM;
726 print "4. Use php recode functions : $WHT$use_php_recode$NRM\n";
727 print "5. Use php iconv functions : $WHT$use_php_iconv$NRM\n";
729 print $WHT. "Configuration tweaks\n" . $NRM;
730 print "6. Allow remote configtest : $WHT$allow_remote_configtest$NRM\n";
732 print "R Return to Main Menu\n";
734 if ( $config_use_color == 1 ) {
735 print "C Turn color off\n";
737 print "C Turn color on\n";
739 print "S Save data\n";
743 print "Command >> " . $WHT;
745 $command =~ s/[\n\r]//g;
746 $command =~ tr/A-Z/a-z/;
749 # Read the commands they entered.
750 if ( $command eq "r" ) {
752 } elsif ( $command eq "s" ) {
754 print "Press enter to continue...";
757 } elsif ( ( $command eq "q" ) && ( $saved == 0 ) ) {
758 print "You have not saved your data.\n";
759 print "Save? [" . $WHT . "Y" . $NRM . "/n]: ";
761 if ( ( $save =~ /^y/i ) || ( $save =~ /^\s*$/ ) ) {
764 } elsif ( $command eq "c" ) {
765 if ( $config_use_color == 1 ) {
766 $config_use_color = 2;
770 $config_use_color = 1;
774 } elsif ( $command eq "d" && $menu == 0 ) {
779 if ( ( $command > 0 ) && ( $command < 12 ) ) {
782 } elsif ( $menu == 1 ) {
783 if ( $command == 1 ) { $org_name = command1
(); }
784 elsif ( $command == 2 ) { $org_logo = command2
(); }
785 elsif ( $command == 3 ) { ($org_logo_width,$org_logo_height) = command2a
(); }
786 elsif ( $command == 4 ) { $org_title = command3
(); }
787 elsif ( $command == 5 ) { $signout_page = command4
(); }
788 elsif ( $command == 6 ) { $frame_top = command6
(); }
789 elsif ( $command == 7 ) { $provider_uri = command7
(); }
790 elsif ( $command == 8 ) { $provider_name = command8
(); }
792 } elsif ( $menu == 2 ) {
793 if ( $command eq "a" ) { $show_imap_settings = 1; $show_smtp_settings = 0; }
794 elsif ( $command eq "b" ) { $show_imap_settings = 0; $show_smtp_settings = 1; }
795 elsif ( $command eq "h" ) { $show_imap_settings = 0; $show_smtp_settings = 0; }
796 elsif ( $command <= 3 ) {
797 if ( $command == 1 ) { $domain = command11
(); }
798 elsif ( $command == 2 ) { $invert_time = command110
(); }
799 elsif ( $command == 3 ) { $useSendmail = command14
(); }
800 $show_imap_settings = 0; $show_smtp_settings = 0;
801 } elsif ( $show_imap_settings ) {
802 if ( $command == 4 ) { $imapServerAddress = command12
(); }
803 elsif ( $command == 5 ) { $imapPort = command13
(); }
804 elsif ( $command == 6 ) { $imap_auth_mech = command112a
(); }
805 elsif ( $command == 7 ) { $use_imap_tls = command_use_tls
("IMAP",$use_imap_tls); }
806 elsif ( $command == 8 ) { $imap_server_type = command19
(); }
807 elsif ( $command == 9 ) { $optional_delimiter = command111
(); }
808 } elsif ( $show_smtp_settings && lc($useSendmail) eq 'true' ) {
809 if ( $command == 4 ) { $sendmail_path = command15
(); }
810 elsif ( $command == 5 ) { $sendmail_args = command_sendmail_args
(); }
811 elsif ( $command == 6 ) { $encode_header_key = command114
(); }
812 } elsif ( $show_smtp_settings ) {
813 if ( $command == 4 ) { $smtpServerAddress = command16
(); }
814 elsif ( $command == 5 ) { $smtpPort = command17
(); }
815 elsif ( $command == 6 ) { $pop_before_smtp = command18a
(); }
816 elsif ( $command == 7 ) { $smtp_auth_mech = command112b
(); }
817 elsif ( $command == 8 ) { $use_smtp_tls = command_use_tls
("SMTP",$use_smtp_tls); }
818 elsif ( $command == 9 ) { $encode_header_key = command114
(); }
820 } elsif ( $menu == 3 ) {
821 if ( $command == 1 ) { $default_folder_prefix = command21
(); }
822 elsif ( $command == 2 ) { $show_prefix_option = command22
(); }
823 elsif ( $command == 3 ) { $trash_folder = command23a
(); }
824 elsif ( $command == 4 ) { $sent_folder = command23b
(); }
825 elsif ( $command == 5 ) { $draft_folder = command23c
(); }
826 elsif ( $command == 6 ) { $default_move_to_trash = command24a
(); }
827 elsif ( $command == 7 ) { $default_move_to_sent = command24b
(); }
828 elsif ( $command == 8 ) { $default_save_as_draft = command24c
(); }
829 elsif ( $command == 9 ) { $list_special_folders_first = command27
(); }
830 elsif ( $command == 10 ) { $use_special_folder_color = command28
(); }
831 elsif ( $command == 11 ) { $auto_expunge = command29
(); }
832 elsif ( $command == 12 ) { $default_sub_of_inbox = command210
(); }
833 elsif ( $command == 13 ) { $show_contain_subfolders_option = command211
(); }
834 elsif ( $command == 14 ) { $default_unseen_notify = command212
(); }
835 elsif ( $command == 15 ) { $default_unseen_type = command213
(); }
836 elsif ( $command == 16 ) { $auto_create_special = command214
(); }
837 elsif ( $command == 17 ) { $delete_folder = command215
(); }
838 elsif ( $command == 18 ) { $noselect_fix_enable = command216
(); }
839 } elsif ( $menu == 4 ) {
840 if ( $command == 1 ) { $data_dir = command33a
(); }
841 elsif ( $command == 2 ) { $attachment_dir = command33b
(); }
842 elsif ( $command == 3 ) { $dir_hash_level = command33c
(); }
843 elsif ( $command == 4 ) { $default_left_size = command35
(); }
844 elsif ( $command == 5 ) { $force_username_lowercase = command36
(); }
845 elsif ( $command == 6 ) { $default_use_priority = command37
(); }
846 elsif ( $command == 7 ) { $hide_sm_attributions = command38
(); }
847 elsif ( $command == 8 ) { $default_use_mdn = command39
(); }
848 elsif ( $command == 9 ) { $edit_identity = command310
(); }
849 elsif ( $command == 10 ) { $disable_thread_sort = command312
(); }
850 elsif ( $command == 11 ) { $disable_server_sort = command313
(); }
851 elsif ( $command == 12 ) { $allow_charset_search = command314
(); }
852 elsif ( $command == 13 ) { $allow_advanced_search = command316
(); }
853 elsif ( $command == 14 ) { $session_name = command317
(); }
854 elsif ( $command == 15 ) { $time_zone_type = command318
(); }
855 elsif ( $command == 16 ) { $config_location_base = command_config_location_base
(); }
856 } elsif ( $menu == 5 ) {
857 if ( $command == 1 ) { $templateset_default = command_templates
(); }
858 elsif ( $command == 2 ) { $theme_css = command42
(); }
859 elsif ( $command == 3 ) { $default_fontsize = command_default_fontsize
(); }
860 elsif ( $command == 4 ) { command_fontsets
(); }
861 elsif ( $command == 5 ) { command41
(); }
862 } elsif ( $menu == 6 ) {
863 if ( $command == 1 ) { command61
(); }
864 elsif ( $command == 2 ) { command62
(); }
865 elsif ( $command == 3 ) { $abook_global_file=command63
(); }
866 elsif ( $command == 4 ) { command64
(); }
867 elsif ( $command == 5 ) { command65
(); }
868 elsif ( $command == 6 ) { command_abook_file_line_length
(); }
869 } elsif ( $menu == 7 ) {
870 if ( $command == 1 ) { $motd = command71
(); }
871 } elsif ( $menu == 8 ) {
872 if ( $command =~ /^[0-9]+/ ) { @plugins = command81
(); }
873 } elsif ( $menu == 9 ) {
874 if ( $command == 1 ) { $addrbook_dsn = command91
(); }
875 elsif ( $command == 2 ) { $addrbook_table = command92
(); }
876 elsif ( $command == 3 ) { $prefs_dsn = command93
(); }
877 elsif ( $command == 4 ) { $prefs_table = command94
(); }
878 elsif ( $command == 5 ) { $prefs_user_field = command95
(); }
879 elsif ( $command == 6 ) { $prefs_key_field = command96
(); }
880 elsif ( $command == 7 ) { $prefs_val_field = command97
(); }
881 elsif ( $command == 8 ) { $addrbook_global_dsn = command98
(); }
882 elsif ( $command == 9 ) { $addrbook_global_table = command99
(); }
883 elsif ( $command == 10 ) { $addrbook_global_writeable = command910
(); }
884 elsif ( $command == 11 ) { $addrbook_global_listing = command911
(); }
885 } elsif ( $menu == 10 ) {
886 if ( $command == 1 ) { $squirrelmail_default_language = commandA1
(); }
887 elsif ( $command == 2 ) { $default_charset = commandA2
(); }
888 elsif ( $command == 3 ) { $show_alternative_names = commandA3
(); }
889 elsif ( $command == 4 ) { $aggressive_decoding = commandA4
(); }
890 elsif ( $command == 5 ) { $lossy_encoding = commandA5
(); }
891 } elsif ( $menu == 11 ) {
892 if ( $command == 1 ) { $use_iframe = commandB2
(); }
893 elsif ( $command == 2 ) { $use_icons = commandB3
(); }
894 elsif ( $command == 3 ) { $icon_theme_def = commandB7
(); }
895 elsif ( $command == 4 ) { $use_php_recode = commandB4
(); }
896 elsif ( $command == 5 ) { $use_php_iconv = commandB5
(); }
897 elsif ( $command == 6 ) { $allow_remote_configtest = commandB6
(); }
903 print "\nExiting conf.pl.\n".
904 "You might want to test your configuration by browsing to\n".
905 "http://your-squirrelmail-location/src/configtest.php\n".
906 "Happy SquirrelMailing!\n\n";
909 ####################################################################################
913 print "We have tried to make the name SquirrelMail as transparent as\n";
914 print "possible. If you set up an organization name, most places where\n";
915 print "SquirrelMail would take credit will be credited to your organization.\n";
917 print "If your Organization Name includes a '\$', please precede it with a \\. \n";
918 print "Other '\$' will be considered the beginning of a variable that\n";
919 print "must be defined before the \$org_name is printed.\n";
921 print "[$WHT$org_name$NRM]: $WHT";
922 $new_org_name = <STDIN
>;
923 if ( $new_org_name eq "\n" ) {
924 $new_org_name = $org_name;
926 $new_org_name =~ s/[\r\n]//g;
927 $new_org_name =~ s/\"/"/g;
929 return $new_org_name;
934 print "Your organization's logo is an image that will be displayed at\n";
935 print "different times throughout SquirrelMail. ";
937 print "Please be aware of the following: \n";
938 print " - Relative URLs are relative to the config dir\n";
939 print " to use the default logo, use ../images/sm_logo.png\n";
940 print " - To specify a logo defined outside the SquirrelMail source tree\n";
941 print " use the absolute URL the webserver would use to include the file\n";
942 print " e.g. http://www.example.com/images/mylogo.gif or /images/mylogo.jpg\n";
944 print "[$WHT$org_logo$NRM]: $WHT";
945 $new_org_logo = <STDIN
>;
946 if ( $new_org_logo eq "\n" ) {
947 $new_org_logo = $org_logo;
949 $new_org_logo =~ s/[\r\n]//g;
951 return $new_org_logo;
956 print "Your organization's logo is an image that will be displayed at\n";
957 print "different times throughout SquirrelMail. Width\n";
958 print "and Height of your logo image. Use '0' to disable.\n";
960 print "Width: [$WHT$org_logo_width$NRM]: $WHT";
961 $new_org_logo_width = <STDIN
>;
962 $new_org_logo_width =~ tr/0-9//cd; # only want digits!
963 if ( $new_org_logo_width eq '' ) {
964 $new_org_logo_width = $org_logo_width;
966 if ( $new_org_logo_width > 0 ) {
967 print "Height: [$WHT$org_logo_height$NRM]: $WHT";
968 $new_org_logo_height = <STDIN
>;
969 $new_org_logo_height =~ tr/0-9//cd; # only want digits!
970 if( $new_org_logo_height eq '' ) {
971 $new_org_logo_height = $org_logo_height;
974 $new_org_logo_height = 0;
976 return ($new_org_logo_width, $new_org_logo_height);
981 print "A title is what is displayed at the top of the browser window in\n";
982 print "the titlebar. Usually this will end up looking something like:\n";
983 print "\"Netscape: $org_title\"\n";
985 print "If your Organization Title includes a '\$', please precede it with a \\. \n";
986 print "Other '\$' will be considered the beginning of a variable that\n";
987 print "must be defined before the \$org_title is printed.\n";
989 print "[$WHT$org_title$NRM]: $WHT";
990 $new_org_title = <STDIN
>;
991 if ( $new_org_title eq "\n" ) {
992 $new_org_title = $org_title;
994 $new_org_title =~ s/[\r\n]//g;
995 $new_org_title =~ s/\"/\'/g;
997 return $new_org_title;
1002 print "When users click the Sign Out button they will be logged out and\n";
1003 print "then sent to signout_page. If signout_page is left empty,\n";
1004 print "(hit space and then return) they will be taken, as normal,\n";
1005 print "to the default and rather sparse SquirrelMail signout page.\n";
1007 print "[$WHT$signout_page$NRM]: $WHT";
1008 $new_signout_page = <STDIN
>;
1009 if ( $new_signout_page eq "\n" ) {
1010 $new_signout_page = $signout_page;
1012 $new_signout_page =~ s/[\r\n]//g;
1013 $new_signout_page =~ s/^\s+$//g;
1015 return $new_signout_page;
1020 print "SquirrelMail defaults to using the whole of the browser window.\n";
1021 print "This allows you to keep it within a specified frame. The default\n";
1022 print "is '_top'\n";
1024 print "[$WHT$frame_top$NRM]: $WHT";
1025 $new_frame_top = <STDIN
>;
1026 if ( $new_frame_top eq "\n" ) {
1027 $new_frame_top = '_top';
1029 $new_frame_top =~ s/[\r\n]//g;
1030 $new_frame_top =~ s/^\s+$//g;
1032 return $new_frame_top;
1035 # Default link to provider
1037 print "Here you can set the link on the right of the page.\n";
1038 print "If empty, it will link to the SquirrelMail About page.\n";
1040 print "[$WHT$provider_uri$NRM]: $WHT";
1041 $new_provider_uri = <STDIN
>;
1042 if ( $new_provider_uri eq "\n" ) {
1043 $new_provider_uri = '';
1045 $new_provider_uri =~ s/[\r\n]//g;
1046 $new_provider_uri =~ s/^\s+$//g;
1048 return $new_provider_uri;
1052 print "Here you can set the name of the link on the right of the page.\n";
1053 print "The default is 'SquirrelMail'\n";
1055 print "[$WHT$provider_name$NRM]: $WHT";
1056 $new_provider_name = <STDIN
>;
1057 if ( $new_provider_name eq "\n" ) {
1058 $new_provider_name = 'SquirrelMail';
1060 $new_provider_name =~ s/[\r\n]//g;
1061 $new_provider_name =~ s/^\s+$//g;
1062 $new_provider_name =~ s/\'/\\'/g;
1064 return $new_provider_name;
1067 ####################################################################################
1071 print "The domain name is the suffix at the end of all email addresses. If\n";
1072 print "for example, your email address is jdoe\@example.com, then your domain\n";
1073 print "would be example.com.\n";
1075 print "[$WHT$domain$NRM]: $WHT";
1076 $new_domain = <STDIN
>;
1077 if ( $new_domain eq "\n" ) {
1078 $new_domain = $domain;
1080 $new_domain =~ s/[\r\n]//g;
1087 print "This is the hostname where your IMAP server can be contacted.\n";
1088 print "[$WHT$imapServerAddress$NRM]: $WHT";
1089 $new_imapServerAddress = <STDIN
>;
1090 if ( $new_imapServerAddress eq "\n" ) {
1091 $new_imapServerAddress = $imapServerAddress;
1093 $new_imapServerAddress =~ s/[\r\n]//g;
1095 return $new_imapServerAddress;
1100 print "This is the port that your IMAP server is on. Usually this is 143.\n";
1101 print "[$WHT$imapPort$NRM]: $WHT";
1102 $new_imapPort = <STDIN
>;
1103 if ( $new_imapPort eq "\n" ) {
1104 $new_imapPort = $imapPort;
1106 $new_imapPort =~ s/[\r\n]//g;
1108 return $new_imapPort;
1113 print "You now need to choose the method that you will use for sending\n";
1114 print "messages in SquirrelMail. You can either connect to an SMTP server\n";
1115 print "or use sendmail directly.\n";
1116 if ( lc($useSendmail) eq 'true' ) {
1117 $default_value = "1";
1119 $default_value = "2";
1122 print " 1. Sendmail\n";
1124 print "Your choice [1/2] [$WHT$default_value$NRM]: $WHT";
1125 $use_sendmail = <STDIN
>;
1126 if ( ( $use_sendmail =~ /^1\n/i )
1127 || ( ( $use_sendmail =~ /^\n/ ) && ( $default_value eq "1" ) ) ) {
1128 $useSendmail = 'true';
1130 $useSendmail = 'false';
1132 return $useSendmail;
1137 print "Specify where the sendmail executable is located. Usually /usr/sbin/sendmail\n";
1138 print "[$WHT$sendmail_path$NRM]: $WHT";
1139 $new_sendmail_path = <STDIN
>;
1140 if ( $new_sendmail_path eq "\n" ) {
1141 $new_sendmail_path = $sendmail_path;
1143 $new_sendmail_path =~ s/[\r\n]//g;
1145 return $new_sendmail_path;
1148 # Extra sendmail arguments
1149 sub command_sendmail_args
{
1150 print "Specify additional sendmail program arguments.\n";
1152 print "Make sure that arguments are supported by your sendmail program. -f argument \n";
1153 print "is added automatically by SquirrelMail scripts. Variable defaults to standard\n";
1154 print "/usr/sbin/sendmail arguments. If you use qmail-inject, nbsmtp or any other \n";
1155 print "sendmail wrapper, which does not support -i and -t arguments, set variable to\n";
1156 print "empty string or use arguments suitable for your mailer.\n";
1158 print "[$WHT$sendmail_args$NRM]: $WHT";
1159 $new_sendmail_args = <STDIN
>;
1160 if ( $new_sendmail_args eq "\n" ) {
1161 $new_sendmail_args = $sendmail_args;
1163 # strip linefeeds and crs.
1164 $new_sendmail_args =~ s/[\r\n]//g;
1166 return trim
($new_sendmail_args);
1171 print "This is the hostname of your SMTP server.\n";
1172 print "[$WHT$smtpServerAddress$NRM]: $WHT";
1173 $new_smtpServerAddress = <STDIN
>;
1174 if ( $new_smtpServerAddress eq "\n" ) {
1175 $new_smtpServerAddress = $smtpServerAddress;
1177 $new_smtpServerAddress =~ s/[\r\n]//g;
1179 return $new_smtpServerAddress;
1184 print "This is the port to connect to for SMTP. Usually 25.\n";
1185 print "[$WHT$smtpPort$NRM]: $WHT";
1186 $new_smtpPort = <STDIN
>;
1187 if ( $new_smtpPort eq "\n" ) {
1188 $new_smtpPort = $smtpPort;
1190 $new_smtpPort =~ s/[\r\n]//g;
1192 return $new_smtpPort;
1197 print "Do you wish to use POP3 before SMTP? Your server must\n";
1198 print "support this in order for SquirrelMail to work with it.\n";
1201 $YesNo = 'y' if ( lc($pop_before_smtp) eq 'true' );
1203 print "Use pop before SMTP (y/n) [$WHT$YesNo$NRM]: $WHT";
1205 $new_pop_before_smtp = <STDIN
>;
1206 $new_pop_before_smtp =~ tr/yn//cd;
1207 return 'true' if ( $new_pop_before_smtp eq "y" );
1208 return 'false' if ( $new_pop_before_smtp eq "n" );
1209 return $pop_before_smtp;
1214 print "Each IMAP server has its own quirks. As much as we tried to stick\n";
1215 print "to standards, it doesn't help much if the IMAP server doesn't follow\n";
1216 print "the same principles. We have made some work-arounds for some of\n";
1217 print "these servers. If you would like to use them, please select your\n";
1218 print "IMAP server. If you do not wish to use these work-arounds, you can\n";
1219 print "set this to \"other\", and none will be used.\n";
1220 print " courier = Courier IMAP server\n";
1221 print " cyrus = Cyrus IMAP server\n";
1222 print " dovecot = Dovecot Secure IMAP server\n";
1223 print " exchange = Microsoft Exchange IMAP server\n";
1224 print " hmailserver = hMailServer\n";
1225 print " macosx = Mac OS X Mailserver\n";
1226 print " mercury32 = Mercury Mail Transport System\n";
1227 print " uw = University of Washington's IMAP server\n";
1229 print " other = Not one of the above servers\n";
1231 print "[$WHT$imap_server_type$NRM]: $WHT";
1232 $new_imap_server_type = <STDIN
>;
1234 if ( $new_imap_server_type eq "\n" ) {
1235 $new_imap_server_type = $imap_server_type;
1237 $new_imap_server_type =~ s/[\r\n]//g;
1239 return $new_imap_server_type;
1244 print "Sometimes the date of messages sent is messed up (off by a few hours\n";
1245 print "on some machines). Typically this happens if the system doesn't support\n";
1246 print "tm_gmtoff. It will happen only if your time zone is \"negative\".\n";
1247 print "This most often occurs on Solaris 7 machines in the United States.\n";
1248 print "By default, this is off. It should be kept off unless problems surface\n";
1249 print "about the time that messages are sent.\n";
1250 print " no = Do NOT fix time -- almost always correct\n";
1251 print " yes = Fix the time for this system\n";
1254 $YesNo = 'y' if ( lc($invert_time) eq 'true' );
1256 print "Fix the time for this system (y/n) [$WHT$YesNo$NRM]: $WHT";
1258 $new_invert_time = <STDIN
>;
1259 $new_invert_time =~ tr/yn//cd;
1260 return 'true' if ( $new_invert_time eq "y" );
1261 return 'false' if ( $new_invert_time eq "n" );
1262 return $invert_time;
1266 print "This is the delimiter that your IMAP server uses to distinguish between\n";
1267 print "folders. For example, Cyrus uses '.' as the delimiter and a complete\n";
1268 print "folder would look like 'INBOX.Friends.Bob', while UW uses '/' and would\n";
1269 print "look like 'INBOX/Friends/Bob'. Normally this should be left at 'detect'\n";
1270 print "but if you are sure you know what delimiter your server uses, you can\n";
1271 print "specify it here.\n";
1272 print "\nTo have it autodetect the delimiter, set it to 'detect'.\n\n";
1273 print "[$WHT$optional_delimiter$NRM]: $WHT";
1274 $new_optional_delimiter = <STDIN
>;
1276 if ( $new_optional_delimiter eq "\n" ) {
1277 $new_optional_delimiter = $optional_delimiter;
1279 $new_optional_delimiter =~ s/[\r\n]//g;
1281 return $new_optional_delimiter;
1283 # IMAP authentication type
1284 # Possible values: login, plain, cram-md5, digest-md5
1285 # Now offers to detect supported mechs, assuming server & port are set correctly
1288 if ($use_imap_tls ne "0") {
1289 # 1. Script does not handle TLS.
1290 # 2. Server does not have to declare all supported authentication mechs when
1291 # STARTTLS is used. Supported mechs are declared only after STARTTLS.
1292 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1294 print "If you have already set the hostname and port number, I can try to\n";
1295 print "detect the mechanisms your IMAP server supports.\n";
1296 print "I will try to detect CRAM-MD5 and DIGEST-MD5 support. I can't test\n";
1297 print "for \"login\" or \"plain\" without knowing a username and password.\n";
1298 print "Auto-detecting is optional - you can safely say \"n\" here.\n";
1299 print "\nTry to detect supported mechanisms? [y/N]: ";
1302 if ($inval =~ /^y\b/i) {
1303 # Yes, let's try to detect.
1304 print "Trying to detect IMAP capabilities...\n";
1305 my $host = $imapServerAddress . ':'. $imapPort;
1306 print "CRAM-MD5:\t";
1307 my $tmp = detect_auth_support
('IMAP',$host,'CRAM-MD5');
1308 if (defined($tmp)) {
1309 if ($tmp eq 'YES') {
1310 print "$WHT SUPPORTED$NRM\n";
1312 print "$WHT NOT SUPPORTED$NRM\n";
1315 print $WHT . " ERROR DETECTING$NRM\n";
1318 print "DIGEST-MD5:\t";
1319 $tmp = detect_auth_support
('IMAP',$host,'DIGEST-MD5');
1320 if (defined($tmp)) {
1321 if ($tmp eq 'YES') {
1322 print "$WHT SUPPORTED$NRM\n";
1324 print "$WHT NOT SUPPORTED$NRM\n";
1327 print $WHT . " ERROR DETECTING$NRM\n";
1332 print "\nWhat authentication mechanism do you want to use for IMAP connections?\n\n";
1333 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1334 print $WHT . "plain" . $NRM . " - SASL PLAIN. If you need this, you already know it.\n";
1335 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext methods.\n";
1336 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1337 print "\n*** YOUR IMAP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n";
1338 print "If you don't understand or are unsure, you probably want \"login\"\n\n";
1339 print "login, plain, cram-md5, or digest-md5 [$WHT$imap_auth_mech$NRM]: $WHT";
1342 if ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) || ($inval =~ /^login\b/i) || ($inval =~ /^plain\b/i)) {
1345 # user entered garbage or default value so nothing needs to be set
1346 return $imap_auth_mech;
1351 # SMTP authentication type
1352 # Possible choices: none, plain, cram-md5, digest-md5
1354 if ($use_smtp_tls ne "0") {
1355 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1356 } elsif (eval ("use IO::Socket; 1")) {
1357 # try loading IO::Socket module
1358 print "If you have already set the hostname and port number, I can try to\n";
1359 print "automatically detect some of the mechanisms your SMTP server supports.\n";
1360 print "Auto-detection is *optional* - you can safely say \"n\" here.\n";
1361 print "\nTry to detect auth mechanisms? [y/N]: ";
1364 if ($inval =~ /^y\b/i) {
1365 # Yes, let's try to detect.
1366 print "Trying to detect supported methods (SMTP)...\n";
1369 # Check none by trying to relay to junk@microsoft.com
1370 $host = $smtpServerAddress . ':' . $smtpPort;
1371 my $sock = IO
::Socket
::INET
->new($host);
1372 print "Testing none:\t\t$WHT";
1373 if (!defined($sock)) {
1374 print " ERROR TESTING\n";
1377 print $sock "HELO $domain\r\n";
1378 $got = <$sock>; # Discard
1379 print $sock "MAIL FROM:<tester\@squirrelmail.org>\r\n";
1380 $got = <$sock>; # Discard
1381 print $sock "RCPT TO:<junk\@microsoft.com\r\n";
1382 $got = <$sock>; # This is the important line
1383 if ($got =~ /^250\b/) { # SMTP will relay without auth
1384 print "SUPPORTED$NRM\n";
1386 print "NOT SUPPORTED$NRM\n";
1388 print $sock "RSET\r\n";
1389 print $sock "QUIT\r\n";
1392 # Try login (SquirrelMail default)
1393 print "Testing login:\t\t";
1394 $tmp=detect_auth_support
('SMTP',$host,'LOGIN');
1395 if (defined($tmp)) {
1396 if ($tmp eq 'YES') {
1397 print $WHT . "SUPPORTED$NRM\n";
1399 print $WHT . "NOT SUPPORTED$NRM\n";
1402 print $WHT . "ERROR DETECTING$NRM\n";
1406 print "Testing CRAM-MD5:\t";
1407 $tmp=detect_auth_support
('SMTP',$host,'CRAM-MD5');
1408 if (defined($tmp)) {
1409 if ($tmp eq 'YES') {
1410 print $WHT . "SUPPORTED$NRM\n";
1412 print $WHT . "NOT SUPPORTED$NRM\n";
1415 print $WHT . "ERROR DETECTING$NRM\n";
1419 print "Testing DIGEST-MD5:\t";
1420 $tmp=detect_auth_support
('SMTP',$host,'DIGEST-MD5');
1421 if (defined($tmp)) {
1422 if ($tmp eq 'YES') {
1423 print $WHT . "SUPPORTED$NRM\n";
1425 print $WHT . "NOT SUPPORTED$NRM\n";
1428 print $WHT . "ERROR DETECTING$NRM\n";
1432 print "\nWhat authentication mechanism do you want to use for SMTP connections?\n";
1433 print $WHT . "none" . $NRM . " - Your SMTP server does not require authorization.\n";
1434 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1435 print $WHT . "plain" . $NRM . " - SASL PLAIN. You already know it if you need this.\n";
1436 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext.\n";
1437 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1438 print $WHT . "\n*** YOUR SMTP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n" . $NRM;
1439 print "If you don't understand or are unsure, you probably want \"none\"\n\n";
1440 print "none, login, cram-md5, or digest-md5 [$WHT$smtp_auth_mech$NRM]: $WHT";
1443 if ($inval =~ /^none\b/i) {
1444 # remove sitewide smtp authentication information
1445 $smtp_sitewide_user = '';
1446 $smtp_sitewide_pass = '';
1447 # SMTP doesn't necessarily require logins
1449 } elsif ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) ||
1450 ($inval =~ /^login\b/i) || ($inval =~/^plain\b/i)) {
1451 command_smtp_sitewide_userpass
($inval);
1453 } elsif (trim
($inval) eq '') {
1454 # user selected default value
1455 command_smtp_sitewide_userpass
($smtp_auth_mech);
1456 return $smtp_auth_mech;
1458 # user entered garbage
1459 return $smtp_auth_mech;
1463 sub command_smtp_sitewide_userpass
($) {
1464 # get first function argument
1465 my $auth_mech = shift(@_);
1467 $auth_mech = lc(trim
($auth_mech));
1468 if ($auth_mech eq 'none') {
1471 print "SMTP authentication uses IMAP username and password by default.\n";
1473 print "Would you like to use other login and password for all SquirrelMail \n";
1474 print "SMTP connections?";
1475 if ($smtp_sitewide_user ne '') {
1492 $smtp_sitewide_user = '';
1493 $smtp_sitewide_pass = '';
1494 } elsif ($tmp eq 'y') {
1495 print "Enter username [$smtp_sitewide_user]:";
1496 my $new_user = <STDIN
>;
1497 $new_user = trim
($new_user);
1498 if ($new_user ne '') {
1499 $smtp_sitewide_user = $new_user;
1501 if ($smtp_sitewide_user ne '') {
1502 print "If you don't enter any password, current sitewide password will be used.\n";
1503 print "If you enter space, password will be set to empty string.\n";
1504 print "Enter password:";
1505 my $new_pass = <STDIN
>;
1506 if ($new_pass ne "\n") {
1507 $smtp_sitewide_pass = trim
($new_pass);
1510 print "Invalid input. You must set username used for SMTP authentication.\n";
1511 print "Click any key to continue\n";
1515 print "Invalid input\n";
1516 print "Click any key to continue\n";
1521 # Sub adds information about SMTP authentication type to menu
1522 sub display_smtp_sitewide_userpass
() {
1524 if ($smtp_auth_mech ne 'none') {
1525 if ($smtp_sitewide_user ne '') {
1526 $ret = ' (with custom username and password)';
1528 $ret = ' (with IMAP username and password)';
1535 # This sub is reused for IMAP and SMTP
1536 # Args: service name, default value
1537 sub command_use_tls
{
1538 my($default_val,$service,$inval);
1541 print "TLS (Transport Layer Security) encrypts the traffic between server and client.\n";
1542 print "STARTTLS extensions allow to start encryption on existing plain text connection.\n";
1543 print "These options add specific PHP and IMAP server configuration requirements.\n";
1544 print "See SquirrelMail documentation about connection security.\n";
1546 print "If your " . $service . " server is localhost, you can safely disable this.\n";
1547 print "If it is remote, you may wish to seriously consider enabling this.\n";
1549 while ($valid_input eq 0) {
1550 print "\nSelect connection security model:\n";
1551 print " 0 - Use plain text connection\n";
1552 print " 1 - Use TLS connection\n";
1553 print " 2 - Use STARTTLS extension\n";
1554 print "Select [$default_val]: ";
1556 $inval=trim
($inval);
1557 if ($inval =~ /^[012]$/ || $inval eq '') {
1561 if ($inval ne '') {$default_val = $inval};
1562 return $default_val;
1565 # This sub is used to display human readable text for
1566 # $use_imap_tls and $use_smtp_tls values in conf.pl menu
1567 sub display_use_tls
($) {
1568 my $val = shift(@_);
1569 my $ret = 'disabled';
1572 } elsif ($val eq '1') {
1578 # $encode_header_key
1580 print "Encryption key allows to hide SquirrelMail Received: headers\n";
1581 print "in outbound messages. Interface uses encryption key to encode\n";
1582 print "username, remote address and proxied address, then stores encoded\n";
1583 print "information in X-Squirrel-* headers.\n";
1585 print "Warning: used encryption function is not bulletproof. When used\n";
1586 print "with static encryption keys, it provides only minimal security\n";
1587 print "measures and information can be decoded quickly.\n";
1589 print "Encoded information can be decoded with decrypt_headers.php script\n";
1590 print "from SquirrelMail contrib/ directory.\n";
1592 print "Enter encryption key: ";
1593 $new_encode_header_key = <STDIN
>;
1594 if ( $new_encode_header_key eq "\n" ) {
1595 $new_encode_header_key = $encode_header_key;
1597 $new_encode_header_key =~ s/[\r\n]//g;
1599 return $new_encode_header_key;
1604 print "\nYou can now create the welcome message that is displayed\n";
1605 print "every time a user logs on. You can use HTML or just plain\n";
1607 "text. If you do not wish to have one, just make it blank.\n\n(Type @ on a blank line to exit)\n";
1613 $line =~ s/[\r\n]//g;
1614 if ( $line ne "@" ) {
1615 $line =~ s/ /\ \ /g;
1616 $line =~ s/\t/\ \ \ \ /g;
1618 $line =~ s/\"/\\\"/g;
1620 $new_motd = $new_motd . $line;
1622 } while ( $line ne "@" );
1626 ################# PLUGINS ###################
1629 $command =~ s/[\s\n\r]*//g;
1630 if ( $command > 0 ) {
1631 $command = $command - 1;
1632 if ( $command <= $#plugins ) {
1635 while ( $ct <= $#plugins ) {
1636 if ( $ct != $command ) {
1637 @newplugins = ( @newplugins, $plugins[$ct] );
1641 @plugins = @newplugins;
1642 } elsif ( $command <= $#plugins + $#unused_plugins + 1 ) {
1643 $num = $command - $#plugins - 1;
1644 @newplugins = @plugins;
1646 while ( $ct <= $#unused_plugins ) {
1647 if ( $ct == $num ) {
1648 @newplugins = ( @newplugins, $unused_plugins[$ct] );
1652 @plugins = @newplugins;
1658 ################# FOLDERS ###################
1660 # default_folder_prefix
1662 print "Some IMAP servers (UW, for example) store mail and folders in\n";
1663 print "your user space in a separate subdirectory. This is where you\n";
1664 print "specify what that directory is.\n";
1666 print "EXAMPLE: mail/";
1668 print "NOTE: If you use Cyrus, or some server that would not use this\n";
1669 print " option, you must set this to 'none'.\n";
1671 print "[$WHT$default_folder_prefix$NRM]: $WHT";
1672 $new_default_folder_prefix = <STDIN
>;
1674 if ( $new_default_folder_prefix eq "\n" ) {
1675 $new_default_folder_prefix = $default_folder_prefix;
1677 $new_default_folder_prefix =~ s/[\r\n]//g;
1679 if ( ( $new_default_folder_prefix =~ /^\s*$/ ) || ( $new_default_folder_prefix =~ m/^none$/i ) ) {
1680 $new_default_folder_prefix = "";
1682 # add the trailing delimiter only if we know what the server is.
1683 if (($imap_server_type eq 'cyrus' and
1684 $optional_delimiter eq 'detect') or
1685 ($imap_server_type eq 'courier' and
1686 $optional_delimiter eq 'detect')) {
1687 $new_default_folder_prefix =~ s/\.*$/\./;
1688 } elsif ($imap_server_type eq 'uw' and
1689 $optional_delimiter eq 'detect') {
1690 $new_default_folder_prefix =~ s/\/*$/\
//;
1693 return $new_default_folder_prefix;
1696 # Show Folder Prefix
1698 print "It is possible to set up the default folder prefix as a user\n";
1699 print "specific option, where each user can specify what their mail\n";
1700 print "folder is. If you set this to false, they will never see the\n";
1701 print "option, but if it is true, this option will appear in the\n";
1702 print "'options' section.\n";
1704 print "NOTE: You set the default folder prefix in option '1' of this\n";
1705 print " section. That will be the default if the user doesn't\n";
1706 print " specify anything different.\n";
1709 if ( lc($show_prefix_option) eq 'true' ) {
1710 $default_value = "y";
1712 $default_value = "n";
1715 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
1716 $new_show = <STDIN
>;
1717 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1718 $show_prefix_option = 'true';
1720 $show_prefix_option = 'false';
1722 return $show_prefix_option;
1727 print "You can now specify where the default trash folder is located.\n";
1728 print "On servers where you do not want this, you can set it to anything\n";
1729 print "and set option 6 to false.\n";
1731 print "This is relative to where the rest of your email is kept. You do\n";
1732 print "not need to worry about their mail directory. If this folder\n";
1733 print "would be ~/mail/trash on the filesystem, you only need to specify\n";
1734 print "that this is 'trash', and be sure to put 'mail/' in option 1.\n";
1737 print "[$WHT$trash_folder$NRM]: $WHT";
1738 $new_trash_folder = <STDIN
>;
1739 if ( $new_trash_folder eq "\n" ) {
1740 $new_trash_folder = $trash_folder;
1742 if (check_imap_folder
($new_trash_folder)) {
1743 $new_trash_folder =~ s/[\r\n]//g;
1745 $new_trash_folder = $trash_folder;
1748 return $new_trash_folder;
1753 print "This is where messages that are sent will be stored. SquirrelMail\n";
1754 print "by default puts a copy of all outgoing messages in this folder.\n";
1756 print "This is relative to where the rest of your email is kept. You do\n";
1757 print "not need to worry about their mail directory. If this folder\n";
1758 print "would be ~/mail/sent on the filesystem, you only need to specify\n";
1759 print "that this is 'sent', and be sure to put 'mail/' in option 1.\n";
1762 print "[$WHT$sent_folder$NRM]: $WHT";
1763 $new_sent_folder = <STDIN
>;
1764 if ( $new_sent_folder eq "\n" ) {
1765 $new_sent_folder = $sent_folder;
1767 if (check_imap_folder
($new_sent_folder)) {
1768 $new_sent_folder =~ s/[\r\n]//g;
1770 $new_sent_folder = $sent_folder;
1773 return $new_sent_folder;
1778 print "You can now specify where the default draft folder is located.\n";
1779 print "On servers where you do not want this, you can set it to anything\n";
1780 print "and set option 9 to false.\n";
1782 print "This is relative to where the rest of your email is kept. You do\n";
1783 print "not need to worry about their mail directory. If this folder\n";
1784 print "would be ~/mail/drafts on the filesystem, you only need to specify\n";
1785 print "that this is 'drafts', and be sure to put 'mail/' in option 1.\n";
1788 print "[$WHT$draft_folder$NRM]: $WHT";
1789 $new_draft_folder = <STDIN
>;
1790 if ( $new_draft_folder eq "\n" ) {
1791 $new_draft_folder = $draft_folder;
1793 if (check_imap_folder
($new_draft_folder)) {
1794 $new_draft_folder =~ s/[\r\n]//g;
1796 $new_draft_folder = $draft_folder;
1799 return $new_draft_folder;
1802 # default move to trash
1804 print "By default, should messages get moved to the trash folder? You\n";
1805 print "can specify the default trash folder in option 3. If this is set\n";
1806 print "to false, messages will get deleted immediately without moving\n";
1807 print "to the trash folder.\n";
1809 print "Trash folder is currently: $trash_folder\n";
1812 if ( lc($default_move_to_trash) eq 'true' ) {
1813 $default_value = "y";
1815 $default_value = "n";
1817 print "By default, move to trash (y/n) [$WHT$default_value$NRM]: $WHT";
1818 $new_show = <STDIN
>;
1819 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1820 $default_move_to_trash = 'true';
1822 $default_move_to_trash = 'false';
1824 return $default_move_to_trash;
1827 # default move to sent
1829 print "By default, should messages get moved to the sent folder? You\n";
1830 print "can specify the default sent folder in option 4. If this is set\n";
1831 print "to false, messages will get sent and no copy will be made.\n";
1833 print "Sent folder is currently: $sent_folder\n";
1836 if ( lc($default_move_to_sent) eq 'true' ) {
1837 $default_value = "y";
1839 $default_value = "n";
1841 print "By default, move to sent (y/n) [$WHT$default_value$NRM]: $WHT";
1842 $new_show = <STDIN
>;
1843 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1844 $default_move_to_sent = 'true';
1846 $default_move_to_sent = 'false';
1848 return $default_move_to_sent;
1851 # default save as draft
1853 print "By default, should the save to draft option be shown? You can\n";
1854 print "specify the default drafts folder in option 5. If this is set\n";
1855 print "to false, users will not be shown the save to draft option.\n";
1857 print "Drafts folder is currently: $draft_folder\n";
1860 if ( lc($default_move_to_draft) eq 'true' ) {
1861 $default_value = "y";
1863 $default_value = "n";
1865 print "By default, save as draft (y/n) [$WHT$default_value$NRM]: $WHT";
1866 $new_show = <STDIN
>;
1867 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1868 $default_save_as_draft = 'true';
1870 $default_save_as_draft = 'false';
1872 return $default_save_as_draft;
1875 # List special folders first
1877 print "SquirrelMail has what we call 'special folders' that are not\n";
1878 print "manipulated and viewed like normal folders. Some examples of\n";
1879 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
1880 print "Simply asks if you want these folders listed first in the folder\n";
1884 if ( lc($list_special_folders_first) eq 'true' ) {
1885 $default_value = "y";
1887 $default_value = "n";
1890 print "List first (y/n) [$WHT$default_value$NRM]: $WHT";
1891 $new_show = <STDIN
>;
1892 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1893 $list_special_folders_first = 'true';
1895 $list_special_folders_first = 'false';
1897 return $list_special_folders_first;
1900 # Show special folders color
1902 print "SquirrelMail has what we call 'special folders' that are not\n";
1903 print "manipulated and viewed like normal folders. Some examples of\n";
1904 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
1905 print "wants to know if we should display special folders in a\n";
1906 print "color than the other folders.\n";
1909 if ( lc($use_special_folder_color) eq 'true' ) {
1910 $default_value = "y";
1912 $default_value = "n";
1915 print "Show color (y/n) [$WHT$default_value$NRM]: $WHT";
1916 $new_show = <STDIN
>;
1917 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1918 $use_special_folder_color = 'true';
1920 $use_special_folder_color = 'false';
1922 return $use_special_folder_color;
1927 print "The way that IMAP handles deleting messages is as follows. You\n";
1928 print "mark the message as deleted, and then to 'really' delete it, you\n";
1929 print "expunge it. This option asks if you want to just have messages\n";
1930 print "marked as deleted, or if you want SquirrelMail to expunge the \n";
1931 print "messages too.\n";
1934 if ( lc($auto_expunge) eq 'true' ) {
1935 $default_value = "y";
1937 $default_value = "n";
1939 print "Auto expunge (y/n) [$WHT$default_value$NRM]: $WHT";
1940 $new_show = <STDIN
>;
1941 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1942 $auto_expunge = 'true';
1944 $auto_expunge = 'false';
1946 return $auto_expunge;
1949 # Default sub of inbox
1951 print "Some IMAP servers (Cyrus) have all folders as subfolders of INBOX.\n";
1952 print "This can cause some confusion in folder creation for users when\n";
1953 print "they try to create folders and don't put it as a subfolder of INBOX\n";
1954 print "and get permission errors. This option asks if you want folders\n";
1955 print "to be subfolders of INBOX by default.\n";
1958 if ( lc($default_sub_of_inbox) eq 'true' ) {
1959 $default_value = "y";
1961 $default_value = "n";
1963 print "Default sub of INBOX (y/n) [$WHT$default_value$NRM]: $WHT";
1964 $new_show = <STDIN
>;
1965 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1966 $default_sub_of_inbox = 'true';
1968 $default_sub_of_inbox = 'false';
1970 return $default_sub_of_inbox;
1973 # Show contain subfolder option
1975 print "Some IMAP servers (UW) make it so that there are two types of\n";
1976 print "folders. Those that contain messages, and those that contain\n";
1977 print "subfolders. If this is the case for your server, set this to\n";
1978 print "true, and it will ask the user whether the folder they are\n";
1979 print "creating contains subfolders or messages.\n";
1982 if ( lc($show_contain_subfolders_option) eq 'true' ) {
1983 $default_value = "y";
1985 $default_value = "n";
1987 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
1988 $new_show = <STDIN
>;
1989 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1990 $show_contain_subfolders_option = 'true';
1992 $show_contain_subfolders_option = 'false';
1994 return $show_contain_subfolders_option;
1997 # Default Unseen Notify
1999 print "This option specifies where the users will receive notification\n";
2000 print "about unseen messages by default. This is of course an option that\n";
2001 print "can be changed on a user level.\n";
2002 print " 1 = No notification\n";
2003 print " 2 = Only on the INBOX\n";
2004 print " 3 = On all folders\n";
2007 print "Which one should be default (1,2,3)? [$WHT$default_unseen_notify$NRM]: $WHT";
2008 $new_show = <STDIN
>;
2009 if ( $new_show =~ /^[123]\n/i ) {
2010 $default_unseen_notify = $new_show;
2012 $default_unseen_notify =~ s/[\r\n]//g;
2013 return $default_unseen_notify;
2016 # Default Unseen Type
2018 print "Here you can define the default way that unseen messages will be displayed\n";
2019 print "to the user in the folder listing on the left side.\n";
2020 print " 1 = Only unseen messages (4)\n";
2021 print " 2 = Unseen and Total messages (4/27)\n";
2024 print "Which one should be default (1,2)? [$WHT$default_unseen_type$NRM]: $WHT";
2025 $new_show = <STDIN
>;
2026 if ( $new_show =~ /^[12]\n/i ) {
2027 $default_unseen_type = $new_show;
2029 $default_unseen_type =~ s/[\r\n]//g;
2030 return $default_unseen_type;
2033 # Auto create special folders
2035 print "Would you like the Sent, Trash, and Drafts folders to be created\n";
2036 print "automatically print for you when a user logs in? If the user\n";
2037 print "accidentally deletes their special folders, this option will\n";
2038 print "automatically create it again for them.\n";
2041 if ( lc($auto_create_special) eq 'true' ) {
2042 $default_value = "y";
2044 $default_value = "n";
2046 print "Auto create special folders? (y/n) [$WHT$default_value$NRM]: $WHT";
2047 $new_show = <STDIN
>;
2048 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2049 $auto_create_special = 'true';
2051 $auto_create_special = 'false';
2053 return $auto_create_special;
2056 # Automatically delete folders
2058 if ( $imap_server_type eq "uw" ) {
2059 print "UW IMAP servers will not allow folders containing mail to also contain folders.\n";
2060 print "Deleting folders will bypass the trash folder and be immediately deleted\n\n";
2061 print "If this is not the correct value for your server,\n";
2062 print "please use option D on the Main Menu to configure your server correctly.\n\n";
2063 print "Press any key to continue...\n";
2064 $new_delete = <STDIN
>;
2065 $delete_folder = 'true';
2067 if ( $imap_server_type eq "courier" ) {
2068 print "Courier (or Courier-IMAP) IMAP servers may not support ";
2069 print "subfolders of Trash. \n";
2070 print "Specifically, if Courier is set to always move messages to Trash, \n";
2071 print "Trash will be treated by Courier as a special folder that does not \n";
2072 print "allow subfolders. \n\n";
2073 print "Please verify your Courier configuration, and test folder deletion \n";
2074 print "when changing this setting.\n\n";
2077 print "Are subfolders of the Trash supported by your IMAP server?\n";
2078 print "If so, should deleted folders be sent to Trash?\n";
2079 print "If not, say no (deleted folders should not be sent to Trash)\n\n";
2080 # reversal of logic.
2081 # question was: Should folders be automatically deleted instead of sent to trash..
2082 # we've changed the question to make it more clear,
2083 # and are here handling that to avoid changing the answers..
2084 if ( lc($delete_folder) eq 'true' ) {
2085 $default_value = "n";
2087 $default_value = "y";
2089 print "Send deleted folders to Trash? (y/n) [$WHT$default_value$NRM]: $WHT";
2090 $new_delete = <STDIN
>;
2091 if ( ( $new_delete =~ /^y\n/i ) || ( ( $new_delete =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2092 $delete_folder = 'false';
2094 $delete_folder = 'true';
2097 return $delete_folder;
2102 print "Some IMAP server allow subfolders to exist even if the parent\n";
2103 print "folders do not. This fixes some problems with the folder list\n";
2104 print "when this is the case, causing the /NoSelect folders to be displayed\n";
2107 if ( lc($noselect_fix_enable) eq 'true' ) {
2108 $default_value = "y";
2110 $default_value = "n";
2112 print "enable noselect fix? (y/n) [$WHT$noselect_fix_enable$NRM]: $WHT";
2113 $noselect_fix_enable = <STDIN
>;
2114 if ( ( $noselect_fix_enable =~ /^y\n/i ) || ( ( $noselect_fix_enable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2115 $noselect_fix_enable = 'true';
2117 $noselect_fix_enable = 'false';
2119 return $noselect_fix_enable;
2121 ############# GENERAL OPTIONS #####################
2125 print "Specify the location for your data directory.\n";
2126 print "You need to create this directory yourself.\n";
2127 print "The path name can be absolute or relative (to the config directory).\n";
2128 print "Here are two examples:\n";
2129 print " Absolute: /var/local/squirrelmail/data/\n";
2130 print " Relative: ../data/\n";
2131 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2132 print "will be converted to their absolute path equivalents in config.php.\n\n";
2133 print "Note: There are potential security risks with having a writeable directory\n";
2134 print "under the web server's root directory (ex: /home/httpd/html).\n";
2135 print "For this reason, it is recommended to put the data directory\n";
2136 print "in an alternate location of your choice. \n";
2139 print "[$WHT$data_dir$NRM]: $WHT";
2140 $new_data_dir = <STDIN
>;
2141 if ( $new_data_dir eq "\n" ) {
2142 $new_data_dir = $data_dir;
2144 $new_data_dir =~ s/[\r\n]//g;
2146 if ( $new_data_dir =~ /^\s*$/ ) {
2149 $new_data_dir =~ s/\/*$//g
;
2150 $new_data_dir =~ s/$/\//g
;
2152 return $new_data_dir;
2155 # Attachment directory
2157 print "Path to directory used for storing attachments while a mail is\n";
2158 print "being composed. The path name can be absolute or relative (to the\n";
2159 print "config directory). Here are two examples:\n";
2160 print " Absolute: /var/local/squirrelmail/attach/\n";
2161 print " Relative: ../attach/\n";
2162 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2163 print "will be converted to their absolute path equivalents in config.php.\n\n";
2164 print "Note: There are a few security considerations regarding this\n";
2165 print "directory:\n";
2166 print " 1. It should have the permission 733 (rwx-wx-wx) to make it\n";
2167 print " impossible for a random person with access to the webserver\n";
2168 print " to list files in this directory. Confidential data might\n";
2169 print " be laying around in there.\n";
2170 print " Depending on your user:group assignments, 730 (rwx-wx---)\n";
2171 print " may be possible, and more secure (e.g. root:apache)\n";
2172 print " 2. Since the webserver is not able to list the files in the\n";
2173 print " content is also impossible for the webserver to delete files\n";
2174 print " lying around there for too long.\n";
2175 print " 3. It should probably be another directory than the data\n";
2176 print " directory specified in option 3.\n";
2179 print "[$WHT$attachment_dir$NRM]: $WHT";
2180 $new_attachment_dir = <STDIN
>;
2181 if ( $new_attachment_dir eq "\n" ) {
2182 $new_attachment_dir = $attachment_dir;
2184 $new_attachment_dir =~ s/[\r\n]//g;
2186 if ( $new_attachment_dir =~ /^\s*$/ ) {
2187 $new_attachment_dir = "";
2189 $new_attachment_dir =~ s/\/*$//g
;
2190 $new_attachment_dir =~ s/$/\//g
;
2192 return $new_attachment_dir;
2196 print "The directory hash level setting allows you to configure the level\n";
2197 print "of hashing that SquirrelMail employs in your data and attachment\n";
2198 print "directories. This value must be an integer ranging from 0 to 4.\n";
2199 print "When this value is set to 0, SquirrelMail will simply store all\n";
2200 print "files as normal in the data and attachment directories. However,\n";
2201 print "when set to a value from 1 to 4, a simple hashing scheme will be\n";
2202 print "used to organize the files in this directory. In short, the crc32\n";
2203 print "value for a username will be computed. Then, up to the first 4\n";
2204 print "digits of the hash, as set by this configuration value, will be\n";
2205 print "used to directory hash the files for that user in the data and\n";
2206 print "attachment directory. This allows for better performance on\n";
2207 print "servers with larger numbers of users.\n";
2210 print "[$WHT$dir_hash_level$NRM]: $WHT";
2211 $new_dir_hash_level = <STDIN
>;
2212 if ( $new_dir_hash_level eq "\n" ) {
2213 $new_dir_hash_level = $dir_hash_level;
2215 $new_dir_hash_level =~ s/[\r\n]//g;
2217 if ( ( int($new_dir_hash_level) < 0 )
2218 || ( int($new_dir_hash_level) > 4 )
2219 || !( int($new_dir_hash_level) eq $new_dir_hash_level ) ) {
2220 print "Invalid Directory Hash Level.\n";
2221 print "Value must be an integer ranging from 0 to 4\n";
2222 print "Hit enter to continue.\n";
2223 $enter_key = <STDIN
>;
2225 $new_dir_hash_level = $dir_hash_level;
2228 return $new_dir_hash_level;
2232 print "This is the default size (in pixels) of the left folder list.\n";
2233 print "Default is 200, but you can set it to whatever you wish. This\n";
2234 print "is a user preference, so this will only show up as their default.\n";
2236 print "[$WHT$default_left_size$NRM]: $WHT";
2237 $new_default_left_size = <STDIN
>;
2238 if ( $new_default_left_size eq "\n" ) {
2239 $new_default_left_size = $default_left_size;
2241 $new_default_left_size =~ s/[\r\n]//g;
2243 return $new_default_left_size;
2247 print "Some IMAP servers only have lowercase letters in the usernames\n";
2248 print "but they still allow people with uppercase to log in. This\n";
2249 print "causes a problem with the user's preference files. This option\n";
2250 print "transparently changes all usernames to lowercase.";
2253 if ( lc($force_username_lowercase) eq 'true' ) {
2254 $default_value = "y";
2256 $default_value = "n";
2258 print "Convert usernames to lowercase (y/n) [$WHT$default_value$NRM]: $WHT";
2259 $new_show = <STDIN
>;
2260 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2270 if ( lc($default_use_priority) eq 'true' ) {
2271 $default_value = "y";
2273 $default_value = "n";
2276 print "Allow users to specify priority of outgoing mail (y/n) [$WHT$default_value$NRM]: $WHT";
2277 $new_show = <STDIN
>;
2278 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2288 if ( lc($default_hide_attribution) eq 'true' ) {
2289 $default_value = "y";
2291 $default_value = "n";
2294 print "Hide SM attributions (y/n) [$WHT$default_value$NRM]: $WHT";
2295 $new_show = <STDIN
>;
2296 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2306 if ( lc($default_use_mdn) eq 'true' ) {
2307 $default_value = "y";
2309 $default_value = "n";
2312 print "Enable support for read/delivery receipt support (y/n) [$WHT$default_value$NRM]: $WHT";
2313 $new_show = <STDIN
>;
2314 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2322 print " In loosely managed environments, you may want to allow users
2323 to edit their full name and email address. In strictly managed
2324 environments, you may want to force users to use the name
2325 and email address assigned to them.
2327 'y' - allow a user to edit their full name and email address,
2328 'n' - users must use the assigned values.
2332 if ( lc($edit_identity) eq 'true' ) {
2333 $default_value = "y";
2335 $default_value = "n";
2337 print "Allow editing of user's identity? (y/n) [$WHT$default_value$NRM]: $WHT";
2338 $new_edit = <STDIN
>;
2339 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2340 $edit_identity = 'true';
2341 $edit_name = 'true';
2342 $hide_auth_header = command311b
();
2344 $edit_identity = 'false';
2345 $edit_name = command311
();
2346 $hide_auth_header = command311b
();
2348 return $edit_identity;
2352 print " Given that users are not allowed to modify their
2353 email address, can they edit their full name?
2357 if ( lc($edit_name) eq 'true' ) {
2358 $default_value = "y";
2360 $default_value = "n";
2362 print "Allow the user to edit their full name? (y/n) [$WHT$default_value$NRM]: $WHT";
2363 $new_edit = <STDIN
>;
2364 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2365 $edit_name = 'true';
2367 $edit_name = 'false';
2373 print " SquirrelMail adds username information to every sent email
2374 in order to prevent possible sender forging when users are allowed
2375 to change their email and/or full name.
2377 You can remove user information from this header (y), if you think that
2378 it violates privacy or security.
2380 Note: If users are allowed to change their email addresses,
2381 this setting will make it difficult to determine who sent what where.
2382 Use at your own risk.
2386 if ( lc($hide_auth_header) eq "true" ) {
2387 $default_value = "y";
2389 $default_value = "n";
2391 print "Remove username from email headers? (y/n) [$WHT$default_value$NRM]: $WHT";
2392 $new_header = <STDIN
>;
2393 if ( ( $new_header =~ /^y\n/i ) || ( ( $new_header =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2394 $hide_auth_header = "true";
2396 $hide_auth_header = "false";
2398 return $hide_auth_header;
2402 print "This option allows you to disable server side thread sorting if your server \n";
2403 print "declares THREAD support, but you don't want to provide threading options \n";
2404 print "to end users or THREAD extension is broken or extension does not work with \n";
2405 print "options used by SquirrelMail. Option is not used, if THREAD extension is \n";
2406 print "not declared in IMAP CAPABILITY.\n";
2409 if ( lc($disable_thread_sort) eq 'true' ) {
2410 $default_value = "y";
2412 $default_value = "n";
2414 print "Disable server side thread sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2415 $disable_thread_sort = <STDIN
>;
2416 if ( ( $disable_thread_sort =~ /^y\n/i ) || ( ( $disable_thread_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2417 $disable_thread_sort = 'true';
2419 $disable_thread_sort = 'false';
2421 return $disable_thread_sort;
2425 print "This option allows you to disable server side sorting if your server declares \n";
2426 print "SORT support, but SORT extension is broken or does not work with options \n";
2427 print "used by SquirrelMail. Option is not used, if SORT extension is not declared \n";
2428 print "in IMAP CAPABILITY.\n";
2430 print "It is strongly recommended to keep server side sorting enabled, if your ";
2431 print "IMAP server supports it.";
2434 if ( lc($disable_server_sort) eq 'true' ) {
2435 $default_value = "y";
2437 $default_value = "n";
2439 print "Disable server-side sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2440 $disable_server_sort = <STDIN
>;
2441 if ( ( $disable_server_sort =~ /^y\n/i ) || ( ( $disable_server_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2442 $disable_server_sort = 'true';
2444 $disable_server_sort = 'false';
2446 return $disable_server_sort;
2450 print "This option allows you to choose if SM uses charset search\n";
2451 print "Your IMAP server must support the SEARCH CHARSET command for this to work\n";
2454 if ( lc($allow_charset_search) eq 'true' ) {
2455 $default_value = "y";
2457 $default_value = "n";
2459 print "Allow charset searching? (y/n) [$WHT$default_value$NRM]: $WHT";
2460 $allow_charset_search = <STDIN
>;
2461 if ( ( $allow_charset_search =~ /^y\n/i ) || ( ( $allow_charset_search =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2462 $allow_charset_search = 'true';
2464 $allow_charset_search = 'false';
2466 return $allow_charset_search;
2469 # command315 (UID support) obsoleted.
2471 # advanced search option
2473 print "This option allows you to control the use of advanced search form.\n";
2474 print " 0 = enable basic search only\n";
2475 print " 1 = enable advanced search only\n";
2476 print " 2 = enable both\n";
2479 print "Allowed search (0,1,2)? [$WHT$allow_advanced_search$NRM]: $WHT";
2480 $new_allow_advanced_search = <STDIN
>;
2481 if ( $new_allow_advanced_search =~ /^[012]\n/i ) {
2482 $allow_advanced_search = $new_allow_advanced_search;
2484 $allow_advanced_search =~ s/[\r\n]//g;
2485 return $allow_advanced_search;
2490 print "This option allows you to change the name of the PHP session used\n";
2491 print "by SquirrelMail. Unless you know what you are doing, you probably\n";
2492 print "don't need or want to change this from the default of SQMSESSID.\n";
2493 print "[$WHT$session_name$NRM]: $WHT";
2494 $new_session_name = <STDIN
>;
2495 chomp($new_session_name);
2496 if ( $new_session_name eq "" ) {
2497 $new_session_name = $session_name;
2499 return $new_session_name;
2502 # time zone config (since 1.5.1)
2504 print "This option allows you to control the use of time zones.\n";
2505 print " 0 = (default) standard, GNU C time zone names\n";
2506 print " 1 = strict, generic time zone codes with offsets\n";
2507 print " 2 = custom, GNU C time zones loaded from config/timezones.php\n";
2508 print " 3 = custom strict, generic time zone codes with offsets loaded \n";
2509 print " from config/timezones.php\n";
2510 print "See SquirrelMail documentation about format of config/timezones.php file.\n";
2513 print "Used time zone configuration (0,1,2,3)? [$WHT$time_zone_type$NRM]: $WHT";
2514 $new_time_zone_type = <STDIN
>;
2515 if ( $new_time_zone_type =~ /^[0123]\n/i ) {
2516 $time_zone_type = $new_time_zone_type;
2518 print "\nInvalid configuration value.\n";
2519 print "\nPress enter to continue...";
2522 $time_zone_type =~ s/[\r\n]//g;
2523 return $time_zone_type;
2526 # set the location base for redirects (since 1.5.2)
2527 sub command_config_location_base
{
2528 print "Here you can set the base part of the SquirrelMail URL.\n";
2529 print "It is normally autodetected but if that fails, use this\n";
2530 print "option to override.\n";
2531 print "It should contain only the protocol and hostname/port parts\n";
2532 print "of the URL; the full path will be appended automatically.\n\n";
2533 print "Examples:\nhttp://webmail.example.org\nhttp://webmail.example.com:8080\nhttps://webmail.example.com:6691\n\n";
2534 print "Do not add any path elements.\n";
2536 print "URL base? [" .$WHT."autodetect$NRM]: $WHT";
2537 $new_config_location_base = <STDIN
>;
2538 chomp($new_config_location_base);
2539 $config_location_base = $new_config_location_base;
2541 return $config_location_base;
2547 print "\nDefine the themes that you wish to use. If you have added ";
2548 print "a theme of your own, just follow the instructions (?) about how to add ";
2549 print "them. You can also change the default theme.\n";
2550 print "[theme] command (?=help) > ";
2552 $input =~ s/[\r\n]//g;
2553 while ( $input ne "d" ) {
2554 if ( $input =~ /^\s*l\s*/i ) {
2556 while ( $count <= $#theme_name ) {
2557 if ( $count == $theme_default ) {
2562 if ( $count < 10 ) {
2565 $name = $theme_name[$count];
2566 $num_spaces = 35 - length($name);
2567 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2568 $name = $name . " ";
2571 print " $count. $name";
2572 print "($theme_path[$count])\n";
2576 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2577 $old_def = $theme_default;
2578 $theme_default = $input;
2579 $theme_default =~ s/^\s*m\s*//;
2580 if ( ( $theme_default > $#theme_name ) || ( $theme_default < 0 ) ) {
2581 print "Cannot set default theme to $theme_default. That theme does not exist.\n";
2582 $theme_default = $old_def;
2584 } elsif ( $input =~ /^\s*\+/ ) {
2585 print "What is the name of this theme: ";
2587 $name =~ s/[\r\n]//g;
2588 $theme_name[ $#theme_name + 1 ] = $name;
2589 print "Be sure to put ../themes/ before the filename.\n";
2590 print "What file is this stored in (ex: ../themes/default_theme.php): ";
2592 $name =~ s/[\r\n]//g;
2593 $theme_path[ $#theme_path + 1 ] = $name;
2594 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2595 if ( $input =~ /[0-9]+\s*$/ ) {
2597 $rem_num =~ s/^\s*-\s*//g;
2598 $rem_num =~ s/\s*$//;
2600 $rem_num = $#theme_name;
2602 if ( $rem_num == $theme_default ) {
2603 print "You cannot remove the default theme!\n";
2606 @new_theme_name = ();
2607 @new_theme_path = ();
2608 while ( $count <= $#theme_name ) {
2609 if ( $count != $rem_num ) {
2610 @new_theme_name = ( @new_theme_name, $theme_name[$count] );
2611 @new_theme_path = ( @new_theme_path, $theme_path[$count] );
2615 @theme_name = @new_theme_name;
2616 @theme_path = @new_theme_path;
2617 if ( $theme_default > $rem_num ) {
2621 } elsif ( $input =~ /^\s*t\s*/i ) {
2622 print "\nStarting detection...\n\n";
2624 opendir( DIR
, "../themes" );
2625 @files = grep { /\.php$/i } readdir(DIR
);
2627 while ( $cnt <= $#files ) {
2628 $filename = "../themes/" . $files[$cnt];
2629 if ( $filename ne "../themes/index.php" ) {
2631 for ( $x = 0 ; $x <= $#theme_path ; $x++ ) {
2632 if ( $theme_path[$x] eq $filename ) {
2636 if ( $found != 1 ) {
2637 print "** Found theme: $filename\n";
2638 print " What is its name? ";
2641 $theme_name[ $#theme_name + 1 ] = $nm;
2642 $theme_path[ $#theme_path + 1 ] = $filename;
2648 for ( $cnt = 0 ; $cnt <= $#theme_path ; $cnt++ ) {
2649 $filename = $theme_path[$cnt];
2650 if ( !( -e
$filename ) ) {
2651 print " Removing $filename (file not found)\n";
2653 @new_theme_name = ();
2654 @new_theme_path = ();
2655 for ( $x = 0 ; $x < $#theme_path ; $x++ ) {
2656 if ( $theme_path[$x] eq $filename ) {
2659 if ( $offset == 1 ) {
2660 $new_theme_name[$x] = $theme_name[ $x + 1 ];
2661 $new_theme_path[$x] = $theme_path[ $x + 1 ];
2663 $new_theme_name[$x] = $theme_name[$x];
2664 $new_theme_path[$x] = $theme_path[$x];
2667 @theme_name = @new_theme_name;
2668 @theme_path = @new_theme_path;
2671 print "\nDetection complete!\n\n";
2674 } elsif ( $input =~ /^\s*\?\s*/ ) {
2675 print ".-------------------------.\n";
2676 print "| t (detect themes) |\n";
2677 print "| + (add theme) |\n";
2678 print "| - N (remove theme) |\n";
2679 print "| m N (mark default) |\n";
2680 print "| l (list themes) |\n";
2681 print "| d (done) |\n";
2682 print "`-------------------------'\n";
2684 print "[theme] command (?=help) > ";
2686 $input =~ s/[\r\n]//g;
2690 sub command_templates
{
2691 print "\nDefine the template sets that you wish to use. If you have added ";
2692 print "a template set of your own, just follow the instructions (?) about how to add ";
2693 print "them. You can also change the default template.\n";
2695 print "\n Available Templates:\n";
2698 while ( $count <= $#templateset_name ) {
2699 if ( $count == $templateset_default ) {
2704 if ( $count < 10 ) {
2707 $name = $templateset_name[$count];
2708 $num_spaces = 35 - length($name);
2709 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2710 $name = $name . " ";
2713 print " $count. $name";
2714 print "($templateset_id[$count])\n";
2719 # FIXME: what is this stuff? it is commented out, can we just blast it?
2720 # opendir( DIR, "../templates" );
2721 # @files = readdir(DIR);
2724 # while ( $cnt <= $#files ) {
2725 # if ( -d "../templates/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne "CVS" ) {
2726 # $filename = "../templates/" . $files[$cnt];
2728 # for ( $x = 0 ; $x <= $#templateset_id ; $x++ ) {
2729 # if ( $theme_path[$x] eq $filename ) {
2736 # for ( $i = 0 ; $i <= $#files ; $i++ ) {
2737 # if ( -d "../templates/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne "CVS" ) {
2739 # for ( $k = 0 ; $k <= $#aTemplateSets ; $k++ ) {
2740 # if ( $aTemplateSets[$chosen] eq $files[$i] ) {
2744 # if ( $match == 0 ) {
2745 # $unused_plugins[$pos] = $files[$i];
2751 # for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
2753 # print " $num. $unused_plugins[$i]\n";
2757 $menu_text = ".-------------------------------------.\n"
2758 . "| t (detect templates set) |\n"
2759 . "| + (add template set) |\n"
2760 . "| - N (remove template set) |\n"
2761 . "| m N (mark default template set) |\n"
2762 . "| l (list template sets) |\n"
2764 . "|-------------------------------------|\n"
2765 . "| where N is a template set number |\n"
2766 . "`-------------------------------------'\n";
2769 print "\n[template set] command (?=help) > ";
2772 $input =~ s/[\r\n]//g;
2773 while ( $input ne "d" ) {
2775 # list template sets
2777 if ( $input =~ /^\s*l\s*/i ) {
2779 while ( $count <= $#templateset_name ) {
2780 if ( $count == $templateset_default ) {
2785 if ( $count < 10 ) {
2788 $name = $templateset_name[$count];
2789 $num_spaces = 35 - length($name);
2790 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2791 $name = $name . " ";
2794 print " $count. $name";
2795 print "($templateset_id[$count])\n";
2800 # mark default template set
2802 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2803 $old_def = $templateset_default;
2804 $templateset_default = $input;
2805 $templateset_default =~ s/^\s*m\s*//;
2806 if ( ( $templateset_default > $#templateset_name ) || ( $templateset_default < 0 ) ) {
2807 print "Cannot set default template set to $templateset_default. That template set does not exist.\n";
2808 $templateset_default = $old_def;
2813 } elsif ( $input =~ /^\s*\+/ ) {
2814 print "\nWhat is the name of this template (as shown to your users): ";
2816 $name =~ s/[\r\n]//g;
2817 $templateset_name[ $#templateset_name + 1 ] = $name;
2818 print "\n\nThe directory name should not contain any path information\n"
2819 . "or slashes, and should be the name of the directory that the\n"
2820 . "template set is found in within the SquirrelMail templates\n"
2822 print "What directory is this stored in (ex: default_advanced): ";
2824 $name =~ s/[\r\n]//g;
2825 $templateset_id[ $#templateset_id + 1 ] = $name;
2827 # detect template sets
2829 } elsif ( $input =~ /^\s*t\s*/i ) {
2830 print "\nStarting detection...\n\n";
2831 opendir( DIR
, "../templates" );
2832 @files = readdir(DIR
);
2834 while ( $cnt <= $#files ) {
2835 if ( -d
"../templates/" . $files[$cnt] && $files[$cnt] !~ /^\./ && $files[$cnt] ne "CVS" ) {
2836 $filename = $files[$cnt];
2838 for ( $x = 0 ; $x <= $#templateset_id ; $x++ ) {
2839 if ( $templateset_id[$x] eq $filename ) {
2845 print "** Found template set: $filename\n";
2846 print " What is it's name (as shown to your users)? ";
2849 $templateset_id[ $#templateset_id + 1 ] = $filename;
2850 $templateset_name[ $#templateset_name + 1 ] = $nm;
2851 # FIXME: why are these two lines here?
2852 # $aTemplateSet[ $#templateset_name + 1 ] = $nm;
2853 # $aTemplateSet[ $#templateset_id + 1 ] = $filename;
2859 for ( $cnt= 0 ; $cnt <= $#templateset_id ; ) {
2860 $filename = $templateset_id[$cnt];
2861 if ( !(-d change_to_rel_path
('SM_PATH . \'templates/' . $filename)) ) {
2862 print " Removing \"$filename\" (template set directory not found)\n";
2863 if ( $templateset_default gt $cnt ) { $templateset_default--; }
2864 elsif ( $templateset_default eq $cnt ) { $templateset_default = 0; }
2866 @new_templateset_name = ();
2867 @new_templateset_id = ();
2868 for ( $x = 0 ; $x < $#templateset_id ; $x++ ) {
2869 if ( $templateset_id[$x] eq $filename ) {
2872 if ( $offset == 1 ) {
2873 $new_templateset_name[$x] = $templateset_name[ $x + 1 ];
2874 $new_templateset_id[$x] = $templateset_id[ $x + 1 ];
2876 $new_templateset_name[$x] = $templateset_name[$x];
2877 $new_templateset_id[$x] = $templateset_id[$x];
2880 @templateset_name = @new_templateset_name;
2881 @templateset_id = @new_templateset_id;
2884 print "\nDetection complete!\n\n";
2888 # remove template set
2890 # undocumented functionality of removing last template set isn't that great
2891 #} elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2892 } elsif ( $input =~ /^\s*-\s*[0-9]+/ ) {
2893 if ( $input =~ /[0-9]+\s*$/ ) {
2895 $rem_num =~ s/^\s*-\s*//g;
2896 $rem_num =~ s/\s*$//;
2898 $rem_num = $#templateset_name;
2900 if ( $rem_num == $templateset_default ) {
2901 print "You cannot remove the default template set!\n";
2904 @new_templateset_name = ();
2905 @new_templateset_id = ();
2906 while ( $count <= $#templateset_name ) {
2907 if ( $count != $rem_num ) {
2908 @new_templateset_name = ( @new_templateset_name, $templateset_name[$count] );
2909 @new_templateset_id = ( @new_templateset_id, $templateset_id[$count] );
2913 @templateset_name = @new_templateset_name;
2914 @templateset_id = @new_templateset_id;
2915 if ( $templateset_default > $rem_num ) {
2916 $templateset_default--;
2922 } elsif ( $input =~ /^\s*\?\s*/ ) {
2925 print "[template set] command (?=help) > ";
2927 $input =~ s/[\r\n]//g;
2929 return $templateset_default;
2935 print "You may specify a cascading style-sheet (CSS) file to be included\n";
2936 print "on each html page generated by SquirrelMail. The CSS file is useful\n";
2937 print "for specifying a site-wide font. If you're not familiar with CSS\n";
2938 print "files, leave this blank.\n";
2940 print "To clear out an existing value, just type a space for the input.\n";
2942 print "Please be aware of the following: \n";
2943 print " - Relative URLs are relative to the config dir\n";
2944 print " to use the themes directory, use ../themes/css/newdefault.css\n";
2945 print " - To specify a css file defined outside the SquirrelMail source tree\n";
2946 print " use the absolute URL the webserver would use to include the file\n";
2947 print " e.g. http://some.host.com/css/mystyle.css or /css/mystyle.css\n";
2949 print "[$WHT$theme_css$NRM]: $WHT";
2950 $new_theme_css = <STDIN
>;
2952 if ( $new_theme_css eq "\n" ) {
2953 $new_theme_css = $theme_css;
2955 $new_theme_css =~ s/[\r\n]//g;
2957 $new_theme_css =~ s/^\s*//;
2958 return $new_theme_css;
2961 # sets default font size option
2962 sub command_default_fontsize
{
2963 print "Enter default font size [$WHT$$default_fontsize$NRM]: $WHT";
2964 $new_size = <STDIN
>;
2965 if ( $new_size eq "\n" ) {
2968 $new_size =~ s/[\r\n]//g;
2973 # controls available fontsets
2974 sub command_fontsets
{
2976 print "You can control fontsets available to end users here.\n";
2977 # set initial $input value
2979 while ( $input ne "x" ) {
2980 if ( $input =~ /^\s*a\s*/i ) {
2982 print "\nFontset name: ";
2984 if (! $fontsets{trim
($name)}) {
2985 print "Fontset string: ";
2987 $fontsets{trim
($name)} = trim
($value);
2989 print "\nERROR: Such fontset already exists.\n";
2991 } elsif ( $input =~ /^\s*e\s*/i ) {
2992 # edit existing fontset
2993 print "\nFontset name: ";
2995 if (! $fontsets{trim
($name)}) {
2996 print "\nERROR: No such fontset.\n";
2998 print "Fontset string [$fontsets{trim($name)}]: ";
3000 $fontsets{trim
($name)} = trim
($value);
3002 } elsif ( $input =~ /^\s*d\s*/ ) {
3003 # delete existing fontset
3004 print "\nFontset name: ";
3006 if (! $fontsets{trim
($name)}) {
3007 print "\nERROR: No such fontset.\n";
3009 delete $fontsets{trim
($name)};
3011 } elsif ( $input =~ /^\s*l\s*/ ) {
3013 print "\nConfigured fontsets:\n";
3014 while (($fontset_name, $fontset_string) = each(%fontsets)) {
3015 print " $fontset_name = $fontset_string\n";
3017 print "Default fontset: $default_fontset\n";
3018 } elsif ( $input =~ /^\s*m\s*/ ) {
3019 # set default fontset
3020 print "\nSet default fontset [$default_fontset]: ";
3022 if (trim
($name) ne '' and ! $fontsets{trim
($name)}) {
3023 print "\nERROR: No such fontset.\n";
3025 $default_fontset = trim
($name);
3028 # print available commands on any other input
3029 print "\nAvailable commands:\n";
3030 print " a - Adds new fontset.\n";
3031 print " d - Deletes existing fontset.\n";
3032 print " e - Edits existing fontset.\n";
3033 print " h or ? - Shows this help screen.\n";
3034 print " l - Lists available fontsets.\n";
3035 print " m - Sets default fontset.\n";
3036 print " x - Exits fontset editor mode.\n";
3038 print "\nCommand [fontsets] (a,d,e,h,?=help,l,m,x)> ";
3040 $input =~ s/[\r\n]//g;
3045 print "You can now define different LDAP servers.\n";
3046 print "Please ensure proper permissions for config.php when including\n";
3047 print "sensitive passwords.\n\n";
3048 print "[ldap] command (?=help) > ";
3050 $input =~ s/[\r\n]//g;
3051 while ( $input ne "d" ) {
3052 if ( $input =~ /^\s*l\s*/i ) {
3054 while ( $count <= $#ldap_host ) {
3055 print "$count. $ldap_host[$count]\n";
3056 print " base: $ldap_base[$count]\n";
3057 if ( $ldap_charset[$count] ) {
3058 print " charset: $ldap_charset[$count]\n";
3060 if ( $ldap_port[$count] ) {
3061 print " port: $ldap_port[$count]\n";
3063 if ( $ldap_name[$count] ) {
3064 print " name: $ldap_name[$count]\n";
3066 if ( $ldap_maxrows[$count] ) {
3067 print " maxrows: $ldap_maxrows[$count]\n";
3069 if ( $ldap_filter[$count] ) {
3070 print " filter: $ldap_filter[$count]\n";
3072 if ( $ldap_binddn[$count] ) {
3073 print " binddn: $ldap_binddn[$count]\n";
3074 if ( $ldap_bindpw[$count] ) {
3075 print " bindpw: $ldap_bindpw[$count]\n";
3078 if ( $ldap_protocol[$count] ) {
3079 print " protocol: $ldap_protocol[$count]\n";
3081 if ( $ldap_limit_scope[$count] ) {
3082 print " limit_scope: $ldap_limit_scope[$count]\n";
3084 if ( $ldap_listing[$count] ) {
3085 print " listing: $ldap_listing[$count]\n";
3087 if ( $ldap_writeable[$count] ) {
3088 print " writeable: $ldap_writeable[$count]\n";
3090 if ( $ldap_search_tree[$count] ) {
3091 print " search_tree: $ldap_search_tree[$count]\n";
3093 if ( $ldap_starttls[$count] ) {
3094 print " starttls: $ldap_starttls[$count]\n";
3100 } elsif ( $input =~ /^\s*\+/ ) {
3101 $sub = $#ldap_host + 1;
3103 print "First, we need to have the hostname or the IP address where\n";
3104 print "this LDAP server resides. Example: ldap.bigfoot.com\n";
3106 print "You can use any URI compatible with your LDAP library. Please\n";
3107 print "note that StartTLS option is not compatible with ldaps and\n";
3108 print "ldapi URIs.\n";
3111 $name =~ s/[\r\n]//g;
3112 $ldap_host[$sub] = $name;
3116 print "Next, we need the server root (base dn). For this, an empty\n";
3117 print "string is allowed.\n";
3118 print "Example: ou=member_directory,o=netcenter.com\n";