4 # Copyright (c) 1999-2007 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 || $provider_name eq 'SquirrelMail');
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 );
474 $only_secure_cookies = 'true' if ( !$only_secure_cookies );
476 if ( $ARGV[0] eq '--install-plugin' ) {
477 print "Activating plugin " . $ARGV[1] . "\n";
478 push @plugins, $ARGV[1];
481 } elsif ( $ARGV[0] eq '--remove-plugin' ) {
482 print "Removing plugin " . $ARGV[1] . "\n";
483 foreach $plugin (@plugins) {
484 if ( $plugin ne $ARGV[1] ) {
485 push @newplugins, $plugin;
488 @plugins = @newplugins;
491 } elsif ( $ARGV[0] eq '--update-plugins' or $ARGV[0] eq '-u') {
492 build_plugin_hook_array
();
494 } elsif ( $ARGV[0] eq '--help' or $ARGV[0] eq '-h') {
495 print "SquirrelMail Configuration Script\n";
497 print " * No arguments: initiates the configuration dialog\n";
498 print " * --install-plugin <plugin> : activates the specified plugin\n";
499 print " * --remove-plugin <plugin> : deactivates the specified plugin\n";
500 print " * --update-plugins , -u : rebuilds plugin_hooks.php according\n";
501 print " to plugins activated in config.php\n";
502 print " * --help , -h : Displays this help\n";
509 ####################################################################################
511 # used in multiple places, define once
512 $list_supported_imap_servers =
513 " bincimap = Binc IMAP server\n" .
514 " courier = Courier IMAP server\n" .
515 " cyrus = Cyrus IMAP server\n" .
516 " dovecot = Dovecot Secure IMAP server\n" .
517 " exchange = Microsoft Exchange IMAP server\n" .
518 " hmailserver = hMailServer\n" .
519 " macosx = Mac OS X Mailserver\n" .
520 " mercury32 = Mercury/32\n" .
521 " uw = University of Washington's IMAP server\n";
523 #####################################################################################
524 if ( $config_use_color == 1 ) {
530 $config_use_color = 2;
533 while ( ( $command ne "q" ) && ( $command ne "Q" ) && ( $command ne ":q" ) ) {
535 print $WHT. "SquirrelMail Configuration : " . $NRM;
536 if ( $config == 1 ) { print "Read: config.php"; }
537 elsif ( $config == 2 ) { print "Read: config_default.php"; }
538 print " ($print_config_version)\n";
539 print "---------------------------------------------------------\n";
542 print $WHT. "Main Menu --\n" . $NRM;
543 print "1. Organization Preferences\n";
544 print "2. Server Settings\n";
545 print "3. Folder Defaults\n";
546 print "4. General Options\n";
547 print "5. User Interface\n";
548 print "6. Address Books\n";
549 print "7. Message of the Day (MOTD)\n";
550 print "8. Plugins\n";
551 print "9. Database\n";
552 print "10. Language settings\n";
553 print "11. Tweaks\n";
555 print "D. Set pre-defined settings for specific IMAP servers\n";
557 } elsif ( $menu == 1 ) {
558 print $WHT. "Organization Preferences\n" . $NRM;
559 print "1. Organization Name : $WHT$org_name$NRM\n";
560 print "2. Organization Logo : $WHT$org_logo$NRM\n";
561 print "3. Org. Logo Width/Height : $WHT($org_logo_width/$org_logo_height)$NRM\n";
562 print "4. Organization Title : $WHT$org_title$NRM\n";
563 print "5. Signout Page : $WHT$signout_page$NRM\n";
564 print "6. Top Frame : $WHT$frame_top$NRM\n";
565 print "7. Provider link : $WHT$provider_uri$NRM\n";
566 print "8. Provider link text : $WHT$provider_name$NRM\n";
569 print "R Return to Main Menu\n";
570 } elsif ( $menu == 2 ) {
571 print $WHT. "Server Settings\n\n" . $NRM;
572 print $WHT . "General" . $NRM . "\n";
574 print "1. Domain : $WHT$domain$NRM\n";
575 print "2. Invert Time : $WHT$invert_time$NRM\n";
576 print "3. Sendmail or SMTP : $WHT";
577 if ( lc($useSendmail) eq 'true' ) {
585 if ( $show_imap_settings ) {
586 print $WHT . "IMAP Settings". $NRM . "\n--------------\n";
587 print "4. IMAP Server : $WHT$imapServerAddress$NRM\n";
588 print "5. IMAP Port : $WHT$imapPort$NRM\n";
589 print "6. Authentication type : $WHT$imap_auth_mech$NRM\n";
590 print "7. Secure IMAP (TLS) : $WHT" . display_use_tls
($use_imap_tls) . "$NRM\n";
591 print "8. Server software : $WHT$imap_server_type$NRM\n";
592 print "9. Delimiter : $WHT$optional_delimiter$NRM\n";
594 } elsif ( $show_smtp_settings ) {
595 if ( lc($useSendmail) eq 'true' ) {
596 print $WHT . "Sendmail" . $NRM . "\n--------\n";
597 print "4. Sendmail Path : $WHT$sendmail_path$NRM\n";
598 print "5. Sendmail arguments : $WHT$sendmail_args$NRM\n";
599 print "6. Header encryption key : $WHT$encode_header_key$NRM\n";
602 print $WHT . "SMTP Settings" . $NRM . "\n-------------\n";
603 print "4. SMTP Server : $WHT$smtpServerAddress$NRM\n";
604 print "5. SMTP Port : $WHT$smtpPort$NRM\n";
605 print "6. POP before SMTP : $WHT$pop_before_smtp$NRM\n";
606 print "7. SMTP Authentication : $WHT$smtp_auth_mech" . display_smtp_sitewide_userpass
() ."$NRM\n";
607 print "8. Secure SMTP (TLS) : $WHT" . display_use_tls
($use_smtp_tls) . "$NRM\n";
608 print "9. Header encryption key : $WHT$encode_header_key$NRM\n";
613 if ($show_imap_settings == 0) {
614 print "A. Update IMAP Settings : ";
615 print "$WHT$imapServerAddress$NRM:";
616 print "$WHT$imapPort$NRM ";
617 print "($WHT$imap_server_type$NRM)\n";
619 if ($show_smtp_settings == 0) {
620 if ( lc($useSendmail) eq 'true' ) {
621 print "B. Change Sendmail Config : $WHT$sendmail_path$NRM\n";
623 print "B. Update SMTP Settings : ";
624 print "$WHT$smtpServerAddress$NRM:";
625 print "$WHT$smtpPort$NRM\n";
628 if ( $show_smtp_settings || $show_imap_settings )
631 ($show_imap_settings ?
"IMAP Server" :
632 (lc($useSendmail) eq 'true') ?
"Sendmail" : "SMTP") . " Settings\n";
636 print "R Return to Main Menu\n";
637 } elsif ( $menu == 3 ) {
638 print $WHT. "Folder Defaults\n" . $NRM;
639 print "1. Default Folder Prefix : $WHT$default_folder_prefix$NRM\n";
640 print "2. Show Folder Prefix Option : $WHT$show_prefix_option$NRM\n";
641 print "3. Trash Folder : $WHT$trash_folder$NRM\n";
642 print "4. Sent Folder : $WHT$sent_folder$NRM\n";
643 print "5. Drafts Folder : $WHT$draft_folder$NRM\n";
644 print "6. By default, move to trash : $WHT$default_move_to_trash$NRM\n";
645 print "7. By default, move to sent : $WHT$default_move_to_sent$NRM\n";
646 print "8. By default, save as draft : $WHT$default_save_as_draft$NRM\n";
647 print "9. List Special Folders First : $WHT$list_special_folders_first$NRM\n";
648 print "10. Show Special Folders Color : $WHT$use_special_folder_color$NRM\n";
649 print "11. Auto Expunge : $WHT$auto_expunge$NRM\n";
650 print "12. Default Sub. of INBOX : $WHT$default_sub_of_inbox$NRM\n";
651 print "13. Show 'Contain Sub.' Option : $WHT$show_contain_subfolders_option$NRM\n";
652 print "14. Default Unseen Notify : $WHT$default_unseen_notify$NRM\n";
653 print "15. Default Unseen Type : $WHT$default_unseen_type$NRM\n";
654 print "16. Auto Create Special Folders : $WHT$auto_create_special$NRM\n";
655 print "17. Folder Delete Bypasses Trash : $WHT$delete_folder$NRM\n";
656 print "18. Enable /NoSelect folder fix : $WHT$noselect_fix_enable$NRM\n";
658 print "R Return to Main Menu\n";
659 } elsif ( $menu == 4 ) {
660 print $WHT. "General Options\n" . $NRM;
661 print "1. Data Directory : $WHT$data_dir$NRM\n";
662 print "2. Attachment Directory : $WHT$attachment_dir$NRM\n";
663 print "3. Directory Hash Level : $WHT$dir_hash_level$NRM\n";
664 print "4. Default Left Size : $WHT$default_left_size$NRM\n";
665 print "5. Usernames in Lowercase : $WHT$force_username_lowercase$NRM\n";
666 print "6. Allow use of priority : $WHT$default_use_priority$NRM\n";
667 print "7. Hide SM attributions : $WHT$hide_sm_attributions$NRM\n";
668 print "8. Allow use of receipts : $WHT$default_use_mdn$NRM\n";
669 print "9. Allow editing of identity : $WHT$edit_identity$NRM\n";
670 print " Allow editing of name : $WHT$edit_name$NRM\n";
671 print " Remove username from header : $WHT$hide_auth_header$NRM\n";
672 print "10. Disable server thread sort : $WHT$disable_thread_sort$NRM\n";
673 print "11. Disable server-side sorting : $WHT$disable_server_sort$NRM\n";
674 print "12. Allow server charset search : $WHT$allow_charset_search$NRM\n";
675 print "13. Allow advanced search : $WHT$allow_advanced_search$NRM\n";
676 print "14. PHP session name : $WHT$session_name$NRM\n";
677 print "15. Time zone configuration : $WHT$time_zone_type$NRM\n";
678 print "16. Location base : $WHT$config_location_base$NRM\n";
679 print "17. Only secure cookies if poss. : $WHT$only_secure_cookies$NRM\n";
681 print "R Return to Main Menu\n";
682 } elsif ( $menu == 5 ) {
683 print $WHT. "User Interface\n" . $NRM;
684 print "1. Use Icons? : $WHT$use_icons$NRM\n";
685 # print "3. Default Icon Set : $WHT$icon_theme_def$NRM\n";
686 print "2. Default font size : $WHT$default_fontsize$NRM\n";
687 print "3. Manage template sets\n";
688 print "4. Manage user themes\n";
689 print "5. Manage font sets\n";
690 print "6. Manage icon themes\n";
693 print "R Return to Main Menu\n";
694 } elsif ( $menu == 6 ) {
695 print $WHT. "Address Books\n" . $NRM;
696 print "1. Change LDAP Servers\n";
697 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
698 print " > $ldap_host[$count]\n";
700 print "2. Use Javascript address book search : $WHT$default_use_javascript_addr_book$NRM\n";
701 print "3. Global address book file : $WHT$abook_global_file$NRM\n";
702 print "4. Allow writing into global file address book : $WHT$abook_global_file_writeable$NRM\n";
703 print "5. Allow listing of global file address book : $WHT$abook_global_file_listing$NRM\n";
704 print "6. Allowed address book line length : $WHT$abook_file_line_length$NRM\n";
706 print "R Return to Main Menu\n";
707 } elsif ( $menu == 7 ) {
708 print $WHT. "Message of the Day (MOTD)\n" . $NRM;
711 print "1 Edit the MOTD\n";
713 print "R Return to Main Menu\n";
714 } elsif ( $menu == 8 ) {
715 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
716 print $WHT. "Plugins (WARNING: All plugins are currently disabled\n for the user \"$disable_plugins_user\"!)\n" . $NRM;
717 } elsif (lc($disable_plugins) eq 'true') {
718 print $WHT. "Plugins (WARNING: All plugins are currently disabled!)\n" . $NRM;
720 print $WHT. "Plugins\n" . $NRM;
722 print " Installed Plugins\n";
724 for ( $count = 0 ; $count <= $#plugins ; $count++ ) {
726 print " $num. $plugins[$count]" . get_plugin_version
($plugins[$count]) . "\n";
728 print "\n Available Plugins:\n";
729 opendir( DIR
, "../plugins" );
730 @files = readdir(DIR
);
732 @unused_plugins = ();
733 for ( $i = 0 ; $i <= $#files ; $i++ ) {
734 if ( -d
"../plugins/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne "CVS" ) {
736 for ( $k = 0 ; $k <= $#plugins ; $k++ ) {
737 if ( $plugins[$k] eq $files[$i] ) {
742 $unused_plugins[$pos] = $files[$i];
748 for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
750 print " $num. $unused_plugins[$i]" . get_plugin_version
($unused_plugins[$i]) . "\n";
755 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
756 print "E Enable active plugins (all plugins currently\n disabled for the user \"$disable_plugins_user\")\n";
757 } elsif (lc($disable_plugins) eq 'true') {
758 print "E Enable active plugins (all plugins currently\n disabled)\n";
760 print "D Disable all plugins\n";
762 print "U Set the user for whom plugins can be disabled\n";
763 print "R Return to Main Menu\n";
764 } elsif ( $menu == 9 ) {
765 print $WHT. "Database\n" . $NRM;
766 print "1. DSN for Address Book : $WHT$addrbook_dsn$NRM\n";
767 print "2. Table for Address Book : $WHT$addrbook_table$NRM\n";
769 print "3. DSN for Preferences : $WHT$prefs_dsn$NRM\n";
770 print "4. Table for Preferences : $WHT$prefs_table$NRM\n";
771 print "5. Field for username : $WHT$prefs_user_field$NRM ($prefs_user_size)\n";
772 print "6. Field for prefs key : $WHT$prefs_key_field$NRM ($prefs_key_size)\n";
773 print "7. Field for prefs value : $WHT$prefs_val_field$NRM ($prefs_val_size)\n";
775 print "8. DSN for Global Address Book : $WHT$addrbook_global_dsn$NRM\n";
776 print "9. Table for Global Address Book : $WHT$addrbook_global_table$NRM\n";
777 print "10. Allow writing into Global Address Book : $WHT$addrbook_global_writeable$NRM\n";
778 print "11. Allow listing of Global Address Book : $WHT$addrbook_global_listing$NRM\n";
780 print "R Return to Main Menu\n";
781 } elsif ( $menu == 10 ) {
782 print $WHT. "Language settings\n" . $NRM;
783 print "1. Default Language : $WHT$squirrelmail_default_language$NRM\n";
784 print "2. Default Charset : $WHT$default_charset$NRM\n";
785 print "3. Show alternative language names : $WHT$show_alternative_names$NRM\n";
786 print "4. Enable aggressive decoding : $WHT$aggressive_decoding$NRM\n";
787 print "5. Enable lossy encoding : $WHT$lossy_encoding$NRM\n";
789 print "R Return to Main Menu\n";
790 } elsif ( $menu == 11 ) {
791 print $WHT. "Interface tweaks\n" . $NRM;
792 print "1. Display html mails in iframe : $WHT$use_iframe$NRM\n";
794 print $WHT. "PHP tweaks\n" . $NRM;
795 print "4. Use php recode functions : $WHT$use_php_recode$NRM\n";
796 print "5. Use php iconv functions : $WHT$use_php_iconv$NRM\n";
798 print $WHT. "Configuration tweaks\n" . $NRM;
799 print "6. Allow remote configtest : $WHT$allow_remote_configtest$NRM\n";
801 print "R Return to Main Menu\n";
803 if ( $config_use_color == 1 ) {
804 print "C Turn color off\n";
806 print "C Turn color on\n";
808 print "S Save data\n";
812 print "Command >> " . $WHT;
814 $command =~ s/[\n\r]//g;
815 $command =~ tr/A-Z/a-z/;
818 # Read the commands they entered.
819 if ( $command eq "r" ) {
821 } elsif ( $command eq "s" ) {
823 print "Press enter to continue...";
826 } elsif ( ( $command eq "q" ) && ( $saved == 0 ) ) {
827 print "You have not saved your data.\n";
828 print "Save? [" . $WHT . "Y" . $NRM . "/n]: ";
830 if ( ( $save =~ /^y/i ) || ( $save =~ /^\s*$/ ) ) {
833 } elsif ( $command eq "c" ) {
834 if ( $config_use_color == 1 ) {
835 $config_use_color = 2;
839 $config_use_color = 1;
843 } elsif ( $command eq "d" && $menu == 0 ) {
848 if ( ( $command > 0 ) && ( $command < 12 ) ) {
851 } elsif ( $menu == 1 ) {
852 if ( $command == 1 ) { $org_name = command1
(); }
853 elsif ( $command == 2 ) { $org_logo = command2
(); }
854 elsif ( $command == 3 ) { ($org_logo_width,$org_logo_height) = command2a
(); }
855 elsif ( $command == 4 ) { $org_title = command3
(); }
856 elsif ( $command == 5 ) { $signout_page = command4
(); }
857 elsif ( $command == 6 ) { $frame_top = command6
(); }
858 elsif ( $command == 7 ) { $provider_uri = command7
(); }
859 elsif ( $command == 8 ) { $provider_name = command8
(); }
861 } elsif ( $menu == 2 ) {
862 if ( $command eq "a" ) { $show_imap_settings = 1; $show_smtp_settings = 0; }
863 elsif ( $command eq "b" ) { $show_imap_settings = 0; $show_smtp_settings = 1; }
864 elsif ( $command eq "h" ) { $show_imap_settings = 0; $show_smtp_settings = 0; }
865 elsif ( $command <= 3 ) {
866 if ( $command == 1 ) { $domain = command11
(); }
867 elsif ( $command == 2 ) { $invert_time = command110
(); }
868 elsif ( $command == 3 ) { $useSendmail = command14
(); }
869 $show_imap_settings = 0; $show_smtp_settings = 0;
870 } elsif ( $show_imap_settings ) {
871 if ( $command == 4 ) { $imapServerAddress = command12
(); }
872 elsif ( $command == 5 ) { $imapPort = command13
(); }
873 elsif ( $command == 6 ) { $imap_auth_mech = command112a
(); }
874 elsif ( $command == 7 ) { $use_imap_tls = command_use_tls
("IMAP",$use_imap_tls); }
875 elsif ( $command == 8 ) { $imap_server_type = command19
(); }
876 elsif ( $command == 9 ) { $optional_delimiter = command111
(); }
877 } elsif ( $show_smtp_settings && lc($useSendmail) eq 'true' ) {
878 if ( $command == 4 ) { $sendmail_path = command15
(); }
879 elsif ( $command == 5 ) { $sendmail_args = command_sendmail_args
(); }
880 elsif ( $command == 6 ) { $encode_header_key = command114
(); }
881 } elsif ( $show_smtp_settings ) {
882 if ( $command == 4 ) { $smtpServerAddress = command16
(); }
883 elsif ( $command == 5 ) { $smtpPort = command17
(); }
884 elsif ( $command == 6 ) { $pop_before_smtp = command18a
(); }
885 elsif ( $command == 7 ) { $smtp_auth_mech = command112b
(); }
886 elsif ( $command == 8 ) { $use_smtp_tls = command_use_tls
("SMTP",$use_smtp_tls); }
887 elsif ( $command == 9 ) { $encode_header_key = command114
(); }
889 } elsif ( $menu == 3 ) {
890 if ( $command == 1 ) { $default_folder_prefix = command21
(); }
891 elsif ( $command == 2 ) { $show_prefix_option = command22
(); }
892 elsif ( $command == 3 ) { $trash_folder = command23a
(); }
893 elsif ( $command == 4 ) { $sent_folder = command23b
(); }
894 elsif ( $command == 5 ) { $draft_folder = command23c
(); }
895 elsif ( $command == 6 ) { $default_move_to_trash = command24a
(); }
896 elsif ( $command == 7 ) { $default_move_to_sent = command24b
(); }
897 elsif ( $command == 8 ) { $default_save_as_draft = command24c
(); }
898 elsif ( $command == 9 ) { $list_special_folders_first = command27
(); }
899 elsif ( $command == 10 ) { $use_special_folder_color = command28
(); }
900 elsif ( $command == 11 ) { $auto_expunge = command29
(); }
901 elsif ( $command == 12 ) { $default_sub_of_inbox = command210
(); }
902 elsif ( $command == 13 ) { $show_contain_subfolders_option = command211
(); }
903 elsif ( $command == 14 ) { $default_unseen_notify = command212
(); }
904 elsif ( $command == 15 ) { $default_unseen_type = command213
(); }
905 elsif ( $command == 16 ) { $auto_create_special = command214
(); }
906 elsif ( $command == 17 ) { $delete_folder = command215
(); }
907 elsif ( $command == 18 ) { $noselect_fix_enable = command216
(); }
908 } elsif ( $menu == 4 ) {
909 if ( $command == 1 ) { $data_dir = command33a
(); }
910 elsif ( $command == 2 ) { $attachment_dir = command33b
(); }
911 elsif ( $command == 3 ) { $dir_hash_level = command33c
(); }
912 elsif ( $command == 4 ) { $default_left_size = command35
(); }
913 elsif ( $command == 5 ) { $force_username_lowercase = command36
(); }
914 elsif ( $command == 6 ) { $default_use_priority = command37
(); }
915 elsif ( $command == 7 ) { $hide_sm_attributions = command38
(); }
916 elsif ( $command == 8 ) { $default_use_mdn = command39
(); }
917 elsif ( $command == 9 ) { $edit_identity = command310
(); }
918 elsif ( $command == 10 ) { $disable_thread_sort = command312
(); }
919 elsif ( $command == 11 ) { $disable_server_sort = command313
(); }
920 elsif ( $command == 12 ) { $allow_charset_search = command314
(); }
921 elsif ( $command == 13 ) { $allow_advanced_search = command316
(); }
922 elsif ( $command == 14 ) { $session_name = command317
(); }
923 elsif ( $command == 15 ) { $time_zone_type = command318
(); }
924 elsif ( $command == 16 ) { $config_location_base = command_config_location_base
(); }
925 elsif ( $command == 17 ) { $only_secure_cookies = command319
(); }
926 } elsif ( $menu == 5 ) {
927 if ( $command == 1 ) { $use_icons = commandB3
(); }
928 # elsif ( $command == 3 ) { $icon_theme_def = commandB7(); }
929 elsif ( $command == 2 ) { $default_fontsize = command_default_fontsize
(); }
930 elsif ( $command == 3 ) { $templateset_default = command_templates
(); }
931 elsif ( $command == 4 ) { command_userThemes
(); }
932 elsif ( $command == 5 ) { command_fontsets
(); }
933 elsif ( $command == 6 ) { command_iconSets
(); }
934 } elsif ( $menu == 6 ) {
935 if ( $command == 1 ) { command61
(); }
936 elsif ( $command == 2 ) { command62
(); }
937 elsif ( $command == 3 ) { $abook_global_file=command63
(); }
938 elsif ( $command == 4 ) { command64
(); }
939 elsif ( $command == 5 ) { command65
(); }
940 elsif ( $command == 6 ) { command_abook_file_line_length
(); }
941 } elsif ( $menu == 7 ) {
942 if ( $command == 1 ) { $motd = command71
(); }
943 } elsif ( $menu == 8 ) {
944 if ( $command =~ /^[0-9]+/ ) { @plugins = command81
(); }
945 elsif ( $command eq "u" ) { $disable_plugins_user = command82
(); }
946 elsif ( $command eq "d" ) { $disable_plugins = 'true'; }
947 elsif ( $command eq "e" ) { $disable_plugins = 'false'; }
948 } elsif ( $menu == 9 ) {
949 if ( $command == 1 ) { $addrbook_dsn = command91
(); }
950 elsif ( $command == 2 ) { $addrbook_table = command92
(); }
951 elsif ( $command == 3 ) { $prefs_dsn = command93
(); }
952 elsif ( $command == 4 ) { $prefs_table = command94
(); }
953 elsif ( $command == 5 ) { $prefs_user_field = command95
(); }
954 elsif ( $command == 6 ) { $prefs_key_field = command96
(); }
955 elsif ( $command == 7 ) { $prefs_val_field = command97
(); }
956 elsif ( $command == 8 ) { $addrbook_global_dsn = command98
(); }
957 elsif ( $command == 9 ) { $addrbook_global_table = command99
(); }
958 elsif ( $command == 10 ) { $addrbook_global_writeable = command910
(); }
959 elsif ( $command == 11 ) { $addrbook_global_listing = command911
(); }
960 } elsif ( $menu == 10 ) {
961 if ( $command == 1 ) { $squirrelmail_default_language = commandA1
(); }
962 elsif ( $command == 2 ) { $default_charset = commandA2
(); }
963 elsif ( $command == 3 ) { $show_alternative_names = commandA3
(); }
964 elsif ( $command == 4 ) { $aggressive_decoding = commandA4
(); }
965 elsif ( $command == 5 ) { $lossy_encoding = commandA5
(); }
966 } elsif ( $menu == 11 ) {
967 if ( $command == 1 ) { $use_iframe = commandB2
(); }
968 elsif ( $command == 4 ) { $use_php_recode = commandB4
(); }
969 elsif ( $command == 5 ) { $use_php_iconv = commandB5
(); }
970 elsif ( $command == 6 ) { $allow_remote_configtest = commandB6
(); }
976 print "\nExiting conf.pl.\n".
977 "You might want to test your configuration by browsing to\n".
978 "http://your-squirrelmail-location/src/configtest.php\n".
979 "Happy SquirrelMailing!\n\n";
982 ####################################################################################
986 print "We have tried to make the name SquirrelMail as transparent as\n";
987 print "possible. If you set up an organization name, most places where\n";
988 print "SquirrelMail would take credit will be credited to your organization.\n";
990 print "If your Organization Name includes a '\$', please precede it with a \\. \n";
991 print "Other '\$' will be considered the beginning of a variable that\n";
992 print "must be defined before the \$org_name is printed.\n";
994 print "[$WHT$org_name$NRM]: $WHT";
995 $new_org_name = <STDIN
>;
996 if ( $new_org_name eq "\n" ) {
997 $new_org_name = $org_name;
999 $new_org_name =~ s/[\r\n]//g;
1000 $new_org_name =~ s/\"/"/g;
1002 return $new_org_name;
1007 print "Your organization's logo is an image that will be displayed at\n";
1008 print "different times throughout SquirrelMail. ";
1010 print "Please be aware of the following: \n";
1011 print " - Relative URLs are relative to the config dir\n";
1012 print " to use the default logo, use ../images/sm_logo.png\n";
1013 print " - To specify a logo defined outside the SquirrelMail source tree\n";
1014 print " use the absolute URL the webserver would use to include the file\n";
1015 print " e.g. http://www.example.com/images/mylogo.gif or /images/mylogo.jpg\n";
1017 print "[$WHT$org_logo$NRM]: $WHT";
1018 $new_org_logo = <STDIN
>;
1019 if ( $new_org_logo eq "\n" ) {
1020 $new_org_logo = $org_logo;
1022 $new_org_logo =~ s/[\r\n]//g;
1024 return $new_org_logo;
1029 print "Your organization's logo is an image that will be displayed at\n";
1030 print "different times throughout SquirrelMail. Width\n";
1031 print "and Height of your logo image. Use '0' to disable.\n";
1033 print "Width: [$WHT$org_logo_width$NRM]: $WHT";
1034 $new_org_logo_width = <STDIN
>;
1035 $new_org_logo_width =~ tr/0-9//cd; # only want digits!
1036 if ( $new_org_logo_width eq '' ) {
1037 $new_org_logo_width = $org_logo_width;
1039 if ( $new_org_logo_width > 0 ) {
1040 print "Height: [$WHT$org_logo_height$NRM]: $WHT";
1041 $new_org_logo_height = <STDIN
>;
1042 $new_org_logo_height =~ tr/0-9//cd; # only want digits!
1043 if( $new_org_logo_height eq '' ) {
1044 $new_org_logo_height = $org_logo_height;
1047 $new_org_logo_height = 0;
1049 return ($new_org_logo_width, $new_org_logo_height);
1054 print "A title is what is displayed at the top of the browser window in\n";
1055 print "the titlebar. Usually this will end up looking something like:\n";
1056 print "\"Netscape: $org_title\"\n";
1058 print "If your Organization Title includes a '\$', please precede it with a \\. \n";
1059 print "Other '\$' will be considered the beginning of a variable that\n";
1060 print "must be defined before the \$org_title is printed.\n";
1062 print "[$WHT$org_title$NRM]: $WHT";
1063 $new_org_title = <STDIN
>;
1064 if ( $new_org_title eq "\n" ) {
1065 $new_org_title = $org_title;
1067 $new_org_title =~ s/[\r\n]//g;
1068 $new_org_title =~ s/\"/\'/g;
1070 return $new_org_title;
1075 print "When users click the Sign Out button they will be logged out and\n";
1076 print "then sent to signout_page. If signout_page is left empty,\n";
1077 print "(hit space and then return) they will be taken, as normal,\n";
1078 print "to the default and rather sparse SquirrelMail signout page.\n";
1080 print "[$WHT$signout_page$NRM]: $WHT";
1081 $new_signout_page = <STDIN
>;
1082 if ( $new_signout_page eq "\n" ) {
1083 $new_signout_page = $signout_page;
1085 $new_signout_page =~ s/[\r\n]//g;
1086 $new_signout_page =~ s/^\s+$//g;
1088 return $new_signout_page;
1093 print "SquirrelMail defaults to using the whole of the browser window.\n";
1094 print "This allows you to keep it within a specified frame. The default\n";
1095 print "is '_top'\n";
1097 print "[$WHT$frame_top$NRM]: $WHT";
1098 $new_frame_top = <STDIN
>;
1099 if ( $new_frame_top eq "\n" ) {
1100 $new_frame_top = '_top';
1102 $new_frame_top =~ s/[\r\n]//g;
1103 $new_frame_top =~ s/^\s+$//g;
1105 return $new_frame_top;
1108 # Default link to provider
1110 print "Here you can set the link on the top-right of the message list.\n";
1111 print "If empty, it will not be displayed.\n";
1113 print "[$WHT$provider_uri$NRM]: $WHT";
1114 $new_provider_uri = <STDIN
>;
1115 if ( $new_provider_uri eq "\n" ) {
1116 $new_provider_uri = '';
1118 $new_provider_uri =~ s/[\r\n]//g;
1119 $new_provider_uri =~ s/^\s+$//g;
1121 return $new_provider_uri;
1125 print "Here you can set the name of the link on the top-right of the message list.\n";
1126 print "The default is empty (do not display anything).'\n";
1128 print "[$WHT$provider_name$NRM]: $WHT";
1129 $new_provider_name = <STDIN
>;
1130 if ( $new_provider_name eq "\n" ) {
1131 $new_provider_name = '';
1133 $new_provider_name =~ s/[\r\n]//g;
1134 $new_provider_name =~ s/^\s+$//g;
1135 $new_provider_name =~ s/\'/\\'/g;
1137 return $new_provider_name;
1140 ####################################################################################
1144 print "The domain name is the suffix at the end of all email addresses. If\n";
1145 print "for example, your email address is jdoe\@example.com, then your domain\n";
1146 print "would be example.com.\n";
1148 print "[$WHT$domain$NRM]: $WHT";
1149 $new_domain = <STDIN
>;
1150 if ( $new_domain eq "\n" ) {
1151 $new_domain = $domain;
1153 $new_domain =~ s/\s//g;
1160 print "This is the hostname where your IMAP server can be contacted.\n";
1161 print "[$WHT$imapServerAddress$NRM]: $WHT";
1162 $new_imapServerAddress = <STDIN
>;
1163 if ( $new_imapServerAddress eq "\n" ) {
1164 $new_imapServerAddress = $imapServerAddress;
1166 $new_imapServerAddress =~ s/[\r\n]//g;
1168 return $new_imapServerAddress;
1173 print "This is the port that your IMAP server is on. Usually this is 143.\n";
1174 print "[$WHT$imapPort$NRM]: $WHT";
1175 $new_imapPort = <STDIN
>;
1176 if ( $new_imapPort eq "\n" ) {
1177 $new_imapPort = $imapPort;
1179 $new_imapPort =~ s/[\r\n]//g;
1181 return $new_imapPort;
1186 print "You now need to choose the method that you will use for sending\n";
1187 print "messages in SquirrelMail. You can either connect to an SMTP server\n";
1188 print "or use sendmail directly.\n";
1189 if ( lc($useSendmail) eq 'true' ) {
1190 $default_value = "1";
1192 $default_value = "2";
1195 print " 1. Sendmail\n";
1197 print "Your choice [1/2] [$WHT$default_value$NRM]: $WHT";
1198 $use_sendmail = <STDIN
>;
1199 if ( ( $use_sendmail =~ /^1\n/i )
1200 || ( ( $use_sendmail =~ /^\n/ ) && ( $default_value eq "1" ) ) ) {
1201 $useSendmail = 'true';
1203 $useSendmail = 'false';
1205 return $useSendmail;
1210 print "Specify where the sendmail executable is located. Usually /usr/sbin/sendmail\n";
1211 print "[$WHT$sendmail_path$NRM]: $WHT";
1212 $new_sendmail_path = <STDIN
>;
1213 if ( $new_sendmail_path eq "\n" ) {
1214 $new_sendmail_path = $sendmail_path;
1216 $new_sendmail_path =~ s/[\r\n]//g;
1218 return $new_sendmail_path;
1221 # Extra sendmail arguments
1222 sub command_sendmail_args
{
1223 print "Specify additional sendmail program arguments.\n";
1225 print "Make sure that arguments are supported by your sendmail program. -f argument \n";
1226 print "is added automatically by SquirrelMail scripts. Variable defaults to standard\n";
1227 print "/usr/sbin/sendmail arguments. If you use qmail-inject, nbsmtp or any other \n";
1228 print "sendmail wrapper, which does not support -i and -t arguments, set variable to\n";
1229 print "empty string or use arguments suitable for your mailer.\n";
1231 print "[$WHT$sendmail_args$NRM]: $WHT";
1232 $new_sendmail_args = <STDIN
>;
1233 if ( $new_sendmail_args eq "\n" ) {
1234 $new_sendmail_args = $sendmail_args;
1236 # strip linefeeds and crs.
1237 $new_sendmail_args =~ s/[\r\n]//g;
1239 return trim
($new_sendmail_args);
1244 print "This is the hostname of your SMTP server.\n";
1245 print "[$WHT$smtpServerAddress$NRM]: $WHT";
1246 $new_smtpServerAddress = <STDIN
>;
1247 if ( $new_smtpServerAddress eq "\n" ) {
1248 $new_smtpServerAddress = $smtpServerAddress;
1250 $new_smtpServerAddress =~ s/[\r\n]//g;
1252 return $new_smtpServerAddress;
1257 print "This is the port to connect to for SMTP. Usually 25.\n";
1258 print "[$WHT$smtpPort$NRM]: $WHT";
1259 $new_smtpPort = <STDIN
>;
1260 if ( $new_smtpPort eq "\n" ) {
1261 $new_smtpPort = $smtpPort;
1263 $new_smtpPort =~ s/[\r\n]//g;
1265 return $new_smtpPort;
1270 print "Do you wish to use POP3 before SMTP? Your server must\n";
1271 print "support this in order for SquirrelMail to work with it.\n";
1274 $YesNo = 'y' if ( lc($pop_before_smtp) eq 'true' );
1276 print "Use pop before SMTP (y/n) [$WHT$YesNo$NRM]: $WHT";
1278 $new_pop_before_smtp = <STDIN
>;
1279 $new_pop_before_smtp =~ tr/yn//cd;
1280 return 'true' if ( $new_pop_before_smtp eq "y" );
1281 return 'false' if ( $new_pop_before_smtp eq "n" );
1282 return $pop_before_smtp;
1287 print "Each IMAP server has its own quirks. As much as we tried to stick\n";
1288 print "to standards, it doesn't help much if the IMAP server doesn't follow\n";
1289 print "the same principles. We have made some work-arounds for some of\n";
1290 print "these servers. If you would like to use them, please select your\n";
1291 print "IMAP server. If you do not wish to use these work-arounds, you can\n";
1292 print "set this to \"other\", and none will be used.\n";
1293 print $list_supported_imap_servers;
1295 print " other = Not one of the above servers\n";
1297 print "[$WHT$imap_server_type$NRM]: $WHT";
1298 $new_imap_server_type = <STDIN
>;
1300 if ( $new_imap_server_type eq "\n" ) {
1301 $new_imap_server_type = $imap_server_type;
1303 $new_imap_server_type =~ s/[\r\n]//g;
1305 return $new_imap_server_type;
1310 print "Sometimes the date of messages sent is messed up (off by a few hours\n";
1311 print "on some machines). Typically this happens if the system doesn't support\n";
1312 print "tm_gmtoff. It will happen only if your time zone is \"negative\".\n";
1313 print "This most often occurs on Solaris 7 machines in the United States.\n";
1314 print "By default, this is off. It should be kept off unless problems surface\n";
1315 print "about the time that messages are sent.\n";
1316 print " no = Do NOT fix time -- almost always correct\n";
1317 print " yes = Fix the time for this system\n";
1320 $YesNo = 'y' if ( lc($invert_time) eq 'true' );
1322 print "Fix the time for this system (y/n) [$WHT$YesNo$NRM]: $WHT";
1324 $new_invert_time = <STDIN
>;
1325 $new_invert_time =~ tr/yn//cd;
1326 return 'true' if ( $new_invert_time eq "y" );
1327 return 'false' if ( $new_invert_time eq "n" );
1328 return $invert_time;
1332 print "This is the delimiter that your IMAP server uses to distinguish between\n";
1333 print "folders. For example, Cyrus uses '.' as the delimiter and a complete\n";
1334 print "folder would look like 'INBOX.Friends.Bob', while UW uses '/' and would\n";
1335 print "look like 'INBOX/Friends/Bob'. Normally this should be left at 'detect'\n";
1336 print "but if you are sure you know what delimiter your server uses, you can\n";
1337 print "specify it here.\n";
1338 print "\nTo have it autodetect the delimiter, set it to 'detect'.\n\n";
1339 print "[$WHT$optional_delimiter$NRM]: $WHT";
1340 $new_optional_delimiter = <STDIN
>;
1342 if ( $new_optional_delimiter eq "\n" ) {
1343 $new_optional_delimiter = $optional_delimiter;
1345 $new_optional_delimiter =~ s/[\r\n]//g;
1347 return $new_optional_delimiter;
1349 # IMAP authentication type
1350 # Possible values: login, plain, cram-md5, digest-md5
1351 # Now offers to detect supported mechs, assuming server & port are set correctly
1354 if ($use_imap_tls ne "0") {
1355 # 1. Script does not handle TLS.
1356 # 2. Server does not have to declare all supported authentication mechs when
1357 # STARTTLS is used. Supported mechs are declared only after STARTTLS.
1358 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1360 print "If you have already set the hostname and port number, I can try to\n";
1361 print "detect the mechanisms your IMAP server supports.\n";
1362 print "I will try to detect CRAM-MD5 and DIGEST-MD5 support. I can't test\n";
1363 print "for \"login\" or \"plain\" without knowing a username and password.\n";
1364 print "Auto-detecting is optional - you can safely say \"n\" here.\n";
1365 print "\nTry to detect supported mechanisms? [y/N]: ";
1368 if ($inval =~ /^y\b/i) {
1369 # Yes, let's try to detect.
1370 print "Trying to detect IMAP capabilities...\n";
1371 my $host = $imapServerAddress . ':'. $imapPort;
1372 print "CRAM-MD5:\t";
1373 my $tmp = detect_auth_support
('IMAP',$host,'CRAM-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";
1384 print "DIGEST-MD5:\t";
1385 $tmp = detect_auth_support
('IMAP',$host,'DIGEST-MD5');
1386 if (defined($tmp)) {
1387 if ($tmp eq 'YES') {
1388 print "$WHT SUPPORTED$NRM\n";
1390 print "$WHT NOT SUPPORTED$NRM\n";
1393 print $WHT . " ERROR DETECTING$NRM\n";
1398 print "\nWhat authentication mechanism do you want to use for IMAP connections?\n\n";
1399 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1400 print $WHT . "plain" . $NRM . " - SASL PLAIN. If you need this, you already know it.\n";
1401 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext methods.\n";
1402 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1403 print "\n*** YOUR IMAP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n";
1404 print "If you don't understand or are unsure, you probably want \"login\"\n\n";
1405 print "login, plain, cram-md5, or digest-md5 [$WHT$imap_auth_mech$NRM]: $WHT";
1408 if ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) || ($inval =~ /^login\b/i) || ($inval =~ /^plain\b/i)) {
1411 # user entered garbage or default value so nothing needs to be set
1412 return $imap_auth_mech;
1417 # SMTP authentication type
1418 # Possible choices: none, plain, cram-md5, digest-md5
1420 if ($use_smtp_tls ne "0") {
1421 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1422 } elsif (eval ("use IO::Socket; 1")) {
1423 # try loading IO::Socket module
1424 print "If you have already set the hostname and port number, I can try to\n";
1425 print "automatically detect some of the mechanisms your SMTP server supports.\n";
1426 print "Auto-detection is *optional* - you can safely say \"n\" here.\n";
1427 print "\nTry to detect auth mechanisms? [y/N]: ";
1430 if ($inval =~ /^y\b/i) {
1431 # Yes, let's try to detect.
1432 print "Trying to detect supported methods (SMTP)...\n";
1435 # Check none by trying to relay to junk@microsoft.com
1436 $host = $smtpServerAddress . ':' . $smtpPort;
1437 my $sock = IO
::Socket
::INET
->new($host);
1438 print "Testing none:\t\t$WHT";
1439 if (!defined($sock)) {
1440 print " ERROR TESTING\n";
1443 print $sock "HELO $domain\r\n";
1444 $got = <$sock>; # Discard
1445 print $sock "MAIL FROM:<tester\@squirrelmail.org>\r\n";
1446 $got = <$sock>; # Discard
1447 print $sock "RCPT TO:<junk\@microsoft.com\r\n";
1448 $got = <$sock>; # This is the important line
1449 if ($got =~ /^250\b/) { # SMTP will relay without auth
1450 print "SUPPORTED$NRM\n";
1452 print "NOT SUPPORTED$NRM\n";
1454 print $sock "RSET\r\n";
1455 print $sock "QUIT\r\n";
1458 # Try login (SquirrelMail default)
1459 print "Testing login:\t\t";
1460 $tmp=detect_auth_support
('SMTP',$host,'LOGIN');
1461 if (defined($tmp)) {
1462 if ($tmp eq 'YES') {
1463 print $WHT . "SUPPORTED$NRM\n";
1465 print $WHT . "NOT SUPPORTED$NRM\n";
1468 print $WHT . "ERROR DETECTING$NRM\n";
1472 print "Testing CRAM-MD5:\t";
1473 $tmp=detect_auth_support
('SMTP',$host,'CRAM-MD5');
1474 if (defined($tmp)) {
1475 if ($tmp eq 'YES') {
1476 print $WHT . "SUPPORTED$NRM\n";
1478 print $WHT . "NOT SUPPORTED$NRM\n";
1481 print $WHT . "ERROR DETECTING$NRM\n";
1485 print "Testing DIGEST-MD5:\t";
1486 $tmp=detect_auth_support
('SMTP',$host,'DIGEST-MD5');
1487 if (defined($tmp)) {
1488 if ($tmp eq 'YES') {
1489 print $WHT . "SUPPORTED$NRM\n";
1491 print $WHT . "NOT SUPPORTED$NRM\n";
1494 print $WHT . "ERROR DETECTING$NRM\n";
1498 print "\nWhat authentication mechanism do you want to use for SMTP connections?\n";
1499 print $WHT . "none" . $NRM . " - Your SMTP server does not require authorization.\n";
1500 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1501 print $WHT . "plain" . $NRM . " - SASL PLAIN. You already know it if you need this.\n";
1502 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext.\n";
1503 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1504 print $WHT . "\n*** YOUR SMTP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n" . $NRM;
1505 print "If you don't understand or are unsure, you probably want \"none\"\n\n";
1506 print "none, login, cram-md5, or digest-md5 [$WHT$smtp_auth_mech$NRM]: $WHT";
1509 if ($inval =~ /^none\b/i) {
1510 # remove sitewide smtp authentication information
1511 $smtp_sitewide_user = '';
1512 $smtp_sitewide_pass = '';
1513 # SMTP doesn't necessarily require logins
1515 } elsif ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) ||
1516 ($inval =~ /^login\b/i) || ($inval =~/^plain\b/i)) {
1517 command_smtp_sitewide_userpass
($inval);
1519 } elsif (trim
($inval) eq '') {
1520 # user selected default value
1521 command_smtp_sitewide_userpass
($smtp_auth_mech);
1522 return $smtp_auth_mech;
1524 # user entered garbage
1525 return $smtp_auth_mech;
1529 sub command_smtp_sitewide_userpass
($) {
1530 # get first function argument
1531 my $auth_mech = shift(@_);
1533 $auth_mech = lc(trim
($auth_mech));
1534 if ($auth_mech eq 'none') {
1537 print "SMTP authentication uses IMAP username and password by default.\n";
1539 print "Would you like to use other login and password for all SquirrelMail \n";
1540 print "SMTP connections?";
1541 if ($smtp_sitewide_user ne '') {
1558 $smtp_sitewide_user = '';
1559 $smtp_sitewide_pass = '';
1560 } elsif ($tmp eq 'y') {
1561 print "Enter username [$smtp_sitewide_user]:";
1562 my $new_user = <STDIN
>;
1563 $new_user = trim
($new_user);
1564 if ($new_user ne '') {
1565 $smtp_sitewide_user = $new_user;
1567 if ($smtp_sitewide_user ne '') {
1568 print "If you don't enter any password, current sitewide password will be used.\n";
1569 print "If you enter space, password will be set to empty string.\n";
1570 print "Enter password:";
1571 my $new_pass = <STDIN
>;
1572 if ($new_pass ne "\n") {
1573 $smtp_sitewide_pass = trim
($new_pass);
1576 print "Invalid input. You must set username used for SMTP authentication.\n";
1577 print "Click enter to continue\n";
1581 print "Invalid input\n";
1582 print "Click enter to continue\n";
1587 # Sub adds information about SMTP authentication type to menu
1588 sub display_smtp_sitewide_userpass
() {
1590 if ($smtp_auth_mech ne 'none') {
1591 if ($smtp_sitewide_user ne '') {
1592 $ret = ' (with custom username and password)';
1594 $ret = ' (with IMAP username and password)';
1601 # This sub is reused for IMAP and SMTP
1602 # Args: service name, default value
1603 sub command_use_tls
{
1604 my($default_val,$service,$inval);
1607 print "TLS (Transport Layer Security) encrypts the traffic between server and client.\n";
1608 print "STARTTLS extensions allow to start encryption on existing plain text connection.\n";
1609 print "These options add specific PHP and IMAP server configuration requirements.\n";
1610 print "See SquirrelMail documentation about connection security.\n";
1612 print "If your " . $service . " server is localhost, you can safely disable this.\n";
1613 print "If it is remote, you may wish to seriously consider enabling this.\n";
1615 while ($valid_input eq 0) {
1616 print "\nSelect connection security model:\n";
1617 print " 0 - Use plain text connection\n";
1618 print " 1 - Use TLS connection\n";
1619 print " 2 - Use STARTTLS extension\n";
1620 print "Select [$default_val]: ";
1622 $inval=trim
($inval);
1623 if ($inval =~ /^[012]$/ || $inval eq '') {
1627 if ($inval ne '') {$default_val = $inval};
1628 return $default_val;
1631 # This sub is used to display human readable text for
1632 # $use_imap_tls and $use_smtp_tls values in conf.pl menu
1633 sub display_use_tls
($) {
1634 my $val = shift(@_);
1635 my $ret = 'disabled';
1638 } elsif ($val eq '1') {
1644 # $encode_header_key
1646 print "Encryption key allows to hide SquirrelMail Received: headers\n";
1647 print "in outbound messages. Interface uses encryption key to encode\n";
1648 print "username, remote address and proxied address, then stores encoded\n";
1649 print "information in X-Squirrel-* headers.\n";
1651 print "Warning: used encryption function is not bulletproof. When used\n";
1652 print "with static encryption keys, it provides only minimal security\n";
1653 print "measures and information can be decoded quickly.\n";
1655 print "Encoded information can be decoded with decrypt_headers.php script\n";
1656 print "from SquirrelMail contrib/ directory.\n";
1658 print "Enter encryption key: ";
1659 $new_encode_header_key = <STDIN
>;
1660 if ( $new_encode_header_key eq "\n" ) {
1661 $new_encode_header_key = $encode_header_key;
1663 $new_encode_header_key =~ s/[\r\n]//g;
1665 return $new_encode_header_key;
1670 print "\nYou can now create the welcome message that is displayed\n";
1671 print "every time a user logs on. You can use HTML or just plain\n";
1673 "text. If you do not wish to have one, just make it blank.\n\n(Type @ on a blank line to exit)\n";
1679 $line =~ s/[\r\n]//g;
1680 if ( $line ne "@" ) {
1681 $line =~ s/ /\ \ /g;
1682 $line =~ s/\t/\ \ \ \ /g;
1684 $line =~ s/\"/\\\"/g;
1686 $new_motd = $new_motd . $line;
1688 } while ( $line ne "@" );
1692 ################# PLUGINS ###################
1695 $command =~ s/[\s\n\r]*//g;
1696 if ( $command > 0 ) {
1697 $command = $command - 1;
1698 if ( $command <= $#plugins ) {
1701 while ( $ct <= $#plugins ) {
1702 if ( $ct != $command ) {
1703 @newplugins = ( @newplugins, $plugins[$ct] );
1707 @plugins = @newplugins;
1708 } elsif ( $command <= $#plugins + $#unused_plugins + 1 ) {
1709 $num = $command - $#plugins - 1;
1710 @newplugins = @plugins;
1712 while ( $ct <= $#unused_plugins ) {
1713 if ( $ct == $num ) {
1714 @newplugins = ( @newplugins, $unused_plugins[$ct] );
1718 @plugins = @newplugins;
1724 # disable_plugins_user
1726 print "When all active plugins are disabled, they can be disabled only\n";
1727 print "for the one user named here. If left blank, plugins will be\n";
1728 print "disabled for ALL users. This setting has no effect if plugins\n";
1729 print "are not disabled.\n";
1731 print "This must be the exact IMAP login name for the desired user.\n";
1733 print "[$WHT$disable_plugins_user$NRM]: $WHT";
1734 $new_disable_plugins_user = <STDIN
>;
1735 if ( $new_disable_plugins_user eq "\n" ) {
1736 $new_disable_plugins_user = $disable_plugins_user;
1738 $new_disable_plugins_user =~ s/[\r\n]//g;
1740 return $new_disable_plugins_user;
1743 ################# FOLDERS ###################
1745 # default_folder_prefix
1747 print "Some IMAP servers (UW, for example) store mail and folders in\n";
1748 print "your user space in a separate subdirectory. This is where you\n";
1749 print "specify what that directory is.\n";
1751 print "EXAMPLE: mail/";
1753 print "NOTE: If you use Cyrus, or some server that would not use this\n";
1754 print " option, you must set this to 'none'.\n";
1756 print "[$WHT$default_folder_prefix$NRM]: $WHT";
1757 $new_default_folder_prefix = <STDIN
>;
1759 if ( $new_default_folder_prefix eq "\n" ) {
1760 $new_default_folder_prefix = $default_folder_prefix;
1762 $new_default_folder_prefix =~ s/[\r\n]//g;
1764 if ( ( $new_default_folder_prefix =~ /^\s*$/ ) || ( $new_default_folder_prefix =~ m/^none$/i ) ) {
1765 $new_default_folder_prefix = "";
1767 # add the trailing delimiter only if we know what the server is.
1768 if (($imap_server_type eq 'cyrus' and
1769 $optional_delimiter eq 'detect') or
1770 ($imap_server_type eq 'courier' and
1771 $optional_delimiter eq 'detect')) {
1772 $new_default_folder_prefix =~ s/\.*$/\./;
1773 } elsif ($imap_server_type eq 'uw' and
1774 $optional_delimiter eq 'detect') {
1775 $new_default_folder_prefix =~ s/\/*$/\
//;
1778 return $new_default_folder_prefix;
1781 # Show Folder Prefix
1783 print "It is possible to set up the default folder prefix as a user\n";
1784 print "specific option, where each user can specify what their mail\n";
1785 print "folder is. If you set this to false, they will never see the\n";
1786 print "option, but if it is true, this option will appear in the\n";
1787 print "'options' section.\n";
1789 print "NOTE: You set the default folder prefix in option '1' of this\n";
1790 print " section. That will be the default if the user doesn't\n";
1791 print " specify anything different.\n";
1794 if ( lc($show_prefix_option) eq 'true' ) {
1795 $default_value = "y";
1797 $default_value = "n";
1800 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
1801 $new_show = <STDIN
>;
1802 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1803 $show_prefix_option = 'true';
1805 $show_prefix_option = 'false';
1807 return $show_prefix_option;
1812 print "You can now specify where the default trash folder is located.\n";
1813 print "On servers where you do not want this, you can set it to anything\n";
1814 print "and set option 6 to false.\n";
1816 print "This is relative to where the rest of your email is kept. You do\n";
1817 print "not need to worry about their mail directory. If this folder\n";
1818 print "would be ~/mail/trash on the filesystem, you only need to specify\n";
1819 print "that this is 'trash', and be sure to put 'mail/' in option 1.\n";
1822 print "[$WHT$trash_folder$NRM]: $WHT";
1823 $new_trash_folder = <STDIN
>;
1824 if ( $new_trash_folder eq "\n" ) {
1825 $new_trash_folder = $trash_folder;
1827 if (check_imap_folder
($new_trash_folder)) {
1828 $new_trash_folder =~ s/[\r\n]//g;
1830 $new_trash_folder = $trash_folder;
1833 return $new_trash_folder;
1838 print "This is where messages that are sent will be stored. SquirrelMail\n";
1839 print "by default puts a copy of all outgoing messages in this folder.\n";
1841 print "This is relative to where the rest of your email is kept. You do\n";
1842 print "not need to worry about their mail directory. If this folder\n";
1843 print "would be ~/mail/sent on the filesystem, you only need to specify\n";
1844 print "that this is 'sent', and be sure to put 'mail/' in option 1.\n";
1847 print "[$WHT$sent_folder$NRM]: $WHT";
1848 $new_sent_folder = <STDIN
>;
1849 if ( $new_sent_folder eq "\n" ) {
1850 $new_sent_folder = $sent_folder;
1852 if (check_imap_folder
($new_sent_folder)) {
1853 $new_sent_folder =~ s/[\r\n]//g;
1855 $new_sent_folder = $sent_folder;
1858 return $new_sent_folder;
1863 print "You can now specify where the default draft folder is located.\n";
1864 print "On servers where you do not want this, you can set it to anything\n";
1865 print "and set option 9 to false.\n";
1867 print "This is relative to where the rest of your email is kept. You do\n";
1868 print "not need to worry about their mail directory. If this folder\n";
1869 print "would be ~/mail/drafts on the filesystem, you only need to specify\n";
1870 print "that this is 'drafts', and be sure to put 'mail/' in option 1.\n";
1873 print "[$WHT$draft_folder$NRM]: $WHT";
1874 $new_draft_folder = <STDIN
>;
1875 if ( $new_draft_folder eq "\n" ) {
1876 $new_draft_folder = $draft_folder;
1878 if (check_imap_folder
($new_draft_folder)) {
1879 $new_draft_folder =~ s/[\r\n]//g;
1881 $new_draft_folder = $draft_folder;
1884 return $new_draft_folder;
1887 # default move to trash
1889 print "By default, should messages get moved to the trash folder? You\n";
1890 print "can specify the default trash folder in option 3. If this is set\n";
1891 print "to false, messages will get deleted immediately without moving\n";
1892 print "to the trash folder.\n";
1894 print "Trash folder is currently: $trash_folder\n";
1897 if ( lc($default_move_to_trash) eq 'true' ) {
1898 $default_value = "y";
1900 $default_value = "n";
1902 print "By default, move to trash (y/n) [$WHT$default_value$NRM]: $WHT";
1903 $new_show = <STDIN
>;
1904 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1905 $default_move_to_trash = 'true';
1907 $default_move_to_trash = 'false';
1909 return $default_move_to_trash;
1912 # default move to sent
1914 print "By default, should messages get moved to the sent folder? You\n";
1915 print "can specify the default sent folder in option 4. If this is set\n";
1916 print "to false, messages will get sent and no copy will be made.\n";
1918 print "Sent folder is currently: $sent_folder\n";
1921 if ( lc($default_move_to_sent) eq 'true' ) {
1922 $default_value = "y";
1924 $default_value = "n";
1926 print "By default, move to sent (y/n) [$WHT$default_value$NRM]: $WHT";
1927 $new_show = <STDIN
>;
1928 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1929 $default_move_to_sent = 'true';
1931 $default_move_to_sent = 'false';
1933 return $default_move_to_sent;
1936 # default save as draft
1938 print "By default, should the save to draft option be shown? You can\n";
1939 print "specify the default drafts folder in option 5. If this is set\n";
1940 print "to false, users will not be shown the save to draft option.\n";
1942 print "Drafts folder is currently: $draft_folder\n";
1945 if ( lc($default_move_to_draft) eq 'true' ) {
1946 $default_value = "y";
1948 $default_value = "n";
1950 print "By default, save as draft (y/n) [$WHT$default_value$NRM]: $WHT";
1951 $new_show = <STDIN
>;
1952 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1953 $default_save_as_draft = 'true';
1955 $default_save_as_draft = 'false';
1957 return $default_save_as_draft;
1960 # List special folders first
1962 print "SquirrelMail has what we call 'special folders' that are not\n";
1963 print "manipulated and viewed like normal folders. Some examples of\n";
1964 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
1965 print "Simply asks if you want these folders listed first in the folder\n";
1969 if ( lc($list_special_folders_first) eq 'true' ) {
1970 $default_value = "y";
1972 $default_value = "n";
1975 print "List first (y/n) [$WHT$default_value$NRM]: $WHT";
1976 $new_show = <STDIN
>;
1977 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1978 $list_special_folders_first = 'true';
1980 $list_special_folders_first = 'false';
1982 return $list_special_folders_first;
1985 # Show special folders color
1987 print "SquirrelMail has what we call 'special folders' that are not\n";
1988 print "manipulated and viewed like normal folders. Some examples of\n";
1989 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
1990 print "wants to know if we should display special folders in a\n";
1991 print "color than the other folders.\n";
1994 if ( lc($use_special_folder_color) eq 'true' ) {
1995 $default_value = "y";
1997 $default_value = "n";
2000 print "Show color (y/n) [$WHT$default_value$NRM]: $WHT";
2001 $new_show = <STDIN
>;
2002 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2003 $use_special_folder_color = 'true';
2005 $use_special_folder_color = 'false';
2007 return $use_special_folder_color;
2012 print "The way that IMAP handles deleting messages is as follows. You\n";
2013 print "mark the message as deleted, and then to 'really' delete it, you\n";
2014 print "expunge it. This option asks if you want to just have messages\n";
2015 print "marked as deleted, or if you want SquirrelMail to expunge the \n";
2016 print "messages too.\n";
2019 if ( lc($auto_expunge) eq 'true' ) {
2020 $default_value = "y";
2022 $default_value = "n";
2024 print "Auto expunge (y/n) [$WHT$default_value$NRM]: $WHT";
2025 $new_show = <STDIN
>;
2026 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2027 $auto_expunge = 'true';
2029 $auto_expunge = 'false';
2031 return $auto_expunge;
2034 # Default sub of inbox
2036 print "Some IMAP servers (Cyrus) have all folders as subfolders of INBOX.\n";
2037 print "This can cause some confusion in folder creation for users when\n";
2038 print "they try to create folders and don't put it as a subfolder of INBOX\n";
2039 print "and get permission errors. This option asks if you want folders\n";
2040 print "to be subfolders of INBOX by default.\n";
2043 if ( lc($default_sub_of_inbox) eq 'true' ) {
2044 $default_value = "y";
2046 $default_value = "n";
2048 print "Default sub of INBOX (y/n) [$WHT$default_value$NRM]: $WHT";
2049 $new_show = <STDIN
>;
2050 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2051 $default_sub_of_inbox = 'true';
2053 $default_sub_of_inbox = 'false';
2055 return $default_sub_of_inbox;
2058 # Show contain subfolder option
2060 print "Some IMAP servers (UW) make it so that there are two types of\n";
2061 print "folders. Those that contain messages, and those that contain\n";
2062 print "subfolders. If this is the case for your server, set this to\n";
2063 print "true, and it will ask the user whether the folder they are\n";
2064 print "creating contains subfolders or messages.\n";
2067 if ( lc($show_contain_subfolders_option) eq 'true' ) {
2068 $default_value = "y";
2070 $default_value = "n";
2072 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
2073 $new_show = <STDIN
>;
2074 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2075 $show_contain_subfolders_option = 'true';
2077 $show_contain_subfolders_option = 'false';
2079 return $show_contain_subfolders_option;
2082 # Default Unseen Notify
2084 print "This option specifies where the users will receive notification\n";
2085 print "about unseen messages by default. This is of course an option that\n";
2086 print "can be changed on a user level.\n";
2087 print " 1 = No notification\n";
2088 print " 2 = Only on the INBOX\n";
2089 print " 3 = On all folders\n";
2092 print "Which one should be default (1,2,3)? [$WHT$default_unseen_notify$NRM]: $WHT";
2093 $new_show = <STDIN
>;
2094 if ( $new_show =~ /^[123]\n/i ) {
2095 $default_unseen_notify = $new_show;
2097 $default_unseen_notify =~ s/[\r\n]//g;
2098 return $default_unseen_notify;
2101 # Default Unseen Type
2103 print "Here you can define the default way that unseen messages will be displayed\n";
2104 print "to the user in the folder listing on the left side.\n";
2105 print " 1 = Only unseen messages (4)\n";
2106 print " 2 = Unseen and Total messages (4/27)\n";
2109 print "Which one should be default (1,2)? [$WHT$default_unseen_type$NRM]: $WHT";
2110 $new_show = <STDIN
>;
2111 if ( $new_show =~ /^[12]\n/i ) {
2112 $default_unseen_type = $new_show;
2114 $default_unseen_type =~ s/[\r\n]//g;
2115 return $default_unseen_type;
2118 # Auto create special folders
2120 print "Would you like the Sent, Trash, and Drafts folders to be created\n";
2121 print "automatically print for you when a user logs in? If the user\n";
2122 print "accidentally deletes their special folders, this option will\n";
2123 print "automatically create it again for them.\n";
2126 if ( lc($auto_create_special) eq 'true' ) {
2127 $default_value = "y";
2129 $default_value = "n";
2131 print "Auto create special folders? (y/n) [$WHT$default_value$NRM]: $WHT";
2132 $new_show = <STDIN
>;
2133 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2134 $auto_create_special = 'true';
2136 $auto_create_special = 'false';
2138 return $auto_create_special;
2141 # Automatically delete folders
2143 if ( $imap_server_type eq "uw" ) {
2144 print "UW IMAP servers will not allow folders containing mail to also contain folders.\n";
2145 print "Deleting folders will bypass the trash folder and be immediately deleted\n\n";
2146 print "If this is not the correct value for your server,\n";
2147 print "please use option D on the Main Menu to configure your server correctly.\n\n";
2148 print "Press enter to continue...\n";
2149 $new_delete = <STDIN
>;
2150 $delete_folder = 'true';
2152 if ( $imap_server_type eq "courier" ) {
2153 print "Courier (or Courier-IMAP) IMAP servers may not support ";
2154 print "subfolders of Trash. \n";
2155 print "Specifically, if Courier is set to always move messages to Trash, \n";
2156 print "Trash will be treated by Courier as a special folder that does not \n";
2157 print "allow subfolders. \n\n";
2158 print "Please verify your Courier configuration, and test folder deletion \n";
2159 print "when changing this setting.\n\n";
2162 print "Are subfolders of the Trash supported by your IMAP server?\n";
2163 print "If so, should deleted folders be sent to Trash?\n";
2164 print "If not, say no (deleted folders should not be sent to Trash)\n\n";
2165 # reversal of logic.
2166 # question was: Should folders be automatically deleted instead of sent to trash..
2167 # we've changed the question to make it more clear,
2168 # and are here handling that to avoid changing the answers..
2169 if ( lc($delete_folder) eq 'true' ) {
2170 $default_value = "n";
2172 $default_value = "y";
2174 print "Send deleted folders to Trash? (y/n) [$WHT$default_value$NRM]: $WHT";
2175 $new_delete = <STDIN
>;
2176 if ( ( $new_delete =~ /^y\n/i ) || ( ( $new_delete =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2177 $delete_folder = 'false';
2179 $delete_folder = 'true';
2182 return $delete_folder;
2187 print "Some IMAP server allow subfolders to exist even if the parent\n";
2188 print "folders do not. This fixes some problems with the folder list\n";
2189 print "when this is the case, causing the /NoSelect folders to be displayed\n";
2192 if ( lc($noselect_fix_enable) eq 'true' ) {
2193 $default_value = "y";
2195 $default_value = "n";
2197 print "enable noselect fix? (y/n) [$WHT$noselect_fix_enable$NRM]: $WHT";
2198 $noselect_fix_enable = <STDIN
>;
2199 if ( ( $noselect_fix_enable =~ /^y\n/i ) || ( ( $noselect_fix_enable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2200 $noselect_fix_enable = 'true';
2202 $noselect_fix_enable = 'false';
2204 return $noselect_fix_enable;
2206 ############# GENERAL OPTIONS #####################
2210 print "Specify the location for your data directory.\n";
2211 print "You need to create this directory yourself.\n";
2212 print "The path name can be absolute or relative (to the config directory).\n";
2213 print "Here are two examples:\n";
2214 print " Absolute: /var/local/squirrelmail/data/\n";
2215 print " Relative: ../data/\n";
2216 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2217 print "will be converted to their absolute path equivalents in config.php.\n\n";
2218 print "Note: There are potential security risks with having a writeable directory\n";
2219 print "under the web server's root directory (ex: /home/httpd/html).\n";
2220 print "For this reason, it is recommended to put the data directory\n";
2221 print "in an alternate location of your choice. \n";
2224 print "[$WHT$data_dir$NRM]: $WHT";
2225 $new_data_dir = <STDIN
>;
2226 if ( $new_data_dir eq "\n" ) {
2227 $new_data_dir = $data_dir;
2229 $new_data_dir =~ s/[\r\n]//g;
2231 if ( $new_data_dir =~ /^\s*$/ ) {
2234 $new_data_dir =~ s/\/*$//g
;
2235 $new_data_dir =~ s/$/\//g
;
2237 return $new_data_dir;
2240 # Attachment directory
2242 print "Path to directory used for storing attachments while a mail is\n";
2243 print "being composed. The path name can be absolute or relative (to the\n";
2244 print "config directory). Here are two examples:\n";
2245 print " Absolute: /var/local/squirrelmail/attach/\n";
2246 print " Relative: ../attach/\n";
2247 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2248 print "will be converted to their absolute path equivalents in config.php.\n\n";
2249 print "Note: There are a few security considerations regarding this\n";
2250 print "directory:\n";
2251 print " 1. It should have the permission 733 (rwx-wx-wx) to make it\n";
2252 print " impossible for a random person with access to the webserver\n";
2253 print " to list files in this directory. Confidential data might\n";
2254 print " be laying around in there.\n";
2255 print " Depending on your user:group assignments, 730 (rwx-wx---)\n";
2256 print " may be possible, and more secure (e.g. root:apache)\n";
2257 print " 2. Since the webserver is not able to list the files in the\n";
2258 print " content is also impossible for the webserver to delete files\n";
2259 print " lying around there for too long.\n";
2260 print " 3. It should probably be another directory than the data\n";
2261 print " directory specified in option 3.\n";
2264 print "[$WHT$attachment_dir$NRM]: $WHT";
2265 $new_attachment_dir = <STDIN
>;
2266 if ( $new_attachment_dir eq "\n" ) {
2267 $new_attachment_dir = $attachment_dir;
2269 $new_attachment_dir =~ s/[\r\n]//g;
2271 if ( $new_attachment_dir =~ /^\s*$/ ) {
2272 $new_attachment_dir = "";
2274 $new_attachment_dir =~ s/\/*$//g
;
2275 $new_attachment_dir =~ s/$/\//g
;
2277 return $new_attachment_dir;
2281 print "The directory hash level setting allows you to configure the level\n";
2282 print "of hashing that SquirrelMail employs in your data and attachment\n";
2283 print "directories. This value must be an integer ranging from 0 to 4.\n";
2284 print "When this value is set to 0, SquirrelMail will simply store all\n";
2285 print "files as normal in the data and attachment directories. However,\n";
2286 print "when set to a value from 1 to 4, a simple hashing scheme will be\n";
2287 print "used to organize the files in this directory. In short, the crc32\n";
2288 print "value for a username will be computed. Then, up to the first 4\n";
2289 print "digits of the hash, as set by this configuration value, will be\n";
2290 print "used to directory hash the files for that user in the data and\n";
2291 print "attachment directory. This allows for better performance on\n";
2292 print "servers with larger numbers of users.\n";
2295 print "[$WHT$dir_hash_level$NRM]: $WHT";
2296 $new_dir_hash_level = <STDIN
>;
2297 if ( $new_dir_hash_level eq "\n" ) {
2298 $new_dir_hash_level = $dir_hash_level;
2300 $new_dir_hash_level =~ s/[\r\n]//g;
2302 if ( ( int($new_dir_hash_level) < 0 )
2303 || ( int($new_dir_hash_level) > 4 )
2304 || !( int($new_dir_hash_level) eq $new_dir_hash_level ) ) {
2305 print "Invalid Directory Hash Level.\n";
2306 print "Value must be an integer ranging from 0 to 4\n";
2307 print "Hit enter to continue.\n";
2308 $enter_key = <STDIN
>;
2310 $new_dir_hash_level = $dir_hash_level;
2313 return $new_dir_hash_level;
2317 print "This is the default size (in pixels) of the left folder list.\n";
2318 print "Default is 200, but you can set it to whatever you wish. This\n";
2319 print "is a user preference, so this will only show up as their default.\n";
2321 print "[$WHT$default_left_size$NRM]: $WHT";
2322 $new_default_left_size = <STDIN
>;
2323 if ( $new_default_left_size eq "\n" ) {
2324 $new_default_left_size = $default_left_size;
2326 $new_default_left_size =~ s/[\r\n]//g;
2328 return $new_default_left_size;
2332 print "Some IMAP servers only have lowercase letters in the usernames\n";
2333 print "but they still allow people with uppercase to log in. This\n";
2334 print "causes a problem with the user's preference files. This option\n";
2335 print "transparently changes all usernames to lowercase.";
2338 if ( lc($force_username_lowercase) eq 'true' ) {
2339 $default_value = "y";
2341 $default_value = "n";
2343 print "Convert usernames to lowercase (y/n) [$WHT$default_value$NRM]: $WHT";
2344 $new_show = <STDIN
>;
2345 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2355 if ( lc($default_use_priority) eq 'true' ) {
2356 $default_value = "y";
2358 $default_value = "n";
2361 print "Allow users to specify priority of outgoing mail (y/n) [$WHT$default_value$NRM]: $WHT";
2362 $new_show = <STDIN
>;
2363 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2373 if ( lc($default_hide_attribution) eq 'true' ) {
2374 $default_value = "y";
2376 $default_value = "n";
2379 print "Hide SM attributions (y/n) [$WHT$default_value$NRM]: $WHT";
2380 $new_show = <STDIN
>;
2381 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2391 if ( lc($default_use_mdn) eq 'true' ) {
2392 $default_value = "y";
2394 $default_value = "n";
2397 print "Enable support for read/delivery receipt support (y/n) [$WHT$default_value$NRM]: $WHT";
2398 $new_show = <STDIN
>;
2399 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2407 print " In loosely managed environments, you may want to allow users
2408 to edit their full name and email address. In strictly managed
2409 environments, you may want to force users to use the name
2410 and email address assigned to them.
2412 'y' - allow a user to edit their full name and email address,
2413 'n' - users must use the assigned values.
2417 if ( lc($edit_identity) eq 'true' ) {
2418 $default_value = "y";
2420 $default_value = "n";
2422 print "Allow editing of user's identity? (y/n) [$WHT$default_value$NRM]: $WHT";
2423 $new_edit = <STDIN
>;
2424 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2425 $edit_identity = 'true';
2426 $edit_name = 'true';
2427 $hide_auth_header = command311b
();
2429 $edit_identity = 'false';
2430 $edit_name = command311
();
2431 $hide_auth_header = command311b
();
2433 return $edit_identity;
2437 print " Given that users are not allowed to modify their
2438 email address, can they edit their full name?
2442 if ( lc($edit_name) eq 'true' ) {
2443 $default_value = "y";
2445 $default_value = "n";
2447 print "Allow the user to edit their full name? (y/n) [$WHT$default_value$NRM]: $WHT";
2448 $new_edit = <STDIN
>;
2449 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2450 $edit_name = 'true';
2452 $edit_name = 'false';
2458 print " SquirrelMail adds username information to every sent email
2459 in order to prevent possible sender forging when users are allowed
2460 to change their email and/or full name.
2462 You can remove user information from this header (y), if you think that
2463 it violates privacy or security.
2465 Note: If users are allowed to change their email addresses,
2466 this setting will make it difficult to determine who sent what where.
2467 Use at your own risk.
2471 if ( lc($hide_auth_header) eq "true" ) {
2472 $default_value = "y";
2474 $default_value = "n";
2476 print "Remove username from email headers? (y/n) [$WHT$default_value$NRM]: $WHT";
2477 $new_header = <STDIN
>;
2478 if ( ( $new_header =~ /^y\n/i ) || ( ( $new_header =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2479 $hide_auth_header = "true";
2481 $hide_auth_header = "false";
2483 return $hide_auth_header;
2487 print "This option allows you to disable server side thread sorting if your server \n";
2488 print "declares THREAD support, but you don't want to provide threading options \n";
2489 print "to end users or THREAD extension is broken or extension does not work with \n";
2490 print "options used by SquirrelMail. Option is not used, if THREAD extension is \n";
2491 print "not declared in IMAP CAPABILITY.\n";
2494 if ( lc($disable_thread_sort) eq 'true' ) {
2495 $default_value = "y";
2497 $default_value = "n";
2499 print "Disable server side thread sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2500 $disable_thread_sort = <STDIN
>;
2501 if ( ( $disable_thread_sort =~ /^y\n/i ) || ( ( $disable_thread_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2502 $disable_thread_sort = 'true';
2504 $disable_thread_sort = 'false';
2506 return $disable_thread_sort;
2510 print "This option allows you to disable server side sorting if your server declares \n";
2511 print "SORT support, but SORT extension is broken or does not work with options \n";
2512 print "used by SquirrelMail. Option is not used, if SORT extension is not declared \n";
2513 print "in IMAP CAPABILITY.\n";
2515 print "It is strongly recommended to keep server side sorting enabled, if your ";
2516 print "IMAP server supports it.";
2519 if ( lc($disable_server_sort) eq 'true' ) {
2520 $default_value = "y";
2522 $default_value = "n";
2524 print "Disable server-side sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2525 $disable_server_sort = <STDIN
>;
2526 if ( ( $disable_server_sort =~ /^y\n/i ) || ( ( $disable_server_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2527 $disable_server_sort = 'true';
2529 $disable_server_sort = 'false';
2531 return $disable_server_sort;
2535 print "This option allows you to choose if SM uses charset search\n";
2536 print "Your IMAP server must support the SEARCH CHARSET command for this to work\n";
2539 if ( lc($allow_charset_search) eq 'true' ) {
2540 $default_value = "y";
2542 $default_value = "n";
2544 print "Allow charset searching? (y/n) [$WHT$default_value$NRM]: $WHT";
2545 $allow_charset_search = <STDIN
>;
2546 if ( ( $allow_charset_search =~ /^y\n/i ) || ( ( $allow_charset_search =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2547 $allow_charset_search = 'true';
2549 $allow_charset_search = 'false';
2551 return $allow_charset_search;
2554 # command315 (UID support) obsoleted.
2556 # advanced search option
2558 print "This option allows you to control the use of advanced search form.\n";
2559 print " 0 = enable basic search only\n";
2560 print " 1 = enable advanced search only\n";
2561 print " 2 = enable both\n";
2564 print "Allowed search (0,1,2)? [$WHT$allow_advanced_search$NRM]: $WHT";
2565 $new_allow_advanced_search = <STDIN
>;
2566 if ( $new_allow_advanced_search =~ /^[012]\n/i ) {
2567 $allow_advanced_search = $new_allow_advanced_search;
2569 $allow_advanced_search =~ s/[\r\n]//g;
2570 return $allow_advanced_search;
2575 print "This option allows you to change the name of the PHP session used\n";
2576 print "by SquirrelMail. Unless you know what you are doing, you probably\n";
2577 print "don't need or want to change this from the default of SQMSESSID.\n";
2578 print "[$WHT$session_name$NRM]: $WHT";
2579 $new_session_name = <STDIN
>;
2580 chomp($new_session_name);
2581 if ( $new_session_name eq "" ) {
2582 $new_session_name = $session_name;
2584 return $new_session_name;
2587 # time zone config (since 1.5.1)
2589 print "This option allows you to control the use of time zones.\n";
2590 print " 0 = (default) standard, GNU C time zone names\n";
2591 print " 1 = strict, generic time zone codes with offsets\n";
2592 print " 2 = custom, GNU C time zones loaded from config/timezones.php\n";
2593 print " 3 = custom strict, generic time zone codes with offsets loaded \n";
2594 print " from config/timezones.php\n";
2595 print "See SquirrelMail documentation about format of config/timezones.php file.\n";
2598 print "Used time zone configuration (0,1,2,3)? [$WHT$time_zone_type$NRM]: $WHT";
2599 $new_time_zone_type = <STDIN
>;
2600 if ( $new_time_zone_type =~ /^[0123]\n/i ) {
2601 $time_zone_type = $new_time_zone_type;
2603 print "\nInvalid configuration value.\n";
2604 print "\nPress enter to continue...";
2607 $time_zone_type =~ s/[\r\n]//g;
2608 return $time_zone_type;
2611 # set the location base for redirects (since 1.5.2)
2612 sub command_config_location_base
{
2613 print "Here you can set the base part of the SquirrelMail URL.\n";
2614 print "It is normally autodetected but if that fails, use this\n";
2615 print "option to override.\n";
2616 print "It should contain only the protocol and hostname/port parts\n";
2617 print "of the URL; the full path will be appended automatically.\n\n";
2618 print "Examples:\nhttp://webmail.example.org\nhttp://webmail.example.com:8080\nhttps://webmail.example.com:6691\n\n";
2619 print "Do not add any path elements.\n";
2621 print "URL base? [" .$WHT."autodetect$NRM]: $WHT";
2622 $new_config_location_base = <STDIN
>;
2623 chomp($new_config_location_base);
2624 $config_location_base = $new_config_location_base;
2626 return $config_location_base;
2629 # only_secure_cookies (since 1.5.2)
2631 print "This option allows you to specify that if a user session is initiated\n";
2632 print "under a secure (HTTPS, SSL-encrypted) connection, the cookies given to\n";
2633 print "the browser will ONLY be transmitted via a secure connection henceforth.\n\n";
2634 print "Generally this is a Good Thing, and should NOT be disabled. However,\n";
2635 print "if you intend to use the Secure Login or Show SSL Link plugins to\n";
2636 print "encrypt the user login, but not the rest of the SquirrelMail session,\n";
2637 print "this can be turned off. Think twice before doing so.\n";
2640 if ( lc($only_secure_cookies) eq 'true' ) {
2641 $default_value = "y";
2643 $default_value = "n";
2645 print "Transmit cookies only on secure connection when available? (y/n) [$WHT$default_value$NRM]: $WHT";
2646 $only_secure_cookies = <STDIN
>;
2647 if ( ( $only_secure_cookies =~ /^y\n/i ) || ( ( $only_secure_cookies =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2648 $only_secure_cookies = 'true';
2650 $only_secure_cookies = 'false';
2652 return $only_secure_cookies;
2656 sub command_userThemes
{
2657 print "\nDefine the user themes that you wish to use. If you have added\n";
2658 print "a theme of your own, just follow the instructions (?) about\n";
2659 print "how to add them. You can also change the default theme.\n\n";
2661 print "Available user themes:\n";
2663 while ( $count <= $#user_theme_name ) {
2664 if ( $count == $user_theme_default ) {
2669 if ( $count < 10 ) {
2672 $name = $user_theme_name[$count];
2673 $num_spaces = 35 - length($name);
2674 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2675 $name = $name . " ";
2678 print " $count. $name";
2679 print "($user_theme_path[$count])\n";
2685 print ".------------------------------------.\n";
2686 print "| t (detect user themes) |\n";
2687 print "| + (add user theme) |\n";
2688 print "| - N (remove user theme) |\n";
2689 print "| m N (mark default user theme) |\n";
2690 print "| l (list user themes) |\n";
2691 print "| d (done) |\n";
2692 print "`------------------------------------'\n";
2694 print "\n[user_themes] command (?=help) > ";
2696 $input =~ s/[\r\n]//g;
2697 while ( $input ne "d" ) {
2698 if ( $input =~ /^\s*l\s*/i ) {
2700 while ( $count <= $#user_theme_name ) {
2701 if ( $count == $user_theme_default ) {
2706 if ( $count < 10 ) {
2709 $name = $user_theme_name[$count];
2710 $num_spaces = 35 - length($name);
2711 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2712 $name = $name . " ";
2715 print " $count. $name";
2716 print "($user_theme_path[$count])\n";
2720 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2721 $old_def = $user_theme_default;
2722 $user_theme_default = $input;
2723 $user_theme_default =~ s/^\s*m\s*//;
2724 if ( ( $user_theme_default > $#user_theme_name ) || ( $user_theme_default < 0 ) ) {
2725 print "Cannot set default theme to $user_theme_default. That theme does not exist.\n";
2726 $user_theme_default = $old_def;
2728 } elsif ( $input =~ /^\s*\+/ ) {
2729 print "What is the name of this theme? ";
2731 $name =~ s/[\r\n]//g;
2732 $user_theme_name[ $#user_theme_name + 1 ] = $name;
2733 print "Be sure to put ../css/ before the filename.\n";
2734 print "What file is this stored in (ex: ../css/my_theme/): ";
2736 $name =~ s/[\r\n]//g;
2737 $user_theme_path[ $#user_theme_path + 1 ] = $name;
2738 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2739 if ( $input =~ /[0-9]+\s*$/ ) {
2741 $rem_num =~ s/^\s*-\s*//g;
2742 $rem_num =~ s/\s*$//;
2744 $rem_num = $#user_theme_name;
2746 if ( $rem_num == $user_theme_default ) {
2747 print "You cannot remove the default theme!\n";
2750 @new_theme_name = ();
2751 @new_theme_path = ();
2752 while ( $count <= $#user_theme_name ) {
2753 if ( $count != $rem_num ) {
2754 @new_theme_name = ( @new_theme_name, $user_theme_name[$count] );
2755 @new_theme_path = ( @new_theme_path, $user_theme_path[$count] );
2759 @user_theme_name = @new_theme_name;
2760 @user_theme_path = @new_theme_path;
2761 if ( $user_theme_default > $rem_num ) {
2762 $user_theme_default--;
2765 } elsif ( $input =~ /^\s*t\s*/i ) {
2766 print "\nStarting detection...\n\n";
2768 opendir( DIR
, "../css" );
2769 @files = readdir(DIR
);
2771 while ( $cnt <= $#files ) {
2772 $filename = "../css/" . $files[$cnt] .'/';
2773 if ( $filename ne "../css/rtl.css" && -e
$filename . "default.css" ) {
2775 for ( $x = 0 ; $x <= $#user_theme_path ; $x++ ) {
2776 if ( $user_theme_path[$x] eq $filename ) {
2780 if ( $found != 1 ) {
2781 print "** Found user theme: $filename\n";
2782 print " What is its name? ";
2785 $user_theme_name[ $#user_theme_name + 1 ] = $nm;
2786 $user_theme_path[ $#user_theme_path + 1 ] = $filename;
2792 for ( $cnt = 0 ; $cnt <= $#user_theme_path ; $cnt++ ) {
2793 $filename = $user_theme_path[$cnt];
2794 if ( $filename != 'none' && !( -e
$filename ."/default.css" ) ) {
2795 print " Removing $filename (file not found)\n";
2797 @new_user_theme_name = ();
2798 @new_user_theme_path = ();
2799 for ( $x = 0 ; $x < $#user_theme_path ; $x++ ) {
2800 if ( $user_theme_path[$x] eq $filename ) {
2803 if ( $offset == 1 ) {
2804 $new_user_theme_name[$x] = $user_theme_name[ $x + 1 ];
2805 $new_user_theme_path[$x] = $user_theme_path[ $x + 1 ];
2807 $new_user_theme_name[$x] = $user_theme_name[$x];
2808 $new_user_theme_path[$x] = $user_theme_path[$x];
2811 @user_theme_name = @new_user_theme_name;
2812 @user_theme_path = @new_user_theme_path;
2815 print "\nDetection complete!\n\n";
2818 } elsif ( $input =~ /^\s*\?\s*/ ) {
2819 print ".------------------------------------.\n";
2820 print "| t (detect user themes) |\n";
2821 print "| + (add user theme) |\n";
2822 print "| - N (remove user theme) |\n";
2823 print "| m N (mark default user theme) |\n";
2824 print "| l (list user themes) |\n";
2825 print "| d (done) |\n";
2826 print "`------------------------------------'\n";
2828 print "[user_themes] command (?=help) > ";
2830 $input =~ s/[\r\n]//g;
2834 sub command_iconSets
{
2835 print "\nDefine the icon themes that you wish to use. If you have added\n";
2836 print "a theme of your own, just follow the instructions (?) about\n";
2837 print "how to add them. You can also change the default and fallback\n";
2838 print "themes. The default theme will be used when no icon theme is\n";
2839 print "set by the user. The fallback theme will be used if an icon\n";
2840 print "cannot be found in the currently selected icon theme.\n\n";
2842 print "Available icon themes:\n\n";
2845 while ( $count <= $#icon_theme_name ) {
2846 if ( $count == $icon_theme_def ) {
2851 if ( $count eq $icon_theme_fallback ) {
2856 if ( $count < 10 ) {
2859 $name = $icon_theme_name[$count];
2860 $num_spaces = 35 - length($name);
2861 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2862 $name = $name . " ";
2865 print " $count. $name";
2866 print "($icon_theme_path[$count])\n";
2871 print "\n d = Default icon theme\n";
2872 print " f = Fallback icon theme\n";
2874 print ".------------------------------------.\n";
2875 print "| t (detect icon themes) |\n";
2876 print "| + (add icon theme) |\n";
2877 print "| - N (remove icon theme) |\n";
2878 print "| m N (mark default icon theme) |\n";
2879 print "| f N (set fallback icon set) |\n";
2880 print "| l (list icon themes) |\n";
2881 print "| d (done) |\n";
2882 print "`------------------------------------'\n";
2884 print "\n[icon_themes] command (?=help) > ";
2886 $input =~ s/[\r\n]//g;
2887 while ( $input ne "d" ) {
2888 if ( $input =~ /^\s*l\s*/i ) {
2891 while ( $count <= $#icon_theme_name ) {
2892 if ( $count == $icon_theme_def ) {
2897 if ( $count eq $icon_theme_fallback ) {
2902 $name = $icon_theme_name[$count];
2903 $num_spaces = 35 - length($name);
2904 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2905 $name = $name . " ";
2908 print " $count. $name";
2909 print "($icon_theme_path[$count])\n";
2913 print "\n d = Default icon theme\n";
2914 print " f = Fallback icon theme\n\n";
2915 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2916 $old_def = $icon_theme_def;
2917 $icon_theme_def = $input;
2918 $icon_theme_def =~ s/^\s*m\s*//;
2919 if ( ( $icon_theme_default > $#icon_theme_name ) || ( $icon_theme_default < 0 ) ) {
2920 print "Cannot set default icon theme to $icon_theme_default. That theme does not exist.\n";
2921 $icon_theme_def = $old_def;
2923 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
2924 $old_fb = $icon_theme_fallback;
2925 $icon_theme_fallback = $input;
2926 $icon_theme_fallback =~ s/^\s*f\s*//;
2927 if ( ( $icon_theme_fallback > $#icon_theme_name ) || ( $icon_theme_fallback < 0 ) ) {
2928 print "Cannot set fallback icon theme to $icon_theme_fallback. That theme does not exist.\n";
2929 $icon_theme_fallback = $old_fb;
2931 } elsif ( $input =~ /^\s*\+/ ) {
2932 print "What is the name of this icon theme? ";
2934 $name =~ s/[\r\n]//g;
2935 $icon_theme_name[ $#icon_theme_name + 1 ] = $name;
2936 print "Be sure to put ../images/themes/ before the filename.\n";
2937 print "What directory is this icon theme stored in (ex: ../images/themes/my_theme/)? ";
2939 $name =~ s/[\r\n]//g;
2940 $icon_theme_path[ $#icon_theme_path + 1 ] = $name;
2941 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2942 if ( $input =~ /[0-9]+\s*$/ ) {
2944 $rem_num =~ s/^\s*-\s*//g;
2945 $rem_num =~ s/\s*$//;
2947 $rem_num = $#icon_theme_name;
2949 if ( $rem_num == $icon_theme_def ) {
2950 print "You cannot remove the default icon theme!\n";
2951 } elsif ( $rem_num == $icon_theme_fallback ) {
2952 print "You cannot remove the fallback icon theme!\n";
2955 @new_theme_name = ();
2956 @new_theme_path = ();
2957 while ( $count <= $#icon_theme_name ) {
2958 if ( $count != $rem_num ) {
2959 @new_theme_name = ( @new_theme_name, $icon_theme_name[$count] );
2960 @new_theme_path = ( @new_theme_path, $icon_theme_path[$count] );
2964 @icon_theme_name = @new_theme_name;
2965 @icon_theme_path = @new_theme_path;
2966 if ( $icon_theme_def > $rem_num ) {
2970 } elsif ( $input =~ /^\s*t\s*/i ) {
2971 print "\nStarting detection...\n\n";
2973 opendir( DIR
, "../images/themes/" );
2974 @files = readdir(DIR
);
2976 while ( $cnt <= $#files ) {
2977 $filename = "../images/themes/" . $files[$cnt] .'/';
2978 if ( -d
"../images/themes/" . $files[$cnt] && $files[$cnt] !~ /^\
./ && $files[$cnt] ne "CVS" ) {
2980 for ( $x = 0 ; $x <= $#icon_theme_path ; $x++ ) {
2981 if ( $icon_theme_path[$x] eq $filename ) {
2985 if ( $found != 1 ) {
2986 print "** Found icon theme: $filename\n";
2987 print " What is its name? ";
2990 $icon_theme_name[ $#icon_theme_name + 1 ] = $nm;
2991 $icon_theme_path[ $#icon_theme_path + 1 ] = $filename;
2997 for ( $cnt = 0 ; $cnt <= $#icon_theme_path ; $cnt++ ) {
2998 $filename = $icon_theme_path[$cnt];
2999 if ( $filename ne "none" && $filename ne "template" && ! -d
$filename ) {
3000 print " Removing $filename (file not found)\n";
3002 @new_icon_theme_name = ();
3003 @new_icon_theme_path = ();
3004 for ( $x = 0 ; $x < $#icon_theme_path ; $x++ ) {
3005 if ( $icon_theme_path[$x] eq $filename ) {
3008 if ( $offset == 1 ) {
3009 $new_icon_theme_name[$x] = $icon_theme_name[ $x + 1 ];
3010 $new_icon_theme_path[$x] = $icon_theme_path[ $x + 1 ];
3012 $new_icon_theme_name[$x] = $icon_theme_name[$x];
3013 $new_icon_theme_path[$x] = $icon_theme_path[$x];
3016 @icon_theme_name = @new_icon_theme_name;
3017 @icon_theme_path = @new_icon_theme_path;
3020 print "\nDetection complete!\n\n";
3023 } elsif ( $input =~ /^\s*\?\s*/ ) {
3024 print ".------------------------------------.\n";
3025 print "| t (detect icon themes) |\n";
3026 print "| + (add icon theme) |\n";
3027 print "| - N (remove icon theme) |\n";
3028 print "| m N (mark default icon theme) |\n";
3029 print "| f N (set fallback icon set) |\n";
3030 print "| l (list icon themes) |\n";
3031 print "| d (done) |\n";
3032 print "`------------------------------------'\n";
3034 print "[icon_themes] command (?=help) > ";
3036 $input =~ s/[\r\n]//g;
3040 sub command_templates
{
3041 print "\nDefine the template sets that you wish to use. If you have added\n";
3042 print "a template set of your own, just follow the instructions (?) about\n";
3043 print "how to add them. You can also change the default template.\n";
3045 print "\n Available Templates:\n";
3048 while ( $count <= $#templateset_name ) {
3049 if ( $templateset_id[$count] eq $templateset_default ) {
3054 if ( $templateset_id[$count] eq $templateset_fallback ) {
3059 if ( $count < 10 ) {
3062 $name = $templateset_name[$count];
3063 $num_spaces = 35 - length($name);
3064 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3065 $name = $name . " ";
3068 print " $count. $name";
3069 print "($templateset_id[$count])\n";
3073 print "\n d = default template set\n"
3074 . " f = fallback template set\n\n";
3076 $menu_text = ".-------------------------------------.\n"
3077 . "| t (detect template set) |\n"
3078 . "| + (add template set) |\n"
3079 . "| - N (remove template set) |\n"
3080 . "| m N (mark default template set) |\n"
3081 . "| f N (set fallback template set) |\n"
3082 . "| l (list template sets) |\n"
3084 . "|-------------------------------------|\n"
3085 . "| where N is a template set number |\n"
3086 . "`-------------------------------------'\n";