4 # Copyright (c) 1999-2006 The SquirrelMail Project Team
5 # Licensed under the GNU GPL. For full terms see COPYING.
7 # A simple configure script to configure SquirrelMail
10 ############################################################
11 $conf_pl_version = "1.5.0";
13 ############################################################
14 # Check what directory we're supposed to be running in, and
15 # change there if necessary. File::Basename has been in
16 # Perl since at least 5.003_7, and nobody sane runs anything
17 # before that, but just in case.
18 ############################################################
20 if ( eval q{require "File/Basename.pm"} ) {
21 $dir = File
::Basename
::dirname
($0);
25 ############################################################
26 # Some people try to run this as a CGI. That's wrong!
27 ############################################################
28 if ( defined( $ENV{'PATH_INFO'} )
29 || defined( $ENV{'QUERY_STRING'} )
30 || defined( $ENV{'REQUEST_METHOD'} ) ) {
31 print "Content-Type: text/html\n\n";
32 print "You must run this script from the command line.";
36 ############################################################
37 # If we got here, use Cwd to get the full directory path
38 # (the Basename stuff above will sometimes return '.' as
39 # the base directory, which is not helpful here).
40 ############################################################
45 ############################################################
46 # First, lets read in the data already in there...
47 ############################################################
48 if ( -e
"config.php" ) {
49 # Make sure that file is readable
50 if (! -r
"config.php") {
53 print "The file \"config/config.php\" was found, but you don't\n";
54 print "have rights to read it.\n";
56 print "Press enter to continue";
60 open( FILE
, "config.php" );
61 while ( $line = <FILE
> ) {
67 if ( $var =~ /^([a-z])/i ) {
68 @o = split ( /\s*EQUALS\s*/, $var );
69 if ( $o[0] eq "config_version" ) {
71 $o[1] =~ s/[\'\"];\s*$//;
75 $config_version = $o[1];
82 if ( $config_version ne $conf_pl_version ) {
85 print " The file \"config/config.php\" was found, but it is for\n";
86 print " an older version of SquirrelMail. It is possible to still\n";
87 print " read the defaults from this file but be warned that many\n";
88 print " preferences change between versions. It is recommended that\n";
89 print " you start with a clean config.php for each upgrade that you\n";
90 print " do. To do this, just move config/config.php out of the way.\n";
92 print "Continue loading with the old config.php [y/N]? ";
95 if ( ( $ctu !~ /^y\n/i ) || ( $ctu =~ /^\n/ ) ) {
99 print "\nDo you want me to stop warning you [y/N]? ";
101 if ( $ctu =~ /^y\n/i ) {
102 $print_config_version = $conf_pl_version;
104 $print_config_version = $config_version;
107 $print_config_version = $config_version;
111 open( FILE
, "config.php" );
112 } elsif ( -e
"config_default.php" ) {
113 open( FILE
, "config_default.php" );
114 while ( $line = <FILE
> ) {
120 if ( $var =~ /^([a-z])/i ) {
121 @o = split ( /\s*EQUALS\s*/, $var );
122 if ( $o[0] eq "config_version" ) {
123 $o[1] =~ s/[\n\r]//g;
124 $o[1] =~ s/[\'\"];\s*$//;
126 $o[1] =~ s/^[\'\"]//;
128 $config_version = $o[1];
135 if ( $config_version ne $conf_pl_version ) {
138 print " You are trying to use a 'config_default.php' from an older\n";
139 print " version of SquirrelMail. This is HIGHLY unrecommended. You\n";
140 print " should get the 'config_default.php' that matches the version\n";
141 print " of SquirrelMail that you are running. You can get this from\n";
142 print " the SquirrelMail web page by going to the following URL:\n";
143 print " http://www.squirrelmail.org.\n";
145 print "Continue loading with old config_default.php (a bad idea) [y/N]? ";
148 if ( ( $ctu !~ /^y\n/i ) || ( $ctu =~ /^\n/ ) ) {
152 print "\nDo you want me to stop warning you [y/N]? ";
154 if ( $ctu =~ /^y\n/i ) {
155 $print_config_version = $conf_pl_version;
157 $print_config_version = $config_version;
160 $print_config_version = $config_version;
163 open( FILE
, "config_default.php" );
165 print "No configuration file found. Please get config_default.php\n";
166 print "or config.php before running this again. This program needs\n";
167 print "a default config file to get default values.\n";
171 # Read and parse the current configuration file
172 # (either config.php or config_default.php).
173 while ( $line = <FILE
> ) {
179 if ( $var =~ /^([a-z])/i ) {
180 @options = split ( /\s*EQUALS\s*/, $var );
181 $options[1] =~ s/[\n\r]//g;
182 $options[1] =~ s/[\'\"];\s*$//;
183 $options[1] =~ s/;$//;
184 $options[1] =~ s/^[\'\"]//;
185 # de-escape escaped strings
186 $options[1] =~ s/\\'/'/g;
187 $options[1] =~ s/\\\\/\\/g;
189 if ( $options[0] =~ /^user_themes\[[0-9]+\]\[['"]PATH['"]\]/ ) {
191 $sub =~ s/\]\[['"]PATH['"]\]//;
193 if ( -e
"../css/" ) {
194 $options[1] =~ s/^\.\.\/config/\
.\
.\
/css/;
196 $user_theme_path[$sub] = &change_to_rel_path
($options[1]);
197 } elsif ( $options[0] =~ /^user_themes\[[0-9]+\]\[['"]NAME['"]\]/ ) {
199 $sub =~ s/\]\[['"]NAME['"]\]//;
201 $user_theme_name[$sub] = $options[1];
202 } elsif ( $options[0] =~ /^icon_themes\[[0-9]+\]\[['"]PATH['"]\]/ ) {
204 $sub =~ s/\]\[['"]PATH['"]\]//;
206 if ( -e
"../images/" ) {
207 $options[1] =~ s/^\.\.\/config/\
.\
.\
/images/;
209 $icon_theme_path[$sub] = &change_to_rel_path
($options[1]);
210 } elsif ( $options[0] =~ /^icon_themes\[[0-9]+\]\[['"]NAME['"]\]/ ) {
212 $sub =~ s/\]\[['"]NAME['"]\]//;
214 $icon_theme_name[$sub] = $options[1];
215 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]ID['"]\]/ ) {
217 $sub =~ s/\]\[['"]ID['"]\]//;
219 if ( -e
"../templates" ) {
220 $options[1] =~ s/^\.\.\/config/\
.\
.\
/templates/;
222 $templateset_id[$sub] = $options[1];
223 ##### FIXME: This section BELOW here so old prefs files don't blow up when running conf.pl
224 ##### Remove after a month or two
225 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]PATH['"]\]/ ) {
227 $sub =~ s/\]\[['"]PATH['"]\]//;
229 if ( -e
"../templates" ) {
230 $options[1] =~ s/^\.\.\/config/\
.\
.\
/templates/;
232 $templateset_id[$sub] = $options[1];
233 ##### FIXME: This section ABOVE here so old prefs files don't blow up when running conf.pl
234 ##### Remove after a month or two
235 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]NAME['"]\]/ ) {
237 $sub =~ s/\]\[['"]NAME['"]\]//;
239 $templateset_name[$sub] = $options[1];
240 } elsif ( $options[0] =~ /^plugins\[[0-9]*\]/ ) {
243 $sub =~ s/^plugins\[//;
245 push @plugins, $options[1];
247 $plugins[$sub] = $options[1];
249 } elsif ($options[0] =~ /^fontsets\[\'[a-z]*\'\]/) {
250 # parse associative $fontsets array
253 $sub =~ s/^fontsets\[\'//;
254 $fontsets{$sub} = $options[1];
255 } elsif ( $options[0] =~ /^theme\[[0-9]+\]\[['"]PATH|NAME['"]\]/ ) {
257 ## $color themes are no longer supported. Please leave this
258 ## so conf.pl doesn't barf if it encounters a $theme.
260 } elsif ( $options[0] =~ /^ldap_server\[[0-9]+\]/ ) {
263 $sub =~ s/^ldap_server\[//;
265 while ( ( $tmp = <FILE
> ) && ( $continue != 1 ) ) {
266 if ( $tmp =~ /\);\s*$/ ) {
270 if ( $tmp =~ /^\s*[\'\"]host[\'\"]/i ) {
271 $tmp =~ s/^\s*[\'\"]host[\'\"]\s*=>\s*[\'\"]//i;
272 $tmp =~ s/[\'\"],?\s*$//;
273 $tmp =~ s/[\'\"]\);\s*$//;
275 } elsif ( $tmp =~ /^\s*[\'\"]base[\'\"]/i ) {
276 $tmp =~ s/^\s*[\'\"]base[\'\"]\s*=>\s*[\'\"]//i;
277 $tmp =~ s/[\'\"],?\s*$//;
278 $tmp =~ s/[\'\"]\);\s*$//;
280 } elsif ( $tmp =~ /^\s*[\'\"]charset[\'\"]/i ) {
281 $tmp =~ s/^\s*[\'\"]charset[\'\"]\s*=>\s*[\'\"]//i;
282 $tmp =~ s/[\'\"],?\s*$//;
283 $tmp =~ s/[\'\"]\);\s*$//;
285 } elsif ( $tmp =~ /^\s*[\'\"]port[\'\"]/i ) {
286 $tmp =~ s/^\s*[\'\"]port[\'\"]\s*=>\s*[\'\"]?//i;
287 $tmp =~ s/[\'\"]?,?\s*$//;
288 $tmp =~ s/[\'\"]?\);\s*$//;
290 } elsif ( $tmp =~ /^\s*[\'\"]maxrows[\'\"]/i ) {
291 $tmp =~ s/^\s*[\'\"]maxrows[\'\"]\s*=>\s*[\'\"]?//i;
292 $tmp =~ s/[\'\"]?,?\s*$//;
293 $tmp =~ s/[\'\"]?\);\s*$//;
295 } elsif ( $tmp =~ /^\s*[\'\"]filter[\'\"]/i ) {
296 $tmp =~ s/^\s*[\'\"]filter[\'\"]\s*=>\s*[\'\"]?//i;
297 $tmp =~ s/[\'\"]?,?\s*$//;
298 $tmp =~ s/[\'\"]?\);\s*$//;
300 } elsif ( $tmp =~ /^\s*[\'\"]name[\'\"]/i ) {
301 $tmp =~ s/^\s*[\'\"]name[\'\"]\s*=>\s*[\'\"]//i;
302 $tmp =~ s/[\'\"],?\s*$//;
303 $tmp =~ s/[\'\"]\);\s*$//;
305 } elsif ( $tmp =~ /^\s*[\'\"]binddn[\'\"]/i ) {
306 $tmp =~ s/^\s*[\'\"]binddn[\'\"]\s*=>\s*[\'\"]//i;
307 $tmp =~ s/[\'\"],?\s*$//;
308 $tmp =~ s/[\'\"]\);\s*$//;
310 } elsif ( $tmp =~ /^\s*[\'\"]bindpw[\'\"]/i ) {
311 $tmp =~ s/^\s*[\'\"]bindpw[\'\"]\s*=>\s*[\'\"]//i;
312 $tmp =~ s/[\'\"],?\s*$//;
313 $tmp =~ s/[\'\"]\);\s*$//;
315 } elsif ( $tmp =~ /^\s*[\'\"]protocol[\'\"]/i ) {
316 $tmp =~ s/^\s*[\'\"]protocol[\'\"]\s*=>\s*[\'\"]?//i;
317 $tmp =~ s/[\'\"]?,?\s*$//;
318 $tmp =~ s/[\'\"]?\);\s*$//;
320 } elsif ( $tmp =~ /^\s*[\'\"]limit_scope[\'\"]/i ) {
321 $tmp =~ s/^\s*[\'\"]limit_scope[\'\"]\s*=>\s*[\'\"]?//i;
322 $tmp =~ s/[\'\"]?,?\s*$//;
323 $tmp =~ s/[\'\"]?\);\s*$//;
325 } elsif ( $tmp =~ /^\s*[\'\"]listing[\'\"]/i ) {
326 $tmp =~ s/^\s*[\'\"]listing[\'\"]\s*=>\s*[\'\"]?//i;
327 $tmp =~ s/[\'\"]?,?\s*$//;
328 $tmp =~ s/[\'\"]?\);\s*$//;
330 } elsif ( $tmp =~ /^\s*[\'\"]writeable[\'\"]/i ) {
331 $tmp =~ s/^\s*[\'\"]writeable[\'\"]\s*=>\s*[\'\"]?//i;
332 $tmp =~ s/[\'\"]?,?\s*$//;
333 $tmp =~ s/[\'\"]?\);\s*$//;
335 } elsif ( $tmp =~ /^\s*[\'\"]search_tree[\'\"]/i ) {
336 $tmp =~ s/^\s*[\'\"]search_tree[\'\"]\s*=>\s*[\'\"]?//i;
337 $tmp =~ s/[\'\"]?,?\s*$//;
338 $tmp =~ s/[\'\"]?\);\s*$//;
340 } elsif ( $tmp =~ /^\s*[\'\"]starttls[\'\"]/i ) {
341 $tmp =~ s/^\s*[\'\"]starttls[\'\"]\s*=>\s*[\'\"]?//i;
342 $tmp =~ s/[\'\"]?,?\s*$//;
343 $tmp =~ s/[\'\"]?\);\s*$//;
347 $ldap_host[$sub] = $host;
348 $ldap_base[$sub] = $base;
349 $ldap_name[$sub] = $name;
350 $ldap_port[$sub] = $port;
351 $ldap_maxrows[$sub] = $maxrows;
352 $ldap_filter[$sub] = $filter;
353 $ldap_charset[$sub] = $charset;
354 $ldap_binddn[$sub] = $binddn;
355 $ldap_bindpw[$sub] = $bindpw;
356 $ldap_protocol[$sub] = $protocol;
357 $ldap_limit_scope[$sub] = $limit_scope;
358 $ldap_listing[$sub] = $listing;
359 $ldap_writeable[$sub] = $writeable;
360 $ldap_search_tree[$sub] = $search_tree;
361 $ldap_starttls[$sub] = $starttls;
362 } elsif ( $options[0] =~ /^(data_dir|attachment_dir|org_logo|signout_page|icon_theme_def)$/ ) {
363 ${ $options[0] } = &change_to_rel_path
($options[1]);
365 ${ $options[0] } = $options[1];
371 # FIXME: unknown introduction date
372 $useSendmail = 'false' if ( lc($useSendmail) ne 'true' );
373 $sendmail_path = "/usr/sbin/sendmail" if ( !$sendmail_path );
374 $pop_before_smtp = 'false' if ( !$pop_before_smtp );
375 $default_unseen_notify = 2 if ( !$default_unseen_notify );
376 $default_unseen_type = 1 if ( !$default_unseen_type );
377 $config_use_color = 0 if ( !$config_use_color );
378 $invert_time = 'false' if ( !$invert_time );
379 $force_username_lowercase = 'false' if ( !$force_username_lowercase );
380 $optional_delimiter = "detect" if ( !$optional_delimiter );
381 $auto_create_special = 'false' if ( !$auto_create_special );
382 $default_use_priority = 'true' if ( !$default_use_priority );
383 $default_use_mdn = 'true' if ( !$default_use_mdn );
384 $delete_folder = 'false' if ( !$delete_folder );
385 $noselect_fix_enable = 'false' if ( !$noselect_fix_enable );
386 $frame_top = "_top" if ( !$frame_top );
387 $provider_uri = '' if ( !$provider_uri );
388 $provider_name = '' if ( !$provider_name );
389 $no_list_for_subscribe = 'false' if ( !$no_list_for_subscribe );
390 $allow_charset_search = 'true' if ( !$allow_charset_search );
391 $allow_advanced_search = 0 if ( !$allow_advanced_search) ;
392 $prefs_user_field = 'user' if ( !$prefs_user_field );
393 $prefs_key_field = 'prefkey' if ( !$prefs_key_field );
394 $prefs_val_field = 'prefval' if ( !$prefs_val_field );
395 $session_name = 'SQMSESSID' if ( !$session_name );
396 $skip_SM_header = 'false' if ( !$skip_SM_header );
397 $default_use_javascript_addr_book = 'false' if (! $default_use_javascript_addr_book);
400 $hide_sm_attributions = 'false' if ( !$hide_sm_attributions );
402 $edit_identity = 'true' if ( !$edit_identity );
403 $edit_name = 'true' if ( !$edit_name );
406 $use_smtp_tls= 'false' if ( !$use_smtp_tls);
407 $smtp_auth_mech = 'none' if ( !$smtp_auth_mech );
408 $use_imap_tls = 'false' if ( !$use_imap_tls );
409 $imap_auth_mech = 'login' if ( !$imap_auth_mech );
412 $show_alternative_names = 'false' if ( !$show_alternative_names );
413 # $available_languages option available only in 1.5.0. removed due to $languages
414 # implementation changes. options are provided by limit_languages plugin
415 # $available_languages = 'all' if ( !$available_languages );
416 $aggressive_decoding = 'false' if ( !$aggressive_decoding );
417 # available only in 1.5.0 and 1.5.1
418 # $advanced_tree = 'false' if ( !$advanced_tree );
419 $use_php_recode = 'false' if ( !$use_php_recode );
420 $use_php_iconv = 'false' if ( !$use_php_iconv );
423 $use_icons = 'false' if ( !$use_icons );
424 $use_iframe = 'false' if ( !$use_iframe );
425 $lossy_encoding = 'false' if ( !$lossy_encoding );
426 $allow_remote_configtest = 'false' if ( !$allow_remote_configtest );
427 $addrbook_global_table = 'global_abook' if ( !$addrbook_global_table );
428 $addrbook_global_writeable = 'false' if ( !$addrbook_global_writeable );
429 $addrbook_global_listing = 'false' if ( !$addrbook_global_listing );
430 $abook_global_file = '' if ( !$abook_global_file);
431 $abook_global_file_writeable = 'false' if ( !$abook_global_file_writeable);
432 $abook_global_file_listing = 'true' if ( !$abook_global_file_listing );
433 $encode_header_key = '' if ( !$encode_header_key );
434 $hide_auth_header = 'false' if ( !$hide_auth_header );
435 $time_zone_type = '0' if ( !$time_zone_type );
436 $prefs_user_size = 128 if ( !$prefs_user_size );
437 $prefs_key_size = 64 if ( !$prefs_key_size );
438 $prefs_val_size = 65536 if ( !$prefs_val_size );
440 # add qmail-inject test here for backwards compatibility
441 if ( !$sendmail_args && $sendmail_path =~ /qmail-inject/ ) {
443 } elsif ( !$sendmail_args ) {
444 $sendmail_args = '-i -t';
447 $default_fontsize = '' if ( !$default_fontsize);
448 $default_fontset = '' if ( !$default_fontset);
450 %fontsets = ('serif', 'serif',
451 'sans', 'helvetica,arial,sans-serif',
452 'comicsans', 'comic sans ms,sans-serif',
453 'tahoma', 'tahoma,sans-serif',
454 'verasans', 'bitstream vera sans,verdana,sans-serif');
457 # $use_imap_tls and $use_smtp_tls are switched to integer since 1.5.1
458 $use_imap_tls = 0 if ( $use_imap_tls eq 'false');
459 $use_imap_tls = 1 if ( $use_imap_tls eq 'true');
460 $use_smtp_tls = 0 if ( $use_smtp_tls eq 'false');
461 $use_smtp_tls = 1 if ( $use_smtp_tls eq 'true');
462 # sorting options changed names and reversed values in 1.5.1
463 $disable_thread_sort = 'false' if ( !$disable_thread_sort );
464 $disable_server_sort = 'false' if ( !$disable_server_sort );
467 $abook_file_line_length = 2048 if ( !$abook_file_line_length );
468 $config_location_base = '' if ( !$config_location_base );
469 $smtp_sitewide_user = '' if ( !$smtp_sitewide_user );
470 $smtp_sitewide_pass = '' if ( !$smtp_sitewide_pass );
471 $icon_theme_def = '' if ( !$icon_theme_def );
472 $disable_plugins = 'false' if ( !$disable_plugins );
473 $disable_plugins_user = '' if ( !$disable_plugins_user );
475 if ( $ARGV[0] eq '--install-plugin' ) {
476 print "Activating plugin " . $ARGV[1] . "\n";
477 push @plugins, $ARGV[1];
480 } elsif ( $ARGV[0] eq '--remove-plugin' ) {
481 print "Removing plugin " . $ARGV[1] . "\n";
482 foreach $plugin (@plugins) {
483 if ( $plugin ne $ARGV[1] ) {
484 push @newplugins, $plugin;
487 @plugins = @newplugins;
490 } elsif ( $ARGV[0] eq '--update-plugins' or $ARGV[0] eq '-u') {
491 build_plugin_hook_array
();
493 } elsif ( $ARGV[0] eq '--help' or $ARGV[0] eq '-h') {
494 print "SquirrelMail Configuration Script\n";
496 print " * No arguments: initiates the configuration dialog\n";
497 print " * --install-plugin <plugin> : activates the specified plugin\n";
498 print " * --remove-plugin <plugin> : deactivates the specified plugin\n";
499 print " * --update-plugins , -u : rebuilds plugin_hooks.php according\n";
500 print " to plugins activated in config.php\n";
501 print " * --help , -h : Displays this help\n";
506 #####################################################################################
507 if ( $config_use_color == 1 ) {
513 $config_use_color = 2;
516 while ( ( $command ne "q" ) && ( $command ne "Q" ) && ( $command ne ":q" ) ) {
518 print $WHT. "SquirrelMail Configuration : " . $NRM;
519 if ( $config == 1 ) { print "Read: config.php"; }
520 elsif ( $config == 2 ) { print "Read: config_default.php"; }
521 print " ($print_config_version)\n";
522 print "---------------------------------------------------------\n";
525 print $WHT. "Main Menu --\n" . $NRM;
526 print "1. Organization Preferences\n";
527 print "2. Server Settings\n";
528 print "3. Folder Defaults\n";
529 print "4. General Options\n";
530 print "5. User Interface\n";
531 print "6. Address Books\n";
532 print "7. Message of the Day (MOTD)\n";
533 print "8. Plugins\n";
534 print "9. Database\n";
535 print "10. Language settings\n";
536 print "11. Tweaks\n";
538 print "D. Set pre-defined settings for specific IMAP servers\n";
540 } elsif ( $menu == 1 ) {
541 print $WHT. "Organization Preferences\n" . $NRM;
542 print "1. Organization Name : $WHT$org_name$NRM\n";
543 print "2. Organization Logo : $WHT$org_logo$NRM\n";
544 print "3. Org. Logo Width/Height : $WHT($org_logo_width/$org_logo_height)$NRM\n";
545 print "4. Organization Title : $WHT$org_title$NRM\n";
546 print "5. Signout Page : $WHT$signout_page$NRM\n";
547 print "6. Top Frame : $WHT$frame_top$NRM\n";
548 print "7. Provider link : $WHT$provider_uri$NRM\n";
549 print "8. Provider name : $WHT$provider_name$NRM\n";
552 print "R Return to Main Menu\n";
553 } elsif ( $menu == 2 ) {
554 print $WHT. "Server Settings\n\n" . $NRM;
555 print $WHT . "General" . $NRM . "\n";
557 print "1. Domain : $WHT$domain$NRM\n";
558 print "2. Invert Time : $WHT$invert_time$NRM\n";
559 print "3. Sendmail or SMTP : $WHT";
560 if ( lc($useSendmail) eq 'true' ) {
568 if ( $show_imap_settings ) {
569 print $WHT . "IMAP Settings". $NRM . "\n--------------\n";
570 print "4. IMAP Server : $WHT$imapServerAddress$NRM\n";
571 print "5. IMAP Port : $WHT$imapPort$NRM\n";
572 print "6. Authentication type : $WHT$imap_auth_mech$NRM\n";
573 print "7. Secure IMAP (TLS) : $WHT" . display_use_tls
($use_imap_tls) . "$NRM\n";
574 print "8. Server software : $WHT$imap_server_type$NRM\n";
575 print "9. Delimiter : $WHT$optional_delimiter$NRM\n";
577 } elsif ( $show_smtp_settings ) {
578 if ( lc($useSendmail) eq 'true' ) {
579 print $WHT . "Sendmail" . $NRM . "\n--------\n";
580 print "4. Sendmail Path : $WHT$sendmail_path$NRM\n";
581 print "5. Sendmail arguments : $WHT$sendmail_args$NRM\n";
582 print "6. Header encryption key : $WHT$encode_header_key$NRM\n";
585 print $WHT . "SMTP Settings" . $NRM . "\n-------------\n";
586 print "4. SMTP Server : $WHT$smtpServerAddress$NRM\n";
587 print "5. SMTP Port : $WHT$smtpPort$NRM\n";
588 print "6. POP before SMTP : $WHT$pop_before_smtp$NRM\n";
589 print "7. SMTP Authentication : $WHT$smtp_auth_mech" . display_smtp_sitewide_userpass
() ."$NRM\n";
590 print "8. Secure SMTP (TLS) : $WHT" . display_use_tls
($use_smtp_tls) . "$NRM\n";
591 print "9. Header encryption key : $WHT$encode_header_key$NRM\n";
596 if ($show_imap_settings == 0) {
597 print "A. Update IMAP Settings : ";
598 print "$WHT$imapServerAddress$NRM:";
599 print "$WHT$imapPort$NRM ";
600 print "($WHT$imap_server_type$NRM)\n";
602 if ($show_smtp_settings == 0) {
603 if ( lc($useSendmail) eq 'true' ) {
604 print "B. Change Sendmail Config : $WHT$sendmail_path$NRM\n";
606 print "B. Update SMTP Settings : ";
607 print "$WHT$smtpServerAddress$NRM:";
608 print "$WHT$smtpPort$NRM\n";
611 if ( $show_smtp_settings || $show_imap_settings )
614 ($show_imap_settings ?
"IMAP Server" :
615 (lc($useSendmail) eq 'true') ?
"Sendmail" : "SMTP") . " Settings\n";
619 print "R Return to Main Menu\n";
620 } elsif ( $menu == 3 ) {
621 print $WHT. "Folder Defaults\n" . $NRM;
622 print "1. Default Folder Prefix : $WHT$default_folder_prefix$NRM\n";
623 print "2. Show Folder Prefix Option : $WHT$show_prefix_option$NRM\n";
624 print "3. Trash Folder : $WHT$trash_folder$NRM\n";
625 print "4. Sent Folder : $WHT$sent_folder$NRM\n";
626 print "5. Drafts Folder : $WHT$draft_folder$NRM\n";
627 print "6. By default, move to trash : $WHT$default_move_to_trash$NRM\n";
628 print "7. By default, move to sent : $WHT$default_move_to_sent$NRM\n";
629 print "8. By default, save as draft : $WHT$default_save_as_draft$NRM\n";
630 print "9. List Special Folders First : $WHT$list_special_folders_first$NRM\n";
631 print "10. Show Special Folders Color : $WHT$use_special_folder_color$NRM\n";
632 print "11. Auto Expunge : $WHT$auto_expunge$NRM\n";
633 print "12. Default Sub. of INBOX : $WHT$default_sub_of_inbox$NRM\n";
634 print "13. Show 'Contain Sub.' Option : $WHT$show_contain_subfolders_option$NRM\n";
635 print "14. Default Unseen Notify : $WHT$default_unseen_notify$NRM\n";
636 print "15. Default Unseen Type : $WHT$default_unseen_type$NRM\n";
637 print "16. Auto Create Special Folders : $WHT$auto_create_special$NRM\n";
638 print "17. Folder Delete Bypasses Trash : $WHT$delete_folder$NRM\n";
639 print "18. Enable /NoSelect folder fix : $WHT$noselect_fix_enable$NRM\n";
641 print "R Return to Main Menu\n";
642 } elsif ( $menu == 4 ) {
643 print $WHT. "General Options\n" . $NRM;
644 print "1. Data Directory : $WHT$data_dir$NRM\n";
645 print "2. Attachment Directory : $WHT$attachment_dir$NRM\n";
646 print "3. Directory Hash Level : $WHT$dir_hash_level$NRM\n";
647 print "4. Default Left Size : $WHT$default_left_size$NRM\n";
648 print "5. Usernames in Lowercase : $WHT$force_username_lowercase$NRM\n";
649 print "6. Allow use of priority : $WHT$default_use_priority$NRM\n";
650 print "7. Hide SM attributions : $WHT$hide_sm_attributions$NRM\n";
651 print "8. Allow use of receipts : $WHT$default_use_mdn$NRM\n";
652 print "9. Allow editing of identity : $WHT$edit_identity$NRM\n";
653 print " Allow editing of name : $WHT$edit_name$NRM\n";
654 print " Remove username from header : $WHT$hide_auth_header$NRM\n";
655 print "10. Disable server thread sort : $WHT$disable_thread_sort$NRM\n";
656 print "11. Disable server-side sorting : $WHT$disable_server_sort$NRM\n";
657 print "12. Allow server charset search : $WHT$allow_charset_search$NRM\n";
658 print "13. Allow advanced search : $WHT$allow_advanced_search$NRM\n";
659 print "14. PHP session name : $WHT$session_name$NRM\n";
660 print "15. Time zone configuration : $WHT$time_zone_type$NRM\n";
661 print "16. Location base : $WHT$config_location_base$NRM\n";
663 print "R Return to Main Menu\n";
664 } elsif ( $menu == 5 ) {
665 print $WHT. "User Interface\n" . $NRM;
666 print "1. Use Icons? : $WHT$use_icons$NRM\n";
667 # print "3. Default Icon Set : $WHT$icon_theme_def$NRM\n";
668 print "2. Default font size : $WHT$default_fontsize$NRM\n";
669 print "3. Manage template sets\n";
670 print "4. Manage user themes\n";
671 print "5. Manage font sets\n";
672 print "6. Manage icon themes\n";
675 print "R Return to Main Menu\n";
676 } elsif ( $menu == 6 ) {
677 print $WHT. "Address Books\n" . $NRM;
678 print "1. Change LDAP Servers\n";
679 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
680 print " > $ldap_host[$count]\n";
682 print "2. Use Javascript address book search : $WHT$default_use_javascript_addr_book$NRM\n";
683 print "3. Global address book file : $WHT$abook_global_file$NRM\n";
684 print "4. Allow writing into global file address book : $WHT$abook_global_file_writeable$NRM\n";
685 print "5. Allow listing of global file address book : $WHT$abook_global_file_listing$NRM\n";
686 print "6. Allowed address book line length : $WHT$abook_file_line_length$NRM\n";
688 print "R Return to Main Menu\n";
689 } elsif ( $menu == 7 ) {
690 print $WHT. "Message of the Day (MOTD)\n" . $NRM;
693 print "1 Edit the MOTD\n";
695 print "R Return to Main Menu\n";
696 } elsif ( $menu == 8 ) {
697 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
698 print $WHT. "Plugins (WARNING: All plugins are currently disabled\n for the user \"$disable_plugins_user\"!)\n" . $NRM;
699 } elsif (lc($disable_plugins) eq 'true') {
700 print $WHT. "Plugins (WARNING: All plugins are currently disabled!)\n" . $NRM;
702 print $WHT. "Plugins\n" . $NRM;
704 print " Installed Plugins\n";
706 for ( $count = 0 ; $count <= $#plugins ; $count++ ) {
708 print " $num. $plugins[$count]\n";
710 print "\n Available Plugins:\n";
711 opendir( DIR
, "../plugins" );
712 @files = readdir(DIR
);
714 @unused_plugins = ();
715 for ( $i = 0 ; $i <= $#files ; $i++ ) {
716 if ( -d
"../plugins/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne "CVS" ) {
718 for ( $k = 0 ; $k <= $#plugins ; $k++ ) {
719 if ( $plugins[$k] eq $files[$i] ) {
724 $unused_plugins[$pos] = $files[$i];
730 for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
732 print " $num. $unused_plugins[$i]\n";
737 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
738 print "E Enable active plugins (all plugins currently\n disabled for the user \"$disable_plugins_user\")\n";
739 } elsif (lc($disable_plugins) eq 'true') {
740 print "E Enable active plugins (all plugins currently\n disabled)\n";
742 print "D Disable all plugins\n";
744 print "U Set the user for whom plugins can be disabled\n";
745 print "R Return to Main Menu\n";
746 } elsif ( $menu == 9 ) {
747 print $WHT. "Database\n" . $NRM;
748 print "1. DSN for Address Book : $WHT$addrbook_dsn$NRM\n";
749 print "2. Table for Address Book : $WHT$addrbook_table$NRM\n";
751 print "3. DSN for Preferences : $WHT$prefs_dsn$NRM\n";
752 print "4. Table for Preferences : $WHT$prefs_table$NRM\n";
753 print "5. Field for username : $WHT$prefs_user_field$NRM ($prefs_user_size)\n";
754 print "6. Field for prefs key : $WHT$prefs_key_field$NRM ($prefs_key_size)\n";
755 print "7. Field for prefs value : $WHT$prefs_val_field$NRM ($prefs_val_size)\n";
757 print "8. DSN for Global Address Book : $WHT$addrbook_global_dsn$NRM\n";
758 print "9. Table for Global Address Book : $WHT$addrbook_global_table$NRM\n";
759 print "10. Allow writing into Global Address Book : $WHT$addrbook_global_writeable$NRM\n";
760 print "11. Allow listing of Global Address Book : $WHT$addrbook_global_listing$NRM\n";
762 print "R Return to Main Menu\n";
763 } elsif ( $menu == 10 ) {
764 print $WHT. "Language settings\n" . $NRM;
765 print "1. Default Language : $WHT$squirrelmail_default_language$NRM\n";
766 print "2. Default Charset : $WHT$default_charset$NRM\n";
767 print "3. Show alternative language names : $WHT$show_alternative_names$NRM\n";
768 print "4. Enable aggressive decoding : $WHT$aggressive_decoding$NRM\n";
769 print "5. Enable lossy encoding : $WHT$lossy_encoding$NRM\n";
771 print "R Return to Main Menu\n";
772 } elsif ( $menu == 11 ) {
773 print $WHT. "Interface tweaks\n" . $NRM;
774 print "1. Display html mails in iframe : $WHT$use_iframe$NRM\n";
776 print $WHT. "PHP tweaks\n" . $NRM;
777 print "4. Use php recode functions : $WHT$use_php_recode$NRM\n";
778 print "5. Use php iconv functions : $WHT$use_php_iconv$NRM\n";
780 print $WHT. "Configuration tweaks\n" . $NRM;
781 print "6. Allow remote configtest : $WHT$allow_remote_configtest$NRM\n";
783 print "R Return to Main Menu\n";
785 if ( $config_use_color == 1 ) {
786 print "C Turn color off\n";
788 print "C Turn color on\n";
790 print "S Save data\n";
794 print "Command >> " . $WHT;
796 $command =~ s/[\n\r]//g;
797 $command =~ tr/A-Z/a-z/;
800 # Read the commands they entered.
801 if ( $command eq "r" ) {
803 } elsif ( $command eq "s" ) {
805 print "Press enter to continue...";
808 } elsif ( ( $command eq "q" ) && ( $saved == 0 ) ) {
809 print "You have not saved your data.\n";
810 print "Save? [" . $WHT . "Y" . $NRM . "/n]: ";
812 if ( ( $save =~ /^y/i ) || ( $save =~ /^\s*$/ ) ) {
815 } elsif ( $command eq "c" ) {
816 if ( $config_use_color == 1 ) {
817 $config_use_color = 2;
821 $config_use_color = 1;
825 } elsif ( $command eq "d" && $menu == 0 ) {
830 if ( ( $command > 0 ) && ( $command < 12 ) ) {
833 } elsif ( $menu == 1 ) {
834 if ( $command == 1 ) { $org_name = command1
(); }
835 elsif ( $command == 2 ) { $org_logo = command2
(); }
836 elsif ( $command == 3 ) { ($org_logo_width,$org_logo_height) = command2a
(); }
837 elsif ( $command == 4 ) { $org_title = command3
(); }
838 elsif ( $command == 5 ) { $signout_page = command4
(); }
839 elsif ( $command == 6 ) { $frame_top = command6
(); }
840 elsif ( $command == 7 ) { $provider_uri = command7
(); }
841 elsif ( $command == 8 ) { $provider_name = command8
(); }
843 } elsif ( $menu == 2 ) {
844 if ( $command eq "a" ) { $show_imap_settings = 1; $show_smtp_settings = 0; }
845 elsif ( $command eq "b" ) { $show_imap_settings = 0; $show_smtp_settings = 1; }
846 elsif ( $command eq "h" ) { $show_imap_settings = 0; $show_smtp_settings = 0; }
847 elsif ( $command <= 3 ) {
848 if ( $command == 1 ) { $domain = command11
(); }
849 elsif ( $command == 2 ) { $invert_time = command110
(); }
850 elsif ( $command == 3 ) { $useSendmail = command14
(); }
851 $show_imap_settings = 0; $show_smtp_settings = 0;
852 } elsif ( $show_imap_settings ) {
853 if ( $command == 4 ) { $imapServerAddress = command12
(); }
854 elsif ( $command == 5 ) { $imapPort = command13
(); }
855 elsif ( $command == 6 ) { $imap_auth_mech = command112a
(); }
856 elsif ( $command == 7 ) { $use_imap_tls = command_use_tls
("IMAP",$use_imap_tls); }
857 elsif ( $command == 8 ) { $imap_server_type = command19
(); }
858 elsif ( $command == 9 ) { $optional_delimiter = command111
(); }
859 } elsif ( $show_smtp_settings && lc($useSendmail) eq 'true' ) {
860 if ( $command == 4 ) { $sendmail_path = command15
(); }
861 elsif ( $command == 5 ) { $sendmail_args = command_sendmail_args
(); }
862 elsif ( $command == 6 ) { $encode_header_key = command114
(); }
863 } elsif ( $show_smtp_settings ) {
864 if ( $command == 4 ) { $smtpServerAddress = command16
(); }
865 elsif ( $command == 5 ) { $smtpPort = command17
(); }
866 elsif ( $command == 6 ) { $pop_before_smtp = command18a
(); }
867 elsif ( $command == 7 ) { $smtp_auth_mech = command112b
(); }
868 elsif ( $command == 8 ) { $use_smtp_tls = command_use_tls
("SMTP",$use_smtp_tls); }
869 elsif ( $command == 9 ) { $encode_header_key = command114
(); }
871 } elsif ( $menu == 3 ) {
872 if ( $command == 1 ) { $default_folder_prefix = command21
(); }
873 elsif ( $command == 2 ) { $show_prefix_option = command22
(); }
874 elsif ( $command == 3 ) { $trash_folder = command23a
(); }
875 elsif ( $command == 4 ) { $sent_folder = command23b
(); }
876 elsif ( $command == 5 ) { $draft_folder = command23c
(); }
877 elsif ( $command == 6 ) { $default_move_to_trash = command24a
(); }
878 elsif ( $command == 7 ) { $default_move_to_sent = command24b
(); }
879 elsif ( $command == 8 ) { $default_save_as_draft = command24c
(); }
880 elsif ( $command == 9 ) { $list_special_folders_first = command27
(); }
881 elsif ( $command == 10 ) { $use_special_folder_color = command28
(); }
882 elsif ( $command == 11 ) { $auto_expunge = command29
(); }
883 elsif ( $command == 12 ) { $default_sub_of_inbox = command210
(); }
884 elsif ( $command == 13 ) { $show_contain_subfolders_option = command211
(); }
885 elsif ( $command == 14 ) { $default_unseen_notify = command212
(); }
886 elsif ( $command == 15 ) { $default_unseen_type = command213
(); }
887 elsif ( $command == 16 ) { $auto_create_special = command214
(); }
888 elsif ( $command == 17 ) { $delete_folder = command215
(); }
889 elsif ( $command == 18 ) { $noselect_fix_enable = command216
(); }
890 } elsif ( $menu == 4 ) {
891 if ( $command == 1 ) { $data_dir = command33a
(); }
892 elsif ( $command == 2 ) { $attachment_dir = command33b
(); }
893 elsif ( $command == 3 ) { $dir_hash_level = command33c
(); }
894 elsif ( $command == 4 ) { $default_left_size = command35
(); }
895 elsif ( $command == 5 ) { $force_username_lowercase = command36
(); }
896 elsif ( $command == 6 ) { $default_use_priority = command37
(); }
897 elsif ( $command == 7 ) { $hide_sm_attributions = command38
(); }
898 elsif ( $command == 8 ) { $default_use_mdn = command39
(); }
899 elsif ( $command == 9 ) { $edit_identity = command310
(); }
900 elsif ( $command == 10 ) { $disable_thread_sort = command312
(); }
901 elsif ( $command == 11 ) { $disable_server_sort = command313
(); }
902 elsif ( $command == 12 ) { $allow_charset_search = command314
(); }
903 elsif ( $command == 13 ) { $allow_advanced_search = command316
(); }
904 elsif ( $command == 14 ) { $session_name = command317
(); }
905 elsif ( $command == 15 ) { $time_zone_type = command318
(); }
906 elsif ( $command == 16 ) { $config_location_base = command_config_location_base
(); }
907 } elsif ( $menu == 5 ) {
908 if ( $command == 1 ) { $use_icons = commandB3
(); }
909 # elsif ( $command == 3 ) { $icon_theme_def = commandB7(); }
910 elsif ( $command == 2 ) { $default_fontsize = command_default_fontsize
(); }
911 elsif ( $command == 3 ) { $templateset_default = command_templates
(); }
912 elsif ( $command == 4 ) { command_userThemes
(); }
913 elsif ( $command == 5 ) { command_fontsets
(); }
914 elsif ( $command == 6 ) { command_iconSets
(); }
915 } elsif ( $menu == 6 ) {
916 if ( $command == 1 ) { command61
(); }
917 elsif ( $command == 2 ) { command62
(); }
918 elsif ( $command == 3 ) { $abook_global_file=command63
(); }
919 elsif ( $command == 4 ) { command64
(); }
920 elsif ( $command == 5 ) { command65
(); }
921 elsif ( $command == 6 ) { command_abook_file_line_length
(); }
922 } elsif ( $menu == 7 ) {
923 if ( $command == 1 ) { $motd = command71
(); }
924 } elsif ( $menu == 8 ) {
925 if ( $command =~ /^[0-9]+/ ) { @plugins = command81
(); }
926 elsif ( $command eq "u" ) { $disable_plugins_user = command82
(); }
927 elsif ( $command eq "d" ) { $disable_plugins = 'true'; }
928 elsif ( $command eq "e" ) { $disable_plugins = 'false'; }
929 } elsif ( $menu == 9 ) {
930 if ( $command == 1 ) { $addrbook_dsn = command91
(); }
931 elsif ( $command == 2 ) { $addrbook_table = command92
(); }
932 elsif ( $command == 3 ) { $prefs_dsn = command93
(); }
933 elsif ( $command == 4 ) { $prefs_table = command94
(); }
934 elsif ( $command == 5 ) { $prefs_user_field = command95
(); }
935 elsif ( $command == 6 ) { $prefs_key_field = command96
(); }
936 elsif ( $command == 7 ) { $prefs_val_field = command97
(); }
937 elsif ( $command == 8 ) { $addrbook_global_dsn = command98
(); }
938 elsif ( $command == 9 ) { $addrbook_global_table = command99
(); }
939 elsif ( $command == 10 ) { $addrbook_global_writeable = command910
(); }
940 elsif ( $command == 11 ) { $addrbook_global_listing = command911
(); }
941 } elsif ( $menu == 10 ) {
942 if ( $command == 1 ) { $squirrelmail_default_language = commandA1
(); }
943 elsif ( $command == 2 ) { $default_charset = commandA2
(); }
944 elsif ( $command == 3 ) { $show_alternative_names = commandA3
(); }
945 elsif ( $command == 4 ) { $aggressive_decoding = commandA4
(); }
946 elsif ( $command == 5 ) { $lossy_encoding = commandA5
(); }
947 } elsif ( $menu == 11 ) {
948 if ( $command == 1 ) { $use_iframe = commandB2
(); }
949 elsif ( $command == 4 ) { $use_php_recode = commandB4
(); }
950 elsif ( $command == 5 ) { $use_php_iconv = commandB5
(); }
951 elsif ( $command == 6 ) { $allow_remote_configtest = commandB6
(); }
957 print "\nExiting conf.pl.\n".
958 "You might want to test your configuration by browsing to\n".
959 "http://your-squirrelmail-location/src/configtest.php\n".
960 "Happy SquirrelMailing!\n\n";
963 ####################################################################################
967 print "We have tried to make the name SquirrelMail as transparent as\n";
968 print "possible. If you set up an organization name, most places where\n";
969 print "SquirrelMail would take credit will be credited to your organization.\n";
971 print "If your Organization Name includes a '\$', please precede it with a \\. \n";
972 print "Other '\$' will be considered the beginning of a variable that\n";
973 print "must be defined before the \$org_name is printed.\n";
975 print "[$WHT$org_name$NRM]: $WHT";
976 $new_org_name = <STDIN
>;
977 if ( $new_org_name eq "\n" ) {
978 $new_org_name = $org_name;
980 $new_org_name =~ s/[\r\n]//g;
981 $new_org_name =~ s/\"/"/g;
983 return $new_org_name;
988 print "Your organization's logo is an image that will be displayed at\n";
989 print "different times throughout SquirrelMail. ";
991 print "Please be aware of the following: \n";
992 print " - Relative URLs are relative to the config dir\n";
993 print " to use the default logo, use ../images/sm_logo.png\n";
994 print " - To specify a logo defined outside the SquirrelMail source tree\n";
995 print " use the absolute URL the webserver would use to include the file\n";
996 print " e.g. http://www.example.com/images/mylogo.gif or /images/mylogo.jpg\n";
998 print "[$WHT$org_logo$NRM]: $WHT";
999 $new_org_logo = <STDIN
>;
1000 if ( $new_org_logo eq "\n" ) {
1001 $new_org_logo = $org_logo;
1003 $new_org_logo =~ s/[\r\n]//g;
1005 return $new_org_logo;
1010 print "Your organization's logo is an image that will be displayed at\n";
1011 print "different times throughout SquirrelMail. Width\n";
1012 print "and Height of your logo image. Use '0' to disable.\n";
1014 print "Width: [$WHT$org_logo_width$NRM]: $WHT";
1015 $new_org_logo_width = <STDIN
>;
1016 $new_org_logo_width =~ tr/0-9//cd; # only want digits!
1017 if ( $new_org_logo_width eq '' ) {
1018 $new_org_logo_width = $org_logo_width;
1020 if ( $new_org_logo_width > 0 ) {
1021 print "Height: [$WHT$org_logo_height$NRM]: $WHT";
1022 $new_org_logo_height = <STDIN
>;
1023 $new_org_logo_height =~ tr/0-9//cd; # only want digits!
1024 if( $new_org_logo_height eq '' ) {
1025 $new_org_logo_height = $org_logo_height;
1028 $new_org_logo_height = 0;
1030 return ($new_org_logo_width, $new_org_logo_height);
1035 print "A title is what is displayed at the top of the browser window in\n";
1036 print "the titlebar. Usually this will end up looking something like:\n";
1037 print "\"Netscape: $org_title\"\n";
1039 print "If your Organization Title includes a '\$', please precede it with a \\. \n";
1040 print "Other '\$' will be considered the beginning of a variable that\n";
1041 print "must be defined before the \$org_title is printed.\n";
1043 print "[$WHT$org_title$NRM]: $WHT";
1044 $new_org_title = <STDIN
>;
1045 if ( $new_org_title eq "\n" ) {
1046 $new_org_title = $org_title;
1048 $new_org_title =~ s/[\r\n]//g;
1049 $new_org_title =~ s/\"/\'/g;
1051 return $new_org_title;
1056 print "When users click the Sign Out button they will be logged out and\n";
1057 print "then sent to signout_page. If signout_page is left empty,\n";
1058 print "(hit space and then return) they will be taken, as normal,\n";
1059 print "to the default and rather sparse SquirrelMail signout page.\n";
1061 print "[$WHT$signout_page$NRM]: $WHT";
1062 $new_signout_page = <STDIN
>;
1063 if ( $new_signout_page eq "\n" ) {
1064 $new_signout_page = $signout_page;
1066 $new_signout_page =~ s/[\r\n]//g;
1067 $new_signout_page =~ s/^\s+$//g;
1069 return $new_signout_page;
1074 print "SquirrelMail defaults to using the whole of the browser window.\n";
1075 print "This allows you to keep it within a specified frame. The default\n";
1076 print "is '_top'\n";
1078 print "[$WHT$frame_top$NRM]: $WHT";
1079 $new_frame_top = <STDIN
>;
1080 if ( $new_frame_top eq "\n" ) {
1081 $new_frame_top = '_top';
1083 $new_frame_top =~ s/[\r\n]//g;
1084 $new_frame_top =~ s/^\s+$//g;
1086 return $new_frame_top;
1089 # Default link to provider
1091 print "Here you can set the link on the right of the page.\n";
1092 print "If empty, it will link to the SquirrelMail About page.\n";
1094 print "[$WHT$provider_uri$NRM]: $WHT";
1095 $new_provider_uri = <STDIN
>;
1096 if ( $new_provider_uri eq "\n" ) {
1097 $new_provider_uri = '';
1099 $new_provider_uri =~ s/[\r\n]//g;
1100 $new_provider_uri =~ s/^\s+$//g;
1102 return $new_provider_uri;
1106 print "Here you can set the name of the link on the right of the page.\n";
1107 print "The default is 'SquirrelMail'\n";
1109 print "[$WHT$provider_name$NRM]: $WHT";
1110 $new_provider_name = <STDIN
>;
1111 if ( $new_provider_name eq "\n" ) {
1112 $new_provider_name = 'SquirrelMail';
1114 $new_provider_name =~ s/[\r\n]//g;
1115 $new_provider_name =~ s/^\s+$//g;
1116 $new_provider_name =~ s/\'/\\'/g;
1118 return $new_provider_name;
1121 ####################################################################################
1125 print "The domain name is the suffix at the end of all email addresses. If\n";
1126 print "for example, your email address is jdoe\@example.com, then your domain\n";
1127 print "would be example.com.\n";
1129 print "[$WHT$domain$NRM]: $WHT";
1130 $new_domain = <STDIN
>;
1131 if ( $new_domain eq "\n" ) {
1132 $new_domain = $domain;
1134 $new_domain =~ s/[\r\n]//g;
1141 print "This is the hostname where your IMAP server can be contacted.\n";
1142 print "[$WHT$imapServerAddress$NRM]: $WHT";
1143 $new_imapServerAddress = <STDIN
>;
1144 if ( $new_imapServerAddress eq "\n" ) {
1145 $new_imapServerAddress = $imapServerAddress;
1147 $new_imapServerAddress =~ s/[\r\n]//g;
1149 return $new_imapServerAddress;
1154 print "This is the port that your IMAP server is on. Usually this is 143.\n";
1155 print "[$WHT$imapPort$NRM]: $WHT";
1156 $new_imapPort = <STDIN
>;
1157 if ( $new_imapPort eq "\n" ) {
1158 $new_imapPort = $imapPort;
1160 $new_imapPort =~ s/[\r\n]//g;
1162 return $new_imapPort;
1167 print "You now need to choose the method that you will use for sending\n";
1168 print "messages in SquirrelMail. You can either connect to an SMTP server\n";
1169 print "or use sendmail directly.\n";
1170 if ( lc($useSendmail) eq 'true' ) {
1171 $default_value = "1";
1173 $default_value = "2";
1176 print " 1. Sendmail\n";
1178 print "Your choice [1/2] [$WHT$default_value$NRM]: $WHT";
1179 $use_sendmail = <STDIN
>;
1180 if ( ( $use_sendmail =~ /^1\n/i )
1181 || ( ( $use_sendmail =~ /^\n/ ) && ( $default_value eq "1" ) ) ) {
1182 $useSendmail = 'true';
1184 $useSendmail = 'false';
1186 return $useSendmail;
1191 print "Specify where the sendmail executable is located. Usually /usr/sbin/sendmail\n";
1192 print "[$WHT$sendmail_path$NRM]: $WHT";
1193 $new_sendmail_path = <STDIN
>;
1194 if ( $new_sendmail_path eq "\n" ) {
1195 $new_sendmail_path = $sendmail_path;
1197 $new_sendmail_path =~ s/[\r\n]//g;
1199 return $new_sendmail_path;
1202 # Extra sendmail arguments
1203 sub command_sendmail_args
{
1204 print "Specify additional sendmail program arguments.\n";
1206 print "Make sure that arguments are supported by your sendmail program. -f argument \n";
1207 print "is added automatically by SquirrelMail scripts. Variable defaults to standard\n";
1208 print "/usr/sbin/sendmail arguments. If you use qmail-inject, nbsmtp or any other \n";
1209 print "sendmail wrapper, which does not support -i and -t arguments, set variable to\n";
1210 print "empty string or use arguments suitable for your mailer.\n";
1212 print "[$WHT$sendmail_args$NRM]: $WHT";
1213 $new_sendmail_args = <STDIN
>;
1214 if ( $new_sendmail_args eq "\n" ) {
1215 $new_sendmail_args = $sendmail_args;
1217 # strip linefeeds and crs.
1218 $new_sendmail_args =~ s/[\r\n]//g;
1220 return trim
($new_sendmail_args);
1225 print "This is the hostname of your SMTP server.\n";
1226 print "[$WHT$smtpServerAddress$NRM]: $WHT";
1227 $new_smtpServerAddress = <STDIN
>;
1228 if ( $new_smtpServerAddress eq "\n" ) {
1229 $new_smtpServerAddress = $smtpServerAddress;
1231 $new_smtpServerAddress =~ s/[\r\n]//g;
1233 return $new_smtpServerAddress;
1238 print "This is the port to connect to for SMTP. Usually 25.\n";
1239 print "[$WHT$smtpPort$NRM]: $WHT";
1240 $new_smtpPort = <STDIN
>;
1241 if ( $new_smtpPort eq "\n" ) {
1242 $new_smtpPort = $smtpPort;
1244 $new_smtpPort =~ s/[\r\n]//g;
1246 return $new_smtpPort;
1251 print "Do you wish to use POP3 before SMTP? Your server must\n";
1252 print "support this in order for SquirrelMail to work with it.\n";
1255 $YesNo = 'y' if ( lc($pop_before_smtp) eq 'true' );
1257 print "Use pop before SMTP (y/n) [$WHT$YesNo$NRM]: $WHT";
1259 $new_pop_before_smtp = <STDIN
>;
1260 $new_pop_before_smtp =~ tr/yn//cd;
1261 return 'true' if ( $new_pop_before_smtp eq "y" );
1262 return 'false' if ( $new_pop_before_smtp eq "n" );
1263 return $pop_before_smtp;
1268 print "Each IMAP server has its own quirks. As much as we tried to stick\n";
1269 print "to standards, it doesn't help much if the IMAP server doesn't follow\n";
1270 print "the same principles. We have made some work-arounds for some of\n";
1271 print "these servers. If you would like to use them, please select your\n";
1272 print "IMAP server. If you do not wish to use these work-arounds, you can\n";
1273 print "set this to \"other\", and none will be used.\n";
1274 print " courier = Courier IMAP server\n";
1275 print " cyrus = Cyrus IMAP server\n";
1276 print " dovecot = Dovecot Secure IMAP server\n";
1277 print " exchange = Microsoft Exchange IMAP server\n";
1278 print " hmailserver = hMailServer\n";
1279 print " macosx = Mac OS X Mailserver\n";
1280 print " mercury32 = Mercury Mail Transport System\n";
1281 print " uw = University of Washington's IMAP server\n";
1283 print " other = Not one of the above servers\n";
1285 print "[$WHT$imap_server_type$NRM]: $WHT";
1286 $new_imap_server_type = <STDIN
>;
1288 if ( $new_imap_server_type eq "\n" ) {
1289 $new_imap_server_type = $imap_server_type;
1291 $new_imap_server_type =~ s/[\r\n]//g;
1293 return $new_imap_server_type;
1298 print "Sometimes the date of messages sent is messed up (off by a few hours\n";
1299 print "on some machines). Typically this happens if the system doesn't support\n";
1300 print "tm_gmtoff. It will happen only if your time zone is \"negative\".\n";
1301 print "This most often occurs on Solaris 7 machines in the United States.\n";
1302 print "By default, this is off. It should be kept off unless problems surface\n";
1303 print "about the time that messages are sent.\n";
1304 print " no = Do NOT fix time -- almost always correct\n";
1305 print " yes = Fix the time for this system\n";
1308 $YesNo = 'y' if ( lc($invert_time) eq 'true' );
1310 print "Fix the time for this system (y/n) [$WHT$YesNo$NRM]: $WHT";
1312 $new_invert_time = <STDIN
>;
1313 $new_invert_time =~ tr/yn//cd;
1314 return 'true' if ( $new_invert_time eq "y" );
1315 return 'false' if ( $new_invert_time eq "n" );
1316 return $invert_time;
1320 print "This is the delimiter that your IMAP server uses to distinguish between\n";
1321 print "folders. For example, Cyrus uses '.' as the delimiter and a complete\n";
1322 print "folder would look like 'INBOX.Friends.Bob', while UW uses '/' and would\n";
1323 print "look like 'INBOX/Friends/Bob'. Normally this should be left at 'detect'\n";
1324 print "but if you are sure you know what delimiter your server uses, you can\n";
1325 print "specify it here.\n";
1326 print "\nTo have it autodetect the delimiter, set it to 'detect'.\n\n";
1327 print "[$WHT$optional_delimiter$NRM]: $WHT";
1328 $new_optional_delimiter = <STDIN
>;
1330 if ( $new_optional_delimiter eq "\n" ) {
1331 $new_optional_delimiter = $optional_delimiter;
1333 $new_optional_delimiter =~ s/[\r\n]//g;
1335 return $new_optional_delimiter;
1337 # IMAP authentication type
1338 # Possible values: login, plain, cram-md5, digest-md5
1339 # Now offers to detect supported mechs, assuming server & port are set correctly
1342 if ($use_imap_tls ne "0") {
1343 # 1. Script does not handle TLS.
1344 # 2. Server does not have to declare all supported authentication mechs when
1345 # STARTTLS is used. Supported mechs are declared only after STARTTLS.
1346 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1348 print "If you have already set the hostname and port number, I can try to\n";
1349 print "detect the mechanisms your IMAP server supports.\n";
1350 print "I will try to detect CRAM-MD5 and DIGEST-MD5 support. I can't test\n";
1351 print "for \"login\" or \"plain\" without knowing a username and password.\n";
1352 print "Auto-detecting is optional - you can safely say \"n\" here.\n";
1353 print "\nTry to detect supported mechanisms? [y/N]: ";
1356 if ($inval =~ /^y\b/i) {
1357 # Yes, let's try to detect.
1358 print "Trying to detect IMAP capabilities...\n";
1359 my $host = $imapServerAddress . ':'. $imapPort;
1360 print "CRAM-MD5:\t";
1361 my $tmp = detect_auth_support
('IMAP',$host,'CRAM-MD5');
1362 if (defined($tmp)) {
1363 if ($tmp eq 'YES') {
1364 print "$WHT SUPPORTED$NRM\n";
1366 print "$WHT NOT SUPPORTED$NRM\n";
1369 print $WHT . " ERROR DETECTING$NRM\n";
1372 print "DIGEST-MD5:\t";
1373 $tmp = detect_auth_support
('IMAP',$host,'DIGEST-MD5');
1374 if (defined($tmp)) {
1375 if ($tmp eq 'YES') {
1376 print "$WHT SUPPORTED$NRM\n";
1378 print "$WHT NOT SUPPORTED$NRM\n";
1381 print $WHT . " ERROR DETECTING$NRM\n";
1386 print "\nWhat authentication mechanism do you want to use for IMAP connections?\n\n";
1387 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1388 print $WHT . "plain" . $NRM . " - SASL PLAIN. If you need this, you already know it.\n";
1389 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext methods.\n";
1390 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1391 print "\n*** YOUR IMAP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n";
1392 print "If you don't understand or are unsure, you probably want \"login\"\n\n";
1393 print "login, plain, cram-md5, or digest-md5 [$WHT$imap_auth_mech$NRM]: $WHT";
1396 if ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) || ($inval =~ /^login\b/i) || ($inval =~ /^plain\b/i)) {
1399 # user entered garbage or default value so nothing needs to be set
1400 return $imap_auth_mech;
1405 # SMTP authentication type
1406 # Possible choices: none, plain, cram-md5, digest-md5
1408 if ($use_smtp_tls ne "0") {
1409 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1410 } elsif (eval ("use IO::Socket; 1")) {
1411 # try loading IO::Socket module
1412 print "If you have already set the hostname and port number, I can try to\n";
1413 print "automatically detect some of the mechanisms your SMTP server supports.\n";
1414 print "Auto-detection is *optional* - you can safely say \"n\" here.\n";
1415 print "\nTry to detect auth mechanisms? [y/N]: ";
1418 if ($inval =~ /^y\b/i) {
1419 # Yes, let's try to detect.
1420 print "Trying to detect supported methods (SMTP)...\n";
1423 # Check none by trying to relay to junk@microsoft.com
1424 $host = $smtpServerAddress . ':' . $smtpPort;
1425 my $sock = IO
::Socket
::INET
->new($host);
1426 print "Testing none:\t\t$WHT";
1427 if (!defined($sock)) {
1428 print " ERROR TESTING\n";
1431 print $sock "HELO $domain\r\n";
1432 $got = <$sock>; # Discard
1433 print $sock "MAIL FROM:<tester\@squirrelmail.org>\r\n";
1434 $got = <$sock>; # Discard
1435 print $sock "RCPT TO:<junk\@microsoft.com\r\n";
1436 $got = <$sock>; # This is the important line
1437 if ($got =~ /^250\b/) { # SMTP will relay without auth
1438 print "SUPPORTED$NRM\n";
1440 print "NOT SUPPORTED$NRM\n";
1442 print $sock "RSET\r\n";
1443 print $sock "QUIT\r\n";
1446 # Try login (SquirrelMail default)
1447 print "Testing login:\t\t";
1448 $tmp=detect_auth_support
('SMTP',$host,'LOGIN');
1449 if (defined($tmp)) {
1450 if ($tmp eq 'YES') {
1451 print $WHT . "SUPPORTED$NRM\n";
1453 print $WHT . "NOT SUPPORTED$NRM\n";
1456 print $WHT . "ERROR DETECTING$NRM\n";
1460 print "Testing CRAM-MD5:\t";
1461 $tmp=detect_auth_support
('SMTP',$host,'CRAM-MD5');
1462 if (defined($tmp)) {
1463 if ($tmp eq 'YES') {
1464 print $WHT . "SUPPORTED$NRM\n";
1466 print $WHT . "NOT SUPPORTED$NRM\n";
1469 print $WHT . "ERROR DETECTING$NRM\n";
1473 print "Testing DIGEST-MD5:\t";
1474 $tmp=detect_auth_support
('SMTP',$host,'DIGEST-MD5');
1475 if (defined($tmp)) {
1476 if ($tmp eq 'YES') {
1477 print $WHT . "SUPPORTED$NRM\n";
1479 print $WHT . "NOT SUPPORTED$NRM\n";
1482 print $WHT . "ERROR DETECTING$NRM\n";
1486 print "\nWhat authentication mechanism do you want to use for SMTP connections?\n";
1487 print $WHT . "none" . $NRM . " - Your SMTP server does not require authorization.\n";
1488 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1489 print $WHT . "plain" . $NRM . " - SASL PLAIN. You already know it if you need this.\n";
1490 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext.\n";
1491 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1492 print $WHT . "\n*** YOUR SMTP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n" . $NRM;
1493 print "If you don't understand or are unsure, you probably want \"none\"\n\n";
1494 print "none, login, cram-md5, or digest-md5 [$WHT$smtp_auth_mech$NRM]: $WHT";
1497 if ($inval =~ /^none\b/i) {
1498 # remove sitewide smtp authentication information
1499 $smtp_sitewide_user = '';
1500 $smtp_sitewide_pass = '';
1501 # SMTP doesn't necessarily require logins
1503 } elsif ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) ||
1504 ($inval =~ /^login\b/i) || ($inval =~/^plain\b/i)) {
1505 command_smtp_sitewide_userpass
($inval);
1507 } elsif (trim
($inval) eq '') {
1508 # user selected default value
1509 command_smtp_sitewide_userpass
($smtp_auth_mech);
1510 return $smtp_auth_mech;
1512 # user entered garbage
1513 return $smtp_auth_mech;
1517 sub command_smtp_sitewide_userpass
($) {
1518 # get first function argument
1519 my $auth_mech = shift(@_);
1521 $auth_mech = lc(trim
($auth_mech));
1522 if ($auth_mech eq 'none') {
1525 print "SMTP authentication uses IMAP username and password by default.\n";
1527 print "Would you like to use other login and password for all SquirrelMail \n";
1528 print "SMTP connections?";
1529 if ($smtp_sitewide_user ne '') {
1546 $smtp_sitewide_user = '';
1547 $smtp_sitewide_pass = '';
1548 } elsif ($tmp eq 'y') {
1549 print "Enter username [$smtp_sitewide_user]:";
1550 my $new_user = <STDIN
>;
1551 $new_user = trim
($new_user);
1552 if ($new_user ne '') {
1553 $smtp_sitewide_user = $new_user;
1555 if ($smtp_sitewide_user ne '') {
1556 print "If you don't enter any password, current sitewide password will be used.\n";
1557 print "If you enter space, password will be set to empty string.\n";
1558 print "Enter password:";
1559 my $new_pass = <STDIN
>;
1560 if ($new_pass ne "\n") {
1561 $smtp_sitewide_pass = trim
($new_pass);
1564 print "Invalid input. You must set username used for SMTP authentication.\n";
1565 print "Click enter to continue\n";
1569 print "Invalid input\n";
1570 print "Click enter to continue\n";
1575 # Sub adds information about SMTP authentication type to menu
1576 sub display_smtp_sitewide_userpass
() {
1578 if ($smtp_auth_mech ne 'none') {
1579 if ($smtp_sitewide_user ne '') {
1580 $ret = ' (with custom username and password)';
1582 $ret = ' (with IMAP username and password)';
1589 # This sub is reused for IMAP and SMTP
1590 # Args: service name, default value
1591 sub command_use_tls
{
1592 my($default_val,$service,$inval);
1595 print "TLS (Transport Layer Security) encrypts the traffic between server and client.\n";
1596 print "STARTTLS extensions allow to start encryption on existing plain text connection.\n";
1597 print "These options add specific PHP and IMAP server configuration requirements.\n";
1598 print "See SquirrelMail documentation about connection security.\n";
1600 print "If your " . $service . " server is localhost, you can safely disable this.\n";
1601 print "If it is remote, you may wish to seriously consider enabling this.\n";
1603 while ($valid_input eq 0) {
1604 print "\nSelect connection security model:\n";
1605 print " 0 - Use plain text connection\n";
1606 print " 1 - Use TLS connection\n";
1607 print " 2 - Use STARTTLS extension\n";
1608 print "Select [$default_val]: ";
1610 $inval=trim
($inval);
1611 if ($inval =~ /^[012]$/ || $inval eq '') {
1615 if ($inval ne '') {$default_val = $inval};
1616 return $default_val;
1619 # This sub is used to display human readable text for
1620 # $use_imap_tls and $use_smtp_tls values in conf.pl menu
1621 sub display_use_tls
($) {
1622 my $val = shift(@_);
1623 my $ret = 'disabled';
1626 } elsif ($val eq '1') {
1632 # $encode_header_key
1634 print "Encryption key allows to hide SquirrelMail Received: headers\n";
1635 print "in outbound messages. Interface uses encryption key to encode\n";
1636 print "username, remote address and proxied address, then stores encoded\n";
1637 print "information in X-Squirrel-* headers.\n";
1639 print "Warning: used encryption function is not bulletproof. When used\n";
1640 print "with static encryption keys, it provides only minimal security\n";
1641 print "measures and information can be decoded quickly.\n";
1643 print "Encoded information can be decoded with decrypt_headers.php script\n";
1644 print "from SquirrelMail contrib/ directory.\n";
1646 print "Enter encryption key: ";
1647 $new_encode_header_key = <STDIN
>;
1648 if ( $new_encode_header_key eq "\n" ) {
1649 $new_encode_header_key = $encode_header_key;
1651 $new_encode_header_key =~ s/[\r\n]//g;
1653 return $new_encode_header_key;
1658 print "\nYou can now create the welcome message that is displayed\n";
1659 print "every time a user logs on. You can use HTML or just plain\n";
1661 "text. If you do not wish to have one, just make it blank.\n\n(Type @ on a blank line to exit)\n";
1667 $line =~ s/[\r\n]//g;
1668 if ( $line ne "@" ) {
1669 $line =~ s/ /\ \ /g;
1670 $line =~ s/\t/\ \ \ \ /g;
1672 $line =~ s/\"/\\\"/g;
1674 $new_motd = $new_motd . $line;
1676 } while ( $line ne "@" );
1680 ################# PLUGINS ###################
1683 $command =~ s/[\s\n\r]*//g;
1684 if ( $command > 0 ) {
1685 $command = $command - 1;
1686 if ( $command <= $#plugins ) {
1689 while ( $ct <= $#plugins ) {
1690 if ( $ct != $command ) {
1691 @newplugins = ( @newplugins, $plugins[$ct] );
1695 @plugins = @newplugins;
1696 } elsif ( $command <= $#plugins + $#unused_plugins + 1 ) {
1697 $num = $command - $#plugins - 1;
1698 @newplugins = @plugins;
1700 while ( $ct <= $#unused_plugins ) {
1701 if ( $ct == $num ) {
1702 @newplugins = ( @newplugins, $unused_plugins[$ct] );
1706 @plugins = @newplugins;
1712 # disable_plugins_user
1714 print "When all active plugins are disabled, they can be disabled only\n";
1715 print "for the one user named here. If left blank, plugins will be\n";
1716 print "disabled for ALL users. This setting has no effect if plugins\n";
1717 print "are not disabled.\n";
1719 print "This must be the exact IMAP login name for the desired user.\n";
1721 print "[$WHT$disable_plugins_user$NRM]: $WHT";
1722 $new_disable_plugins_user = <STDIN
>;
1723 if ( $new_disable_plugins_user eq "\n" ) {
1724 $new_disable_plugins_user = $disable_plugins_user;
1726 $new_disable_plugins_user =~ s/[\r\n]//g;
1728 return $new_disable_plugins_user;
1731 ################# FOLDERS ###################
1733 # default_folder_prefix
1735 print "Some IMAP servers (UW, for example) store mail and folders in\n";
1736 print "your user space in a separate subdirectory. This is where you\n";
1737 print "specify what that directory is.\n";
1739 print "EXAMPLE: mail/";
1741 print "NOTE: If you use Cyrus, or some server that would not use this\n";
1742 print " option, you must set this to 'none'.\n";
1744 print "[$WHT$default_folder_prefix$NRM]: $WHT";
1745 $new_default_folder_prefix = <STDIN
>;
1747 if ( $new_default_folder_prefix eq "\n" ) {
1748 $new_default_folder_prefix = $default_folder_prefix;
1750 $new_default_folder_prefix =~ s/[\r\n]//g;
1752 if ( ( $new_default_folder_prefix =~ /^\s*$/ ) || ( $new_default_folder_prefix =~ m/^none$/i ) ) {
1753 $new_default_folder_prefix = "";
1755 # add the trailing delimiter only if we know what the server is.
1756 if (($imap_server_type eq 'cyrus' and
1757 $optional_delimiter eq 'detect') or
1758 ($imap_server_type eq 'courier' and
1759 $optional_delimiter eq 'detect')) {
1760 $new_default_folder_prefix =~ s/\.*$/\./;
1761 } elsif ($imap_server_type eq 'uw' and
1762 $optional_delimiter eq 'detect') {
1763 $new_default_folder_prefix =~ s/\/*$/\
//;
1766 return $new_default_folder_prefix;
1769 # Show Folder Prefix
1771 print "It is possible to set up the default folder prefix as a user\n";
1772 print "specific option, where each user can specify what their mail\n";
1773 print "folder is. If you set this to false, they will never see the\n";
1774 print "option, but if it is true, this option will appear in the\n";
1775 print "'options' section.\n";
1777 print "NOTE: You set the default folder prefix in option '1' of this\n";
1778 print " section. That will be the default if the user doesn't\n";
1779 print " specify anything different.\n";
1782 if ( lc($show_prefix_option) eq 'true' ) {
1783 $default_value = "y";
1785 $default_value = "n";
1788 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
1789 $new_show = <STDIN
>;
1790 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1791 $show_prefix_option = 'true';
1793 $show_prefix_option = 'false';
1795 return $show_prefix_option;
1800 print "You can now specify where the default trash folder is located.\n";
1801 print "On servers where you do not want this, you can set it to anything\n";
1802 print "and set option 6 to false.\n";
1804 print "This is relative to where the rest of your email is kept. You do\n";
1805 print "not need to worry about their mail directory. If this folder\n";
1806 print "would be ~/mail/trash on the filesystem, you only need to specify\n";
1807 print "that this is 'trash', and be sure to put 'mail/' in option 1.\n";
1810 print "[$WHT$trash_folder$NRM]: $WHT";
1811 $new_trash_folder = <STDIN
>;
1812 if ( $new_trash_folder eq "\n" ) {
1813 $new_trash_folder = $trash_folder;
1815 if (check_imap_folder
($new_trash_folder)) {
1816 $new_trash_folder =~ s/[\r\n]//g;
1818 $new_trash_folder = $trash_folder;
1821 return $new_trash_folder;
1826 print "This is where messages that are sent will be stored. SquirrelMail\n";
1827 print "by default puts a copy of all outgoing messages in this folder.\n";
1829 print "This is relative to where the rest of your email is kept. You do\n";
1830 print "not need to worry about their mail directory. If this folder\n";
1831 print "would be ~/mail/sent on the filesystem, you only need to specify\n";
1832 print "that this is 'sent', and be sure to put 'mail/' in option 1.\n";
1835 print "[$WHT$sent_folder$NRM]: $WHT";
1836 $new_sent_folder = <STDIN
>;
1837 if ( $new_sent_folder eq "\n" ) {
1838 $new_sent_folder = $sent_folder;
1840 if (check_imap_folder
($new_sent_folder)) {
1841 $new_sent_folder =~ s/[\r\n]//g;
1843 $new_sent_folder = $sent_folder;
1846 return $new_sent_folder;
1851 print "You can now specify where the default draft folder is located.\n";
1852 print "On servers where you do not want this, you can set it to anything\n";
1853 print "and set option 9 to false.\n";
1855 print "This is relative to where the rest of your email is kept. You do\n";
1856 print "not need to worry about their mail directory. If this folder\n";
1857 print "would be ~/mail/drafts on the filesystem, you only need to specify\n";
1858 print "that this is 'drafts', and be sure to put 'mail/' in option 1.\n";
1861 print "[$WHT$draft_folder$NRM]: $WHT";
1862 $new_draft_folder = <STDIN
>;
1863 if ( $new_draft_folder eq "\n" ) {
1864 $new_draft_folder = $draft_folder;
1866 if (check_imap_folder
($new_draft_folder)) {
1867 $new_draft_folder =~ s/[\r\n]//g;
1869 $new_draft_folder = $draft_folder;
1872 return $new_draft_folder;
1875 # default move to trash
1877 print "By default, should messages get moved to the trash folder? You\n";
1878 print "can specify the default trash folder in option 3. If this is set\n";
1879 print "to false, messages will get deleted immediately without moving\n";
1880 print "to the trash folder.\n";
1882 print "Trash folder is currently: $trash_folder\n";
1885 if ( lc($default_move_to_trash) eq 'true' ) {
1886 $default_value = "y";
1888 $default_value = "n";
1890 print "By default, move to trash (y/n) [$WHT$default_value$NRM]: $WHT";
1891 $new_show = <STDIN
>;
1892 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1893 $default_move_to_trash = 'true';
1895 $default_move_to_trash = 'false';
1897 return $default_move_to_trash;
1900 # default move to sent
1902 print "By default, should messages get moved to the sent folder? You\n";
1903 print "can specify the default sent folder in option 4. If this is set\n";
1904 print "to false, messages will get sent and no copy will be made.\n";
1906 print "Sent folder is currently: $sent_folder\n";
1909 if ( lc($default_move_to_sent) eq 'true' ) {
1910 $default_value = "y";
1912 $default_value = "n";
1914 print "By default, move to sent (y/n) [$WHT$default_value$NRM]: $WHT";
1915 $new_show = <STDIN
>;
1916 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1917 $default_move_to_sent = 'true';
1919 $default_move_to_sent = 'false';
1921 return $default_move_to_sent;
1924 # default save as draft
1926 print "By default, should the save to draft option be shown? You can\n";
1927 print "specify the default drafts folder in option 5. If this is set\n";
1928 print "to false, users will not be shown the save to draft option.\n";
1930 print "Drafts folder is currently: $draft_folder\n";
1933 if ( lc($default_move_to_draft) eq 'true' ) {
1934 $default_value = "y";
1936 $default_value = "n";
1938 print "By default, save as draft (y/n) [$WHT$default_value$NRM]: $WHT";
1939 $new_show = <STDIN
>;
1940 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1941 $default_save_as_draft = 'true';
1943 $default_save_as_draft = 'false';
1945 return $default_save_as_draft;
1948 # List special folders first
1950 print "SquirrelMail has what we call 'special folders' that are not\n";
1951 print "manipulated and viewed like normal folders. Some examples of\n";
1952 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
1953 print "Simply asks if you want these folders listed first in the folder\n";
1957 if ( lc($list_special_folders_first) eq 'true' ) {
1958 $default_value = "y";
1960 $default_value = "n";
1963 print "List first (y/n) [$WHT$default_value$NRM]: $WHT";
1964 $new_show = <STDIN
>;
1965 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1966 $list_special_folders_first = 'true';
1968 $list_special_folders_first = 'false';
1970 return $list_special_folders_first;
1973 # Show special folders color
1975 print "SquirrelMail has what we call 'special folders' that are not\n";
1976 print "manipulated and viewed like normal folders. Some examples of\n";
1977 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
1978 print "wants to know if we should display special folders in a\n";
1979 print "color than the other folders.\n";
1982 if ( lc($use_special_folder_color) eq 'true' ) {
1983 $default_value = "y";
1985 $default_value = "n";
1988 print "Show color (y/n) [$WHT$default_value$NRM]: $WHT";
1989 $new_show = <STDIN
>;
1990 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1991 $use_special_folder_color = 'true';
1993 $use_special_folder_color = 'false';
1995 return $use_special_folder_color;
2000 print "The way that IMAP handles deleting messages is as follows. You\n";
2001 print "mark the message as deleted, and then to 'really' delete it, you\n";
2002 print "expunge it. This option asks if you want to just have messages\n";
2003 print "marked as deleted, or if you want SquirrelMail to expunge the \n";
2004 print "messages too.\n";
2007 if ( lc($auto_expunge) eq 'true' ) {
2008 $default_value = "y";
2010 $default_value = "n";
2012 print "Auto expunge (y/n) [$WHT$default_value$NRM]: $WHT";
2013 $new_show = <STDIN
>;
2014 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2015 $auto_expunge = 'true';
2017 $auto_expunge = 'false';
2019 return $auto_expunge;
2022 # Default sub of inbox
2024 print "Some IMAP servers (Cyrus) have all folders as subfolders of INBOX.\n";
2025 print "This can cause some confusion in folder creation for users when\n";
2026 print "they try to create folders and don't put it as a subfolder of INBOX\n";
2027 print "and get permission errors. This option asks if you want folders\n";
2028 print "to be subfolders of INBOX by default.\n";
2031 if ( lc($default_sub_of_inbox) eq 'true' ) {
2032 $default_value = "y";
2034 $default_value = "n";
2036 print "Default sub of INBOX (y/n) [$WHT$default_value$NRM]: $WHT";
2037 $new_show = <STDIN
>;
2038 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2039 $default_sub_of_inbox = 'true';
2041 $default_sub_of_inbox = 'false';
2043 return $default_sub_of_inbox;
2046 # Show contain subfolder option
2048 print "Some IMAP servers (UW) make it so that there are two types of\n";
2049 print "folders. Those that contain messages, and those that contain\n";
2050 print "subfolders. If this is the case for your server, set this to\n";
2051 print "true, and it will ask the user whether the folder they are\n";
2052 print "creating contains subfolders or messages.\n";
2055 if ( lc($show_contain_subfolders_option) eq 'true' ) {
2056 $default_value = "y";
2058 $default_value = "n";
2060 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
2061 $new_show = <STDIN
>;
2062 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2063 $show_contain_subfolders_option = 'true';
2065 $show_contain_subfolders_option = 'false';
2067 return $show_contain_subfolders_option;
2070 # Default Unseen Notify
2072 print "This option specifies where the users will receive notification\n";
2073 print "about unseen messages by default. This is of course an option that\n";
2074 print "can be changed on a user level.\n";
2075 print " 1 = No notification\n";
2076 print " 2 = Only on the INBOX\n";
2077 print " 3 = On all folders\n";
2080 print "Which one should be default (1,2,3)? [$WHT$default_unseen_notify$NRM]: $WHT";
2081 $new_show = <STDIN
>;
2082 if ( $new_show =~ /^[123]\n/i ) {
2083 $default_unseen_notify = $new_show;
2085 $default_unseen_notify =~ s/[\r\n]//g;
2086 return $default_unseen_notify;
2089 # Default Unseen Type
2091 print "Here you can define the default way that unseen messages will be displayed\n";
2092 print "to the user in the folder listing on the left side.\n";
2093 print " 1 = Only unseen messages (4)\n";
2094 print " 2 = Unseen and Total messages (4/27)\n";
2097 print "Which one should be default (1,2)? [$WHT$default_unseen_type$NRM]: $WHT";
2098 $new_show = <STDIN
>;
2099 if ( $new_show =~ /^[12]\n/i ) {
2100 $default_unseen_type = $new_show;
2102 $default_unseen_type =~ s/[\r\n]//g;
2103 return $default_unseen_type;
2106 # Auto create special folders
2108 print "Would you like the Sent, Trash, and Drafts folders to be created\n";
2109 print "automatically print for you when a user logs in? If the user\n";
2110 print "accidentally deletes their special folders, this option will\n";
2111 print "automatically create it again for them.\n";
2114 if ( lc($auto_create_special) eq 'true' ) {
2115 $default_value = "y";
2117 $default_value = "n";
2119 print "Auto create special folders? (y/n) [$WHT$default_value$NRM]: $WHT";
2120 $new_show = <STDIN
>;
2121 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2122 $auto_create_special = 'true';
2124 $auto_create_special = 'false';
2126 return $auto_create_special;
2129 # Automatically delete folders
2131 if ( $imap_server_type eq "uw" ) {
2132 print "UW IMAP servers will not allow folders containing mail to also contain folders.\n";
2133 print "Deleting folders will bypass the trash folder and be immediately deleted\n\n";
2134 print "If this is not the correct value for your server,\n";
2135 print "please use option D on the Main Menu to configure your server correctly.\n\n";
2136 print "Press enter to continue...\n";
2137 $new_delete = <STDIN
>;
2138 $delete_folder = 'true';
2140 if ( $imap_server_type eq "courier" ) {
2141 print "Courier (or Courier-IMAP) IMAP servers may not support ";
2142 print "subfolders of Trash. \n";
2143 print "Specifically, if Courier is set to always move messages to Trash, \n";
2144 print "Trash will be treated by Courier as a special folder that does not \n";
2145 print "allow subfolders. \n\n";
2146 print "Please verify your Courier configuration, and test folder deletion \n";
2147 print "when changing this setting.\n\n";
2150 print "Are subfolders of the Trash supported by your IMAP server?\n";
2151 print "If so, should deleted folders be sent to Trash?\n";
2152 print "If not, say no (deleted folders should not be sent to Trash)\n\n";
2153 # reversal of logic.
2154 # question was: Should folders be automatically deleted instead of sent to trash..
2155 # we've changed the question to make it more clear,
2156 # and are here handling that to avoid changing the answers..
2157 if ( lc($delete_folder) eq 'true' ) {
2158 $default_value = "n";
2160 $default_value = "y";
2162 print "Send deleted folders to Trash? (y/n) [$WHT$default_value$NRM]: $WHT";
2163 $new_delete = <STDIN
>;
2164 if ( ( $new_delete =~ /^y\n/i ) || ( ( $new_delete =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2165 $delete_folder = 'false';
2167 $delete_folder = 'true';
2170 return $delete_folder;
2175 print "Some IMAP server allow subfolders to exist even if the parent\n";
2176 print "folders do not. This fixes some problems with the folder list\n";
2177 print "when this is the case, causing the /NoSelect folders to be displayed\n";
2180 if ( lc($noselect_fix_enable) eq 'true' ) {
2181 $default_value = "y";
2183 $default_value = "n";
2185 print "enable noselect fix? (y/n) [$WHT$noselect_fix_enable$NRM]: $WHT";
2186 $noselect_fix_enable = <STDIN
>;
2187 if ( ( $noselect_fix_enable =~ /^y\n/i ) || ( ( $noselect_fix_enable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2188 $noselect_fix_enable = 'true';
2190 $noselect_fix_enable = 'false';
2192 return $noselect_fix_enable;
2194 ############# GENERAL OPTIONS #####################
2198 print "Specify the location for your data directory.\n";
2199 print "You need to create this directory yourself.\n";
2200 print "The path name can be absolute or relative (to the config directory).\n";
2201 print "Here are two examples:\n";
2202 print " Absolute: /var/local/squirrelmail/data/\n";
2203 print " Relative: ../data/\n";
2204 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2205 print "will be converted to their absolute path equivalents in config.php.\n\n";
2206 print "Note: There are potential security risks with having a writeable directory\n";
2207 print "under the web server's root directory (ex: /home/httpd/html).\n";
2208 print "For this reason, it is recommended to put the data directory\n";
2209 print "in an alternate location of your choice. \n";
2212 print "[$WHT$data_dir$NRM]: $WHT";
2213 $new_data_dir = <STDIN
>;
2214 if ( $new_data_dir eq "\n" ) {
2215 $new_data_dir = $data_dir;
2217 $new_data_dir =~ s/[\r\n]//g;
2219 if ( $new_data_dir =~ /^\s*$/ ) {
2222 $new_data_dir =~ s/\/*$//g
;
2223 $new_data_dir =~ s/$/\//g
;
2225 return $new_data_dir;
2228 # Attachment directory
2230 print "Path to directory used for storing attachments while a mail is\n";
2231 print "being composed. The path name can be absolute or relative (to the\n";
2232 print "config directory). Here are two examples:\n";
2233 print " Absolute: /var/local/squirrelmail/attach/\n";
2234 print " Relative: ../attach/\n";
2235 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2236 print "will be converted to their absolute path equivalents in config.php.\n\n";
2237 print "Note: There are a few security considerations regarding this\n";
2238 print "directory:\n";
2239 print " 1. It should have the permission 733 (rwx-wx-wx) to make it\n";
2240 print " impossible for a random person with access to the webserver\n";
2241 print " to list files in this directory. Confidential data might\n";
2242 print " be laying around in there.\n";
2243 print " Depending on your user:group assignments, 730 (rwx-wx---)\n";
2244 print " may be possible, and more secure (e.g. root:apache)\n";
2245 print " 2. Since the webserver is not able to list the files in the\n";
2246 print " content is also impossible for the webserver to delete files\n";
2247 print " lying around there for too long.\n";
2248 print " 3. It should probably be another directory than the data\n";
2249 print " directory specified in option 3.\n";
2252 print "[$WHT$attachment_dir$NRM]: $WHT";
2253 $new_attachment_dir = <STDIN
>;
2254 if ( $new_attachment_dir eq "\n" ) {
2255 $new_attachment_dir = $attachment_dir;
2257 $new_attachment_dir =~ s/[\r\n]//g;
2259 if ( $new_attachment_dir =~ /^\s*$/ ) {
2260 $new_attachment_dir = "";
2262 $new_attachment_dir =~ s/\/*$//g
;
2263 $new_attachment_dir =~ s/$/\//g
;
2265 return $new_attachment_dir;
2269 print "The directory hash level setting allows you to configure the level\n";
2270 print "of hashing that SquirrelMail employs in your data and attachment\n";
2271 print "directories. This value must be an integer ranging from 0 to 4.\n";
2272 print "When this value is set to 0, SquirrelMail will simply store all\n";
2273 print "files as normal in the data and attachment directories. However,\n";
2274 print "when set to a value from 1 to 4, a simple hashing scheme will be\n";
2275 print "used to organize the files in this directory. In short, the crc32\n";
2276 print "value for a username will be computed. Then, up to the first 4\n";
2277 print "digits of the hash, as set by this configuration value, will be\n";
2278 print "used to directory hash the files for that user in the data and\n";
2279 print "attachment directory. This allows for better performance on\n";
2280 print "servers with larger numbers of users.\n";
2283 print "[$WHT$dir_hash_level$NRM]: $WHT";
2284 $new_dir_hash_level = <STDIN
>;
2285 if ( $new_dir_hash_level eq "\n" ) {
2286 $new_dir_hash_level = $dir_hash_level;
2288 $new_dir_hash_level =~ s/[\r\n]//g;
2290 if ( ( int($new_dir_hash_level) < 0 )
2291 || ( int($new_dir_hash_level) > 4 )
2292 || !( int($new_dir_hash_level) eq $new_dir_hash_level ) ) {
2293 print "Invalid Directory Hash Level.\n";
2294 print "Value must be an integer ranging from 0 to 4\n";
2295 print "Hit enter to continue.\n";
2296 $enter_key = <STDIN
>;
2298 $new_dir_hash_level = $dir_hash_level;
2301 return $new_dir_hash_level;
2305 print "This is the default size (in pixels) of the left folder list.\n";
2306 print "Default is 200, but you can set it to whatever you wish. This\n";
2307 print "is a user preference, so this will only show up as their default.\n";
2309 print "[$WHT$default_left_size$NRM]: $WHT";
2310 $new_default_left_size = <STDIN
>;
2311 if ( $new_default_left_size eq "\n" ) {
2312 $new_default_left_size = $default_left_size;
2314 $new_default_left_size =~ s/[\r\n]//g;
2316 return $new_default_left_size;
2320 print "Some IMAP servers only have lowercase letters in the usernames\n";
2321 print "but they still allow people with uppercase to log in. This\n";
2322 print "causes a problem with the user's preference files. This option\n";
2323 print "transparently changes all usernames to lowercase.";
2326 if ( lc($force_username_lowercase) eq 'true' ) {
2327 $default_value = "y";
2329 $default_value = "n";
2331 print "Convert usernames to lowercase (y/n) [$WHT$default_value$NRM]: $WHT";
2332 $new_show = <STDIN
>;
2333 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2343 if ( lc($default_use_priority) eq 'true' ) {
2344 $default_value = "y";
2346 $default_value = "n";
2349 print "Allow users to specify priority of outgoing mail (y/n) [$WHT$default_value$NRM]: $WHT";
2350 $new_show = <STDIN
>;
2351 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2361 if ( lc($default_hide_attribution) eq 'true' ) {
2362 $default_value = "y";
2364 $default_value = "n";
2367 print "Hide SM attributions (y/n) [$WHT$default_value$NRM]: $WHT";
2368 $new_show = <STDIN
>;
2369 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2379 if ( lc($default_use_mdn) eq 'true' ) {
2380 $default_value = "y";
2382 $default_value = "n";
2385 print "Enable support for read/delivery receipt support (y/n) [$WHT$default_value$NRM]: $WHT";
2386 $new_show = <STDIN
>;
2387 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2395 print " In loosely managed environments, you may want to allow users
2396 to edit their full name and email address. In strictly managed
2397 environments, you may want to force users to use the name
2398 and email address assigned to them.
2400 'y' - allow a user to edit their full name and email address,
2401 'n' - users must use the assigned values.
2405 if ( lc($edit_identity) eq 'true' ) {
2406 $default_value = "y";
2408 $default_value = "n";
2410 print "Allow editing of user's identity? (y/n) [$WHT$default_value$NRM]: $WHT";
2411 $new_edit = <STDIN
>;
2412 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2413 $edit_identity = 'true';
2414 $edit_name = 'true';
2415 $hide_auth_header = command311b
();
2417 $edit_identity = 'false';
2418 $edit_name = command311
();
2419 $hide_auth_header = command311b
();
2421 return $edit_identity;
2425 print " Given that users are not allowed to modify their
2426 email address, can they edit their full name?
2430 if ( lc($edit_name) eq 'true' ) {
2431 $default_value = "y";
2433 $default_value = "n";
2435 print "Allow the user to edit their full name? (y/n) [$WHT$default_value$NRM]: $WHT";
2436 $new_edit = <STDIN
>;
2437 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2438 $edit_name = 'true';
2440 $edit_name = 'false';
2446 print " SquirrelMail adds username information to every sent email
2447 in order to prevent possible sender forging when users are allowed
2448 to change their email and/or full name.
2450 You can remove user information from this header (y), if you think that
2451 it violates privacy or security.
2453 Note: If users are allowed to change their email addresses,
2454 this setting will make it difficult to determine who sent what where.
2455 Use at your own risk.
2459 if ( lc($hide_auth_header) eq "true" ) {
2460 $default_value = "y";
2462 $default_value = "n";
2464 print "Remove username from email headers? (y/n) [$WHT$default_value$NRM]: $WHT";
2465 $new_header = <STDIN
>;
2466 if ( ( $new_header =~ /^y\n/i ) || ( ( $new_header =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2467 $hide_auth_header = "true";
2469 $hide_auth_header = "false";
2471 return $hide_auth_header;
2475 print "This option allows you to disable server side thread sorting if your server \n";
2476 print "declares THREAD support, but you don't want to provide threading options \n";
2477 print "to end users or THREAD extension is broken or extension does not work with \n";
2478 print "options used by SquirrelMail. Option is not used, if THREAD extension is \n";
2479 print "not declared in IMAP CAPABILITY.\n";
2482 if ( lc($disable_thread_sort) eq 'true' ) {
2483 $default_value = "y";
2485 $default_value = "n";
2487 print "Disable server side thread sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2488 $disable_thread_sort = <STDIN
>;
2489 if ( ( $disable_thread_sort =~ /^y\n/i ) || ( ( $disable_thread_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2490 $disable_thread_sort = 'true';
2492 $disable_thread_sort = 'false';
2494 return $disable_thread_sort;
2498 print "This option allows you to disable server side sorting if your server declares \n";
2499 print "SORT support, but SORT extension is broken or does not work with options \n";
2500 print "used by SquirrelMail. Option is not used, if SORT extension is not declared \n";
2501 print "in IMAP CAPABILITY.\n";
2503 print "It is strongly recommended to keep server side sorting enabled, if your ";
2504 print "IMAP server supports it.";
2507 if ( lc($disable_server_sort) eq 'true' ) {
2508 $default_value = "y";
2510 $default_value = "n";
2512 print "Disable server-side sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2513 $disable_server_sort = <STDIN
>;
2514 if ( ( $disable_server_sort =~ /^y\n/i ) || ( ( $disable_server_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2515 $disable_server_sort = 'true';
2517 $disable_server_sort = 'false';
2519 return $disable_server_sort;
2523 print "This option allows you to choose if SM uses charset search\n";
2524 print "Your IMAP server must support the SEARCH CHARSET command for this to work\n";
2527 if ( lc($allow_charset_search) eq 'true' ) {
2528 $default_value = "y";
2530 $default_value = "n";
2532 print "Allow charset searching? (y/n) [$WHT$default_value$NRM]: $WHT";
2533 $allow_charset_search = <STDIN
>;
2534 if ( ( $allow_charset_search =~ /^y\n/i ) || ( ( $allow_charset_search =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2535 $allow_charset_search = 'true';
2537 $allow_charset_search = 'false';
2539 return $allow_charset_search;
2542 # command315 (UID support) obsoleted.
2544 # advanced search option
2546 print "This option allows you to control the use of advanced search form.\n";
2547 print " 0 = enable basic search only\n";
2548 print " 1 = enable advanced search only\n";
2549 print " 2 = enable both\n";
2552 print "Allowed search (0,1,2)? [$WHT$allow_advanced_search$NRM]: $WHT";
2553 $new_allow_advanced_search = <STDIN
>;
2554 if ( $new_allow_advanced_search =~ /^[012]\n/i ) {
2555 $allow_advanced_search = $new_allow_advanced_search;
2557 $allow_advanced_search =~ s/[\r\n]//g;
2558 return $allow_advanced_search;
2563 print "This option allows you to change the name of the PHP session used\n";
2564 print "by SquirrelMail. Unless you know what you are doing, you probably\n";
2565 print "don't need or want to change this from the default of SQMSESSID.\n";
2566 print "[$WHT$session_name$NRM]: $WHT";
2567 $new_session_name = <STDIN
>;
2568 chomp($new_session_name);
2569 if ( $new_session_name eq "" ) {
2570 $new_session_name = $session_name;
2572 return $new_session_name;
2575 # time zone config (since 1.5.1)
2577 print "This option allows you to control the use of time zones.\n";
2578 print " 0 = (default) standard, GNU C time zone names\n";
2579 print " 1 = strict, generic time zone codes with offsets\n";
2580 print " 2 = custom, GNU C time zones loaded from config/timezones.php\n";
2581 print " 3 = custom strict, generic time zone codes with offsets loaded \n";
2582 print " from config/timezones.php\n";
2583 print "See SquirrelMail documentation about format of config/timezones.php file.\n";
2586 print "Used time zone configuration (0,1,2,3)? [$WHT$time_zone_type$NRM]: $WHT";
2587 $new_time_zone_type = <STDIN
>;
2588 if ( $new_time_zone_type =~ /^[0123]\n/i ) {
2589 $time_zone_type = $new_time_zone_type;
2591 print "\nInvalid configuration value.\n";
2592 print "\nPress enter to continue...";
2595 $time_zone_type =~ s/[\r\n]//g;
2596 return $time_zone_type;
2599 # set the location base for redirects (since 1.5.2)
2600 sub command_config_location_base
{
2601 print "Here you can set the base part of the SquirrelMail URL.\n";
2602 print "It is normally autodetected but if that fails, use this\n";
2603 print "option to override.\n";
2604 print "It should contain only the protocol and hostname/port parts\n";
2605 print "of the URL; the full path will be appended automatically.\n\n";
2606 print "Examples:\nhttp://webmail.example.org\nhttp://webmail.example.com:8080\nhttps://webmail.example.com:6691\n\n";
2607 print "Do not add any path elements.\n";
2609 print "URL base? [" .$WHT."autodetect$NRM]: $WHT";
2610 $new_config_location_base = <STDIN
>;
2611 chomp($new_config_location_base);
2612 $config_location_base = $new_config_location_base;
2614 return $config_location_base;
2618 sub command_userThemes
{
2619 print "\nDefine the user themes that you wish to use. If you have added\n";
2620 print "a theme of your own, just follow the instructions (?) about\n";
2621 print "how to add them. You can also change the default theme.\n\n";
2623 print "Available user themes:\n";
2625 while ( $count <= $#user_theme_name ) {
2626 if ( $count == $user_theme_default ) {
2631 if ( $count < 10 ) {
2634 $name = $user_theme_name[$count];
2635 $num_spaces = 35 - length($name);
2636 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2637 $name = $name . " ";
2640 print " $count. $name";
2641 print "($user_theme_path[$count])\n";
2647 print ".------------------------------------.\n";
2648 print "| t (detect user themes) |\n";
2649 print "| + (add user theme) |\n";
2650 print "| - N (remove user theme) |\n";
2651 print "| m N (mark default user theme) |\n";
2652 print "| l (list user themes) |\n";
2653 print "| d (done) |\n";
2654 print "`------------------------------------'\n";
2656 print "\n[user_themes] command (?=help) > ";
2658 $input =~ s/[\r\n]//g;
2659 while ( $input ne "d" ) {
2660 if ( $input =~ /^\s*l\s*/i ) {
2662 while ( $count <= $#user_theme_name ) {
2663 if ( $count == $user_theme_default ) {
2668 if ( $count < 10 ) {
2671 $name = $user_theme_name[$count];
2672 $num_spaces = 35 - length($name);
2673 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2674 $name = $name . " ";
2677 print " $count. $name";
2678 print "($user_theme_path[$count])\n";
2682 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2683 $old_def = $user_theme_default;
2684 $user_theme_default = $input;
2685 $user_theme_default =~ s/^\s*m\s*//;
2686 if ( ( $user_theme_default > $#user_theme_name ) || ( $user_theme_default < 0 ) ) {
2687 print "Cannot set default theme to $user_theme_default. That theme does not exist.\n";
2688 $user_theme_default = $old_def;
2690 } elsif ( $input =~ /^\s*\+/ ) {
2691 print "What is the name of this theme? ";
2693 $name =~ s/[\r\n]//g;
2694 $user_theme_name[ $#user_theme_name + 1 ] = $name;
2695 print "Be sure to put ../css/ before the filename.\n";
2696 print "What file is this stored in (ex: ../css/my_theme/): ";
2698 $name =~ s/[\r\n]//g;
2699 $user_theme_path[ $#user_theme_path + 1 ] = $name;
2700 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2701 if ( $input =~ /[0-9]+\s*$/ ) {
2703 $rem_num =~ s/^\s*-\s*//g;
2704 $rem_num =~ s/\s*$//;
2706 $rem_num = $#user_theme_name;
2708 if ( $rem_num == $user_theme_default ) {
2709 print "You cannot remove the default theme!\n";
2712 @new_theme_name = ();
2713 @new_theme_path = ();
2714 while ( $count <= $#user_theme_name ) {
2715 if ( $count != $rem_num ) {
2716 @new_theme_name = ( @new_theme_name, $user_theme_name[$count] );
2717 @new_theme_path = ( @new_theme_path, $user_theme_path[$count] );
2721 @user_theme_name = @new_theme_name;
2722 @user_theme_path = @new_theme_path;
2723 if ( $user_theme_default > $rem_num ) {
2724 $user_theme_default--;
2727 } elsif ( $input =~ /^\s*t\s*/i ) {
2728 print "\nStarting detection...\n\n";
2730 opendir( DIR
, "../css" );
2731 @files = readdir(DIR
);
2733 while ( $cnt <= $#files ) {
2734 $filename = "../css/" . $files[$cnt] .'/';
2735 if ( $filename ne "../css/rtl.css" && -e
$filename . "default.css" ) {
2737 for ( $x = 0 ; $x <= $#user_theme_path ; $x++ ) {
2738 if ( $user_theme_path[$x] eq $filename ) {
2742 if ( $found != 1 ) {
2743 print "** Found user theme: $filename\n";
2744 print " What is its name? ";
2747 $user_theme_name[ $#user_theme_name + 1 ] = $nm;
2748 $user_theme_path[ $#user_theme_path + 1 ] = $filename;
2754 for ( $cnt = 0 ; $cnt <= $#user_theme_path ; $cnt++ ) {
2755 $filename = $user_theme_path[$cnt];
2756 if ( $filename != 'none' && !( -e
$filename ."/default.css" ) ) {
2757 print " Removing $filename (file not found)\n";
2759 @new_user_theme_name = ();
2760 @new_user_theme_path = ();
2761 for ( $x = 0 ; $x < $#user_theme_path ; $x++ ) {
2762 if ( $user_theme_path[$x] eq $filename ) {
2765 if ( $offset == 1 ) {
2766 $new_user_theme_name[$x] = $user_theme_name[ $x + 1 ];
2767 $new_user_theme_path[$x] = $user_theme_path[ $x + 1 ];
2769 $new_user_theme_name[$x] = $user_theme_name[$x];
2770 $new_user_theme_path[$x] = $user_theme_path[$x];
2773 @user_theme_name = @new_user_theme_name;
2774 @user_theme_path = @new_user_theme_path;
2777 print "\nDetection complete!\n\n";
2780 } elsif ( $input =~ /^\s*\?\s*/ ) {
2781 print ".------------------------------------.\n";
2782 print "| t (detect user themes) |\n";
2783 print "| + (add user theme) |\n";
2784 print "| - N (remove user theme) |\n";
2785 print "| m N (mark default user theme) |\n";
2786 print "| l (list user themes) |\n";
2787 print "| d (done) |\n";
2788 print "`------------------------------------'\n";
2790 print "[user_themes] command (?=help) > ";
2792 $input =~ s/[\r\n]//g;
2796 sub command_iconSets
{
2797 print "\nDefine the icon themes that you wish to use. If you have added\n";
2798 print "a theme of your own, just follow the instructions (?) about\n";
2799 print "how to add them. You can also change the default and fallback\n";
2800 print "themes. The default theme will be used when no icon theme is\n";
2801 print "set by the user. The fallback theme will be used if an icon\n";
2802 print "cannot be found in the currently selected icon theme.\n\n";
2804 print "Available icon themes:\n\n";
2807 while ( $count <= $#icon_theme_name ) {
2808 if ( $count == $icon_theme_def ) {
2813 if ( $count eq $icon_theme_fallback ) {
2818 if ( $count < 10 ) {
2821 $name = $icon_theme_name[$count];
2822 $num_spaces = 35 - length($name);
2823 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2824 $name = $name . " ";
2827 print " $count. $name";
2828 print "($icon_theme_path[$count])\n";
2833 print "\n d = Default icon theme\n";
2834 print " f = Fallback icon theme\n";
2836 print ".------------------------------------.\n";
2837 print "| t (detect icon themes) |\n";
2838 print "| + (add icon theme) |\n";
2839 print "| - N (remove icon theme) |\n";
2840 print "| m N (mark default icon theme) |\n";
2841 print "| f N (set fallback icon set) |\n";
2842 print "| l (list icon themes) |\n";
2843 print "| d (done) |\n";
2844 print "`------------------------------------'\n";
2846 print "\n[icon_themes] command (?=help) > ";
2848 $input =~ s/[\r\n]//g;
2849 while ( $input ne "d" ) {
2850 if ( $input =~ /^\s*l\s*/i ) {
2853 while ( $count <= $#icon_theme_name ) {
2854 if ( $count == $icon_theme_def ) {
2859 if ( $count eq $icon_theme_fallback ) {
2864 $name = $icon_theme_name[$count];
2865 $num_spaces = 35 - length($name);
2866 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2867 $name = $name . " ";
2870 print " $count. $name";
2871 print "($icon_theme_path[$count])\n";
2875 print "\n d = Default icon theme\n";
2876 print " f = Fallback icon theme\n\n";
2877 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2878 $old_def = $icon_theme_def;
2879 $icon_theme_def = $input;
2880 $icon_theme_def =~ s/^\s*m\s*//;
2881 if ( ( $icon_theme_default > $#icon_theme_name ) || ( $icon_theme_default < 0 ) ) {
2882 print "Cannot set default icon theme to $icon_theme_default. That theme does not exist.\n";
2883 $icon_theme_def = $old_def;
2885 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
2886 $old_fb = $icon_theme_fallback;
2887 $icon_theme_fallback = $input;
2888 $icon_theme_fallback =~ s/^\s*f\s*//;
2889 if ( ( $icon_theme_fallback > $#icon_theme_name ) || ( $icon_theme_fallback < 0 ) ) {
2890 print "Cannot set fallback icon theme to $icon_theme_fallback. That theme does not exist.\n";
2891 $icon_theme_fallback = $old_fb;
2893 } elsif ( $input =~ /^\s*\+/ ) {
2894 print "What is the name of this icon theme? ";
2896 $name =~ s/[\r\n]//g;
2897 $icon_theme_name[ $#icon_theme_name + 1 ] = $name;
2898 print "Be sure to put ../images/themes/ before the filename.\n";
2899 print "What directory is this icon theme stored in (ex: ../images/themes/my_theme/)? ";
2901 $name =~ s/[\r\n]//g;
2902 $icon_theme_path[ $#icon_theme_path + 1 ] = $name;
2903 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2904 if ( $input =~ /[0-9]+\s*$/ ) {
2906 $rem_num =~ s/^\s*-\s*//g;
2907 $rem_num =~ s/\s*$//;
2909 $rem_num = $#icon_theme_name;
2911 if ( $rem_num == $icon_theme_def ) {
2912 print "You cannot remove the default icon theme!\n";
2913 } elsif ( $rem_num == $icon_theme_fallback ) {
2914 print "You cannot remove the fallback icon theme!\n";
2917 @new_theme_name = ();
2918 @new_theme_path = ();
2919 while ( $count <= $#icon_theme_name ) {
2920 if ( $count != $rem_num ) {
2921 @new_theme_name = ( @new_theme_name, $icon_theme_name[$count] );
2922 @new_theme_path = ( @new_theme_path, $icon_theme_path[$count] );
2926 @icon_theme_name = @new_theme_name;
2927 @icon_theme_path = @new_theme_path;
2928 if ( $icon_theme_def > $rem_num ) {
2932 } elsif ( $input =~ /^\s*t\s*/i ) {
2933 print "\nStarting detection...\n\n";
2935 opendir( DIR
, "../images/themes/" );
2936 @files = readdir(DIR
);
2938 while ( $cnt <= $#files ) {
2939 $filename = "../images/themes/" . $files[$cnt] .'/';
2940 if ( -d
"../images/themes/" . $files[$cnt] && $files[$cnt] !~ /^\
./ && $files[$cnt] ne "CVS" ) {
2942 for ( $x = 0 ; $x <= $#icon_theme_path ; $x++ ) {
2943 if ( $icon_theme_path[$x] eq $filename ) {
2947 if ( $found != 1 ) {
2948 print "** Found icon theme: $filename\n";
2949 print " What is its name? ";
2952 $icon_theme_name[ $#icon_theme_name + 1 ] = $nm;
2953 $icon_theme_path[ $#icon_theme_path + 1 ] = $filename;
2959 for ( $cnt = 0 ; $cnt <= $#icon_theme_path ; $cnt++ ) {
2960 $filename = $icon_theme_path[$cnt];
2961 if ( $filename ne "none" && $filename ne "template" && ! -d
$filename ) {
2962 print " Removing $filename (file not found)\n";
2964 @new_icon_theme_name = ();
2965 @new_icon_theme_path = ();
2966 for ( $x = 0 ; $x < $#icon_theme_path ; $x++ ) {
2967 if ( $icon_theme_path[$x] eq $filename ) {
2970 if ( $offset == 1 ) {
2971 $new_icon_theme_name[$x] = $icon_theme_name[ $x + 1 ];
2972 $new_icon_theme_path[$x] = $icon_theme_path[ $x + 1 ];
2974 $new_icon_theme_name[$x] = $icon_theme_name[$x];
2975 $new_icon_theme_path[$x] = $icon_theme_path[$x];
2978 @icon_theme_name = @new_icon_theme_name;
2979 @icon_theme_path = @new_icon_theme_path;
2982 print "\nDetection complete!\n\n";
2985 } elsif ( $input =~ /^\s*\?\s*/ ) {
2986 print ".------------------------------------.\n";
2987 print "| t (detect icon themes) |\n";
2988 print "| + (add icon theme) |\n";
2989 print "| - N (remove icon theme) |\n";
2990 print "| m N (mark default icon theme) |\n";
2991 print "| f N (set fallback icon set) |\n";
2992 print "| l (list icon themes) |\n";
2993 print "| d (done) |\n";
2994 print "`------------------------------------'\n";
2996 print "[icon_themes] command (?=help) > ";
2998 $input =~ s/[\r\n]//g;
3002 sub command_templates
{
3003 print "\nDefine the template sets that you wish to use. If you have added\n";
3004 print "a template set of your own, just follow the instructions (?) about\n";
3005 print "how to add them. You can also change the default template.\n";
3007 print "\n Available Templates:\n";
3010 while ( $count <= $#templateset_name ) {
3011 if ( $templateset_id[$count] eq $templateset_default ) {
3016 if ( $templateset_id[$count] eq $templateset_fallback ) {
3021 if ( $count < 10 ) {
3024 $name = $templateset_name[$count];
3025 $num_spaces = 35 - length($name);
3026 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3027 $name = $name . " ";
3030 print " $count. $name";
3031 print "($templateset_id[$count])\n";
3035 print "\n d = default template set\n"
3036 . " f = fallback template set\n\n";
3038 $menu_text = ".-------------------------------------.\n"
3039 . "| t (detect template set) |\n"
3040 . "| + (add template set) |\n"
3041 . "| - N (remove template set) |\n"
3042 . "| m N (mark default template set) |\n"
3043 . "| f N (set fallback template set) |\n"
3044 . "| l (list template sets) |\n"
3046 . "|-------------------------------------|\n"
3047 . "| where N is a template set number |\n"
3048 . "`-------------------------------------'\n";
3051 print "\n[template set] command (?=help) > ";
3054 $input =~ s/[\r\n]//g;
3055 while ( $input ne "d" ) {
3057 # list template sets
3059 if ( $input =~ /^\s*l\s*/i ) {
3061 while ( $count <= $#templateset_name ) {
3062 if ( $templateset_id[$count] eq $templateset_default ) {
3067 if ( $templateset_id[$count] eq $templateset_fallback ) {
3072 if ( $count < 10 ) {
3075 $name = $templateset_name[$count];
3076 $num_spaces = 35 - length($name);
3077 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3078 $name = $name . " ";
3081 print " $count. $name";
3082 print "($templateset_id[$count])\n";
3086 print "\n d = default template set\n"
3087 . " f = fallback template set\n\n";
3089 # mark default template set
3091 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
3092 $old_def = $templateset_default;
3093 $input =~ s/^\s*m\s*//;
3094 $templateset_default = $templateset_id[$input];
3095 if ( $templateset_default =~ /^\s*$/ ) {
3096 print "Cannot set default template set to $input. That template set does not exist.\n";
3097 $templateset_default = $old_def;
3100 # set fallback template set
3102 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
3103 $old_def = $templateset_fallback;
3104 $input =~ s/^\s*f\s*//;
3105 $templateset_fallback = $templateset_id[$input];
3106 if ( $templateset_fallback =~ /^\s*$/ ) {
3107 print "Cannot set fallback template set to $input. That template set does not exist.\n";
3108 $templateset_fallback = $old_def;
3113 } elsif ( $input =~ /^\s*\+/ ) {
3114 print "\nWhat is the name of this template (as shown to your users): ";
3116 $name =~ s/[\r\n]//g;
3117 $templateset_name[ $#templateset_name + 1 ] = $name;
3118 print "\n\nThe directory name should not contain any path information\n"
3119 . "or slashes, and should be the name of the directory that the\n"
3120 . "template set is found in within the SquirrelMail templates\n"
3122 print "What directory is this stored in (ex: default_advanced): ";
3124 $name =~ s/[\r\n]//g;
3125 $templateset_id[ $#templateset_id + 1 ] = $name;
3127 # detect template sets
3129 } elsif ( $input =~ /^\s*t\s*/i ) {
3130 print "\nStarting detection...\n\n";
3131 opendir( DIR
, "../templates" );
3132 @files = readdir(DIR
);
3134 while ( $cnt <= $#files ) {
3135 if ( -d
"../templates/" . $files[$cnt] && $files[$cnt] !~ /^\./ && $files[$cnt] ne "CVS" ) {
3136 $filename = $files[$cnt];
3138 for ( $x = 0 ; $x <= $#templateset_id ; $x++ ) {
3139 if ( $templateset_id[$x] eq $filename ) {
3145 print "** Found template set: $filename\n";
3146 print " What is it's name (as shown to your users)? ";
3149 $templateset_id[ $#templateset_id + 1 ] = $filename;
3150 $templateset_name[ $#templateset_name + 1 ] = $nm;
3156 for ( $cnt= 0 ; $cnt <= $#templateset_id ; ) {
3157 $filename = $templateset_id[$cnt];
3158 if ( !(-d change_to_rel_path
('SM_PATH . \'templates/' . $filename)) ) {
3159 print " Removing \"$filename\" (template set directory not found)\n";
3160 if ( $templateset_default eq $filename ) { $templateset_default = 'default'; }
3161 if ( $templateset_fallback eq $filename ) { $templateset_fallback = 'default'; }
3163 @new_templateset_name = ();
3164 @new_templateset_id = ();
3165 for ( $x = 0 ; $x < $#templateset_id ; $x++ ) {
3166 if ( $templateset_id[$x] eq $filename ) {
3169 if ( $offset == 1 ) {
3170 $new_templateset_name[$x] = $templateset_name[ $x + 1 ];
3171 $new_templateset_id[$x] = $templateset_id[ $x + 1 ];
3173 $new_templateset_name[$x] = $templateset_name[$x];
3174 $new_templateset_id[$x] = $templateset_id[$x];
3177 @templateset_name = @new_templateset_name;
3178 @templateset_id = @new_templateset_id;
3181 print "\nDetection complete!\n\n";
3185 # remove template set
3187 # undocumented functionality of removing last template set isn't that great
3188 #} elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3189 } elsif ( $input =~ /^\s*-\s*[0-9]+/ ) {
3190 if ( $input =~ /[0-9]+\s*$/ ) {
3192 $rem_num =~ s/^\s*-\s*//g;
3193 $rem_num =~ s/\s*$//;
3195 $rem_num = $#templateset_name;
3197 if ( $templateset_id[$rem_num] eq $templateset_default ) {
3198 print "You cannot remove the default template set!\n";
3199 } elsif ( $templateset_id[$rem_num] eq $templateset_fallback ) {
3200 print "You cannot remove the fallback template set!\n";
3203 @new_templateset_name = ();
3204 @new_templateset_id = ();
3205 while ( $count <= $#templateset_name ) {
3206 if ( $count != $rem_num ) {
3207 @new_templateset_name = ( @new_templateset_name, $templateset_name[$count] );
3208 @new_templateset_id = ( @new_templateset_id, $templateset_id[$count] );
3212 @templateset_name = @new_templateset_name;
3213 @templateset_id = @new_templateset_id;
3218 } elsif ( $input =~ /^\s*\?\s*/ ) {
3221 # command not understood
3224 print "Command not understood\n";
3227 print "[template set] command (?=help) > ";
3229 $input =~ s/[\r\n]//g;
3231 return $templateset_default;
3235 # sets default font size option
3236 sub command_default_fontsize
{
3237 print "Enter default font size [$WHT$$default_fontsize$NRM]: $WHT";
3238 $new_size = <STDIN
>;
3239 if ( $new_size eq "\n" ) {
3242 $new_size =~ s/[\r\n]//g;
3247 # controls available fontsets
3248 sub command_fontsets
{
3250 print "You can control fontsets available to end users here.\n";
3251 # set initial $input value
3253 while ( $input ne "x" ) {
3254 if ( $input =~ /^\s*a\s*/i ) {
3256 print "\nFontset name: ";
3258 if (! $fontsets{trim
($name)}) {
3259 print "Fontset string: ";
3261 $fontsets{trim
($name)} = trim
($value);
3263 print "\nERROR: Such fontset already exists.\n";
3265 } elsif ( $input =~ /^\s*e\s*/i ) {
3266 # edit existing fontset
3267 print "\nFontset name: ";
3269 if (! $fontsets{trim
($name)}) {
3270 print "\nERROR: No such fontset.\n";
3272 print "Fontset string [$fontsets{trim($name)}]: ";
3274 $fontsets{trim
($name)} = trim
($value);
3276 } elsif ( $input =~ /^\s*d\s*/ ) {
3277 # delete existing fontset
3278 print "\nFontset name: ";
3280 if (! $fontsets{trim
($name)}) {
3281 print "\nERROR: No such fontset.\n";
3283 delete $fontsets{trim
($name)};
3285 } elsif ( $input =~ /^\s*l\s*/ ) {
3287 print "\nConfigured fontsets:\n";
3288 while (($fontset_name, $fontset_string) = each(%fontsets)) {
3289 print " $fontset_name = $fontset_string\n";
3291 print "Default fontset: $default_fontset\n";
3292 } elsif ( $input =~ /^\s*m\s*/ ) {
3293 # set default fontset
3294 print "\nSet default fontset [$default_fontset]: ";
3296 if (trim
($name) ne '' and ! $fontsets{trim
($name)}) {
3297 print "\nERROR: No such fontset.\n";
3299 $default_fontset = trim
($name);
3302 # print available commands on any other input
3303 print "\nAvailable commands:\n";
3304 print " a - Adds new fontset.\n";
3305 print " d - Deletes existing fontset.\n";
3306 print " e - Edits existing fontset.\n";
3307 print " h or ? - Shows this help screen.\n";
3308 print " l - Lists available fontsets.\n";
3309 print " m - Sets default fontset.\n";
3310 print " x - Exits fontset editor mode.\n";
3312 print "\nCommand [fontsets] (a,d,e,h,?=help,l,m,x)> ";
3314 $input =~ s/[\r\n]//g;
3319 print "You can now define different LDAP servers.\n";
3320 print "Please ensure proper permissions for config.php when including\n";
3321 print "sensitive passwords.\n\n";
3322 print "[ldap] command (?=help) > ";
3324 $input =~ s/[\r\n]//g;
3325 while ( $input ne "d" ) {
3326 if ( $input =~ /^\s*l\s*/i ) {
3328 while ( $count <= $#ldap_host ) {
3329 print "$count. $ldap_host[$count]\n";
3330 print " base: $ldap_base[$count]\n";
3331 if ( $ldap_charset[$count] ) {
3332 print " charset: $ldap_charset[$count]\n";
3334 if ( $ldap_port[$count] ) {
3335 print " port: $ldap_port[$count]\n";
3337 if ( $ldap_name[$count] ) {
3338 print " name: $ldap_name[$count]\n";
3340 if ( $ldap_maxrows[$count] ) {
3341 print " maxrows: $ldap_maxrows[$count]\n";
3343 if ( $ldap_filter[$count] ) {
3344 print " filter: $ldap_filter[$count]\n";
3346 if ( $ldap_binddn[$count] ) {
3347 print " binddn: $ldap_binddn[$count]\n";
3348 if ( $ldap_bindpw[$count] ) {
3349 print " bindpw: $ldap_bindpw[$count]\n";
3352 if ( $ldap_protocol[$count] ) {
3353 print " protocol: $ldap_protocol[$count]\n";
3355 if ( $ldap_limit_scope[$count] ) {
3356 print " limit_scope: $ldap_limit_scope[$count]\n";
3358 if ( $ldap_listing[$count] ) {
3359 print " listing: $ldap_listing[$count]\n";
3361 if ( $ldap_writeable[$count] ) {
3362 print " writeable: $ldap_writeable[$count]\n";
3364 if ( $ldap_search_tree[$count] ) {
3365 print " search_tree: $ldap_search_tree[$count]\n";
3367 if ( $ldap_starttls[$count] ) {
3368 print " starttls: $ldap_starttls[$count]\n";
3374 } elsif ( $input =~ /^\s*\+/ ) {
3375 $sub = $#ldap_host + 1;
3377 print "First, we need to have the hostname or the IP address where\n";
3378 print "this LDAP server resides. Example: ldap.bigfoot.com\n";
3380 print "You can use any URI compatible with your LDAP library. Please\n";
3381 print "note that StartTLS option is not compatible with ldaps and\n";
3382 print "ldapi URIs.\n";
3385 $name =~ s/[\r\n]//g;
3386 $ldap_host[$sub] = $name;
3390 print "Next, we need the server root (base dn). For this, an empty\n";
3391 print "string is allowed.\n";
3392 print "Example: ou=member_directory,o=netcenter.com\n";
3395 $name =~ s/[\r\n]//g;
3396 $ldap_base[$sub] = $name;
3400 print "This is the TCP/IP port number for the LDAP server. Default\n";
3401 print "port is 389. This is optional. Press ENTER for default.\n";
3404 $name =~ s/[\r\n]//g;
3405 $ldap_port[$sub] = $name;
3409 print "This is the charset for the server. Default is utf-8. This\n";
3410 print "is also optional. Press ENTER for default.\n";
3413 $name =~ s/[\r\n]//g;
3414 $ldap_charset[$sub] = $name;
3418 print "This is the name for the server, used to tag the results of\n";
3419 print "the search. Default it \"LDAP: hostname\". Press ENTER for default\n";
3422 $name =~ s/[\r\n]//g;
3423 $ldap_name[$sub] = $name;
3427 print "You can specify the maximum number of rows in the search result.\n";
3428 print "Default value is equal to 250 rows. Press ENTER for default.\n";
3431 $name =~ s/[\r\n]//g;
3432 $ldap_maxrows[$sub] = $name;
3437 print "If your LDAP server does not like anonymous logins, you can specify bind DN.\n";
3438 print "Default is none, anonymous bind. Press ENTER for default.\n";
3441 $name =~ s/[\r\n]//g;
3442 $ldap_binddn[$sub] = $name;
3446 if ( $ldap_binddn[$sub] ne '' ) {
3448 print "Now, please specify password for that DN.\n";
3451 $name =~ s/[\r\n]//g;
3452 $ldap_bindpw[$sub] = $name;
3457 print "You can specify bind protocol version here.\n";
3458 print "Default protocol version depends on your php ldap settings.\n";
3459 print "Press ENTER for default.\n";
3462 $name =~ s/[\r\n]//g;
3463 $ldap_protocol[$sub] = $name;
3467 print "This configuration section allows to set some rarely used\n";
3468 print "options and options specific to some LDAP implementations.\n";
3470 print "Do you want to set advanced LDAP directory settings? (y/N):";
3471 $ldap_advanced_settings = <STDIN
>;
3472 if ( $ldap_advanced_settings =~ /^y\n/i ) {
3473 $ldap_advanced_settings = 'true';
3475 $ldap_advanced_settings = 'false';
3478 if ($ldap_advanced_settings eq 'true') {
3481 print "You can control LDAP directory listing here. This option can\n";
3482 print "be useful if you run small LDAP server and want to provide listing\n";
3483 print "of all addresses stored in LDAP to users of webmail interface.\n";
3484 print "Number of displayed entries is limited by maxrows setting.\n";
3486 print "Don't enable this option for public LDAP directories.\n";
3488 print "Allow listing of LDAP directory? (y/N):";
3490 if ( $name =~ /^y\n/i ) {
3495 $ldap_listing[$sub] = $name;
3499 print "You can control write access to LDAP address book here. This option can\n";
3500 print "be useful if you run small LDAP server and want to provide writable\n";
3501 print "shared address book stored in LDAP to users of webmail interface.\n";
3503 print "Don't enable this option for public LDAP directories.\n";
3505 print "Allow writing to LDAP directory? (y/N):";
3507 if ( $name =~ /^y\n/i ) {
3512 $ldap_writeable[$sub] = $name;
3516 print "You can specify an additional search filter.\n";
3517 print "This could be something like \"(objectclass=posixAccount)\".\n";
3518 print "No filtering is performed by default. Press ENTER for default.\n";
3521 $name =~ s/[\r|\n]//g;
3522 $ldap_filter[$sub] = $name;
3526 print "You can control search scope here.\n";
3527 print "This option is specific to Microsoft ADS implementation.\n";
3528 print "It requires use of v3 or newer LDAP protocol.\n";
3529 print "Don't enable it, if you use other LDAP server.\n";
3531 print "Limit ldap scope? (y/N):";
3533 if ( $name =~ /^y\n/i ) {
3538 $ldap_limit_scope[$sub] = $name;
3542 print "You can control ldap search type here.\n";
3543 print "Addresses can be searched in entire LDAP subtree (default)\n";
3544 print "or only first level entries are returned.\n";
3546 print "Search entire LDAP subtree? (Y/n):";
3548 if ( $name =~ /^n\n/i ) {
3553 $ldap_search_tree[$sub] = $name;
3557 print "You can control use of StartTLS on LDAP connection here.\n";
3558 print "This option requires use of v3 or newer LDAP protocol and php 4.2+.\n";
3560 print "Use StartTLS? (y/N):";
3562 if ( $name =~ /^y\n/i ) {
3567 $ldap_starttls[$sub] = $name;
3571 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3572 if ( $input =~ /[0-9]+\s*$/ ) {
3574 $rem_num =~ s/^\s*-\s*//g;
3575 $rem_num =~ s/\s*$//;
3577 $rem_num = $#ldap_host;
3580 @new_ldap_host = ();
3581 @new_ldap_base = ();
3582 @new_ldap_port = ();
3583 @new_ldap_name = ();
3584 @new_ldap_charset = ();
3585 @new_ldap_maxrows = ();
3586 @new_ldap_filter = ();
3587 @new_ldap_bindpw = ();
3588 @new_ldap_binddn = ();
3589 @new_ldap_protocol = ();
3590 @new_ldap_limit_scope = ();
3591 @new_ldap_listing = ();
3592 @new_ldap_writeable = ();
3593 @new_ldap_search_tree = ();
3594 @new_ldap_starttls = ();
3596 while ( $count <= $#ldap_host ) {
3597 if ( $count != $rem_num ) {
3598 @new_ldap_host = ( @new_ldap_host, $ldap_host[$count] );
3599 @new_ldap_base = ( @new_ldap_base, $ldap_base[$count] );
3600 @new_ldap_port = ( @new_ldap_port, $ldap_port[$count] );
3601 @new_ldap_name = ( @new_ldap_name, $ldap_name[$count] );
3602 @new_ldap_charset = ( @new_ldap_charset, $ldap_charset[$count] );
3603 @new_ldap_maxrows = ( @new_ldap_maxrows, $ldap_maxrows[$count] );
3604 @new_ldap_filter = ( @new_ldap_filter, $ldap_filter[$count] );
3605 @new_ldap_binddn = ( @new_ldap_binddn, $ldap_binddn[$count] );
3606 @new_ldap_bindpw = ( @new_ldap_bindpw, $ldap_bindpw[$count] );
3607 @new_ldap_protocol = ( @new_ldap_protocol, $ldap_protocol[$count] );
3608 @new_ldap_limit_scope = ( @new_ldap_limit_scope, $ldap_limit_scope[$count] );
3609 @new_ldap_listing = ( @new_ldap_listing, $ldap_listing[$count] );
3610 @new_ldap_writeable = ( @new_ldap_writeable, $ldap_writeable[$count] );
3611 @new_ldap_search_tree = ( @new_ldap_search_tree, $ldap_search_tree[$count] );
3612 @new_ldap_starttls = ( @new_ldap_starttls, $ldap_starttls[$count] );
3616 @ldap_host = @new_ldap_host;
3617 @ldap_base = @new_ldap_base;
3618 @ldap_port = @new_ldap_port;
3619 @ldap_name = @new_ldap_name;
3620 @ldap_charset = @new_ldap_charset;
3621 @ldap_maxrows = @new_ldap_maxrows;
3622 @ldap_filter = @new_ldap_filter;
3623 @ldap_binddn = @new_ldap_binddn;
3624 @ldap_bindpw = @new_ldap_bindpw;
3625 @ldap_protocol = @new_ldap_protocol;
3626 @ldap_limit_scope = @new_ldap_limit_scope;
3627 @ldap_listing = @new_ldap_listing;
3628 @ldap_writeable = @new_ldap_writeable;
3629 @ldap_search_tree = @new_ldap_search_tree;
3630 @ldap_starttls = @new_ldap_starttls;
3632 } elsif ( $input =~ /^\s*\?\s*/ ) {
3633 print ".-------------------------.\n";
3634 print "| + (add host) |\n";
3635 print "| - N (remove host) |\n";
3636 print "| l (list hosts) |\n";
3637 print "| d (done) |\n";
3638 print "`-------------------------'\n";
3640 print "[ldap] command (?=help) > ";
3642 $input =~ s/[\r\n]//g;
3647 print "Some of our developers have come up with very good javascript interface\n";
3648 print "for searching through address books, however, our original goals said\n";
3649 print "that we would be 100% HTML. In order to make it possible to use their\n";
3650 print "interface, and yet stick with our goals, we have also written a plain\n";
3651 print "HTML version of the search. Here, you can choose which version to use.\n";
3653 print "This is just the default value. It is also a user option that each\n";
3654 print "user can configure individually\n";
3657 if ( lc($default_use_javascript_addr_book) eq 'true' ) {
3658 $default_value = "y";
3660 $default_use_javascript_addr_book = 'false';
3661 $default_value = "n";
3663 print "Use javascript version by default (y/n) [$WHT$default_value$NRM]: $WHT";
3664 $new_show = <STDIN
>;
3665 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3666 $default_use_javascript_addr_book = 'true';
3668 $default_use_javascript_addr_book = 'false';
3670 return $default_use_javascript_addr_book;
3673 # global filebased address book
3675 print "If you want to use global file address book, then you\n";
3676 print "must set this option to a valid value. If option does\n";
3677 print "not have path elements, system assumes that file is\n";
3678 print "stored in data directory. If relative path is set, it is\n";
3679 print "relative to main SquirrelMail directory. If value is empty,\n";
3680 print "address book is not enabled.\n";
3683 print "[$WHT$abook_global_file$NRM]: $WHT";
3684 $new_abook_global_file = <STDIN
>;
3685 if ( $new_abook_global_file eq "\n" ) {
3686 $new_abook_global_file = $abook_global_file;
3688 $new_abook_global_file =~ s/[\r\n]//g;
3690 return $new_abook_global_file;
3693 # writing into global filebased abook control
3695 print "This setting controls writing into global file address\n";
3696 print "book options. Address book file must be writeable by\n";
3697 print "webserver's user, if you want to enable this option.\n";
3700 if ( lc($abook_global_file_writeable) eq 'true' ) {
3701 $default_value = "y";
3703 $abook_global_file_writeable = 'false';
3704 $default_value = "n";
3706 print "Allow writing into global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
3707 $new_show = <STDIN
>;
3708 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3709 $abook_global_file_writeable = 'true';
3711 $abook_global_file_writeable = 'false';
3713 return $abook_global_file_writeable;
3716 # listing of global filebased abook control
3718 print "This setting controls listing of global file address\n";
3719 print "book in addresses page.\n";
3722 if ( lc($abook_global_file_listing) eq 'true' ) {
3723 $default_value = "y";
3725 $abook_global_file_listing = 'false';
3726 $default_value = "n";
3728 print "Allow listing of global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
3729 $new_show = <STDIN
>;
3730 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3731 $abook_global_file_listing = 'true';
3733 $abook_global_file_listing = 'false';
3735 return $abook_global_file_listing;
3738 # controls $abook_file_line_length setting
3739 sub command_abook_file_line_length
{
3740 print "This setting controls space allocated to file based address book records.\n";
3741 print "End users will be unable to save address book entry, if total entry size \n";
3742 print "(quoted address book fields + 4 delimiters + linefeed) exceeds allowed \n";
3743 print "address book length size.\n";
3745 print "Same setting is applied to personal and global file based address books.\n";
3747 print "It is strongly recommended to keep default setting value. Change it only\n";
3748 print "if you really want to store address book entries that are bigger than two\n";
3749 print "kilobytes (2048).\n";
3752 print "Enter allowed address book line length [$abook_file_line_length]: ";
3755 # value is not modified, if user hits Enter or enters space
3757 # make sure that input is numeric
3758 if ($tmp =~ /^\d+$/) {
3759 $abook_file_line_length = $tmp;
3761 print "If you want to change this setting, you must enter number.\n";
3762 print "If you want to keep original setting - enter space.\n\n";
3763 print "Press Enter to continue...";
3770 print "If you want to store your users address book details in a database then\n";
3771 print "you need to set this DSN to a valid value. The format for this is:\n";
3772 print "mysql://user:pass\@hostname/dbname\n";
3773 print "Where mysql can be one of the databases PHP supports, the most common\n";
3774 print "of these are mysql, msql and pgsql.\n";
3775 print "Please ensure proper permissions for config.php when including\n";
3776 print "sensitive passwords.\n\n";
3777 print "If the DSN is left empty (hit space and then return) the database\n";
3778 print "related code for address books will not be used.\n";
3781 if ( $addrbook_dsn eq "" ) {
3782 $default_value = "Disabled";
3784 $default_value = $addrbook_dsn;
3786 print "[$WHT$addrbook_dsn$NRM]: $WHT";
3788 if ( $new_dsn eq "\n" ) {
3791 $new_dsn =~ s/[\r\n]//g;
3792 $new_dsn =~ s/^\s+$//g;
3798 print "This is the name of the table you want to store the address book\n";
3799 print "data in, it defaults to 'address'\n";
3801 print "[$WHT$addrbook_table$NRM]: $WHT";
3802 $new_table = <STDIN
>;
3803 if ( $new_table eq "\n" ) {
3804 $new_table = $addrbook_table;
3806 $new_table =~ s/[\r\n]//g;
3812 print "If you want to store your users preferences in a database then\n";
3813 print "you need to set this DSN to a valid value. The format for this is:\n";
3814 print "mysql://user:pass\@hostname/dbname\n";
3815 print "Where mysql can be one of the databases PHP supports, the most common\n";
3816 print "of these are mysql, msql and pgsql.\n";
3817 print "Please ensure proper permissions for config.php when including\n";
3818 print "sensitive passwords.\n\n";
3819 print "If the DSN is left empty (hit space and then return) the database\n";
3820 print "related code for address books will not be used.\n";
3823 if ( $prefs_dsn eq "" ) {
3824 $default_value = "Disabled";
3826 $default_value = $prefs_dsn;
3828 print "[$WHT$prefs_dsn$NRM]: $WHT";
3830 if ( $new_dsn eq "\n" ) {
3833 $new_dsn =~ s/[\r\n]//g;
3834 $new_dsn =~ s/^\s+$//g;
3840 print "This is the name of the table you want to store the preferences\n";
3841 print "data in, it defaults to 'userprefs'\n";
3843 print "[$WHT$prefs_table$NRM]: $WHT";
3844 $new_table = <STDIN
>;
3845 if ( $new_table eq "\n" ) {
3846 $new_table = $prefs_table;
3848 $new_table =~ s/[\r\n]//g;
3854 print "This is the name of the field in which you want to store the\n";
3855 print "username of the person the prefs are for. It default to 'user'\n";
3856 print "which clashes with a reserved keyword in PostgreSQL so this\n";
3857 print "will need to be changed for that database at least\n";
3859 print "[$WHT$prefs_user_field$NRM]: $WHT";
3860 $new_field = <STDIN
>;
3861 if ( $new_field eq "\n" ) {
3862 $new_field = $prefs_user_field;
3864 $new_field =~ s/[\r\n]//g;
3866 $prefs_user_size = db_pref_size
($prefs_user_size);
3871 print "This is the name of the field in which you want to store the\n";
3872 print "preferences keyword. It defaults to 'prefkey'\n";
3874 print "[$WHT$prefs_key_field$NRM]: $WHT";
3875 $new_field = <STDIN
>;
3876 if ( $new_field eq "\n" ) {
3877 $new_field = $prefs_key_field;
3879 $new_field =~ s/[\r\n]//g;
3881 $prefs_key_size = db_pref_size
($prefs_key_size);
3886 print "This is the name of the field in which you want to store the\n";
3887 print "preferences value. It defaults to 'prefval'\n";
3889 print "[$WHT$prefs_val_field$NRM]: $WHT";
3890 $new_field = <STDIN
>;
3891 if ( $new_field eq "\n" ) {
3892 $new_field = $prefs_val_field;
3894 $new_field =~ s/[\r\n]//g;
3896 $prefs_val_size = db_pref_size
($prefs_val_size);
3900 # routine is used to set database field limits
3901 # it needs one argument
3902 sub db_pref_size
() {
3904 print "\nDatabase fields have size limits.\n";
3906 print "What limit is set for this field? [$WHT$size$NRM]: $WHT";
3907 $new_size = <STDIN
>;
3908 if ( $new_size eq "\n" ) {
3911 $new_size =~ s/[\r\n]//g;
3917 print "If you want to store your global address book in a database then\n";
3918 print "you need to set this DSN to a valid value. The format for this is:\n";
3919 print "mysql://user:pass\@hostname/dbname\n";
3920 print "Where mysql can be one of the databases PHP supports, the most common\n";
3921 print "of these are mysql, msql and pgsql.\n";
3922 print "Please ensure proper permissions for config.php when including\n";
3923 print "sensitive passwords.\n\n";
3924 print "If the DSN is left empty (hit space and then return) the database\n";
3925 print "related code for global SQL address book will not be used.\n";
3928 if ( $addrbook_global_dsn eq "" ) {
3929 $default_value = "Disabled";
3931 $default_value = $addrbook_global_dsn;
3933 print "[$WHT$addrbook_global_dsn$NRM]: $WHT";
3935 if ( $new_dsn eq "\n" ) {
3938 $new_dsn =~ s/[\r\n]//g;
3939 $new_dsn =~ s/^\s+$//g;
3945 print "This is the name of the table you want to store the global address book\n";
3946 print "data in. Default table name is 'global_abook'. Address book uses same\n";
3947 print "database format as personal address book.\n";
3949 print "[$WHT$addrbook_global_table$NRM]: $WHT";
3950 $new_table = <STDIN
>;
3951 if ( $new_table eq "\n" ) {
3952 $new_table = $addrbook_global_table;
3954 $new_table =~ s/[\r\n]//g;
3960 print "This option controls users\' ability to add or modify records stored \n";
3961 print "in global address book\n";
3963 if ( lc($addrbook_global_writeable) eq 'true' ) {
3964 $default_value = "y";
3966 $default_value = "n";
3968 print "Allow writing into global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
3969 $addrbook_global_writeable = <STDIN
>;
3970 if ( ( $addrbook_global_writeable =~ /^y\n/i ) || ( ( $addrbook_global_writeable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3971 $addrbook_global_writeable = 'true';
3973 $addrbook_global_writeable = 'false';
3975 return $addrbook_global_writeable;
3979 print "Enable this option if you want to see listing of addresses stored \n";
3980 print "in global address book\n";
3982 if ( lc($addrbook_global_listing) eq 'true' ) {
3983 $default_value = "y";
3985 $default_value = "n";
3987 print "Allow listing of global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
3988 $addrbook_global_listing = <STDIN
>;
3989 if ( ( $addrbook_global_listing =~ /^y\n/i ) || ( ( $addrbook_global_listing =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3990 $addrbook_global_listing = 'true';
3992 $addrbook_global_listing = 'false';
3994 return $addrbook_global_listing;
4000 print "SquirrelMail attempts to set the language in many ways. If it\n";
4001 print "can not figure it out in another way, it will default to this\n";
4002 print "language. Please use the code for the desired language.\n";
4004 print "[$WHT$squirrelmail_default_language$NRM]: $WHT";
4005 $new_squirrelmail_default_language = <STDIN
>;
4006 if ( $new_squirrelmail_default_language eq "\n" ) {
4007 $new_squirrelmail_default_language = $squirrelmail_default_language;
4009 $new_squirrelmail_default_language =~ s/[\r\n]//g;
4010 $new_squirrelmail_default_language =~ s/^\s+$//g;
4012 return $new_squirrelmail_default_language;
4016 print "This option controls what character set is used when sending\n";
4017 print "mail and when sending HTML to the browser. Option works only\n";
4018 print "with US English (en_US) translation. Other translations use\n";
4019 print "charsets that are set in translation settings.\n";
4022 print "[$WHT$default_charset$NRM]: $WHT";
4023 $new_default_charset = <STDIN
>;
4024 if ( $new_default_charset eq "\n" ) {
4025 $new_default_charset = $default_charset;
4027 $new_default_charset =~ s/[\r\n]//g;
4029 return $new_default_charset;
4031 # Alternative language names
4033 print "Enable this option if you want to see localized language names in\n";
4034 print "language selection box. Note, that this option can trigger\n";
4035 print "installation of foreign language support modules in some browsers.\n";
4038 if ( lc($show_alternative_names) eq 'true' ) {
4039 $default_value = "y";
4041 $default_value = "n";
4043 print "Show alternative language names? (y/n) [$WHT$default_value$NRM]: $WHT";
4044 $show_alternative_names = <STDIN
>;
4045 if ( ( $show_alternative_names =~ /^y\n/i ) || ( ( $show_alternative_names =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4046 $show_alternative_names = 'true';
4048 $show_alternative_names = 'false';
4050 return $show_alternative_names;
4053 # Aggressive decoding
4055 print "Enable this option if you want to use CPU and memory intensive decoding\n";
4056 print "functions. This option allows reading multibyte charset, that are used\n";
4057 print "in Eastern Asia. SquirrelMail will try to use recode functions here,\n";
4058 print "even when you have disabled use of recode in Tweaks section.\n";
4061 if ( lc($aggressive_decoding) eq 'true' ) {
4062 $default_value = "y";
4064 $default_value = "n";
4066 print "Enable aggressive decoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4067 $aggressive_decoding = <STDIN
>;
4068 if ( ( $aggressive_decoding =~ /^y\n/i ) || ( ( $aggressive_decoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4069 $aggressive_decoding = 'true';
4071 $aggressive_decoding = 'false';
4073 return $aggressive_decoding;
4078 print "Enable this option if you want to allow lossy charset encoding in message\n";
4079 print "composition pages. This option allows charset conversions when output\n";
4080 print "charset does not support all symbols used in original charset. Symbols\n";
4081 print "unsupported by output charset will be replaced with question marks.\n";
4084 if ( lc($lossy_encoding) eq 'true' ) {
4085 $default_value = "y";
4087 $default_value = "n";
4089 print "Enable lossy encoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4090 $lossy_encoding = <STDIN
>;
4091 if ( ( $lossy_encoding =~ /^y\n/i ) || ( ( $lossy_encoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4092 $lossy_encoding = 'true';
4094 $lossy_encoding = 'false';
4096 return $lossy_encoding;
4099 # display html emails in iframe
4101 print "This option can enable html email rendering inside iframe.\n";
4102 print "Inline frames are used in order to provide sandbox environment";
4103 print "for html code included in html formated emails.";
4104 print "Option is experimental and might have glitches in some parts of code.";
4107 if ( lc($use_iframe) eq 'true' ) {
4108 $default_value = "y";
4110 $default_value = "n";
4112 print "Display html emails in iframe? (y/n) [$WHT$default_value$NRM]: $WHT";
4113 $use_iframe = <STDIN
>;
4114 if ( ( $use_iframe =~ /^y\n/i ) || ( ( $use_iframe =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4115 $use_iframe = 'true';
4117 $use_iframe = 'false';
4123 print "Enabling this option will cause icons to be used instead of text\n";
4124 print "markers next to each message in mailbox lists that represent\n";
4125 print "new, read, flagged, and deleted messages, as well as those that\n";
4126 print "have been replied to and forwarded. Icons are also used next to\n";
4127 print "(un)expanded folders in the folder list (Oldway = false). These\n";
4128 print "icons are quite small, but will obviously be more of a resource\n";
4129 print "drain than text markers.\n";
4132 if ( lc($use_icons) eq 'true' ) {
4133 $default_value = "y";
4135 $default_value = "n";
4137 print "Use icons? (y/n) [$WHT$default_value$NRM]: $WHT";
4138 $use_icons = <STDIN
>;
4139 if ( ( $use_icons =~ /^y\n/i ) || ( ( $use_icons =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4140 $use_icons = 'true';
4142 $use_icons = 'false';
4148 print "Enable this option if you want to use php recode functions to read\n";
4149 print "emails written in charset that differs from the one that is set in\n";
4150 print "translation selected by user. Code is experimental, it might cause\n";
4151 print "errors, if email contains charset unsupported by recode or if your\n";
4152 print "php does not have recode support.\n";
4155 if ( lc($use_php_recode) eq 'true' ) {
4156 $default_value = "y";
4158 $default_value = "n";
4160 print "Use php recode functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4161 $use_php_recode = <STDIN
>;
4162 if ( ( $use_php_recode =~ /^y\n/i ) || ( ( $use_php_recode =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4163 $use_php_recode = 'true';
4165 $use_php_recode = 'false';
4167 return $use_php_recode;
4171 print "Enable this option if you want to use php iconv functions to read\n";
4172 print "emails written in charset that differs from the one that is set in\n";
4173 print "translation selected by user. Code is experimental, it works only\n";
4174 print "with translations that use utf-8 charset. Code might cause errors,\n";
4175 print "if email contains charset unsupported by iconv or if your php does\n";
4176 print "not have iconv support.\n";
4179 if ( lc($use_php_iconv) eq 'true' ) {
4180 $default_value = "y";
4182 $default_value = "n";
4184 print "Use php iconv functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4185 $use_php_iconv = <STDIN
>;
4186 if ( ( $use_php_iconv =~ /^y\n/i ) || ( ( $use_php_iconv =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4187 $use_php_iconv = 'true';
4189 $use_php_iconv = 'false';
4191 return $use_php_iconv;
4196 print "Enable this option if you want to check SquirrelMail configuration\n";
4197 print "remotely with configtest.php script.\n";
4200 if ( lc($allow_remote_configtest) eq 'true' ) {
4201 $default_value = "y";
4203 $default_value = "n";
4205 print "Allow remote configuration tests? (y/n) [$WHT$default_value$NRM]: $WHT";
4206 $allow_remote_configtest = <STDIN
>;
4207 if ( ( $allow_remote_configtest =~ /^y\n/i ) || ( ( $allow_remote_configtest =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4208 $allow_remote_configtest = 'true';
4210 $allow_remote_configtest = 'false';
4212 return $allow_remote_configtest;
4215 # Default Icon theme
4217 print "You may change the path to the default icon theme to be used, if icons\n";
4218 print "have been enabled. This theme will be used when an icon cannot be\n";
4219 print "found in the current theme, or when no icon theme is specified. If\n";
4220 print "left blank, and icons are enabled, the default theme will be used\n";
4221 print "from images/themes/default/.\n";
4223 print "To clear out an existing value, just type a space for the input.\n";
4225 print "Please be aware of the following: \n";
4226 print " - Relative URLs are relative to the config dir\n";
4227 print " to use the icon themes directory, use ../images/themes/newtheme/\n";
4228 print " - The icon theme may be outside the SquirrelMail directory, but\n";
4229 print " it must be web accessible.\n";
4230 print "[$WHT$icon_theme_def$NRM]: $WHT";
4231 $new_icon_theme_def = <STDIN
>;
4233 if ( $new_icon_theme_def eq "\n" ) {
4234 $new_icon_theme_def = $icon_theme_def;
4236 $new_icon_theme_def =~ s/[\r\n]//g;
4238 $new_icon_theme_def =~ s/^\s*//;
4239 return $new_icon_theme_def;
4244 if ( open( CF
, ">config.php" ) ) {
4249 print CF
" * SquirrelMail Configuration File\n";
4250 print CF
" * Created using the configure script, conf.pl\n";
4253 print CF
"global \$version;\n";
4255 if ($print_config_version) {
4256 print CF
"\$config_version = '$print_config_version';\n";
4259 print CF
"\$config_use_color = $config_use_color;\n";
4263 print CF
"\$org_name = \"$org_name\";\n";
4265 print CF
"\$org_logo = " . &change_to_SM_path
($org_logo) . ";\n";
4266 $org_logo_width |= 0;
4267 $org_logo_height |= 0;
4269 print CF
"\$org_logo_width = '$org_logo_width';\n";
4271 print CF
"\$org_logo_height = '$org_logo_height';\n";
4272 # string that can contain variables.
4273 print CF
"\$org_title = \"$org_title\";\n";
4275 print CF
"\$signout_page = " . &change_to_SM_path
($signout_page) . ";\n";
4277 print CF
"\$frame_top = '$frame_top';\n";
4280 print CF
"\$provider_uri = '$provider_uri';\n";
4283 print CF
"\$provider_name = '$provider_name';\n";
4286 # string that can contain variables
4287 print CF
"\$motd = \"$motd\";\n";
4291 print CF
"\$squirrelmail_default_language = '$squirrelmail_default_language';\n";
4293 print CF
"\$default_charset = '$default_charset';\n";
4295 print CF
"\$show_alternative_names = $show_alternative_names;\n";
4297 print CF
"\$aggressive_decoding = $aggressive_decoding;\n";
4299 print CF
"\$lossy_encoding = $lossy_encoding;\n";
4303 print CF
"\$domain = '$domain';\n";
4305 print CF
"\$imapServerAddress = '$imapServerAddress';\n";
4307 print CF
"\$imapPort = $imapPort;\n";
4309 print CF
"\$useSendmail = $useSendmail;\n";
4311 print CF
"\$smtpServerAddress = '$smtpServerAddress';\n";
4313 print CF
"\$smtpPort = $smtpPort;\n";
4315 print CF
"\$sendmail_path = '$sendmail_path';\n";
4317 print CF
"\$sendmail_args = '$sendmail_args';\n";
4319 # print CF "\$use_authenticated_smtp = $use_authenticated_smtp;\n";
4321 print CF
"\$pop_before_smtp = $pop_before_smtp;\n";
4323 print CF
"\$imap_server_type = '$imap_server_type';\n";
4325 print CF
"\$invert_time = $invert_time;\n";
4327 print CF
"\$optional_delimiter = '$optional_delimiter';\n";
4329 print CF
"\$encode_header_key = '$encode_header_key';\n";
4333 print CF
"\$default_folder_prefix = '$default_folder_prefix';\n";
4335 print CF
"\$trash_folder = '$trash_folder';\n";
4337 print CF
"\$sent_folder = '$sent_folder';\n";
4339 print CF
"\$draft_folder = '$draft_folder';\n";
4341 print CF
"\$default_move_to_trash = $default_move_to_trash;\n";
4343 print CF
"\$default_move_to_sent = $default_move_to_sent;\n";
4345 print CF
"\$default_save_as_draft = $default_save_as_draft;\n";
4347 print CF
"\$show_prefix_option = $show_prefix_option;\n";
4349 print CF
"\$list_special_folders_first = $list_special_folders_first;\n";
4351 print CF
"\$use_special_folder_color = $use_special_folder_color;\n";
4353 print CF
"\$auto_expunge = $auto_expunge;\n";
4355 print CF
"\$default_sub_of_inbox = $default_sub_of_inbox;\n";
4357 print CF
"\$show_contain_subfolders_option = $show_contain_subfolders_option;\n";
4359 print CF
"\$default_unseen_notify = $default_unseen_notify;\n";
4361 print CF
"\$default_unseen_type = $default_unseen_type;\n";
4363 print CF
"\$auto_create_special = $auto_create_special;\n";
4365 print CF
"\$delete_folder = $delete_folder;\n";
4367 print CF
"\$noselect_fix_enable = $noselect_fix_enable;\n";
4372 print CF
"\$data_dir = " . &change_to_SM_path
($data_dir) . ";\n";
4373 # string that can contain a variable
4374 print CF
"\$attachment_dir = " . &change_to_SM_path
($attachment_dir) . ";\n";
4376 print CF
"\$dir_hash_level = $dir_hash_level;\n";
4378 print CF
"\$default_left_size = '$default_left_size';\n";
4380 print CF
"\$force_username_lowercase = $force_username_lowercase;\n";
4382 print CF
"\$default_use_priority = $default_use_priority;\n";
4384 print CF
"\$hide_sm_attributions = $hide_sm_attributions;\n";
4386 print CF
"\$default_use_mdn = $default_use_mdn;\n";
4388 print CF
"\$edit_identity = $edit_identity;\n";
4390 print CF
"\$edit_name = $edit_name;\n";
4392 print CF
"\$hide_auth_header = $hide_auth_header;\n";
4394 print CF
"\$disable_thread_sort = $disable_thread_sort;\n";
4396 print CF
"\$disable_server_sort = $disable_server_sort;\n";
4398 print CF
"\$allow_charset_search = $allow_charset_search;\n";
4400 print CF
"\$allow_advanced_search = $allow_advanced_search;\n";
4403 print CF
"\$time_zone_type = $time_zone_type;\n";
4406 print CF
"\$config_location_base = '$config_location_base';\n";
4409 print CF
"\$disable_plugins = $disable_plugins;\n";
4411 print CF
"\$disable_plugins_user = '$disable_plugins_user';\n";
4414 # all plugins are strings
4415 for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
4416 print CF
"\$plugins[] = '$plugins[$ct]';\n";
4421 if ( $user_theme_default eq '' ) { $user_theme_default = '0'; }
4422 print CF
"\$user_theme_default = $user_theme_default;\n";
4424 for ( $count = 0 ; $count <= $#user_theme_name ; $count++ ) {
4425 if ($user_theme_path[$count] eq 'none') {
4428 $path = &change_to_SM_path
($user_theme_path[$count]);
4430 print CF
"\$user_themes[$count]['PATH'] = " . $path . ";\n";
4431 # escape theme name so it can contain single quotes.
4432 $esc_name = $user_theme_name[$count];
4433 $esc_name =~ s/\\/\\\\/g;
4434 $esc_name =~ s/'/\\'/g;
4435 print CF
"\$user_themes[$count]['NAME'] = '$esc_name';\n";
4439 if ( $icon_theme_def eq '' ) { $icon_theme_def = '0'; }
4440 print CF
"\$icon_theme_def = $icon_theme_def;\n";
4441 if ( $icon_theme_fallback eq '' ) { $icon_theme_fallback = '0'; }
4442 print CF
"\$icon_theme_fallback = $icon_theme_fallback;\n";
4444 for ( $count = 0 ; $count <= $#icon_theme_name ; $count++ ) {
4445 $path = $icon_theme_path[$count];
4446 if ($path eq 'none' || $path eq 'template') {
4447 $path = "'".$path."'";
4449 $path = &change_to_SM_path
($icon_theme_path[$count]);
4451 print CF
"\$icon_themes[$count]['PATH'] = " . $path . ";\n";
4452 # escape theme name so it can contain single quotes.
4453 $esc_name = $icon_theme_name[$count];
4454 $esc_name =~ s/\\/\\\\/g;
4455 $esc_name =~ s/'/\\'/g;
4456 print CF
"\$icon_themes[$count]['NAME'] = '$esc_name';\n";
4460 if ( $templateset_default eq '' ) { $templateset_default = 'default'; }
4461 print CF
"\$templateset_default = '$templateset_default';\n";
4463 if ( $templateset_fallback eq '' ) { $templateset_fallback = 'default'; }
4464 print CF
"\$templateset_fallback = '$templateset_fallback';\n";
4466 for ( $count = 0 ; $count <= $#templateset_name ; $count++ ) {
4467 print CF
"\$aTemplateSet[$count]['ID'] = '" . $templateset_id[$count] . "';\n";
4468 # escape theme name so it can contain single quotes.
4469 $esc_name = $templateset_name[$count];
4470 $esc_name =~ s/\\/\\\\/g;
4471 $esc_name =~ s/'/\\'/g;
4472 print CF
"\$aTemplateSet[$count]['NAME'] = '$esc_name';\n";
4478 print CF
"\$default_fontsize = '$default_fontsize';\n";
4480 print CF
"\$default_fontset = '$default_fontset';\n";
4482 # assoc. array (maybe initial value should be set somewhere else)
4483 print CF
'$fontsets = array();'."\n";
4484 while (($fontset_name, $fontset_value) = each(%fontsets)) {
4485 print CF
"\$fontsets\['$fontset_name'\] = '$fontset_value';\n";
4491 print CF
"\$default_use_javascript_addr_book = $default_use_javascript_addr_book;\n";
4492 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
4493 print CF
"\$ldap_server[$count] = array(\n";
4495 print CF
" 'host' => '$ldap_host[$count]',\n";
4497 print CF
" 'base' => '$ldap_base[$count]'";
4498 if ( $ldap_name[$count] ) {
4501 print CF
" 'name' => '$ldap_name[$count]'";
4503 if ( $ldap_port[$count] ) {
4506 print CF
" 'port' => $ldap_port[$count]";
4508 if ( $ldap_charset[$count] ) {
4511 print CF
" 'charset' => '$ldap_charset[$count]'";
4513 if ( $ldap_maxrows[$count] ) {
4516 print CF
" 'maxrows' => $ldap_maxrows[$count]";
4519 if ( $ldap_filter[$count] ) {
4521 print CF
" 'filter' => '$ldap_filter[$count]'";
4523 if ( $ldap_binddn[$count] ) {
4526 print CF
" 'binddn' => '$ldap_binddn[$count]'";
4527 if ( $ldap_bindpw[$count] ) {
4530 print CF
" 'bindpw' => '$ldap_bindpw[$count]'";
4533 if ( $ldap_protocol[$count] ) {
4536 print CF
" 'protocol' => $ldap_protocol[$count]";
4538 if ( $ldap_limit_scope[$count] ) {
4541 print CF
" 'limit_scope' => $ldap_limit_scope[$count]";
4543 if ( $ldap_listing[$count] ) {
4546 print CF
" 'listing' => $ldap_listing[$count]";
4548 if ( $ldap_writeable[$count] ) {
4551 print CF
" 'writeable' => $ldap_writeable[$count]";
4553 if ( $ldap_search_tree[$count] ) {
4556 print CF
" 'search_tree' => $ldap_search_tree[$count]";
4558 if ( $ldap_listing[$count] ) {
4561 print CF
" 'starttls' => $ldap_starttls[$count]";
4569 print CF
"\$addrbook_dsn = '$addrbook_dsn';\n";
4571 print CF
"\$addrbook_table = '$addrbook_table';\n\n";
4573 print CF
"\$prefs_dsn = '$prefs_dsn';\n";
4575 print CF
"\$prefs_table = '$prefs_table';\n";
4577 print CF
"\$prefs_user_field = '$prefs_user_field';\n";
4579 print CF
"\$prefs_user_size = $prefs_user_size;\n";
4581 print CF
"\$prefs_key_field = '$prefs_key_field';\n";
4583 print CF
"\$prefs_key_size = $prefs_key_size;\n";
4585 print CF
"\$prefs_val_field = '$prefs_val_field';\n";
4587 print CF
"\$prefs_val_size = $prefs_val_size;\n\n";
4589 print CF
"\$addrbook_global_dsn = '$addrbook_global_dsn';\n";
4591 print CF
"\$addrbook_global_table = '$addrbook_global_table';\n";
4593 print CF
"\$addrbook_global_writeable = $addrbook_global_writeable;\n";
4595 print CF
"\$addrbook_global_listing = $addrbook_global_listing;\n\n";
4597 print CF
"\$abook_global_file = '$abook_global_file';\n";
4599 print CF
"\$abook_global_file_writeable = $abook_global_file_writeable;\n\n";
4601 print CF
"\$abook_global_file_listing = $abook_global_file_listing;\n\n";
4603 print CF
"\$abook_file_line_length = $abook_file_line_length;\n\n";
4605 print CF
"\$no_list_for_subscribe = $no_list_for_subscribe;\n";
4608 print CF
"\$smtp_auth_mech = '$smtp_auth_mech';\n";
4609 print CF
"\$smtp_sitewide_user = '". quote_single
($smtp_sitewide_user) ."';\n";
4610 print CF
"\$smtp_sitewide_pass = '". quote_single
($smtp_sitewide_pass) ."';\n";
4612 print CF
"\$imap_auth_mech = '$imap_auth_mech';\n";
4614 print CF
"\$use_imap_tls = $use_imap_tls;\n";
4616 print CF
"\$use_smtp_tls = $use_smtp_tls;\n";
4618 print CF
"\$session_name = '$session_name';\n";
4623 print CF
"\$use_iframe = $use_iframe;\n";
4626 print CF
"\$use_icons = $use_icons;\n";
4629 print CF
"\$use_php_recode = $use_php_recode;\n";
4632 print CF
"\$use_php_iconv = $use_php_iconv;\n";
4635 print CF
"\$allow_remote_configtest = $allow_remote_configtest;\n";
4640 print "Data saved in config.php\n";
4642 build_plugin_hook_array
();
4645 print "Error saving config.php: $!\n";
4651 print $WHT. "SquirrelMail Configuration : " . $NRM;
4652 if ( $config == 1 ) { print "Read: config.php"; }
4653 elsif ( $config == 2 ) { print "Read: config_default.php"; }
4655 print "---------------------------------------------------------\n";
4657 print "While we have been building SquirrelMail, we have discovered some\n";
4658 print "preferences that work better with some servers that don't work so\n";
4659 print "well with others. If you select your IMAP server, this option will\n";
4660 print "set some pre-defined settings for that server.\n";
4662 print "Please note that you will still need to go through and make sure\n";
4663 print "everything is correct. This does not change everything. There are\n";
4664 print "only a few settings that this will change.\n";
4668 while ( $continue != 1 ) {
4669 print "Please select your IMAP server:\n";
4670 print " bincimap = Binc IMAP server\n";
4671 print " courier = Courier IMAP server\n";
4672 print " cyrus = Cyrus IMAP server\n";
4673 print " dovecot = Dovecot Secure IMAP server\n";
4674 print " exchange = Microsoft Exchange IMAP server\n";
4675 print " hmailserver = hMailServer\n";
4676 print " macosx = Mac OS X Mailserver\n";
4677 print " mercury32 = Mercury/32\n";
4678 print " uw = University of Washington's IMAP server\n";
4680 print " quit = Do not change anything\n";
4682 print "Command >> ";
4684 $server =~ s/[\r\n]//g;
4686 # variable is used to display additional messages.
4690 if ( $server eq "cyrus" ) {
4691 $imap_server_type = "cyrus";
4692 $default_folder_prefix = "";
4693 $trash_folder = "INBOX.Trash";
4694 $sent_folder = "INBOX.Sent";
4695 $draft_folder = "INBOX.Drafts";
4696 $show_prefix_option = false
;
4697 $default_sub_of_inbox = true
;
4698 $show_contain_subfolders_option = false
;
4699 $optional_delimiter = ".";
4700 $disp_default_folder_prefix = "<none>";
4701 $force_username_lowercase = false
;
4703 # Delimiter might differ if unixhierarchysep is set to yes.
4704 $message = "\nIf you have enabled unixhierarchysep, you must change delimiter and special folder names.\n";
4707 } elsif ( $server eq "uw" ) {
4708 $imap_server_type = "uw";
4709 $default_folder_prefix = "mail/";
4710 $trash_folder = "Trash";
4711 $sent_folder = "Sent";
4712 $draft_folder = "Drafts";
4713 $show_prefix_option = true
;
4714 $default_sub_of_inbox = false
;
4715 $show_contain_subfolders_option = true
;
4716 $optional_delimiter = "/";
4717 $disp_default_folder_prefix = $default_folder_prefix;
4718 $delete_folder = true
;
4719 $force_username_lowercase = true
;
4722 } elsif ( $server eq "exchange" ) {
4723 $imap_server_type = "exchange";
4724 $default_folder_prefix = "";
4725 $default_sub_of_inbox = true
;
4726 $trash_folder = "INBOX/Deleted Items";
4727 $sent_folder = "INBOX/Sent Items";
4728 $drafts_folder = "INBOX/Drafts";
4729 $show_prefix_option = false
;
4730 $show_contain_subfolders_option = false
;
4731 $optional_delimiter = "detect";
4732 $disp_default_folder_prefix = "<none>";
4733 $force_username_lowercase = true
;
4736 } elsif ( $server eq "courier" ) {
4737 $imap_server_type = "courier";
4738 $default_folder_prefix = "INBOX.";
4739 $trash_folder = "Trash";
4740 $sent_folder = "Sent";
4741 $draft_folder = "Drafts";
4742 $show_prefix_option = false
;
4743 $default_sub_of_inbox = false
;
4744 $show_contain_subfolders_option = false
;
4745 $optional_delimiter = ".";
4746 $disp_default_folder_prefix = $default_folder_prefix;
4747 $delete_folder = true
;
4748 $force_username_lowercase = false
;
4751 } elsif ( $server eq "macosx" ) {
4752 $imap_server_type = "macosx";
4753 $default_folder_prefix = "INBOX/";
4754 $trash_folder = "Trash";
4755 $sent_folder = "Sent";
4756 $draft_folder = "Drafts";
4757 $show_prefix_option = false
;
4758 $default_sub_of_inbox = true
;
4759 $show_contain_subfolders_option = false
;
4760 $optional_delimiter = "detect";
4761 $allow_charset_search = false
;
4762 $disp_default_folder_prefix = $default_folder_prefix;
4765 } elsif ( $server eq "hmailserver" ) {
4766 $imap_server_type = "hmailserver";
4767 $default_folder_prefix = "";
4768 $trash_folder = "INBOX.Trash";
4769 $sent_folder = "INBOX.Sent";
4770 $draft_folder = "INBOX.Drafts";
4771 $show_prefix_option = false
;
4772 $default_sub_of_inbox = true
;
4773 $show_contain_subfolders_option = false
;
4774 $optional_delimiter = "detect";
4775 $allow_charset_search = false
;
4776 $disp_default_folder_prefix = $default_folder_prefix;
4777 $delete_folder = false
;
4778 $force_username_lowercase = false
;
4781 } elsif ( $server eq "mercury32" ) {
4782 $imap_server_type = "mercury32";
4783 $default_folder_prefix = "";
4784 $trash_folder = "Trash";
4785 $sent_folder = "Sent";
4786 $draft_folder = "Drafts";
4787 $show_prefix_option = false
;
4788 $default_sub_of_inbox = true
;
4789 $show_contain_subfolders_option = true
;
4790 $optional_delimiter = "detect";
4791 $delete_folder = true
;
4792 $force_username_lowercase = true
;
4795 } elsif ( $server eq "dovecot" ) {
4796 $imap_server_type = "dovecot";
4797 $default_folder_prefix = "";
4798 $trash_folder = "Trash";
4799 $sent_folder = "Sent";
4800 $draft_folder = "Drafts";
4801 $show_prefix_option = false
;
4802 $default_sub_of_inbox = false
;
4803 $show_contain_subfolders_option = false
;
4804 $delete_folder = false
;
4805 $force_username_lowercase = true
;
4806 $optional_delimiter = "detect";
4807 $disp_default_folder_prefix = "<none>";
4810 } elsif ( $server eq "bincimap" ) {
4811 $imap_server_type = "bincimap";
4812 $default_folder_prefix = "INBOX/";
4813 $trash_folder = "Trash";
4814 $sent_folder = "Sent";
4815 $draft_folder = "Drafts";
4816 $show_prefix_option = false
;
4817 $default_sub_of_inbox = false
;
4818 $show_contain_subfolders_option = false
;
4819 $delete_folder = true
;
4820 $force_username_lowercase = false
;
4821 $optional_delimiter = "detect";
4822 $disp_default_folder_prefix = $default_folder_prefix;
4824 # Default folder prefix depends on used depot.
4825 $message = "\nIf you use IMAPdir depot, you must set default folder prefix to empty string.\n";
4828 } elsif ( $server eq "quit" ) {
4831 $disp_default_folder_prefix = $default_folder_prefix;
4832 print "Unrecognized server: $server\n";
4836 print " imap_server_type = $imap_server_type\n";
4837 print " default_folder_prefix = $disp_default_folder_prefix\n";
4838 print " trash_folder = $trash_folder\n";
4839 print " sent_folder = $sent_folder\n";
4840 print " draft_folder = $draft_folder\n";
4841 print " show_prefix_option = $show_prefix_option\n";
4842 print " default_sub_of_inbox = $default_sub_of_inbox\n";
4843 print "show_contain_subfolders_option = $show_contain_subfolders_option\n";
4844 print " optional_delimiter = $optional_delimiter\n";
4845 print " delete_folder = $delete_folder\n";
4846 print " force_username_lowercase = $force_username_lowercase\n";
4850 print "\nPress enter to continue...";
4854 # This subroutine corrects relative paths to ensure they
4855 # will work within the SM space. If the path falls within
4856 # the SM directory tree, the SM_PATH variable will be
4857 # prepended to the path, if not, then the path will be
4858 # converted to an absolute path, e.g.
4859 # '../images/logo.gif' --> SM_PATH . 'images/logo.gif'
4860 # '../../someplace/data' --> '/absolute/path/someplace/data'
4861 # 'images/logo.gif' --> SM_PATH . 'config/images/logo.gif'
4862 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
4863 # 'http://whatever/' --> 'http://whatever'
4864 # $some_var/path --> "$some_var/path"
4865 sub change_to_SM_path
() {
4866 my ($old_path) = @_;
4872 # If the path is absolute, don't bother.
4873 return "\'" . $old_path . "\'" if ( $old_path eq '');
4874 return "\'" . $old_path . "\'" if ( $old_path =~ /^(\/|http
)/ );
4875 return "\'" . $old_path . "\'" if ( $old_path =~ /^\w:\// );
4876 return $old_path if ( $old_path =~ /^\'(\/|http
)/ );
4877 return $old_path if ( $old_path =~ /^\'\w:\// );
4878 return $old_path if ( $old_path =~ /^SM_PATH/);
4880 if ( $old_path =~ /^\$/ ) {
4881 # check if it's a single var, or a $var/path combination
4882 # if it's $var/path, enclose in ""
4883 if ( $old_path =~ /\// ) {
4884 return '"'.$old_path.'"';
4889 # Remove remaining '
4890 $old_path =~ s/\'//g;
4892 # For relative paths, split on '../'
4893 @rel_path = split(/\.\.\//, $old_path);
4895 if ( $#rel_path > 1 ) {
4896 # more than two levels away. Make it absolute.
4897 @abs_path = split(/\//, $dir);
4899 # Lop off the relative pieces of the absolute path..
4900 for ( $i = 0; $i <= $#rel_path; $i++ ) {
4904 push @abs_path, @rel_path;
4905 $new_path = "\'" . join('/', @abs_path) . "\'";
4906 } elsif ( $#rel_path > 0 ) {
4907 # it's within the SM tree, prepend SM_PATH
4908 $new_path = $old_path;
4909 $new_path =~ s/^\.\.\//SM_PATH
. \'/;
4912 # Last, it's a relative path without any leading '.'
4913 # Prepend SM_PATH and config, since the paths are
4914 # relative to the config directory
4915 $new_path = "SM_PATH . \'config/" . $old_path . "\'";
4921 # Change SM_PATH to admin-friendly version, e.g.:
4922 # SM_PATH . 'images/logo.gif' --> '../images/logo.gif'
4923 # SM_PATH . 'config/some.php' --> 'some.php'
4924 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
4925 # 'http://whatever/' --> 'http://whatever'
4926 sub change_to_rel_path
() {
4927 my ($old_path) = @_;
4928 my $new_path = $old_path;
4930 if ( $old_path =~ /^SM_PATH/ ) {
4931 # FIXME: the following replacement loses the opening quote mark!
4932 $new_path =~ s/^SM_PATH . \'/\.\.\//;
4933 $new_path =~ s/\.\.\/config\///;
4939 # Attempts to auto-detect if a specific auth mechanism is supported.
4940 # Called by 'command112a' and 'command112b'
4941 # ARGS: service-name (IMAP or SMTP), host:port, mech-name (ie. CRAM-MD5)
4942 sub detect_auth_support
{
4943 # Try loading IO::Socket
4944 unless (eval("use IO::Socket; 1")) {
4945 print "Perl IO::Socket module is not available.";
4949 my $service = shift;
4953 if ((!defined($service)) or (!defined($host)) or (!defined($mech))) {
4954 # Error - wrong # of args
4955 print "BAD ARGS!\n";
4959 if ($service eq 'SMTP') {
4960 $cmd = "AUTH $mech\r\n";
4961 $logout = "QUIT\r\n";
4962 } elsif ($service eq 'IMAP') {
4963 $cmd = "A01 AUTHENTICATE $mech\n";
4964 $logout = "C01 LOGOUT\n";
4966 # unknown service - whoops.
4970 # Get this show on the road
4971 my $sock=IO
::Socket
::INET
->new($host);
4972 if (!defined($sock)) {
4976 my $discard = <$sock>; # Server greeting/banner - who cares..
4978 if ($service eq 'SMTP') {
4980 print $sock "HELO $domain\r\n";
4981 $discard = <$sock>; # Yeah yeah, you're happy to see me..
4985 my $response = <$sock>;
4987 if (!defined($response)) {
4991 # So at this point, we have a response, and it is (hopefully) valid.
4992 if ($service eq 'SMTP') {
4993 if (($response =~ /^535/) or ($response =~/^502/)) {
4995 print $sock $logout;
4998 } elsif ($response =~ /^503/) {
4999 #Something went wrong
5002 } elsif ($service eq 'IMAP') {
5003 if ($response =~ /^A01/) {
5005 print $sock $logout;
5010 # Unknown service - this shouldn't be able to happen.
5015 # If it gets here, the mech is supported
5016 print $sock "*\n"; # Attempt to cancel authentication
5017 print $sock $logout; # Try to log out, but we don't really care if this fails
5023 # Example code from O'Reilly Perl Cookbook
5030 return wantarray ?
@out : $out[0];
5033 sub clear_screen
() {
5034 if ( $^O
=~ /^mswin/i) {
5041 # checks IMAP mailbox name. Refuses to accept 8bit folders
5042 # returns 0 (folder name is not correct) or 1 (folder name is correct)
5043 sub check_imap_folder
($) {
5044 my $folder_name = shift(@_);
5046 if ($folder_name =~ /[\x80-\xFFFF]/) {
5047 print "Folder name contains 8bit characters. Configuration utility requires\n";
5048 print "UTF7-IMAP encoded folder names.\n";
5049 print "Press enter to continue...";
5052 } elsif ($folder_name =~ /[&\*\%]/) {
5053 # check for ampersand and list-wildcards
5054 print "Folder name contains special UTF7-IMAP characters.\n";
5055 print "Are you sure that folder name is correct? (yN): ";
5057 $tmp = lc(trim
($tmp));
5058 if ($tmp =~ /^y$/) {
5068 # quotes string written in single quotes
5069 sub quote_single
($) {
5070 my $string = shift(@_);
5071 $string =~ s/\'/\\'/g;
5075 # parses the setup.php files for all activated plugins and
5076 # builds static plugin hooks array so we don't have to load
5077 # ALL plugins are runtime and build the hook array on every
5080 # hook array is saved in config/plugin_hooks.php
5082 # Note the $verbose variable at the top of this routine
5083 # can be set to zero to quiet it down.
5085 # NOTE/FIXME: we aren't necessarily interested in writing
5086 # a full-blown PHP parsing engine, so plenty
5087 # of assumptions are included herein about the
5088 # coding of the plugin setup files, and things
5089 # like commented out curly braces or other
5090 # such oddities can break this in a bad way.
5092 sub build_plugin_hook_array
() {
5100 if ( open( HOOKFILE
, ">plugin_hooks.php" ) ) {
5101 print HOOKFILE
"<?php\n";
5102 print HOOKFILE
"\n";
5104 print HOOKFILE
"/**\n";
5105 print HOOKFILE
" * SquirrelMail Plugin Hook Registration File\n";
5106 print HOOKFILE
" * Auto-generated using the configure script, conf.pl\n";
5107 print HOOKFILE
" */\n";
5108 print HOOKFILE
"\n";
5109 print HOOKFILE
"global \$squirrelmail_plugin_hooks;\n";
5110 print HOOKFILE
"\n";
5112 PLUGIN
: for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
5115 print "Activating plugin \"" . $plugins[$ct] . "\"...\n";
5118 $setup_file = '../plugins/' . $plugins[$ct] . '/setup.php';
5119 if ( -e
"$setup_file" ) {
5120 # Make sure that file is readable
5121 if (! -r
"$setup_file") {
5124 print "The file \"$setup_file\" was found, but you don't\n";
5125 print "have rights to read it. The plugin \"";
5126 print $plugins[$ct] . "\" will not be activated until you fix this.\n";
5127 print "\nPress enter to continue";
5132 open( FILE
, "$setup_file" );
5133 $inside_init_fxn = 0;
5135 while ( $line = <FILE
> ) {
5137 # throw away lines until we get to target function
5139 if (!$inside_init_fxn
5140 && $line !~ /^\s*function\s*squirrelmail_plugin_init_/i) {
5143 $inside_init_fxn = 1;
5153 # count close braces
5158 # leaving <plugin>_init() function...
5159 if ($brace_count == 0) {
5167 # throw away lines that are not exactly one "brace set" deep
5169 if ($brace_count > 1) {
5174 # also not interested in lines that are not
5175 # hook registration points
5177 if ($line !~ /^\s*\$squirrelmail_plugin_hooks/i) {
5182 # if $line does not have an ending semicolon,
5183 # we need to recursively read in subsequent
5184 # lines until we find one
5185 while ( $line !~ /;\s*$/ ) {
5186 $line =~ s/[\n\r]\s*$//;
5195 $var =~ s/=/EQUALS/;
5196 if ( $var =~ /^([a-z])/i ) {
5197 @options = split ( /\s*EQUALS\s*/, $var );
5198 $options[1] =~ s/[\n\r]//g;
5199 $options[1] =~ s/[\'\"];\s*$//;
5200 $options[1] =~ s/;$//;
5201 $options[1] =~ s/^[\'\"]//;
5202 # de-escape escaped strings
5203 $options[1] =~ s/\\'/'/g;
5204 $options[1] =~ s/\\\\/\\/g;
5206 if ( $options[0] =~ /^squirrelmail_plugin_hooks\s*\[\s*['"]([a-z0-9 \/._
*-]+)['"]\s*\]\s*\[\s*['"]([0-9a-z._-]+)['"]\s
*\
]/i
) {
5208 $hooked_plugin_name = $2;
5209 # Note: if we wanted to stop plugins from registering
5210 # a *different* plugin on a hook, we could catch
5211 # it here, however this has actually proven to be
5212 # a useful *feature*
5213 #if ($hooked_plugin_name ne $plugins[$ct]) {
5214 # print "...plugin is tring to hook in under different name...\n";
5217 #FIXME: do we want to count the number of hook registrations for each plugin and warn if a plugin doesn't have any?
5218 # hook registration has been found!
5220 if ($hooked_plugin_name ne $plugins[$ct]) {
5221 print " registering on hook \"" . $hook_name . "\" (as \"$hooked_plugin_name\" plugin)\n";
5223 print " registering on hook \"" . $hook_name . "\"\n";
5226 $line =~ s/ {2,}/ /g;
5228 print HOOKFILE
"\$$line";
5240 print "The file \"$setup_file\" was not found.\n";
5241 print "The plugin \"" . $plugins[$ct];
5242 print "\" will not be activated until you fix this.\n";
5243 print "\nPress enter to continue";
5251 print HOOKFILE
"\n\n";
5254 print "\nDone activating plugins; registration data saved in plugin_hooks.php\n\n";
5261 print "The file \"plugin_hooks.php\" was not able to be written to.\n";
5262 print "No plugins will be activated until you fix this.\n";
5263 print "\nPress enter to continue";