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 );
499 if ( $ARGV[0] eq '--install-plugin' ) {
500 print "Activating plugin " . $ARGV[1] . "\n";
501 if ( -d
"../plugins/" . $ARGV[1]) {
502 push @plugins, $ARGV[1];
506 print "No such plugin.\n";
509 } elsif ( $ARGV[0] eq '--remove-plugin' ) {
510 print "Removing plugin " . $ARGV[1] . "\n";
511 foreach $plugin (@plugins) {
512 if ( $plugin ne $ARGV[1] ) {
513 push @newplugins, $plugin;
516 @plugins = @newplugins;
519 } elsif ( $ARGV[0] eq '--update-plugins' or $ARGV[0] eq '-u') {
520 build_plugin_hook_array
();
522 } elsif ( $ARGV[0] eq '--help' or $ARGV[0] eq '-h') {
523 print "SquirrelMail Configuration Script\n";
525 print " * No arguments: initiates the configuration dialog\n";
526 print " * --install-plugin <plugin> : activates the specified plugin\n";
527 print " * --remove-plugin <plugin> : deactivates the specified plugin\n";
528 print " * --update-plugins , -u : rebuilds plugin_hooks.php according\n";
529 print " to plugins activated in config.php\n";
530 print " * --help , -h : Displays this help\n";
537 ####################################################################################
539 # used in multiple places, define once
540 $list_supported_imap_servers =
541 " bincimap = Binc IMAP server\n" .
542 " courier = Courier IMAP server\n" .
543 " cyrus = Cyrus IMAP server\n" .
544 " dovecot = Dovecot Secure IMAP server\n" .
545 " exchange = Microsoft Exchange IMAP server\n" .
546 " hmailserver = hMailServer\n" .
547 " macosx = Mac OS X Mailserver\n" .
548 " mercury32 = Mercury/32\n" .
549 " uw = University of Washington's IMAP server\n" .
550 " gmail = IMAP access to Google mail (Gmail) accounts\n";
552 #####################################################################################
553 if ( $config_use_color == 1 ) {
559 $config_use_color = 2;
562 # lists can be printed in more than one column; default is just one
566 # try to get screen width dynamically if possible; default to 80
567 # (user can override with "w#" command)
569 eval { require "sys/ioctl.ph" };
571 || !defined &TIOCGWINSZ
572 || !open(TTY
, "+</dev/tty")
573 || !ioctl(TTY
, &TIOCGWINSZ
, $winsize='')) {
576 ($row, $col, $xpixel, $ypixel) = unpack('S4', $winsize);
577 $screen_width = $col;
580 while ( ( $command ne "q" ) && ( $command ne "Q" ) && ( $command ne ":q" ) ) {
582 print $WHT. "SquirrelMail Configuration : " . $NRM;
583 if ( $config == 1 ) { print "Read: config.php"; }
584 elsif ( $config == 2 ) { print "Read: config_default.php"; }
585 print " ($print_config_version)\n";
586 print "---------------------------------------------------------\n";
589 print $WHT. "Main Menu --\n" . $NRM;
590 print "1. Organization Preferences\n";
591 print "2. Server Settings\n";
592 print "3. Folder Defaults\n";
593 print "4. General Options\n";
594 print "5. User Interface\n";
595 print "6. Address Books\n";
596 print "7. Message of the Day (MOTD)\n";
597 print "8. Plugins\n";
598 print "9. Database\n";
599 print "10. Language settings\n";
600 print "11. Tweaks\n";
602 print "D. Set pre-defined settings for specific IMAP servers\n";
604 } elsif ( $menu == 1 ) {
605 print $WHT. "Organization Preferences\n" . $NRM;
606 print "1. Organization Name : $WHT$org_name$NRM\n";
607 print "2. Organization Logo : $WHT$org_logo$NRM\n";
608 print "3. Org. Logo Width/Height : $WHT($org_logo_width/$org_logo_height)$NRM\n";
609 print "4. Organization Title : $WHT$org_title$NRM\n";
610 print "5. Signout Page : $WHT$signout_page$NRM\n";
611 print "6. Top Frame : $WHT$frame_top$NRM\n";
612 print "7. Provider link : $WHT$provider_uri$NRM\n";
613 print "8. Provider link text : $WHT$provider_name$NRM\n";
616 print "R Return to Main Menu\n";
617 } elsif ( $menu == 2 ) {
618 print $WHT. "Server Settings\n\n" . $NRM;
619 print $WHT . "General" . $NRM . "\n";
621 print "1. Domain : $WHT$domain$NRM\n";
622 print "2. Invert Time : $WHT$invert_time$NRM\n";
623 print "3. Sendmail or SMTP : $WHT";
624 if ( lc($useSendmail) eq 'true' ) {
632 if ( $show_imap_settings ) {
633 print $WHT . "IMAP Settings". $NRM . "\n--------------\n";
634 print "4. IMAP Server : $WHT$imapServerAddress$NRM\n";
635 print "5. IMAP Port : $WHT$imapPort$NRM\n";
636 print "6. Authentication type : $WHT$imap_auth_mech$NRM\n";
637 print "7. Secure IMAP (TLS) : $WHT" . display_use_tls
($use_imap_tls) . "$NRM\n";
638 print "8. Server software : $WHT$imap_server_type$NRM\n";
639 print "9. Delimiter : $WHT$optional_delimiter$NRM\n";
641 } elsif ( $show_smtp_settings ) {
642 if ( lc($useSendmail) eq 'true' ) {
643 print $WHT . "Sendmail" . $NRM . "\n--------\n";
644 print "4. Sendmail Path : $WHT$sendmail_path$NRM\n";
645 print "5. Sendmail arguments : $WHT$sendmail_args$NRM\n";
646 print "6. Header encryption key : $WHT$encode_header_key$NRM\n";
649 print $WHT . "SMTP Settings" . $NRM . "\n-------------\n";
650 print "4. SMTP Server : $WHT$smtpServerAddress$NRM\n";
651 print "5. SMTP Port : $WHT$smtpPort$NRM\n";
652 print "6. POP before SMTP : $WHT$pop_before_smtp$NRM\n";
653 print "7. SMTP Authentication : $WHT$smtp_auth_mech" . display_smtp_sitewide_userpass
() ."$NRM\n";
654 print "8. Secure SMTP (TLS) : $WHT" . display_use_tls
($use_smtp_tls) . "$NRM\n";
655 print "9. Header encryption key : $WHT$encode_header_key$NRM\n";
660 if ($show_imap_settings == 0) {
661 print "A. Update IMAP Settings : ";
662 print "$WHT$imapServerAddress$NRM:";
663 print "$WHT$imapPort$NRM ";
664 print "($WHT$imap_server_type$NRM)\n";
666 if ($show_smtp_settings == 0) {
667 if ( lc($useSendmail) eq 'true' ) {
668 print "B. Change Sendmail Config : $WHT$sendmail_path$NRM\n";
670 print "B. Update SMTP Settings : ";
671 print "$WHT$smtpServerAddress$NRM:";
672 print "$WHT$smtpPort$NRM\n";
675 if ( $show_smtp_settings || $show_imap_settings )
678 ($show_imap_settings ?
"IMAP Server" :
679 (lc($useSendmail) eq 'true') ?
"Sendmail" : "SMTP") . " Settings\n";
683 print "R Return to Main Menu\n";
684 } elsif ( $menu == 3 ) {
685 print $WHT. "Folder Defaults\n" . $NRM;
686 print "1. Default Folder Prefix : $WHT$default_folder_prefix$NRM\n";
687 print "2. Show Folder Prefix Option : $WHT$show_prefix_option$NRM\n";
688 print "3. Trash Folder : $WHT$trash_folder$NRM\n";
689 print "4. Sent Folder : $WHT$sent_folder$NRM\n";
690 print "5. Drafts Folder : $WHT$draft_folder$NRM\n";
691 print "6. By default, move to trash : $WHT$default_move_to_trash$NRM\n";
692 print "7. By default, save sent messages : $WHT$default_move_to_sent$NRM\n";
693 print "8. By default, save as draft : $WHT$default_save_as_draft$NRM\n";
694 print "9. List Special Folders First : $WHT$list_special_folders_first$NRM\n";
695 print "10. Show Special Folders Color : $WHT$use_special_folder_color$NRM\n";
696 print "11. Auto Expunge : $WHT$auto_expunge$NRM\n";
697 print "12. Default Sub. of INBOX : $WHT$default_sub_of_inbox$NRM\n";
698 print "13. Show 'Contain Sub.' Option : $WHT$show_contain_subfolders_option$NRM\n";
699 print "14. Default Unseen Notify : $WHT$default_unseen_notify$NRM\n";
700 print "15. Default Unseen Type : $WHT$default_unseen_type$NRM\n";
701 print "16. Auto Create Special Folders : $WHT$auto_create_special$NRM\n";
702 print "17. Folder Delete Bypasses Trash : $WHT$delete_folder$NRM\n";
703 print "18. Enable /NoSelect folder fix : $WHT$noselect_fix_enable$NRM\n";
705 print "R Return to Main Menu\n";
706 } elsif ( $menu == 4 ) {
707 print $WHT. "General Options\n" . $NRM;
708 print "1. Data Directory : $WHT$data_dir$NRM\n";
709 print "2. Attachment Directory : $WHT$attachment_dir$NRM\n";
710 print "3. Directory Hash Level : $WHT$dir_hash_level$NRM\n";
711 print "4. Default Left Size : $WHT$default_left_size$NRM\n";
712 print "5. Usernames in Lowercase : $WHT$force_username_lowercase$NRM\n";
713 print "6. Allow use of priority : $WHT$default_use_priority$NRM\n";
714 print "7. Hide SM attributions : $WHT$hide_sm_attributions$NRM\n";
715 print "8. Allow use of receipts : $WHT$default_use_mdn$NRM\n";
716 print "9. Allow editing of identity : $WHT$edit_identity$NRM\n";
717 print " Allow editing of name : $WHT$edit_name$NRM\n";
718 print " Remove username from header : $WHT$hide_auth_header$NRM\n";
719 print "10. Disable server thread sort : $WHT$disable_thread_sort$NRM\n";
720 print "11. Disable server-side sorting : $WHT$disable_server_sort$NRM\n";
721 print "12. Allow server charset search : $WHT$allow_charset_search$NRM\n";
722 print "13. Allow advanced search : $WHT$allow_advanced_search$NRM\n";
723 print "14. PHP session name : $WHT$session_name$NRM\n";
724 print "15. Time zone configuration : $WHT$time_zone_type$NRM\n";
725 print "16. Location base : $WHT$config_location_base$NRM\n";
726 print "17. Only secure cookies if poss. : $WHT$only_secure_cookies$NRM\n";
727 print "18. Disable secure forms : $WHT$disable_security_tokens$NRM\n";
728 print "19. Page referal requirement : $WHT$check_referrer$NRM\n";
729 print "20. Security image : $WHT" . (lc($use_transparent_security_image) eq 'true' ?
'Transparent' : 'Textual') . "$NRM\n";
731 print "R Return to Main Menu\n";
732 } elsif ( $menu == 5 ) {
733 print $WHT. "User Interface\n" . $NRM;
734 print "1. Use Icons? : $WHT$use_icons$NRM\n";
735 # print "3. Default Icon Set : $WHT$icon_theme_def$NRM\n";
736 print "2. Default font size : $WHT$default_fontsize$NRM\n";
737 print "3. Manage template sets (skins)\n";
738 print "4. Manage user themes\n";
739 print "5. Manage font sets\n";
740 print "6. Manage icon themes\n";
743 print "R Return to Main Menu\n";
744 } elsif ( $menu == 6 ) {
745 print $WHT. "Address Books\n" . $NRM;
746 print "1. Change LDAP Servers\n";
747 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
748 print " > $ldap_host[$count]\n";
750 print "2. Use Javascript address book search : $WHT$default_use_javascript_addr_book$NRM\n";
751 print "3. Global address book file : $WHT$abook_global_file$NRM\n";
752 print "4. Allow writing into global file address book : $WHT$abook_global_file_writeable$NRM\n";
753 print "5. Allow listing of global file address book : $WHT$abook_global_file_listing$NRM\n";
754 print "6. Allowed address book line length : $WHT$abook_file_line_length$NRM\n";
756 print "R Return to Main Menu\n";
757 } elsif ( $menu == 7 ) {
758 print $WHT. "Message of the Day (MOTD)\n" . $NRM;
761 print "1 Edit the MOTD\n";
763 print "R Return to Main Menu\n";
764 } elsif ( $menu == 8 ) {
765 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
766 print $WHT. "Plugins (WARNING: All plugins are currently disabled\n for the user \"$disable_plugins_user\"!)\n" . $NRM;
767 } elsif (lc($disable_plugins) eq 'true') {
768 print $WHT. "Plugins (WARNING: All plugins are currently disabled!)\n" . $NRM;
770 print $WHT. "Plugins\n" . $NRM;
772 print " Installed Plugins\n";
774 $num = print_multi_col_list
(1, $columns, $screen_width, 1, @plugins);
777 for ( $count = 0 ; $count <= $#plugins ; $count++ ) {
779 $english_name = get_plugin_english_name
($plugins[$count]);
780 if ( $english_name eq "" ) {
781 print " $WHT$num.$NRM $plugins[$count]" . get_plugin_version
($plugins[$count]) . "\n";
783 print " $WHT$num.$NRM $english_name ($plugins[$count])" . get_plugin_version
($plugins[$count]) . "\n";
787 print "\n Available Plugins:\n";
788 opendir( DIR
, "../plugins" );
789 @files = sort(readdir(DIR
));
791 @unused_plugins = ();
792 for ( $i = 0 ; $i <= $#files ; $i++ ) {
793 if ( -d
"../plugins/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne ".svn" ) {
795 for ( $k = 0 ; $k <= $#plugins ; $k++ ) {
796 if ( $plugins[$k] eq $files[$i] ) {
801 $unused_plugins[$pos] = $files[$i];
808 $num = print_multi_col_list
($num + 1, $columns, $screen_width, 1, @unused_plugins);
810 for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
812 $english_name = get_plugin_english_name
($unused_plugins[$i]);
813 if ( $english_name eq "" ) {
814 print " $WHT$num.$NRM $unused_plugins[$i]" . get_plugin_version
($unused_plugins[$i]) . "\n";
816 print " $WHT$num.$NRM $english_name ($unused_plugins[$i])" . get_plugin_version
($unused_plugins[$i]) . "\n";
823 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
824 print "E Enable active plugins (all plugins currently\n disabled for the user \"$disable_plugins_user\")\n";
825 } elsif (lc($disable_plugins) eq 'true') {
826 print "E Enable active plugins (all plugins currently\n disabled)\n";
828 print "D Disable all plugins\n";
830 print "U Set the user for whom plugins can be disabled\n";
831 print "R Return to Main Menu\n";
832 print "C# List plugins in <#> number of columns\n";
833 print "W# Change screen width to <#> (currently $screen_width)\n";
834 } elsif ( $menu == 9 ) {
835 print $WHT. "Database\n" . $NRM;
836 print "1. DSN for Address Book : $WHT$addrbook_dsn$NRM\n";
837 print "2. Table for Address Book : $WHT$addrbook_table$NRM\n";
839 print "3. DSN for Preferences : $WHT$prefs_dsn$NRM\n";
840 print "4. Table for Preferences : $WHT$prefs_table$NRM\n";
841 print "5. Field for username : $WHT$prefs_user_field$NRM ($prefs_user_size)\n";
842 print "6. Field for prefs key : $WHT$prefs_key_field$NRM ($prefs_key_size)\n";
843 print "7. Field for prefs value : $WHT$prefs_val_field$NRM ($prefs_val_size)\n";
845 print "8. DSN for Global Address Book : $WHT$addrbook_global_dsn$NRM\n";
846 print "9. Table for Global Address Book : $WHT$addrbook_global_table$NRM\n";
847 print "10. Allow writing into Global Address Book : $WHT$addrbook_global_writeable$NRM\n";
848 print "11. Allow listing of Global Address Book : $WHT$addrbook_global_listing$NRM\n";
850 print "R Return to Main Menu\n";
851 } elsif ( $menu == 10 ) {
852 print $WHT. "Language settings\n" . $NRM;
853 print "1. Default Language : $WHT$squirrelmail_default_language$NRM\n";
854 print "2. Default Charset : $WHT$default_charset$NRM\n";
855 print "3. Show alternative language names : $WHT$show_alternative_names$NRM\n";
856 print "4. Enable aggressive decoding : $WHT$aggressive_decoding$NRM\n";
857 print "5. Enable lossy encoding : $WHT$lossy_encoding$NRM\n";
859 print "R Return to Main Menu\n";
860 } elsif ( $menu == 11 ) {
861 print $WHT. "Interface tweaks\n" . $NRM;
862 print "1. Display html mails in iframe : $WHT$use_iframe$NRM\n";
863 print "2. Ask user info on first login : $WHT$ask_user_info$NRM\n";
865 print $WHT. "PHP tweaks\n" . $NRM;
866 print "4. Use php recode functions : $WHT$use_php_recode$NRM\n";
867 print "5. Use php iconv functions : $WHT$use_php_iconv$NRM\n";
868 print "6. Buffer all output : $WHT$buffer_output$NRM\n";
870 print $WHT. "Configuration tweaks\n" . $NRM;
871 print "7. Allow remote configtest : $WHT$allow_remote_configtest$NRM\n";
872 print "8. Debug mode : $WHT$sm_debug_mode$NRM\n";
873 print "9. Secured configuration mode : $WHT$secured_config$NRM\n";
874 print "10. HTTPS port : $WHT$sq_https_port$NRM\n";
875 print "11. Ignore HTTP_X_FORWARDED headers: $WHT$sq_ignore_http_x_forwarded_headers$NRM\n";
877 print "R Return to Main Menu\n";
879 if ( $config_use_color == 1 ) {
880 print "C Turn color off\n";
882 print "C Turn color on\n";
884 print "S Save data\n";
888 print "Command >> " . $WHT;
890 $command =~ s/[\n\r]//g;
891 $command =~ tr/A-Z/a-z/;
894 # Read the commands they entered.
895 if ( $command eq "r" ) {
897 } elsif ( $command eq "s" ) {
899 print "Press enter to continue...";
902 } elsif ( ( $command eq "q" ) && ( $saved == 0 ) ) {
903 print "You have not saved your data.\n";
904 print "Save? [" . $WHT . "Y" . $NRM . "/n]: ";
906 if ( ( $save =~ /^y/i ) || ( $save =~ /^\s*$/ ) ) {
909 } elsif ( $command eq "c" ) {
910 if ( $config_use_color == 1 ) {
911 $config_use_color = 2;
915 $config_use_color = 1;
919 } elsif ( $command =~ /^w([0-9]+)/ ) {
921 } elsif ( $command eq "d" && $menu == 0 ) {
926 if ( ( $command > 0 ) && ( $command < 12 ) ) {
929 } elsif ( $menu == 1 ) {
930 if ( $command == 1 ) { $org_name = command1
(); }
931 elsif ( $command == 2 ) { $org_logo = command2
(); }
932 elsif ( $command == 3 ) { ($org_logo_width,$org_logo_height) = command2a
(); }
933 elsif ( $command == 4 ) { $org_title = command3
(); }
934 elsif ( $command == 5 ) { $signout_page = command4
(); }
935 elsif ( $command == 6 ) { $frame_top = command6
(); }
936 elsif ( $command == 7 ) { $provider_uri = command7
(); }
937 elsif ( $command == 8 ) { $provider_name = command8
(); }
939 } elsif ( $menu == 2 ) {
940 if ( $command eq "a" ) { $show_imap_settings = 1; $show_smtp_settings = 0; }
941 elsif ( $command eq "b" ) { $show_imap_settings = 0; $show_smtp_settings = 1; }
942 elsif ( $command eq "h" ) { $show_imap_settings = 0; $show_smtp_settings = 0; }
943 elsif ( $command <= 3 ) {
944 if ( $command == 1 ) { $domain = command11
(); }
945 elsif ( $command == 2 ) { $invert_time = command110
(); }
946 elsif ( $command == 3 ) { $useSendmail = command14
(); }
947 $show_imap_settings = 0; $show_smtp_settings = 0;
948 } elsif ( $show_imap_settings ) {
949 if ( $command == 4 ) { $imapServerAddress = command12
(); }
950 elsif ( $command == 5 ) { $imapPort = command13
(); }
951 elsif ( $command == 6 ) { $imap_auth_mech = command112a
(); }
952 elsif ( $command == 7 ) { $use_imap_tls = command_use_tls
("IMAP",$use_imap_tls); }
953 elsif ( $command == 8 ) { $imap_server_type = command19
(); }
954 elsif ( $command == 9 ) { $optional_delimiter = command111
(); }
955 } elsif ( $show_smtp_settings && lc($useSendmail) eq 'true' ) {
956 if ( $command == 4 ) { $sendmail_path = command15
(); }
957 elsif ( $command == 5 ) { $sendmail_args = command_sendmail_args
(); }
958 elsif ( $command == 6 ) { $encode_header_key = command114
(); }
959 } elsif ( $show_smtp_settings ) {
960 if ( $command == 4 ) { $smtpServerAddress = command16
(); }
961 elsif ( $command == 5 ) { $smtpPort = command17
(); }
962 elsif ( $command == 6 ) { $pop_before_smtp = command18a
(); }
963 elsif ( $command == 7 ) { $smtp_auth_mech = command112b
(); }
964 elsif ( $command == 8 ) { $use_smtp_tls = command_use_tls
("SMTP",$use_smtp_tls); }
965 elsif ( $command == 9 ) { $encode_header_key = command114
(); }
967 } elsif ( $menu == 3 ) {
968 if ( $command == 1 ) { $default_folder_prefix = command21
(); }
969 elsif ( $command == 2 ) { $show_prefix_option = command22
(); }
970 elsif ( $command == 3 ) { $trash_folder = command23a
(); }
971 elsif ( $command == 4 ) { $sent_folder = command23b
(); }
972 elsif ( $command == 5 ) { $draft_folder = command23c
(); }
973 elsif ( $command == 6 ) { $default_move_to_trash = command24a
(); }
974 elsif ( $command == 7 ) { $default_move_to_sent = command24b
(); }
975 elsif ( $command == 8 ) { $default_save_as_draft = command24c
(); }
976 elsif ( $command == 9 ) { $list_special_folders_first = command27
(); }
977 elsif ( $command == 10 ) { $use_special_folder_color = command28
(); }
978 elsif ( $command == 11 ) { $auto_expunge = command29
(); }
979 elsif ( $command == 12 ) { $default_sub_of_inbox = command210
(); }
980 elsif ( $command == 13 ) { $show_contain_subfolders_option = command211
(); }
981 elsif ( $command == 14 ) { $default_unseen_notify = command212
(); }
982 elsif ( $command == 15 ) { $default_unseen_type = command213
(); }
983 elsif ( $command == 16 ) { $auto_create_special = command214
(); }
984 elsif ( $command == 17 ) { $delete_folder = command215
(); }
985 elsif ( $command == 18 ) { $noselect_fix_enable = command216
(); }
986 } elsif ( $menu == 4 ) {
987 if ( $command == 1 ) { $data_dir = command33a
(); }
988 elsif ( $command == 2 ) { $attachment_dir = command33b
(); }
989 elsif ( $command == 3 ) { $dir_hash_level = command33c
(); }
990 elsif ( $command == 4 ) { $default_left_size = command35
(); }
991 elsif ( $command == 5 ) { $force_username_lowercase = command36
(); }
992 elsif ( $command == 6 ) { $default_use_priority = command37
(); }
993 elsif ( $command == 7 ) { $hide_sm_attributions = command38
(); }
994 elsif ( $command == 8 ) { $default_use_mdn = command39
(); }
995 elsif ( $command == 9 ) { $edit_identity = command310
(); }
996 elsif ( $command == 10 ) { $disable_thread_sort = command312
(); }
997 elsif ( $command == 11 ) { $disable_server_sort = command313
(); }
998 elsif ( $command == 12 ) { $allow_charset_search = command314
(); }
999 elsif ( $command == 13 ) { $allow_advanced_search = command316
(); }
1000 elsif ( $command == 14 ) { $session_name = command317
(); }
1001 elsif ( $command == 15 ) { $time_zone_type = command318
(); }
1002 elsif ( $command == 16 ) { $config_location_base = command_config_location_base
(); }
1003 elsif ( $command == 17 ) { $only_secure_cookies = command319
(); }
1004 elsif ( $command == 18 ) { $disable_security_tokens = command320
(); }
1005 elsif ( $command == 19 ) { $check_referrer = command321
(); }
1006 elsif ( $command == 20 ) { $use_transparent_security_image = command322
(); }
1007 } elsif ( $menu == 5 ) {
1008 if ( $command == 1 ) { $use_icons = commandB3
(); }
1009 # elsif ( $command == 3 ) { $icon_theme_def = command53(); }
1010 elsif ( $command == 2 ) { $default_fontsize = command_default_fontsize
(); }
1011 elsif ( $command == 3 ) { $templateset_default = command_templates
(); }
1012 elsif ( $command == 4 ) { command_userThemes
(); }
1013 elsif ( $command == 5 ) { command_fontsets
(); }
1014 elsif ( $command == 6 ) { command_iconSets
(); }
1015 } elsif ( $menu == 6 ) {
1016 if ( $command == 1 ) { command61
(); }
1017 elsif ( $command == 2 ) { command62
(); }
1018 elsif ( $command == 3 ) { $abook_global_file=command63
(); }
1019 elsif ( $command == 4 ) { command64
(); }
1020 elsif ( $command == 5 ) { command65
(); }
1021 elsif ( $command == 6 ) { command_abook_file_line_length
(); }
1022 } elsif ( $menu == 7 ) {
1023 if ( $command == 1 ) { $motd = command71
(); }
1024 } elsif ( $menu == 8 ) {
1025 if ( $command =~ /^[0-9]+/ ) { @plugins = command81
(); }
1026 elsif ( $command eq "u" ) { $disable_plugins_user = command82
(); }
1027 elsif ( $command eq "d" ) { $disable_plugins = 'true'; }
1028 elsif ( $command eq "e" ) { $disable_plugins = 'false'; }
1029 elsif ( $command =~ /^c([0-9]+)/ ) { $columns = $1; }
1030 } elsif ( $menu == 9 ) {
1031 if ( $command == 1 ) { $addrbook_dsn = command91
(); }
1032 elsif ( $command == 2 ) { $addrbook_table = command92
(); }
1033 elsif ( $command == 3 ) { $prefs_dsn = command93
(); }
1034 elsif ( $command == 4 ) { $prefs_table = command94
(); }
1035 elsif ( $command == 5 ) { $prefs_user_field = command95
(); }
1036 elsif ( $command == 6 ) { $prefs_key_field = command96
(); }
1037 elsif ( $command == 7 ) { $prefs_val_field = command97
(); }
1038 elsif ( $command == 8 ) { $addrbook_global_dsn = command98
(); }
1039 elsif ( $command == 9 ) { $addrbook_global_table = command99
(); }
1040 elsif ( $command == 10 ) { $addrbook_global_writeable = command910
(); }
1041 elsif ( $command == 11 ) { $addrbook_global_listing = command911
(); }
1042 } elsif ( $menu == 10 ) {
1043 if ( $command == 1 ) { $squirrelmail_default_language = commandA1
(); }
1044 elsif ( $command == 2 ) { $default_charset = commandA2
(); }
1045 elsif ( $command == 3 ) { $show_alternative_names = commandA3
(); }
1046 elsif ( $command == 4 ) { $aggressive_decoding = commandA4
(); }
1047 elsif ( $command == 5 ) { $lossy_encoding = commandA5
(); }
1048 } elsif ( $menu == 11 ) {
1049 if ( $command == 1 ) { $use_iframe = commandB2
(); }
1050 elsif ( $command == 2 ) { $ask_user_info = command_ask_user_info
(); }
1051 elsif ( $command == 4 ) { $use_php_recode = commandB4
(); }
1052 elsif ( $command == 5 ) { $use_php_iconv = commandB5
(); }
1053 elsif ( $command == 6 ) { $buffer_output = commandB6
(); }
1054 elsif ( $command == 7 ) { $allow_remote_configtest = commandB7
(); }
1055 elsif ( $command == 8 ) { $sm_debug_mode = commandB8
(); }
1056 elsif ( $command == 9 ) { $secured_config = commandB9
(); }
1057 elsif ( $command == 10 ) { $sq_https_port = commandB10
(); }
1058 elsif ( $command == 11 ) { $sq_ignore_http_x_forwarded_headers = commandB11
(); }
1064 print "\nExiting conf.pl.\n".
1065 "You might want to test your configuration by browsing to\n".
1066 "http://your-squirrelmail-location/src/configtest.php\n".
1067 "Happy SquirrelMailing!\n\n";
1070 ####################################################################################
1074 print "We have tried to make the name SquirrelMail as transparent as\n";
1075 print "possible. If you set up an organization name, most places where\n";
1076 print "SquirrelMail would take credit will be credited to your organization.\n";
1078 print "If your Organization Name includes a '\$', please precede it with a \\. \n";
1079 print "Other '\$' will be considered the beginning of a variable that\n";
1080 print "must be defined before the \$org_name is printed.\n";
1082 print "[$WHT$org_name$NRM]: $WHT";
1083 $new_org_name = <STDIN
>;
1084 if ( $new_org_name eq "\n" ) {
1085 $new_org_name = $org_name;
1087 $new_org_name =~ s/[\r\n]//g;
1088 $new_org_name =~ s/\"/"/g;
1090 return $new_org_name;
1095 print "Your organization's logo is an image that will be displayed at\n";
1096 print "different times throughout SquirrelMail. ";
1098 print "Please be aware of the following: \n";
1099 print " - Relative URLs are relative to the config dir\n";
1100 print " to use the default logo, use ../images/sm_logo.png\n";
1101 print " - To specify a logo defined outside the SquirrelMail source tree\n";
1102 print " use the absolute URL the webserver would use to include the file\n";
1103 print " e.g. http://example.com/images/mylogo.gif or /images/mylogo.jpg\n";
1105 print "[$WHT$org_logo$NRM]: $WHT";
1106 $new_org_logo = <STDIN
>;
1107 if ( $new_org_logo eq "\n" ) {
1108 $new_org_logo = $org_logo;
1110 $new_org_logo =~ s/[\r\n]//g;
1112 return $new_org_logo;
1117 print "Your organization's logo is an image that will be displayed at\n";
1118 print "different times throughout SquirrelMail. Width\n";
1119 print "and Height of your logo image. Use '0' to disable.\n";
1121 print "Width: [$WHT$org_logo_width$NRM]: $WHT";
1122 $new_org_logo_width = <STDIN
>;
1123 $new_org_logo_width =~ tr/0-9//cd; # only want digits!
1124 if ( $new_org_logo_width eq '' ) {
1125 $new_org_logo_width = $org_logo_width;
1127 if ( $new_org_logo_width > 0 ) {
1128 print "Height: [$WHT$org_logo_height$NRM]: $WHT";
1129 $new_org_logo_height = <STDIN
>;
1130 $new_org_logo_height =~ tr/0-9//cd; # only want digits!
1131 if( $new_org_logo_height eq '' ) {
1132 $new_org_logo_height = $org_logo_height;
1135 $new_org_logo_height = 0;
1137 return ($new_org_logo_width, $new_org_logo_height);
1142 print "A title is what is displayed at the top of the browser window in\n";
1143 print "the titlebar. Usually this will end up looking something like:\n";
1144 print "\"Netscape: $org_title\"\n";
1146 print "If your Organization Title includes a '\$', please precede it with a \\. \n";
1147 print "Other '\$' will be considered the beginning of a variable that\n";
1148 print "must be defined before the \$org_title is printed.\n";
1150 print "[$WHT$org_title$NRM]: $WHT";
1151 $new_org_title = <STDIN
>;
1152 if ( $new_org_title eq "\n" ) {
1153 $new_org_title = $org_title;
1155 $new_org_title =~ s/[\r\n]//g;
1156 $new_org_title =~ s/\"/\'/g;
1158 return $new_org_title;
1163 print "When users click the Sign Out button they will be logged out and\n";
1164 print "then sent to signout_page. If signout_page is left empty,\n";
1165 print "(hit space and then return) they will be taken, as normal,\n";
1166 print "to the default and rather sparse SquirrelMail signout page.\n";
1168 print "[$WHT$signout_page$NRM]: $WHT";
1169 $new_signout_page = <STDIN
>;
1170 if ( $new_signout_page eq "\n" ) {
1171 $new_signout_page = $signout_page;
1173 $new_signout_page =~ s/[\r\n]//g;
1174 $new_signout_page =~ s/^\s+$//g;
1176 return $new_signout_page;
1181 print "SquirrelMail defaults to using the whole of the browser window.\n";
1182 print "This allows you to keep it within a specified frame. The default\n";
1183 print "is '_top'\n";
1185 print "[$WHT$frame_top$NRM]: $WHT";
1186 $new_frame_top = <STDIN
>;
1187 if ( $new_frame_top eq "\n" ) {
1188 $new_frame_top = '_top';
1190 $new_frame_top =~ s/[\r\n]//g;
1191 $new_frame_top =~ s/^\s+$//g;
1193 return $new_frame_top;
1196 # Default link to provider
1198 print "Here you can set the link on the top-right of the message list.\n";
1199 print "If empty, it will not be displayed.\n";
1201 print "[$WHT$provider_uri$NRM]: $WHT";
1202 $new_provider_uri = <STDIN
>;
1203 if ( $new_provider_uri eq "\n" ) {
1204 $new_provider_uri = '';
1206 $new_provider_uri =~ s/[\r\n]//g;
1207 $new_provider_uri =~ s/^\s+$//g;
1209 return $new_provider_uri;
1213 print "Here you can set the name of the link on the top-right of the message list.\n";
1214 print "The default is empty (do not display anything).'\n";
1216 print "[$WHT$provider_name$NRM]: $WHT";
1217 $new_provider_name = <STDIN
>;
1218 if ( $new_provider_name eq "\n" ) {
1219 $new_provider_name = '';
1221 $new_provider_name =~ s/[\r\n]//g;
1222 $new_provider_name =~ s/^\s+$//g;
1223 $new_provider_name =~ s/\'/\\'/g;
1225 return $new_provider_name;
1228 ####################################################################################
1232 print "The domain name is the suffix at the end of all email addresses. If\n";
1233 print "for example, your email address is jdoe\@example.com, then your domain\n";
1234 print "would be example.com.\n";
1236 print "[$WHT$domain$NRM]: $WHT";
1237 $new_domain = <STDIN
>;
1238 if ( $new_domain eq "\n" ) {
1239 $new_domain = $domain;
1241 $new_domain =~ s/\s//g;
1248 print "This is the hostname where your IMAP server can be contacted.\n";
1249 print "[$WHT$imapServerAddress$NRM]: $WHT";
1250 $new_imapServerAddress = <STDIN
>;
1251 if ( $new_imapServerAddress eq "\n" ) {
1252 $new_imapServerAddress = $imapServerAddress;
1254 $new_imapServerAddress =~ s/[\r\n]//g;
1256 return $new_imapServerAddress;
1261 print "This is the port that your IMAP server is on. Usually this is 143.\n";
1262 print "[$WHT$imapPort$NRM]: $WHT";
1263 $new_imapPort = <STDIN
>;
1264 if ( $new_imapPort eq "\n" ) {
1265 $new_imapPort = $imapPort;
1267 $new_imapPort =~ s/[\r\n]//g;
1269 return $new_imapPort;
1274 print "You now need to choose the method that you will use for sending\n";
1275 print "messages in SquirrelMail. You can either connect to an SMTP server\n";
1276 print "or use sendmail directly.\n";
1277 if ( lc($useSendmail) eq 'true' ) {
1278 $default_value = "1";
1280 $default_value = "2";
1283 print " 1. Sendmail\n";
1285 print "Your choice [1/2] [$WHT$default_value$NRM]: $WHT";
1286 $use_sendmail = <STDIN
>;
1287 if ( ( $use_sendmail =~ /^1\n/i )
1288 || ( ( $use_sendmail =~ /^\n/ ) && ( $default_value eq "1" ) ) ) {
1289 $useSendmail = 'true';
1291 $useSendmail = 'false';
1293 return $useSendmail;
1298 print "Specify where the sendmail executable is located. Usually /usr/sbin/sendmail\n";
1299 print "[$WHT$sendmail_path$NRM]: $WHT";
1300 $new_sendmail_path = <STDIN
>;
1301 if ( $new_sendmail_path eq "\n" ) {
1302 $new_sendmail_path = $sendmail_path;
1304 $new_sendmail_path =~ s/[\r\n]//g;
1306 return $new_sendmail_path;
1309 # Extra sendmail arguments
1310 sub command_sendmail_args
{
1311 print "Specify additional sendmail program arguments.\n";
1313 print "Make sure that arguments are supported by your sendmail program. -f argument \n";
1314 print "is added automatically by SquirrelMail scripts. Variable defaults to standard\n";
1315 print "/usr/sbin/sendmail arguments. If you use qmail-inject, nbsmtp or any other \n";
1316 print "sendmail wrapper, which does not support -i and -t arguments, set variable to\n";
1317 print "empty string or use arguments suitable for your mailer.\n";
1319 print "[$WHT$sendmail_args$NRM]: $WHT";
1320 $new_sendmail_args = <STDIN
>;
1321 if ( $new_sendmail_args eq "\n" ) {
1322 $new_sendmail_args = $sendmail_args;
1324 # strip linefeeds and crs.
1325 $new_sendmail_args =~ s/[\r\n]//g;
1327 return trim
($new_sendmail_args);
1332 print "This is the hostname of your SMTP server.\n";
1333 print "[$WHT$smtpServerAddress$NRM]: $WHT";
1334 $new_smtpServerAddress = <STDIN
>;
1335 if ( $new_smtpServerAddress eq "\n" ) {
1336 $new_smtpServerAddress = $smtpServerAddress;
1338 $new_smtpServerAddress =~ s/[\r\n]//g;
1340 return $new_smtpServerAddress;
1345 print "This is the port to connect to for SMTP. Usually 25.\n";
1346 print "[$WHT$smtpPort$NRM]: $WHT";
1347 $new_smtpPort = <STDIN
>;
1348 if ( $new_smtpPort eq "\n" ) {
1349 $new_smtpPort = $smtpPort;
1351 $new_smtpPort =~ s/[\r\n]//g;
1353 return $new_smtpPort;
1358 print "Do you wish to use POP3 before SMTP? Your server must\n";
1359 print "support this in order for SquirrelMail to work with it.\n";
1362 $YesNo = 'y' if ( lc($pop_before_smtp) eq 'true' );
1364 print "Use POP before SMTP (y/n) [$WHT$YesNo$NRM]: $WHT";
1366 $new_pop_before_smtp = <STDIN
>;
1367 $new_pop_before_smtp =~ tr/yn//cd;
1368 if ( $new_pop_before_smtp eq "y" ) {
1369 $new_pop_before_smtp = "true";
1370 } elsif ( $new_pop_before_smtp eq "n" ) {
1371 $new_pop_before_smtp = "false";
1373 $new_pop_before_smtp = $pop_before_smtp;
1376 # if using POP before SMTP, allow setting of custom POP server address
1377 if ($new_pop_before_smtp eq "true") {
1378 print "$NRM\nIf the address of the POP server is not the same as\n";
1379 print "your SMTP server, you may specify it here. Leave blank (to\n";
1380 print "clear this, enter only spaces) to use the same address as\n";
1381 print "your SMTP server.\n";
1382 print "POP before SMTP server address [$WHT$pop_before_smtp_host$NRM]: $WHT";
1384 $new_pop_before_smtp_host = <STDIN
>;
1385 if ( $new_pop_before_smtp_host eq "\n" ) {
1386 $new_pop_before_smtp_host = $pop_before_smtp_host;
1387 } elsif ($new_pop_before_smtp_host =~ /^\s+$/) {
1388 $new_pop_before_smtp_host = '';
1390 $new_pop_before_smtp_host =~ s/[\r|\n]//g;
1392 $pop_before_smtp_host = $new_pop_before_smtp_host;
1395 return $new_pop_before_smtp;
1400 print "Each IMAP server has its own quirks. As much as we tried to stick\n";
1401 print "to standards, it doesn't help much if the IMAP server doesn't follow\n";
1402 print "the same principles. We have made some work-arounds for some of\n";
1403 print "these servers. If you would like to use them, please select your\n";
1404 print "IMAP server. If you do not wish to use these work-arounds, you can\n";
1405 print "set this to \"other\", and none will be used.\n";
1406 print $list_supported_imap_servers;
1408 print " other = Not one of the above servers\n";
1410 print "[$WHT$imap_server_type$NRM]: $WHT";
1411 $new_imap_server_type = <STDIN
>;
1413 if ( $new_imap_server_type eq "\n" ) {
1414 $new_imap_server_type = $imap_server_type;
1416 $new_imap_server_type =~ s/[\r\n]//g;
1418 return $new_imap_server_type;
1423 print "Sometimes the date of messages sent is messed up (off by a few hours\n";
1424 print "on some machines). Typically this happens if the system doesn't support\n";
1425 print "tm_gmtoff. It will happen only if your time zone is \"negative\".\n";
1426 print "This most often occurs on Solaris 7 machines in the United States.\n";
1427 print "By default, this is off. It should be kept off unless problems surface\n";
1428 print "about the time that messages are sent.\n";
1429 print " no = Do NOT fix time -- almost always correct\n";
1430 print " yes = Fix the time for this system\n";
1433 $YesNo = 'y' if ( lc($invert_time) eq 'true' );
1435 print "Fix the time for this system (y/n) [$WHT$YesNo$NRM]: $WHT";
1437 $new_invert_time = <STDIN
>;
1438 $new_invert_time =~ tr/yn//cd;
1439 return 'true' if ( $new_invert_time eq "y" );
1440 return 'false' if ( $new_invert_time eq "n" );
1441 return $invert_time;
1445 print "This is the delimiter that your IMAP server uses to distinguish between\n";
1446 print "folders. For example, Cyrus uses '.' as the delimiter and a complete\n";
1447 print "folder would look like 'INBOX.Friends.Bob', while UW uses '/' and would\n";
1448 print "look like 'INBOX/Friends/Bob'. Normally this should be left at 'detect'\n";
1449 print "but if you are sure you know what delimiter your server uses, you can\n";
1450 print "specify it here.\n";
1451 print "\nTo have it autodetect the delimiter, set it to 'detect'.\n\n";
1452 print "[$WHT$optional_delimiter$NRM]: $WHT";
1453 $new_optional_delimiter = <STDIN
>;
1455 if ( $new_optional_delimiter eq "\n" ) {
1456 $new_optional_delimiter = $optional_delimiter;
1458 $new_optional_delimiter =~ s/[\r\n]//g;
1460 return $new_optional_delimiter;
1462 # IMAP authentication type
1463 # Possible values: login, plain, cram-md5, digest-md5
1464 # Now offers to detect supported mechs, assuming server & port are set correctly
1467 if ($use_imap_tls ne "0") {
1468 # 1. Script does not handle TLS.
1469 # 2. Server does not have to declare all supported authentication mechs when
1470 # STARTTLS is used. Supported mechs are declared only after STARTTLS.
1471 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1473 print "If you have already set the hostname and port number, I can try to\n";
1474 print "detect the mechanisms your IMAP server supports.\n";
1475 print "I will try to detect CRAM-MD5 and DIGEST-MD5 support. I can't test\n";
1476 print "for \"login\" or \"plain\" without knowing a username and password.\n";
1477 print "Auto-detecting is optional - you can safely say \"n\" here.\n";
1478 print "\nTry to detect supported mechanisms? [y/N]: ";
1481 if ($inval =~ /^y\b/i) {
1482 # Yes, let's try to detect.
1483 print "Trying to detect IMAP capabilities...\n";
1484 my $host = $imapServerAddress . ':'. $imapPort;
1485 print "CRAM-MD5:\t";
1486 my $tmp = detect_auth_support
('IMAP',$host,'CRAM-MD5');
1487 if (defined($tmp)) {
1488 if ($tmp eq 'YES') {
1489 print "$WHT SUPPORTED$NRM\n";
1491 print "$WHT NOT SUPPORTED$NRM\n";
1494 print $WHT . " ERROR DETECTING$NRM\n";
1497 print "DIGEST-MD5:\t";
1498 $tmp = detect_auth_support
('IMAP',$host,'DIGEST-MD5');
1499 if (defined($tmp)) {
1500 if ($tmp eq 'YES') {
1501 print "$WHT SUPPORTED$NRM\n";
1503 print "$WHT NOT SUPPORTED$NRM\n";
1506 print $WHT . " ERROR DETECTING$NRM\n";
1511 print "\nWhat authentication mechanism do you want to use for IMAP connections?\n\n";
1512 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1513 print $WHT . "plain" . $NRM . " - SASL PLAIN. If you need this, you already know it.\n";
1514 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext methods.\n";
1515 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1516 print "\n*** YOUR IMAP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n";
1517 print "If you don't understand or are unsure, you probably want \"login\"\n\n";
1518 print "login, plain, cram-md5, or digest-md5 [$WHT$imap_auth_mech$NRM]: $WHT";
1521 if ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) || ($inval =~ /^login\b/i) || ($inval =~ /^plain\b/i)) {
1524 # user entered garbage or default value so nothing needs to be set
1525 return $imap_auth_mech;
1530 # SMTP authentication type
1531 # Possible choices: none, login, plain, cram-md5, digest-md5
1533 if ($use_smtp_tls ne "0") {
1534 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1535 } elsif (eval ("use IO::Socket; 1")) {
1536 # try loading IO::Socket module
1537 print "If you have already set the hostname and port number, I can try to\n";
1538 print "automatically detect some of the mechanisms your SMTP server supports.\n";
1539 print "Auto-detection is *optional* - you can safely say \"n\" here.\n";
1540 print "\nTry to detect auth mechanisms? [y/N]: ";
1543 if ($inval =~ /^y\b/i) {
1544 # Yes, let's try to detect.
1545 print "Trying to detect supported methods (SMTP)...\n";
1548 # Check none by trying to relay to junk@microsoft.com
1549 $host = $smtpServerAddress . ':' . $smtpPort;
1550 my $sock = IO
::Socket
::INET
->new($host);
1551 print "Testing none:\t\t$WHT";
1552 if (!defined($sock)) {
1553 print " ERROR TESTING\n";
1556 $got = <$sock>; # Discard greeting
1557 print $sock "HELO $domain\r\n";
1558 $got = <$sock>; # Discard
1559 print $sock "MAIL FROM:<tester\@squirrelmail.org>\r\n";
1560 $got = <$sock>; # Discard
1561 print $sock "RCPT TO:<junk\@microsoft.com\r\n";
1562 $got = <$sock>; # This is the important line
1563 if ($got =~ /^250\b/) { # SMTP will relay without auth
1564 print "SUPPORTED$NRM\n";
1566 print "NOT SUPPORTED$NRM\n";
1568 print $sock "RSET\r\n";
1569 print $sock "QUIT\r\n";
1573 # Try login (SquirrelMail default)
1574 print "Testing login:\t\t";
1575 $tmp=detect_auth_support
('SMTP',$host,'LOGIN');
1576 if (defined($tmp)) {
1577 if ($tmp eq 'YES') {
1578 print $WHT . "SUPPORTED$NRM\n";
1580 print $WHT . "NOT SUPPORTED$NRM\n";
1583 print $WHT . "ERROR DETECTING$NRM\n";
1587 print "Testing plain:\t\t";
1588 $tmp=detect_auth_support
('SMTP',$host,'PLAIN');
1589 if (defined($tmp)) {
1590 if ($tmp eq 'YES') {
1591 print $WHT . "SUPPORTED$NRM\n";
1593 print $WHT . "NOT SUPPORTED$NRM\n";
1596 print $WHT . "ERROR DETECTING$NRM\n";
1600 print "Testing CRAM-MD5:\t";
1601 $tmp=detect_auth_support
('SMTP',$host,'CRAM-MD5');
1602 if (defined($tmp)) {
1603 if ($tmp eq 'YES') {
1604 print $WHT . "SUPPORTED$NRM\n";
1606 print $WHT . "NOT SUPPORTED$NRM\n";
1609 print $WHT . "ERROR DETECTING$NRM\n";
1613 print "Testing DIGEST-MD5:\t";
1614 $tmp=detect_auth_support
('SMTP',$host,'DIGEST-MD5');
1615 if (defined($tmp)) {
1616 if ($tmp eq 'YES') {
1617 print $WHT . "SUPPORTED$NRM\n";
1619 print $WHT . "NOT SUPPORTED$NRM\n";
1622 print $WHT . "ERROR DETECTING$NRM\n";
1626 print "\nWhat authentication mechanism do you want to use for SMTP connections?\n";
1627 print $WHT . "none" . $NRM . " - Your SMTP server does not require authorization.\n";
1628 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1629 print $WHT . "plain" . $NRM . " - SASL PLAIN. Plaintext. If you can do better, you probably should.\n";
1630 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext.\n";
1631 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1632 print $WHT . "\n*** YOUR SMTP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n" . $NRM;
1633 print "If you don't understand or are unsure, you probably want \"none\"\n\n";
1634 print "none, login, plain, cram-md5, or digest-md5 [$WHT$smtp_auth_mech$NRM]: $WHT";
1637 if ($inval =~ /^none\b/i) {
1638 # remove sitewide smtp authentication information
1639 $smtp_sitewide_user = '';
1640 $smtp_sitewide_pass = '';
1641 # SMTP doesn't necessarily require logins
1643 } elsif ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) ||
1644 ($inval =~ /^login\b/i) || ($inval =~/^plain\b/i)) {
1645 command_smtp_sitewide_userpass
($inval);
1647 } elsif (trim
($inval) eq '') {
1648 # user selected default value
1649 command_smtp_sitewide_userpass
($smtp_auth_mech);
1650 return $smtp_auth_mech;
1652 # user entered garbage
1653 return $smtp_auth_mech;
1657 sub command_smtp_sitewide_userpass
($) {
1658 # get first function argument
1659 my $auth_mech = shift(@_);
1661 $auth_mech = lc(trim
($auth_mech));
1662 if ($auth_mech eq 'none') {
1665 print "SMTP authentication uses IMAP username and password by default.\n";
1667 print "Would you like to use other login and password for all SquirrelMail \n";
1668 print "SMTP connections?";
1669 if ($smtp_sitewide_user ne '') {
1686 $smtp_sitewide_user = '';
1687 $smtp_sitewide_pass = '';
1688 } elsif ($tmp eq 'y') {
1689 print "Enter username [$smtp_sitewide_user]:";
1690 my $new_user = <STDIN
>;
1691 $new_user = trim
($new_user);
1692 if ($new_user ne '') {
1693 $smtp_sitewide_user = $new_user;
1695 if ($smtp_sitewide_user ne '') {
1696 print "If you don't enter any password, current sitewide password will be used.\n";
1697 print "If you enter space, password will be set to empty string.\n";
1698 print "Enter password:";
1699 my $new_pass = <STDIN
>;
1700 if ($new_pass ne "\n") {
1701 $smtp_sitewide_pass = trim
($new_pass);
1704 print "Invalid input. You must set username used for SMTP authentication.\n";
1705 print "Click enter to continue\n";
1709 print "Invalid input\n";
1710 print "Click enter to continue\n";
1715 # Sub adds information about SMTP authentication type to menu
1716 sub display_smtp_sitewide_userpass
() {
1718 if ($smtp_auth_mech ne 'none') {
1719 if ($smtp_sitewide_user ne '') {
1720 $ret = ' (with custom username and password)';
1722 $ret = ' (with IMAP username and password)';
1729 # This sub is reused for IMAP and SMTP
1730 # Args: service name, default value
1731 sub command_use_tls
{
1732 my($default_val,$service,$inval);
1735 print "TLS (Transport Layer Security) encrypts the traffic between server and client.\n";
1736 print "STARTTLS extensions allow to start encryption on existing plain text connection.\n";
1737 print "These options add specific PHP and IMAP server configuration requirements.\n";
1738 print "See SquirrelMail documentation about connection security.\n";
1740 print "If your " . $service . " server is localhost, you can safely disable this.\n";
1741 print "If it is remote, you may wish to seriously consider enabling this.\n";
1743 while ($valid_input eq 0) {
1744 print "\nSelect connection security model:\n";
1745 print " 0 - Use plain text connection\n";
1746 print " 1 - Use TLS connection\n";
1747 print " 2 - Use STARTTLS extension\n";
1748 print "Select [$default_val]: ";
1750 $inval=trim
($inval);
1751 if ($inval =~ /^[012]$/ || $inval eq '') {
1755 if ($inval ne '') {$default_val = $inval};
1756 return $default_val;
1759 # This sub is used to display human readable text for
1760 # $use_imap_tls and $use_smtp_tls values in conf.pl menu
1761 sub display_use_tls
($) {
1762 my $val = shift(@_);
1763 my $ret = 'disabled';
1766 } elsif ($val eq '1') {
1772 # $encode_header_key
1774 print "This encryption key allows the hiding of SquirrelMail Received:\n";
1775 print "headers in outbound messages. SquirrelMail uses the encryption\n";
1776 print "key to encode the username, remote address, and proxied address\n";
1777 print "and then stores that encoded information in X-Squirrel-* headers.\n";
1779 print "Warning: the encryption function used to accomplish this is not\n";
1780 print "bulletproof. When used with a static encryption key as it is here,\n";
1781 print "it provides only minimal security and the encoded user information\n";
1782 print "in the X-Squirrel-* headers can be decoded quickly by a skilled\n";
1783 print "attacker.\n";
1785 print "When you need to inspect an email sent from your system with the\n";
1786 print "X-Squirrel-* headers, you can decode the user information therein\n";
1787 print "by using the decrypt_headers.php script found in the SquirrelMail\n";
1788 print "contrib/ directory. You'll need the encryption key that you\n";
1789 print "defined here when doing so.\n";
1791 print "Enter encryption key: ";
1792 $new_encode_header_key = <STDIN
>;
1793 if ( $new_encode_header_key eq "\n" ) {
1794 $new_encode_header_key = $encode_header_key;
1796 $new_encode_header_key =~ s/[\r\n]//g;
1798 return $new_encode_header_key;
1803 print "\nYou can now create the welcome message that is displayed\n";
1804 print "every time a user logs on. You can use HTML or just plain\n";
1806 "text. If you do not wish to have one, just make it blank.\n\n(Type @ on a blank line to exit)\n";
1812 $line =~ s/[\r\n]//g;
1813 if ( $line ne "@" ) {
1814 $line =~ s/ /\ \ /g;
1815 $line =~ s/\t/\ \ \ \ /g;
1817 $line =~ s/\"/\\\"/g;
1819 $new_motd = $new_motd . $line;
1821 } while ( $line ne "@" );
1825 ################# PLUGINS ###################
1828 $command =~ s/[\s\n\r]*//g;
1829 if ( $command > 0 ) {
1830 $command = $command - 1;
1831 if ( $command <= $#plugins ) {
1834 while ( $ct <= $#plugins ) {
1835 if ( $ct != $command ) {
1836 @newplugins = ( @newplugins, $plugins[$ct] );
1840 @plugins = @newplugins;
1841 } elsif ( $command <= $#plugins + $#unused_plugins + 1 ) {
1842 $num = $command - $#plugins - 1;
1843 @newplugins = @plugins;
1845 while ( $ct <= $#unused_plugins ) {
1846 if ( $ct == $num ) {
1847 @newplugins = ( @newplugins, $unused_plugins[$ct] );
1851 @plugins = @newplugins;
1857 # disable_plugins_user
1859 print "When all active plugins are disabled, they can be disabled only\n";
1860 print "for the one user named here. If left blank, plugins will be\n";
1861 print "disabled for ALL users. This setting has no effect if plugins\n";
1862 print "are not disabled.\n";
1864 print "This must be the exact IMAP login name for the desired user.\n";
1866 print "[$WHT$disable_plugins_user$NRM]: $WHT";
1867 $new_disable_plugins_user = <STDIN
>;
1868 if ( $new_disable_plugins_user eq "\n" ) {
1869 $new_disable_plugins_user = $disable_plugins_user;
1871 $new_disable_plugins_user =~ s/[\r\n]//g;
1873 return $new_disable_plugins_user;
1876 ################# FOLDERS ###################
1878 # default_folder_prefix
1880 print "Some IMAP servers (UW, for example) store mail and folders in\n";
1881 print "your user space in a separate subdirectory. This is where you\n";
1882 print "specify what that directory is.\n";
1884 print "EXAMPLE: mail/";
1886 print "NOTE: If you use Cyrus, or some server that would not use this\n";
1887 print " option, you must set this to 'none'.\n";
1889 print "[$WHT$default_folder_prefix$NRM]: $WHT";
1890 $new_default_folder_prefix = <STDIN
>;
1892 if ( $new_default_folder_prefix eq "\n" ) {
1893 $new_default_folder_prefix = $default_folder_prefix;
1895 $new_default_folder_prefix =~ s/[\r\n]//g;
1897 if ( ( $new_default_folder_prefix =~ /^\s*$/ ) || ( $new_default_folder_prefix =~ m/^none$/i ) ) {
1898 $new_default_folder_prefix = "";
1900 # add the trailing delimiter only if we know what the server is.
1901 if (($imap_server_type eq 'cyrus' and
1902 $optional_delimiter eq 'detect') or
1903 ($imap_server_type eq 'courier' and
1904 $optional_delimiter eq 'detect')) {
1905 $new_default_folder_prefix =~ s/\.*$/\./;
1906 } elsif ($imap_server_type eq 'uw' and
1907 $optional_delimiter eq 'detect') {
1908 $new_default_folder_prefix =~ s/\/*$/\
//;
1911 return $new_default_folder_prefix;
1914 # Show Folder Prefix
1916 print "It is possible to set up the default folder prefix as a user\n";
1917 print "specific option, where each user can specify what their mail\n";
1918 print "folder is. If you set this to false, they will never see the\n";
1919 print "option, but if it is true, this option will appear in the\n";
1920 print "'options' section.\n";
1922 print "NOTE: You set the default folder prefix in option '1' of this\n";
1923 print " section. That will be the default if the user doesn't\n";
1924 print " specify anything different.\n";
1927 if ( lc($show_prefix_option) eq 'true' ) {
1928 $default_value = "y";
1930 $default_value = "n";
1933 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
1934 $new_show = <STDIN
>;
1935 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1936 $show_prefix_option = 'true';
1938 $show_prefix_option = 'false';
1940 return $show_prefix_option;
1945 print "You can now specify where the default trash folder is located.\n";
1946 print "On servers where you do not want this, you can set it to anything\n";
1947 print "and set option 6 to false.\n";
1949 print "This is relative to where the rest of your email is kept. You do\n";
1950 print "not need to worry about their mail directory. If this folder\n";
1951 print "would be ~/mail/trash on the filesystem, you only need to specify\n";
1952 print "that this is 'trash', and be sure to put 'mail/' in option 1.\n";
1955 print "[$WHT$trash_folder$NRM]: $WHT";
1956 $new_trash_folder = <STDIN
>;
1957 if ( $new_trash_folder eq "\n" ) {
1958 $new_trash_folder = $trash_folder;
1960 if (check_imap_folder
($new_trash_folder)) {
1961 $new_trash_folder =~ s/[\r\n]//g;
1963 $new_trash_folder = $trash_folder;
1966 return $new_trash_folder;
1971 print "This is where messages that are sent will be stored. SquirrelMail\n";
1972 print "by default puts a copy of all outgoing messages in this folder.\n";
1974 print "This is relative to where the rest of your email is kept. You do\n";
1975 print "not need to worry about their mail directory. If this folder\n";
1976 print "would be ~/mail/sent on the filesystem, you only need to specify\n";
1977 print "that this is 'sent', and be sure to put 'mail/' in option 1.\n";
1980 print "[$WHT$sent_folder$NRM]: $WHT";
1981 $new_sent_folder = <STDIN
>;
1982 if ( $new_sent_folder eq "\n" ) {
1983 $new_sent_folder = $sent_folder;
1985 if (check_imap_folder
($new_sent_folder)) {
1986 $new_sent_folder =~ s/[\r\n]//g;
1988 $new_sent_folder = $sent_folder;
1991 return $new_sent_folder;
1996 print "You can now specify where the default draft folder is located.\n";
1997 print "On servers where you do not want this, you can set it to anything\n";
1998 print "and set option 9 to false.\n";
2000 print "This is relative to where the rest of your email is kept. You do\n";
2001 print "not need to worry about their mail directory. If this folder\n";
2002 print "would be ~/mail/drafts on the filesystem, you only need to specify\n";
2003 print "that this is 'drafts', and be sure to put 'mail/' in option 1.\n";
2006 print "[$WHT$draft_folder$NRM]: $WHT";
2007 $new_draft_folder = <STDIN
>;
2008 if ( $new_draft_folder eq "\n" ) {
2009 $new_draft_folder = $draft_folder;
2011 if (check_imap_folder
($new_draft_folder)) {
2012 $new_draft_folder =~ s/[\r\n]//g;
2014 $new_draft_folder = $draft_folder;
2017 return $new_draft_folder;
2020 # default move to trash
2022 print "By default, should messages get moved to the trash folder? You\n";
2023 print "can specify the default trash folder in option 3. If this is set\n";
2024 print "to false, messages will get deleted immediately without moving\n";
2025 print "to the trash folder.\n";
2027 print "Trash folder is currently: $trash_folder\n";
2030 if ( lc($default_move_to_trash) eq 'true' ) {
2031 $default_value = "y";
2033 $default_value = "n";
2035 print "By default, move to trash (y/n) [$WHT$default_value$NRM]: $WHT";
2036 $new_show = <STDIN
>;
2037 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2038 $default_move_to_trash = 'true';
2040 $default_move_to_trash = 'false';
2042 return $default_move_to_trash;
2045 # default move to sent (save sent messages)
2047 print "By default, should copies of outgoing messages get saved in the\n";
2048 print "sent folder? You can specify the default sent folder in option 4.\n";
2049 print "If this is set to false, messages will get sent and no copy will\n";
2052 print "Sent folder is currently: $sent_folder\n";
2055 if ( lc($default_move_to_sent) eq 'true' ) {
2056 $default_value = "y";
2058 $default_value = "n";
2060 print "By default, save sent messages (y/n) [$WHT$default_value$NRM]: $WHT";
2061 $new_show = <STDIN
>;
2062 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2063 $default_move_to_sent = 'true';
2065 $default_move_to_sent = 'false';
2067 return $default_move_to_sent;
2070 # default save as draft
2072 print "By default, should the save to draft option be shown? You can\n";
2073 print "specify the default drafts folder in option 5. If this is set\n";
2074 print "to false, users will not be shown the save to draft option.\n";
2076 print "Drafts folder is currently: $draft_folder\n";
2079 if ( lc($default_save_as_draft) eq 'true' ) {
2080 $default_value = "y";
2082 $default_value = "n";
2084 print "By default, save as draft (y/n) [$WHT$default_value$NRM]: $WHT";
2085 $new_show = <STDIN
>;
2086 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2087 $default_save_as_draft = 'true';
2089 $default_save_as_draft = 'false';
2091 return $default_save_as_draft;
2094 # List special folders first
2096 print "SquirrelMail has what we call 'special folders' that are not\n";
2097 print "manipulated and viewed like normal folders. Some examples of\n";
2098 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
2099 print "Simply asks if you want these folders listed first in the folder\n";
2103 if ( lc($list_special_folders_first) eq 'true' ) {
2104 $default_value = "y";
2106 $default_value = "n";
2109 print "List first (y/n) [$WHT$default_value$NRM]: $WHT";
2110 $new_show = <STDIN
>;
2111 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2112 $list_special_folders_first = 'true';
2114 $list_special_folders_first = 'false';
2116 return $list_special_folders_first;
2119 # Show special folders color
2121 print "SquirrelMail has what we call 'special folders' that are not\n";
2122 print "manipulated and viewed like normal folders. Some examples of\n";
2123 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
2124 print "wants to know if we should display special folders in a\n";
2125 print "color than the other folders.\n";
2128 if ( lc($use_special_folder_color) eq 'true' ) {
2129 $default_value = "y";
2131 $default_value = "n";
2134 print "Show color (y/n) [$WHT$default_value$NRM]: $WHT";
2135 $new_show = <STDIN
>;
2136 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2137 $use_special_folder_color = 'true';
2139 $use_special_folder_color = 'false';
2141 return $use_special_folder_color;
2146 print "The way that IMAP handles deleting messages is as follows. You\n";
2147 print "mark the message as deleted, and then to 'really' delete it, you\n";
2148 print "expunge it. This option asks if you want to just have messages\n";
2149 print "marked as deleted, or if you want SquirrelMail to expunge the \n";
2150 print "messages too.\n";
2153 if ( lc($auto_expunge) eq 'true' ) {
2154 $default_value = "y";
2156 $default_value = "n";
2158 print "Auto expunge (y/n) [$WHT$default_value$NRM]: $WHT";
2159 $new_show = <STDIN
>;
2160 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2161 $auto_expunge = 'true';
2163 $auto_expunge = 'false';
2165 return $auto_expunge;
2168 # Default sub of inbox
2170 print "Some IMAP servers (Cyrus) have all folders as subfolders of INBOX.\n";
2171 print "This can cause some confusion in folder creation for users when\n";
2172 print "they try to create folders and don't put it as a subfolder of INBOX\n";
2173 print "and get permission errors. This option asks if you want folders\n";
2174 print "to be subfolders of INBOX by default.\n";
2177 if ( lc($default_sub_of_inbox) eq 'true' ) {
2178 $default_value = "y";
2180 $default_value = "n";
2182 print "Default sub of INBOX (y/n) [$WHT$default_value$NRM]: $WHT";
2183 $new_show = <STDIN
>;
2184 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2185 $default_sub_of_inbox = 'true';
2187 $default_sub_of_inbox = 'false';
2189 return $default_sub_of_inbox;
2192 # Show contain subfolder option
2194 print "Some IMAP servers (UW) make it so that there are two types of\n";
2195 print "folders. Those that contain messages, and those that contain\n";
2196 print "subfolders. If this is the case for your server, set this to\n";
2197 print "true, and it will ask the user whether the folder they are\n";
2198 print "creating contains subfolders or messages.\n";
2201 if ( lc($show_contain_subfolders_option) eq 'true' ) {
2202 $default_value = "y";
2204 $default_value = "n";
2206 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
2207 $new_show = <STDIN
>;
2208 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2209 $show_contain_subfolders_option = 'true';
2211 $show_contain_subfolders_option = 'false';
2213 return $show_contain_subfolders_option;
2216 # Default Unseen Notify
2218 print "This option specifies where the users will receive notification\n";
2219 print "about unseen messages by default. This is of course an option that\n";
2220 print "can be changed on a user level.\n";
2221 print " 1 = No notification\n";
2222 print " 2 = Only on the INBOX\n";
2223 print " 3 = On all folders\n";
2226 print "Which one should be default (1,2,3)? [$WHT$default_unseen_notify$NRM]: $WHT";
2227 $new_show = <STDIN
>;
2228 if ( $new_show =~ /^[123]\n/i ) {
2229 $default_unseen_notify = $new_show;
2231 $default_unseen_notify =~ s/[\r\n]//g;
2232 return $default_unseen_notify;
2235 # Default Unseen Type
2237 print "Here you can define the default way that unseen messages will be displayed\n";
2238 print "to the user in the folder listing on the left side.\n";
2239 print " 1 = Only unseen messages (4)\n";
2240 print " 2 = Unseen and Total messages (4/27)\n";
2243 print "Which one should be default (1,2)? [$WHT$default_unseen_type$NRM]: $WHT";
2244 $new_show = <STDIN
>;
2245 if ( $new_show =~ /^[12]\n/i ) {
2246 $default_unseen_type = $new_show;
2248 $default_unseen_type =~ s/[\r\n]//g;
2249 return $default_unseen_type;
2252 # Auto create special folders
2254 print "Would you like the Sent, Trash, and Drafts folders to be created\n";
2255 print "automatically print for you when a user logs in? If the user\n";
2256 print "accidentally deletes their special folders, this option will\n";
2257 print "automatically create it again for them.\n";
2260 if ( lc($auto_create_special) eq 'true' ) {
2261 $default_value = "y";
2263 $default_value = "n";
2265 print "Auto create special folders? (y/n) [$WHT$default_value$NRM]: $WHT";
2266 $new_show = <STDIN
>;
2267 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2268 $auto_create_special = 'true';
2270 $auto_create_special = 'false';
2272 return $auto_create_special;
2275 # Automatically delete folders
2277 if ( $imap_server_type eq "uw" ) {
2278 print "UW IMAP servers will not allow folders containing mail to also contain folders.\n";
2279 print "Deleting folders will bypass the trash folder and be immediately deleted\n\n";
2280 print "If this is not the correct value for your server,\n";
2281 print "please use option D on the Main Menu to configure your server correctly.\n\n";
2282 print "Press enter to continue...\n";
2283 $new_delete = <STDIN
>;
2284 $delete_folder = 'true';
2286 if ( $imap_server_type eq "courier" ) {
2287 print "Courier (or Courier-IMAP) IMAP servers may not support ";
2288 print "subfolders of Trash. \n";
2289 print "Specifically, if Courier is set to always move messages to Trash, \n";
2290 print "Trash will be treated by Courier as a special folder that does not \n";
2291 print "allow subfolders. \n\n";
2292 print "Please verify your Courier configuration, and test folder deletion \n";
2293 print "when changing this setting.\n\n";
2296 print "Are subfolders of the Trash supported by your IMAP server?\n";
2297 print "If so, should deleted folders be sent to Trash?\n";
2298 print "If not, say no (deleted folders should not be sent to Trash)\n\n";
2299 # reversal of logic.
2300 # question was: Should folders be automatically deleted instead of sent to trash..
2301 # we've changed the question to make it more clear,
2302 # and are here handling that to avoid changing the answers..
2303 if ( lc($delete_folder) eq 'true' ) {
2304 $default_value = "n";
2306 $default_value = "y";
2308 print "Send deleted folders to Trash? (y/n) [$WHT$default_value$NRM]: $WHT";
2309 $new_delete = <STDIN
>;
2310 if ( ( $new_delete =~ /^y\n/i ) || ( ( $new_delete =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2311 $delete_folder = 'false';
2313 $delete_folder = 'true';
2316 return $delete_folder;
2321 print "Some IMAP servers allow subfolders to exist even if the parent\n";
2322 print "folders do not. This fixes some problems with the folder list\n";
2323 print "when this is the case, causing the /NoSelect folders to be displayed\n";
2326 if ( lc($noselect_fix_enable) eq 'true' ) {
2327 $default_value = "y";
2329 $default_value = "n";
2331 print "enable noselect fix? (y/n) [$WHT$noselect_fix_enable$NRM]: $WHT";
2332 $noselect_fix_enable = <STDIN
>;
2333 if ( ( $noselect_fix_enable =~ /^y\n/i ) || ( ( $noselect_fix_enable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2334 $noselect_fix_enable = 'true';
2336 $noselect_fix_enable = 'false';
2338 return $noselect_fix_enable;
2340 ############# GENERAL OPTIONS #####################
2344 print "Specify the location for your data directory.\n";
2345 print "You need to create this directory yourself.\n";
2346 print "The path name can be absolute or relative (to the config directory).\n";
2347 print "Here are two examples:\n";
2348 print " Absolute: /var/local/squirrelmail/data/\n";
2349 print " Relative: ../data/\n";
2350 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2351 print "will be converted to their absolute path equivalents in config.php.\n\n";
2352 print "Note: There are potential security risks with having a writeable directory\n";
2353 print "under the web server's root directory (ex: /home/httpd/html).\n";
2354 print "For this reason, it is recommended to put the data directory\n";
2355 print "in an alternate location of your choice. \n";
2358 print "[$WHT$data_dir$NRM]: $WHT";
2359 $new_data_dir = <STDIN
>;
2360 if ( $new_data_dir eq "\n" ) {
2361 $new_data_dir = $data_dir;
2363 $new_data_dir =~ s/[\r\n]//g;
2365 if ( $new_data_dir =~ /^\s*$/ ) {
2368 $new_data_dir =~ s/\/*$//g
;
2369 $new_data_dir =~ s/$/\//g
;
2371 return $new_data_dir;
2374 # Attachment directory
2376 print "Path to directory used for storing attachments while a mail is\n";
2377 print "being composed. The path name can be absolute or relative (to the\n";
2378 print "config directory). Here are two examples:\n";
2379 print " Absolute: /var/local/squirrelmail/attach/\n";
2380 print " Relative: ../attach/\n";
2381 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2382 print "will be converted to their absolute path equivalents in config.php.\n\n";
2383 print "Note: There are a few security considerations regarding this\n";
2384 print "directory:\n";
2385 print " 1. It should have the permission 733 (rwx-wx-wx) to make it\n";
2386 print " impossible for a random person with access to the webserver\n";
2387 print " to list files in this directory. Confidential data might\n";
2388 print " be laying around in there.\n";
2389 print " Depending on your user:group assignments, 730 (rwx-wx---)\n";
2390 print " may be possible, and more secure (e.g. root:apache)\n";
2391 print " 2. Since the webserver is not able to list the files in the\n";
2392 print " content is also impossible for the webserver to delete files\n";
2393 print " lying around there for too long.\n";
2394 print " 3. It should probably be another directory than the data\n";
2395 print " directory specified in option 3.\n";
2398 print "[$WHT$attachment_dir$NRM]: $WHT";
2399 $new_attachment_dir = <STDIN
>;
2400 if ( $new_attachment_dir eq "\n" ) {
2401 $new_attachment_dir = $attachment_dir;
2403 $new_attachment_dir =~ s/[\r\n]//g;
2405 if ( $new_attachment_dir =~ /^\s*$/ ) {
2406 $new_attachment_dir = "";
2408 $new_attachment_dir =~ s/\/*$//g
;
2409 $new_attachment_dir =~ s/$/\//g
;
2411 return $new_attachment_dir;
2415 print "The directory hash level setting allows you to configure the level\n";
2416 print "of hashing that SquirrelMail employs in your data and attachment\n";
2417 print "directories. This value must be an integer ranging from 0 to 4.\n";
2418 print "When this value is set to 0, SquirrelMail will simply store all\n";
2419 print "files as normal in the data and attachment directories. However,\n";
2420 print "when set to a value from 1 to 4, a simple hashing scheme will be\n";
2421 print "used to organize the files in this directory. In short, the crc32\n";
2422 print "value for a username will be computed. Then, up to the first 4\n";
2423 print "digits of the hash, as set by this configuration value, will be\n";
2424 print "used to directory hash the files for that user in the data and\n";
2425 print "attachment directory. This allows for better performance on\n";
2426 print "servers with larger numbers of users.\n";
2429 print "[$WHT$dir_hash_level$NRM]: $WHT";
2430 $new_dir_hash_level = <STDIN
>;
2431 if ( $new_dir_hash_level eq "\n" ) {
2432 $new_dir_hash_level = $dir_hash_level;
2434 $new_dir_hash_level =~ s/[\r\n]//g;
2436 if ( ( int($new_dir_hash_level) < 0 )
2437 || ( int($new_dir_hash_level) > 4 )
2438 || !( int($new_dir_hash_level) eq $new_dir_hash_level ) ) {
2439 print "Invalid Directory Hash Level.\n";
2440 print "Value must be an integer ranging from 0 to 4\n";
2441 print "Hit enter to continue.\n";
2442 $enter_key = <STDIN
>;
2444 $new_dir_hash_level = $dir_hash_level;
2447 return $new_dir_hash_level;
2451 print "This is the default size (in pixels) of the left folder list.\n";
2452 print "Default is 200, but you can set it to whatever you wish. This\n";
2453 print "is a user preference, so this will only show up as their default.\n";
2455 print "[$WHT$default_left_size$NRM]: $WHT";
2456 $new_default_left_size = <STDIN
>;
2457 if ( $new_default_left_size eq "\n" ) {
2458 $new_default_left_size = $default_left_size;
2460 $new_default_left_size =~ s/[\r\n]//g;
2462 return $new_default_left_size;
2466 print "Some IMAP servers only have lowercase letters in the usernames\n";
2467 print "but they still allow people with uppercase to log in. This\n";
2468 print "causes a problem with the user's preference files. This option\n";
2469 print "transparently changes all usernames to lowercase.";
2472 if ( lc($force_username_lowercase) eq 'true' ) {
2473 $default_value = "y";
2475 $default_value = "n";
2477 print "Convert usernames to lowercase (y/n) [$WHT$default_value$NRM]: $WHT";
2478 $new_show = <STDIN
>;
2479 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2489 if ( lc($default_use_priority) eq 'true' ) {
2490 $default_value = "y";
2492 $default_value = "n";
2495 print "Allow users to specify priority of outgoing mail (y/n) [$WHT$default_value$NRM]: $WHT";
2496 $new_show = <STDIN
>;
2497 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2507 if ( lc($hide_sm_attributions) eq 'true' ) {
2508 $default_value = "y";
2510 $default_value = "n";
2513 print "Hide SM attributions (y/n) [$WHT$default_value$NRM]: $WHT";
2514 $new_show = <STDIN
>;
2515 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2525 if ( lc($default_use_mdn) eq 'true' ) {
2526 $default_value = "y";
2528 $default_value = "n";
2531 print "Enable support for read/delivery receipt support (y/n) [$WHT$default_value$NRM]: $WHT";
2532 $new_show = <STDIN
>;
2533 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2541 print " In loosely managed environments, you may want to allow users
2542 to edit their full name and email address. In strictly managed
2543 environments, you may want to force users to use the name
2544 and email address assigned to them.
2546 'y' - allow a user to edit their full name and email address,
2547 'n' - users must use the assigned values.
2551 if ( lc($edit_identity) eq 'true' ) {
2552 $default_value = "y";
2554 $default_value = "n";
2556 print "Allow editing of user's identity? (y/n) [$WHT$default_value$NRM]: $WHT";
2557 $new_edit = <STDIN
>;
2558 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2559 $edit_identity = 'true';
2560 $edit_name = 'true';
2561 $hide_auth_header = command311b
();
2563 $edit_identity = 'false';
2564 $edit_name = command311
();
2565 $hide_auth_header = command311b
();
2567 return $edit_identity;
2572 print "\n Given that users are not allowed to modify their
2573 email address, can they edit their full name?
2577 if ( lc($edit_name) eq 'true' ) {
2578 $default_value = "y";
2580 $default_value = "n";
2582 print "Allow the user to edit their full name? (y/n) [$WHT$default_value$NRM]: $WHT";
2583 $new_edit = <STDIN
>;
2584 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2585 $edit_name = 'true';
2587 $edit_name = 'false';
2594 print "\n SquirrelMail adds username information to every outgoing email in
2595 order to prevent possible sender forging by users that are allowed
2596 to change their email and/or full name.
2598 You can remove user information from this header (y) if you think
2599 that it violates privacy or security.
2601 Note: If users are allowed to change their email addresses, this
2602 setting will make it difficult to determine who sent what where.
2603 Use at your own risk.
2605 Note: If you have defined a header encryption key in your SMTP or
2606 Sendmail settings (see the \"Server Settings\" option page), this
2607 setting is ignored because all user information in outgoing messages
2612 if ( lc($hide_auth_header) eq "true" ) {
2613 $default_value = "y";
2615 $default_value = "n";
2617 print "Remove username from email headers? (y/n) [$WHT$default_value$NRM]: $WHT";
2618 $new_header = <STDIN
>;
2619 if ( ( $new_header =~ /^y\n/i ) || ( ( $new_header =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2620 $hide_auth_header = "true";
2622 $hide_auth_header = "false";
2624 return $hide_auth_header;
2628 print "This option allows you to disable server side thread sorting if your server \n";
2629 print "declares THREAD support, but you don't want to provide threading options \n";
2630 print "to end users or THREAD extension is broken or extension does not work with \n";
2631 print "options used by SquirrelMail. Option is not used, if THREAD extension is \n";
2632 print "not declared in IMAP CAPABILITY.\n";
2635 if ( lc($disable_thread_sort) eq 'true' ) {
2636 $default_value = "y";
2638 $default_value = "n";
2640 print "Disable server side thread sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2641 $disable_thread_sort = <STDIN
>;
2642 if ( ( $disable_thread_sort =~ /^y\n/i ) || ( ( $disable_thread_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2643 $disable_thread_sort = 'true';
2645 $disable_thread_sort = 'false';
2647 return $disable_thread_sort;
2651 print "This option allows you to disable server side sorting if your server declares \n";
2652 print "SORT support, but SORT extension is broken or does not work with options \n";
2653 print "used by SquirrelMail. Option is not used, if SORT extension is not declared \n";
2654 print "in IMAP CAPABILITY.\n";
2656 print "It is strongly recommended to keep server side sorting enabled, if your ";
2657 print "IMAP server supports it.";
2660 if ( lc($disable_server_sort) eq 'true' ) {
2661 $default_value = "y";
2663 $default_value = "n";
2665 print "Disable server-side sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2666 $disable_server_sort = <STDIN
>;
2667 if ( ( $disable_server_sort =~ /^y\n/i ) || ( ( $disable_server_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2668 $disable_server_sort = 'true';
2670 $disable_server_sort = 'false';
2672 return $disable_server_sort;
2676 print "This option allows you to choose if SM uses charset search\n";
2677 print "Your IMAP server must support the SEARCH CHARSET command for this to work\n";
2680 if ( lc($allow_charset_search) eq 'true' ) {
2681 $default_value = "y";
2683 $default_value = "n";
2685 print "Allow charset searching? (y/n) [$WHT$default_value$NRM]: $WHT";
2686 $allow_charset_search = <STDIN
>;
2687 if ( ( $allow_charset_search =~ /^y\n/i ) || ( ( $allow_charset_search =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2688 $allow_charset_search = 'true';
2690 $allow_charset_search = 'false';
2692 return $allow_charset_search;
2695 # command315 (UID support) obsoleted.
2697 # advanced search option
2699 print "This option allows you to control the use of advanced search form.\n";
2700 print " 0 = enable basic search only\n";
2701 print " 1 = enable advanced search only\n";
2702 print " 2 = enable both\n";
2705 print "Allowed search (0,1,2)? [$WHT$allow_advanced_search$NRM]: $WHT";
2706 $new_allow_advanced_search = <STDIN
>;
2707 if ( $new_allow_advanced_search =~ /^[012]\n/i ) {
2708 $allow_advanced_search = $new_allow_advanced_search;
2710 $allow_advanced_search =~ s/[\r\n]//g;
2711 return $allow_advanced_search;
2716 print "This option allows you to change the name of the PHP session used\n";
2717 print "by SquirrelMail. Unless you know what you are doing, you probably\n";
2718 print "don't need or want to change this from the default of SQMSESSID.\n";
2719 print "[$WHT$session_name$NRM]: $WHT";
2720 $new_session_name = <STDIN
>;
2721 chomp($new_session_name);
2722 if ( $new_session_name eq "" ) {
2723 $new_session_name = $session_name;
2725 return $new_session_name;
2728 # time zone config (since 1.5.1)
2730 print "This option allows you to control the use of time zones.\n";
2731 print " 0 = (default) standard, GNU C time zone names\n";
2732 print " 1 = strict, generic time zone codes with offsets\n";
2733 print " 2 = custom, GNU C time zones loaded from config/timezones.php\n";
2734 print " 3 = custom strict, generic time zone codes with offsets loaded \n";
2735 print " from config/timezones.php\n";
2736 print "See SquirrelMail documentation about format of config/timezones.php file.\n";
2739 print "Desired time zone configuration (0,1,2,3)? [$WHT$time_zone_type$NRM]: $WHT";
2740 $new_time_zone_type = <STDIN
>;
2741 if ( $new_time_zone_type =~ /^[0123]\n/i ) {
2742 $time_zone_type = $new_time_zone_type;
2744 print "\nInvalid configuration value.\n";
2745 print "\nPress enter to continue...";
2748 $time_zone_type =~ s/[\r\n]//g;
2749 return $time_zone_type;
2752 # set the location base for redirects (since 1.5.2)
2753 sub command_config_location_base
{
2754 print "Here you can set the base part of the SquirrelMail URL.\n";
2755 print "It is normally autodetected but if that fails, use this\n";
2756 print "option to override.\n";
2757 print "It should contain only the protocol and hostname/port parts\n";
2758 print "of the URL; the full path will be appended automatically.\n\n";
2759 print "Examples:\nhttp://webmail.example.org\nhttp://webmail.example.com:8080\nhttps://webmail.example.com:6691\n\n";
2760 print "Do not add any path elements.\n";
2762 print "URL base? [" .$WHT."autodetect$NRM]: $WHT";
2763 $new_config_location_base = <STDIN
>;
2764 chomp($new_config_location_base);
2765 $config_location_base = $new_config_location_base;
2767 return $config_location_base;
2770 # only_secure_cookies (since 1.5.2)
2772 print "This option allows you to specify that if a user session is initiated\n";
2773 print "under a secure (HTTPS, SSL-encrypted) connection, the cookies given to\n";
2774 print "the browser will ONLY be transmitted via a secure connection henceforth.\n\n";
2775 print "Generally this is a Good Thing, and should NOT be disabled. However,\n";
2776 print "if you intend to use the Secure Login or Show SSL Link plugins to\n";
2777 print "encrypt the user login, but not the rest of the SquirrelMail session,\n";
2778 print "this can be turned off. Think twice before doing so.\n";
2781 if ( lc($only_secure_cookies) eq 'true' ) {
2782 $default_value = "y";
2784 $default_value = "n";
2786 print "Transmit cookies only on secure connection when available? (y/n) [$WHT$default_value$NRM]: $WHT";
2787 $only_secure_cookies = <STDIN
>;
2788 if ( ( $only_secure_cookies =~ /^y\n/i ) || ( ( $only_secure_cookies =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2789 $only_secure_cookies = 'true';
2791 $only_secure_cookies = 'false';
2793 return $only_secure_cookies;
2797 # disable_security_tokens (since 1.5.2)
2799 print "This option allows you to turn off the security checks in the forms\n";
2800 print "that SquirrelMail generates. It is NOT RECOMMENDED that you disable\n";
2801 print "this feature - otherwise, your users may be exposed to phishing and\n";
2802 print "other attacks.\n";
2803 print "Unless you know what you are doing, you should leave this set to \"NO\".\n";
2806 if ( lc($disable_security_tokens) eq 'true' ) {
2807 $default_value = "y";
2809 $default_value = "n";
2811 print "Disable secure forms? (y/n) [$WHT$default_value$NRM]: $WHT";
2812 $disable_security_tokens = <STDIN
>;
2813 if ( ( $disable_security_tokens =~ /^y\n/i ) || ( ( $disable_security_tokens =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2814 $disable_security_tokens = 'true';
2816 $disable_security_tokens = 'false';
2818 return $disable_security_tokens;
2823 # check_referrer (since 1.5.2)
2825 print "This option allows you to enable referal checks for all page requests\n";
2826 print "made to SquirrelMail. This can help ensure that page requests came\n";
2827 print "from the same server and not from an attacker's site (usually the\n";
2828 print "result of a XSS or phishing attack). To enable referal checking,\n";
2829 print "this setting can be set to the domain where your SquirrelMail is\n";
2830 print "being hosted (usually the same as the Domain setting under Server\n";
2831 print "Settings). For example, it could be \"example.com\", or if you\n";
2832 print "use a plugin (such as Login Manager) to host SquirrelMail on more\n";
2833 print "than one domain, you can set this to \"###DOMAIN###\" to tell it\n";
2834 print "to use the current domain.\n";
2836 print "However, in some cases (where proxy servers are in use, etc.), the\n";
2837 print "domain might be different.\n";
2839 print "NOTE that referal checks are not foolproof - they can be spoofed by\n";
2840 print "browsers, and some browsers intentionally don't send referal\n";
2841 print "information (in which case, the check is silently bypassed)\n";
2844 print "Referal requirement? [$WHT$check_referrer$NRM]: $WHT";
2845 $new_check_referrer = <STDIN
>;
2846 chomp($new_check_referrer);
2847 $check_referrer = $new_check_referrer;
2849 return $check_referrer;
2854 # use_transparent_security_image (since 1.5.2)
2856 print "When HTML messages are being displayed, SquirrelMail's default behavior\n";
2857 print "is to remove all remote images and replace them with a local one.\n";
2859 print "This option allows you to specify whether the local image should contain\n";
2860 print "text that indicates to the user that \"this image has been removed for\n";
2861 print "security reasons\" (translated into most languages), or if it should be\n";
2862 print "transparent.\n";
2865 if ( lc($use_transparent_security_image) eq 'true' ) {
2866 $default_value = "y";
2868 $default_value = "n";
2870 print "Use transparent security image? (y/n) [$WHT$default_value$NRM]: $WHT";
2871 $use_transparent_security_image = <STDIN
>;
2872 if ( ( $use_transparent_security_image =~ /^y\n/i ) || ( ( $use_transparent_security_image =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2873 $use_transparent_security_image = 'true';
2875 $use_transparent_security_image = 'false';
2877 return $use_transparent_security_image;
2882 sub command_userThemes
{
2883 print "\nDefine the user themes that you wish to use. If you have added\n";
2884 print "a theme of your own, just follow the instructions (?) about\n";
2885 print "how to add them. You can also change the default theme.\n\n";
2887 print "Available user themes:\n";
2889 while ( $count <= $#user_theme_name ) {
2890 if ( $count == $user_theme_default ) {
2895 if ( $count < 10 ) {
2898 $name = $user_theme_name[$count];
2899 $num_spaces = 35 - length($name);
2900 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2901 $name = $name . " ";
2904 print " $count. $name";
2905 print "($user_theme_path[$count])\n";
2911 print ".------------------------------------.\n";
2912 print "| t (detect user themes) |\n";
2913 print "| + (add user theme) |\n";
2914 print "| - N (remove user theme) |\n";
2915 print "| m N (mark default user theme) |\n";
2916 print "| l (list user themes) |\n";
2917 print "| d (done) |\n";
2918 print "`------------------------------------'\n";
2920 print "\n[user_themes] command (?=help) > ";
2922 $input =~ s/[\r\n]//g;
2923 while ( $input ne "d" ) {
2924 if ( $input =~ /^\s*l\s*/i ) {
2926 while ( $count <= $#user_theme_name ) {
2927 if ( $count == $user_theme_default ) {
2932 if ( $count < 10 ) {
2935 $name = $user_theme_name[$count];
2936 $num_spaces = 35 - length($name);
2937 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2938 $name = $name . " ";
2941 print " $count. $name";
2942 print "($user_theme_path[$count])\n";
2946 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2947 $old_def = $user_theme_default;
2948 $user_theme_default = $input;
2949 $user_theme_default =~ s/^\s*m\s*//;
2950 if ( ( $user_theme_default > $#user_theme_name ) || ( $user_theme_default < 0 ) ) {
2951 print "Cannot set default theme to $user_theme_default. That theme does not exist.\n";
2952 $user_theme_default = $old_def;
2954 } elsif ( $input =~ /^\s*\+/ ) {
2955 print "What is the name of this theme? ";
2957 $name =~ s/[\r\n]//g;
2958 $user_theme_name[ $#user_theme_name + 1 ] = $name;
2959 print "Be sure to put ../css/ before the filename.\n";
2960 print "What file is this stored in (ex: ../css/my_theme/): ";
2962 $name =~ s/[\r\n]//g;
2963 $user_theme_path[ $#user_theme_path + 1 ] = $name;
2964 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2965 if ( $input =~ /[0-9]+\s*$/ ) {
2967 $rem_num =~ s/^\s*-\s*//g;
2968 $rem_num =~ s/\s*$//;
2970 $rem_num = $#user_theme_name;
2972 if ( $rem_num == $user_theme_default ) {
2973 print "You cannot remove the default theme!\n";
2976 @new_theme_name = ();
2977 @new_theme_path = ();
2978 while ( $count <= $#user_theme_name ) {
2979 if ( $count != $rem_num ) {
2980 @new_theme_name = ( @new_theme_name, $user_theme_name[$count] );
2981 @new_theme_path = ( @new_theme_path, $user_theme_path[$count] );
2985 @user_theme_name = @new_theme_name;
2986 @user_theme_path = @new_theme_path;
2987 if ( $user_theme_default > $rem_num ) {
2988 $user_theme_default--;
2991 } elsif ( $input =~ /^\s*t\s*/i ) {
2992 print "\nStarting detection...\n\n";
2994 opendir( DIR
, "../css" );
2995 @files = sort(readdir(DIR
));
2997 while ( $cnt <= $#files ) {
2998 $filename = "../css/" . $files[$cnt] .'/';
2999 if ( $files[$cnt] !~ /^\./ && $filename ne "../css/rtl.css" && -e
$filename . "default.css" ) {
3001 for ( $x = 0 ; $x <= $#user_theme_path ; $x++ ) {
3002 if ( $user_theme_path[$x] eq $filename ) {
3006 if ( $found != 1 ) {
3007 print "** Found user theme: $filename\n";
3008 $def = $files[$cnt];
3011 #$def =~ s/(^\w+)/ucfirst $1/eg;
3012 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3013 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3014 print " What is its name? [$def]: ";
3016 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3017 if ( $nm eq '' ) { $nm = $def; }
3018 $user_theme_name[ $#user_theme_name + 1 ] = $nm;
3019 $user_theme_path[ $#user_theme_path + 1 ] = $filename;
3025 for ( $cnt = 0 ; $cnt <= $#user_theme_path ; $cnt++ ) {
3026 $filename = $user_theme_path[$cnt];
3027 if ( $filename != 'none' && !( -e
$filename ."/default.css" ) ) {
3028 print " Removing $filename (file not found)\n";
3030 @new_user_theme_name = ();
3031 @new_user_theme_path = ();
3032 for ( $x = 0 ; $x < $#user_theme_path ; $x++ ) {
3033 if ( $user_theme_path[$x] eq $filename ) {
3036 if ( $offset == 1 ) {
3037 $new_user_theme_name[$x] = $user_theme_name[ $x + 1 ];
3038 $new_user_theme_path[$x] = $user_theme_path[ $x + 1 ];
3040 $new_user_theme_name[$x] = $user_theme_name[$x];
3041 $new_user_theme_path[$x] = $user_theme_path[$x];
3044 @user_theme_name = @new_user_theme_name;
3045 @user_theme_path = @new_user_theme_path;
3048 print "\nDetection complete!\n\n";
3051 } elsif ( $input =~ /^\s*\?\s*/ ) {
3052 print ".------------------------------------.\n";
3053 print "| t (detect user themes) |\n";
3054 print "| + (add user theme) |\n";
3055 print "| - N (remove user theme) |\n";
3056 print "| m N (mark default user theme) |\n";
3057 print "| l (list user themes) |\n";
3058 print "| d (done) |\n";
3059 print "`------------------------------------'\n";
3061 print "[user_themes] command (?=help) > ";
3063 $input =~ s/[\r\n]//g;
3067 sub command_iconSets
{
3068 print "\nDefine the icon themes that you wish to use. If you have added\n";
3069 print "a theme of your own, just follow the instructions (?) about\n";
3070 print "how to add them. You can also change the default and fallback\n";
3071 print "themes. The default theme will be used when no icon theme is\n";
3072 print "set by the user. The fallback theme will be used if an icon\n";
3073 print "cannot be found in the currently selected icon theme.\n\n";
3075 print "Available icon themes:\n\n";
3078 while ( $count <= $#icon_theme_name ) {
3079 if ( $count == $icon_theme_def ) {
3084 if ( $count eq $icon_theme_fallback ) {
3089 if ( $count < 10 ) {
3092 $name = $icon_theme_name[$count];
3093 $num_spaces = 35 - length($name);
3094 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3095 $name = $name . " ";
3098 print " $count. $name";
3099 print "($icon_theme_path[$count])\n";
3104 print "\n d = Default icon theme\n";
3105 print " f = Fallback icon theme\n";
3107 print ".------------------------------------.\n";
3108 print "| t (detect icon themes) |\n";
3109 print "| + (add icon theme) |\n";
3110 print "| - N (remove icon theme) |\n";
3111 print "| m N (mark default icon theme) |\n";
3112 print "| f N (set fallback icon set) |\n";
3113 print "| l (list icon themes) |\n";
3114 print "| d (done) |\n";
3115 print "`------------------------------------'\n";
3117 print "\n[icon_themes] command (?=help) > ";
3119 $input =~ s/[\r\n]//g;
3120 while ( $input ne "d" ) {
3121 if ( $input =~ /^\s*l\s*/i ) {
3124 while ( $count <= $#icon_theme_name ) {
3125 if ( $count == $icon_theme_def ) {
3130 if ( $count eq $icon_theme_fallback ) {
3135 $name = $icon_theme_name[$count];
3136 $num_spaces = 35 - length($name);
3137 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3138 $name = $name . " ";
3141 print " $count. $name";
3142 print "($icon_theme_path[$count])\n";
3146 print "\n d = Default icon theme\n";
3147 print " f = Fallback icon theme\n\n";
3148 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
3149 $old_def = $icon_theme_def;
3150 $icon_theme_def = $input;
3151 $icon_theme_def =~ s/^\s*m\s*//;
3152 if ( ( $icon_theme_default > $#icon_theme_name ) || ( $icon_theme_default < 0 ) ) {
3153 print "Cannot set default icon theme to $icon_theme_default. That theme does not exist.\n";
3154 $icon_theme_def = $old_def;
3156 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
3157 $old_fb = $icon_theme_fallback;
3158 $icon_theme_fallback = $input;
3159 $icon_theme_fallback =~ s/^\s*f\s*//;
3160 if ( ( $icon_theme_fallback > $#icon_theme_name ) || ( $icon_theme_fallback < 0 ) ) {
3161 print "Cannot set fallback icon theme to $icon_theme_fallback. That theme does not exist.\n";
3162 $icon_theme_fallback = $old_fb;
3164 } elsif ( $input =~ /^\s*\+/ ) {
3165 print "What is the name of this icon theme? ";
3167 $name =~ s/[\r\n]//g;
3168 $icon_theme_name[ $#icon_theme_name + 1 ] = $name;
3169 print "Be sure to put ../images/themes/ before the filename.\n";
3170 print "What directory is this icon theme stored in (ex: ../images/themes/my_theme/)? ";
3172 $name =~ s/[\r\n]//g;
3173 $icon_theme_path[ $#icon_theme_path + 1 ] = $name;
3174 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3175 if ( $input =~ /[0-9]+\s*$/ ) {
3177 $rem_num =~ s/^\s*-\s*//g;
3178 $rem_num =~ s/\s*$//;
3180 $rem_num = $#icon_theme_name;
3182 if ( $rem_num == $icon_theme_def ) {
3183 print "You cannot remove the default icon theme!\n";
3184 } elsif ( $rem_num == $icon_theme_fallback ) {
3185 print "You cannot remove the fallback icon theme!\n";
3188 @new_theme_name = ();
3189 @new_theme_path = ();
3190 while ( $count <= $#icon_theme_name ) {
3191 if ( $count != $rem_num ) {
3192 @new_theme_name = ( @new_theme_name, $icon_theme_name[$count] );
3193 @new_theme_path = ( @new_theme_path, $icon_theme_path[$count] );
3197 @icon_theme_name = @new_theme_name;
3198 @icon_theme_path = @new_theme_path;
3199 if ( $icon_theme_def > $rem_num ) {
3203 } elsif ( $input =~ /^\s*t\s*/i ) {
3204 print "\nStarting detection...\n\n";
3206 opendir( DIR
, "../images/themes/" );
3207 @files = sort(readdir(DIR
));
3209 while ( $cnt <= $#files ) {
3210 $filename = "../images/themes/" . $files[$cnt] .'/';
3211 if ( -d
"../images/themes/" . $files[$cnt] && $files[$cnt] !~ /^\
./ && $files[$cnt] ne ".svn" ) {
3213 for ( $x = 0 ; $x <= $#icon_theme_path ; $x++ ) {
3214 if ( $icon_theme_path[$x] eq $filename ) {
3218 if ( $found != 1 ) {
3219 print "** Found icon theme: $filename\n";
3220 $def = $files[$cnt];
3223 #$def =~ s/(^\w+)/ucfirst $1/eg;
3224 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3225 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3226 print " What is its name? [$def]: ";
3228 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3229 if ( $nm eq '' ) { $nm = $def; }
3230 $icon_theme_name[ $#icon_theme_name + 1 ] = $nm;
3231 $icon_theme_path[ $#icon_theme_path + 1 ] = $filename;
3237 for ( $cnt = 0 ; $cnt <= $#icon_theme_path ; $cnt++ ) {
3238 $filename = $icon_theme_path[$cnt];
3239 if ( $filename ne "none" && $filename ne "template" && ! -d
$filename ) {
3240 print " Removing $filename (file not found)\n";
3242 @new_icon_theme_name = ();
3243 @new_icon_theme_path = ();
3244 for ( $x = 0 ; $x < $#icon_theme_path ; $x++ ) {
3245 if ( $icon_theme_path[$x] eq $filename ) {
3248 if ( $offset == 1 ) {
3249 $new_icon_theme_name[$x] = $icon_theme_name[ $x + 1 ];
3250 $new_icon_theme_path[$x] = $icon_theme_path[ $x + 1 ];
3252 $new_icon_theme_name[$x] = $icon_theme_name[$x];
3253 $new_icon_theme_path[$x] = $icon_theme_path[$x];
3256 @icon_theme_name = @new_icon_theme_name;
3257 @icon_theme_path = @new_icon_theme_path;
3260 print "\nDetection complete!\n\n";
3263 } elsif ( $input =~ /^\s*\?\s*/ ) {
3264 print ".------------------------------------.\n";
3265 print "| t (detect icon themes) |\n";
3266 print "| + (add icon theme) |\n";
3267 print "| - N (remove icon theme) |\n";
3268 print "| m N (mark default icon theme) |\n";
3269 print "| f N (set fallback icon set) |\n";
3270 print "| l (list icon themes) |\n";
3271 print "| d (done) |\n";
3272 print "`------------------------------------'\n";
3274 print "[icon_themes] command (?=help) > ";
3276 $input =~ s/[\r\n]//g;
3280 sub command_templates
{
3281 print "\nDefine the template sets (skins) that you wish to use. If you have added\n";
3282 print "a template set of your own, just follow the instructions (?) about\n";
3283 print "how to add them. You can also change the default template.\n";
3285 print "\n Available Templates:\n";
3288 while ( $count <= $#templateset_name ) {
3289 if ( $templateset_id[$count] eq $templateset_default ) {
3294 if ( $templateset_id[$count] eq $templateset_fallback ) {
3299 if ( $templateset_id[$count] eq $rpc_templateset ) {
3304 if ( $count < 10 ) {
3307 if ( $count < 100 ) {
3310 $name = $templateset_name[$count];
3312 # present RPC template sets differently
3314 if ( $templateset_id[$count] =~ /_rpc$/ ) {
3315 $name = $name . " (not shown in user interface; used for RPC interface only)";
3318 $num_spaces = 35 - length($name);
3319 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3320 $name = $name . " ";
3322 $name = $name . "($templateset_id[$count])";
3326 print " $count. $name\n";
3330 print "\n d = default template set\n"
3331 . " f = fallback template set\n"
3332 . " r = RPC template set\n\n";
3334 $menu_text = ".-------------------------------------.\n"
3335 . "| t (detect template set) |\n"
3336 . "| + (add template set) |\n"
3337 . "| - N (remove template set) |\n"
3338 . "| m N (mark default template set) |\n"
3339 . "| f N (set fallback template set) |\n"
3340 . "| r N (set RPC template set) |\n"
3341 . "| l (list template sets/skins) |\n"
3343 . "|-------------------------------------|\n"
3344 . "| where N is a template set number |\n"
3345 . "`-------------------------------------'\n";
3348 print "\n[template set] command (?=help) > ";
3351 $input =~ s/[\r\n]//g;
3352 while ( $input ne "d" ) {
3354 # list template sets
3356 if ( $input =~ /^\s*l\s*/i ) {
3358 while ( $count <= $#templateset_name ) {
3359 if ( $templateset_id[$count] eq $templateset_default ) {
3364 if ( $templateset_id[$count] eq $templateset_fallback ) {
3369 if ( $templateset_id[$count] eq $rpc_templateset ) {
3374 if ( $count < 10 ) {
3377 if ( $count < 100 ) {
3380 $name = $templateset_name[$count];
3382 # present RPC template sets differently
3384 if ( $templateset_id[$count] =~ /_rpc$/ ) {
3385 $name = $name . " (not shown in user interface; used for RPC interface only)";
3388 $num_spaces = 35 - length($name);
3389 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3390 $name = $name . " ";
3392 $name = $name . "($templateset_id[$count])";
3396 print " $count. $name\n";
3400 print "\n d = default template set\n"
3401 . " f = fallback template set\n"
3402 . " r = RPC template set\n\n";
3404 # mark default template set
3406 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
3407 $old_def = $templateset_default;
3408 $input =~ s/^\s*m\s*//;
3409 $templateset_default = $templateset_id[$input];
3410 if ( $templateset_default =~ /^\s*$/ ) {
3411 print "Cannot set default template set to $input. That template set does not exist.\n";
3412 $templateset_default = $old_def;
3414 if ( $templateset_default =~ /_rpc$/ ) {
3415 print "Cannot set default template set to $input. That template set is intended for the RPC interface only.\n";
3416 $templateset_default = $old_def;
3419 # set fallback template set
3421 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
3422 $old_def = $templateset_fallback;
3423 $input =~ s/^\s*f\s*//;
3424 $templateset_fallback = $templateset_id[$input];
3425 if ( $templateset_fallback =~ /^\s*$/ ) {
3426 print "Cannot set fallback template set to $input. That template set does not exist.\n";
3427 $templateset_fallback = $old_def;
3429 if ( $templateset_fallback =~ /_rpc$/ ) {
3430 print "Cannot set fallback template set to $input. That template set is intended for the RPC interface only.\n";
3431 $templateset_fallback = $old_def;
3434 # set RPC template set
3436 } elsif ( $input =~ /^\s*r\s*[0-9]+/i ) {
3437 $old_def = $rpc_templateset;
3438 $input =~ s/^\s*r\s*//;
3439 $rpc_templateset = $templateset_id[$input];
3440 if ( $rpc_templateset =~ /^\s*$/ ) {
3441 print "Cannot set RPC template set to $input. That template set does not exist.\n";
3442 $rpc_templateset = $old_def;
3444 if ( $rpc_templateset !~ /_rpc$/ ) {
3445 print "Cannot set fallback template set to $input. That template set is not intended for the RPC interface.\n";
3446 $rpc_templateset = $old_def;
3451 } elsif ( $input =~ /^\s*\+/ ) {
3452 print "\nWhat is the name of this template (as shown to your users): ";
3454 $name =~ s/[\r\n]//g;
3455 $templateset_name[ $#templateset_name + 1 ] = $name;
3456 print "\n\nThe directory name should not contain any path information\n"
3457 . "or slashes, and should be the name of the directory that the\n"
3458 . "template set is found in within the SquirrelMail templates\n"
3460 print "What directory is this stored in (ex: default_advanced): ";
3462 $name =~ s/[\r\n]//g;
3463 $templateset_id[ $#templateset_id + 1 ] = $name;
3465 # detect template sets
3467 } elsif ( $input =~ /^\s*t\s*/i ) {
3468 print "\nStarting detection...\n\n";
3469 opendir( DIR
, "../templates" );
3470 @files = sort(readdir(DIR
));
3472 while ( $cnt <= $#files ) {
3473 if ( -d
"../templates/" . $files[$cnt] && $files[$cnt] !~ /^\./ && $files[$cnt] ne ".svn" ) {
3474 $filename = $files[$cnt];
3476 for ( $x = 0 ; $x <= $#templateset_id ; $x++ ) {
3477 if ( $templateset_id[$x] eq $filename ) {
3483 print "** Found template set: $filename\n";
3484 $def = $files[$cnt];
3486 # no user-friendly names needed for RPC template sets
3488 if ( $def =~ /_rpc$/ ) {
3493 #$def =~ s/(^\w+)/ucfirst $1/eg;
3494 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3495 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3496 print " What is it's name (as shown to your users)? [$def]: ";
3498 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3499 if ( $nm eq '' ) { $nm = $def; }
3501 $templateset_id[ $#templateset_id + 1 ] = $filename;
3502 $templateset_name[ $#templateset_name + 1 ] = $nm;
3508 for ( $cnt= 0 ; $cnt <= $#templateset_id ; ) {
3509 $filename = $templateset_id[$cnt];
3510 if ( !(-d change_to_rel_path
('SM_PATH . \'templates/' . $filename)) ) {
3511 print " Removing \"$filename\" (template set directory not found)\n";
3512 if ( $templateset_default eq $filename ) { $templateset_default = 'default'; }
3513 if ( $templateset_fallback eq $filename ) { $templateset_fallback = 'default'; }
3514 if ( $rpc_templateset eq $filename ) { $rpc_templateset = 'default_rpc'; }
3516 @new_templateset_name = ();
3517 @new_templateset_id = ();
3518 for ( $x = 0 ; $x < $#templateset_id ; $x++ ) {
3519 if ( $templateset_id[$x] eq $filename ) {
3522 if ( $offset == 1 ) {
3523 $new_templateset_name[$x] = $templateset_name[ $x + 1 ];
3524 $new_templateset_id[$x] = $templateset_id[ $x + 1 ];
3526 $new_templateset_name[$x] = $templateset_name[$x];
3527 $new_templateset_id[$x] = $templateset_id[$x];
3530 @templateset_name = @new_templateset_name;
3531 @templateset_id = @new_templateset_id;
3534 print "\nDetection complete!\n\n";
3538 # remove template set
3540 # undocumented functionality of removing last template set isn't that great
3541 #} elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3542 } elsif ( $input =~ /^\s*-\s*[0-9]+/ ) {
3543 if ( $input =~ /[0-9]+\s*$/ ) {
3545 $rem_num =~ s/^\s*-\s*//g;
3546 $rem_num =~ s/\s*$//;
3548 $rem_num = $#templateset_name;
3550 if ( $templateset_id[$rem_num] eq $templateset_default ) {
3551 print "You cannot remove the default template set!\n";
3552 } elsif ( $templateset_id[$rem_num] eq $templateset_fallback ) {
3553 print "You cannot remove the fallback template set!\n";
3554 } elsif ( $templateset_id[$rem_num] eq $rpc_templateset ) {
3555 print "You cannot remove the RPC template set!\n";
3558 @new_templateset_name = ();
3559 @new_templateset_id = ();
3560 while ( $count <= $#templateset_name ) {
3561 if ( $count != $rem_num ) {
3562 @new_templateset_name = ( @new_templateset_name, $templateset_name[$count] );
3563 @new_templateset_id = ( @new_templateset_id, $templateset_id[$count] );
3567 @templateset_name = @new_templateset_name;
3568 @templateset_id = @new_templateset_id;
3573 } elsif ( $input =~ /^\s*\?\s*/ ) {
3576 # command not understood
3579 print "Command not understood\n";
3582 print "[template set] command (?=help) > ";
3584 $input =~ s/[\r\n]//g;
3586 return $templateset_default;
3590 # sets default font size option
3591 sub command_default_fontsize
{
3592 print "Enter default font size [$WHT$$default_fontsize$NRM]: $WHT";
3593 $new_size = <STDIN
>;
3594 if ( $new_size eq "\n" ) {
3597 $new_size =~ s/[\r\n]//g;
3602 # controls available fontsets
3603 sub command_fontsets
{
3605 print "You can control fontsets available to end users here.\n";
3606 # set initial $input value
3608 while ( $input ne "x" ) {
3609 if ( $input =~ /^\s*a\s*/i ) {
3611 print "\nFontset name: ";
3613 if (! $fontsets{trim
($name)}) {
3614 print "Fontset string: ";
3616 $fontsets{trim
($name)} = trim
($value);
3618 print "\nERROR: Such fontset already exists.\n";
3620 } elsif ( $input =~ /^\s*e\s*/i ) {
3621 # edit existing fontset
3622 print "\nFontset name: ";
3624 if (! $fontsets{trim
($name)}) {
3625 print "\nERROR: No such fontset.\n";
3627 print "Fontset string [$fontsets{trim($name)}]: ";
3629 $fontsets{trim
($name)} = trim
($value);
3631 } elsif ( $input =~ /^\s*d\s*/ ) {
3632 # delete existing fontset
3633 print "\nFontset name: ";
3635 if (! $fontsets{trim
($name)}) {
3636 print "\nERROR: No such fontset.\n";
3638 delete $fontsets{trim
($name)};
3640 } elsif ( $input =~ /^\s*l\s*/ ) {
3642 print "\nConfigured fontsets:\n";
3643 while (($fontset_name, $fontset_string) = each(%fontsets)) {
3644 print " $fontset_name = $fontset_string\n";
3646 print "Default fontset: $default_fontset\n";
3647 } elsif ( $input =~ /^\s*m\s*/ ) {
3648 # set default fontset
3649 print "\nSet default fontset [$default_fontset]: ";
3651 if (trim
($name) ne '' and ! $fontsets{trim
($name)}) {
3652 print "\nERROR: No such fontset.\n";
3654 $default_fontset = trim
($name);
3657 # print available commands on any other input
3658 print "\nAvailable commands:\n";
3659 print " a - Adds new fontset.\n";
3660 print " d - Deletes existing fontset.\n";
3661 print " e - Edits existing fontset.\n";
3662 print " h or ? - Shows this help screen.\n";
3663 print " l - Lists available fontsets.\n";
3664 print " m - Sets default fontset.\n";
3665 print " x - Exits fontset editor mode.\n";
3667 print "\nCommand [fontsets] (a,d,e,h,?=help,l,m,x)> ";
3669 $input =~ s/[\r\n]//g;
3674 print "You can now define different LDAP servers.\n";
3675 print "Please ensure proper permissions for config.php when including\n";
3676 print "sensitive passwords.\n\n";
3677 print "[ldap] command (?=help) > ";
3679 $input =~ s/[\r\n]//g;
3680 while ( $input ne "d" ) {
3681 if ( $input =~ /^\s*l\s*/i ) {
3683 while ( $count <= $#ldap_host ) {
3684 print "$count. $ldap_host[$count]\n";
3685 print " base: $ldap_base[$count]\n";
3686 if ( $ldap_charset[$count] ) {
3687 print " charset: $ldap_charset[$count]\n";
3689 if ( $ldap_port[$count] ) {
3690 print " port: $ldap_port[$count]\n";
3692 if ( $ldap_name[$count] ) {
3693 print " name: $ldap_name[$count]\n";
3695 if ( $ldap_maxrows[$count] ) {
3696 print " maxrows: $ldap_maxrows[$count]\n";
3698 if ( $ldap_filter[$count] ) {
3699 print " filter: $ldap_filter[$count]\n";
3701 if ( $ldap_binddn[$count] ) {
3702 print " binddn: $ldap_binddn[$count]\n";
3703 if ( $ldap_bindpw[$count] ) {
3704 print " bindpw: $ldap_bindpw[$count]\n";
3707 if ( $ldap_protocol[$count] ) {
3708 print " protocol: $ldap_protocol[$count]\n";
3710 if ( $ldap_limit_scope[$count] ) {
3711 print " limit_scope: $ldap_limit_scope[$count]\n";
3713 if ( $ldap_listing[$count] ) {
3714 print " listing: $ldap_listing[$count]\n";
3716 if ( $ldap_writeable[$count] ) {
3717 print " writeable: $ldap_writeable[$count]\n";
3719 if ( $ldap_search_tree[$count] ) {
3720 print " search_tree: $ldap_search_tree[$count]\n";
3722 if ( $ldap_starttls[$count] ) {
3723 print " starttls: $ldap_starttls[$count]\n";
3729 } elsif ( $input =~ /^\s*\+/ ) {
3730 $sub = $#ldap_host + 1;
3732 print "First, we need to have the hostname or the IP address where\n";
3733 print "this LDAP server resides. Example: ldap.bigfoot.com\n";
3735 print "You can use any URI compatible with your LDAP library. Please\n";
3736 print "note that StartTLS option is not compatible with ldaps and\n";
3737 print "ldapi URIs.\n";
3740 $name =~ s/[\r\n]//g;
3741 $ldap_host[$sub] = $name;
3745 print "Next, we need the server root (base dn). For this, an empty\n";
3746 print "string is allowed.\n";
3747 print "Example: ou=member_directory,o=netcenter.com\n";
3750 $name =~ s/[\r\n]//g;
3751 $ldap_base[$sub] = $name;
3755 print "This is the TCP/IP port number for the LDAP server. Default\n";
3756 print "port is 389. This is optional. Press ENTER for default.\n";
3759 $name =~ s/[\r\n]//g;
3760 $ldap_port[$sub] = $name;
3764 print "This is the charset for the server. Default is utf-8. This\n";
3765 print "is also optional. Press ENTER for default.\n";
3768 $name =~ s/[\r\n]//g;
3769 $ldap_charset[$sub] = $name;
3773 print "This is the name for the server, used to tag the results of\n";
3774 print "the search. Default it \"LDAP: hostname\". Press ENTER for default\n";
3777 $name =~ s/[\r\n]//g;
3778 $ldap_name[$sub] = $name;
3782 print "You can specify the maximum number of rows in the search result.\n";
3783 print "Default value is equal to 250 rows. Press ENTER for default.\n";
3786 $name =~ s/[\r\n]//g;
3787 $ldap_maxrows[$sub] = $name;
3792 print "If your LDAP server does not like anonymous logins, you can specify bind DN.\n";
3793 print "Default is none, anonymous bind. Press ENTER for default.\n";
3796 $name =~ s/[\r\n]//g;
3797 $ldap_binddn[$sub] = $name;
3801 if ( $ldap_binddn[$sub] ne '' ) {
3803 print "Now, please specify password for that DN.\n";
3806 $name =~ s/[\r\n]//g;
3807 $ldap_bindpw[$sub] = $name;
3812 print "You can specify bind protocol version here.\n";
3813 print "Default protocol version depends on your php ldap settings.\n";
3814 print "Press ENTER for default.\n";
3817 $name =~ s/[\r\n]//g;
3818 $ldap_protocol[$sub] = $name;
3822 print "This configuration section allows to set some rarely used\n";
3823 print "options and options specific to some LDAP implementations.\n";
3825 print "Do you want to set advanced LDAP directory settings? (y/N):";
3826 $ldap_advanced_settings = <STDIN
>;
3827 if ( $ldap_advanced_settings =~ /^y\n/i ) {
3828 $ldap_advanced_settings = 'true';
3830 $ldap_advanced_settings = 'false';
3833 if ($ldap_advanced_settings eq 'true') {
3836 print "You can control LDAP directory listing here. This option can\n";
3837 print "be useful if you run small LDAP server and want to provide listing\n";
3838 print "of all addresses stored in LDAP to users of webmail interface.\n";
3839 print "Number of displayed entries is limited by maxrows setting.\n";
3841 print "Don't enable this option for public LDAP directories.\n";
3843 print "Allow listing of LDAP directory? (y/N):";
3845 if ( $name =~ /^y\n/i ) {
3850 $ldap_listing[$sub] = $name;
3854 print "You can control write access to LDAP address book here. This option can\n";
3855 print "be useful if you run small LDAP server and want to provide writable\n";
3856 print "shared address book stored in LDAP to users of webmail interface.\n";
3858 print "Don't enable this option for public LDAP directories.\n";
3860 print "Allow writing to LDAP directory? (y/N):";
3862 if ( $name =~ /^y\n/i ) {
3867 $ldap_writeable[$sub] = $name;
3871 print "You can specify an additional search filter.\n";
3872 print "This could be something like \"(objectclass=posixAccount)\".\n";
3873 print "No filtering is performed by default. Press ENTER for default.\n";
3876 $name =~ s/[\r|\n]//g;
3877 $ldap_filter[$sub] = $name;
3881 print "You can control search scope here.\n";
3882 print "This option is specific to Microsoft ADS implementation.\n";
3883 print "It requires use of v3 or newer LDAP protocol.\n";
3884 print "Don't enable it, if you use other LDAP server.\n";
3886 print "Limit ldap scope? (y/N):";
3888 if ( $name =~ /^y\n/i ) {
3893 $ldap_limit_scope[$sub] = $name;
3897 print "You can control ldap search type here.\n";
3898 print "Addresses can be searched in entire LDAP subtree (default)\n";
3899 print "or only first level entries are returned.\n";
3901 print "Search entire LDAP subtree? (Y/n):";
3903 if ( $name =~ /^n\n/i ) {
3908 $ldap_search_tree[$sub] = $name;
3912 print "You can control use of StartTLS on LDAP connection here.\n";
3913 print "This option requires use of v3 or newer LDAP protocol and php 4.2+.\n";
3915 print "Use StartTLS? (y/N):";
3917 if ( $name =~ /^y\n/i ) {
3922 $ldap_starttls[$sub] = $name;
3926 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3927 if ( $input =~ /[0-9]+\s*$/ ) {
3929 $rem_num =~ s/^\s*-\s*//g;
3930 $rem_num =~ s/\s*$//;
3932 $rem_num = $#ldap_host;
3935 @new_ldap_host = ();
3936 @new_ldap_base = ();
3937 @new_ldap_port = ();
3938 @new_ldap_name = ();
3939 @new_ldap_charset = ();
3940 @new_ldap_maxrows = ();
3941 @new_ldap_filter = ();
3942 @new_ldap_bindpw = ();
3943 @new_ldap_binddn = ();
3944 @new_ldap_protocol = ();
3945 @new_ldap_limit_scope = ();
3946 @new_ldap_listing = ();
3947 @new_ldap_writeable = ();
3948 @new_ldap_search_tree = ();
3949 @new_ldap_starttls = ();
3951 while ( $count <= $#ldap_host ) {
3952 if ( $count != $rem_num ) {
3953 @new_ldap_host = ( @new_ldap_host, $ldap_host[$count] );
3954 @new_ldap_base = ( @new_ldap_base, $ldap_base[$count] );
3955 @new_ldap_port = ( @new_ldap_port, $ldap_port[$count] );
3956 @new_ldap_name = ( @new_ldap_name, $ldap_name[$count] );
3957 @new_ldap_charset = ( @new_ldap_charset, $ldap_charset[$count] );
3958 @new_ldap_maxrows = ( @new_ldap_maxrows, $ldap_maxrows[$count] );
3959 @new_ldap_filter = ( @new_ldap_filter, $ldap_filter[$count] );
3960 @new_ldap_binddn = ( @new_ldap_binddn, $ldap_binddn[$count] );
3961 @new_ldap_bindpw = ( @new_ldap_bindpw, $ldap_bindpw[$count] );
3962 @new_ldap_protocol = ( @new_ldap_protocol, $ldap_protocol[$count] );
3963 @new_ldap_limit_scope = ( @new_ldap_limit_scope, $ldap_limit_scope[$count] );
3964 @new_ldap_listing = ( @new_ldap_listing, $ldap_listing[$count] );
3965 @new_ldap_writeable = ( @new_ldap_writeable, $ldap_writeable[$count] );
3966 @new_ldap_search_tree = ( @new_ldap_search_tree, $ldap_search_tree[$count] );
3967 @new_ldap_starttls = ( @new_ldap_starttls, $ldap_starttls[$count] );
3971 @ldap_host = @new_ldap_host;
3972 @ldap_base = @new_ldap_base;
3973 @ldap_port = @new_ldap_port;
3974 @ldap_name = @new_ldap_name;
3975 @ldap_charset = @new_ldap_charset;
3976 @ldap_maxrows = @new_ldap_maxrows;
3977 @ldap_filter = @new_ldap_filter;
3978 @ldap_binddn = @new_ldap_binddn;
3979 @ldap_bindpw = @new_ldap_bindpw;
3980 @ldap_protocol = @new_ldap_protocol;
3981 @ldap_limit_scope = @new_ldap_limit_scope;
3982 @ldap_listing = @new_ldap_listing;
3983 @ldap_writeable = @new_ldap_writeable;
3984 @ldap_search_tree = @new_ldap_search_tree;
3985 @ldap_starttls = @new_ldap_starttls;
3987 } elsif ( $input =~ /^\s*\?\s*/ ) {
3988 print ".-------------------------.\n";
3989 print "| + (add host) |\n";
3990 print "| - N (remove host) |\n";
3991 print "| l (list hosts) |\n";
3992 print "| d (done) |\n";
3993 print "`-------------------------'\n";
3995 print "[ldap] command (?=help) > ";
3997 $input =~ s/[\r\n]//g;
4002 print "Some of our developers have come up with very good javascript interface\n";
4003 print "for searching through address books, however, our original goals said\n";
4004 print "that we would be 100% HTML. In order to make it possible to use their\n";
4005 print "interface, and yet stick with our goals, we have also written a plain\n";
4006 print "HTML version of the search. Here, you can choose which version to use.\n";
4008 print "This is just the default value. It is also a user option that each\n";
4009 print "user can configure individually\n";
4012 if ( lc($default_use_javascript_addr_book) eq 'true' ) {
4013 $default_value = "y";
4015 $default_use_javascript_addr_book = 'false';
4016 $default_value = "n";
4018 print "Use javascript version by default (y/n) [$WHT$default_value$NRM]: $WHT";
4019 $new_show = <STDIN
>;
4020 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4021 $default_use_javascript_addr_book = 'true';
4023 $default_use_javascript_addr_book = 'false';
4025 return $default_use_javascript_addr_book;
4028 # global filebased address book
4030 print "If you want to use global file address book, then you\n";
4031 print "must set this option to a valid value. If option does\n";
4032 print "not have path elements, system assumes that file is\n";
4033 print "stored in data directory. If relative path is set, it is\n";
4034 print "relative to main SquirrelMail directory. If value is empty,\n";
4035 print "address book is not enabled.\n";
4038 print "[$WHT$abook_global_file$NRM]: $WHT";
4039 $new_abook_global_file = <STDIN
>;
4040 if ( $new_abook_global_file eq "\n" ) {
4041 $new_abook_global_file = $abook_global_file;
4043 $new_abook_global_file =~ s/[\r\n]//g;
4045 return $new_abook_global_file;
4048 # writing into global filebased abook control
4050 print "This setting controls writing into global file address\n";
4051 print "book options. Address book file must be writeable by\n";
4052 print "webserver's user, if you want to enable this option.\n";
4055 if ( lc($abook_global_file_writeable) eq 'true' ) {
4056 $default_value = "y";
4058 $abook_global_file_writeable = 'false';
4059 $default_value = "n";
4061 print "Allow writing into global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
4062 $new_show = <STDIN
>;
4063 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4064 $abook_global_file_writeable = 'true';
4066 $abook_global_file_writeable = 'false';
4068 return $abook_global_file_writeable;
4071 # listing of global filebased abook control
4073 print "This setting controls listing of global file address\n";
4074 print "book in addresses page.\n";
4077 if ( lc($abook_global_file_listing) eq 'true' ) {
4078 $default_value = "y";
4080 $abook_global_file_listing = 'false';
4081 $default_value = "n";
4083 print "Allow listing of global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
4084 $new_show = <STDIN
>;
4085 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4086 $abook_global_file_listing = 'true';
4088 $abook_global_file_listing = 'false';
4090 return $abook_global_file_listing;
4093 # controls $abook_file_line_length setting
4094 sub command_abook_file_line_length
{
4095 print "This setting controls space allocated to file based address book records.\n";
4096 print "End users will be unable to save address book entry, if total entry size \n";
4097 print "(quoted address book fields + 4 delimiters + linefeed) exceeds allowed \n";
4098 print "address book length size.\n";
4100 print "Same setting is applied to personal and global file based address books.\n";
4102 print "It is strongly recommended to keep default setting value. Change it only\n";
4103 print "if you really want to store address book entries that are bigger than two\n";
4104 print "kilobytes (2048).\n";
4107 print "Enter allowed address book line length [$abook_file_line_length]: ";
4110 # value is not modified, if user hits Enter or enters space
4112 # make sure that input is numeric
4113 if ($tmp =~ /^\d+$/) {
4114 $abook_file_line_length = $tmp;
4116 print "If you want to change this setting, you must enter number.\n";
4117 print "If you want to keep original setting - enter space.\n\n";
4118 print "Press Enter to continue...";
4125 print "If you want to store your users address book details in a database then\n";
4126 print "you need to set this DSN to a valid value. The format for this is:\n";
4127 print "mysql://user:pass\@hostname/dbname\n";
4128 print "Where mysql can be one of the databases PHP supports, the most common\n";
4129 print "of these are mysql, msql and pgsql.\n";
4130 print "Please ensure proper permissions for config.php when including\n";
4131 print "sensitive passwords.\n\n";
4132 print "If the DSN is left empty (hit space and then return) the database\n";
4133 print "related code for address books will not be used.\n";
4136 if ( $addrbook_dsn eq "" ) {
4137 $default_value = "Disabled";
4139 $default_value = $addrbook_dsn;
4141 print "[$WHT$addrbook_dsn$NRM]: $WHT";
4143 if ( $new_dsn eq "\n" ) {
4144 $new_dsn = $addrbook_dsn;
4146 $new_dsn =~ s/[\r\n]//g;
4147 $new_dsn =~ s/^\s+$//g;
4153 print "This is the name of the table you want to store the address book\n";
4154 print "data in, it defaults to 'address'\n";
4156 print "[$WHT$addrbook_table$NRM]: $WHT";
4157 $new_table = <STDIN
>;
4158 if ( $new_table eq "\n" ) {
4159 $new_table = $addrbook_table;
4161 $new_table =~ s/[\r\n]//g;
4167 print "If you want to store your users preferences in a database then\n";
4168 print "you need to set this DSN to a valid value. The format for this is:\n";
4169 print "mysql://user:pass\@hostname/dbname\n";
4170 print "Where mysql can be one of the databases PHP supports, the most common\n";
4171 print "of these are mysql, msql and pgsql.\n";
4172 print "Please ensure proper permissions for config.php when including\n";
4173 print "sensitive passwords.\n\n";
4174 print "If the DSN is left empty (hit space and then return) the database\n";
4175 print "related code for address books will not be used.\n";
4178 if ( $prefs_dsn eq "" ) {
4179 $default_value = "Disabled";
4181 $default_value = $prefs_dsn;
4183 print "[$WHT$prefs_dsn$NRM]: $WHT";
4185 if ( $new_dsn eq "\n" ) {
4186 $new_dsn = $prefs_dsn;
4188 $new_dsn =~ s/[\r\n]//g;
4189 $new_dsn =~ s/^\s+$//g;
4195 print "This is the name of the table you want to store the preferences\n";
4196 print "data in, it defaults to 'userprefs'\n";
4198 print "[$WHT$prefs_table$NRM]: $WHT";
4199 $new_table = <STDIN
>;
4200 if ( $new_table eq "\n" ) {
4201 $new_table = $prefs_table;
4203 $new_table =~ s/[\r\n]//g;
4209 print "This is the name of the field in which you want to store the\n";
4210 print "username of the person the prefs are for. It defaults to 'user'\n";
4212 print "[$WHT$prefs_user_field$NRM]: $WHT";
4213 $new_field = <STDIN
>;
4214 if ( $new_field eq "\n" ) {
4215 $new_field = $prefs_user_field;
4217 $new_field =~ s/[\r\n]//g;
4219 $prefs_user_size = db_pref_size
($prefs_user_size);
4224 print "This is the name of the field in which you want to store the\n";
4225 print "preferences keyword. It defaults to 'prefkey'\n";
4227 print "[$WHT$prefs_key_field$NRM]: $WHT";
4228 $new_field = <STDIN
>;
4229 if ( $new_field eq "\n" ) {
4230 $new_field = $prefs_key_field;
4232 $new_field =~ s/[\r\n]//g;
4234 $prefs_key_size = db_pref_size
($prefs_key_size);
4239 print "This is the name of the field in which you want to store the\n";
4240 print "preferences value. It defaults to 'prefval'\n";
4242 print "[$WHT$prefs_val_field$NRM]: $WHT";
4243 $new_field = <STDIN
>;
4244 if ( $new_field eq "\n" ) {
4245 $new_field = $prefs_val_field;
4247 $new_field =~ s/[\r\n]//g;
4249 $prefs_val_size = db_pref_size
($prefs_val_size);
4253 # routine is used to set database field limits
4254 # it needs one argument
4255 sub db_pref_size
() {
4257 print "\nDatabase fields have size limits.\n";
4259 print "What limit is set for this field? [$WHT$size$NRM]: $WHT";
4260 $new_size = <STDIN
>;
4261 if ( $new_size eq "\n" ) {
4264 $new_size =~ s/[\r\n]//g;
4270 print "If you want to store your global address book in a database then\n";
4271 print "you need to set this DSN to a valid value. The format for this is:\n";
4272 print "mysql://user:pass\@hostname/dbname\n";
4273 print "Where mysql can be one of the databases PHP supports, the most common\n";
4274 print "of these are mysql, msql and pgsql.\n";
4275 print "Please ensure proper permissions for config.php when including\n";
4276 print "sensitive passwords.\n\n";
4277 print "If the DSN is left empty (hit space and then return) the database\n";
4278 print "related code for global SQL address book will not be used.\n";
4281 if ( $addrbook_global_dsn eq "" ) {
4282 $default_value = "Disabled";
4284 $default_value = $addrbook_global_dsn;
4286 print "[$WHT$addrbook_global_dsn$NRM]: $WHT";
4288 if ( $new_dsn eq "\n" ) {
4289 $new_dsn = $addrbook_global_dsn;
4291 $new_dsn =~ s/[\r\n]//g;
4292 $new_dsn =~ s/^\s+$//g;
4298 print "This is the name of the table you want to store the global address book\n";
4299 print "data in. Default table name is 'global_abook'. Address book uses same\n";
4300 print "database format as personal address book.\n";
4302 print "[$WHT$addrbook_global_table$NRM]: $WHT";
4303 $new_table = <STDIN
>;
4304 if ( $new_table eq "\n" ) {
4305 $new_table = $addrbook_global_table;
4307 $new_table =~ s/[\r\n]//g;
4313 print "This option controls users\' ability to add or modify records stored \n";
4314 print "in global address book\n";
4316 if ( lc($addrbook_global_writeable) eq 'true' ) {
4317 $default_value = "y";
4319 $default_value = "n";
4321 print "Allow writing into global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
4322 $addrbook_global_writeable = <STDIN
>;
4323 if ( ( $addrbook_global_writeable =~ /^y\n/i ) || ( ( $addrbook_global_writeable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4324 $addrbook_global_writeable = 'true';
4326 $addrbook_global_writeable = 'false';
4328 return $addrbook_global_writeable;
4332 print "Enable this option if you want to see listing of addresses stored \n";
4333 print "in global address book\n";
4335 if ( lc($addrbook_global_listing) eq 'true' ) {
4336 $default_value = "y";
4338 $default_value = "n";
4340 print "Allow listing of global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
4341 $addrbook_global_listing = <STDIN
>;
4342 if ( ( $addrbook_global_listing =~ /^y\n/i ) || ( ( $addrbook_global_listing =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4343 $addrbook_global_listing = 'true';
4345 $addrbook_global_listing = 'false';
4347 return $addrbook_global_listing;
4353 print "SquirrelMail attempts to set the language in many ways. If it\n";
4354 print "can not figure it out in another way, it will default to this\n";
4355 print "language. Please use the code for the desired language.\n";
4357 print "[$WHT$squirrelmail_default_language$NRM]: $WHT";
4358 $new_squirrelmail_default_language = <STDIN
>;
4359 if ( $new_squirrelmail_default_language eq "\n" ) {
4360 $new_squirrelmail_default_language = $squirrelmail_default_language;
4362 $new_squirrelmail_default_language =~ s/[\r\n]//g;
4363 $new_squirrelmail_default_language =~ s/^\s+$//g;
4365 return $new_squirrelmail_default_language;
4369 print "This option controls what character set is used when sending\n";
4370 print "mail and when sending HTML to the browser. Option works only\n";
4371 print "with US English (en_US) translation. Other translations use\n";
4372 print "charsets that are set in translation settings.\n";
4375 print "[$WHT$default_charset$NRM]: $WHT";
4376 $new_default_charset = <STDIN
>;
4377 if ( $new_default_charset eq "\n" ) {
4378 $new_default_charset = $default_charset;
4380 $new_default_charset =~ s/[\r\n]//g;
4382 return $new_default_charset;
4384 # Alternative language names
4386 print "Enable this option if you want to see localized language names in\n";
4387 print "language selection box. Note, that this option can trigger\n";
4388 print "installation of foreign language support modules in some browsers.\n";
4391 if ( lc($show_alternative_names) eq 'true' ) {
4392 $default_value = "y";
4394 $default_value = "n";
4396 print "Show alternative language names? (y/n) [$WHT$default_value$NRM]: $WHT";
4397 $show_alternative_names = <STDIN
>;
4398 if ( ( $show_alternative_names =~ /^y\n/i ) || ( ( $show_alternative_names =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4399 $show_alternative_names = 'true';
4401 $show_alternative_names = 'false';
4403 return $show_alternative_names;
4406 # Aggressive decoding
4408 print "Enable this option if you want to use CPU and memory intensive decoding\n";
4409 print "functions. This option allows reading multibyte charset, that are used\n";
4410 print "in Eastern Asia. SquirrelMail will try to use recode functions here,\n";
4411 print "even when you have disabled use of recode in Tweaks section.\n";
4414 if ( lc($aggressive_decoding) eq 'true' ) {
4415 $default_value = "y";
4417 $default_value = "n";
4419 print "Enable aggressive decoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4420 $aggressive_decoding = <STDIN
>;
4421 if ( ( $aggressive_decoding =~ /^y\n/i ) || ( ( $aggressive_decoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4422 $aggressive_decoding = 'true';
4424 $aggressive_decoding = 'false';
4426 return $aggressive_decoding;
4431 print "Enable this option if you want to allow lossy charset encoding in message\n";
4432 print "composition pages. This option allows charset conversions when output\n";
4433 print "charset does not support all symbols used in original charset. Symbols\n";
4434 print "unsupported by output charset will be replaced with question marks.\n";
4437 if ( lc($lossy_encoding) eq 'true' ) {
4438 $default_value = "y";
4440 $default_value = "n";
4442 print "Enable lossy encoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4443 $lossy_encoding = <STDIN
>;
4444 if ( ( $lossy_encoding =~ /^y\n/i ) || ( ( $lossy_encoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4445 $lossy_encoding = 'true';
4447 $lossy_encoding = 'false';
4449 return $lossy_encoding;
4452 # display html emails in iframe
4454 print "This option can enable html email rendering inside iframe.\n";
4455 print "Inline frames are used in order to provide sandbox environment";
4456 print "for html code included in html formated emails.";
4457 print "Option is experimental and might have glitches in some parts of code.";
4460 if ( lc($use_iframe) eq 'true' ) {
4461 $default_value = "y";
4463 $default_value = "n";
4465 print "Display html emails in iframe? (y/n) [$WHT$default_value$NRM]: $WHT";
4466 $use_iframe = <STDIN
>;
4467 if ( ( $use_iframe =~ /^y\n/i ) || ( ( $use_iframe =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4468 $use_iframe = 'true';
4470 $use_iframe = 'false';
4476 sub command_ask_user_info
{
4477 print "New users need to supply their real name and email address to\n";
4478 print "send out proper mails. When this option is enabled, a user that\n";
4479 print "logs in for the first time will be redirected to the Personal\n";
4480 print "Options screen and asked to supply their personal data.\n";
4483 if ( lc($ask_user_info) eq 'true' ) {
4484 $default_value = "y";
4486 $default_value = "n";
4488 print "Ask user info? (y/n) [$WHT$default_value$NRM]: $WHT";
4489 $ask_user_info = <STDIN
>;
4490 if ( ( $ask_user_info =~ /^y\n/i ) || ( ( $ask_user_info =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4491 $ask_user_info = 'true';
4493 $ask_user_info = 'false';
4495 return $ask_user_info;
4500 print "Enabling this option will cause icons to be used instead of text\n";
4501 print "markers next to each message in mailbox lists that represent\n";
4502 print "new, read, flagged, and deleted messages, as well as those that\n";
4503 print "have been replied to and forwarded. Icons are also used next to\n";
4504 print "(un)expanded folders in the folder list (Oldway = false). These\n";
4505 print "icons are quite small, but will obviously be more of a resource\n";
4506 print "drain than text markers.\n";
4509 if ( lc($use_icons) eq 'true' ) {
4510 $default_value = "y";
4512 $default_value = "n";
4514 print "Use icons? (y/n) [$WHT$default_value$NRM]: $WHT";
4515 $use_icons = <STDIN
>;
4516 if ( ( $use_icons =~ /^y\n/i ) || ( ( $use_icons =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4517 $use_icons = 'true';
4519 $use_icons = 'false';
4525 print "Enable this option if you want to use php recode functions to read\n";
4526 print "emails written in charset that differs from the one that is set in\n";
4527 print "translation selected by user. Code is experimental, it might cause\n";
4528 print "errors, if email contains charset unsupported by recode or if your\n";
4529 print "php does not have recode support.\n";
4532 if ( lc($use_php_recode) eq 'true' ) {
4533 $default_value = "y";
4535 $default_value = "n";
4537 print "Use php recode functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4538 $use_php_recode = <STDIN
>;
4539 if ( ( $use_php_recode =~ /^y\n/i ) || ( ( $use_php_recode =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4540 $use_php_recode = 'true';
4542 $use_php_recode = 'false';
4544 return $use_php_recode;
4548 print "Enable this option if you want to use php iconv functions to read\n";
4549 print "emails written in charset that differs from the one that is set in\n";
4550 print "translation selected by user. Code is experimental, it works only\n";
4551 print "with translations that use utf-8 charset. Code might cause errors,\n";
4552 print "if email contains charset unsupported by iconv or if your php does\n";
4553 print "not have iconv support.\n";
4556 if ( lc($use_php_iconv) eq 'true' ) {
4557 $default_value = "y";
4559 $default_value = "n";
4561 print "Use php iconv functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4562 $use_php_iconv = <STDIN
>;
4563 if ( ( $use_php_iconv =~ /^y\n/i ) || ( ( $use_php_iconv =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4564 $use_php_iconv = 'true';
4566 $use_php_iconv = 'false';
4568 return $use_php_iconv;
4573 print "In some cases, buffering all output (holding it on the server until\n";
4574 print "the full page is ready to send to the browser) allows more complex\n";
4575 print "functionality, especially for plugins that want to add headers on hooks\n";
4576 print "that are beyond the point of output having been sent to the browser\n";
4577 print "otherwise. Most plugins that need this functionality will enable it\n";
4578 print "automatically on their own, but you can turn it on manually here. You'd\n";
4579 print "usually want to do this if you want to specify a custom output handler\n";
4580 print "for parsing the output - you can do that by specifying a value for\n";
4581 print "\$buffered_output_handler in config_local.php. Don't forget to define\n";
4582 print "a function of the same name as what \$buffered_output_handler is set to.\n";
4585 if ( lc($buffer_output) eq 'true' ) {
4586 $default_value = "y";
4588 $default_value = "n";
4590 print "Buffer all output? (y/n) [$WHT$default_value$NRM]: $WHT";
4591 $buffer_output = <STDIN
>;
4592 if ( ( $buffer_output =~ /^y\n/i ) || ( ( $buffer_output =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4593 $buffer_output = 'true';
4595 $buffer_output = 'false';
4597 return $buffer_output;
4602 print "Enable this option if you want to check SquirrelMail configuration\n";
4603 print "remotely with configtest.php script.\n";
4606 if ( lc($allow_remote_configtest) eq 'true' ) {
4607 $default_value = "y";
4609 $default_value = "n";
4611 print "Allow remote configuration tests? (y/n) [$WHT$default_value$NRM]: $WHT";
4612 $allow_remote_configtest = <STDIN
>;
4613 if ( ( $allow_remote_configtest =~ /^y\n/i ) || ( ( $allow_remote_configtest =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4614 $allow_remote_configtest = 'true';
4616 $allow_remote_configtest = 'false';
4618 return $allow_remote_configtest;
4621 # Default Icon theme
4623 print "You may change the path to the default icon theme to be used, if icons\n";
4624 print "have been enabled. This theme will be used when an icon cannot be\n";
4625 print "found in the current theme, or when no icon theme is specified. If\n";
4626 print "left blank, and icons are enabled, the default theme will be used\n";
4627 print "from images/themes/default/.\n";
4629 print "To clear out an existing value, just type a space for the input.\n";
4631 print "Please be aware of the following: \n";
4632 print " - Relative URLs are relative to the config dir\n";
4633 print " to use the icon themes directory, use ../images/themes/newtheme/\n";
4634 print " - The icon theme may be outside the SquirrelMail directory, but\n";
4635 print " it must be web accessible.\n";
4636 print "[$WHT$icon_theme_def$NRM]: $WHT";
4637 $new_icon_theme_def = <STDIN
>;
4639 if ( $new_icon_theme_def eq "\n" ) {
4640 $new_icon_theme_def = $icon_theme_def;
4642 $new_icon_theme_def =~ s/[\r\n]//g;
4644 $new_icon_theme_def =~ s/^\s*//;
4645 return $new_icon_theme_def;
4648 # SquirrelMail debug mode (since 1.5.2)
4650 print "When debugging or developing SquirrelMail, you may want to increase\n";
4651 print "the verbosity of certain kinds of errors, notices, and/or diagnostics.\n";
4652 print "You may enable one or more of the debugging modes here. Please make\n";
4653 print "sure that you have turned off debugging if you are using SquirrelMail\n";
4654 print "in a production environment.\n\n";
4657 while ( $input ne "d\n" ) {
4658 $sm_debug_mode = convert_debug_constants_to_binary_integer
($sm_debug_mode);
4660 # per include/constants.php, here are the debug mode values:
4662 # 0 SM_DEBUG_MODE_OFF
4663 # 1 SM_DEBUG_MODE_SIMPLE
4664 # 512 SM_DEBUG_MODE_MODERATE
4665 # 524288 SM_DEBUG_MODE_ADVANCED
4666 # 536870912 SM_DEBUG_MODE_STRICT
4668 print "\n# Enabled? Description\n";
4669 print "---------------------------------------------------------------------\n";
4670 print "0 " . ($sm_debug_mode == 0 ?
"y" : " ")
4671 . " No debugging (recommended in production environments)\n";
4672 print "1 " . ($sm_debug_mode & 1 ?
"y" : " ")
4673 . " Simple debugging (PHP E_ERROR)\n";
4674 print "2 " . ($sm_debug_mode & 512 ?
"y" : " ")
4675 . " Moderate debugging (PHP E_ALL without E_STRICT)\n";
4676 print "3 " . ($sm_debug_mode & 524288 ?
"y" : " ")
4677 . " Advanced debugging (PHP E_ALL (without E_STRICT) plus\n";
4678 print " log errors intentionally suppressed)\n";
4679 print "4 " . ($sm_debug_mode & 536870912 ?
"y" : " ")
4680 . " Strict debugging (PHP E_ALL and E_STRICT)\n";
4683 print "SquirrelMail debug mode (0,1,2,3,4) or d when done? : $WHT";
4685 if ( $input eq "d\n" ) {
4687 } elsif ($input !~ /^[0-9]+\n$/) {
4688 print "\nInvalid configuration value.\n";
4689 print "\nPress enter to continue...";
4691 } elsif ( $input == "0\n" ) {
4693 } elsif ( $input == "1\n" ) {
4694 if ($sm_debug_mode & 1) {
4695 $sm_debug_mode ^= 1;
4697 $sm_debug_mode |= 1;
4699 } elsif ( $input == "2\n" ) {
4700 if ($sm_debug_mode & 512) {
4701 $sm_debug_mode ^= 512;
4703 $sm_debug_mode |= 512;
4705 } elsif ( $input == "3\n" ) {
4706 if ($sm_debug_mode & 524288) {
4707 $sm_debug_mode ^= 524288;
4709 $sm_debug_mode |= 524288;
4711 } elsif ( $input == "4\n" ) {
4712 if ($sm_debug_mode & 536870912) {
4713 $sm_debug_mode ^= 536870912;
4715 $sm_debug_mode |= 536870912;
4718 print "\nInvalid configuration value.\n";
4719 print "\nPress enter to continue...";
4724 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
4725 return $sm_debug_mode;
4728 # Secured configuration mode (since 1.5.2)
4730 print "This option allows you to enable \"Secured Configuration\" mode,\n";
4731 print "which will guarantee that certain settings made herein will be\n";
4732 print "made immutable and will not be subject to override by either friendly\n";
4733 print "or unfriendly code/plugins. Only a small number of settings herein\n";
4734 print "will be used in this manner - just those that are deemed to be a\n";
4735 print "potential security threat when rouge plugin or other code may be\n";
4736 print "executed inside SquirrelMail.\n";
4739 if ( lc($secured_config) eq 'true' ) {
4740 $default_value = "y";
4742 $default_value = "n";
4744 print "Enable secured configuration mode? (y/n) [$WHT$default_value$NRM]: $WHT";
4745 $secured_config = <STDIN
>;
4746 if ( ( $secured_config =~ /^y\n/i ) || ( ( $secured_config =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4747 $secured_config = 'true';
4749 $secured_config = 'false';
4751 return $secured_config;
4754 # Set a (non-standard) HTTPS port
4756 print "If you run HTTPS (SSL-secured HTTP) on a non-standard port, you should\n";
4757 print "indicate that port here. Even if you do not, SquirrelMail may still\n";
4758 print "auto-detect secure connections, but it is safer and also very useful\n";
4759 print "for third party plugins if you specify the port number here.\n";
4761 print "Most SquirrelMail administrators will not need to use this setting\n";
4762 print "because most all web servers use port 443 for HTTPS connections, and\n";
4763 print "SquirrelMail assumes 443 unless something else is given here.\n";
4766 print "Enter your HTTPS port [$sq_https_port]: ";
4769 # value is not modified, if user hits Enter or enters space
4771 # make sure that input is numeric
4772 if ($tmp =~ /^\d+$/) {
4773 $sq_https_port = $tmp;
4776 print "--- INPUT ERROR ---\n";
4778 print "If you want to change this setting, you must enter a number.\n";
4779 print "If you want to keep the original value, just press Enter.\n\n";
4780 print "Press Enter to continue...";
4784 return $sq_https_port;
4787 # Ignore HTTP_X_FORWARDED_* headers?
4790 if ( lc($sq_ignore_http_x_forwarded_headers) eq 'true' ) {
4791 $default_value = "y";
4793 $default_value = "n";
4796 print "Because HTTP_X_FORWARDED_* headers can be sent by the client and\n";
4797 print "therefore possibly exploited by an outsider, SquirrelMail ignores\n";
4798 print "them by default. If a proxy server or other machine sits between\n";
4799 print "clients and your SquirrelMail server, you can turn this off to\n";
4800 print "tell SquirrelMail to use such headers.\n";
4803 print "Ignore HTTP_X_FORWARDED headers? (y/n) [$WHT$default_value$NRM]: $WHT";
4804 $sq_ignore_http_x_forwarded_headers = <STDIN
>;
4805 if ( ( $sq_ignore_http_x_forwarded_headers =~ /^y\n/i ) || ( ( $sq_ignore_http_x_forwarded_headers =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4806 $sq_ignore_http_x_forwarded_headers = 'true';
4808 $sq_ignore_http_x_forwarded_headers = 'false';
4810 return $sq_ignore_http_x_forwarded_headers;
4815 if ( open( CF
, ">config.php" ) ) {
4820 print CF
" * SquirrelMail Configuration File\n";
4821 print CF
" * Created using the configure script, conf.pl\n";
4825 if ($print_config_version) {
4826 print CF
"\$config_version = '$print_config_version';\n";
4829 print CF
"\$config_use_color = $config_use_color;\n";
4833 print CF
"\$org_name = \"$org_name\";\n";
4835 print CF
"\$org_logo = " . &change_to_SM_path
($org_logo) . ";\n";
4836 $org_logo_width |= 0;
4837 $org_logo_height |= 0;
4839 print CF
"\$org_logo_width = '$org_logo_width';\n";
4841 print CF
"\$org_logo_height = '$org_logo_height';\n";
4842 # string that can contain variables.
4843 print CF
"\$org_title = \"$org_title\";\n";
4845 print CF
"\$signout_page = " . &change_to_SM_path
($signout_page) . ";\n";
4847 print CF
"\$frame_top = '$frame_top';\n";
4850 print CF
"\$provider_uri = '$provider_uri';\n";
4853 print CF
"\$provider_name = '$provider_name';\n";
4856 # string that can contain variables
4857 print CF
"\$motd = \"$motd\";\n";
4861 print CF
"\$squirrelmail_default_language = '$squirrelmail_default_language';\n";
4863 print CF
"\$default_charset = '$default_charset';\n";
4865 print CF
"\$show_alternative_names = $show_alternative_names;\n";
4867 print CF
"\$aggressive_decoding = $aggressive_decoding;\n";
4869 print CF
"\$lossy_encoding = $lossy_encoding;\n";
4873 print CF
"\$domain = '$domain';\n";
4875 print CF
"\$imapServerAddress = '$imapServerAddress';\n";
4877 print CF
"\$imapPort = $imapPort;\n";
4879 print CF
"\$useSendmail = $useSendmail;\n";
4881 print CF
"\$smtpServerAddress = '$smtpServerAddress';\n";
4883 print CF
"\$smtpPort = $smtpPort;\n";
4885 print CF
"\$sendmail_path = '$sendmail_path';\n";
4887 print CF
"\$sendmail_args = '$sendmail_args';\n";
4889 # print CF "\$use_authenticated_smtp = $use_authenticated_smtp;\n";
4891 print CF
"\$pop_before_smtp = $pop_before_smtp;\n";
4893 print CF
"\$pop_before_smtp_host = '$pop_before_smtp_host';\n";
4895 print CF
"\$imap_server_type = '$imap_server_type';\n";
4897 print CF
"\$invert_time = $invert_time;\n";
4899 print CF
"\$optional_delimiter = '$optional_delimiter';\n";
4901 print CF
"\$encode_header_key = '$encode_header_key';\n";
4905 print CF
"\$default_folder_prefix = '$default_folder_prefix';\n";
4907 print CF
"\$trash_folder = '$trash_folder';\n";
4909 print CF
"\$sent_folder = '$sent_folder';\n";
4911 print CF
"\$draft_folder = '$draft_folder';\n";
4913 print CF
"\$default_move_to_trash = $default_move_to_trash;\n";
4915 print CF
"\$default_move_to_sent = $default_move_to_sent;\n";
4917 print CF
"\$default_save_as_draft = $default_save_as_draft;\n";
4919 print CF
"\$show_prefix_option = $show_prefix_option;\n";
4921 print CF
"\$list_special_folders_first = $list_special_folders_first;\n";
4923 print CF
"\$use_special_folder_color = $use_special_folder_color;\n";
4925 print CF
"\$auto_expunge = $auto_expunge;\n";
4927 print CF
"\$default_sub_of_inbox = $default_sub_of_inbox;\n";
4929 print CF
"\$show_contain_subfolders_option = $show_contain_subfolders_option;\n";
4931 print CF
"\$default_unseen_notify = $default_unseen_notify;\n";
4933 print CF
"\$default_unseen_type = $default_unseen_type;\n";
4935 print CF
"\$auto_create_special = $auto_create_special;\n";
4937 print CF
"\$delete_folder = $delete_folder;\n";
4939 print CF
"\$noselect_fix_enable = $noselect_fix_enable;\n";
4944 print CF
"\$data_dir = " . &change_to_SM_path
($data_dir) . ";\n";
4945 # string that can contain a variable
4946 print CF
"\$attachment_dir = " . &change_to_SM_path
($attachment_dir) . ";\n";
4948 print CF
"\$dir_hash_level = $dir_hash_level;\n";
4950 print CF
"\$default_left_size = '$default_left_size';\n";
4952 print CF
"\$force_username_lowercase = $force_username_lowercase;\n";
4954 print CF
"\$default_use_priority = $default_use_priority;\n";
4956 print CF
"\$hide_sm_attributions = $hide_sm_attributions;\n";
4958 print CF
"\$default_use_mdn = $default_use_mdn;\n";
4960 print CF
"\$edit_identity = $edit_identity;\n";
4962 print CF
"\$edit_name = $edit_name;\n";
4964 print CF
"\$hide_auth_header = $hide_auth_header;\n";
4966 print CF
"\$disable_thread_sort = $disable_thread_sort;\n";
4968 print CF
"\$disable_server_sort = $disable_server_sort;\n";
4970 print CF
"\$allow_charset_search = $allow_charset_search;\n";
4972 print CF
"\$allow_advanced_search = $allow_advanced_search;\n";
4975 print CF
"\$time_zone_type = $time_zone_type;\n";
4978 print CF
"\$config_location_base = '$config_location_base';\n";
4981 print CF
"\$disable_plugins = $disable_plugins;\n";
4983 print CF
"\$disable_plugins_user = '$disable_plugins_user';\n";
4986 # all plugins are strings
4987 for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
4988 print CF
"\$plugins[] = '$plugins[$ct]';\n";
4993 if ( $user_theme_default eq '' ) { $user_theme_default = '0'; }
4994 print CF
"\$user_theme_default = $user_theme_default;\n";
4996 for ( $count = 0 ; $count <= $#user_theme_name ; $count++ ) {
4997 if ($user_theme_path[$count] eq 'none') {
5000 $path = &change_to_SM_path
($user_theme_path[$count]);
5002 print CF
"\$user_themes[$count]['PATH'] = " . $path . ";\n";
5003 # escape theme name so it can contain single quotes.
5004 $esc_name = $user_theme_name[$count];
5005 $esc_name =~ s/\\/\\\\/g;
5006 $esc_name =~ s/'/\\'/g;
5007 print CF
"\$user_themes[$count]['NAME'] = '$esc_name';\n";
5011 if ( $icon_theme_def eq '' ) { $icon_theme_def = '0'; }
5012 print CF
"\$icon_theme_def = $icon_theme_def;\n";
5013 if ( $icon_theme_fallback eq '' ) { $icon_theme_fallback = '0'; }
5014 print CF
"\$icon_theme_fallback = $icon_theme_fallback;\n";
5016 for ( $count = 0 ; $count <= $#icon_theme_name ; $count++ ) {
5017 $path = $icon_theme_path[$count];
5018 if ($path eq 'none' || $path eq 'template') {
5019 $path = "'".$path."'";
5021 $path = &change_to_SM_path
($icon_theme_path[$count]);
5023 print CF
"\$icon_themes[$count]['PATH'] = " . $path . ";\n";
5024 # escape theme name so it can contain single quotes.
5025 $esc_name = $icon_theme_name[$count];
5026 $esc_name =~ s/\\/\\\\/g;
5027 $esc_name =~ s/'/\\'/g;
5028 print CF
"\$icon_themes[$count]['NAME'] = '$esc_name';\n";
5032 if ( $templateset_default eq '' ) { $templateset_default = 'default'; }
5033 print CF
"\$templateset_default = '$templateset_default';\n";
5035 if ( $templateset_fallback eq '' ) { $templateset_fallback = 'default'; }
5036 print CF
"\$templateset_fallback = '$templateset_fallback';\n";
5038 if ( $rpc_templateset eq '' ) { $rpc_templateset = 'default_rpc'; }
5039 print CF
"\$rpc_templateset = '$rpc_templateset';\n";
5041 for ( $count = 0 ; $count <= $#templateset_name ; $count++ ) {
5043 # don't include RPC template sets
5045 if ( $templateset_id[$count] =~ /_rpc$/ ) { next; }
5047 print CF
"\$aTemplateSet[$count]['ID'] = '" . $templateset_id[$count] . "';\n";
5048 # escape theme name so it can contain single quotes.
5049 $esc_name = $templateset_name[$count];
5050 $esc_name =~ s/\\/\\\\/g;
5051 $esc_name =~ s/'/\\'/g;
5052 print CF
"\$aTemplateSet[$count]['NAME'] = '$esc_name';\n";
5058 print CF
"\$default_fontsize = '$default_fontsize';\n";
5060 print CF
"\$default_fontset = '$default_fontset';\n";
5062 # assoc. array (maybe initial value should be set somewhere else)
5063 print CF
'$fontsets = array();'."\n";
5064 while (($fontset_name, $fontset_value) = each(%fontsets)) {
5065 print CF
"\$fontsets\['$fontset_name'\] = '$fontset_value';\n";
5071 print CF
"\$default_use_javascript_addr_book = $default_use_javascript_addr_book;\n";
5072 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
5073 print CF
"\$ldap_server[$count] = array(\n";
5075 print CF
" 'host' => '$ldap_host[$count]',\n";
5077 print CF
" 'base' => '$ldap_base[$count]'";
5078 if ( $ldap_name[$count] ) {
5081 print CF
" 'name' => '$ldap_name[$count]'";
5083 if ( $ldap_port[$count] ) {
5086 print CF
" 'port' => $ldap_port[$count]";
5088 if ( $ldap_charset[$count] ) {
5091 print CF
" 'charset' => '$ldap_charset[$count]'";
5093 if ( $ldap_maxrows[$count] ) {
5096 print CF
" 'maxrows' => $ldap_maxrows[$count]";
5099 if ( $ldap_filter[$count] ) {
5101 print CF
" 'filter' => '$ldap_filter[$count]'";
5103 if ( $ldap_binddn[$count] ) {
5106 print CF
" 'binddn' => '$ldap_binddn[$count]'";
5107 if ( $ldap_bindpw[$count] ) {
5110 print CF
" 'bindpw' => '$ldap_bindpw[$count]'";
5113 if ( $ldap_protocol[$count] ) {
5116 print CF
" 'protocol' => $ldap_protocol[$count]";
5118 if ( $ldap_limit_scope[$count] ) {
5121 print CF
" 'limit_scope' => $ldap_limit_scope[$count]";
5123 if ( $ldap_listing[$count] ) {
5126 print CF
" 'listing' => $ldap_listing[$count]";
5128 if ( $ldap_writeable[$count] ) {
5131 print CF
" 'writeable' => $ldap_writeable[$count]";
5133 if ( $ldap_search_tree[$count] ) {
5136 print CF
" 'search_tree' => $ldap_search_tree[$count]";
5138 if ( $ldap_starttls[$count] ) {
5141 print CF
" 'starttls' => $ldap_starttls[$count]";
5149 print CF
"\$addrbook_dsn = '$addrbook_dsn';\n";
5151 print CF
"\$addrbook_table = '$addrbook_table';\n\n";
5153 print CF
"\$prefs_dsn = '$prefs_dsn';\n";
5155 print CF
"\$prefs_table = '$prefs_table';\n";
5157 print CF
"\$prefs_user_field = '$prefs_user_field';\n";
5159 print CF
"\$prefs_user_size = $prefs_user_size;\n";
5161 print CF
"\$prefs_key_field = '$prefs_key_field';\n";
5163 print CF
"\$prefs_key_size = $prefs_key_size;\n";
5165 print CF
"\$prefs_val_field = '$prefs_val_field';\n";
5167 print CF
"\$prefs_val_size = $prefs_val_size;\n\n";
5169 print CF
"\$addrbook_global_dsn = '$addrbook_global_dsn';\n";
5171 print CF
"\$addrbook_global_table = '$addrbook_global_table';\n";
5173 print CF
"\$addrbook_global_writeable = $addrbook_global_writeable;\n";
5175 print CF
"\$addrbook_global_listing = $addrbook_global_listing;\n\n";
5177 print CF
"\$abook_global_file = '$abook_global_file';\n";
5179 print CF
"\$abook_global_file_writeable = $abook_global_file_writeable;\n\n";
5181 print CF
"\$abook_global_file_listing = $abook_global_file_listing;\n\n";
5183 print CF
"\$abook_file_line_length = $abook_file_line_length;\n\n";
5185 print CF
"\$no_list_for_subscribe = $no_list_for_subscribe;\n";
5188 print CF
"\$smtp_auth_mech = '$smtp_auth_mech';\n";
5189 print CF
"\$smtp_sitewide_user = '". quote_single
($smtp_sitewide_user) ."';\n";
5190 print CF
"\$smtp_sitewide_pass = '". quote_single
($smtp_sitewide_pass) ."';\n";
5192 print CF
"\$imap_auth_mech = '$imap_auth_mech';\n";
5194 print CF
"\$use_imap_tls = $use_imap_tls;\n";
5196 print CF
"\$use_smtp_tls = $use_smtp_tls;\n";
5198 print CF
"\$session_name = '$session_name';\n";
5200 print CF
"\$only_secure_cookies = $only_secure_cookies;\n";
5201 print CF
"\$disable_security_tokens = $disable_security_tokens;\n";
5204 print CF
"\$check_referrer = '$check_referrer';\n";
5207 print CF
"\$use_transparent_security_image = $use_transparent_security_image;\n";
5212 print CF
"\$use_iframe = $use_iframe;\n";
5214 print CF
"\$ask_user_info = $ask_user_info;\n";
5216 print CF
"\$use_icons = $use_icons;\n";
5219 print CF
"\$use_php_recode = $use_php_recode;\n";
5221 print CF
"\$use_php_iconv = $use_php_iconv;\n";
5224 print CF
"\$buffer_output = $buffer_output;\n";
5227 print CF
"\$allow_remote_configtest = $allow_remote_configtest;\n";
5228 print CF
"\$secured_config = $secured_config;\n";
5230 print CF
"\$sq_https_port = $sq_https_port;\n";
5232 print CF
"\$sq_ignore_http_x_forwarded_headers = $sq_ignore_http_x_forwarded_headers;\n";
5233 # (binary) integer or constant - convert integer
5234 # values to constants before output
5235 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
5236 print CF
"\$sm_debug_mode = $sm_debug_mode;\n";
5241 print "Data saved in config.php\n";
5243 build_plugin_hook_array
();
5246 print "Error saving config.php: $!\n";
5252 print $WHT. "SquirrelMail Configuration : " . $NRM;
5253 if ( $config == 1 ) { print "Read: config.php"; }
5254 elsif ( $config == 2 ) { print "Read: config_default.php"; }
5256 print "---------------------------------------------------------\n";
5258 print "While we have been building SquirrelMail, we have discovered some\n";
5259 print "preferences that work better with some servers that don't work so\n";
5260 print "well with others. If you select your IMAP server, this option will\n";
5261 print "set some pre-defined settings for that server.\n";
5263 print "Please note that you will still need to go through and make sure\n";
5264 print "everything is correct. This does not change everything. There are\n";
5265 print "only a few settings that this will change.\n";
5269 while ( $continue != 1 ) {
5270 print "Please select your IMAP server:\n";
5271 print $list_supported_imap_servers;
5273 print " quit = Do not change anything\n";
5275 print "Command >> ";
5277 $server =~ s/[\r\n]//g;
5279 # variable is used to display additional messages.
5283 if ( $server eq "cyrus" ) {
5284 $imap_server_type = "cyrus";
5285 $default_folder_prefix = "";
5286 $trash_folder = "INBOX.Trash";
5287 $sent_folder = "INBOX.Sent";
5288 $draft_folder = "INBOX.Drafts";
5289 $show_prefix_option = false
;
5290 $default_sub_of_inbox = true
;
5291 $show_contain_subfolders_option = false
;
5292 $optional_delimiter = ".";
5293 $disp_default_folder_prefix = "<none>";
5294 $force_username_lowercase = false
;
5296 # Delimiter might differ if unixhierarchysep is set to yes.
5297 $message = "\nIf you have enabled unixhierarchysep, you must change delimiter and special folder names.\n";
5300 } elsif ( $server eq "uw" ) {
5301 $imap_server_type = "uw";
5302 $default_folder_prefix = "mail/";
5303 $trash_folder = "Trash";
5304 $sent_folder = "Sent";
5305 $draft_folder = "Drafts";
5306 $show_prefix_option = true
;
5307 $default_sub_of_inbox = false
;
5308 $show_contain_subfolders_option = true
;
5309 $optional_delimiter = "/";
5310 $disp_default_folder_prefix = $default_folder_prefix;
5311 $delete_folder = true
;
5312 $force_username_lowercase = true
;
5315 } elsif ( $server eq "exchange" ) {
5316 $imap_server_type = "exchange";
5317 $default_folder_prefix = "";
5318 $default_sub_of_inbox = true
;
5319 $trash_folder = "INBOX/Deleted Items";
5320 $sent_folder = "INBOX/Sent Items";
5321 $drafts_folder = "INBOX/Drafts";
5322 $show_prefix_option = false
;
5323 $show_contain_subfolders_option = false
;
5324 $optional_delimiter = "detect";
5325 $disp_default_folder_prefix = "<none>";
5326 $force_username_lowercase = true
;
5329 } elsif ( $server eq "courier" ) {
5330 $imap_server_type = "courier";
5331 $default_folder_prefix = "INBOX.";
5332 $trash_folder = "Trash";
5333 $sent_folder = "Sent";
5334 $draft_folder = "Drafts";
5335 $show_prefix_option = false
;
5336 $default_sub_of_inbox = false
;
5337 $show_contain_subfolders_option = false
;
5338 $optional_delimiter = ".";
5339 $disp_default_folder_prefix = $default_folder_prefix;
5340 $delete_folder = true
;
5341 $force_username_lowercase = false
;
5344 } elsif ( $server eq "macosx" ) {
5345 $imap_server_type = "macosx";
5346 $default_folder_prefix = "INBOX/";
5347 $trash_folder = "Trash";
5348 $sent_folder = "Sent";
5349 $draft_folder = "Drafts";
5350 $show_prefix_option = false
;
5351 $default_sub_of_inbox = true
;
5352 $show_contain_subfolders_option = false
;
5353 $optional_delimiter = "detect";
5354 $allow_charset_search = false
;
5355 $disp_default_folder_prefix = $default_folder_prefix;
5358 } elsif ( $server eq "hmailserver" ) {
5359 $imap_server_type = "hmailserver";
5360 $default_folder_prefix = "";
5361 $trash_folder = "INBOX.Trash";
5362 $sent_folder = "INBOX.Sent";
5363 $draft_folder = "INBOX.Drafts";
5364 $show_prefix_option = false
;
5365 $default_sub_of_inbox = true
;
5366 $show_contain_subfolders_option = false
;
5367 $optional_delimiter = "detect";
5368 $allow_charset_search = false
;
5369 $disp_default_folder_prefix = $default_folder_prefix;
5370 $delete_folder = false
;
5371 $force_username_lowercase = false
;
5374 } elsif ( $server eq "mercury32" ) {
5375 $imap_server_type = "mercury32";
5376 $default_folder_prefix = "";
5377 $trash_folder = "Trash";
5378 $sent_folder = "Sent";
5379 $draft_folder = "Drafts";
5380 $show_prefix_option = false
;
5381 $default_sub_of_inbox = true
;
5382 $show_contain_subfolders_option = true
;
5383 $optional_delimiter = "detect";
5384 $delete_folder = true
;
5385 $force_username_lowercase = true
;
5388 } elsif ( $server eq "dovecot" ) {
5389 $imap_server_type = "dovecot";
5390 $default_folder_prefix = "";
5391 $trash_folder = "Trash";
5392 $sent_folder = "Sent";
5393 $draft_folder = "Drafts";
5394 $show_prefix_option = false
;
5395 $default_sub_of_inbox = false
;
5396 $show_contain_subfolders_option = false
;
5397 $delete_folder = false
;
5398 $force_username_lowercase = true
;
5399 $optional_delimiter = "detect";
5400 $disp_default_folder_prefix = "<none>";
5403 } elsif ( $server eq "bincimap" ) {
5404 $imap_server_type = "bincimap";
5405 $default_folder_prefix = "INBOX/";
5406 $trash_folder = "Trash";
5407 $sent_folder = "Sent";
5408 $draft_folder = "Drafts";
5409 $show_prefix_option = false
;
5410 $default_sub_of_inbox = false
;
5411 $show_contain_subfolders_option = false
;
5412 $delete_folder = true
;
5413 $force_username_lowercase = false
;
5414 $optional_delimiter = "detect";
5415 $disp_default_folder_prefix = $default_folder_prefix;
5417 # Default folder prefix depends on used depot.
5418 $message = "\nIf you use IMAPdir depot, you must set default folder prefix to empty string.\n";
5421 } elsif ( $server eq "gmail" ) {
5422 $imap_server_type = "gmail";
5423 $default_folder_prefix = "";
5424 $trash_folder = "[Gmail]/Trash";
5425 $default_move_to_trash = true
;
5426 $sent_folder = "[Gmail]/Sent Mail";
5427 $draft_folder = "[Gmail]/Drafts";
5428 $auto_create_special = false
;
5429 $show_prefix_option = false
;
5430 $default_sub_of_inbox = false
;
5431 $show_contain_subfolders_option = false
;
5432 $delete_folder = true
;
5433 $force_username_lowercase = false
;
5434 $optional_delimiter = "/";
5435 $disp_default_folder_prefix = "<none>";
5436 $domain = "gmail.com";
5437 $imapServerAddress = "imap.gmail.com";
5439 $use_imap_tls = true
;
5440 $imap_auth_mech = "login";
5441 $smtpServerAddress = "smtp.gmail.com";
5443 $pop_before_smtp = false
;
5444 $useSendmail = false
;
5445 $use_smtp_tls = true
;
5446 $smtp_auth_mech = "login";
5449 # Gmail changes system folder names (Drafts, Sent, Trash) out
5450 # from under you when the user changes language settings
5451 $message = "\nNOTE! When a user changes languages in Gmail's interface, the\n"
5452 . "Drafts, Sent and Trash folder names are changed to localized\n"
5453 . "versions thereof. To see those folders correctly in SquirrelMail,\n"
5454 . "the user should change the SquirrelMail language to match.\n"
5455 . "Moreover, SquirrelMail then needs to be told what folders to use\n"
5456 . "for Drafts, Sent and Trash in Options --> Folder Preferences.\n"
5457 . "These default settings will only correctly find the Sent, Trash\n"
5458 . "and Drafts folders if both Gmail and SquirrelMail languages are\n"
5459 . "set to English.\n\n"
5460 . "Also note that in some regions (Europe?), the default folder\n"
5461 . "names (see main menu selection 3. Folder Defaults) are different\n"
5462 . "(they may need to have the prefix \"[Google Mail]\" instead of\n"
5463 . "\"[Gmail]\") and \"Trash\" may be called \"Bin\" instead.\n";
5465 } elsif ( $server eq "quit" ) {
5468 $disp_default_folder_prefix = $default_folder_prefix;
5469 print "Unrecognized server: $server\n";
5473 print " imap_server_type = $imap_server_type\n";
5474 print " default_folder_prefix = $disp_default_folder_prefix\n";
5475 print " trash_folder = $trash_folder\n";
5476 print " sent_folder = $sent_folder\n";
5477 print " draft_folder = $draft_folder\n";
5478 print " show_prefix_option = $show_prefix_option\n";
5479 print " default_sub_of_inbox = $default_sub_of_inbox\n";
5480 print "show_contain_subfolders_option = $show_contain_subfolders_option\n";
5481 print " optional_delimiter = $optional_delimiter\n";
5482 print " delete_folder = $delete_folder\n";
5483 print " force_username_lowercase = $force_username_lowercase\n";
5487 print "\nPress enter to continue...";
5491 # This subroutine corrects relative paths to ensure they
5492 # will work within the SM space. If the path falls within
5493 # the SM directory tree, the SM_PATH variable will be
5494 # prepended to the path, if not, then the path will be
5495 # converted to an absolute path, e.g.
5496 # '../images/logo.gif' --> SM_PATH . 'images/logo.gif'
5497 # '../../someplace/data' --> '/absolute/path/someplace/data'
5498 # 'images/logo.gif' --> SM_PATH . 'config/images/logo.gif'
5499 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
5500 # 'C:\absolute\path\logo.gif' --> 'C:\absolute\path\logo.gif'
5501 # 'http://whatever/' --> 'http://whatever'
5502 # $some_var/path --> "$some_var/path"
5503 sub change_to_SM_path
() {
5504 my ($old_path) = @_;
5510 # If the path is absolute, don't bother.
5511 return "\'" . $old_path . "\'" if ( $old_path eq '');
5512 return "\'" . $old_path . "\'" if ( $old_path =~ /^(\/|http
)/ );
5513 return "\'" . $old_path . "\'" if ( $old_path =~ /^\w:(\\|\/)/ );
5514 return $old_path if ( $old_path =~ /^\'(\/|http
)/ );
5515 return $old_path if ( $old_path =~ /^\'\w:\// );
5516 return $old_path if ( $old_path =~ /^SM_PATH/);
5518 if ( $old_path =~ /^\$/ ) {
5519 # check if it's a single var, or a $var/path combination
5520 # if it's $var/path, enclose in ""
5521 if ( $old_path =~ /\// ) {
5522 return '"'.$old_path.'"';
5527 # Remove remaining '
5528 $old_path =~ s/\'//g;
5530 # For relative paths, split on '../'
5531 @rel_path = split(/\.\.\//, $old_path);
5533 if ( $#rel_path > 1 ) {
5534 # more than two levels away. Make it absolute.
5535 @abs_path = split(/\//, $dir);
5537 # Lop off the relative pieces of the absolute path..
5538 for ( $i = 0; $i <= $#rel_path; $i++ ) {
5542 push @abs_path, @rel_path;
5543 $new_path = "\'" . join('/', @abs_path) . "\'";
5544 } elsif ( $#rel_path > 0 ) {
5545 # it's within the SM tree, prepend SM_PATH
5546 $new_path = $old_path;
5547 $new_path =~ s/^\.\.\//SM_PATH
. \'/;
5550 # Last, it's a relative path without any leading '.'
5551 # Prepend SM_PATH and config, since the paths are
5552 # relative to the config directory
5553 $new_path = "SM_PATH . \'config/" . $old_path . "\'";
5559 # Change SM_PATH to admin-friendly version, e.g.:
5560 # SM_PATH . 'images/logo.gif' --> '../images/logo.gif'
5561 # SM_PATH . 'config/some.php' --> 'some.php'
5562 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
5563 # 'http://whatever/' --> 'http://whatever'
5564 sub change_to_rel_path
() {
5565 my ($old_path) = @_;
5566 my $new_path = $old_path;
5568 if ( $old_path =~ /^SM_PATH/ ) {
5569 # FIXME: the following replacement loses the opening quote mark!
5570 $new_path =~ s/^SM_PATH . \'/\.\.\//;
5571 $new_path =~ s/\.\.\/config\///;
5577 # Attempts to auto-detect if a specific auth mechanism is supported.
5578 # Called by 'command112a' and 'command112b'
5579 # ARGS: service-name (IMAP or SMTP), host:port, mech-name (ie. CRAM-MD5)
5580 sub detect_auth_support
{
5581 # Try loading IO::Socket
5582 unless (eval("use IO::Socket; 1")) {
5583 print "Perl IO::Socket module is not available.";
5587 my $service = shift;
5591 if ((!defined($service)) or (!defined($host)) or (!defined($mech))) {
5592 # Error - wrong # of args
5593 print "BAD ARGS!\n";
5597 if ($service eq 'SMTP') {
5598 $cmd = "AUTH $mech\r\n";
5599 $logout = "QUIT\r\n";
5600 } elsif ($service eq 'IMAP') {
5601 $cmd = "A01 AUTHENTICATE $mech\n";
5602 $logout = "C01 LOGOUT\n";
5604 # unknown service - whoops.
5608 # Get this show on the road
5609 my $sock=IO
::Socket
::INET
->new($host);
5610 if (!defined($sock)) {
5614 my $discard = <$sock>; # Server greeting/banner - who cares..
5616 if ($service eq 'SMTP') {
5618 print $sock "HELO $domain\r\n";
5619 $discard = <$sock>; # Yeah yeah, you're happy to see me..
5623 my $response = <$sock>;
5625 if (!defined($response)) {
5629 # So at this point, we have a response, and it is (hopefully) valid.
5630 if ($service eq 'SMTP') {
5631 if (!($response =~ /^334/)) {
5633 print $sock $logout;
5637 } elsif ($service eq 'IMAP') {
5638 if ($response =~ /^A01/) {
5640 print $sock $logout;
5645 # Unknown service - this shouldn't be able to happen.
5650 # If it gets here, the mech is supported
5651 print $sock "*\n"; # Attempt to cancel authentication
5652 print $sock $logout; # Try to log out, but we don't really care if this fails
5658 # Example code from O'Reilly Perl Cookbook
5665 return wantarray ?
@out : $out[0];
5668 sub clear_screen
() {
5669 if ( $^O
=~ /^mswin/i) {
5676 # checks IMAP mailbox name. Refuses to accept 8bit folders
5677 # returns 0 (folder name is not correct) or 1 (folder name is correct)
5678 sub check_imap_folder
($) {
5679 my $folder_name = shift(@_);
5681 if ($folder_name =~ /[\x80-\xFFFF]/) {
5682 print "Folder name contains 8bit characters. Configuration utility requires\n";
5683 print "UTF7-IMAP encoded folder names.\n";
5684 print "Press enter to continue...";
5687 } elsif ($folder_name =~ /[&\*\%]/) {
5688 # check for ampersand and list-wildcards
5689 print "Folder name contains special UTF7-IMAP characters.\n";
5690 print "Are you sure that folder name is correct? (y/N): ";
5692 $tmp = lc(trim
($tmp));
5693 if ($tmp =~ /^y$/) {
5703 # quotes string written in single quotes
5704 sub quote_single
($) {
5705 my $string = shift(@_);
5706 $string =~ s/\'/\\'/g;
5710 # determine a plugin's version number
5712 # parses the setup.php file, looking for the
5713 # version string in the <plugin>_info() or the
5714 # <plugin>_version functions.
5716 sub get_plugin_version
() {
5718 my $plugin_name = shift(@_);
5720 $setup_file = '../plugins/' . $plugin_name . '/setup.php';
5721 if ( -e
"$setup_file" ) {
5722 # Make sure that file is readable
5723 if (! -r
"$setup_file") {
5726 print "The file \"$setup_file\" was found, but you don't\n";
5727 print "have rights to read it. The plugin \"";
5728 print $plugin_name . "\" may not work correctly until you fix this.\n";
5729 print "\nPress enter to continue";
5736 # FIXME: grep the file instead of reading it into memory?
5738 open( FILE
, "$setup_file" );
5739 while ( $line = <FILE
> ) {
5740 $whole_file .= $line;
5744 # ideally, there is a version in the <plugin>_info function...
5746 if ($whole_file =~ /('version'\s*=>\s*['"](.*?)['"])/) {
5749 # this assumes there is only one function that returns
5750 # a static string in the setup file
5752 } elsif ($whole_file =~ /(return\s*['"](.*?)['"])/) {
5761 print "The file \"$setup_file\" was not found.\n";
5762 print "The plugin \"" . $plugin_name;
5763 print "\" may not work correctly until you fix this.\n";
5764 print "\nPress enter to continue";
5772 # determine a plugin's English name
5774 # parses the setup.php file, looking for the
5775 # English name in the <plugin>_info() function.
5777 sub get_plugin_english_name
() {
5779 my $plugin_name = shift(@_);
5781 $setup_file = '../plugins/' . $plugin_name . '/setup.php';
5782 if ( -e
"$setup_file" ) {
5783 # Make sure that file is readable
5784 if (! -r
"$setup_file") {
5787 print "The file \"$setup_file\" was found, but you don't\n";
5788 print "have rights to read it. The plugin \"";
5789 print $plugin_name . "\" may not work correctly until you fix this.\n";
5790 print "\nPress enter to continue";
5797 # FIXME: grep the file instead of reading it into memory?
5799 open( FILE
, "$setup_file" );
5800 while ( $line = <FILE
> ) {
5801 $whole_file .= $line;
5805 # the English name is in the <plugin>_info function or nothing...
5807 if ($whole_file =~ /('english_name'\s*=>\s*['"](.*?)['"])/) {
5808 $english_name .= $2;
5811 return $english_name;
5816 print "The file \"$setup_file\" was not found.\n";
5817 print "The plugin \"" . $plugin_name;
5818 print "\" may not work correctly until you fix this.\n";
5819 print "\nPress enter to continue";
5827 # parses the setup.php files for all activated plugins and
5828 # builds static plugin hooks array so we don't have to load
5829 # ALL plugins are runtime and build the hook array on every
5832 # hook array is saved in config/plugin_hooks.php
5834 # Note the $verbose variable at the top of this routine
5835 # can be set to zero to quiet it down.
5837 # NOTE/FIXME: we aren't necessarily interested in writing
5838 # a full-blown PHP parsing engine, so plenty
5839 # of assumptions are included herein about the
5840 # coding of the plugin setup files, and things
5841 # like commented out curly braces or other
5842 # such oddities can break this in a bad way.
5844 sub build_plugin_hook_array
() {
5852 if ( open( HOOKFILE
, ">plugin_hooks.php" ) ) {
5853 print HOOKFILE
"<?php\n";
5854 print HOOKFILE
"\n";
5856 print HOOKFILE
"/**\n";
5857 print HOOKFILE
" * SquirrelMail Plugin Hook Registration File\n";
5858 print HOOKFILE
" * Auto-generated using the configure script, conf.pl\n";
5859 print HOOKFILE
" */\n";
5860 print HOOKFILE
"\n";
5861 print HOOKFILE
"global \$squirrelmail_plugin_hooks;\n";
5862 print HOOKFILE
"\n";
5864 PLUGIN
: for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
5867 print "Activating plugin \"" . $plugins[$ct] . "\"...\n";
5870 $setup_file = '../plugins/' . $plugins[$ct] . '/setup.php';
5871 if ( -e
"$setup_file" ) {
5872 # Make sure that file is readable
5873 if (! -r
"$setup_file") {
5876 print "The file \"$setup_file\" was found, but you don't\n";
5877 print "have rights to read it. The plugin \"";
5878 print $plugins[$ct] . "\" will not be activated until you fix this.\n";
5879 print "\nPress enter to continue";
5884 open( FILE
, "$setup_file" );
5885 $inside_init_fxn = 0;
5887 while ( $line = <FILE
> ) {
5889 # throw away lines until we get to target function
5891 if (!$inside_init_fxn
5892 && $line !~ /^\s*function\s*squirrelmail_plugin_init_/i) {
5895 $inside_init_fxn = 1;
5905 # count close braces
5910 # leaving <plugin>_init() function...
5911 if ($brace_count == 0) {
5919 # throw away lines that are not exactly one "brace set" deep
5921 if ($brace_count > 1) {
5926 # also not interested in lines that are not
5927 # hook registration points
5929 if ($line !~ /^\s*\$squirrelmail_plugin_hooks/i) {
5934 # if $line does not have an ending semicolon,
5935 # we need to recursively read in subsequent
5936 # lines until we find one
5937 while ( $line !~ /;\s*$/ ) {
5938 $line =~ s/[\n\r]\s*$//;
5947 $var =~ s/=/EQUALS/;
5948 if ( $var =~ /^([a-z])/i ) {
5949 @options = split ( /\s*EQUALS\s*/, $var );
5950 $options[1] =~ s/[\n\r]//g;
5951 $options[1] =~ s/[\'\"];\s*$//;
5952 $options[1] =~ s/;$//;
5953 $options[1] =~ s/^[\'\"]//;
5954 # de-escape escaped strings
5955 $options[1] =~ s/\\'/'/g;
5956 $options[1] =~ s/\\\\/\\/g;
5958 if ( $options[0] =~ /^squirrelmail_plugin_hooks\s*\[\s*['"]([a-z0-9 \/._
*-]+)['"]\s*\]\s*\[\s*['"]([0-9a-z._-]+)['"]\s
*\
]/i
) {
5960 $hooked_plugin_name = $2;
5961 # Note: if we wanted to stop plugins from registering
5962 # a *different* plugin on a hook, we could catch
5963 # it here, however this has actually proven to be
5964 # a useful *feature*
5965 #if ($hooked_plugin_name ne $plugins[$ct]) {
5966 # print "...plugin is tring to hook in under different name...\n";
5969 #FIXME: do we want to count the number of hook registrations for each plugin and warn if a plugin doesn't have any?
5970 # hook registration has been found!
5972 if ($hooked_plugin_name ne $plugins[$ct]) {
5973 print " registering on hook \"" . $hook_name . "\" (as \"$hooked_plugin_name\" plugin)\n";
5975 print " registering on hook \"" . $hook_name . "\"\n";
5978 $line =~ s/ {2,}/ /g;
5980 print HOOKFILE
"\$$line";
5992 print "The file \"$setup_file\" was not found.\n";
5993 print "The plugin \"" . $plugins[$ct];
5994 print "\" will not be activated until you fix this.\n";
5995 print "\nPress enter to continue";
6003 print HOOKFILE
"\n\n";
6006 print "\nDone activating plugins; registration data saved in plugin_hooks.php\n\n";
6013 print "The file \"plugin_hooks.php\" was not able to be written to.\n";
6014 print "No plugins will be activated until you fix this.\n";
6015 print "\nPress enter to continue";
6023 # converts (binary) integer values that correspond
6024 # to the SquirrelMail debug mode constants (see
6025 # include/constants.php) into those constant strings
6026 # (bitwise or'd if more than one is enabled)
6028 # if the value passed in is not an integer, it is
6029 # returned unmolested
6031 sub convert_debug_binary_integer_to_constants
() {
6033 my ($debug_mode) = @_;
6034 if ($debug_mode =~ /^[^0-9]/) {
6037 $debug_mode = int($debug_mode);
6038 $new_debug_mode = '';
6040 # per include/constants.php, here are their values:
6042 # 0 SM_DEBUG_MODE_OFF
6043 # 1 SM_DEBUG_MODE_SIMPLE
6044 # 512 SM_DEBUG_MODE_MODERATE
6045 # 524288 SM_DEBUG_MODE_ADVANCED
6046 # 536870912 SM_DEBUG_MODE_STRICT
6048 if ($debug_mode & 1) {
6049 $new_debug_mode .= ' | SM_DEBUG_MODE_SIMPLE';
6051 if ($debug_mode & 512) {
6052 $new_debug_mode .= ' | SM_DEBUG_MODE_MODERATE';
6054 if ($debug_mode & 524288) {
6055 $new_debug_mode .= ' | SM_DEBUG_MODE_ADVANCED';
6057 if ($debug_mode & 536870912) {
6058 $new_debug_mode .= ' | SM_DEBUG_MODE_STRICT';
6061 $new_debug_mode =~ s/^ \| //;
6062 if (!$new_debug_mode) {
6063 $new_debug_mode = 'SM_DEBUG_MODE_OFF';
6066 return $new_debug_mode;
6069 # converts SquirrelMail debug mode constants (see
6070 # include/constants.php) into their corresponding
6071 # (binary) integer values
6073 # if the value passed in is an integer already, it
6074 # is returned unmolested
6076 sub convert_debug_constants_to_binary_integer
() {
6078 my ($debug_mode) = @_;
6079 if ($debug_mode =~ /^[0-9]/) {
6082 $new_debug_mode = 0;
6084 # per include/constants.php, here are their values:
6086 # 0 SM_DEBUG_MODE_OFF
6087 # 1 SM_DEBUG_MODE_SIMPLE
6088 # 512 SM_DEBUG_MODE_MODERATE
6089 # 524288 SM_DEBUG_MODE_ADVANCED
6090 # 536870912 SM_DEBUG_MODE_STRICT
6092 if ($debug_mode =~ /\bSM_DEBUG_MODE_OFF\b/) {
6093 $new_debug_mode = 0;
6095 if ($debug_mode =~ /\bSM_DEBUG_MODE_SIMPLE\b/) {
6096 $new_debug_mode |= 1;
6098 if ($debug_mode =~ /\bSM_DEBUG_MODE_MODERATE\b/) {
6099 $new_debug_mode |= 512;
6101 if ($debug_mode =~ /\bSM_DEBUG_MODE_ADVANCED\b/) {
6102 $new_debug_mode |= 524288;
6104 if ($debug_mode =~ /\bSM_DEBUG_MODE_STRICT\b/) {
6105 $new_debug_mode |= 536870912;
6108 return $new_debug_mode;
6111 # Function to print n column numbered lists
6113 # WARNING: the names in the list will be truncated
6114 # to fit in their respective columns based on the
6115 # screen width and number of columns.
6117 # Expected arguments (in this order):
6119 # * The start number to use for the list
6120 # * The number of columns to use
6121 # * The screen width
6122 # * Boolean (zero/one), indicating
6123 # whether or not to show item numbers
6124 # * The list of strings to be shown
6126 # Returns: The number printed on screen of the last item in the list
6128 sub print_multi_col_list
{
6129 my ($num, $cols, $screen_width, $show_numbering, @list) = @_;
6139 $rows = int(@list / $cols);
6140 if (@list % $cols) { $rows++; }
6141 if ($show_numbering) { $col_width = int(($screen_width - 2) / $cols) - 5; }
6142 else { $col_width = int(($screen_width - 2) / $cols) - 2; }
6144 # build the layout array so numbers run down each column
6146 for ( $x = 0; $x < @list; $x++ ) {
6148 $layout[$row_cnt][$col_cnt] = $list[$x];
6149 $numbers[$row_cnt][$col_cnt] = $num++;
6151 # move to next column
6153 if ($row_cnt == $rows - 1) {
6157 else { $row_cnt++; }
6161 # if we filled up fewer rows than needed, recalc column width
6163 if ($rows * $col_cnt == @list) { $col_cnt--; } # loop above ended right after increment
6164 if ($col_cnt + 1 < $cols) {
6165 if ($show_numbering) { $col_width = int(($screen_width - 2) / ($col_cnt + 1)) - 5; }
6166 else { $col_width = int(($screen_width - 2) / ($col_cnt + 1)) - 2; }
6172 for ( $row_cnt = 0; $row_cnt <= $rows; $row_cnt++ ) {
6178 # iterate columns for this row
6180 for ( $col_cnt = 0; $col_cnt <= $cols; $col_cnt++ ) {
6181 if ($layout[$row_cnt][$col_cnt]) {
6183 if ($show_numbering) { printf "$WHT% 2u.$NRM", $numbers[$row_cnt][$col_cnt]; }
6184 printf " %-$col_width." . $col_width . "s", $layout[$row_cnt][$col_cnt];