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 );
439 $sm_debug_mode = 'SM_DEBUG_MODE_MODERATE' if ( !$sm_debug_mode );
440 #FIXME: When this is STABLE software, remove the line above and uncomment the one below:
441 #$sm_debug_mode = 'SM_DEBUG_MODE_OFF' if ( !$sm_debug_mode );
442 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
444 $addrbook_global_table = 'global_abook' if ( !$addrbook_global_table );
445 $addrbook_global_writeable = 'false' if ( !$addrbook_global_writeable );
446 $addrbook_global_listing = 'false' if ( !$addrbook_global_listing );
447 $abook_global_file = '' if ( !$abook_global_file);
448 $abook_global_file_writeable = 'false' if ( !$abook_global_file_writeable);
449 $abook_global_file_listing = 'true' if ( !$abook_global_file_listing );
450 $encode_header_key = '' if ( !$encode_header_key );
451 $hide_auth_header = 'false' if ( !$hide_auth_header );
452 $time_zone_type = '0' if ( !$time_zone_type );
453 $prefs_user_size = 128 if ( !$prefs_user_size );
454 $prefs_key_size = 64 if ( !$prefs_key_size );
455 $prefs_val_size = 65536 if ( !$prefs_val_size );
457 # add qmail-inject test here for backwards compatibility
458 if ( !$sendmail_args && $sendmail_path =~ /qmail-inject/ ) {
460 } elsif ( !$sendmail_args ) {
461 $sendmail_args = '-i -t';
464 $default_fontsize = '' if ( !$default_fontsize);
465 $default_fontset = '' if ( !$default_fontset);
467 %fontsets = ('serif', 'serif',
468 'sans', 'helvetica,arial,sans-serif',
469 'comicsans', 'comic sans ms,sans-serif',
470 'tahoma', 'tahoma,sans-serif',
471 'verasans', 'bitstream vera sans,verdana,sans-serif');
474 # $use_imap_tls and $use_smtp_tls are switched to integer since 1.5.1
475 $use_imap_tls = 0 if ( $use_imap_tls eq 'false');
476 $use_imap_tls = 1 if ( $use_imap_tls eq 'true');
477 $use_smtp_tls = 0 if ( $use_smtp_tls eq 'false');
478 $use_smtp_tls = 1 if ( $use_smtp_tls eq 'true');
479 # sorting options changed names and reversed values in 1.5.1
480 $disable_thread_sort = 'false' if ( !$disable_thread_sort );
481 $disable_server_sort = 'false' if ( !$disable_server_sort );
484 $abook_file_line_length = 2048 if ( !$abook_file_line_length );
485 $config_location_base = '' if ( !$config_location_base );
486 $smtp_sitewide_user = '' if ( !$smtp_sitewide_user );
487 $smtp_sitewide_pass = '' if ( !$smtp_sitewide_pass );
488 $icon_theme_def = '' if ( !$icon_theme_def );
489 $disable_plugins = 'false' if ( !$disable_plugins );
490 $disable_plugins_user = '' if ( !$disable_plugins_user );
491 $only_secure_cookies = 'true' if ( !$only_secure_cookies );
492 $ask_user_info = 'true' if ( !$ask_user_info );
494 if ( $ARGV[0] eq '--install-plugin' ) {
495 print "Activating plugin " . $ARGV[1] . "\n";
496 if ( -d
"../plugins/" . $ARGV[1]) {
497 push @plugins, $ARGV[1];
501 print "No such plugin.\n";
504 } elsif ( $ARGV[0] eq '--remove-plugin' ) {
505 print "Removing plugin " . $ARGV[1] . "\n";
506 foreach $plugin (@plugins) {
507 if ( $plugin ne $ARGV[1] ) {
508 push @newplugins, $plugin;
511 @plugins = @newplugins;
514 } elsif ( $ARGV[0] eq '--update-plugins' or $ARGV[0] eq '-u') {
515 build_plugin_hook_array
();
517 } elsif ( $ARGV[0] eq '--help' or $ARGV[0] eq '-h') {
518 print "SquirrelMail Configuration Script\n";
520 print " * No arguments: initiates the configuration dialog\n";
521 print " * --install-plugin <plugin> : activates the specified plugin\n";
522 print " * --remove-plugin <plugin> : deactivates the specified plugin\n";
523 print " * --update-plugins , -u : rebuilds plugin_hooks.php according\n";
524 print " to plugins activated in config.php\n";
525 print " * --help , -h : Displays this help\n";
532 ####################################################################################
534 # used in multiple places, define once
535 $list_supported_imap_servers =
536 " bincimap = Binc IMAP server\n" .
537 " courier = Courier IMAP server\n" .
538 " cyrus = Cyrus IMAP server\n" .
539 " dovecot = Dovecot Secure IMAP server\n" .
540 " exchange = Microsoft Exchange IMAP server\n" .
541 " hmailserver = hMailServer\n" .
542 " macosx = Mac OS X Mailserver\n" .
543 " mercury32 = Mercury/32\n" .
544 " uw = University of Washington's IMAP server\n";
546 #####################################################################################
547 if ( $config_use_color == 1 ) {
553 $config_use_color = 2;
556 # lists can be printed in more than one column; default is just one
560 # try to get screen width dynamically if possible; default to 80
561 # (user can override with "w#" command)
563 eval { require "sys/ioctl.ph" };
565 || !defined &TIOCGWINSZ
566 || !open(TTY
, "+</dev/tty")
567 || !ioctl(TTY
, &TIOCGWINSZ
, $winsize='')) {
570 ($row, $col, $xpixel, $ypixel) = unpack('S4', $winsize);
571 $screen_width = $col;
574 while ( ( $command ne "q" ) && ( $command ne "Q" ) && ( $command ne ":q" ) ) {
576 print $WHT. "SquirrelMail Configuration : " . $NRM;
577 if ( $config == 1 ) { print "Read: config.php"; }
578 elsif ( $config == 2 ) { print "Read: config_default.php"; }
579 print " ($print_config_version)\n";
580 print "---------------------------------------------------------\n";
583 print $WHT. "Main Menu --\n" . $NRM;
584 print "1. Organization Preferences\n";
585 print "2. Server Settings\n";
586 print "3. Folder Defaults\n";
587 print "4. General Options\n";
588 print "5. User Interface\n";
589 print "6. Address Books\n";
590 print "7. Message of the Day (MOTD)\n";
591 print "8. Plugins\n";
592 print "9. Database\n";
593 print "10. Language settings\n";
594 print "11. Tweaks\n";
596 print "D. Set pre-defined settings for specific IMAP servers\n";
598 } elsif ( $menu == 1 ) {
599 print $WHT. "Organization Preferences\n" . $NRM;
600 print "1. Organization Name : $WHT$org_name$NRM\n";
601 print "2. Organization Logo : $WHT$org_logo$NRM\n";
602 print "3. Org. Logo Width/Height : $WHT($org_logo_width/$org_logo_height)$NRM\n";
603 print "4. Organization Title : $WHT$org_title$NRM\n";
604 print "5. Signout Page : $WHT$signout_page$NRM\n";
605 print "6. Top Frame : $WHT$frame_top$NRM\n";
606 print "7. Provider link : $WHT$provider_uri$NRM\n";
607 print "8. Provider link text : $WHT$provider_name$NRM\n";
610 print "R Return to Main Menu\n";
611 } elsif ( $menu == 2 ) {
612 print $WHT. "Server Settings\n\n" . $NRM;
613 print $WHT . "General" . $NRM . "\n";
615 print "1. Domain : $WHT$domain$NRM\n";
616 print "2. Invert Time : $WHT$invert_time$NRM\n";
617 print "3. Sendmail or SMTP : $WHT";
618 if ( lc($useSendmail) eq 'true' ) {
626 if ( $show_imap_settings ) {
627 print $WHT . "IMAP Settings". $NRM . "\n--------------\n";
628 print "4. IMAP Server : $WHT$imapServerAddress$NRM\n";
629 print "5. IMAP Port : $WHT$imapPort$NRM\n";
630 print "6. Authentication type : $WHT$imap_auth_mech$NRM\n";
631 print "7. Secure IMAP (TLS) : $WHT" . display_use_tls
($use_imap_tls) . "$NRM\n";
632 print "8. Server software : $WHT$imap_server_type$NRM\n";
633 print "9. Delimiter : $WHT$optional_delimiter$NRM\n";
635 } elsif ( $show_smtp_settings ) {
636 if ( lc($useSendmail) eq 'true' ) {
637 print $WHT . "Sendmail" . $NRM . "\n--------\n";
638 print "4. Sendmail Path : $WHT$sendmail_path$NRM\n";
639 print "5. Sendmail arguments : $WHT$sendmail_args$NRM\n";
640 print "6. Header encryption key : $WHT$encode_header_key$NRM\n";
643 print $WHT . "SMTP Settings" . $NRM . "\n-------------\n";
644 print "4. SMTP Server : $WHT$smtpServerAddress$NRM\n";
645 print "5. SMTP Port : $WHT$smtpPort$NRM\n";
646 print "6. POP before SMTP : $WHT$pop_before_smtp$NRM\n";
647 print "7. SMTP Authentication : $WHT$smtp_auth_mech" . display_smtp_sitewide_userpass
() ."$NRM\n";
648 print "8. Secure SMTP (TLS) : $WHT" . display_use_tls
($use_smtp_tls) . "$NRM\n";
649 print "9. Header encryption key : $WHT$encode_header_key$NRM\n";
654 if ($show_imap_settings == 0) {
655 print "A. Update IMAP Settings : ";
656 print "$WHT$imapServerAddress$NRM:";
657 print "$WHT$imapPort$NRM ";
658 print "($WHT$imap_server_type$NRM)\n";
660 if ($show_smtp_settings == 0) {
661 if ( lc($useSendmail) eq 'true' ) {
662 print "B. Change Sendmail Config : $WHT$sendmail_path$NRM\n";
664 print "B. Update SMTP Settings : ";
665 print "$WHT$smtpServerAddress$NRM:";
666 print "$WHT$smtpPort$NRM\n";
669 if ( $show_smtp_settings || $show_imap_settings )
672 ($show_imap_settings ?
"IMAP Server" :
673 (lc($useSendmail) eq 'true') ?
"Sendmail" : "SMTP") . " Settings\n";
677 print "R Return to Main Menu\n";
678 } elsif ( $menu == 3 ) {
679 print $WHT. "Folder Defaults\n" . $NRM;
680 print "1. Default Folder Prefix : $WHT$default_folder_prefix$NRM\n";
681 print "2. Show Folder Prefix Option : $WHT$show_prefix_option$NRM\n";
682 print "3. Trash Folder : $WHT$trash_folder$NRM\n";
683 print "4. Sent Folder : $WHT$sent_folder$NRM\n";
684 print "5. Drafts Folder : $WHT$draft_folder$NRM\n";
685 print "6. By default, move to trash : $WHT$default_move_to_trash$NRM\n";
686 print "7. By default, save sent messages : $WHT$default_move_to_sent$NRM\n";
687 print "8. By default, save as draft : $WHT$default_save_as_draft$NRM\n";
688 print "9. List Special Folders First : $WHT$list_special_folders_first$NRM\n";
689 print "10. Show Special Folders Color : $WHT$use_special_folder_color$NRM\n";
690 print "11. Auto Expunge : $WHT$auto_expunge$NRM\n";
691 print "12. Default Sub. of INBOX : $WHT$default_sub_of_inbox$NRM\n";
692 print "13. Show 'Contain Sub.' Option : $WHT$show_contain_subfolders_option$NRM\n";
693 print "14. Default Unseen Notify : $WHT$default_unseen_notify$NRM\n";
694 print "15. Default Unseen Type : $WHT$default_unseen_type$NRM\n";
695 print "16. Auto Create Special Folders : $WHT$auto_create_special$NRM\n";
696 print "17. Folder Delete Bypasses Trash : $WHT$delete_folder$NRM\n";
697 print "18. Enable /NoSelect folder fix : $WHT$noselect_fix_enable$NRM\n";
699 print "R Return to Main Menu\n";
700 } elsif ( $menu == 4 ) {
701 print $WHT. "General Options\n" . $NRM;
702 print "1. Data Directory : $WHT$data_dir$NRM\n";
703 print "2. Attachment Directory : $WHT$attachment_dir$NRM\n";
704 print "3. Directory Hash Level : $WHT$dir_hash_level$NRM\n";
705 print "4. Default Left Size : $WHT$default_left_size$NRM\n";
706 print "5. Usernames in Lowercase : $WHT$force_username_lowercase$NRM\n";
707 print "6. Allow use of priority : $WHT$default_use_priority$NRM\n";
708 print "7. Hide SM attributions : $WHT$hide_sm_attributions$NRM\n";
709 print "8. Allow use of receipts : $WHT$default_use_mdn$NRM\n";
710 print "9. Allow editing of identity : $WHT$edit_identity$NRM\n";
711 print " Allow editing of name : $WHT$edit_name$NRM\n";
712 print " Remove username from header : $WHT$hide_auth_header$NRM\n";
713 print "10. Disable server thread sort : $WHT$disable_thread_sort$NRM\n";
714 print "11. Disable server-side sorting : $WHT$disable_server_sort$NRM\n";
715 print "12. Allow server charset search : $WHT$allow_charset_search$NRM\n";
716 print "13. Allow advanced search : $WHT$allow_advanced_search$NRM\n";
717 print "14. PHP session name : $WHT$session_name$NRM\n";
718 print "15. Time zone configuration : $WHT$time_zone_type$NRM\n";
719 print "16. Location base : $WHT$config_location_base$NRM\n";
720 print "17. Only secure cookies if poss. : $WHT$only_secure_cookies$NRM\n";
722 print "R Return to Main Menu\n";
723 } elsif ( $menu == 5 ) {
724 print $WHT. "User Interface\n" . $NRM;
725 print "1. Use Icons? : $WHT$use_icons$NRM\n";
726 # print "3. Default Icon Set : $WHT$icon_theme_def$NRM\n";
727 print "2. Default font size : $WHT$default_fontsize$NRM\n";
728 print "3. Manage template sets (skins)\n";
729 print "4. Manage user themes\n";
730 print "5. Manage font sets\n";
731 print "6. Manage icon themes\n";
734 print "R Return to Main Menu\n";
735 } elsif ( $menu == 6 ) {
736 print $WHT. "Address Books\n" . $NRM;
737 print "1. Change LDAP Servers\n";
738 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
739 print " > $ldap_host[$count]\n";
741 print "2. Use Javascript address book search : $WHT$default_use_javascript_addr_book$NRM\n";
742 print "3. Global address book file : $WHT$abook_global_file$NRM\n";
743 print "4. Allow writing into global file address book : $WHT$abook_global_file_writeable$NRM\n";
744 print "5. Allow listing of global file address book : $WHT$abook_global_file_listing$NRM\n";
745 print "6. Allowed address book line length : $WHT$abook_file_line_length$NRM\n";
747 print "R Return to Main Menu\n";
748 } elsif ( $menu == 7 ) {
749 print $WHT. "Message of the Day (MOTD)\n" . $NRM;
752 print "1 Edit the MOTD\n";
754 print "R Return to Main Menu\n";
755 } elsif ( $menu == 8 ) {
756 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
757 print $WHT. "Plugins (WARNING: All plugins are currently disabled\n for the user \"$disable_plugins_user\"!)\n" . $NRM;
758 } elsif (lc($disable_plugins) eq 'true') {
759 print $WHT. "Plugins (WARNING: All plugins are currently disabled!)\n" . $NRM;
761 print $WHT. "Plugins\n" . $NRM;
763 print " Installed Plugins\n";
765 $num = print_multi_col_list
(1, $columns, $screen_width, 1, @plugins);
768 for ( $count = 0 ; $count <= $#plugins ; $count++ ) {
770 $english_name = get_plugin_english_name
($plugins[$count]);
771 if ( $english_name eq "" ) {
772 print " $WHT$num.$NRM $plugins[$count]" . get_plugin_version
($plugins[$count]) . "\n";
774 print " $WHT$num.$NRM $english_name ($plugins[$count])" . get_plugin_version
($plugins[$count]) . "\n";
778 print "\n Available Plugins:\n";
779 opendir( DIR
, "../plugins" );
780 @files = sort(readdir(DIR
));
782 @unused_plugins = ();
783 for ( $i = 0 ; $i <= $#files ; $i++ ) {
784 if ( -d
"../plugins/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne ".svn" ) {
786 for ( $k = 0 ; $k <= $#plugins ; $k++ ) {
787 if ( $plugins[$k] eq $files[$i] ) {
792 $unused_plugins[$pos] = $files[$i];
799 $num = print_multi_col_list
($num + 1, $columns, $screen_width, 1, @unused_plugins);
801 for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
803 $english_name = get_plugin_english_name
($unused_plugins[$i]);
804 if ( $english_name eq "" ) {
805 print " $WHT$num.$NRM $unused_plugins[$i]" . get_plugin_version
($unused_plugins[$i]) . "\n";
807 print " $WHT$num.$NRM $english_name ($unused_plugins[$i])" . get_plugin_version
($unused_plugins[$i]) . "\n";
814 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
815 print "E Enable active plugins (all plugins currently\n disabled for the user \"$disable_plugins_user\")\n";
816 } elsif (lc($disable_plugins) eq 'true') {
817 print "E Enable active plugins (all plugins currently\n disabled)\n";
819 print "D Disable all plugins\n";
821 print "U Set the user for whom plugins can be disabled\n";
822 print "R Return to Main Menu\n";
823 print "C# List plugins in <#> number of columns\n";
824 print "W# Change screen width to <#> (currently $screen_width)\n";
825 } elsif ( $menu == 9 ) {
826 print $WHT. "Database\n" . $NRM;
827 print "1. DSN for Address Book : $WHT$addrbook_dsn$NRM\n";
828 print "2. Table for Address Book : $WHT$addrbook_table$NRM\n";
830 print "3. DSN for Preferences : $WHT$prefs_dsn$NRM\n";
831 print "4. Table for Preferences : $WHT$prefs_table$NRM\n";
832 print "5. Field for username : $WHT$prefs_user_field$NRM ($prefs_user_size)\n";
833 print "6. Field for prefs key : $WHT$prefs_key_field$NRM ($prefs_key_size)\n";
834 print "7. Field for prefs value : $WHT$prefs_val_field$NRM ($prefs_val_size)\n";
836 print "8. DSN for Global Address Book : $WHT$addrbook_global_dsn$NRM\n";
837 print "9. Table for Global Address Book : $WHT$addrbook_global_table$NRM\n";
838 print "10. Allow writing into Global Address Book : $WHT$addrbook_global_writeable$NRM\n";
839 print "11. Allow listing of Global Address Book : $WHT$addrbook_global_listing$NRM\n";
841 print "R Return to Main Menu\n";
842 } elsif ( $menu == 10 ) {
843 print $WHT. "Language settings\n" . $NRM;
844 print "1. Default Language : $WHT$squirrelmail_default_language$NRM\n";
845 print "2. Default Charset : $WHT$default_charset$NRM\n";
846 print "3. Show alternative language names : $WHT$show_alternative_names$NRM\n";
847 print "4. Enable aggressive decoding : $WHT$aggressive_decoding$NRM\n";
848 print "5. Enable lossy encoding : $WHT$lossy_encoding$NRM\n";
850 print "R Return to Main Menu\n";
851 } elsif ( $menu == 11 ) {
852 print $WHT. "Interface tweaks\n" . $NRM;
853 print "1. Display html mails in iframe : $WHT$use_iframe$NRM\n";
854 print "2. Ask user info on first login : $WHT$ask_user_info$NRM\n";
856 print $WHT. "PHP tweaks\n" . $NRM;
857 print "4. Use php recode functions : $WHT$use_php_recode$NRM\n";
858 print "5. Use php iconv functions : $WHT$use_php_iconv$NRM\n";
859 print "6. Buffer all output : $WHT$buffer_output$NRM\n";
861 print $WHT. "Configuration tweaks\n" . $NRM;
862 print "7. Allow remote configtest : $WHT$allow_remote_configtest$NRM\n";
863 print "8. Debug mode : $WHT$sm_debug_mode$NRM\n";
864 print "9. Secured configuration mode : $WHT$secured_config$NRM\n";
866 print "R Return to Main Menu\n";
868 if ( $config_use_color == 1 ) {
869 print "C Turn color off\n";
871 print "C Turn color on\n";
873 print "S Save data\n";
877 print "Command >> " . $WHT;
879 $command =~ s/[\n\r]//g;
880 $command =~ tr/A-Z/a-z/;
883 # Read the commands they entered.
884 if ( $command eq "r" ) {
886 } elsif ( $command eq "s" ) {
888 print "Press enter to continue...";
891 } elsif ( ( $command eq "q" ) && ( $saved == 0 ) ) {
892 print "You have not saved your data.\n";
893 print "Save? [" . $WHT . "Y" . $NRM . "/n]: ";
895 if ( ( $save =~ /^y/i ) || ( $save =~ /^\s*$/ ) ) {
898 } elsif ( $command eq "c" ) {
899 if ( $config_use_color == 1 ) {
900 $config_use_color = 2;
904 $config_use_color = 1;
908 } elsif ( $command =~ /^w([0-9]+)/ ) {
910 } elsif ( $command eq "d" && $menu == 0 ) {
915 if ( ( $command > 0 ) && ( $command < 12 ) ) {
918 } elsif ( $menu == 1 ) {
919 if ( $command == 1 ) { $org_name = command1
(); }
920 elsif ( $command == 2 ) { $org_logo = command2
(); }
921 elsif ( $command == 3 ) { ($org_logo_width,$org_logo_height) = command2a
(); }
922 elsif ( $command == 4 ) { $org_title = command3
(); }
923 elsif ( $command == 5 ) { $signout_page = command4
(); }
924 elsif ( $command == 6 ) { $frame_top = command6
(); }
925 elsif ( $command == 7 ) { $provider_uri = command7
(); }
926 elsif ( $command == 8 ) { $provider_name = command8
(); }
928 } elsif ( $menu == 2 ) {
929 if ( $command eq "a" ) { $show_imap_settings = 1; $show_smtp_settings = 0; }
930 elsif ( $command eq "b" ) { $show_imap_settings = 0; $show_smtp_settings = 1; }
931 elsif ( $command eq "h" ) { $show_imap_settings = 0; $show_smtp_settings = 0; }
932 elsif ( $command <= 3 ) {
933 if ( $command == 1 ) { $domain = command11
(); }
934 elsif ( $command == 2 ) { $invert_time = command110
(); }
935 elsif ( $command == 3 ) { $useSendmail = command14
(); }
936 $show_imap_settings = 0; $show_smtp_settings = 0;
937 } elsif ( $show_imap_settings ) {
938 if ( $command == 4 ) { $imapServerAddress = command12
(); }
939 elsif ( $command == 5 ) { $imapPort = command13
(); }
940 elsif ( $command == 6 ) { $imap_auth_mech = command112a
(); }
941 elsif ( $command == 7 ) { $use_imap_tls = command_use_tls
("IMAP",$use_imap_tls); }
942 elsif ( $command == 8 ) { $imap_server_type = command19
(); }
943 elsif ( $command == 9 ) { $optional_delimiter = command111
(); }
944 } elsif ( $show_smtp_settings && lc($useSendmail) eq 'true' ) {
945 if ( $command == 4 ) { $sendmail_path = command15
(); }
946 elsif ( $command == 5 ) { $sendmail_args = command_sendmail_args
(); }
947 elsif ( $command == 6 ) { $encode_header_key = command114
(); }
948 } elsif ( $show_smtp_settings ) {
949 if ( $command == 4 ) { $smtpServerAddress = command16
(); }
950 elsif ( $command == 5 ) { $smtpPort = command17
(); }
951 elsif ( $command == 6 ) { $pop_before_smtp = command18a
(); }
952 elsif ( $command == 7 ) { $smtp_auth_mech = command112b
(); }
953 elsif ( $command == 8 ) { $use_smtp_tls = command_use_tls
("SMTP",$use_smtp_tls); }
954 elsif ( $command == 9 ) { $encode_header_key = command114
(); }
956 } elsif ( $menu == 3 ) {
957 if ( $command == 1 ) { $default_folder_prefix = command21
(); }
958 elsif ( $command == 2 ) { $show_prefix_option = command22
(); }
959 elsif ( $command == 3 ) { $trash_folder = command23a
(); }
960 elsif ( $command == 4 ) { $sent_folder = command23b
(); }
961 elsif ( $command == 5 ) { $draft_folder = command23c
(); }
962 elsif ( $command == 6 ) { $default_move_to_trash = command24a
(); }
963 elsif ( $command == 7 ) { $default_move_to_sent = command24b
(); }
964 elsif ( $command == 8 ) { $default_save_as_draft = command24c
(); }
965 elsif ( $command == 9 ) { $list_special_folders_first = command27
(); }
966 elsif ( $command == 10 ) { $use_special_folder_color = command28
(); }
967 elsif ( $command == 11 ) { $auto_expunge = command29
(); }
968 elsif ( $command == 12 ) { $default_sub_of_inbox = command210
(); }
969 elsif ( $command == 13 ) { $show_contain_subfolders_option = command211
(); }
970 elsif ( $command == 14 ) { $default_unseen_notify = command212
(); }
971 elsif ( $command == 15 ) { $default_unseen_type = command213
(); }
972 elsif ( $command == 16 ) { $auto_create_special = command214
(); }
973 elsif ( $command == 17 ) { $delete_folder = command215
(); }
974 elsif ( $command == 18 ) { $noselect_fix_enable = command216
(); }
975 } elsif ( $menu == 4 ) {
976 if ( $command == 1 ) { $data_dir = command33a
(); }
977 elsif ( $command == 2 ) { $attachment_dir = command33b
(); }
978 elsif ( $command == 3 ) { $dir_hash_level = command33c
(); }
979 elsif ( $command == 4 ) { $default_left_size = command35
(); }
980 elsif ( $command == 5 ) { $force_username_lowercase = command36
(); }
981 elsif ( $command == 6 ) { $default_use_priority = command37
(); }
982 elsif ( $command == 7 ) { $hide_sm_attributions = command38
(); }
983 elsif ( $command == 8 ) { $default_use_mdn = command39
(); }
984 elsif ( $command == 9 ) { $edit_identity = command310
(); }
985 elsif ( $command == 10 ) { $disable_thread_sort = command312
(); }
986 elsif ( $command == 11 ) { $disable_server_sort = command313
(); }
987 elsif ( $command == 12 ) { $allow_charset_search = command314
(); }
988 elsif ( $command == 13 ) { $allow_advanced_search = command316
(); }
989 elsif ( $command == 14 ) { $session_name = command317
(); }
990 elsif ( $command == 15 ) { $time_zone_type = command318
(); }
991 elsif ( $command == 16 ) { $config_location_base = command_config_location_base
(); }
992 elsif ( $command == 17 ) { $only_secure_cookies = command319
(); }
993 } elsif ( $menu == 5 ) {
994 if ( $command == 1 ) { $use_icons = commandB3
(); }
995 # elsif ( $command == 3 ) { $icon_theme_def = command53(); }
996 elsif ( $command == 2 ) { $default_fontsize = command_default_fontsize
(); }
997 elsif ( $command == 3 ) { $templateset_default = command_templates
(); }
998 elsif ( $command == 4 ) { command_userThemes
(); }
999 elsif ( $command == 5 ) { command_fontsets
(); }
1000 elsif ( $command == 6 ) { command_iconSets
(); }
1001 } elsif ( $menu == 6 ) {
1002 if ( $command == 1 ) { command61
(); }
1003 elsif ( $command == 2 ) { command62
(); }
1004 elsif ( $command == 3 ) { $abook_global_file=command63
(); }
1005 elsif ( $command == 4 ) { command64
(); }
1006 elsif ( $command == 5 ) { command65
(); }
1007 elsif ( $command == 6 ) { command_abook_file_line_length
(); }
1008 } elsif ( $menu == 7 ) {
1009 if ( $command == 1 ) { $motd = command71
(); }
1010 } elsif ( $menu == 8 ) {
1011 if ( $command =~ /^[0-9]+/ ) { @plugins = command81
(); }
1012 elsif ( $command eq "u" ) { $disable_plugins_user = command82
(); }
1013 elsif ( $command eq "d" ) { $disable_plugins = 'true'; }
1014 elsif ( $command eq "e" ) { $disable_plugins = 'false'; }
1015 elsif ( $command =~ /^c([0-9]+)/ ) { $columns = $1; }
1016 } elsif ( $menu == 9 ) {
1017 if ( $command == 1 ) { $addrbook_dsn = command91
(); }
1018 elsif ( $command == 2 ) { $addrbook_table = command92
(); }
1019 elsif ( $command == 3 ) { $prefs_dsn = command93
(); }
1020 elsif ( $command == 4 ) { $prefs_table = command94
(); }
1021 elsif ( $command == 5 ) { $prefs_user_field = command95
(); }
1022 elsif ( $command == 6 ) { $prefs_key_field = command96
(); }
1023 elsif ( $command == 7 ) { $prefs_val_field = command97
(); }
1024 elsif ( $command == 8 ) { $addrbook_global_dsn = command98
(); }
1025 elsif ( $command == 9 ) { $addrbook_global_table = command99
(); }
1026 elsif ( $command == 10 ) { $addrbook_global_writeable = command910
(); }
1027 elsif ( $command == 11 ) { $addrbook_global_listing = command911
(); }
1028 } elsif ( $menu == 10 ) {
1029 if ( $command == 1 ) { $squirrelmail_default_language = commandA1
(); }
1030 elsif ( $command == 2 ) { $default_charset = commandA2
(); }
1031 elsif ( $command == 3 ) { $show_alternative_names = commandA3
(); }
1032 elsif ( $command == 4 ) { $aggressive_decoding = commandA4
(); }
1033 elsif ( $command == 5 ) { $lossy_encoding = commandA5
(); }
1034 } elsif ( $menu == 11 ) {
1035 if ( $command == 1 ) { $use_iframe = commandB2
(); }
1036 elsif ( $command == 2 ) { $ask_user_info = command_ask_user_info
(); }
1037 elsif ( $command == 4 ) { $use_php_recode = commandB4
(); }
1038 elsif ( $command == 5 ) { $use_php_iconv = commandB5
(); }
1039 elsif ( $command == 6 ) { $buffer_output = commandB6
(); }
1040 elsif ( $command == 7 ) { $allow_remote_configtest = commandB7
(); }
1041 elsif ( $command == 8 ) { $sm_debug_mode = commandB8
(); }
1042 elsif ( $command == 9 ) { $secured_config = commandB9
(); }
1048 print "\nExiting conf.pl.\n".
1049 "You might want to test your configuration by browsing to\n".
1050 "http://your-squirrelmail-location/src/configtest.php\n".
1051 "Happy SquirrelMailing!\n\n";
1054 ####################################################################################
1058 print "We have tried to make the name SquirrelMail as transparent as\n";
1059 print "possible. If you set up an organization name, most places where\n";
1060 print "SquirrelMail would take credit will be credited to your organization.\n";
1062 print "If your Organization Name includes a '\$', please precede it with a \\. \n";
1063 print "Other '\$' will be considered the beginning of a variable that\n";
1064 print "must be defined before the \$org_name is printed.\n";
1066 print "[$WHT$org_name$NRM]: $WHT";
1067 $new_org_name = <STDIN
>;
1068 if ( $new_org_name eq "\n" ) {
1069 $new_org_name = $org_name;
1071 $new_org_name =~ s/[\r\n]//g;
1072 $new_org_name =~ s/\"/"/g;
1074 return $new_org_name;
1079 print "Your organization's logo is an image that will be displayed at\n";
1080 print "different times throughout SquirrelMail. ";
1082 print "Please be aware of the following: \n";
1083 print " - Relative URLs are relative to the config dir\n";
1084 print " to use the default logo, use ../images/sm_logo.png\n";
1085 print " - To specify a logo defined outside the SquirrelMail source tree\n";
1086 print " use the absolute URL the webserver would use to include the file\n";
1087 print " e.g. http://example.com/images/mylogo.gif or /images/mylogo.jpg\n";
1089 print "[$WHT$org_logo$NRM]: $WHT";
1090 $new_org_logo = <STDIN
>;
1091 if ( $new_org_logo eq "\n" ) {
1092 $new_org_logo = $org_logo;
1094 $new_org_logo =~ s/[\r\n]//g;
1096 return $new_org_logo;
1101 print "Your organization's logo is an image that will be displayed at\n";
1102 print "different times throughout SquirrelMail. Width\n";
1103 print "and Height of your logo image. Use '0' to disable.\n";
1105 print "Width: [$WHT$org_logo_width$NRM]: $WHT";
1106 $new_org_logo_width = <STDIN
>;
1107 $new_org_logo_width =~ tr/0-9//cd; # only want digits!
1108 if ( $new_org_logo_width eq '' ) {
1109 $new_org_logo_width = $org_logo_width;
1111 if ( $new_org_logo_width > 0 ) {
1112 print "Height: [$WHT$org_logo_height$NRM]: $WHT";
1113 $new_org_logo_height = <STDIN
>;
1114 $new_org_logo_height =~ tr/0-9//cd; # only want digits!
1115 if( $new_org_logo_height eq '' ) {
1116 $new_org_logo_height = $org_logo_height;
1119 $new_org_logo_height = 0;
1121 return ($new_org_logo_width, $new_org_logo_height);
1126 print "A title is what is displayed at the top of the browser window in\n";
1127 print "the titlebar. Usually this will end up looking something like:\n";
1128 print "\"Netscape: $org_title\"\n";
1130 print "If your Organization Title includes a '\$', please precede it with a \\. \n";
1131 print "Other '\$' will be considered the beginning of a variable that\n";
1132 print "must be defined before the \$org_title is printed.\n";
1134 print "[$WHT$org_title$NRM]: $WHT";
1135 $new_org_title = <STDIN
>;
1136 if ( $new_org_title eq "\n" ) {
1137 $new_org_title = $org_title;
1139 $new_org_title =~ s/[\r\n]//g;
1140 $new_org_title =~ s/\"/\'/g;
1142 return $new_org_title;
1147 print "When users click the Sign Out button they will be logged out and\n";
1148 print "then sent to signout_page. If signout_page is left empty,\n";
1149 print "(hit space and then return) they will be taken, as normal,\n";
1150 print "to the default and rather sparse SquirrelMail signout page.\n";
1152 print "[$WHT$signout_page$NRM]: $WHT";
1153 $new_signout_page = <STDIN
>;
1154 if ( $new_signout_page eq "\n" ) {
1155 $new_signout_page = $signout_page;
1157 $new_signout_page =~ s/[\r\n]//g;
1158 $new_signout_page =~ s/^\s+$//g;
1160 return $new_signout_page;
1165 print "SquirrelMail defaults to using the whole of the browser window.\n";
1166 print "This allows you to keep it within a specified frame. The default\n";
1167 print "is '_top'\n";
1169 print "[$WHT$frame_top$NRM]: $WHT";
1170 $new_frame_top = <STDIN
>;
1171 if ( $new_frame_top eq "\n" ) {
1172 $new_frame_top = '_top';
1174 $new_frame_top =~ s/[\r\n]//g;
1175 $new_frame_top =~ s/^\s+$//g;
1177 return $new_frame_top;
1180 # Default link to provider
1182 print "Here you can set the link on the top-right of the message list.\n";
1183 print "If empty, it will not be displayed.\n";
1185 print "[$WHT$provider_uri$NRM]: $WHT";
1186 $new_provider_uri = <STDIN
>;
1187 if ( $new_provider_uri eq "\n" ) {
1188 $new_provider_uri = '';
1190 $new_provider_uri =~ s/[\r\n]//g;
1191 $new_provider_uri =~ s/^\s+$//g;
1193 return $new_provider_uri;
1197 print "Here you can set the name of the link on the top-right of the message list.\n";
1198 print "The default is empty (do not display anything).'\n";
1200 print "[$WHT$provider_name$NRM]: $WHT";
1201 $new_provider_name = <STDIN
>;
1202 if ( $new_provider_name eq "\n" ) {
1203 $new_provider_name = '';
1205 $new_provider_name =~ s/[\r\n]//g;
1206 $new_provider_name =~ s/^\s+$//g;
1207 $new_provider_name =~ s/\'/\\'/g;
1209 return $new_provider_name;
1212 ####################################################################################
1216 print "The domain name is the suffix at the end of all email addresses. If\n";
1217 print "for example, your email address is jdoe\@example.com, then your domain\n";
1218 print "would be example.com.\n";
1220 print "[$WHT$domain$NRM]: $WHT";
1221 $new_domain = <STDIN
>;
1222 if ( $new_domain eq "\n" ) {
1223 $new_domain = $domain;
1225 $new_domain =~ s/\s//g;
1232 print "This is the hostname where your IMAP server can be contacted.\n";
1233 print "[$WHT$imapServerAddress$NRM]: $WHT";
1234 $new_imapServerAddress = <STDIN
>;
1235 if ( $new_imapServerAddress eq "\n" ) {
1236 $new_imapServerAddress = $imapServerAddress;
1238 $new_imapServerAddress =~ s/[\r\n]//g;
1240 return $new_imapServerAddress;
1245 print "This is the port that your IMAP server is on. Usually this is 143.\n";
1246 print "[$WHT$imapPort$NRM]: $WHT";
1247 $new_imapPort = <STDIN
>;
1248 if ( $new_imapPort eq "\n" ) {
1249 $new_imapPort = $imapPort;
1251 $new_imapPort =~ s/[\r\n]//g;
1253 return $new_imapPort;
1258 print "You now need to choose the method that you will use for sending\n";
1259 print "messages in SquirrelMail. You can either connect to an SMTP server\n";
1260 print "or use sendmail directly.\n";
1261 if ( lc($useSendmail) eq 'true' ) {
1262 $default_value = "1";
1264 $default_value = "2";
1267 print " 1. Sendmail\n";
1269 print "Your choice [1/2] [$WHT$default_value$NRM]: $WHT";
1270 $use_sendmail = <STDIN
>;
1271 if ( ( $use_sendmail =~ /^1\n/i )
1272 || ( ( $use_sendmail =~ /^\n/ ) && ( $default_value eq "1" ) ) ) {
1273 $useSendmail = 'true';
1275 $useSendmail = 'false';
1277 return $useSendmail;
1282 print "Specify where the sendmail executable is located. Usually /usr/sbin/sendmail\n";
1283 print "[$WHT$sendmail_path$NRM]: $WHT";
1284 $new_sendmail_path = <STDIN
>;
1285 if ( $new_sendmail_path eq "\n" ) {
1286 $new_sendmail_path = $sendmail_path;
1288 $new_sendmail_path =~ s/[\r\n]//g;
1290 return $new_sendmail_path;
1293 # Extra sendmail arguments
1294 sub command_sendmail_args
{
1295 print "Specify additional sendmail program arguments.\n";
1297 print "Make sure that arguments are supported by your sendmail program. -f argument \n";
1298 print "is added automatically by SquirrelMail scripts. Variable defaults to standard\n";
1299 print "/usr/sbin/sendmail arguments. If you use qmail-inject, nbsmtp or any other \n";
1300 print "sendmail wrapper, which does not support -i and -t arguments, set variable to\n";
1301 print "empty string or use arguments suitable for your mailer.\n";
1303 print "[$WHT$sendmail_args$NRM]: $WHT";
1304 $new_sendmail_args = <STDIN
>;
1305 if ( $new_sendmail_args eq "\n" ) {
1306 $new_sendmail_args = $sendmail_args;
1308 # strip linefeeds and crs.
1309 $new_sendmail_args =~ s/[\r\n]//g;
1311 return trim
($new_sendmail_args);
1316 print "This is the hostname of your SMTP server.\n";
1317 print "[$WHT$smtpServerAddress$NRM]: $WHT";
1318 $new_smtpServerAddress = <STDIN
>;
1319 if ( $new_smtpServerAddress eq "\n" ) {
1320 $new_smtpServerAddress = $smtpServerAddress;
1322 $new_smtpServerAddress =~ s/[\r\n]//g;
1324 return $new_smtpServerAddress;
1329 print "This is the port to connect to for SMTP. Usually 25.\n";
1330 print "[$WHT$smtpPort$NRM]: $WHT";
1331 $new_smtpPort = <STDIN
>;
1332 if ( $new_smtpPort eq "\n" ) {
1333 $new_smtpPort = $smtpPort;
1335 $new_smtpPort =~ s/[\r\n]//g;
1337 return $new_smtpPort;
1342 print "Do you wish to use POP3 before SMTP? Your server must\n";
1343 print "support this in order for SquirrelMail to work with it.\n";
1346 $YesNo = 'y' if ( lc($pop_before_smtp) eq 'true' );
1348 print "Use POP before SMTP (y/n) [$WHT$YesNo$NRM]: $WHT";
1350 $new_pop_before_smtp = <STDIN
>;
1351 $new_pop_before_smtp =~ tr/yn//cd;
1352 if ( $new_pop_before_smtp eq "y" ) {
1353 $new_pop_before_smtp = "true";
1354 } elsif ( $new_pop_before_smtp eq "n" ) {
1355 $new_pop_before_smtp = "false";
1357 $new_pop_before_smtp = $pop_before_smtp;
1360 # if using POP before SMTP, allow setting of custom POP server address
1361 if ($new_pop_before_smtp eq "true") {
1362 print "$NRM\nIf the address of the POP server is not the same as\n";
1363 print "your SMTP server, you may specify it here. Leave blank (to\n";
1364 print "clear this, enter only spaces) to use the same address as\n";
1365 print "your SMTP server.\n";
1366 print "POP before SMTP server address [$WHT$pop_before_smtp_host$NRM]: $WHT";
1368 $new_pop_before_smtp_host = <STDIN
>;
1369 if ( $new_pop_before_smtp_host eq "\n" ) {
1370 $new_pop_before_smtp_host = $pop_before_smtp_host;
1371 } elsif ($new_pop_before_smtp_host =~ /^\s+$/) {
1372 $new_pop_before_smtp_host = '';
1374 $new_pop_before_smtp_host =~ s/[\r|\n]//g;
1376 $pop_before_smtp_host = $new_pop_before_smtp_host;
1379 return $new_pop_before_smtp;
1384 print "Each IMAP server has its own quirks. As much as we tried to stick\n";
1385 print "to standards, it doesn't help much if the IMAP server doesn't follow\n";
1386 print "the same principles. We have made some work-arounds for some of\n";
1387 print "these servers. If you would like to use them, please select your\n";
1388 print "IMAP server. If you do not wish to use these work-arounds, you can\n";
1389 print "set this to \"other\", and none will be used.\n";
1390 print $list_supported_imap_servers;
1392 print " other = Not one of the above servers\n";
1394 print "[$WHT$imap_server_type$NRM]: $WHT";
1395 $new_imap_server_type = <STDIN
>;
1397 if ( $new_imap_server_type eq "\n" ) {
1398 $new_imap_server_type = $imap_server_type;
1400 $new_imap_server_type =~ s/[\r\n]//g;
1402 return $new_imap_server_type;
1407 print "Sometimes the date of messages sent is messed up (off by a few hours\n";
1408 print "on some machines). Typically this happens if the system doesn't support\n";
1409 print "tm_gmtoff. It will happen only if your time zone is \"negative\".\n";
1410 print "This most often occurs on Solaris 7 machines in the United States.\n";
1411 print "By default, this is off. It should be kept off unless problems surface\n";
1412 print "about the time that messages are sent.\n";
1413 print " no = Do NOT fix time -- almost always correct\n";
1414 print " yes = Fix the time for this system\n";
1417 $YesNo = 'y' if ( lc($invert_time) eq 'true' );
1419 print "Fix the time for this system (y/n) [$WHT$YesNo$NRM]: $WHT";
1421 $new_invert_time = <STDIN
>;
1422 $new_invert_time =~ tr/yn//cd;
1423 return 'true' if ( $new_invert_time eq "y" );
1424 return 'false' if ( $new_invert_time eq "n" );
1425 return $invert_time;
1429 print "This is the delimiter that your IMAP server uses to distinguish between\n";
1430 print "folders. For example, Cyrus uses '.' as the delimiter and a complete\n";
1431 print "folder would look like 'INBOX.Friends.Bob', while UW uses '/' and would\n";
1432 print "look like 'INBOX/Friends/Bob'. Normally this should be left at 'detect'\n";
1433 print "but if you are sure you know what delimiter your server uses, you can\n";
1434 print "specify it here.\n";
1435 print "\nTo have it autodetect the delimiter, set it to 'detect'.\n\n";
1436 print "[$WHT$optional_delimiter$NRM]: $WHT";
1437 $new_optional_delimiter = <STDIN
>;
1439 if ( $new_optional_delimiter eq "\n" ) {
1440 $new_optional_delimiter = $optional_delimiter;
1442 $new_optional_delimiter =~ s/[\r\n]//g;
1444 return $new_optional_delimiter;
1446 # IMAP authentication type
1447 # Possible values: login, plain, cram-md5, digest-md5
1448 # Now offers to detect supported mechs, assuming server & port are set correctly
1451 if ($use_imap_tls ne "0") {
1452 # 1. Script does not handle TLS.
1453 # 2. Server does not have to declare all supported authentication mechs when
1454 # STARTTLS is used. Supported mechs are declared only after STARTTLS.
1455 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1457 print "If you have already set the hostname and port number, I can try to\n";
1458 print "detect the mechanisms your IMAP server supports.\n";
1459 print "I will try to detect CRAM-MD5 and DIGEST-MD5 support. I can't test\n";
1460 print "for \"login\" or \"plain\" without knowing a username and password.\n";
1461 print "Auto-detecting is optional - you can safely say \"n\" here.\n";
1462 print "\nTry to detect supported mechanisms? [y/N]: ";
1465 if ($inval =~ /^y\b/i) {
1466 # Yes, let's try to detect.
1467 print "Trying to detect IMAP capabilities...\n";
1468 my $host = $imapServerAddress . ':'. $imapPort;
1469 print "CRAM-MD5:\t";
1470 my $tmp = detect_auth_support
('IMAP',$host,'CRAM-MD5');
1471 if (defined($tmp)) {
1472 if ($tmp eq 'YES') {
1473 print "$WHT SUPPORTED$NRM\n";
1475 print "$WHT NOT SUPPORTED$NRM\n";
1478 print $WHT . " ERROR DETECTING$NRM\n";
1481 print "DIGEST-MD5:\t";
1482 $tmp = detect_auth_support
('IMAP',$host,'DIGEST-MD5');
1483 if (defined($tmp)) {
1484 if ($tmp eq 'YES') {
1485 print "$WHT SUPPORTED$NRM\n";
1487 print "$WHT NOT SUPPORTED$NRM\n";
1490 print $WHT . " ERROR DETECTING$NRM\n";
1495 print "\nWhat authentication mechanism do you want to use for IMAP connections?\n\n";
1496 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1497 print $WHT . "plain" . $NRM . " - SASL PLAIN. If you need this, you already know it.\n";
1498 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext methods.\n";
1499 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1500 print "\n*** YOUR IMAP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n";
1501 print "If you don't understand or are unsure, you probably want \"login\"\n\n";
1502 print "login, plain, cram-md5, or digest-md5 [$WHT$imap_auth_mech$NRM]: $WHT";
1505 if ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) || ($inval =~ /^login\b/i) || ($inval =~ /^plain\b/i)) {
1508 # user entered garbage or default value so nothing needs to be set
1509 return $imap_auth_mech;
1514 # SMTP authentication type
1515 # Possible choices: none, plain, cram-md5, digest-md5
1517 if ($use_smtp_tls ne "0") {
1518 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1519 } elsif (eval ("use IO::Socket; 1")) {
1520 # try loading IO::Socket module
1521 print "If you have already set the hostname and port number, I can try to\n";
1522 print "automatically detect some of the mechanisms your SMTP server supports.\n";
1523 print "Auto-detection is *optional* - you can safely say \"n\" here.\n";
1524 print "\nTry to detect auth mechanisms? [y/N]: ";
1527 if ($inval =~ /^y\b/i) {
1528 # Yes, let's try to detect.
1529 print "Trying to detect supported methods (SMTP)...\n";
1532 # Check none by trying to relay to junk@microsoft.com
1533 $host = $smtpServerAddress . ':' . $smtpPort;
1534 my $sock = IO
::Socket
::INET
->new($host);
1535 print "Testing none:\t\t$WHT";
1536 if (!defined($sock)) {
1537 print " ERROR TESTING\n";
1540 $got = <$sock>; # Discard greeting
1541 print $sock "HELO $domain\r\n";
1542 $got = <$sock>; # Discard
1543 print $sock "MAIL FROM:<tester\@squirrelmail.org>\r\n";
1544 $got = <$sock>; # Discard
1545 print $sock "RCPT TO:<junk\@microsoft.com\r\n";
1546 $got = <$sock>; # This is the important line
1547 if ($got =~ /^250\b/) { # SMTP will relay without auth
1548 print "SUPPORTED$NRM\n";
1550 print "NOT SUPPORTED$NRM\n";
1552 print $sock "RSET\r\n";
1553 print $sock "QUIT\r\n";
1556 # Try login (SquirrelMail default)
1557 print "Testing login:\t\t";
1558 $tmp=detect_auth_support
('SMTP',$host,'LOGIN');
1559 if (defined($tmp)) {
1560 if ($tmp eq 'YES') {
1561 print $WHT . "SUPPORTED$NRM\n";
1563 print $WHT . "NOT SUPPORTED$NRM\n";
1566 print $WHT . "ERROR DETECTING$NRM\n";
1570 print "Testing CRAM-MD5:\t";
1571 $tmp=detect_auth_support
('SMTP',$host,'CRAM-MD5');
1572 if (defined($tmp)) {
1573 if ($tmp eq 'YES') {
1574 print $WHT . "SUPPORTED$NRM\n";
1576 print $WHT . "NOT SUPPORTED$NRM\n";
1579 print $WHT . "ERROR DETECTING$NRM\n";
1583 print "Testing DIGEST-MD5:\t";
1584 $tmp=detect_auth_support
('SMTP',$host,'DIGEST-MD5');
1585 if (defined($tmp)) {
1586 if ($tmp eq 'YES') {
1587 print $WHT . "SUPPORTED$NRM\n";
1589 print $WHT . "NOT SUPPORTED$NRM\n";
1592 print $WHT . "ERROR DETECTING$NRM\n";
1596 print "\nWhat authentication mechanism do you want to use for SMTP connections?\n";
1597 print $WHT . "none" . $NRM . " - Your SMTP server does not require authorization.\n";
1598 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1599 print $WHT . "plain" . $NRM . " - SASL PLAIN. You already know it if you need this.\n";
1600 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext.\n";
1601 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1602 print $WHT . "\n*** YOUR SMTP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n" . $NRM;
1603 print "If you don't understand or are unsure, you probably want \"none\"\n\n";
1604 print "none, login, cram-md5, or digest-md5 [$WHT$smtp_auth_mech$NRM]: $WHT";
1607 if ($inval =~ /^none\b/i) {
1608 # remove sitewide smtp authentication information
1609 $smtp_sitewide_user = '';
1610 $smtp_sitewide_pass = '';
1611 # SMTP doesn't necessarily require logins
1613 } elsif ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) ||
1614 ($inval =~ /^login\b/i) || ($inval =~/^plain\b/i)) {
1615 command_smtp_sitewide_userpass
($inval);
1617 } elsif (trim
($inval) eq '') {
1618 # user selected default value
1619 command_smtp_sitewide_userpass
($smtp_auth_mech);
1620 return $smtp_auth_mech;
1622 # user entered garbage
1623 return $smtp_auth_mech;
1627 sub command_smtp_sitewide_userpass
($) {
1628 # get first function argument
1629 my $auth_mech = shift(@_);
1631 $auth_mech = lc(trim
($auth_mech));
1632 if ($auth_mech eq 'none') {
1635 print "SMTP authentication uses IMAP username and password by default.\n";
1637 print "Would you like to use other login and password for all SquirrelMail \n";
1638 print "SMTP connections?";
1639 if ($smtp_sitewide_user ne '') {
1656 $smtp_sitewide_user = '';
1657 $smtp_sitewide_pass = '';
1658 } elsif ($tmp eq 'y') {
1659 print "Enter username [$smtp_sitewide_user]:";
1660 my $new_user = <STDIN
>;
1661 $new_user = trim
($new_user);
1662 if ($new_user ne '') {
1663 $smtp_sitewide_user = $new_user;
1665 if ($smtp_sitewide_user ne '') {
1666 print "If you don't enter any password, current sitewide password will be used.\n";
1667 print "If you enter space, password will be set to empty string.\n";
1668 print "Enter password:";
1669 my $new_pass = <STDIN
>;
1670 if ($new_pass ne "\n") {
1671 $smtp_sitewide_pass = trim
($new_pass);
1674 print "Invalid input. You must set username used for SMTP authentication.\n";
1675 print "Click enter to continue\n";
1679 print "Invalid input\n";
1680 print "Click enter to continue\n";
1685 # Sub adds information about SMTP authentication type to menu
1686 sub display_smtp_sitewide_userpass
() {
1688 if ($smtp_auth_mech ne 'none') {
1689 if ($smtp_sitewide_user ne '') {
1690 $ret = ' (with custom username and password)';
1692 $ret = ' (with IMAP username and password)';
1699 # This sub is reused for IMAP and SMTP
1700 # Args: service name, default value
1701 sub command_use_tls
{
1702 my($default_val,$service,$inval);
1705 print "TLS (Transport Layer Security) encrypts the traffic between server and client.\n";
1706 print "STARTTLS extensions allow to start encryption on existing plain text connection.\n";
1707 print "These options add specific PHP and IMAP server configuration requirements.\n";
1708 print "See SquirrelMail documentation about connection security.\n";
1710 print "If your " . $service . " server is localhost, you can safely disable this.\n";
1711 print "If it is remote, you may wish to seriously consider enabling this.\n";
1713 while ($valid_input eq 0) {
1714 print "\nSelect connection security model:\n";
1715 print " 0 - Use plain text connection\n";
1716 print " 1 - Use TLS connection\n";
1717 print " 2 - Use STARTTLS extension\n";
1718 print "Select [$default_val]: ";
1720 $inval=trim
($inval);
1721 if ($inval =~ /^[012]$/ || $inval eq '') {
1725 if ($inval ne '') {$default_val = $inval};
1726 return $default_val;
1729 # This sub is used to display human readable text for
1730 # $use_imap_tls and $use_smtp_tls values in conf.pl menu
1731 sub display_use_tls
($) {
1732 my $val = shift(@_);
1733 my $ret = 'disabled';
1736 } elsif ($val eq '1') {
1742 # $encode_header_key
1744 print "Encryption key allows to hide SquirrelMail Received: headers\n";
1745 print "in outbound messages. Interface uses encryption key to encode\n";
1746 print "username, remote address and proxied address, then stores encoded\n";
1747 print "information in X-Squirrel-* headers.\n";
1749 print "Warning: used encryption function is not bulletproof. When used\n";
1750 print "with static encryption keys, it provides only minimal security\n";
1751 print "measures and information can be decoded quickly.\n";
1753 print "Encoded information can be decoded with decrypt_headers.php script\n";
1754 print "from SquirrelMail contrib/ directory.\n";
1756 print "Enter encryption key: ";
1757 $new_encode_header_key = <STDIN
>;
1758 if ( $new_encode_header_key eq "\n" ) {
1759 $new_encode_header_key = $encode_header_key;
1761 $new_encode_header_key =~ s/[\r\n]//g;
1763 return $new_encode_header_key;
1768 print "\nYou can now create the welcome message that is displayed\n";
1769 print "every time a user logs on. You can use HTML or just plain\n";
1771 "text. If you do not wish to have one, just make it blank.\n\n(Type @ on a blank line to exit)\n";
1777 $line =~ s/[\r\n]//g;
1778 if ( $line ne "@" ) {
1779 $line =~ s/ /\ \ /g;
1780 $line =~ s/\t/\ \ \ \ /g;
1782 $line =~ s/\"/\\\"/g;
1784 $new_motd = $new_motd . $line;
1786 } while ( $line ne "@" );
1790 ################# PLUGINS ###################
1793 $command =~ s/[\s\n\r]*//g;
1794 if ( $command > 0 ) {
1795 $command = $command - 1;
1796 if ( $command <= $#plugins ) {
1799 while ( $ct <= $#plugins ) {
1800 if ( $ct != $command ) {
1801 @newplugins = ( @newplugins, $plugins[$ct] );
1805 @plugins = @newplugins;
1806 } elsif ( $command <= $#plugins + $#unused_plugins + 1 ) {
1807 $num = $command - $#plugins - 1;
1808 @newplugins = @plugins;
1810 while ( $ct <= $#unused_plugins ) {
1811 if ( $ct == $num ) {
1812 @newplugins = ( @newplugins, $unused_plugins[$ct] );
1816 @plugins = @newplugins;
1822 # disable_plugins_user
1824 print "When all active plugins are disabled, they can be disabled only\n";
1825 print "for the one user named here. If left blank, plugins will be\n";
1826 print "disabled for ALL users. This setting has no effect if plugins\n";
1827 print "are not disabled.\n";
1829 print "This must be the exact IMAP login name for the desired user.\n";
1831 print "[$WHT$disable_plugins_user$NRM]: $WHT";
1832 $new_disable_plugins_user = <STDIN
>;
1833 if ( $new_disable_plugins_user eq "\n" ) {
1834 $new_disable_plugins_user = $disable_plugins_user;
1836 $new_disable_plugins_user =~ s/[\r\n]//g;
1838 return $new_disable_plugins_user;
1841 ################# FOLDERS ###################
1843 # default_folder_prefix
1845 print "Some IMAP servers (UW, for example) store mail and folders in\n";
1846 print "your user space in a separate subdirectory. This is where you\n";
1847 print "specify what that directory is.\n";
1849 print "EXAMPLE: mail/";
1851 print "NOTE: If you use Cyrus, or some server that would not use this\n";
1852 print " option, you must set this to 'none'.\n";
1854 print "[$WHT$default_folder_prefix$NRM]: $WHT";
1855 $new_default_folder_prefix = <STDIN
>;
1857 if ( $new_default_folder_prefix eq "\n" ) {
1858 $new_default_folder_prefix = $default_folder_prefix;
1860 $new_default_folder_prefix =~ s/[\r\n]//g;
1862 if ( ( $new_default_folder_prefix =~ /^\s*$/ ) || ( $new_default_folder_prefix =~ m/^none$/i ) ) {
1863 $new_default_folder_prefix = "";
1865 # add the trailing delimiter only if we know what the server is.
1866 if (($imap_server_type eq 'cyrus' and
1867 $optional_delimiter eq 'detect') or
1868 ($imap_server_type eq 'courier' and
1869 $optional_delimiter eq 'detect')) {
1870 $new_default_folder_prefix =~ s/\.*$/\./;
1871 } elsif ($imap_server_type eq 'uw' and
1872 $optional_delimiter eq 'detect') {
1873 $new_default_folder_prefix =~ s/\/*$/\
//;
1876 return $new_default_folder_prefix;
1879 # Show Folder Prefix
1881 print "It is possible to set up the default folder prefix as a user\n";
1882 print "specific option, where each user can specify what their mail\n";
1883 print "folder is. If you set this to false, they will never see the\n";
1884 print "option, but if it is true, this option will appear in the\n";
1885 print "'options' section.\n";
1887 print "NOTE: You set the default folder prefix in option '1' of this\n";
1888 print " section. That will be the default if the user doesn't\n";
1889 print " specify anything different.\n";
1892 if ( lc($show_prefix_option) eq 'true' ) {
1893 $default_value = "y";
1895 $default_value = "n";
1898 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
1899 $new_show = <STDIN
>;
1900 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1901 $show_prefix_option = 'true';
1903 $show_prefix_option = 'false';
1905 return $show_prefix_option;
1910 print "You can now specify where the default trash folder is located.\n";
1911 print "On servers where you do not want this, you can set it to anything\n";
1912 print "and set option 6 to false.\n";
1914 print "This is relative to where the rest of your email is kept. You do\n";
1915 print "not need to worry about their mail directory. If this folder\n";
1916 print "would be ~/mail/trash on the filesystem, you only need to specify\n";
1917 print "that this is 'trash', and be sure to put 'mail/' in option 1.\n";
1920 print "[$WHT$trash_folder$NRM]: $WHT";
1921 $new_trash_folder = <STDIN
>;
1922 if ( $new_trash_folder eq "\n" ) {
1923 $new_trash_folder = $trash_folder;
1925 if (check_imap_folder
($new_trash_folder)) {
1926 $new_trash_folder =~ s/[\r\n]//g;
1928 $new_trash_folder = $trash_folder;
1931 return $new_trash_folder;
1936 print "This is where messages that are sent will be stored. SquirrelMail\n";
1937 print "by default puts a copy of all outgoing messages in this folder.\n";
1939 print "This is relative to where the rest of your email is kept. You do\n";
1940 print "not need to worry about their mail directory. If this folder\n";
1941 print "would be ~/mail/sent on the filesystem, you only need to specify\n";
1942 print "that this is 'sent', and be sure to put 'mail/' in option 1.\n";
1945 print "[$WHT$sent_folder$NRM]: $WHT";
1946 $new_sent_folder = <STDIN
>;
1947 if ( $new_sent_folder eq "\n" ) {
1948 $new_sent_folder = $sent_folder;
1950 if (check_imap_folder
($new_sent_folder)) {
1951 $new_sent_folder =~ s/[\r\n]//g;
1953 $new_sent_folder = $sent_folder;
1956 return $new_sent_folder;
1961 print "You can now specify where the default draft folder is located.\n";
1962 print "On servers where you do not want this, you can set it to anything\n";
1963 print "and set option 9 to false.\n";
1965 print "This is relative to where the rest of your email is kept. You do\n";
1966 print "not need to worry about their mail directory. If this folder\n";
1967 print "would be ~/mail/drafts on the filesystem, you only need to specify\n";
1968 print "that this is 'drafts', and be sure to put 'mail/' in option 1.\n";
1971 print "[$WHT$draft_folder$NRM]: $WHT";
1972 $new_draft_folder = <STDIN
>;
1973 if ( $new_draft_folder eq "\n" ) {
1974 $new_draft_folder = $draft_folder;
1976 if (check_imap_folder
($new_draft_folder)) {
1977 $new_draft_folder =~ s/[\r\n]//g;
1979 $new_draft_folder = $draft_folder;
1982 return $new_draft_folder;
1985 # default move to trash
1987 print "By default, should messages get moved to the trash folder? You\n";
1988 print "can specify the default trash folder in option 3. If this is set\n";
1989 print "to false, messages will get deleted immediately without moving\n";
1990 print "to the trash folder.\n";
1992 print "Trash folder is currently: $trash_folder\n";
1995 if ( lc($default_move_to_trash) eq 'true' ) {
1996 $default_value = "y";
1998 $default_value = "n";
2000 print "By default, move to trash (y/n) [$WHT$default_value$NRM]: $WHT";
2001 $new_show = <STDIN
>;
2002 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2003 $default_move_to_trash = 'true';
2005 $default_move_to_trash = 'false';
2007 return $default_move_to_trash;
2010 # default move to sent (save sent messages)
2012 print "By default, should copies of outgoing messages get saved in the\n";
2013 print "sent folder? You can specify the default sent folder in option 4.\n";
2014 print "If this is set to false, messages will get sent and no copy will\n";
2017 print "Sent folder is currently: $sent_folder\n";
2020 if ( lc($default_move_to_sent) eq 'true' ) {
2021 $default_value = "y";
2023 $default_value = "n";
2025 print "By default, save sent messages (y/n) [$WHT$default_value$NRM]: $WHT";
2026 $new_show = <STDIN
>;
2027 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2028 $default_move_to_sent = 'true';
2030 $default_move_to_sent = 'false';
2032 return $default_move_to_sent;
2035 # default save as draft
2037 print "By default, should the save to draft option be shown? You can\n";
2038 print "specify the default drafts folder in option 5. If this is set\n";
2039 print "to false, users will not be shown the save to draft option.\n";
2041 print "Drafts folder is currently: $draft_folder\n";
2044 if ( lc($default_save_as_draft) eq 'true' ) {
2045 $default_value = "y";
2047 $default_value = "n";
2049 print "By default, save as draft (y/n) [$WHT$default_value$NRM]: $WHT";
2050 $new_show = <STDIN
>;
2051 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2052 $default_save_as_draft = 'true';
2054 $default_save_as_draft = 'false';
2056 return $default_save_as_draft;
2059 # List special folders first
2061 print "SquirrelMail has what we call 'special folders' that are not\n";
2062 print "manipulated and viewed like normal folders. Some examples of\n";
2063 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
2064 print "Simply asks if you want these folders listed first in the folder\n";
2068 if ( lc($list_special_folders_first) eq 'true' ) {
2069 $default_value = "y";
2071 $default_value = "n";
2074 print "List first (y/n) [$WHT$default_value$NRM]: $WHT";
2075 $new_show = <STDIN
>;
2076 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2077 $list_special_folders_first = 'true';
2079 $list_special_folders_first = 'false';
2081 return $list_special_folders_first;
2084 # Show special folders color
2086 print "SquirrelMail has what we call 'special folders' that are not\n";
2087 print "manipulated and viewed like normal folders. Some examples of\n";
2088 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
2089 print "wants to know if we should display special folders in a\n";
2090 print "color than the other folders.\n";
2093 if ( lc($use_special_folder_color) eq 'true' ) {
2094 $default_value = "y";
2096 $default_value = "n";
2099 print "Show color (y/n) [$WHT$default_value$NRM]: $WHT";
2100 $new_show = <STDIN
>;
2101 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2102 $use_special_folder_color = 'true';
2104 $use_special_folder_color = 'false';
2106 return $use_special_folder_color;
2111 print "The way that IMAP handles deleting messages is as follows. You\n";
2112 print "mark the message as deleted, and then to 'really' delete it, you\n";
2113 print "expunge it. This option asks if you want to just have messages\n";
2114 print "marked as deleted, or if you want SquirrelMail to expunge the \n";
2115 print "messages too.\n";
2118 if ( lc($auto_expunge) eq 'true' ) {
2119 $default_value = "y";
2121 $default_value = "n";
2123 print "Auto expunge (y/n) [$WHT$default_value$NRM]: $WHT";
2124 $new_show = <STDIN
>;
2125 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2126 $auto_expunge = 'true';
2128 $auto_expunge = 'false';
2130 return $auto_expunge;
2133 # Default sub of inbox
2135 print "Some IMAP servers (Cyrus) have all folders as subfolders of INBOX.\n";
2136 print "This can cause some confusion in folder creation for users when\n";
2137 print "they try to create folders and don't put it as a subfolder of INBOX\n";
2138 print "and get permission errors. This option asks if you want folders\n";
2139 print "to be subfolders of INBOX by default.\n";
2142 if ( lc($default_sub_of_inbox) eq 'true' ) {
2143 $default_value = "y";
2145 $default_value = "n";
2147 print "Default sub of INBOX (y/n) [$WHT$default_value$NRM]: $WHT";
2148 $new_show = <STDIN
>;
2149 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2150 $default_sub_of_inbox = 'true';
2152 $default_sub_of_inbox = 'false';
2154 return $default_sub_of_inbox;
2157 # Show contain subfolder option
2159 print "Some IMAP servers (UW) make it so that there are two types of\n";
2160 print "folders. Those that contain messages, and those that contain\n";
2161 print "subfolders. If this is the case for your server, set this to\n";
2162 print "true, and it will ask the user whether the folder they are\n";
2163 print "creating contains subfolders or messages.\n";
2166 if ( lc($show_contain_subfolders_option) eq 'true' ) {
2167 $default_value = "y";
2169 $default_value = "n";
2171 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
2172 $new_show = <STDIN
>;
2173 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2174 $show_contain_subfolders_option = 'true';
2176 $show_contain_subfolders_option = 'false';
2178 return $show_contain_subfolders_option;
2181 # Default Unseen Notify
2183 print "This option specifies where the users will receive notification\n";
2184 print "about unseen messages by default. This is of course an option that\n";
2185 print "can be changed on a user level.\n";
2186 print " 1 = No notification\n";
2187 print " 2 = Only on the INBOX\n";
2188 print " 3 = On all folders\n";
2191 print "Which one should be default (1,2,3)? [$WHT$default_unseen_notify$NRM]: $WHT";
2192 $new_show = <STDIN
>;
2193 if ( $new_show =~ /^[123]\n/i ) {
2194 $default_unseen_notify = $new_show;
2196 $default_unseen_notify =~ s/[\r\n]//g;
2197 return $default_unseen_notify;
2200 # Default Unseen Type
2202 print "Here you can define the default way that unseen messages will be displayed\n";
2203 print "to the user in the folder listing on the left side.\n";
2204 print " 1 = Only unseen messages (4)\n";
2205 print " 2 = Unseen and Total messages (4/27)\n";
2208 print "Which one should be default (1,2)? [$WHT$default_unseen_type$NRM]: $WHT";
2209 $new_show = <STDIN
>;
2210 if ( $new_show =~ /^[12]\n/i ) {
2211 $default_unseen_type = $new_show;
2213 $default_unseen_type =~ s/[\r\n]//g;
2214 return $default_unseen_type;
2217 # Auto create special folders
2219 print "Would you like the Sent, Trash, and Drafts folders to be created\n";
2220 print "automatically print for you when a user logs in? If the user\n";
2221 print "accidentally deletes their special folders, this option will\n";
2222 print "automatically create it again for them.\n";
2225 if ( lc($auto_create_special) eq 'true' ) {
2226 $default_value = "y";
2228 $default_value = "n";
2230 print "Auto create special folders? (y/n) [$WHT$default_value$NRM]: $WHT";
2231 $new_show = <STDIN
>;
2232 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2233 $auto_create_special = 'true';
2235 $auto_create_special = 'false';
2237 return $auto_create_special;
2240 # Automatically delete folders
2242 if ( $imap_server_type eq "uw" ) {
2243 print "UW IMAP servers will not allow folders containing mail to also contain folders.\n";
2244 print "Deleting folders will bypass the trash folder and be immediately deleted\n\n";
2245 print "If this is not the correct value for your server,\n";
2246 print "please use option D on the Main Menu to configure your server correctly.\n\n";
2247 print "Press enter to continue...\n";
2248 $new_delete = <STDIN
>;
2249 $delete_folder = 'true';
2251 if ( $imap_server_type eq "courier" ) {
2252 print "Courier (or Courier-IMAP) IMAP servers may not support ";
2253 print "subfolders of Trash. \n";
2254 print "Specifically, if Courier is set to always move messages to Trash, \n";
2255 print "Trash will be treated by Courier as a special folder that does not \n";
2256 print "allow subfolders. \n\n";
2257 print "Please verify your Courier configuration, and test folder deletion \n";
2258 print "when changing this setting.\n\n";
2261 print "Are subfolders of the Trash supported by your IMAP server?\n";
2262 print "If so, should deleted folders be sent to Trash?\n";
2263 print "If not, say no (deleted folders should not be sent to Trash)\n\n";
2264 # reversal of logic.
2265 # question was: Should folders be automatically deleted instead of sent to trash..
2266 # we've changed the question to make it more clear,
2267 # and are here handling that to avoid changing the answers..
2268 if ( lc($delete_folder) eq 'true' ) {
2269 $default_value = "n";
2271 $default_value = "y";
2273 print "Send deleted folders to Trash? (y/n) [$WHT$default_value$NRM]: $WHT";
2274 $new_delete = <STDIN
>;
2275 if ( ( $new_delete =~ /^y\n/i ) || ( ( $new_delete =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2276 $delete_folder = 'false';
2278 $delete_folder = 'true';
2281 return $delete_folder;
2286 print "Some IMAP servers allow subfolders to exist even if the parent\n";
2287 print "folders do not. This fixes some problems with the folder list\n";
2288 print "when this is the case, causing the /NoSelect folders to be displayed\n";
2291 if ( lc($noselect_fix_enable) eq 'true' ) {
2292 $default_value = "y";
2294 $default_value = "n";
2296 print "enable noselect fix? (y/n) [$WHT$noselect_fix_enable$NRM]: $WHT";
2297 $noselect_fix_enable = <STDIN
>;
2298 if ( ( $noselect_fix_enable =~ /^y\n/i ) || ( ( $noselect_fix_enable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2299 $noselect_fix_enable = 'true';
2301 $noselect_fix_enable = 'false';
2303 return $noselect_fix_enable;
2305 ############# GENERAL OPTIONS #####################
2309 print "Specify the location for your data directory.\n";
2310 print "You need to create this directory yourself.\n";
2311 print "The path name can be absolute or relative (to the config directory).\n";
2312 print "Here are two examples:\n";
2313 print " Absolute: /var/local/squirrelmail/data/\n";
2314 print " Relative: ../data/\n";
2315 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2316 print "will be converted to their absolute path equivalents in config.php.\n\n";
2317 print "Note: There are potential security risks with having a writeable directory\n";
2318 print "under the web server's root directory (ex: /home/httpd/html).\n";
2319 print "For this reason, it is recommended to put the data directory\n";
2320 print "in an alternate location of your choice. \n";
2323 print "[$WHT$data_dir$NRM]: $WHT";
2324 $new_data_dir = <STDIN
>;
2325 if ( $new_data_dir eq "\n" ) {
2326 $new_data_dir = $data_dir;
2328 $new_data_dir =~ s/[\r\n]//g;
2330 if ( $new_data_dir =~ /^\s*$/ ) {
2333 $new_data_dir =~ s/\/*$//g
;
2334 $new_data_dir =~ s/$/\//g
;
2336 return $new_data_dir;
2339 # Attachment directory
2341 print "Path to directory used for storing attachments while a mail is\n";
2342 print "being composed. The path name can be absolute or relative (to the\n";
2343 print "config directory). Here are two examples:\n";
2344 print " Absolute: /var/local/squirrelmail/attach/\n";
2345 print " Relative: ../attach/\n";
2346 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2347 print "will be converted to their absolute path equivalents in config.php.\n\n";
2348 print "Note: There are a few security considerations regarding this\n";
2349 print "directory:\n";
2350 print " 1. It should have the permission 733 (rwx-wx-wx) to make it\n";
2351 print " impossible for a random person with access to the webserver\n";
2352 print " to list files in this directory. Confidential data might\n";
2353 print " be laying around in there.\n";
2354 print " Depending on your user:group assignments, 730 (rwx-wx---)\n";
2355 print " may be possible, and more secure (e.g. root:apache)\n";
2356 print " 2. Since the webserver is not able to list the files in the\n";
2357 print " content is also impossible for the webserver to delete files\n";
2358 print " lying around there for too long.\n";
2359 print " 3. It should probably be another directory than the data\n";
2360 print " directory specified in option 3.\n";
2363 print "[$WHT$attachment_dir$NRM]: $WHT";
2364 $new_attachment_dir = <STDIN
>;
2365 if ( $new_attachment_dir eq "\n" ) {
2366 $new_attachment_dir = $attachment_dir;
2368 $new_attachment_dir =~ s/[\r\n]//g;
2370 if ( $new_attachment_dir =~ /^\s*$/ ) {
2371 $new_attachment_dir = "";
2373 $new_attachment_dir =~ s/\/*$//g
;
2374 $new_attachment_dir =~ s/$/\//g
;
2376 return $new_attachment_dir;
2380 print "The directory hash level setting allows you to configure the level\n";
2381 print "of hashing that SquirrelMail employs in your data and attachment\n";
2382 print "directories. This value must be an integer ranging from 0 to 4.\n";
2383 print "When this value is set to 0, SquirrelMail will simply store all\n";
2384 print "files as normal in the data and attachment directories. However,\n";
2385 print "when set to a value from 1 to 4, a simple hashing scheme will be\n";
2386 print "used to organize the files in this directory. In short, the crc32\n";
2387 print "value for a username will be computed. Then, up to the first 4\n";
2388 print "digits of the hash, as set by this configuration value, will be\n";
2389 print "used to directory hash the files for that user in the data and\n";
2390 print "attachment directory. This allows for better performance on\n";
2391 print "servers with larger numbers of users.\n";
2394 print "[$WHT$dir_hash_level$NRM]: $WHT";
2395 $new_dir_hash_level = <STDIN
>;
2396 if ( $new_dir_hash_level eq "\n" ) {
2397 $new_dir_hash_level = $dir_hash_level;
2399 $new_dir_hash_level =~ s/[\r\n]//g;
2401 if ( ( int($new_dir_hash_level) < 0 )
2402 || ( int($new_dir_hash_level) > 4 )
2403 || !( int($new_dir_hash_level) eq $new_dir_hash_level ) ) {
2404 print "Invalid Directory Hash Level.\n";
2405 print "Value must be an integer ranging from 0 to 4\n";
2406 print "Hit enter to continue.\n";
2407 $enter_key = <STDIN
>;
2409 $new_dir_hash_level = $dir_hash_level;
2412 return $new_dir_hash_level;
2416 print "This is the default size (in pixels) of the left folder list.\n";
2417 print "Default is 200, but you can set it to whatever you wish. This\n";
2418 print "is a user preference, so this will only show up as their default.\n";
2420 print "[$WHT$default_left_size$NRM]: $WHT";
2421 $new_default_left_size = <STDIN
>;
2422 if ( $new_default_left_size eq "\n" ) {
2423 $new_default_left_size = $default_left_size;
2425 $new_default_left_size =~ s/[\r\n]//g;
2427 return $new_default_left_size;
2431 print "Some IMAP servers only have lowercase letters in the usernames\n";
2432 print "but they still allow people with uppercase to log in. This\n";
2433 print "causes a problem with the user's preference files. This option\n";
2434 print "transparently changes all usernames to lowercase.";
2437 if ( lc($force_username_lowercase) eq 'true' ) {
2438 $default_value = "y";
2440 $default_value = "n";
2442 print "Convert usernames to lowercase (y/n) [$WHT$default_value$NRM]: $WHT";
2443 $new_show = <STDIN
>;
2444 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2454 if ( lc($default_use_priority) eq 'true' ) {
2455 $default_value = "y";
2457 $default_value = "n";
2460 print "Allow users to specify priority of outgoing mail (y/n) [$WHT$default_value$NRM]: $WHT";
2461 $new_show = <STDIN
>;
2462 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2472 if ( lc($hide_sm_attributions) eq 'true' ) {
2473 $default_value = "y";
2475 $default_value = "n";
2478 print "Hide SM attributions (y/n) [$WHT$default_value$NRM]: $WHT";
2479 $new_show = <STDIN
>;
2480 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2490 if ( lc($default_use_mdn) eq 'true' ) {
2491 $default_value = "y";
2493 $default_value = "n";
2496 print "Enable support for read/delivery receipt support (y/n) [$WHT$default_value$NRM]: $WHT";
2497 $new_show = <STDIN
>;
2498 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2506 print " In loosely managed environments, you may want to allow users
2507 to edit their full name and email address. In strictly managed
2508 environments, you may want to force users to use the name
2509 and email address assigned to them.
2511 'y' - allow a user to edit their full name and email address,
2512 'n' - users must use the assigned values.
2516 if ( lc($edit_identity) eq 'true' ) {
2517 $default_value = "y";
2519 $default_value = "n";
2521 print "Allow editing of user's identity? (y/n) [$WHT$default_value$NRM]: $WHT";
2522 $new_edit = <STDIN
>;
2523 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2524 $edit_identity = 'true';
2525 $edit_name = 'true';
2526 $hide_auth_header = command311b
();
2528 $edit_identity = 'false';
2529 $edit_name = command311
();
2530 $hide_auth_header = command311b
();
2532 return $edit_identity;
2536 print " Given that users are not allowed to modify their
2537 email address, can they edit their full name?
2541 if ( lc($edit_name) eq 'true' ) {
2542 $default_value = "y";
2544 $default_value = "n";
2546 print "Allow the user to edit their full name? (y/n) [$WHT$default_value$NRM]: $WHT";
2547 $new_edit = <STDIN
>;
2548 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2549 $edit_name = 'true';
2551 $edit_name = 'false';
2557 print " SquirrelMail adds username information to every sent email
2558 in order to prevent possible sender forging when users are allowed
2559 to change their email and/or full name.
2561 You can remove user information from this header (y), if you think that
2562 it violates privacy or security.
2564 Note: If users are allowed to change their email addresses,
2565 this setting will make it difficult to determine who sent what where.
2566 Use at your own risk.
2570 if ( lc($hide_auth_header) eq "true" ) {
2571 $default_value = "y";
2573 $default_value = "n";
2575 print "Remove username from email headers? (y/n) [$WHT$default_value$NRM]: $WHT";
2576 $new_header = <STDIN
>;
2577 if ( ( $new_header =~ /^y\n/i ) || ( ( $new_header =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2578 $hide_auth_header = "true";
2580 $hide_auth_header = "false";
2582 return $hide_auth_header;
2586 print "This option allows you to disable server side thread sorting if your server \n";
2587 print "declares THREAD support, but you don't want to provide threading options \n";
2588 print "to end users or THREAD extension is broken or extension does not work with \n";
2589 print "options used by SquirrelMail. Option is not used, if THREAD extension is \n";
2590 print "not declared in IMAP CAPABILITY.\n";
2593 if ( lc($disable_thread_sort) eq 'true' ) {
2594 $default_value = "y";
2596 $default_value = "n";
2598 print "Disable server side thread sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2599 $disable_thread_sort = <STDIN
>;
2600 if ( ( $disable_thread_sort =~ /^y\n/i ) || ( ( $disable_thread_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2601 $disable_thread_sort = 'true';
2603 $disable_thread_sort = 'false';
2605 return $disable_thread_sort;
2609 print "This option allows you to disable server side sorting if your server declares \n";
2610 print "SORT support, but SORT extension is broken or does not work with options \n";
2611 print "used by SquirrelMail. Option is not used, if SORT extension is not declared \n";
2612 print "in IMAP CAPABILITY.\n";
2614 print "It is strongly recommended to keep server side sorting enabled, if your ";
2615 print "IMAP server supports it.";
2618 if ( lc($disable_server_sort) eq 'true' ) {
2619 $default_value = "y";
2621 $default_value = "n";
2623 print "Disable server-side sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2624 $disable_server_sort = <STDIN
>;
2625 if ( ( $disable_server_sort =~ /^y\n/i ) || ( ( $disable_server_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2626 $disable_server_sort = 'true';
2628 $disable_server_sort = 'false';
2630 return $disable_server_sort;
2634 print "This option allows you to choose if SM uses charset search\n";
2635 print "Your IMAP server must support the SEARCH CHARSET command for this to work\n";
2638 if ( lc($allow_charset_search) eq 'true' ) {
2639 $default_value = "y";
2641 $default_value = "n";
2643 print "Allow charset searching? (y/n) [$WHT$default_value$NRM]: $WHT";
2644 $allow_charset_search = <STDIN
>;
2645 if ( ( $allow_charset_search =~ /^y\n/i ) || ( ( $allow_charset_search =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2646 $allow_charset_search = 'true';
2648 $allow_charset_search = 'false';
2650 return $allow_charset_search;
2653 # command315 (UID support) obsoleted.
2655 # advanced search option
2657 print "This option allows you to control the use of advanced search form.\n";
2658 print " 0 = enable basic search only\n";
2659 print " 1 = enable advanced search only\n";
2660 print " 2 = enable both\n";
2663 print "Allowed search (0,1,2)? [$WHT$allow_advanced_search$NRM]: $WHT";
2664 $new_allow_advanced_search = <STDIN
>;
2665 if ( $new_allow_advanced_search =~ /^[012]\n/i ) {
2666 $allow_advanced_search = $new_allow_advanced_search;
2668 $allow_advanced_search =~ s/[\r\n]//g;
2669 return $allow_advanced_search;
2674 print "This option allows you to change the name of the PHP session used\n";
2675 print "by SquirrelMail. Unless you know what you are doing, you probably\n";
2676 print "don't need or want to change this from the default of SQMSESSID.\n";
2677 print "[$WHT$session_name$NRM]: $WHT";
2678 $new_session_name = <STDIN
>;
2679 chomp($new_session_name);
2680 if ( $new_session_name eq "" ) {
2681 $new_session_name = $session_name;
2683 return $new_session_name;
2686 # time zone config (since 1.5.1)
2688 print "This option allows you to control the use of time zones.\n";
2689 print " 0 = (default) standard, GNU C time zone names\n";
2690 print " 1 = strict, generic time zone codes with offsets\n";
2691 print " 2 = custom, GNU C time zones loaded from config/timezones.php\n";
2692 print " 3 = custom strict, generic time zone codes with offsets loaded \n";
2693 print " from config/timezones.php\n";
2694 print "See SquirrelMail documentation about format of config/timezones.php file.\n";
2697 print "Desired time zone configuration (0,1,2,3)? [$WHT$time_zone_type$NRM]: $WHT";
2698 $new_time_zone_type = <STDIN
>;
2699 if ( $new_time_zone_type =~ /^[0123]\n/i ) {
2700 $time_zone_type = $new_time_zone_type;
2702 print "\nInvalid configuration value.\n";
2703 print "\nPress enter to continue...";
2706 $time_zone_type =~ s/[\r\n]//g;
2707 return $time_zone_type;
2710 # set the location base for redirects (since 1.5.2)
2711 sub command_config_location_base
{
2712 print "Here you can set the base part of the SquirrelMail URL.\n";
2713 print "It is normally autodetected but if that fails, use this\n";
2714 print "option to override.\n";
2715 print "It should contain only the protocol and hostname/port parts\n";
2716 print "of the URL; the full path will be appended automatically.\n\n";
2717 print "Examples:\nhttp://webmail.example.org\nhttp://webmail.example.com:8080\nhttps://webmail.example.com:6691\n\n";
2718 print "Do not add any path elements.\n";
2720 print "URL base? [" .$WHT."autodetect$NRM]: $WHT";
2721 $new_config_location_base = <STDIN
>;
2722 chomp($new_config_location_base);
2723 $config_location_base = $new_config_location_base;
2725 return $config_location_base;
2728 # only_secure_cookies (since 1.5.2)
2730 print "This option allows you to specify that if a user session is initiated\n";
2731 print "under a secure (HTTPS, SSL-encrypted) connection, the cookies given to\n";
2732 print "the browser will ONLY be transmitted via a secure connection henceforth.\n\n";
2733 print "Generally this is a Good Thing, and should NOT be disabled. However,\n";
2734 print "if you intend to use the Secure Login or Show SSL Link plugins to\n";
2735 print "encrypt the user login, but not the rest of the SquirrelMail session,\n";
2736 print "this can be turned off. Think twice before doing so.\n";
2739 if ( lc($only_secure_cookies) eq 'true' ) {
2740 $default_value = "y";
2742 $default_value = "n";
2744 print "Transmit cookies only on secure connection when available? (y/n) [$WHT$default_value$NRM]: $WHT";
2745 $only_secure_cookies = <STDIN
>;
2746 if ( ( $only_secure_cookies =~ /^y\n/i ) || ( ( $only_secure_cookies =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2747 $only_secure_cookies = 'true';
2749 $only_secure_cookies = 'false';
2751 return $only_secure_cookies;
2755 sub command_userThemes
{
2756 print "\nDefine the user themes that you wish to use. If you have added\n";
2757 print "a theme of your own, just follow the instructions (?) about\n";
2758 print "how to add them. You can also change the default theme.\n\n";
2760 print "Available user themes:\n";
2762 while ( $count <= $#user_theme_name ) {
2763 if ( $count == $user_theme_default ) {
2768 if ( $count < 10 ) {
2771 $name = $user_theme_name[$count];
2772 $num_spaces = 35 - length($name);
2773 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2774 $name = $name . " ";
2777 print " $count. $name";
2778 print "($user_theme_path[$count])\n";
2784 print ".------------------------------------.\n";
2785 print "| t (detect user themes) |\n";
2786 print "| + (add user theme) |\n";
2787 print "| - N (remove user theme) |\n";
2788 print "| m N (mark default user theme) |\n";
2789 print "| l (list user themes) |\n";
2790 print "| d (done) |\n";
2791 print "`------------------------------------'\n";
2793 print "\n[user_themes] command (?=help) > ";
2795 $input =~ s/[\r\n]//g;
2796 while ( $input ne "d" ) {
2797 if ( $input =~ /^\s*l\s*/i ) {
2799 while ( $count <= $#user_theme_name ) {
2800 if ( $count == $user_theme_default ) {
2805 if ( $count < 10 ) {
2808 $name = $user_theme_name[$count];
2809 $num_spaces = 35 - length($name);
2810 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2811 $name = $name . " ";
2814 print " $count. $name";
2815 print "($user_theme_path[$count])\n";
2819 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2820 $old_def = $user_theme_default;
2821 $user_theme_default = $input;
2822 $user_theme_default =~ s/^\s*m\s*//;
2823 if ( ( $user_theme_default > $#user_theme_name ) || ( $user_theme_default < 0 ) ) {
2824 print "Cannot set default theme to $user_theme_default. That theme does not exist.\n";
2825 $user_theme_default = $old_def;
2827 } elsif ( $input =~ /^\s*\+/ ) {
2828 print "What is the name of this theme? ";
2830 $name =~ s/[\r\n]//g;
2831 $user_theme_name[ $#user_theme_name + 1 ] = $name;
2832 print "Be sure to put ../css/ before the filename.\n";
2833 print "What file is this stored in (ex: ../css/my_theme/): ";
2835 $name =~ s/[\r\n]//g;
2836 $user_theme_path[ $#user_theme_path + 1 ] = $name;
2837 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2838 if ( $input =~ /[0-9]+\s*$/ ) {
2840 $rem_num =~ s/^\s*-\s*//g;
2841 $rem_num =~ s/\s*$//;
2843 $rem_num = $#user_theme_name;
2845 if ( $rem_num == $user_theme_default ) {
2846 print "You cannot remove the default theme!\n";
2849 @new_theme_name = ();
2850 @new_theme_path = ();
2851 while ( $count <= $#user_theme_name ) {
2852 if ( $count != $rem_num ) {
2853 @new_theme_name = ( @new_theme_name, $user_theme_name[$count] );
2854 @new_theme_path = ( @new_theme_path, $user_theme_path[$count] );
2858 @user_theme_name = @new_theme_name;
2859 @user_theme_path = @new_theme_path;
2860 if ( $user_theme_default > $rem_num ) {
2861 $user_theme_default--;
2864 } elsif ( $input =~ /^\s*t\s*/i ) {
2865 print "\nStarting detection...\n\n";
2867 opendir( DIR
, "../css" );
2868 @files = sort(readdir(DIR
));
2870 while ( $cnt <= $#files ) {
2871 $filename = "../css/" . $files[$cnt] .'/';
2872 if ( $files[$cnt] !~ /^\./ && $filename ne "../css/rtl.css" && -e
$filename . "default.css" ) {
2874 for ( $x = 0 ; $x <= $#user_theme_path ; $x++ ) {
2875 if ( $user_theme_path[$x] eq $filename ) {
2879 if ( $found != 1 ) {
2880 print "** Found user theme: $filename\n";
2881 $def = $files[$cnt];
2884 #$def =~ s/(^\w+)/ucfirst $1/eg;
2885 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
2886 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
2887 print " What is its name? [$def]: ";
2889 $nm =~ s/^\s+|\s+$|[\n\r]//g;
2890 if ( $nm eq '' ) { $nm = $def; }
2891 $user_theme_name[ $#user_theme_name + 1 ] = $nm;
2892 $user_theme_path[ $#user_theme_path + 1 ] = $filename;
2898 for ( $cnt = 0 ; $cnt <= $#user_theme_path ; $cnt++ ) {
2899 $filename = $user_theme_path[$cnt];
2900 if ( $filename != 'none' && !( -e
$filename ."/default.css" ) ) {
2901 print " Removing $filename (file not found)\n";
2903 @new_user_theme_name = ();
2904 @new_user_theme_path = ();
2905 for ( $x = 0 ; $x < $#user_theme_path ; $x++ ) {
2906 if ( $user_theme_path[$x] eq $filename ) {
2909 if ( $offset == 1 ) {
2910 $new_user_theme_name[$x] = $user_theme_name[ $x + 1 ];
2911 $new_user_theme_path[$x] = $user_theme_path[ $x + 1 ];
2913 $new_user_theme_name[$x] = $user_theme_name[$x];
2914 $new_user_theme_path[$x] = $user_theme_path[$x];
2917 @user_theme_name = @new_user_theme_name;
2918 @user_theme_path = @new_user_theme_path;
2921 print "\nDetection complete!\n\n";
2924 } elsif ( $input =~ /^\s*\?\s*/ ) {
2925 print ".------------------------------------.\n";
2926 print "| t (detect user themes) |\n";
2927 print "| + (add user theme) |\n";
2928 print "| - N (remove user theme) |\n";
2929 print "| m N (mark default user theme) |\n";
2930 print "| l (list user themes) |\n";
2931 print "| d (done) |\n";
2932 print "`------------------------------------'\n";
2934 print "[user_themes] command (?=help) > ";
2936 $input =~ s/[\r\n]//g;
2940 sub command_iconSets
{
2941 print "\nDefine the icon themes that you wish to use. If you have added\n";
2942 print "a theme of your own, just follow the instructions (?) about\n";
2943 print "how to add them. You can also change the default and fallback\n";
2944 print "themes. The default theme will be used when no icon theme is\n";
2945 print "set by the user. The fallback theme will be used if an icon\n";
2946 print "cannot be found in the currently selected icon theme.\n\n";
2948 print "Available icon themes:\n\n";
2951 while ( $count <= $#icon_theme_name ) {
2952 if ( $count == $icon_theme_def ) {
2957 if ( $count eq $icon_theme_fallback ) {
2962 if ( $count < 10 ) {
2965 $name = $icon_theme_name[$count];
2966 $num_spaces = 35 - length($name);
2967 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2968 $name = $name . " ";
2971 print " $count. $name";
2972 print "($icon_theme_path[$count])\n";
2977 print "\n d = Default icon theme\n";
2978 print " f = Fallback icon theme\n";
2980 print ".------------------------------------.\n";
2981 print "| t (detect icon themes) |\n";
2982 print "| + (add icon theme) |\n";
2983 print "| - N (remove icon theme) |\n";
2984 print "| m N (mark default icon theme) |\n";
2985 print "| f N (set fallback icon set) |\n";
2986 print "| l (list icon themes) |\n";
2987 print "| d (done) |\n";
2988 print "`------------------------------------'\n";
2990 print "\n[icon_themes] command (?=help) > ";
2992 $input =~ s/[\r\n]//g;
2993 while ( $input ne "d" ) {
2994 if ( $input =~ /^\s*l\s*/i ) {
2997 while ( $count <= $#icon_theme_name ) {
2998 if ( $count == $icon_theme_def ) {
3003 if ( $count eq $icon_theme_fallback ) {
3008 $name = $icon_theme_name[$count];
3009 $num_spaces = 35 - length($name);
3010 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3011 $name = $name . " ";
3014 print " $count. $name";
3015 print "($icon_theme_path[$count])\n";
3019 print "\n d = Default icon theme\n";
3020 print " f = Fallback icon theme\n\n";
3021 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
3022 $old_def = $icon_theme_def;
3023 $icon_theme_def = $input;
3024 $icon_theme_def =~ s/^\s*m\s*//;
3025 if ( ( $icon_theme_default > $#icon_theme_name ) || ( $icon_theme_default < 0 ) ) {
3026 print "Cannot set default icon theme to $icon_theme_default. That theme does not exist.\n";
3027 $icon_theme_def = $old_def;
3029 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
3030 $old_fb = $icon_theme_fallback;
3031 $icon_theme_fallback = $input;
3032 $icon_theme_fallback =~ s/^\s*f\s*//;
3033 if ( ( $icon_theme_fallback > $#icon_theme_name ) || ( $icon_theme_fallback < 0 ) ) {
3034 print "Cannot set fallback icon theme to $icon_theme_fallback. That theme does not exist.\n";
3035 $icon_theme_fallback = $old_fb;
3037 } elsif ( $input =~ /^\s*\+/ ) {
3038 print "What is the name of this icon theme? ";
3040 $name =~ s/[\r\n]//g;
3041 $icon_theme_name[ $#icon_theme_name + 1 ] = $name;
3042 print "Be sure to put ../images/themes/ before the filename.\n";
3043 print "What directory is this icon theme stored in (ex: ../images/themes/my_theme/)? ";
3045 $name =~ s/[\r\n]//g;
3046 $icon_theme_path[ $#icon_theme_path + 1 ] = $name;
3047 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3048 if ( $input =~ /[0-9]+\s*$/ ) {
3050 $rem_num =~ s/^\s*-\s*//g;
3051 $rem_num =~ s/\s*$//;
3053 $rem_num = $#icon_theme_name;
3055 if ( $rem_num == $icon_theme_def ) {
3056 print "You cannot remove the default icon theme!\n";
3057 } elsif ( $rem_num == $icon_theme_fallback ) {
3058 print "You cannot remove the fallback icon theme!\n";
3061 @new_theme_name = ();
3062 @new_theme_path = ();
3063 while ( $count <= $#icon_theme_name ) {
3064 if ( $count != $rem_num ) {
3065 @new_theme_name = ( @new_theme_name, $icon_theme_name[$count] );
3066 @new_theme_path = ( @new_theme_path, $icon_theme_path[$count] );
3070 @icon_theme_name = @new_theme_name;
3071 @icon_theme_path = @new_theme_path;
3072 if ( $icon_theme_def > $rem_num ) {
3076 } elsif ( $input =~ /^\s*t\s*/i ) {
3077 print "\nStarting detection...\n\n";
3079 opendir( DIR
, "../images/themes/" );
3080 @files = sort(readdir(DIR
));
3082 while ( $cnt <= $#files ) {
3083 $filename = "../images/themes/" . $files[$cnt] .'/';
3084 if ( -d
"../images/themes/" . $files[$cnt] && $files[$cnt] !~ /^\
./ && $files[$cnt] ne ".svn" ) {
3086 for ( $x = 0 ; $x <= $#icon_theme_path ; $x++ ) {
3087 if ( $icon_theme_path[$x] eq $filename ) {
3091 if ( $found != 1 ) {
3092 print "** Found icon theme: $filename\n";
3093 $def = $files[$cnt];
3096 #$def =~ s/(^\w+)/ucfirst $1/eg;
3097 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3098 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3099 print " What is its name? [$def]: ";
3101 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3102 if ( $nm eq '' ) { $nm = $def; }
3103 $icon_theme_name[ $#icon_theme_name + 1 ] = $nm;
3104 $icon_theme_path[ $#icon_theme_path + 1 ] = $filename;
3110 for ( $cnt = 0 ; $cnt <= $#icon_theme_path ; $cnt++ ) {
3111 $filename = $icon_theme_path[$cnt];
3112 if ( $filename ne "none" && $filename ne "template" && ! -d
$filename ) {
3113 print " Removing $filename (file not found)\n";
3115 @new_icon_theme_name = ();
3116 @new_icon_theme_path = ();
3117 for ( $x = 0 ; $x < $#icon_theme_path ; $x++ ) {
3118 if ( $icon_theme_path[$x] eq $filename ) {
3121 if ( $offset == 1 ) {
3122 $new_icon_theme_name[$x] = $icon_theme_name[ $x + 1 ];
3123 $new_icon_theme_path[$x] = $icon_theme_path[ $x + 1 ];
3125 $new_icon_theme_name[$x] = $icon_theme_name[$x];
3126 $new_icon_theme_path[$x] = $icon_theme_path[$x];
3129 @icon_theme_name = @new_icon_theme_name;
3130 @icon_theme_path = @new_icon_theme_path;
3133 print "\nDetection complete!\n\n";
3136 } elsif ( $input =~ /^\s*\?\s*/ ) {
3137 print ".------------------------------------.\n";
3138 print "| t (detect icon themes) |\n";
3139 print "| + (add icon theme) |\n";
3140 print "| - N (remove icon theme) |\n";
3141 print "| m N (mark default icon theme) |\n";
3142 print "| f N (set fallback icon set) |\n";
3143 print "| l (list icon themes) |\n";
3144 print "| d (done) |\n";
3145 print "`------------------------------------'\n";
3147 print "[icon_themes] command (?=help) > ";
3149 $input =~ s/[\r\n]//g;
3153 sub command_templates
{
3154 print "\nDefine the template sets (skins) that you wish to use. If you have added\n";
3155 print "a template set of your own, just follow the instructions (?) about\n";
3156 print "how to add them. You can also change the default template.\n";
3158 print "\n Available Templates:\n";
3161 while ( $count <= $#templateset_name ) {
3162 if ( $templateset_id[$count] eq $templateset_default ) {
3167 if ( $templateset_id[$count] eq $templateset_fallback ) {
3172 if ( $templateset_id[$count] eq $rpc_templateset ) {
3177 if ( $count < 10 ) {
3180 if ( $count < 100 ) {
3183 $name = $templateset_name[$count];
3185 # present RPC template sets differently
3187 if ( $templateset_id[$count] =~ /_rpc$/ ) {
3188 $name = $name . " (not shown in user interface; used for RPC interface only)";
3191 $num_spaces = 35 - length($name);
3192 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3193 $name = $name . " ";
3195 $name = $name . "($templateset_id[$count])";
3199 print " $count. $name\n";
3203 print "\n d = default template set\n"
3204 . " f = fallback template set\n"
3205 . " r = RPC template set\n\n";
3207 $menu_text = ".-------------------------------------.\n"
3208 . "| t (detect template set) |\n"
3209 . "| + (add template set) |\n"
3210 . "| - N (remove template set) |\n"
3211 . "| m N (mark default template set) |\n"
3212 . "| f N (set fallback template set) |\n"
3213 . "| r N (set RPC template set) |\n"
3214 . "| l (list template sets/skins) |\n"
3216 . "|-------------------------------------|\n"
3217 . "| where N is a template set number |\n"
3218 . "`-------------------------------------'\n";
3221 print "\n[template set] command (?=help) > ";
3224 $input =~ s/[\r\n]//g;
3225 while ( $input ne "d" ) {
3227 # list template sets
3229 if ( $input =~ /^\s*l\s*/i ) {
3231 while ( $count <= $#templateset_name ) {
3232 if ( $templateset_id[$count] eq $templateset_default ) {
3237 if ( $templateset_id[$count] eq $templateset_fallback ) {
3242 if ( $templateset_id[$count] eq $rpc_templateset ) {
3247 if ( $count < 10 ) {
3250 if ( $count < 100 ) {
3253 $name = $templateset_name[$count];
3255 # present RPC template sets differently
3257 if ( $templateset_id[$count] =~ /_rpc$/ ) {
3258 $name = $name . " (not shown in user interface; used for RPC interface only)";
3261 $num_spaces = 35 - length($name);
3262 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3263 $name = $name . " ";
3265 $name = $name . "($templateset_id[$count])";
3269 print " $count. $name\n";
3273 print "\n d = default template set\n"
3274 . " f = fallback template set\n"
3275 . " r = RPC template set\n\n";
3277 # mark default template set
3279 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
3280 $old_def = $templateset_default;
3281 $input =~ s/^\s*m\s*//;
3282 $templateset_default = $templateset_id[$input];
3283 if ( $templateset_default =~ /^\s*$/ ) {
3284 print "Cannot set default template set to $input. That template set does not exist.\n";
3285 $templateset_default = $old_def;
3287 if ( $templateset_default =~ /_rpc$/ ) {
3288 print "Cannot set default template set to $input. That template set is intended for the RPC interface only.\n";
3289 $templateset_default = $old_def;
3292 # set fallback template set
3294 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
3295 $old_def = $templateset_fallback;
3296 $input =~ s/^\s*f\s*//;
3297 $templateset_fallback = $templateset_id[$input];
3298 if ( $templateset_fallback =~ /^\s*$/ ) {
3299 print "Cannot set fallback template set to $input. That template set does not exist.\n";
3300 $templateset_fallback = $old_def;
3302 if ( $templateset_fallback =~ /_rpc$/ ) {
3303 print "Cannot set fallback template set to $input. That template set is intended for the RPC interface only.\n";
3304 $templateset_fallback = $old_def;
3307 # set RPC template set
3309 } elsif ( $input =~ /^\s*r\s*[0-9]+/i ) {
3310 $old_def = $rpc_templateset;
3311 $input =~ s/^\s*r\s*//;
3312 $rpc_templateset = $templateset_id[$input];
3313 if ( $rpc_templateset =~ /^\s*$/ ) {
3314 print "Cannot set RPC template set to $input. That template set does not exist.\n";
3315 $rpc_templateset = $old_def;
3317 if ( $rpc_templateset !~ /_rpc$/ ) {
3318 print "Cannot set fallback template set to $input. That template set is not intended for the RPC interface.\n";
3319 $rpc_templateset = $old_def;
3324 } elsif ( $input =~ /^\s*\+/ ) {
3325 print "\nWhat is the name of this template (as shown to your users): ";
3327 $name =~ s/[\r\n]//g;
3328 $templateset_name[ $#templateset_name + 1 ] = $name;
3329 print "\n\nThe directory name should not contain any path information\n"
3330 . "or slashes, and should be the name of the directory that the\n"
3331 . "template set is found in within the SquirrelMail templates\n"
3333 print "What directory is this stored in (ex: default_advanced): ";
3335 $name =~ s/[\r\n]//g;
3336 $templateset_id[ $#templateset_id + 1 ] = $name;
3338 # detect template sets
3340 } elsif ( $input =~ /^\s*t\s*/i ) {
3341 print "\nStarting detection...\n\n";
3342 opendir( DIR
, "../templates" );
3343 @files = sort(readdir(DIR
));
3345 while ( $cnt <= $#files ) {
3346 if ( -d
"../templates/" . $files[$cnt] && $files[$cnt] !~ /^\./ && $files[$cnt] ne ".svn" ) {
3347 $filename = $files[$cnt];
3349 for ( $x = 0 ; $x <= $#templateset_id ; $x++ ) {
3350 if ( $templateset_id[$x] eq $filename ) {
3356 print "** Found template set: $filename\n";
3357 $def = $files[$cnt];
3359 # no user-friendly names needed for RPC template sets
3361 if ( $def =~ /_rpc$/ ) {
3366 #$def =~ s/(^\w+)/ucfirst $1/eg;
3367 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3368 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3369 print " What is it's name (as shown to your users)? [$def]: ";
3371 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3372 if ( $nm eq '' ) { $nm = $def; }
3374 $templateset_id[ $#templateset_id + 1 ] = $filename;
3375 $templateset_name[ $#templateset_name + 1 ] = $nm;
3381 for ( $cnt= 0 ; $cnt <= $#templateset_id ; ) {
3382 $filename = $templateset_id[$cnt];
3383 if ( !(-d change_to_rel_path
('SM_PATH . \'templates/' . $filename)) ) {
3384 print " Removing \"$filename\" (template set directory not found)\n";
3385 if ( $templateset_default eq $filename ) { $templateset_default = 'default'; }
3386 if ( $templateset_fallback eq $filename ) { $templateset_fallback = 'default'; }
3387 if ( $rpc_templateset eq $filename ) { $rpc_templateset = 'default_rpc'; }
3389 @new_templateset_name = ();
3390 @new_templateset_id = ();
3391 for ( $x = 0 ; $x < $#templateset_id ; $x++ ) {
3392 if ( $templateset_id[$x] eq $filename ) {
3395 if ( $offset == 1 ) {
3396 $new_templateset_name[$x] = $templateset_name[ $x + 1 ];
3397 $new_templateset_id[$x] = $templateset_id[ $x + 1 ];
3399 $new_templateset_name[$x] = $templateset_name[$x];
3400 $new_templateset_id[$x] = $templateset_id[$x];
3403 @templateset_name = @new_templateset_name;
3404 @templateset_id = @new_templateset_id;
3407 print "\nDetection complete!\n\n";
3411 # remove template set
3413 # undocumented functionality of removing last template set isn't that great
3414 #} elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3415 } elsif ( $input =~ /^\s*-\s*[0-9]+/ ) {
3416 if ( $input =~ /[0-9]+\s*$/ ) {
3418 $rem_num =~ s/^\s*-\s*//g;
3419 $rem_num =~ s/\s*$//;
3421 $rem_num = $#templateset_name;
3423 if ( $templateset_id[$rem_num] eq $templateset_default ) {
3424 print "You cannot remove the default template set!\n";
3425 } elsif ( $templateset_id[$rem_num] eq $templateset_fallback ) {
3426 print "You cannot remove the fallback template set!\n";
3427 } elsif ( $templateset_id[$rem_num] eq $rpc_templateset ) {
3428 print "You cannot remove the RPC template set!\n";
3431 @new_templateset_name = ();
3432 @new_templateset_id = ();
3433 while ( $count <= $#templateset_name ) {
3434 if ( $count != $rem_num ) {
3435 @new_templateset_name = ( @new_templateset_name, $templateset_name[$count] );
3436 @new_templateset_id = ( @new_templateset_id, $templateset_id[$count] );
3440 @templateset_name = @new_templateset_name;
3441 @templateset_id = @new_templateset_id;
3446 } elsif ( $input =~ /^\s*\?\s*/ ) {
3449 # command not understood
3452 print "Command not understood\n";
3455 print "[template set] command (?=help) > ";
3457 $input =~ s/[\r\n]//g;
3459 return $templateset_default;
3463 # sets default font size option
3464 sub command_default_fontsize
{
3465 print "Enter default font size [$WHT$$default_fontsize$NRM]: $WHT";
3466 $new_size = <STDIN
>;
3467 if ( $new_size eq "\n" ) {
3470 $new_size =~ s/[\r\n]//g;
3475 # controls available fontsets
3476 sub command_fontsets
{
3478 print "You can control fontsets available to end users here.\n";
3479 # set initial $input value
3481 while ( $input ne "x" ) {
3482 if ( $input =~ /^\s*a\s*/i ) {
3484 print "\nFontset name: ";
3486 if (! $fontsets{trim
($name)}) {
3487 print "Fontset string: ";
3489 $fontsets{trim
($name)} = trim
($value);
3491 print "\nERROR: Such fontset already exists.\n";
3493 } elsif ( $input =~ /^\s*e\s*/i ) {
3494 # edit existing fontset
3495 print "\nFontset name: ";
3497 if (! $fontsets{trim
($name)}) {
3498 print "\nERROR: No such fontset.\n";
3500 print "Fontset string [$fontsets{trim($name)}]: ";
3502 $fontsets{trim
($name)} = trim
($value);
3504 } elsif ( $input =~ /^\s*d\s*/ ) {
3505 # delete existing fontset
3506 print "\nFontset name: ";
3508 if (! $fontsets{trim
($name)}) {
3509 print "\nERROR: No such fontset.\n";
3511 delete $fontsets{trim
($name)};
3513 } elsif ( $input =~ /^\s*l\s*/ ) {
3515 print "\nConfigured fontsets:\n";
3516 while (($fontset_name, $fontset_string) = each(%fontsets)) {
3517 print " $fontset_name = $fontset_string\n";
3519 print "Default fontset: $default_fontset\n";
3520 } elsif ( $input =~ /^\s*m\s*/ ) {
3521 # set default fontset
3522 print "\nSet default fontset [$default_fontset]: ";
3524 if (trim
($name) ne '' and ! $fontsets{trim
($name)}) {
3525 print "\nERROR: No such fontset.\n";
3527 $default_fontset = trim
($name);
3530 # print available commands on any other input
3531 print "\nAvailable commands:\n";
3532 print " a - Adds new fontset.\n";
3533 print " d - Deletes existing fontset.\n";
3534 print " e - Edits existing fontset.\n";
3535 print " h or ? - Shows this help screen.\n";
3536 print " l - Lists available fontsets.\n";
3537 print " m - Sets default fontset.\n";
3538 print " x - Exits fontset editor mode.\n";
3540 print "\nCommand [fontsets] (a,d,e,h,?=help,l,m,x)> ";
3542 $input =~ s/[\r\n]//g;
3547 print "You can now define different LDAP servers.\n";
3548 print "Please ensure proper permissions for config.php when including\n";
3549 print "sensitive passwords.\n\n";
3550 print "[ldap] command (?=help) > ";
3552 $input =~ s/[\r\n]//g;
3553 while ( $input ne "d" ) {
3554 if ( $input =~ /^\s*l\s*/i ) {
3556 while ( $count <= $#ldap_host ) {
3557 print "$count. $ldap_host[$count]\n";
3558 print " base: $ldap_base[$count]\n";
3559 if ( $ldap_charset[$count] ) {
3560 print " charset: $ldap_charset[$count]\n";
3562 if ( $ldap_port[$count] ) {
3563 print " port: $ldap_port[$count]\n";
3565 if ( $ldap_name[$count] ) {
3566 print " name: $ldap_name[$count]\n";
3568 if ( $ldap_maxrows[$count] ) {
3569 print " maxrows: $ldap_maxrows[$count]\n";
3571 if ( $ldap_filter[$count] ) {
3572 print " filter: $ldap_filter[$count]\n";
3574 if ( $ldap_binddn[$count] ) {
3575 print " binddn: $ldap_binddn[$count]\n";
3576 if ( $ldap_bindpw[$count] ) {
3577 print " bindpw: $ldap_bindpw[$count]\n";
3580 if ( $ldap_protocol[$count] ) {
3581 print " protocol: $ldap_protocol[$count]\n";
3583 if ( $ldap_limit_scope[$count] ) {
3584 print " limit_scope: $ldap_limit_scope[$count]\n";
3586 if ( $ldap_listing[$count] ) {
3587 print " listing: $ldap_listing[$count]\n";
3589 if ( $ldap_writeable[$count] ) {
3590 print " writeable: $ldap_writeable[$count]\n";
3592 if ( $ldap_search_tree[$count] ) {
3593 print " search_tree: $ldap_search_tree[$count]\n";
3595 if ( $ldap_starttls[$count] ) {
3596 print " starttls: $ldap_starttls[$count]\n";
3602 } elsif ( $input =~ /^\s*\+/ ) {
3603 $sub = $#ldap_host + 1;
3605 print "First, we need to have the hostname or the IP address where\n";
3606 print "this LDAP server resides. Example: ldap.bigfoot.com\n";
3608 print "You can use any URI compatible with your LDAP library. Please\n";
3609 print "note that StartTLS option is not compatible with ldaps and\n";
3610 print "ldapi URIs.\n";
3613 $name =~ s/[\r\n]//g;
3614 $ldap_host[$sub] = $name;
3618 print "Next, we need the server root (base dn). For this, an empty\n";
3619 print "string is allowed.\n";
3620 print "Example: ou=member_directory,o=netcenter.com\n";
3623 $name =~ s/[\r\n]//g;
3624 $ldap_base[$sub] = $name;
3628 print "This is the TCP/IP port number for the LDAP server. Default\n";
3629 print "port is 389. This is optional. Press ENTER for default.\n";
3632 $name =~ s/[\r\n]//g;
3633 $ldap_port[$sub] = $name;
3637 print "This is the charset for the server. Default is utf-8. This\n";
3638 print "is also optional. Press ENTER for default.\n";
3641 $name =~ s/[\r\n]//g;
3642 $ldap_charset[$sub] = $name;
3646 print "This is the name for the server, used to tag the results of\n";
3647 print "the search. Default it \"LDAP: hostname\". Press ENTER for default\n";
3650 $name =~ s/[\r\n]//g;
3651 $ldap_name[$sub] = $name;
3655 print "You can specify the maximum number of rows in the search result.\n";
3656 print "Default value is equal to 250 rows. Press ENTER for default.\n";
3659 $name =~ s/[\r\n]//g;
3660 $ldap_maxrows[$sub] = $name;
3665 print "If your LDAP server does not like anonymous logins, you can specify bind DN.\n";
3666 print "Default is none, anonymous bind. Press ENTER for default.\n";
3669 $name =~ s/[\r\n]//g;
3670 $ldap_binddn[$sub] = $name;
3674 if ( $ldap_binddn[$sub] ne '' ) {
3676 print "Now, please specify password for that DN.\n";
3679 $name =~ s/[\r\n]//g;
3680 $ldap_bindpw[$sub] = $name;
3685 print "You can specify bind protocol version here.\n";
3686 print "Default protocol version depends on your php ldap settings.\n";
3687 print "Press ENTER for default.\n";
3690 $name =~ s/[\r\n]//g;
3691 $ldap_protocol[$sub] = $name;
3695 print "This configuration section allows to set some rarely used\n";
3696 print "options and options specific to some LDAP implementations.\n";
3698 print "Do you want to set advanced LDAP directory settings? (y/N):";
3699 $ldap_advanced_settings = <STDIN
>;
3700 if ( $ldap_advanced_settings =~ /^y\n/i ) {
3701 $ldap_advanced_settings = 'true';
3703 $ldap_advanced_settings = 'false';
3706 if ($ldap_advanced_settings eq 'true') {
3709 print "You can control LDAP directory listing here. This option can\n";
3710 print "be useful if you run small LDAP server and want to provide listing\n";
3711 print "of all addresses stored in LDAP to users of webmail interface.\n";
3712 print "Number of displayed entries is limited by maxrows setting.\n";
3714 print "Don't enable this option for public LDAP directories.\n";
3716 print "Allow listing of LDAP directory? (y/N):";
3718 if ( $name =~ /^y\n/i ) {
3723 $ldap_listing[$sub] = $name;
3727 print "You can control write access to LDAP address book here. This option can\n";
3728 print "be useful if you run small LDAP server and want to provide writable\n";
3729 print "shared address book stored in LDAP to users of webmail interface.\n";
3731 print "Don't enable this option for public LDAP directories.\n";
3733 print "Allow writing to LDAP directory? (y/N):";
3735 if ( $name =~ /^y\n/i ) {
3740 $ldap_writeable[$sub] = $name;
3744 print "You can specify an additional search filter.\n";
3745 print "This could be something like \"(objectclass=posixAccount)\".\n";
3746 print "No filtering is performed by default. Press ENTER for default.\n";
3749 $name =~ s/[\r|\n]//g;
3750 $ldap_filter[$sub] = $name;
3754 print "You can control search scope here.\n";
3755 print "This option is specific to Microsoft ADS implementation.\n";
3756 print "It requires use of v3 or newer LDAP protocol.\n";
3757 print "Don't enable it, if you use other LDAP server.\n";
3759 print "Limit ldap scope? (y/N):";
3761 if ( $name =~ /^y\n/i ) {
3766 $ldap_limit_scope[$sub] = $name;
3770 print "You can control ldap search type here.\n";
3771 print "Addresses can be searched in entire LDAP subtree (default)\n";
3772 print "or only first level entries are returned.\n";
3774 print "Search entire LDAP subtree? (Y/n):";
3776 if ( $name =~ /^n\n/i ) {
3781 $ldap_search_tree[$sub] = $name;
3785 print "You can control use of StartTLS on LDAP connection here.\n";
3786 print "This option requires use of v3 or newer LDAP protocol and php 4.2+.\n";
3788 print "Use StartTLS? (y/N):";
3790 if ( $name =~ /^y\n/i ) {
3795 $ldap_starttls[$sub] = $name;
3799 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3800 if ( $input =~ /[0-9]+\s*$/ ) {
3802 $rem_num =~ s/^\s*-\s*//g;
3803 $rem_num =~ s/\s*$//;
3805 $rem_num = $#ldap_host;
3808 @new_ldap_host = ();
3809 @new_ldap_base = ();
3810 @new_ldap_port = ();
3811 @new_ldap_name = ();
3812 @new_ldap_charset = ();
3813 @new_ldap_maxrows = ();
3814 @new_ldap_filter = ();
3815 @new_ldap_bindpw = ();
3816 @new_ldap_binddn = ();
3817 @new_ldap_protocol = ();
3818 @new_ldap_limit_scope = ();
3819 @new_ldap_listing = ();
3820 @new_ldap_writeable = ();
3821 @new_ldap_search_tree = ();
3822 @new_ldap_starttls = ();
3824 while ( $count <= $#ldap_host ) {
3825 if ( $count != $rem_num ) {
3826 @new_ldap_host = ( @new_ldap_host, $ldap_host[$count] );
3827 @new_ldap_base = ( @new_ldap_base, $ldap_base[$count] );
3828 @new_ldap_port = ( @new_ldap_port, $ldap_port[$count] );
3829 @new_ldap_name = ( @new_ldap_name, $ldap_name[$count] );
3830 @new_ldap_charset = ( @new_ldap_charset, $ldap_charset[$count] );
3831 @new_ldap_maxrows = ( @new_ldap_maxrows, $ldap_maxrows[$count] );
3832 @new_ldap_filter = ( @new_ldap_filter, $ldap_filter[$count] );
3833 @new_ldap_binddn = ( @new_ldap_binddn, $ldap_binddn[$count] );
3834 @new_ldap_bindpw = ( @new_ldap_bindpw, $ldap_bindpw[$count] );
3835 @new_ldap_protocol = ( @new_ldap_protocol, $ldap_protocol[$count] );
3836 @new_ldap_limit_scope = ( @new_ldap_limit_scope, $ldap_limit_scope[$count] );
3837 @new_ldap_listing = ( @new_ldap_listing, $ldap_listing[$count] );
3838 @new_ldap_writeable = ( @new_ldap_writeable, $ldap_writeable[$count] );
3839 @new_ldap_search_tree = ( @new_ldap_search_tree, $ldap_search_tree[$count] );
3840 @new_ldap_starttls = ( @new_ldap_starttls, $ldap_starttls[$count] );
3844 @ldap_host = @new_ldap_host;
3845 @ldap_base = @new_ldap_base;
3846 @ldap_port = @new_ldap_port;
3847 @ldap_name = @new_ldap_name;
3848 @ldap_charset = @new_ldap_charset;
3849 @ldap_maxrows = @new_ldap_maxrows;
3850 @ldap_filter = @new_ldap_filter;
3851 @ldap_binddn = @new_ldap_binddn;
3852 @ldap_bindpw = @new_ldap_bindpw;
3853 @ldap_protocol = @new_ldap_protocol;
3854 @ldap_limit_scope = @new_ldap_limit_scope;
3855 @ldap_listing = @new_ldap_listing;
3856 @ldap_writeable = @new_ldap_writeable;
3857 @ldap_search_tree = @new_ldap_search_tree;
3858 @ldap_starttls = @new_ldap_starttls;
3860 } elsif ( $input =~ /^\s*\?\s*/ ) {
3861 print ".-------------------------.\n";
3862 print "| + (add host) |\n";
3863 print "| - N (remove host) |\n";
3864 print "| l (list hosts) |\n";
3865 print "| d (done) |\n";
3866 print "`-------------------------'\n";
3868 print "[ldap] command (?=help) > ";
3870 $input =~ s/[\r\n]//g;
3875 print "Some of our developers have come up with very good javascript interface\n";
3876 print "for searching through address books, however, our original goals said\n";
3877 print "that we would be 100% HTML. In order to make it possible to use their\n";
3878 print "interface, and yet stick with our goals, we have also written a plain\n";
3879 print "HTML version of the search. Here, you can choose which version to use.\n";
3881 print "This is just the default value. It is also a user option that each\n";
3882 print "user can configure individually\n";
3885 if ( lc($default_use_javascript_addr_book) eq 'true' ) {
3886 $default_value = "y";
3888 $default_use_javascript_addr_book = 'false';
3889 $default_value = "n";
3891 print "Use javascript version by default (y/n) [$WHT$default_value$NRM]: $WHT";
3892 $new_show = <STDIN
>;
3893 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3894 $default_use_javascript_addr_book = 'true';
3896 $default_use_javascript_addr_book = 'false';
3898 return $default_use_javascript_addr_book;
3901 # global filebased address book
3903 print "If you want to use global file address book, then you\n";
3904 print "must set this option to a valid value. If option does\n";
3905 print "not have path elements, system assumes that file is\n";
3906 print "stored in data directory. If relative path is set, it is\n";
3907 print "relative to main SquirrelMail directory. If value is empty,\n";
3908 print "address book is not enabled.\n";
3911 print "[$WHT$abook_global_file$NRM]: $WHT";
3912 $new_abook_global_file = <STDIN
>;
3913 if ( $new_abook_global_file eq "\n" ) {
3914 $new_abook_global_file = $abook_global_file;
3916 $new_abook_global_file =~ s/[\r\n]//g;
3918 return $new_abook_global_file;
3921 # writing into global filebased abook control
3923 print "This setting controls writing into global file address\n";
3924 print "book options. Address book file must be writeable by\n";
3925 print "webserver's user, if you want to enable this option.\n";
3928 if ( lc($abook_global_file_writeable) eq 'true' ) {
3929 $default_value = "y";
3931 $abook_global_file_writeable = 'false';
3932 $default_value = "n";
3934 print "Allow writing into global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
3935 $new_show = <STDIN
>;
3936 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3937 $abook_global_file_writeable = 'true';
3939 $abook_global_file_writeable = 'false';
3941 return $abook_global_file_writeable;
3944 # listing of global filebased abook control
3946 print "This setting controls listing of global file address\n";
3947 print "book in addresses page.\n";
3950 if ( lc($abook_global_file_listing) eq 'true' ) {
3951 $default_value = "y";
3953 $abook_global_file_listing = 'false';
3954 $default_value = "n";
3956 print "Allow listing of global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
3957 $new_show = <STDIN
>;
3958 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3959 $abook_global_file_listing = 'true';
3961 $abook_global_file_listing = 'false';
3963 return $abook_global_file_listing;
3966 # controls $abook_file_line_length setting
3967 sub command_abook_file_line_length
{
3968 print "This setting controls space allocated to file based address book records.\n";
3969 print "End users will be unable to save address book entry, if total entry size \n";
3970 print "(quoted address book fields + 4 delimiters + linefeed) exceeds allowed \n";
3971 print "address book length size.\n";
3973 print "Same setting is applied to personal and global file based address books.\n";
3975 print "It is strongly recommended to keep default setting value. Change it only\n";
3976 print "if you really want to store address book entries that are bigger than two\n";
3977 print "kilobytes (2048).\n";
3980 print "Enter allowed address book line length [$abook_file_line_length]: ";
3983 # value is not modified, if user hits Enter or enters space
3985 # make sure that input is numeric
3986 if ($tmp =~ /^\d+$/) {
3987 $abook_file_line_length = $tmp;
3989 print "If you want to change this setting, you must enter number.\n";
3990 print "If you want to keep original setting - enter space.\n\n";
3991 print "Press Enter to continue...";
3998 print "If you want to store your users address book details in a database then\n";
3999 print "you need to set this DSN to a valid value. The format for this is:\n";
4000 print "mysql://user:pass\@hostname/dbname\n";
4001 print "Where mysql can be one of the databases PHP supports, the most common\n";
4002 print "of these are mysql, msql and pgsql.\n";
4003 print "Please ensure proper permissions for config.php when including\n";
4004 print "sensitive passwords.\n\n";
4005 print "If the DSN is left empty (hit space and then return) the database\n";
4006 print "related code for address books will not be used.\n";
4009 if ( $addrbook_dsn eq "" ) {
4010 $default_value = "Disabled";
4012 $default_value = $addrbook_dsn;
4014 print "[$WHT$addrbook_dsn$NRM]: $WHT";
4016 if ( $new_dsn eq "\n" ) {
4019 $new_dsn =~ s/[\r\n]//g;
4020 $new_dsn =~ s/^\s+$//g;
4026 print "This is the name of the table you want to store the address book\n";
4027 print "data in, it defaults to 'address'\n";
4029 print "[$WHT$addrbook_table$NRM]: $WHT";
4030 $new_table = <STDIN
>;
4031 if ( $new_table eq "\n" ) {
4032 $new_table = $addrbook_table;
4034 $new_table =~ s/[\r\n]//g;
4040 print "If you want to store your users preferences in a database then\n";
4041 print "you need to set this DSN to a valid value. The format for this is:\n";
4042 print "mysql://user:pass\@hostname/dbname\n";
4043 print "Where mysql can be one of the databases PHP supports, the most common\n";
4044 print "of these are mysql, msql and pgsql.\n";
4045 print "Please ensure proper permissions for config.php when including\n";
4046 print "sensitive passwords.\n\n";
4047 print "If the DSN is left empty (hit space and then return) the database\n";
4048 print "related code for address books will not be used.\n";
4051 if ( $prefs_dsn eq "" ) {
4052 $default_value = "Disabled";
4054 $default_value = $prefs_dsn;
4056 print "[$WHT$prefs_dsn$NRM]: $WHT";
4058 if ( $new_dsn eq "\n" ) {
4061 $new_dsn =~ s/[\r\n]//g;
4062 $new_dsn =~ s/^\s+$//g;
4068 print "This is the name of the table you want to store the preferences\n";
4069 print "data in, it defaults to 'userprefs'\n";
4071 print "[$WHT$prefs_table$NRM]: $WHT";
4072 $new_table = <STDIN
>;
4073 if ( $new_table eq "\n" ) {
4074 $new_table = $prefs_table;
4076 $new_table =~ s/[\r\n]//g;
4082 print "This is the name of the field in which you want to store the\n";
4083 print "username of the person the prefs are for. It default to 'user'\n";
4084 print "which clashes with a reserved keyword in PostgreSQL so this\n";
4085 print "will need to be changed for that database at least\n";
4087 print "[$WHT$prefs_user_field$NRM]: $WHT";
4088 $new_field = <STDIN
>;
4089 if ( $new_field eq "\n" ) {
4090 $new_field = $prefs_user_field;
4092 $new_field =~ s/[\r\n]//g;
4094 $prefs_user_size = db_pref_size
($prefs_user_size);
4099 print "This is the name of the field in which you want to store the\n";
4100 print "preferences keyword. It defaults to 'prefkey'\n";
4102 print "[$WHT$prefs_key_field$NRM]: $WHT";
4103 $new_field = <STDIN
>;
4104 if ( $new_field eq "\n" ) {
4105 $new_field = $prefs_key_field;
4107 $new_field =~ s/[\r\n]//g;
4109 $prefs_key_size = db_pref_size
($prefs_key_size);
4114 print "This is the name of the field in which you want to store the\n";
4115 print "preferences value. It defaults to 'prefval'\n";
4117 print "[$WHT$prefs_val_field$NRM]: $WHT";
4118 $new_field = <STDIN
>;
4119 if ( $new_field eq "\n" ) {
4120 $new_field = $prefs_val_field;
4122 $new_field =~ s/[\r\n]//g;
4124 $prefs_val_size = db_pref_size
($prefs_val_size);
4128 # routine is used to set database field limits
4129 # it needs one argument
4130 sub db_pref_size
() {
4132 print "\nDatabase fields have size limits.\n";
4134 print "What limit is set for this field? [$WHT$size$NRM]: $WHT";
4135 $new_size = <STDIN
>;
4136 if ( $new_size eq "\n" ) {
4139 $new_size =~ s/[\r\n]//g;
4145 print "If you want to store your global address book in a database then\n";
4146 print "you need to set this DSN to a valid value. The format for this is:\n";
4147 print "mysql://user:pass\@hostname/dbname\n";
4148 print "Where mysql can be one of the databases PHP supports, the most common\n";
4149 print "of these are mysql, msql and pgsql.\n";
4150 print "Please ensure proper permissions for config.php when including\n";
4151 print "sensitive passwords.\n\n";
4152 print "If the DSN is left empty (hit space and then return) the database\n";
4153 print "related code for global SQL address book will not be used.\n";
4156 if ( $addrbook_global_dsn eq "" ) {
4157 $default_value = "Disabled";
4159 $default_value = $addrbook_global_dsn;
4161 print "[$WHT$addrbook_global_dsn$NRM]: $WHT";
4163 if ( $new_dsn eq "\n" ) {
4166 $new_dsn =~ s/[\r\n]//g;
4167 $new_dsn =~ s/^\s+$//g;
4173 print "This is the name of the table you want to store the global address book\n";
4174 print "data in. Default table name is 'global_abook'. Address book uses same\n";
4175 print "database format as personal address book.\n";
4177 print "[$WHT$addrbook_global_table$NRM]: $WHT";
4178 $new_table = <STDIN
>;
4179 if ( $new_table eq "\n" ) {
4180 $new_table = $addrbook_global_table;
4182 $new_table =~ s/[\r\n]//g;
4188 print "This option controls users\' ability to add or modify records stored \n";
4189 print "in global address book\n";
4191 if ( lc($addrbook_global_writeable) eq 'true' ) {
4192 $default_value = "y";
4194 $default_value = "n";
4196 print "Allow writing into global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
4197 $addrbook_global_writeable = <STDIN
>;
4198 if ( ( $addrbook_global_writeable =~ /^y\n/i ) || ( ( $addrbook_global_writeable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4199 $addrbook_global_writeable = 'true';
4201 $addrbook_global_writeable = 'false';
4203 return $addrbook_global_writeable;
4207 print "Enable this option if you want to see listing of addresses stored \n";
4208 print "in global address book\n";
4210 if ( lc($addrbook_global_listing) eq 'true' ) {
4211 $default_value = "y";
4213 $default_value = "n";
4215 print "Allow listing of global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
4216 $addrbook_global_listing = <STDIN
>;
4217 if ( ( $addrbook_global_listing =~ /^y\n/i ) || ( ( $addrbook_global_listing =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4218 $addrbook_global_listing = 'true';
4220 $addrbook_global_listing = 'false';
4222 return $addrbook_global_listing;
4228 print "SquirrelMail attempts to set the language in many ways. If it\n";
4229 print "can not figure it out in another way, it will default to this\n";
4230 print "language. Please use the code for the desired language.\n";
4232 print "[$WHT$squirrelmail_default_language$NRM]: $WHT";
4233 $new_squirrelmail_default_language = <STDIN
>;
4234 if ( $new_squirrelmail_default_language eq "\n" ) {
4235 $new_squirrelmail_default_language = $squirrelmail_default_language;
4237 $new_squirrelmail_default_language =~ s/[\r\n]//g;
4238 $new_squirrelmail_default_language =~ s/^\s+$//g;
4240 return $new_squirrelmail_default_language;
4244 print "This option controls what character set is used when sending\n";
4245 print "mail and when sending HTML to the browser. Option works only\n";
4246 print "with US English (en_US) translation. Other translations use\n";
4247 print "charsets that are set in translation settings.\n";
4250 print "[$WHT$default_charset$NRM]: $WHT";
4251 $new_default_charset = <STDIN
>;
4252 if ( $new_default_charset eq "\n" ) {
4253 $new_default_charset = $default_charset;
4255 $new_default_charset =~ s/[\r\n]//g;
4257 return $new_default_charset;
4259 # Alternative language names
4261 print "Enable this option if you want to see localized language names in\n";
4262 print "language selection box. Note, that this option can trigger\n";
4263 print "installation of foreign language support modules in some browsers.\n";
4266 if ( lc($show_alternative_names) eq 'true' ) {
4267 $default_value = "y";
4269 $default_value = "n";
4271 print "Show alternative language names? (y/n) [$WHT$default_value$NRM]: $WHT";
4272 $show_alternative_names = <STDIN
>;
4273 if ( ( $show_alternative_names =~ /^y\n/i ) || ( ( $show_alternative_names =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4274 $show_alternative_names = 'true';
4276 $show_alternative_names = 'false';
4278 return $show_alternative_names;
4281 # Aggressive decoding
4283 print "Enable this option if you want to use CPU and memory intensive decoding\n";
4284 print "functions. This option allows reading multibyte charset, that are used\n";
4285 print "in Eastern Asia. SquirrelMail will try to use recode functions here,\n";
4286 print "even when you have disabled use of recode in Tweaks section.\n";
4289 if ( lc($aggressive_decoding) eq 'true' ) {
4290 $default_value = "y";
4292 $default_value = "n";
4294 print "Enable aggressive decoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4295 $aggressive_decoding = <STDIN
>;
4296 if ( ( $aggressive_decoding =~ /^y\n/i ) || ( ( $aggressive_decoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4297 $aggressive_decoding = 'true';
4299 $aggressive_decoding = 'false';
4301 return $aggressive_decoding;
4306 print "Enable this option if you want to allow lossy charset encoding in message\n";
4307 print "composition pages. This option allows charset conversions when output\n";
4308 print "charset does not support all symbols used in original charset. Symbols\n";
4309 print "unsupported by output charset will be replaced with question marks.\n";
4312 if ( lc($lossy_encoding) eq 'true' ) {
4313 $default_value = "y";
4315 $default_value = "n";
4317 print "Enable lossy encoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4318 $lossy_encoding = <STDIN
>;
4319 if ( ( $lossy_encoding =~ /^y\n/i ) || ( ( $lossy_encoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4320 $lossy_encoding = 'true';
4322 $lossy_encoding = 'false';
4324 return $lossy_encoding;
4327 # display html emails in iframe
4329 print "This option can enable html email rendering inside iframe.\n";
4330 print "Inline frames are used in order to provide sandbox environment";
4331 print "for html code included in html formated emails.";
4332 print "Option is experimental and might have glitches in some parts of code.";
4335 if ( lc($use_iframe) eq 'true' ) {
4336 $default_value = "y";
4338 $default_value = "n";
4340 print "Display html emails in iframe? (y/n) [$WHT$default_value$NRM]: $WHT";
4341 $use_iframe = <STDIN
>;
4342 if ( ( $use_iframe =~ /^y\n/i ) || ( ( $use_iframe =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4343 $use_iframe = 'true';
4345 $use_iframe = 'false';
4351 sub command_ask_user_info
{
4352 print "New users need to supply their real name and email address to\n";
4353 print "send out proper mails. When this option is enabled, a user that\n";
4354 print "logs in for the first time will be redirected to the Personal\n";
4355 print "Options screen and asked to supply their personal data.\n";
4358 if ( lc($ask_user_info) eq 'true' ) {
4359 $default_value = "y";
4361 $default_value = "n";
4363 print "Ask user info? (y/n) [$WHT$default_value$NRM]: $WHT";
4364 $ask_user_info = <STDIN
>;
4365 if ( ( $ask_user_info =~ /^y\n/i ) || ( ( $ask_user_info =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4366 $ask_user_info = 'true';
4368 $ask_user_info = 'false';
4370 return $ask_user_info;
4375 print "Enabling this option will cause icons to be used instead of text\n";
4376 print "markers next to each message in mailbox lists that represent\n";
4377 print "new, read, flagged, and deleted messages, as well as those that\n";
4378 print "have been replied to and forwarded. Icons are also used next to\n";
4379 print "(un)expanded folders in the folder list (Oldway = false). These\n";
4380 print "icons are quite small, but will obviously be more of a resource\n";
4381 print "drain than text markers.\n";
4384 if ( lc($use_icons) eq 'true' ) {
4385 $default_value = "y";
4387 $default_value = "n";
4389 print "Use icons? (y/n) [$WHT$default_value$NRM]: $WHT";
4390 $use_icons = <STDIN
>;
4391 if ( ( $use_icons =~ /^y\n/i ) || ( ( $use_icons =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4392 $use_icons = 'true';
4394 $use_icons = 'false';
4400 print "Enable this option if you want to use php recode functions to read\n";
4401 print "emails written in charset that differs from the one that is set in\n";
4402 print "translation selected by user. Code is experimental, it might cause\n";
4403 print "errors, if email contains charset unsupported by recode or if your\n";
4404 print "php does not have recode support.\n";
4407 if ( lc($use_php_recode) eq 'true' ) {
4408 $default_value = "y";
4410 $default_value = "n";
4412 print "Use php recode functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4413 $use_php_recode = <STDIN
>;
4414 if ( ( $use_php_recode =~ /^y\n/i ) || ( ( $use_php_recode =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4415 $use_php_recode = 'true';
4417 $use_php_recode = 'false';
4419 return $use_php_recode;
4423 print "Enable this option if you want to use php iconv functions to read\n";
4424 print "emails written in charset that differs from the one that is set in\n";
4425 print "translation selected by user. Code is experimental, it works only\n";
4426 print "with translations that use utf-8 charset. Code might cause errors,\n";
4427 print "if email contains charset unsupported by iconv or if your php does\n";
4428 print "not have iconv support.\n";
4431 if ( lc($use_php_iconv) eq 'true' ) {
4432 $default_value = "y";
4434 $default_value = "n";
4436 print "Use php iconv functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4437 $use_php_iconv = <STDIN
>;
4438 if ( ( $use_php_iconv =~ /^y\n/i ) || ( ( $use_php_iconv =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4439 $use_php_iconv = 'true';
4441 $use_php_iconv = 'false';
4443 return $use_php_iconv;
4448 print "In some cases, buffering all output (holding it on the server until\n";
4449 print "the full page is ready to send to the browser) allows more complex\n";
4450 print "functionality, especially for plugins that want to add headers on hooks\n";
4451 print "that are beyond the point of output having been sent to the browser\n";
4452 print "otherwise. Most plugins that need this functionality will enable it\n";
4453 print "automatically on their own, but you can turn it on manually here. You'd\n";
4454 print "usually want to do this if you want to specify a custom output handler\n";
4455 print "for parsing the output - you can do that by specifying a value for\n";
4456 print "\$buffered_output_handler in config_local.php. Don't forget to define\n";
4457 print "a function of the same name as what \$buffered_output_handler is set to.\n";
4460 if ( lc($buffer_output) eq 'true' ) {
4461 $default_value = "y";
4463 $default_value = "n";
4465 print "Buffer all output? (y/n) [$WHT$default_value$NRM]: $WHT";
4466 $buffer_output = <STDIN
>;
4467 if ( ( $buffer_output =~ /^y\n/i ) || ( ( $buffer_output =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4468 $buffer_output = 'true';
4470 $buffer_output = 'false';
4472 return $buffer_output;
4477 print "Enable this option if you want to check SquirrelMail configuration\n";
4478 print "remotely with configtest.php script.\n";
4481 if ( lc($allow_remote_configtest) eq 'true' ) {
4482 $default_value = "y";
4484 $default_value = "n";
4486 print "Allow remote configuration tests? (y/n) [$WHT$default_value$NRM]: $WHT";
4487 $allow_remote_configtest = <STDIN
>;
4488 if ( ( $allow_remote_configtest =~ /^y\n/i ) || ( ( $allow_remote_configtest =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4489 $allow_remote_configtest = 'true';
4491 $allow_remote_configtest = 'false';
4493 return $allow_remote_configtest;
4496 # Default Icon theme
4498 print "You may change the path to the default icon theme to be used, if icons\n";
4499 print "have been enabled. This theme will be used when an icon cannot be\n";
4500 print "found in the current theme, or when no icon theme is specified. If\n";
4501 print "left blank, and icons are enabled, the default theme will be used\n";
4502 print "from images/themes/default/.\n";
4504 print "To clear out an existing value, just type a space for the input.\n";
4506 print "Please be aware of the following: \n";
4507 print " - Relative URLs are relative to the config dir\n";
4508 print " to use the icon themes directory, use ../images/themes/newtheme/\n";
4509 print " - The icon theme may be outside the SquirrelMail directory, but\n";
4510 print " it must be web accessible.\n";
4511 print "[$WHT$icon_theme_def$NRM]: $WHT";
4512 $new_icon_theme_def = <STDIN
>;
4514 if ( $new_icon_theme_def eq "\n" ) {
4515 $new_icon_theme_def = $icon_theme_def;
4517 $new_icon_theme_def =~ s/[\r\n]//g;
4519 $new_icon_theme_def =~ s/^\s*//;
4520 return $new_icon_theme_def;
4523 # SquirrelMail debug mode (since 1.5.2)
4525 print "When debugging or developing SquirrelMail, you may want to increase\n";
4526 print "the verbosity of certain kinds of errors, notices, and/or diagnostics.\n";
4527 print "You may enable one or more of the debugging modes here. Please make\n";
4528 print "sure that you have turned off debugging if you are using SquirrelMail\n";
4529 print "in a production environment.\n\n";
4532 while ( $input ne "d\n" ) {
4533 $sm_debug_mode = convert_debug_constants_to_binary_integer
($sm_debug_mode);
4535 # per include/constants.php, here are the debug mode values:
4537 # 0 SM_DEBUG_MODE_OFF
4538 # 1 SM_DEBUG_MODE_SIMPLE
4539 # 512 SM_DEBUG_MODE_MODERATE
4540 # 524288 SM_DEBUG_MODE_ADVANCED
4541 # 536870912 SM_DEBUG_MODE_STRICT
4543 print "\n# Enabled? Description\n";
4544 print "---------------------------------------------------------------------\n";
4545 print "0 " . ($sm_debug_mode == 0 ?
"y" : " ")
4546 . " No debugging (recommended in production environments)\n";
4547 print "1 " . ($sm_debug_mode & 1 ?
"y" : " ")
4548 . " Simple debugging (PHP E_ERROR)\n";
4549 print "2 " . ($sm_debug_mode & 512 ?
"y" : " ")
4550 . " Moderate debugging (PHP E_ALL)\n";
4551 print "3 " . ($sm_debug_mode & 524288 ?
"y" : " ")
4552 . " Advanced debugging (PHP E_ALL plus log errors\n";
4553 print " intentionally suppressed)\n";
4554 print "4 " . ($sm_debug_mode & 536870912 ?
"y" : " ")
4555 . " Strict debugging (PHP E_STRICT)\n";
4558 print "SquirrelMail debug mode (0,1,2,3,4) or d when done? : $WHT";
4560 if ( $input eq "d\n" ) {
4562 } elsif ($input !~ /^[0-9]+\n$/) {
4563 print "\nInvalid configuration value.\n";
4564 print "\nPress enter to continue...";
4566 } elsif ( $input == "0\n" ) {
4568 } elsif ( $input == "1\n" ) {
4569 if ($sm_debug_mode & 1) {
4570 $sm_debug_mode ^= 1;
4572 $sm_debug_mode |= 1;
4574 } elsif ( $input == "2\n" ) {
4575 if ($sm_debug_mode & 512) {
4576 $sm_debug_mode ^= 512;
4578 $sm_debug_mode |= 512;
4580 } elsif ( $input == "3\n" ) {
4581 if ($sm_debug_mode & 524288) {
4582 $sm_debug_mode ^= 524288;
4584 $sm_debug_mode |= 524288;
4586 } elsif ( $input == "4\n" ) {
4587 if ($sm_debug_mode & 536870912) {
4588 $sm_debug_mode ^= 536870912;
4590 $sm_debug_mode |= 536870912;
4593 print "\nInvalid configuration value.\n";
4594 print "\nPress enter to continue...";
4599 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
4600 return $sm_debug_mode;
4603 # Secured configuration mode (since 1.5.2)
4605 print "This option allows you to enable \"Secured Configuration\" mode,\n";
4606 print "which will guarantee that certain settings made herein will be\n";
4607 print "made immutable and will not be subject to override by either friendly\n";
4608 print "or unfriendly code/plugins. Only a small number of settings herein\n";
4609 print "will be used in this manner - just those that are deemed to be a\n";
4610 print "potential security threat when rouge plugin or other code may be\n";
4611 print "executed inside SquirrelMail.\n";
4614 if ( lc($secured_config) eq 'true' ) {
4615 $default_value = "y";
4617 $default_value = "n";
4619 print "Enable secured configuration mode? (y/n) [$WHT$default_value$NRM]: $WHT";
4620 $secured_config = <STDIN
>;
4621 if ( ( $secured_config =~ /^y\n/i ) || ( ( $secured_config =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4622 $secured_config = 'true';
4624 $secured_config = 'false';
4626 return $secured_config;
4631 if ( open( CF
, ">config.php" ) ) {
4636 print CF
" * SquirrelMail Configuration File\n";
4637 print CF
" * Created using the configure script, conf.pl\n";
4641 if ($print_config_version) {
4642 print CF
"\$config_version = '$print_config_version';\n";
4645 print CF
"\$config_use_color = $config_use_color;\n";
4649 print CF
"\$org_name = \"$org_name\";\n";
4651 print CF
"\$org_logo = " . &change_to_SM_path
($org_logo) . ";\n";
4652 $org_logo_width |= 0;
4653 $org_logo_height |= 0;
4655 print CF
"\$org_logo_width = '$org_logo_width';\n";
4657 print CF
"\$org_logo_height = '$org_logo_height';\n";
4658 # string that can contain variables.
4659 print CF
"\$org_title = \"$org_title\";\n";
4661 print CF
"\$signout_page = " . &change_to_SM_path
($signout_page) . ";\n";
4663 print CF
"\$frame_top = '$frame_top';\n";
4666 print CF
"\$provider_uri = '$provider_uri';\n";
4669 print CF
"\$provider_name = '$provider_name';\n";
4672 # string that can contain variables
4673 print CF
"\$motd = \"$motd\";\n";
4677 print CF
"\$squirrelmail_default_language = '$squirrelmail_default_language';\n";
4679 print CF
"\$default_charset = '$default_charset';\n";
4681 print CF
"\$show_alternative_names = $show_alternative_names;\n";
4683 print CF
"\$aggressive_decoding = $aggressive_decoding;\n";
4685 print CF
"\$lossy_encoding = $lossy_encoding;\n";
4689 print CF
"\$domain = '$domain';\n";
4691 print CF
"\$imapServerAddress = '$imapServerAddress';\n";
4693 print CF
"\$imapPort = $imapPort;\n";
4695 print CF
"\$useSendmail = $useSendmail;\n";
4697 print CF
"\$smtpServerAddress = '$smtpServerAddress';\n";
4699 print CF
"\$smtpPort = $smtpPort;\n";
4701 print CF
"\$sendmail_path = '$sendmail_path';\n";
4703 print CF
"\$sendmail_args = '$sendmail_args';\n";
4705 # print CF "\$use_authenticated_smtp = $use_authenticated_smtp;\n";
4707 print CF
"\$pop_before_smtp = $pop_before_smtp;\n";
4709 print CF
"\$pop_before_smtp_host = '$pop_before_smtp_host';\n";
4711 print CF
"\$imap_server_type = '$imap_server_type';\n";
4713 print CF
"\$invert_time = $invert_time;\n";
4715 print CF
"\$optional_delimiter = '$optional_delimiter';\n";
4717 print CF
"\$encode_header_key = '$encode_header_key';\n";
4721 print CF
"\$default_folder_prefix = '$default_folder_prefix';\n";
4723 print CF
"\$trash_folder = '$trash_folder';\n";
4725 print CF
"\$sent_folder = '$sent_folder';\n";
4727 print CF
"\$draft_folder = '$draft_folder';\n";
4729 print CF
"\$default_move_to_trash = $default_move_to_trash;\n";
4731 print CF
"\$default_move_to_sent = $default_move_to_sent;\n";
4733 print CF
"\$default_save_as_draft = $default_save_as_draft;\n";
4735 print CF
"\$show_prefix_option = $show_prefix_option;\n";
4737 print CF
"\$list_special_folders_first = $list_special_folders_first;\n";
4739 print CF
"\$use_special_folder_color = $use_special_folder_color;\n";
4741 print CF
"\$auto_expunge = $auto_expunge;\n";
4743 print CF
"\$default_sub_of_inbox = $default_sub_of_inbox;\n";
4745 print CF
"\$show_contain_subfolders_option = $show_contain_subfolders_option;\n";
4747 print CF
"\$default_unseen_notify = $default_unseen_notify;\n";
4749 print CF
"\$default_unseen_type = $default_unseen_type;\n";
4751 print CF
"\$auto_create_special = $auto_create_special;\n";
4753 print CF
"\$delete_folder = $delete_folder;\n";
4755 print CF
"\$noselect_fix_enable = $noselect_fix_enable;\n";
4760 print CF
"\$data_dir = " . &change_to_SM_path
($data_dir) . ";\n";
4761 # string that can contain a variable
4762 print CF
"\$attachment_dir = " . &change_to_SM_path
($attachment_dir) . ";\n";
4764 print CF
"\$dir_hash_level = $dir_hash_level;\n";
4766 print CF
"\$default_left_size = '$default_left_size';\n";
4768 print CF
"\$force_username_lowercase = $force_username_lowercase;\n";
4770 print CF
"\$default_use_priority = $default_use_priority;\n";
4772 print CF
"\$hide_sm_attributions = $hide_sm_attributions;\n";
4774 print CF
"\$default_use_mdn = $default_use_mdn;\n";
4776 print CF
"\$edit_identity = $edit_identity;\n";
4778 print CF
"\$edit_name = $edit_name;\n";
4780 print CF
"\$hide_auth_header = $hide_auth_header;\n";
4782 print CF
"\$disable_thread_sort = $disable_thread_sort;\n";
4784 print CF
"\$disable_server_sort = $disable_server_sort;\n";
4786 print CF
"\$allow_charset_search = $allow_charset_search;\n";
4788 print CF
"\$allow_advanced_search = $allow_advanced_search;\n";
4791 print CF
"\$time_zone_type = $time_zone_type;\n";
4794 print CF
"\$config_location_base = '$config_location_base';\n";
4797 print CF
"\$disable_plugins = $disable_plugins;\n";
4799 print CF
"\$disable_plugins_user = '$disable_plugins_user';\n";
4802 # all plugins are strings
4803 for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
4804 print CF
"\$plugins[] = '$plugins[$ct]';\n";
4809 if ( $user_theme_default eq '' ) { $user_theme_default = '0'; }
4810 print CF
"\$user_theme_default = $user_theme_default;\n";
4812 for ( $count = 0 ; $count <= $#user_theme_name ; $count++ ) {
4813 if ($user_theme_path[$count] eq 'none') {
4816 $path = &change_to_SM_path
($user_theme_path[$count]);
4818 print CF
"\$user_themes[$count]['PATH'] = " . $path . ";\n";
4819 # escape theme name so it can contain single quotes.
4820 $esc_name = $user_theme_name[$count];
4821 $esc_name =~ s/\\/\\\\/g;
4822 $esc_name =~ s/'/\\'/g;
4823 print CF
"\$user_themes[$count]['NAME'] = '$esc_name';\n";
4827 if ( $icon_theme_def eq '' ) { $icon_theme_def = '0'; }
4828 print CF
"\$icon_theme_def = $icon_theme_def;\n";
4829 if ( $icon_theme_fallback eq '' ) { $icon_theme_fallback = '0'; }
4830 print CF
"\$icon_theme_fallback = $icon_theme_fallback;\n";
4832 for ( $count = 0 ; $count <= $#icon_theme_name ; $count++ ) {
4833 $path = $icon_theme_path[$count];
4834 if ($path eq 'none' || $path eq 'template') {
4835 $path = "'".$path."'";
4837 $path = &change_to_SM_path
($icon_theme_path[$count]);
4839 print CF
"\$icon_themes[$count]['PATH'] = " . $path . ";\n";
4840 # escape theme name so it can contain single quotes.
4841 $esc_name = $icon_theme_name[$count];
4842 $esc_name =~ s/\\/\\\\/g;
4843 $esc_name =~ s/'/\\'/g;
4844 print CF
"\$icon_themes[$count]['NAME'] = '$esc_name';\n";
4848 if ( $templateset_default eq '' ) { $templateset_default = 'default'; }
4849 print CF
"\$templateset_default = '$templateset_default';\n";
4851 if ( $templateset_fallback eq '' ) { $templateset_fallback = 'default'; }
4852 print CF
"\$templateset_fallback = '$templateset_fallback';\n";
4854 if ( $rpc_templateset eq '' ) { $rpc_templateset = 'default_rpc'; }
4855 print CF
"\$rpc_templateset = '$rpc_templateset';\n";
4857 for ( $count = 0 ; $count <= $#templateset_name ; $count++ ) {
4859 # don't include RPC template sets
4861 if ( $templateset_id[$count] =~ /_rpc$/ ) { next; }
4863 print CF
"\$aTemplateSet[$count]['ID'] = '" . $templateset_id[$count] . "';\n";
4864 # escape theme name so it can contain single quotes.
4865 $esc_name = $templateset_name[$count];
4866 $esc_name =~ s/\\/\\\\/g;
4867 $esc_name =~ s/'/\\'/g;
4868 print CF
"\$aTemplateSet[$count]['NAME'] = '$esc_name';\n";
4874 print CF
"\$default_fontsize = '$default_fontsize';\n";
4876 print CF
"\$default_fontset = '$default_fontset';\n";
4878 # assoc. array (maybe initial value should be set somewhere else)
4879 print CF
'$fontsets = array();'."\n";
4880 while (($fontset_name, $fontset_value) = each(%fontsets)) {
4881 print CF
"\$fontsets\['$fontset_name'\] = '$fontset_value';\n";
4887 print CF
"\$default_use_javascript_addr_book = $default_use_javascript_addr_book;\n";
4888 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
4889 print CF
"\$ldap_server[$count] = array(\n";
4891 print CF
" 'host' => '$ldap_host[$count]',\n";
4893 print CF
" 'base' => '$ldap_base[$count]'";
4894 if ( $ldap_name[$count] ) {
4897 print CF
" 'name' => '$ldap_name[$count]'";
4899 if ( $ldap_port[$count] ) {
4902 print CF
" 'port' => $ldap_port[$count]";
4904 if ( $ldap_charset[$count] ) {
4907 print CF
" 'charset' => '$ldap_charset[$count]'";
4909 if ( $ldap_maxrows[$count] ) {
4912 print CF
" 'maxrows' => $ldap_maxrows[$count]";
4915 if ( $ldap_filter[$count] ) {
4917 print CF
" 'filter' => '$ldap_filter[$count]'";
4919 if ( $ldap_binddn[$count] ) {
4922 print CF
" 'binddn' => '$ldap_binddn[$count]'";
4923 if ( $ldap_bindpw[$count] ) {
4926 print CF
" 'bindpw' => '$ldap_bindpw[$count]'";
4929 if ( $ldap_protocol[$count] ) {
4932 print CF
" 'protocol' => $ldap_protocol[$count]";
4934 if ( $ldap_limit_scope[$count] ) {
4937 print CF
" 'limit_scope' => $ldap_limit_scope[$count]";
4939 if ( $ldap_listing[$count] ) {
4942 print CF
" 'listing' => $ldap_listing[$count]";
4944 if ( $ldap_writeable[$count] ) {
4947 print CF
" 'writeable' => $ldap_writeable[$count]";
4949 if ( $ldap_search_tree[$count] ) {
4952 print CF
" 'search_tree' => $ldap_search_tree[$count]";
4954 if ( $ldap_listing[$count] ) {
4957 print CF
" 'starttls' => $ldap_starttls[$count]";
4965 print CF
"\$addrbook_dsn = '$addrbook_dsn';\n";
4967 print CF
"\$addrbook_table = '$addrbook_table';\n\n";
4969 print CF
"\$prefs_dsn = '$prefs_dsn';\n";
4971 print CF
"\$prefs_table = '$prefs_table';\n";
4973 print CF
"\$prefs_user_field = '$prefs_user_field';\n";
4975 print CF
"\$prefs_user_size = $prefs_user_size;\n";
4977 print CF
"\$prefs_key_field = '$prefs_key_field';\n";
4979 print CF
"\$prefs_key_size = $prefs_key_size;\n";
4981 print CF
"\$prefs_val_field = '$prefs_val_field';\n";
4983 print CF
"\$prefs_val_size = $prefs_val_size;\n\n";
4985 print CF
"\$addrbook_global_dsn = '$addrbook_global_dsn';\n";
4987 print CF
"\$addrbook_global_table = '$addrbook_global_table';\n";
4989 print CF
"\$addrbook_global_writeable = $addrbook_global_writeable;\n";
4991 print CF
"\$addrbook_global_listing = $addrbook_global_listing;\n\n";
4993 print CF
"\$abook_global_file = '$abook_global_file';\n";
4995 print CF
"\$abook_global_file_writeable = $abook_global_file_writeable;\n\n";
4997 print CF
"\$abook_global_file_listing = $abook_global_file_listing;\n\n";
4999 print CF
"\$abook_file_line_length = $abook_file_line_length;\n\n";
5001 print CF
"\$no_list_for_subscribe = $no_list_for_subscribe;\n";
5004 print CF
"\$smtp_auth_mech = '$smtp_auth_mech';\n";
5005 print CF
"\$smtp_sitewide_user = '". quote_single
($smtp_sitewide_user) ."';\n";
5006 print CF
"\$smtp_sitewide_pass = '". quote_single
($smtp_sitewide_pass) ."';\n";
5008 print CF
"\$imap_auth_mech = '$imap_auth_mech';\n";
5010 print CF
"\$use_imap_tls = $use_imap_tls;\n";
5012 print CF
"\$use_smtp_tls = $use_smtp_tls;\n";
5014 print CF
"\$session_name = '$session_name';\n";
5016 print CF
"\$only_secure_cookies = $only_secure_cookies;\n";
5021 print CF
"\$use_iframe = $use_iframe;\n";
5023 print CF
"\$ask_user_info = $ask_user_info;\n";
5025 print CF
"\$use_icons = $use_icons;\n";
5028 print CF
"\$use_php_recode = $use_php_recode;\n";
5030 print CF
"\$use_php_iconv = $use_php_iconv;\n";
5033 print CF
"\$buffer_output = $buffer_output;\n";
5036 print CF
"\$allow_remote_configtest = $allow_remote_configtest;\n";
5037 print CF
"\$secured_config = $secured_config;\n";
5038 # (binary) integer or constant - convert integer
5039 # values to constants before output
5040 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
5041 print CF
"\$sm_debug_mode = $sm_debug_mode;\n";
5046 print "Data saved in config.php\n";
5048 build_plugin_hook_array
();
5051 print "Error saving config.php: $!\n";
5057 print $WHT. "SquirrelMail Configuration : " . $NRM;
5058 if ( $config == 1 ) { print "Read: config.php"; }
5059 elsif ( $config == 2 ) { print "Read: config_default.php"; }
5061 print "---------------------------------------------------------\n";
5063 print "While we have been building SquirrelMail, we have discovered some\n";
5064 print "preferences that work better with some servers that don't work so\n";
5065 print "well with others. If you select your IMAP server, this option will\n";
5066 print "set some pre-defined settings for that server.\n";
5068 print "Please note that you will still need to go through and make sure\n";
5069 print "everything is correct. This does not change everything. There are\n";
5070 print "only a few settings that this will change.\n";
5074 while ( $continue != 1 ) {
5075 print "Please select your IMAP server:\n";
5076 print $list_supported_imap_servers;
5078 print " quit = Do not change anything\n";
5080 print "Command >> ";
5082 $server =~ s/[\r\n]//g;
5084 # variable is used to display additional messages.
5088 if ( $server eq "cyrus" ) {
5089 $imap_server_type = "cyrus";
5090 $default_folder_prefix = "";
5091 $trash_folder = "INBOX.Trash";
5092 $sent_folder = "INBOX.Sent";
5093 $draft_folder = "INBOX.Drafts";
5094 $show_prefix_option = false
;
5095 $default_sub_of_inbox = true
;
5096 $show_contain_subfolders_option = false
;
5097 $optional_delimiter = ".";
5098 $disp_default_folder_prefix = "<none>";
5099 $force_username_lowercase = false
;
5101 # Delimiter might differ if unixhierarchysep is set to yes.
5102 $message = "\nIf you have enabled unixhierarchysep, you must change delimiter and special folder names.\n";
5105 } elsif ( $server eq "uw" ) {
5106 $imap_server_type = "uw";
5107 $default_folder_prefix = "mail/";
5108 $trash_folder = "Trash";
5109 $sent_folder = "Sent";
5110 $draft_folder = "Drafts";
5111 $show_prefix_option = true
;
5112 $default_sub_of_inbox = false
;
5113 $show_contain_subfolders_option = true
;
5114 $optional_delimiter = "/";
5115 $disp_default_folder_prefix = $default_folder_prefix;
5116 $delete_folder = true
;
5117 $force_username_lowercase = true
;
5120 } elsif ( $server eq "exchange" ) {
5121 $imap_server_type = "exchange";
5122 $default_folder_prefix = "";
5123 $default_sub_of_inbox = true
;
5124 $trash_folder = "INBOX/Deleted Items";
5125 $sent_folder = "INBOX/Sent Items";
5126 $drafts_folder = "INBOX/Drafts";
5127 $show_prefix_option = false
;
5128 $show_contain_subfolders_option = false
;
5129 $optional_delimiter = "detect";
5130 $disp_default_folder_prefix = "<none>";
5131 $force_username_lowercase = true
;
5134 } elsif ( $server eq "courier" ) {
5135 $imap_server_type = "courier";
5136 $default_folder_prefix = "INBOX.";
5137 $trash_folder = "Trash";
5138 $sent_folder = "Sent";
5139 $draft_folder = "Drafts";
5140 $show_prefix_option = false
;
5141 $default_sub_of_inbox = false
;
5142 $show_contain_subfolders_option = false
;
5143 $optional_delimiter = ".";
5144 $disp_default_folder_prefix = $default_folder_prefix;
5145 $delete_folder = true
;
5146 $force_username_lowercase = false
;
5149 } elsif ( $server eq "macosx" ) {
5150 $imap_server_type = "macosx";
5151 $default_folder_prefix = "INBOX/";
5152 $trash_folder = "Trash";
5153 $sent_folder = "Sent";
5154 $draft_folder = "Drafts";
5155 $show_prefix_option = false
;
5156 $default_sub_of_inbox = true
;
5157 $show_contain_subfolders_option = false
;
5158 $optional_delimiter = "detect";
5159 $allow_charset_search = false
;
5160 $disp_default_folder_prefix = $default_folder_prefix;
5163 } elsif ( $server eq "hmailserver" ) {
5164 $imap_server_type = "hmailserver";
5165 $default_folder_prefix = "";
5166 $trash_folder = "INBOX.Trash";
5167 $sent_folder = "INBOX.Sent";
5168 $draft_folder = "INBOX.Drafts";
5169 $show_prefix_option = false
;
5170 $default_sub_of_inbox = true
;
5171 $show_contain_subfolders_option = false
;
5172 $optional_delimiter = "detect";
5173 $allow_charset_search = false
;
5174 $disp_default_folder_prefix = $default_folder_prefix;
5175 $delete_folder = false
;
5176 $force_username_lowercase = false
;
5179 } elsif ( $server eq "mercury32" ) {
5180 $imap_server_type = "mercury32";
5181 $default_folder_prefix = "";
5182 $trash_folder = "Trash";
5183 $sent_folder = "Sent";
5184 $draft_folder = "Drafts";
5185 $show_prefix_option = false
;
5186 $default_sub_of_inbox = true
;
5187 $show_contain_subfolders_option = true
;
5188 $optional_delimiter = "detect";
5189 $delete_folder = true
;
5190 $force_username_lowercase = true
;
5193 } elsif ( $server eq "dovecot" ) {
5194 $imap_server_type = "dovecot";
5195 $default_folder_prefix = "";
5196 $trash_folder = "Trash";
5197 $sent_folder = "Sent";
5198 $draft_folder = "Drafts";
5199 $show_prefix_option = false
;
5200 $default_sub_of_inbox = false
;
5201 $show_contain_subfolders_option = false
;
5202 $delete_folder = false
;
5203 $force_username_lowercase = true
;
5204 $optional_delimiter = "detect";
5205 $disp_default_folder_prefix = "<none>";
5208 } elsif ( $server eq "bincimap" ) {
5209 $imap_server_type = "bincimap";
5210 $default_folder_prefix = "INBOX/";
5211 $trash_folder = "Trash";
5212 $sent_folder = "Sent";
5213 $draft_folder = "Drafts";
5214 $show_prefix_option = false
;
5215 $default_sub_of_inbox = false
;
5216 $show_contain_subfolders_option = false
;
5217 $delete_folder = true
;
5218 $force_username_lowercase = false
;
5219 $optional_delimiter = "detect";
5220 $disp_default_folder_prefix = $default_folder_prefix;
5222 # Default folder prefix depends on used depot.
5223 $message = "\nIf you use IMAPdir depot, you must set default folder prefix to empty string.\n";
5226 } elsif ( $server eq "quit" ) {
5229 $disp_default_folder_prefix = $default_folder_prefix;
5230 print "Unrecognized server: $server\n";
5234 print " imap_server_type = $imap_server_type\n";
5235 print " default_folder_prefix = $disp_default_folder_prefix\n";
5236 print " trash_folder = $trash_folder\n";
5237 print " sent_folder = $sent_folder\n";
5238 print " draft_folder = $draft_folder\n";
5239 print " show_prefix_option = $show_prefix_option\n";
5240 print " default_sub_of_inbox = $default_sub_of_inbox\n";
5241 print "show_contain_subfolders_option = $show_contain_subfolders_option\n";
5242 print " optional_delimiter = $optional_delimiter\n";
5243 print " delete_folder = $delete_folder\n";
5244 print " force_username_lowercase = $force_username_lowercase\n";
5248 print "\nPress enter to continue...";
5252 # This subroutine corrects relative paths to ensure they
5253 # will work within the SM space. If the path falls within
5254 # the SM directory tree, the SM_PATH variable will be
5255 # prepended to the path, if not, then the path will be
5256 # converted to an absolute path, e.g.
5257 # '../images/logo.gif' --> SM_PATH . 'images/logo.gif'
5258 # '../../someplace/data' --> '/absolute/path/someplace/data'
5259 # 'images/logo.gif' --> SM_PATH . 'config/images/logo.gif'
5260 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
5261 # 'http://whatever/' --> 'http://whatever'
5262 # $some_var/path --> "$some_var/path"
5263 sub change_to_SM_path
() {
5264 my ($old_path) = @_;
5270 # If the path is absolute, don't bother.
5271 return "\'" . $old_path . "\'" if ( $old_path eq '');
5272 return "\'" . $old_path . "\'" if ( $old_path =~ /^(\/|http
)/ );
5273 return "\'" . $old_path . "\'" if ( $old_path =~ /^\w:\// );
5274 return $old_path if ( $old_path =~ /^\'(\/|http
)/ );
5275 return $old_path if ( $old_path =~ /^\'\w:\// );
5276 return $old_path if ( $old_path =~ /^SM_PATH/);
5278 if ( $old_path =~ /^\$/ ) {
5279 # check if it's a single var, or a $var/path combination
5280 # if it's $var/path, enclose in ""
5281 if ( $old_path =~ /\// ) {
5282 return '"'.$old_path.'"';
5287 # Remove remaining '
5288 $old_path =~ s/\'//g;
5290 # For relative paths, split on '../'
5291 @rel_path = split(/\.\.\//, $old_path);
5293 if ( $#rel_path > 1 ) {
5294 # more than two levels away. Make it absolute.
5295 @abs_path = split(/\//, $dir);
5297 # Lop off the relative pieces of the absolute path..
5298 for ( $i = 0; $i <= $#rel_path; $i++ ) {
5302 push @abs_path, @rel_path;
5303 $new_path = "\'" . join('/', @abs_path) . "\'";
5304 } elsif ( $#rel_path > 0 ) {
5305 # it's within the SM tree, prepend SM_PATH
5306 $new_path = $old_path;
5307 $new_path =~ s/^\.\.\//SM_PATH
. \'/;
5310 # Last, it's a relative path without any leading '.'
5311 # Prepend SM_PATH and config, since the paths are
5312 # relative to the config directory
5313 $new_path = "SM_PATH . \'config/" . $old_path . "\'";
5319 # Change SM_PATH to admin-friendly version, e.g.:
5320 # SM_PATH . 'images/logo.gif' --> '../images/logo.gif'
5321 # SM_PATH . 'config/some.php' --> 'some.php'
5322 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
5323 # 'http://whatever/' --> 'http://whatever'
5324 sub change_to_rel_path
() {
5325 my ($old_path) = @_;
5326 my $new_path = $old_path;
5328 if ( $old_path =~ /^SM_PATH/ ) {
5329 # FIXME: the following replacement loses the opening quote mark!
5330 $new_path =~ s/^SM_PATH . \'/\.\.\//;
5331 $new_path =~ s/\.\.\/config\///;
5337 # Attempts to auto-detect if a specific auth mechanism is supported.
5338 # Called by 'command112a' and 'command112b'
5339 # ARGS: service-name (IMAP or SMTP), host:port, mech-name (ie. CRAM-MD5)
5340 sub detect_auth_support
{
5341 # Try loading IO::Socket
5342 unless (eval("use IO::Socket; 1")) {
5343 print "Perl IO::Socket module is not available.";
5347 my $service = shift;
5351 if ((!defined($service)) or (!defined($host)) or (!defined($mech))) {
5352 # Error - wrong # of args
5353 print "BAD ARGS!\n";
5357 if ($service eq 'SMTP') {
5358 $cmd = "AUTH $mech\r\n";
5359 $logout = "QUIT\r\n";
5360 } elsif ($service eq 'IMAP') {
5361 $cmd = "A01 AUTHENTICATE $mech\n";
5362 $logout = "C01 LOGOUT\n";
5364 # unknown service - whoops.
5368 # Get this show on the road
5369 my $sock=IO
::Socket
::INET
->new($host);
5370 if (!defined($sock)) {
5374 my $discard = <$sock>; # Server greeting/banner - who cares..
5376 if ($service eq 'SMTP') {
5378 print $sock "HELO $domain\r\n";
5379 $discard = <$sock>; # Yeah yeah, you're happy to see me..
5383 my $response = <$sock>;
5385 if (!defined($response)) {
5389 # So at this point, we have a response, and it is (hopefully) valid.
5390 if ($service eq 'SMTP') {
5391 if (!($response =~ /^334/)) {
5393 print $sock $logout;
5397 } elsif ($service eq 'IMAP') {
5398 if ($response =~ /^A01/) {
5400 print $sock $logout;
5405 # Unknown service - this shouldn't be able to happen.
5410 # If it gets here, the mech is supported
5411 print $sock "*\n"; # Attempt to cancel authentication
5412 print $sock $logout; # Try to log out, but we don't really care if this fails
5418 # Example code from O'Reilly Perl Cookbook
5425 return wantarray ?
@out : $out[0];
5428 sub clear_screen
() {
5429 if ( $^O
=~ /^mswin/i) {
5436 # checks IMAP mailbox name. Refuses to accept 8bit folders
5437 # returns 0 (folder name is not correct) or 1 (folder name is correct)
5438 sub check_imap_folder
($) {
5439 my $folder_name = shift(@_);
5441 if ($folder_name =~ /[\x80-\xFFFF]/) {
5442 print "Folder name contains 8bit characters. Configuration utility requires\n";
5443 print "UTF7-IMAP encoded folder names.\n";
5444 print "Press enter to continue...";
5447 } elsif ($folder_name =~ /[&\*\%]/) {
5448 # check for ampersand and list-wildcards
5449 print "Folder name contains special UTF7-IMAP characters.\n";
5450 print "Are you sure that folder name is correct? (y/N): ";
5452 $tmp = lc(trim
($tmp));
5453 if ($tmp =~ /^y$/) {
5463 # quotes string written in single quotes
5464 sub quote_single
($) {
5465 my $string = shift(@_);
5466 $string =~ s/\'/\\'/g;
5470 # determine a plugin's version number
5472 # parses the setup.php file, looking for the
5473 # version string in the <plugin>_info() or the
5474 # <plugin>_version functions.
5476 sub get_plugin_version
() {
5478 my $plugin_name = shift(@_);
5480 $setup_file = '../plugins/' . $plugin_name . '/setup.php';
5481 if ( -e
"$setup_file" ) {
5482 # Make sure that file is readable
5483 if (! -r
"$setup_file") {
5486 print "The file \"$setup_file\" was found, but you don't\n";
5487 print "have rights to read it. The plugin \"";
5488 print $plugin_name . "\" may not work correctly until you fix this.\n";
5489 print "\nPress enter to continue";
5496 # FIXME: grep the file instead of reading it into memory?
5498 open( FILE
, "$setup_file" );
5499 while ( $line = <FILE
> ) {
5500 $whole_file .= $line;
5504 # ideally, there is a version in the <plugin>_info function...
5506 if ($whole_file =~ /('version'\s*=>\s*['"](.*?)['"])/) {
5509 # this assumes there is only one function that returns
5510 # a static string in the setup file
5512 } elsif ($whole_file =~ /(return\s*['"](.*?)['"])/) {
5521 print "The file \"$setup_file\" was not found.\n";
5522 print "The plugin \"" . $plugin_name;
5523 print "\" may not work correctly until you fix this.\n";
5524 print "\nPress enter to continue";
5532 # determine a plugin's English name
5534 # parses the setup.php file, looking for the
5535 # English name in the <plugin>_info() function.
5537 sub get_plugin_english_name
() {
5539 my $plugin_name = shift(@_);
5541 $setup_file = '../plugins/' . $plugin_name . '/setup.php';
5542 if ( -e
"$setup_file" ) {
5543 # Make sure that file is readable
5544 if (! -r
"$setup_file") {
5547 print "The file \"$setup_file\" was found, but you don't\n";
5548 print "have rights to read it. The plugin \"";
5549 print $plugin_name . "\" may not work correctly until you fix this.\n";
5550 print "\nPress enter to continue";
5557 # FIXME: grep the file instead of reading it into memory?
5559 open( FILE
, "$setup_file" );
5560 while ( $line = <FILE
> ) {
5561 $whole_file .= $line;
5565 # the English name is in the <plugin>_info function or nothing...
5567 if ($whole_file =~ /('english_name'\s*=>\s*['"](.*?)['"])/) {
5568 $english_name .= $2;
5571 return $english_name;
5576 print "The file \"$setup_file\" was not found.\n";
5577 print "The plugin \"" . $plugin_name;
5578 print "\" may not work correctly until you fix this.\n";
5579 print "\nPress enter to continue";
5587 # parses the setup.php files for all activated plugins and
5588 # builds static plugin hooks array so we don't have to load
5589 # ALL plugins are runtime and build the hook array on every
5592 # hook array is saved in config/plugin_hooks.php
5594 # Note the $verbose variable at the top of this routine
5595 # can be set to zero to quiet it down.
5597 # NOTE/FIXME: we aren't necessarily interested in writing
5598 # a full-blown PHP parsing engine, so plenty
5599 # of assumptions are included herein about the
5600 # coding of the plugin setup files, and things
5601 # like commented out curly braces or other
5602 # such oddities can break this in a bad way.
5604 sub build_plugin_hook_array
() {
5612 if ( open( HOOKFILE
, ">plugin_hooks.php" ) ) {
5613 print HOOKFILE
"<?php\n";
5614 print HOOKFILE
"\n";
5616 print HOOKFILE
"/**\n";
5617 print HOOKFILE
" * SquirrelMail Plugin Hook Registration File\n";
5618 print HOOKFILE
" * Auto-generated using the configure script, conf.pl\n";
5619 print HOOKFILE
" */\n";
5620 print HOOKFILE
"\n";
5621 print HOOKFILE
"global \$squirrelmail_plugin_hooks;\n";
5622 print HOOKFILE
"\n";
5624 PLUGIN
: for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
5627 print "Activating plugin \"" . $plugins[$ct] . "\"...\n";
5630 $setup_file = '../plugins/' . $plugins[$ct] . '/setup.php';
5631 if ( -e
"$setup_file" ) {
5632 # Make sure that file is readable
5633 if (! -r
"$setup_file") {
5636 print "The file \"$setup_file\" was found, but you don't\n";
5637 print "have rights to read it. The plugin \"";
5638 print $plugins[$ct] . "\" will not be activated until you fix this.\n";
5639 print "\nPress enter to continue";
5644 open( FILE
, "$setup_file" );
5645 $inside_init_fxn = 0;
5647 while ( $line = <FILE
> ) {
5649 # throw away lines until we get to target function
5651 if (!$inside_init_fxn
5652 && $line !~ /^\s*function\s*squirrelmail_plugin_init_/i) {
5655 $inside_init_fxn = 1;
5665 # count close braces
5670 # leaving <plugin>_init() function...
5671 if ($brace_count == 0) {
5679 # throw away lines that are not exactly one "brace set" deep
5681 if ($brace_count > 1) {
5686 # also not interested in lines that are not
5687 # hook registration points
5689 if ($line !~ /^\s*\$squirrelmail_plugin_hooks/i) {
5694 # if $line does not have an ending semicolon,
5695 # we need to recursively read in subsequent
5696 # lines until we find one
5697 while ( $line !~ /;\s*$/ ) {
5698 $line =~ s/[\n\r]\s*$//;
5707 $var =~ s/=/EQUALS/;
5708 if ( $var =~ /^([a-z])/i ) {
5709 @options = split ( /\s*EQUALS\s*/, $var );
5710 $options[1] =~ s/[\n\r]//g;
5711 $options[1] =~ s/[\'\"];\s*$//;
5712 $options[1] =~ s/;$//;
5713 $options[1] =~ s/^[\'\"]//;
5714 # de-escape escaped strings
5715 $options[1] =~ s/\\'/'/g;
5716 $options[1] =~ s/\\\\/\\/g;
5718 if ( $options[0] =~ /^squirrelmail_plugin_hooks\s*\[\s*['"]([a-z0-9 \/._
*-]+)['"]\s*\]\s*\[\s*['"]([0-9a-z._-]+)['"]\s
*\
]/i
) {
5720 $hooked_plugin_name = $2;
5721 # Note: if we wanted to stop plugins from registering
5722 # a *different* plugin on a hook, we could catch
5723 # it here, however this has actually proven to be
5724 # a useful *feature*
5725 #if ($hooked_plugin_name ne $plugins[$ct]) {
5726 # print "...plugin is tring to hook in under different name...\n";
5729 #FIXME: do we want to count the number of hook registrations for each plugin and warn if a plugin doesn't have any?
5730 # hook registration has been found!
5732 if ($hooked_plugin_name ne $plugins[$ct]) {
5733 print " registering on hook \"" . $hook_name . "\" (as \"$hooked_plugin_name\" plugin)\n";
5735 print " registering on hook \"" . $hook_name . "\"\n";
5738 $line =~ s/ {2,}/ /g;
5740 print HOOKFILE
"\$$line";
5752 print "The file \"$setup_file\" was not found.\n";
5753 print "The plugin \"" . $plugins[$ct];
5754 print "\" will not be activated until you fix this.\n";
5755 print "\nPress enter to continue";
5763 print HOOKFILE
"\n\n";
5766 print "\nDone activating plugins; registration data saved in plugin_hooks.php\n\n";
5773 print "The file \"plugin_hooks.php\" was not able to be written to.\n";
5774 print "No plugins will be activated until you fix this.\n";
5775 print "\nPress enter to continue";
5783 # converts (binary) integer values that correspond
5784 # to the SquirrelMail debug mode constants (see
5785 # include/constants.php) into those constant strings
5786 # (bitwise or'd if more than one is enabled)
5788 # if the value passed in is not an integer, it is
5789 # returned unmolested
5791 sub convert_debug_binary_integer_to_constants
() {
5793 my ($debug_mode) = @_;
5794 if ($debug_mode =~ /^[^0-9]/) {
5797 $debug_mode = int($debug_mode);
5798 $new_debug_mode = '';
5800 # per include/constants.php, here are their values:
5802 # 0 SM_DEBUG_MODE_OFF
5803 # 1 SM_DEBUG_MODE_SIMPLE
5804 # 512 SM_DEBUG_MODE_MODERATE
5805 # 524288 SM_DEBUG_MODE_ADVANCED
5806 # 536870912 SM_DEBUG_MODE_STRICT
5808 if ($debug_mode & 1) {
5809 $new_debug_mode .= ' | SM_DEBUG_MODE_SIMPLE';
5811 if ($debug_mode & 512) {
5812 $new_debug_mode .= ' | SM_DEBUG_MODE_MODERATE';
5814 if ($debug_mode & 524288) {
5815 $new_debug_mode .= ' | SM_DEBUG_MODE_ADVANCED';
5817 if ($debug_mode & 536870912) {
5818 $new_debug_mode .= ' | SM_DEBUG_MODE_STRICT';
5821 $new_debug_mode =~ s/^ \| //;
5822 if (!$new_debug_mode) {
5823 $new_debug_mode = 'SM_DEBUG_MODE_OFF';
5826 return $new_debug_mode;
5829 # converts SquirrelMail debug mode constants (see
5830 # include/constants.php) into their corresponding
5831 # (binary) integer values
5833 # if the value passed in is an integer already, it
5834 # is returned unmolested
5836 sub convert_debug_constants_to_binary_integer
() {
5838 my ($debug_mode) = @_;
5839 if ($debug_mode =~ /^[0-9]/) {
5842 $new_debug_mode = 0;
5844 # per include/constants.php, here are their values:
5846 # 0 SM_DEBUG_MODE_OFF
5847 # 1 SM_DEBUG_MODE_SIMPLE
5848 # 512 SM_DEBUG_MODE_MODERATE
5849 # 524288 SM_DEBUG_MODE_ADVANCED
5850 # 536870912 SM_DEBUG_MODE_STRICT
5852 if ($debug_mode =~ /\bSM_DEBUG_MODE_OFF\b/) {
5853 $new_debug_mode = 0;
5855 if ($debug_mode =~ /\bSM_DEBUG_MODE_SIMPLE\b/) {
5856 $new_debug_mode |= 1;
5858 if ($debug_mode =~ /\bSM_DEBUG_MODE_MODERATE\b/) {
5859 $new_debug_mode |= 512;
5861 if ($debug_mode =~ /\bSM_DEBUG_MODE_ADVANCED\b/) {
5862 $new_debug_mode |= 524288;
5864 if ($debug_mode =~ /\bSM_DEBUG_MODE_STRICT\b/) {
5865 $new_debug_mode |= 536870912;
5868 return $new_debug_mode;
5871 # Function to print n column numbered lists
5873 # WARNING: the names in the list will be truncated
5874 # to fit in their respective columns based on the
5875 # screen width and number of columns.
5877 # Expected arguments (in this order):
5879 # * The start number to use for the list
5880 # * The number of columns to use
5881 # * The screen width
5882 # * Boolean (zero/one), indicating
5883 # whether or not to show item numbers
5884 # * The list of strings to be shown
5886 # Returns: The number printed on screen of the last item in the list
5888 sub print_multi_col_list
{
5889 my ($num, $cols, $screen_width, $show_numbering, @list) = @_;
5899 $rows = int(@list / $cols);
5900 if (@list % $cols) { $rows++; }
5901 if ($show_numbering) { $col_width = int(($screen_width - 2) / $cols) - 5; }
5902 else { $col_width = int(($screen_width - 2) / $cols) - 2; }
5904 # build the layout array so numbers run down each column
5906 for ( $x = 0; $x < @list; $x++ ) {
5908 $layout[$row_cnt][$col_cnt] = $list[$x];
5909 $numbers[$row_cnt][$col_cnt] = $num++;
5911 # move to next column
5913 if ($row_cnt == $rows - 1) {
5917 else { $row_cnt++; }
5921 # if we filled up fewer rows than needed, recalc column width
5923 if ($rows * $col_cnt == @list) { $col_cnt--; } # loop above ended right after increment
5924 if ($col_cnt + 1 < $cols) {
5925 if ($show_numbering) { $col_width = int(($screen_width - 2) / ($col_cnt + 1)) - 5; }
5926 else { $col_width = int(($screen_width - 2) / ($col_cnt + 1)) - 2; }
5932 for ( $row_cnt = 0; $row_cnt <= $rows; $row_cnt++ ) {
5938 # iterate columns for this row
5940 for ( $col_cnt = 0; $col_cnt <= $cols; $col_cnt++ ) {
5941 if ($layout[$row_cnt][$col_cnt]) {
5943 if ($show_numbering) { printf "$WHT% 2u.$NRM", $numbers[$row_cnt][$col_cnt]; }
5944 printf " %-$col_width." . $col_width . "s", $layout[$row_cnt][$col_cnt];