4 # Copyright (c) 1999-2014 The SquirrelMail Project Team
5 # Licensed under the GNU GPL. For full terms see COPYING.
7 # A simple configure script to configure SquirrelMail
10 ############################################################
11 $conf_pl_version = "1.5.0";
13 ############################################################
14 # Check what directory we're supposed to be running in, and
15 # change there if necessary. File::Basename has been in
16 # Perl since at least 5.003_7, and nobody sane runs anything
17 # before that, but just in case.
18 ############################################################
20 if ( eval q{require "File/Basename.pm"} ) {
21 $dir = File
::Basename
::dirname
($0);
25 ############################################################
26 # Some people try to run this as a CGI. That's wrong!
27 ############################################################
28 if ( defined( $ENV{'PATH_INFO'} )
29 || defined( $ENV{'QUERY_STRING'} )
30 || defined( $ENV{'REQUEST_METHOD'} ) ) {
31 print "Content-Type: text/html\n\n";
32 print "You must run this script from the command line.";
36 ############################################################
37 # If we got here, use Cwd to get the full directory path
38 # (the Basename stuff above will sometimes return '.' as
39 # the base directory, which is not helpful here).
40 ############################################################
45 ############################################################
46 # First, lets read in the data already in there...
47 ############################################################
48 if ( -e
"config.php" ) {
49 # Make sure that file is readable
50 if (! -r
"config.php") {
53 print "The file \"config/config.php\" was found, but you don't\n";
54 print "have rights to read it.\n";
56 print "Press enter to continue";
60 open( FILE
, "config.php" );
61 while ( $line = <FILE
> ) {
67 if ( $var =~ /^([a-z])/i ) {
68 @o = split ( /\s*EQUALS\s*/, $var );
69 if ( $o[0] eq "config_version" ) {
71 $o[1] =~ s/[\'\"];\s*$//;
75 $config_version = $o[1];
82 if ( $config_version ne $conf_pl_version ) {
85 print " The file \"config/config.php\" was found, but it is for\n";
86 print " an older version of SquirrelMail. It is possible to still\n";
87 print " read the defaults from this file but be warned that many\n";
88 print " preferences change between versions. It is recommended that\n";
89 print " you start with a clean config.php for each upgrade that you\n";
90 print " do. To do this, just move config/config.php out of the way.\n";
92 print "Continue loading with the old config.php [y/N]? ";
95 if ( ( $ctu !~ /^y\n/i ) || ( $ctu =~ /^\n/ ) ) {
99 print "\nDo you want me to stop warning you [y/N]? ";
101 if ( $ctu =~ /^y\n/i ) {
102 $print_config_version = $conf_pl_version;
104 $print_config_version = $config_version;
107 $print_config_version = $config_version;
111 open( FILE
, "config.php" );
112 } elsif ( -e
"config_default.php" ) {
113 open( FILE
, "config_default.php" );
114 while ( $line = <FILE
> ) {
120 if ( $var =~ /^([a-z])/i ) {
121 @o = split ( /\s*EQUALS\s*/, $var );
122 if ( $o[0] eq "config_version" ) {
123 $o[1] =~ s/[\n\r]//g;
124 $o[1] =~ s/[\'\"];\s*$//;
126 $o[1] =~ s/^[\'\"]//;
128 $config_version = $o[1];
135 if ( $config_version ne $conf_pl_version ) {
138 print " You are trying to use a 'config_default.php' from an older\n";
139 print " version of SquirrelMail. This is HIGHLY unrecommended. You\n";
140 print " should get the 'config_default.php' that matches the version\n";
141 print " of SquirrelMail that you are running. You can get this from\n";
142 print " the SquirrelMail web page by going to the following URL:\n";
143 print " http://squirrelmail.org.\n";
145 print "Continue loading with old config_default.php (a bad idea) [y/N]? ";
148 if ( ( $ctu !~ /^y\n/i ) || ( $ctu =~ /^\n/ ) ) {
152 print "\nDo you want me to stop warning you [y/N]? ";
154 if ( $ctu =~ /^y\n/i ) {
155 $print_config_version = $conf_pl_version;
157 $print_config_version = $config_version;
160 $print_config_version = $config_version;
163 open( FILE
, "config_default.php" );
165 print "No configuration file found. Please get config_default.php\n";
166 print "or config.php before running this again. This program needs\n";
167 print "a default config file to get default values.\n";
171 # Read and parse the current configuration file
172 # (either config.php or config_default.php).
173 while ( $line = <FILE
> ) {
179 if ( $var =~ /^([a-z])/i ) {
180 @options = split ( /\s*EQUALS\s*/, $var );
181 $options[1] =~ s/[\n\r]//g;
182 $options[1] =~ s/[\'\"];\s*$//;
183 $options[1] =~ s/;$//;
184 $options[1] =~ s/^[\'\"]//;
185 # de-escape escaped strings
186 $options[1] =~ s/\\'/'/g;
187 $options[1] =~ s/\\\\/\\/g;
189 if ( $options[0] =~ /^user_themes\[[0-9]+\]\[['"]PATH['"]\]/ ) {
191 $sub =~ s/\]\[['"]PATH['"]\]//;
193 if ( -e
"../css/" ) {
194 $options[1] =~ s/^\.\.\/config/\
.\
.\
/css/;
196 $user_theme_path[$sub] = &change_to_rel_path
($options[1]);
197 } elsif ( $options[0] =~ /^user_themes\[[0-9]+\]\[['"]NAME['"]\]/ ) {
199 $sub =~ s/\]\[['"]NAME['"]\]//;
201 $user_theme_name[$sub] = $options[1];
202 } elsif ( $options[0] =~ /^icon_themes\[[0-9]+\]\[['"]PATH['"]\]/ ) {
204 $sub =~ s/\]\[['"]PATH['"]\]//;
206 if ( -e
"../images/" ) {
207 $options[1] =~ s/^\.\.\/config/\
.\
.\
/images/;
209 $icon_theme_path[$sub] = &change_to_rel_path
($options[1]);
210 } elsif ( $options[0] =~ /^icon_themes\[[0-9]+\]\[['"]NAME['"]\]/ ) {
212 $sub =~ s/\]\[['"]NAME['"]\]//;
214 $icon_theme_name[$sub] = $options[1];
215 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]ID['"]\]/ ) {
217 $sub =~ s/\]\[['"]ID['"]\]//;
219 if ( -e
"../templates" ) {
220 $options[1] =~ s/^\.\.\/config/\
.\
.\
/templates/;
222 $templateset_id[$sub] = $options[1];
223 ##### FIXME: This section BELOW here so old prefs files don't blow up when running conf.pl
224 ##### Remove after a month or two
225 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]PATH['"]\]/ ) {
227 $sub =~ s/\]\[['"]PATH['"]\]//;
229 if ( -e
"../templates" ) {
230 $options[1] =~ s/^\.\.\/config/\
.\
.\
/templates/;
232 $templateset_id[$sub] = $options[1];
233 ##### FIXME: This section ABOVE here so old prefs files don't blow up when running conf.pl
234 ##### Remove after a month or two
235 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]NAME['"]\]/ ) {
237 $sub =~ s/\]\[['"]NAME['"]\]//;
239 $templateset_name[$sub] = $options[1];
240 } elsif ( $options[0] =~ /^plugins\[[0-9]*\]/ ) {
243 $sub =~ s/^plugins\[//;
245 push @plugins, $options[1];
247 $plugins[$sub] = $options[1];
249 } elsif ($options[0] =~ /^fontsets\[\'[a-z]*\'\]/) {
250 # parse associative $fontsets array
253 $sub =~ s/^fontsets\[\'//;
254 $fontsets{$sub} = $options[1];
255 } elsif ( $options[0] =~ /^theme\[[0-9]+\]\[['"]PATH|NAME['"]\]/ ) {
257 ## $color themes are no longer supported. Please leave this
258 ## so conf.pl doesn't barf if it encounters a $theme.
260 } elsif ( $options[0] =~ /^ldap_server\[[0-9]+\]/ ) {
263 $sub =~ s/^ldap_server\[//;
265 while ( ( $tmp = <FILE
> ) && ( $continue != 1 ) ) {
266 if ( $tmp =~ /\);\s*$/ ) {
270 if ( $tmp =~ /^\s*[\'\"]host[\'\"]/i ) {
271 $tmp =~ s/^\s*[\'\"]host[\'\"]\s*=>\s*[\'\"]//i;
272 $tmp =~ s/[\'\"],?\s*$//;
273 $tmp =~ s/[\'\"]\);\s*$//;
275 } elsif ( $tmp =~ /^\s*[\'\"]base[\'\"]/i ) {
276 $tmp =~ s/^\s*[\'\"]base[\'\"]\s*=>\s*[\'\"]//i;
277 $tmp =~ s/[\'\"],?\s*$//;
278 $tmp =~ s/[\'\"]\);\s*$//;
280 } elsif ( $tmp =~ /^\s*[\'\"]charset[\'\"]/i ) {
281 $tmp =~ s/^\s*[\'\"]charset[\'\"]\s*=>\s*[\'\"]//i;
282 $tmp =~ s/[\'\"],?\s*$//;
283 $tmp =~ s/[\'\"]\);\s*$//;
285 } elsif ( $tmp =~ /^\s*[\'\"]port[\'\"]/i ) {
286 $tmp =~ s/^\s*[\'\"]port[\'\"]\s*=>\s*[\'\"]?//i;
287 $tmp =~ s/[\'\"]?,?\s*$//;
288 $tmp =~ s/[\'\"]?\);\s*$//;
290 } elsif ( $tmp =~ /^\s*[\'\"]maxrows[\'\"]/i ) {
291 $tmp =~ s/^\s*[\'\"]maxrows[\'\"]\s*=>\s*[\'\"]?//i;
292 $tmp =~ s/[\'\"]?,?\s*$//;
293 $tmp =~ s/[\'\"]?\);\s*$//;
295 } elsif ( $tmp =~ /^\s*[\'\"]filter[\'\"]/i ) {
296 $tmp =~ s/^\s*[\'\"]filter[\'\"]\s*=>\s*[\'\"]?//i;
297 $tmp =~ s/[\'\"]?,?\s*$//;
298 $tmp =~ s/[\'\"]?\);\s*$//;
300 } elsif ( $tmp =~ /^\s*[\'\"]name[\'\"]/i ) {
301 $tmp =~ s/^\s*[\'\"]name[\'\"]\s*=>\s*[\'\"]//i;
302 $tmp =~ s/[\'\"],?\s*$//;
303 $tmp =~ s/[\'\"]\);\s*$//;
305 } elsif ( $tmp =~ /^\s*[\'\"]binddn[\'\"]/i ) {
306 $tmp =~ s/^\s*[\'\"]binddn[\'\"]\s*=>\s*[\'\"]//i;
307 $tmp =~ s/[\'\"],?\s*$//;
308 $tmp =~ s/[\'\"]\);\s*$//;
310 } elsif ( $tmp =~ /^\s*[\'\"]bindpw[\'\"]/i ) {
311 $tmp =~ s/^\s*[\'\"]bindpw[\'\"]\s*=>\s*[\'\"]//i;
312 $tmp =~ s/[\'\"],?\s*$//;
313 $tmp =~ s/[\'\"]\);\s*$//;
315 } elsif ( $tmp =~ /^\s*[\'\"]protocol[\'\"]/i ) {
316 $tmp =~ s/^\s*[\'\"]protocol[\'\"]\s*=>\s*[\'\"]?//i;
317 $tmp =~ s/[\'\"]?,?\s*$//;
318 $tmp =~ s/[\'\"]?\);\s*$//;
320 } elsif ( $tmp =~ /^\s*[\'\"]limit_scope[\'\"]/i ) {
321 $tmp =~ s/^\s*[\'\"]limit_scope[\'\"]\s*=>\s*[\'\"]?//i;
322 $tmp =~ s/[\'\"]?,?\s*$//;
323 $tmp =~ s/[\'\"]?\);\s*$//;
325 } elsif ( $tmp =~ /^\s*[\'\"]listing[\'\"]/i ) {
326 $tmp =~ s/^\s*[\'\"]listing[\'\"]\s*=>\s*[\'\"]?//i;
327 $tmp =~ s/[\'\"]?,?\s*$//;
328 $tmp =~ s/[\'\"]?\);\s*$//;
330 } elsif ( $tmp =~ /^\s*[\'\"]writeable[\'\"]/i ) {
331 $tmp =~ s/^\s*[\'\"]writeable[\'\"]\s*=>\s*[\'\"]?//i;
332 $tmp =~ s/[\'\"]?,?\s*$//;
333 $tmp =~ s/[\'\"]?\);\s*$//;
335 } elsif ( $tmp =~ /^\s*[\'\"]search_tree[\'\"]/i ) {
336 $tmp =~ s/^\s*[\'\"]search_tree[\'\"]\s*=>\s*[\'\"]?//i;
337 $tmp =~ s/[\'\"]?,?\s*$//;
338 $tmp =~ s/[\'\"]?\);\s*$//;
340 } elsif ( $tmp =~ /^\s*[\'\"]starttls[\'\"]/i ) {
341 $tmp =~ s/^\s*[\'\"]starttls[\'\"]\s*=>\s*[\'\"]?//i;
342 $tmp =~ s/[\'\"]?,?\s*$//;
343 $tmp =~ s/[\'\"]?\);\s*$//;
347 $ldap_host[$sub] = $host;
348 $ldap_base[$sub] = $base;
349 $ldap_name[$sub] = $name;
350 $ldap_port[$sub] = $port;
351 $ldap_maxrows[$sub] = $maxrows;
352 $ldap_filter[$sub] = $filter;
353 $ldap_charset[$sub] = $charset;
354 $ldap_binddn[$sub] = $binddn;
355 $ldap_bindpw[$sub] = $bindpw;
356 $ldap_protocol[$sub] = $protocol;
357 $ldap_limit_scope[$sub] = $limit_scope;
358 $ldap_listing[$sub] = $listing;
359 $ldap_writeable[$sub] = $writeable;
360 $ldap_search_tree[$sub] = $search_tree;
361 $ldap_starttls[$sub] = $starttls;
362 } elsif ( $options[0] =~ /^(data_dir|attachment_dir|org_logo|signout_page|icon_theme_def)$/ ) {
363 ${ $options[0] } = &change_to_rel_path
($options[1]);
365 ${ $options[0] } = $options[1];
371 # RPC template sets aren't included in user interface skin list,
372 # so add the one from the config file here
374 if ($rpc_templateset =~ /_rpc$/) {
375 $templateset_name[$#templateset_name + 1] = $rpc_templateset;
376 $templateset_id[$#templateset_id + 1] = $rpc_templateset;
379 # FIXME: unknown introduction date
380 $useSendmail = 'false' if ( lc($useSendmail) ne 'true' );
381 $sendmail_path = "/usr/sbin/sendmail" if ( !$sendmail_path );
382 $pop_before_smtp = 'false' if ( !$pop_before_smtp );
383 $pop_before_smtp_host = '' if ( !$pop_before_smtp_host );
384 $default_unseen_notify = 2 if ( !$default_unseen_notify );
385 $default_unseen_type = 1 if ( !$default_unseen_type );
386 $config_use_color = 0 if ( !$config_use_color );
387 $invert_time = 'false' if ( !$invert_time );
388 $force_username_lowercase = 'false' if ( !$force_username_lowercase );
389 $optional_delimiter = "detect" if ( !$optional_delimiter );
390 $auto_create_special = 'false' if ( !$auto_create_special );
391 $default_use_priority = 'true' if ( !$default_use_priority );
392 $default_use_mdn = 'true' if ( !$default_use_mdn );
393 $delete_folder = 'false' if ( !$delete_folder );
394 $noselect_fix_enable = 'false' if ( !$noselect_fix_enable );
395 $frame_top = "_top" if ( !$frame_top );
396 $provider_uri = '' if ( !$provider_uri );
397 $provider_name = '' if ( !$provider_name || $provider_name eq 'SquirrelMail');
398 $no_list_for_subscribe = 'false' if ( !$no_list_for_subscribe );
399 $allow_charset_search = 'true' if ( !$allow_charset_search );
400 $allow_advanced_search = 0 if ( !$allow_advanced_search) ;
401 $prefs_user_field = 'user' if ( !$prefs_user_field );
402 $prefs_key_field = 'prefkey' if ( !$prefs_key_field );
403 $prefs_val_field = 'prefval' if ( !$prefs_val_field );
404 $session_name = 'SQMSESSID' if ( !$session_name );
405 $skip_SM_header = 'false' if ( !$skip_SM_header );
406 $default_use_javascript_addr_book = 'false' if (! $default_use_javascript_addr_book);
409 $hide_sm_attributions = 'false' if ( !$hide_sm_attributions );
411 $edit_identity = 'true' if ( !$edit_identity );
412 $edit_name = 'true' if ( !$edit_name );
415 $use_smtp_tls= 'false' if ( !$use_smtp_tls);
416 $smtp_auth_mech = 'none' if ( !$smtp_auth_mech );
417 $use_imap_tls = 'false' if ( !$use_imap_tls );
418 $imap_auth_mech = 'login' if ( !$imap_auth_mech );
421 $show_alternative_names = 'false' if ( !$show_alternative_names );
422 # $available_languages option available only in 1.5.0. removed due to $languages
423 # implementation changes. options are provided by limit_languages plugin
424 # $available_languages = 'all' if ( !$available_languages );
425 $aggressive_decoding = 'false' if ( !$aggressive_decoding );
426 # available only in 1.5.0 and 1.5.1
427 # $advanced_tree = 'false' if ( !$advanced_tree );
428 $use_php_recode = 'false' if ( !$use_php_recode );
429 $use_php_iconv = 'false' if ( !$use_php_iconv );
430 $buffer_output = 'false' if ( !$buffer_output );
433 $use_icons = 'false' if ( !$use_icons );
434 $use_iframe = 'false' if ( !$use_iframe );
435 $lossy_encoding = 'false' if ( !$lossy_encoding );
436 $allow_remote_configtest = 'false' if ( !$allow_remote_configtest );
437 $secured_config = 'true' if ( !$secured_config );
438 $sq_https_port = 443 if ( !$sq_https_port );
439 $sq_ignore_http_x_forwarded_headers = 'true' if ( !$sq_ignore_http_x_forwarded_headers );
441 $sm_debug_mode = 'SM_DEBUG_MODE_MODERATE' if ( !$sm_debug_mode );
442 #FIXME: When this is STABLE software, remove the line above and uncomment the one below:
443 #$sm_debug_mode = 'SM_DEBUG_MODE_OFF' if ( !$sm_debug_mode );
444 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
446 $addrbook_global_table = 'global_abook' if ( !$addrbook_global_table );
447 $addrbook_global_writeable = 'false' if ( !$addrbook_global_writeable );
448 $addrbook_global_listing = 'false' if ( !$addrbook_global_listing );
449 $abook_global_file = '' if ( !$abook_global_file);
450 $abook_global_file_writeable = 'false' if ( !$abook_global_file_writeable);
451 $abook_global_file_listing = 'true' if ( !$abook_global_file_listing );
452 $encode_header_key = '' if ( !$encode_header_key );
453 $hide_auth_header = 'false' if ( !$hide_auth_header );
454 $time_zone_type = '0' if ( !$time_zone_type );
455 $prefs_user_size = 128 if ( !$prefs_user_size );
456 $prefs_key_size = 64 if ( !$prefs_key_size );
457 $prefs_val_size = 65536 if ( !$prefs_val_size );
459 # add qmail-inject test here for backwards compatibility
460 if ( !$sendmail_args && $sendmail_path =~ /qmail-inject/ ) {
462 } elsif ( !$sendmail_args ) {
463 $sendmail_args = '-i -t';
466 $default_fontsize = '' if ( !$default_fontsize);
467 $default_fontset = '' if ( !$default_fontset);
469 %fontsets = ('serif', 'serif',
470 'sans', 'helvetica,arial,sans-serif',
471 'comicsans', 'comic sans ms,sans-serif',
472 'tahoma', 'tahoma,sans-serif',
473 'verasans', 'bitstream vera sans,verdana,sans-serif');
476 # $use_imap_tls and $use_smtp_tls are switched to integer since 1.5.1
477 $use_imap_tls = 0 if ( $use_imap_tls eq 'false');
478 $use_imap_tls = 1 if ( $use_imap_tls eq 'true');
479 $use_smtp_tls = 0 if ( $use_smtp_tls eq 'false');
480 $use_smtp_tls = 1 if ( $use_smtp_tls eq 'true');
481 # sorting options changed names and reversed values in 1.5.1
482 $disable_thread_sort = 'false' if ( !$disable_thread_sort );
483 $disable_server_sort = 'false' if ( !$disable_server_sort );
486 $abook_file_line_length = 2048 if ( !$abook_file_line_length );
487 $config_location_base = '' if ( !$config_location_base );
488 $smtp_sitewide_user = '' if ( !$smtp_sitewide_user );
489 $smtp_sitewide_pass = '' if ( !$smtp_sitewide_pass );
490 $icon_theme_def = '' if ( !$icon_theme_def );
491 $disable_plugins = 'false' if ( !$disable_plugins );
492 $disable_plugins_user = '' if ( !$disable_plugins_user );
493 $only_secure_cookies = 'true' if ( !$only_secure_cookies );
494 $disable_security_tokens = 'false' if ( !$disable_security_tokens );
495 $check_referrer = '' if ( !$check_referrer );
496 $ask_user_info = 'true' if ( !$ask_user_info );
497 $use_transparent_security_image = 'true' if ( !$use_transparent_security_image );
498 $display_imap_login_error = 'false' if ( !$display_imap_login_error );
500 if ( $ARGV[0] eq '--install-plugin' ) {
501 print "Activating plugin " . $ARGV[1] . "\n";
502 if ( -d
"../plugins/" . $ARGV[1]) {
503 push @plugins, $ARGV[1];
507 print "No such plugin.\n";
510 } elsif ( $ARGV[0] eq '--remove-plugin' ) {
511 print "Removing plugin " . $ARGV[1] . "\n";
512 foreach $plugin (@plugins) {
513 if ( $plugin ne $ARGV[1] ) {
514 push @newplugins, $plugin;
517 @plugins = @newplugins;
520 } elsif ( $ARGV[0] eq '--update-plugins' or $ARGV[0] eq '-u') {
521 build_plugin_hook_array
();
523 } elsif ( $ARGV[0] eq '--help' or $ARGV[0] eq '-h') {
524 print "SquirrelMail Configuration Script\n";
526 print " * No arguments: initiates the configuration dialog\n";
527 print " * --install-plugin <plugin> : activates the specified plugin\n";
528 print " * --remove-plugin <plugin> : deactivates the specified plugin\n";
529 print " * --update-plugins , -u : rebuilds plugin_hooks.php according\n";
530 print " to plugins activated in config.php\n";
531 print " * --help , -h : Displays this help\n";
538 ####################################################################################
540 # used in multiple places, define once
541 $list_supported_imap_servers =
542 " bincimap = Binc IMAP server\n" .
543 " courier = Courier IMAP server\n" .
544 " cyrus = Cyrus IMAP server\n" .
545 " dovecot = Dovecot Secure IMAP server\n" .
546 " exchange = Microsoft Exchange IMAP server\n" .
547 " hmailserver = hMailServer\n" .
548 " macosx = Mac OS X Mailserver\n" .
549 " mercury32 = Mercury/32\n" .
550 " uw = University of Washington's IMAP server\n" .
551 " gmail = IMAP access to Google mail (Gmail) accounts\n";
553 #####################################################################################
554 if ( $config_use_color == 1 ) {
560 $config_use_color = 2;
563 # lists can be printed in more than one column; default is just one
567 # try to get screen width dynamically if possible; default to 80
568 # (user can override with "w#" command)
570 eval { require "sys/ioctl.ph" };
572 || !defined &TIOCGWINSZ
573 || !open(TTY
, "+</dev/tty")
574 || !ioctl(TTY
, &TIOCGWINSZ
, $winsize='')) {
577 ($row, $col, $xpixel, $ypixel) = unpack('S4', $winsize);
578 $screen_width = $col;
581 while ( ( $command ne "q" ) && ( $command ne "Q" ) && ( $command ne ":q" ) ) {
583 print $WHT. "SquirrelMail Configuration : " . $NRM;
584 if ( $config == 1 ) { print "Read: config.php"; }
585 elsif ( $config == 2 ) { print "Read: config_default.php"; }
586 print " ($print_config_version)\n";
587 print "---------------------------------------------------------\n";
590 print $WHT. "Main Menu --\n" . $NRM;
591 print "1. Organization Preferences\n";
592 print "2. Server Settings\n";
593 print "3. Folder Defaults\n";
594 print "4. General Options\n";
595 print "5. User Interface\n";
596 print "6. Address Books\n";
597 print "7. Message of the Day (MOTD)\n";
598 print "8. Plugins\n";
599 print "9. Database\n";
600 print "10. Language settings\n";
601 print "11. Tweaks\n";
603 print "D. Set pre-defined settings for specific IMAP servers\n";
605 } elsif ( $menu == 1 ) {
606 print $WHT. "Organization Preferences\n" . $NRM;
607 print "1. Organization Name : $WHT$org_name$NRM\n";
608 print "2. Organization Logo : $WHT$org_logo$NRM\n";
609 print "3. Org. Logo Width/Height : $WHT($org_logo_width/$org_logo_height)$NRM\n";
610 print "4. Organization Title : $WHT$org_title$NRM\n";
611 print "5. Signout Page : $WHT$signout_page$NRM\n";
612 print "6. Top Frame : $WHT$frame_top$NRM\n";
613 print "7. Provider link : $WHT$provider_uri$NRM\n";
614 print "8. Provider link text : $WHT$provider_name$NRM\n";
617 print "R Return to Main Menu\n";
618 } elsif ( $menu == 2 ) {
619 print $WHT. "Server Settings\n\n" . $NRM;
620 print $WHT . "General" . $NRM . "\n";
622 print "1. Domain : $WHT$domain$NRM\n";
623 print "2. Invert Time : $WHT$invert_time$NRM\n";
624 print "3. Sendmail or SMTP : $WHT";
625 if ( lc($useSendmail) eq 'true' ) {
633 if ( $show_imap_settings ) {
634 print $WHT . "IMAP Settings". $NRM . "\n--------------\n";
635 print "4. IMAP Server : $WHT$imapServerAddress$NRM\n";
636 print "5. IMAP Port : $WHT$imapPort$NRM\n";
637 print "6. Authentication type : $WHT$imap_auth_mech$NRM\n";
638 print "7. Secure IMAP (TLS) : $WHT" . display_use_tls
($use_imap_tls) . "$NRM\n";
639 print "8. Server software : $WHT$imap_server_type$NRM\n";
640 print "9. Delimiter : $WHT$optional_delimiter$NRM\n";
642 } elsif ( $show_smtp_settings ) {
643 if ( lc($useSendmail) eq 'true' ) {
644 print $WHT . "Sendmail" . $NRM . "\n--------\n";
645 print "4. Sendmail Path : $WHT$sendmail_path$NRM\n";
646 print "5. Sendmail arguments : $WHT$sendmail_args$NRM\n";
647 print "6. Header encryption key : $WHT$encode_header_key$NRM\n";
650 print $WHT . "SMTP Settings" . $NRM . "\n-------------\n";
651 print "4. SMTP Server : $WHT$smtpServerAddress$NRM\n";
652 print "5. SMTP Port : $WHT$smtpPort$NRM\n";
653 print "6. POP before SMTP : $WHT$pop_before_smtp$NRM\n";
654 print "7. SMTP Authentication : $WHT$smtp_auth_mech" . display_smtp_sitewide_userpass
() ."$NRM\n";
655 print "8. Secure SMTP (TLS) : $WHT" . display_use_tls
($use_smtp_tls) . "$NRM\n";
656 print "9. Header encryption key : $WHT$encode_header_key$NRM\n";
661 if ($show_imap_settings == 0) {
662 print "A. Update IMAP Settings : ";
663 print "$WHT$imapServerAddress$NRM:";
664 print "$WHT$imapPort$NRM ";
665 print "($WHT$imap_server_type$NRM)\n";
667 if ($show_smtp_settings == 0) {
668 if ( lc($useSendmail) eq 'true' ) {
669 print "B. Change Sendmail Config : $WHT$sendmail_path$NRM\n";
671 print "B. Update SMTP Settings : ";
672 print "$WHT$smtpServerAddress$NRM:";
673 print "$WHT$smtpPort$NRM\n";
676 if ( $show_smtp_settings || $show_imap_settings )
679 ($show_imap_settings ?
"IMAP Server" :
680 (lc($useSendmail) eq 'true') ?
"Sendmail" : "SMTP") . " Settings\n";
684 print "R Return to Main Menu\n";
685 } elsif ( $menu == 3 ) {
686 print $WHT. "Folder Defaults\n" . $NRM;
687 print "1. Default Folder Prefix : $WHT$default_folder_prefix$NRM\n";
688 print "2. Show Folder Prefix Option : $WHT$show_prefix_option$NRM\n";
689 print "3. Trash Folder : $WHT$trash_folder$NRM\n";
690 print "4. Sent Folder : $WHT$sent_folder$NRM\n";
691 print "5. Drafts Folder : $WHT$draft_folder$NRM\n";
692 print "6. By default, move to trash : $WHT$default_move_to_trash$NRM\n";
693 print "7. By default, save sent messages : $WHT$default_move_to_sent$NRM\n";
694 print "8. By default, save as draft : $WHT$default_save_as_draft$NRM\n";
695 print "9. List Special Folders First : $WHT$list_special_folders_first$NRM\n";
696 print "10. Show Special Folders Color : $WHT$use_special_folder_color$NRM\n";
697 print "11. Auto Expunge : $WHT$auto_expunge$NRM\n";
698 print "12. Default Sub. of INBOX : $WHT$default_sub_of_inbox$NRM\n";
699 print "13. Show 'Contain Sub.' Option : $WHT$show_contain_subfolders_option$NRM\n";
700 print "14. Default Unseen Notify : $WHT$default_unseen_notify$NRM\n";
701 print "15. Default Unseen Type : $WHT$default_unseen_type$NRM\n";
702 print "16. Auto Create Special Folders : $WHT$auto_create_special$NRM\n";
703 print "17. Folder Delete Bypasses Trash : $WHT$delete_folder$NRM\n";
704 print "18. Enable /NoSelect folder fix : $WHT$noselect_fix_enable$NRM\n";
706 print "R Return to Main Menu\n";
707 } elsif ( $menu == 4 ) {
708 print $WHT. "General Options\n" . $NRM;
709 print "1. Data Directory : $WHT$data_dir$NRM\n";
710 print "2. Attachment Directory : $WHT$attachment_dir$NRM\n";
711 print "3. Directory Hash Level : $WHT$dir_hash_level$NRM\n";
712 print "4. Default Left Size : $WHT$default_left_size$NRM\n";
713 print "5. Usernames in Lowercase : $WHT$force_username_lowercase$NRM\n";
714 print "6. Allow use of priority : $WHT$default_use_priority$NRM\n";
715 print "7. Hide SM attributions : $WHT$hide_sm_attributions$NRM\n";
716 print "8. Allow use of receipts : $WHT$default_use_mdn$NRM\n";
717 print "9. Allow editing of identity : $WHT$edit_identity$NRM\n";
718 print " Allow editing of name : $WHT$edit_name$NRM\n";
719 print " Remove username from header : $WHT$hide_auth_header$NRM\n";
720 print "10. Disable server thread sort : $WHT$disable_thread_sort$NRM\n";
721 print "11. Disable server-side sorting : $WHT$disable_server_sort$NRM\n";
722 print "12. Allow server charset search : $WHT$allow_charset_search$NRM\n";
723 print "13. Allow advanced search : $WHT$allow_advanced_search$NRM\n";
724 print "14. PHP session name : $WHT$session_name$NRM\n";
725 print "15. Time zone configuration : $WHT$time_zone_type$NRM\n";
726 print "16. Location base : $WHT$config_location_base$NRM\n";
727 print "17. Only secure cookies if poss. : $WHT$only_secure_cookies$NRM\n";
728 print "18. Disable secure forms : $WHT$disable_security_tokens$NRM\n";
729 print "19. Page referal requirement : $WHT$check_referrer$NRM\n";
730 print "20. Security image : $WHT" . (lc($use_transparent_security_image) eq 'true' ?
'Transparent' : 'Textual') . "$NRM\n";
731 print "21. Display login error from IMAP: $WHT$display_imap_login_error$NRM\n";
733 print "R Return to Main Menu\n";
734 } elsif ( $menu == 5 ) {
735 print $WHT. "User Interface\n" . $NRM;
736 print "1. Use Icons? : $WHT$use_icons$NRM\n";
737 # print "3. Default Icon Set : $WHT$icon_theme_def$NRM\n";
738 print "2. Default font size : $WHT$default_fontsize$NRM\n";
739 print "3. Manage template sets (skins)\n";
740 print "4. Manage user themes\n";
741 print "5. Manage font sets\n";
742 print "6. Manage icon themes\n";
745 print "R Return to Main Menu\n";
746 } elsif ( $menu == 6 ) {
747 print $WHT. "Address Books\n" . $NRM;
748 print "1. Change LDAP Servers\n";
749 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
750 print " > $ldap_host[$count]\n";
752 print "2. Use Javascript address book search : $WHT$default_use_javascript_addr_book$NRM\n";
753 print "3. Global address book file : $WHT$abook_global_file$NRM\n";
754 print "4. Allow writing into global file address book : $WHT$abook_global_file_writeable$NRM\n";
755 print "5. Allow listing of global file address book : $WHT$abook_global_file_listing$NRM\n";
756 print "6. Allowed address book line length : $WHT$abook_file_line_length$NRM\n";
758 print "R Return to Main Menu\n";
759 } elsif ( $menu == 7 ) {
760 print $WHT. "Message of the Day (MOTD)\n" . $NRM;
763 print "1 Edit the MOTD\n";
765 print "R Return to Main Menu\n";
766 } elsif ( $menu == 8 ) {
767 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
768 print $WHT. "Plugins (WARNING: All plugins are currently disabled\n for the user \"$disable_plugins_user\"!)\n" . $NRM;
769 } elsif (lc($disable_plugins) eq 'true') {
770 print $WHT. "Plugins (WARNING: All plugins are currently disabled!)\n" . $NRM;
772 print $WHT. "Plugins\n" . $NRM;
774 print " Installed Plugins\n";
776 $num = print_multi_col_list
(1, $columns, $screen_width, 1, @plugins);
779 for ( $count = 0 ; $count <= $#plugins ; $count++ ) {
781 $english_name = get_plugin_english_name
($plugins[$count]);
782 if ( $english_name eq "" ) {
783 print " $WHT$num.$NRM $plugins[$count]" . get_plugin_version
($plugins[$count]) . "\n";
785 print " $WHT$num.$NRM $english_name ($plugins[$count])" . get_plugin_version
($plugins[$count]) . "\n";
789 print "\n Available Plugins:\n";
790 opendir( DIR
, "../plugins" );
791 @files = sort(readdir(DIR
));
793 @unused_plugins = ();
794 for ( $i = 0 ; $i <= $#files ; $i++ ) {
795 if ( -d
"../plugins/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne ".svn" ) {
797 for ( $k = 0 ; $k <= $#plugins ; $k++ ) {
798 if ( $plugins[$k] eq $files[$i] ) {
803 $unused_plugins[$pos] = $files[$i];
810 $num = print_multi_col_list
($num + 1, $columns, $screen_width, 1, @unused_plugins);
812 for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
814 $english_name = get_plugin_english_name
($unused_plugins[$i]);
815 if ( $english_name eq "" ) {
816 print " $WHT$num.$NRM $unused_plugins[$i]" . get_plugin_version
($unused_plugins[$i]) . "\n";
818 print " $WHT$num.$NRM $english_name ($unused_plugins[$i])" . get_plugin_version
($unused_plugins[$i]) . "\n";
825 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
826 print "E Enable active plugins (all plugins currently\n disabled for the user \"$disable_plugins_user\")\n";
827 } elsif (lc($disable_plugins) eq 'true') {
828 print "E Enable active plugins (all plugins currently\n disabled)\n";
830 print "D Disable all plugins\n";
832 print "U Set the user for whom plugins can be disabled\n";
833 print "R Return to Main Menu\n";
834 print "C# List plugins in <#> number of columns\n";
835 print "W# Change screen width to <#> (currently $screen_width)\n";
836 } elsif ( $menu == 9 ) {
837 print $WHT. "Database\n" . $NRM;
838 print "1. DSN for Address Book : $WHT$addrbook_dsn$NRM\n";
839 print "2. Table for Address Book : $WHT$addrbook_table$NRM\n";
841 print "3. DSN for Preferences : $WHT$prefs_dsn$NRM\n";
842 print "4. Table for Preferences : $WHT$prefs_table$NRM\n";
843 print "5. Field for username : $WHT$prefs_user_field$NRM ($prefs_user_size)\n";
844 print "6. Field for prefs key : $WHT$prefs_key_field$NRM ($prefs_key_size)\n";
845 print "7. Field for prefs value : $WHT$prefs_val_field$NRM ($prefs_val_size)\n";
847 print "8. DSN for Global Address Book : $WHT$addrbook_global_dsn$NRM\n";
848 print "9. Table for Global Address Book : $WHT$addrbook_global_table$NRM\n";
849 print "10. Allow writing into Global Address Book : $WHT$addrbook_global_writeable$NRM\n";
850 print "11. Allow listing of Global Address Book : $WHT$addrbook_global_listing$NRM\n";
852 print "R Return to Main Menu\n";
853 } elsif ( $menu == 10 ) {
854 print $WHT. "Language settings\n" . $NRM;
855 print "1. Default Language : $WHT$squirrelmail_default_language$NRM\n";
856 print "2. Default Charset : $WHT$default_charset$NRM\n";
857 print "3. Show alternative language names : $WHT$show_alternative_names$NRM\n";
858 print "4. Enable aggressive decoding : $WHT$aggressive_decoding$NRM\n";
859 print "5. Enable lossy encoding : $WHT$lossy_encoding$NRM\n";
861 print "R Return to Main Menu\n";
862 } elsif ( $menu == 11 ) {
863 print $WHT. "Interface tweaks\n" . $NRM;
864 print "1. Display html mails in iframe : $WHT$use_iframe$NRM\n";
865 print "2. Ask user info on first login : $WHT$ask_user_info$NRM\n";
867 print $WHT. "PHP tweaks\n" . $NRM;
868 print "4. Use php recode functions : $WHT$use_php_recode$NRM\n";
869 print "5. Use php iconv functions : $WHT$use_php_iconv$NRM\n";
870 print "6. Buffer all output : $WHT$buffer_output$NRM\n";
872 print $WHT. "Configuration tweaks\n" . $NRM;
873 print "7. Allow remote configtest : $WHT$allow_remote_configtest$NRM\n";
874 print "8. Debug mode : $WHT$sm_debug_mode$NRM\n";
875 print "9. Secured configuration mode : $WHT$secured_config$NRM\n";
876 print "10. HTTPS port : $WHT$sq_https_port$NRM\n";
877 print "11. Ignore HTTP_X_FORWARDED headers: $WHT$sq_ignore_http_x_forwarded_headers$NRM\n";
879 print "R Return to Main Menu\n";
881 if ( $config_use_color == 1 ) {
882 print "C Turn color off\n";
884 print "C Turn color on\n";
886 print "S Save data\n";
890 print "Command >> " . $WHT;
892 $command =~ s/[\n\r]//g;
893 $command =~ tr/A-Z/a-z/;
896 # Read the commands they entered.
897 if ( $command eq "r" ) {
899 } elsif ( $command eq "s" ) {
901 print "Press enter to continue...";
904 } elsif ( ( $command eq "q" ) && ( $saved == 0 ) ) {
905 print "You have not saved your data.\n";
906 print "Save? [" . $WHT . "Y" . $NRM . "/n]: ";
908 if ( ( $save =~ /^y/i ) || ( $save =~ /^\s*$/ ) ) {
911 } elsif ( $command eq "c" ) {
912 if ( $config_use_color == 1 ) {
913 $config_use_color = 2;
917 $config_use_color = 1;
921 } elsif ( $command =~ /^w([0-9]+)/ ) {
923 } elsif ( $command eq "d" && $menu == 0 ) {
928 if ( ( $command > 0 ) && ( $command < 12 ) ) {
931 } elsif ( $menu == 1 ) {
932 if ( $command == 1 ) { $org_name = command1
(); }
933 elsif ( $command == 2 ) { $org_logo = command2
(); }
934 elsif ( $command == 3 ) { ($org_logo_width,$org_logo_height) = command2a
(); }
935 elsif ( $command == 4 ) { $org_title = command3
(); }
936 elsif ( $command == 5 ) { $signout_page = command4
(); }
937 elsif ( $command == 6 ) { $frame_top = command6
(); }
938 elsif ( $command == 7 ) { $provider_uri = command7
(); }
939 elsif ( $command == 8 ) { $provider_name = command8
(); }
941 } elsif ( $menu == 2 ) {
942 if ( $command eq "a" ) { $show_imap_settings = 1; $show_smtp_settings = 0; }
943 elsif ( $command eq "b" ) { $show_imap_settings = 0; $show_smtp_settings = 1; }
944 elsif ( $command eq "h" ) { $show_imap_settings = 0; $show_smtp_settings = 0; }
945 elsif ( $command <= 3 ) {
946 if ( $command == 1 ) { $domain = command11
(); }
947 elsif ( $command == 2 ) { $invert_time = command110
(); }
948 elsif ( $command == 3 ) { $useSendmail = command14
(); }
949 $show_imap_settings = 0; $show_smtp_settings = 0;
950 } elsif ( $show_imap_settings ) {
951 if ( $command == 4 ) { $imapServerAddress = command12
(); }
952 elsif ( $command == 5 ) { $imapPort = command13
(); }
953 elsif ( $command == 6 ) { $imap_auth_mech = command112a
(); }
954 elsif ( $command == 7 ) { $use_imap_tls = command_use_tls
("IMAP",$use_imap_tls); }
955 elsif ( $command == 8 ) { $imap_server_type = command19
(); }
956 elsif ( $command == 9 ) { $optional_delimiter = command111
(); }
957 } elsif ( $show_smtp_settings && lc($useSendmail) eq 'true' ) {
958 if ( $command == 4 ) { $sendmail_path = command15
(); }
959 elsif ( $command == 5 ) { $sendmail_args = command_sendmail_args
(); }
960 elsif ( $command == 6 ) { $encode_header_key = command114
(); }
961 } elsif ( $show_smtp_settings ) {
962 if ( $command == 4 ) { $smtpServerAddress = command16
(); }
963 elsif ( $command == 5 ) { $smtpPort = command17
(); }
964 elsif ( $command == 6 ) { $pop_before_smtp = command18a
(); }
965 elsif ( $command == 7 ) { $smtp_auth_mech = command112b
(); }
966 elsif ( $command == 8 ) { $use_smtp_tls = command_use_tls
("SMTP",$use_smtp_tls); }
967 elsif ( $command == 9 ) { $encode_header_key = command114
(); }
969 } elsif ( $menu == 3 ) {
970 if ( $command == 1 ) { $default_folder_prefix = command21
(); }
971 elsif ( $command == 2 ) { $show_prefix_option = command22
(); }
972 elsif ( $command == 3 ) { $trash_folder = command23a
(); }
973 elsif ( $command == 4 ) { $sent_folder = command23b
(); }
974 elsif ( $command == 5 ) { $draft_folder = command23c
(); }
975 elsif ( $command == 6 ) { $default_move_to_trash = command24a
(); }
976 elsif ( $command == 7 ) { $default_move_to_sent = command24b
(); }
977 elsif ( $command == 8 ) { $default_save_as_draft = command24c
(); }
978 elsif ( $command == 9 ) { $list_special_folders_first = command27
(); }
979 elsif ( $command == 10 ) { $use_special_folder_color = command28
(); }
980 elsif ( $command == 11 ) { $auto_expunge = command29
(); }
981 elsif ( $command == 12 ) { $default_sub_of_inbox = command210
(); }
982 elsif ( $command == 13 ) { $show_contain_subfolders_option = command211
(); }
983 elsif ( $command == 14 ) { $default_unseen_notify = command212
(); }
984 elsif ( $command == 15 ) { $default_unseen_type = command213
(); }
985 elsif ( $command == 16 ) { $auto_create_special = command214
(); }
986 elsif ( $command == 17 ) { $delete_folder = command215
(); }
987 elsif ( $command == 18 ) { $noselect_fix_enable = command216
(); }
988 } elsif ( $menu == 4 ) {
989 if ( $command == 1 ) { $data_dir = command33a
(); }
990 elsif ( $command == 2 ) { $attachment_dir = command33b
(); }
991 elsif ( $command == 3 ) { $dir_hash_level = command33c
(); }
992 elsif ( $command == 4 ) { $default_left_size = command35
(); }
993 elsif ( $command == 5 ) { $force_username_lowercase = command36
(); }
994 elsif ( $command == 6 ) { $default_use_priority = command37
(); }
995 elsif ( $command == 7 ) { $hide_sm_attributions = command38
(); }
996 elsif ( $command == 8 ) { $default_use_mdn = command39
(); }
997 elsif ( $command == 9 ) { $edit_identity = command310
(); }
998 elsif ( $command == 10 ) { $disable_thread_sort = command312
(); }
999 elsif ( $command == 11 ) { $disable_server_sort = command313
(); }
1000 elsif ( $command == 12 ) { $allow_charset_search = command314
(); }
1001 elsif ( $command == 13 ) { $allow_advanced_search = command316
(); }
1002 elsif ( $command == 14 ) { $session_name = command317
(); }
1003 elsif ( $command == 15 ) { $time_zone_type = command318
(); }
1004 elsif ( $command == 16 ) { $config_location_base = command_config_location_base
(); }
1005 elsif ( $command == 17 ) { $only_secure_cookies = command319
(); }
1006 elsif ( $command == 18 ) { $disable_security_tokens = command320
(); }
1007 elsif ( $command == 19 ) { $check_referrer = command321
(); }
1008 elsif ( $command == 20 ) { $use_transparent_security_image = command322
(); }
1009 elsif ( $command == 21 ) { $display_imap_login_error = command323
(); }
1010 } elsif ( $menu == 5 ) {
1011 if ( $command == 1 ) { $use_icons = commandB3
(); }
1012 # elsif ( $command == 3 ) { $icon_theme_def = command53(); }
1013 elsif ( $command == 2 ) { $default_fontsize = command_default_fontsize
(); }
1014 elsif ( $command == 3 ) { $templateset_default = command_templates
(); }
1015 elsif ( $command == 4 ) { command_userThemes
(); }
1016 elsif ( $command == 5 ) { command_fontsets
(); }
1017 elsif ( $command == 6 ) { command_iconSets
(); }
1018 } elsif ( $menu == 6 ) {
1019 if ( $command == 1 ) { command61
(); }
1020 elsif ( $command == 2 ) { command62
(); }
1021 elsif ( $command == 3 ) { $abook_global_file=command63
(); }
1022 elsif ( $command == 4 ) { command64
(); }
1023 elsif ( $command == 5 ) { command65
(); }
1024 elsif ( $command == 6 ) { command_abook_file_line_length
(); }
1025 } elsif ( $menu == 7 ) {
1026 if ( $command == 1 ) { $motd = command71
(); }
1027 } elsif ( $menu == 8 ) {
1028 if ( $command =~ /^[0-9]+/ ) { @plugins = command81
(); }
1029 elsif ( $command eq "u" ) { $disable_plugins_user = command82
(); }
1030 elsif ( $command eq "d" ) { $disable_plugins = 'true'; }
1031 elsif ( $command eq "e" ) { $disable_plugins = 'false'; }
1032 elsif ( $command =~ /^c([0-9]+)/ ) { $columns = $1; }
1033 } elsif ( $menu == 9 ) {
1034 if ( $command == 1 ) { $addrbook_dsn = command91
(); }
1035 elsif ( $command == 2 ) { $addrbook_table = command92
(); }
1036 elsif ( $command == 3 ) { $prefs_dsn = command93
(); }
1037 elsif ( $command == 4 ) { $prefs_table = command94
(); }
1038 elsif ( $command == 5 ) { $prefs_user_field = command95
(); }
1039 elsif ( $command == 6 ) { $prefs_key_field = command96
(); }
1040 elsif ( $command == 7 ) { $prefs_val_field = command97
(); }
1041 elsif ( $command == 8 ) { $addrbook_global_dsn = command98
(); }
1042 elsif ( $command == 9 ) { $addrbook_global_table = command99
(); }
1043 elsif ( $command == 10 ) { $addrbook_global_writeable = command910
(); }
1044 elsif ( $command == 11 ) { $addrbook_global_listing = command911
(); }
1045 } elsif ( $menu == 10 ) {
1046 if ( $command == 1 ) { $squirrelmail_default_language = commandA1
(); }
1047 elsif ( $command == 2 ) { $default_charset = commandA2
(); }
1048 elsif ( $command == 3 ) { $show_alternative_names = commandA3
(); }
1049 elsif ( $command == 4 ) { $aggressive_decoding = commandA4
(); }
1050 elsif ( $command == 5 ) { $lossy_encoding = commandA5
(); }
1051 } elsif ( $menu == 11 ) {
1052 if ( $command == 1 ) { $use_iframe = commandB2
(); }
1053 elsif ( $command == 2 ) { $ask_user_info = command_ask_user_info
(); }
1054 elsif ( $command == 4 ) { $use_php_recode = commandB4
(); }
1055 elsif ( $command == 5 ) { $use_php_iconv = commandB5
(); }
1056 elsif ( $command == 6 ) { $buffer_output = commandB6
(); }
1057 elsif ( $command == 7 ) { $allow_remote_configtest = commandB7
(); }
1058 elsif ( $command == 8 ) { $sm_debug_mode = commandB8
(); }
1059 elsif ( $command == 9 ) { $secured_config = commandB9
(); }
1060 elsif ( $command == 10 ) { $sq_https_port = commandB10
(); }
1061 elsif ( $command == 11 ) { $sq_ignore_http_x_forwarded_headers = commandB11
(); }
1067 print "\nExiting conf.pl.\n".
1068 "You might want to test your configuration by browsing to\n".
1069 "http://your-squirrelmail-location/src/configtest.php\n".
1070 "Happy SquirrelMailing!\n\n";
1073 ####################################################################################
1077 print "We have tried to make the name SquirrelMail as transparent as\n";
1078 print "possible. If you set up an organization name, most places where\n";
1079 print "SquirrelMail would take credit will be credited to your organization.\n";
1081 print "If your Organization Name includes a '\$', please precede it with a \\. \n";
1082 print "Other '\$' will be considered the beginning of a variable that\n";
1083 print "must be defined before the \$org_name is printed.\n";
1085 print "[$WHT$org_name$NRM]: $WHT";
1086 $new_org_name = <STDIN
>;
1087 if ( $new_org_name eq "\n" ) {
1088 $new_org_name = $org_name;
1090 $new_org_name =~ s/[\r\n]//g;
1091 $new_org_name =~ s/\"/"/g;
1093 return $new_org_name;
1098 print "Your organization's logo is an image that will be displayed at\n";
1099 print "different times throughout SquirrelMail. ";
1101 print "Please be aware of the following: \n";
1102 print " - Relative URLs are relative to the config dir\n";
1103 print " to use the default logo, use ../images/sm_logo.png\n";
1104 print " - To specify a logo defined outside the SquirrelMail source tree\n";
1105 print " use the absolute URL the webserver would use to include the file\n";
1106 print " e.g. http://example.com/images/mylogo.gif or /images/mylogo.jpg\n";
1108 print "[$WHT$org_logo$NRM]: $WHT";
1109 $new_org_logo = <STDIN
>;
1110 if ( $new_org_logo eq "\n" ) {
1111 $new_org_logo = $org_logo;
1113 $new_org_logo =~ s/[\r\n]//g;
1115 return $new_org_logo;
1120 print "Your organization's logo is an image that will be displayed at\n";
1121 print "different times throughout SquirrelMail. Width\n";
1122 print "and Height of your logo image. Use '0' to disable.\n";
1124 print "Width: [$WHT$org_logo_width$NRM]: $WHT";
1125 $new_org_logo_width = <STDIN
>;
1126 $new_org_logo_width =~ tr/0-9//cd; # only want digits!
1127 if ( $new_org_logo_width eq '' ) {
1128 $new_org_logo_width = $org_logo_width;
1130 if ( $new_org_logo_width > 0 ) {
1131 print "Height: [$WHT$org_logo_height$NRM]: $WHT";
1132 $new_org_logo_height = <STDIN
>;
1133 $new_org_logo_height =~ tr/0-9//cd; # only want digits!
1134 if( $new_org_logo_height eq '' ) {
1135 $new_org_logo_height = $org_logo_height;
1138 $new_org_logo_height = 0;
1140 return ($new_org_logo_width, $new_org_logo_height);
1145 print "A title is what is displayed at the top of the browser window in\n";
1146 print "the titlebar. Usually this will end up looking something like:\n";
1147 print "\"Netscape: $org_title\"\n";
1149 print "If your Organization Title includes a '\$', please precede it with a \\. \n";
1150 print "Other '\$' will be considered the beginning of a variable that\n";
1151 print "must be defined before the \$org_title is printed.\n";
1153 print "[$WHT$org_title$NRM]: $WHT";
1154 $new_org_title = <STDIN
>;
1155 if ( $new_org_title eq "\n" ) {
1156 $new_org_title = $org_title;
1158 $new_org_title =~ s/[\r\n]//g;
1159 $new_org_title =~ s/\"/\'/g;
1161 return $new_org_title;
1166 print "When users click the Sign Out button they will be logged out and\n";
1167 print "then sent to signout_page. If signout_page is left empty,\n";
1168 print "(hit space and then return) they will be taken, as normal,\n";
1169 print "to the default and rather sparse SquirrelMail signout page.\n";
1171 print "[$WHT$signout_page$NRM]: $WHT";
1172 $new_signout_page = <STDIN
>;
1173 if ( $new_signout_page eq "\n" ) {
1174 $new_signout_page = $signout_page;
1176 $new_signout_page =~ s/[\r\n]//g;
1177 $new_signout_page =~ s/^\s+$//g;
1179 return $new_signout_page;
1184 print "SquirrelMail defaults to using the whole of the browser window.\n";
1185 print "This allows you to keep it within a specified frame. The default\n";
1186 print "is '_top'\n";
1188 print "[$WHT$frame_top$NRM]: $WHT";
1189 $new_frame_top = <STDIN
>;
1190 if ( $new_frame_top eq "\n" ) {
1191 $new_frame_top = '_top';
1193 $new_frame_top =~ s/[\r\n]//g;
1194 $new_frame_top =~ s/^\s+$//g;
1196 return $new_frame_top;
1199 # Default link to provider
1201 print "Here you can set the link on the top-right of the message list.\n";
1202 print "If empty, it will not be displayed.\n";
1204 print "[$WHT$provider_uri$NRM]: $WHT";
1205 $new_provider_uri = <STDIN
>;
1206 if ( $new_provider_uri eq "\n" ) {
1207 $new_provider_uri = '';
1209 $new_provider_uri =~ s/[\r\n]//g;
1210 $new_provider_uri =~ s/^\s+$//g;
1212 return $new_provider_uri;
1216 print "Here you can set the name of the link on the top-right of the message list.\n";
1217 print "The default is empty (do not display anything).'\n";
1219 print "[$WHT$provider_name$NRM]: $WHT";
1220 $new_provider_name = <STDIN
>;
1221 if ( $new_provider_name eq "\n" ) {
1222 $new_provider_name = '';
1224 $new_provider_name =~ s/[\r\n]//g;
1225 $new_provider_name =~ s/^\s+$//g;
1226 $new_provider_name =~ s/\'/\\'/g;
1228 return $new_provider_name;
1231 ####################################################################################
1235 print "The domain name is the suffix at the end of all email addresses. If\n";
1236 print "for example, your email address is jdoe\@example.com, then your domain\n";
1237 print "would be example.com.\n";
1239 print "[$WHT$domain$NRM]: $WHT";
1240 $new_domain = <STDIN
>;
1241 if ( $new_domain eq "\n" ) {
1242 $new_domain = $domain;
1244 $new_domain =~ s/\s//g;
1251 print "This is the hostname where your IMAP server can be contacted.\n";
1252 print "[$WHT$imapServerAddress$NRM]: $WHT";
1253 $new_imapServerAddress = <STDIN
>;
1254 if ( $new_imapServerAddress eq "\n" ) {
1255 $new_imapServerAddress = $imapServerAddress;
1257 $new_imapServerAddress =~ s/[\r\n]//g;
1259 return $new_imapServerAddress;
1264 print "This is the port that your IMAP server is on. Usually this is 143.\n";
1265 print "[$WHT$imapPort$NRM]: $WHT";
1266 $new_imapPort = <STDIN
>;
1267 if ( $new_imapPort eq "\n" ) {
1268 $new_imapPort = $imapPort;
1270 $new_imapPort =~ s/[\r\n]//g;
1272 return $new_imapPort;
1277 print "You now need to choose the method that you will use for sending\n";
1278 print "messages in SquirrelMail. You can either connect to an SMTP server\n";
1279 print "or use sendmail directly.\n";
1280 if ( lc($useSendmail) eq 'true' ) {
1281 $default_value = "1";
1283 $default_value = "2";
1286 print " 1. Sendmail\n";
1288 print "Your choice [1/2] [$WHT$default_value$NRM]: $WHT";
1289 $use_sendmail = <STDIN
>;
1290 if ( ( $use_sendmail =~ /^1\n/i )
1291 || ( ( $use_sendmail =~ /^\n/ ) && ( $default_value eq "1" ) ) ) {
1292 $useSendmail = 'true';
1294 $useSendmail = 'false';
1296 return $useSendmail;
1301 print "Specify where the sendmail executable is located. Usually /usr/sbin/sendmail\n";
1302 print "[$WHT$sendmail_path$NRM]: $WHT";
1303 $new_sendmail_path = <STDIN
>;
1304 if ( $new_sendmail_path eq "\n" ) {
1305 $new_sendmail_path = $sendmail_path;
1307 $new_sendmail_path =~ s/[\r\n]//g;
1309 return $new_sendmail_path;
1312 # Extra sendmail arguments
1313 sub command_sendmail_args
{
1314 print "Specify additional sendmail program arguments.\n";
1316 print "Make sure that arguments are supported by your sendmail program. -f argument \n";
1317 print "is added automatically by SquirrelMail scripts. Variable defaults to standard\n";
1318 print "/usr/sbin/sendmail arguments. If you use qmail-inject, nbsmtp or any other \n";
1319 print "sendmail wrapper, which does not support -i and -t arguments, set variable to\n";
1320 print "empty string or use arguments suitable for your mailer.\n";
1322 print "[$WHT$sendmail_args$NRM]: $WHT";
1323 $new_sendmail_args = <STDIN
>;
1324 if ( $new_sendmail_args eq "\n" ) {
1325 $new_sendmail_args = $sendmail_args;
1327 # strip linefeeds and crs.
1328 $new_sendmail_args =~ s/[\r\n]//g;
1330 return trim
($new_sendmail_args);
1335 print "This is the hostname of your SMTP server.\n";
1336 print "[$WHT$smtpServerAddress$NRM]: $WHT";
1337 $new_smtpServerAddress = <STDIN
>;
1338 if ( $new_smtpServerAddress eq "\n" ) {
1339 $new_smtpServerAddress = $smtpServerAddress;
1341 $new_smtpServerAddress =~ s/[\r\n]//g;
1343 return $new_smtpServerAddress;
1348 print "This is the port to connect to for SMTP. Usually 25.\n";
1349 print "[$WHT$smtpPort$NRM]: $WHT";
1350 $new_smtpPort = <STDIN
>;
1351 if ( $new_smtpPort eq "\n" ) {
1352 $new_smtpPort = $smtpPort;
1354 $new_smtpPort =~ s/[\r\n]//g;
1356 return $new_smtpPort;
1361 print "Do you wish to use POP3 before SMTP? Your server must\n";
1362 print "support this in order for SquirrelMail to work with it.\n";
1365 $YesNo = 'y' if ( lc($pop_before_smtp) eq 'true' );
1367 print "Use POP before SMTP (y/n) [$WHT$YesNo$NRM]: $WHT";
1369 $new_pop_before_smtp = <STDIN
>;
1370 $new_pop_before_smtp =~ tr/yn//cd;
1371 if ( $new_pop_before_smtp eq "y" ) {
1372 $new_pop_before_smtp = "true";
1373 } elsif ( $new_pop_before_smtp eq "n" ) {
1374 $new_pop_before_smtp = "false";
1376 $new_pop_before_smtp = $pop_before_smtp;
1379 # if using POP before SMTP, allow setting of custom POP server address
1380 if ($new_pop_before_smtp eq "true") {
1381 print "$NRM\nIf the address of the POP server is not the same as\n";
1382 print "your SMTP server, you may specify it here. Leave blank (to\n";
1383 print "clear this, enter only spaces) to use the same address as\n";
1384 print "your SMTP server.\n";
1385 print "POP before SMTP server address [$WHT$pop_before_smtp_host$NRM]: $WHT";
1387 $new_pop_before_smtp_host = <STDIN
>;
1388 if ( $new_pop_before_smtp_host eq "\n" ) {
1389 $new_pop_before_smtp_host = $pop_before_smtp_host;
1390 } elsif ($new_pop_before_smtp_host =~ /^\s+$/) {
1391 $new_pop_before_smtp_host = '';
1393 $new_pop_before_smtp_host =~ s/[\r|\n]//g;
1395 $pop_before_smtp_host = $new_pop_before_smtp_host;
1398 return $new_pop_before_smtp;
1403 print "Each IMAP server has its own quirks. As much as we tried to stick\n";
1404 print "to standards, it doesn't help much if the IMAP server doesn't follow\n";
1405 print "the same principles. We have made some work-arounds for some of\n";
1406 print "these servers. If you would like to use them, please select your\n";
1407 print "IMAP server. If you do not wish to use these work-arounds, you can\n";
1408 print "set this to \"other\", and none will be used.\n";
1409 print $list_supported_imap_servers;
1411 print " other = Not one of the above servers\n";
1413 print "[$WHT$imap_server_type$NRM]: $WHT";
1414 $new_imap_server_type = <STDIN
>;
1416 if ( $new_imap_server_type eq "\n" ) {
1417 $new_imap_server_type = $imap_server_type;
1419 $new_imap_server_type =~ s/[\r\n]//g;
1421 return $new_imap_server_type;
1426 print "Sometimes the date of messages sent is messed up (off by a few hours\n";
1427 print "on some machines). Typically this happens if the system doesn't support\n";
1428 print "tm_gmtoff. It will happen only if your time zone is \"negative\".\n";
1429 print "This most often occurs on Solaris 7 machines in the United States.\n";
1430 print "By default, this is off. It should be kept off unless problems surface\n";
1431 print "about the time that messages are sent.\n";
1432 print " no = Do NOT fix time -- almost always correct\n";
1433 print " yes = Fix the time for this system\n";
1436 $YesNo = 'y' if ( lc($invert_time) eq 'true' );
1438 print "Fix the time for this system (y/n) [$WHT$YesNo$NRM]: $WHT";
1440 $new_invert_time = <STDIN
>;
1441 $new_invert_time =~ tr/yn//cd;
1442 return 'true' if ( $new_invert_time eq "y" );
1443 return 'false' if ( $new_invert_time eq "n" );
1444 return $invert_time;
1448 print "This is the delimiter that your IMAP server uses to distinguish between\n";
1449 print "folders. For example, Cyrus uses '.' as the delimiter and a complete\n";
1450 print "folder would look like 'INBOX.Friends.Bob', while UW uses '/' and would\n";
1451 print "look like 'INBOX/Friends/Bob'. Normally this should be left at 'detect'\n";
1452 print "but if you are sure you know what delimiter your server uses, you can\n";
1453 print "specify it here.\n";
1454 print "\nTo have it autodetect the delimiter, set it to 'detect'.\n\n";
1455 print "[$WHT$optional_delimiter$NRM]: $WHT";
1456 $new_optional_delimiter = <STDIN
>;
1458 if ( $new_optional_delimiter eq "\n" ) {
1459 $new_optional_delimiter = $optional_delimiter;
1461 $new_optional_delimiter =~ s/[\r\n]//g;
1463 return $new_optional_delimiter;
1465 # IMAP authentication type
1466 # Possible values: login, plain, cram-md5, digest-md5
1467 # Now offers to detect supported mechs, assuming server & port are set correctly
1470 if ($use_imap_tls ne "0") {
1471 # 1. Script does not handle TLS.
1472 # 2. Server does not have to declare all supported authentication mechs when
1473 # STARTTLS is used. Supported mechs are declared only after STARTTLS.
1474 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1476 print "If you have already set the hostname and port number, I can try to\n";
1477 print "detect the mechanisms your IMAP server supports.\n";
1478 print "I will try to detect CRAM-MD5 and DIGEST-MD5 support. I can't test\n";
1479 print "for \"login\" or \"plain\" without knowing a username and password.\n";
1480 print "Auto-detecting is optional - you can safely say \"n\" here.\n";
1481 print "\nTry to detect supported mechanisms? [y/N]: ";
1484 if ($inval =~ /^y\b/i) {
1485 # Yes, let's try to detect.
1486 print "Trying to detect IMAP capabilities...\n";
1487 my $host = $imapServerAddress . ':'. $imapPort;
1488 print "CRAM-MD5:\t";
1489 my $tmp = detect_auth_support
('IMAP',$host,'CRAM-MD5');
1490 if (defined($tmp)) {
1491 if ($tmp eq 'YES') {
1492 print "$WHT SUPPORTED$NRM\n";
1494 print "$WHT NOT SUPPORTED$NRM\n";
1497 print $WHT . " ERROR DETECTING$NRM\n";
1500 print "DIGEST-MD5:\t";
1501 $tmp = detect_auth_support
('IMAP',$host,'DIGEST-MD5');
1502 if (defined($tmp)) {
1503 if ($tmp eq 'YES') {
1504 print "$WHT SUPPORTED$NRM\n";
1506 print "$WHT NOT SUPPORTED$NRM\n";
1509 print $WHT . " ERROR DETECTING$NRM\n";
1514 print "\nWhat authentication mechanism do you want to use for IMAP connections?\n\n";
1515 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1516 print $WHT . "plain" . $NRM . " - SASL PLAIN. If you need this, you already know it.\n";
1517 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext methods.\n";
1518 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1519 print "\n*** YOUR IMAP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n";
1520 print "If you don't understand or are unsure, you probably want \"login\"\n\n";
1521 print "login, plain, cram-md5, or digest-md5 [$WHT$imap_auth_mech$NRM]: $WHT";
1524 if ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) || ($inval =~ /^login\b/i) || ($inval =~ /^plain\b/i)) {
1527 # user entered garbage or default value so nothing needs to be set
1528 return $imap_auth_mech;
1533 # SMTP authentication type
1534 # Possible choices: none, login, plain, cram-md5, digest-md5
1536 if ($use_smtp_tls ne "0") {
1537 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1538 } elsif (eval ("use IO::Socket; 1")) {
1539 # try loading IO::Socket module
1540 print "If you have already set the hostname and port number, I can try to\n";
1541 print "automatically detect some of the mechanisms your SMTP server supports.\n";
1542 print "Auto-detection is *optional* - you can safely say \"n\" here.\n";
1543 print "\nTry to detect auth mechanisms? [y/N]: ";
1546 if ($inval =~ /^y\b/i) {
1547 # Yes, let's try to detect.
1548 print "Trying to detect supported methods (SMTP)...\n";
1551 # Check none by trying to relay to junk@microsoft.com
1552 $host = $smtpServerAddress . ':' . $smtpPort;
1553 my $sock = IO
::Socket
::INET
->new($host);
1554 print "Testing none:\t\t$WHT";
1555 if (!defined($sock)) {
1556 print " ERROR TESTING\n";
1559 $got = <$sock>; # Discard greeting
1560 print $sock "HELO $domain\r\n";
1561 $got = <$sock>; # Discard
1562 print $sock "MAIL FROM:<tester\@squirrelmail.org>\r\n";
1563 $got = <$sock>; # Discard
1564 print $sock "RCPT TO:<junk\@microsoft.com\r\n";
1565 $got = <$sock>; # This is the important line
1566 if ($got =~ /^250\b/) { # SMTP will relay without auth
1567 print "SUPPORTED$NRM\n";
1569 print "NOT SUPPORTED$NRM\n";
1571 print $sock "RSET\r\n";
1572 print $sock "QUIT\r\n";
1576 # Try login (SquirrelMail default)
1577 print "Testing login:\t\t";
1578 $tmp=detect_auth_support
('SMTP',$host,'LOGIN');
1579 if (defined($tmp)) {
1580 if ($tmp eq 'YES') {
1581 print $WHT . "SUPPORTED$NRM\n";
1583 print $WHT . "NOT SUPPORTED$NRM\n";
1586 print $WHT . "ERROR DETECTING$NRM\n";
1590 print "Testing plain:\t\t";
1591 $tmp=detect_auth_support
('SMTP',$host,'PLAIN');
1592 if (defined($tmp)) {
1593 if ($tmp eq 'YES') {
1594 print $WHT . "SUPPORTED$NRM\n";
1596 print $WHT . "NOT SUPPORTED$NRM\n";
1599 print $WHT . "ERROR DETECTING$NRM\n";
1603 print "Testing CRAM-MD5:\t";
1604 $tmp=detect_auth_support
('SMTP',$host,'CRAM-MD5');
1605 if (defined($tmp)) {
1606 if ($tmp eq 'YES') {
1607 print $WHT . "SUPPORTED$NRM\n";
1609 print $WHT . "NOT SUPPORTED$NRM\n";
1612 print $WHT . "ERROR DETECTING$NRM\n";
1616 print "Testing DIGEST-MD5:\t";
1617 $tmp=detect_auth_support
('SMTP',$host,'DIGEST-MD5');
1618 if (defined($tmp)) {
1619 if ($tmp eq 'YES') {
1620 print $WHT . "SUPPORTED$NRM\n";
1622 print $WHT . "NOT SUPPORTED$NRM\n";
1625 print $WHT . "ERROR DETECTING$NRM\n";
1629 print "\nWhat authentication mechanism do you want to use for SMTP connections?\n";
1630 print $WHT . "none" . $NRM . " - Your SMTP server does not require authorization.\n";
1631 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1632 print $WHT . "plain" . $NRM . " - SASL PLAIN. Plaintext. If you can do better, you probably should.\n";
1633 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext.\n";
1634 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1635 print $WHT . "\n*** YOUR SMTP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n" . $NRM;
1636 print "If you don't understand or are unsure, you probably want \"none\"\n\n";
1637 print "none, login, plain, cram-md5, or digest-md5 [$WHT$smtp_auth_mech$NRM]: $WHT";
1640 if ($inval =~ /^none\b/i) {
1641 # remove sitewide smtp authentication information
1642 $smtp_sitewide_user = '';
1643 $smtp_sitewide_pass = '';
1644 # SMTP doesn't necessarily require logins
1646 } elsif ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) ||
1647 ($inval =~ /^login\b/i) || ($inval =~/^plain\b/i)) {
1648 command_smtp_sitewide_userpass
($inval);
1650 } elsif (trim
($inval) eq '') {
1651 # user selected default value
1652 command_smtp_sitewide_userpass
($smtp_auth_mech);
1653 return $smtp_auth_mech;
1655 # user entered garbage
1656 return $smtp_auth_mech;
1660 sub command_smtp_sitewide_userpass
($) {
1661 # get first function argument
1662 my $auth_mech = shift(@_);
1664 $auth_mech = lc(trim
($auth_mech));
1665 if ($auth_mech eq 'none') {
1668 print "SMTP authentication uses IMAP username and password by default.\n";
1670 print "Would you like to use other login and password for all SquirrelMail \n";
1671 print "SMTP connections?";
1672 if ($smtp_sitewide_user ne '') {
1689 $smtp_sitewide_user = '';
1690 $smtp_sitewide_pass = '';
1691 } elsif ($tmp eq 'y') {
1692 print "Enter username [$smtp_sitewide_user]:";
1693 my $new_user = <STDIN
>;
1694 $new_user = trim
($new_user);
1695 if ($new_user ne '') {
1696 $smtp_sitewide_user = $new_user;
1698 if ($smtp_sitewide_user ne '') {
1699 print "If you don't enter any password, current sitewide password will be used.\n";
1700 print "If you enter space, password will be set to empty string.\n";
1701 print "Enter password:";
1702 my $new_pass = <STDIN
>;
1703 if ($new_pass ne "\n") {
1704 $smtp_sitewide_pass = trim
($new_pass);
1707 print "Invalid input. You must set username used for SMTP authentication.\n";
1708 print "Click enter to continue\n";
1712 print "Invalid input\n";
1713 print "Click enter to continue\n";
1718 # Sub adds information about SMTP authentication type to menu
1719 sub display_smtp_sitewide_userpass
() {
1721 if ($smtp_auth_mech ne 'none') {
1722 if ($smtp_sitewide_user ne '') {
1723 $ret = ' (with custom username and password)';
1725 $ret = ' (with IMAP username and password)';
1732 # This sub is reused for IMAP and SMTP
1733 # Args: service name, default value
1734 sub command_use_tls
{
1735 my($default_val,$service,$inval);
1738 print "TLS (Transport Layer Security) encrypts the traffic between server and client.\n";
1739 print "STARTTLS extensions allow to start encryption on existing plain text connection.\n";
1740 print "These options add specific PHP and IMAP server configuration requirements.\n";
1741 print "See SquirrelMail documentation about connection security.\n";
1743 print "If your " . $service . " server is localhost, you can safely disable this.\n";
1744 print "If it is remote, you may wish to seriously consider enabling this.\n";
1746 while ($valid_input eq 0) {
1747 print "\nSelect connection security model:\n";
1748 print " 0 - Use plain text connection\n";
1749 print " 1 - Use TLS connection\n";
1750 print " 2 - Use STARTTLS extension\n";
1751 print "Select [$default_val]: ";
1753 $inval=trim
($inval);
1754 if ($inval =~ /^[012]$/ || $inval eq '') {
1758 if ($inval ne '') {$default_val = $inval};
1759 return $default_val;
1762 # This sub is used to display human readable text for
1763 # $use_imap_tls and $use_smtp_tls values in conf.pl menu
1764 sub display_use_tls
($) {
1765 my $val = shift(@_);
1766 my $ret = 'disabled';
1769 } elsif ($val eq '1') {
1775 # $encode_header_key
1777 print "This encryption key allows the hiding of SquirrelMail Received:\n";
1778 print "headers in outbound messages. SquirrelMail uses the encryption\n";
1779 print "key to encode the username, remote address, and proxied address\n";
1780 print "and then stores that encoded information in X-Squirrel-* headers.\n";
1782 print "Warning: the encryption function used to accomplish this is not\n";
1783 print "bulletproof. When used with a static encryption key as it is here,\n";
1784 print "it provides only minimal security and the encoded user information\n";
1785 print "in the X-Squirrel-* headers can be decoded quickly by a skilled\n";
1786 print "attacker.\n";
1788 print "When you need to inspect an email sent from your system with the\n";
1789 print "X-Squirrel-* headers, you can decode the user information therein\n";
1790 print "by using the decrypt_headers.php script found in the SquirrelMail\n";
1791 print "contrib/ directory. You'll need the encryption key that you\n";
1792 print "defined here when doing so.\n";
1794 print "Enter encryption key: ";
1795 $new_encode_header_key = <STDIN
>;
1796 if ( $new_encode_header_key eq "\n" ) {
1797 $new_encode_header_key = $encode_header_key;
1799 $new_encode_header_key =~ s/[\r\n]//g;
1801 return $new_encode_header_key;
1806 print "\nYou can now create the welcome message that is displayed\n";
1807 print "every time a user logs on. You can use HTML or just plain\n";
1809 "text. If you do not wish to have one, just make it blank.\n\n(Type @ on a blank line to exit)\n";
1815 $line =~ s/[\r\n]//g;
1816 if ( $line ne "@" ) {
1817 $line =~ s/ /\ \ /g;
1818 $line =~ s/\t/\ \ \ \ /g;
1820 $line =~ s/\"/\\\"/g;
1822 $new_motd = $new_motd . $line;
1824 } while ( $line ne "@" );
1828 ################# PLUGINS ###################
1831 $command =~ s/[\s\n\r]*//g;
1832 if ( $command > 0 ) {
1833 $command = $command - 1;
1834 if ( $command <= $#plugins ) {
1837 while ( $ct <= $#plugins ) {
1838 if ( $ct != $command ) {
1839 @newplugins = ( @newplugins, $plugins[$ct] );
1843 @plugins = @newplugins;
1844 } elsif ( $command <= $#plugins + $#unused_plugins + 1 ) {
1845 $num = $command - $#plugins - 1;
1846 @newplugins = @plugins;
1848 while ( $ct <= $#unused_plugins ) {
1849 if ( $ct == $num ) {
1850 @newplugins = ( @newplugins, $unused_plugins[$ct] );
1854 @plugins = @newplugins;
1860 # disable_plugins_user
1862 print "When all active plugins are disabled, they can be disabled only\n";
1863 print "for the one user named here. If left blank, plugins will be\n";
1864 print "disabled for ALL users. This setting has no effect if plugins\n";
1865 print "are not disabled.\n";
1867 print "This must be the exact IMAP login name for the desired user.\n";
1869 print "[$WHT$disable_plugins_user$NRM]: $WHT";
1870 $new_disable_plugins_user = <STDIN
>;
1871 if ( $new_disable_plugins_user eq "\n" ) {
1872 $new_disable_plugins_user = $disable_plugins_user;
1874 $new_disable_plugins_user =~ s/[\r\n]//g;
1876 return $new_disable_plugins_user;
1879 ################# FOLDERS ###################
1881 # default_folder_prefix
1883 print "Some IMAP servers (UW, for example) store mail and folders in\n";
1884 print "your user space in a separate subdirectory. This is where you\n";
1885 print "specify what that directory is.\n";
1887 print "EXAMPLE: mail/";
1889 print "NOTE: If you use Cyrus, or some server that would not use this\n";
1890 print " option, you must set this to 'none'.\n";
1892 print "[$WHT$default_folder_prefix$NRM]: $WHT";
1893 $new_default_folder_prefix = <STDIN
>;
1895 if ( $new_default_folder_prefix eq "\n" ) {
1896 $new_default_folder_prefix = $default_folder_prefix;
1898 $new_default_folder_prefix =~ s/[\r\n]//g;
1900 if ( ( $new_default_folder_prefix =~ /^\s*$/ ) || ( $new_default_folder_prefix =~ m/^none$/i ) ) {
1901 $new_default_folder_prefix = "";
1903 # add the trailing delimiter only if we know what the server is.
1904 if (($imap_server_type eq 'cyrus' and
1905 $optional_delimiter eq 'detect') or
1906 ($imap_server_type eq 'courier' and
1907 $optional_delimiter eq 'detect')) {
1908 $new_default_folder_prefix =~ s/\.*$/\./;
1909 } elsif ($imap_server_type eq 'uw' and
1910 $optional_delimiter eq 'detect') {
1911 $new_default_folder_prefix =~ s/\/*$/\
//;
1914 return $new_default_folder_prefix;
1917 # Show Folder Prefix
1919 print "It is possible to set up the default folder prefix as a user\n";
1920 print "specific option, where each user can specify what their mail\n";
1921 print "folder is. If you set this to false, they will never see the\n";
1922 print "option, but if it is true, this option will appear in the\n";
1923 print "'options' section.\n";
1925 print "NOTE: You set the default folder prefix in option '1' of this\n";
1926 print " section. That will be the default if the user doesn't\n";
1927 print " specify anything different.\n";
1930 if ( lc($show_prefix_option) eq 'true' ) {
1931 $default_value = "y";
1933 $default_value = "n";
1936 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
1937 $new_show = <STDIN
>;
1938 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1939 $show_prefix_option = 'true';
1941 $show_prefix_option = 'false';
1943 return $show_prefix_option;
1948 print "You can now specify where the default trash folder is located.\n";
1949 print "On servers where you do not want this, you can set it to anything\n";
1950 print "and set option 6 to false.\n";
1952 print "This is relative to where the rest of your email is kept. You do\n";
1953 print "not need to worry about their mail directory. If this folder\n";
1954 print "would be ~/mail/trash on the filesystem, you only need to specify\n";
1955 print "that this is 'trash', and be sure to put 'mail/' in option 1.\n";
1958 print "[$WHT$trash_folder$NRM]: $WHT";
1959 $new_trash_folder = <STDIN
>;
1960 if ( $new_trash_folder eq "\n" ) {
1961 $new_trash_folder = $trash_folder;
1963 if (check_imap_folder
($new_trash_folder)) {
1964 $new_trash_folder =~ s/[\r\n]//g;
1966 $new_trash_folder = $trash_folder;
1969 return $new_trash_folder;
1974 print "This is where messages that are sent will be stored. SquirrelMail\n";
1975 print "by default puts a copy of all outgoing messages in this folder.\n";
1977 print "This is relative to where the rest of your email is kept. You do\n";
1978 print "not need to worry about their mail directory. If this folder\n";
1979 print "would be ~/mail/sent on the filesystem, you only need to specify\n";
1980 print "that this is 'sent', and be sure to put 'mail/' in option 1.\n";
1983 print "[$WHT$sent_folder$NRM]: $WHT";
1984 $new_sent_folder = <STDIN
>;
1985 if ( $new_sent_folder eq "\n" ) {
1986 $new_sent_folder = $sent_folder;
1988 if (check_imap_folder
($new_sent_folder)) {
1989 $new_sent_folder =~ s/[\r\n]//g;
1991 $new_sent_folder = $sent_folder;
1994 return $new_sent_folder;
1999 print "You can now specify where the default draft folder is located.\n";
2000 print "On servers where you do not want this, you can set it to anything\n";
2001 print "and set option 9 to false.\n";
2003 print "This is relative to where the rest of your email is kept. You do\n";
2004 print "not need to worry about their mail directory. If this folder\n";
2005 print "would be ~/mail/drafts on the filesystem, you only need to specify\n";
2006 print "that this is 'drafts', and be sure to put 'mail/' in option 1.\n";
2009 print "[$WHT$draft_folder$NRM]: $WHT";
2010 $new_draft_folder = <STDIN
>;
2011 if ( $new_draft_folder eq "\n" ) {
2012 $new_draft_folder = $draft_folder;
2014 if (check_imap_folder
($new_draft_folder)) {
2015 $new_draft_folder =~ s/[\r\n]//g;
2017 $new_draft_folder = $draft_folder;
2020 return $new_draft_folder;
2023 # default move to trash
2025 print "By default, should messages get moved to the trash folder? You\n";
2026 print "can specify the default trash folder in option 3. If this is set\n";
2027 print "to false, messages will get deleted immediately without moving\n";
2028 print "to the trash folder.\n";
2030 print "Trash folder is currently: $trash_folder\n";
2033 if ( lc($default_move_to_trash) eq 'true' ) {
2034 $default_value = "y";
2036 $default_value = "n";
2038 print "By default, move to trash (y/n) [$WHT$default_value$NRM]: $WHT";
2039 $new_show = <STDIN
>;
2040 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2041 $default_move_to_trash = 'true';
2043 $default_move_to_trash = 'false';
2045 return $default_move_to_trash;
2048 # default move to sent (save sent messages)
2050 print "By default, should copies of outgoing messages get saved in the\n";
2051 print "sent folder? You can specify the default sent folder in option 4.\n";
2052 print "If this is set to false, messages will get sent and no copy will\n";
2055 print "Sent folder is currently: $sent_folder\n";
2058 if ( lc($default_move_to_sent) eq 'true' ) {
2059 $default_value = "y";
2061 $default_value = "n";
2063 print "By default, save sent messages (y/n) [$WHT$default_value$NRM]: $WHT";
2064 $new_show = <STDIN
>;
2065 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2066 $default_move_to_sent = 'true';
2068 $default_move_to_sent = 'false';
2070 return $default_move_to_sent;
2073 # default save as draft
2075 print "By default, should the save to draft option be shown? You can\n";
2076 print "specify the default drafts folder in option 5. If this is set\n";
2077 print "to false, users will not be shown the save to draft option.\n";
2079 print "Drafts folder is currently: $draft_folder\n";
2082 if ( lc($default_save_as_draft) eq 'true' ) {
2083 $default_value = "y";
2085 $default_value = "n";
2087 print "By default, save as draft (y/n) [$WHT$default_value$NRM]: $WHT";
2088 $new_show = <STDIN
>;
2089 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2090 $default_save_as_draft = 'true';
2092 $default_save_as_draft = 'false';
2094 return $default_save_as_draft;
2097 # List special folders first
2099 print "SquirrelMail has what we call 'special folders' that are not\n";
2100 print "manipulated and viewed like normal folders. Some examples of\n";
2101 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
2102 print "Simply asks if you want these folders listed first in the folder\n";
2106 if ( lc($list_special_folders_first) eq 'true' ) {
2107 $default_value = "y";
2109 $default_value = "n";
2112 print "List first (y/n) [$WHT$default_value$NRM]: $WHT";
2113 $new_show = <STDIN
>;
2114 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2115 $list_special_folders_first = 'true';
2117 $list_special_folders_first = 'false';
2119 return $list_special_folders_first;
2122 # Show special folders color
2124 print "SquirrelMail has what we call 'special folders' that are not\n";
2125 print "manipulated and viewed like normal folders. Some examples of\n";
2126 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
2127 print "wants to know if we should display special folders in a\n";
2128 print "color than the other folders.\n";
2131 if ( lc($use_special_folder_color) eq 'true' ) {
2132 $default_value = "y";
2134 $default_value = "n";
2137 print "Show color (y/n) [$WHT$default_value$NRM]: $WHT";
2138 $new_show = <STDIN
>;
2139 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2140 $use_special_folder_color = 'true';
2142 $use_special_folder_color = 'false';
2144 return $use_special_folder_color;
2149 print "The way that IMAP handles deleting messages is as follows. You\n";
2150 print "mark the message as deleted, and then to 'really' delete it, you\n";
2151 print "expunge it. This option asks if you want to just have messages\n";
2152 print "marked as deleted, or if you want SquirrelMail to expunge the \n";
2153 print "messages too.\n";
2156 if ( lc($auto_expunge) eq 'true' ) {
2157 $default_value = "y";
2159 $default_value = "n";
2161 print "Auto expunge (y/n) [$WHT$default_value$NRM]: $WHT";
2162 $new_show = <STDIN
>;
2163 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2164 $auto_expunge = 'true';
2166 $auto_expunge = 'false';
2168 return $auto_expunge;
2171 # Default sub of inbox
2173 print "Some IMAP servers (Cyrus) have all folders as subfolders of INBOX.\n";
2174 print "This can cause some confusion in folder creation for users when\n";
2175 print "they try to create folders and don't put it as a subfolder of INBOX\n";
2176 print "and get permission errors. This option asks if you want folders\n";
2177 print "to be subfolders of INBOX by default.\n";
2180 if ( lc($default_sub_of_inbox) eq 'true' ) {
2181 $default_value = "y";
2183 $default_value = "n";
2185 print "Default sub of INBOX (y/n) [$WHT$default_value$NRM]: $WHT";
2186 $new_show = <STDIN
>;
2187 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2188 $default_sub_of_inbox = 'true';
2190 $default_sub_of_inbox = 'false';
2192 return $default_sub_of_inbox;
2195 # Show contain subfolder option
2197 print "Some IMAP servers (UW) make it so that there are two types of\n";
2198 print "folders. Those that contain messages, and those that contain\n";
2199 print "subfolders. If this is the case for your server, set this to\n";
2200 print "true, and it will ask the user whether the folder they are\n";
2201 print "creating contains subfolders or messages.\n";
2204 if ( lc($show_contain_subfolders_option) eq 'true' ) {
2205 $default_value = "y";
2207 $default_value = "n";
2209 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
2210 $new_show = <STDIN
>;
2211 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2212 $show_contain_subfolders_option = 'true';
2214 $show_contain_subfolders_option = 'false';
2216 return $show_contain_subfolders_option;
2219 # Default Unseen Notify
2221 print "This option specifies where the users will receive notification\n";
2222 print "about unseen messages by default. This is of course an option that\n";
2223 print "can be changed on a user level.\n";
2224 print " 1 = No notification\n";
2225 print " 2 = Only on the INBOX\n";
2226 print " 3 = On all folders\n";
2229 print "Which one should be default (1,2,3)? [$WHT$default_unseen_notify$NRM]: $WHT";
2230 $new_show = <STDIN
>;
2231 if ( $new_show =~ /^[123]\n/i ) {
2232 $default_unseen_notify = $new_show;
2234 $default_unseen_notify =~ s/[\r\n]//g;
2235 return $default_unseen_notify;
2238 # Default Unseen Type
2240 print "Here you can define the default way that unseen messages will be displayed\n";
2241 print "to the user in the folder listing on the left side.\n";
2242 print " 1 = Only unseen messages (4)\n";
2243 print " 2 = Unseen and Total messages (4/27)\n";
2246 print "Which one should be default (1,2)? [$WHT$default_unseen_type$NRM]: $WHT";
2247 $new_show = <STDIN
>;
2248 if ( $new_show =~ /^[12]\n/i ) {
2249 $default_unseen_type = $new_show;
2251 $default_unseen_type =~ s/[\r\n]//g;
2252 return $default_unseen_type;
2255 # Auto create special folders
2257 print "Would you like the Sent, Trash, and Drafts folders to be created\n";
2258 print "automatically print for you when a user logs in? If the user\n";
2259 print "accidentally deletes their special folders, this option will\n";
2260 print "automatically create it again for them.\n";
2263 if ( lc($auto_create_special) eq 'true' ) {
2264 $default_value = "y";
2266 $default_value = "n";
2268 print "Auto create special folders? (y/n) [$WHT$default_value$NRM]: $WHT";
2269 $new_show = <STDIN
>;
2270 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2271 $auto_create_special = 'true';
2273 $auto_create_special = 'false';
2275 return $auto_create_special;
2278 # Automatically delete folders
2280 if ( $imap_server_type eq "uw" ) {
2281 print "UW IMAP servers will not allow folders containing mail to also contain folders.\n";
2282 print "Deleting folders will bypass the trash folder and be immediately deleted\n\n";
2283 print "If this is not the correct value for your server,\n";
2284 print "please use option D on the Main Menu to configure your server correctly.\n\n";
2285 print "Press enter to continue...\n";
2286 $new_delete = <STDIN
>;
2287 $delete_folder = 'true';
2289 if ( $imap_server_type eq "courier" ) {
2290 print "Courier (or Courier-IMAP) IMAP servers may not support ";
2291 print "subfolders of Trash. \n";
2292 print "Specifically, if Courier is set to always move messages to Trash, \n";
2293 print "Trash will be treated by Courier as a special folder that does not \n";
2294 print "allow subfolders. \n\n";
2295 print "Please verify your Courier configuration, and test folder deletion \n";
2296 print "when changing this setting.\n\n";
2299 print "Are subfolders of the Trash supported by your IMAP server?\n";
2300 print "If so, should deleted folders be sent to Trash?\n";
2301 print "If not, say no (deleted folders should not be sent to Trash)\n\n";
2302 # reversal of logic.
2303 # question was: Should folders be automatically deleted instead of sent to trash..
2304 # we've changed the question to make it more clear,
2305 # and are here handling that to avoid changing the answers..
2306 if ( lc($delete_folder) eq 'true' ) {
2307 $default_value = "n";
2309 $default_value = "y";
2311 print "Send deleted folders to Trash? (y/n) [$WHT$default_value$NRM]: $WHT";
2312 $new_delete = <STDIN
>;
2313 if ( ( $new_delete =~ /^y\n/i ) || ( ( $new_delete =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2314 $delete_folder = 'false';
2316 $delete_folder = 'true';
2319 return $delete_folder;
2324 print "Some IMAP servers allow subfolders to exist even if the parent\n";
2325 print "folders do not. This fixes some problems with the folder list\n";
2326 print "when this is the case, causing the /NoSelect folders to be displayed\n";
2329 if ( lc($noselect_fix_enable) eq 'true' ) {
2330 $default_value = "y";
2332 $default_value = "n";
2334 print "enable noselect fix? (y/n) [$WHT$noselect_fix_enable$NRM]: $WHT";
2335 $noselect_fix_enable = <STDIN
>;
2336 if ( ( $noselect_fix_enable =~ /^y\n/i ) || ( ( $noselect_fix_enable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2337 $noselect_fix_enable = 'true';
2339 $noselect_fix_enable = 'false';
2341 return $noselect_fix_enable;
2343 ############# GENERAL OPTIONS #####################
2347 print "Specify the location for your data directory.\n";
2348 print "You need to create this directory yourself.\n";
2349 print "The path name can be absolute or relative (to the config directory).\n";
2350 print "Here are two examples:\n";
2351 print " Absolute: /var/local/squirrelmail/data/\n";
2352 print " Relative: ../data/\n";
2353 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2354 print "will be converted to their absolute path equivalents in config.php.\n\n";
2355 print "Note: There are potential security risks with having a writeable directory\n";
2356 print "under the web server's root directory (ex: /home/httpd/html).\n";
2357 print "For this reason, it is recommended to put the data directory\n";
2358 print "in an alternate location of your choice. \n";
2361 print "[$WHT$data_dir$NRM]: $WHT";
2362 $new_data_dir = <STDIN
>;
2363 if ( $new_data_dir eq "\n" ) {
2364 $new_data_dir = $data_dir;
2366 $new_data_dir =~ s/[\r\n]//g;
2368 if ( $new_data_dir =~ /^\s*$/ ) {
2371 $new_data_dir =~ s/\/*$//g
;
2372 $new_data_dir =~ s/$/\//g
;
2374 return $new_data_dir;
2377 # Attachment directory
2379 print "Path to directory used for storing attachments while a mail is\n";
2380 print "being composed. The path name can be absolute or relative (to the\n";
2381 print "config directory). Here are two examples:\n";
2382 print " Absolute: /var/local/squirrelmail/attach/\n";
2383 print " Relative: ../attach/\n";
2384 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2385 print "will be converted to their absolute path equivalents in config.php.\n\n";
2386 print "Note: There are a few security considerations regarding this\n";
2387 print "directory:\n";
2388 print " 1. It should have the permission 733 (rwx-wx-wx) to make it\n";
2389 print " impossible for a random person with access to the webserver\n";
2390 print " to list files in this directory. Confidential data might\n";
2391 print " be laying around in there.\n";
2392 print " Depending on your user:group assignments, 730 (rwx-wx---)\n";
2393 print " may be possible, and more secure (e.g. root:apache)\n";
2394 print " 2. Since the webserver is not able to list the files in the\n";
2395 print " content is also impossible for the webserver to delete files\n";
2396 print " lying around there for too long.\n";
2397 print " 3. It should probably be another directory than the data\n";
2398 print " directory specified in option 3.\n";
2401 print "[$WHT$attachment_dir$NRM]: $WHT";
2402 $new_attachment_dir = <STDIN
>;
2403 if ( $new_attachment_dir eq "\n" ) {
2404 $new_attachment_dir = $attachment_dir;
2406 $new_attachment_dir =~ s/[\r\n]//g;
2408 if ( $new_attachment_dir =~ /^\s*$/ ) {
2409 $new_attachment_dir = "";
2411 $new_attachment_dir =~ s/\/*$//g
;
2412 $new_attachment_dir =~ s/$/\//g
;
2414 return $new_attachment_dir;
2418 print "The directory hash level setting allows you to configure the level\n";
2419 print "of hashing that SquirrelMail employs in your data and attachment\n";
2420 print "directories. This value must be an integer ranging from 0 to 4.\n";
2421 print "When this value is set to 0, SquirrelMail will simply store all\n";
2422 print "files as normal in the data and attachment directories. However,\n";
2423 print "when set to a value from 1 to 4, a simple hashing scheme will be\n";
2424 print "used to organize the files in this directory. In short, the crc32\n";
2425 print "value for a username will be computed. Then, up to the first 4\n";
2426 print "digits of the hash, as set by this configuration value, will be\n";
2427 print "used to directory hash the files for that user in the data and\n";
2428 print "attachment directory. This allows for better performance on\n";
2429 print "servers with larger numbers of users.\n";
2432 print "[$WHT$dir_hash_level$NRM]: $WHT";
2433 $new_dir_hash_level = <STDIN
>;
2434 if ( $new_dir_hash_level eq "\n" ) {
2435 $new_dir_hash_level = $dir_hash_level;
2437 $new_dir_hash_level =~ s/[\r\n]//g;
2439 if ( ( int($new_dir_hash_level) < 0 )
2440 || ( int($new_dir_hash_level) > 4 )
2441 || !( int($new_dir_hash_level) eq $new_dir_hash_level ) ) {
2442 print "Invalid Directory Hash Level.\n";
2443 print "Value must be an integer ranging from 0 to 4\n";
2444 print "Hit enter to continue.\n";
2445 $enter_key = <STDIN
>;
2447 $new_dir_hash_level = $dir_hash_level;
2450 return $new_dir_hash_level;
2454 print "This is the default size (in pixels) of the left folder list.\n";
2455 print "Default is 200, but you can set it to whatever you wish. This\n";
2456 print "is a user preference, so this will only show up as their default.\n";
2458 print "[$WHT$default_left_size$NRM]: $WHT";
2459 $new_default_left_size = <STDIN
>;
2460 if ( $new_default_left_size eq "\n" ) {
2461 $new_default_left_size = $default_left_size;
2463 $new_default_left_size =~ s/[\r\n]//g;
2465 return $new_default_left_size;
2469 print "Some IMAP servers only have lowercase letters in the usernames\n";
2470 print "but they still allow people with uppercase to log in. This\n";
2471 print "causes a problem with the user's preference files. This option\n";
2472 print "transparently changes all usernames to lowercase.";
2475 if ( lc($force_username_lowercase) eq 'true' ) {
2476 $default_value = "y";
2478 $default_value = "n";
2480 print "Convert usernames to lowercase (y/n) [$WHT$default_value$NRM]: $WHT";
2481 $new_show = <STDIN
>;
2482 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2492 if ( lc($default_use_priority) eq 'true' ) {
2493 $default_value = "y";
2495 $default_value = "n";
2498 print "Allow users to specify priority of outgoing mail (y/n) [$WHT$default_value$NRM]: $WHT";
2499 $new_show = <STDIN
>;
2500 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2510 if ( lc($hide_sm_attributions) eq 'true' ) {
2511 $default_value = "y";
2513 $default_value = "n";
2516 print "Hide SM attributions (y/n) [$WHT$default_value$NRM]: $WHT";
2517 $new_show = <STDIN
>;
2518 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2528 if ( lc($default_use_mdn) eq 'true' ) {
2529 $default_value = "y";
2531 $default_value = "n";
2534 print "Enable support for read/delivery receipt support (y/n) [$WHT$default_value$NRM]: $WHT";
2535 $new_show = <STDIN
>;
2536 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2544 print " In loosely managed environments, you may want to allow users
2545 to edit their full name and email address. In strictly managed
2546 environments, you may want to force users to use the name
2547 and email address assigned to them.
2549 'y' - allow a user to edit their full name and email address,
2550 'n' - users must use the assigned values.
2554 if ( lc($edit_identity) eq 'true' ) {
2555 $default_value = "y";
2557 $default_value = "n";
2559 print "Allow editing of user's identity? (y/n) [$WHT$default_value$NRM]: $WHT";
2560 $new_edit = <STDIN
>;
2561 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2562 $edit_identity = 'true';
2563 $edit_name = 'true';
2564 $hide_auth_header = command311b
();
2566 $edit_identity = 'false';
2567 $edit_name = command311
();
2568 $hide_auth_header = command311b
();
2570 return $edit_identity;
2575 print "\n Given that users are not allowed to modify their
2576 email address, can they edit their full name?
2580 if ( lc($edit_name) eq 'true' ) {
2581 $default_value = "y";
2583 $default_value = "n";
2585 print "Allow the user to edit their full name? (y/n) [$WHT$default_value$NRM]: $WHT";
2586 $new_edit = <STDIN
>;
2587 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2588 $edit_name = 'true';
2590 $edit_name = 'false';
2597 print "\n SquirrelMail adds username information to every outgoing email in
2598 order to prevent possible sender forging by users that are allowed
2599 to change their email and/or full name.
2601 You can remove user information from this header (y) if you think
2602 that it violates privacy or security.
2604 Note: If users are allowed to change their email addresses, this
2605 setting will make it difficult to determine who sent what where.
2606 Use at your own risk.
2608 Note: If you have defined a header encryption key in your SMTP or
2609 Sendmail settings (see the \"Server Settings\" option page), this
2610 setting is ignored because all user information in outgoing messages
2615 if ( lc($hide_auth_header) eq "true" ) {
2616 $default_value = "y";
2618 $default_value = "n";
2620 print "Remove username from email headers? (y/n) [$WHT$default_value$NRM]: $WHT";
2621 $new_header = <STDIN
>;
2622 if ( ( $new_header =~ /^y\n/i ) || ( ( $new_header =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2623 $hide_auth_header = "true";
2625 $hide_auth_header = "false";
2627 return $hide_auth_header;
2631 print "This option allows you to disable server side thread sorting if your server \n";
2632 print "declares THREAD support, but you don't want to provide threading options \n";
2633 print "to end users or THREAD extension is broken or extension does not work with \n";
2634 print "options used by SquirrelMail. Option is not used, if THREAD extension is \n";
2635 print "not declared in IMAP CAPABILITY.\n";
2638 if ( lc($disable_thread_sort) eq 'true' ) {
2639 $default_value = "y";
2641 $default_value = "n";
2643 print "Disable server side thread sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2644 $disable_thread_sort = <STDIN
>;
2645 if ( ( $disable_thread_sort =~ /^y\n/i ) || ( ( $disable_thread_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2646 $disable_thread_sort = 'true';
2648 $disable_thread_sort = 'false';
2650 return $disable_thread_sort;
2654 print "This option allows you to disable server side sorting if your server declares \n";
2655 print "SORT support, but SORT extension is broken or does not work with options \n";
2656 print "used by SquirrelMail. Option is not used, if SORT extension is not declared \n";
2657 print "in IMAP CAPABILITY.\n";
2659 print "It is strongly recommended to keep server side sorting enabled, if your ";
2660 print "IMAP server supports it.";
2663 if ( lc($disable_server_sort) eq 'true' ) {
2664 $default_value = "y";
2666 $default_value = "n";
2668 print "Disable server-side sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2669 $disable_server_sort = <STDIN
>;
2670 if ( ( $disable_server_sort =~ /^y\n/i ) || ( ( $disable_server_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2671 $disable_server_sort = 'true';
2673 $disable_server_sort = 'false';
2675 return $disable_server_sort;
2679 print "This option allows you to choose if SM uses charset search\n";
2680 print "Your IMAP server must support the SEARCH CHARSET command for this to work\n";
2683 if ( lc($allow_charset_search) eq 'true' ) {
2684 $default_value = "y";
2686 $default_value = "n";
2688 print "Allow charset searching? (y/n) [$WHT$default_value$NRM]: $WHT";
2689 $allow_charset_search = <STDIN
>;
2690 if ( ( $allow_charset_search =~ /^y\n/i ) || ( ( $allow_charset_search =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2691 $allow_charset_search = 'true';
2693 $allow_charset_search = 'false';
2695 return $allow_charset_search;
2698 # command315 (UID support) obsoleted.
2700 # advanced search option
2702 print "This option allows you to control the use of advanced search form.\n";
2703 print " 0 = enable basic search only\n";
2704 print " 1 = enable advanced search only\n";
2705 print " 2 = enable both\n";
2708 print "Allowed search (0,1,2)? [$WHT$allow_advanced_search$NRM]: $WHT";
2709 $new_allow_advanced_search = <STDIN
>;
2710 if ( $new_allow_advanced_search =~ /^[012]\n/i ) {
2711 $allow_advanced_search = $new_allow_advanced_search;
2713 $allow_advanced_search =~ s/[\r\n]//g;
2714 return $allow_advanced_search;
2719 print "This option allows you to change the name of the PHP session used\n";
2720 print "by SquirrelMail. Unless you know what you are doing, you probably\n";
2721 print "don't need or want to change this from the default of SQMSESSID.\n";
2722 print "[$WHT$session_name$NRM]: $WHT";
2723 $new_session_name = <STDIN
>;
2724 chomp($new_session_name);
2725 if ( $new_session_name eq "" ) {
2726 $new_session_name = $session_name;
2728 return $new_session_name;
2731 # time zone config (since 1.5.1)
2733 print "This option allows you to control the use of time zones.\n";
2734 print " 0 = (default) standard, GNU C time zone names\n";
2735 print " 1 = strict, generic time zone codes with offsets\n";
2736 print " 2 = custom, GNU C time zones loaded from config/timezones.php\n";
2737 print " 3 = custom strict, generic time zone codes with offsets loaded \n";
2738 print " from config/timezones.php\n";
2739 print "See SquirrelMail documentation about format of config/timezones.php file.\n";
2742 print "Desired time zone configuration (0,1,2,3)? [$WHT$time_zone_type$NRM]: $WHT";
2743 $new_time_zone_type = <STDIN
>;
2744 if ( $new_time_zone_type =~ /^[0123]\n/i ) {
2745 $time_zone_type = $new_time_zone_type;
2747 print "\nInvalid configuration value.\n";
2748 print "\nPress enter to continue...";
2751 $time_zone_type =~ s/[\r\n]//g;
2752 return $time_zone_type;
2755 # set the location base for redirects (since 1.5.2)
2756 sub command_config_location_base
{
2757 print "Here you can set the base part of the SquirrelMail URL.\n";
2758 print "It is normally autodetected but if that fails, use this\n";
2759 print "option to override.\n";
2760 print "It should contain only the protocol and hostname/port parts\n";
2761 print "of the URL; the full path will be appended automatically.\n\n";
2762 print "Examples:\nhttp://webmail.example.org\nhttp://webmail.example.com:8080\nhttps://webmail.example.com:6691\n\n";
2763 print "Do not add any path elements.\n";
2765 print "URL base? [" .$WHT."autodetect$NRM]: $WHT";
2766 $new_config_location_base = <STDIN
>;
2767 chomp($new_config_location_base);
2768 $config_location_base = $new_config_location_base;
2770 return $config_location_base;
2773 # only_secure_cookies (since 1.5.2)
2775 print "This option allows you to specify that if a user session is initiated\n";
2776 print "under a secure (HTTPS, SSL-encrypted) connection, the cookies given to\n";
2777 print "the browser will ONLY be transmitted via a secure connection henceforth.\n\n";
2778 print "Generally this is a Good Thing, and should NOT be disabled. However,\n";
2779 print "if you intend to use the Secure Login or Show SSL Link plugins to\n";
2780 print "encrypt the user login, but not the rest of the SquirrelMail session,\n";
2781 print "this can be turned off. Think twice before doing so.\n";
2784 if ( lc($only_secure_cookies) eq 'true' ) {
2785 $default_value = "y";
2787 $default_value = "n";
2789 print "Transmit cookies only on secure connection when available? (y/n) [$WHT$default_value$NRM]: $WHT";
2790 $only_secure_cookies = <STDIN
>;
2791 if ( ( $only_secure_cookies =~ /^y\n/i ) || ( ( $only_secure_cookies =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2792 $only_secure_cookies = 'true';
2794 $only_secure_cookies = 'false';
2796 return $only_secure_cookies;
2800 # disable_security_tokens (since 1.5.2)
2802 print "This option allows you to turn off the security checks in the forms\n";
2803 print "that SquirrelMail generates. It is NOT RECOMMENDED that you disable\n";
2804 print "this feature - otherwise, your users may be exposed to phishing and\n";
2805 print "other attacks.\n";
2806 print "Unless you know what you are doing, you should leave this set to \"NO\".\n";
2809 if ( lc($disable_security_tokens) eq 'true' ) {
2810 $default_value = "y";
2812 $default_value = "n";
2814 print "Disable secure forms? (y/n) [$WHT$default_value$NRM]: $WHT";
2815 $disable_security_tokens = <STDIN
>;
2816 if ( ( $disable_security_tokens =~ /^y\n/i ) || ( ( $disable_security_tokens =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2817 $disable_security_tokens = 'true';
2819 $disable_security_tokens = 'false';
2821 return $disable_security_tokens;
2826 # check_referrer (since 1.5.2)
2828 print "This option allows you to enable referal checks for all page requests\n";
2829 print "made to SquirrelMail. This can help ensure that page requests came\n";
2830 print "from the same server and not from an attacker's site (usually the\n";
2831 print "result of a XSS or phishing attack). To enable referal checking,\n";
2832 print "this setting can be set to the domain where your SquirrelMail is\n";
2833 print "being hosted (usually the same as the Domain setting under Server\n";
2834 print "Settings). For example, it could be \"example.com\", or if you\n";
2835 print "use a plugin (such as Login Manager) to host SquirrelMail on more\n";
2836 print "than one domain, you can set this to \"###DOMAIN###\" to tell it\n";
2837 print "to use the current domain.\n";
2839 print "However, in some cases (where proxy servers are in use, etc.), the\n";
2840 print "domain might be different.\n";
2842 print "NOTE that referal checks are not foolproof - they can be spoofed by\n";
2843 print "browsers, and some browsers intentionally don't send referal\n";
2844 print "information (in which case, the check is silently bypassed)\n";
2847 print "Referal requirement? [$WHT$check_referrer$NRM]: $WHT";
2848 $new_check_referrer = <STDIN
>;
2849 chomp($new_check_referrer);
2850 $check_referrer = $new_check_referrer;
2852 return $check_referrer;
2857 # use_transparent_security_image (since 1.5.2)
2859 print "When HTML messages are being displayed, SquirrelMail's default behavior\n";
2860 print "is to remove all remote images and replace them with a local one.\n";
2862 print "This option allows you to specify whether the local image should contain\n";
2863 print "text that indicates to the user that \"this image has been removed for\n";
2864 print "security reasons\" (translated into most languages), or if it should be\n";
2865 print "transparent.\n";
2868 if ( lc($use_transparent_security_image) eq 'true' ) {
2869 $default_value = "y";
2871 $default_value = "n";
2873 print "Use transparent security image? (y/n) [$WHT$default_value$NRM]: $WHT";
2874 $use_transparent_security_image = <STDIN
>;
2875 if ( ( $use_transparent_security_image =~ /^y\n/i ) || ( ( $use_transparent_security_image =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2876 $use_transparent_security_image = 'true';
2878 $use_transparent_security_image = 'false';
2880 return $use_transparent_security_image;
2885 # display_imap_login_error (since 1.5.2)
2887 print "Some IMAP servers return detailed information about why a login is\n";
2888 print "being refused (the username or password could be invalid or there\n";
2889 print "might be an administrative lock on the account).\n";
2891 print "Enabling this option will cause SquirrelMail to display login failure\n";
2892 print "messages directly from the IMAP server. When it is disabled, login\n";
2893 print "failures are always reported to the user with the traditional \"Unknown\n";
2894 print "user or password incorrect.\"\n";
2897 if ( lc($display_imap_login_error) eq 'true' ) {
2898 $default_value = "y";
2900 $default_value = "n";
2902 print "Display login error messages directly from the IMAP server? (y/n) [$WHT$default_value$NRM]: $WHT";
2903 $display_imap_login_error = <STDIN
>;
2904 if ( ( $display_imap_login_error =~ /^y\n/i ) || ( ( $display_imap_login_error =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2905 $display_imap_login_error = 'true';
2907 $display_imap_login_error = 'false';
2909 return $display_imap_login_error;
2914 sub command_userThemes
{
2915 print "\nDefine the user themes that you wish to use. If you have added\n";
2916 print "a theme of your own, just follow the instructions (?) about\n";
2917 print "how to add them. You can also change the default theme.\n\n";
2919 print "Available user themes:\n";
2921 while ( $count <= $#user_theme_name ) {
2922 if ( $count == $user_theme_default ) {
2927 if ( $count < 10 ) {
2930 $name = $user_theme_name[$count];
2931 $num_spaces = 35 - length($name);
2932 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2933 $name = $name . " ";
2936 print " $count. $name";
2937 print "($user_theme_path[$count])\n";
2943 print ".------------------------------------.\n";
2944 print "| t (detect user themes) |\n";
2945 print "| + (add user theme) |\n";
2946 print "| - N (remove user theme) |\n";
2947 print "| m N (mark default user theme) |\n";
2948 print "| l (list user themes) |\n";
2949 print "| d (done) |\n";
2950 print "`------------------------------------'\n";
2952 print "\n[user_themes] command (?=help) > ";
2954 $input =~ s/[\r\n]//g;
2955 while ( $input ne "d" ) {
2956 if ( $input =~ /^\s*l\s*/i ) {
2958 while ( $count <= $#user_theme_name ) {
2959 if ( $count == $user_theme_default ) {
2964 if ( $count < 10 ) {
2967 $name = $user_theme_name[$count];
2968 $num_spaces = 35 - length($name);
2969 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2970 $name = $name . " ";
2973 print " $count. $name";
2974 print "($user_theme_path[$count])\n";
2978 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2979 $old_def = $user_theme_default;
2980 $user_theme_default = $input;
2981 $user_theme_default =~ s/^\s*m\s*//;
2982 if ( ( $user_theme_default > $#user_theme_name ) || ( $user_theme_default < 0 ) ) {
2983 print "Cannot set default theme to $user_theme_default. That theme does not exist.\n";
2984 $user_theme_default = $old_def;
2986 } elsif ( $input =~ /^\s*\+/ ) {
2987 print "What is the name of this theme? ";
2989 $name =~ s/[\r\n]//g;
2990 $user_theme_name[ $#user_theme_name + 1 ] = $name;
2991 print "Be sure to put ../css/ before the filename.\n";
2992 print "What file is this stored in (ex: ../css/my_theme/): ";
2994 $name =~ s/[\r\n]//g;
2995 $user_theme_path[ $#user_theme_path + 1 ] = $name;
2996 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2997 if ( $input =~ /[0-9]+\s*$/ ) {
2999 $rem_num =~ s/^\s*-\s*//g;
3000 $rem_num =~ s/\s*$//;
3002 $rem_num = $#user_theme_name;
3004 if ( $rem_num == $user_theme_default ) {
3005 print "You cannot remove the default theme!\n";
3008 @new_theme_name = ();
3009 @new_theme_path = ();
3010 while ( $count <= $#user_theme_name ) {
3011 if ( $count != $rem_num ) {
3012 @new_theme_name = ( @new_theme_name, $user_theme_name[$count] );
3013 @new_theme_path = ( @new_theme_path, $user_theme_path[$count] );
3017 @user_theme_name = @new_theme_name;
3018 @user_theme_path = @new_theme_path;
3019 if ( $user_theme_default > $rem_num ) {
3020 $user_theme_default--;
3023 } elsif ( $input =~ /^\s*t\s*/i ) {
3024 print "\nStarting detection...\n\n";
3026 opendir( DIR
, "../css" );
3027 @files = sort(readdir(DIR
));
3029 while ( $cnt <= $#files ) {
3030 $filename = "../css/" . $files[$cnt] .'/';
3031 if ( $files[$cnt] !~ /^\./ && $filename ne "../css/rtl.css" && -e
$filename . "default.css" ) {
3033 for ( $x = 0 ; $x <= $#user_theme_path ; $x++ ) {
3034 if ( $user_theme_path[$x] eq $filename ) {
3038 if ( $found != 1 ) {
3039 print "** Found user theme: $filename\n";
3040 $def = $files[$cnt];
3043 #$def =~ s/(^\w+)/ucfirst $1/eg;
3044 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3045 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3046 print " What is its name? [$def]: ";
3048 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3049 if ( $nm eq '' ) { $nm = $def; }
3050 $user_theme_name[ $#user_theme_name + 1 ] = $nm;
3051 $user_theme_path[ $#user_theme_path + 1 ] = $filename;
3057 for ( $cnt = 0 ; $cnt <= $#user_theme_path ; $cnt++ ) {
3058 $filename = $user_theme_path[$cnt];
3059 if ( $filename != 'none' && !( -e
$filename ."/default.css" ) ) {
3060 print " Removing $filename (file not found)\n";
3062 @new_user_theme_name = ();
3063 @new_user_theme_path = ();
3064 for ( $x = 0 ; $x < $#user_theme_path ; $x++ ) {
3065 if ( $user_theme_path[$x] eq $filename ) {
3068 if ( $offset == 1 ) {
3069 $new_user_theme_name[$x] = $user_theme_name[ $x + 1 ];
3070 $new_user_theme_path[$x] = $user_theme_path[ $x + 1 ];
3072 $new_user_theme_name[$x] = $user_theme_name[$x];
3073 $new_user_theme_path[$x] = $user_theme_path[$x];
3076 @user_theme_name = @new_user_theme_name;
3077 @user_theme_path = @new_user_theme_path;
3080 print "\nDetection complete!\n\n";
3083 } elsif ( $input =~ /^\s*\?\s*/ ) {
3084 print ".------------------------------------.\n";
3085 print "| t (detect user themes) |\n";
3086 print "| + (add user theme) |\n";
3087 print "| - N (remove user theme) |\n";
3088 print "| m N (mark default user theme) |\n";
3089 print "| l (list user themes) |\n";
3090 print "| d (done) |\n";
3091 print "`------------------------------------'\n";
3093 print "[user_themes] command (?=help) > ";
3095 $input =~ s/[\r\n]//g;
3099 sub command_iconSets
{
3100 print "\nDefine the icon themes that you wish to use. If you have added\n";
3101 print "a theme of your own, just follow the instructions (?) about\n";
3102 print "how to add them. You can also change the default and fallback\n";
3103 print "themes. The default theme will be used when no icon theme is\n";
3104 print "set by the user. The fallback theme will be used if an icon\n";
3105 print "cannot be found in the currently selected icon theme.\n\n";
3107 print "Available icon themes:\n\n";
3110 while ( $count <= $#icon_theme_name ) {
3111 if ( $count == $icon_theme_def ) {
3116 if ( $count eq $icon_theme_fallback ) {
3121 if ( $count < 10 ) {
3124 $name = $icon_theme_name[$count];
3125 $num_spaces = 35 - length($name);
3126 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3127 $name = $name . " ";
3130 print " $count. $name";
3131 print "($icon_theme_path[$count])\n";
3136 print "\n d = Default icon theme\n";
3137 print " f = Fallback icon theme\n";
3139 print ".------------------------------------.\n";
3140 print "| t (detect icon themes) |\n";
3141 print "| + (add icon theme) |\n";
3142 print "| - N (remove icon theme) |\n";
3143 print "| m N (mark default icon theme) |\n";
3144 print "| f N (set fallback icon set) |\n";
3145 print "| l (list icon themes) |\n";
3146 print "| d (done) |\n";
3147 print "`------------------------------------'\n";
3149 print "\n[icon_themes] command (?=help) > ";
3151 $input =~ s/[\r\n]//g;
3152 while ( $input ne "d" ) {
3153 if ( $input =~ /^\s*l\s*/i ) {
3156 while ( $count <= $#icon_theme_name ) {
3157 if ( $count == $icon_theme_def ) {
3162 if ( $count eq $icon_theme_fallback ) {
3167 $name = $icon_theme_name[$count];
3168 $num_spaces = 35 - length($name);
3169 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3170 $name = $name . " ";
3173 print " $count. $name";
3174 print "($icon_theme_path[$count])\n";
3178 print "\n d = Default icon theme\n";
3179 print " f = Fallback icon theme\n\n";
3180 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
3181 $old_def = $icon_theme_def;
3182 $icon_theme_def = $input;
3183 $icon_theme_def =~ s/^\s*m\s*//;
3184 if ( ( $icon_theme_default > $#icon_theme_name ) || ( $icon_theme_default < 0 ) ) {
3185 print "Cannot set default icon theme to $icon_theme_default. That theme does not exist.\n";
3186 $icon_theme_def = $old_def;
3188 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
3189 $old_fb = $icon_theme_fallback;
3190 $icon_theme_fallback = $input;
3191 $icon_theme_fallback =~ s/^\s*f\s*//;
3192 if ( ( $icon_theme_fallback > $#icon_theme_name ) || ( $icon_theme_fallback < 0 ) ) {
3193 print "Cannot set fallback icon theme to $icon_theme_fallback. That theme does not exist.\n";
3194 $icon_theme_fallback = $old_fb;
3196 } elsif ( $input =~ /^\s*\+/ ) {
3197 print "What is the name of this icon theme? ";
3199 $name =~ s/[\r\n]//g;
3200 $icon_theme_name[ $#icon_theme_name + 1 ] = $name;
3201 print "Be sure to put ../images/themes/ before the filename.\n";
3202 print "What directory is this icon theme stored in (ex: ../images/themes/my_theme/)? ";
3204 $name =~ s/[\r\n]//g;
3205 $icon_theme_path[ $#icon_theme_path + 1 ] = $name;
3206 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3207 if ( $input =~ /[0-9]+\s*$/ ) {
3209 $rem_num =~ s/^\s*-\s*//g;
3210 $rem_num =~ s/\s*$//;
3212 $rem_num = $#icon_theme_name;
3214 if ( $rem_num == $icon_theme_def ) {
3215 print "You cannot remove the default icon theme!\n";
3216 } elsif ( $rem_num == $icon_theme_fallback ) {
3217 print "You cannot remove the fallback icon theme!\n";
3220 @new_theme_name = ();
3221 @new_theme_path = ();
3222 while ( $count <= $#icon_theme_name ) {
3223 if ( $count != $rem_num ) {
3224 @new_theme_name = ( @new_theme_name, $icon_theme_name[$count] );
3225 @new_theme_path = ( @new_theme_path, $icon_theme_path[$count] );
3229 @icon_theme_name = @new_theme_name;
3230 @icon_theme_path = @new_theme_path;
3231 if ( $icon_theme_def > $rem_num ) {
3235 } elsif ( $input =~ /^\s*t\s*/i ) {
3236 print "\nStarting detection...\n\n";
3238 opendir( DIR
, "../images/themes/" );
3239 @files = sort(readdir(DIR
));
3241 while ( $cnt <= $#files ) {
3242 $filename = "../images/themes/" . $files[$cnt] .'/';
3243 if ( -d
"../images/themes/" . $files[$cnt] && $files[$cnt] !~ /^\
./ && $files[$cnt] ne ".svn" ) {
3245 for ( $x = 0 ; $x <= $#icon_theme_path ; $x++ ) {
3246 if ( $icon_theme_path[$x] eq $filename ) {
3250 if ( $found != 1 ) {
3251 print "** Found icon theme: $filename\n";
3252 $def = $files[$cnt];
3255 #$def =~ s/(^\w+)/ucfirst $1/eg;
3256 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3257 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3258 print " What is its name? [$def]: ";
3260 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3261 if ( $nm eq '' ) { $nm = $def; }
3262 $icon_theme_name[ $#icon_theme_name + 1 ] = $nm;
3263 $icon_theme_path[ $#icon_theme_path + 1 ] = $filename;
3269 for ( $cnt = 0 ; $cnt <= $#icon_theme_path ; $cnt++ ) {
3270 $filename = $icon_theme_path[$cnt];
3271 if ( $filename ne "none" && $filename ne "template" && ! -d
$filename ) {
3272 print " Removing $filename (file not found)\n";
3274 @new_icon_theme_name = ();
3275 @new_icon_theme_path = ();
3276 for ( $x = 0 ; $x < $#icon_theme_path ; $x++ ) {
3277 if ( $icon_theme_path[$x] eq $filename ) {
3280 if ( $offset == 1 ) {
3281 $new_icon_theme_name[$x] = $icon_theme_name[ $x + 1 ];
3282 $new_icon_theme_path[$x] = $icon_theme_path[ $x + 1 ];
3284 $new_icon_theme_name[$x] = $icon_theme_name[$x];
3285 $new_icon_theme_path[$x] = $icon_theme_path[$x];
3288 @icon_theme_name = @new_icon_theme_name;
3289 @icon_theme_path = @new_icon_theme_path;
3292 print "\nDetection complete!\n\n";
3295 } elsif ( $input =~ /^\s*\?\s*/ ) {
3296 print ".------------------------------------.\n";
3297 print "| t (detect icon themes) |\n";
3298 print "| + (add icon theme) |\n";
3299 print "| - N (remove icon theme) |\n";
3300 print "| m N (mark default icon theme) |\n";
3301 print "| f N (set fallback icon set) |\n";
3302 print "| l (list icon themes) |\n";
3303 print "| d (done) |\n";
3304 print "`------------------------------------'\n";
3306 print "[icon_themes] command (?=help) > ";
3308 $input =~ s/[\r\n]//g;
3312 sub command_templates
{
3313 print "\nDefine the template sets (skins) that you wish to use. If you have added\n";
3314 print "a template set of your own, just follow the instructions (?) about\n";
3315 print "how to add them. You can also change the default template.\n";
3317 print "\n Available Templates:\n";
3320 while ( $count <= $#templateset_name ) {
3321 if ( $templateset_id[$count] eq $templateset_default ) {
3326 if ( $templateset_id[$count] eq $templateset_fallback ) {
3331 if ( $templateset_id[$count] eq $rpc_templateset ) {
3336 if ( $count < 10 ) {
3339 if ( $count < 100 ) {
3342 $name = $templateset_name[$count];
3344 # present RPC template sets differently
3346 if ( $templateset_id[$count] =~ /_rpc$/ ) {
3347 $name = $name . " (not shown in user interface; used for RPC interface only)";
3350 $num_spaces = 35 - length($name);
3351 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3352 $name = $name . " ";
3354 $name = $name . "($templateset_id[$count])";
3358 print " $count. $name\n";
3362 print "\n d = default template set\n"
3363 . " f = fallback template set\n"
3364 . " r = RPC template set\n\n";
3366 $menu_text = ".-------------------------------------.\n"
3367 . "| t (detect template set) |\n"
3368 . "| + (add template set) |\n"
3369 . "| - N (remove template set) |\n"
3370 . "| m N (mark default template set) |\n"
3371 . "| f N (set fallback template set) |\n"
3372 . "| r N (set RPC template set) |\n"
3373 . "| l (list template sets/skins) |\n"
3375 . "|-------------------------------------|\n"
3376 . "| where N is a template set number |\n"
3377 . "`-------------------------------------'\n";
3380 print "\n[template set] command (?=help) > ";
3383 $input =~ s/[\r\n]//g;
3384 while ( $input ne "d" ) {
3386 # list template sets
3388 if ( $input =~ /^\s*l\s*/i ) {
3390 while ( $count <= $#templateset_name ) {
3391 if ( $templateset_id[$count] eq $templateset_default ) {
3396 if ( $templateset_id[$count] eq $templateset_fallback ) {
3401 if ( $templateset_id[$count] eq $rpc_templateset ) {
3406 if ( $count < 10 ) {
3409 if ( $count < 100 ) {
3412 $name = $templateset_name[$count];
3414 # present RPC template sets differently
3416 if ( $templateset_id[$count] =~ /_rpc$/ ) {
3417 $name = $name . " (not shown in user interface; used for RPC interface only)";
3420 $num_spaces = 35 - length($name);
3421 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3422 $name = $name . " ";
3424 $name = $name . "($templateset_id[$count])";
3428 print " $count. $name\n";
3432 print "\n d = default template set\n"
3433 . " f = fallback template set\n"
3434 . " r = RPC template set\n\n";
3436 # mark default template set
3438 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
3439 $old_def = $templateset_default;
3440 $input =~ s/^\s*m\s*//;
3441 $templateset_default = $templateset_id[$input];
3442 if ( $templateset_default =~ /^\s*$/ ) {
3443 print "Cannot set default template set to $input. That template set does not exist.\n";
3444 $templateset_default = $old_def;
3446 if ( $templateset_default =~ /_rpc$/ ) {
3447 print "Cannot set default template set to $input. That template set is intended for the RPC interface only.\n";
3448 $templateset_default = $old_def;
3451 # set fallback template set
3453 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
3454 $old_def = $templateset_fallback;
3455 $input =~ s/^\s*f\s*//;
3456 $templateset_fallback = $templateset_id[$input];
3457 if ( $templateset_fallback =~ /^\s*$/ ) {
3458 print "Cannot set fallback template set to $input. That template set does not exist.\n";
3459 $templateset_fallback = $old_def;
3461 if ( $templateset_fallback =~ /_rpc$/ ) {
3462 print "Cannot set fallback template set to $input. That template set is intended for the RPC interface only.\n";
3463 $templateset_fallback = $old_def;
3466 # set RPC template set
3468 } elsif ( $input =~ /^\s*r\s*[0-9]+/i ) {
3469 $old_def = $rpc_templateset;
3470 $input =~ s/^\s*r\s*//;
3471 $rpc_templateset = $templateset_id[$input];
3472 if ( $rpc_templateset =~ /^\s*$/ ) {
3473 print "Cannot set RPC template set to $input. That template set does not exist.\n";
3474 $rpc_templateset = $old_def;
3476 if ( $rpc_templateset !~ /_rpc$/ ) {
3477 print "Cannot set fallback template set to $input. That template set is not intended for the RPC interface.\n";
3478 $rpc_templateset = $old_def;
3483 } elsif ( $input =~ /^\s*\+/ ) {
3484 print "\nWhat is the name of this template (as shown to your users): ";
3486 $name =~ s/[\r\n]//g;
3487 $templateset_name[ $#templateset_name + 1 ] = $name;
3488 print "\n\nThe directory name should not contain any path information\n"
3489 . "or slashes, and should be the name of the directory that the\n"
3490 . "template set is found in within the SquirrelMail templates\n"
3492 print "What directory is this stored in (ex: default_advanced): ";
3494 $name =~ s/[\r\n]//g;
3495 $templateset_id[ $#templateset_id + 1 ] = $name;
3497 # detect template sets
3499 } elsif ( $input =~ /^\s*t\s*/i ) {
3500 print "\nStarting detection...\n\n";
3501 opendir( DIR
, "../templates" );
3502 @files = sort(readdir(DIR
));
3504 while ( $cnt <= $#files ) {
3505 if ( -d
"../templates/" . $files[$cnt] && $files[$cnt] !~ /^\./ && $files[$cnt] ne ".svn" ) {
3506 $filename = $files[$cnt];
3508 for ( $x = 0 ; $x <= $#templateset_id ; $x++ ) {
3509 if ( $templateset_id[$x] eq $filename ) {
3515 print "** Found template set: $filename\n";
3516 $def = $files[$cnt];
3518 # no user-friendly names needed for RPC template sets
3520 if ( $def =~ /_rpc$/ ) {
3525 #$def =~ s/(^\w+)/ucfirst $1/eg;
3526 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3527 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3528 print " What is it's name (as shown to your users)? [$def]: ";
3530 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3531 if ( $nm eq '' ) { $nm = $def; }
3533 $templateset_id[ $#templateset_id + 1 ] = $filename;
3534 $templateset_name[ $#templateset_name + 1 ] = $nm;
3540 for ( $cnt= 0 ; $cnt <= $#templateset_id ; ) {
3541 $filename = $templateset_id[$cnt];
3542 if ( !(-d change_to_rel_path
('SM_PATH . \'templates/' . $filename)) ) {
3543 print " Removing \"$filename\" (template set directory not found)\n";
3544 if ( $templateset_default eq $filename ) { $templateset_default = 'default'; }
3545 if ( $templateset_fallback eq $filename ) { $templateset_fallback = 'default'; }
3546 if ( $rpc_templateset eq $filename ) { $rpc_templateset = 'default_rpc'; }
3548 @new_templateset_name = ();
3549 @new_templateset_id = ();
3550 for ( $x = 0 ; $x < $#templateset_id ; $x++ ) {
3551 if ( $templateset_id[$x] eq $filename ) {
3554 if ( $offset == 1 ) {
3555 $new_templateset_name[$x] = $templateset_name[ $x + 1 ];
3556 $new_templateset_id[$x] = $templateset_id[ $x + 1 ];
3558 $new_templateset_name[$x] = $templateset_name[$x];
3559 $new_templateset_id[$x] = $templateset_id[$x];
3562 @templateset_name = @new_templateset_name;
3563 @templateset_id = @new_templateset_id;
3566 print "\nDetection complete!\n\n";
3570 # remove template set
3572 # undocumented functionality of removing last template set isn't that great
3573 #} elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3574 } elsif ( $input =~ /^\s*-\s*[0-9]+/ ) {
3575 if ( $input =~ /[0-9]+\s*$/ ) {
3577 $rem_num =~ s/^\s*-\s*//g;
3578 $rem_num =~ s/\s*$//;
3580 $rem_num = $#templateset_name;
3582 if ( $templateset_id[$rem_num] eq $templateset_default ) {
3583 print "You cannot remove the default template set!\n";
3584 } elsif ( $templateset_id[$rem_num] eq $templateset_fallback ) {
3585 print "You cannot remove the fallback template set!\n";
3586 } elsif ( $templateset_id[$rem_num] eq $rpc_templateset ) {
3587 print "You cannot remove the RPC template set!\n";
3590 @new_templateset_name = ();
3591 @new_templateset_id = ();
3592 while ( $count <= $#templateset_name ) {
3593 if ( $count != $rem_num ) {
3594 @new_templateset_name = ( @new_templateset_name, $templateset_name[$count] );
3595 @new_templateset_id = ( @new_templateset_id, $templateset_id[$count] );
3599 @templateset_name = @new_templateset_name;
3600 @templateset_id = @new_templateset_id;
3605 } elsif ( $input =~ /^\s*\?\s*/ ) {
3608 # command not understood
3611 print "Command not understood\n";
3614 print "[template set] command (?=help) > ";
3616 $input =~ s/[\r\n]//g;
3618 return $templateset_default;
3622 # sets default font size option
3623 sub command_default_fontsize
{
3624 print "Enter default font size [$WHT$$default_fontsize$NRM]: $WHT";
3625 $new_size = <STDIN
>;
3626 if ( $new_size eq "\n" ) {
3629 $new_size =~ s/[\r\n]//g;
3634 # controls available fontsets
3635 sub command_fontsets
{
3637 print "You can control fontsets available to end users here.\n";
3638 # set initial $input value
3640 while ( $input ne "x" ) {
3641 if ( $input =~ /^\s*a\s*/i ) {
3643 print "\nFontset name: ";
3645 if (! $fontsets{trim
($name)}) {
3646 print "Fontset string: ";
3648 $fontsets{trim
($name)} = trim
($value);
3650 print "\nERROR: Such fontset already exists.\n";
3652 } elsif ( $input =~ /^\s*e\s*/i ) {
3653 # edit existing fontset
3654 print "\nFontset name: ";
3656 if (! $fontsets{trim
($name)}) {
3657 print "\nERROR: No such fontset.\n";
3659 print "Fontset string [$fontsets{trim($name)}]: ";
3661 $fontsets{trim
($name)} = trim
($value);
3663 } elsif ( $input =~ /^\s*d\s*/ ) {
3664 # delete existing fontset
3665 print "\nFontset name: ";
3667 if (! $fontsets{trim
($name)}) {
3668 print "\nERROR: No such fontset.\n";
3670 delete $fontsets{trim
($name)};
3672 } elsif ( $input =~ /^\s*l\s*/ ) {
3674 print "\nConfigured fontsets:\n";
3675 while (($fontset_name, $fontset_string) = each(%fontsets)) {
3676 print " $fontset_name = $fontset_string\n";
3678 print "Default fontset: $default_fontset\n";
3679 } elsif ( $input =~ /^\s*m\s*/ ) {
3680 # set default fontset
3681 print "\nSet default fontset [$default_fontset]: ";
3683 if (trim
($name) ne '' and ! $fontsets{trim
($name)}) {
3684 print "\nERROR: No such fontset.\n";
3686 $default_fontset = trim
($name);
3689 # print available commands on any other input
3690 print "\nAvailable commands:\n";
3691 print " a - Adds new fontset.\n";
3692 print " d - Deletes existing fontset.\n";
3693 print " e - Edits existing fontset.\n";
3694 print " h or ? - Shows this help screen.\n";
3695 print " l - Lists available fontsets.\n";
3696 print " m - Sets default fontset.\n";
3697 print " x - Exits fontset editor mode.\n";
3699 print "\nCommand [fontsets] (a,d,e,h,?=help,l,m,x)> ";
3701 $input =~ s/[\r\n]//g;
3706 print "You can now define different LDAP servers.\n";
3707 print "Please ensure proper permissions for config.php when including\n";
3708 print "sensitive passwords.\n\n";
3709 print "[ldap] command (?=help) > ";
3711 $input =~ s/[\r\n]//g;
3712 while ( $input ne "d" ) {
3713 if ( $input =~ /^\s*l\s*/i ) {
3715 while ( $count <= $#ldap_host ) {
3716 print "$count. $ldap_host[$count]\n";
3717 print " base: $ldap_base[$count]\n";
3718 if ( $ldap_charset[$count] ) {
3719 print " charset: $ldap_charset[$count]\n";
3721 if ( $ldap_port[$count] ) {
3722 print " port: $ldap_port[$count]\n";
3724 if ( $ldap_name[$count] ) {
3725 print " name: $ldap_name[$count]\n";
3727 if ( $ldap_maxrows[$count] ) {
3728 print " maxrows: $ldap_maxrows[$count]\n";
3730 if ( $ldap_filter[$count] ) {
3731 print " filter: $ldap_filter[$count]\n";
3733 if ( $ldap_binddn[$count] ) {
3734 print " binddn: $ldap_binddn[$count]\n";
3735 if ( $ldap_bindpw[$count] ) {
3736 print " bindpw: $ldap_bindpw[$count]\n";
3739 if ( $ldap_protocol[$count] ) {
3740 print " protocol: $ldap_protocol[$count]\n";
3742 if ( $ldap_limit_scope[$count] ) {
3743 print " limit_scope: $ldap_limit_scope[$count]\n";
3745 if ( $ldap_listing[$count] ) {
3746 print " listing: $ldap_listing[$count]\n";
3748 if ( $ldap_writeable[$count] ) {
3749 print " writeable: $ldap_writeable[$count]\n";
3751 if ( $ldap_search_tree[$count] ) {
3752 print " search_tree: $ldap_search_tree[$count]\n";
3754 if ( $ldap_starttls[$count] ) {
3755 print " starttls: $ldap_starttls[$count]\n";
3761 } elsif ( $input =~ /^\s*\+/ ) {
3762 $sub = $#ldap_host + 1;
3764 print "First, we need to have the hostname or the IP address where\n";
3765 print "this LDAP server resides. Example: ldap.bigfoot.com\n";
3767 print "You can use any URI compatible with your LDAP library. Please\n";
3768 print "note that StartTLS option is not compatible with ldaps and\n";
3769 print "ldapi URIs.\n";
3772 $name =~ s/[\r\n]//g;
3773 $ldap_host[$sub] = $name;
3777 print "Next, we need the server root (base dn). For this, an empty\n";
3778 print "string is allowed.\n";
3779 print "Example: ou=member_directory,o=netcenter.com\n";
3782 $name =~ s/[\r\n]//g;
3783 $ldap_base[$sub] = $name;
3787 print "This is the TCP/IP port number for the LDAP server. Default\n";
3788 print "port is 389. This is optional. Press ENTER for default.\n";
3791 $name =~ s/[\r\n]//g;
3792 $ldap_port[$sub] = $name;
3796 print "This is the charset for the server. Default is utf-8. This\n";
3797 print "is also optional. Press ENTER for default.\n";
3800 $name =~ s/[\r\n]//g;
3801 $ldap_charset[$sub] = $name;
3805 print "This is the name for the server, used to tag the results of\n";
3806 print "the search. Default it \"LDAP: hostname\". Press ENTER for default\n";
3809 $name =~ s/[\r\n]//g;
3810 $ldap_name[$sub] = $name;
3814 print "You can specify the maximum number of rows in the search result.\n";
3815 print "Default value is equal to 250 rows. Press ENTER for default.\n";
3818 $name =~ s/[\r\n]//g;
3819 $ldap_maxrows[$sub] = $name;
3824 print "If your LDAP server does not like anonymous logins, you can specify bind DN.\n";
3825 print "Default is none, anonymous bind. Press ENTER for default.\n";
3828 $name =~ s/[\r\n]//g;
3829 $ldap_binddn[$sub] = $name;
3833 if ( $ldap_binddn[$sub] ne '' ) {
3835 print "Now, please specify password for that DN.\n";
3838 $name =~ s/[\r\n]//g;
3839 $ldap_bindpw[$sub] = $name;
3844 print "You can specify bind protocol version here.\n";
3845 print "Default protocol version depends on your php ldap settings.\n";
3846 print "Press ENTER for default.\n";
3849 $name =~ s/[\r\n]//g;
3850 $ldap_protocol[$sub] = $name;
3854 print "This configuration section allows to set some rarely used\n";
3855 print "options and options specific to some LDAP implementations.\n";
3857 print "Do you want to set advanced LDAP directory settings? (y/N):";
3858 $ldap_advanced_settings = <STDIN
>;
3859 if ( $ldap_advanced_settings =~ /^y\n/i ) {
3860 $ldap_advanced_settings = 'true';
3862 $ldap_advanced_settings = 'false';
3865 if ($ldap_advanced_settings eq 'true') {
3868 print "You can control LDAP directory listing here. This option can\n";
3869 print "be useful if you run small LDAP server and want to provide listing\n";
3870 print "of all addresses stored in LDAP to users of webmail interface.\n";
3871 print "Number of displayed entries is limited by maxrows setting.\n";
3873 print "Don't enable this option for public LDAP directories.\n";
3875 print "Allow listing of LDAP directory? (y/N):";
3877 if ( $name =~ /^y\n/i ) {
3882 $ldap_listing[$sub] = $name;
3886 print "You can control write access to LDAP address book here. This option can\n";
3887 print "be useful if you run small LDAP server and want to provide writable\n";
3888 print "shared address book stored in LDAP to users of webmail interface.\n";
3890 print "Don't enable this option for public LDAP directories.\n";
3892 print "Allow writing to LDAP directory? (y/N):";
3894 if ( $name =~ /^y\n/i ) {
3899 $ldap_writeable[$sub] = $name;
3903 print "You can specify an additional search filter.\n";
3904 print "This could be something like \"(objectclass=posixAccount)\".\n";
3905 print "No filtering is performed by default. Press ENTER for default.\n";
3908 $name =~ s/[\r|\n]//g;
3909 $ldap_filter[$sub] = $name;
3913 print "You can control search scope here.\n";
3914 print "This option is specific to Microsoft ADS implementation.\n";
3915 print "It requires use of v3 or newer LDAP protocol.\n";
3916 print "Don't enable it, if you use other LDAP server.\n";
3918 print "Limit ldap scope? (y/N):";
3920 if ( $name =~ /^y\n/i ) {
3925 $ldap_limit_scope[$sub] = $name;
3929 print "You can control ldap search type here.\n";
3930 print "Addresses can be searched in entire LDAP subtree (default)\n";
3931 print "or only first level entries are returned.\n";
3933 print "Search entire LDAP subtree? (Y/n):";
3935 if ( $name =~ /^n\n/i ) {
3940 $ldap_search_tree[$sub] = $name;
3944 print "You can control use of StartTLS on LDAP connection here.\n";
3945 print "This option requires use of v3 or newer LDAP protocol and php 4.2+.\n";
3947 print "Use StartTLS? (y/N):";
3949 if ( $name =~ /^y\n/i ) {
3954 $ldap_starttls[$sub] = $name;
3958 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3959 if ( $input =~ /[0-9]+\s*$/ ) {
3961 $rem_num =~ s/^\s*-\s*//g;
3962 $rem_num =~ s/\s*$//;
3964 $rem_num = $#ldap_host;
3967 @new_ldap_host = ();
3968 @new_ldap_base = ();
3969 @new_ldap_port = ();
3970 @new_ldap_name = ();
3971 @new_ldap_charset = ();
3972 @new_ldap_maxrows = ();
3973 @new_ldap_filter = ();
3974 @new_ldap_bindpw = ();
3975 @new_ldap_binddn = ();
3976 @new_ldap_protocol = ();
3977 @new_ldap_limit_scope = ();
3978 @new_ldap_listing = ();
3979 @new_ldap_writeable = ();
3980 @new_ldap_search_tree = ();
3981 @new_ldap_starttls = ();
3983 while ( $count <= $#ldap_host ) {
3984 if ( $count != $rem_num ) {
3985 @new_ldap_host = ( @new_ldap_host, $ldap_host[$count] );
3986 @new_ldap_base = ( @new_ldap_base, $ldap_base[$count] );
3987 @new_ldap_port = ( @new_ldap_port, $ldap_port[$count] );
3988 @new_ldap_name = ( @new_ldap_name, $ldap_name[$count] );
3989 @new_ldap_charset = ( @new_ldap_charset, $ldap_charset[$count] );
3990 @new_ldap_maxrows = ( @new_ldap_maxrows, $ldap_maxrows[$count] );
3991 @new_ldap_filter = ( @new_ldap_filter, $ldap_filter[$count] );
3992 @new_ldap_binddn = ( @new_ldap_binddn, $ldap_binddn[$count] );
3993 @new_ldap_bindpw = ( @new_ldap_bindpw, $ldap_bindpw[$count] );
3994 @new_ldap_protocol = ( @new_ldap_protocol, $ldap_protocol[$count] );
3995 @new_ldap_limit_scope = ( @new_ldap_limit_scope, $ldap_limit_scope[$count] );
3996 @new_ldap_listing = ( @new_ldap_listing, $ldap_listing[$count] );
3997 @new_ldap_writeable = ( @new_ldap_writeable, $ldap_writeable[$count] );
3998 @new_ldap_search_tree = ( @new_ldap_search_tree, $ldap_search_tree[$count] );
3999 @new_ldap_starttls = ( @new_ldap_starttls, $ldap_starttls[$count] );
4003 @ldap_host = @new_ldap_host;
4004 @ldap_base = @new_ldap_base;
4005 @ldap_port = @new_ldap_port;
4006 @ldap_name = @new_ldap_name;
4007 @ldap_charset = @new_ldap_charset;
4008 @ldap_maxrows = @new_ldap_maxrows;
4009 @ldap_filter = @new_ldap_filter;
4010 @ldap_binddn = @new_ldap_binddn;
4011 @ldap_bindpw = @new_ldap_bindpw;
4012 @ldap_protocol = @new_ldap_protocol;
4013 @ldap_limit_scope = @new_ldap_limit_scope;
4014 @ldap_listing = @new_ldap_listing;
4015 @ldap_writeable = @new_ldap_writeable;
4016 @ldap_search_tree = @new_ldap_search_tree;
4017 @ldap_starttls = @new_ldap_starttls;
4019 } elsif ( $input =~ /^\s*\?\s*/ ) {
4020 print ".-------------------------.\n";
4021 print "| + (add host) |\n";
4022 print "| - N (remove host) |\n";
4023 print "| l (list hosts) |\n";
4024 print "| d (done) |\n";
4025 print "`-------------------------'\n";
4027 print "[ldap] command (?=help) > ";
4029 $input =~ s/[\r\n]//g;
4034 print "Some of our developers have come up with very good javascript interface\n";
4035 print "for searching through address books, however, our original goals said\n";
4036 print "that we would be 100% HTML. In order to make it possible to use their\n";
4037 print "interface, and yet stick with our goals, we have also written a plain\n";
4038 print "HTML version of the search. Here, you can choose which version to use.\n";
4040 print "This is just the default value. It is also a user option that each\n";
4041 print "user can configure individually\n";
4044 if ( lc($default_use_javascript_addr_book) eq 'true' ) {
4045 $default_value = "y";
4047 $default_use_javascript_addr_book = 'false';
4048 $default_value = "n";
4050 print "Use javascript version by default (y/n) [$WHT$default_value$NRM]: $WHT";
4051 $new_show = <STDIN
>;
4052 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4053 $default_use_javascript_addr_book = 'true';
4055 $default_use_javascript_addr_book = 'false';
4057 return $default_use_javascript_addr_book;
4060 # global filebased address book
4062 print "If you want to use global file address book, then you\n";
4063 print "must set this option to a valid value. If option does\n";
4064 print "not have path elements, system assumes that file is\n";
4065 print "stored in data directory. If relative path is set, it is\n";
4066 print "relative to main SquirrelMail directory. If value is empty,\n";
4067 print "address book is not enabled.\n";
4070 print "[$WHT$abook_global_file$NRM]: $WHT";
4071 $new_abook_global_file = <STDIN
>;
4072 if ( $new_abook_global_file eq "\n" ) {
4073 $new_abook_global_file = $abook_global_file;
4075 $new_abook_global_file =~ s/[\r\n]//g;
4077 return $new_abook_global_file;
4080 # writing into global filebased abook control
4082 print "This setting controls writing into global file address\n";
4083 print "book options. Address book file must be writeable by\n";
4084 print "webserver's user, if you want to enable this option.\n";
4087 if ( lc($abook_global_file_writeable) eq 'true' ) {
4088 $default_value = "y";
4090 $abook_global_file_writeable = 'false';
4091 $default_value = "n";
4093 print "Allow writing into global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
4094 $new_show = <STDIN
>;
4095 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4096 $abook_global_file_writeable = 'true';
4098 $abook_global_file_writeable = 'false';
4100 return $abook_global_file_writeable;
4103 # listing of global filebased abook control
4105 print "This setting controls listing of global file address\n";
4106 print "book in addresses page.\n";
4109 if ( lc($abook_global_file_listing) eq 'true' ) {
4110 $default_value = "y";
4112 $abook_global_file_listing = 'false';
4113 $default_value = "n";
4115 print "Allow listing of global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
4116 $new_show = <STDIN
>;
4117 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4118 $abook_global_file_listing = 'true';
4120 $abook_global_file_listing = 'false';
4122 return $abook_global_file_listing;
4125 # controls $abook_file_line_length setting
4126 sub command_abook_file_line_length
{
4127 print "This setting controls space allocated to file based address book records.\n";
4128 print "End users will be unable to save address book entry, if total entry size \n";
4129 print "(quoted address book fields + 4 delimiters + linefeed) exceeds allowed \n";
4130 print "address book length size.\n";
4132 print "Same setting is applied to personal and global file based address books.\n";
4134 print "It is strongly recommended to keep default setting value. Change it only\n";
4135 print "if you really want to store address book entries that are bigger than two\n";
4136 print "kilobytes (2048).\n";
4139 print "Enter allowed address book line length [$abook_file_line_length]: ";
4142 # value is not modified, if user hits Enter or enters space
4144 # make sure that input is numeric
4145 if ($tmp =~ /^\d+$/) {
4146 $abook_file_line_length = $tmp;
4148 print "If you want to change this setting, you must enter number.\n";
4149 print "If you want to keep original setting - enter space.\n\n";
4150 print "Press Enter to continue...";
4157 print "If you want to store your users address book details in a database then\n";
4158 print "you need to set this DSN to a valid value. The format for this is:\n";
4159 print "mysql://user:pass\@hostname/dbname\n";
4160 print "Where mysql can be one of the databases PHP supports, the most common\n";
4161 print "of these are mysql, msql and pgsql.\n";
4162 print "Please ensure proper permissions for config.php when including\n";
4163 print "sensitive passwords.\n\n";
4164 print "If the DSN is left empty (hit space and then return) the database\n";
4165 print "related code for address books will not be used.\n";
4168 if ( $addrbook_dsn eq "" ) {
4169 $default_value = "Disabled";
4171 $default_value = $addrbook_dsn;
4173 print "[$WHT$addrbook_dsn$NRM]: $WHT";
4175 if ( $new_dsn eq "\n" ) {
4176 $new_dsn = $addrbook_dsn;
4178 $new_dsn =~ s/[\r\n]//g;
4179 $new_dsn =~ s/^\s+$//g;
4185 print "This is the name of the table you want to store the address book\n";
4186 print "data in, it defaults to 'address'\n";
4188 print "[$WHT$addrbook_table$NRM]: $WHT";
4189 $new_table = <STDIN
>;
4190 if ( $new_table eq "\n" ) {
4191 $new_table = $addrbook_table;
4193 $new_table =~ s/[\r\n]//g;
4199 print "If you want to store your users preferences in a database then\n";
4200 print "you need to set this DSN to a valid value. The format for this is:\n";
4201 print "mysql://user:pass\@hostname/dbname\n";
4202 print "Where mysql can be one of the databases PHP supports, the most common\n";
4203 print "of these are mysql, msql and pgsql.\n";
4204 print "Please ensure proper permissions for config.php when including\n";
4205 print "sensitive passwords.\n\n";
4206 print "If the DSN is left empty (hit space and then return) the database\n";
4207 print "related code for address books will not be used.\n";
4210 if ( $prefs_dsn eq "" ) {
4211 $default_value = "Disabled";
4213 $default_value = $prefs_dsn;
4215 print "[$WHT$prefs_dsn$NRM]: $WHT";
4217 if ( $new_dsn eq "\n" ) {
4218 $new_dsn = $prefs_dsn;
4220 $new_dsn =~ s/[\r\n]//g;
4221 $new_dsn =~ s/^\s+$//g;
4227 print "This is the name of the table you want to store the preferences\n";
4228 print "data in, it defaults to 'userprefs'\n";
4230 print "[$WHT$prefs_table$NRM]: $WHT";
4231 $new_table = <STDIN
>;
4232 if ( $new_table eq "\n" ) {
4233 $new_table = $prefs_table;
4235 $new_table =~ s/[\r\n]//g;
4241 print "This is the name of the field in which you want to store the\n";
4242 print "username of the person the prefs are for. It defaults to 'user'\n";
4244 print "[$WHT$prefs_user_field$NRM]: $WHT";
4245 $new_field = <STDIN
>;
4246 if ( $new_field eq "\n" ) {
4247 $new_field = $prefs_user_field;
4249 $new_field =~ s/[\r\n]//g;
4251 $prefs_user_size = db_pref_size
($prefs_user_size);
4256 print "This is the name of the field in which you want to store the\n";
4257 print "preferences keyword. It defaults to 'prefkey'\n";
4259 print "[$WHT$prefs_key_field$NRM]: $WHT";
4260 $new_field = <STDIN
>;
4261 if ( $new_field eq "\n" ) {
4262 $new_field = $prefs_key_field;
4264 $new_field =~ s/[\r\n]//g;
4266 $prefs_key_size = db_pref_size
($prefs_key_size);
4271 print "This is the name of the field in which you want to store the\n";
4272 print "preferences value. It defaults to 'prefval'\n";
4274 print "[$WHT$prefs_val_field$NRM]: $WHT";
4275 $new_field = <STDIN
>;
4276 if ( $new_field eq "\n" ) {
4277 $new_field = $prefs_val_field;
4279 $new_field =~ s/[\r\n]//g;
4281 $prefs_val_size = db_pref_size
($prefs_val_size);
4285 # routine is used to set database field limits
4286 # it needs one argument
4287 sub db_pref_size
() {
4289 print "\nDatabase fields have size limits.\n";
4291 print "What limit is set for this field? [$WHT$size$NRM]: $WHT";
4292 $new_size = <STDIN
>;
4293 if ( $new_size eq "\n" ) {
4296 $new_size =~ s/[\r\n]//g;
4302 print "If you want to store your global address book in a database then\n";
4303 print "you need to set this DSN to a valid value. The format for this is:\n";
4304 print "mysql://user:pass\@hostname/dbname\n";
4305 print "Where mysql can be one of the databases PHP supports, the most common\n";
4306 print "of these are mysql, msql and pgsql.\n";
4307 print "Please ensure proper permissions for config.php when including\n";
4308 print "sensitive passwords.\n\n";
4309 print "If the DSN is left empty (hit space and then return) the database\n";
4310 print "related code for global SQL address book will not be used.\n";
4313 if ( $addrbook_global_dsn eq "" ) {
4314 $default_value = "Disabled";
4316 $default_value = $addrbook_global_dsn;
4318 print "[$WHT$addrbook_global_dsn$NRM]: $WHT";
4320 if ( $new_dsn eq "\n" ) {
4321 $new_dsn = $addrbook_global_dsn;
4323 $new_dsn =~ s/[\r\n]//g;
4324 $new_dsn =~ s/^\s+$//g;
4330 print "This is the name of the table you want to store the global address book\n";
4331 print "data in. Default table name is 'global_abook'. Address book uses same\n";
4332 print "database format as personal address book.\n";
4334 print "[$WHT$addrbook_global_table$NRM]: $WHT";
4335 $new_table = <STDIN
>;
4336 if ( $new_table eq "\n" ) {
4337 $new_table = $addrbook_global_table;
4339 $new_table =~ s/[\r\n]//g;
4345 print "This option controls users\' ability to add or modify records stored \n";
4346 print "in global address book\n";
4348 if ( lc($addrbook_global_writeable) eq 'true' ) {
4349 $default_value = "y";
4351 $default_value = "n";
4353 print "Allow writing into global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
4354 $addrbook_global_writeable = <STDIN
>;
4355 if ( ( $addrbook_global_writeable =~ /^y\n/i ) || ( ( $addrbook_global_writeable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4356 $addrbook_global_writeable = 'true';
4358 $addrbook_global_writeable = 'false';
4360 return $addrbook_global_writeable;
4364 print "Enable this option if you want to see listing of addresses stored \n";
4365 print "in global address book\n";
4367 if ( lc($addrbook_global_listing) eq 'true' ) {
4368 $default_value = "y";
4370 $default_value = "n";
4372 print "Allow listing of global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
4373 $addrbook_global_listing = <STDIN
>;
4374 if ( ( $addrbook_global_listing =~ /^y\n/i ) || ( ( $addrbook_global_listing =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4375 $addrbook_global_listing = 'true';
4377 $addrbook_global_listing = 'false';
4379 return $addrbook_global_listing;
4385 print "SquirrelMail attempts to set the language in many ways. If it\n";
4386 print "can not figure it out in another way, it will default to this\n";
4387 print "language. Please use the code for the desired language.\n";
4389 print "[$WHT$squirrelmail_default_language$NRM]: $WHT";
4390 $new_squirrelmail_default_language = <STDIN
>;
4391 if ( $new_squirrelmail_default_language eq "\n" ) {
4392 $new_squirrelmail_default_language = $squirrelmail_default_language;
4394 $new_squirrelmail_default_language =~ s/[\r\n]//g;
4395 $new_squirrelmail_default_language =~ s/^\s+$//g;
4397 return $new_squirrelmail_default_language;
4401 print "This option controls what character set is used when sending\n";
4402 print "mail and when sending HTML to the browser. Option works only\n";
4403 print "with US English (en_US) translation. Other translations use\n";
4404 print "charsets that are set in translation settings.\n";
4407 print "[$WHT$default_charset$NRM]: $WHT";
4408 $new_default_charset = <STDIN
>;
4409 if ( $new_default_charset eq "\n" ) {
4410 $new_default_charset = $default_charset;
4412 $new_default_charset =~ s/[\r\n]//g;
4414 return $new_default_charset;
4416 # Alternative language names
4418 print "Enable this option if you want to see localized language names in\n";
4419 print "language selection box. Note, that this option can trigger\n";
4420 print "installation of foreign language support modules in some browsers.\n";
4423 if ( lc($show_alternative_names) eq 'true' ) {
4424 $default_value = "y";
4426 $default_value = "n";
4428 print "Show alternative language names? (y/n) [$WHT$default_value$NRM]: $WHT";
4429 $show_alternative_names = <STDIN
>;
4430 if ( ( $show_alternative_names =~ /^y\n/i ) || ( ( $show_alternative_names =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4431 $show_alternative_names = 'true';
4433 $show_alternative_names = 'false';
4435 return $show_alternative_names;
4438 # Aggressive decoding
4440 print "Enable this option if you want to use CPU and memory intensive decoding\n";
4441 print "functions. This option allows reading multibyte charset, that are used\n";
4442 print "in Eastern Asia. SquirrelMail will try to use recode functions here,\n";
4443 print "even when you have disabled use of recode in Tweaks section.\n";
4446 if ( lc($aggressive_decoding) eq 'true' ) {
4447 $default_value = "y";
4449 $default_value = "n";
4451 print "Enable aggressive decoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4452 $aggressive_decoding = <STDIN
>;
4453 if ( ( $aggressive_decoding =~ /^y\n/i ) || ( ( $aggressive_decoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4454 $aggressive_decoding = 'true';
4456 $aggressive_decoding = 'false';
4458 return $aggressive_decoding;
4463 print "Enable this option if you want to allow lossy charset encoding in message\n";
4464 print "composition pages. This option allows charset conversions when output\n";
4465 print "charset does not support all symbols used in original charset. Symbols\n";
4466 print "unsupported by output charset will be replaced with question marks.\n";
4469 if ( lc($lossy_encoding) eq 'true' ) {
4470 $default_value = "y";
4472 $default_value = "n";
4474 print "Enable lossy encoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4475 $lossy_encoding = <STDIN
>;
4476 if ( ( $lossy_encoding =~ /^y\n/i ) || ( ( $lossy_encoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4477 $lossy_encoding = 'true';
4479 $lossy_encoding = 'false';
4481 return $lossy_encoding;
4484 # display html emails in iframe
4486 print "This option can enable html email rendering inside iframe.\n";
4487 print "Inline frames are used in order to provide sandbox environment";
4488 print "for html code included in html formated emails.";
4489 print "Option is experimental and might have glitches in some parts of code.";
4492 if ( lc($use_iframe) eq 'true' ) {
4493 $default_value = "y";
4495 $default_value = "n";
4497 print "Display html emails in iframe? (y/n) [$WHT$default_value$NRM]: $WHT";
4498 $use_iframe = <STDIN
>;
4499 if ( ( $use_iframe =~ /^y\n/i ) || ( ( $use_iframe =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4500 $use_iframe = 'true';
4502 $use_iframe = 'false';
4508 sub command_ask_user_info
{
4509 print "New users need to supply their real name and email address to\n";
4510 print "send out proper mails. When this option is enabled, a user that\n";
4511 print "logs in for the first time will be redirected to the Personal\n";
4512 print "Options screen and asked to supply their personal data.\n";
4515 if ( lc($ask_user_info) eq 'true' ) {
4516 $default_value = "y";
4518 $default_value = "n";
4520 print "Ask user info? (y/n) [$WHT$default_value$NRM]: $WHT";
4521 $ask_user_info = <STDIN
>;
4522 if ( ( $ask_user_info =~ /^y\n/i ) || ( ( $ask_user_info =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4523 $ask_user_info = 'true';
4525 $ask_user_info = 'false';
4527 return $ask_user_info;
4532 print "Enabling this option will cause icons to be used instead of text\n";
4533 print "markers next to each message in mailbox lists that represent\n";
4534 print "new, read, flagged, and deleted messages, as well as those that\n";
4535 print "have been replied to and forwarded. Icons are also used next to\n";
4536 print "(un)expanded folders in the folder list (Oldway = false). These\n";
4537 print "icons are quite small, but will obviously be more of a resource\n";
4538 print "drain than text markers.\n";
4541 if ( lc($use_icons) eq 'true' ) {
4542 $default_value = "y";
4544 $default_value = "n";
4546 print "Use icons? (y/n) [$WHT$default_value$NRM]: $WHT";
4547 $use_icons = <STDIN
>;
4548 if ( ( $use_icons =~ /^y\n/i ) || ( ( $use_icons =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4549 $use_icons = 'true';
4551 $use_icons = 'false';
4557 print "Enable this option if you want to use php recode functions to read\n";
4558 print "emails written in charset that differs from the one that is set in\n";
4559 print "translation selected by user. Code is experimental, it might cause\n";
4560 print "errors, if email contains charset unsupported by recode or if your\n";
4561 print "php does not have recode support.\n";
4564 if ( lc($use_php_recode) eq 'true' ) {
4565 $default_value = "y";
4567 $default_value = "n";
4569 print "Use php recode functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4570 $use_php_recode = <STDIN
>;
4571 if ( ( $use_php_recode =~ /^y\n/i ) || ( ( $use_php_recode =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4572 $use_php_recode = 'true';
4574 $use_php_recode = 'false';
4576 return $use_php_recode;
4580 print "Enable this option if you want to use php iconv functions to read\n";
4581 print "emails written in charset that differs from the one that is set in\n";
4582 print "translation selected by user. Code is experimental, it works only\n";
4583 print "with translations that use utf-8 charset. Code might cause errors,\n";
4584 print "if email contains charset unsupported by iconv or if your php does\n";
4585 print "not have iconv support.\n";
4588 if ( lc($use_php_iconv) eq 'true' ) {
4589 $default_value = "y";
4591 $default_value = "n";
4593 print "Use php iconv functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4594 $use_php_iconv = <STDIN
>;
4595 if ( ( $use_php_iconv =~ /^y\n/i ) || ( ( $use_php_iconv =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4596 $use_php_iconv = 'true';
4598 $use_php_iconv = 'false';
4600 return $use_php_iconv;
4605 print "In some cases, buffering all output (holding it on the server until\n";
4606 print "the full page is ready to send to the browser) allows more complex\n";
4607 print "functionality, especially for plugins that want to add headers on hooks\n";
4608 print "that are beyond the point of output having been sent to the browser\n";
4609 print "otherwise. Most plugins that need this functionality will enable it\n";
4610 print "automatically on their own, but you can turn it on manually here. You'd\n";
4611 print "usually want to do this if you want to specify a custom output handler\n";
4612 print "for parsing the output - you can do that by specifying a value for\n";
4613 print "\$buffered_output_handler in config_local.php. Don't forget to define\n";
4614 print "a function of the same name as what \$buffered_output_handler is set to.\n";
4617 if ( lc($buffer_output) eq 'true' ) {
4618 $default_value = "y";
4620 $default_value = "n";
4622 print "Buffer all output? (y/n) [$WHT$default_value$NRM]: $WHT";
4623 $buffer_output = <STDIN
>;
4624 if ( ( $buffer_output =~ /^y\n/i ) || ( ( $buffer_output =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4625 $buffer_output = 'true';
4627 $buffer_output = 'false';
4629 return $buffer_output;
4634 print "Enable this option if you want to check SquirrelMail configuration\n";
4635 print "remotely with configtest.php script.\n";
4638 if ( lc($allow_remote_configtest) eq 'true' ) {
4639 $default_value = "y";
4641 $default_value = "n";
4643 print "Allow remote configuration tests? (y/n) [$WHT$default_value$NRM]: $WHT";
4644 $allow_remote_configtest = <STDIN
>;
4645 if ( ( $allow_remote_configtest =~ /^y\n/i ) || ( ( $allow_remote_configtest =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4646 $allow_remote_configtest = 'true';
4648 $allow_remote_configtest = 'false';
4650 return $allow_remote_configtest;
4653 # Default Icon theme
4655 print "You may change the path to the default icon theme to be used, if icons\n";
4656 print "have been enabled. This theme will be used when an icon cannot be\n";
4657 print "found in the current theme, or when no icon theme is specified. If\n";
4658 print "left blank, and icons are enabled, the default theme will be used\n";
4659 print "from images/themes/default/.\n";
4661 print "To clear out an existing value, just type a space for the input.\n";
4663 print "Please be aware of the following: \n";
4664 print " - Relative URLs are relative to the config dir\n";
4665 print " to use the icon themes directory, use ../images/themes/newtheme/\n";
4666 print " - The icon theme may be outside the SquirrelMail directory, but\n";
4667 print " it must be web accessible.\n";
4668 print "[$WHT$icon_theme_def$NRM]: $WHT";
4669 $new_icon_theme_def = <STDIN
>;
4671 if ( $new_icon_theme_def eq "\n" ) {
4672 $new_icon_theme_def = $icon_theme_def;
4674 $new_icon_theme_def =~ s/[\r\n]//g;
4676 $new_icon_theme_def =~ s/^\s*//;
4677 return $new_icon_theme_def;
4680 # SquirrelMail debug mode (since 1.5.2)
4682 print "When debugging or developing SquirrelMail, you may want to increase\n";
4683 print "the verbosity of certain kinds of errors, notices, and/or diagnostics.\n";
4684 print "You may enable one or more of the debugging modes here. Please make\n";
4685 print "sure that you have turned off debugging if you are using SquirrelMail\n";
4686 print "in a production environment.\n\n";
4689 while ( $input ne "d\n" ) {
4690 $sm_debug_mode = convert_debug_constants_to_binary_integer
($sm_debug_mode);
4692 # per include/constants.php, here are the debug mode values:
4694 # 0 SM_DEBUG_MODE_OFF
4695 # 1 SM_DEBUG_MODE_SIMPLE
4696 # 512 SM_DEBUG_MODE_MODERATE
4697 # 524288 SM_DEBUG_MODE_ADVANCED
4698 # 536870912 SM_DEBUG_MODE_STRICT
4700 print "\n# Enabled? Description\n";
4701 print "---------------------------------------------------------------------\n";
4702 print "0 " . ($sm_debug_mode == 0 ?
"y" : " ")
4703 . " No debugging (recommended in production environments)\n";
4704 print "1 " . ($sm_debug_mode & 1 ?
"y" : " ")
4705 . " Simple debugging (PHP E_ERROR)\n";
4706 print "2 " . ($sm_debug_mode & 512 ?
"y" : " ")
4707 . " Moderate debugging (PHP E_ALL without E_STRICT)\n";
4708 print "3 " . ($sm_debug_mode & 524288 ?
"y" : " ")
4709 . " Advanced debugging (PHP E_ALL (without E_STRICT) plus\n";
4710 print " log errors intentionally suppressed)\n";
4711 print "4 " . ($sm_debug_mode & 536870912 ?
"y" : " ")
4712 . " Strict debugging (PHP E_ALL and E_STRICT)\n";
4715 print "SquirrelMail debug mode (0,1,2,3,4) or d when done? : $WHT";
4717 if ( $input eq "d\n" ) {
4719 } elsif ($input !~ /^[0-9]+\n$/) {
4720 print "\nInvalid configuration value.\n";
4721 print "\nPress enter to continue...";
4723 } elsif ( $input == "0\n" ) {
4725 } elsif ( $input == "1\n" ) {
4726 if ($sm_debug_mode & 1) {
4727 $sm_debug_mode ^= 1;
4729 $sm_debug_mode |= 1;
4731 } elsif ( $input == "2\n" ) {
4732 if ($sm_debug_mode & 512) {
4733 $sm_debug_mode ^= 512;
4735 $sm_debug_mode |= 512;
4737 } elsif ( $input == "3\n" ) {
4738 if ($sm_debug_mode & 524288) {
4739 $sm_debug_mode ^= 524288;
4741 $sm_debug_mode |= 524288;
4743 } elsif ( $input == "4\n" ) {
4744 if ($sm_debug_mode & 536870912) {
4745 $sm_debug_mode ^= 536870912;
4747 $sm_debug_mode |= 536870912;
4750 print "\nInvalid configuration value.\n";
4751 print "\nPress enter to continue...";
4756 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
4757 return $sm_debug_mode;
4760 # Secured configuration mode (since 1.5.2)
4762 print "This option allows you to enable \"Secured Configuration\" mode,\n";
4763 print "which will guarantee that certain settings made herein will be\n";
4764 print "made immutable and will not be subject to override by either friendly\n";
4765 print "or unfriendly code/plugins. Only a small number of settings herein\n";
4766 print "will be used in this manner - just those that are deemed to be a\n";
4767 print "potential security threat when rouge plugin or other code may be\n";
4768 print "executed inside SquirrelMail.\n";
4771 if ( lc($secured_config) eq 'true' ) {
4772 $default_value = "y";
4774 $default_value = "n";
4776 print "Enable secured configuration mode? (y/n) [$WHT$default_value$NRM]: $WHT";
4777 $secured_config = <STDIN
>;
4778 if ( ( $secured_config =~ /^y\n/i ) || ( ( $secured_config =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4779 $secured_config = 'true';
4781 $secured_config = 'false';
4783 return $secured_config;
4786 # Set a (non-standard) HTTPS port
4788 print "If you run HTTPS (SSL-secured HTTP) on a non-standard port, you should\n";
4789 print "indicate that port here. Even if you do not, SquirrelMail may still\n";
4790 print "auto-detect secure connections, but it is safer and also very useful\n";
4791 print "for third party plugins if you specify the port number here.\n";
4793 print "Most SquirrelMail administrators will not need to use this setting\n";
4794 print "because most all web servers use port 443 for HTTPS connections, and\n";
4795 print "SquirrelMail assumes 443 unless something else is given here.\n";
4798 print "Enter your HTTPS port [$sq_https_port]: ";
4801 # value is not modified, if user hits Enter or enters space
4803 # make sure that input is numeric
4804 if ($tmp =~ /^\d+$/) {
4805 $sq_https_port = $tmp;
4808 print "--- INPUT ERROR ---\n";
4810 print "If you want to change this setting, you must enter a number.\n";
4811 print "If you want to keep the original value, just press Enter.\n\n";
4812 print "Press Enter to continue...";
4816 return $sq_https_port;
4819 # Ignore HTTP_X_FORWARDED_* headers?
4822 if ( lc($sq_ignore_http_x_forwarded_headers) eq 'true' ) {
4823 $default_value = "y";
4825 $default_value = "n";
4828 print "Because HTTP_X_FORWARDED_* headers can be sent by the client and\n";
4829 print "therefore possibly exploited by an outsider, SquirrelMail ignores\n";
4830 print "them by default. If a proxy server or other machine sits between\n";
4831 print "clients and your SquirrelMail server, you can turn this off to\n";
4832 print "tell SquirrelMail to use such headers.\n";
4835 print "Ignore HTTP_X_FORWARDED headers? (y/n) [$WHT$default_value$NRM]: $WHT";
4836 $sq_ignore_http_x_forwarded_headers = <STDIN
>;
4837 if ( ( $sq_ignore_http_x_forwarded_headers =~ /^y\n/i ) || ( ( $sq_ignore_http_x_forwarded_headers =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4838 $sq_ignore_http_x_forwarded_headers = 'true';
4840 $sq_ignore_http_x_forwarded_headers = 'false';
4842 return $sq_ignore_http_x_forwarded_headers;
4847 if ( open( CF
, ">config.php" ) ) {
4852 print CF
" * SquirrelMail Configuration File\n";
4853 print CF
" * Created using the configure script, conf.pl\n";
4857 if ($print_config_version) {
4858 print CF
"\$config_version = '$print_config_version';\n";
4861 print CF
"\$config_use_color = $config_use_color;\n";
4865 print CF
"\$org_name = \"$org_name\";\n";
4867 print CF
"\$org_logo = " . &change_to_SM_path
($org_logo) . ";\n";
4868 $org_logo_width |= 0;
4869 $org_logo_height |= 0;
4871 print CF
"\$org_logo_width = '$org_logo_width';\n";
4873 print CF
"\$org_logo_height = '$org_logo_height';\n";
4874 # string that can contain variables.
4875 print CF
"\$org_title = \"$org_title\";\n";
4877 print CF
"\$signout_page = " . &change_to_SM_path
($signout_page) . ";\n";
4879 print CF
"\$frame_top = '$frame_top';\n";
4882 print CF
"\$provider_uri = '$provider_uri';\n";
4885 print CF
"\$provider_name = '$provider_name';\n";
4888 # string that can contain variables
4889 print CF
"\$motd = \"$motd\";\n";
4893 print CF
"\$squirrelmail_default_language = '$squirrelmail_default_language';\n";
4895 print CF
"\$default_charset = '$default_charset';\n";
4897 print CF
"\$show_alternative_names = $show_alternative_names;\n";
4899 print CF
"\$aggressive_decoding = $aggressive_decoding;\n";
4901 print CF
"\$lossy_encoding = $lossy_encoding;\n";
4905 print CF
"\$domain = '$domain';\n";
4907 print CF
"\$imapServerAddress = '$imapServerAddress';\n";
4909 print CF
"\$imapPort = $imapPort;\n";
4911 print CF
"\$useSendmail = $useSendmail;\n";
4913 print CF
"\$smtpServerAddress = '$smtpServerAddress';\n";
4915 print CF
"\$smtpPort = $smtpPort;\n";
4917 print CF
"\$sendmail_path = '$sendmail_path';\n";
4919 print CF
"\$sendmail_args = '$sendmail_args';\n";
4921 # print CF "\$use_authenticated_smtp = $use_authenticated_smtp;\n";
4923 print CF
"\$pop_before_smtp = $pop_before_smtp;\n";
4925 print CF
"\$pop_before_smtp_host = '$pop_before_smtp_host';\n";
4927 print CF
"\$imap_server_type = '$imap_server_type';\n";
4929 print CF
"\$invert_time = $invert_time;\n";
4931 print CF
"\$optional_delimiter = '$optional_delimiter';\n";
4933 print CF
"\$encode_header_key = '$encode_header_key';\n";
4937 print CF
"\$default_folder_prefix = '$default_folder_prefix';\n";
4939 print CF
"\$trash_folder = '$trash_folder';\n";
4941 print CF
"\$sent_folder = '$sent_folder';\n";
4943 print CF
"\$draft_folder = '$draft_folder';\n";
4945 print CF
"\$default_move_to_trash = $default_move_to_trash;\n";
4947 print CF
"\$default_move_to_sent = $default_move_to_sent;\n";
4949 print CF
"\$default_save_as_draft = $default_save_as_draft;\n";
4951 print CF
"\$show_prefix_option = $show_prefix_option;\n";
4953 print CF
"\$list_special_folders_first = $list_special_folders_first;\n";
4955 print CF
"\$use_special_folder_color = $use_special_folder_color;\n";
4957 print CF
"\$auto_expunge = $auto_expunge;\n";
4959 print CF
"\$default_sub_of_inbox = $default_sub_of_inbox;\n";
4961 print CF
"\$show_contain_subfolders_option = $show_contain_subfolders_option;\n";
4963 print CF
"\$default_unseen_notify = $default_unseen_notify;\n";
4965 print CF
"\$default_unseen_type = $default_unseen_type;\n";
4967 print CF
"\$auto_create_special = $auto_create_special;\n";
4969 print CF
"\$delete_folder = $delete_folder;\n";
4971 print CF
"\$noselect_fix_enable = $noselect_fix_enable;\n";
4976 print CF
"\$data_dir = " . &change_to_SM_path
($data_dir) . ";\n";
4977 # string that can contain a variable
4978 print CF
"\$attachment_dir = " . &change_to_SM_path
($attachment_dir) . ";\n";
4980 print CF
"\$dir_hash_level = $dir_hash_level;\n";
4982 print CF
"\$default_left_size = '$default_left_size';\n";
4984 print CF
"\$force_username_lowercase = $force_username_lowercase;\n";
4986 print CF
"\$default_use_priority = $default_use_priority;\n";
4988 print CF
"\$hide_sm_attributions = $hide_sm_attributions;\n";
4990 print CF
"\$default_use_mdn = $default_use_mdn;\n";
4992 print CF
"\$edit_identity = $edit_identity;\n";
4994 print CF
"\$edit_name = $edit_name;\n";
4996 print CF
"\$hide_auth_header = $hide_auth_header;\n";
4998 print CF
"\$disable_thread_sort = $disable_thread_sort;\n";
5000 print CF
"\$disable_server_sort = $disable_server_sort;\n";
5002 print CF
"\$allow_charset_search = $allow_charset_search;\n";
5004 print CF
"\$allow_advanced_search = $allow_advanced_search;\n";
5007 print CF
"\$time_zone_type = $time_zone_type;\n";
5010 print CF
"\$config_location_base = '$config_location_base';\n";
5013 print CF
"\$disable_plugins = $disable_plugins;\n";
5015 print CF
"\$disable_plugins_user = '$disable_plugins_user';\n";
5018 # all plugins are strings
5019 for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
5020 print CF
"\$plugins[] = '$plugins[$ct]';\n";
5025 if ( $user_theme_default eq '' ) { $user_theme_default = '0'; }
5026 print CF
"\$user_theme_default = $user_theme_default;\n";
5028 for ( $count = 0 ; $count <= $#user_theme_name ; $count++ ) {
5029 if ($user_theme_path[$count] eq 'none') {
5032 $path = &change_to_SM_path
($user_theme_path[$count]);
5034 print CF
"\$user_themes[$count]['PATH'] = " . $path . ";\n";
5035 # escape theme name so it can contain single quotes.
5036 $esc_name = $user_theme_name[$count];
5037 $esc_name =~ s/\\/\\\\/g;
5038 $esc_name =~ s/'/\\'/g;
5039 print CF
"\$user_themes[$count]['NAME'] = '$esc_name';\n";
5043 if ( $icon_theme_def eq '' ) { $icon_theme_def = '0'; }
5044 print CF
"\$icon_theme_def = $icon_theme_def;\n";
5045 if ( $icon_theme_fallback eq '' ) { $icon_theme_fallback = '0'; }
5046 print CF
"\$icon_theme_fallback = $icon_theme_fallback;\n";
5048 for ( $count = 0 ; $count <= $#icon_theme_name ; $count++ ) {
5049 $path = $icon_theme_path[$count];
5050 if ($path eq 'none' || $path eq 'template') {
5051 $path = "'".$path."'";
5053 $path = &change_to_SM_path
($icon_theme_path[$count]);
5055 print CF
"\$icon_themes[$count]['PATH'] = " . $path . ";\n";
5056 # escape theme name so it can contain single quotes.
5057 $esc_name = $icon_theme_name[$count];
5058 $esc_name =~ s/\\/\\\\/g;
5059 $esc_name =~ s/'/\\'/g;
5060 print CF
"\$icon_themes[$count]['NAME'] = '$esc_name';\n";
5064 if ( $templateset_default eq '' ) { $templateset_default = 'default'; }
5065 print CF
"\$templateset_default = '$templateset_default';\n";
5067 if ( $templateset_fallback eq '' ) { $templateset_fallback = 'default'; }
5068 print CF
"\$templateset_fallback = '$templateset_fallback';\n";
5070 if ( $rpc_templateset eq '' ) { $rpc_templateset = 'default_rpc'; }
5071 print CF
"\$rpc_templateset = '$rpc_templateset';\n";
5073 for ( $count = 0 ; $count <= $#templateset_name ; $count++ ) {
5075 # don't include RPC template sets
5077 if ( $templateset_id[$count] =~ /_rpc$/ ) { next; }
5079 print CF
"\$aTemplateSet[$count]['ID'] = '" . $templateset_id[$count] . "';\n";
5080 # escape theme name so it can contain single quotes.
5081 $esc_name = $templateset_name[$count];
5082 $esc_name =~ s/\\/\\\\/g;
5083 $esc_name =~ s/'/\\'/g;
5084 print CF
"\$aTemplateSet[$count]['NAME'] = '$esc_name';\n";
5090 print CF
"\$default_fontsize = '$default_fontsize';\n";
5092 print CF
"\$default_fontset = '$default_fontset';\n";
5094 # assoc. array (maybe initial value should be set somewhere else)
5095 print CF
'$fontsets = array();'."\n";
5096 while (($fontset_name, $fontset_value) = each(%fontsets)) {
5097 print CF
"\$fontsets\['$fontset_name'\] = '$fontset_value';\n";
5103 print CF
"\$default_use_javascript_addr_book = $default_use_javascript_addr_book;\n";
5104 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
5105 print CF
"\$ldap_server[$count] = array(\n";
5107 print CF
" 'host' => '$ldap_host[$count]',\n";
5109 print CF
" 'base' => '$ldap_base[$count]'";
5110 if ( $ldap_name[$count] ) {
5113 print CF
" 'name' => '$ldap_name[$count]'";
5115 if ( $ldap_port[$count] ) {
5118 print CF
" 'port' => $ldap_port[$count]";
5120 if ( $ldap_charset[$count] ) {
5123 print CF
" 'charset' => '$ldap_charset[$count]'";
5125 if ( $ldap_maxrows[$count] ) {
5128 print CF
" 'maxrows' => $ldap_maxrows[$count]";
5131 if ( $ldap_filter[$count] ) {
5133 print CF
" 'filter' => '$ldap_filter[$count]'";
5135 if ( $ldap_binddn[$count] ) {
5138 print CF
" 'binddn' => '$ldap_binddn[$count]'";
5139 if ( $ldap_bindpw[$count] ) {
5142 print CF
" 'bindpw' => '$ldap_bindpw[$count]'";
5145 if ( $ldap_protocol[$count] ) {
5148 print CF
" 'protocol' => $ldap_protocol[$count]";
5150 if ( $ldap_limit_scope[$count] ) {
5153 print CF
" 'limit_scope' => $ldap_limit_scope[$count]";
5155 if ( $ldap_listing[$count] ) {
5158 print CF
" 'listing' => $ldap_listing[$count]";
5160 if ( $ldap_writeable[$count] ) {
5163 print CF
" 'writeable' => $ldap_writeable[$count]";
5165 if ( $ldap_search_tree[$count] ) {
5168 print CF
" 'search_tree' => $ldap_search_tree[$count]";
5170 if ( $ldap_starttls[$count] ) {
5173 print CF
" 'starttls' => $ldap_starttls[$count]";
5181 print CF
"\$addrbook_dsn = '$addrbook_dsn';\n";
5183 print CF
"\$addrbook_table = '$addrbook_table';\n\n";
5185 print CF
"\$prefs_dsn = '$prefs_dsn';\n";
5187 print CF
"\$prefs_table = '$prefs_table';\n";
5189 print CF
"\$prefs_user_field = '$prefs_user_field';\n";
5191 print CF
"\$prefs_user_size = $prefs_user_size;\n";
5193 print CF
"\$prefs_key_field = '$prefs_key_field';\n";
5195 print CF
"\$prefs_key_size = $prefs_key_size;\n";
5197 print CF
"\$prefs_val_field = '$prefs_val_field';\n";
5199 print CF
"\$prefs_val_size = $prefs_val_size;\n\n";
5201 print CF
"\$addrbook_global_dsn = '$addrbook_global_dsn';\n";
5203 print CF
"\$addrbook_global_table = '$addrbook_global_table';\n";
5205 print CF
"\$addrbook_global_writeable = $addrbook_global_writeable;\n";
5207 print CF
"\$addrbook_global_listing = $addrbook_global_listing;\n\n";
5209 print CF
"\$abook_global_file = '$abook_global_file';\n";
5211 print CF
"\$abook_global_file_writeable = $abook_global_file_writeable;\n\n";
5213 print CF
"\$abook_global_file_listing = $abook_global_file_listing;\n\n";
5215 print CF
"\$abook_file_line_length = $abook_file_line_length;\n\n";
5217 print CF
"\$no_list_for_subscribe = $no_list_for_subscribe;\n";
5220 print CF
"\$smtp_auth_mech = '$smtp_auth_mech';\n";
5221 print CF
"\$smtp_sitewide_user = '". quote_single
($smtp_sitewide_user) ."';\n";
5222 print CF
"\$smtp_sitewide_pass = '". quote_single
($smtp_sitewide_pass) ."';\n";
5224 print CF
"\$imap_auth_mech = '$imap_auth_mech';\n";
5226 print CF
"\$use_imap_tls = $use_imap_tls;\n";
5228 print CF
"\$use_smtp_tls = $use_smtp_tls;\n";
5230 print CF
"\$display_imap_login_error = $display_imap_login_error;\n";
5232 print CF
"\$session_name = '$session_name';\n";
5234 print CF
"\$only_secure_cookies = $only_secure_cookies;\n";
5235 print CF
"\$disable_security_tokens = $disable_security_tokens;\n";
5238 print CF
"\$check_referrer = '$check_referrer';\n";
5241 print CF
"\$use_transparent_security_image = $use_transparent_security_image;\n";
5246 print CF
"\$use_iframe = $use_iframe;\n";
5248 print CF
"\$ask_user_info = $ask_user_info;\n";
5250 print CF
"\$use_icons = $use_icons;\n";
5253 print CF
"\$use_php_recode = $use_php_recode;\n";
5255 print CF
"\$use_php_iconv = $use_php_iconv;\n";
5258 print CF
"\$buffer_output = $buffer_output;\n";
5261 print CF
"\$allow_remote_configtest = $allow_remote_configtest;\n";
5262 print CF
"\$secured_config = $secured_config;\n";
5264 print CF
"\$sq_https_port = $sq_https_port;\n";
5266 print CF
"\$sq_ignore_http_x_forwarded_headers = $sq_ignore_http_x_forwarded_headers;\n";
5267 # (binary) integer or constant - convert integer
5268 # values to constants before output
5269 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
5270 print CF
"\$sm_debug_mode = $sm_debug_mode;\n";
5275 print "Data saved in config.php\n";
5277 build_plugin_hook_array
();
5280 print "Error saving config.php: $!\n";
5286 print $WHT. "SquirrelMail Configuration : " . $NRM;
5287 if ( $config == 1 ) { print "Read: config.php"; }
5288 elsif ( $config == 2 ) { print "Read: config_default.php"; }
5290 print "---------------------------------------------------------\n";
5292 print "While we have been building SquirrelMail, we have discovered some\n";
5293 print "preferences that work better with some servers that don't work so\n";
5294 print "well with others. If you select your IMAP server, this option will\n";
5295 print "set some pre-defined settings for that server.\n";
5297 print "Please note that you will still need to go through and make sure\n";
5298 print "everything is correct. This does not change everything. There are\n";
5299 print "only a few settings that this will change.\n";
5303 while ( $continue != 1 ) {
5304 print "Please select your IMAP server:\n";
5305 print $list_supported_imap_servers;
5307 print " quit = Do not change anything\n";
5309 print "Command >> ";
5311 $server =~ s/[\r\n]//g;
5313 # variable is used to display additional messages.
5317 if ( $server eq "cyrus" ) {
5318 $imap_server_type = "cyrus";
5319 $default_folder_prefix = "";
5320 $trash_folder = "INBOX.Trash";
5321 $sent_folder = "INBOX.Sent";
5322 $draft_folder = "INBOX.Drafts";
5323 $show_prefix_option = false
;
5324 $default_sub_of_inbox = true
;
5325 $show_contain_subfolders_option = false
;
5326 $optional_delimiter = ".";
5327 $disp_default_folder_prefix = "<none>";
5328 $force_username_lowercase = false
;
5330 # Delimiter might differ if unixhierarchysep is set to yes.
5331 $message = "\nIf you have enabled unixhierarchysep, you must change delimiter and special folder names.\n";
5334 } elsif ( $server eq "uw" ) {
5335 $imap_server_type = "uw";
5336 $default_folder_prefix = "mail/";
5337 $trash_folder = "Trash";
5338 $sent_folder = "Sent";
5339 $draft_folder = "Drafts";
5340 $show_prefix_option = true
;
5341 $default_sub_of_inbox = false
;
5342 $show_contain_subfolders_option = true
;
5343 $optional_delimiter = "/";
5344 $disp_default_folder_prefix = $default_folder_prefix;
5345 $delete_folder = true
;
5346 $force_username_lowercase = true
;
5349 } elsif ( $server eq "exchange" ) {
5350 $imap_server_type = "exchange";
5351 $default_folder_prefix = "";
5352 $default_sub_of_inbox = true
;
5353 $trash_folder = "INBOX/Deleted Items";
5354 $sent_folder = "INBOX/Sent Items";
5355 $drafts_folder = "INBOX/Drafts";
5356 $show_prefix_option = false
;
5357 $show_contain_subfolders_option = false
;
5358 $optional_delimiter = "detect";
5359 $disp_default_folder_prefix = "<none>";
5360 $force_username_lowercase = true
;
5363 } elsif ( $server eq "courier" ) {
5364 $imap_server_type = "courier";
5365 $default_folder_prefix = "INBOX.";
5366 $trash_folder = "Trash";
5367 $sent_folder = "Sent";
5368 $draft_folder = "Drafts";
5369 $show_prefix_option = false
;
5370 $default_sub_of_inbox = false
;
5371 $show_contain_subfolders_option = false
;
5372 $optional_delimiter = ".";
5373 $disp_default_folder_prefix = $default_folder_prefix;
5374 $delete_folder = true
;
5375 $force_username_lowercase = false
;
5378 } elsif ( $server eq "macosx" ) {
5379 $imap_server_type = "macosx";
5380 $default_folder_prefix = "INBOX/";
5381 $trash_folder = "Trash";
5382 $sent_folder = "Sent";
5383 $draft_folder = "Drafts";
5384 $show_prefix_option = false
;
5385 $default_sub_of_inbox = true
;
5386 $show_contain_subfolders_option = false
;
5387 $optional_delimiter = "detect";
5388 $allow_charset_search = false
;
5389 $disp_default_folder_prefix = $default_folder_prefix;
5392 } elsif ( $server eq "hmailserver" ) {
5393 $imap_server_type = "hmailserver";
5394 $default_folder_prefix = "";
5395 $trash_folder = "INBOX.Trash";
5396 $sent_folder = "INBOX.Sent";
5397 $draft_folder = "INBOX.Drafts";
5398 $show_prefix_option = false
;
5399 $default_sub_of_inbox = true
;
5400 $show_contain_subfolders_option = false
;
5401 $optional_delimiter = "detect";
5402 $allow_charset_search = false
;
5403 $disp_default_folder_prefix = $default_folder_prefix;
5404 $delete_folder = false
;
5405 $force_username_lowercase = false
;
5408 } elsif ( $server eq "mercury32" ) {
5409 $imap_server_type = "mercury32";
5410 $default_folder_prefix = "";
5411 $trash_folder = "Trash";
5412 $sent_folder = "Sent";
5413 $draft_folder = "Drafts";
5414 $show_prefix_option = false
;
5415 $default_sub_of_inbox = true
;
5416 $show_contain_subfolders_option = true
;
5417 $optional_delimiter = "detect";
5418 $delete_folder = true
;
5419 $force_username_lowercase = true
;
5422 } elsif ( $server eq "dovecot" ) {
5423 $imap_server_type = "dovecot";
5424 $default_folder_prefix = "";
5425 $trash_folder = "Trash";
5426 $sent_folder = "Sent";
5427 $draft_folder = "Drafts";
5428 $show_prefix_option = false
;
5429 $default_sub_of_inbox = false
;
5430 $show_contain_subfolders_option = false
;
5431 $delete_folder = false
;
5432 $force_username_lowercase = true
;
5433 $optional_delimiter = "detect";
5434 $disp_default_folder_prefix = "<none>";
5437 } elsif ( $server eq "bincimap" ) {
5438 $imap_server_type = "bincimap";
5439 $default_folder_prefix = "INBOX/";
5440 $trash_folder = "Trash";
5441 $sent_folder = "Sent";
5442 $draft_folder = "Drafts";
5443 $show_prefix_option = false
;
5444 $default_sub_of_inbox = false
;
5445 $show_contain_subfolders_option = false
;
5446 $delete_folder = true
;
5447 $force_username_lowercase = false
;
5448 $optional_delimiter = "detect";
5449 $disp_default_folder_prefix = $default_folder_prefix;
5451 # Default folder prefix depends on used depot.
5452 $message = "\nIf you use IMAPdir depot, you must set default folder prefix to empty string.\n";
5455 } elsif ( $server eq "gmail" ) {
5456 $imap_server_type = "gmail";
5457 $default_folder_prefix = "";
5458 $trash_folder = "[Gmail]/Trash";
5459 $default_move_to_trash = true
;
5460 $sent_folder = "[Gmail]/Sent Mail";
5461 $draft_folder = "[Gmail]/Drafts";
5462 $auto_create_special = false
;
5463 $show_prefix_option = false
;
5464 $default_sub_of_inbox = false
;
5465 $show_contain_subfolders_option = false
;
5466 $delete_folder = true
;
5467 $force_username_lowercase = false
;
5468 $optional_delimiter = "/";
5469 $disp_default_folder_prefix = "<none>";
5470 $domain = "gmail.com";
5471 $imapServerAddress = "imap.gmail.com";
5473 $use_imap_tls = true
;
5474 $imap_auth_mech = "login";
5475 $smtpServerAddress = "smtp.gmail.com";
5477 $pop_before_smtp = false
;
5478 $useSendmail = false
;
5479 $use_smtp_tls = true
;
5480 $smtp_auth_mech = "login";
5483 # Gmail changes system folder names (Drafts, Sent, Trash) out
5484 # from under you when the user changes language settings
5485 $message = "\nNOTE! When a user changes languages in Gmail's interface, the\n"
5486 . "Drafts, Sent and Trash folder names are changed to localized\n"
5487 . "versions thereof. To see those folders correctly in SquirrelMail,\n"
5488 . "the user should change the SquirrelMail language to match.\n"
5489 . "Moreover, SquirrelMail then needs to be told what folders to use\n"
5490 . "for Drafts, Sent and Trash in Options --> Folder Preferences.\n"
5491 . "These default settings will only correctly find the Sent, Trash\n"
5492 . "and Drafts folders if both Gmail and SquirrelMail languages are\n"
5493 . "set to English.\n\n"
5494 . "Also note that in some regions (Europe?), the default folder\n"
5495 . "names (see main menu selection 3. Folder Defaults) are different\n"
5496 . "(they may need to have the prefix \"[Google Mail]\" instead of\n"
5497 . "\"[Gmail]\") and \"Trash\" may be called \"Bin\" instead.\n";
5499 } elsif ( $server eq "quit" ) {
5502 $disp_default_folder_prefix = $default_folder_prefix;
5503 print "Unrecognized server: $server\n";
5507 print " imap_server_type = $imap_server_type\n";
5508 print " default_folder_prefix = $disp_default_folder_prefix\n";
5509 print " trash_folder = $trash_folder\n";
5510 print " sent_folder = $sent_folder\n";
5511 print " draft_folder = $draft_folder\n";
5512 print " show_prefix_option = $show_prefix_option\n";
5513 print " default_sub_of_inbox = $default_sub_of_inbox\n";
5514 print "show_contain_subfolders_option = $show_contain_subfolders_option\n";
5515 print " optional_delimiter = $optional_delimiter\n";
5516 print " delete_folder = $delete_folder\n";
5517 print " force_username_lowercase = $force_username_lowercase\n";
5521 print "\nPress enter to continue...";
5525 # This subroutine corrects relative paths to ensure they
5526 # will work within the SM space. If the path falls within
5527 # the SM directory tree, the SM_PATH variable will be
5528 # prepended to the path, if not, then the path will be
5529 # converted to an absolute path, e.g.
5530 # '../images/logo.gif' --> SM_PATH . 'images/logo.gif'
5531 # '../../someplace/data' --> '/absolute/path/someplace/data'
5532 # 'images/logo.gif' --> SM_PATH . 'config/images/logo.gif'
5533 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
5534 # 'C:\absolute\path\logo.gif' --> 'C:\absolute\path\logo.gif'
5535 # 'http://whatever/' --> 'http://whatever'
5536 # $some_var/path --> "$some_var/path"
5537 sub change_to_SM_path
() {
5538 my ($old_path) = @_;
5544 # If the path is absolute, don't bother.
5545 return "\'" . $old_path . "\'" if ( $old_path eq '');
5546 return "\'" . $old_path . "\'" if ( $old_path =~ /^(\/|http
)/ );
5547 return "\'" . $old_path . "\'" if ( $old_path =~ /^\w:(\\|\/)/ );
5548 return $old_path if ( $old_path =~ /^\'(\/|http
)/ );
5549 return $old_path if ( $old_path =~ /^\'\w:\// );
5550 return $old_path if ( $old_path =~ /^SM_PATH/);
5552 if ( $old_path =~ /^\$/ ) {
5553 # check if it's a single var, or a $var/path combination
5554 # if it's $var/path, enclose in ""
5555 if ( $old_path =~ /\// ) {
5556 return '"'.$old_path.'"';
5561 # Remove remaining '
5562 $old_path =~ s/\'//g;
5564 # For relative paths, split on '../'
5565 @rel_path = split(/\.\.\//, $old_path);
5567 if ( $#rel_path > 1 ) {
5568 # more than two levels away. Make it absolute.
5569 @abs_path = split(/\//, $dir);
5571 # Lop off the relative pieces of the absolute path..
5572 for ( $i = 0; $i <= $#rel_path; $i++ ) {
5576 push @abs_path, @rel_path;
5577 $new_path = "\'" . join('/', @abs_path) . "\'";
5578 } elsif ( $#rel_path > 0 ) {
5579 # it's within the SM tree, prepend SM_PATH
5580 $new_path = $old_path;
5581 $new_path =~ s/^\.\.\//SM_PATH
. \'/;
5584 # Last, it's a relative path without any leading '.'
5585 # Prepend SM_PATH and config, since the paths are
5586 # relative to the config directory
5587 $new_path = "SM_PATH . \'config/" . $old_path . "\'";
5593 # Change SM_PATH to admin-friendly version, e.g.:
5594 # SM_PATH . 'images/logo.gif' --> '../images/logo.gif'
5595 # SM_PATH . 'config/some.php' --> 'some.php'
5596 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
5597 # 'http://whatever/' --> 'http://whatever'
5598 sub change_to_rel_path
() {
5599 my ($old_path) = @_;
5600 my $new_path = $old_path;
5602 if ( $old_path =~ /^SM_PATH/ ) {
5603 # FIXME: the following replacement loses the opening quote mark!
5604 $new_path =~ s/^SM_PATH . \'/\.\.\//;
5605 $new_path =~ s/\.\.\/config\///;
5611 # Attempts to auto-detect if a specific auth mechanism is supported.
5612 # Called by 'command112a' and 'command112b'
5613 # ARGS: service-name (IMAP or SMTP), host:port, mech-name (ie. CRAM-MD5)
5614 sub detect_auth_support
{
5615 # Try loading IO::Socket
5616 unless (eval("use IO::Socket; 1")) {
5617 print "Perl IO::Socket module is not available.";
5621 my $service = shift;
5625 if ((!defined($service)) or (!defined($host)) or (!defined($mech))) {
5626 # Error - wrong # of args
5627 print "BAD ARGS!\n";
5631 if ($service eq 'SMTP') {
5632 $cmd = "AUTH $mech\r\n";
5633 $logout = "QUIT\r\n";
5634 } elsif ($service eq 'IMAP') {
5635 $cmd = "A01 AUTHENTICATE $mech\n";
5636 $logout = "C01 LOGOUT\n";
5638 # unknown service - whoops.
5642 # Get this show on the road
5643 my $sock=IO
::Socket
::INET
->new($host);
5644 if (!defined($sock)) {
5648 my $discard = <$sock>; # Server greeting/banner - who cares..
5650 if ($service eq 'SMTP') {
5652 print $sock "HELO $domain\r\n";
5653 $discard = <$sock>; # Yeah yeah, you're happy to see me..
5657 my $response = <$sock>;
5659 if (!defined($response)) {
5663 # So at this point, we have a response, and it is (hopefully) valid.
5664 if ($service eq 'SMTP') {
5665 if (!($response =~ /^334/)) {
5667 print $sock $logout;
5671 } elsif ($service eq 'IMAP') {
5672 if ($response =~ /^A01/) {
5674 print $sock $logout;
5679 # Unknown service - this shouldn't be able to happen.
5684 # If it gets here, the mech is supported
5685 print $sock "*\n"; # Attempt to cancel authentication
5686 print $sock $logout; # Try to log out, but we don't really care if this fails
5692 # Example code from O'Reilly Perl Cookbook
5699 return wantarray ?
@out : $out[0];
5702 sub clear_screen
() {
5703 if ( $^O
=~ /^mswin/i) {
5710 # checks IMAP mailbox name. Refuses to accept 8bit folders
5711 # returns 0 (folder name is not correct) or 1 (folder name is correct)
5712 sub check_imap_folder
($) {
5713 my $folder_name = shift(@_);
5715 if ($folder_name =~ /[\x80-\xFFFF]/) {
5716 print "Folder name contains 8bit characters. Configuration utility requires\n";
5717 print "UTF7-IMAP encoded folder names.\n";
5718 print "Press enter to continue...";
5721 } elsif ($folder_name =~ /[&\*\%]/) {
5722 # check for ampersand and list-wildcards
5723 print "Folder name contains special UTF7-IMAP characters.\n";
5724 print "Are you sure that folder name is correct? (y/N): ";
5726 $tmp = lc(trim
($tmp));
5727 if ($tmp =~ /^y$/) {
5737 # quotes string written in single quotes
5738 sub quote_single
($) {
5739 my $string = shift(@_);
5740 $string =~ s/\'/\\'/g;
5744 # determine a plugin's version number
5746 # parses the setup.php file, looking for the
5747 # version string in the <plugin>_info() or the
5748 # <plugin>_version functions.
5750 sub get_plugin_version
() {
5752 my $plugin_name = shift(@_);
5754 $setup_file = '../plugins/' . $plugin_name . '/setup.php';
5755 if ( -e
"$setup_file" ) {
5756 # Make sure that file is readable
5757 if (! -r
"$setup_file") {
5760 print "The file \"$setup_file\" was found, but you don't\n";
5761 print "have rights to read it. The plugin \"";
5762 print $plugin_name . "\" may not work correctly until you fix this.\n";
5763 print "\nPress enter to continue";
5770 # FIXME: grep the file instead of reading it into memory?
5772 open( FILE
, "$setup_file" );
5773 while ( $line = <FILE
> ) {
5774 $whole_file .= $line;
5778 # ideally, there is a version in the <plugin>_info function...
5780 if ($whole_file =~ /('version'\s*=>\s*['"](.*?)['"])/) {
5783 # this assumes there is only one function that returns
5784 # a static string in the setup file
5786 } elsif ($whole_file =~ /(return\s*['"](.*?)['"])/) {
5795 print "The file \"$setup_file\" was not found.\n";
5796 print "The plugin \"" . $plugin_name;
5797 print "\" may not work correctly until you fix this.\n";
5798 print "\nPress enter to continue";
5806 # determine a plugin's English name
5808 # parses the setup.php file, looking for the
5809 # English name in the <plugin>_info() function.
5811 sub get_plugin_english_name
() {
5813 my $plugin_name = shift(@_);
5815 $setup_file = '../plugins/' . $plugin_name . '/setup.php';
5816 if ( -e
"$setup_file" ) {
5817 # Make sure that file is readable
5818 if (! -r
"$setup_file") {
5821 print "The file \"$setup_file\" was found, but you don't\n";
5822 print "have rights to read it. The plugin \"";
5823 print $plugin_name . "\" may not work correctly until you fix this.\n";
5824 print "\nPress enter to continue";
5831 # FIXME: grep the file instead of reading it into memory?
5833 open( FILE
, "$setup_file" );
5834 while ( $line = <FILE
> ) {
5835 $whole_file .= $line;
5839 # the English name is in the <plugin>_info function or nothing...
5841 if ($whole_file =~ /('english_name'\s*=>\s*['"](.*?)['"])/) {
5842 $english_name .= $2;
5845 return $english_name;
5850 print "The file \"$setup_file\" was not found.\n";
5851 print "The plugin \"" . $plugin_name;
5852 print "\" may not work correctly until you fix this.\n";
5853 print "\nPress enter to continue";
5861 # parses the setup.php files for all activated plugins and
5862 # builds static plugin hooks array so we don't have to load
5863 # ALL plugins are runtime and build the hook array on every
5866 # hook array is saved in config/plugin_hooks.php
5868 # Note the $verbose variable at the top of this routine
5869 # can be set to zero to quiet it down.
5871 # NOTE/FIXME: we aren't necessarily interested in writing
5872 # a full-blown PHP parsing engine, so plenty
5873 # of assumptions are included herein about the
5874 # coding of the plugin setup files, and things
5875 # like commented out curly braces or other
5876 # such oddities can break this in a bad way.
5878 sub build_plugin_hook_array
() {
5886 if ( open( HOOKFILE
, ">plugin_hooks.php" ) ) {
5887 print HOOKFILE
"<?php\n";
5888 print HOOKFILE
"\n";
5890 print HOOKFILE
"/**\n";
5891 print HOOKFILE
" * SquirrelMail Plugin Hook Registration File\n";
5892 print HOOKFILE
" * Auto-generated using the configure script, conf.pl\n";
5893 print HOOKFILE
" */\n";
5894 print HOOKFILE
"\n";
5895 print HOOKFILE
"global \$squirrelmail_plugin_hooks;\n";
5896 print HOOKFILE
"\n";
5898 PLUGIN
: for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
5901 print "Activating plugin \"" . $plugins[$ct] . "\"...\n";
5904 $setup_file = '../plugins/' . $plugins[$ct] . '/setup.php';
5905 if ( -e
"$setup_file" ) {
5906 # Make sure that file is readable
5907 if (! -r
"$setup_file") {
5910 print "The file \"$setup_file\" was found, but you don't\n";
5911 print "have rights to read it. The plugin \"";
5912 print $plugins[$ct] . "\" will not be activated until you fix this.\n";
5913 print "\nPress enter to continue";
5918 open( FILE
, "$setup_file" );
5919 $inside_init_fxn = 0;
5921 while ( $line = <FILE
> ) {
5923 # throw away lines until we get to target function
5925 if (!$inside_init_fxn
5926 && $line !~ /^\s*function\s*squirrelmail_plugin_init_/i) {
5929 $inside_init_fxn = 1;
5939 # count close braces
5944 # leaving <plugin>_init() function...
5945 if ($brace_count == 0) {
5953 # throw away lines that are not exactly one "brace set" deep
5955 if ($brace_count > 1) {
5960 # also not interested in lines that are not
5961 # hook registration points
5963 if ($line !~ /^\s*\$squirrelmail_plugin_hooks/i) {
5968 # if $line does not have an ending semicolon,
5969 # we need to recursively read in subsequent
5970 # lines until we find one
5971 while ( $line !~ /;\s*$/ ) {
5972 $line =~ s/[\n\r]\s*$//;
5981 $var =~ s/=/EQUALS/;
5982 if ( $var =~ /^([a-z])/i ) {
5983 @options = split ( /\s*EQUALS\s*/, $var );
5984 $options[1] =~ s/[\n\r]//g;
5985 $options[1] =~ s/[\'\"];\s*$//;
5986 $options[1] =~ s/;$//;
5987 $options[1] =~ s/^[\'\"]//;
5988 # de-escape escaped strings
5989 $options[1] =~ s/\\'/'/g;
5990 $options[1] =~ s/\\\\/\\/g;
5992 if ( $options[0] =~ /^squirrelmail_plugin_hooks\s*\[\s*['"]([a-z0-9 \/._
*-]+)['"]\s*\]\s*\[\s*['"]([0-9a-z._-]+)['"]\s
*\
]/i
) {
5994 $hooked_plugin_name = $2;
5995 # Note: if we wanted to stop plugins from registering
5996 # a *different* plugin on a hook, we could catch
5997 # it here, however this has actually proven to be
5998 # a useful *feature*
5999 #if ($hooked_plugin_name ne $plugins[$ct]) {
6000 # print "...plugin is tring to hook in under different name...\n";
6003 #FIXME: do we want to count the number of hook registrations for each plugin and warn if a plugin doesn't have any?
6004 # hook registration has been found!
6006 if ($hooked_plugin_name ne $plugins[$ct]) {
6007 print " registering on hook \"" . $hook_name . "\" (as \"$hooked_plugin_name\" plugin)\n";
6009 print " registering on hook \"" . $hook_name . "\"\n";
6012 $line =~ s/ {2,}/ /g;
6014 print HOOKFILE
"\$$line";
6026 print "The file \"$setup_file\" was not found.\n";
6027 print "The plugin \"" . $plugins[$ct];
6028 print "\" will not be activated until you fix this.\n";
6029 print "\nPress enter to continue";
6037 print HOOKFILE
"\n\n";
6040 print "\nDone activating plugins; registration data saved in plugin_hooks.php\n\n";
6047 print "The file \"plugin_hooks.php\" was not able to be written to.\n";
6048 print "No plugins will be activated until you fix this.\n";
6049 print "\nPress enter to continue";
6057 # converts (binary) integer values that correspond
6058 # to the SquirrelMail debug mode constants (see
6059 # include/constants.php) into those constant strings
6060 # (bitwise or'd if more than one is enabled)
6062 # if the value passed in is not an integer, it is
6063 # returned unmolested
6065 sub convert_debug_binary_integer_to_constants
() {
6067 my ($debug_mode) = @_;
6068 if ($debug_mode =~ /^[^0-9]/) {
6071 $debug_mode = int($debug_mode);
6072 $new_debug_mode = '';
6074 # per include/constants.php, here are their values:
6076 # 0 SM_DEBUG_MODE_OFF
6077 # 1 SM_DEBUG_MODE_SIMPLE
6078 # 512 SM_DEBUG_MODE_MODERATE
6079 # 524288 SM_DEBUG_MODE_ADVANCED
6080 # 536870912 SM_DEBUG_MODE_STRICT
6082 if ($debug_mode & 1) {
6083 $new_debug_mode .= ' | SM_DEBUG_MODE_SIMPLE';
6085 if ($debug_mode & 512) {
6086 $new_debug_mode .= ' | SM_DEBUG_MODE_MODERATE';
6088 if ($debug_mode & 524288) {
6089 $new_debug_mode .= ' | SM_DEBUG_MODE_ADVANCED';
6091 if ($debug_mode & 536870912) {
6092 $new_debug_mode .= ' | SM_DEBUG_MODE_STRICT';
6095 $new_debug_mode =~ s/^ \| //;
6096 if (!$new_debug_mode) {
6097 $new_debug_mode = 'SM_DEBUG_MODE_OFF';
6100 return $new_debug_mode;
6103 # converts SquirrelMail debug mode constants (see
6104 # include/constants.php) into their corresponding
6105 # (binary) integer values
6107 # if the value passed in is an integer already, it
6108 # is returned unmolested
6110 sub convert_debug_constants_to_binary_integer
() {
6112 my ($debug_mode) = @_;
6113 if ($debug_mode =~ /^[0-9]/) {
6116 $new_debug_mode = 0;
6118 # per include/constants.php, here are their values:
6120 # 0 SM_DEBUG_MODE_OFF
6121 # 1 SM_DEBUG_MODE_SIMPLE
6122 # 512 SM_DEBUG_MODE_MODERATE
6123 # 524288 SM_DEBUG_MODE_ADVANCED
6124 # 536870912 SM_DEBUG_MODE_STRICT
6126 if ($debug_mode =~ /\bSM_DEBUG_MODE_OFF\b/) {
6127 $new_debug_mode = 0;
6129 if ($debug_mode =~ /\bSM_DEBUG_MODE_SIMPLE\b/) {
6130 $new_debug_mode |= 1;
6132 if ($debug_mode =~ /\bSM_DEBUG_MODE_MODERATE\b/) {
6133 $new_debug_mode |= 512;
6135 if ($debug_mode =~ /\bSM_DEBUG_MODE_ADVANCED\b/) {
6136 $new_debug_mode |= 524288;
6138 if ($debug_mode =~ /\bSM_DEBUG_MODE_STRICT\b/) {
6139 $new_debug_mode |= 536870912;
6142 return $new_debug_mode;
6145 # Function to print n column numbered lists
6147 # WARNING: the names in the list will be truncated
6148 # to fit in their respective columns based on the
6149 # screen width and number of columns.
6151 # Expected arguments (in this order):
6153 # * The start number to use for the list
6154 # * The number of columns to use
6155 # * The screen width
6156 # * Boolean (zero/one), indicating
6157 # whether or not to show item numbers
6158 # * The list of strings to be shown
6160 # Returns: The number printed on screen of the last item in the list
6162 sub print_multi_col_list
{
6163 my ($num, $cols, $screen_width, $show_numbering, @list) = @_;
6173 $rows = int(@list / $cols);
6174 if (@list % $cols) { $rows++; }
6175 if ($show_numbering) { $col_width = int(($screen_width - 2) / $cols) - 5; }
6176 else { $col_width = int(($screen_width - 2) / $cols) - 2; }
6178 # build the layout array so numbers run down each column
6180 for ( $x = 0; $x < @list; $x++ ) {
6182 $layout[$row_cnt][$col_cnt] = $list[$x];
6183 $numbers[$row_cnt][$col_cnt] = $num++;
6185 # move to next column
6187 if ($row_cnt == $rows - 1) {
6191 else { $row_cnt++; }
6195 # if we filled up fewer rows than needed, recalc column width
6197 if ($rows * $col_cnt == @list) { $col_cnt--; } # loop above ended right after increment
6198 if ($col_cnt + 1 < $cols) {
6199 if ($show_numbering) { $col_width = int(($screen_width - 2) / ($col_cnt + 1)) - 5; }
6200 else { $col_width = int(($screen_width - 2) / ($col_cnt + 1)) - 2; }
6206 for ( $row_cnt = 0; $row_cnt <= $rows; $row_cnt++ ) {
6212 # iterate columns for this row
6214 for ( $col_cnt = 0; $col_cnt <= $cols; $col_cnt++ ) {
6215 if ($layout[$row_cnt][$col_cnt]) {
6217 if ($show_numbering) { printf "$WHT% 2u.$NRM", $numbers[$row_cnt][$col_cnt]; }
6218 printf " %-$col_width." . $col_width . "s", $layout[$row_cnt][$col_cnt];