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.5.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 # Make sure that file is readable
50 if (! -r
"config.php") {
53 print "The file \"config/config.php\" was found, but you don't\n";
54 print "have rights to read it.\n";
56 print "Press enter to continue";
60 open( FILE
, "config.php" );
61 while ( $line = <FILE
> ) {
67 if ( $var =~ /^([a-z])/i ) {
68 @o = split ( /\s*EQUALS\s*/, $var );
69 if ( $o[0] eq "config_version" ) {
71 $o[1] =~ s/[\'\"];\s*$//;
75 $config_version = $o[1];
82 if ( $config_version ne $conf_pl_version ) {
85 print " The file \"config/config.php\" was found, but it is for\n";
86 print " an older version of SquirrelMail. It is possible to still\n";
87 print " read the defaults from this file but be warned that many\n";
88 print " preferences change between versions. It is recommended that\n";
89 print " you start with a clean config.php for each upgrade that you\n";
90 print " do. To do this, just move config/config.php out of the way.\n";
92 print "Continue loading with the old config.php [y/N]? ";
95 if ( ( $ctu !~ /^y\n/i ) || ( $ctu =~ /^\n/ ) ) {
99 print "\nDo you want me to stop warning you [y/N]? ";
101 if ( $ctu =~ /^y\n/i ) {
102 $print_config_version = $conf_pl_version;
104 $print_config_version = $config_version;
107 $print_config_version = $config_version;
111 open( FILE
, "config.php" );
112 } elsif ( -e
"config_default.php" ) {
113 open( FILE
, "config_default.php" );
114 while ( $line = <FILE
> ) {
120 if ( $var =~ /^([a-z])/i ) {
121 @o = split ( /\s*EQUALS\s*/, $var );
122 if ( $o[0] eq "config_version" ) {
123 $o[1] =~ s/[\n\r]//g;
124 $o[1] =~ s/[\'\"];\s*$//;
126 $o[1] =~ s/^[\'\"]//;
128 $config_version = $o[1];
135 if ( $config_version ne $conf_pl_version ) {
138 print " You are trying to use a 'config_default.php' from an older\n";
139 print " version of SquirrelMail. This is HIGHLY unrecommended. You\n";
140 print " should get the 'config_default.php' that matches the version\n";
141 print " of SquirrelMail that you are running. You can get this from\n";
142 print " the SquirrelMail web page by going to the following URL:\n";
143 print " http://www.squirrelmail.org.\n";
145 print "Continue loading with old config_default.php (a bad idea) [y/N]? ";
148 if ( ( $ctu !~ /^y\n/i ) || ( $ctu =~ /^\n/ ) ) {
152 print "\nDo you want me to stop warning you [y/N]? ";
154 if ( $ctu =~ /^y\n/i ) {
155 $print_config_version = $conf_pl_version;
157 $print_config_version = $config_version;
160 $print_config_version = $config_version;
163 open( FILE
, "config_default.php" );
165 print "No configuration file found. Please get config_default.php\n";
166 print "or config.php before running this again. This program needs\n";
167 print "a default config file to get default values.\n";
171 # Read and parse the current configuration file
172 # (either config.php or config_default.php).
173 while ( $line = <FILE
> ) {
179 if ( $var =~ /^([a-z])/i ) {
180 @options = split ( /\s*EQUALS\s*/, $var );
181 $options[1] =~ s/[\n\r]//g;
182 $options[1] =~ s/[\'\"];\s*$//;
183 $options[1] =~ s/;$//;
184 $options[1] =~ s/^[\'\"]//;
185 # de-escape escaped strings
186 $options[1] =~ s/\\'/'/g;
187 $options[1] =~ s/\\\\/\\/g;
189 if ( $options[0] =~ /^user_themes\[[0-9]+\]\[['"]PATH['"]\]/ ) {
191 $sub =~ s/\]\[['"]PATH['"]\]//;
193 if ( -e
"../css/" ) {
194 $options[1] =~ s/^\.\.\/config/\
.\
.\
/css/;
196 $user_theme_path[$sub] = &change_to_rel_path
($options[1]);
197 } elsif ( $options[0] =~ /^user_themes\[[0-9]+\]\[['"]NAME['"]\]/ ) {
199 $sub =~ s/\]\[['"]NAME['"]\]//;
201 $user_theme_name[$sub] = $options[1];
202 } elsif ( $options[0] =~ /^icon_themes\[[0-9]+\]\[['"]PATH['"]\]/ ) {
204 $sub =~ s/\]\[['"]PATH['"]\]//;
206 if ( -e
"../images/" ) {
207 $options[1] =~ s/^\.\.\/config/\
.\
.\
/images/;
209 $icon_theme_path[$sub] = &change_to_rel_path
($options[1]);
210 } elsif ( $options[0] =~ /^icon_themes\[[0-9]+\]\[['"]NAME['"]\]/ ) {
212 $sub =~ s/\]\[['"]NAME['"]\]//;
214 $icon_theme_name[$sub] = $options[1];
215 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]ID['"]\]/ ) {
217 $sub =~ s/\]\[['"]ID['"]\]//;
219 if ( -e
"../templates" ) {
220 $options[1] =~ s/^\.\.\/config/\
.\
.\
/templates/;
222 $templateset_id[$sub] = $options[1];
223 ##### FIXME: This section BELOW here so old prefs files don't blow up when running conf.pl
224 ##### Remove after a month or two
225 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]PATH['"]\]/ ) {
227 $sub =~ s/\]\[['"]PATH['"]\]//;
229 if ( -e
"../templates" ) {
230 $options[1] =~ s/^\.\.\/config/\
.\
.\
/templates/;
232 $templateset_id[$sub] = $options[1];
233 ##### FIXME: This section ABOVE here so old prefs files don't blow up when running conf.pl
234 ##### Remove after a month or two
235 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]NAME['"]\]/ ) {
237 $sub =~ s/\]\[['"]NAME['"]\]//;
239 $templateset_name[$sub] = $options[1];
240 } elsif ( $options[0] =~ /^plugins\[[0-9]*\]/ ) {
243 $sub =~ s/^plugins\[//;
245 push @plugins, $options[1];
247 $plugins[$sub] = $options[1];
249 } elsif ($options[0] =~ /^fontsets\[\'[a-z]*\'\]/) {
250 # parse associative $fontsets array
253 $sub =~ s/^fontsets\[\'//;
254 $fontsets{$sub} = $options[1];
255 } elsif ( $options[0] =~ /^theme\[[0-9]+\]\[['"]PATH|NAME['"]\]/ ) {
257 ## $color themes are no longer supported. Please leave this
258 ## so conf.pl doesn't barf if it encounters a $theme.
260 } elsif ( $options[0] =~ /^ldap_server\[[0-9]+\]/ ) {
263 $sub =~ s/^ldap_server\[//;
265 while ( ( $tmp = <FILE
> ) && ( $continue != 1 ) ) {
266 if ( $tmp =~ /\);\s*$/ ) {
270 if ( $tmp =~ /^\s*[\'\"]host[\'\"]/i ) {
271 $tmp =~ s/^\s*[\'\"]host[\'\"]\s*=>\s*[\'\"]//i;
272 $tmp =~ s/[\'\"],?\s*$//;
273 $tmp =~ s/[\'\"]\);\s*$//;
275 } elsif ( $tmp =~ /^\s*[\'\"]base[\'\"]/i ) {
276 $tmp =~ s/^\s*[\'\"]base[\'\"]\s*=>\s*[\'\"]//i;
277 $tmp =~ s/[\'\"],?\s*$//;
278 $tmp =~ s/[\'\"]\);\s*$//;
280 } elsif ( $tmp =~ /^\s*[\'\"]charset[\'\"]/i ) {
281 $tmp =~ s/^\s*[\'\"]charset[\'\"]\s*=>\s*[\'\"]//i;
282 $tmp =~ s/[\'\"],?\s*$//;
283 $tmp =~ s/[\'\"]\);\s*$//;
285 } elsif ( $tmp =~ /^\s*[\'\"]port[\'\"]/i ) {
286 $tmp =~ s/^\s*[\'\"]port[\'\"]\s*=>\s*[\'\"]?//i;
287 $tmp =~ s/[\'\"]?,?\s*$//;
288 $tmp =~ s/[\'\"]?\);\s*$//;
290 } elsif ( $tmp =~ /^\s*[\'\"]maxrows[\'\"]/i ) {
291 $tmp =~ s/^\s*[\'\"]maxrows[\'\"]\s*=>\s*[\'\"]?//i;
292 $tmp =~ s/[\'\"]?,?\s*$//;
293 $tmp =~ s/[\'\"]?\);\s*$//;
295 } elsif ( $tmp =~ /^\s*[\'\"]filter[\'\"]/i ) {
296 $tmp =~ s/^\s*[\'\"]filter[\'\"]\s*=>\s*[\'\"]?//i;
297 $tmp =~ s/[\'\"]?,?\s*$//;
298 $tmp =~ s/[\'\"]?\);\s*$//;
300 } elsif ( $tmp =~ /^\s*[\'\"]name[\'\"]/i ) {
301 $tmp =~ s/^\s*[\'\"]name[\'\"]\s*=>\s*[\'\"]//i;
302 $tmp =~ s/[\'\"],?\s*$//;
303 $tmp =~ s/[\'\"]\);\s*$//;
305 } elsif ( $tmp =~ /^\s*[\'\"]binddn[\'\"]/i ) {
306 $tmp =~ s/^\s*[\'\"]binddn[\'\"]\s*=>\s*[\'\"]//i;
307 $tmp =~ s/[\'\"],?\s*$//;
308 $tmp =~ s/[\'\"]\);\s*$//;
310 } elsif ( $tmp =~ /^\s*[\'\"]bindpw[\'\"]/i ) {
311 $tmp =~ s/^\s*[\'\"]bindpw[\'\"]\s*=>\s*[\'\"]//i;
312 $tmp =~ s/[\'\"],?\s*$//;
313 $tmp =~ s/[\'\"]\);\s*$//;
315 } elsif ( $tmp =~ /^\s*[\'\"]protocol[\'\"]/i ) {
316 $tmp =~ s/^\s*[\'\"]protocol[\'\"]\s*=>\s*[\'\"]?//i;
317 $tmp =~ s/[\'\"]?,?\s*$//;
318 $tmp =~ s/[\'\"]?\);\s*$//;
320 } elsif ( $tmp =~ /^\s*[\'\"]limit_scope[\'\"]/i ) {
321 $tmp =~ s/^\s*[\'\"]limit_scope[\'\"]\s*=>\s*[\'\"]?//i;
322 $tmp =~ s/[\'\"]?,?\s*$//;
323 $tmp =~ s/[\'\"]?\);\s*$//;
325 } elsif ( $tmp =~ /^\s*[\'\"]listing[\'\"]/i ) {
326 $tmp =~ s/^\s*[\'\"]listing[\'\"]\s*=>\s*[\'\"]?//i;
327 $tmp =~ s/[\'\"]?,?\s*$//;
328 $tmp =~ s/[\'\"]?\);\s*$//;
330 } elsif ( $tmp =~ /^\s*[\'\"]writeable[\'\"]/i ) {
331 $tmp =~ s/^\s*[\'\"]writeable[\'\"]\s*=>\s*[\'\"]?//i;
332 $tmp =~ s/[\'\"]?,?\s*$//;
333 $tmp =~ s/[\'\"]?\);\s*$//;
335 } elsif ( $tmp =~ /^\s*[\'\"]search_tree[\'\"]/i ) {
336 $tmp =~ s/^\s*[\'\"]search_tree[\'\"]\s*=>\s*[\'\"]?//i;
337 $tmp =~ s/[\'\"]?,?\s*$//;
338 $tmp =~ s/[\'\"]?\);\s*$//;
340 } elsif ( $tmp =~ /^\s*[\'\"]starttls[\'\"]/i ) {
341 $tmp =~ s/^\s*[\'\"]starttls[\'\"]\s*=>\s*[\'\"]?//i;
342 $tmp =~ s/[\'\"]?,?\s*$//;
343 $tmp =~ s/[\'\"]?\);\s*$//;
347 $ldap_host[$sub] = $host;
348 $ldap_base[$sub] = $base;
349 $ldap_name[$sub] = $name;
350 $ldap_port[$sub] = $port;
351 $ldap_maxrows[$sub] = $maxrows;
352 $ldap_filter[$sub] = $filter;
353 $ldap_charset[$sub] = $charset;
354 $ldap_binddn[$sub] = $binddn;
355 $ldap_bindpw[$sub] = $bindpw;
356 $ldap_protocol[$sub] = $protocol;
357 $ldap_limit_scope[$sub] = $limit_scope;
358 $ldap_listing[$sub] = $listing;
359 $ldap_writeable[$sub] = $writeable;
360 $ldap_search_tree[$sub] = $search_tree;
361 $ldap_starttls[$sub] = $starttls;
362 } elsif ( $options[0] =~ /^(data_dir|attachment_dir|org_logo|signout_page|icon_theme_def)$/ ) {
363 ${ $options[0] } = &change_to_rel_path
($options[1]);
365 ${ $options[0] } = $options[1];
371 # FIXME: unknown introduction date
372 $useSendmail = 'false' if ( lc($useSendmail) ne 'true' );
373 $sendmail_path = "/usr/sbin/sendmail" if ( !$sendmail_path );
374 $pop_before_smtp = 'false' if ( !$pop_before_smtp );
375 $default_unseen_notify = 2 if ( !$default_unseen_notify );
376 $default_unseen_type = 1 if ( !$default_unseen_type );
377 $config_use_color = 0 if ( !$config_use_color );
378 $invert_time = 'false' if ( !$invert_time );
379 $force_username_lowercase = 'false' if ( !$force_username_lowercase );
380 $optional_delimiter = "detect" if ( !$optional_delimiter );
381 $auto_create_special = 'false' if ( !$auto_create_special );
382 $default_use_priority = 'true' if ( !$default_use_priority );
383 $default_use_mdn = 'true' if ( !$default_use_mdn );
384 $delete_folder = 'false' if ( !$delete_folder );
385 $noselect_fix_enable = 'false' if ( !$noselect_fix_enable );
386 $frame_top = "_top" if ( !$frame_top );
387 $provider_uri = '' if ( !$provider_uri );
388 $provider_name = '' if ( !$provider_name );
389 $no_list_for_subscribe = 'false' if ( !$no_list_for_subscribe );
390 $allow_charset_search = 'true' if ( !$allow_charset_search );
391 $allow_advanced_search = 0 if ( !$allow_advanced_search) ;
392 $prefs_user_field = 'user' if ( !$prefs_user_field );
393 $prefs_key_field = 'prefkey' if ( !$prefs_key_field );
394 $prefs_val_field = 'prefval' if ( !$prefs_val_field );
395 $session_name = 'SQMSESSID' if ( !$session_name );
396 $skip_SM_header = 'false' if ( !$skip_SM_header );
397 $default_use_javascript_addr_book = 'false' if (! $default_use_javascript_addr_book);
400 $hide_sm_attributions = 'false' if ( !$hide_sm_attributions );
402 $edit_identity = 'true' if ( !$edit_identity );
403 $edit_name = 'true' if ( !$edit_name );
406 $use_smtp_tls= 'false' if ( !$use_smtp_tls);
407 $smtp_auth_mech = 'none' if ( !$smtp_auth_mech );
408 $use_imap_tls = 'false' if ( !$use_imap_tls );
409 $imap_auth_mech = 'login' if ( !$imap_auth_mech );
412 $show_alternative_names = 'false' if ( !$show_alternative_names );
413 # $available_languages option available only in 1.5.0. removed due to $languages
414 # implementation changes. options are provided by limit_languages plugin
415 # $available_languages = 'all' if ( !$available_languages );
416 $aggressive_decoding = 'false' if ( !$aggressive_decoding );
417 # available only in 1.5.0 and 1.5.1
418 # $advanced_tree = 'false' if ( !$advanced_tree );
419 $use_php_recode = 'false' if ( !$use_php_recode );
420 $use_php_iconv = 'false' if ( !$use_php_iconv );
423 $use_icons = 'false' if ( !$use_icons );
424 $use_iframe = 'false' if ( !$use_iframe );
425 $lossy_encoding = 'false' if ( !$lossy_encoding );
426 $allow_remote_configtest = 'false' if ( !$allow_remote_configtest );
427 $addrbook_global_table = 'global_abook' if ( !$addrbook_global_table );
428 $addrbook_global_writeable = 'false' if ( !$addrbook_global_writeable );
429 $addrbook_global_listing = 'false' if ( !$addrbook_global_listing );
430 $abook_global_file = '' if ( !$abook_global_file);
431 $abook_global_file_writeable = 'false' if ( !$abook_global_file_writeable);
432 $abook_global_file_listing = 'true' if ( !$abook_global_file_listing );
433 $encode_header_key = '' if ( !$encode_header_key );
434 $hide_auth_header = 'false' if ( !$hide_auth_header );
435 $time_zone_type = '0' if ( !$time_zone_type );
436 $prefs_user_size = 128 if ( !$prefs_user_size );
437 $prefs_key_size = 64 if ( !$prefs_key_size );
438 $prefs_val_size = 65536 if ( !$prefs_val_size );
440 # add qmail-inject test here for backwards compatibility
441 if ( !$sendmail_args && $sendmail_path =~ /qmail-inject/ ) {
443 } elsif ( !$sendmail_args ) {
444 $sendmail_args = '-i -t';
447 $default_fontsize = '' if ( !$default_fontsize);
448 $default_fontset = '' if ( !$default_fontset);
450 %fontsets = ('serif', 'serif',
451 'sans', 'helvetica,arial,sans-serif',
452 'comicsans', 'comic sans ms,sans-serif',
453 'tahoma', 'tahoma,sans-serif',
454 'verasans', 'bitstream vera sans,verdana,sans-serif');
457 # $use_imap_tls and $use_smtp_tls are switched to integer since 1.5.1
458 $use_imap_tls = 0 if ( $use_imap_tls eq 'false');
459 $use_imap_tls = 1 if ( $use_imap_tls eq 'true');
460 $use_smtp_tls = 0 if ( $use_smtp_tls eq 'false');
461 $use_smtp_tls = 1 if ( $use_smtp_tls eq 'true');
462 # sorting options changed names and reversed values in 1.5.1
463 $disable_thread_sort = 'false' if ( !$disable_thread_sort );
464 $disable_server_sort = 'false' if ( !$disable_server_sort );
467 $abook_file_line_length = 2048 if ( !$abook_file_line_length );
468 $config_location_base = '' if ( !$config_location_base );
469 $smtp_sitewide_user = '' if ( !$smtp_sitewide_user );
470 $smtp_sitewide_pass = '' if ( !$smtp_sitewide_pass );
471 $icon_theme_def = '' if ( !$icon_theme_def );
472 $disable_plugins = 'false' if ( !$disable_plugins );
473 $disable_plugins_user = '' if ( !$disable_plugins_user );
475 if ( $ARGV[0] eq '--install-plugin' ) {
476 print "Activating plugin " . $ARGV[1] . "\n";
477 push @plugins, $ARGV[1];
480 } elsif ( $ARGV[0] eq '--remove-plugin' ) {
481 print "Removing plugin " . $ARGV[1] . "\n";
482 foreach $plugin (@plugins) {
483 if ( $plugin ne $ARGV[1] ) {
484 push @newplugins, $plugin;
487 @plugins = @newplugins;
490 } elsif ( $ARGV[0] eq '--update-plugins' or $ARGV[0] eq '-u') {
491 build_plugin_hook_array
();
493 } elsif ( $ARGV[0] eq '--help' or $ARGV[0] eq '-h') {
494 print "SquirrelMail Configuration Script\n";
496 print " * No arguments: initiates the configuration dialog\n";
497 print " * --install-plugin <plugin> : activates the specified plugin\n";
498 print " * --remove-plugin <plugin> : deactivates the specified plugin\n";
499 print " * --update-plugins , -u : rebuilds plugin_hooks.php according\n";
500 print " to plugins activated in config.php\n";
501 print " * --help , -h : Displays this help\n";
506 #####################################################################################
507 if ( $config_use_color == 1 ) {
513 $config_use_color = 2;
516 while ( ( $command ne "q" ) && ( $command ne "Q" ) && ( $command ne ":q" ) ) {
518 print $WHT. "SquirrelMail Configuration : " . $NRM;
519 if ( $config == 1 ) { print "Read: config.php"; }
520 elsif ( $config == 2 ) { print "Read: config_default.php"; }
521 print " ($print_config_version)\n";
522 print "---------------------------------------------------------\n";
525 print $WHT. "Main Menu --\n" . $NRM;
526 print "1. Organization Preferences\n";
527 print "2. Server Settings\n";
528 print "3. Folder Defaults\n";
529 print "4. General Options\n";
530 print "5. User Interface\n";
531 print "6. Address Books\n";
532 print "7. Message of the Day (MOTD)\n";
533 print "8. Plugins\n";
534 print "9. Database\n";
535 print "10. Language settings\n";
536 print "11. Tweaks\n";
538 print "D. Set pre-defined settings for specific IMAP servers\n";
540 } elsif ( $menu == 1 ) {
541 print $WHT. "Organization Preferences\n" . $NRM;
542 print "1. Organization Name : $WHT$org_name$NRM\n";
543 print "2. Organization Logo : $WHT$org_logo$NRM\n";
544 print "3. Org. Logo Width/Height : $WHT($org_logo_width/$org_logo_height)$NRM\n";
545 print "4. Organization Title : $WHT$org_title$NRM\n";
546 print "5. Signout Page : $WHT$signout_page$NRM\n";
547 print "6. Top Frame : $WHT$frame_top$NRM\n";
548 print "7. Provider link : $WHT$provider_uri$NRM\n";
549 print "8. Provider name : $WHT$provider_name$NRM\n";
552 print "R Return to Main Menu\n";
553 } elsif ( $menu == 2 ) {
554 print $WHT. "Server Settings\n\n" . $NRM;
555 print $WHT . "General" . $NRM . "\n";
557 print "1. Domain : $WHT$domain$NRM\n";
558 print "2. Invert Time : $WHT$invert_time$NRM\n";
559 print "3. Sendmail or SMTP : $WHT";
560 if ( lc($useSendmail) eq 'true' ) {
568 if ( $show_imap_settings ) {
569 print $WHT . "IMAP Settings". $NRM . "\n--------------\n";
570 print "4. IMAP Server : $WHT$imapServerAddress$NRM\n";
571 print "5. IMAP Port : $WHT$imapPort$NRM\n";
572 print "6. Authentication type : $WHT$imap_auth_mech$NRM\n";
573 print "7. Secure IMAP (TLS) : $WHT" . display_use_tls
($use_imap_tls) . "$NRM\n";
574 print "8. Server software : $WHT$imap_server_type$NRM\n";
575 print "9. Delimiter : $WHT$optional_delimiter$NRM\n";
577 } elsif ( $show_smtp_settings ) {
578 if ( lc($useSendmail) eq 'true' ) {
579 print $WHT . "Sendmail" . $NRM . "\n--------\n";
580 print "4. Sendmail Path : $WHT$sendmail_path$NRM\n";
581 print "5. Sendmail arguments : $WHT$sendmail_args$NRM\n";
582 print "6. Header encryption key : $WHT$encode_header_key$NRM\n";
585 print $WHT . "SMTP Settings" . $NRM . "\n-------------\n";
586 print "4. SMTP Server : $WHT$smtpServerAddress$NRM\n";
587 print "5. SMTP Port : $WHT$smtpPort$NRM\n";
588 print "6. POP before SMTP : $WHT$pop_before_smtp$NRM\n";
589 print "7. SMTP Authentication : $WHT$smtp_auth_mech" . display_smtp_sitewide_userpass
() ."$NRM\n";
590 print "8. Secure SMTP (TLS) : $WHT" . display_use_tls
($use_smtp_tls) . "$NRM\n";
591 print "9. Header encryption key : $WHT$encode_header_key$NRM\n";
596 if ($show_imap_settings == 0) {
597 print "A. Update IMAP Settings : ";
598 print "$WHT$imapServerAddress$NRM:";
599 print "$WHT$imapPort$NRM ";
600 print "($WHT$imap_server_type$NRM)\n";
602 if ($show_smtp_settings == 0) {
603 if ( lc($useSendmail) eq 'true' ) {
604 print "B. Change Sendmail Config : $WHT$sendmail_path$NRM\n";
606 print "B. Update SMTP Settings : ";
607 print "$WHT$smtpServerAddress$NRM:";
608 print "$WHT$smtpPort$NRM\n";
611 if ( $show_smtp_settings || $show_imap_settings )
614 ($show_imap_settings ?
"IMAP Server" :
615 (lc($useSendmail) eq 'true') ?
"Sendmail" : "SMTP") . " Settings\n";
619 print "R Return to Main Menu\n";
620 } elsif ( $menu == 3 ) {
621 print $WHT. "Folder Defaults\n" . $NRM;
622 print "1. Default Folder Prefix : $WHT$default_folder_prefix$NRM\n";
623 print "2. Show Folder Prefix Option : $WHT$show_prefix_option$NRM\n";
624 print "3. Trash Folder : $WHT$trash_folder$NRM\n";
625 print "4. Sent Folder : $WHT$sent_folder$NRM\n";
626 print "5. Drafts Folder : $WHT$draft_folder$NRM\n";
627 print "6. By default, move to trash : $WHT$default_move_to_trash$NRM\n";
628 print "7. By default, move to sent : $WHT$default_move_to_sent$NRM\n";
629 print "8. By default, save as draft : $WHT$default_save_as_draft$NRM\n";
630 print "9. List Special Folders First : $WHT$list_special_folders_first$NRM\n";
631 print "10. Show Special Folders Color : $WHT$use_special_folder_color$NRM\n";
632 print "11. Auto Expunge : $WHT$auto_expunge$NRM\n";
633 print "12. Default Sub. of INBOX : $WHT$default_sub_of_inbox$NRM\n";
634 print "13. Show 'Contain Sub.' Option : $WHT$show_contain_subfolders_option$NRM\n";
635 print "14. Default Unseen Notify : $WHT$default_unseen_notify$NRM\n";
636 print "15. Default Unseen Type : $WHT$default_unseen_type$NRM\n";
637 print "16. Auto Create Special Folders : $WHT$auto_create_special$NRM\n";
638 print "17. Folder Delete Bypasses Trash : $WHT$delete_folder$NRM\n";
639 print "18. Enable /NoSelect folder fix : $WHT$noselect_fix_enable$NRM\n";
641 print "R Return to Main Menu\n";
642 } elsif ( $menu == 4 ) {
643 print $WHT. "General Options\n" . $NRM;
644 print "1. Data Directory : $WHT$data_dir$NRM\n";
645 print "2. Attachment Directory : $WHT$attachment_dir$NRM\n";
646 print "3. Directory Hash Level : $WHT$dir_hash_level$NRM\n";
647 print "4. Default Left Size : $WHT$default_left_size$NRM\n";
648 print "5. Usernames in Lowercase : $WHT$force_username_lowercase$NRM\n";
649 print "6. Allow use of priority : $WHT$default_use_priority$NRM\n";
650 print "7. Hide SM attributions : $WHT$hide_sm_attributions$NRM\n";
651 print "8. Allow use of receipts : $WHT$default_use_mdn$NRM\n";
652 print "9. Allow editing of identity : $WHT$edit_identity$NRM\n";
653 print " Allow editing of name : $WHT$edit_name$NRM\n";
654 print " Remove username from header : $WHT$hide_auth_header$NRM\n";
655 print "10. Disable server thread sort : $WHT$disable_thread_sort$NRM\n";
656 print "11. Disable server-side sorting : $WHT$disable_server_sort$NRM\n";
657 print "12. Allow server charset search : $WHT$allow_charset_search$NRM\n";
658 print "13. Allow advanced search : $WHT$allow_advanced_search$NRM\n";
659 print "14. PHP session name : $WHT$session_name$NRM\n";
660 print "15. Time zone configuration : $WHT$time_zone_type$NRM\n";
661 print "16. Location base : $WHT$config_location_base$NRM\n";
663 print "R Return to Main Menu\n";
664 } elsif ( $menu == 5 ) {
665 print $WHT. "User Interface\n" . $NRM;
666 print "1. Use Icons? : $WHT$use_icons$NRM\n";
667 # print "3. Default Icon Set : $WHT$icon_theme_def$NRM\n";
668 print "2. Default font size : $WHT$default_fontsize$NRM\n";
669 print "3. Manage template sets\n";
670 print "4. Manage user themes\n";
671 print "5. Manage font sets\n";
672 print "6. Manage icon themes\n";
675 print "R Return to Main Menu\n";
676 } elsif ( $menu == 6 ) {
677 print $WHT. "Address Books\n" . $NRM;
678 print "1. Change LDAP Servers\n";
679 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
680 print " > $ldap_host[$count]\n";
682 print "2. Use Javascript address book search : $WHT$default_use_javascript_addr_book$NRM\n";
683 print "3. Global address book file : $WHT$abook_global_file$NRM\n";
684 print "4. Allow writing into global file address book : $WHT$abook_global_file_writeable$NRM\n";
685 print "5. Allow listing of global file address book : $WHT$abook_global_file_listing$NRM\n";
686 print "6. Allowed address book line length : $WHT$abook_file_line_length$NRM\n";
688 print "R Return to Main Menu\n";
689 } elsif ( $menu == 7 ) {
690 print $WHT. "Message of the Day (MOTD)\n" . $NRM;
693 print "1 Edit the MOTD\n";
695 print "R Return to Main Menu\n";
696 } elsif ( $menu == 8 ) {
697 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
698 print $WHT. "Plugins (WARNING: All plugins are currently disabled\n for the user \"$disable_plugins_user\"!)\n" . $NRM;
699 } elsif (lc($disable_plugins) eq 'true') {
700 print $WHT. "Plugins (WARNING: All plugins are currently disabled!)\n" . $NRM;
702 print $WHT. "Plugins\n" . $NRM;
704 print " Installed Plugins\n";
706 for ( $count = 0 ; $count <= $#plugins ; $count++ ) {
708 print " $num. $plugins[$count]\n";
710 print "\n Available Plugins:\n";
711 opendir( DIR
, "../plugins" );
712 @files = readdir(DIR
);
714 @unused_plugins = ();
715 for ( $i = 0 ; $i <= $#files ; $i++ ) {
716 if ( -d
"../plugins/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne "CVS" ) {
718 for ( $k = 0 ; $k <= $#plugins ; $k++ ) {
719 if ( $plugins[$k] eq $files[$i] ) {
724 $unused_plugins[$pos] = $files[$i];
730 for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
732 print " $num. $unused_plugins[$i]\n";
737 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
738 print "E Enable active plugins (all plugins currently\n disabled for the user \"$disable_plugins_user\")\n";
739 } elsif (lc($disable_plugins) eq 'true') {
740 print "E Enable active plugins (all plugins currently\n disabled)\n";
742 print "D Disable all plugins\n";
744 print "U Set the user for whom plugins can be disabled\n";
745 print "R Return to Main Menu\n";
746 } elsif ( $menu == 9 ) {
747 print $WHT. "Database\n" . $NRM;
748 print "1. DSN for Address Book : $WHT$addrbook_dsn$NRM\n";
749 print "2. Table for Address Book : $WHT$addrbook_table$NRM\n";
751 print "3. DSN for Preferences : $WHT$prefs_dsn$NRM\n";
752 print "4. Table for Preferences : $WHT$prefs_table$NRM\n";
753 print "5. Field for username : $WHT$prefs_user_field$NRM ($prefs_user_size)\n";
754 print "6. Field for prefs key : $WHT$prefs_key_field$NRM ($prefs_key_size)\n";
755 print "7. Field for prefs value : $WHT$prefs_val_field$NRM ($prefs_val_size)\n";
757 print "8. DSN for Global Address Book : $WHT$addrbook_global_dsn$NRM\n";
758 print "9. Table for Global Address Book : $WHT$addrbook_global_table$NRM\n";
759 print "10. Allow writing into Global Address Book : $WHT$addrbook_global_writeable$NRM\n";
760 print "11. Allow listing of Global Address Book : $WHT$addrbook_global_listing$NRM\n";
762 print "R Return to Main Menu\n";
763 } elsif ( $menu == 10 ) {
764 print $WHT. "Language settings\n" . $NRM;
765 print "1. Default Language : $WHT$squirrelmail_default_language$NRM\n";
766 print "2. Default Charset : $WHT$default_charset$NRM\n";
767 print "3. Show alternative language names : $WHT$show_alternative_names$NRM\n";
768 print "4. Enable aggressive decoding : $WHT$aggressive_decoding$NRM\n";
769 print "5. Enable lossy encoding : $WHT$lossy_encoding$NRM\n";
771 print "R Return to Main Menu\n";
772 } elsif ( $menu == 11 ) {
773 print $WHT. "Interface tweaks\n" . $NRM;
774 print "1. Display html mails in iframe : $WHT$use_iframe$NRM\n";
776 print $WHT. "PHP tweaks\n" . $NRM;
777 print "4. Use php recode functions : $WHT$use_php_recode$NRM\n";
778 print "5. Use php iconv functions : $WHT$use_php_iconv$NRM\n";
780 print $WHT. "Configuration tweaks\n" . $NRM;
781 print "6. Allow remote configtest : $WHT$allow_remote_configtest$NRM\n";
783 print "R Return to Main Menu\n";
785 if ( $config_use_color == 1 ) {
786 print "C Turn color off\n";
788 print "C Turn color on\n";
790 print "S Save data\n";
794 print "Command >> " . $WHT;
796 $command =~ s/[\n\r]//g;
797 $command =~ tr/A-Z/a-z/;
800 # Read the commands they entered.
801 if ( $command eq "r" ) {
803 } elsif ( $command eq "s" ) {
805 print "Press enter to continue...";
808 } elsif ( ( $command eq "q" ) && ( $saved == 0 ) ) {
809 print "You have not saved your data.\n";
810 print "Save? [" . $WHT . "Y" . $NRM . "/n]: ";
812 if ( ( $save =~ /^y/i ) || ( $save =~ /^\s*$/ ) ) {
815 } elsif ( $command eq "c" ) {
816 if ( $config_use_color == 1 ) {
817 $config_use_color = 2;
821 $config_use_color = 1;
825 } elsif ( $command eq "d" && $menu == 0 ) {
830 if ( ( $command > 0 ) && ( $command < 12 ) ) {
833 } elsif ( $menu == 1 ) {
834 if ( $command == 1 ) { $org_name = command1
(); }
835 elsif ( $command == 2 ) { $org_logo = command2
(); }
836 elsif ( $command == 3 ) { ($org_logo_width,$org_logo_height) = command2a
(); }
837 elsif ( $command == 4 ) { $org_title = command3
(); }
838 elsif ( $command == 5 ) { $signout_page = command4
(); }
839 elsif ( $command == 6 ) { $frame_top = command6
(); }
840 elsif ( $command == 7 ) { $provider_uri = command7
(); }
841 elsif ( $command == 8 ) { $provider_name = command8
(); }
843 } elsif ( $menu == 2 ) {
844 if ( $command eq "a" ) { $show_imap_settings = 1; $show_smtp_settings = 0; }
845 elsif ( $command eq "b" ) { $show_imap_settings = 0; $show_smtp_settings = 1; }
846 elsif ( $command eq "h" ) { $show_imap_settings = 0; $show_smtp_settings = 0; }
847 elsif ( $command <= 3 ) {
848 if ( $command == 1 ) { $domain = command11
(); }
849 elsif ( $command == 2 ) { $invert_time = command110
(); }
850 elsif ( $command == 3 ) { $useSendmail = command14
(); }
851 $show_imap_settings = 0; $show_smtp_settings = 0;
852 } elsif ( $show_imap_settings ) {
853 if ( $command == 4 ) { $imapServerAddress = command12
(); }
854 elsif ( $command == 5 ) { $imapPort = command13
(); }
855 elsif ( $command == 6 ) { $imap_auth_mech = command112a
(); }
856 elsif ( $command == 7 ) { $use_imap_tls = command_use_tls
("IMAP",$use_imap_tls); }
857 elsif ( $command == 8 ) { $imap_server_type = command19
(); }
858 elsif ( $command == 9 ) { $optional_delimiter = command111
(); }
859 } elsif ( $show_smtp_settings && lc($useSendmail) eq 'true' ) {
860 if ( $command == 4 ) { $sendmail_path = command15
(); }
861 elsif ( $command == 5 ) { $sendmail_args = command_sendmail_args
(); }
862 elsif ( $command == 6 ) { $encode_header_key = command114
(); }
863 } elsif ( $show_smtp_settings ) {
864 if ( $command == 4 ) { $smtpServerAddress = command16
(); }
865 elsif ( $command == 5 ) { $smtpPort = command17
(); }
866 elsif ( $command == 6 ) { $pop_before_smtp = command18a
(); }
867 elsif ( $command == 7 ) { $smtp_auth_mech = command112b
(); }
868 elsif ( $command == 8 ) { $use_smtp_tls = command_use_tls
("SMTP",$use_smtp_tls); }
869 elsif ( $command == 9 ) { $encode_header_key = command114
(); }
871 } elsif ( $menu == 3 ) {
872 if ( $command == 1 ) { $default_folder_prefix = command21
(); }
873 elsif ( $command == 2 ) { $show_prefix_option = command22
(); }
874 elsif ( $command == 3 ) { $trash_folder = command23a
(); }
875 elsif ( $command == 4 ) { $sent_folder = command23b
(); }
876 elsif ( $command == 5 ) { $draft_folder = command23c
(); }
877 elsif ( $command == 6 ) { $default_move_to_trash = command24a
(); }
878 elsif ( $command == 7 ) { $default_move_to_sent = command24b
(); }
879 elsif ( $command == 8 ) { $default_save_as_draft = command24c
(); }
880 elsif ( $command == 9 ) { $list_special_folders_first = command27
(); }
881 elsif ( $command == 10 ) { $use_special_folder_color = command28
(); }
882 elsif ( $command == 11 ) { $auto_expunge = command29
(); }
883 elsif ( $command == 12 ) { $default_sub_of_inbox = command210
(); }
884 elsif ( $command == 13 ) { $show_contain_subfolders_option = command211
(); }
885 elsif ( $command == 14 ) { $default_unseen_notify = command212
(); }
886 elsif ( $command == 15 ) { $default_unseen_type = command213
(); }
887 elsif ( $command == 16 ) { $auto_create_special = command214
(); }
888 elsif ( $command == 17 ) { $delete_folder = command215
(); }
889 elsif ( $command == 18 ) { $noselect_fix_enable = command216
(); }
890 } elsif ( $menu == 4 ) {
891 if ( $command == 1 ) { $data_dir = command33a
(); }
892 elsif ( $command == 2 ) { $attachment_dir = command33b
(); }
893 elsif ( $command == 3 ) { $dir_hash_level = command33c
(); }
894 elsif ( $command == 4 ) { $default_left_size = command35
(); }
895 elsif ( $command == 5 ) { $force_username_lowercase = command36
(); }
896 elsif ( $command == 6 ) { $default_use_priority = command37
(); }
897 elsif ( $command == 7 ) { $hide_sm_attributions = command38
(); }
898 elsif ( $command == 8 ) { $default_use_mdn = command39
(); }
899 elsif ( $command == 9 ) { $edit_identity = command310
(); }
900 elsif ( $command == 10 ) { $disable_thread_sort = command312
(); }
901 elsif ( $command == 11 ) { $disable_server_sort = command313
(); }
902 elsif ( $command == 12 ) { $allow_charset_search = command314
(); }
903 elsif ( $command == 13 ) { $allow_advanced_search = command316
(); }
904 elsif ( $command == 14 ) { $session_name = command317
(); }
905 elsif ( $command == 15 ) { $time_zone_type = command318
(); }
906 elsif ( $command == 16 ) { $config_location_base = command_config_location_base
(); }
907 } elsif ( $menu == 5 ) {
908 if ( $command == 1 ) { $use_icons = commandB3
(); }
909 # elsif ( $command == 3 ) { $icon_theme_def = commandB7(); }
910 elsif ( $command == 2 ) { $default_fontsize = command_default_fontsize
(); }
911 elsif ( $command == 3 ) { $templateset_default = command_templates
(); }
912 elsif ( $command == 4 ) { command_userThemes
(); }
913 elsif ( $command == 5 ) { command_fontsets
(); }
914 elsif ( $command == 6 ) { command_iconSets
(); }
915 } elsif ( $menu == 6 ) {
916 if ( $command == 1 ) { command61
(); }
917 elsif ( $command == 2 ) { command62
(); }
918 elsif ( $command == 3 ) { $abook_global_file=command63
(); }
919 elsif ( $command == 4 ) { command64
(); }
920 elsif ( $command == 5 ) { command65
(); }
921 elsif ( $command == 6 ) { command_abook_file_line_length
(); }
922 } elsif ( $menu == 7 ) {
923 if ( $command == 1 ) { $motd = command71
(); }
924 } elsif ( $menu == 8 ) {
925 if ( $command =~ /^[0-9]+/ ) { @plugins = command81
(); }
926 elsif ( $command eq "u" ) { $disable_plugins_user = command82
(); }
927 elsif ( $command eq "d" ) { $disable_plugins = 'true'; }
928 elsif ( $command eq "e" ) { $disable_plugins = 'false'; }
929 } elsif ( $menu == 9 ) {
930 if ( $command == 1 ) { $addrbook_dsn = command91
(); }
931 elsif ( $command == 2 ) { $addrbook_table = command92
(); }
932 elsif ( $command == 3 ) { $prefs_dsn = command93
(); }
933 elsif ( $command == 4 ) { $prefs_table = command94
(); }
934 elsif ( $command == 5 ) { $prefs_user_field = command95
(); }
935 elsif ( $command == 6 ) { $prefs_key_field = command96
(); }
936 elsif ( $command == 7 ) { $prefs_val_field = command97
(); }
937 elsif ( $command == 8 ) { $addrbook_global_dsn = command98
(); }
938 elsif ( $command == 9 ) { $addrbook_global_table = command99
(); }
939 elsif ( $command == 10 ) { $addrbook_global_writeable = command910
(); }
940 elsif ( $command == 11 ) { $addrbook_global_listing = command911
(); }
941 } elsif ( $menu == 10 ) {
942 if ( $command == 1 ) { $squirrelmail_default_language = commandA1
(); }
943 elsif ( $command == 2 ) { $default_charset = commandA2
(); }
944 elsif ( $command == 3 ) { $show_alternative_names = commandA3
(); }
945 elsif ( $command == 4 ) { $aggressive_decoding = commandA4
(); }
946 elsif ( $command == 5 ) { $lossy_encoding = commandA5
(); }
947 } elsif ( $menu == 11 ) {
948 if ( $command == 1 ) { $use_iframe = commandB2
(); }
949 elsif ( $command == 4 ) { $use_php_recode = commandB4
(); }
950 elsif ( $command == 5 ) { $use_php_iconv = commandB5
(); }
951 elsif ( $command == 6 ) { $allow_remote_configtest = commandB6
(); }
957 print "\nExiting conf.pl.\n".
958 "You might want to test your configuration by browsing to\n".
959 "http://your-squirrelmail-location/src/configtest.php\n".
960 "Happy SquirrelMailing!\n\n";
963 ####################################################################################
967 print "We have tried to make the name SquirrelMail as transparent as\n";
968 print "possible. If you set up an organization name, most places where\n";
969 print "SquirrelMail would take credit will be credited to your organization.\n";
971 print "If your Organization Name includes a '\$', please precede it with a \\. \n";
972 print "Other '\$' will be considered the beginning of a variable that\n";
973 print "must be defined before the \$org_name is printed.\n";
975 print "[$WHT$org_name$NRM]: $WHT";
976 $new_org_name = <STDIN
>;
977 if ( $new_org_name eq "\n" ) {
978 $new_org_name = $org_name;
980 $new_org_name =~ s/[\r\n]//g;
981 $new_org_name =~ s/\"/"/g;
983 return $new_org_name;
988 print "Your organization's logo is an image that will be displayed at\n";
989 print "different times throughout SquirrelMail. ";
991 print "Please be aware of the following: \n";
992 print " - Relative URLs are relative to the config dir\n";
993 print " to use the default logo, use ../images/sm_logo.png\n";
994 print " - To specify a logo defined outside the SquirrelMail source tree\n";
995 print " use the absolute URL the webserver would use to include the file\n";
996 print " e.g. http://www.example.com/images/mylogo.gif or /images/mylogo.jpg\n";
998 print "[$WHT$org_logo$NRM]: $WHT";
999 $new_org_logo = <STDIN
>;
1000 if ( $new_org_logo eq "\n" ) {
1001 $new_org_logo = $org_logo;
1003 $new_org_logo =~ s/[\r\n]//g;
1005 return $new_org_logo;
1010 print "Your organization's logo is an image that will be displayed at\n";
1011 print "different times throughout SquirrelMail. Width\n";
1012 print "and Height of your logo image. Use '0' to disable.\n";
1014 print "Width: [$WHT$org_logo_width$NRM]: $WHT";
1015 $new_org_logo_width = <STDIN
>;
1016 $new_org_logo_width =~ tr/0-9//cd; # only want digits!
1017 if ( $new_org_logo_width eq '' ) {
1018 $new_org_logo_width = $org_logo_width;
1020 if ( $new_org_logo_width > 0 ) {
1021 print "Height: [$WHT$org_logo_height$NRM]: $WHT";
1022 $new_org_logo_height = <STDIN
>;
1023 $new_org_logo_height =~ tr/0-9//cd; # only want digits!
1024 if( $new_org_logo_height eq '' ) {
1025 $new_org_logo_height = $org_logo_height;
1028 $new_org_logo_height = 0;
1030 return ($new_org_logo_width, $new_org_logo_height);
1035 print "A title is what is displayed at the top of the browser window in\n";
1036 print "the titlebar. Usually this will end up looking something like:\n";
1037 print "\"Netscape: $org_title\"\n";
1039 print "If your Organization Title includes a '\$', please precede it with a \\. \n";
1040 print "Other '\$' will be considered the beginning of a variable that\n";
1041 print "must be defined before the \$org_title is printed.\n";
1043 print "[$WHT$org_title$NRM]: $WHT";
1044 $new_org_title = <STDIN
>;
1045 if ( $new_org_title eq "\n" ) {
1046 $new_org_title = $org_title;
1048 $new_org_title =~ s/[\r\n]//g;
1049 $new_org_title =~ s/\"/\'/g;
1051 return $new_org_title;
1056 print "When users click the Sign Out button they will be logged out and\n";
1057 print "then sent to signout_page. If signout_page is left empty,\n";
1058 print "(hit space and then return) they will be taken, as normal,\n";
1059 print "to the default and rather sparse SquirrelMail signout page.\n";
1061 print "[$WHT$signout_page$NRM]: $WHT";
1062 $new_signout_page = <STDIN
>;
1063 if ( $new_signout_page eq "\n" ) {
1064 $new_signout_page = $signout_page;
1066 $new_signout_page =~ s/[\r\n]//g;
1067 $new_signout_page =~ s/^\s+$//g;
1069 return $new_signout_page;
1074 print "SquirrelMail defaults to using the whole of the browser window.\n";
1075 print "This allows you to keep it within a specified frame. The default\n";
1076 print "is '_top'\n";
1078 print "[$WHT$frame_top$NRM]: $WHT";
1079 $new_frame_top = <STDIN
>;
1080 if ( $new_frame_top eq "\n" ) {
1081 $new_frame_top = '_top';
1083 $new_frame_top =~ s/[\r\n]//g;
1084 $new_frame_top =~ s/^\s+$//g;
1086 return $new_frame_top;
1089 # Default link to provider
1091 print "Here you can set the link on the right of the page.\n";
1092 print "If empty, it will link to the SquirrelMail About page.\n";
1094 print "[$WHT$provider_uri$NRM]: $WHT";
1095 $new_provider_uri = <STDIN
>;
1096 if ( $new_provider_uri eq "\n" ) {
1097 $new_provider_uri = '';
1099 $new_provider_uri =~ s/[\r\n]//g;
1100 $new_provider_uri =~ s/^\s+$//g;
1102 return $new_provider_uri;
1106 print "Here you can set the name of the link on the right of the page.\n";
1107 print "The default is 'SquirrelMail'\n";
1109 print "[$WHT$provider_name$NRM]: $WHT";
1110 $new_provider_name = <STDIN
>;
1111 if ( $new_provider_name eq "\n" ) {
1112 $new_provider_name = 'SquirrelMail';
1114 $new_provider_name =~ s/[\r\n]//g;
1115 $new_provider_name =~ s/^\s+$//g;
1116 $new_provider_name =~ s/\'/\\'/g;
1118 return $new_provider_name;
1121 ####################################################################################
1125 print "The domain name is the suffix at the end of all email addresses. If\n";
1126 print "for example, your email address is jdoe\@example.com, then your domain\n";
1127 print "would be example.com.\n";
1129 print "[$WHT$domain$NRM]: $WHT";
1130 $new_domain = <STDIN
>;
1131 if ( $new_domain eq "\n" ) {
1132 $new_domain = $domain;
1134 $new_domain =~ s/\s//g;
1141 print "This is the hostname where your IMAP server can be contacted.\n";
1142 print "[$WHT$imapServerAddress$NRM]: $WHT";
1143 $new_imapServerAddress = <STDIN
>;
1144 if ( $new_imapServerAddress eq "\n" ) {
1145 $new_imapServerAddress = $imapServerAddress;
1147 $new_imapServerAddress =~ s/[\r\n]//g;
1149 return $new_imapServerAddress;
1154 print "This is the port that your IMAP server is on. Usually this is 143.\n";
1155 print "[$WHT$imapPort$NRM]: $WHT";
1156 $new_imapPort = <STDIN
>;
1157 if ( $new_imapPort eq "\n" ) {
1158 $new_imapPort = $imapPort;
1160 $new_imapPort =~ s/[\r\n]//g;
1162 return $new_imapPort;
1167 print "You now need to choose the method that you will use for sending\n";
1168 print "messages in SquirrelMail. You can either connect to an SMTP server\n";
1169 print "or use sendmail directly.\n";
1170 if ( lc($useSendmail) eq 'true' ) {
1171 $default_value = "1";
1173 $default_value = "2";
1176 print " 1. Sendmail\n";
1178 print "Your choice [1/2] [$WHT$default_value$NRM]: $WHT";
1179 $use_sendmail = <STDIN
>;
1180 if ( ( $use_sendmail =~ /^1\n/i )
1181 || ( ( $use_sendmail =~ /^\n/ ) && ( $default_value eq "1" ) ) ) {
1182 $useSendmail = 'true';
1184 $useSendmail = 'false';
1186 return $useSendmail;
1191 print "Specify where the sendmail executable is located. Usually /usr/sbin/sendmail\n";
1192 print "[$WHT$sendmail_path$NRM]: $WHT";
1193 $new_sendmail_path = <STDIN
>;
1194 if ( $new_sendmail_path eq "\n" ) {
1195 $new_sendmail_path = $sendmail_path;
1197 $new_sendmail_path =~ s/[\r\n]//g;
1199 return $new_sendmail_path;
1202 # Extra sendmail arguments
1203 sub command_sendmail_args
{
1204 print "Specify additional sendmail program arguments.\n";
1206 print "Make sure that arguments are supported by your sendmail program. -f argument \n";
1207 print "is added automatically by SquirrelMail scripts. Variable defaults to standard\n";
1208 print "/usr/sbin/sendmail arguments. If you use qmail-inject, nbsmtp or any other \n";
1209 print "sendmail wrapper, which does not support -i and -t arguments, set variable to\n";
1210 print "empty string or use arguments suitable for your mailer.\n";
1212 print "[$WHT$sendmail_args$NRM]: $WHT";
1213 $new_sendmail_args = <STDIN
>;
1214 if ( $new_sendmail_args eq "\n" ) {
1215 $new_sendmail_args = $sendmail_args;
1217 # strip linefeeds and crs.
1218 $new_sendmail_args =~ s/[\r\n]//g;
1220 return trim
($new_sendmail_args);
1225 print "This is the hostname of your SMTP server.\n";
1226 print "[$WHT$smtpServerAddress$NRM]: $WHT";
1227 $new_smtpServerAddress = <STDIN
>;
1228 if ( $new_smtpServerAddress eq "\n" ) {
1229 $new_smtpServerAddress = $smtpServerAddress;
1231 $new_smtpServerAddress =~ s/[\r\n]//g;
1233 return $new_smtpServerAddress;
1238 print "This is the port to connect to for SMTP. Usually 25.\n";
1239 print "[$WHT$smtpPort$NRM]: $WHT";
1240 $new_smtpPort = <STDIN
>;
1241 if ( $new_smtpPort eq "\n" ) {
1242 $new_smtpPort = $smtpPort;
1244 $new_smtpPort =~ s/[\r\n]//g;
1246 return $new_smtpPort;
1251 print "Do you wish to use POP3 before SMTP? Your server must\n";
1252 print "support this in order for SquirrelMail to work with it.\n";
1255 $YesNo = 'y' if ( lc($pop_before_smtp) eq 'true' );
1257 print "Use pop before SMTP (y/n) [$WHT$YesNo$NRM]: $WHT";
1259 $new_pop_before_smtp = <STDIN
>;
1260 $new_pop_before_smtp =~ tr/yn//cd;
1261 return 'true' if ( $new_pop_before_smtp eq "y" );
1262 return 'false' if ( $new_pop_before_smtp eq "n" );
1263 return $pop_before_smtp;
1268 print "Each IMAP server has its own quirks. As much as we tried to stick\n";
1269 print "to standards, it doesn't help much if the IMAP server doesn't follow\n";
1270 print "the same principles. We have made some work-arounds for some of\n";
1271 print "these servers. If you would like to use them, please select your\n";
1272 print "IMAP server. If you do not wish to use these work-arounds, you can\n";
1273 print "set this to \"other\", and none will be used.\n";
1274 print " courier = Courier IMAP server\n";
1275 print " cyrus = Cyrus IMAP server\n";
1276 print " dovecot = Dovecot Secure IMAP server\n";
1277 print " exchange = Microsoft Exchange IMAP server\n";
1278 print " hmailserver = hMailServer\n";
1279 print " macosx = Mac OS X Mailserver\n";
1280 print " mercury32 = Mercury Mail Transport System\n";
1281 print " uw = University of Washington's IMAP server\n";
1283 print " other = Not one of the above servers\n";
1285 print "[$WHT$imap_server_type$NRM]: $WHT";
1286 $new_imap_server_type = <STDIN
>;
1288 if ( $new_imap_server_type eq "\n" ) {
1289 $new_imap_server_type = $imap_server_type;
1291 $new_imap_server_type =~ s/[\r\n]//g;
1293 return $new_imap_server_type;
1298 print "Sometimes the date of messages sent is messed up (off by a few hours\n";
1299 print "on some machines). Typically this happens if the system doesn't support\n";
1300 print "tm_gmtoff. It will happen only if your time zone is \"negative\".\n";
1301 print "This most often occurs on Solaris 7 machines in the United States.\n";
1302 print "By default, this is off. It should be kept off unless problems surface\n";
1303 print "about the time that messages are sent.\n";
1304 print " no = Do NOT fix time -- almost always correct\n";
1305 print " yes = Fix the time for this system\n";
1308 $YesNo = 'y' if ( lc($invert_time) eq 'true' );
1310 print "Fix the time for this system (y/n) [$WHT$YesNo$NRM]: $WHT";
1312 $new_invert_time = <STDIN
>;
1313 $new_invert_time =~ tr/yn//cd;
1314 return 'true' if ( $new_invert_time eq "y" );
1315 return 'false' if ( $new_invert_time eq "n" );
1316 return $invert_time;
1320 print "This is the delimiter that your IMAP server uses to distinguish between\n";
1321 print "folders. For example, Cyrus uses '.' as the delimiter and a complete\n";
1322 print "folder would look like 'INBOX.Friends.Bob', while UW uses '/' and would\n";
1323 print "look like 'INBOX/Friends/Bob'. Normally this should be left at 'detect'\n";
1324 print "but if you are sure you know what delimiter your server uses, you can\n";
1325 print "specify it here.\n";
1326 print "\nTo have it autodetect the delimiter, set it to 'detect'.\n\n";
1327 print "[$WHT$optional_delimiter$NRM]: $WHT";
1328 $new_optional_delimiter = <STDIN
>;
1330 if ( $new_optional_delimiter eq "\n" ) {
1331 $new_optional_delimiter = $optional_delimiter;
1333 $new_optional_delimiter =~ s/[\r\n]//g;
1335 return $new_optional_delimiter;
1337 # IMAP authentication type
1338 # Possible values: login, plain, cram-md5, digest-md5
1339 # Now offers to detect supported mechs, assuming server & port are set correctly
1342 if ($use_imap_tls ne "0") {
1343 # 1. Script does not handle TLS.
1344 # 2. Server does not have to declare all supported authentication mechs when
1345 # STARTTLS is used. Supported mechs are declared only after STARTTLS.
1346 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1348 print "If you have already set the hostname and port number, I can try to\n";
1349 print "detect the mechanisms your IMAP server supports.\n";
1350 print "I will try to detect CRAM-MD5 and DIGEST-MD5 support. I can't test\n";
1351 print "for \"login\" or \"plain\" without knowing a username and password.\n";
1352 print "Auto-detecting is optional - you can safely say \"n\" here.\n";
1353 print "\nTry to detect supported mechanisms? [y/N]: ";
1356 if ($inval =~ /^y\b/i) {
1357 # Yes, let's try to detect.
1358 print "Trying to detect IMAP capabilities...\n";
1359 my $host = $imapServerAddress . ':'. $imapPort;
1360 print "CRAM-MD5:\t";
1361 my $tmp = detect_auth_support
('IMAP',$host,'CRAM-MD5');
1362 if (defined($tmp)) {
1363 if ($tmp eq 'YES') {
1364 print "$WHT SUPPORTED$NRM\n";
1366 print "$WHT NOT SUPPORTED$NRM\n";
1369 print $WHT . " ERROR DETECTING$NRM\n";
1372 print "DIGEST-MD5:\t";
1373 $tmp = detect_auth_support
('IMAP',$host,'DIGEST-MD5');
1374 if (defined($tmp)) {
1375 if ($tmp eq 'YES') {
1376 print "$WHT SUPPORTED$NRM\n";
1378 print "$WHT NOT SUPPORTED$NRM\n";
1381 print $WHT . " ERROR DETECTING$NRM\n";
1386 print "\nWhat authentication mechanism do you want to use for IMAP connections?\n\n";
1387 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1388 print $WHT . "plain" . $NRM . " - SASL PLAIN. If you need this, you already know it.\n";
1389 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext methods.\n";
1390 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1391 print "\n*** YOUR IMAP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n";
1392 print "If you don't understand or are unsure, you probably want \"login\"\n\n";
1393 print "login, plain, cram-md5, or digest-md5 [$WHT$imap_auth_mech$NRM]: $WHT";
1396 if ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) || ($inval =~ /^login\b/i) || ($inval =~ /^plain\b/i)) {
1399 # user entered garbage or default value so nothing needs to be set
1400 return $imap_auth_mech;
1405 # SMTP authentication type
1406 # Possible choices: none, plain, cram-md5, digest-md5
1408 if ($use_smtp_tls ne "0") {
1409 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1410 } elsif (eval ("use IO::Socket; 1")) {
1411 # try loading IO::Socket module
1412 print "If you have already set the hostname and port number, I can try to\n";
1413 print "automatically detect some of the mechanisms your SMTP server supports.\n";
1414 print "Auto-detection is *optional* - you can safely say \"n\" here.\n";
1415 print "\nTry to detect auth mechanisms? [y/N]: ";
1418 if ($inval =~ /^y\b/i) {
1419 # Yes, let's try to detect.
1420 print "Trying to detect supported methods (SMTP)...\n";
1423 # Check none by trying to relay to junk@microsoft.com
1424 $host = $smtpServerAddress . ':' . $smtpPort;
1425 my $sock = IO
::Socket
::INET
->new($host);
1426 print "Testing none:\t\t$WHT";
1427 if (!defined($sock)) {
1428 print " ERROR TESTING\n";
1431 print $sock "HELO $domain\r\n";
1432 $got = <$sock>; # Discard
1433 print $sock "MAIL FROM:<tester\@squirrelmail.org>\r\n";
1434 $got = <$sock>; # Discard
1435 print $sock "RCPT TO:<junk\@microsoft.com\r\n";
1436 $got = <$sock>; # This is the important line
1437 if ($got =~ /^250\b/) { # SMTP will relay without auth
1438 print "SUPPORTED$NRM\n";
1440 print "NOT SUPPORTED$NRM\n";
1442 print $sock "RSET\r\n";
1443 print $sock "QUIT\r\n";
1446 # Try login (SquirrelMail default)
1447 print "Testing login:\t\t";
1448 $tmp=detect_auth_support
('SMTP',$host,'LOGIN');
1449 if (defined($tmp)) {
1450 if ($tmp eq 'YES') {
1451 print $WHT . "SUPPORTED$NRM\n";
1453 print $WHT . "NOT SUPPORTED$NRM\n";
1456 print $WHT . "ERROR DETECTING$NRM\n";
1460 print "Testing CRAM-MD5:\t";
1461 $tmp=detect_auth_support
('SMTP',$host,'CRAM-MD5');
1462 if (defined($tmp)) {
1463 if ($tmp eq 'YES') {
1464 print $WHT . "SUPPORTED$NRM\n";
1466 print $WHT . "NOT SUPPORTED$NRM\n";
1469 print $WHT . "ERROR DETECTING$NRM\n";
1473 print "Testing DIGEST-MD5:\t";
1474 $tmp=detect_auth_support
('SMTP',$host,'DIGEST-MD5');
1475 if (defined($tmp)) {
1476 if ($tmp eq 'YES') {
1477 print $WHT . "SUPPORTED$NRM\n";
1479 print $WHT . "NOT SUPPORTED$NRM\n";
1482 print $WHT . "ERROR DETECTING$NRM\n";
1486 print "\nWhat authentication mechanism do you want to use for SMTP connections?\n";
1487 print $WHT . "none" . $NRM . " - Your SMTP server does not require authorization.\n";
1488 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1489 print $WHT . "plain" . $NRM . " - SASL PLAIN. You already know it if you need this.\n";
1490 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext.\n";
1491 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1492 print $WHT . "\n*** YOUR SMTP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n" . $NRM;
1493 print "If you don't understand or are unsure, you probably want \"none\"\n\n";
1494 print "none, login, cram-md5, or digest-md5 [$WHT$smtp_auth_mech$NRM]: $WHT";
1497 if ($inval =~ /^none\b/i) {
1498 # remove sitewide smtp authentication information
1499 $smtp_sitewide_user = '';
1500 $smtp_sitewide_pass = '';
1501 # SMTP doesn't necessarily require logins
1503 } elsif ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) ||
1504 ($inval =~ /^login\b/i) || ($inval =~/^plain\b/i)) {
1505 command_smtp_sitewide_userpass
($inval);
1507 } elsif (trim
($inval) eq '') {
1508 # user selected default value
1509 command_smtp_sitewide_userpass
($smtp_auth_mech);
1510 return $smtp_auth_mech;
1512 # user entered garbage
1513 return $smtp_auth_mech;
1517 sub command_smtp_sitewide_userpass
($) {
1518 # get first function argument
1519 my $auth_mech = shift(@_);
1521 $auth_mech = lc(trim
($auth_mech));
1522 if ($auth_mech eq 'none') {
1525 print "SMTP authentication uses IMAP username and password by default.\n";
1527 print "Would you like to use other login and password for all SquirrelMail \n";
1528 print "SMTP connections?";
1529 if ($smtp_sitewide_user ne '') {
1546 $smtp_sitewide_user = '';
1547 $smtp_sitewide_pass = '';
1548 } elsif ($tmp eq 'y') {
1549 print "Enter username [$smtp_sitewide_user]:";
1550 my $new_user = <STDIN
>;
1551 $new_user = trim
($new_user);
1552 if ($new_user ne '') {
1553 $smtp_sitewide_user = $new_user;
1555 if ($smtp_sitewide_user ne '') {
1556 print "If you don't enter any password, current sitewide password will be used.\n";
1557 print "If you enter space, password will be set to empty string.\n";
1558 print "Enter password:";
1559 my $new_pass = <STDIN
>;
1560 if ($new_pass ne "\n") {
1561 $smtp_sitewide_pass = trim
($new_pass);
1564 print "Invalid input. You must set username used for SMTP authentication.\n";
1565 print "Click enter to continue\n";
1569 print "Invalid input\n";
1570 print "Click enter to continue\n";
1575 # Sub adds information about SMTP authentication type to menu
1576 sub display_smtp_sitewide_userpass
() {
1578 if ($smtp_auth_mech ne 'none') {
1579 if ($smtp_sitewide_user ne '') {
1580 $ret = ' (with custom username and password)';
1582 $ret = ' (with IMAP username and password)';
1589 # This sub is reused for IMAP and SMTP
1590 # Args: service name, default value
1591 sub command_use_tls
{
1592 my($default_val,$service,$inval);
1595 print "TLS (Transport Layer Security) encrypts the traffic between server and client.\n";
1596 print "STARTTLS extensions allow to start encryption on existing plain text connection.\n";
1597 print "These options add specific PHP and IMAP server configuration requirements.\n";
1598 print "See SquirrelMail documentation about connection security.\n";
1600 print "If your " . $service . " server is localhost, you can safely disable this.\n";
1601 print "If it is remote, you may wish to seriously consider enabling this.\n";
1603 while ($valid_input eq 0) {
1604 print "\nSelect connection security model:\n";
1605 print " 0 - Use plain text connection\n";
1606 print " 1 - Use TLS connection\n";
1607 print " 2 - Use STARTTLS extension\n";
1608 print "Select [$default_val]: ";
1610 $inval=trim
($inval);
1611 if ($inval =~ /^[012]$/ || $inval eq '') {
1615 if ($inval ne '') {$default_val = $inval};
1616 return $default_val;
1619 # This sub is used to display human readable text for
1620 # $use_imap_tls and $use_smtp_tls values in conf.pl menu
1621 sub display_use_tls
($) {
1622 my $val = shift(@_);
1623 my $ret = 'disabled';
1626 } elsif ($val eq '1') {
1632 # $encode_header_key
1634 print "Encryption key allows to hide SquirrelMail Received: headers\n";
1635 print "in outbound messages. Interface uses encryption key to encode\n";
1636 print "username, remote address and proxied address, then stores encoded\n";
1637 print "information in X-Squirrel-* headers.\n";
1639 print "Warning: used encryption function is not bulletproof. When used\n";
1640 print "with static encryption keys, it provides only minimal security\n";
1641 print "measures and information can be decoded quickly.\n";
1643 print "Encoded information can be decoded with decrypt_headers.php script\n";
1644 print "from SquirrelMail contrib/ directory.\n";
1646 print "Enter encryption key: ";
1647 $new_encode_header_key = <STDIN
>;
1648 if ( $new_encode_header_key eq "\n" ) {
1649 $new_encode_header_key = $encode_header_key;
1651 $new_encode_header_key =~ s/[\r\n]//g;
1653 return $new_encode_header_key;
1658 print "\nYou can now create the welcome message that is displayed\n";
1659 print "every time a user logs on. You can use HTML or just plain\n";
1661 "text. If you do not wish to have one, just make it blank.\n\n(Type @ on a blank line to exit)\n";
1667 $line =~ s/[\r\n]//g;
1668 if ( $line ne "@" ) {
1669 $line =~ s/ /\ \ /g;
1670 $line =~ s/\t/\ \ \ \ /g;
1672 $line =~ s/\"/\\\"/g;
1674 $new_motd = $new_motd . $line;
1676 } while ( $line ne "@" );
1680 ################# PLUGINS ###################
1683 $command =~ s/[\s\n\r]*//g;
1684 if ( $command > 0 ) {
1685 $command = $command - 1;
1686 if ( $command <= $#plugins ) {
1689 while ( $ct <= $#plugins ) {
1690 if ( $ct != $command ) {
1691 @newplugins = ( @newplugins, $plugins[$ct] );
1695 @plugins = @newplugins;
1696 } elsif ( $command <= $#plugins + $#unused_plugins + 1 ) {
1697 $num = $command - $#plugins - 1;
1698 @newplugins = @plugins;
1700 while ( $ct <= $#unused_plugins ) {
1701 if ( $ct == $num ) {
1702 @newplugins = ( @newplugins, $unused_plugins[$ct] );
1706 @plugins = @newplugins;
1712 # disable_plugins_user
1714 print "When all active plugins are disabled, they can be disabled only\n";
1715 print "for the one user named here. If left blank, plugins will be\n";
1716 print "disabled for ALL users. This setting has no effect if plugins\n";
1717 print "are not disabled.\n";
1719 print "This must be the exact IMAP login name for the desired user.\n";
1721 print "[$WHT$disable_plugins_user$NRM]: $WHT";
1722 $new_disable_plugins_user = <STDIN
>;
1723 if ( $new_disable_plugins_user eq "\n" ) {
1724 $new_disable_plugins_user = $disable_plugins_user;
1726 $new_disable_plugins_user =~ s/[\r\n]//g;
1728 return $new_disable_plugins_user;
1731 ################# FOLDERS ###################
1733 # default_folder_prefix
1735 print "Some IMAP servers (UW, for example) store mail and folders in\n";
1736 print "your user space in a separate subdirectory. This is where you\n";
1737 print "specify what that directory is.\n";
1739 print "EXAMPLE: mail/";
1741 print "NOTE: If you use Cyrus, or some server that would not use this\n";
1742 print " option, you must set this to 'none'.\n";
1744 print "[$WHT$default_folder_prefix$NRM]: $WHT";
1745 $new_default_folder_prefix = <STDIN
>;
1747 if ( $new_default_folder_prefix eq "\n" ) {
1748 $new_default_folder_prefix = $default_folder_prefix;
1750 $new_default_folder_prefix =~ s/[\r\n]//g;
1752 if ( ( $new_default_folder_prefix =~ /^\s*$/ ) || ( $new_default_folder_prefix =~ m/^none$/i ) ) {
1753 $new_default_folder_prefix = "";
1755 # add the trailing delimiter only if we know what the server is.
1756 if (($imap_server_type eq 'cyrus' and
1757 $optional_delimiter eq 'detect') or
1758 ($imap_server_type eq 'courier' and
1759 $optional_delimiter eq 'detect')) {
1760 $new_default_folder_prefix =~ s/\.*$/\./;
1761 } elsif ($imap_server_type eq 'uw' and
1762 $optional_delimiter eq 'detect') {
1763 $new_default_folder_prefix =~ s/\/*$/\
//;
1766 return $new_default_folder_prefix;
1769 # Show Folder Prefix
1771 print "It is possible to set up the default folder prefix as a user\n";
1772 print "specific option, where each user can specify what their mail\n";
1773 print "folder is. If you set this to false, they will never see the\n";
1774 print "option, but if it is true, this option will appear in the\n";
1775 print "'options' section.\n";
1777 print "NOTE: You set the default folder prefix in option '1' of this\n";
1778 print " section. That will be the default if the user doesn't\n";
1779 print " specify anything different.\n";
1782 if ( lc($show_prefix_option) eq 'true' ) {
1783 $default_value = "y";
1785 $default_value = "n";
1788 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
1789 $new_show = <STDIN
>;
1790 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1791 $show_prefix_option = 'true';
1793 $show_prefix_option = 'false';
1795 return $show_prefix_option;
1800 print "You can now specify where the default trash folder is located.\n";
1801 print "On servers where you do not want this, you can set it to anything\n";
1802 print "and set option 6 to false.\n";
1804 print "This is relative to where the rest of your email is kept. You do\n";
1805 print "not need to worry about their mail directory. If this folder\n";
1806 print "would be ~/mail/trash on the filesystem, you only need to specify\n";
1807 print "that this is 'trash', and be sure to put 'mail/' in option 1.\n";
1810 print "[$WHT$trash_folder$NRM]: $WHT";
1811 $new_trash_folder = <STDIN
>;
1812 if ( $new_trash_folder eq "\n" ) {
1813 $new_trash_folder = $trash_folder;
1815 if (check_imap_folder
($new_trash_folder)) {
1816 $new_trash_folder =~ s/[\r\n]//g;
1818 $new_trash_folder = $trash_folder;
1821 return $new_trash_folder;
1826 print "This is where messages that are sent will be stored. SquirrelMail\n";
1827 print "by default puts a copy of all outgoing messages in this folder.\n";
1829 print "This is relative to where the rest of your email is kept. You do\n";
1830 print "not need to worry about their mail directory. If this folder\n";
1831 print "would be ~/mail/sent on the filesystem, you only need to specify\n";
1832 print "that this is 'sent', and be sure to put 'mail/' in option 1.\n";
1835 print "[$WHT$sent_folder$NRM]: $WHT";
1836 $new_sent_folder = <STDIN
>;
1837 if ( $new_sent_folder eq "\n" ) {
1838 $new_sent_folder = $sent_folder;
1840 if (check_imap_folder
($new_sent_folder)) {
1841 $new_sent_folder =~ s/[\r\n]//g;
1843 $new_sent_folder = $sent_folder;
1846 return $new_sent_folder;
1851 print "You can now specify where the default draft folder is located.\n";
1852 print "On servers where you do not want this, you can set it to anything\n";
1853 print "and set option 9 to false.\n";
1855 print "This is relative to where the rest of your email is kept. You do\n";
1856 print "not need to worry about their mail directory. If this folder\n";
1857 print "would be ~/mail/drafts on the filesystem, you only need to specify\n";
1858 print "that this is 'drafts', and be sure to put 'mail/' in option 1.\n";
1861 print "[$WHT$draft_folder$NRM]: $WHT";
1862 $new_draft_folder = <STDIN
>;
1863 if ( $new_draft_folder eq "\n" ) {
1864 $new_draft_folder = $draft_folder;
1866 if (check_imap_folder
($new_draft_folder)) {
1867 $new_draft_folder =~ s/[\r\n]//g;
1869 $new_draft_folder = $draft_folder;
1872 return $new_draft_folder;
1875 # default move to trash
1877 print "By default, should messages get moved to the trash folder? You\n";
1878 print "can specify the default trash folder in option 3. If this is set\n";
1879 print "to false, messages will get deleted immediately without moving\n";
1880 print "to the trash folder.\n";
1882 print "Trash folder is currently: $trash_folder\n";
1885 if ( lc($default_move_to_trash) eq 'true' ) {
1886 $default_value = "y";
1888 $default_value = "n";
1890 print "By default, move to trash (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 $default_move_to_trash = 'true';
1895 $default_move_to_trash = 'false';
1897 return $default_move_to_trash;
1900 # default move to sent
1902 print "By default, should messages get moved to the sent folder? You\n";
1903 print "can specify the default sent folder in option 4. If this is set\n";
1904 print "to false, messages will get sent and no copy will be made.\n";
1906 print "Sent folder is currently: $sent_folder\n";
1909 if ( lc($default_move_to_sent) eq 'true' ) {
1910 $default_value = "y";
1912 $default_value = "n";
1914 print "By default, move to sent (y/n) [$WHT$default_value$NRM]: $WHT";
1915 $new_show = <STDIN
>;
1916 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1917 $default_move_to_sent = 'true';
1919 $default_move_to_sent = 'false';
1921 return $default_move_to_sent;
1924 # default save as draft
1926 print "By default, should the save to draft option be shown? You can\n";
1927 print "specify the default drafts folder in option 5. If this is set\n";
1928 print "to false, users will not be shown the save to draft option.\n";
1930 print "Drafts folder is currently: $draft_folder\n";
1933 if ( lc($default_move_to_draft) eq 'true' ) {
1934 $default_value = "y";
1936 $default_value = "n";
1938 print "By default, save as draft (y/n) [$WHT$default_value$NRM]: $WHT";
1939 $new_show = <STDIN
>;
1940 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1941 $default_save_as_draft = 'true';
1943 $default_save_as_draft = 'false';
1945 return $default_save_as_draft;
1948 # List special folders first
1950 print "SquirrelMail has what we call 'special folders' that are not\n";
1951 print "manipulated and viewed like normal folders. Some examples of\n";
1952 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
1953 print "Simply asks if you want these folders listed first in the folder\n";
1957 if ( lc($list_special_folders_first) eq 'true' ) {
1958 $default_value = "y";
1960 $default_value = "n";
1963 print "List first (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 $list_special_folders_first = 'true';
1968 $list_special_folders_first = 'false';
1970 return $list_special_folders_first;
1973 # Show special folders color
1975 print "SquirrelMail has what we call 'special folders' that are not\n";
1976 print "manipulated and viewed like normal folders. Some examples of\n";
1977 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
1978 print "wants to know if we should display special folders in a\n";
1979 print "color than the other folders.\n";
1982 if ( lc($use_special_folder_color) eq 'true' ) {
1983 $default_value = "y";
1985 $default_value = "n";
1988 print "Show color (y/n) [$WHT$default_value$NRM]: $WHT";
1989 $new_show = <STDIN
>;
1990 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1991 $use_special_folder_color = 'true';
1993 $use_special_folder_color = 'false';
1995 return $use_special_folder_color;
2000 print "The way that IMAP handles deleting messages is as follows. You\n";
2001 print "mark the message as deleted, and then to 'really' delete it, you\n";
2002 print "expunge it. This option asks if you want to just have messages\n";
2003 print "marked as deleted, or if you want SquirrelMail to expunge the \n";
2004 print "messages too.\n";
2007 if ( lc($auto_expunge) eq 'true' ) {
2008 $default_value = "y";
2010 $default_value = "n";
2012 print "Auto expunge (y/n) [$WHT$default_value$NRM]: $WHT";
2013 $new_show = <STDIN
>;
2014 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2015 $auto_expunge = 'true';
2017 $auto_expunge = 'false';
2019 return $auto_expunge;
2022 # Default sub of inbox
2024 print "Some IMAP servers (Cyrus) have all folders as subfolders of INBOX.\n";
2025 print "This can cause some confusion in folder creation for users when\n";
2026 print "they try to create folders and don't put it as a subfolder of INBOX\n";
2027 print "and get permission errors. This option asks if you want folders\n";
2028 print "to be subfolders of INBOX by default.\n";
2031 if ( lc($default_sub_of_inbox) eq 'true' ) {
2032 $default_value = "y";
2034 $default_value = "n";
2036 print "Default sub of INBOX (y/n) [$WHT$default_value$NRM]: $WHT";
2037 $new_show = <STDIN
>;
2038 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2039 $default_sub_of_inbox = 'true';
2041 $default_sub_of_inbox = 'false';
2043 return $default_sub_of_inbox;
2046 # Show contain subfolder option
2048 print "Some IMAP servers (UW) make it so that there are two types of\n";
2049 print "folders. Those that contain messages, and those that contain\n";
2050 print "subfolders. If this is the case for your server, set this to\n";
2051 print "true, and it will ask the user whether the folder they are\n";
2052 print "creating contains subfolders or messages.\n";
2055 if ( lc($show_contain_subfolders_option) eq 'true' ) {
2056 $default_value = "y";
2058 $default_value = "n";
2060 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
2061 $new_show = <STDIN
>;
2062 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2063 $show_contain_subfolders_option = 'true';
2065 $show_contain_subfolders_option = 'false';
2067 return $show_contain_subfolders_option;
2070 # Default Unseen Notify
2072 print "This option specifies where the users will receive notification\n";
2073 print "about unseen messages by default. This is of course an option that\n";
2074 print "can be changed on a user level.\n";
2075 print " 1 = No notification\n";
2076 print " 2 = Only on the INBOX\n";
2077 print " 3 = On all folders\n";
2080 print "Which one should be default (1,2,3)? [$WHT$default_unseen_notify$NRM]: $WHT";
2081 $new_show = <STDIN
>;
2082 if ( $new_show =~ /^[123]\n/i ) {
2083 $default_unseen_notify = $new_show;
2085 $default_unseen_notify =~ s/[\r\n]//g;
2086 return $default_unseen_notify;
2089 # Default Unseen Type
2091 print "Here you can define the default way that unseen messages will be displayed\n";
2092 print "to the user in the folder listing on the left side.\n";
2093 print " 1 = Only unseen messages (4)\n";
2094 print " 2 = Unseen and Total messages (4/27)\n";
2097 print "Which one should be default (1,2)? [$WHT$default_unseen_type$NRM]: $WHT";
2098 $new_show = <STDIN
>;
2099 if ( $new_show =~ /^[12]\n/i ) {
2100 $default_unseen_type = $new_show;
2102 $default_unseen_type =~ s/[\r\n]//g;
2103 return $default_unseen_type;
2106 # Auto create special folders
2108 print "Would you like the Sent, Trash, and Drafts folders to be created\n";
2109 print "automatically print for you when a user logs in? If the user\n";
2110 print "accidentally deletes their special folders, this option will\n";
2111 print "automatically create it again for them.\n";
2114 if ( lc($auto_create_special) eq 'true' ) {
2115 $default_value = "y";
2117 $default_value = "n";
2119 print "Auto create special folders? (y/n) [$WHT$default_value$NRM]: $WHT";
2120 $new_show = <STDIN
>;
2121 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2122 $auto_create_special = 'true';
2124 $auto_create_special = 'false';
2126 return $auto_create_special;
2129 # Automatically delete folders
2131 if ( $imap_server_type eq "uw" ) {
2132 print "UW IMAP servers will not allow folders containing mail to also contain folders.\n";
2133 print "Deleting folders will bypass the trash folder and be immediately deleted\n\n";
2134 print "If this is not the correct value for your server,\n";
2135 print "please use option D on the Main Menu to configure your server correctly.\n\n";
2136 print "Press enter to continue...\n";
2137 $new_delete = <STDIN
>;
2138 $delete_folder = 'true';
2140 if ( $imap_server_type eq "courier" ) {
2141 print "Courier (or Courier-IMAP) IMAP servers may not support ";
2142 print "subfolders of Trash. \n";
2143 print "Specifically, if Courier is set to always move messages to Trash, \n";
2144 print "Trash will be treated by Courier as a special folder that does not \n";
2145 print "allow subfolders. \n\n";
2146 print "Please verify your Courier configuration, and test folder deletion \n";
2147 print "when changing this setting.\n\n";
2150 print "Are subfolders of the Trash supported by your IMAP server?\n";
2151 print "If so, should deleted folders be sent to Trash?\n";
2152 print "If not, say no (deleted folders should not be sent to Trash)\n\n";
2153 # reversal of logic.
2154 # question was: Should folders be automatically deleted instead of sent to trash..
2155 # we've changed the question to make it more clear,
2156 # and are here handling that to avoid changing the answers..
2157 if ( lc($delete_folder) eq 'true' ) {
2158 $default_value = "n";
2160 $default_value = "y";
2162 print "Send deleted folders to Trash? (y/n) [$WHT$default_value$NRM]: $WHT";
2163 $new_delete = <STDIN
>;
2164 if ( ( $new_delete =~ /^y\n/i ) || ( ( $new_delete =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2165 $delete_folder = 'false';
2167 $delete_folder = 'true';
2170 return $delete_folder;
2175 print "Some IMAP server allow subfolders to exist even if the parent\n";
2176 print "folders do not. This fixes some problems with the folder list\n";
2177 print "when this is the case, causing the /NoSelect folders to be displayed\n";
2180 if ( lc($noselect_fix_enable) eq 'true' ) {
2181 $default_value = "y";
2183 $default_value = "n";
2185 print "enable noselect fix? (y/n) [$WHT$noselect_fix_enable$NRM]: $WHT";
2186 $noselect_fix_enable = <STDIN
>;
2187 if ( ( $noselect_fix_enable =~ /^y\n/i ) || ( ( $noselect_fix_enable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2188 $noselect_fix_enable = 'true';
2190 $noselect_fix_enable = 'false';
2192 return $noselect_fix_enable;
2194 ############# GENERAL OPTIONS #####################
2198 print "Specify the location for your data directory.\n";
2199 print "You need to create this directory yourself.\n";
2200 print "The path name can be absolute or relative (to the config directory).\n";
2201 print "Here are two examples:\n";
2202 print " Absolute: /var/local/squirrelmail/data/\n";
2203 print " Relative: ../data/\n";
2204 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2205 print "will be converted to their absolute path equivalents in config.php.\n\n";
2206 print "Note: There are potential security risks with having a writeable directory\n";
2207 print "under the web server's root directory (ex: /home/httpd/html).\n";
2208 print "For this reason, it is recommended to put the data directory\n";
2209 print "in an alternate location of your choice. \n";
2212 print "[$WHT$data_dir$NRM]: $WHT";
2213 $new_data_dir = <STDIN
>;
2214 if ( $new_data_dir eq "\n" ) {
2215 $new_data_dir = $data_dir;
2217 $new_data_dir =~ s/[\r\n]//g;
2219 if ( $new_data_dir =~ /^\s*$/ ) {
2222 $new_data_dir =~ s/\/*$//g
;
2223 $new_data_dir =~ s/$/\//g
;
2225 return $new_data_dir;
2228 # Attachment directory
2230 print "Path to directory used for storing attachments while a mail is\n";
2231 print "being composed. The path name can be absolute or relative (to the\n";
2232 print "config directory). Here are two examples:\n";
2233 print " Absolute: /var/local/squirrelmail/attach/\n";
2234 print " Relative: ../attach/\n";
2235 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2236 print "will be converted to their absolute path equivalents in config.php.\n\n";
2237 print "Note: There are a few security considerations regarding this\n";
2238 print "directory:\n";
2239 print " 1. It should have the permission 733 (rwx-wx-wx) to make it\n";
2240 print " impossible for a random person with access to the webserver\n";
2241 print " to list files in this directory. Confidential data might\n";
2242 print " be laying around in there.\n";
2243 print " Depending on your user:group assignments, 730 (rwx-wx---)\n";
2244 print " may be possible, and more secure (e.g. root:apache)\n";
2245 print " 2. Since the webserver is not able to list the files in the\n";
2246 print " content is also impossible for the webserver to delete files\n";
2247 print " lying around there for too long.\n";
2248 print " 3. It should probably be another directory than the data\n";
2249 print " directory specified in option 3.\n";
2252 print "[$WHT$attachment_dir$NRM]: $WHT";
2253 $new_attachment_dir = <STDIN
>;
2254 if ( $new_attachment_dir eq "\n" ) {
2255 $new_attachment_dir = $attachment_dir;
2257 $new_attachment_dir =~ s/[\r\n]//g;
2259 if ( $new_attachment_dir =~ /^\s*$/ ) {
2260 $new_attachment_dir = "";
2262 $new_attachment_dir =~ s/\/*$//g
;
2263 $new_attachment_dir =~ s/$/\//g
;
2265 return $new_attachment_dir;
2269 print "The directory hash level setting allows you to configure the level\n";
2270 print "of hashing that SquirrelMail employs in your data and attachment\n";
2271 print "directories. This value must be an integer ranging from 0 to 4.\n";
2272 print "When this value is set to 0, SquirrelMail will simply store all\n";
2273 print "files as normal in the data and attachment directories. However,\n";
2274 print "when set to a value from 1 to 4, a simple hashing scheme will be\n";
2275 print "used to organize the files in this directory. In short, the crc32\n";
2276 print "value for a username will be computed. Then, up to the first 4\n";
2277 print "digits of the hash, as set by this configuration value, will be\n";
2278 print "used to directory hash the files for that user in the data and\n";
2279 print "attachment directory. This allows for better performance on\n";
2280 print "servers with larger numbers of users.\n";
2283 print "[$WHT$dir_hash_level$NRM]: $WHT";
2284 $new_dir_hash_level = <STDIN
>;
2285 if ( $new_dir_hash_level eq "\n" ) {
2286 $new_dir_hash_level = $dir_hash_level;
2288 $new_dir_hash_level =~ s/[\r\n]//g;
2290 if ( ( int($new_dir_hash_level) < 0 )
2291 || ( int($new_dir_hash_level) > 4 )
2292 || !( int($new_dir_hash_level) eq $new_dir_hash_level ) ) {
2293 print "Invalid Directory Hash Level.\n";
2294 print "Value must be an integer ranging from 0 to 4\n";
2295 print "Hit enter to continue.\n";
2296 $enter_key = <STDIN
>;
2298 $new_dir_hash_level = $dir_hash_level;
2301 return $new_dir_hash_level;
2305 print "This is the default size (in pixels) of the left folder list.\n";
2306 print "Default is 200, but you can set it to whatever you wish. This\n";
2307 print "is a user preference, so this will only show up as their default.\n";
2309 print "[$WHT$default_left_size$NRM]: $WHT";
2310 $new_default_left_size = <STDIN
>;
2311 if ( $new_default_left_size eq "\n" ) {
2312 $new_default_left_size = $default_left_size;
2314 $new_default_left_size =~ s/[\r\n]//g;
2316 return $new_default_left_size;
2320 print "Some IMAP servers only have lowercase letters in the usernames\n";
2321 print "but they still allow people with uppercase to log in. This\n";
2322 print "causes a problem with the user's preference files. This option\n";
2323 print "transparently changes all usernames to lowercase.";
2326 if ( lc($force_username_lowercase) eq 'true' ) {
2327 $default_value = "y";
2329 $default_value = "n";
2331 print "Convert usernames to lowercase (y/n) [$WHT$default_value$NRM]: $WHT";
2332 $new_show = <STDIN
>;
2333 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2343 if ( lc($default_use_priority) eq 'true' ) {
2344 $default_value = "y";
2346 $default_value = "n";
2349 print "Allow users to specify priority of outgoing mail (y/n) [$WHT$default_value$NRM]: $WHT";
2350 $new_show = <STDIN
>;
2351 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2361 if ( lc($default_hide_attribution) eq 'true' ) {
2362 $default_value = "y";
2364 $default_value = "n";
2367 print "Hide SM attributions (y/n) [$WHT$default_value$NRM]: $WHT";
2368 $new_show = <STDIN
>;
2369 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2379 if ( lc($default_use_mdn) eq 'true' ) {
2380 $default_value = "y";
2382 $default_value = "n";
2385 print "Enable support for read/delivery receipt support (y/n) [$WHT$default_value$NRM]: $WHT";
2386 $new_show = <STDIN
>;
2387 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2395 print " In loosely managed environments, you may want to allow users
2396 to edit their full name and email address. In strictly managed
2397 environments, you may want to force users to use the name
2398 and email address assigned to them.
2400 'y' - allow a user to edit their full name and email address,
2401 'n' - users must use the assigned values.
2405 if ( lc($edit_identity) eq 'true' ) {
2406 $default_value = "y";
2408 $default_value = "n";
2410 print "Allow editing of user's identity? (y/n) [$WHT$default_value$NRM]: $WHT";
2411 $new_edit = <STDIN
>;
2412 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2413 $edit_identity = 'true';
2414 $edit_name = 'true';
2415 $hide_auth_header = command311b
();
2417 $edit_identity = 'false';
2418 $edit_name = command311
();
2419 $hide_auth_header = command311b
();
2421 return $edit_identity;
2425 print " Given that users are not allowed to modify their
2426 email address, can they edit their full name?
2430 if ( lc($edit_name) eq 'true' ) {
2431 $default_value = "y";
2433 $default_value = "n";
2435 print "Allow the user to edit their full name? (y/n) [$WHT$default_value$NRM]: $WHT";
2436 $new_edit = <STDIN
>;
2437 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2438 $edit_name = 'true';
2440 $edit_name = 'false';
2446 print " SquirrelMail adds username information to every sent email
2447 in order to prevent possible sender forging when users are allowed
2448 to change their email and/or full name.
2450 You can remove user information from this header (y), if you think that
2451 it violates privacy or security.
2453 Note: If users are allowed to change their email addresses,
2454 this setting will make it difficult to determine who sent what where.
2455 Use at your own risk.
2459 if ( lc($hide_auth_header) eq "true" ) {
2460 $default_value = "y";
2462 $default_value = "n";
2464 print "Remove username from email headers? (y/n) [$WHT$default_value$NRM]: $WHT";
2465 $new_header = <STDIN
>;
2466 if ( ( $new_header =~ /^y\n/i ) || ( ( $new_header =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2467 $hide_auth_header = "true";
2469 $hide_auth_header = "false";
2471 return $hide_auth_header;
2475 print "This option allows you to disable server side thread sorting if your server \n";
2476 print "declares THREAD support, but you don't want to provide threading options \n";
2477 print "to end users or THREAD extension is broken or extension does not work with \n";
2478 print "options used by SquirrelMail. Option is not used, if THREAD extension is \n";
2479 print "not declared in IMAP CAPABILITY.\n";
2482 if ( lc($disable_thread_sort) eq 'true' ) {
2483 $default_value = "y";
2485 $default_value = "n";
2487 print "Disable server side thread sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2488 $disable_thread_sort = <STDIN
>;
2489 if ( ( $disable_thread_sort =~ /^y\n/i ) || ( ( $disable_thread_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2490 $disable_thread_sort = 'true';
2492 $disable_thread_sort = 'false';
2494 return $disable_thread_sort;
2498 print "This option allows you to disable server side sorting if your server declares \n";
2499 print "SORT support, but SORT extension is broken or does not work with options \n";
2500 print "used by SquirrelMail. Option is not used, if SORT extension is not declared \n";
2501 print "in IMAP CAPABILITY.\n";
2503 print "It is strongly recommended to keep server side sorting enabled, if your ";
2504 print "IMAP server supports it.";
2507 if ( lc($disable_server_sort) eq 'true' ) {
2508 $default_value = "y";
2510 $default_value = "n";
2512 print "Disable server-side sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2513 $disable_server_sort = <STDIN
>;
2514 if ( ( $disable_server_sort =~ /^y\n/i ) || ( ( $disable_server_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2515 $disable_server_sort = 'true';
2517 $disable_server_sort = 'false';
2519 return $disable_server_sort;
2523 print "This option allows you to choose if SM uses charset search\n";
2524 print "Your IMAP server must support the SEARCH CHARSET command for this to work\n";
2527 if ( lc($allow_charset_search) eq 'true' ) {
2528 $default_value = "y";
2530 $default_value = "n";
2532 print "Allow charset searching? (y/n) [$WHT$default_value$NRM]: $WHT";
2533 $allow_charset_search = <STDIN
>;
2534 if ( ( $allow_charset_search =~ /^y\n/i ) || ( ( $allow_charset_search =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2535 $allow_charset_search = 'true';
2537 $allow_charset_search = 'false';
2539 return $allow_charset_search;
2542 # command315 (UID support) obsoleted.
2544 # advanced search option
2546 print "This option allows you to control the use of advanced search form.\n";
2547 print " 0 = enable basic search only\n";
2548 print " 1 = enable advanced search only\n";
2549 print " 2 = enable both\n";
2552 print "Allowed search (0,1,2)? [$WHT$allow_advanced_search$NRM]: $WHT";
2553 $new_allow_advanced_search = <STDIN
>;
2554 if ( $new_allow_advanced_search =~ /^[012]\n/i ) {
2555 $allow_advanced_search = $new_allow_advanced_search;
2557 $allow_advanced_search =~ s/[\r\n]//g;
2558 return $allow_advanced_search;
2563 print "This option allows you to change the name of the PHP session used\n";
2564 print "by SquirrelMail. Unless you know what you are doing, you probably\n";
2565 print "don't need or want to change this from the default of SQMSESSID.\n";
2566 print "[$WHT$session_name$NRM]: $WHT";
2567 $new_session_name = <STDIN
>;
2568 chomp($new_session_name);
2569 if ( $new_session_name eq "" ) {
2570 $new_session_name = $session_name;
2572 return $new_session_name;
2575 # time zone config (since 1.5.1)
2577 print "This option allows you to control the use of time zones.\n";
2578 print " 0 = (default) standard, GNU C time zone names\n";
2579 print " 1 = strict, generic time zone codes with offsets\n";
2580 print " 2 = custom, GNU C time zones loaded from config/timezones.php\n";
2581 print " 3 = custom strict, generic time zone codes with offsets loaded \n";
2582 print " from config/timezones.php\n";
2583 print "See SquirrelMail documentation about format of config/timezones.php file.\n";
2586 print "Used time zone configuration (0,1,2,3)? [$WHT$time_zone_type$NRM]: $WHT";
2587 $new_time_zone_type = <STDIN
>;
2588 if ( $new_time_zone_type =~ /^[0123]\n/i ) {
2589 $time_zone_type = $new_time_zone_type;
2591 print "\nInvalid configuration value.\n";
2592 print "\nPress enter to continue...";
2595 $time_zone_type =~ s/[\r\n]//g;
2596 return $time_zone_type;
2599 # set the location base for redirects (since 1.5.2)
2600 sub command_config_location_base
{
2601 print "Here you can set the base part of the SquirrelMail URL.\n";
2602 print "It is normally autodetected but if that fails, use this\n";
2603 print "option to override.\n";
2604 print "It should contain only the protocol and hostname/port parts\n";
2605 print "of the URL; the full path will be appended automatically.\n\n";
2606 print "Examples:\nhttp://webmail.example.org\nhttp://webmail.example.com:8080\nhttps://webmail.example.com:6691\n\n";
2607 print "Do not add any path elements.\n";
2609 print "URL base? [" .$WHT."autodetect$NRM]: $WHT";
2610 $new_config_location_base = <STDIN
>;
2611 chomp($new_config_location_base);
2612 $config_location_base = $new_config_location_base;
2614 return $config_location_base;
2618 sub command_userThemes
{
2619 print "\nDefine the user themes that you wish to use. If you have added\n";
2620 print "a theme of your own, just follow the instructions (?) about\n";
2621 print "how to add them. You can also change the default theme.\n\n";
2623 print "Available user themes:\n";
2625 while ( $count <= $#user_theme_name ) {
2626 if ( $count == $user_theme_default ) {
2631 if ( $count < 10 ) {
2634 $name = $user_theme_name[$count];
2635 $num_spaces = 35 - length($name);
2636 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2637 $name = $name . " ";
2640 print " $count. $name";
2641 print "($user_theme_path[$count])\n";
2647 print ".------------------------------------.\n";
2648 print "| t (detect user themes) |\n";
2649 print "| + (add user theme) |\n";
2650 print "| - N (remove user theme) |\n";
2651 print "| m N (mark default user theme) |\n";
2652 print "| l (list user themes) |\n";
2653 print "| d (done) |\n";
2654 print "`------------------------------------'\n";
2656 print "\n[user_themes] command (?=help) > ";
2658 $input =~ s/[\r\n]//g;
2659 while ( $input ne "d" ) {
2660 if ( $input =~ /^\s*l\s*/i ) {
2662 while ( $count <= $#user_theme_name ) {
2663 if ( $count == $user_theme_default ) {
2668 if ( $count < 10 ) {
2671 $name = $user_theme_name[$count];
2672 $num_spaces = 35 - length($name);
2673 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2674 $name = $name . " ";
2677 print " $count. $name";
2678 print "($user_theme_path[$count])\n";
2682 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2683 $old_def = $user_theme_default;
2684 $user_theme_default = $input;
2685 $user_theme_default =~ s/^\s*m\s*//;
2686 if ( ( $user_theme_default > $#user_theme_name ) || ( $user_theme_default < 0 ) ) {
2687 print "Cannot set default theme to $user_theme_default. That theme does not exist.\n";
2688 $user_theme_default = $old_def;
2690 } elsif ( $input =~ /^\s*\+/ ) {
2691 print "What is the name of this theme? ";
2693 $name =~ s/[\r\n]//g;
2694 $user_theme_name[ $#user_theme_name + 1 ] = $name;
2695 print "Be sure to put ../css/ before the filename.\n";
2696 print "What file is this stored in (ex: ../css/my_theme/): ";
2698 $name =~ s/[\r\n]//g;
2699 $user_theme_path[ $#user_theme_path + 1 ] = $name;
2700 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2701 if ( $input =~ /[0-9]+\s*$/ ) {
2703 $rem_num =~ s/^\s*-\s*//g;
2704 $rem_num =~ s/\s*$//;
2706 $rem_num = $#user_theme_name;
2708 if ( $rem_num == $user_theme_default ) {
2709 print "You cannot remove the default theme!\n";
2712 @new_theme_name = ();
2713 @new_theme_path = ();
2714 while ( $count <= $#user_theme_name ) {
2715 if ( $count != $rem_num ) {
2716 @new_theme_name = ( @new_theme_name, $user_theme_name[$count] );
2717 @new_theme_path = ( @new_theme_path, $user_theme_path[$count] );
2721 @user_theme_name = @new_theme_name;
2722 @user_theme_path = @new_theme_path;
2723 if ( $user_theme_default > $rem_num ) {
2724 $user_theme_default--;
2727 } elsif ( $input =~ /^\s*t\s*/i ) {
2728 print "\nStarting detection...\n\n";
2730 opendir( DIR
, "../css" );
2731 @files = readdir(DIR
);
2733 while ( $cnt <= $#files ) {
2734 $filename = "../css/" . $files[$cnt] .'/';
2735 if ( $filename ne "../css/rtl.css" && -e
$filename . "default.css" ) {
2737 for ( $x = 0 ; $x <= $#user_theme_path ; $x++ ) {
2738 if ( $user_theme_path[$x] eq $filename ) {
2742 if ( $found != 1 ) {
2743 print "** Found user theme: $filename\n";
2744 print " What is its name? ";
2747 $user_theme_name[ $#user_theme_name + 1 ] = $nm;
2748 $user_theme_path[ $#user_theme_path + 1 ] = $filename;
2754 for ( $cnt = 0 ; $cnt <= $#user_theme_path ; $cnt++ ) {
2755 $filename = $user_theme_path[$cnt];
2756 if ( $filename != 'none' && !( -e
$filename ."/default.css" ) ) {
2757 print " Removing $filename (file not found)\n";
2759 @new_user_theme_name = ();
2760 @new_user_theme_path = ();
2761 for ( $x = 0 ; $x < $#user_theme_path ; $x++ ) {
2762 if ( $user_theme_path[$x] eq $filename ) {
2765 if ( $offset == 1 ) {
2766 $new_user_theme_name[$x] = $user_theme_name[ $x + 1 ];
2767 $new_user_theme_path[$x] = $user_theme_path[ $x + 1 ];
2769 $new_user_theme_name[$x] = $user_theme_name[$x];
2770 $new_user_theme_path[$x] = $user_theme_path[$x];
2773 @user_theme_name = @new_user_theme_name;
2774 @user_theme_path = @new_user_theme_path;
2777 print "\nDetection complete!\n\n";
2780 } elsif ( $input =~ /^\s*\?\s*/ ) {
2781 print ".------------------------------------.\n";
2782 print "| t (detect user themes) |\n";
2783 print "| + (add user theme) |\n";
2784 print "| - N (remove user theme) |\n";
2785 print "| m N (mark default user theme) |\n";
2786 print "| l (list user themes) |\n";
2787 print "| d (done) |\n";
2788 print "`------------------------------------'\n";
2790 print "[user_themes] command (?=help) > ";
2792 $input =~ s/[\r\n]//g;
2796 sub command_iconSets
{
2797 print "\nDefine the icon themes that you wish to use. If you have added\n";
2798 print "a theme of your own, just follow the instructions (?) about\n";
2799 print "how to add them. You can also change the default and fallback\n";
2800 print "themes. The default theme will be used when no icon theme is\n";
2801 print "set by the user. The fallback theme will be used if an icon\n";
2802 print "cannot be found in the currently selected icon theme.\n\n";
2804 print "Available icon themes:\n\n";
2807 while ( $count <= $#icon_theme_name ) {
2808 if ( $count == $icon_theme_def ) {
2813 if ( $count eq $icon_theme_fallback ) {
2818 if ( $count < 10 ) {
2821 $name = $icon_theme_name[$count];
2822 $num_spaces = 35 - length($name);
2823 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2824 $name = $name . " ";
2827 print " $count. $name";
2828 print "($icon_theme_path[$count])\n";
2833 print "\n d = Default icon theme\n";
2834 print " f = Fallback icon theme\n";
2836 print ".------------------------------------.\n";
2837 print "| t (detect icon themes) |\n";
2838 print "| + (add icon theme) |\n";
2839 print "| - N (remove icon theme) |\n";
2840 print "| m N (mark default icon theme) |\n";
2841 print "| f N (set fallback icon set) |\n";
2842 print "| l (list icon themes) |\n";
2843 print "| d (done) |\n";
2844 print "`------------------------------------'\n";
2846 print "\n[icon_themes] command (?=help) > ";
2848 $input =~ s/[\r\n]//g;
2849 while ( $input ne "d" ) {
2850 if ( $input =~ /^\s*l\s*/i ) {
2853 while ( $count <= $#icon_theme_name ) {
2854 if ( $count == $icon_theme_def ) {
2859 if ( $count eq $icon_theme_fallback ) {
2864 $name = $icon_theme_name[$count];
2865 $num_spaces = 35 - length($name);
2866 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2867 $name = $name . " ";
2870 print " $count. $name";
2871 print "($icon_theme_path[$count])\n";
2875 print "\n d = Default icon theme\n";
2876 print " f = Fallback icon theme\n\n";
2877 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2878 $old_def = $icon_theme_def;
2879 $icon_theme_def = $input;
2880 $icon_theme_def =~ s/^\s*m\s*//;
2881 if ( ( $icon_theme_default > $#icon_theme_name ) || ( $icon_theme_default < 0 ) ) {
2882 print "Cannot set default icon theme to $icon_theme_default. That theme does not exist.\n";
2883 $icon_theme_def = $old_def;
2885 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
2886 $old_fb = $icon_theme_fallback;
2887 $icon_theme_fallback = $input;
2888 $icon_theme_fallback =~ s/^\s*f\s*//;
2889 if ( ( $icon_theme_fallback > $#icon_theme_name ) || ( $icon_theme_fallback < 0 ) ) {
2890 print "Cannot set fallback icon theme to $icon_theme_fallback. That theme does not exist.\n";
2891 $icon_theme_fallback = $old_fb;
2893 } elsif ( $input =~ /^\s*\+/ ) {
2894 print "What is the name of this icon theme? ";
2896 $name =~ s/[\r\n]//g;
2897 $icon_theme_name[ $#icon_theme_name + 1 ] = $name;
2898 print "Be sure to put ../images/themes/ before the filename.\n";
2899 print "What directory is this icon theme stored in (ex: ../images/themes/my_theme/)? ";
2901 $name =~ s/[\r\n]//g;
2902 $icon_theme_path[ $#icon_theme_path + 1 ] = $name;
2903 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2904 if ( $input =~ /[0-9]+\s*$/ ) {
2906 $rem_num =~ s/^\s*-\s*//g;
2907 $rem_num =~ s/\s*$//;
2909 $rem_num = $#icon_theme_name;
2911 if ( $rem_num == $icon_theme_def ) {
2912 print "You cannot remove the default icon theme!\n";
2913 } elsif ( $rem_num == $icon_theme_fallback ) {
2914 print "You cannot remove the fallback icon theme!\n";
2917 @new_theme_name = ();
2918 @new_theme_path = ();
2919 while ( $count <= $#icon_theme_name ) {
2920 if ( $count != $rem_num ) {
2921 @new_theme_name = ( @new_theme_name, $icon_theme_name[$count] );
2922 @new_theme_path = ( @new_theme_path, $icon_theme_path[$count] );
2926 @icon_theme_name = @new_theme_name;
2927 @icon_theme_path = @new_theme_path;
2928 if ( $icon_theme_def > $rem_num ) {
2932 } elsif ( $input =~ /^\s*t\s*/i ) {
2933 print "\nStarting detection...\n\n";
2935 opendir( DIR
, "../images/themes/" );
2936 @files = readdir(DIR
);
2938 while ( $cnt <= $#files ) {
2939 $filename = "../images/themes/" . $files[$cnt] .'/';
2940 if ( -d
"../images/themes/" . $files[$cnt] && $files[$cnt] !~ /^\
./ && $files[$cnt] ne "CVS" ) {
2942 for ( $x = 0 ; $x <= $#icon_theme_path ; $x++ ) {
2943 if ( $icon_theme_path[$x] eq $filename ) {
2947 if ( $found != 1 ) {
2948 print "** Found icon theme: $filename\n";
2949 print " What is its name? ";
2952 $icon_theme_name[ $#icon_theme_name + 1 ] = $nm;
2953 $icon_theme_path[ $#icon_theme_path + 1 ] = $filename;
2959 for ( $cnt = 0 ; $cnt <= $#icon_theme_path ; $cnt++ ) {
2960 $filename = $icon_theme_path[$cnt];
2961 if ( $filename ne "none" && $filename ne "template" && ! -d
$filename ) {
2962 print " Removing $filename (file not found)\n";
2964 @new_icon_theme_name = ();
2965 @new_icon_theme_path = ();
2966 for ( $x = 0 ; $x < $#icon_theme_path ; $x++ ) {
2967 if ( $icon_theme_path[$x] eq $filename ) {
2970 if ( $offset == 1 ) {
2971 $new_icon_theme_name[$x] = $icon_theme_name[ $x + 1 ];
2972 $new_icon_theme_path[$x] = $icon_theme_path[ $x + 1 ];
2974 $new_icon_theme_name[$x] = $icon_theme_name[$x];
2975 $new_icon_theme_path[$x] = $icon_theme_path[$x];
2978 @icon_theme_name = @new_icon_theme_name;
2979 @icon_theme_path = @new_icon_theme_path;
2982 print "\nDetection complete!\n\n";
2985 } elsif ( $input =~ /^\s*\?\s*/ ) {
2986 print ".------------------------------------.\n";
2987 print "| t (detect icon themes) |\n";
2988 print "| + (add icon theme) |\n";
2989 print "| - N (remove icon theme) |\n";
2990 print "| m N (mark default icon theme) |\n";
2991 print "| f N (set fallback icon set) |\n";
2992 print "| l (list icon themes) |\n";
2993 print "| d (done) |\n";
2994 print "`------------------------------------'\n";
2996 print "[icon_themes] command (?=help) > ";
2998 $input =~ s/[\r\n]//g;
3002 sub command_templates
{
3003 print "\nDefine the template sets that you wish to use. If you have added\n";
3004 print "a template set of your own, just follow the instructions (?) about\n";
3005 print "how to add them. You can also change the default template.\n";
3007 print "\n Available Templates:\n";
3010 while ( $count <= $#templateset_name ) {
3011 if ( $templateset_id[$count] eq $templateset_default ) {
3016 if ( $templateset_id[$count] eq $templateset_fallback ) {
3021 if ( $count < 10 ) {
3024 $name = $templateset_name[$count];
3025 $num_spaces = 35 - length($name);
3026 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3027 $name = $name . " ";
3030 print " $count. $name";
3031 print "($templateset_id[$count])\n";
3035 print "\n d = default template set\n"
3036 . " f = fallback template set\n\n";
3038 $menu_text = ".-------------------------------------.\n"
3039 . "| t (detect template set) |\n"
3040 . "| + (add template set) |\n"
3041 . "| - N (remove template set) |\n"
3042 . "| m N (mark default template set) |\n"
3043 . "| f N (set fallback template set) |\n"
3044 . "| l (list template sets) |\n"
3046 . "|-------------------------------------|\n"
3047 . "| where N is a template set number |\n"
3048 . "`-------------------------------------'\n";
3051 print "\n[template set] command (?=help) > ";
3054 $input =~ s/[\r\n]//g;
3055 while ( $input ne "d" ) {
3057 # list template sets
3059 if ( $input =~ /^\s*l\s*/i ) {
3061 while ( $count <= $#templateset_name ) {
3062 if ( $templateset_id[$count] eq $templateset_default ) {
3067 if ( $templateset_id[$count] eq $templateset_fallback ) {
3072 if ( $count < 10 ) {
3075 $name = $templateset_name[$count];
3076 $num_spaces = 35 - length($name);
3077 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3078 $name = $name . " ";
3081 print " $count. $name";
3082 print "($templateset_id[$count])\n";
3086 print "\n d = default template set\n"
3087 . " f = fallback template set\n\n";
3089 # mark default template set