4 # Copyright (c) 1999-2007 The SquirrelMail Project Team
5 # Licensed under the GNU GPL. For full terms see COPYING.
7 # A simple configure script to configure SquirrelMail
10 ############################################################
11 $conf_pl_version = "1.5.0";
13 ############################################################
14 # Check what directory we're supposed to be running in, and
15 # change there if necessary. File::Basename has been in
16 # Perl since at least 5.003_7, and nobody sane runs anything
17 # before that, but just in case.
18 ############################################################
20 if ( eval q{require "File/Basename.pm"} ) {
21 $dir = File
::Basename
::dirname
($0);
25 ############################################################
26 # Some people try to run this as a CGI. That's wrong!
27 ############################################################
28 if ( defined( $ENV{'PATH_INFO'} )
29 || defined( $ENV{'QUERY_STRING'} )
30 || defined( $ENV{'REQUEST_METHOD'} ) ) {
31 print "Content-Type: text/html\n\n";
32 print "You must run this script from the command line.";
36 ############################################################
37 # If we got here, use Cwd to get the full directory path
38 # (the Basename stuff above will sometimes return '.' as
39 # the base directory, which is not helpful here).
40 ############################################################
45 ############################################################
46 # First, lets read in the data already in there...
47 ############################################################
48 if ( -e
"config.php" ) {
49 # Make sure that file is readable
50 if (! -r
"config.php") {
53 print "The file \"config/config.php\" was found, but you don't\n";
54 print "have rights to read it.\n";
56 print "Press enter to continue";
60 open( FILE
, "config.php" );
61 while ( $line = <FILE
> ) {
67 if ( $var =~ /^([a-z])/i ) {
68 @o = split ( /\s*EQUALS\s*/, $var );
69 if ( $o[0] eq "config_version" ) {
71 $o[1] =~ s/[\'\"];\s*$//;
75 $config_version = $o[1];
82 if ( $config_version ne $conf_pl_version ) {
85 print " The file \"config/config.php\" was found, but it is for\n";
86 print " an older version of SquirrelMail. It is possible to still\n";
87 print " read the defaults from this file but be warned that many\n";
88 print " preferences change between versions. It is recommended that\n";
89 print " you start with a clean config.php for each upgrade that you\n";
90 print " do. To do this, just move config/config.php out of the way.\n";
92 print "Continue loading with the old config.php [y/N]? ";
95 if ( ( $ctu !~ /^y\n/i ) || ( $ctu =~ /^\n/ ) ) {
99 print "\nDo you want me to stop warning you [y/N]? ";
101 if ( $ctu =~ /^y\n/i ) {
102 $print_config_version = $conf_pl_version;
104 $print_config_version = $config_version;
107 $print_config_version = $config_version;
111 open( FILE
, "config.php" );
112 } elsif ( -e
"config_default.php" ) {
113 open( FILE
, "config_default.php" );
114 while ( $line = <FILE
> ) {
120 if ( $var =~ /^([a-z])/i ) {
121 @o = split ( /\s*EQUALS\s*/, $var );
122 if ( $o[0] eq "config_version" ) {
123 $o[1] =~ s/[\n\r]//g;
124 $o[1] =~ s/[\'\"];\s*$//;
126 $o[1] =~ s/^[\'\"]//;
128 $config_version = $o[1];
135 if ( $config_version ne $conf_pl_version ) {
138 print " You are trying to use a 'config_default.php' from an older\n";
139 print " version of SquirrelMail. This is HIGHLY unrecommended. You\n";
140 print " should get the 'config_default.php' that matches the version\n";
141 print " of SquirrelMail that you are running. You can get this from\n";
142 print " the SquirrelMail web page by going to the following URL:\n";
143 print " http://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 $ask_user_info = 'true' if ( !$ask_user_info );
496 if ( $ARGV[0] eq '--install-plugin' ) {
497 print "Activating plugin " . $ARGV[1] . "\n";
498 if ( -d
"../plugins/" . $ARGV[1]) {
499 push @plugins, $ARGV[1];
503 print "No such plugin.\n";
506 } elsif ( $ARGV[0] eq '--remove-plugin' ) {
507 print "Removing plugin " . $ARGV[1] . "\n";
508 foreach $plugin (@plugins) {
509 if ( $plugin ne $ARGV[1] ) {
510 push @newplugins, $plugin;
513 @plugins = @newplugins;
516 } elsif ( $ARGV[0] eq '--update-plugins' or $ARGV[0] eq '-u') {
517 build_plugin_hook_array
();
519 } elsif ( $ARGV[0] eq '--help' or $ARGV[0] eq '-h') {
520 print "SquirrelMail Configuration Script\n";
522 print " * No arguments: initiates the configuration dialog\n";
523 print " * --install-plugin <plugin> : activates the specified plugin\n";
524 print " * --remove-plugin <plugin> : deactivates the specified plugin\n";
525 print " * --update-plugins , -u : rebuilds plugin_hooks.php according\n";
526 print " to plugins activated in config.php\n";
527 print " * --help , -h : Displays this help\n";
534 ####################################################################################
536 # used in multiple places, define once
537 $list_supported_imap_servers =
538 " bincimap = Binc IMAP server\n" .
539 " courier = Courier IMAP server\n" .
540 " cyrus = Cyrus IMAP server\n" .
541 " dovecot = Dovecot Secure IMAP server\n" .
542 " exchange = Microsoft Exchange IMAP server\n" .
543 " hmailserver = hMailServer\n" .
544 " macosx = Mac OS X Mailserver\n" .
545 " mercury32 = Mercury/32\n" .
546 " uw = University of Washington's IMAP server\n";
548 #####################################################################################
549 if ( $config_use_color == 1 ) {
555 $config_use_color = 2;
558 # lists can be printed in more than one column; default is just one
562 # try to get screen width dynamically if possible; default to 80
563 # (user can override with "w#" command)
565 eval { require "sys/ioctl.ph" };
567 || !defined &TIOCGWINSZ
568 || !open(TTY
, "+</dev/tty")
569 || !ioctl(TTY
, &TIOCGWINSZ
, $winsize='')) {
572 ($row, $col, $xpixel, $ypixel) = unpack('S4', $winsize);
573 $screen_width = $col;
576 while ( ( $command ne "q" ) && ( $command ne "Q" ) && ( $command ne ":q" ) ) {
578 print $WHT. "SquirrelMail Configuration : " . $NRM;
579 if ( $config == 1 ) { print "Read: config.php"; }
580 elsif ( $config == 2 ) { print "Read: config_default.php"; }
581 print " ($print_config_version)\n";
582 print "---------------------------------------------------------\n";
585 print $WHT. "Main Menu --\n" . $NRM;
586 print "1. Organization Preferences\n";
587 print "2. Server Settings\n";
588 print "3. Folder Defaults\n";
589 print "4. General Options\n";
590 print "5. User Interface\n";
591 print "6. Address Books\n";
592 print "7. Message of the Day (MOTD)\n";
593 print "8. Plugins\n";
594 print "9. Database\n";
595 print "10. Language settings\n";
596 print "11. Tweaks\n";
598 print "D. Set pre-defined settings for specific IMAP servers\n";
600 } elsif ( $menu == 1 ) {
601 print $WHT. "Organization Preferences\n" . $NRM;
602 print "1. Organization Name : $WHT$org_name$NRM\n";
603 print "2. Organization Logo : $WHT$org_logo$NRM\n";
604 print "3. Org. Logo Width/Height : $WHT($org_logo_width/$org_logo_height)$NRM\n";
605 print "4. Organization Title : $WHT$org_title$NRM\n";
606 print "5. Signout Page : $WHT$signout_page$NRM\n";
607 print "6. Top Frame : $WHT$frame_top$NRM\n";
608 print "7. Provider link : $WHT$provider_uri$NRM\n";
609 print "8. Provider link text : $WHT$provider_name$NRM\n";
612 print "R Return to Main Menu\n";
613 } elsif ( $menu == 2 ) {
614 print $WHT. "Server Settings\n\n" . $NRM;
615 print $WHT . "General" . $NRM . "\n";
617 print "1. Domain : $WHT$domain$NRM\n";
618 print "2. Invert Time : $WHT$invert_time$NRM\n";
619 print "3. Sendmail or SMTP : $WHT";
620 if ( lc($useSendmail) eq 'true' ) {
628 if ( $show_imap_settings ) {
629 print $WHT . "IMAP Settings". $NRM . "\n--------------\n";
630 print "4. IMAP Server : $WHT$imapServerAddress$NRM\n";
631 print "5. IMAP Port : $WHT$imapPort$NRM\n";
632 print "6. Authentication type : $WHT$imap_auth_mech$NRM\n";
633 print "7. Secure IMAP (TLS) : $WHT" . display_use_tls
($use_imap_tls) . "$NRM\n";
634 print "8. Server software : $WHT$imap_server_type$NRM\n";
635 print "9. Delimiter : $WHT$optional_delimiter$NRM\n";
637 } elsif ( $show_smtp_settings ) {
638 if ( lc($useSendmail) eq 'true' ) {
639 print $WHT . "Sendmail" . $NRM . "\n--------\n";
640 print "4. Sendmail Path : $WHT$sendmail_path$NRM\n";
641 print "5. Sendmail arguments : $WHT$sendmail_args$NRM\n";
642 print "6. Header encryption key : $WHT$encode_header_key$NRM\n";
645 print $WHT . "SMTP Settings" . $NRM . "\n-------------\n";
646 print "4. SMTP Server : $WHT$smtpServerAddress$NRM\n";
647 print "5. SMTP Port : $WHT$smtpPort$NRM\n";
648 print "6. POP before SMTP : $WHT$pop_before_smtp$NRM\n";
649 print "7. SMTP Authentication : $WHT$smtp_auth_mech" . display_smtp_sitewide_userpass
() ."$NRM\n";
650 print "8. Secure SMTP (TLS) : $WHT" . display_use_tls
($use_smtp_tls) . "$NRM\n";
651 print "9. Header encryption key : $WHT$encode_header_key$NRM\n";
656 if ($show_imap_settings == 0) {
657 print "A. Update IMAP Settings : ";
658 print "$WHT$imapServerAddress$NRM:";
659 print "$WHT$imapPort$NRM ";
660 print "($WHT$imap_server_type$NRM)\n";
662 if ($show_smtp_settings == 0) {
663 if ( lc($useSendmail) eq 'true' ) {
664 print "B. Change Sendmail Config : $WHT$sendmail_path$NRM\n";
666 print "B. Update SMTP Settings : ";
667 print "$WHT$smtpServerAddress$NRM:";
668 print "$WHT$smtpPort$NRM\n";
671 if ( $show_smtp_settings || $show_imap_settings )
674 ($show_imap_settings ?
"IMAP Server" :
675 (lc($useSendmail) eq 'true') ?
"Sendmail" : "SMTP") . " Settings\n";
679 print "R Return to Main Menu\n";
680 } elsif ( $menu == 3 ) {
681 print $WHT. "Folder Defaults\n" . $NRM;
682 print "1. Default Folder Prefix : $WHT$default_folder_prefix$NRM\n";
683 print "2. Show Folder Prefix Option : $WHT$show_prefix_option$NRM\n";
684 print "3. Trash Folder : $WHT$trash_folder$NRM\n";
685 print "4. Sent Folder : $WHT$sent_folder$NRM\n";
686 print "5. Drafts Folder : $WHT$draft_folder$NRM\n";
687 print "6. By default, move to trash : $WHT$default_move_to_trash$NRM\n";
688 print "7. By default, save sent messages : $WHT$default_move_to_sent$NRM\n";
689 print "8. By default, save as draft : $WHT$default_save_as_draft$NRM\n";
690 print "9. List Special Folders First : $WHT$list_special_folders_first$NRM\n";
691 print "10. Show Special Folders Color : $WHT$use_special_folder_color$NRM\n";
692 print "11. Auto Expunge : $WHT$auto_expunge$NRM\n";
693 print "12. Default Sub. of INBOX : $WHT$default_sub_of_inbox$NRM\n";
694 print "13. Show 'Contain Sub.' Option : $WHT$show_contain_subfolders_option$NRM\n";
695 print "14. Default Unseen Notify : $WHT$default_unseen_notify$NRM\n";
696 print "15. Default Unseen Type : $WHT$default_unseen_type$NRM\n";
697 print "16. Auto Create Special Folders : $WHT$auto_create_special$NRM\n";
698 print "17. Folder Delete Bypasses Trash : $WHT$delete_folder$NRM\n";
699 print "18. Enable /NoSelect folder fix : $WHT$noselect_fix_enable$NRM\n";
701 print "R Return to Main Menu\n";
702 } elsif ( $menu == 4 ) {
703 print $WHT. "General Options\n" . $NRM;
704 print "1. Data Directory : $WHT$data_dir$NRM\n";
705 print "2. Attachment Directory : $WHT$attachment_dir$NRM\n";
706 print "3. Directory Hash Level : $WHT$dir_hash_level$NRM\n";
707 print "4. Default Left Size : $WHT$default_left_size$NRM\n";
708 print "5. Usernames in Lowercase : $WHT$force_username_lowercase$NRM\n";
709 print "6. Allow use of priority : $WHT$default_use_priority$NRM\n";
710 print "7. Hide SM attributions : $WHT$hide_sm_attributions$NRM\n";
711 print "8. Allow use of receipts : $WHT$default_use_mdn$NRM\n";
712 print "9. Allow editing of identity : $WHT$edit_identity$NRM\n";
713 print " Allow editing of name : $WHT$edit_name$NRM\n";
714 print " Remove username from header : $WHT$hide_auth_header$NRM\n";
715 print "10. Disable server thread sort : $WHT$disable_thread_sort$NRM\n";
716 print "11. Disable server-side sorting : $WHT$disable_server_sort$NRM\n";
717 print "12. Allow server charset search : $WHT$allow_charset_search$NRM\n";
718 print "13. Allow advanced search : $WHT$allow_advanced_search$NRM\n";
719 print "14. PHP session name : $WHT$session_name$NRM\n";
720 print "15. Time zone configuration : $WHT$time_zone_type$NRM\n";
721 print "16. Location base : $WHT$config_location_base$NRM\n";
722 print "17. Only secure cookies if poss. : $WHT$only_secure_cookies$NRM\n";
724 print "R Return to Main Menu\n";
725 } elsif ( $menu == 5 ) {
726 print $WHT. "User Interface\n" . $NRM;
727 print "1. Use Icons? : $WHT$use_icons$NRM\n";
728 # print "3. Default Icon Set : $WHT$icon_theme_def$NRM\n";
729 print "2. Default font size : $WHT$default_fontsize$NRM\n";
730 print "3. Manage template sets (skins)\n";
731 print "4. Manage user themes\n";
732 print "5. Manage font sets\n";
733 print "6. Manage icon themes\n";
736 print "R Return to Main Menu\n";
737 } elsif ( $menu == 6 ) {
738 print $WHT. "Address Books\n" . $NRM;
739 print "1. Change LDAP Servers\n";
740 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
741 print " > $ldap_host[$count]\n";
743 print "2. Use Javascript address book search : $WHT$default_use_javascript_addr_book$NRM\n";
744 print "3. Global address book file : $WHT$abook_global_file$NRM\n";
745 print "4. Allow writing into global file address book : $WHT$abook_global_file_writeable$NRM\n";
746 print "5. Allow listing of global file address book : $WHT$abook_global_file_listing$NRM\n";
747 print "6. Allowed address book line length : $WHT$abook_file_line_length$NRM\n";
749 print "R Return to Main Menu\n";
750 } elsif ( $menu == 7 ) {
751 print $WHT. "Message of the Day (MOTD)\n" . $NRM;
754 print "1 Edit the MOTD\n";
756 print "R Return to Main Menu\n";
757 } elsif ( $menu == 8 ) {
758 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
759 print $WHT. "Plugins (WARNING: All plugins are currently disabled\n for the user \"$disable_plugins_user\"!)\n" . $NRM;
760 } elsif (lc($disable_plugins) eq 'true') {
761 print $WHT. "Plugins (WARNING: All plugins are currently disabled!)\n" . $NRM;
763 print $WHT. "Plugins\n" . $NRM;
765 print " Installed Plugins\n";
767 $num = print_multi_col_list
(1, $columns, $screen_width, 1, @plugins);
770 for ( $count = 0 ; $count <= $#plugins ; $count++ ) {
772 $english_name = get_plugin_english_name
($plugins[$count]);
773 if ( $english_name eq "" ) {
774 print " $WHT$num.$NRM $plugins[$count]" . get_plugin_version
($plugins[$count]) . "\n";
776 print " $WHT$num.$NRM $english_name ($plugins[$count])" . get_plugin_version
($plugins[$count]) . "\n";
780 print "\n Available Plugins:\n";
781 opendir( DIR
, "../plugins" );
782 @files = sort(readdir(DIR
));
784 @unused_plugins = ();
785 for ( $i = 0 ; $i <= $#files ; $i++ ) {
786 if ( -d
"../plugins/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne ".svn" ) {
788 for ( $k = 0 ; $k <= $#plugins ; $k++ ) {
789 if ( $plugins[$k] eq $files[$i] ) {
794 $unused_plugins[$pos] = $files[$i];
801 $num = print_multi_col_list
($num + 1, $columns, $screen_width, 1, @unused_plugins);
803 for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
805 $english_name = get_plugin_english_name
($unused_plugins[$i]);
806 if ( $english_name eq "" ) {
807 print " $WHT$num.$NRM $unused_plugins[$i]" . get_plugin_version
($unused_plugins[$i]) . "\n";
809 print " $WHT$num.$NRM $english_name ($unused_plugins[$i])" . get_plugin_version
($unused_plugins[$i]) . "\n";
816 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
817 print "E Enable active plugins (all plugins currently\n disabled for the user \"$disable_plugins_user\")\n";
818 } elsif (lc($disable_plugins) eq 'true') {
819 print "E Enable active plugins (all plugins currently\n disabled)\n";
821 print "D Disable all plugins\n";
823 print "U Set the user for whom plugins can be disabled\n";
824 print "R Return to Main Menu\n";
825 print "C# List plugins in <#> number of columns\n";
826 print "W# Change screen width to <#> (currently $screen_width)\n";
827 } elsif ( $menu == 9 ) {
828 print $WHT. "Database\n" . $NRM;
829 print "1. DSN for Address Book : $WHT$addrbook_dsn$NRM\n";
830 print "2. Table for Address Book : $WHT$addrbook_table$NRM\n";
832 print "3. DSN for Preferences : $WHT$prefs_dsn$NRM\n";
833 print "4. Table for Preferences : $WHT$prefs_table$NRM\n";
834 print "5. Field for username : $WHT$prefs_user_field$NRM ($prefs_user_size)\n";
835 print "6. Field for prefs key : $WHT$prefs_key_field$NRM ($prefs_key_size)\n";
836 print "7. Field for prefs value : $WHT$prefs_val_field$NRM ($prefs_val_size)\n";
838 print "8. DSN for Global Address Book : $WHT$addrbook_global_dsn$NRM\n";
839 print "9. Table for Global Address Book : $WHT$addrbook_global_table$NRM\n";
840 print "10. Allow writing into Global Address Book : $WHT$addrbook_global_writeable$NRM\n";
841 print "11. Allow listing of Global Address Book : $WHT$addrbook_global_listing$NRM\n";
843 print "R Return to Main Menu\n";
844 } elsif ( $menu == 10 ) {
845 print $WHT. "Language settings\n" . $NRM;
846 print "1. Default Language : $WHT$squirrelmail_default_language$NRM\n";
847 print "2. Default Charset : $WHT$default_charset$NRM\n";
848 print "3. Show alternative language names : $WHT$show_alternative_names$NRM\n";
849 print "4. Enable aggressive decoding : $WHT$aggressive_decoding$NRM\n";
850 print "5. Enable lossy encoding : $WHT$lossy_encoding$NRM\n";
852 print "R Return to Main Menu\n";
853 } elsif ( $menu == 11 ) {
854 print $WHT. "Interface tweaks\n" . $NRM;
855 print "1. Display html mails in iframe : $WHT$use_iframe$NRM\n";
856 print "2. Ask user info on first login : $WHT$ask_user_info$NRM\n";
858 print $WHT. "PHP tweaks\n" . $NRM;
859 print "4. Use php recode functions : $WHT$use_php_recode$NRM\n";
860 print "5. Use php iconv functions : $WHT$use_php_iconv$NRM\n";
861 print "6. Buffer all output : $WHT$buffer_output$NRM\n";
863 print $WHT. "Configuration tweaks\n" . $NRM;
864 print "7. Allow remote configtest : $WHT$allow_remote_configtest$NRM\n";
865 print "8. Debug mode : $WHT$sm_debug_mode$NRM\n";
866 print "9. Secured configuration mode : $WHT$secured_config$NRM\n";
867 print "10. HTTPS port : $WHT$sq_https_port$NRM\n";
868 print "11. Ignore HTTP_X_FORWARDED headers: $WHT$sq_ignore_http_x_forwarded_headers$NRM\n";
870 print "R Return to Main Menu\n";
872 if ( $config_use_color == 1 ) {
873 print "C Turn color off\n";
875 print "C Turn color on\n";
877 print "S Save data\n";
881 print "Command >> " . $WHT;
883 $command =~ s/[\n\r]//g;
884 $command =~ tr/A-Z/a-z/;
887 # Read the commands they entered.
888 if ( $command eq "r" ) {
890 } elsif ( $command eq "s" ) {
892 print "Press enter to continue...";
895 } elsif ( ( $command eq "q" ) && ( $saved == 0 ) ) {
896 print "You have not saved your data.\n";
897 print "Save? [" . $WHT . "Y" . $NRM . "/n]: ";
899 if ( ( $save =~ /^y/i ) || ( $save =~ /^\s*$/ ) ) {
902 } elsif ( $command eq "c" ) {
903 if ( $config_use_color == 1 ) {
904 $config_use_color = 2;
908 $config_use_color = 1;
912 } elsif ( $command =~ /^w([0-9]+)/ ) {
914 } elsif ( $command eq "d" && $menu == 0 ) {
919 if ( ( $command > 0 ) && ( $command < 12 ) ) {
922 } elsif ( $menu == 1 ) {
923 if ( $command == 1 ) { $org_name = command1
(); }
924 elsif ( $command == 2 ) { $org_logo = command2
(); }
925 elsif ( $command == 3 ) { ($org_logo_width,$org_logo_height) = command2a
(); }
926 elsif ( $command == 4 ) { $org_title = command3
(); }
927 elsif ( $command == 5 ) { $signout_page = command4
(); }
928 elsif ( $command == 6 ) { $frame_top = command6
(); }
929 elsif ( $command == 7 ) { $provider_uri = command7
(); }
930 elsif ( $command == 8 ) { $provider_name = command8
(); }
932 } elsif ( $menu == 2 ) {
933 if ( $command eq "a" ) { $show_imap_settings = 1; $show_smtp_settings = 0; }
934 elsif ( $command eq "b" ) { $show_imap_settings = 0; $show_smtp_settings = 1; }
935 elsif ( $command eq "h" ) { $show_imap_settings = 0; $show_smtp_settings = 0; }
936 elsif ( $command <= 3 ) {
937 if ( $command == 1 ) { $domain = command11
(); }
938 elsif ( $command == 2 ) { $invert_time = command110
(); }
939 elsif ( $command == 3 ) { $useSendmail = command14
(); }
940 $show_imap_settings = 0; $show_smtp_settings = 0;
941 } elsif ( $show_imap_settings ) {
942 if ( $command == 4 ) { $imapServerAddress = command12
(); }
943 elsif ( $command == 5 ) { $imapPort = command13
(); }
944 elsif ( $command == 6 ) { $imap_auth_mech = command112a
(); }
945 elsif ( $command == 7 ) { $use_imap_tls = command_use_tls
("IMAP",$use_imap_tls); }
946 elsif ( $command == 8 ) { $imap_server_type = command19
(); }
947 elsif ( $command == 9 ) { $optional_delimiter = command111
(); }
948 } elsif ( $show_smtp_settings && lc($useSendmail) eq 'true' ) {
949 if ( $command == 4 ) { $sendmail_path = command15
(); }
950 elsif ( $command == 5 ) { $sendmail_args = command_sendmail_args
(); }
951 elsif ( $command == 6 ) { $encode_header_key = command114
(); }
952 } elsif ( $show_smtp_settings ) {
953 if ( $command == 4 ) { $smtpServerAddress = command16
(); }
954 elsif ( $command == 5 ) { $smtpPort = command17
(); }
955 elsif ( $command == 6 ) { $pop_before_smtp = command18a
(); }
956 elsif ( $command == 7 ) { $smtp_auth_mech = command112b
(); }
957 elsif ( $command == 8 ) { $use_smtp_tls = command_use_tls
("SMTP",$use_smtp_tls); }
958 elsif ( $command == 9 ) { $encode_header_key = command114
(); }
960 } elsif ( $menu == 3 ) {
961 if ( $command == 1 ) { $default_folder_prefix = command21
(); }
962 elsif ( $command == 2 ) { $show_prefix_option = command22
(); }
963 elsif ( $command == 3 ) { $trash_folder = command23a
(); }
964 elsif ( $command == 4 ) { $sent_folder = command23b
(); }
965 elsif ( $command == 5 ) { $draft_folder = command23c
(); }
966 elsif ( $command == 6 ) { $default_move_to_trash = command24a
(); }
967 elsif ( $command == 7 ) { $default_move_to_sent = command24b
(); }
968 elsif ( $command == 8 ) { $default_save_as_draft = command24c
(); }
969 elsif ( $command == 9 ) { $list_special_folders_first = command27
(); }
970 elsif ( $command == 10 ) { $use_special_folder_color = command28
(); }
971 elsif ( $command == 11 ) { $auto_expunge = command29
(); }
972 elsif ( $command == 12 ) { $default_sub_of_inbox = command210
(); }
973 elsif ( $command == 13 ) { $show_contain_subfolders_option = command211
(); }
974 elsif ( $command == 14 ) { $default_unseen_notify = command212
(); }
975 elsif ( $command == 15 ) { $default_unseen_type = command213
(); }
976 elsif ( $command == 16 ) { $auto_create_special = command214
(); }
977 elsif ( $command == 17 ) { $delete_folder = command215
(); }
978 elsif ( $command == 18 ) { $noselect_fix_enable = command216
(); }
979 } elsif ( $menu == 4 ) {
980 if ( $command == 1 ) { $data_dir = command33a
(); }
981 elsif ( $command == 2 ) { $attachment_dir = command33b
(); }
982 elsif ( $command == 3 ) { $dir_hash_level = command33c
(); }
983 elsif ( $command == 4 ) { $default_left_size = command35
(); }
984 elsif ( $command == 5 ) { $force_username_lowercase = command36
(); }
985 elsif ( $command == 6 ) { $default_use_priority = command37
(); }
986 elsif ( $command == 7 ) { $hide_sm_attributions = command38
(); }
987 elsif ( $command == 8 ) { $default_use_mdn = command39
(); }
988 elsif ( $command == 9 ) { $edit_identity = command310
(); }
989 elsif ( $command == 10 ) { $disable_thread_sort = command312
(); }
990 elsif ( $command == 11 ) { $disable_server_sort = command313
(); }
991 elsif ( $command == 12 ) { $allow_charset_search = command314
(); }
992 elsif ( $command == 13 ) { $allow_advanced_search = command316
(); }
993 elsif ( $command == 14 ) { $session_name = command317
(); }
994 elsif ( $command == 15 ) { $time_zone_type = command318
(); }
995 elsif ( $command == 16 ) { $config_location_base = command_config_location_base
(); }
996 elsif ( $command == 17 ) { $only_secure_cookies = command319
(); }
997 } elsif ( $menu == 5 ) {
998 if ( $command == 1 ) { $use_icons = commandB3
(); }
999 # elsif ( $command == 3 ) { $icon_theme_def = command53(); }
1000 elsif ( $command == 2 ) { $default_fontsize = command_default_fontsize
(); }
1001 elsif ( $command == 3 ) { $templateset_default = command_templates
(); }
1002 elsif ( $command == 4 ) { command_userThemes
(); }
1003 elsif ( $command == 5 ) { command_fontsets
(); }
1004 elsif ( $command == 6 ) { command_iconSets
(); }
1005 } elsif ( $menu == 6 ) {
1006 if ( $command == 1 ) { command61
(); }
1007 elsif ( $command == 2 ) { command62
(); }
1008 elsif ( $command == 3 ) { $abook_global_file=command63
(); }
1009 elsif ( $command == 4 ) { command64
(); }
1010 elsif ( $command == 5 ) { command65
(); }
1011 elsif ( $command == 6 ) { command_abook_file_line_length
(); }
1012 } elsif ( $menu == 7 ) {
1013 if ( $command == 1 ) { $motd = command71
(); }
1014 } elsif ( $menu == 8 ) {
1015 if ( $command =~ /^[0-9]+/ ) { @plugins = command81
(); }
1016 elsif ( $command eq "u" ) { $disable_plugins_user = command82
(); }
1017 elsif ( $command eq "d" ) { $disable_plugins = 'true'; }
1018 elsif ( $command eq "e" ) { $disable_plugins = 'false'; }
1019 elsif ( $command =~ /^c([0-9]+)/ ) { $columns = $1; }
1020 } elsif ( $menu == 9 ) {
1021 if ( $command == 1 ) { $addrbook_dsn = command91
(); }
1022 elsif ( $command == 2 ) { $addrbook_table = command92
(); }
1023 elsif ( $command == 3 ) { $prefs_dsn = command93
(); }
1024 elsif ( $command == 4 ) { $prefs_table = command94
(); }
1025 elsif ( $command == 5 ) { $prefs_user_field = command95
(); }
1026 elsif ( $command == 6 ) { $prefs_key_field = command96
(); }
1027 elsif ( $command == 7 ) { $prefs_val_field = command97
(); }
1028 elsif ( $command == 8 ) { $addrbook_global_dsn = command98
(); }
1029 elsif ( $command == 9 ) { $addrbook_global_table = command99
(); }
1030 elsif ( $command == 10 ) { $addrbook_global_writeable = command910
(); }
1031 elsif ( $command == 11 ) { $addrbook_global_listing = command911
(); }
1032 } elsif ( $menu == 10 ) {
1033 if ( $command == 1 ) { $squirrelmail_default_language = commandA1
(); }
1034 elsif ( $command == 2 ) { $default_charset = commandA2
(); }
1035 elsif ( $command == 3 ) { $show_alternative_names = commandA3
(); }
1036 elsif ( $command == 4 ) { $aggressive_decoding = commandA4
(); }
1037 elsif ( $command == 5 ) { $lossy_encoding = commandA5
(); }
1038 } elsif ( $menu == 11 ) {
1039 if ( $command == 1 ) { $use_iframe = commandB2
(); }
1040 elsif ( $command == 2 ) { $ask_user_info = command_ask_user_info
(); }
1041 elsif ( $command == 4 ) { $use_php_recode = commandB4
(); }
1042 elsif ( $command == 5 ) { $use_php_iconv = commandB5
(); }
1043 elsif ( $command == 6 ) { $buffer_output = commandB6
(); }
1044 elsif ( $command == 7 ) { $allow_remote_configtest = commandB7
(); }
1045 elsif ( $command == 8 ) { $sm_debug_mode = commandB8
(); }
1046 elsif ( $command == 9 ) { $secured_config = commandB9
(); }
1047 elsif ( $command == 10 ) { $sq_https_port = commandB10
(); }
1048 elsif ( $command == 11 ) { $sq_ignore_http_x_forwarded_headers = commandB11
(); }
1054 print "\nExiting conf.pl.\n".
1055 "You might want to test your configuration by browsing to\n".
1056 "http://your-squirrelmail-location/src/configtest.php\n".
1057 "Happy SquirrelMailing!\n\n";
1060 ####################################################################################
1064 print "We have tried to make the name SquirrelMail as transparent as\n";
1065 print "possible. If you set up an organization name, most places where\n";
1066 print "SquirrelMail would take credit will be credited to your organization.\n";
1068 print "If your Organization Name includes a '\$', please precede it with a \\. \n";
1069 print "Other '\$' will be considered the beginning of a variable that\n";
1070 print "must be defined before the \$org_name is printed.\n";
1072 print "[$WHT$org_name$NRM]: $WHT";
1073 $new_org_name = <STDIN
>;
1074 if ( $new_org_name eq "\n" ) {
1075 $new_org_name = $org_name;
1077 $new_org_name =~ s/[\r\n]//g;
1078 $new_org_name =~ s/\"/"/g;
1080 return $new_org_name;
1085 print "Your organization's logo is an image that will be displayed at\n";
1086 print "different times throughout SquirrelMail. ";
1088 print "Please be aware of the following: \n";
1089 print " - Relative URLs are relative to the config dir\n";
1090 print " to use the default logo, use ../images/sm_logo.png\n";
1091 print " - To specify a logo defined outside the SquirrelMail source tree\n";
1092 print " use the absolute URL the webserver would use to include the file\n";
1093 print " e.g. http://example.com/images/mylogo.gif or /images/mylogo.jpg\n";
1095 print "[$WHT$org_logo$NRM]: $WHT";
1096 $new_org_logo = <STDIN
>;
1097 if ( $new_org_logo eq "\n" ) {
1098 $new_org_logo = $org_logo;
1100 $new_org_logo =~ s/[\r\n]//g;
1102 return $new_org_logo;
1107 print "Your organization's logo is an image that will be displayed at\n";
1108 print "different times throughout SquirrelMail. Width\n";
1109 print "and Height of your logo image. Use '0' to disable.\n";
1111 print "Width: [$WHT$org_logo_width$NRM]: $WHT";
1112 $new_org_logo_width = <STDIN
>;
1113 $new_org_logo_width =~ tr/0-9//cd; # only want digits!
1114 if ( $new_org_logo_width eq '' ) {
1115 $new_org_logo_width = $org_logo_width;
1117 if ( $new_org_logo_width > 0 ) {
1118 print "Height: [$WHT$org_logo_height$NRM]: $WHT";
1119 $new_org_logo_height = <STDIN
>;
1120 $new_org_logo_height =~ tr/0-9//cd; # only want digits!
1121 if( $new_org_logo_height eq '' ) {
1122 $new_org_logo_height = $org_logo_height;
1125 $new_org_logo_height = 0;
1127 return ($new_org_logo_width, $new_org_logo_height);
1132 print "A title is what is displayed at the top of the browser window in\n";
1133 print "the titlebar. Usually this will end up looking something like:\n";
1134 print "\"Netscape: $org_title\"\n";
1136 print "If your Organization Title includes a '\$', please precede it with a \\. \n";
1137 print "Other '\$' will be considered the beginning of a variable that\n";
1138 print "must be defined before the \$org_title is printed.\n";
1140 print "[$WHT$org_title$NRM]: $WHT";
1141 $new_org_title = <STDIN
>;
1142 if ( $new_org_title eq "\n" ) {
1143 $new_org_title = $org_title;
1145 $new_org_title =~ s/[\r\n]//g;
1146 $new_org_title =~ s/\"/\'/g;
1148 return $new_org_title;
1153 print "When users click the Sign Out button they will be logged out and\n";
1154 print "then sent to signout_page. If signout_page is left empty,\n";
1155 print "(hit space and then return) they will be taken, as normal,\n";
1156 print "to the default and rather sparse SquirrelMail signout page.\n";
1158 print "[$WHT$signout_page$NRM]: $WHT";
1159 $new_signout_page = <STDIN
>;
1160 if ( $new_signout_page eq "\n" ) {
1161 $new_signout_page = $signout_page;
1163 $new_signout_page =~ s/[\r\n]//g;
1164 $new_signout_page =~ s/^\s+$//g;
1166 return $new_signout_page;
1171 print "SquirrelMail defaults to using the whole of the browser window.\n";
1172 print "This allows you to keep it within a specified frame. The default\n";
1173 print "is '_top'\n";
1175 print "[$WHT$frame_top$NRM]: $WHT";
1176 $new_frame_top = <STDIN
>;
1177 if ( $new_frame_top eq "\n" ) {
1178 $new_frame_top = '_top';
1180 $new_frame_top =~ s/[\r\n]//g;
1181 $new_frame_top =~ s/^\s+$//g;
1183 return $new_frame_top;
1186 # Default link to provider
1188 print "Here you can set the link on the top-right of the message list.\n";
1189 print "If empty, it will not be displayed.\n";
1191 print "[$WHT$provider_uri$NRM]: $WHT";
1192 $new_provider_uri = <STDIN
>;
1193 if ( $new_provider_uri eq "\n" ) {
1194 $new_provider_uri = '';
1196 $new_provider_uri =~ s/[\r\n]//g;
1197 $new_provider_uri =~ s/^\s+$//g;
1199 return $new_provider_uri;
1203 print "Here you can set the name of the link on the top-right of the message list.\n";
1204 print "The default is empty (do not display anything).'\n";
1206 print "[$WHT$provider_name$NRM]: $WHT";
1207 $new_provider_name = <STDIN
>;
1208 if ( $new_provider_name eq "\n" ) {
1209 $new_provider_name = '';
1211 $new_provider_name =~ s/[\r\n]//g;
1212 $new_provider_name =~ s/^\s+$//g;
1213 $new_provider_name =~ s/\'/\\'/g;
1215 return $new_provider_name;
1218 ####################################################################################
1222 print "The domain name is the suffix at the end of all email addresses. If\n";
1223 print "for example, your email address is jdoe\@example.com, then your domain\n";
1224 print "would be example.com.\n";
1226 print "[$WHT$domain$NRM]: $WHT";
1227 $new_domain = <STDIN
>;
1228 if ( $new_domain eq "\n" ) {
1229 $new_domain = $domain;
1231 $new_domain =~ s/\s//g;
1238 print "This is the hostname where your IMAP server can be contacted.\n";
1239 print "[$WHT$imapServerAddress$NRM]: $WHT";
1240 $new_imapServerAddress = <STDIN
>;
1241 if ( $new_imapServerAddress eq "\n" ) {
1242 $new_imapServerAddress = $imapServerAddress;
1244 $new_imapServerAddress =~ s/[\r\n]//g;
1246 return $new_imapServerAddress;
1251 print "This is the port that your IMAP server is on. Usually this is 143.\n";
1252 print "[$WHT$imapPort$NRM]: $WHT";
1253 $new_imapPort = <STDIN
>;
1254 if ( $new_imapPort eq "\n" ) {
1255 $new_imapPort = $imapPort;
1257 $new_imapPort =~ s/[\r\n]//g;
1259 return $new_imapPort;
1264 print "You now need to choose the method that you will use for sending\n";
1265 print "messages in SquirrelMail. You can either connect to an SMTP server\n";
1266 print "or use sendmail directly.\n";
1267 if ( lc($useSendmail) eq 'true' ) {
1268 $default_value = "1";
1270 $default_value = "2";
1273 print " 1. Sendmail\n";
1275 print "Your choice [1/2] [$WHT$default_value$NRM]: $WHT";
1276 $use_sendmail = <STDIN
>;
1277 if ( ( $use_sendmail =~ /^1\n/i )
1278 || ( ( $use_sendmail =~ /^\n/ ) && ( $default_value eq "1" ) ) ) {
1279 $useSendmail = 'true';
1281 $useSendmail = 'false';
1283 return $useSendmail;
1288 print "Specify where the sendmail executable is located. Usually /usr/sbin/sendmail\n";
1289 print "[$WHT$sendmail_path$NRM]: $WHT";
1290 $new_sendmail_path = <STDIN
>;
1291 if ( $new_sendmail_path eq "\n" ) {
1292 $new_sendmail_path = $sendmail_path;
1294 $new_sendmail_path =~ s/[\r\n]//g;
1296 return $new_sendmail_path;
1299 # Extra sendmail arguments
1300 sub command_sendmail_args
{
1301 print "Specify additional sendmail program arguments.\n";
1303 print "Make sure that arguments are supported by your sendmail program. -f argument \n";
1304 print "is added automatically by SquirrelMail scripts. Variable defaults to standard\n";
1305 print "/usr/sbin/sendmail arguments. If you use qmail-inject, nbsmtp or any other \n";
1306 print "sendmail wrapper, which does not support -i and -t arguments, set variable to\n";
1307 print "empty string or use arguments suitable for your mailer.\n";
1309 print "[$WHT$sendmail_args$NRM]: $WHT";
1310 $new_sendmail_args = <STDIN
>;
1311 if ( $new_sendmail_args eq "\n" ) {
1312 $new_sendmail_args = $sendmail_args;
1314 # strip linefeeds and crs.
1315 $new_sendmail_args =~ s/[\r\n]//g;
1317 return trim
($new_sendmail_args);
1322 print "This is the hostname of your SMTP server.\n";
1323 print "[$WHT$smtpServerAddress$NRM]: $WHT";
1324 $new_smtpServerAddress = <STDIN
>;
1325 if ( $new_smtpServerAddress eq "\n" ) {
1326 $new_smtpServerAddress = $smtpServerAddress;
1328 $new_smtpServerAddress =~ s/[\r\n]//g;
1330 return $new_smtpServerAddress;
1335 print "This is the port to connect to for SMTP. Usually 25.\n";
1336 print "[$WHT$smtpPort$NRM]: $WHT";
1337 $new_smtpPort = <STDIN
>;
1338 if ( $new_smtpPort eq "\n" ) {
1339 $new_smtpPort = $smtpPort;
1341 $new_smtpPort =~ s/[\r\n]//g;
1343 return $new_smtpPort;
1348 print "Do you wish to use POP3 before SMTP? Your server must\n";
1349 print "support this in order for SquirrelMail to work with it.\n";
1352 $YesNo = 'y' if ( lc($pop_before_smtp) eq 'true' );
1354 print "Use POP before SMTP (y/n) [$WHT$YesNo$NRM]: $WHT";
1356 $new_pop_before_smtp = <STDIN
>;
1357 $new_pop_before_smtp =~ tr/yn//cd;
1358 if ( $new_pop_before_smtp eq "y" ) {
1359 $new_pop_before_smtp = "true";
1360 } elsif ( $new_pop_before_smtp eq "n" ) {
1361 $new_pop_before_smtp = "false";
1363 $new_pop_before_smtp = $pop_before_smtp;
1366 # if using POP before SMTP, allow setting of custom POP server address
1367 if ($new_pop_before_smtp eq "true") {
1368 print "$NRM\nIf the address of the POP server is not the same as\n";
1369 print "your SMTP server, you may specify it here. Leave blank (to\n";
1370 print "clear this, enter only spaces) to use the same address as\n";
1371 print "your SMTP server.\n";
1372 print "POP before SMTP server address [$WHT$pop_before_smtp_host$NRM]: $WHT";
1374 $new_pop_before_smtp_host = <STDIN
>;
1375 if ( $new_pop_before_smtp_host eq "\n" ) {
1376 $new_pop_before_smtp_host = $pop_before_smtp_host;
1377 } elsif ($new_pop_before_smtp_host =~ /^\s+$/) {
1378 $new_pop_before_smtp_host = '';
1380 $new_pop_before_smtp_host =~ s/[\r|\n]//g;
1382 $pop_before_smtp_host = $new_pop_before_smtp_host;
1385 return $new_pop_before_smtp;
1390 print "Each IMAP server has its own quirks. As much as we tried to stick\n";
1391 print "to standards, it doesn't help much if the IMAP server doesn't follow\n";
1392 print "the same principles. We have made some work-arounds for some of\n";
1393 print "these servers. If you would like to use them, please select your\n";
1394 print "IMAP server. If you do not wish to use these work-arounds, you can\n";
1395 print "set this to \"other\", and none will be used.\n";
1396 print $list_supported_imap_servers;
1398 print " other = Not one of the above servers\n";
1400 print "[$WHT$imap_server_type$NRM]: $WHT";
1401 $new_imap_server_type = <STDIN
>;
1403 if ( $new_imap_server_type eq "\n" ) {
1404 $new_imap_server_type = $imap_server_type;
1406 $new_imap_server_type =~ s/[\r\n]//g;
1408 return $new_imap_server_type;
1413 print "Sometimes the date of messages sent is messed up (off by a few hours\n";
1414 print "on some machines). Typically this happens if the system doesn't support\n";
1415 print "tm_gmtoff. It will happen only if your time zone is \"negative\".\n";
1416 print "This most often occurs on Solaris 7 machines in the United States.\n";
1417 print "By default, this is off. It should be kept off unless problems surface\n";
1418 print "about the time that messages are sent.\n";
1419 print " no = Do NOT fix time -- almost always correct\n";
1420 print " yes = Fix the time for this system\n";
1423 $YesNo = 'y' if ( lc($invert_time) eq 'true' );
1425 print "Fix the time for this system (y/n) [$WHT$YesNo$NRM]: $WHT";
1427 $new_invert_time = <STDIN
>;
1428 $new_invert_time =~ tr/yn//cd;
1429 return 'true' if ( $new_invert_time eq "y" );
1430 return 'false' if ( $new_invert_time eq "n" );
1431 return $invert_time;
1435 print "This is the delimiter that your IMAP server uses to distinguish between\n";
1436 print "folders. For example, Cyrus uses '.' as the delimiter and a complete\n";
1437 print "folder would look like 'INBOX.Friends.Bob', while UW uses '/' and would\n";
1438 print "look like 'INBOX/Friends/Bob'. Normally this should be left at 'detect'\n";
1439 print "but if you are sure you know what delimiter your server uses, you can\n";
1440 print "specify it here.\n";
1441 print "\nTo have it autodetect the delimiter, set it to 'detect'.\n\n";
1442 print "[$WHT$optional_delimiter$NRM]: $WHT";
1443 $new_optional_delimiter = <STDIN
>;
1445 if ( $new_optional_delimiter eq "\n" ) {
1446 $new_optional_delimiter = $optional_delimiter;
1448 $new_optional_delimiter =~ s/[\r\n]//g;
1450 return $new_optional_delimiter;
1452 # IMAP authentication type
1453 # Possible values: login, plain, cram-md5, digest-md5
1454 # Now offers to detect supported mechs, assuming server & port are set correctly
1457 if ($use_imap_tls ne "0") {
1458 # 1. Script does not handle TLS.
1459 # 2. Server does not have to declare all supported authentication mechs when
1460 # STARTTLS is used. Supported mechs are declared only after STARTTLS.
1461 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1463 print "If you have already set the hostname and port number, I can try to\n";
1464 print "detect the mechanisms your IMAP server supports.\n";
1465 print "I will try to detect CRAM-MD5 and DIGEST-MD5 support. I can't test\n";
1466 print "for \"login\" or \"plain\" without knowing a username and password.\n";
1467 print "Auto-detecting is optional - you can safely say \"n\" here.\n";
1468 print "\nTry to detect supported mechanisms? [y/N]: ";
1471 if ($inval =~ /^y\b/i) {
1472 # Yes, let's try to detect.
1473 print "Trying to detect IMAP capabilities...\n";
1474 my $host = $imapServerAddress . ':'. $imapPort;
1475 print "CRAM-MD5:\t";
1476 my $tmp = detect_auth_support
('IMAP',$host,'CRAM-MD5');
1477 if (defined($tmp)) {
1478 if ($tmp eq 'YES') {
1479 print "$WHT SUPPORTED$NRM\n";
1481 print "$WHT NOT SUPPORTED$NRM\n";
1484 print $WHT . " ERROR DETECTING$NRM\n";
1487 print "DIGEST-MD5:\t";
1488 $tmp = detect_auth_support
('IMAP',$host,'DIGEST-MD5');
1489 if (defined($tmp)) {
1490 if ($tmp eq 'YES') {
1491 print "$WHT SUPPORTED$NRM\n";
1493 print "$WHT NOT SUPPORTED$NRM\n";
1496 print $WHT . " ERROR DETECTING$NRM\n";
1501 print "\nWhat authentication mechanism do you want to use for IMAP connections?\n\n";
1502 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1503 print $WHT . "plain" . $NRM . " - SASL PLAIN. If you need this, you already know it.\n";
1504 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext methods.\n";
1505 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1506 print "\n*** YOUR IMAP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n";
1507 print "If you don't understand or are unsure, you probably want \"login\"\n\n";
1508 print "login, plain, cram-md5, or digest-md5 [$WHT$imap_auth_mech$NRM]: $WHT";
1511 if ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) || ($inval =~ /^login\b/i) || ($inval =~ /^plain\b/i)) {
1514 # user entered garbage or default value so nothing needs to be set
1515 return $imap_auth_mech;
1520 # SMTP authentication type
1521 # Possible choices: none, plain, cram-md5, digest-md5
1523 if ($use_smtp_tls ne "0") {
1524 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1525 } elsif (eval ("use IO::Socket; 1")) {
1526 # try loading IO::Socket module
1527 print "If you have already set the hostname and port number, I can try to\n";
1528 print "automatically detect some of the mechanisms your SMTP server supports.\n";
1529 print "Auto-detection is *optional* - you can safely say \"n\" here.\n";
1530 print "\nTry to detect auth mechanisms? [y/N]: ";
1533 if ($inval =~ /^y\b/i) {
1534 # Yes, let's try to detect.
1535 print "Trying to detect supported methods (SMTP)...\n";
1538 # Check none by trying to relay to junk@microsoft.com
1539 $host = $smtpServerAddress . ':' . $smtpPort;
1540 my $sock = IO
::Socket
::INET
->new($host);
1541 print "Testing none:\t\t$WHT";
1542 if (!defined($sock)) {
1543 print " ERROR TESTING\n";
1546 $got = <$sock>; # Discard greeting
1547 print $sock "HELO $domain\r\n";
1548 $got = <$sock>; # Discard
1549 print $sock "MAIL FROM:<tester\@squirrelmail.org>\r\n";
1550 $got = <$sock>; # Discard
1551 print $sock "RCPT TO:<junk\@microsoft.com\r\n";
1552 $got = <$sock>; # This is the important line
1553 if ($got =~ /^250\b/) { # SMTP will relay without auth
1554 print "SUPPORTED$NRM\n";
1556 print "NOT SUPPORTED$NRM\n";
1558 print $sock "RSET\r\n";
1559 print $sock "QUIT\r\n";
1562 # Try login (SquirrelMail default)
1563 print "Testing login:\t\t";
1564 $tmp=detect_auth_support
('SMTP',$host,'LOGIN');
1565 if (defined($tmp)) {
1566 if ($tmp eq 'YES') {
1567 print $WHT . "SUPPORTED$NRM\n";
1569 print $WHT . "NOT SUPPORTED$NRM\n";
1572 print $WHT . "ERROR DETECTING$NRM\n";
1576 print "Testing CRAM-MD5:\t";
1577 $tmp=detect_auth_support
('SMTP',$host,'CRAM-MD5');
1578 if (defined($tmp)) {
1579 if ($tmp eq 'YES') {
1580 print $WHT . "SUPPORTED$NRM\n";
1582 print $WHT . "NOT SUPPORTED$NRM\n";
1585 print $WHT . "ERROR DETECTING$NRM\n";
1589 print "Testing DIGEST-MD5:\t";
1590 $tmp=detect_auth_support
('SMTP',$host,'DIGEST-MD5');
1591 if (defined($tmp)) {
1592 if ($tmp eq 'YES') {
1593 print $WHT . "SUPPORTED$NRM\n";
1595 print $WHT . "NOT SUPPORTED$NRM\n";
1598 print $WHT . "ERROR DETECTING$NRM\n";
1602 print "\nWhat authentication mechanism do you want to use for SMTP connections?\n";
1603 print $WHT . "none" . $NRM . " - Your SMTP server does not require authorization.\n";
1604 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1605 print $WHT . "plain" . $NRM . " - SASL PLAIN. You already know it if you need this.\n";
1606 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext.\n";
1607 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1608 print $WHT . "\n*** YOUR SMTP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n" . $NRM;
1609 print "If you don't understand or are unsure, you probably want \"none\"\n\n";
1610 print "none, login, cram-md5, or digest-md5 [$WHT$smtp_auth_mech$NRM]: $WHT";
1613 if ($inval =~ /^none\b/i) {
1614 # remove sitewide smtp authentication information
1615 $smtp_sitewide_user = '';
1616 $smtp_sitewide_pass = '';
1617 # SMTP doesn't necessarily require logins
1619 } elsif ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) ||
1620 ($inval =~ /^login\b/i) || ($inval =~/^plain\b/i)) {
1621 command_smtp_sitewide_userpass
($inval);
1623 } elsif (trim
($inval) eq '') {
1624 # user selected default value
1625 command_smtp_sitewide_userpass
($smtp_auth_mech);
1626 return $smtp_auth_mech;
1628 # user entered garbage
1629 return $smtp_auth_mech;
1633 sub command_smtp_sitewide_userpass
($) {
1634 # get first function argument
1635 my $auth_mech = shift(@_);
1637 $auth_mech = lc(trim
($auth_mech));
1638 if ($auth_mech eq 'none') {
1641 print "SMTP authentication uses IMAP username and password by default.\n";
1643 print "Would you like to use other login and password for all SquirrelMail \n";
1644 print "SMTP connections?";
1645 if ($smtp_sitewide_user ne '') {
1662 $smtp_sitewide_user = '';
1663 $smtp_sitewide_pass = '';
1664 } elsif ($tmp eq 'y') {
1665 print "Enter username [$smtp_sitewide_user]:";
1666 my $new_user = <STDIN
>;
1667 $new_user = trim
($new_user);
1668 if ($new_user ne '') {
1669 $smtp_sitewide_user = $new_user;
1671 if ($smtp_sitewide_user ne '') {
1672 print "If you don't enter any password, current sitewide password will be used.\n";
1673 print "If you enter space, password will be set to empty string.\n";
1674 print "Enter password:";
1675 my $new_pass = <STDIN
>;
1676 if ($new_pass ne "\n") {
1677 $smtp_sitewide_pass = trim
($new_pass);
1680 print "Invalid input. You must set username used for SMTP authentication.\n";
1681 print "Click enter to continue\n";
1685 print "Invalid input\n";
1686 print "Click enter to continue\n";
1691 # Sub adds information about SMTP authentication type to menu
1692 sub display_smtp_sitewide_userpass
() {
1694 if ($smtp_auth_mech ne 'none') {
1695 if ($smtp_sitewide_user ne '') {
1696 $ret = ' (with custom username and password)';
1698 $ret = ' (with IMAP username and password)';
1705 # This sub is reused for IMAP and SMTP
1706 # Args: service name, default value
1707 sub command_use_tls
{
1708 my($default_val,$service,$inval);
1711 print "TLS (Transport Layer Security) encrypts the traffic between server and client.\n";
1712 print "STARTTLS extensions allow to start encryption on existing plain text connection.\n";
1713 print "These options add specific PHP and IMAP server configuration requirements.\n";
1714 print "See SquirrelMail documentation about connection security.\n";
1716 print "If your " . $service . " server is localhost, you can safely disable this.\n";
1717 print "If it is remote, you may wish to seriously consider enabling this.\n";
1719 while ($valid_input eq 0) {
1720 print "\nSelect connection security model:\n";
1721 print " 0 - Use plain text connection\n";
1722 print " 1 - Use TLS connection\n";
1723 print " 2 - Use STARTTLS extension\n";
1724 print "Select [$default_val]: ";
1726 $inval=trim
($inval);
1727 if ($inval =~ /^[012]$/ || $inval eq '') {
1731 if ($inval ne '') {$default_val = $inval};
1732 return $default_val;
1735 # This sub is used to display human readable text for
1736 # $use_imap_tls and $use_smtp_tls values in conf.pl menu
1737 sub display_use_tls
($) {
1738 my $val = shift(@_);
1739 my $ret = 'disabled';
1742 } elsif ($val eq '1') {
1748 # $encode_header_key
1750 print "This encryption key allows the hiding of SquirrelMail Received:\n";
1751 print "headers in outbound messages. SquirrelMail uses the encryption\n";
1752 print "key to encode the username, remote address, and proxied address\n";
1753 print "and then stores that encoded information in X-Squirrel-* headers.\n";
1755 print "Warning: the encryption function used to accomplish this is not\n";
1756 print "bulletproof. When used with a static encryption key as it is here,\n";
1757 print "it provides only minimal security and the encoded user information\n";
1758 print "in the X-Squirrel-* headers can be decoded quickly by a skilled\n";
1759 print "attacker.\n";
1761 print "When you need to inspect an email sent from your system with the\n";
1762 print "X-Squirrel-* headers, you can decode the user information therein\n";
1763 print "by using the decrypt_headers.php script found in the SquirrelMail\n";
1764 print "contrib/ directory. You'll need the encryption key that you\n";
1765 print "defined here when doing so.\n";
1767 print "Enter encryption key: ";
1768 $new_encode_header_key = <STDIN
>;
1769 if ( $new_encode_header_key eq "\n" ) {
1770 $new_encode_header_key = $encode_header_key;
1772 $new_encode_header_key =~ s/[\r\n]//g;
1774 return $new_encode_header_key;
1779 print "\nYou can now create the welcome message that is displayed\n";
1780 print "every time a user logs on. You can use HTML or just plain\n";
1782 "text. If you do not wish to have one, just make it blank.\n\n(Type @ on a blank line to exit)\n";
1788 $line =~ s/[\r\n]//g;
1789 if ( $line ne "@" ) {
1790 $line =~ s/ /\ \ /g;
1791 $line =~ s/\t/\ \ \ \ /g;
1793 $line =~ s/\"/\\\"/g;
1795 $new_motd = $new_motd . $line;
1797 } while ( $line ne "@" );
1801 ################# PLUGINS ###################
1804 $command =~ s/[\s\n\r]*//g;
1805 if ( $command > 0 ) {
1806 $command = $command - 1;
1807 if ( $command <= $#plugins ) {
1810 while ( $ct <= $#plugins ) {
1811 if ( $ct != $command ) {
1812 @newplugins = ( @newplugins, $plugins[$ct] );
1816 @plugins = @newplugins;
1817 } elsif ( $command <= $#plugins + $#unused_plugins + 1 ) {
1818 $num = $command - $#plugins - 1;
1819 @newplugins = @plugins;
1821 while ( $ct <= $#unused_plugins ) {
1822 if ( $ct == $num ) {
1823 @newplugins = ( @newplugins, $unused_plugins[$ct] );
1827 @plugins = @newplugins;
1833 # disable_plugins_user
1835 print "When all active plugins are disabled, they can be disabled only\n";
1836 print "for the one user named here. If left blank, plugins will be\n";
1837 print "disabled for ALL users. This setting has no effect if plugins\n";
1838 print "are not disabled.\n";
1840 print "This must be the exact IMAP login name for the desired user.\n";
1842 print "[$WHT$disable_plugins_user$NRM]: $WHT";
1843 $new_disable_plugins_user = <STDIN
>;
1844 if ( $new_disable_plugins_user eq "\n" ) {
1845 $new_disable_plugins_user = $disable_plugins_user;
1847 $new_disable_plugins_user =~ s/[\r\n]//g;
1849 return $new_disable_plugins_user;
1852 ################# FOLDERS ###################
1854 # default_folder_prefix
1856 print "Some IMAP servers (UW, for example) store mail and folders in\n";
1857 print "your user space in a separate subdirectory. This is where you\n";
1858 print "specify what that directory is.\n";
1860 print "EXAMPLE: mail/";
1862 print "NOTE: If you use Cyrus, or some server that would not use this\n";
1863 print " option, you must set this to 'none'.\n";
1865 print "[$WHT$default_folder_prefix$NRM]: $WHT";
1866 $new_default_folder_prefix = <STDIN
>;
1868 if ( $new_default_folder_prefix eq "\n" ) {
1869 $new_default_folder_prefix = $default_folder_prefix;
1871 $new_default_folder_prefix =~ s/[\r\n]//g;
1873 if ( ( $new_default_folder_prefix =~ /^\s*$/ ) || ( $new_default_folder_prefix =~ m/^none$/i ) ) {
1874 $new_default_folder_prefix = "";
1876 # add the trailing delimiter only if we know what the server is.
1877 if (($imap_server_type eq 'cyrus' and
1878 $optional_delimiter eq 'detect') or
1879 ($imap_server_type eq 'courier' and
1880 $optional_delimiter eq 'detect')) {
1881 $new_default_folder_prefix =~ s/\.*$/\./;
1882 } elsif ($imap_server_type eq 'uw' and
1883 $optional_delimiter eq 'detect') {
1884 $new_default_folder_prefix =~ s/\/*$/\
//;
1887 return $new_default_folder_prefix;
1890 # Show Folder Prefix
1892 print "It is possible to set up the default folder prefix as a user\n";
1893 print "specific option, where each user can specify what their mail\n";
1894 print "folder is. If you set this to false, they will never see the\n";
1895 print "option, but if it is true, this option will appear in the\n";
1896 print "'options' section.\n";
1898 print "NOTE: You set the default folder prefix in option '1' of this\n";
1899 print " section. That will be the default if the user doesn't\n";
1900 print " specify anything different.\n";
1903 if ( lc($show_prefix_option) eq 'true' ) {
1904 $default_value = "y";
1906 $default_value = "n";
1909 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
1910 $new_show = <STDIN
>;
1911 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1912 $show_prefix_option = 'true';
1914 $show_prefix_option = 'false';
1916 return $show_prefix_option;
1921 print "You can now specify where the default trash folder is located.\n";
1922 print "On servers where you do not want this, you can set it to anything\n";
1923 print "and set option 6 to false.\n";
1925 print "This is relative to where the rest of your email is kept. You do\n";
1926 print "not need to worry about their mail directory. If this folder\n";
1927 print "would be ~/mail/trash on the filesystem, you only need to specify\n";
1928 print "that this is 'trash', and be sure to put 'mail/' in option 1.\n";
1931 print "[$WHT$trash_folder$NRM]: $WHT";
1932 $new_trash_folder = <STDIN
>;
1933 if ( $new_trash_folder eq "\n" ) {
1934 $new_trash_folder = $trash_folder;
1936 if (check_imap_folder
($new_trash_folder)) {
1937 $new_trash_folder =~ s/[\r\n]//g;
1939 $new_trash_folder = $trash_folder;
1942 return $new_trash_folder;
1947 print "This is where messages that are sent will be stored. SquirrelMail\n";
1948 print "by default puts a copy of all outgoing messages in this folder.\n";
1950 print "This is relative to where the rest of your email is kept. You do\n";
1951 print "not need to worry about their mail directory. If this folder\n";
1952 print "would be ~/mail/sent on the filesystem, you only need to specify\n";
1953 print "that this is 'sent', and be sure to put 'mail/' in option 1.\n";
1956 print "[$WHT$sent_folder$NRM]: $WHT";
1957 $new_sent_folder = <STDIN
>;
1958 if ( $new_sent_folder eq "\n" ) {
1959 $new_sent_folder = $sent_folder;
1961 if (check_imap_folder
($new_sent_folder)) {
1962 $new_sent_folder =~ s/[\r\n]//g;
1964 $new_sent_folder = $sent_folder;
1967 return $new_sent_folder;
1972 print "You can now specify where the default draft folder is located.\n";
1973 print "On servers where you do not want this, you can set it to anything\n";
1974 print "and set option 9 to false.\n";
1976 print "This is relative to where the rest of your email is kept. You do\n";
1977 print "not need to worry about their mail directory. If this folder\n";
1978 print "would be ~/mail/drafts on the filesystem, you only need to specify\n";
1979 print "that this is 'drafts', and be sure to put 'mail/' in option 1.\n";
1982 print "[$WHT$draft_folder$NRM]: $WHT";
1983 $new_draft_folder = <STDIN
>;
1984 if ( $new_draft_folder eq "\n" ) {
1985 $new_draft_folder = $draft_folder;
1987 if (check_imap_folder
($new_draft_folder)) {
1988 $new_draft_folder =~ s/[\r\n]//g;
1990 $new_draft_folder = $draft_folder;
1993 return $new_draft_folder;
1996 # default move to trash
1998 print "By default, should messages get moved to the trash folder? You\n";
1999 print "can specify the default trash folder in option 3. If this is set\n";
2000 print "to false, messages will get deleted immediately without moving\n";
2001 print "to the trash folder.\n";
2003 print "Trash folder is currently: $trash_folder\n";
2006 if ( lc($default_move_to_trash) eq 'true' ) {
2007 $default_value = "y";
2009 $default_value = "n";
2011 print "By default, move to trash (y/n) [$WHT$default_value$NRM]: $WHT";
2012 $new_show = <STDIN
>;
2013 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2014 $default_move_to_trash = 'true';
2016 $default_move_to_trash = 'false';
2018 return $default_move_to_trash;
2021 # default move to sent (save sent messages)
2023 print "By default, should copies of outgoing messages get saved in the\n";
2024 print "sent folder? You can specify the default sent folder in option 4.\n";
2025 print "If this is set to false, messages will get sent and no copy will\n";
2028 print "Sent folder is currently: $sent_folder\n";
2031 if ( lc($default_move_to_sent) eq 'true' ) {
2032 $default_value = "y";
2034 $default_value = "n";
2036 print "By default, save sent messages (y/n) [$WHT$default_value$NRM]: $WHT";
2037 $new_show = <STDIN
>;
2038 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2039 $default_move_to_sent = 'true';
2041 $default_move_to_sent = 'false';
2043 return $default_move_to_sent;
2046 # default save as draft
2048 print "By default, should the save to draft option be shown? You can\n";
2049 print "specify the default drafts folder in option 5. If this is set\n";
2050 print "to false, users will not be shown the save to draft option.\n";
2052 print "Drafts folder is currently: $draft_folder\n";
2055 if ( lc($default_save_as_draft) eq 'true' ) {
2056 $default_value = "y";
2058 $default_value = "n";
2060 print "By default, save as draft (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_save_as_draft = 'true';
2065 $default_save_as_draft = 'false';
2067 return $default_save_as_draft;
2070 # List special folders first
2072 print "SquirrelMail has what we call 'special folders' that are not\n";
2073 print "manipulated and viewed like normal folders. Some examples of\n";
2074 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
2075 print "Simply asks if you want these folders listed first in the folder\n";
2079 if ( lc($list_special_folders_first) eq 'true' ) {
2080 $default_value = "y";
2082 $default_value = "n";
2085 print "List first (y/n) [$WHT$default_value$NRM]: $WHT";
2086 $new_show = <STDIN
>;
2087 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2088 $list_special_folders_first = 'true';
2090 $list_special_folders_first = 'false';
2092 return $list_special_folders_first;
2095 # Show special folders color
2097 print "SquirrelMail has what we call 'special folders' that are not\n";
2098 print "manipulated and viewed like normal folders. Some examples of\n";
2099 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
2100 print "wants to know if we should display special folders in a\n";
2101 print "color than the other folders.\n";
2104 if ( lc($use_special_folder_color) eq 'true' ) {
2105 $default_value = "y";
2107 $default_value = "n";
2110 print "Show color (y/n) [$WHT$default_value$NRM]: $WHT";
2111 $new_show = <STDIN
>;
2112 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2113 $use_special_folder_color = 'true';
2115 $use_special_folder_color = 'false';
2117 return $use_special_folder_color;
2122 print "The way that IMAP handles deleting messages is as follows. You\n";
2123 print "mark the message as deleted, and then to 'really' delete it, you\n";
2124 print "expunge it. This option asks if you want to just have messages\n";
2125 print "marked as deleted, or if you want SquirrelMail to expunge the \n";
2126 print "messages too.\n";
2129 if ( lc($auto_expunge) eq 'true' ) {
2130 $default_value = "y";
2132 $default_value = "n";
2134 print "Auto expunge (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 $auto_expunge = 'true';
2139 $auto_expunge = 'false';
2141 return $auto_expunge;
2144 # Default sub of inbox
2146 print "Some IMAP servers (Cyrus) have all folders as subfolders of INBOX.\n";
2147 print "This can cause some confusion in folder creation for users when\n";
2148 print "they try to create folders and don't put it as a subfolder of INBOX\n";
2149 print "and get permission errors. This option asks if you want folders\n";
2150 print "to be subfolders of INBOX by default.\n";
2153 if ( lc($default_sub_of_inbox) eq 'true' ) {
2154 $default_value = "y";
2156 $default_value = "n";
2158 print "Default sub of INBOX (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 $default_sub_of_inbox = 'true';
2163 $default_sub_of_inbox = 'false';
2165 return $default_sub_of_inbox;
2168 # Show contain subfolder option
2170 print "Some IMAP servers (UW) make it so that there are two types of\n";
2171 print "folders. Those that contain messages, and those that contain\n";
2172 print "subfolders. If this is the case for your server, set this to\n";
2173 print "true, and it will ask the user whether the folder they are\n";
2174 print "creating contains subfolders or messages.\n";
2177 if ( lc($show_contain_subfolders_option) eq 'true' ) {
2178 $default_value = "y";
2180 $default_value = "n";
2182 print "Show option (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 $show_contain_subfolders_option = 'true';
2187 $show_contain_subfolders_option = 'false';
2189 return $show_contain_subfolders_option;
2192 # Default Unseen Notify
2194 print "This option specifies where the users will receive notification\n";
2195 print "about unseen messages by default. This is of course an option that\n";
2196 print "can be changed on a user level.\n";
2197 print " 1 = No notification\n";
2198 print " 2 = Only on the INBOX\n";
2199 print " 3 = On all folders\n";
2202 print "Which one should be default (1,2,3)? [$WHT$default_unseen_notify$NRM]: $WHT";
2203 $new_show = <STDIN
>;
2204 if ( $new_show =~ /^[123]\n/i ) {
2205 $default_unseen_notify = $new_show;
2207 $default_unseen_notify =~ s/[\r\n]//g;
2208 return $default_unseen_notify;
2211 # Default Unseen Type
2213 print "Here you can define the default way that unseen messages will be displayed\n";
2214 print "to the user in the folder listing on the left side.\n";
2215 print " 1 = Only unseen messages (4)\n";
2216 print " 2 = Unseen and Total messages (4/27)\n";
2219 print "Which one should be default (1,2)? [$WHT$default_unseen_type$NRM]: $WHT";
2220 $new_show = <STDIN
>;
2221 if ( $new_show =~ /^[12]\n/i ) {
2222 $default_unseen_type = $new_show;
2224 $default_unseen_type =~ s/[\r\n]//g;
2225 return $default_unseen_type;
2228 # Auto create special folders
2230 print "Would you like the Sent, Trash, and Drafts folders to be created\n";
2231 print "automatically print for you when a user logs in? If the user\n";
2232 print "accidentally deletes their special folders, this option will\n";
2233 print "automatically create it again for them.\n";
2236 if ( lc($auto_create_special) eq 'true' ) {
2237 $default_value = "y";
2239 $default_value = "n";
2241 print "Auto create special folders? (y/n) [$WHT$default_value$NRM]: $WHT";
2242 $new_show = <STDIN
>;
2243 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2244 $auto_create_special = 'true';
2246 $auto_create_special = 'false';
2248 return $auto_create_special;
2251 # Automatically delete folders
2253 if ( $imap_server_type eq "uw" ) {
2254 print "UW IMAP servers will not allow folders containing mail to also contain folders.\n";
2255 print "Deleting folders will bypass the trash folder and be immediately deleted\n\n";
2256 print "If this is not the correct value for your server,\n";
2257 print "please use option D on the Main Menu to configure your server correctly.\n\n";
2258 print "Press enter to continue...\n";
2259 $new_delete = <STDIN
>;
2260 $delete_folder = 'true';
2262 if ( $imap_server_type eq "courier" ) {
2263 print "Courier (or Courier-IMAP) IMAP servers may not support ";
2264 print "subfolders of Trash. \n";
2265 print "Specifically, if Courier is set to always move messages to Trash, \n";
2266 print "Trash will be treated by Courier as a special folder that does not \n";
2267 print "allow subfolders. \n\n";
2268 print "Please verify your Courier configuration, and test folder deletion \n";
2269 print "when changing this setting.\n\n";
2272 print "Are subfolders of the Trash supported by your IMAP server?\n";
2273 print "If so, should deleted folders be sent to Trash?\n";
2274 print "If not, say no (deleted folders should not be sent to Trash)\n\n";
2275 # reversal of logic.
2276 # question was: Should folders be automatically deleted instead of sent to trash..
2277 # we've changed the question to make it more clear,
2278 # and are here handling that to avoid changing the answers..
2279 if ( lc($delete_folder) eq 'true' ) {
2280 $default_value = "n";
2282 $default_value = "y";
2284 print "Send deleted folders to Trash? (y/n) [$WHT$default_value$NRM]: $WHT";
2285 $new_delete = <STDIN
>;
2286 if ( ( $new_delete =~ /^y\n/i ) || ( ( $new_delete =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2287 $delete_folder = 'false';
2289 $delete_folder = 'true';
2292 return $delete_folder;
2297 print "Some IMAP servers allow subfolders to exist even if the parent\n";
2298 print "folders do not. This fixes some problems with the folder list\n";
2299 print "when this is the case, causing the /NoSelect folders to be displayed\n";
2302 if ( lc($noselect_fix_enable) eq 'true' ) {
2303 $default_value = "y";
2305 $default_value = "n";
2307 print "enable noselect fix? (y/n) [$WHT$noselect_fix_enable$NRM]: $WHT";
2308 $noselect_fix_enable = <STDIN
>;
2309 if ( ( $noselect_fix_enable =~ /^y\n/i ) || ( ( $noselect_fix_enable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2310 $noselect_fix_enable = 'true';
2312 $noselect_fix_enable = 'false';
2314 return $noselect_fix_enable;
2316 ############# GENERAL OPTIONS #####################
2320 print "Specify the location for your data directory.\n";
2321 print "You need to create this directory yourself.\n";
2322 print "The path name can be absolute or relative (to the config directory).\n";
2323 print "Here are two examples:\n";
2324 print " Absolute: /var/local/squirrelmail/data/\n";
2325 print " Relative: ../data/\n";
2326 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2327 print "will be converted to their absolute path equivalents in config.php.\n\n";
2328 print "Note: There are potential security risks with having a writeable directory\n";
2329 print "under the web server's root directory (ex: /home/httpd/html).\n";
2330 print "For this reason, it is recommended to put the data directory\n";
2331 print "in an alternate location of your choice. \n";
2334 print "[$WHT$data_dir$NRM]: $WHT";
2335 $new_data_dir = <STDIN
>;
2336 if ( $new_data_dir eq "\n" ) {
2337 $new_data_dir = $data_dir;
2339 $new_data_dir =~ s/[\r\n]//g;
2341 if ( $new_data_dir =~ /^\s*$/ ) {
2344 $new_data_dir =~ s/\/*$//g
;
2345 $new_data_dir =~ s/$/\//g
;
2347 return $new_data_dir;
2350 # Attachment directory
2352 print "Path to directory used for storing attachments while a mail is\n";
2353 print "being composed. The path name can be absolute or relative (to the\n";
2354 print "config directory). Here are two examples:\n";
2355 print " Absolute: /var/local/squirrelmail/attach/\n";
2356 print " Relative: ../attach/\n";
2357 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2358 print "will be converted to their absolute path equivalents in config.php.\n\n";
2359 print "Note: There are a few security considerations regarding this\n";
2360 print "directory:\n";
2361 print " 1. It should have the permission 733 (rwx-wx-wx) to make it\n";
2362 print " impossible for a random person with access to the webserver\n";
2363 print " to list files in this directory. Confidential data might\n";
2364 print " be laying around in there.\n";
2365 print " Depending on your user:group assignments, 730 (rwx-wx---)\n";
2366 print " may be possible, and more secure (e.g. root:apache)\n";
2367 print " 2. Since the webserver is not able to list the files in the\n";
2368 print " content is also impossible for the webserver to delete files\n";
2369 print " lying around there for too long.\n";
2370 print " 3. It should probably be another directory than the data\n";
2371 print " directory specified in option 3.\n";
2374 print "[$WHT$attachment_dir$NRM]: $WHT";
2375 $new_attachment_dir = <STDIN
>;
2376 if ( $new_attachment_dir eq "\n" ) {
2377 $new_attachment_dir = $attachment_dir;
2379 $new_attachment_dir =~ s/[\r\n]//g;
2381 if ( $new_attachment_dir =~ /^\s*$/ ) {
2382 $new_attachment_dir = "";
2384 $new_attachment_dir =~ s/\/*$//g
;
2385 $new_attachment_dir =~ s/$/\//g
;
2387 return $new_attachment_dir;
2391 print "The directory hash level setting allows you to configure the level\n";
2392 print "of hashing that SquirrelMail employs in your data and attachment\n";
2393 print "directories. This value must be an integer ranging from 0 to 4.\n";
2394 print "When this value is set to 0, SquirrelMail will simply store all\n";
2395 print "files as normal in the data and attachment directories. However,\n";
2396 print "when set to a value from 1 to 4, a simple hashing scheme will be\n";
2397 print "used to organize the files in this directory. In short, the crc32\n";
2398 print "value for a username will be computed. Then, up to the first 4\n";
2399 print "digits of the hash, as set by this configuration value, will be\n";
2400 print "used to directory hash the files for that user in the data and\n";
2401 print "attachment directory. This allows for better performance on\n";
2402 print "servers with larger numbers of users.\n";
2405 print "[$WHT$dir_hash_level$NRM]: $WHT";
2406 $new_dir_hash_level = <STDIN
>;
2407 if ( $new_dir_hash_level eq "\n" ) {
2408 $new_dir_hash_level = $dir_hash_level;
2410 $new_dir_hash_level =~ s/[\r\n]//g;
2412 if ( ( int($new_dir_hash_level) < 0 )
2413 || ( int($new_dir_hash_level) > 4 )
2414 || !( int($new_dir_hash_level) eq $new_dir_hash_level ) ) {
2415 print "Invalid Directory Hash Level.\n";
2416 print "Value must be an integer ranging from 0 to 4\n";
2417 print "Hit enter to continue.\n";
2418 $enter_key = <STDIN
>;
2420 $new_dir_hash_level = $dir_hash_level;
2423 return $new_dir_hash_level;
2427 print "This is the default size (in pixels) of the left folder list.\n";
2428 print "Default is 200, but you can set it to whatever you wish. This\n";
2429 print "is a user preference, so this will only show up as their default.\n";
2431 print "[$WHT$default_left_size$NRM]: $WHT";
2432 $new_default_left_size = <STDIN
>;
2433 if ( $new_default_left_size eq "\n" ) {
2434 $new_default_left_size = $default_left_size;
2436 $new_default_left_size =~ s/[\r\n]//g;
2438 return $new_default_left_size;
2442 print "Some IMAP servers only have lowercase letters in the usernames\n";
2443 print "but they still allow people with uppercase to log in. This\n";
2444 print "causes a problem with the user's preference files. This option\n";
2445 print "transparently changes all usernames to lowercase.";
2448 if ( lc($force_username_lowercase) eq 'true' ) {
2449 $default_value = "y";
2451 $default_value = "n";
2453 print "Convert usernames to lowercase (y/n) [$WHT$default_value$NRM]: $WHT";
2454 $new_show = <STDIN
>;
2455 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2465 if ( lc($default_use_priority) eq 'true' ) {
2466 $default_value = "y";
2468 $default_value = "n";
2471 print "Allow users to specify priority of outgoing mail (y/n) [$WHT$default_value$NRM]: $WHT";
2472 $new_show = <STDIN
>;
2473 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2483 if ( lc($hide_sm_attributions) eq 'true' ) {
2484 $default_value = "y";
2486 $default_value = "n";
2489 print "Hide SM attributions (y/n) [$WHT$default_value$NRM]: $WHT";
2490 $new_show = <STDIN
>;
2491 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2501 if ( lc($default_use_mdn) eq 'true' ) {
2502 $default_value = "y";
2504 $default_value = "n";
2507 print "Enable support for read/delivery receipt support (y/n) [$WHT$default_value$NRM]: $WHT";
2508 $new_show = <STDIN
>;
2509 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2517 print " In loosely managed environments, you may want to allow users
2518 to edit their full name and email address. In strictly managed
2519 environments, you may want to force users to use the name
2520 and email address assigned to them.
2522 'y' - allow a user to edit their full name and email address,
2523 'n' - users must use the assigned values.
2527 if ( lc($edit_identity) eq 'true' ) {
2528 $default_value = "y";
2530 $default_value = "n";
2532 print "Allow editing of user's identity? (y/n) [$WHT$default_value$NRM]: $WHT";
2533 $new_edit = <STDIN
>;
2534 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2535 $edit_identity = 'true';
2536 $edit_name = 'true';
2537 $hide_auth_header = command311b
();
2539 $edit_identity = 'false';
2540 $edit_name = command311
();
2541 $hide_auth_header = command311b
();
2543 return $edit_identity;
2548 print "\n Given that users are not allowed to modify their
2549 email address, can they edit their full name?
2553 if ( lc($edit_name) eq 'true' ) {
2554 $default_value = "y";
2556 $default_value = "n";
2558 print "Allow the user to edit their full name? (y/n) [$WHT$default_value$NRM]: $WHT";
2559 $new_edit = <STDIN
>;
2560 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2561 $edit_name = 'true';
2563 $edit_name = 'false';
2570 print "\n SquirrelMail adds username information to every outgoing
2571 email in order to prevent possible sender forging when users are
2572 allowed to change their email and/or full name.
2574 You can remove user information from this header (y) if you think that
2575 it violates privacy or security.
2577 Note: If users are allowed to change their email addresses,
2578 this setting will make it difficult to determine who sent what where.
2579 Use at your own risk.
2583 if ( lc($hide_auth_header) eq "true" ) {
2584 $default_value = "y";
2586 $default_value = "n";
2588 print "Remove username from email headers? (y/n) [$WHT$default_value$NRM]: $WHT";
2589 $new_header = <STDIN
>;
2590 if ( ( $new_header =~ /^y\n/i ) || ( ( $new_header =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2591 $hide_auth_header = "true";
2593 $hide_auth_header = "false";
2595 return $hide_auth_header;
2599 print "This option allows you to disable server side thread sorting if your server \n";
2600 print "declares THREAD support, but you don't want to provide threading options \n";
2601 print "to end users or THREAD extension is broken or extension does not work with \n";
2602 print "options used by SquirrelMail. Option is not used, if THREAD extension is \n";
2603 print "not declared in IMAP CAPABILITY.\n";
2606 if ( lc($disable_thread_sort) eq 'true' ) {
2607 $default_value = "y";
2609 $default_value = "n";
2611 print "Disable server side thread sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2612 $disable_thread_sort = <STDIN
>;
2613 if ( ( $disable_thread_sort =~ /^y\n/i ) || ( ( $disable_thread_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2614 $disable_thread_sort = 'true';
2616 $disable_thread_sort = 'false';
2618 return $disable_thread_sort;
2622 print "This option allows you to disable server side sorting if your server declares \n";
2623 print "SORT support, but SORT extension is broken or does not work with options \n";
2624 print "used by SquirrelMail. Option is not used, if SORT extension is not declared \n";
2625 print "in IMAP CAPABILITY.\n";
2627 print "It is strongly recommended to keep server side sorting enabled, if your ";
2628 print "IMAP server supports it.";
2631 if ( lc($disable_server_sort) eq 'true' ) {
2632 $default_value = "y";
2634 $default_value = "n";
2636 print "Disable server-side sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2637 $disable_server_sort = <STDIN
>;
2638 if ( ( $disable_server_sort =~ /^y\n/i ) || ( ( $disable_server_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2639 $disable_server_sort = 'true';
2641 $disable_server_sort = 'false';
2643 return $disable_server_sort;
2647 print "This option allows you to choose if SM uses charset search\n";
2648 print "Your IMAP server must support the SEARCH CHARSET command for this to work\n";
2651 if ( lc($allow_charset_search) eq 'true' ) {
2652 $default_value = "y";
2654 $default_value = "n";
2656 print "Allow charset searching? (y/n) [$WHT$default_value$NRM]: $WHT";
2657 $allow_charset_search = <STDIN
>;
2658 if ( ( $allow_charset_search =~ /^y\n/i ) || ( ( $allow_charset_search =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2659 $allow_charset_search = 'true';
2661 $allow_charset_search = 'false';
2663 return $allow_charset_search;
2666 # command315 (UID support) obsoleted.
2668 # advanced search option
2670 print "This option allows you to control the use of advanced search form.\n";
2671 print " 0 = enable basic search only\n";
2672 print " 1 = enable advanced search only\n";
2673 print " 2 = enable both\n";
2676 print "Allowed search (0,1,2)? [$WHT$allow_advanced_search$NRM]: $WHT";
2677 $new_allow_advanced_search = <STDIN
>;
2678 if ( $new_allow_advanced_search =~ /^[012]\n/i ) {
2679 $allow_advanced_search = $new_allow_advanced_search;
2681 $allow_advanced_search =~ s/[\r\n]//g;
2682 return $allow_advanced_search;
2687 print "This option allows you to change the name of the PHP session used\n";
2688 print "by SquirrelMail. Unless you know what you are doing, you probably\n";
2689 print "don't need or want to change this from the default of SQMSESSID.\n";
2690 print "[$WHT$session_name$NRM]: $WHT";
2691 $new_session_name = <STDIN
>;
2692 chomp($new_session_name);
2693 if ( $new_session_name eq "" ) {
2694 $new_session_name = $session_name;
2696 return $new_session_name;
2699 # time zone config (since 1.5.1)
2701 print "This option allows you to control the use of time zones.\n";
2702 print " 0 = (default) standard, GNU C time zone names\n";
2703 print " 1 = strict, generic time zone codes with offsets\n";
2704 print " 2 = custom, GNU C time zones loaded from config/timezones.php\n";
2705 print " 3 = custom strict, generic time zone codes with offsets loaded \n";
2706 print " from config/timezones.php\n";
2707 print "See SquirrelMail documentation about format of config/timezones.php file.\n";
2710 print "Desired time zone configuration (0,1,2,3)? [$WHT$time_zone_type$NRM]: $WHT";
2711 $new_time_zone_type = <STDIN
>;
2712 if ( $new_time_zone_type =~ /^[0123]\n/i ) {
2713 $time_zone_type = $new_time_zone_type;
2715 print "\nInvalid configuration value.\n";
2716 print "\nPress enter to continue...";
2719 $time_zone_type =~ s/[\r\n]//g;
2720 return $time_zone_type;
2723 # set the location base for redirects (since 1.5.2)
2724 sub command_config_location_base
{
2725 print "Here you can set the base part of the SquirrelMail URL.\n";
2726 print "It is normally autodetected but if that fails, use this\n";
2727 print "option to override.\n";
2728 print "It should contain only the protocol and hostname/port parts\n";
2729 print "of the URL; the full path will be appended automatically.\n\n";
2730 print "Examples:\nhttp://webmail.example.org\nhttp://webmail.example.com:8080\nhttps://webmail.example.com:6691\n\n";
2731 print "Do not add any path elements.\n";
2733 print "URL base? [" .$WHT."autodetect$NRM]: $WHT";
2734 $new_config_location_base = <STDIN
>;
2735 chomp($new_config_location_base);
2736 $config_location_base = $new_config_location_base;
2738 return $config_location_base;
2741 # only_secure_cookies (since 1.5.2)
2743 print "This option allows you to specify that if a user session is initiated\n";
2744 print "under a secure (HTTPS, SSL-encrypted) connection, the cookies given to\n";
2745 print "the browser will ONLY be transmitted via a secure connection henceforth.\n\n";
2746 print "Generally this is a Good Thing, and should NOT be disabled. However,\n";
2747 print "if you intend to use the Secure Login or Show SSL Link plugins to\n";
2748 print "encrypt the user login, but not the rest of the SquirrelMail session,\n";
2749 print "this can be turned off. Think twice before doing so.\n";
2752 if ( lc($only_secure_cookies) eq 'true' ) {
2753 $default_value = "y";
2755 $default_value = "n";
2757 print "Transmit cookies only on secure connection when available? (y/n) [$WHT$default_value$NRM]: $WHT";
2758 $only_secure_cookies = <STDIN
>;
2759 if ( ( $only_secure_cookies =~ /^y\n/i ) || ( ( $only_secure_cookies =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2760 $only_secure_cookies = 'true';
2762 $only_secure_cookies = 'false';
2764 return $only_secure_cookies;
2768 sub command_userThemes
{
2769 print "\nDefine the user themes that you wish to use. If you have added\n";
2770 print "a theme of your own, just follow the instructions (?) about\n";
2771 print "how to add them. You can also change the default theme.\n\n";
2773 print "Available user themes:\n";
2775 while ( $count <= $#user_theme_name ) {
2776 if ( $count == $user_theme_default ) {
2781 if ( $count < 10 ) {
2784 $name = $user_theme_name[$count];
2785 $num_spaces = 35 - length($name);
2786 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2787 $name = $name . " ";
2790 print " $count. $name";
2791 print "($user_theme_path[$count])\n";
2797 print ".------------------------------------.\n";
2798 print "| t (detect user themes) |\n";
2799 print "| + (add user theme) |\n";
2800 print "| - N (remove user theme) |\n";
2801 print "| m N (mark default user theme) |\n";
2802 print "| l (list user themes) |\n";
2803 print "| d (done) |\n";
2804 print "`------------------------------------'\n";
2806 print "\n[user_themes] command (?=help) > ";
2808 $input =~ s/[\r\n]//g;
2809 while ( $input ne "d" ) {
2810 if ( $input =~ /^\s*l\s*/i ) {
2812 while ( $count <= $#user_theme_name ) {
2813 if ( $count == $user_theme_default ) {
2818 if ( $count < 10 ) {
2821 $name = $user_theme_name[$count];
2822 $num_spaces = 35 - length($name);
2823 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2824 $name = $name . " ";
2827 print " $count. $name";
2828 print "($user_theme_path[$count])\n";
2832 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2833 $old_def = $user_theme_default;
2834 $user_theme_default = $input;
2835 $user_theme_default =~ s/^\s*m\s*//;
2836 if ( ( $user_theme_default > $#user_theme_name ) || ( $user_theme_default < 0 ) ) {
2837 print "Cannot set default theme to $user_theme_default. That theme does not exist.\n";
2838 $user_theme_default = $old_def;
2840 } elsif ( $input =~ /^\s*\+/ ) {
2841 print "What is the name of this theme? ";
2843 $name =~ s/[\r\n]//g;
2844 $user_theme_name[ $#user_theme_name + 1 ] = $name;
2845 print "Be sure to put ../css/ before the filename.\n";
2846 print "What file is this stored in (ex: ../css/my_theme/): ";
2848 $name =~ s/[\r\n]//g;
2849 $user_theme_path[ $#user_theme_path + 1 ] = $name;
2850 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2851 if ( $input =~ /[0-9]+\s*$/ ) {
2853 $rem_num =~ s/^\s*-\s*//g;
2854 $rem_num =~ s/\s*$//;
2856 $rem_num = $#user_theme_name;
2858 if ( $rem_num == $user_theme_default ) {
2859 print "You cannot remove the default theme!\n";
2862 @new_theme_name = ();
2863 @new_theme_path = ();
2864 while ( $count <= $#user_theme_name ) {
2865 if ( $count != $rem_num ) {
2866 @new_theme_name = ( @new_theme_name, $user_theme_name[$count] );
2867 @new_theme_path = ( @new_theme_path, $user_theme_path[$count] );
2871 @user_theme_name = @new_theme_name;
2872 @user_theme_path = @new_theme_path;
2873 if ( $user_theme_default > $rem_num ) {
2874 $user_theme_default--;
2877 } elsif ( $input =~ /^\s*t\s*/i ) {
2878 print "\nStarting detection...\n\n";
2880 opendir( DIR
, "../css" );
2881 @files = sort(readdir(DIR
));
2883 while ( $cnt <= $#files ) {
2884 $filename = "../css/" . $files[$cnt] .'/';
2885 if ( $files[$cnt] !~ /^\./ && $filename ne "../css/rtl.css" && -e
$filename . "default.css" ) {
2887 for ( $x = 0 ; $x <= $#user_theme_path ; $x++ ) {
2888 if ( $user_theme_path[$x] eq $filename ) {
2892 if ( $found != 1 ) {
2893 print "** Found user theme: $filename\n";
2894 $def = $files[$cnt];
2897 #$def =~ s/(^\w+)/ucfirst $1/eg;
2898 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
2899 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
2900 print " What is its name? [$def]: ";
2902 $nm =~ s/^\s+|\s+$|[\n\r]//g;
2903 if ( $nm eq '' ) { $nm = $def; }
2904 $user_theme_name[ $#user_theme_name + 1 ] = $nm;
2905 $user_theme_path[ $#user_theme_path + 1 ] = $filename;
2911 for ( $cnt = 0 ; $cnt <= $#user_theme_path ; $cnt++ ) {
2912 $filename = $user_theme_path[$cnt];
2913 if ( $filename != 'none' && !( -e
$filename ."/default.css" ) ) {
2914 print " Removing $filename (file not found)\n";
2916 @new_user_theme_name = ();
2917 @new_user_theme_path = ();
2918 for ( $x = 0 ; $x < $#user_theme_path ; $x++ ) {
2919 if ( $user_theme_path[$x] eq $filename ) {
2922 if ( $offset == 1 ) {
2923 $new_user_theme_name[$x] = $user_theme_name[ $x + 1 ];
2924 $new_user_theme_path[$x] = $user_theme_path[ $x + 1 ];
2926 $new_user_theme_name[$x] = $user_theme_name[$x];
2927 $new_user_theme_path[$x] = $user_theme_path[$x];
2930 @user_theme_name = @new_user_theme_name;
2931 @user_theme_path = @new_user_theme_path;
2934 print "\nDetection complete!\n\n";
2937 } elsif ( $input =~ /^\s*\?\s*/ ) {
2938 print ".------------------------------------.\n";
2939 print "| t (detect user themes) |\n";
2940 print "| + (add user theme) |\n";
2941 print "| - N (remove user theme) |\n";
2942 print "| m N (mark default user theme) |\n";
2943 print "| l (list user themes) |\n";
2944 print "| d (done) |\n";
2945 print "`------------------------------------'\n";
2947 print "[user_themes] command (?=help) > ";
2949 $input =~ s/[\r\n]//g;
2953 sub command_iconSets
{
2954 print "\nDefine the icon themes that you wish to use. If you have added\n";
2955 print "a theme of your own, just follow the instructions (?) about\n";
2956 print "how to add them. You can also change the default and fallback\n";
2957 print "themes. The default theme will be used when no icon theme is\n";
2958 print "set by the user. The fallback theme will be used if an icon\n";
2959 print "cannot be found in the currently selected icon theme.\n\n";
2961 print "Available icon themes:\n\n";
2964 while ( $count <= $#icon_theme_name ) {
2965 if ( $count == $icon_theme_def ) {
2970 if ( $count eq $icon_theme_fallback ) {
2975 if ( $count < 10 ) {
2978 $name = $icon_theme_name[$count];
2979 $num_spaces = 35 - length($name);
2980 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2981 $name = $name . " ";
2984 print " $count. $name";
2985 print "($icon_theme_path[$count])\n";
2990 print "\n d = Default icon theme\n";
2991 print " f = Fallback icon theme\n";
2993 print ".------------------------------------.\n";
2994 print "| t (detect icon themes) |\n";
2995 print "| + (add icon theme) |\n";
2996 print "| - N (remove icon theme) |\n";
2997 print "| m N (mark default icon theme) |\n";
2998 print "| f N (set fallback icon set) |\n";
2999 print "| l (list icon themes) |\n";
3000 print "| d (done) |\n";
3001 print "`------------------------------------'\n";
3003 print "\n[icon_themes] command (?=help) > ";
3005 $input =~ s/[\r\n]//g;
3006 while ( $input ne "d" ) {
3007 if ( $input =~ /^\s*l\s*/i ) {
3010 while ( $count <= $#icon_theme_name ) {
3011 if ( $count == $icon_theme_def ) {
3016 if ( $count eq $icon_theme_fallback ) {
3021 $name = $icon_theme_name[$count];
3022 $num_spaces = 35 - length($name);
3023 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3024 $name = $name . " ";
3027 print " $count. $name";
3028 print "($icon_theme_path[$count])\n";
3032 print "\n d = Default icon theme\n";
3033 print " f = Fallback icon theme\n\n";
3034 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
3035 $old_def = $icon_theme_def;
3036 $icon_theme_def = $input;
3037 $icon_theme_def =~ s/^\s*m\s*//;
3038 if ( ( $icon_theme_default > $#icon_theme_name ) || ( $icon_theme_default < 0 ) ) {
3039 print "Cannot set default icon theme to $icon_theme_default. That theme does not exist.\n";
3040 $icon_theme_def = $old_def;
3042 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
3043 $old_fb = $icon_theme_fallback;
3044 $icon_theme_fallback = $input;
3045 $icon_theme_fallback =~ s/^\s*f\s*//;
3046 if ( ( $icon_theme_fallback > $#icon_theme_name ) || ( $icon_theme_fallback < 0 ) ) {
3047 print "Cannot set fallback icon theme to $icon_theme_fallback. That theme does not exist.\n";
3048 $icon_theme_fallback = $old_fb;
3050 } elsif ( $input =~ /^\s*\+/ ) {
3051 print "What is the name of this icon theme? ";
3053 $name =~ s/[\r\n]//g;
3054 $icon_theme_name[ $#icon_theme_name + 1 ] = $name;
3055 print "Be sure to put ../images/themes/ before the filename.\n";
3056 print "What directory is this icon theme stored in (ex: ../images/themes/my_theme/)? ";
3058 $name =~ s/[\r\n]//g;
3059 $icon_theme_path[ $#icon_theme_path + 1 ] = $name;
3060 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3061 if ( $input =~ /[0-9]+\s*$/ ) {
3063 $rem_num =~ s/^\s*-\s*//g;
3064 $rem_num =~ s/\s*$//;
3066 $rem_num = $#icon_theme_name;
3068 if ( $rem_num == $icon_theme_def ) {
3069 print "You cannot remove the default icon theme!\n";
3070 } elsif ( $rem_num == $icon_theme_fallback ) {
3071 print "You cannot remove the fallback icon theme!\n";
3074 @new_theme_name = ();
3075 @new_theme_path = ();
3076 while ( $count <= $#icon_theme_name ) {
3077 if ( $count != $rem_num ) {
3078 @new_theme_name = ( @new_theme_name, $icon_theme_name[$count] );
3079 @new_theme_path = ( @new_theme_path, $icon_theme_path[$count] );
3083 @icon_theme_name = @new_theme_name;
3084 @icon_theme_path = @new_theme_path;
3085 if ( $icon_theme_def > $rem_num ) {
3089 } elsif ( $input =~ /^\s*t\s*/i ) {
3090 print "\nStarting detection...\n\n";
3092 opendir( DIR
, "../images/themes/" );
3093 @files = sort(readdir(DIR
));
3095 while ( $cnt <= $#files ) {
3096 $filename = "../images/themes/" . $files[$cnt] .'/';
3097 if ( -d
"../images/themes/" . $files[$cnt] && $files[$cnt] !~ /^\
./ && $files[$cnt] ne ".svn" ) {
3099 for ( $x = 0 ; $x <= $#icon_theme_path ; $x++ ) {
3100 if ( $icon_theme_path[$x] eq $filename ) {
3104 if ( $found != 1 ) {
3105 print "** Found icon theme: $filename\n";
3106 $def = $files[$cnt];
3109 #$def =~ s/(^\w+)/ucfirst $1/eg;
3110 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3111 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3112 print " What is its name? [$def]: ";
3114 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3115 if ( $nm eq '' ) { $nm = $def; }
3116 $icon_theme_name[ $#icon_theme_name + 1 ] = $nm;
3117 $icon_theme_path[ $#icon_theme_path + 1 ] = $filename;
3123 for ( $cnt = 0 ; $cnt <= $#icon_theme_path ; $cnt++ ) {
3124 $filename = $icon_theme_path[$cnt];
3125 if ( $filename ne "none" && $filename ne "template" && ! -d
$filename ) {
3126 print " Removing $filename (file not found)\n";
3128 @new_icon_theme_name = ();
3129 @new_icon_theme_path = ();
3130 for ( $x = 0 ; $x < $#icon_theme_path ; $x++ ) {
3131 if ( $icon_theme_path[$x] eq $filename ) {
3134 if ( $offset == 1 ) {
3135 $new_icon_theme_name[$x] = $icon_theme_name[ $x + 1 ];
3136 $new_icon_theme_path[$x] = $icon_theme_path[ $x + 1 ];
3138 $new_icon_theme_name[$x] = $icon_theme_name[$x];
3139 $new_icon_theme_path[$x] = $icon_theme_path[$x];
3142 @icon_theme_name = @new_icon_theme_name;
3143 @icon_theme_path = @new_icon_theme_path;
3146 print "\nDetection complete!\n\n";
3149 } elsif ( $input =~ /^\s*\?\s*/ ) {
3150 print ".------------------------------------.\n";
3151 print "| t (detect icon themes) |\n";
3152 print "| + (add icon theme) |\n";
3153 print "| - N (remove icon theme) |\n";
3154 print "| m N (mark default icon theme) |\n";
3155 print "| f N (set fallback icon set) |\n";
3156 print "| l (list icon themes) |\n";
3157 print "| d (done) |\n";
3158 print "`------------------------------------'\n";
3160 print "[icon_themes] command (?=help) > ";
3162 $input =~ s/[\r\n]//g;
3166 sub command_templates
{
3167 print "\nDefine the template sets (skins) that you wish to use. If you have added\n";
3168 print "a template set of your own, just follow the instructions (?) about\n";
3169 print "how to add them. You can also change the default template.\n";
3171 print "\n Available Templates:\n";
3174 while ( $count <= $#templateset_name ) {
3175 if ( $templateset_id[$count] eq $templateset_default ) {
3180 if ( $templateset_id[$count] eq $templateset_fallback ) {
3185 if ( $templateset_id[$count] eq $rpc_templateset ) {
3190 if ( $count < 10 ) {
3193 if ( $count < 100 ) {
3196 $name = $templateset_name[$count];
3198 # present RPC template sets differently
3200 if ( $templateset_id[$count] =~ /_rpc$/ ) {
3201 $name = $name . " (not shown in user interface; used for RPC interface only)";
3204 $num_spaces = 35 - length($name);
3205 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3206 $name = $name . " ";
3208 $name = $name . "($templateset_id[$count])";
3212 print " $count. $name\n";
3216 print "\n d = default template set\n"
3217 . " f = fallback template set\n"
3218 . " r = RPC template set\n\n";
3220 $menu_text = ".-------------------------------------.\n"
3221 . "| t (detect template set) |\n"
3222 . "| + (add template set) |\n"
3223 . "| - N (remove template set) |\n"
3224 . "| m N (mark default template set) |\n"
3225 . "| f N (set fallback template set) |\n"
3226 . "| r N (set RPC template set) |\n"
3227 . "| l (list template sets/skins) |\n"
3229 . "|-------------------------------------|\n"
3230 . "| where N is a template set number |\n"
3231 . "`-------------------------------------'\n";
3234 print "\n[template set] command (?=help) > ";
3237 $input =~ s/[\r\n]//g;
3238 while ( $input ne "d" ) {
3240 # list template sets
3242 if ( $input =~ /^\s*l\s*/i ) {
3244 while ( $count <= $#templateset_name ) {
3245 if ( $templateset_id[$count] eq $templateset_default ) {
3250 if ( $templateset_id[$count] eq $templateset_fallback ) {
3255 if ( $templateset_id[$count] eq $rpc_templateset ) {
3260 if ( $count < 10 ) {
3263 if ( $count < 100 ) {
3266 $name = $templateset_name[$count];
3268 # present RPC template sets differently
3270 if ( $templateset_id[$count] =~ /_rpc$/ ) {
3271 $name = $name . " (not shown in user interface; used for RPC interface only)";
3274 $num_spaces = 35 - length($name);
3275 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3276 $name = $name . " ";
3278 $name = $name . "($templateset_id[$count])";
3282 print " $count. $name\n";
3286 print "\n d = default template set\n"
3287 . " f = fallback template set\n"
3288 . " r = RPC template set\n\n";
3290 # mark default template set
3292 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
3293 $old_def = $templateset_default;
3294 $input =~ s/^\s*m\s*//;
3295 $templateset_default = $templateset_id[$input];
3296 if ( $templateset_default =~ /^\s*$/ ) {
3297 print "Cannot set default template set to $input. That template set does not exist.\n";
3298 $templateset_default = $old_def;
3300 if ( $templateset_default =~ /_rpc$/ ) {
3301 print "Cannot set default template set to $input. That template set is intended for the RPC interface only.\n";
3302 $templateset_default = $old_def;
3305 # set fallback template set
3307 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
3308 $old_def = $templateset_fallback;
3309 $input =~ s/^\s*f\s*//;
3310 $templateset_fallback = $templateset_id[$input];
3311 if ( $templateset_fallback =~ /^\s*$/ ) {
3312 print "Cannot set fallback template set to $input. That template set does not exist.\n";
3313 $templateset_fallback = $old_def;
3315 if ( $templateset_fallback =~ /_rpc$/ ) {
3316 print "Cannot set fallback template set to $input. That template set is intended for the RPC interface only.\n";
3317 $templateset_fallback = $old_def;
3320 # set RPC template set
3322 } elsif ( $input =~ /^\s*r\s*[0-9]+/i ) {
3323 $old_def = $rpc_templateset;
3324 $input =~ s/^\s*r\s*//;
3325 $rpc_templateset = $templateset_id[$input];
3326 if ( $rpc_templateset =~ /^\s*$/ ) {
3327 print "Cannot set RPC template set to $input. That template set does not exist.\n";
3328 $rpc_templateset = $old_def;
3330 if ( $rpc_templateset !~ /_rpc$/ ) {
3331 print "Cannot set fallback template set to $input. That template set is not intended for the RPC interface.\n";
3332 $rpc_templateset = $old_def;
3337 } elsif ( $input =~ /^\s*\+/ ) {
3338 print "\nWhat is the name of this template (as shown to your users): ";
3340 $name =~ s/[\r\n]//g;
3341 $templateset_name[ $#templateset_name + 1 ] = $name;
3342 print "\n\nThe directory name should not contain any path information\n"
3343 . "or slashes, and should be the name of the directory that the\n"
3344 . "template set is found in within the SquirrelMail templates\n"
3346 print "What directory is this stored in (ex: default_advanced): ";
3348 $name =~ s/[\r\n]//g;
3349 $templateset_id[ $#templateset_id + 1 ] = $name;
3351 # detect template sets
3353 } elsif ( $input =~ /^\s*t\s*/i ) {
3354 print "\nStarting detection...\n\n";
3355 opendir( DIR
, "../templates" );
3356 @files = sort(readdir(DIR
));
3358 while ( $cnt <= $#files ) {
3359 if ( -d
"../templates/" . $files[$cnt] && $files[$cnt] !~ /^\./ && $files[$cnt] ne ".svn" ) {
3360 $filename = $files[$cnt];
3362 for ( $x = 0 ; $x <= $#templateset_id ; $x++ ) {
3363 if ( $templateset_id[$x] eq $filename ) {
3369 print "** Found template set: $filename\n";
3370 $def = $files[$cnt];
3372 # no user-friendly names needed for RPC template sets
3374 if ( $def =~ /_rpc$/ ) {
3379 #$def =~ s/(^\w+)/ucfirst $1/eg;
3380 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3381 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3382 print " What is it's name (as shown to your users)? [$def]: ";
3384 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3385 if ( $nm eq '' ) { $nm = $def; }
3387 $templateset_id[ $#templateset_id + 1 ] = $filename;
3388 $templateset_name[ $#templateset_name + 1 ] = $nm;
3394 for ( $cnt= 0 ; $cnt <= $#templateset_id ; ) {
3395 $filename = $templateset_id[$cnt];
3396 if ( !(-d change_to_rel_path
('SM_PATH . \'templates/' . $filename)) ) {
3397 print " Removing \"$filename\" (template set directory not found)\n";
3398 if ( $templateset_default eq $filename ) { $templateset_default = 'default'; }
3399 if ( $templateset_fallback eq $filename ) { $templateset_fallback = 'default'; }
3400 if ( $rpc_templateset eq $filename ) { $rpc_templateset = 'default_rpc'; }
3402 @new_templateset_name = ();
3403 @new_templateset_id = ();
3404 for ( $x = 0 ; $x < $#templateset_id ; $x++ ) {
3405 if ( $templateset_id[$x] eq $filename ) {
3408 if ( $offset == 1 ) {
3409 $new_templateset_name[$x] = $templateset_name[ $x + 1 ];
3410 $new_templateset_id[$x] = $templateset_id[ $x + 1 ];
3412 $new_templateset_name[$x] = $templateset_name[$x];
3413 $new_templateset_id[$x] = $templateset_id[$x];
3416 @templateset_name = @new_templateset_name;
3417 @templateset_id = @new_templateset_id;
3420 print "\nDetection complete!\n\n";
3424 # remove template set
3426 # undocumented functionality of removing last template set isn't that great
3427 #} elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3428 } elsif ( $input =~ /^\s*-\s*[0-9]+/ ) {
3429 if ( $input =~ /[0-9]+\s*$/ ) {
3431 $rem_num =~ s/^\s*-\s*//g;
3432 $rem_num =~ s/\s*$//;
3434 $rem_num = $#templateset_name;
3436 if ( $templateset_id[$rem_num] eq $templateset_default ) {
3437 print "You cannot remove the default template set!\n";
3438 } elsif ( $templateset_id[$rem_num] eq $templateset_fallback ) {
3439 print "You cannot remove the fallback template set!\n";
3440 } elsif ( $templateset_id[$rem_num] eq $rpc_templateset ) {
3441 print "You cannot remove the RPC template set!\n";
3444 @new_templateset_name = ();
3445 @new_templateset_id = ();
3446 while ( $count <= $#templateset_name ) {
3447 if ( $count != $rem_num ) {
3448 @new_templateset_name = ( @new_templateset_name, $templateset_name[$count] );
3449 @new_templateset_id = ( @new_templateset_id, $templateset_id[$count] );
3453 @templateset_name = @new_templateset_name;
3454 @templateset_id = @new_templateset_id;
3459 } elsif ( $input =~ /^\s*\?\s*/ ) {
3462 # command not understood
3465 print "Command not understood\n";
3468 print "[template set] command (?=help) > ";
3470 $input =~ s/[\r\n]//g;
3472 return $templateset_default;
3476 # sets default font size option
3477 sub command_default_fontsize
{
3478 print "Enter default font size [$WHT$$default_fontsize$NRM]: $WHT";
3479 $new_size = <STDIN
>;
3480 if ( $new_size eq "\n" ) {
3483 $new_size =~ s/[\r\n]//g;
3488 # controls available fontsets
3489 sub command_fontsets
{
3491 print "You can control fontsets available to end users here.\n";
3492 # set initial $input value
3494 while ( $input ne "x" ) {
3495 if ( $input =~ /^\s*a\s*/i ) {
3497 print "\nFontset name: ";
3499 if (! $fontsets{trim
($name)}) {
3500 print "Fontset string: ";
3502 $fontsets{trim
($name)} = trim
($value);
3504 print "\nERROR: Such fontset already exists.\n";
3506 } elsif ( $input =~ /^\s*e\s*/i ) {
3507 # edit existing fontset
3508 print "\nFontset name: ";
3510 if (! $fontsets{trim
($name)}) {
3511 print "\nERROR: No such fontset.\n";
3513 print "Fontset string [$fontsets{trim($name)}]: ";
3515 $fontsets{trim
($name)} = trim
($value);
3517 } elsif ( $input =~ /^\s*d\s*/ ) {
3518 # delete existing fontset
3519 print "\nFontset name: ";
3521 if (! $fontsets{trim
($name)}) {
3522 print "\nERROR: No such fontset.\n";
3524 delete $fontsets{trim
($name)};
3526 } elsif ( $input =~ /^\s*l\s*/ ) {
3528 print "\nConfigured fontsets:\n";
3529 while (($fontset_name, $fontset_string) = each(%fontsets)) {
3530 print " $fontset_name = $fontset_string\n";
3532 print "Default fontset: $default_fontset\n";
3533 } elsif ( $input =~ /^\s*m\s*/ ) {
3534 # set default fontset
3535 print "\nSet default fontset [$default_fontset]: ";
3537 if (trim
($name) ne '' and ! $fontsets{trim
($name)}) {
3538 print "\nERROR: No such fontset.\n";
3540 $default_fontset = trim
($name);
3543 # print available commands on any other input
3544 print "\nAvailable commands:\n";
3545 print " a - Adds new fontset.\n";
3546 print " d - Deletes existing fontset.\n";
3547 print " e - Edits existing fontset.\n";
3548 print " h or ? - Shows this help screen.\n";
3549 print " l - Lists available fontsets.\n";
3550 print " m - Sets default fontset.\n";
3551 print " x - Exits fontset editor mode.\n";
3553 print "\nCommand [fontsets] (a,d,e,h,?=help,l,m,x)> ";
3555 $input =~ s/[\r\n]//g;
3560 print "You can now define different LDAP servers.\n";
3561 print "Please ensure proper permissions for config.php when including\n";
3562 print "sensitive passwords.\n\n";
3563 print "[ldap] command (?=help) > ";
3565 $input =~ s/[\r\n]//g;
3566 while ( $input ne "d" ) {
3567 if ( $input =~ /^\s*l\s*/i ) {
3569 while ( $count <= $#ldap_host ) {
3570 print "$count. $ldap_host[$count]\n";
3571 print " base: $ldap_base[$count]\n";
3572 if ( $ldap_charset[$count] ) {
3573 print " charset: $ldap_charset[$count]\n";
3575 if ( $ldap_port[$count] ) {
3576 print " port: $ldap_port[$count]\n";
3578 if ( $ldap_name[$count] ) {
3579 print " name: $ldap_name[$count]\n";
3581 if ( $ldap_maxrows[$count] ) {
3582 print " maxrows: $ldap_maxrows[$count]\n";
3584 if ( $ldap_filter[$count] ) {
3585 print " filter: $ldap_filter[$count]\n";
3587 if ( $ldap_binddn[$count] ) {
3588 print " binddn: $ldap_binddn[$count]\n";
3589 if ( $ldap_bindpw[$count] ) {
3590 print " bindpw: $ldap_bindpw[$count]\n";
3593 if ( $ldap_protocol[$count] ) {
3594 print " protocol: $ldap_protocol[$count]\n";
3596 if ( $ldap_limit_scope[$count] ) {
3597 print " limit_scope: $ldap_limit_scope[$count]\n";
3599 if ( $ldap_listing[$count] ) {
3600 print " listing: $ldap_listing[$count]\n";
3602 if ( $ldap_writeable[$count] ) {
3603 print " writeable: $ldap_writeable[$count]\n";
3605 if ( $ldap_search_tree[$count] ) {
3606 print " search_tree: $ldap_search_tree[$count]\n";
3608 if ( $ldap_starttls[$count] ) {
3609 print " starttls: $ldap_starttls[$count]\n";
3615 } elsif ( $input =~ /^\s*\+/ ) {
3616 $sub = $#ldap_host + 1;
3618 print "First, we need to have the hostname or the IP address where\n";
3619 print "this LDAP server resides. Example: ldap.bigfoot.com\n";
3621 print "You can use any URI compatible with your LDAP library. Please\n";
3622 print "note that StartTLS option is not compatible with ldaps and\n";
3623 print "ldapi URIs.\n";
3626 $name =~ s/[\r\n]//g;
3627 $ldap_host[$sub] = $name;
3631 print "Next, we need the server root (base dn). For this, an empty\n";
3632 print "string is allowed.\n";
3633 print "Example: ou=member_directory,o=netcenter.com\n";
3636 $name =~ s/[\r\n]//g;
3637 $ldap_base[$sub] = $name;
3641 print "This is the TCP/IP port number for the LDAP server. Default\n";
3642 print "port is 389. This is optional. Press ENTER for default.\n";
3645 $name =~ s/[\r\n]//g;
3646 $ldap_port[$sub] = $name;
3650 print "This is the charset for the server. Default is utf-8. This\n";
3651 print "is also optional. Press ENTER for default.\n";
3654 $name =~ s/[\r\n]//g;
3655 $ldap_charset[$sub] = $name;
3659 print "This is the name for the server, used to tag the results of\n";
3660 print "the search. Default it \"LDAP: hostname\". Press ENTER for default\n";
3663 $name =~ s/[\r\n]//g;
3664 $ldap_name[$sub] = $name;
3668 print "You can specify the maximum number of rows in the search result.\n";
3669 print "Default value is equal to 250 rows. Press ENTER for default.\n";
3672 $name =~ s/[\r\n]//g;
3673 $ldap_maxrows[$sub] = $name;
3678 print "If your LDAP server does not like anonymous logins, you can specify bind DN.\n";
3679 print "Default is none, anonymous bind. Press ENTER for default.\n";
3682 $name =~ s/[\r\n]//g;
3683 $ldap_binddn[$sub] = $name;
3687 if ( $ldap_binddn[$sub] ne '' ) {
3689 print "Now, please specify password for that DN.\n";
3692 $name =~ s/[\r\n]//g;
3693 $ldap_bindpw[$sub] = $name;
3698 print "You can specify bind protocol version here.\n";
3699 print "Default protocol version depends on your php ldap settings.\n";
3700 print "Press ENTER for default.\n";
3703 $name =~ s/[\r\n]//g;
3704 $ldap_protocol[$sub] = $name;
3708 print "This configuration section allows to set some rarely used\n";
3709 print "options and options specific to some LDAP implementations.\n";
3711 print "Do you want to set advanced LDAP directory settings? (y/N):";
3712 $ldap_advanced_settings = <STDIN
>;
3713 if ( $ldap_advanced_settings =~ /^y\n/i ) {
3714 $ldap_advanced_settings = 'true';
3716 $ldap_advanced_settings = 'false';
3719 if ($ldap_advanced_settings eq 'true') {
3722 print "You can control LDAP directory listing here. This option can\n";
3723 print "be useful if you run small LDAP server and want to provide listing\n";
3724 print "of all addresses stored in LDAP to users of webmail interface.\n";
3725 print "Number of displayed entries is limited by maxrows setting.\n";
3727 print "Don't enable this option for public LDAP directories.\n";
3729 print "Allow listing of LDAP directory? (y/N):";
3731 if ( $name =~ /^y\n/i ) {
3736 $ldap_listing[$sub] = $name;
3740 print "You can control write access to LDAP address book here. This option can\n";
3741 print "be useful if you run small LDAP server and want to provide writable\n";
3742 print "shared address book stored in LDAP to users of webmail interface.\n";
3744 print "Don't enable this option for public LDAP directories.\n";
3746 print "Allow writing to LDAP directory? (y/N):";
3748 if ( $name =~ /^y\n/i ) {
3753 $ldap_writeable[$sub] = $name;
3757 print "You can specify an additional search filter.\n";
3758 print "This could be something like \"(objectclass=posixAccount)\".\n";
3759 print "No filtering is performed by default. Press ENTER for default.\n";
3762 $name =~ s/[\r|\n]//g;
3763 $ldap_filter[$sub] = $name;
3767 print "You can control search scope here.\n";
3768 print "This option is specific to Microsoft ADS implementation.\n";
3769 print "It requires use of v3 or newer LDAP protocol.\n";
3770 print "Don't enable it, if you use other LDAP server.\n";
3772 print "Limit ldap scope? (y/N):";
3774 if ( $name =~ /^y\n/i ) {
3779 $ldap_limit_scope[$sub] = $name;
3783 print "You can control ldap search type here.\n";
3784 print "Addresses can be searched in entire LDAP subtree (default)\n";
3785 print "or only first level entries are returned.\n";
3787 print "Search entire LDAP subtree? (Y/n):";
3789 if ( $name =~ /^n\n/i ) {
3794 $ldap_search_tree[$sub] = $name;
3798 print "You can control use of StartTLS on LDAP connection here.\n";
3799 print "This option requires use of v3 or newer LDAP protocol and php 4.2+.\n";
3801 print "Use StartTLS? (y/N):";
3803 if ( $name =~ /^y\n/i ) {
3808 $ldap_starttls[$sub] = $name;
3812 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3813 if ( $input =~ /[0-9]+\s*$/ ) {
3815 $rem_num =~ s/^\s*-\s*//g;
3816 $rem_num =~ s/\s*$//;
3818 $rem_num = $#ldap_host;
3821 @new_ldap_host = ();
3822 @new_ldap_base = ();
3823 @new_ldap_port = ();
3824 @new_ldap_name = ();
3825 @new_ldap_charset = ();
3826 @new_ldap_maxrows = ();
3827 @new_ldap_filter = ();
3828 @new_ldap_bindpw = ();
3829 @new_ldap_binddn = ();
3830 @new_ldap_protocol = ();
3831 @new_ldap_limit_scope = ();
3832 @new_ldap_listing = ();
3833 @new_ldap_writeable = ();
3834 @new_ldap_search_tree = ();
3835 @new_ldap_starttls = ();
3837 while ( $count <= $#ldap_host ) {
3838 if ( $count != $rem_num ) {
3839 @new_ldap_host = ( @new_ldap_host, $ldap_host[$count] );
3840 @new_ldap_base = ( @new_ldap_base, $ldap_base[$count] );
3841 @new_ldap_port = ( @new_ldap_port, $ldap_port[$count] );
3842 @new_ldap_name = ( @new_ldap_name, $ldap_name[$count] );
3843 @new_ldap_charset = ( @new_ldap_charset, $ldap_charset[$count] );
3844 @new_ldap_maxrows = ( @new_ldap_maxrows, $ldap_maxrows[$count] );
3845 @new_ldap_filter = ( @new_ldap_filter, $ldap_filter[$count] );
3846 @new_ldap_binddn = ( @new_ldap_binddn, $ldap_binddn[$count] );
3847 @new_ldap_bindpw = ( @new_ldap_bindpw, $ldap_bindpw[$count] );
3848 @new_ldap_protocol = ( @new_ldap_protocol, $ldap_protocol[$count] );
3849 @new_ldap_limit_scope = ( @new_ldap_limit_scope, $ldap_limit_scope[$count] );
3850 @new_ldap_listing = ( @new_ldap_listing, $ldap_listing[$count] );
3851 @new_ldap_writeable = ( @new_ldap_writeable, $ldap_writeable[$count] );
3852 @new_ldap_search_tree = ( @new_ldap_search_tree, $ldap_search_tree[$count] );
3853 @new_ldap_starttls = ( @new_ldap_starttls, $ldap_starttls[$count] );
3857 @ldap_host = @new_ldap_host;
3858 @ldap_base = @new_ldap_base;
3859 @ldap_port = @new_ldap_port;
3860 @ldap_name = @new_ldap_name;
3861 @ldap_charset = @new_ldap_charset;
3862 @ldap_maxrows = @new_ldap_maxrows;
3863 @ldap_filter = @new_ldap_filter;
3864 @ldap_binddn = @new_ldap_binddn;
3865 @ldap_bindpw = @new_ldap_bindpw;
3866 @ldap_protocol = @new_ldap_protocol;
3867 @ldap_limit_scope = @new_ldap_limit_scope;
3868 @ldap_listing = @new_ldap_listing;
3869 @ldap_writeable = @new_ldap_writeable;
3870 @ldap_search_tree = @new_ldap_search_tree;
3871 @ldap_starttls = @new_ldap_starttls;
3873 } elsif ( $input =~ /^\s*\?\s*/ ) {
3874 print ".-------------------------.\n";
3875 print "| + (add host) |\n";
3876 print "| - N (remove host) |\n";
3877 print "| l (list hosts) |\n";
3878 print "| d (done) |\n";
3879 print "`-------------------------'\n";
3881 print "[ldap] command (?=help) > ";
3883 $input =~ s/[\r\n]//g;
3888 print "Some of our developers have come up with very good javascript interface\n";
3889 print "for searching through address books, however, our original goals said\n";
3890 print "that we would be 100% HTML. In order to make it possible to use their\n";
3891 print "interface, and yet stick with our goals, we have also written a plain\n";
3892 print "HTML version of the search. Here, you can choose which version to use.\n";
3894 print "This is just the default value. It is also a user option that each\n";
3895 print "user can configure individually\n";
3898 if ( lc($default_use_javascript_addr_book) eq 'true' ) {
3899 $default_value = "y";
3901 $default_use_javascript_addr_book = 'false';
3902 $default_value = "n";
3904 print "Use javascript version by default (y/n) [$WHT$default_value$NRM]: $WHT";
3905 $new_show = <STDIN
>;
3906 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3907 $default_use_javascript_addr_book = 'true';
3909 $default_use_javascript_addr_book = 'false';
3911 return $default_use_javascript_addr_book;
3914 # global filebased address book
3916 print "If you want to use global file address book, then you\n";
3917 print "must set this option to a valid value. If option does\n";
3918 print "not have path elements, system assumes that file is\n";
3919 print "stored in data directory. If relative path is set, it is\n";
3920 print "relative to main SquirrelMail directory. If value is empty,\n";
3921 print "address book is not enabled.\n";
3924 print "[$WHT$abook_global_file$NRM]: $WHT";
3925 $new_abook_global_file = <STDIN
>;
3926 if ( $new_abook_global_file eq "\n" ) {
3927 $new_abook_global_file = $abook_global_file;
3929 $new_abook_global_file =~ s/[\r\n]//g;
3931 return $new_abook_global_file;
3934 # writing into global filebased abook control
3936 print "This setting controls writing into global file address\n";
3937 print "book options. Address book file must be writeable by\n";
3938 print "webserver's user, if you want to enable this option.\n";
3941 if ( lc($abook_global_file_writeable) eq 'true' ) {
3942 $default_value = "y";
3944 $abook_global_file_writeable = 'false';
3945 $default_value = "n";
3947 print "Allow writing into global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
3948 $new_show = <STDIN
>;
3949 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3950 $abook_global_file_writeable = 'true';
3952 $abook_global_file_writeable = 'false';
3954 return $abook_global_file_writeable;
3957 # listing of global filebased abook control
3959 print "This setting controls listing of global file address\n";
3960 print "book in addresses page.\n";
3963 if ( lc($abook_global_file_listing) eq 'true' ) {
3964 $default_value = "y";
3966 $abook_global_file_listing = 'false';
3967 $default_value = "n";
3969 print "Allow listing of global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
3970 $new_show = <STDIN
>;
3971 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3972 $abook_global_file_listing = 'true';
3974 $abook_global_file_listing = 'false';
3976 return $abook_global_file_listing;
3979 # controls $abook_file_line_length setting
3980 sub command_abook_file_line_length
{
3981 print "This setting controls space allocated to file based address book records.\n";
3982 print "End users will be unable to save address book entry, if total entry size \n";
3983 print "(quoted address book fields + 4 delimiters + linefeed) exceeds allowed \n";
3984 print "address book length size.\n";
3986 print "Same setting is applied to personal and global file based address books.\n";
3988 print "It is strongly recommended to keep default setting value. Change it only\n";
3989 print "if you really want to store address book entries that are bigger than two\n";
3990 print "kilobytes (2048).\n";
3993 print "Enter allowed address book line length [$abook_file_line_length]: ";
3996 # value is not modified, if user hits Enter or enters space
3998 # make sure that input is numeric
3999 if ($tmp =~ /^\d+$/) {
4000 $abook_file_line_length = $tmp;
4002 print "If you want to change this setting, you must enter number.\n";
4003 print "If you want to keep original setting - enter space.\n\n";
4004 print "Press Enter to continue...";
4011 print "If you want to store your users address book details in a database then\n";
4012 print "you need to set this DSN to a valid value. The format for this is:\n";
4013 print "mysql://user:pass\@hostname/dbname\n";
4014 print "Where mysql can be one of the databases PHP supports, the most common\n";
4015 print "of these are mysql, msql and pgsql.\n";
4016 print "Please ensure proper permissions for config.php when including\n";
4017 print "sensitive passwords.\n\n";
4018 print "If the DSN is left empty (hit space and then return) the database\n";
4019 print "related code for address books will not be used.\n";
4022 if ( $addrbook_dsn eq "" ) {
4023 $default_value = "Disabled";
4025 $default_value = $addrbook_dsn;
4027 print "[$WHT$addrbook_dsn$NRM]: $WHT";
4029 if ( $new_dsn eq "\n" ) {
4032 $new_dsn =~ s/[\r\n]//g;
4033 $new_dsn =~ s/^\s+$//g;
4039 print "This is the name of the table you want to store the address book\n";
4040 print "data in, it defaults to 'address'\n";
4042 print "[$WHT$addrbook_table$NRM]: $WHT";
4043 $new_table = <STDIN
>;
4044 if ( $new_table eq "\n" ) {
4045 $new_table = $addrbook_table;
4047 $new_table =~ s/[\r\n]//g;
4053 print "If you want to store your users preferences in a database then\n";
4054 print "you need to set this DSN to a valid value. The format for this is:\n";
4055 print "mysql://user:pass\@hostname/dbname\n";
4056 print "Where mysql can be one of the databases PHP supports, the most common\n";
4057 print "of these are mysql, msql and pgsql.\n";
4058 print "Please ensure proper permissions for config.php when including\n";
4059 print "sensitive passwords.\n\n";
4060 print "If the DSN is left empty (hit space and then return) the database\n";
4061 print "related code for address books will not be used.\n";
4064 if ( $prefs_dsn eq "" ) {
4065 $default_value = "Disabled";
4067 $default_value = $prefs_dsn;
4069 print "[$WHT$prefs_dsn$NRM]: $WHT";
4071 if ( $new_dsn eq "\n" ) {
4074 $new_dsn =~ s/[\r\n]//g;
4075 $new_dsn =~ s/^\s+$//g;
4081 print "This is the name of the table you want to store the preferences\n";
4082 print "data in, it defaults to 'userprefs'\n";
4084 print "[$WHT$prefs_table$NRM]: $WHT";
4085 $new_table = <STDIN
>;
4086 if ( $new_table eq "\n" ) {
4087 $new_table = $prefs_table;
4089 $new_table =~ s/[\r\n]//g;
4095 print "This is the name of the field in which you want to store the\n";
4096 print "username of the person the prefs are for. It default to 'user'\n";
4097 print "which clashes with a reserved keyword in PostgreSQL so this\n";
4098 print "will need to be changed for that database at least\n";
4100 print "[$WHT$prefs_user_field$NRM]: $WHT";
4101 $new_field = <STDIN
>;
4102 if ( $new_field eq "\n" ) {
4103 $new_field = $prefs_user_field;
4105 $new_field =~ s/[\r\n]//g;
4107 $prefs_user_size = db_pref_size
($prefs_user_size);
4112 print "This is the name of the field in which you want to store the\n";
4113 print "preferences keyword. It defaults to 'prefkey'\n";
4115 print "[$WHT$prefs_key_field$NRM]: $WHT";
4116 $new_field = <STDIN
>;
4117 if ( $new_field eq "\n" ) {
4118 $new_field = $prefs_key_field;
4120 $new_field =~ s/[\r\n]//g;
4122 $prefs_key_size = db_pref_size
($prefs_key_size);
4127 print "This is the name of the field in which you want to store the\n";
4128 print "preferences value. It defaults to 'prefval'\n";
4130 print "[$WHT$prefs_val_field$NRM]: $WHT";
4131 $new_field = <STDIN
>;
4132 if ( $new_field eq "\n" ) {
4133 $new_field = $prefs_val_field;
4135 $new_field =~ s/[\r\n]//g;
4137 $prefs_val_size = db_pref_size
($prefs_val_size);
4141 # routine is used to set database field limits
4142 # it needs one argument
4143 sub db_pref_size
() {
4145 print "\nDatabase fields have size limits.\n";
4147 print "What limit is set for this field? [$WHT$size$NRM]: $WHT";
4148 $new_size = <STDIN
>;
4149 if ( $new_size eq "\n" ) {
4152 $new_size =~ s/[\r\n]//g;
4158 print "If you want to store your global address book in a database then\n";
4159 print "you need to set this DSN to a valid value. The format for this is:\n";
4160 print "mysql://user:pass\@hostname/dbname\n";
4161 print "Where mysql can be one of the databases PHP supports, the most common\n";
4162 print "of these are mysql, msql and pgsql.\n";
4163 print "Please ensure proper permissions for config.php when including\n";
4164 print "sensitive passwords.\n\n";
4165 print "If the DSN is left empty (hit space and then return) the database\n";
4166 print "related code for global SQL address book will not be used.\n";
4169 if ( $addrbook_global_dsn eq "" ) {
4170 $default_value = "Disabled";
4172 $default_value = $addrbook_global_dsn;
4174 print "[$WHT$addrbook_global_dsn$NRM]: $WHT";
4176 if ( $new_dsn eq "\n" ) {
4179 $new_dsn =~ s/[\r\n]//g;
4180 $new_dsn =~ s/^\s+$//g;
4186 print "This is the name of the table you want to store the global address book\n";
4187 print "data in. Default table name is 'global_abook'. Address book uses same\n";
4188 print "database format as personal address book.\n";
4190 print "[$WHT$addrbook_global_table$NRM]: $WHT";
4191 $new_table = <STDIN
>;
4192 if ( $new_table eq "\n" ) {
4193 $new_table = $addrbook_global_table;
4195 $new_table =~ s/[\r\n]//g;
4201 print "This option controls users\' ability to add or modify records stored \n";
4202 print "in global address book\n";
4204 if ( lc($addrbook_global_writeable) eq 'true' ) {
4205 $default_value = "y";
4207 $default_value = "n";
4209 print "Allow writing into global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
4210 $addrbook_global_writeable = <STDIN
>;
4211 if ( ( $addrbook_global_writeable =~ /^y\n/i ) || ( ( $addrbook_global_writeable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4212 $addrbook_global_writeable = 'true';
4214 $addrbook_global_writeable = 'false';
4216 return $addrbook_global_writeable;
4220 print "Enable this option if you want to see listing of addresses stored \n";
4221 print "in global address book\n";
4223 if ( lc($addrbook_global_listing) eq 'true' ) {
4224 $default_value = "y";
4226 $default_value = "n";
4228 print "Allow listing of global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
4229 $addrbook_global_listing = <STDIN
>;
4230 if ( ( $addrbook_global_listing =~ /^y\n/i ) || ( ( $addrbook_global_listing =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4231 $addrbook_global_listing = 'true';
4233 $addrbook_global_listing = 'false';
4235 return $addrbook_global_listing;
4241 print "SquirrelMail attempts to set the language in many ways. If it\n";
4242 print "can not figure it out in another way, it will default to this\n";
4243 print "language. Please use the code for the desired language.\n";
4245 print "[$WHT$squirrelmail_default_language$NRM]: $WHT";
4246 $new_squirrelmail_default_language = <STDIN
>;
4247 if ( $new_squirrelmail_default_language eq "\n" ) {
4248 $new_squirrelmail_default_language = $squirrelmail_default_language;
4250 $new_squirrelmail_default_language =~ s/[\r\n]//g;
4251 $new_squirrelmail_default_language =~ s/^\s+$//g;
4253 return $new_squirrelmail_default_language;
4257 print "This option controls what character set is used when sending\n";
4258 print "mail and when sending HTML to the browser. Option works only\n";
4259 print "with US English (en_US) translation. Other translations use\n";
4260 print "charsets that are set in translation settings.\n";
4263 print "[$WHT$default_charset$NRM]: $WHT";
4264 $new_default_charset = <STDIN
>;
4265 if ( $new_default_charset eq "\n" ) {
4266 $new_default_charset = $default_charset;
4268 $new_default_charset =~ s/[\r\n]//g;
4270 return $new_default_charset;
4272 # Alternative language names
4274 print "Enable this option if you want to see localized language names in\n";
4275 print "language selection box. Note, that this option can trigger\n";
4276 print "installation of foreign language support modules in some browsers.\n";
4279 if ( lc($show_alternative_names) eq 'true' ) {
4280 $default_value = "y";
4282 $default_value = "n";
4284 print "Show alternative language names? (y/n) [$WHT$default_value$NRM]: $WHT";
4285 $show_alternative_names = <STDIN
>;
4286 if ( ( $show_alternative_names =~ /^y\n/i ) || ( ( $show_alternative_names =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4287 $show_alternative_names = 'true';
4289 $show_alternative_names = 'false';
4291 return $show_alternative_names;
4294 # Aggressive decoding
4296 print "Enable this option if you want to use CPU and memory intensive decoding\n";
4297 print "functions. This option allows reading multibyte charset, that are used\n";
4298 print "in Eastern Asia. SquirrelMail will try to use recode functions here,\n";
4299 print "even when you have disabled use of recode in Tweaks section.\n";
4302 if ( lc($aggressive_decoding) eq 'true' ) {
4303 $default_value = "y";
4305 $default_value = "n";
4307 print "Enable aggressive decoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4308 $aggressive_decoding = <STDIN
>;
4309 if ( ( $aggressive_decoding =~ /^y\n/i ) || ( ( $aggressive_decoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4310 $aggressive_decoding = 'true';
4312 $aggressive_decoding = 'false';
4314 return $aggressive_decoding;
4319 print "Enable this option if you want to allow lossy charset encoding in message\n";
4320 print "composition pages. This option allows charset conversions when output\n";
4321 print "charset does not support all symbols used in original charset. Symbols\n";
4322 print "unsupported by output charset will be replaced with question marks.\n";
4325 if ( lc($lossy_encoding) eq 'true' ) {
4326 $default_value = "y";
4328 $default_value = "n";
4330 print "Enable lossy encoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4331 $lossy_encoding = <STDIN
>;
4332 if ( ( $lossy_encoding =~ /^y\n/i ) || ( ( $lossy_encoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4333 $lossy_encoding = 'true';
4335 $lossy_encoding = 'false';
4337 return $lossy_encoding;
4340 # display html emails in iframe
4342 print "This option can enable html email rendering inside iframe.\n";
4343 print "Inline frames are used in order to provide sandbox environment";
4344 print "for html code included in html formated emails.";
4345 print "Option is experimental and might have glitches in some parts of code.";
4348 if ( lc($use_iframe) eq 'true' ) {
4349 $default_value = "y";
4351 $default_value = "n";
4353 print "Display html emails in iframe? (y/n) [$WHT$default_value$NRM]: $WHT";
4354 $use_iframe = <STDIN
>;
4355 if ( ( $use_iframe =~ /^y\n/i ) || ( ( $use_iframe =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4356 $use_iframe = 'true';
4358 $use_iframe = 'false';
4364 sub command_ask_user_info
{
4365 print "New users need to supply their real name and email address to\n";
4366 print "send out proper mails. When this option is enabled, a user that\n";
4367 print "logs in for the first time will be redirected to the Personal\n";
4368 print "Options screen and asked to supply their personal data.\n";
4371 if ( lc($ask_user_info) eq 'true' ) {
4372 $default_value = "y";
4374 $default_value = "n";
4376 print "Ask user info? (y/n) [$WHT$default_value$NRM]: $WHT";
4377 $ask_user_info = <STDIN
>;
4378 if ( ( $ask_user_info =~ /^y\n/i ) || ( ( $ask_user_info =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4379 $ask_user_info = 'true';
4381 $ask_user_info = 'false';
4383 return $ask_user_info;
4388 print "Enabling this option will cause icons to be used instead of text\n";
4389 print "markers next to each message in mailbox lists that represent\n";
4390 print "new, read, flagged, and deleted messages, as well as those that\n";
4391 print "have been replied to and forwarded. Icons are also used next to\n";
4392 print "(un)expanded folders in the folder list (Oldway = false). These\n";
4393 print "icons are quite small, but will obviously be more of a resource\n";
4394 print "drain than text markers.\n";
4397 if ( lc($use_icons) eq 'true' ) {
4398 $default_value = "y";
4400 $default_value = "n";
4402 print "Use icons? (y/n) [$WHT$default_value$NRM]: $WHT";
4403 $use_icons = <STDIN
>;
4404 if ( ( $use_icons =~ /^y\n/i ) || ( ( $use_icons =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4405 $use_icons = 'true';
4407 $use_icons = 'false';
4413 print "Enable this option if you want to use php recode functions to read\n";
4414 print "emails written in charset that differs from the one that is set in\n";
4415 print "translation selected by user. Code is experimental, it might cause\n";
4416 print "errors, if email contains charset unsupported by recode or if your\n";
4417 print "php does not have recode support.\n";
4420 if ( lc($use_php_recode) eq 'true' ) {
4421 $default_value = "y";
4423 $default_value = "n";
4425 print "Use php recode functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4426 $use_php_recode = <STDIN
>;
4427 if ( ( $use_php_recode =~ /^y\n/i ) || ( ( $use_php_recode =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4428 $use_php_recode = 'true';
4430 $use_php_recode = 'false';
4432 return $use_php_recode;
4436 print "Enable this option if you want to use php iconv functions to read\n";
4437 print "emails written in charset that differs from the one that is set in\n";
4438 print "translation selected by user. Code is experimental, it works only\n";
4439 print "with translations that use utf-8 charset. Code might cause errors,\n";
4440 print "if email contains charset unsupported by iconv or if your php does\n";
4441 print "not have iconv support.\n";
4444 if ( lc($use_php_iconv) eq 'true' ) {
4445 $default_value = "y";
4447 $default_value = "n";
4449 print "Use php iconv functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4450 $use_php_iconv = <STDIN
>;
4451 if ( ( $use_php_iconv =~ /^y\n/i ) || ( ( $use_php_iconv =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4452 $use_php_iconv = 'true';
4454 $use_php_iconv = 'false';
4456 return $use_php_iconv;
4461 print "In some cases, buffering all output (holding it on the server until\n";
4462 print "the full page is ready to send to the browser) allows more complex\n";
4463 print "functionality, especially for plugins that want to add headers on hooks\n";
4464 print "that are beyond the point of output having been sent to the browser\n";
4465 print "otherwise. Most plugins that need this functionality will enable it\n";
4466 print "automatically on their own, but you can turn it on manually here. You'd\n";
4467 print "usually want to do this if you want to specify a custom output handler\n";
4468 print "for parsing the output - you can do that by specifying a value for\n";
4469 print "\$buffered_output_handler in config_local.php. Don't forget to define\n";
4470 print "a function of the same name as what \$buffered_output_handler is set to.\n";
4473 if ( lc($buffer_output) eq 'true' ) {
4474 $default_value = "y";
4476 $default_value = "n";
4478 print "Buffer all output? (y/n) [$WHT$default_value$NRM]: $WHT";
4479 $buffer_output = <STDIN
>;
4480 if ( ( $buffer_output =~ /^y\n/i ) || ( ( $buffer_output =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4481 $buffer_output = 'true';
4483 $buffer_output = 'false';
4485 return $buffer_output;
4490 print "Enable this option if you want to check SquirrelMail configuration\n";
4491 print "remotely with configtest.php script.\n";
4494 if ( lc($allow_remote_configtest) eq 'true' ) {
4495 $default_value = "y";
4497 $default_value = "n";
4499 print "Allow remote configuration tests? (y/n) [$WHT$default_value$NRM]: $WHT";
4500 $allow_remote_configtest = <STDIN
>;
4501 if ( ( $allow_remote_configtest =~ /^y\n/i ) || ( ( $allow_remote_configtest =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4502 $allow_remote_configtest = 'true';
4504 $allow_remote_configtest = 'false';
4506 return $allow_remote_configtest;
4509 # Default Icon theme
4511 print "You may change the path to the default icon theme to be used, if icons\n";
4512 print "have been enabled. This theme will be used when an icon cannot be\n";
4513 print "found in the current theme, or when no icon theme is specified. If\n";
4514 print "left blank, and icons are enabled, the default theme will be used\n";
4515 print "from images/themes/default/.\n";
4517 print "To clear out an existing value, just type a space for the input.\n";
4519 print "Please be aware of the following: \n";
4520 print " - Relative URLs are relative to the config dir\n";
4521 print " to use the icon themes directory, use ../images/themes/newtheme/\n";
4522 print " - The icon theme may be outside the SquirrelMail directory, but\n";
4523 print " it must be web accessible.\n";
4524 print "[$WHT$icon_theme_def$NRM]: $WHT";
4525 $new_icon_theme_def = <STDIN
>;
4527 if ( $new_icon_theme_def eq "\n" ) {
4528 $new_icon_theme_def = $icon_theme_def;
4530 $new_icon_theme_def =~ s/[\r\n]//g;
4532 $new_icon_theme_def =~ s/^\s*//;
4533 return $new_icon_theme_def;
4536 # SquirrelMail debug mode (since 1.5.2)
4538 print "When debugging or developing SquirrelMail, you may want to increase\n";
4539 print "the verbosity of certain kinds of errors, notices, and/or diagnostics.\n";
4540 print "You may enable one or more of the debugging modes here. Please make\n";
4541 print "sure that you have turned off debugging if you are using SquirrelMail\n";
4542 print "in a production environment.\n\n";
4545 while ( $input ne "d\n" ) {
4546 $sm_debug_mode = convert_debug_constants_to_binary_integer
($sm_debug_mode);
4548 # per include/constants.php, here are the debug mode values:
4550 # 0 SM_DEBUG_MODE_OFF
4551 # 1 SM_DEBUG_MODE_SIMPLE
4552 # 512 SM_DEBUG_MODE_MODERATE
4553 # 524288 SM_DEBUG_MODE_ADVANCED
4554 # 536870912 SM_DEBUG_MODE_STRICT
4556 print "\n# Enabled? Description\n";
4557 print "---------------------------------------------------------------------\n";
4558 print "0 " . ($sm_debug_mode == 0 ?
"y" : " ")
4559 . " No debugging (recommended in production environments)\n";
4560 print "1 " . ($sm_debug_mode & 1 ?
"y" : " ")
4561 . " Simple debugging (PHP E_ERROR)\n";
4562 print "2 " . ($sm_debug_mode & 512 ?
"y" : " ")
4563 . " Moderate debugging (PHP E_ALL)\n";
4564 print "3 " . ($sm_debug_mode & 524288 ?
"y" : " ")
4565 . " Advanced debugging (PHP E_ALL plus log errors\n";
4566 print " intentionally suppressed)\n";
4567 print "4 " . ($sm_debug_mode & 536870912 ?
"y" : " ")
4568 . " Strict debugging (PHP E_STRICT)\n";
4571 print "SquirrelMail debug mode (0,1,2,3,4) or d when done? : $WHT";
4573 if ( $input eq "d\n" ) {
4575 } elsif ($input !~ /^[0-9]+\n$/) {
4576 print "\nInvalid configuration value.\n";
4577 print "\nPress enter to continue...";
4579 } elsif ( $input == "0\n" ) {
4581 } elsif ( $input == "1\n" ) {
4582 if ($sm_debug_mode & 1) {
4583 $sm_debug_mode ^= 1;
4585 $sm_debug_mode |= 1;
4587 } elsif ( $input == "2\n" ) {
4588 if ($sm_debug_mode & 512) {
4589 $sm_debug_mode ^= 512;
4591 $sm_debug_mode |= 512;
4593 } elsif ( $input == "3\n" ) {
4594 if ($sm_debug_mode & 524288) {
4595 $sm_debug_mode ^= 524288;
4597 $sm_debug_mode |= 524288;
4599 } elsif ( $input == "4\n" ) {
4600 if ($sm_debug_mode & 536870912) {
4601 $sm_debug_mode ^= 536870912;
4603 $sm_debug_mode |= 536870912;
4606 print "\nInvalid configuration value.\n";
4607 print "\nPress enter to continue...";
4612 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
4613 return $sm_debug_mode;
4616 # Secured configuration mode (since 1.5.2)
4618 print "This option allows you to enable \"Secured Configuration\" mode,\n";
4619 print "which will guarantee that certain settings made herein will be\n";
4620 print "made immutable and will not be subject to override by either friendly\n";
4621 print "or unfriendly code/plugins. Only a small number of settings herein\n";
4622 print "will be used in this manner - just those that are deemed to be a\n";
4623 print "potential security threat when rouge plugin or other code may be\n";
4624 print "executed inside SquirrelMail.\n";
4627 if ( lc($secured_config) eq 'true' ) {
4628 $default_value = "y";
4630 $default_value = "n";
4632 print "Enable secured configuration mode? (y/n) [$WHT$default_value$NRM]: $WHT";
4633 $secured_config = <STDIN
>;
4634 if ( ( $secured_config =~ /^y\n/i ) || ( ( $secured_config =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4635 $secured_config = 'true';
4637 $secured_config = 'false';
4639 return $secured_config;
4642 # Set a (non-standard) HTTPS port
4644 print "If you run HTTPS (SSL-secured HTTP) on a non-standard port, you should\n";
4645 print "indicate that port here. Even if you do not, SquirrelMail may still\n";
4646 print "auto-detect secure connections, but it is safer and also very useful\n";
4647 print "for third party plugins if you specify the port number here.\n";
4649 print "Most SquirrelMail administrators will not need to use this setting\n";
4650 print "because most all web servers use port 443 for HTTPS connections, and\n";
4651 print "SquirrelMail assumes 443 unless something else is given here.\n";
4654 print "Enter your HTTPS port [$sq_https_port]: ";
4657 # value is not modified, if user hits Enter or enters space
4659 # make sure that input is numeric
4660 if ($tmp =~ /^\d+$/) {
4661 $sq_https_port = $tmp;
4664 print "--- INPUT ERROR ---\n";
4666 print "If you want to change this setting, you must enter a number.\n";
4667 print "If you want to keep the original value, just press Enter.\n\n";
4668 print "Press Enter to continue...";
4672 return $sq_https_port;
4675 # Ignore HTTP_X_FORWARDED_* headers?
4678 if ( lc($sq_ignore_http_x_forwarded_headers) eq 'true' ) {
4679 $default_value = "y";
4681 $default_value = "n";
4684 print "Because HTTP_X_FORWARDED_* headers can be sent by the client and\n";
4685 print "therefore possibly exploited by an outsider, SquirrelMail ignores\n";
4686 print "them by default. If a proxy server or other machine sits between\n";
4687 print "clients and your SquirrelMail server, you can turn this off to\n";
4688 print "tell SquirrelMail to use such headers.\n";
4691 print "Ignore HTTP_X_FORWARDED headers? (y/n) [$WHT$default_value$NRM]: $WHT";
4692 $sq_ignore_http_x_forwarded_headers = <STDIN
>;
4693 if ( ( $sq_ignore_http_x_forwarded_headers =~ /^y\n/i ) || ( ( $sq_ignore_http_x_forwarded_headers =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4694 $sq_ignore_http_x_forwarded_headers = 'true';
4696 $sq_ignore_http_x_forwarded_headers = 'false';
4698 return $sq_ignore_http_x_forwarded_headers;
4703 if ( open( CF
, ">config.php" ) ) {
4708 print CF
" * SquirrelMail Configuration File\n";
4709 print CF
" * Created using the configure script, conf.pl\n";
4713 if ($print_config_version) {
4714 print CF
"\$config_version = '$print_config_version';\n";
4717 print CF
"\$config_use_color = $config_use_color;\n";
4721 print CF
"\$org_name = \"$org_name\";\n";
4723 print CF
"\$org_logo = " . &change_to_SM_path
($org_logo) . ";\n";
4724 $org_logo_width |= 0;
4725 $org_logo_height |= 0;
4727 print CF
"\$org_logo_width = '$org_logo_width';\n";
4729 print CF
"\$org_logo_height = '$org_logo_height';\n";
4730 # string that can contain variables.
4731 print CF
"\$org_title = \"$org_title\";\n";
4733 print CF
"\$signout_page = " . &change_to_SM_path
($signout_page) . ";\n";
4735 print CF
"\$frame_top = '$frame_top';\n";
4738 print CF
"\$provider_uri = '$provider_uri';\n";
4741 print CF
"\$provider_name = '$provider_name';\n";
4744 # string that can contain variables
4745 print CF
"\$motd = \"$motd\";\n";
4749 print CF
"\$squirrelmail_default_language = '$squirrelmail_default_language';\n";
4751 print CF
"\$default_charset = '$default_charset';\n";
4753 print CF
"\$show_alternative_names = $show_alternative_names;\n";
4755 print CF
"\$aggressive_decoding = $aggressive_decoding;\n";
4757 print CF
"\$lossy_encoding = $lossy_encoding;\n";
4761 print CF
"\$domain = '$domain';\n";
4763 print CF
"\$imapServerAddress = '$imapServerAddress';\n";
4765 print CF
"\$imapPort = $imapPort;\n";
4767 print CF
"\$useSendmail = $useSendmail;\n";
4769 print CF
"\$smtpServerAddress = '$smtpServerAddress';\n";
4771 print CF
"\$smtpPort = $smtpPort;\n";
4773 print CF
"\$sendmail_path = '$sendmail_path';\n";
4775 print CF
"\$sendmail_args = '$sendmail_args';\n";
4777 # print CF "\$use_authenticated_smtp = $use_authenticated_smtp;\n";
4779 print CF
"\$pop_before_smtp = $pop_before_smtp;\n";
4781 print CF
"\$pop_before_smtp_host = '$pop_before_smtp_host';\n";
4783 print CF
"\$imap_server_type = '$imap_server_type';\n";
4785 print CF
"\$invert_time = $invert_time;\n";
4787 print CF
"\$optional_delimiter = '$optional_delimiter';\n";
4789 print CF
"\$encode_header_key = '$encode_header_key';\n";
4793 print CF
"\$default_folder_prefix = '$default_folder_prefix';\n";
4795 print CF
"\$trash_folder = '$trash_folder';\n";
4797 print CF
"\$sent_folder = '$sent_folder';\n";
4799 print CF
"\$draft_folder = '$draft_folder';\n";
4801 print CF
"\$default_move_to_trash = $default_move_to_trash;\n";
4803 print CF
"\$default_move_to_sent = $default_move_to_sent;\n";
4805 print CF
"\$default_save_as_draft = $default_save_as_draft;\n";
4807 print CF
"\$show_prefix_option = $show_prefix_option;\n";
4809 print CF
"\$list_special_folders_first = $list_special_folders_first;\n";
4811 print CF
"\$use_special_folder_color = $use_special_folder_color;\n";
4813 print CF
"\$auto_expunge = $auto_expunge;\n";
4815 print CF
"\$default_sub_of_inbox = $default_sub_of_inbox;\n";
4817 print CF
"\$show_contain_subfolders_option = $show_contain_subfolders_option;\n";
4819 print CF
"\$default_unseen_notify = $default_unseen_notify;\n";
4821 print CF
"\$default_unseen_type = $default_unseen_type;\n";
4823 print CF
"\$auto_create_special = $auto_create_special;\n";
4825 print CF
"\$delete_folder = $delete_folder;\n";
4827 print CF
"\$noselect_fix_enable = $noselect_fix_enable;\n";
4832 print CF
"\$data_dir = " . &change_to_SM_path
($data_dir) . ";\n";
4833 # string that can contain a variable
4834 print CF
"\$attachment_dir = " . &change_to_SM_path
($attachment_dir) . ";\n";
4836 print CF
"\$dir_hash_level = $dir_hash_level;\n";
4838 print CF
"\$default_left_size = '$default_left_size';\n";
4840 print CF
"\$force_username_lowercase = $force_username_lowercase;\n";
4842 print CF
"\$default_use_priority = $default_use_priority;\n";
4844 print CF
"\$hide_sm_attributions = $hide_sm_attributions;\n";
4846 print CF
"\$default_use_mdn = $default_use_mdn;\n";
4848 print CF
"\$edit_identity = $edit_identity;\n";
4850 print CF
"\$edit_name = $edit_name;\n";
4852 print CF
"\$hide_auth_header = $hide_auth_header;\n";
4854 print CF
"\$disable_thread_sort = $disable_thread_sort;\n";
4856 print CF
"\$disable_server_sort = $disable_server_sort;\n";
4858 print CF
"\$allow_charset_search = $allow_charset_search;\n";
4860 print CF
"\$allow_advanced_search = $allow_advanced_search;\n";
4863 print CF
"\$time_zone_type = $time_zone_type;\n";
4866 print CF
"\$config_location_base = '$config_location_base';\n";
4869 print CF
"\$disable_plugins = $disable_plugins;\n";
4871 print CF
"\$disable_plugins_user = '$disable_plugins_user';\n";
4874 # all plugins are strings
4875 for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
4876 print CF
"\$plugins[] = '$plugins[$ct]';\n";
4881 if ( $user_theme_default eq '' ) { $user_theme_default = '0'; }
4882 print CF
"\$user_theme_default = $user_theme_default;\n";
4884 for ( $count = 0 ; $count <= $#user_theme_name ; $count++ ) {
4885 if ($user_theme_path[$count] eq 'none') {
4888 $path = &change_to_SM_path
($user_theme_path[$count]);
4890 print CF
"\$user_themes[$count]['PATH'] = " . $path . ";\n";
4891 # escape theme name so it can contain single quotes.
4892 $esc_name = $user_theme_name[$count];
4893 $esc_name =~ s/\\/\\\\/g;
4894 $esc_name =~ s/'/\\'/g;
4895 print CF
"\$user_themes[$count]['NAME'] = '$esc_name';\n";
4899 if ( $icon_theme_def eq '' ) { $icon_theme_def = '0'; }
4900 print CF
"\$icon_theme_def = $icon_theme_def;\n";
4901 if ( $icon_theme_fallback eq '' ) { $icon_theme_fallback = '0'; }
4902 print CF
"\$icon_theme_fallback = $icon_theme_fallback;\n";
4904 for ( $count = 0 ; $count <= $#icon_theme_name ; $count++ ) {
4905 $path = $icon_theme_path[$count];
4906 if ($path eq 'none' || $path eq 'template') {
4907 $path = "'".$path."'";
4909 $path = &change_to_SM_path
($icon_theme_path[$count]);
4911 print CF
"\$icon_themes[$count]['PATH'] = " . $path . ";\n";
4912 # escape theme name so it can contain single quotes.
4913 $esc_name = $icon_theme_name[$count];
4914 $esc_name =~ s/\\/\\\\/g;
4915 $esc_name =~ s/'/\\'/g;
4916 print CF
"\$icon_themes[$count]['NAME'] = '$esc_name';\n";
4920 if ( $templateset_default eq '' ) { $templateset_default = 'default'; }
4921 print CF
"\$templateset_default = '$templateset_default';\n";
4923 if ( $templateset_fallback eq '' ) { $templateset_fallback = 'default'; }
4924 print CF
"\$templateset_fallback = '$templateset_fallback';\n";
4926 if ( $rpc_templateset eq '' ) { $rpc_templateset = 'default_rpc'; }
4927 print CF
"\$rpc_templateset = '$rpc_templateset';\n";
4929 for ( $count = 0 ; $count <= $#templateset_name ; $count++ ) {
4931 # don't include RPC template sets
4933 if ( $templateset_id[$count] =~ /_rpc$/ ) { next; }
4935 print CF
"\$aTemplateSet[$count]['ID'] = '" . $templateset_id[$count] . "';\n";
4936 # escape theme name so it can contain single quotes.
4937 $esc_name = $templateset_name[$count];
4938 $esc_name =~ s/\\/\\\\/g;
4939 $esc_name =~ s/'/\\'/g;
4940 print CF
"\$aTemplateSet[$count]['NAME'] = '$esc_name';\n";
4946 print CF
"\$default_fontsize = '$default_fontsize';\n";
4948 print CF
"\$default_fontset = '$default_fontset';\n";
4950 # assoc. array (maybe initial value should be set somewhere else)
4951 print CF
'$fontsets = array();'."\n";
4952 while (($fontset_name, $fontset_value) = each(%fontsets)) {
4953 print CF
"\$fontsets\['$fontset_name'\] = '$fontset_value';\n";
4959 print CF
"\$default_use_javascript_addr_book = $default_use_javascript_addr_book;\n";
4960 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
4961 print CF
"\$ldap_server[$count] = array(\n";
4963 print CF
" 'host' => '$ldap_host[$count]',\n";
4965 print CF
" 'base' => '$ldap_base[$count]'";
4966 if ( $ldap_name[$count] ) {
4969 print CF
" 'name' => '$ldap_name[$count]'";
4971 if ( $ldap_port[$count] ) {
4974 print CF
" 'port' => $ldap_port[$count]";
4976 if ( $ldap_charset[$count] ) {
4979 print CF
" 'charset' => '$ldap_charset[$count]'";
4981 if ( $ldap_maxrows[$count] ) {
4984 print CF
" 'maxrows' => $ldap_maxrows[$count]";
4987 if ( $ldap_filter[$count] ) {
4989 print CF
" 'filter' => '$ldap_filter[$count]'";
4991 if ( $ldap_binddn[$count] ) {
4994 print CF
" 'binddn' => '$ldap_binddn[$count]'";
4995 if ( $ldap_bindpw[$count] ) {
4998 print CF
" 'bindpw' => '$ldap_bindpw[$count]'";
5001 if ( $ldap_protocol[$count] ) {
5004 print CF
" 'protocol' => $ldap_protocol[$count]";
5006 if ( $ldap_limit_scope[$count] ) {
5009 print CF
" 'limit_scope' => $ldap_limit_scope[$count]";
5011 if ( $ldap_listing[$count] ) {
5014 print CF
" 'listing' => $ldap_listing[$count]";
5016 if ( $ldap_writeable[$count] ) {
5019 print CF
" 'writeable' => $ldap_writeable[$count]";
5021 if ( $ldap_search_tree[$count] ) {
5024 print CF
" 'search_tree' => $ldap_search_tree[$count]";
5026 if ( $ldap_listing[$count] ) {
5029 print CF
" 'starttls' => $ldap_starttls[$count]";
5037 print CF
"\$addrbook_dsn = '$addrbook_dsn';\n";
5039 print CF
"\$addrbook_table = '$addrbook_table';\n\n";
5041 print CF
"\$prefs_dsn = '$prefs_dsn';\n";
5043 print CF
"\$prefs_table = '$prefs_table';\n";
5045 print CF
"\$prefs_user_field = '$prefs_user_field';\n";
5047 print CF
"\$prefs_user_size = $prefs_user_size;\n";
5049 print CF
"\$prefs_key_field = '$prefs_key_field';\n";
5051 print CF
"\$prefs_key_size = $prefs_key_size;\n";
5053 print CF
"\$prefs_val_field = '$prefs_val_field';\n";
5055 print CF
"\$prefs_val_size = $prefs_val_size;\n\n";
5057 print CF
"\$addrbook_global_dsn = '$addrbook_global_dsn';\n";
5059 print CF
"\$addrbook_global_table = '$addrbook_global_table';\n";
5061 print CF
"\$addrbook_global_writeable = $addrbook_global_writeable;\n";
5063 print CF
"\$addrbook_global_listing = $addrbook_global_listing;\n\n";
5065 print CF
"\$abook_global_file = '$abook_global_file';\n";
5067 print CF
"\$abook_global_file_writeable = $abook_global_file_writeable;\n\n";
5069 print CF
"\$abook_global_file_listing = $abook_global_file_listing;\n\n";
5071 print CF
"\$abook_file_line_length = $abook_file_line_length;\n\n";
5073 print CF
"\$no_list_for_subscribe = $no_list_for_subscribe;\n";
5076 print CF
"\$smtp_auth_mech = '$smtp_auth_mech';\n";
5077 print CF
"\$smtp_sitewide_user = '". quote_single
($smtp_sitewide_user) ."';\n";
5078 print CF
"\$smtp_sitewide_pass = '". quote_single
($smtp_sitewide_pass) ."';\n";
5080 print CF
"\$imap_auth_mech = '$imap_auth_mech';\n";
5082 print CF
"\$use_imap_tls = $use_imap_tls;\n";
5084 print CF
"\$use_smtp_tls = $use_smtp_tls;\n";
5086 print CF
"\$session_name = '$session_name';\n";
5088 print CF
"\$only_secure_cookies = $only_secure_cookies;\n";
5093 print CF
"\$use_iframe = $use_iframe;\n";
5095 print CF
"\$ask_user_info = $ask_user_info;\n";
5097 print CF
"\$use_icons = $use_icons;\n";
5100 print CF
"\$use_php_recode = $use_php_recode;\n";
5102 print CF
"\$use_php_iconv = $use_php_iconv;\n";
5105 print CF
"\$buffer_output = $buffer_output;\n";
5108 print CF
"\$allow_remote_configtest = $allow_remote_configtest;\n";
5109 print CF
"\$secured_config = $secured_config;\n";
5111 print CF
"\$sq_https_port = $sq_https_port;\n";
5113 print CF
"\$sq_ignore_http_x_forwarded_headers = $sq_ignore_http_x_forwarded_headers;\n";
5114 # (binary) integer or constant - convert integer
5115 # values to constants before output
5116 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
5117 print CF
"\$sm_debug_mode = $sm_debug_mode;\n";
5122 print "Data saved in config.php\n";
5124 build_plugin_hook_array
();
5127 print "Error saving config.php: $!\n";
5133 print $WHT. "SquirrelMail Configuration : " . $NRM;
5134 if ( $config == 1 ) { print "Read: config.php"; }
5135 elsif ( $config == 2 ) { print "Read: config_default.php"; }
5137 print "---------------------------------------------------------\n";
5139 print "While we have been building SquirrelMail, we have discovered some\n";
5140 print "preferences that work better with some servers that don't work so\n";
5141 print "well with others. If you select your IMAP server, this option will\n";
5142 print "set some pre-defined settings for that server.\n";
5144 print "Please note that you will still need to go through and make sure\n";
5145 print "everything is correct. This does not change everything. There are\n";
5146 print "only a few settings that this will change.\n";
5150 while ( $continue != 1 ) {
5151 print "Please select your IMAP server:\n";
5152 print $list_supported_imap_servers;
5154 print " quit = Do not change anything\n";
5156 print "Command >> ";
5158 $server =~ s/[\r\n]//g;
5160 # variable is used to display additional messages.
5164 if ( $server eq "cyrus" ) {
5165 $imap_server_type = "cyrus";
5166 $default_folder_prefix = "";
5167 $trash_folder = "INBOX.Trash";
5168 $sent_folder = "INBOX.Sent";
5169 $draft_folder = "INBOX.Drafts";
5170 $show_prefix_option = false
;
5171 $default_sub_of_inbox = true
;
5172 $show_contain_subfolders_option = false
;
5173 $optional_delimiter = ".";
5174 $disp_default_folder_prefix = "<none>";
5175 $force_username_lowercase = false
;
5177 # Delimiter might differ if unixhierarchysep is set to yes.
5178 $message = "\nIf you have enabled unixhierarchysep, you must change delimiter and special folder names.\n";
5181 } elsif ( $server eq "uw" ) {
5182 $imap_server_type = "uw";
5183 $default_folder_prefix = "mail/";
5184 $trash_folder = "Trash";
5185 $sent_folder = "Sent";
5186 $draft_folder = "Drafts";
5187 $show_prefix_option = true
;
5188 $default_sub_of_inbox = false
;
5189 $show_contain_subfolders_option = true
;
5190 $optional_delimiter = "/";
5191 $disp_default_folder_prefix = $default_folder_prefix;
5192 $delete_folder = true
;
5193 $force_username_lowercase = true
;
5196 } elsif ( $server eq "exchange" ) {
5197 $imap_server_type = "exchange";
5198 $default_folder_prefix = "";
5199 $default_sub_of_inbox = true
;
5200 $trash_folder = "INBOX/Deleted Items";
5201 $sent_folder = "INBOX/Sent Items";
5202 $drafts_folder = "INBOX/Drafts";
5203 $show_prefix_option = false
;
5204 $show_contain_subfolders_option = false
;
5205 $optional_delimiter = "detect";
5206 $disp_default_folder_prefix = "<none>";
5207 $force_username_lowercase = true
;
5210 } elsif ( $server eq "courier" ) {
5211 $imap_server_type = "courier";
5212 $default_folder_prefix = "INBOX.";
5213 $trash_folder = "Trash";
5214 $sent_folder = "Sent";
5215 $draft_folder = "Drafts";
5216 $show_prefix_option = false
;
5217 $default_sub_of_inbox = false
;
5218 $show_contain_subfolders_option = false
;
5219 $optional_delimiter = ".";
5220 $disp_default_folder_prefix = $default_folder_prefix;
5221 $delete_folder = true
;
5222 $force_username_lowercase = false
;
5225 } elsif ( $server eq "macosx" ) {
5226 $imap_server_type = "macosx";
5227 $default_folder_prefix = "INBOX/";
5228 $trash_folder = "Trash";
5229 $sent_folder = "Sent";
5230 $draft_folder = "Drafts";
5231 $show_prefix_option = false
;
5232 $default_sub_of_inbox = true
;
5233 $show_contain_subfolders_option = false
;
5234 $optional_delimiter = "detect";
5235 $allow_charset_search = false
;
5236 $disp_default_folder_prefix = $default_folder_prefix;
5239 } elsif ( $server eq "hmailserver" ) {
5240 $imap_server_type = "hmailserver";
5241 $default_folder_prefix = "";
5242 $trash_folder = "INBOX.Trash";
5243 $sent_folder = "INBOX.Sent";
5244 $draft_folder = "INBOX.Drafts";
5245 $show_prefix_option = false
;
5246 $default_sub_of_inbox = true
;
5247 $show_contain_subfolders_option = false
;
5248 $optional_delimiter = "detect";
5249 $allow_charset_search = false
;
5250 $disp_default_folder_prefix = $default_folder_prefix;
5251 $delete_folder = false
;
5252 $force_username_lowercase = false
;
5255 } elsif ( $server eq "mercury32" ) {
5256 $imap_server_type = "mercury32";
5257 $default_folder_prefix = "";
5258 $trash_folder = "Trash";
5259 $sent_folder = "Sent";
5260 $draft_folder = "Drafts";
5261 $show_prefix_option = false
;
5262 $default_sub_of_inbox = true
;
5263 $show_contain_subfolders_option = true
;
5264 $optional_delimiter = "detect";
5265 $delete_folder = true
;
5266 $force_username_lowercase = true
;
5269 } elsif ( $server eq "dovecot" ) {
5270 $imap_server_type = "dovecot";
5271 $default_folder_prefix = "";
5272 $trash_folder = "Trash";
5273 $sent_folder = "Sent";
5274 $draft_folder = "Drafts";
5275 $show_prefix_option = false
;
5276 $default_sub_of_inbox = false
;
5277 $show_contain_subfolders_option = false
;
5278 $delete_folder = false
;
5279 $force_username_lowercase = true
;
5280 $optional_delimiter = "detect";
5281 $disp_default_folder_prefix = "<none>";
5284 } elsif ( $server eq "bincimap" ) {
5285 $imap_server_type = "bincimap";
5286 $default_folder_prefix = "INBOX/";
5287 $trash_folder = "Trash";
5288 $sent_folder = "Sent";
5289 $draft_folder = "Drafts";
5290 $show_prefix_option = false
;
5291 $default_sub_of_inbox = false
;
5292 $show_contain_subfolders_option = false
;
5293 $delete_folder = true
;
5294 $force_username_lowercase = false
;
5295 $optional_delimiter = "detect";
5296 $disp_default_folder_prefix = $default_folder_prefix;
5298 # Default folder prefix depends on used depot.
5299 $message = "\nIf you use IMAPdir depot, you must set default folder prefix to empty string.\n";
5302 } elsif ( $server eq "quit" ) {
5305 $disp_default_folder_prefix = $default_folder_prefix;
5306 print "Unrecognized server: $server\n";
5310 print " imap_server_type = $imap_server_type\n";
5311 print " default_folder_prefix = $disp_default_folder_prefix\n";
5312 print " trash_folder = $trash_folder\n";
5313 print " sent_folder = $sent_folder\n";
5314 print " draft_folder = $draft_folder\n";
5315 print " show_prefix_option = $show_prefix_option\n";
5316 print " default_sub_of_inbox = $default_sub_of_inbox\n";
5317 print "show_contain_subfolders_option = $show_contain_subfolders_option\n";
5318 print " optional_delimiter = $optional_delimiter\n";
5319 print " delete_folder = $delete_folder\n";
5320 print " force_username_lowercase = $force_username_lowercase\n";
5324 print "\nPress enter to continue...";
5328 # This subroutine corrects relative paths to ensure they
5329 # will work within the SM space. If the path falls within
5330 # the SM directory tree, the SM_PATH variable will be
5331 # prepended to the path, if not, then the path will be
5332 # converted to an absolute path, e.g.
5333 # '../images/logo.gif' --> SM_PATH . 'images/logo.gif'
5334 # '../../someplace/data' --> '/absolute/path/someplace/data'
5335 # 'images/logo.gif' --> SM_PATH . 'config/images/logo.gif'
5336 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
5337 # 'http://whatever/' --> 'http://whatever'
5338 # $some_var/path --> "$some_var/path"
5339 sub change_to_SM_path
() {
5340 my ($old_path) = @_;
5346 # If the path is absolute, don't bother.
5347 return "\'" . $old_path . "\'" if ( $old_path eq '');
5348 return "\'" . $old_path . "\'" if ( $old_path =~ /^(\/|http
)/ );
5349 return "\'" . $old_path . "\'" if ( $old_path =~ /^\w:\// );
5350 return $old_path if ( $old_path =~ /^\'(\/|http
)/ );
5351 return $old_path if ( $old_path =~ /^\'\w:\// );
5352 return $old_path if ( $old_path =~ /^SM_PATH/);
5354 if ( $old_path =~ /^\$/ ) {
5355 # check if it's a single var, or a $var/path combination
5356 # if it's $var/path, enclose in ""
5357 if ( $old_path =~ /\// ) {
5358 return '"'.$old_path.'"';
5363 # Remove remaining '
5364 $old_path =~ s/\'//g;
5366 # For relative paths, split on '../'
5367 @rel_path = split(/\.\.\//, $old_path);
5369 if ( $#rel_path > 1 ) {
5370 # more than two levels away. Make it absolute.
5371 @abs_path = split(/\//, $dir);
5373 # Lop off the relative pieces of the absolute path..
5374 for ( $i = 0; $i <= $#rel_path; $i++ ) {
5378 push @abs_path, @rel_path;
5379 $new_path = "\'" . join('/', @abs_path) . "\'";
5380 } elsif ( $#rel_path > 0 ) {
5381 # it's within the SM tree, prepend SM_PATH
5382 $new_path = $old_path;
5383 $new_path =~ s/^\.\.\//SM_PATH
. \'/;
5386 # Last, it's a relative path without any leading '.'
5387 # Prepend SM_PATH and config, since the paths are
5388 # relative to the config directory
5389 $new_path = "SM_PATH . \'config/" . $old_path . "\'";
5395 # Change SM_PATH to admin-friendly version, e.g.:
5396 # SM_PATH . 'images/logo.gif' --> '../images/logo.gif'
5397 # SM_PATH . 'config/some.php' --> 'some.php'
5398 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
5399 # 'http://whatever/' --> 'http://whatever'
5400 sub change_to_rel_path
() {
5401 my ($old_path) = @_;
5402 my $new_path = $old_path;
5404 if ( $old_path =~ /^SM_PATH/ ) {
5405 # FIXME: the following replacement loses the opening quote mark!
5406 $new_path =~ s/^SM_PATH . \'/\.\.\//;
5407 $new_path =~ s/\.\.\/config\///;
5413 # Attempts to auto-detect if a specific auth mechanism is supported.
5414 # Called by 'command112a' and 'command112b'
5415 # ARGS: service-name (IMAP or SMTP), host:port, mech-name (ie. CRAM-MD5)
5416 sub detect_auth_support
{
5417 # Try loading IO::Socket
5418 unless (eval("use IO::Socket; 1")) {
5419 print "Perl IO::Socket module is not available.";
5423 my $service = shift;
5427 if ((!defined($service)) or (!defined($host)) or (!defined($mech))) {
5428 # Error - wrong # of args
5429 print "BAD ARGS!\n";
5433 if ($service eq 'SMTP') {
5434 $cmd = "AUTH $mech\r\n";
5435 $logout = "QUIT\r\n";
5436 } elsif ($service eq 'IMAP') {
5437 $cmd = "A01 AUTHENTICATE $mech\n";
5438 $logout = "C01 LOGOUT\n";
5440 # unknown service - whoops.
5444 # Get this show on the road
5445 my $sock=IO
::Socket
::INET
->new($host);
5446 if (!defined($sock)) {
5450 my $discard = <$sock>; # Server greeting/banner - who cares..
5452 if ($service eq 'SMTP') {
5454 print $sock "HELO $domain\r\n";
5455 $discard = <$sock>; # Yeah yeah, you're happy to see me..
5459 my $response = <$sock>;
5461 if (!defined($response)) {
5465 # So at this point, we have a response, and it is (hopefully) valid.
5466 if ($service eq 'SMTP') {
5467 if (!($response =~ /^334/)) {
5469 print $sock $logout;
5473 } elsif ($service eq 'IMAP') {
5474 if ($response =~ /^A01/) {
5476 print $sock $logout;
5481 # Unknown service - this shouldn't be able to happen.
5486 # If it gets here, the mech is supported
5487 print $sock "*\n"; # Attempt to cancel authentication
5488 print $sock $logout; # Try to log out, but we don't really care if this fails
5494 # Example code from O'Reilly Perl Cookbook
5501 return wantarray ?
@out : $out[0];
5504 sub clear_screen
() {
5505 if ( $^O
=~ /^mswin/i) {
5512 # checks IMAP mailbox name. Refuses to accept 8bit folders
5513 # returns 0 (folder name is not correct) or 1 (folder name is correct)
5514 sub check_imap_folder
($) {
5515 my $folder_name = shift(@_);
5517 if ($folder_name =~ /[\x80-\xFFFF]/) {
5518 print "Folder name contains 8bit characters. Configuration utility requires\n";
5519 print "UTF7-IMAP encoded folder names.\n";
5520 print "Press enter to continue...";
5523 } elsif ($folder_name =~ /[&\*\%]/) {
5524 # check for ampersand and list-wildcards
5525 print "Folder name contains special UTF7-IMAP characters.\n";
5526 print "Are you sure that folder name is correct? (y/N): ";
5528 $tmp = lc(trim
($tmp));
5529 if ($tmp =~ /^y$/) {
5539 # quotes string written in single quotes
5540 sub quote_single
($) {
5541 my $string = shift(@_);
5542 $string =~ s/\'/\\'/g;
5546 # determine a plugin's version number
5548 # parses the setup.php file, looking for the
5549 # version string in the <plugin>_info() or the
5550 # <plugin>_version functions.
5552 sub get_plugin_version
() {
5554 my $plugin_name = shift(@_);
5556 $setup_file = '../plugins/' . $plugin_name . '/setup.php';
5557 if ( -e
"$setup_file" ) {
5558 # Make sure that file is readable
5559 if (! -r
"$setup_file") {
5562 print "The file \"$setup_file\" was found, but you don't\n";
5563 print "have rights to read it. The plugin \"";
5564 print $plugin_name . "\" may not work correctly until you fix this.\n";
5565 print "\nPress enter to continue";
5572 # FIXME: grep the file instead of reading it into memory?
5574 open( FILE
, "$setup_file" );
5575 while ( $line = <FILE
> ) {
5576 $whole_file .= $line;
5580 # ideally, there is a version in the <plugin>_info function...
5582 if ($whole_file =~ /('version'\s*=>\s*['"](.*?)['"])/) {
5585 # this assumes there is only one function that returns
5586 # a static string in the setup file
5588 } elsif ($whole_file =~ /(return\s*['"](.*?)['"])/) {
5597 print "The file \"$setup_file\" was not found.\n";
5598 print "The plugin \"" . $plugin_name;
5599 print "\" may not work correctly until you fix this.\n";
5600 print "\nPress enter to continue";
5608 # determine a plugin's English name
5610 # parses the setup.php file, looking for the
5611 # English name in the <plugin>_info() function.
5613 sub get_plugin_english_name
() {
5615 my $plugin_name = shift(@_);
5617 $setup_file = '../plugins/' . $plugin_name . '/setup.php';
5618 if ( -e
"$setup_file" ) {
5619 # Make sure that file is readable
5620 if (! -r
"$setup_file") {
5623 print "The file \"$setup_file\" was found, but you don't\n";
5624 print "have rights to read it. The plugin \"";
5625 print $plugin_name . "\" may not work correctly until you fix this.\n";
5626 print "\nPress enter to continue";
5633 # FIXME: grep the file instead of reading it into memory?
5635 open( FILE
, "$setup_file" );
5636 while ( $line = <FILE
> ) {
5637 $whole_file .= $line;
5641 # the English name is in the <plugin>_info function or nothing...
5643 if ($whole_file =~ /('english_name'\s*=>\s*['"](.*?)['"])/) {
5644 $english_name .= $2;
5647 return $english_name;
5652 print "The file \"$setup_file\" was not found.\n";
5653 print "The plugin \"" . $plugin_name;
5654 print "\" may not work correctly until you fix this.\n";
5655 print "\nPress enter to continue";
5663 # parses the setup.php files for all activated plugins and
5664 # builds static plugin hooks array so we don't have to load
5665 # ALL plugins are runtime and build the hook array on every
5668 # hook array is saved in config/plugin_hooks.php
5670 # Note the $verbose variable at the top of this routine
5671 # can be set to zero to quiet it down.
5673 # NOTE/FIXME: we aren't necessarily interested in writing
5674 # a full-blown PHP parsing engine, so plenty
5675 # of assumptions are included herein about the
5676 # coding of the plugin setup files, and things
5677 # like commented out curly braces or other
5678 # such oddities can break this in a bad way.
5680 sub build_plugin_hook_array
() {
5688 if ( open( HOOKFILE
, ">plugin_hooks.php" ) ) {
5689 print HOOKFILE
"<?php\n";
5690 print HOOKFILE
"\n";
5692 print HOOKFILE
"/**\n";
5693 print HOOKFILE
" * SquirrelMail Plugin Hook Registration File\n";
5694 print HOOKFILE
" * Auto-generated using the configure script, conf.pl\n";
5695 print HOOKFILE
" */\n";
5696 print HOOKFILE
"\n";
5697 print HOOKFILE
"global \$squirrelmail_plugin_hooks;\n";
5698 print HOOKFILE
"\n";
5700 PLUGIN
: for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
5703 print "Activating plugin \"" . $plugins[$ct] . "\"...\n";
5706 $setup_file = '../plugins/' . $plugins[$ct] . '/setup.php';
5707 if ( -e
"$setup_file" ) {
5708 # Make sure that file is readable
5709 if (! -r
"$setup_file") {
5712 print "The file \"$setup_file\" was found, but you don't\n";
5713 print "have rights to read it. The plugin \"";
5714 print $plugins[$ct] . "\" will not be activated until you fix this.\n";
5715 print "\nPress enter to continue";
5720 open( FILE
, "$setup_file" );
5721 $inside_init_fxn = 0;
5723 while ( $line = <FILE
> ) {
5725 # throw away lines until we get to target function
5727 if (!$inside_init_fxn
5728 && $line !~ /^\s*function\s*squirrelmail_plugin_init_/i) {
5731 $inside_init_fxn = 1;
5741 # count close braces
5746 # leaving <plugin>_init() function...
5747 if ($brace_count == 0) {
5755 # throw away lines that are not exactly one "brace set" deep
5757 if ($brace_count > 1) {
5762 # also not interested in lines that are not
5763 # hook registration points
5765 if ($line !~ /^\s*\$squirrelmail_plugin_hooks/i) {
5770 # if $line does not have an ending semicolon,
5771 # we need to recursively read in subsequent
5772 # lines until we find one
5773 while ( $line !~ /;\s*$/ ) {
5774 $line =~ s/[\n\r]\s*$//;
5783 $var =~ s/=/EQUALS/;
5784 if ( $var =~ /^([a-z])/i ) {
5785 @options = split ( /\s*EQUALS\s*/, $var );
5786 $options[1] =~ s/[\n\r]//g;
5787 $options[1] =~ s/[\'\"];\s*$//;
5788 $options[1] =~ s/;$//;
5789 $options[1] =~ s/^[\'\"]//;
5790 # de-escape escaped strings
5791 $options[1] =~ s/\\'/'/g;
5792 $options[1] =~ s/\\\\/\\/g;
5794 if ( $options[0] =~ /^squirrelmail_plugin_hooks\s*\[\s*['"]([a-z0-9 \/._
*-]+)['"]\s*\]\s*\[\s*['"]([0-9a-z._-]+)['"]\s
*\
]/i
) {
5796 $hooked_plugin_name = $2;
5797 # Note: if we wanted to stop plugins from registering
5798 # a *different* plugin on a hook, we could catch
5799 # it here, however this has actually proven to be
5800 # a useful *feature*
5801 #if ($hooked_plugin_name ne $plugins[$ct]) {
5802 # print "...plugin is tring to hook in under different name...\n";
5805 #FIXME: do we want to count the number of hook registrations for each plugin and warn if a plugin doesn't have any?
5806 # hook registration has been found!
5808 if ($hooked_plugin_name ne $plugins[$ct]) {
5809 print " registering on hook \"" . $hook_name . "\" (as \"$hooked_plugin_name\" plugin)\n";
5811 print " registering on hook \"" . $hook_name . "\"\n";
5814 $line =~ s/ {2,}/ /g;
5816 print HOOKFILE
"\$$line";
5828 print "The file \"$setup_file\" was not found.\n";
5829 print "The plugin \"" . $plugins[$ct];
5830 print "\" will not be activated until you fix this.\n";
5831 print "\nPress enter to continue";
5839 print HOOKFILE
"\n\n";
5842 print "\nDone activating plugins; registration data saved in plugin_hooks.php\n\n";
5849 print "The file \"plugin_hooks.php\" was not able to be written to.\n";
5850 print "No plugins will be activated until you fix this.\n";
5851 print "\nPress enter to continue";
5859 # converts (binary) integer values that correspond
5860 # to the SquirrelMail debug mode constants (see
5861 # include/constants.php) into those constant strings
5862 # (bitwise or'd if more than one is enabled)
5864 # if the value passed in is not an integer, it is
5865 # returned unmolested
5867 sub convert_debug_binary_integer_to_constants
() {
5869 my ($debug_mode) = @_;
5870 if ($debug_mode =~ /^[^0-9]/) {
5873 $debug_mode = int($debug_mode);
5874 $new_debug_mode = '';
5876 # per include/constants.php, here are their values:
5878 # 0 SM_DEBUG_MODE_OFF
5879 # 1 SM_DEBUG_MODE_SIMPLE
5880 # 512 SM_DEBUG_MODE_MODERATE
5881 # 524288 SM_DEBUG_MODE_ADVANCED
5882 # 536870912 SM_DEBUG_MODE_STRICT
5884 if ($debug_mode & 1) {
5885 $new_debug_mode .= ' | SM_DEBUG_MODE_SIMPLE';
5887 if ($debug_mode & 512) {
5888 $new_debug_mode .= ' | SM_DEBUG_MODE_MODERATE';
5890 if ($debug_mode & 524288) {
5891 $new_debug_mode .= ' | SM_DEBUG_MODE_ADVANCED';
5893 if ($debug_mode & 536870912) {
5894 $new_debug_mode .= ' | SM_DEBUG_MODE_STRICT';
5897 $new_debug_mode =~ s/^ \| //;
5898 if (!$new_debug_mode) {
5899 $new_debug_mode = 'SM_DEBUG_MODE_OFF';
5902 return $new_debug_mode;
5905 # converts SquirrelMail debug mode constants (see
5906 # include/constants.php) into their corresponding
5907 # (binary) integer values
5909 # if the value passed in is an integer already, it
5910 # is returned unmolested
5912 sub convert_debug_constants_to_binary_integer
() {
5914 my ($debug_mode) = @_;
5915 if ($debug_mode =~ /^[0-9]/) {
5918 $new_debug_mode = 0;
5920 # per include/constants.php, here are their values:
5922 # 0 SM_DEBUG_MODE_OFF
5923 # 1 SM_DEBUG_MODE_SIMPLE
5924 # 512 SM_DEBUG_MODE_MODERATE
5925 # 524288 SM_DEBUG_MODE_ADVANCED
5926 # 536870912 SM_DEBUG_MODE_STRICT
5928 if ($debug_mode =~ /\bSM_DEBUG_MODE_OFF\b/) {
5929 $new_debug_mode = 0;
5931 if ($debug_mode =~ /\bSM_DEBUG_MODE_SIMPLE\b/) {
5932 $new_debug_mode |= 1;
5934 if ($debug_mode =~ /\bSM_DEBUG_MODE_MODERATE\b/) {
5935 $new_debug_mode |= 512;
5937 if ($debug_mode =~ /\bSM_DEBUG_MODE_ADVANCED\b/) {
5938 $new_debug_mode |= 524288;
5940 if ($debug_mode =~ /\bSM_DEBUG_MODE_STRICT\b/) {
5941 $new_debug_mode |= 536870912;
5944 return $new_debug_mode;
5947 # Function to print n column numbered lists
5949 # WARNING: the names in the list will be truncated
5950 # to fit in their respective columns based on the
5951 # screen width and number of columns.
5953 # Expected arguments (in this order):
5955 # * The start number to use for the list
5956 # * The number of columns to use
5957 # * The screen width
5958 # * Boolean (zero/one), indicating
5959 # whether or not to show item numbers
5960 # * The list of strings to be shown
5962 # Returns: The number printed on screen of the last item in the list
5964 sub print_multi_col_list
{
5965 my ($num, $cols, $screen_width, $show_numbering, @list) = @_;
5975 $rows = int(@list / $cols);
5976 if (@list % $cols) { $rows++; }
5977 if ($show_numbering) { $col_width = int(($screen_width - 2) / $cols) - 5; }
5978 else { $col_width = int(($screen_width - 2) / $cols) - 2; }
5980 # build the layout array so numbers run down each column
5982 for ( $x = 0; $x < @list; $x++ ) {
5984 $layout[$row_cnt][$col_cnt] = $list[$x];
5985 $numbers[$row_cnt][$col_cnt] = $num++;
5987 # move to next column
5989 if ($row_cnt == $rows - 1) {
5993 else { $row_cnt++; }
5997 # if we filled up fewer rows than needed, recalc column width
5999 if ($rows * $col_cnt == @list) { $col_cnt--; } # loop above ended right after increment
6000 if ($col_cnt + 1 < $cols) {
6001 if ($show_numbering) { $col_width = int(($screen_width - 2) / ($col_cnt + 1)) - 5; }
6002 else { $col_width = int(($screen_width - 2) / ($col_cnt + 1)) - 2; }
6008 for ( $row_cnt = 0; $row_cnt <= $rows; $row_cnt++ ) {
6014 # iterate columns for this row
6016 for ( $col_cnt = 0; $col_cnt <= $cols; $col_cnt++ ) {
6017 if ($layout[$row_cnt][$col_cnt]) {
6019 if ($show_numbering) { printf "$WHT% 2u.$NRM", $numbers[$row_cnt][$col_cnt]; }
6020 printf " %-$col_width." . $col_width . "s", $layout[$row_cnt][$col_cnt];