4 # Copyright (c) 1999-2006 The SquirrelMail Project Team
5 # Licensed under the GNU GPL. For full terms see COPYING.
7 # A simple configure script to configure SquirrelMail
10 ############################################################
11 $conf_pl_version = "1.4.0";
13 ############################################################
14 # Check what directory we're supposed to be running in, and
15 # change there if necessary. File::Basename has been in
16 # Perl since at least 5.003_7, and nobody sane runs anything
17 # before that, but just in case.
18 ############################################################
20 if ( eval q{require "File/Basename.pm"} ) {
21 $dir = File
::Basename
::dirname
($0);
25 ############################################################
26 # Some people try to run this as a CGI. That's wrong!
27 ############################################################
28 if ( defined( $ENV{'PATH_INFO'} )
29 || defined( $ENV{'QUERY_STRING'} )
30 || defined( $ENV{'REQUEST_METHOD'} ) ) {
31 print "Content-Type: text/html\n\n";
32 print "You must run this script from the command line.";
36 ############################################################
37 # If we got here, use Cwd to get the full directory path
38 # (the Basename stuff above will sometimes return '.' as
39 # the base directory, which is not helpful here).
40 ############################################################
45 ############################################################
46 # First, lets read in the data already in there...
47 ############################################################
48 if ( -e
"config.php" ) {
49 open( FILE
, "config.php" );
50 while ( $line = <FILE
> ) {
56 if ( $var =~ /^([a-z])/i ) {
57 @o = split ( /\s*EQUALS\s*/, $var );
58 if ( $o[0] eq "config_version" ) {
60 $o[1] =~ s/[\'\"];\s*$//;
64 $config_version = $o[1];
71 if ( $config_version ne $conf_pl_version ) {
73 print $WHT. "WARNING:\n" . $NRM;
74 print " The file \"config/config.php\" was found, but it is for\n";
75 print " an older version of SquirrelMail. It is possible to still\n";
76 print " read the defaults from this file but be warned that many\n";
77 print " preferences change between versions. It is recommended that\n";
78 print " you start with a clean config.php for each upgrade that you\n";
79 print " do. To do this, just move config/config.php out of the way.\n";
81 print "Continue loading with the old config.php [y/N]? ";
84 if ( ( $ctu !~ /^y\n/i ) || ( $ctu =~ /^\n/ ) ) {
88 print "\nDo you want me to stop warning you [y/N]? ";
90 if ( $ctu =~ /^y\n/i ) {
91 $print_config_version = $conf_pl_version;
93 $print_config_version = $config_version;
96 $print_config_version = $config_version;
100 open( FILE
, "config.php" );
101 } elsif ( -e
"config_default.php" ) {
102 open( FILE
, "config_default.php" );
103 while ( $line = <FILE
> ) {
109 if ( $var =~ /^([a-z])/i ) {
110 @o = split ( /\s*EQUALS\s*/, $var );
111 if ( $o[0] eq "config_version" ) {
112 $o[1] =~ s/[\n\r]//g;
113 $o[1] =~ s/[\'\"];\s*$//;
115 $o[1] =~ s/^[\'\"]//;
117 $config_version = $o[1];
124 if ( $config_version ne $conf_pl_version ) {
126 print $WHT. "WARNING:\n" . $NRM;
127 print " You are trying to use a 'config_default.php' from an older\n";
128 print " version of SquirrelMail. This is HIGHLY unrecommended. You\n";
129 print " should get the 'config_default.php' that matches the version\n";
130 print " of SquirrelMail that you are running. You can get this from\n";
131 print " the SquirrelMail web page by going to the following URL:\n";
132 print " http://www.squirrelmail.org.\n";
134 print "Continue loading with old config_default.php (a bad idea) [y/N]? ";
137 if ( ( $ctu !~ /^y\n/i ) || ( $ctu =~ /^\n/ ) ) {
141 print "\nDo you want me to stop warning you [y/N]? ";
143 if ( $ctu =~ /^y\n/i ) {
144 $print_config_version = $conf_pl_version;
146 $print_config_version = $config_version;
149 $print_config_version = $config_version;
152 open( FILE
, "config_default.php" );
154 print "No configuration file found. Please get config_default.php\n";
155 print "or config.php before running this again. This program needs\n";
156 print "a default config file to get default values.\n";
160 # Read and parse the current configuration file
161 # (either config.php or config_default.php).
162 while ( $line = <FILE
> ) {
168 if ( $var =~ /^([a-z])/i ) {
169 @options = split ( /\s*EQUALS\s*/, $var );
170 $options[1] =~ s/[\n\r]//g;
171 $options[1] =~ s/[\'\"];\s*$//;
172 $options[1] =~ s/;$//;
173 $options[1] =~ s/^[\'\"]//;
174 # de-escape escaped strings
175 $options[1] =~ s/\\'/'/g;
176 $options[1] =~ s/\\\\/\\/g;
178 if ( $options[0] =~ /^theme\[[0-9]+\]\[['"]PATH['"]\]/ ) {
180 $sub =~ s/\]\[['"]PATH['"]\]//;
182 if ( -e
"../themes" ) {
183 $options[1] =~ s/^\.\.\/config/\
.\
.\
/themes/;
185 $theme_path[$sub] = &change_to_rel_path
($options[1]);
186 } elsif ( $options[0] =~ /^theme\[[0-9]+\]\[['"]NAME['"]\]/ ) {
188 $sub =~ s/\]\[['"]NAME['"]\]//;
190 $theme_name[$sub] = $options[1];
191 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]ID['"]\]/ ) {
193 $sub =~ s/\]\[['"]ID['"]\]//;
195 if ( -e
"../templates" ) {
196 $options[1] =~ s/^\.\.\/config/\
.\
.\
/templates/;
198 $templateset_id[$sub] = $options[1];
199 ##### FIXME: This section BELOW here so old prefs files don't blow up when running conf.pl
200 ##### Remove after a month or two
201 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]PATH['"]\]/ ) {
203 $sub =~ s/\]\[['"]PATH['"]\]//;
205 if ( -e
"../templates" ) {
206 $options[1] =~ s/^\.\.\/config/\
.\
.\
/templates/;
208 $templateset_id[$sub] = $options[1];
209 ##### FIXME: This section ABOVE here so old prefs files don't blow up when running conf.pl
210 ##### Remove after a month or two
211 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]NAME['"]\]/ ) {
213 $sub =~ s/\]\[['"]NAME['"]\]//;
215 $templateset_name[$sub] = $options[1];
216 } elsif ( $options[0] =~ /^plugins\[[0-9]*\]/ ) {
219 $sub =~ s/^plugins\[//;
221 push @plugins, $options[1];
223 $plugins[$sub] = $options[1];
225 } elsif ($options[0] =~ /^fontsets\[\'[a-z]*\'\]/) {
226 # parse associative $fontsets array
229 $sub =~ s/^fontsets\[\'//;
230 $fontsets{$sub} = $options[1];
231 } elsif ( $options[0] =~ /^ldap_server\[[0-9]+\]/ ) {
234 $sub =~ s/^ldap_server\[//;
236 while ( ( $tmp = <FILE
> ) && ( $continue != 1 ) ) {
237 if ( $tmp =~ /\);\s*$/ ) {
241 if ( $tmp =~ /^\s*[\'\"]host[\'\"]/i ) {
242 $tmp =~ s/^\s*[\'\"]host[\'\"]\s*=>\s*[\'\"]//i;
243 $tmp =~ s/[\'\"],?\s*$//;
244 $tmp =~ s/[\'\"]\);\s*$//;
246 } elsif ( $tmp =~ /^\s*[\'\"]base[\'\"]/i ) {
247 $tmp =~ s/^\s*[\'\"]base[\'\"]\s*=>\s*[\'\"]//i;
248 $tmp =~ s/[\'\"],?\s*$//;
249 $tmp =~ s/[\'\"]\);\s*$//;
251 } elsif ( $tmp =~ /^\s*[\'\"]charset[\'\"]/i ) {
252 $tmp =~ s/^\s*[\'\"]charset[\'\"]\s*=>\s*[\'\"]//i;
253 $tmp =~ s/[\'\"],?\s*$//;
254 $tmp =~ s/[\'\"]\);\s*$//;
256 } elsif ( $tmp =~ /^\s*[\'\"]port[\'\"]/i ) {
257 $tmp =~ s/^\s*[\'\"]port[\'\"]\s*=>\s*[\'\"]?//i;
258 $tmp =~ s/[\'\"]?,?\s*$//;
259 $tmp =~ s/[\'\"]?\);\s*$//;
261 } elsif ( $tmp =~ /^\s*[\'\"]maxrows[\'\"]/i ) {
262 $tmp =~ s/^\s*[\'\"]maxrows[\'\"]\s*=>\s*[\'\"]?//i;
263 $tmp =~ s/[\'\"]?,?\s*$//;
264 $tmp =~ s/[\'\"]?\);\s*$//;
266 } elsif ( $tmp =~ /^\s*[\'\"]filter[\'\"]/i ) {
267 $tmp =~ s/^\s*[\'\"]filter[\'\"]\s*=>\s*[\'\"]?//i;
268 $tmp =~ s/[\'\"]?,?\s*$//;
269 $tmp =~ s/[\'\"]?\);\s*$//;
271 } elsif ( $tmp =~ /^\s*[\'\"]name[\'\"]/i ) {
272 $tmp =~ s/^\s*[\'\"]name[\'\"]\s*=>\s*[\'\"]//i;
273 $tmp =~ s/[\'\"],?\s*$//;
274 $tmp =~ s/[\'\"]\);\s*$//;
276 } elsif ( $tmp =~ /^\s*[\'\"]binddn[\'\"]/i ) {
277 $tmp =~ s/^\s*[\'\"]binddn[\'\"]\s*=>\s*[\'\"]//i;
278 $tmp =~ s/[\'\"],?\s*$//;
279 $tmp =~ s/[\'\"]\);\s*$//;
281 } elsif ( $tmp =~ /^\s*[\'\"]bindpw[\'\"]/i ) {
282 $tmp =~ s/^\s*[\'\"]bindpw[\'\"]\s*=>\s*[\'\"]//i;
283 $tmp =~ s/[\'\"],?\s*$//;
284 $tmp =~ s/[\'\"]\);\s*$//;
286 } elsif ( $tmp =~ /^\s*[\'\"]protocol[\'\"]/i ) {
287 $tmp =~ s/^\s*[\'\"]protocol[\'\"]\s*=>\s*[\'\"]?//i;
288 $tmp =~ s/[\'\"]?,?\s*$//;
289 $tmp =~ s/[\'\"]?\);\s*$//;
291 } elsif ( $tmp =~ /^\s*[\'\"]limit_scope[\'\"]/i ) {
292 $tmp =~ s/^\s*[\'\"]limit_scope[\'\"]\s*=>\s*[\'\"]?//i;
293 $tmp =~ s/[\'\"]?,?\s*$//;
294 $tmp =~ s/[\'\"]?\);\s*$//;
296 } elsif ( $tmp =~ /^\s*[\'\"]listing[\'\"]/i ) {
297 $tmp =~ s/^\s*[\'\"]listing[\'\"]\s*=>\s*[\'\"]?//i;
298 $tmp =~ s/[\'\"]?,?\s*$//;
299 $tmp =~ s/[\'\"]?\);\s*$//;
301 } elsif ( $tmp =~ /^\s*[\'\"]writeable[\'\"]/i ) {
302 $tmp =~ s/^\s*[\'\"]writeable[\'\"]\s*=>\s*[\'\"]?//i;
303 $tmp =~ s/[\'\"]?,?\s*$//;
304 $tmp =~ s/[\'\"]?\);\s*$//;
306 } elsif ( $tmp =~ /^\s*[\'\"]search_tree[\'\"]/i ) {
307 $tmp =~ s/^\s*[\'\"]search_tree[\'\"]\s*=>\s*[\'\"]?//i;
308 $tmp =~ s/[\'\"]?,?\s*$//;
309 $tmp =~ s/[\'\"]?\);\s*$//;
311 } elsif ( $tmp =~ /^\s*[\'\"]starttls[\'\"]/i ) {
312 $tmp =~ s/^\s*[\'\"]starttls[\'\"]\s*=>\s*[\'\"]?//i;
313 $tmp =~ s/[\'\"]?,?\s*$//;
314 $tmp =~ s/[\'\"]?\);\s*$//;
318 $ldap_host[$sub] = $host;
319 $ldap_base[$sub] = $base;
320 $ldap_name[$sub] = $name;
321 $ldap_port[$sub] = $port;
322 $ldap_maxrows[$sub] = $maxrows;
323 $ldap_filter[$sub] = $filter;
324 $ldap_charset[$sub] = $charset;
325 $ldap_binddn[$sub] = $binddn;
326 $ldap_bindpw[$sub] = $bindpw;
327 $ldap_protocol[$sub] = $protocol;
328 $ldap_limit_scope[$sub] = $limit_scope;
329 $ldap_listing[$sub] = $listing;
330 $ldap_writeable[$sub] = $writeable;
331 $ldap_search_tree[$sub] = $search_tree;
332 $ldap_starttls[$sub] = $starttls;
333 } elsif ( $options[0] =~ /^(data_dir|attachment_dir|theme_css|org_logo|signout_page|icon_theme_def)$/ ) {
334 ${ $options[0] } = &change_to_rel_path
($options[1]);
336 ${ $options[0] } = $options[1];
342 # FIXME: unknown introduction date
343 $useSendmail = 'false' if ( lc($useSendmail) ne 'true' );
344 $sendmail_path = "/usr/sbin/sendmail" if ( !$sendmail_path );
345 $pop_before_smtp = 'false' if ( !$pop_before_smtp );
346 $default_unseen_notify = 2 if ( !$default_unseen_notify );
347 $default_unseen_type = 1 if ( !$default_unseen_type );
348 $config_use_color = 0 if ( !$config_use_color );
349 $invert_time = 'false' if ( !$invert_time );
350 $force_username_lowercase = 'false' if ( !$force_username_lowercase );
351 $optional_delimiter = "detect" if ( !$optional_delimiter );
352 $auto_create_special = 'false' if ( !$auto_create_special );
353 $default_use_priority = 'true' if ( !$default_use_priority );
354 $default_use_mdn = 'true' if ( !$default_use_mdn );
355 $delete_folder = 'false' if ( !$delete_folder );
356 $noselect_fix_enable = 'false' if ( !$noselect_fix_enable );
357 $frame_top = "_top" if ( !$frame_top );
358 $provider_uri = '' if ( !$provider_uri );
359 $provider_name = '' if ( !$provider_name );
360 $no_list_for_subscribe = 'false' if ( !$no_list_for_subscribe );
361 $allow_charset_search = 'true' if ( !$allow_charset_search );
362 $allow_advanced_search = 0 if ( !$allow_advanced_search) ;
363 $prefs_user_field = 'user' if ( !$prefs_user_field );
364 $prefs_key_field = 'prefkey' if ( !$prefs_key_field );
365 $prefs_val_field = 'prefval' if ( !$prefs_val_field );
366 $session_name = 'SQMSESSID' if ( !$session_name );
367 $skip_SM_header = 'false' if ( !$skip_SM_header );
368 $default_use_javascript_addr_book = 'false' if (! $default_use_javascript_addr_book);
371 $hide_sm_attributions = 'false' if ( !$hide_sm_attributions );
373 $edit_identity = 'true' if ( !$edit_identity );
374 $edit_name = 'true' if ( !$edit_name );
377 $use_smtp_tls= 'false' if ( !$use_smtp_tls);
378 $smtp_auth_mech = 'none' if ( !$smtp_auth_mech );
379 $use_imap_tls = 'false' if ( !$use_imap_tls );
380 $imap_auth_mech = 'login' if ( !$imap_auth_mech );
383 $show_alternative_names = 'false' if ( !$show_alternative_names );
384 # $available_languages option available only in 1.5.0. removed due to $languages
385 # implementation changes. options are provided by limit_languages plugin
386 # $available_languages = 'all' if ( !$available_languages );
387 $aggressive_decoding = 'false' if ( !$aggressive_decoding );
388 # available only in 1.5.0 and 1.5.1
389 # $advanced_tree = 'false' if ( !$advanced_tree );
390 $use_php_recode = 'false' if ( !$use_php_recode );
391 $use_php_iconv = 'false' if ( !$use_php_iconv );
394 $use_icons = 'false' if ( !$use_icons );
395 $use_iframe = 'false' if ( !$use_iframe );
396 $lossy_encoding = 'false' if ( !$lossy_encoding );
397 $allow_remote_configtest = 'false' if ( !$allow_remote_configtest );
398 $addrbook_global_table = 'global_abook' if ( !$addrbook_global_table );
399 $addrbook_global_writeable = 'false' if ( !$addrbook_global_writeable );
400 $addrbook_global_listing = 'false' if ( !$addrbook_global_listing );
401 $abook_global_file = '' if ( !$abook_global_file);
402 $abook_global_file_writeable = 'false' if ( !$abook_global_file_writeable);
403 $abook_global_file_listing = 'true' if ( !$abook_global_file_listing );
404 $encode_header_key = '' if ( !$encode_header_key );
405 $hide_auth_header = 'false' if ( !$hide_auth_header );
406 $time_zone_type = '0' if ( !$time_zone_type );
407 $prefs_user_size = 128 if ( !$prefs_user_size );
408 $prefs_key_size = 64 if ( !$prefs_key_size );
409 $prefs_val_size = 65536 if ( !$prefs_val_size );
412 $icon_theme_def = '' if ( !$icon_theme_def );
414 # add qmail-inject test here for backwards compatibility
415 if ( !$sendmail_args && $sendmail_path =~ /qmail-inject/ ) {
417 } elsif ( !$sendmail_args ) {
418 $sendmail_args = '-i -t';
421 $default_fontsize = '' if ( !$default_fontsize);
422 $default_fontset = '' if ( !$default_fontset);
424 %fontsets = ('serif', 'serif',
425 'sans', 'helvetica,arial,sans-serif',
426 'comicsans', 'comic sans ms,sans-serif',
427 'tahoma', 'tahoma,sans-serif',
428 'verasans', 'bitstream vera sans,verdana,sans-serif');
431 # $use_imap_tls and $use_smtp_tls are switched to integer since 1.5.1
432 $use_imap_tls = 0 if ( $use_imap_tls eq 'false');
433 $use_imap_tls = 1 if ( $use_imap_tls eq 'true');
434 $use_smtp_tls = 0 if ( $use_smtp_tls eq 'false');
435 $use_smtp_tls = 1 if ( $use_smtp_tls eq 'true');
436 # sorting options changed names and reversed values in 1.5.1
437 $disable_thread_sort = 'false' if ( !$disable_thread_sort );
438 $disable_server_sort = 'false' if ( !$disable_server_sort );
441 $abook_file_line_length = 2048 if ( !$abook_file_line_length );
442 $config_location_base = '' if ( !$config_location_base );
443 $smtp_sitewide_user = '' if ( !$smtp_sitewide_user );
444 $smtp_sitewide_pass = '' if ( !$smtp_sitewide_pass );
446 if ( $ARGV[0] eq '--install-plugin' ) {
447 print "Activating plugin " . $ARGV[1] . "\n";
448 push @plugins, $ARGV[1];
451 } elsif ( $ARGV[0] eq '--remove-plugin' ) {
452 print "Removing plugin " . $ARGV[1] . "\n";
453 foreach $plugin (@plugins) {
454 if ( $plugin ne $ARGV[1] ) {
455 push @newplugins, $plugin;
458 @plugins = @newplugins;
463 #####################################################################################
464 if ( $config_use_color == 1 ) {
470 $config_use_color = 2;
473 while ( ( $command ne "q" ) && ( $command ne "Q" ) && ( $command ne ":q" ) ) {
475 print $WHT. "SquirrelMail Configuration : " . $NRM;
476 if ( $config == 1 ) { print "Read: config.php"; }
477 elsif ( $config == 2 ) { print "Read: config_default.php"; }
478 print " ($print_config_version)\n";
479 print "---------------------------------------------------------\n";
482 print $WHT. "Main Menu --\n" . $NRM;
483 print "1. Organization Preferences\n";
484 print "2. Server Settings\n";
485 print "3. Folder Defaults\n";
486 print "4. General Options\n";
487 print "5. User Interface\n";
488 print "6. Address Books\n";
489 print "7. Message of the Day (MOTD)\n";
490 print "8. Plugins\n";
491 print "9. Database\n";
492 print "10. Language settings\n";
493 print "11. Tweaks\n";
495 print "D. Set pre-defined settings for specific IMAP servers\n";
497 } elsif ( $menu == 1 ) {
498 print $WHT. "Organization Preferences\n" . $NRM;
499 print "1. Organization Name : $WHT$org_name$NRM\n";
500 print "2. Organization Logo : $WHT$org_logo$NRM\n";
501 print "3. Org. Logo Width/Height : $WHT($org_logo_width/$org_logo_height)$NRM\n";
502 print "4. Organization Title : $WHT$org_title$NRM\n";
503 print "5. Signout Page : $WHT$signout_page$NRM\n";
504 print "6. Top Frame : $WHT$frame_top$NRM\n";
505 print "7. Provider link : $WHT$provider_uri$NRM\n";
506 print "8. Provider name : $WHT$provider_name$NRM\n";
509 print "R Return to Main Menu\n";
510 } elsif ( $menu == 2 ) {
511 print $WHT. "Server Settings\n\n" . $NRM;
512 print $WHT . "General" . $NRM . "\n";
514 print "1. Domain : $WHT$domain$NRM\n";
515 print "2. Invert Time : $WHT$invert_time$NRM\n";
516 print "3. Sendmail or SMTP : $WHT";
517 if ( lc($useSendmail) eq 'true' ) {
525 if ( $show_imap_settings ) {
526 print $WHT . "IMAP Settings". $NRM . "\n--------------\n";
527 print "4. IMAP Server : $WHT$imapServerAddress$NRM\n";
528 print "5. IMAP Port : $WHT$imapPort$NRM\n";
529 print "6. Authentication type : $WHT$imap_auth_mech$NRM\n";
530 print "7. Secure IMAP (TLS) : $WHT" . display_use_tls
($use_imap_tls) . "$NRM\n";
531 print "8. Server software : $WHT$imap_server_type$NRM\n";
532 print "9. Delimiter : $WHT$optional_delimiter$NRM\n";
534 } elsif ( $show_smtp_settings ) {
535 if ( lc($useSendmail) eq 'true' ) {
536 print $WHT . "Sendmail" . $NRM . "\n--------\n";
537 print "4. Sendmail Path : $WHT$sendmail_path$NRM\n";
538 print "5. Sendmail arguments : $WHT$sendmail_args$NRM\n";
539 print "6. Header encryption key : $WHT$encode_header_key$NRM\n";
542 print $WHT . "SMTP Settings" . $NRM . "\n-------------\n";
543 print "4. SMTP Server : $WHT$smtpServerAddress$NRM\n";
544 print "5. SMTP Port : $WHT$smtpPort$NRM\n";
545 print "6. POP before SMTP : $WHT$pop_before_smtp$NRM\n";
546 print "7. SMTP Authentication : $WHT$smtp_auth_mech" . display_smtp_sitewide_userpass
() ."$NRM\n";
547 print "8. Secure SMTP (TLS) : $WHT" . display_use_tls
($use_smtp_tls) . "$NRM\n";
548 print "9. Header encryption key : $WHT$encode_header_key$NRM\n";
553 if ($show_imap_settings == 0) {
554 print "A. Update IMAP Settings : ";
555 print "$WHT$imapServerAddress$NRM:";
556 print "$WHT$imapPort$NRM ";
557 print "($WHT$imap_server_type$NRM)\n";
559 if ($show_smtp_settings == 0) {
560 if ( lc($useSendmail) eq 'true' ) {
561 print "B. Change Sendmail Config : $WHT$sendmail_path$NRM\n";
563 print "B. Update SMTP Settings : ";
564 print "$WHT$smtpServerAddress$NRM:";
565 print "$WHT$smtpPort$NRM\n";
568 if ( $show_smtp_settings || $show_imap_settings )
571 ($show_imap_settings ?
"IMAP Server" :
572 (lc($useSendmail) eq 'true') ?
"Sendmail" : "SMTP") . " Settings\n";
576 print "R Return to Main Menu\n";
577 } elsif ( $menu == 3 ) {
578 print $WHT. "Folder Defaults\n" . $NRM;
579 print "1. Default Folder Prefix : $WHT$default_folder_prefix$NRM\n";
580 print "2. Show Folder Prefix Option : $WHT$show_prefix_option$NRM\n";
581 print "3. Trash Folder : $WHT$trash_folder$NRM\n";
582 print "4. Sent Folder : $WHT$sent_folder$NRM\n";
583 print "5. Drafts Folder : $WHT$draft_folder$NRM\n";
584 print "6. By default, move to trash : $WHT$default_move_to_trash$NRM\n";
585 print "7. By default, move to sent : $WHT$default_move_to_sent$NRM\n";
586 print "8. By default, save as draft : $WHT$default_save_as_draft$NRM\n";
587 print "9. List Special Folders First : $WHT$list_special_folders_first$NRM\n";
588 print "10. Show Special Folders Color : $WHT$use_special_folder_color$NRM\n";
589 print "11. Auto Expunge : $WHT$auto_expunge$NRM\n";
590 print "12. Default Sub. of INBOX : $WHT$default_sub_of_inbox$NRM\n";
591 print "13. Show 'Contain Sub.' Option : $WHT$show_contain_subfolders_option$NRM\n";
592 print "14. Default Unseen Notify : $WHT$default_unseen_notify$NRM\n";
593 print "15. Default Unseen Type : $WHT$default_unseen_type$NRM\n";
594 print "16. Auto Create Special Folders : $WHT$auto_create_special$NRM\n";
595 print "17. Folder Delete Bypasses Trash : $WHT$delete_folder$NRM\n";
596 print "18. Enable /NoSelect folder fix : $WHT$noselect_fix_enable$NRM\n";
598 print "R Return to Main Menu\n";
599 } elsif ( $menu == 4 ) {
600 print $WHT. "General Options\n" . $NRM;
601 print "1. Data Directory : $WHT$data_dir$NRM\n";
602 print "2. Attachment Directory : $WHT$attachment_dir$NRM\n";
603 print "3. Directory Hash Level : $WHT$dir_hash_level$NRM\n";
604 print "4. Default Left Size : $WHT$default_left_size$NRM\n";
605 print "5. Usernames in Lowercase : $WHT$force_username_lowercase$NRM\n";
606 print "6. Allow use of priority : $WHT$default_use_priority$NRM\n";
607 print "7. Hide SM attributions : $WHT$hide_sm_attributions$NRM\n";
608 print "8. Allow use of receipts : $WHT$default_use_mdn$NRM\n";
609 print "9. Allow editing of identity : $WHT$edit_identity$NRM\n";
610 print " Allow editing of name : $WHT$edit_name$NRM\n";
611 print " Remove username from header : $WHT$hide_auth_header$NRM\n";
612 print "10. Disable server thread sort : $WHT$disable_thread_sort$NRM\n";
613 print "11. Disable server-side sorting : $WHT$disable_server_sort$NRM\n";
614 print "12. Allow server charset search : $WHT$allow_charset_search$NRM\n";
615 print "13. Allow advanced search : $WHT$allow_advanced_search$NRM\n";
616 print "14. PHP session name : $WHT$session_name$NRM\n";
617 print "15. Time zone configuration : $WHT$time_zone_type$NRM\n";
618 print "16. Location base : $WHT$config_location_base$NRM\n";
620 print "R Return to Main Menu\n";
621 } elsif ( $menu == 5 ) {
622 print $WHT. "User Interface\n" . $NRM;
623 print "1. Modify Template sets\n";
624 print "2. Use Icons : $WHT$use_icons$NRM\n";
625 print "3. Default Icon Set : $WHT$icon_theme_def$NRM\n";
626 print "4. Default font size : $WHT$default_fontsize$NRM\n";
627 print "5. Modify available font sets\n";
628 # print "4. Change Themes\n";
631 print "R Return to Main Menu\n";
632 } elsif ( $menu == 6 ) {
633 print $WHT. "Address Books\n" . $NRM;
634 print "1. Change LDAP Servers\n";
635 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
636 print " > $ldap_host[$count]\n";
638 print "2. Use Javascript address book search : $WHT$default_use_javascript_addr_book$NRM\n";
639 print "3. Global address book file : $WHT$abook_global_file$NRM\n";
640 print "4. Allow writing into global file address book : $WHT$abook_global_file_writeable$NRM\n";
641 print "5. Allow listing of global file address book : $WHT$abook_global_file_listing$NRM\n";
642 print "6. Allowed address book line length : $WHT$abook_file_line_length$NRM\n";
644 print "R Return to Main Menu\n";
645 } elsif ( $menu == 7 ) {
646 print $WHT. "Message of the Day (MOTD)\n" . $NRM;
649 print "1 Edit the MOTD\n";
651 print "R Return to Main Menu\n";
652 } elsif ( $menu == 8 ) {
653 print $WHT. "Plugins\n" . $NRM;
654 print " Installed Plugins\n";
656 for ( $count = 0 ; $count <= $#plugins ; $count++ ) {
658 print " $num. $plugins[$count]\n";
660 print "\n Available Plugins:\n";
661 opendir( DIR
, "../plugins" );
662 @files = readdir(DIR
);
664 @unused_plugins = ();
665 for ( $i = 0 ; $i <= $#files ; $i++ ) {
666 if ( -d
"../plugins/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne "CVS" ) {
668 for ( $k = 0 ; $k <= $#plugins ; $k++ ) {
669 if ( $plugins[$k] eq $files[$i] ) {
674 $unused_plugins[$pos] = $files[$i];
680 for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
682 print " $num. $unused_plugins[$i]\n";
687 print "R Return to Main Menu\n";
688 } elsif ( $menu == 9 ) {
689 print $WHT. "Database\n" . $NRM;
690 print "1. DSN for Address Book : $WHT$addrbook_dsn$NRM\n";
691 print "2. Table for Address Book : $WHT$addrbook_table$NRM\n";
693 print "3. DSN for Preferences : $WHT$prefs_dsn$NRM\n";
694 print "4. Table for Preferences : $WHT$prefs_table$NRM\n";
695 print "5. Field for username : $WHT$prefs_user_field$NRM ($prefs_user_size)\n";
696 print "6. Field for prefs key : $WHT$prefs_key_field$NRM ($prefs_key_size)\n";
697 print "7. Field for prefs value : $WHT$prefs_val_field$NRM ($prefs_val_size)\n";
699 print "8. DSN for Global Address Book : $WHT$addrbook_global_dsn$NRM\n";
700 print "9. Table for Global Address Book : $WHT$addrbook_global_table$NRM\n";
701 print "10. Allow writing into Global Address Book : $WHT$addrbook_global_writeable$NRM\n";
702 print "11. Allow listing of Global Address Book : $WHT$addrbook_global_listing$NRM\n";
704 print "R Return to Main Menu\n";
705 } elsif ( $menu == 10 ) {
706 print $WHT. "Language settings\n" . $NRM;
707 print "1. Default Language : $WHT$squirrelmail_default_language$NRM\n";
708 print "2. Default Charset : $WHT$default_charset$NRM\n";
709 print "3. Show alternative language names : $WHT$show_alternative_names$NRM\n";
710 print "4. Enable aggressive decoding : $WHT$aggressive_decoding$NRM\n";
711 print "5. Enable lossy encoding : $WHT$lossy_encoding$NRM\n";
713 print "R Return to Main Menu\n";
714 } elsif ( $menu == 11 ) {
715 print $WHT. "Interface tweaks\n" . $NRM;
716 print "1. Display html mails in iframe : $WHT$use_iframe$NRM\n";
718 print $WHT. "PHP tweaks\n" . $NRM;
719 print "4. Use php recode functions : $WHT$use_php_recode$NRM\n";
720 print "5. Use php iconv functions : $WHT$use_php_iconv$NRM\n";
722 print $WHT. "Configuration tweaks\n" . $NRM;
723 print "6. Allow remote configtest : $WHT$allow_remote_configtest$NRM\n";
725 print "R Return to Main Menu\n";
727 if ( $config_use_color == 1 ) {
728 print "C Turn color off\n";
730 print "C Turn color on\n";
732 print "S Save data\n";
736 print "Command >> " . $WHT;
738 $command =~ s/[\n\r]//g;
739 $command =~ tr/A-Z/a-z/;
742 # Read the commands they entered.
743 if ( $command eq "r" ) {
745 } elsif ( $command eq "s" ) {
747 print "Press enter to continue...";
750 } elsif ( ( $command eq "q" ) && ( $saved == 0 ) ) {
751 print "You have not saved your data.\n";
752 print "Save? [" . $WHT . "Y" . $NRM . "/n]: ";
754 if ( ( $save =~ /^y/i ) || ( $save =~ /^\s*$/ ) ) {
757 } elsif ( $command eq "c" ) {
758 if ( $config_use_color == 1 ) {
759 $config_use_color = 2;
763 $config_use_color = 1;
767 } elsif ( $command eq "d" && $menu == 0 ) {
772 if ( ( $command > 0 ) && ( $command < 12 ) ) {
775 } elsif ( $menu == 1 ) {
776 if ( $command == 1 ) { $org_name = command1
(); }
777 elsif ( $command == 2 ) { $org_logo = command2
(); }
778 elsif ( $command == 3 ) { ($org_logo_width,$org_logo_height) = command2a
(); }
779 elsif ( $command == 4 ) { $org_title = command3
(); }
780 elsif ( $command == 5 ) { $signout_page = command4
(); }
781 elsif ( $command == 6 ) { $frame_top = command6
(); }
782 elsif ( $command == 7 ) { $provider_uri = command7
(); }
783 elsif ( $command == 8 ) { $provider_name = command8
(); }
785 } elsif ( $menu == 2 ) {
786 if ( $command eq "a" ) { $show_imap_settings = 1; $show_smtp_settings = 0; }
787 elsif ( $command eq "b" ) { $show_imap_settings = 0; $show_smtp_settings = 1; }
788 elsif ( $command eq "h" ) { $show_imap_settings = 0; $show_smtp_settings = 0; }
789 elsif ( $command <= 3 ) {
790 if ( $command == 1 ) { $domain = command11
(); }
791 elsif ( $command == 2 ) { $invert_time = command110
(); }
792 elsif ( $command == 3 ) { $useSendmail = command14
(); }
793 $show_imap_settings = 0; $show_smtp_settings = 0;
794 } elsif ( $show_imap_settings ) {
795 if ( $command == 4 ) { $imapServerAddress = command12
(); }
796 elsif ( $command == 5 ) { $imapPort = command13
(); }
797 elsif ( $command == 6 ) { $imap_auth_mech = command112a
(); }
798 elsif ( $command == 7 ) { $use_imap_tls = command_use_tls
("IMAP",$use_imap_tls); }
799 elsif ( $command == 8 ) { $imap_server_type = command19
(); }
800 elsif ( $command == 9 ) { $optional_delimiter = command111
(); }
801 } elsif ( $show_smtp_settings && lc($useSendmail) eq 'true' ) {
802 if ( $command == 4 ) { $sendmail_path = command15
(); }
803 elsif ( $command == 5 ) { $sendmail_args = command_sendmail_args
(); }
804 elsif ( $command == 6 ) { $encode_header_key = command114
(); }
805 } elsif ( $show_smtp_settings ) {
806 if ( $command == 4 ) { $smtpServerAddress = command16
(); }
807 elsif ( $command == 5 ) { $smtpPort = command17
(); }
808 elsif ( $command == 6 ) { $pop_before_smtp = command18a
(); }
809 elsif ( $command == 7 ) { $smtp_auth_mech = command112b
(); }
810 elsif ( $command == 8 ) { $use_smtp_tls = command_use_tls
("SMTP",$use_smtp_tls); }
811 elsif ( $command == 9 ) { $encode_header_key = command114
(); }
813 } elsif ( $menu == 3 ) {
814 if ( $command == 1 ) { $default_folder_prefix = command21
(); }
815 elsif ( $command == 2 ) { $show_prefix_option = command22
(); }
816 elsif ( $command == 3 ) { $trash_folder = command23a
(); }
817 elsif ( $command == 4 ) { $sent_folder = command23b
(); }
818 elsif ( $command == 5 ) { $draft_folder = command23c
(); }
819 elsif ( $command == 6 ) { $default_move_to_trash = command24a
(); }
820 elsif ( $command == 7 ) { $default_move_to_sent = command24b
(); }
821 elsif ( $command == 8 ) { $default_save_as_draft = command24c
(); }
822 elsif ( $command == 9 ) { $list_special_folders_first = command27
(); }
823 elsif ( $command == 10 ) { $use_special_folder_color = command28
(); }
824 elsif ( $command == 11 ) { $auto_expunge = command29
(); }
825 elsif ( $command == 12 ) { $default_sub_of_inbox = command210
(); }
826 elsif ( $command == 13 ) { $show_contain_subfolders_option = command211
(); }
827 elsif ( $command == 14 ) { $default_unseen_notify = command212
(); }
828 elsif ( $command == 15 ) { $default_unseen_type = command213
(); }
829 elsif ( $command == 16 ) { $auto_create_special = command214
(); }
830 elsif ( $command == 17 ) { $delete_folder = command215
(); }
831 elsif ( $command == 18 ) { $noselect_fix_enable = command216
(); }
832 } elsif ( $menu == 4 ) {
833 if ( $command == 1 ) { $data_dir = command33a
(); }
834 elsif ( $command == 2 ) { $attachment_dir = command33b
(); }
835 elsif ( $command == 3 ) { $dir_hash_level = command33c
(); }
836 elsif ( $command == 4 ) { $default_left_size = command35
(); }
837 elsif ( $command == 5 ) { $force_username_lowercase = command36
(); }
838 elsif ( $command == 6 ) { $default_use_priority = command37
(); }
839 elsif ( $command == 7 ) { $hide_sm_attributions = command38
(); }
840 elsif ( $command == 8 ) { $default_use_mdn = command39
(); }
841 elsif ( $command == 9 ) { $edit_identity = command310
(); }
842 elsif ( $command == 10 ) { $disable_thread_sort = command312
(); }
843 elsif ( $command == 11 ) { $disable_server_sort = command313
(); }
844 elsif ( $command == 12 ) { $allow_charset_search = command314
(); }
845 elsif ( $command == 13 ) { $allow_advanced_search = command316
(); }
846 elsif ( $command == 14 ) { $session_name = command317
(); }
847 elsif ( $command == 15 ) { $time_zone_type = command318
(); }
848 elsif ( $command == 16 ) { $config_location_base = command_config_location_base
(); }
849 } elsif ( $menu == 5 ) {
850 if ( $command == 1 ) { $templateset_default = command_templates
(); }
851 elsif ( $command == 2 ) { $use_icons = commandB3
(); }
852 elsif ( $command == 3 ) { $icon_theme_def = commandB7
(); }
853 elsif ( $command == 4 ) { $default_fontsize = command_default_fontsize
(); }
854 elsif ( $command == 5 ) { command_fontsets
(); }
855 } elsif ( $menu == 6 ) {
856 if ( $command == 1 ) { command61
(); }
857 elsif ( $command == 2 ) { command62
(); }
858 elsif ( $command == 3 ) { $abook_global_file=command63
(); }
859 elsif ( $command == 4 ) { command64
(); }
860 elsif ( $command == 5 ) { command65
(); }
861 elsif ( $command == 6 ) { command_abook_file_line_length
(); }
862 } elsif ( $menu == 7 ) {
863 if ( $command == 1 ) { $motd = command71
(); }
864 } elsif ( $menu == 8 ) {
865 if ( $command =~ /^[0-9]+/ ) { @plugins = command81
(); }
866 } elsif ( $menu == 9 ) {
867 if ( $command == 1 ) { $addrbook_dsn = command91
(); }
868 elsif ( $command == 2 ) { $addrbook_table = command92
(); }
869 elsif ( $command == 3 ) { $prefs_dsn = command93
(); }
870 elsif ( $command == 4 ) { $prefs_table = command94
(); }
871 elsif ( $command == 5 ) { $prefs_user_field = command95
(); }
872 elsif ( $command == 6 ) { $prefs_key_field = command96
(); }
873 elsif ( $command == 7 ) { $prefs_val_field = command97
(); }
874 elsif ( $command == 8 ) { $addrbook_global_dsn = command98
(); }
875 elsif ( $command == 9 ) { $addrbook_global_table = command99
(); }
876 elsif ( $command == 10 ) { $addrbook_global_writeable = command910
(); }
877 elsif ( $command == 11 ) { $addrbook_global_listing = command911
(); }
878 } elsif ( $menu == 10 ) {
879 if ( $command == 1 ) { $squirrelmail_default_language = commandA1
(); }
880 elsif ( $command == 2 ) { $default_charset = commandA2
(); }
881 elsif ( $command == 3 ) { $show_alternative_names = commandA3
(); }
882 elsif ( $command == 4 ) { $aggressive_decoding = commandA4
(); }
883 elsif ( $command == 5 ) { $lossy_encoding = commandA5
(); }
884 } elsif ( $menu == 11 ) {
885 if ( $command == 1 ) { $use_iframe = commandB2
(); }
886 elsif ( $command == 4 ) { $use_php_recode = commandB4
(); }
887 elsif ( $command == 5 ) { $use_php_iconv = commandB5
(); }
888 elsif ( $command == 6 ) { $allow_remote_configtest = commandB6
(); }
894 print "\nExiting conf.pl.\n".
895 "You might want to test your configuration by browsing to\n".
896 "http://your-squirrelmail-location/src/configtest.php\n".
897 "Happy SquirrelMailing!\n\n";
900 ####################################################################################
904 print "We have tried to make the name SquirrelMail as transparent as\n";
905 print "possible. If you set up an organization name, most places where\n";
906 print "SquirrelMail would take credit will be credited to your organization.\n";
908 print "If your Organization Name includes a '\$', please precede it with a \\. \n";
909 print "Other '\$' will be considered the beginning of a variable that\n";
910 print "must be defined before the \$org_name is printed.\n";
912 print "[$WHT$org_name$NRM]: $WHT";
913 $new_org_name = <STDIN
>;
914 if ( $new_org_name eq "\n" ) {
915 $new_org_name = $org_name;
917 $new_org_name =~ s/[\r\n]//g;
918 $new_org_name =~ s/\"/"/g;
920 return $new_org_name;
925 print "Your organization's logo is an image that will be displayed at\n";
926 print "different times throughout SquirrelMail. ";
928 print "Please be aware of the following: \n";
929 print " - Relative URLs are relative to the config dir\n";
930 print " to use the default logo, use ../images/sm_logo.png\n";
931 print " - To specify a logo defined outside the SquirrelMail source tree\n";
932 print " use the absolute URL the webserver would use to include the file\n";
933 print " e.g. http://www.example.com/images/mylogo.gif or /images/mylogo.jpg\n";
935 print "[$WHT$org_logo$NRM]: $WHT";
936 $new_org_logo = <STDIN
>;
937 if ( $new_org_logo eq "\n" ) {
938 $new_org_logo = $org_logo;
940 $new_org_logo =~ s/[\r\n]//g;
942 return $new_org_logo;
947 print "Your organization's logo is an image that will be displayed at\n";
948 print "different times throughout SquirrelMail. Width\n";
949 print "and Height of your logo image. Use '0' to disable.\n";
951 print "Width: [$WHT$org_logo_width$NRM]: $WHT";
952 $new_org_logo_width = <STDIN
>;
953 $new_org_logo_width =~ tr/0-9//cd; # only want digits!
954 if ( $new_org_logo_width eq '' ) {
955 $new_org_logo_width = $org_logo_width;
957 if ( $new_org_logo_width > 0 ) {
958 print "Height: [$WHT$org_logo_height$NRM]: $WHT";
959 $new_org_logo_height = <STDIN
>;
960 $new_org_logo_height =~ tr/0-9//cd; # only want digits!
961 if( $new_org_logo_height eq '' ) {
962 $new_org_logo_height = $org_logo_height;
965 $new_org_logo_height = 0;
967 return ($new_org_logo_width, $new_org_logo_height);
972 print "A title is what is displayed at the top of the browser window in\n";
973 print "the titlebar. Usually this will end up looking something like:\n";
974 print "\"Netscape: $org_title\"\n";
976 print "If your Organization Title includes a '\$', please precede it with a \\. \n";
977 print "Other '\$' will be considered the beginning of a variable that\n";
978 print "must be defined before the \$org_title is printed.\n";
980 print "[$WHT$org_title$NRM]: $WHT";
981 $new_org_title = <STDIN
>;
982 if ( $new_org_title eq "\n" ) {
983 $new_org_title = $org_title;
985 $new_org_title =~ s/[\r\n]//g;
986 $new_org_title =~ s/\"/\'/g;
988 return $new_org_title;
993 print "When users click the Sign Out button they will be logged out and\n";
994 print "then sent to signout_page. If signout_page is left empty,\n";
995 print "(hit space and then return) they will be taken, as normal,\n";
996 print "to the default and rather sparse SquirrelMail signout page.\n";
998 print "[$WHT$signout_page$NRM]: $WHT";
999 $new_signout_page = <STDIN
>;
1000 if ( $new_signout_page eq "\n" ) {
1001 $new_signout_page = $signout_page;
1003 $new_signout_page =~ s/[\r\n]//g;
1004 $new_signout_page =~ s/^\s+$//g;
1006 return $new_signout_page;
1011 print "SquirrelMail defaults to using the whole of the browser window.\n";
1012 print "This allows you to keep it within a specified frame. The default\n";
1013 print "is '_top'\n";
1015 print "[$WHT$frame_top$NRM]: $WHT";
1016 $new_frame_top = <STDIN
>;
1017 if ( $new_frame_top eq "\n" ) {
1018 $new_frame_top = '_top';
1020 $new_frame_top =~ s/[\r\n]//g;
1021 $new_frame_top =~ s/^\s+$//g;
1023 return $new_frame_top;
1026 # Default link to provider
1028 print "Here you can set the link on the right of the page.\n";
1029 print "If empty, it will link to the SquirrelMail About page.\n";
1031 print "[$WHT$provider_uri$NRM]: $WHT";
1032 $new_provider_uri = <STDIN
>;
1033 if ( $new_provider_uri eq "\n" ) {
1034 $new_provider_uri = '';
1036 $new_provider_uri =~ s/[\r\n]//g;
1037 $new_provider_uri =~ s/^\s+$//g;
1039 return $new_provider_uri;
1043 print "Here you can set the name of the link on the right of the page.\n";
1044 print "The default is 'SquirrelMail'\n";
1046 print "[$WHT$provider_name$NRM]: $WHT";
1047 $new_provider_name = <STDIN
>;
1048 if ( $new_provider_name eq "\n" ) {
1049 $new_provider_name = 'SquirrelMail';
1051 $new_provider_name =~ s/[\r\n]//g;
1052 $new_provider_name =~ s/^\s+$//g;
1053 $new_provider_name =~ s/\'/\\'/g;
1055 return $new_provider_name;
1058 ####################################################################################
1062 print "The domain name is the suffix at the end of all email addresses. If\n";
1063 print "for example, your email address is jdoe\@example.com, then your domain\n";
1064 print "would be example.com.\n";
1066 print "[$WHT$domain$NRM]: $WHT";
1067 $new_domain = <STDIN
>;
1068 if ( $new_domain eq "\n" ) {
1069 $new_domain = $domain;
1071 $new_domain =~ s/[\r\n]//g;
1078 print "This is the hostname where your IMAP server can be contacted.\n";
1079 print "[$WHT$imapServerAddress$NRM]: $WHT";
1080 $new_imapServerAddress = <STDIN
>;
1081 if ( $new_imapServerAddress eq "\n" ) {
1082 $new_imapServerAddress = $imapServerAddress;
1084 $new_imapServerAddress =~ s/[\r\n]//g;
1086 return $new_imapServerAddress;
1091 print "This is the port that your IMAP server is on. Usually this is 143.\n";
1092 print "[$WHT$imapPort$NRM]: $WHT";
1093 $new_imapPort = <STDIN
>;
1094 if ( $new_imapPort eq "\n" ) {
1095 $new_imapPort = $imapPort;
1097 $new_imapPort =~ s/[\r\n]//g;
1099 return $new_imapPort;
1104 print "You now need to choose the method that you will use for sending\n";
1105 print "messages in SquirrelMail. You can either connect to an SMTP server\n";
1106 print "or use sendmail directly.\n";
1107 if ( lc($useSendmail) eq 'true' ) {
1108 $default_value = "1";
1110 $default_value = "2";
1113 print " 1. Sendmail\n";
1115 print "Your choice [1/2] [$WHT$default_value$NRM]: $WHT";
1116 $use_sendmail = <STDIN
>;
1117 if ( ( $use_sendmail =~ /^1\n/i )
1118 || ( ( $use_sendmail =~ /^\n/ ) && ( $default_value eq "1" ) ) ) {
1119 $useSendmail = 'true';
1121 $useSendmail = 'false';
1123 return $useSendmail;
1128 print "Specify where the sendmail executable is located. Usually /usr/sbin/sendmail\n";
1129 print "[$WHT$sendmail_path$NRM]: $WHT";
1130 $new_sendmail_path = <STDIN
>;
1131 if ( $new_sendmail_path eq "\n" ) {
1132 $new_sendmail_path = $sendmail_path;
1134 $new_sendmail_path =~ s/[\r\n]//g;
1136 return $new_sendmail_path;
1139 # Extra sendmail arguments
1140 sub command_sendmail_args
{
1141 print "Specify additional sendmail program arguments.\n";
1143 print "Make sure that arguments are supported by your sendmail program. -f argument \n";
1144 print "is added automatically by SquirrelMail scripts. Variable defaults to standard\n";
1145 print "/usr/sbin/sendmail arguments. If you use qmail-inject, nbsmtp or any other \n";
1146 print "sendmail wrapper, which does not support -i and -t arguments, set variable to\n";
1147 print "empty string or use arguments suitable for your mailer.\n";
1149 print "[$WHT$sendmail_args$NRM]: $WHT";
1150 $new_sendmail_args = <STDIN
>;
1151 if ( $new_sendmail_args eq "\n" ) {
1152 $new_sendmail_args = $sendmail_args;
1154 # strip linefeeds and crs.
1155 $new_sendmail_args =~ s/[\r\n]//g;
1157 return trim
($new_sendmail_args);
1162 print "This is the hostname of your SMTP server.\n";
1163 print "[$WHT$smtpServerAddress$NRM]: $WHT";
1164 $new_smtpServerAddress = <STDIN
>;
1165 if ( $new_smtpServerAddress eq "\n" ) {
1166 $new_smtpServerAddress = $smtpServerAddress;
1168 $new_smtpServerAddress =~ s/[\r\n]//g;
1170 return $new_smtpServerAddress;
1175 print "This is the port to connect to for SMTP. Usually 25.\n";
1176 print "[$WHT$smtpPort$NRM]: $WHT";
1177 $new_smtpPort = <STDIN
>;
1178 if ( $new_smtpPort eq "\n" ) {
1179 $new_smtpPort = $smtpPort;
1181 $new_smtpPort =~ s/[\r\n]//g;
1183 return $new_smtpPort;
1188 print "Do you wish to use POP3 before SMTP? Your server must\n";
1189 print "support this in order for SquirrelMail to work with it.\n";
1192 $YesNo = 'y' if ( lc($pop_before_smtp) eq 'true' );
1194 print "Use pop before SMTP (y/n) [$WHT$YesNo$NRM]: $WHT";
1196 $new_pop_before_smtp = <STDIN
>;
1197 $new_pop_before_smtp =~ tr/yn//cd;
1198 return 'true' if ( $new_pop_before_smtp eq "y" );
1199 return 'false' if ( $new_pop_before_smtp eq "n" );
1200 return $pop_before_smtp;
1205 print "Each IMAP server has its own quirks. As much as we tried to stick\n";
1206 print "to standards, it doesn't help much if the IMAP server doesn't follow\n";
1207 print "the same principles. We have made some work-arounds for some of\n";
1208 print "these servers. If you would like to use them, please select your\n";
1209 print "IMAP server. If you do not wish to use these work-arounds, you can\n";
1210 print "set this to \"other\", and none will be used.\n";
1211 print " courier = Courier IMAP server\n";
1212 print " cyrus = Cyrus IMAP server\n";
1213 print " dovecot = Dovecot Secure IMAP server\n";
1214 print " exchange = Microsoft Exchange IMAP server\n";
1215 print " hmailserver = hMailServer\n";
1216 print " macosx = Mac OS X Mailserver\n";
1217 print " mercury32 = Mercury Mail Transport System\n";
1218 print " uw = University of Washington's IMAP server\n";
1220 print " other = Not one of the above servers\n";
1222 print "[$WHT$imap_server_type$NRM]: $WHT";
1223 $new_imap_server_type = <STDIN
>;
1225 if ( $new_imap_server_type eq "\n" ) {
1226 $new_imap_server_type = $imap_server_type;
1228 $new_imap_server_type =~ s/[\r\n]//g;
1230 return $new_imap_server_type;
1235 print "Sometimes the date of messages sent is messed up (off by a few hours\n";
1236 print "on some machines). Typically this happens if the system doesn't support\n";
1237 print "tm_gmtoff. It will happen only if your time zone is \"negative\".\n";
1238 print "This most often occurs on Solaris 7 machines in the United States.\n";
1239 print "By default, this is off. It should be kept off unless problems surface\n";
1240 print "about the time that messages are sent.\n";
1241 print " no = Do NOT fix time -- almost always correct\n";
1242 print " yes = Fix the time for this system\n";
1245 $YesNo = 'y' if ( lc($invert_time) eq 'true' );
1247 print "Fix the time for this system (y/n) [$WHT$YesNo$NRM]: $WHT";
1249 $new_invert_time = <STDIN
>;
1250 $new_invert_time =~ tr/yn//cd;
1251 return 'true' if ( $new_invert_time eq "y" );
1252 return 'false' if ( $new_invert_time eq "n" );
1253 return $invert_time;
1257 print "This is the delimiter that your IMAP server uses to distinguish between\n";
1258 print "folders. For example, Cyrus uses '.' as the delimiter and a complete\n";
1259 print "folder would look like 'INBOX.Friends.Bob', while UW uses '/' and would\n";
1260 print "look like 'INBOX/Friends/Bob'. Normally this should be left at 'detect'\n";
1261 print "but if you are sure you know what delimiter your server uses, you can\n";
1262 print "specify it here.\n";
1263 print "\nTo have it autodetect the delimiter, set it to 'detect'.\n\n";
1264 print "[$WHT$optional_delimiter$NRM]: $WHT";
1265 $new_optional_delimiter = <STDIN
>;
1267 if ( $new_optional_delimiter eq "\n" ) {
1268 $new_optional_delimiter = $optional_delimiter;
1270 $new_optional_delimiter =~ s/[\r\n]//g;
1272 return $new_optional_delimiter;
1274 # IMAP authentication type
1275 # Possible values: login, plain, cram-md5, digest-md5
1276 # Now offers to detect supported mechs, assuming server & port are set correctly
1279 if ($use_imap_tls ne "0") {
1280 # 1. Script does not handle TLS.
1281 # 2. Server does not have to declare all supported authentication mechs when
1282 # STARTTLS is used. Supported mechs are declared only after STARTTLS.
1283 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1285 print "If you have already set the hostname and port number, I can try to\n";
1286 print "detect the mechanisms your IMAP server supports.\n";
1287 print "I will try to detect CRAM-MD5 and DIGEST-MD5 support. I can't test\n";
1288 print "for \"login\" or \"plain\" without knowing a username and password.\n";
1289 print "Auto-detecting is optional - you can safely say \"n\" here.\n";
1290 print "\nTry to detect supported mechanisms? [y/N]: ";
1293 if ($inval =~ /^y\b/i) {
1294 # Yes, let's try to detect.
1295 print "Trying to detect IMAP capabilities...\n";
1296 my $host = $imapServerAddress . ':'. $imapPort;
1297 print "CRAM-MD5:\t";
1298 my $tmp = detect_auth_support
('IMAP',$host,'CRAM-MD5');
1299 if (defined($tmp)) {
1300 if ($tmp eq 'YES') {
1301 print "$WHT SUPPORTED$NRM\n";
1303 print "$WHT NOT SUPPORTED$NRM\n";
1306 print $WHT . " ERROR DETECTING$NRM\n";
1309 print "DIGEST-MD5:\t";
1310 $tmp = detect_auth_support
('IMAP',$host,'DIGEST-MD5');
1311 if (defined($tmp)) {
1312 if ($tmp eq 'YES') {
1313 print "$WHT SUPPORTED$NRM\n";
1315 print "$WHT NOT SUPPORTED$NRM\n";
1318 print $WHT . " ERROR DETECTING$NRM\n";
1323 print "\nWhat authentication mechanism do you want to use for IMAP connections?\n\n";
1324 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1325 print $WHT . "plain" . $NRM . " - SASL PLAIN. If you need this, you already know it.\n";
1326 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext methods.\n";
1327 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1328 print "\n*** YOUR IMAP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n";
1329 print "If you don't understand or are unsure, you probably want \"login\"\n\n";
1330 print "login, plain, cram-md5, or digest-md5 [$WHT$imap_auth_mech$NRM]: $WHT";
1333 if ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) || ($inval =~ /^login\b/i) || ($inval =~ /^plain\b/i)) {
1336 # user entered garbage or default value so nothing needs to be set
1337 return $imap_auth_mech;
1342 # SMTP authentication type
1343 # Possible choices: none, plain, cram-md5, digest-md5
1345 if ($use_smtp_tls ne "0") {
1346 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1347 } elsif (eval ("use IO::Socket; 1")) {
1348 # try loading IO::Socket module
1349 print "If you have already set the hostname and port number, I can try to\n";
1350 print "automatically detect some of the mechanisms your SMTP server supports.\n";
1351 print "Auto-detection is *optional* - you can safely say \"n\" here.\n";
1352 print "\nTry to detect auth mechanisms? [y/N]: ";
1355 if ($inval =~ /^y\b/i) {
1356 # Yes, let's try to detect.
1357 print "Trying to detect supported methods (SMTP)...\n";
1360 # Check none by trying to relay to junk@microsoft.com
1361 $host = $smtpServerAddress . ':' . $smtpPort;
1362 my $sock = IO
::Socket
::INET
->new($host);
1363 print "Testing none:\t\t$WHT";
1364 if (!defined($sock)) {
1365 print " ERROR TESTING\n";
1368 print $sock "HELO $domain\r\n";
1369 $got = <$sock>; # Discard
1370 print $sock "MAIL FROM:<tester\@squirrelmail.org>\r\n";
1371 $got = <$sock>; # Discard
1372 print $sock "RCPT TO:<junk\@microsoft.com\r\n";
1373 $got = <$sock>; # This is the important line
1374 if ($got =~ /^250\b/) { # SMTP will relay without auth
1375 print "SUPPORTED$NRM\n";
1377 print "NOT SUPPORTED$NRM\n";
1379 print $sock "RSET\r\n";
1380 print $sock "QUIT\r\n";
1383 # Try login (SquirrelMail default)
1384 print "Testing login:\t\t";
1385 $tmp=detect_auth_support
('SMTP',$host,'LOGIN');
1386 if (defined($tmp)) {
1387 if ($tmp eq 'YES') {
1388 print $WHT . "SUPPORTED$NRM\n";
1390 print $WHT . "NOT SUPPORTED$NRM\n";
1393 print $WHT . "ERROR DETECTING$NRM\n";
1397 print "Testing CRAM-MD5:\t";
1398 $tmp=detect_auth_support
('SMTP',$host,'CRAM-MD5');
1399 if (defined($tmp)) {
1400 if ($tmp eq 'YES') {
1401 print $WHT . "SUPPORTED$NRM\n";
1403 print $WHT . "NOT SUPPORTED$NRM\n";
1406 print $WHT . "ERROR DETECTING$NRM\n";
1410 print "Testing DIGEST-MD5:\t";
1411 $tmp=detect_auth_support
('SMTP',$host,'DIGEST-MD5');
1412 if (defined($tmp)) {
1413 if ($tmp eq 'YES') {
1414 print $WHT . "SUPPORTED$NRM\n";
1416 print $WHT . "NOT SUPPORTED$NRM\n";
1419 print $WHT . "ERROR DETECTING$NRM\n";
1423 print "\nWhat authentication mechanism do you want to use for SMTP connections?\n";
1424 print $WHT . "none" . $NRM . " - Your SMTP server does not require authorization.\n";
1425 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1426 print $WHT . "plain" . $NRM . " - SASL PLAIN. You already know it if you need this.\n";
1427 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext.\n";
1428 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1429 print $WHT . "\n*** YOUR SMTP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n" . $NRM;
1430 print "If you don't understand or are unsure, you probably want \"none\"\n\n";
1431 print "none, login, cram-md5, or digest-md5 [$WHT$smtp_auth_mech$NRM]: $WHT";
1434 if ($inval =~ /^none\b/i) {
1435 # remove sitewide smtp authentication information
1436 $smtp_sitewide_user = '';
1437 $smtp_sitewide_pass = '';
1438 # SMTP doesn't necessarily require logins
1440 } elsif ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) ||
1441 ($inval =~ /^login\b/i) || ($inval =~/^plain\b/i)) {
1442 command_smtp_sitewide_userpass
($inval);
1444 } elsif (trim
($inval) eq '') {
1445 # user selected default value
1446 command_smtp_sitewide_userpass
($smtp_auth_mech);
1447 return $smtp_auth_mech;
1449 # user entered garbage
1450 return $smtp_auth_mech;
1454 sub command_smtp_sitewide_userpass
($) {
1455 # get first function argument
1456 my $auth_mech = shift(@_);
1458 $auth_mech = lc(trim
($auth_mech));
1459 if ($auth_mech eq 'none') {
1462 print "SMTP authentication uses IMAP username and password by default.\n";
1464 print "Would you like to use other login and password for all SquirrelMail \n";
1465 print "SMTP connections?";
1466 if ($smtp_sitewide_user ne '') {
1483 $smtp_sitewide_user = '';
1484 $smtp_sitewide_pass = '';
1485 } elsif ($tmp eq 'y') {
1486 print "Enter username [$smtp_sitewide_user]:";
1487 my $new_user = <STDIN
>;
1488 $new_user = trim
($new_user);
1489 if ($new_user ne '') {
1490 $smtp_sitewide_user = $new_user;
1492 if ($smtp_sitewide_user ne '') {
1493 print "If you don't enter any password, current sitewide password will be used.\n";
1494 print "If you enter space, password will be set to empty string.\n";
1495 print "Enter password:";
1496 my $new_pass = <STDIN
>;
1497 if ($new_pass ne "\n") {
1498 $smtp_sitewide_pass = trim
($new_pass);
1501 print "Invalid input. You must set username used for SMTP authentication.\n";
1502 print "Click any key to continue\n";
1506 print "Invalid input\n";
1507 print "Click any key to continue\n";
1512 # Sub adds information about SMTP authentication type to menu
1513 sub display_smtp_sitewide_userpass
() {
1515 if ($smtp_auth_mech ne 'none') {
1516 if ($smtp_sitewide_user ne '') {
1517 $ret = ' (with custom username and password)';
1519 $ret = ' (with IMAP username and password)';
1526 # This sub is reused for IMAP and SMTP
1527 # Args: service name, default value
1528 sub command_use_tls
{
1529 my($default_val,$service,$inval);
1532 print "TLS (Transport Layer Security) encrypts the traffic between server and client.\n";
1533 print "STARTTLS extensions allow to start encryption on existing plain text connection.\n";
1534 print "These options add specific PHP and IMAP server configuration requirements.\n";
1535 print "See SquirrelMail documentation about connection security.\n";
1537 print "If your " . $service . " server is localhost, you can safely disable this.\n";
1538 print "If it is remote, you may wish to seriously consider enabling this.\n";
1540 while ($valid_input eq 0) {
1541 print "\nSelect connection security model:\n";
1542 print " 0 - Use plain text connection\n";
1543 print " 1 - Use TLS connection\n";
1544 print " 2 - Use STARTTLS extension\n";
1545 print "Select [$default_val]: ";
1547 $inval=trim
($inval);
1548 if ($inval =~ /^[012]$/ || $inval eq '') {
1552 if ($inval ne '') {$default_val = $inval};
1553 return $default_val;
1556 # This sub is used to display human readable text for
1557 # $use_imap_tls and $use_smtp_tls values in conf.pl menu
1558 sub display_use_tls
($) {
1559 my $val = shift(@_);
1560 my $ret = 'disabled';
1563 } elsif ($val eq '1') {
1569 # $encode_header_key
1571 print "Encryption key allows to hide SquirrelMail Received: headers\n";
1572 print "in outbound messages. Interface uses encryption key to encode\n";
1573 print "username, remote address and proxied address, then stores encoded\n";
1574 print "information in X-Squirrel-* headers.\n";
1576 print "Warning: used encryption function is not bulletproof. When used\n";
1577 print "with static encryption keys, it provides only minimal security\n";
1578 print "measures and information can be decoded quickly.\n";
1580 print "Encoded information can be decoded with decrypt_headers.php script\n";
1581 print "from SquirrelMail contrib/ directory.\n";
1583 print "Enter encryption key: ";
1584 $new_encode_header_key = <STDIN
>;
1585 if ( $new_encode_header_key eq "\n" ) {
1586 $new_encode_header_key = $encode_header_key;
1588 $new_encode_header_key =~ s/[\r\n]//g;
1590 return $new_encode_header_key;
1595 print "\nYou can now create the welcome message that is displayed\n";
1596 print "every time a user logs on. You can use HTML or just plain\n";
1598 "text. If you do not wish to have one, just make it blank.\n\n(Type @ on a blank line to exit)\n";
1604 $line =~ s/[\r\n]//g;
1605 if ( $line ne "@" ) {
1606 $line =~ s/ /\ \ /g;
1607 $line =~ s/\t/\ \ \ \ /g;
1609 $line =~ s/\"/\\\"/g;
1611 $new_motd = $new_motd . $line;
1613 } while ( $line ne "@" );
1617 ################# PLUGINS ###################
1620 $command =~ s/[\s\n\r]*//g;
1621 if ( $command > 0 ) {
1622 $command = $command - 1;
1623 if ( $command <= $#plugins ) {
1626 while ( $ct <= $#plugins ) {
1627 if ( $ct != $command ) {
1628 @newplugins = ( @newplugins, $plugins[$ct] );
1632 @plugins = @newplugins;
1633 } elsif ( $command <= $#plugins + $#unused_plugins + 1 ) {
1634 $num = $command - $#plugins - 1;
1635 @newplugins = @plugins;
1637 while ( $ct <= $#unused_plugins ) {
1638 if ( $ct == $num ) {
1639 @newplugins = ( @newplugins, $unused_plugins[$ct] );
1643 @plugins = @newplugins;
1649 ################# FOLDERS ###################
1651 # default_folder_prefix
1653 print "Some IMAP servers (UW, for example) store mail and folders in\n";
1654 print "your user space in a separate subdirectory. This is where you\n";
1655 print "specify what that directory is.\n";
1657 print "EXAMPLE: mail/";
1659 print "NOTE: If you use Cyrus, or some server that would not use this\n";
1660 print " option, you must set this to 'none'.\n";
1662 print "[$WHT$default_folder_prefix$NRM]: $WHT";
1663 $new_default_folder_prefix = <STDIN
>;
1665 if ( $new_default_folder_prefix eq "\n" ) {
1666 $new_default_folder_prefix = $default_folder_prefix;
1668 $new_default_folder_prefix =~ s/[\r\n]//g;
1670 if ( ( $new_default_folder_prefix =~ /^\s*$/ ) || ( $new_default_folder_prefix =~ m/^none$/i ) ) {
1671 $new_default_folder_prefix = "";
1673 # add the trailing delimiter only if we know what the server is.
1674 if (($imap_server_type eq 'cyrus' and
1675 $optional_delimiter eq 'detect') or
1676 ($imap_server_type eq 'courier' and
1677 $optional_delimiter eq 'detect')) {
1678 $new_default_folder_prefix =~ s/\.*$/\./;
1679 } elsif ($imap_server_type eq 'uw' and
1680 $optional_delimiter eq 'detect') {
1681 $new_default_folder_prefix =~ s/\/*$/\
//;
1684 return $new_default_folder_prefix;
1687 # Show Folder Prefix
1689 print "It is possible to set up the default folder prefix as a user\n";
1690 print "specific option, where each user can specify what their mail\n";
1691 print "folder is. If you set this to false, they will never see the\n";
1692 print "option, but if it is true, this option will appear in the\n";
1693 print "'options' section.\n";
1695 print "NOTE: You set the default folder prefix in option '1' of this\n";
1696 print " section. That will be the default if the user doesn't\n";
1697 print " specify anything different.\n";
1700 if ( lc($show_prefix_option) eq 'true' ) {
1701 $default_value = "y";
1703 $default_value = "n";
1706 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
1707 $new_show = <STDIN
>;
1708 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1709 $show_prefix_option = 'true';
1711 $show_prefix_option = 'false';
1713 return $show_prefix_option;
1718 print "You can now specify where the default trash folder is located.\n";
1719 print "On servers where you do not want this, you can set it to anything\n";
1720 print "and set option 6 to false.\n";
1722 print "This is relative to where the rest of your email is kept. You do\n";
1723 print "not need to worry about their mail directory. If this folder\n";
1724 print "would be ~/mail/trash on the filesystem, you only need to specify\n";
1725 print "that this is 'trash', and be sure to put 'mail/' in option 1.\n";
1728 print "[$WHT$trash_folder$NRM]: $WHT";
1729 $new_trash_folder = <STDIN
>;
1730 if ( $new_trash_folder eq "\n" ) {
1731 $new_trash_folder = $trash_folder;
1733 if (check_imap_folder
($new_trash_folder)) {
1734 $new_trash_folder =~ s/[\r\n]//g;
1736 $new_trash_folder = $trash_folder;
1739 return $new_trash_folder;
1744 print "This is where messages that are sent will be stored. SquirrelMail\n";
1745 print "by default puts a copy of all outgoing messages in this folder.\n";
1747 print "This is relative to where the rest of your email is kept. You do\n";
1748 print "not need to worry about their mail directory. If this folder\n";
1749 print "would be ~/mail/sent on the filesystem, you only need to specify\n";
1750 print "that this is 'sent', and be sure to put 'mail/' in option 1.\n";
1753 print "[$WHT$sent_folder$NRM]: $WHT";
1754 $new_sent_folder = <STDIN
>;
1755 if ( $new_sent_folder eq "\n" ) {
1756 $new_sent_folder = $sent_folder;
1758 if (check_imap_folder
($new_sent_folder)) {
1759 $new_sent_folder =~ s/[\r\n]//g;
1761 $new_sent_folder = $sent_folder;
1764 return $new_sent_folder;
1769 print "You can now specify where the default draft folder is located.\n";
1770 print "On servers where you do not want this, you can set it to anything\n";
1771 print "and set option 9 to false.\n";
1773 print "This is relative to where the rest of your email is kept. You do\n";
1774 print "not need to worry about their mail directory. If this folder\n";
1775 print "would be ~/mail/drafts on the filesystem, you only need to specify\n";
1776 print "that this is 'drafts', and be sure to put 'mail/' in option 1.\n";
1779 print "[$WHT$draft_folder$NRM]: $WHT";
1780 $new_draft_folder = <STDIN
>;
1781 if ( $new_draft_folder eq "\n" ) {
1782 $new_draft_folder = $draft_folder;
1784 if (check_imap_folder
($new_draft_folder)) {
1785 $new_draft_folder =~ s/[\r\n]//g;
1787 $new_draft_folder = $draft_folder;
1790 return $new_draft_folder;
1793 # default move to trash
1795 print "By default, should messages get moved to the trash folder? You\n";
1796 print "can specify the default trash folder in option 3. If this is set\n";
1797 print "to false, messages will get deleted immediately without moving\n";
1798 print "to the trash folder.\n";
1800 print "Trash folder is currently: $trash_folder\n";
1803 if ( lc($default_move_to_trash) eq 'true' ) {
1804 $default_value = "y";
1806 $default_value = "n";
1808 print "By default, move to trash (y/n) [$WHT$default_value$NRM]: $WHT";
1809 $new_show = <STDIN
>;
1810 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1811 $default_move_to_trash = 'true';
1813 $default_move_to_trash = 'false';
1815 return $default_move_to_trash;
1818 # default move to sent
1820 print "By default, should messages get moved to the sent folder? You\n";
1821 print "can specify the default sent folder in option 4. If this is set\n";
1822 print "to false, messages will get sent and no copy will be made.\n";
1824 print "Sent folder is currently: $sent_folder\n";
1827 if ( lc($default_move_to_sent) eq 'true' ) {
1828 $default_value = "y";
1830 $default_value = "n";
1832 print "By default, move to sent (y/n) [$WHT$default_value$NRM]: $WHT";
1833 $new_show = <STDIN
>;
1834 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1835 $default_move_to_sent = 'true';
1837 $default_move_to_sent = 'false';
1839 return $default_move_to_sent;
1842 # default save as draft
1844 print "By default, should the save to draft option be shown? You can\n";
1845 print "specify the default drafts folder in option 5. If this is set\n";
1846 print "to false, users will not be shown the save to draft option.\n";
1848 print "Drafts folder is currently: $draft_folder\n";
1851 if ( lc($default_move_to_draft) eq 'true' ) {
1852 $default_value = "y";
1854 $default_value = "n";
1856 print "By default, save as draft (y/n) [$WHT$default_value$NRM]: $WHT";
1857 $new_show = <STDIN
>;
1858 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1859 $default_save_as_draft = 'true';
1861 $default_save_as_draft = 'false';
1863 return $default_save_as_draft;
1866 # List special folders first
1868 print "SquirrelMail has what we call 'special folders' that are not\n";
1869 print "manipulated and viewed like normal folders. Some examples of\n";
1870 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
1871 print "Simply asks if you want these folders listed first in the folder\n";
1875 if ( lc($list_special_folders_first) eq 'true' ) {
1876 $default_value = "y";
1878 $default_value = "n";
1881 print "List first (y/n) [$WHT$default_value$NRM]: $WHT";
1882 $new_show = <STDIN
>;
1883 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1884 $list_special_folders_first = 'true';
1886 $list_special_folders_first = 'false';
1888 return $list_special_folders_first;
1891 # Show special folders color
1893 print "SquirrelMail has what we call 'special folders' that are not\n";
1894 print "manipulated and viewed like normal folders. Some examples of\n";
1895 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
1896 print "wants to know if we should display special folders in a\n";
1897 print "color than the other folders.\n";
1900 if ( lc($use_special_folder_color) eq 'true' ) {
1901 $default_value = "y";
1903 $default_value = "n";
1906 print "Show color (y/n) [$WHT$default_value$NRM]: $WHT";
1907 $new_show = <STDIN
>;
1908 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1909 $use_special_folder_color = 'true';
1911 $use_special_folder_color = 'false';
1913 return $use_special_folder_color;
1918 print "The way that IMAP handles deleting messages is as follows. You\n";
1919 print "mark the message as deleted, and then to 'really' delete it, you\n";
1920 print "expunge it. This option asks if you want to just have messages\n";
1921 print "marked as deleted, or if you want SquirrelMail to expunge the \n";
1922 print "messages too.\n";
1925 if ( lc($auto_expunge) eq 'true' ) {
1926 $default_value = "y";
1928 $default_value = "n";
1930 print "Auto expunge (y/n) [$WHT$default_value$NRM]: $WHT";
1931 $new_show = <STDIN
>;
1932 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1933 $auto_expunge = 'true';
1935 $auto_expunge = 'false';
1937 return $auto_expunge;
1940 # Default sub of inbox
1942 print "Some IMAP servers (Cyrus) have all folders as subfolders of INBOX.\n";
1943 print "This can cause some confusion in folder creation for users when\n";
1944 print "they try to create folders and don't put it as a subfolder of INBOX\n";
1945 print "and get permission errors. This option asks if you want folders\n";
1946 print "to be subfolders of INBOX by default.\n";
1949 if ( lc($default_sub_of_inbox) eq 'true' ) {
1950 $default_value = "y";
1952 $default_value = "n";
1954 print "Default sub of INBOX (y/n) [$WHT$default_value$NRM]: $WHT";
1955 $new_show = <STDIN
>;
1956 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1957 $default_sub_of_inbox = 'true';
1959 $default_sub_of_inbox = 'false';
1961 return $default_sub_of_inbox;
1964 # Show contain subfolder option
1966 print "Some IMAP servers (UW) make it so that there are two types of\n";
1967 print "folders. Those that contain messages, and those that contain\n";
1968 print "subfolders. If this is the case for your server, set this to\n";
1969 print "true, and it will ask the user whether the folder they are\n";
1970 print "creating contains subfolders or messages.\n";
1973 if ( lc($show_contain_subfolders_option) eq 'true' ) {
1974 $default_value = "y";
1976 $default_value = "n";
1978 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
1979 $new_show = <STDIN
>;
1980 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1981 $show_contain_subfolders_option = 'true';
1983 $show_contain_subfolders_option = 'false';
1985 return $show_contain_subfolders_option;
1988 # Default Unseen Notify
1990 print "This option specifies where the users will receive notification\n";
1991 print "about unseen messages by default. This is of course an option that\n";
1992 print "can be changed on a user level.\n";
1993 print " 1 = No notification\n";
1994 print " 2 = Only on the INBOX\n";
1995 print " 3 = On all folders\n";
1998 print "Which one should be default (1,2,3)? [$WHT$default_unseen_notify$NRM]: $WHT";
1999 $new_show = <STDIN
>;
2000 if ( $new_show =~ /^[123]\n/i ) {
2001 $default_unseen_notify = $new_show;
2003 $default_unseen_notify =~ s/[\r\n]//g;
2004 return $default_unseen_notify;
2007 # Default Unseen Type
2009 print "Here you can define the default way that unseen messages will be displayed\n";
2010 print "to the user in the folder listing on the left side.\n";
2011 print " 1 = Only unseen messages (4)\n";
2012 print " 2 = Unseen and Total messages (4/27)\n";
2015 print "Which one should be default (1,2)? [$WHT$default_unseen_type$NRM]: $WHT";
2016 $new_show = <STDIN
>;
2017 if ( $new_show =~ /^[12]\n/i ) {
2018 $default_unseen_type = $new_show;
2020 $default_unseen_type =~ s/[\r\n]//g;
2021 return $default_unseen_type;
2024 # Auto create special folders
2026 print "Would you like the Sent, Trash, and Drafts folders to be created\n";
2027 print "automatically print for you when a user logs in? If the user\n";
2028 print "accidentally deletes their special folders, this option will\n";
2029 print "automatically create it again for them.\n";
2032 if ( lc($auto_create_special) eq 'true' ) {
2033 $default_value = "y";
2035 $default_value = "n";
2037 print "Auto create special folders? (y/n) [$WHT$default_value$NRM]: $WHT";
2038 $new_show = <STDIN
>;
2039 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2040 $auto_create_special = 'true';
2042 $auto_create_special = 'false';
2044 return $auto_create_special;
2047 # Automatically delete folders
2049 if ( $imap_server_type eq "uw" ) {
2050 print "UW IMAP servers will not allow folders containing mail to also contain folders.\n";
2051 print "Deleting folders will bypass the trash folder and be immediately deleted\n\n";
2052 print "If this is not the correct value for your server,\n";
2053 print "please use option D on the Main Menu to configure your server correctly.\n\n";
2054 print "Press any key to continue...\n";
2055 $new_delete = <STDIN
>;
2056 $delete_folder = 'true';
2058 if ( $imap_server_type eq "courier" ) {
2059 print "Courier (or Courier-IMAP) IMAP servers may not support ";
2060 print "subfolders of Trash. \n";
2061 print "Specifically, if Courier is set to always move messages to Trash, \n";
2062 print "Trash will be treated by Courier as a special folder that does not \n";
2063 print "allow subfolders. \n\n";
2064 print "Please verify your Courier configuration, and test folder deletion \n";
2065 print "when changing this setting.\n\n";
2068 print "Are subfolders of the Trash supported by your IMAP server?\n";
2069 print "If so, should deleted folders be sent to Trash?\n";
2070 print "If not, say no (deleted folders should not be sent to Trash)\n\n";
2071 # reversal of logic.
2072 # question was: Should folders be automatically deleted instead of sent to trash..
2073 # we've changed the question to make it more clear,
2074 # and are here handling that to avoid changing the answers..
2075 if ( lc($delete_folder) eq 'true' ) {
2076 $default_value = "n";
2078 $default_value = "y";
2080 print "Send deleted folders to Trash? (y/n) [$WHT$default_value$NRM]: $WHT";
2081 $new_delete = <STDIN
>;
2082 if ( ( $new_delete =~ /^y\n/i ) || ( ( $new_delete =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2083 $delete_folder = 'false';
2085 $delete_folder = 'true';
2088 return $delete_folder;
2093 print "Some IMAP server allow subfolders to exist even if the parent\n";
2094 print "folders do not. This fixes some problems with the folder list\n";
2095 print "when this is the case, causing the /NoSelect folders to be displayed\n";
2098 if ( lc($noselect_fix_enable) eq 'true' ) {
2099 $default_value = "y";
2101 $default_value = "n";
2103 print "enable noselect fix? (y/n) [$WHT$noselect_fix_enable$NRM]: $WHT";
2104 $noselect_fix_enable = <STDIN
>;
2105 if ( ( $noselect_fix_enable =~ /^y\n/i ) || ( ( $noselect_fix_enable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2106 $noselect_fix_enable = 'true';
2108 $noselect_fix_enable = 'false';
2110 return $noselect_fix_enable;
2112 ############# GENERAL OPTIONS #####################
2116 print "Specify the location for your data directory.\n";
2117 print "You need to create this directory yourself.\n";
2118 print "The path name can be absolute or relative (to the config directory).\n";
2119 print "Here are two examples:\n";
2120 print " Absolute: /var/local/squirrelmail/data/\n";
2121 print " Relative: ../data/\n";
2122 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2123 print "will be converted to their absolute path equivalents in config.php.\n\n";
2124 print "Note: There are potential security risks with having a writeable directory\n";
2125 print "under the web server's root directory (ex: /home/httpd/html).\n";
2126 print "For this reason, it is recommended to put the data directory\n";
2127 print "in an alternate location of your choice. \n";
2130 print "[$WHT$data_dir$NRM]: $WHT";
2131 $new_data_dir = <STDIN
>;
2132 if ( $new_data_dir eq "\n" ) {
2133 $new_data_dir = $data_dir;
2135 $new_data_dir =~ s/[\r\n]//g;
2137 if ( $new_data_dir =~ /^\s*$/ ) {
2140 $new_data_dir =~ s/\/*$//g
;
2141 $new_data_dir =~ s/$/\//g
;
2143 return $new_data_dir;
2146 # Attachment directory
2148 print "Path to directory used for storing attachments while a mail is\n";
2149 print "being composed. The path name can be absolute or relative (to the\n";
2150 print "config directory). Here are two examples:\n";
2151 print " Absolute: /var/local/squirrelmail/attach/\n";
2152 print " Relative: ../attach/\n";
2153 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2154 print "will be converted to their absolute path equivalents in config.php.\n\n";
2155 print "Note: There are a few security considerations regarding this\n";
2156 print "directory:\n";
2157 print " 1. It should have the permission 733 (rwx-wx-wx) to make it\n";
2158 print " impossible for a random person with access to the webserver\n";
2159 print " to list files in this directory. Confidential data might\n";
2160 print " be laying around in there.\n";
2161 print " Depending on your user:group assignments, 730 (rwx-wx---)\n";
2162 print " may be possible, and more secure (e.g. root:apache)\n";
2163 print " 2. Since the webserver is not able to list the files in the\n";
2164 print " content is also impossible for the webserver to delete files\n";
2165 print " lying around there for too long.\n";
2166 print " 3. It should probably be another directory than the data\n";
2167 print " directory specified in option 3.\n";
2170 print "[$WHT$attachment_dir$NRM]: $WHT";
2171 $new_attachment_dir = <STDIN
>;
2172 if ( $new_attachment_dir eq "\n" ) {
2173 $new_attachment_dir = $attachment_dir;
2175 $new_attachment_dir =~ s/[\r\n]//g;
2177 if ( $new_attachment_dir =~ /^\s*$/ ) {
2178 $new_attachment_dir = "";
2180 $new_attachment_dir =~ s/\/*$//g
;
2181 $new_attachment_dir =~ s/$/\//g
;
2183 return $new_attachment_dir;
2187 print "The directory hash level setting allows you to configure the level\n";
2188 print "of hashing that SquirrelMail employs in your data and attachment\n";
2189 print "directories. This value must be an integer ranging from 0 to 4.\n";
2190 print "When this value is set to 0, SquirrelMail will simply store all\n";
2191 print "files as normal in the data and attachment directories. However,\n";
2192 print "when set to a value from 1 to 4, a simple hashing scheme will be\n";
2193 print "used to organize the files in this directory. In short, the crc32\n";
2194 print "value for a username will be computed. Then, up to the first 4\n";
2195 print "digits of the hash, as set by this configuration value, will be\n";
2196 print "used to directory hash the files for that user in the data and\n";
2197 print "attachment directory. This allows for better performance on\n";
2198 print "servers with larger numbers of users.\n";
2201 print "[$WHT$dir_hash_level$NRM]: $WHT";
2202 $new_dir_hash_level = <STDIN
>;
2203 if ( $new_dir_hash_level eq "\n" ) {
2204 $new_dir_hash_level = $dir_hash_level;
2206 $new_dir_hash_level =~ s/[\r\n]//g;
2208 if ( ( int($new_dir_hash_level) < 0 )
2209 || ( int($new_dir_hash_level) > 4 )
2210 || !( int($new_dir_hash_level) eq $new_dir_hash_level ) ) {
2211 print "Invalid Directory Hash Level.\n";
2212 print "Value must be an integer ranging from 0 to 4\n";
2213 print "Hit enter to continue.\n";
2214 $enter_key = <STDIN
>;
2216 $new_dir_hash_level = $dir_hash_level;
2219 return $new_dir_hash_level;
2223 print "This is the default size (in pixels) of the left folder list.\n";
2224 print "Default is 200, but you can set it to whatever you wish. This\n";
2225 print "is a user preference, so this will only show up as their default.\n";
2227 print "[$WHT$default_left_size$NRM]: $WHT";
2228 $new_default_left_size = <STDIN
>;
2229 if ( $new_default_left_size eq "\n" ) {
2230 $new_default_left_size = $default_left_size;
2232 $new_default_left_size =~ s/[\r\n]//g;
2234 return $new_default_left_size;
2238 print "Some IMAP servers only have lowercase letters in the usernames\n";
2239 print "but they still allow people with uppercase to log in. This\n";
2240 print "causes a problem with the user's preference files. This option\n";
2241 print "transparently changes all usernames to lowercase.";
2244 if ( lc($force_username_lowercase) eq 'true' ) {
2245 $default_value = "y";
2247 $default_value = "n";
2249 print "Convert usernames to lowercase (y/n) [$WHT$default_value$NRM]: $WHT";
2250 $new_show = <STDIN
>;
2251 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2261 if ( lc($default_use_priority) eq 'true' ) {
2262 $default_value = "y";
2264 $default_value = "n";
2267 print "Allow users to specify priority of outgoing mail (y/n) [$WHT$default_value$NRM]: $WHT";
2268 $new_show = <STDIN
>;
2269 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2279 if ( lc($default_hide_attribution) eq 'true' ) {
2280 $default_value = "y";
2282 $default_value = "n";
2285 print "Hide SM attributions (y/n) [$WHT$default_value$NRM]: $WHT";
2286 $new_show = <STDIN
>;
2287 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2297 if ( lc($default_use_mdn) eq 'true' ) {
2298 $default_value = "y";
2300 $default_value = "n";
2303 print "Enable support for read/delivery receipt support (y/n) [$WHT$default_value$NRM]: $WHT";
2304 $new_show = <STDIN
>;
2305 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2313 print " In loosely managed environments, you may want to allow users
2314 to edit their full name and email address. In strictly managed
2315 environments, you may want to force users to use the name
2316 and email address assigned to them.
2318 'y' - allow a user to edit their full name and email address,
2319 'n' - users must use the assigned values.
2323 if ( lc($edit_identity) eq 'true' ) {
2324 $default_value = "y";
2326 $default_value = "n";
2328 print "Allow editing of user's identity? (y/n) [$WHT$default_value$NRM]: $WHT";
2329 $new_edit = <STDIN
>;
2330 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2331 $edit_identity = 'true';
2332 $edit_name = 'true';
2333 $hide_auth_header = command311b
();
2335 $edit_identity = 'false';
2336 $edit_name = command311
();
2337 $hide_auth_header = command311b
();
2339 return $edit_identity;
2343 print " Given that users are not allowed to modify their
2344 email address, can they edit their full name?
2348 if ( lc($edit_name) eq 'true' ) {
2349 $default_value = "y";
2351 $default_value = "n";
2353 print "Allow the user to edit their full name? (y/n) [$WHT$default_value$NRM]: $WHT";
2354 $new_edit = <STDIN
>;
2355 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2356 $edit_name = 'true';
2358 $edit_name = 'false';
2364 print " SquirrelMail adds username information to every sent email
2365 in order to prevent possible sender forging when users are allowed
2366 to change their email and/or full name.
2368 You can remove user information from this header (y), if you think that
2369 it violates privacy or security.
2371 Note: If users are allowed to change their email addresses,
2372 this setting will make it difficult to determine who sent what where.
2373 Use at your own risk.
2377 if ( lc($hide_auth_header) eq "true" ) {
2378 $default_value = "y";
2380 $default_value = "n";
2382 print "Remove username from email headers? (y/n) [$WHT$default_value$NRM]: $WHT";
2383 $new_header = <STDIN
>;
2384 if ( ( $new_header =~ /^y\n/i ) || ( ( $new_header =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2385 $hide_auth_header = "true";
2387 $hide_auth_header = "false";
2389 return $hide_auth_header;
2393 print "This option allows you to disable server side thread sorting if your server \n";
2394 print "declares THREAD support, but you don't want to provide threading options \n";
2395 print "to end users or THREAD extension is broken or extension does not work with \n";
2396 print "options used by SquirrelMail. Option is not used, if THREAD extension is \n";
2397 print "not declared in IMAP CAPABILITY.\n";
2400 if ( lc($disable_thread_sort) eq 'true' ) {
2401 $default_value = "y";
2403 $default_value = "n";
2405 print "Disable server side thread sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2406 $disable_thread_sort = <STDIN
>;
2407 if ( ( $disable_thread_sort =~ /^y\n/i ) || ( ( $disable_thread_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2408 $disable_thread_sort = 'true';
2410 $disable_thread_sort = 'false';
2412 return $disable_thread_sort;
2416 print "This option allows you to disable server side sorting if your server declares \n";
2417 print "SORT support, but SORT extension is broken or does not work with options \n";
2418 print "used by SquirrelMail. Option is not used, if SORT extension is not declared \n";
2419 print "in IMAP CAPABILITY.\n";
2421 print "It is strongly recommended to keep server side sorting enabled, if your ";
2422 print "IMAP server supports it.";
2425 if ( lc($disable_server_sort) eq 'true' ) {
2426 $default_value = "y";
2428 $default_value = "n";
2430 print "Disable server-side sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2431 $disable_server_sort = <STDIN
>;
2432 if ( ( $disable_server_sort =~ /^y\n/i ) || ( ( $disable_server_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2433 $disable_server_sort = 'true';
2435 $disable_server_sort = 'false';
2437 return $disable_server_sort;
2441 print "This option allows you to choose if SM uses charset search\n";
2442 print "Your IMAP server must support the SEARCH CHARSET command for this to work\n";
2445 if ( lc($allow_charset_search) eq 'true' ) {
2446 $default_value = "y";
2448 $default_value = "n";
2450 print "Allow charset searching? (y/n) [$WHT$default_value$NRM]: $WHT";
2451 $allow_charset_search = <STDIN
>;
2452 if ( ( $allow_charset_search =~ /^y\n/i ) || ( ( $allow_charset_search =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2453 $allow_charset_search = 'true';
2455 $allow_charset_search = 'false';
2457 return $allow_charset_search;
2460 # command315 (UID support) obsoleted.
2462 # advanced search option
2464 print "This option allows you to control the use of advanced search form.\n";
2465 print " 0 = enable basic search only\n";
2466 print " 1 = enable advanced search only\n";
2467 print " 2 = enable both\n";
2470 print "Allowed search (0,1,2)? [$WHT$allow_advanced_search$NRM]: $WHT";
2471 $new_allow_advanced_search = <STDIN
>;
2472 if ( $new_allow_advanced_search =~ /^[012]\n/i ) {
2473 $allow_advanced_search = $new_allow_advanced_search;
2475 $allow_advanced_search =~ s/[\r\n]//g;
2476 return $allow_advanced_search;
2481 print "This option allows you to change the name of the PHP session used\n";
2482 print "by SquirrelMail. Unless you know what you are doing, you probably\n";
2483 print "don't need or want to change this from the default of SQMSESSID.\n";
2484 print "[$WHT$session_name$NRM]: $WHT";
2485 $new_session_name = <STDIN
>;
2486 chomp($new_session_name);
2487 if ( $new_session_name eq "" ) {
2488 $new_session_name = $session_name;
2490 return $new_session_name;
2493 # time zone config (since 1.5.1)
2495 print "This option allows you to control the use of time zones.\n";
2496 print " 0 = (default) standard, GNU C time zone names\n";
2497 print " 1 = strict, generic time zone codes with offsets\n";
2498 print " 2 = custom, GNU C time zones loaded from config/timezones.php\n";
2499 print " 3 = custom strict, generic time zone codes with offsets loaded \n";
2500 print " from config/timezones.php\n";
2501 print "See SquirrelMail documentation about format of config/timezones.php file.\n";
2504 print "Used time zone configuration (0,1,2,3)? [$WHT$time_zone_type$NRM]: $WHT";
2505 $new_time_zone_type = <STDIN
>;
2506 if ( $new_time_zone_type =~ /^[0123]\n/i ) {
2507 $time_zone_type = $new_time_zone_type;
2509 print "\nInvalid configuration value.\n";
2510 print "\nPress enter to continue...";
2513 $time_zone_type =~ s/[\r\n]//g;
2514 return $time_zone_type;
2517 # set the location base for redirects (since 1.5.2)
2518 sub command_config_location_base
{
2519 print "Here you can set the base part of the SquirrelMail URL.\n";
2520 print "It is normally autodetected but if that fails, use this\n";
2521 print "option to override.\n";
2522 print "It should contain only the protocol and hostname/port parts\n";
2523 print "of the URL; the full path will be appended automatically.\n\n";
2524 print "Examples:\nhttp://webmail.example.org\nhttp://webmail.example.com:8080\nhttps://webmail.example.com:6691\n\n";
2525 print "Do not add any path elements.\n";
2527 print "URL base? [" .$WHT."autodetect$NRM]: $WHT";
2528 $new_config_location_base = <STDIN
>;
2529 chomp($new_config_location_base);
2530 $config_location_base = $new_config_location_base;
2532 return $config_location_base;
2538 print "\nDefine the themes that you wish to use. If you have added ";
2539 print "a theme of your own, just follow the instructions (?) about how to add ";
2540 print "them. You can also change the default theme.\n";
2541 print "[theme] command (?=help) > ";
2543 $input =~ s/[\r\n]//g;
2544 while ( $input ne "d" ) {
2545 if ( $input =~ /^\s*l\s*/i ) {
2547 while ( $count <= $#theme_name ) {
2548 if ( $count == $theme_default ) {
2553 if ( $count < 10 ) {
2556 $name = $theme_name[$count];
2557 $num_spaces = 35 - length($name);
2558 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2559 $name = $name . " ";
2562 print " $count. $name";
2563 print "($theme_path[$count])\n";
2567 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2568 $old_def = $theme_default;
2569 $theme_default = $input;
2570 $theme_default =~ s/^\s*m\s*//;
2571 if ( ( $theme_default > $#theme_name ) || ( $theme_default < 0 ) ) {
2572 print "Cannot set default theme to $theme_default. That theme does not exist.\n";
2573 $theme_default = $old_def;
2575 } elsif ( $input =~ /^\s*\+/ ) {
2576 print "What is the name of this theme: ";
2578 $name =~ s/[\r\n]//g;
2579 $theme_name[ $#theme_name + 1 ] = $name;
2580 print "Be sure to put ../themes/ before the filename.\n";
2581 print "What file is this stored in (ex: ../themes/default_theme.php): ";
2583 $name =~ s/[\r\n]//g;
2584 $theme_path[ $#theme_path + 1 ] = $name;
2585 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2586 if ( $input =~ /[0-9]+\s*$/ ) {
2588 $rem_num =~ s/^\s*-\s*//g;
2589 $rem_num =~ s/\s*$//;
2591 $rem_num = $#theme_name;
2593 if ( $rem_num == $theme_default ) {
2594 print "You cannot remove the default theme!\n";
2597 @new_theme_name = ();
2598 @new_theme_path = ();
2599 while ( $count <= $#theme_name ) {
2600 if ( $count != $rem_num ) {
2601 @new_theme_name = ( @new_theme_name, $theme_name[$count] );
2602 @new_theme_path = ( @new_theme_path, $theme_path[$count] );
2606 @theme_name = @new_theme_name;
2607 @theme_path = @new_theme_path;
2608 if ( $theme_default > $rem_num ) {
2612 } elsif ( $input =~ /^\s*t\s*/i ) {
2613 print "\nStarting detection...\n\n";
2615 opendir( DIR
, "../themes" );
2616 @files = grep { /\.php$/i } readdir(DIR
);
2618 while ( $cnt <= $#files ) {
2619 $filename = "../themes/" . $files[$cnt];
2620 if ( $filename ne "../themes/index.php" ) {
2622 for ( $x = 0 ; $x <= $#theme_path ; $x++ ) {
2623 if ( $theme_path[$x] eq $filename ) {
2627 if ( $found != 1 ) {
2628 print "** Found theme: $filename\n";
2629 print " What is its name? ";
2632 $theme_name[ $#theme_name + 1 ] = $nm;
2633 $theme_path[ $#theme_path + 1 ] = $filename;
2639 for ( $cnt = 0 ; $cnt <= $#theme_path ; $cnt++ ) {
2640 $filename = $theme_path[$cnt];
2641 if ( !( -e
$filename ) ) {
2642 print " Removing $filename (file not found)\n";
2644 @new_theme_name = ();
2645 @new_theme_path = ();
2646 for ( $x = 0 ; $x < $#theme_path ; $x++ ) {
2647 if ( $theme_path[$x] eq $filename ) {
2650 if ( $offset == 1 ) {
2651 $new_theme_name[$x] = $theme_name[ $x + 1 ];
2652 $new_theme_path[$x] = $theme_path[ $x + 1 ];
2654 $new_theme_name[$x] = $theme_name[$x];
2655 $new_theme_path[$x] = $theme_path[$x];
2658 @theme_name = @new_theme_name;
2659 @theme_path = @new_theme_path;
2662 print "\nDetection complete!\n\n";
2665 } elsif ( $input =~ /^\s*\?\s*/ ) {
2666 print ".-------------------------.\n";
2667 print "| t (detect themes) |\n";
2668 print "| + (add theme) |\n";
2669 print "| - N (remove theme) |\n";
2670 print "| m N (mark default) |\n";
2671 print "| l (list themes) |\n";
2672 print "| d (done) |\n";
2673 print "`-------------------------'\n";
2675 print "[theme] command (?=help) > ";
2677 $input =~ s/[\r\n]//g;
2681 sub command_templates
{
2682 print "\nDefine the template sets that you wish to use. If you have added ";
2683 print "a template set of your own, just follow the instructions (?) about how to add ";
2684 print "them. You can also change the default template.\n";
2686 print "\n Available Templates:\n";
2689 while ( $count <= $#templateset_name ) {
2690 if ( $count == $templateset_default ) {
2695 if ( $count < 10 ) {
2698 $name = $templateset_name[$count];
2699 $num_spaces = 35 - length($name);
2700 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2701 $name = $name . " ";
2704 print " $count. $name";
2705 print "($templateset_id[$count])\n";
2710 # FIXME: what is this stuff? it is commented out, can we just blast it?
2711 # opendir( DIR, "../templates" );
2712 # @files = readdir(DIR);
2715 # while ( $cnt <= $#files ) {
2716 # if ( -d "../templates/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne "CVS" ) {
2717 # $filename = "../templates/" . $files[$cnt];
2719 # for ( $x = 0 ; $x <= $#templateset_id ; $x++ ) {
2720 # if ( $theme_path[$x] eq $filename ) {
2727 # for ( $i = 0 ; $i <= $#files ; $i++ ) {
2728 # if ( -d "../templates/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne "CVS" ) {
2730 # for ( $k = 0 ; $k <= $#aTemplateSets ; $k++ ) {
2731 # if ( $aTemplateSets[$chosen] eq $files[$i] ) {
2735 # if ( $match == 0 ) {
2736 # $unused_plugins[$pos] = $files[$i];
2742 # for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
2744 # print " $num. $unused_plugins[$i]\n";
2748 $menu_text = ".-------------------------------------.\n"
2749 . "| t (detect templates set) |\n"
2750 . "| + (add template set) |\n"
2751 . "| - N (remove template set) |\n"
2752 . "| m N (mark default template set) |\n"
2753 . "| l (list template sets) |\n"
2755 . "|-------------------------------------|\n"
2756 . "| where N is a template set number |\n"
2757 . "`-------------------------------------'\n";
2760 print "\n[template set] command (?=help) > ";
2763 $input =~ s/[\r\n]//g;
2764 while ( $input ne "d" ) {
2766 # list template sets
2768 if ( $input =~ /^\s*l\s*/i ) {
2770 while ( $count <= $#templateset_name ) {
2771 if ( $count == $templateset_default ) {
2776 if ( $count < 10 ) {
2779 $name = $templateset_name[$count];
2780 $num_spaces = 35 - length($name);
2781 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2782 $name = $name . " ";
2785 print " $count. $name";
2786 print "($templateset_id[$count])\n";
2791 # mark default template set
2793 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2794 $old_def = $templateset_default;
2795 $templateset_default = $input;
2796 $templateset_default =~ s/^\s*m\s*//;
2797 if ( ( $templateset_default > $#templateset_name ) || ( $templateset_default < 0 ) ) {
2798 print "Cannot set default template set to $templateset_default. That template set does not exist.\n";
2799 $templateset_default = $old_def;
2804 } elsif ( $input =~ /^\s*\+/ ) {
2805 print "\nWhat is the name of this template (as shown to your users): ";
2807 $name =~ s/[\r\n]//g;
2808 $templateset_name[ $#templateset_name + 1 ] = $name;
2809 print "\n\nThe directory name should not contain any path information\n"
2810 . "or slashes, and should be the name of the directory that the\n"
2811 . "template set is found in within the SquirrelMail templates\n"
2813 print "What directory is this stored in (ex: default_advanced): ";
2815 $name =~ s/[\r\n]//g;
2816 $templateset_id[ $#templateset_id + 1 ] = $name;
2818 # detect template sets
2820 } elsif ( $input =~ /^\s*t\s*/i ) {
2821 print "\nStarting detection...\n\n";
2822 opendir( DIR
, "../templates" );
2823 @files = readdir(DIR
);
2825 while ( $cnt <= $#files ) {
2826 if ( -d
"../templates/" . $files[$cnt] && $files[$cnt] !~ /^\./ && $files[$cnt] ne "CVS" ) {
2827 $filename = $files[$cnt];
2829 for ( $x = 0 ; $x <= $#templateset_id ; $x++ ) {
2830 if ( $templateset_id[$x] eq $filename ) {
2836 print "** Found template set: $filename\n";
2837 print " What is it's name (as shown to your users)? ";
2840 $templateset_id[ $#templateset_id + 1 ] = $filename;
2841 $templateset_name[ $#templateset_name + 1 ] = $nm;
2842 # FIXME: why are these two lines here?
2843 # $aTemplateSet[ $#templateset_name + 1 ] = $nm;
2844 # $aTemplateSet[ $#templateset_id + 1 ] = $filename;
2850 for ( $cnt= 0 ; $cnt <= $#templateset_id ; ) {
2851 $filename = $templateset_id[$cnt];
2852 if ( !(-d change_to_rel_path
('SM_PATH . \'templates/' . $filename)) ) {
2853 print " Removing \"$filename\" (template set directory not found)\n";
2854 if ( $templateset_default gt $cnt ) { $templateset_default--; }
2855 elsif ( $templateset_default eq $cnt ) { $templateset_default = 0; }
2857 @new_templateset_name = ();
2858 @new_templateset_id = ();
2859 for ( $x = 0 ; $x < $#templateset_id ; $x++ ) {
2860 if ( $templateset_id[$x] eq $filename ) {
2863 if ( $offset == 1 ) {
2864 $new_templateset_name[$x] = $templateset_name[ $x + 1 ];
2865 $new_templateset_id[$x] = $templateset_id[ $x + 1 ];
2867 $new_templateset_name[$x] = $templateset_name[$x];
2868 $new_templateset_id[$x] = $templateset_id[$x];
2871 @templateset_name = @new_templateset_name;
2872 @templateset_id = @new_templateset_id;
2875 print "\nDetection complete!\n\n";
2879 # remove template set
2881 # undocumented functionality of removing last template set isn't that great
2882 #} elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2883 } elsif ( $input =~ /^\s*-\s*[0-9]+/ ) {
2884 if ( $input =~ /[0-9]+\s*$/ ) {
2886 $rem_num =~ s/^\s*-\s*//g;
2887 $rem_num =~ s/\s*$//;
2889 $rem_num = $#templateset_name;
2891 if ( $rem_num == $templateset_default ) {
2892 print "You cannot remove the default template set!\n";
2895 @new_templateset_name = ();
2896 @new_templateset_id = ();
2897 while ( $count <= $#templateset_name ) {
2898 if ( $count != $rem_num ) {
2899 @new_templateset_name = ( @new_templateset_name, $templateset_name[$count] );
2900 @new_templateset_id = ( @new_templateset_id, $templateset_id[$count] );
2904 @templateset_name = @new_templateset_name;
2905 @templateset_id = @new_templateset_id;
2906 if ( $templateset_default > $rem_num ) {
2907 $templateset_default--;
2913 } elsif ( $input =~ /^\s*\?\s*/ ) {
2916 print "[template set] command (?=help) > ";
2918 $input =~ s/[\r\n]//g;
2920 return $templateset_default;
2924 # sets default font size option
2925 sub command_default_fontsize
{
2926 print "Enter default font size [$WHT$$default_fontsize$NRM]: $WHT";
2927 $new_size = <STDIN
>;
2928 if ( $new_size eq "\n" ) {
2931 $new_size =~ s/[\r\n]//g;
2936 # controls available fontsets
2937 sub command_fontsets
{
2939 print "You can control fontsets available to end users here.\n";
2940 # set initial $input value
2942 while ( $input ne "x" ) {
2943 if ( $input =~ /^\s*a\s*/i ) {
2945 print "\nFontset name: ";
2947 if (! $fontsets{trim
($name)}) {
2948 print "Fontset string: ";
2950 $fontsets{trim
($name)} = trim
($value);
2952 print "\nERROR: Such fontset already exists.\n";
2954 } elsif ( $input =~ /^\s*e\s*/i ) {
2955 # edit existing fontset
2956 print "\nFontset name: ";
2958 if (! $fontsets{trim
($name)}) {
2959 print "\nERROR: No such fontset.\n";
2961 print "Fontset string [$fontsets{trim($name)}]: ";
2963 $fontsets{trim
($name)} = trim
($value);
2965 } elsif ( $input =~ /^\s*d\s*/ ) {
2966 # delete existing fontset
2967 print "\nFontset name: ";
2969 if (! $fontsets{trim
($name)}) {
2970 print "\nERROR: No such fontset.\n";
2972 delete $fontsets{trim
($name)};
2974 } elsif ( $input =~ /^\s*l\s*/ ) {
2976 print "\nConfigured fontsets:\n";
2977 while (($fontset_name, $fontset_string) = each(%fontsets)) {
2978 print " $fontset_name = $fontset_string\n";
2980 print "Default fontset: $default_fontset\n";
2981 } elsif ( $input =~ /^\s*m\s*/ ) {
2982 # set default fontset
2983 print "\nSet default fontset [$default_fontset]: ";
2985 if (trim
($name) ne '' and ! $fontsets{trim
($name)}) {
2986 print "\nERROR: No such fontset.\n";
2988 $default_fontset = trim
($name);
2991 # print available commands on any other input
2992 print "\nAvailable commands:\n";
2993 print " a - Adds new fontset.\n";
2994 print " d - Deletes existing fontset.\n";
2995 print " e - Edits existing fontset.\n";
2996 print " h or ? - Shows this help screen.\n";
2997 print " l - Lists available fontsets.\n";
2998 print " m - Sets default fontset.\n";
2999 print " x - Exits fontset editor mode.\n";
3001 print "\nCommand [fontsets] (a,d,e,h,?=help,l,m,x)> ";
3003 $input =~ s/[\r\n]//g;
3008 print "You can now define different LDAP servers.\n";
3009 print "Please ensure proper permissions for config.php when including\n";
3010 print "sensitive passwords.\n\n";
3011 print "[ldap] command (?=help) > ";
3013 $input =~ s/[\r\n]//g;
3014 while ( $input ne "d" ) {
3015 if ( $input =~ /^\s*l\s*/i ) {
3017 while ( $count <= $#ldap_host ) {
3018 print "$count. $ldap_host[$count]\n";
3019 print " base: $ldap_base[$count]\n";
3020 if ( $ldap_charset[$count] ) {
3021 print " charset: $ldap_charset[$count]\n";
3023 if ( $ldap_port[$count] ) {
3024 print " port: $ldap_port[$count]\n";
3026 if ( $ldap_name[$count] ) {
3027 print " name: $ldap_name[$count]\n";
3029 if ( $ldap_maxrows[$count] ) {
3030 print " maxrows: $ldap_maxrows[$count]\n";
3032 if ( $ldap_filter[$count] ) {
3033 print " filter: $ldap_filter[$count]\n";
3035 if ( $ldap_binddn[$count] ) {
3036 print " binddn: $ldap_binddn[$count]\n";
3037 if ( $ldap_bindpw[$count] ) {
3038 print " bindpw: $ldap_bindpw[$count]\n";
3041 if ( $ldap_protocol[$count] ) {
3042 print " protocol: $ldap_protocol[$count]\n";
3044 if ( $ldap_limit_scope[$count] ) {
3045 print " limit_scope: $ldap_limit_scope[$count]\n";
3047 if ( $ldap_listing[$count] ) {
3048 print " listing: $ldap_listing[$count]\n";
3050 if ( $ldap_writeable[$count] ) {
3051 print " writeable: $ldap_writeable[$count]\n";
3053 if ( $ldap_search_tree[$count] ) {
3054 print " search_tree: $ldap_search_tree[$count]\n";
3056 if ( $ldap_starttls[$count] ) {
3057 print " starttls: $ldap_starttls[$count]\n";
3063 } elsif ( $input =~ /^\s*\+/ ) {
3064 $sub = $#ldap_host + 1;
3066 print "First, we need to have the hostname or the IP address where\n";
3067 print "this LDAP server resides. Example: ldap.bigfoot.com\n";
3069 print "You can use any URI compatible with your LDAP library. Please\n";
3070 print "note that StartTLS option is not compatible with ldaps and\n";
3071 print "ldapi URIs.\n";
3074 $name =~ s/[\r\n]//g;
3075 $ldap_host[$sub] = $name;
3079 print "Next, we need the server root (base dn). For this, an empty\n";
3080 print "string is allowed.\n";
3081 print "Example: ou=member_directory,o=netcenter.com\n";
3084 $name =~ s/[\r\n]//g;
3085 $ldap_base[$sub] = $name;
3089 print "This is the TCP/IP port number for the LDAP server. Default\n";
3090 print "port is 389. This is optional. Press ENTER for default.\n";
3093 $name =~ s/[\r\n]//g;
3094 $ldap_port[$sub] = $name;
3098 print "This is the charset for the server. Default is utf-8. This\n";
3099 print "is also optional. Press ENTER for default.\n";
3102 $name =~ s/[\r\n]//g;
3103 $ldap_charset[$sub] = $name;
3107 print "This is the name for the server, used to tag the results of\n";
3108 print "the search. Default it \"LDAP: hostname\". Press ENTER for default\n";
3111 $name =~ s/[\r\n]//g;
3112 $ldap_name[$sub] = $name;
3116 print "You can specify the maximum number of rows in the search result.\n";
3117 print "Default value is equal to 250 rows. Press ENTER for default.\n";
3120 $name =~ s/[\r\n]//g;
3121 $ldap_maxrows[$sub] = $name;
3126 print "If your LDAP server does not like anonymous logins, you can specify bind DN.\n";
3127 print "Default is none, anonymous bind. Press ENTER for default.\n";
3130 $name =~ s/[\r\n]//g;
3131 $ldap_binddn[$sub] = $name;
3135 if ( $ldap_binddn[$sub] ne '' ) {
3137 print "Now, please specify password for that DN.\n";
3140 $name =~ s/[\r\n]//g;
3141 $ldap_bindpw[$sub] = $name;
3146 print "You can specify bind protocol version here.\n";
3147 print "Default protocol version depends on your php ldap settings.\n";
3148 print "Press ENTER for default.\n";
3151 $name =~ s/[\r\n]//g;
3152 $ldap_protocol[$sub] = $name;
3156 print "This configuration section allows to set some rarely used\n";
3157 print "options and options specific to some LDAP implementations.\n";
3159 print "Do you want to set advanced LDAP directory settings? (y/N):";
3160 $ldap_advanced_settings = <STDIN
>;
3161 if ( $ldap_advanced_settings =~ /^y\n/i ) {
3162 $ldap_advanced_settings = 'true';
3164 $ldap_advanced_settings = 'false';
3167 if ($ldap_advanced_settings eq 'true') {
3170 print "You can control LDAP directory listing here. This option can\n";
3171 print "be useful if you run small LDAP server and want to provide listing\n";
3172 print "of all addresses stored in LDAP to users of webmail interface.\n";
3173 print "Number of displayed entries is limited by maxrows setting.\n";
3175 print "Don't enable this option for public LDAP directories.\n";
3177 print "Allow listing of LDAP directory? (y/N):";
3179 if ( $name =~ /^y\n/i ) {
3184 $ldap_listing[$sub] = $name;
3188 print "You can control write access to LDAP address book here. This option can\n";
3189 print "be useful if you run small LDAP server and want to provide writable\n";
3190 print "shared address book stored in LDAP to users of webmail interface.\n";
3192 print "Don't enable this option for public LDAP directories.\n";
3194 print "Allow writing to LDAP directory? (y/N):";
3196 if ( $name =~ /^y\n/i ) {
3201 $ldap_writeable[$sub] = $name;
3205 print "You can specify an additional search filter.\n";
3206 print "This could be something like \"(objectclass=posixAccount)\".\n";
3207 print "No filtering is performed by default. Press ENTER for default.\n";
3210 $name =~ s/[\r|\n]//g;
3211 $ldap_filter[$sub] = $name;
3215 print "You can control search scope here.\n";
3216 print "This option is specific to Microsoft ADS implementation.\n";
3217 print "It requires use of v3 or newer LDAP protocol.\n";
3218 print "Don't enable it, if you use other LDAP server.\n";
3220 print "Limit ldap scope? (y/N):";
3222 if ( $name =~ /^y\n/i ) {
3227 $ldap_limit_scope[$sub] = $name;
3231 print "You can control ldap search type here.\n";
3232 print "Addresses can be searched in entire LDAP subtree (default)\n";
3233 print "or only first level entries are returned.\n";
3235 print "Search entire LDAP subtree? (Y/n):";
3237 if ( $name =~ /^n\n/i ) {
3242 $ldap_search_tree[$sub] = $name;
3246 print "You can control use of StartTLS on LDAP connection here.\n";
3247 print "This option requires use of v3 or newer LDAP protocol and php 4.2+.\n";
3249 print "Use StartTLS? (y/N):";
3251 if ( $name =~ /^y\n/i ) {
3256 $ldap_starttls[$sub] = $name;
3260 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3261 if ( $input =~ /[0-9]+\s*$/ ) {
3263 $rem_num =~ s/^\s*-\s*//g;
3264 $rem_num =~ s/\s*$//;
3266 $rem_num = $#ldap_host;
3269 @new_ldap_host = ();
3270 @new_ldap_base = ();
3271 @new_ldap_port = ();
3272 @new_ldap_name = ();
3273 @new_ldap_charset = ();
3274 @new_ldap_maxrows = ();
3275 @new_ldap_filter = ();
3276 @new_ldap_bindpw = ();
3277 @new_ldap_binddn = ();
3278 @new_ldap_protocol = ();
3279 @new_ldap_limit_scope = ();
3280 @new_ldap_listing = ();
3281 @new_ldap_writeable = ();
3282 @new_ldap_search_tree = ();
3283 @new_ldap_starttls = ();
3285 while ( $count <= $#ldap_host ) {
3286 if ( $count != $rem_num ) {
3287 @new_ldap_host = ( @new_ldap_host, $ldap_host[$count] );
3288 @new_ldap_base = ( @new_ldap_base, $ldap_base[$count] );
3289 @new_ldap_port = ( @new_ldap_port, $ldap_port[$count] );
3290 @new_ldap_name = ( @new_ldap_name, $ldap_name[$count] );
3291 @new_ldap_charset = ( @new_ldap_charset, $ldap_charset[$count] );
3292 @new_ldap_maxrows = ( @new_ldap_maxrows, $ldap_maxrows[$count] );
3293 @new_ldap_filter = ( @new_ldap_filter, $ldap_filter[$count] );
3294 @new_ldap_binddn = ( @new_ldap_binddn, $ldap_binddn[$count] );
3295 @new_ldap_bindpw = ( @new_ldap_bindpw, $ldap_bindpw[$count] );
3296 @new_ldap_protocol = ( @new_ldap_protocol, $ldap_protocol[$count] );
3297 @new_ldap_limit_scope = ( @new_ldap_limit_scope, $ldap_limit_scope[$count] );
3298 @new_ldap_listing = ( @new_ldap_listing, $ldap_listing[$count] );
3299 @new_ldap_writeable = ( @new_ldap_writeable, $ldap_writeable[$count] );
3300 @new_ldap_search_tree = ( @new_ldap_search_tree, $ldap_search_tree[$count] );
3301 @new_ldap_starttls = ( @new_ldap_starttls, $ldap_starttls[$count] );
3305 @ldap_host = @new_ldap_host;
3306 @ldap_base = @new_ldap_base;
3307 @ldap_port = @new_ldap_port;
3308 @ldap_name = @new_ldap_name;
3309 @ldap_charset = @new_ldap_charset;
3310 @ldap_maxrows = @new_ldap_maxrows;
3311 @ldap_filter = @new_ldap_filter;
3312 @ldap_binddn = @new_ldap_binddn;
3313 @ldap_bindpw = @new_ldap_bindpw;
3314 @ldap_protocol = @new_ldap_protocol;
3315 @ldap_limit_scope = @new_ldap_limit_scope;
3316 @ldap_listing = @new_ldap_listing;
3317 @ldap_writeable = @new_ldap_writeable;
3318 @ldap_search_tree = @new_ldap_search_tree;
3319 @ldap_starttls = @new_ldap_starttls;
3321 } elsif ( $input =~ /^\s*\?\s*/ ) {
3322 print ".-------------------------.\n";
3323 print "| + (add host) |\n";
3324 print "| - N (remove host) |\n";
3325 print "| l (list hosts) |\n";
3326 print "| d (done) |\n";
3327 print "`-------------------------'\n";
3329 print "[ldap] command (?=help) > ";
3331 $input =~ s/[\r\n]//g;
3336 print "Some of our developers have come up with very good javascript interface\n";
3337 print "for searching through address books, however, our original goals said\n";
3338 print "that we would be 100% HTML. In order to make it possible to use their\n";
3339 print "interface, and yet stick with our goals, we have also written a plain\n";
3340 print "HTML version of the search. Here, you can choose which version to use.\n";
3342 print "This is just the default value. It is also a user option that each\n";
3343 print "user can configure individually\n";
3346 if ( lc($default_use_javascript_addr_book) eq 'true' ) {
3347 $default_value = "y";
3349 $default_use_javascript_addr_book = 'false';
3350 $default_value = "n";
3352 print "Use javascript version by default (y/n) [$WHT$default_value$NRM]: $WHT";
3353 $new_show = <STDIN
>;
3354 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3355 $default_use_javascript_addr_book = 'true';
3357 $default_use_javascript_addr_book = 'false';
3359 return $default_use_javascript_addr_book;
3362 # global filebased address book
3364 print "If you want to use global file address book, then you\n";
3365 print "must set this option to a valid value. If option does\n";
3366 print "not have path elements, system assumes that file is\n";
3367 print "stored in data directory. If relative path is set, it is\n";
3368 print "relative to main SquirrelMail directory. If value is empty,\n";
3369 print "address book is not enabled.\n";
3372 print "[$WHT$abook_global_file$NRM]: $WHT";
3373 $new_abook_global_file = <STDIN
>;
3374 if ( $new_abook_global_file eq "\n" ) {
3375 $new_abook_global_file = $abook_global_file;
3377 $new_abook_global_file =~ s/[\r\n]//g;
3379 return $new_abook_global_file;
3382 # writing into global filebased abook control
3384 print "This setting controls writing into global file address\n";
3385 print "book options. Address book file must be writeable by\n";
3386 print "webserver's user, if you want to enable this option.\n";
3389 if ( lc($abook_global_file_writeable) eq 'true' ) {
3390 $default_value = "y";
3392 $abook_global_file_writeable = 'false';
3393 $default_value = "n";
3395 print "Allow writing into global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
3396 $new_show = <STDIN
>;
3397 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3398 $abook_global_file_writeable = 'true';
3400 $abook_global_file_writeable = 'false';
3402 return $abook_global_file_writeable;
3405 # listing of global filebased abook control
3407 print "This setting controls listing of global file address\n";
3408 print "book in addresses page.\n";
3411 if ( lc($abook_global_file_listing) eq 'true' ) {
3412 $default_value = "y";
3414 $abook_global_file_listing = 'false';
3415 $default_value = "n";
3417 print "Allow listing of global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
3418 $new_show = <STDIN
>;
3419 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3420 $abook_global_file_listing = 'true';
3422 $abook_global_file_listing = 'false';
3424 return $abook_global_file_listing;
3427 # controls $abook_file_line_length setting
3428 sub command_abook_file_line_length
{
3429 print "This setting controls space allocated to file based address book records.\n";
3430 print "End users will be unable to save address book entry, if total entry size \n";
3431 print "(quoted address book fields + 4 delimiters + linefeed) exceeds allowed \n";
3432 print "address book length size.\n";
3434 print "Same setting is applied to personal and global file based address books.\n";
3436 print "It is strongly recommended to keep default setting value. Change it only\n";
3437 print "if you really want to store address book entries that are bigger than two\n";
3438 print "kilobytes (2048).\n";
3441 print "Enter allowed address book line length [$abook_file_line_length]: ";
3444 # value is not modified, if user hits Enter or enters space
3446 # make sure that input is numeric
3447 if ($tmp =~ /^\d+$/) {
3448 $abook_file_line_length = $tmp;
3450 print "If you want to change this setting, you must enter number.\n";
3451 print "If you want to keep original setting - enter space.\n\n";
3452 print "Press Enter to continue...";
3459 print "If you want to store your users address book details in a database then\n";
3460 print "you need to set this DSN to a valid value. The format for this is:\n";
3461 print "mysql://user:pass\@hostname/dbname\n";
3462 print "Where mysql can be one of the databases PHP supports, the most common\n";
3463 print "of these are mysql, msql and pgsql.\n";
3464 print "Please ensure proper permissions for config.php when including\n";
3465 print "sensitive passwords.\n\n";
3466 print "If the DSN is left empty (hit space and then return) the database\n";
3467 print "related code for address books will not be used.\n";
3470 if ( $addrbook_dsn eq "" ) {
3471 $default_value = "Disabled";
3473 $default_value = $addrbook_dsn;
3475 print "[$WHT$addrbook_dsn$NRM]: $WHT";
3477 if ( $new_dsn eq "\n" ) {
3480 $new_dsn =~ s/[\r\n]//g;
3481 $new_dsn =~ s/^\s+$//g;
3487 print "This is the name of the table you want to store the address book\n";
3488 print "data in, it defaults to 'address'\n";
3490 print "[$WHT$addrbook_table$NRM]: $WHT";
3491 $new_table = <STDIN
>;
3492 if ( $new_table eq "\n" ) {
3493 $new_table = $addrbook_table;
3495 $new_table =~ s/[\r\n]//g;
3501 print "If you want to store your users preferences in a database then\n";
3502 print "you need to set this DSN to a valid value. The format for this is:\n";
3503 print "mysql://user:pass\@hostname/dbname\n";
3504 print "Where mysql can be one of the databases PHP supports, the most common\n";
3505 print "of these are mysql, msql and pgsql.\n";
3506 print "Please ensure proper permissions for config.php when including\n";
3507 print "sensitive passwords.\n\n";
3508 print "If the DSN is left empty (hit space and then return) the database\n";
3509 print "related code for address books will not be used.\n";
3512 if ( $prefs_dsn eq "" ) {
3513 $default_value = "Disabled";
3515 $default_value = $prefs_dsn;
3517 print "[$WHT$prefs_dsn$NRM]: $WHT";
3519 if ( $new_dsn eq "\n" ) {
3522 $new_dsn =~ s/[\r\n]//g;
3523 $new_dsn =~ s/^\s+$//g;
3529 print "This is the name of the table you want to store the preferences\n";
3530 print "data in, it defaults to 'userprefs'\n";
3532 print "[$WHT$prefs_table$NRM]: $WHT";
3533 $new_table = <STDIN
>;
3534 if ( $new_table eq "\n" ) {
3535 $new_table = $prefs_table;
3537 $new_table =~ s/[\r\n]//g;
3543 print "This is the name of the field in which you want to store the\n";
3544 print "username of the person the prefs are for. It default to 'user'\n";
3545 print "which clashes with a reserved keyword in PostgreSQL so this\n";
3546 print "will need to be changed for that database at least\n";
3548 print "[$WHT$prefs_user_field$NRM]: $WHT";
3549 $new_field = <STDIN
>;
3550 if ( $new_field eq "\n" ) {
3551 $new_field = $prefs_user_field;
3553 $new_field =~ s/[\r\n]//g;
3555 $prefs_user_size = db_pref_size
($prefs_user_size);
3560 print "This is the name of the field in which you want to store the\n";
3561 print "preferences keyword. It defaults to 'prefkey'\n";
3563 print "[$WHT$prefs_key_field$NRM]: $WHT";
3564 $new_field = <STDIN
>;
3565 if ( $new_field eq "\n" ) {
3566 $new_field = $prefs_key_field;
3568 $new_field =~ s/[\r\n]//g;
3570 $prefs_key_size = db_pref_size
($prefs_key_size);
3575 print "This is the name of the field in which you want to store the\n";
3576 print "preferences value. It defaults to 'prefval'\n";
3578 print "[$WHT$prefs_val_field$NRM]: $WHT";
3579 $new_field = <STDIN
>;
3580 if ( $new_field eq "\n" ) {
3581 $new_field = $prefs_val_field;
3583 $new_field =~ s/[\r\n]//g;
3585 $prefs_val_size = db_pref_size
($prefs_val_size);
3589 # routine is used to set database field limits
3590 # it needs one argument
3591 sub db_pref_size
() {
3593 print "\nDatabase fields have size limits.\n";
3595 print "What limit is set for this field? [$WHT$size$NRM]: $WHT";
3596 $new_size = <STDIN
>;
3597 if ( $new_size eq "\n" ) {
3600 $new_size =~ s/[\r\n]//g;
3606 print "If you want to store your global address book in a database then\n";
3607 print "you need to set this DSN to a valid value. The format for this is:\n";
3608 print "mysql://user:pass\@hostname/dbname\n";
3609 print "Where mysql can be one of the databases PHP supports, the most common\n";
3610 print "of these are mysql, msql and pgsql.\n";
3611 print "Please ensure proper permissions for config.php when including\n";
3612 print "sensitive passwords.\n\n";
3613 print "If the DSN is left empty (hit space and then return) the database\n";
3614 print "related code for global SQL address book will not be used.\n";
3617 if ( $addrbook_global_dsn eq "" ) {
3618 $default_value = "Disabled";
3620 $default_value = $addrbook_global_dsn;
3622 print "[$WHT$addrbook_global_dsn$NRM]: $WHT";
3624 if ( $new_dsn eq "\n" ) {
3627 $new_dsn =~ s/[\r\n]//g;
3628 $new_dsn =~ s/^\s+$//g;
3634 print "This is the name of the table you want to store the global address book\n";
3635 print "data in. Default table name is 'global_abook'. Address book uses same\n";
3636 print "database format as personal address book.\n";
3638 print "[$WHT$addrbook_global_table$NRM]: $WHT";
3639 $new_table = <STDIN
>;
3640 if ( $new_table eq "\n" ) {
3641 $new_table = $addrbook_global_table;
3643 $new_table =~ s/[\r\n]//g;
3649 print "This option controls users\' ability to add or modify records stored \n";
3650 print "in global address book\n";
3652 if ( lc($addrbook_global_writeable) eq 'true' ) {
3653 $default_value = "y";
3655 $default_value = "n";
3657 print "Allow writing into global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
3658 $addrbook_global_writeable = <STDIN
>;
3659 if ( ( $addrbook_global_writeable =~ /^y\n/i ) || ( ( $addrbook_global_writeable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3660 $addrbook_global_writeable = 'true';
3662 $addrbook_global_writeable = 'false';
3664 return $addrbook_global_writeable;
3668 print "Enable this option if you want to see listing of addresses stored \n";
3669 print "in global address book\n";
3671 if ( lc($addrbook_global_listing) eq 'true' ) {
3672 $default_value = "y";
3674 $default_value = "n";
3676 print "Allow listing of global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
3677 $addrbook_global_listing = <STDIN
>;
3678 if ( ( $addrbook_global_listing =~ /^y\n/i ) || ( ( $addrbook_global_listing =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3679 $addrbook_global_listing = 'true';
3681 $addrbook_global_listing = 'false';
3683 return $addrbook_global_listing;
3689 print "SquirrelMail attempts to set the language in many ways. If it\n";
3690 print "can not figure it out in another way, it will default to this\n";
3691 print "language. Please use the code for the desired language.\n";
3693 print "[$WHT$squirrelmail_default_language$NRM]: $WHT";
3694 $new_squirrelmail_default_language = <STDIN
>;
3695 if ( $new_squirrelmail_default_language eq "\n" ) {
3696 $new_squirrelmail_default_language = $squirrelmail_default_language;
3698 $new_squirrelmail_default_language =~ s/[\r\n]//g;
3699 $new_squirrelmail_default_language =~ s/^\s+$//g;
3701 return $new_squirrelmail_default_language;
3705 print "This option controls what character set is used when sending\n";
3706 print "mail and when sending HTML to the browser. Option works only\n";
3707 print "with US English (en_US) translation. Other translations use\n";
3708 print "charsets that are set in translation settings.\n";
3711 print "[$WHT$default_charset$NRM]: $WHT";
3712 $new_default_charset = <STDIN
>;
3713 if ( $new_default_charset eq "\n" ) {
3714 $new_default_charset = $default_charset;
3716 $new_default_charset =~ s/[\r\n]//g;
3718 return $new_default_charset;
3720 # Alternative language names
3722 print "Enable this option if you want to see localized language names in\n";
3723 print "language selection box. Note, that this option can trigger\n";
3724 print "installation of foreign language support modules in some browsers.\n";
3727 if ( lc($show_alternative_names) eq 'true' ) {
3728 $default_value = "y";
3730 $default_value = "n";
3732 print "Show alternative language names? (y/n) [$WHT$default_value$NRM]: $WHT";
3733 $show_alternative_names = <STDIN
>;
3734 if ( ( $show_alternative_names =~ /^y\n/i ) || ( ( $show_alternative_names =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3735 $show_alternative_names = 'true';
3737 $show_alternative_names = 'false';
3739 return $show_alternative_names;
3742 # Aggressive decoding
3744 print "Enable this option if you want to use CPU and memory intensive decoding\n";
3745 print "functions. This option allows reading multibyte charset, that are used\n";
3746 print "in Eastern Asia. SquirrelMail will try to use recode functions here,\n";
3747 print "even when you have disabled use of recode in Tweaks section.\n";
3750 if ( lc($aggressive_decoding) eq 'true' ) {
3751 $default_value = "y";
3753 $default_value = "n";
3755 print "Enable aggressive decoding? (y/n) [$WHT$default_value$NRM]: $WHT";
3756 $aggressive_decoding = <STDIN
>;
3757 if ( ( $aggressive_decoding =~ /^y\n/i ) || ( ( $aggressive_decoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3758 $aggressive_decoding = 'true';
3760 $aggressive_decoding = 'false';
3762 return $aggressive_decoding;
3767 print "Enable this option if you want to allow lossy charset encoding in message\n";
3768 print "composition pages. This option allows charset conversions when output\n";
3769 print "charset does not support all symbols used in original charset. Symbols\n";
3770 print "unsupported by output charset will be replaced with question marks.\n";
3773 if ( lc($lossy_encoding) eq 'true' ) {
3774 $default_value = "y";
3776 $default_value = "n";
3778 print "Enable lossy encoding? (y/n) [$WHT$default_value$NRM]: $WHT";
3779 $lossy_encoding = <STDIN
>;
3780 if ( ( $lossy_encoding =~ /^y\n/i ) || ( ( $lossy_encoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3781 $lossy_encoding = 'true';
3783 $lossy_encoding = 'false';
3785 return $lossy_encoding;
3788 # display html emails in iframe
3790 print "This option can enable html email rendering inside iframe.\n";
3791 print "Inline frames are used in order to provide sandbox environment";
3792 print "for html code included in html formated emails.";
3793 print "Option is experimental and might have glitches in some parts of code.";
3796 if ( lc($use_iframe) eq 'true' ) {
3797 $default_value = "y";
3799 $default_value = "n";
3801 print "Display html emails in iframe? (y/n) [$WHT$default_value$NRM]: $WHT";
3802 $use_iframe = <STDIN
>;
3803 if ( ( $use_iframe =~ /^y\n/i ) || ( ( $use_iframe =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3804 $use_iframe = 'true';
3806 $use_iframe = 'false';
3812 print "Enabling this option will cause icons to be used instead of text\n";
3813 print "markers next to each message in mailbox lists that represent\n";
3814 print "new, read, flagged, and deleted messages, as well as those that\n";
3815 print "have been replied to and forwarded. Icons are also used next to\n";
3816 print "(un)expanded folders in the folder list (Oldway = false). These\n";
3817 print "icons are quite small, but will obviously be more of a resource\n";
3818 print "drain than text markers.\n";
3821 if ( lc($use_icons) eq 'true' ) {
3822 $default_value = "y";
3824 $default_value = "n";
3826 print "Use icons? (y/n) [$WHT$default_value$NRM]: $WHT";
3827 $use_icons = <STDIN
>;
3828 if ( ( $use_icons =~ /^y\n/i ) || ( ( $use_icons =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3829 $use_icons = 'true';
3831 $use_icons = 'false';
3837 print "Enable this option if you want to use php recode functions to read\n";
3838 print "emails written in charset that differs from the one that is set in\n";
3839 print "translation selected by user. Code is experimental, it might cause\n";
3840 print "errors, if email contains charset unsupported by recode or if your\n";
3841 print "php does not have recode support.\n";
3844 if ( lc($use_php_recode) eq 'true' ) {
3845 $default_value = "y";
3847 $default_value = "n";
3849 print "Use php recode functions? (y/n) [$WHT$default_value$NRM]: $WHT";
3850 $use_php_recode = <STDIN
>;
3851 if ( ( $use_php_recode =~ /^y\n/i ) || ( ( $use_php_recode =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3852 $use_php_recode = 'true';
3854 $use_php_recode = 'false';
3856 return $use_php_recode;
3860 print "Enable this option if you want to use php iconv functions to read\n";
3861 print "emails written in charset that differs from the one that is set in\n";
3862 print "translation selected by user. Code is experimental, it works only\n";
3863 print "with translations that use utf-8 charset. Code might cause errors,\n";
3864 print "if email contains charset unsupported by iconv or if your php does\n";
3865 print "not have iconv support.\n";
3868 if ( lc($use_php_iconv) eq 'true' ) {
3869 $default_value = "y";
3871 $default_value = "n";
3873 print "Use php iconv functions? (y/n) [$WHT$default_value$NRM]: $WHT";
3874 $use_php_iconv = <STDIN
>;
3875 if ( ( $use_php_iconv =~ /^y\n/i ) || ( ( $use_php_iconv =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3876 $use_php_iconv = 'true';
3878 $use_php_iconv = 'false';
3880 return $use_php_iconv;
3885 print "Enable this option if you want to check SquirrelMail configuration\n";
3886 print "remotely with configtest.php script.\n";
3889 if ( lc($allow_remote_configtest) eq 'true' ) {
3890 $default_value = "y";
3892 $default_value = "n";
3894 print "Allow remote configuration tests? (y/n) [$WHT$default_value$NRM]: $WHT";
3895 $allow_remote_configtest = <STDIN
>;
3896 if ( ( $allow_remote_configtest =~ /^y\n/i ) || ( ( $allow_remote_configtest =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3897 $allow_remote_configtest = 'true';
3899 $allow_remote_configtest = 'false';
3901 return $allow_remote_configtest;
3904 # Default Icon theme
3906 print "You may change the path to the default icon theme to be used, if icons\n";
3907 print "have been enabled. This theme will be used when an icon cannot be\n";
3908 print "found in the current theme, or when no icon theme is specified. If\n";
3909 print "left blank, and icons are enabled, the default theme will be used\n";
3910 print "from images/themes/default/.\n";
3912 print "To clear out an existing value, just type a space for the input.\n";
3914 print "Please be aware of the following: \n";
3915 print " - Relative URLs are relative to the config dir\n";
3916 print " to use the icon themes directory, use ../images/themes/newtheme/\n";
3917 print " - The icon theme may be outside the SquirrelMail directory, but\n";
3918 print " it must be web accessible.\n";
3919 print "[$WHT$icon_theme_def$NRM]: $WHT";
3920 $new_icon_theme_def = <STDIN
>;
3922 if ( $new_icon_theme_def eq "\n" ) {
3923 $new_icon_theme_def = $icon_theme_def;
3925 $new_icon_theme_def =~ s/[\r\n]//g;
3927 $new_icon_theme_def =~ s/^\s*//;
3928 return $new_icon_theme_def;
3933 if ( open( CF
, ">config.php" ) ) {
3938 print CF
" * SquirrelMail Configuration File\n";
3939 print CF
" * Created using the configure script, conf.pl\n";
3942 print CF
"global \$version;\n";
3944 if ($print_config_version) {
3945 print CF
"\$config_version = '$print_config_version';\n";
3948 print CF
"\$config_use_color = $config_use_color;\n";
3952 print CF
"\$org_name = \"$org_name\";\n";
3954 print CF
"\$org_logo = " . &change_to_SM_path
($org_logo) . ";\n";
3955 $org_logo_width |= 0;
3956 $org_logo_height |= 0;
3958 print CF
"\$org_logo_width = '$org_logo_width';\n";
3960 print CF
"\$org_logo_height = '$org_logo_height';\n";
3961 # string that can contain variables.
3962 print CF
"\$org_title = \"$org_title\";\n";
3964 print CF
"\$signout_page = " . &change_to_SM_path
($signout_page) . ";\n";
3966 print CF
"\$frame_top = '$frame_top';\n";
3969 print CF
"\$provider_uri = '$provider_uri';\n";
3972 print CF
"\$provider_name = '$provider_name';\n";
3975 # string that can contain variables
3976 print CF
"\$motd = \"$motd\";\n";
3980 print CF
"\$squirrelmail_default_language = '$squirrelmail_default_language';\n";
3982 print CF
"\$default_charset = '$default_charset';\n";
3984 print CF
"\$show_alternative_names = $show_alternative_names;\n";
3986 print CF
"\$aggressive_decoding = $aggressive_decoding;\n";
3988 print CF
"\$lossy_encoding = $lossy_encoding;\n";
3992 print CF
"\$domain = '$domain';\n";
3994 print CF
"\$imapServerAddress = '$imapServerAddress';\n";
3996 print CF
"\$imapPort = $imapPort;\n";
3998 print CF
"\$useSendmail = $useSendmail;\n";
4000 print CF
"\$smtpServerAddress = '$smtpServerAddress';\n";
4002 print CF
"\$smtpPort = $smtpPort;\n";
4004 print CF
"\$sendmail_path = '$sendmail_path';\n";
4006 print CF
"\$sendmail_args = '$sendmail_args';\n";
4008 # print CF "\$use_authenticated_smtp = $use_authenticated_smtp;\n";
4010 print CF
"\$pop_before_smtp = $pop_before_smtp;\n";
4012 print CF
"\$imap_server_type = '$imap_server_type';\n";
4014 print CF
"\$invert_time = $invert_time;\n";
4016 print CF
"\$optional_delimiter = '$optional_delimiter';\n";
4018 print CF
"\$encode_header_key = '$encode_header_key';\n";
4022 print CF
"\$default_folder_prefix = '$default_folder_prefix';\n";
4024 print CF
"\$trash_folder = '$trash_folder';\n";
4026 print CF
"\$sent_folder = '$sent_folder';\n";
4028 print CF
"\$draft_folder = '$draft_folder';\n";
4030 print CF
"\$default_move_to_trash = $default_move_to_trash;\n";
4032 print CF
"\$default_move_to_sent = $default_move_to_sent;\n";
4034 print CF
"\$default_save_as_draft = $default_save_as_draft;\n";
4036 print CF
"\$show_prefix_option = $show_prefix_option;\n";
4038 print CF
"\$list_special_folders_first = $list_special_folders_first;\n";
4040 print CF
"\$use_special_folder_color = $use_special_folder_color;\n";
4042 print CF
"\$auto_expunge = $auto_expunge;\n";
4044 print CF
"\$default_sub_of_inbox = $default_sub_of_inbox;\n";
4046 print CF
"\$show_contain_subfolders_option = $show_contain_subfolders_option;\n";
4048 print CF
"\$default_unseen_notify = $default_unseen_notify;\n";
4050 print CF
"\$default_unseen_type = $default_unseen_type;\n";
4052 print CF
"\$auto_create_special = $auto_create_special;\n";
4054 print CF
"\$delete_folder = $delete_folder;\n";
4056 print CF
"\$noselect_fix_enable = $noselect_fix_enable;\n";
4061 print CF
"\$data_dir = " . &change_to_SM_path
($data_dir) . ";\n";
4062 # string that can contain a variable
4063 print CF
"\$attachment_dir = " . &change_to_SM_path
($attachment_dir) . ";\n";
4065 print CF
"\$dir_hash_level = $dir_hash_level;\n";
4067 print CF
"\$default_left_size = '$default_left_size';\n";
4069 print CF
"\$force_username_lowercase = $force_username_lowercase;\n";
4071 print CF
"\$default_use_priority = $default_use_priority;\n";
4073 print CF
"\$hide_sm_attributions = $hide_sm_attributions;\n";
4075 print CF
"\$default_use_mdn = $default_use_mdn;\n";
4077 print CF
"\$edit_identity = $edit_identity;\n";
4079 print CF
"\$edit_name = $edit_name;\n";
4081 print CF
"\$hide_auth_header = $hide_auth_header;\n";
4083 print CF
"\$disable_thread_sort = $disable_thread_sort;\n";
4085 print CF
"\$disable_server_sort = $disable_server_sort;\n";
4087 print CF
"\$allow_charset_search = $allow_charset_search;\n";
4089 print CF
"\$allow_advanced_search = $allow_advanced_search;\n";
4092 print CF
"\$time_zone_type = $time_zone_type;\n";
4095 print CF
"\$config_location_base = '$config_location_base';\n";
4098 # all plugins are strings
4099 for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
4100 print CF
"\$plugins[] = '$plugins[$ct]';\n";
4105 print CF
"\$theme_css = " . &change_to_SM_path
($theme_css) . ";\n";
4106 if ( $theme_default eq '' ) { $theme_default = '0'; }
4107 print CF
"\$theme_default = $theme_default;\n";
4109 for ( $count = 0 ; $count <= $#theme_name ; $count++ ) {
4110 print CF
"\$theme[$count]['PATH'] = " . &change_to_SM_path
($theme_path[$count]) . ";\n";
4111 # escape theme name so it can contain single quotes.
4112 $esc_name = $theme_name[$count];
4113 $esc_name =~ s/\\/\\\\/g;
4114 $esc_name =~ s/'/\\'/g;
4115 print CF
"\$theme[$count]['NAME'] = '$esc_name';\n";
4119 if ( $templateset_default eq '' ) { $templateset_default = '0'; }
4120 print CF
"\$templateset_default = $templateset_default;\n";
4121 # FIXME: need to make this a setting the user can change herein
4122 # This REALLY needs to be done, since the index of the "default"
4123 # set cannot always be predicted!
4124 # Heck, why are default and fallback indexes? If we make them
4125 # into the ID strings, then it would not cause such issues
4126 $templateset_fallback = 0;
4127 print CF
"\$templateset_fallback = $templateset_fallback;\n";
4129 for ( $count = 0 ; $count <= $#templateset_name ; $count++ ) {
4130 print CF
"\$aTemplateSet[$count]['ID'] = '" . $templateset_id[$count] . "';\n";
4131 # escape theme name so it can contain single quotes.
4132 $esc_name = $templateset_name[$count];
4133 $esc_name =~ s/\\/\\\\/g;
4134 $esc_name =~ s/'/\\'/g;
4135 print CF
"\$aTemplateSet[$count]['NAME'] = '$esc_name';\n";
4141 print CF
"\$default_fontsize = '$default_fontsize';\n";
4143 print CF
"\$default_fontset = '$default_fontset';\n";
4145 # assoc. array (maybe initial value should be set somewhere else)
4146 print CF
'$fontsets = array();'."\n";
4147 while (($fontset_name, $fontset_value) = each(%fontsets)) {
4148 print CF
"\$fontsets\['$fontset_name'\] = '$fontset_value';\n";
4154 print CF
"\$default_use_javascript_addr_book = $default_use_javascript_addr_book;\n";
4155 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
4156 print CF
"\$ldap_server[$count] = array(\n";
4158 print CF
" 'host' => '$ldap_host[$count]',\n";
4160 print CF
" 'base' => '$ldap_base[$count]'";
4161 if ( $ldap_name[$count] ) {
4164 print CF
" 'name' => '$ldap_name[$count]'";
4166 if ( $ldap_port[$count] ) {
4169 print CF
" 'port' => $ldap_port[$count]";
4171 if ( $ldap_charset[$count] ) {
4174 print CF
" 'charset' => '$ldap_charset[$count]'";
4176 if ( $ldap_maxrows[$count] ) {
4179 print CF
" 'maxrows' => $ldap_maxrows[$count]";
4182 if ( $ldap_filter[$count] ) {
4184 print CF
" 'filter' => '$ldap_filter[$count]'";
4186 if ( $ldap_binddn[$count] ) {
4189 print CF
" 'binddn' => '$ldap_binddn[$count]'";
4190 if ( $ldap_bindpw[$count] ) {
4193 print CF
" 'bindpw' => '$ldap_bindpw[$count]'";
4196 if ( $ldap_protocol[$count] ) {
4199 print CF
" 'protocol' => $ldap_protocol[$count]";
4201 if ( $ldap_limit_scope[$count] ) {
4204 print CF
" 'limit_scope' => $ldap_limit_scope[$count]";
4206 if ( $ldap_listing[$count] ) {
4209 print CF
" 'listing' => $ldap_listing[$count]";
4211 if ( $ldap_writeable[$count] ) {
4214 print CF
" 'writeable' => $ldap_writeable[$count]";
4216 if ( $ldap_search_tree[$count] ) {
4219 print CF
" 'search_tree' => $ldap_search_tree[$count]";
4221 if ( $ldap_listing[$count] ) {
4224 print CF
" 'starttls' => $ldap_starttls[$count]";
4232 print CF
"\$addrbook_dsn = '$addrbook_dsn';\n";
4234 print CF
"\$addrbook_table = '$addrbook_table';\n\n";
4236 print CF
"\$prefs_dsn = '$prefs_dsn';\n";
4238 print CF
"\$prefs_table = '$prefs_table';\n";
4240 print CF
"\$prefs_user_field = '$prefs_user_field';\n";
4242 print CF
"\$prefs_user_size = $prefs_user_size;\n";
4244 print CF
"\$prefs_key_field = '$prefs_key_field';\n";
4246 print CF
"\$prefs_key_size = $prefs_key_size;\n";
4248 print CF
"\$prefs_val_field = '$prefs_val_field';\n";
4250 print CF
"\$prefs_val_size = $prefs_val_size;\n\n";
4252 print CF
"\$addrbook_global_dsn = '$addrbook_global_dsn';\n";
4254 print CF
"\$addrbook_global_table = '$addrbook_global_table';\n";
4256 print CF
"\$addrbook_global_writeable = $addrbook_global_writeable;\n";
4258 print CF
"\$addrbook_global_listing = $addrbook_global_listing;\n\n";
4260 print CF
"\$abook_global_file = '$abook_global_file';\n";
4262 print CF
"\$abook_global_file_writeable = $abook_global_file_writeable;\n\n";
4264 print CF
"\$abook_global_file_listing = $abook_global_file_listing;\n\n";
4266 print CF
"\$abook_file_line_length = $abook_file_line_length;\n\n";
4268 print CF
"\$no_list_for_subscribe = $no_list_for_subscribe;\n";
4271 print CF
"\$smtp_auth_mech = '$smtp_auth_mech';\n";
4272 print CF
"\$smtp_sitewide_user = '". quote_single
($smtp_sitewide_user) ."';\n";
4273 print CF
"\$smtp_sitewide_pass = '". quote_single
($smtp_sitewide_pass) ."';\n";
4275 print CF
"\$imap_auth_mech = '$imap_auth_mech';\n";
4277 print CF
"\$use_imap_tls = $use_imap_tls;\n";
4279 print CF
"\$use_smtp_tls = $use_smtp_tls;\n";
4281 print CF
"\$session_name = '$session_name';\n";
4286 print CF
"\$use_iframe = $use_iframe;\n";
4289 print CF
"\$use_icons = $use_icons;\n";
4292 print CF
"\$icon_theme_def = " . &change_to_SM_path
($icon_theme_def) . ";\n";
4294 print CF
"\$use_php_recode = $use_php_recode;\n";
4297 print CF
"\$use_php_iconv = $use_php_iconv;\n";
4300 print CF
"\$allow_remote_configtest = $allow_remote_configtest;\n";
4305 print "Data saved in config.php\n";
4307 print "Error saving config.php: $!\n";
4313 print $WHT. "SquirrelMail Configuration : " . $NRM;
4314 if ( $config == 1 ) { print "Read: config.php"; }
4315 elsif ( $config == 2 ) { print "Read: config_default.php"; }
4317 print "---------------------------------------------------------\n";
4319 print "While we have been building SquirrelMail, we have discovered some\n";
4320 print "preferences that work better with some servers that don't work so\n";
4321 print "well with others. If you select your IMAP server, this option will\n";
4322 print "set some pre-defined settings for that server.\n";
4324 print "Please note that you will still need to go through and make sure\n";
4325 print "everything is correct. This does not change everything. There are\n";
4326 print "only a few settings that this will change.\n";
4330 while ( $continue != 1 ) {
4331 print "Please select your IMAP server:\n";
4332 print " bincimap = Binc IMAP server\n";
4333 print " courier = Courier IMAP server\n";
4334 print " cyrus = Cyrus IMAP server\n";
4335 print " dovecot = Dovecot Secure IMAP server\n";
4336 print " exchange = Microsoft Exchange IMAP server\n";
4337 print " hmailserver = hMailServer\n";
4338 print " macosx = Mac OS X Mailserver\n";
4339 print " mercury32 = Mercury/32\n";
4340 print " uw = University of Washington's IMAP server\n";
4342 print " quit = Do not change anything\n";
4344 print "Command >> ";
4346 $server =~ s/[\r\n]//g;
4348 # variable is used to display additional messages.
4352 if ( $server eq "cyrus" ) {
4353 $imap_server_type = "cyrus";
4354 $default_folder_prefix = "";
4355 $trash_folder = "INBOX.Trash";
4356 $sent_folder = "INBOX.Sent";
4357 $draft_folder = "INBOX.Drafts";
4358 $show_prefix_option = false
;
4359 $default_sub_of_inbox = true
;
4360 $show_contain_subfolders_option = false
;
4361 $optional_delimiter = ".";
4362 $disp_default_folder_prefix = "<none>";
4363 $force_username_lowercase = false
;
4365 # Delimiter might differ if unixhierarchysep is set to yes.
4366 $message = "\nIf you have enabled unixhierarchysep, you must change delimiter and special folder names.\n";
4369 } elsif ( $server eq "uw" ) {
4370 $imap_server_type = "uw";
4371 $default_folder_prefix = "mail/";
4372 $trash_folder = "Trash";
4373 $sent_folder = "Sent";
4374 $draft_folder = "Drafts";
4375 $show_prefix_option = true
;
4376 $default_sub_of_inbox = false
;
4377 $show_contain_subfolders_option = true
;
4378 $optional_delimiter = "/";
4379 $disp_default_folder_prefix = $default_folder_prefix;
4380 $delete_folder = true
;
4381 $force_username_lowercase = true
;
4384 } elsif ( $server eq "exchange" ) {
4385 $imap_server_type = "exchange";
4386 $default_folder_prefix = "";
4387 $default_sub_of_inbox = true
;
4388 $trash_folder = "INBOX/Deleted Items";
4389 $sent_folder = "INBOX/Sent Items";
4390 $drafts_folder = "INBOX/Drafts";
4391 $show_prefix_option = false
;
4392 $show_contain_subfolders_option = false
;
4393 $optional_delimiter = "detect";
4394 $disp_default_folder_prefix = "<none>";
4395 $force_username_lowercase = true
;
4398 } elsif ( $server eq "courier" ) {
4399 $imap_server_type = "courier";
4400 $default_folder_prefix = "INBOX.";
4401 $trash_folder = "Trash";
4402 $sent_folder = "Sent";
4403 $draft_folder = "Drafts";
4404 $show_prefix_option = false
;
4405 $default_sub_of_inbox = false
;
4406 $show_contain_subfolders_option = false
;
4407 $optional_delimiter = ".";
4408 $disp_default_folder_prefix = $default_folder_prefix;
4409 $delete_folder = true
;
4410 $force_username_lowercase = false
;
4413 } elsif ( $server eq "macosx" ) {
4414 $imap_server_type = "macosx";
4415 $default_folder_prefix = "INBOX/";
4416 $trash_folder = "Trash";
4417 $sent_folder = "Sent";
4418 $draft_folder = "Drafts";
4419 $show_prefix_option = false
;
4420 $default_sub_of_inbox = true
;
4421 $show_contain_subfolders_option = false
;
4422 $optional_delimiter = "detect";
4423 $allow_charset_search = false
;
4424 $disp_default_folder_prefix = $default_folder_prefix;
4427 } elsif ( $server eq "hmailserver" ) {
4428 $imap_server_type = "hmailserver";
4429 $default_folder_prefix = "";
4430 $trash_folder = "INBOX.Trash";
4431 $sent_folder = "INBOX.Sent";
4432 $draft_folder = "INBOX.Drafts";
4433 $show_prefix_option = false
;
4434 $default_sub_of_inbox = true
;
4435 $show_contain_subfolders_option = false
;
4436 $optional_delimiter = "detect";
4437 $allow_charset_search = false
;
4438 $disp_default_folder_prefix = $default_folder_prefix;
4439 $delete_folder = false
;
4440 $force_username_lowercase = false
;
4443 } elsif ( $server eq "mercury32" ) {
4444 $imap_server_type = "mercury32";
4445 $default_folder_prefix = "";
4446 $trash_folder = "Trash";
4447 $sent_folder = "Sent";
4448 $draft_folder = "Drafts";
4449 $show_prefix_option = false
;
4450 $default_sub_of_inbox = true
;
4451 $show_contain_subfolders_option = true
;
4452 $optional_delimiter = "detect";
4453 $delete_folder = true
;
4454 $force_username_lowercase = true
;
4457 } elsif ( $server eq "dovecot" ) {
4458 $imap_server_type = "dovecot";
4459 $default_folder_prefix = "";
4460 $trash_folder = "Trash";
4461 $sent_folder = "Sent";
4462 $draft_folder = "Drafts";
4463 $show_prefix_option = false
;
4464 $default_sub_of_inbox = false
;
4465 $show_contain_subfolders_option = false
;
4466 $delete_folder = false
;
4467 $force_username_lowercase = true
;
4468 $optional_delimiter = "detect";
4469 $disp_default_folder_prefix = "<none>";
4472 } elsif ( $server eq "bincimap" ) {
4473 $imap_server_type = "bincimap";
4474 $default_folder_prefix = "INBOX/";
4475 $trash_folder = "Trash";
4476 $sent_folder = "Sent";
4477 $draft_folder = "Drafts";
4478 $show_prefix_option = false
;
4479 $default_sub_of_inbox = false
;
4480 $show_contain_subfolders_option = false
;
4481 $delete_folder = true
;
4482 $force_username_lowercase = false
;
4483 $optional_delimiter = "detect";
4484 $disp_default_folder_prefix = $default_folder_prefix;
4486 # Default folder prefix depends on used depot.
4487 $message = "\nIf you use IMAPdir depot, you must set default folder prefix to empty string.\n";
4490 } elsif ( $server eq "quit" ) {
4493 $disp_default_folder_prefix = $default_folder_prefix;
4494 print "Unrecognized server: $server\n";
4498 print " imap_server_type = $imap_server_type\n";
4499 print " default_folder_prefix = $disp_default_folder_prefix\n";
4500 print " trash_folder = $trash_folder\n";
4501 print " sent_folder = $sent_folder\n";
4502 print " draft_folder = $draft_folder\n";
4503 print " show_prefix_option = $show_prefix_option\n";
4504 print " default_sub_of_inbox = $default_sub_of_inbox\n";
4505 print "show_contain_subfolders_option = $show_contain_subfolders_option\n";
4506 print " optional_delimiter = $optional_delimiter\n";
4507 print " delete_folder = $delete_folder\n";
4508 print " force_username_lowercase = $force_username_lowercase\n";
4512 print "\nPress enter to continue...";
4516 # This subroutine corrects relative paths to ensure they
4517 # will work within the SM space. If the path falls within
4518 # the SM directory tree, the SM_PATH variable will be
4519 # prepended to the path, if not, then the path will be
4520 # converted to an absolute path, e.g.
4521 # '../images/logo.gif' --> SM_PATH . 'images/logo.gif'
4522 # '../../someplace/data' --> '/absolute/path/someplace/data'
4523 # 'images/logo.gif' --> SM_PATH . 'config/images/logo.gif'
4524 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
4525 # 'http://whatever/' --> 'http://whatever'
4526 # $some_var/path --> "$some_var/path"
4527 sub change_to_SM_path
() {
4528 my ($old_path) = @_;
4534 # If the path is absolute, don't bother.
4535 return "\'" . $old_path . "\'" if ( $old_path eq '');
4536 return "\'" . $old_path . "\'" if ( $old_path =~ /^(\/|http
)/ );
4537 return "\'" . $old_path . "\'" if ( $old_path =~ /^\w:\// );
4538 return $old_path if ( $old_path =~ /^\'(\/|http
)/ );
4539 return $old_path if ( $old_path =~ /^\'\w:\// );
4540 return $old_path if ( $old_path =~ /^SM_PATH/);
4542 if ( $old_path =~ /^\$/ ) {
4543 # check if it's a single var, or a $var/path combination
4544 # if it's $var/path, enclose in ""
4545 if ( $old_path =~ /\// ) {
4546 return '"'.$old_path.'"';
4551 # Remove remaining '
4552 $old_path =~ s/\'//g;
4554 # For relative paths, split on '../'
4555 @rel_path = split(/\.\.\//, $old_path);
4557 if ( $#rel_path > 1 ) {
4558 # more than two levels away. Make it absolute.
4559 @abs_path = split(/\//, $dir);
4561 # Lop off the relative pieces of the absolute path..
4562 for ( $i = 0; $i <= $#rel_path; $i++ ) {
4566 push @abs_path, @rel_path;
4567 $new_path = "\'" . join('/', @abs_path) . "\'";
4568 } elsif ( $#rel_path > 0 ) {
4569 # it's within the SM tree, prepend SM_PATH
4570 $new_path = $old_path;
4571 $new_path =~ s/^\.\.\//SM_PATH
. \'/;
4574 # Last, it's a relative path without any leading '.'
4575 # Prepend SM_PATH and config, since the paths are
4576 # relative to the config directory
4577 $new_path = "SM_PATH . \'config/" . $old_path . "\'";
4583 # Change SM_PATH to admin-friendly version, e.g.:
4584 # SM_PATH . 'images/logo.gif' --> '../images/logo.gif'
4585 # SM_PATH . 'config/some.php' --> 'some.php'
4586 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
4587 # 'http://whatever/' --> 'http://whatever'
4588 sub change_to_rel_path
() {
4589 my ($old_path) = @_;
4590 my $new_path = $old_path;
4592 if ( $old_path =~ /^SM_PATH/ ) {
4593 # FIXME: the following replacement loses the opening quote mark!
4594 $new_path =~ s/^SM_PATH . \'/\.\.\//;
4595 $new_path =~ s/\.\.\/config\///;
4601 # Attempts to auto-detect if a specific auth mechanism is supported.
4602 # Called by 'command112a' and 'command112b'
4603 # ARGS: service-name (IMAP or SMTP), host:port, mech-name (ie. CRAM-MD5)
4604 sub detect_auth_support
{
4605 # Try loading IO::Socket
4606 unless (eval("use IO::Socket; 1")) {
4607 print "Perl IO::Socket module is not available.";
4611 my $service = shift;
4615 if ((!defined($service)) or (!defined($host)) or (!defined($mech))) {
4616 # Error - wrong # of args
4617 print "BAD ARGS!\n";
4621 if ($service eq 'SMTP') {
4622 $cmd = "AUTH $mech\r\n";
4623 $logout = "QUIT\r\n";
4624 } elsif ($service eq 'IMAP') {
4625 $cmd = "A01 AUTHENTICATE $mech\n";
4626 $logout = "C01 LOGOUT\n";
4628 # unknown service - whoops.
4632 # Get this show on the road
4633 my $sock=IO
::Socket
::INET
->new($host);
4634 if (!defined($sock)) {
4638 my $discard = <$sock>; # Server greeting/banner - who cares..
4640 if ($service eq 'SMTP') {
4642 print $sock "HELO $domain\r\n";
4643 $discard = <$sock>; # Yeah yeah, you're happy to see me..
4647 my $response = <$sock>;
4649 if (!defined($response)) {
4653 # So at this point, we have a response, and it is (hopefully) valid.
4654 if ($service eq 'SMTP') {
4655 if (($response =~ /^535/) or ($response =~/^502/)) {
4657 print $sock $logout;
4660 } elsif ($response =~ /^503/) {
4661 #Something went wrong
4664 } elsif ($service eq 'IMAP') {
4665 if ($response =~ /^A01/) {
4667 print $sock $logout;
4672 # Unknown service - this shouldn't be able to happen.
4677 # If it gets here, the mech is supported
4678 print $sock "*\n"; # Attempt to cancel authentication
4679 print $sock $logout; # Try to log out, but we don't really care if this fails
4685 # Example code from O'Reilly Perl Cookbook
4692 return wantarray ?
@out : $out[0];
4695 sub clear_screen
() {
4696 if ( $^O
=~ /^mswin/i) {
4703 # checks IMAP mailbox name. Refuses to accept 8bit folders
4704 # returns 0 (folder name is not correct) or 1 (folder name is correct)
4705 sub check_imap_folder
($) {
4706 my $folder_name = shift(@_);
4708 if ($folder_name =~ /[\x80-\xFFFF]/) {
4709 print "Folder name contains 8bit characters. Configuration utility requires\n";
4710 print "UTF7-IMAP encoded folder names.\n";
4711 print "Press any key to continue...";
4714 } elsif ($folder_name =~ /[&\*\%]/) {
4715 # check for ampersand and list-wildcards
4716 print "Folder name contains special UTF7-IMAP characters.\n";
4717 print "Are you sure that folder name is correct? (yN): ";
4719 $tmp = lc(trim
($tmp));
4720 if ($tmp =~ /^y$/) {
4730 # quotes string written in single quotes
4731 sub quote_single
($) {
4732 my $string = shift(@_);
4733 $string =~ s/\'/\\'/g;