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 # FIXME: unknown introduction date
372 $useSendmail = 'false' if ( lc($useSendmail) ne 'true' );
373 $sendmail_path = "/usr/sbin/sendmail" if ( !$sendmail_path );
374 $pop_before_smtp = 'false' if ( !$pop_before_smtp );
375 $default_unseen_notify = 2 if ( !$default_unseen_notify );
376 $default_unseen_type = 1 if ( !$default_unseen_type );
377 $config_use_color = 0 if ( !$config_use_color );
378 $invert_time = 'false' if ( !$invert_time );
379 $force_username_lowercase = 'false' if ( !$force_username_lowercase );
380 $optional_delimiter = "detect" if ( !$optional_delimiter );
381 $auto_create_special = 'false' if ( !$auto_create_special );
382 $default_use_priority = 'true' if ( !$default_use_priority );
383 $default_use_mdn = 'true' if ( !$default_use_mdn );
384 $delete_folder = 'false' if ( !$delete_folder );
385 $noselect_fix_enable = 'false' if ( !$noselect_fix_enable );
386 $frame_top = "_top" if ( !$frame_top );
387 $provider_uri = '' if ( !$provider_uri );
388 $provider_name = '' if ( !$provider_name || $provider_name eq 'SquirrelMail');
389 $no_list_for_subscribe = 'false' if ( !$no_list_for_subscribe );
390 $allow_charset_search = 'true' if ( !$allow_charset_search );
391 $allow_advanced_search = 0 if ( !$allow_advanced_search) ;
392 $prefs_user_field = 'user' if ( !$prefs_user_field );
393 $prefs_key_field = 'prefkey' if ( !$prefs_key_field );
394 $prefs_val_field = 'prefval' if ( !$prefs_val_field );
395 $session_name = 'SQMSESSID' if ( !$session_name );
396 $skip_SM_header = 'false' if ( !$skip_SM_header );
397 $default_use_javascript_addr_book = 'false' if (! $default_use_javascript_addr_book);
400 $hide_sm_attributions = 'false' if ( !$hide_sm_attributions );
402 $edit_identity = 'true' if ( !$edit_identity );
403 $edit_name = 'true' if ( !$edit_name );
406 $use_smtp_tls= 'false' if ( !$use_smtp_tls);
407 $smtp_auth_mech = 'none' if ( !$smtp_auth_mech );
408 $use_imap_tls = 'false' if ( !$use_imap_tls );
409 $imap_auth_mech = 'login' if ( !$imap_auth_mech );
412 $show_alternative_names = 'false' if ( !$show_alternative_names );
413 # $available_languages option available only in 1.5.0. removed due to $languages
414 # implementation changes. options are provided by limit_languages plugin
415 # $available_languages = 'all' if ( !$available_languages );
416 $aggressive_decoding = 'false' if ( !$aggressive_decoding );
417 # available only in 1.5.0 and 1.5.1
418 # $advanced_tree = 'false' if ( !$advanced_tree );
419 $use_php_recode = 'false' if ( !$use_php_recode );
420 $use_php_iconv = 'false' if ( !$use_php_iconv );
423 $use_icons = 'false' if ( !$use_icons );
424 $use_iframe = 'false' if ( !$use_iframe );
425 $lossy_encoding = 'false' if ( !$lossy_encoding );
426 $allow_remote_configtest = 'false' if ( !$allow_remote_configtest );
427 $secured_config = 'true' if ( !$secured_config );
429 $sm_debug_mode = 'SM_DEBUG_MODE_MODERATE' if ( !$sm_debug_mode );
430 #FIXME: When this is STABLE software, remove the line above and uncomment the one below:
431 #$sm_debug_mode = 'SM_DEBUG_MODE_OFF' if ( !$sm_debug_mode );
432 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
434 $addrbook_global_table = 'global_abook' if ( !$addrbook_global_table );
435 $addrbook_global_writeable = 'false' if ( !$addrbook_global_writeable );
436 $addrbook_global_listing = 'false' if ( !$addrbook_global_listing );
437 $abook_global_file = '' if ( !$abook_global_file);
438 $abook_global_file_writeable = 'false' if ( !$abook_global_file_writeable);
439 $abook_global_file_listing = 'true' if ( !$abook_global_file_listing );
440 $encode_header_key = '' if ( !$encode_header_key );
441 $hide_auth_header = 'false' if ( !$hide_auth_header );
442 $time_zone_type = '0' if ( !$time_zone_type );
443 $prefs_user_size = 128 if ( !$prefs_user_size );
444 $prefs_key_size = 64 if ( !$prefs_key_size );
445 $prefs_val_size = 65536 if ( !$prefs_val_size );
447 # add qmail-inject test here for backwards compatibility
448 if ( !$sendmail_args && $sendmail_path =~ /qmail-inject/ ) {
450 } elsif ( !$sendmail_args ) {
451 $sendmail_args = '-i -t';
454 $default_fontsize = '' if ( !$default_fontsize);
455 $default_fontset = '' if ( !$default_fontset);
457 %fontsets = ('serif', 'serif',
458 'sans', 'helvetica,arial,sans-serif',
459 'comicsans', 'comic sans ms,sans-serif',
460 'tahoma', 'tahoma,sans-serif',
461 'verasans', 'bitstream vera sans,verdana,sans-serif');
464 # $use_imap_tls and $use_smtp_tls are switched to integer since 1.5.1
465 $use_imap_tls = 0 if ( $use_imap_tls eq 'false');
466 $use_imap_tls = 1 if ( $use_imap_tls eq 'true');
467 $use_smtp_tls = 0 if ( $use_smtp_tls eq 'false');
468 $use_smtp_tls = 1 if ( $use_smtp_tls eq 'true');
469 # sorting options changed names and reversed values in 1.5.1
470 $disable_thread_sort = 'false' if ( !$disable_thread_sort );
471 $disable_server_sort = 'false' if ( !$disable_server_sort );
474 $abook_file_line_length = 2048 if ( !$abook_file_line_length );
475 $config_location_base = '' if ( !$config_location_base );
476 $smtp_sitewide_user = '' if ( !$smtp_sitewide_user );
477 $smtp_sitewide_pass = '' if ( !$smtp_sitewide_pass );
478 $icon_theme_def = '' if ( !$icon_theme_def );
479 $disable_plugins = 'false' if ( !$disable_plugins );
480 $disable_plugins_user = '' if ( !$disable_plugins_user );
481 $only_secure_cookies = 'true' if ( !$only_secure_cookies );
482 $ask_user_info = 'true' if ( !$ask_user_info );
484 if ( $ARGV[0] eq '--install-plugin' ) {
485 print "Activating plugin " . $ARGV[1] . "\n";
486 if ( -d
"../plugins/" . $ARGV[1]) {
487 push @plugins, $ARGV[1];
491 print "No such plugin.\n";
494 } elsif ( $ARGV[0] eq '--remove-plugin' ) {
495 print "Removing plugin " . $ARGV[1] . "\n";
496 foreach $plugin (@plugins) {
497 if ( $plugin ne $ARGV[1] ) {
498 push @newplugins, $plugin;
501 @plugins = @newplugins;
504 } elsif ( $ARGV[0] eq '--update-plugins' or $ARGV[0] eq '-u') {
505 build_plugin_hook_array
();
507 } elsif ( $ARGV[0] eq '--help' or $ARGV[0] eq '-h') {
508 print "SquirrelMail Configuration Script\n";
510 print " * No arguments: initiates the configuration dialog\n";
511 print " * --install-plugin <plugin> : activates the specified plugin\n";
512 print " * --remove-plugin <plugin> : deactivates the specified plugin\n";
513 print " * --update-plugins , -u : rebuilds plugin_hooks.php according\n";
514 print " to plugins activated in config.php\n";
515 print " * --help , -h : Displays this help\n";
522 ####################################################################################
524 # used in multiple places, define once
525 $list_supported_imap_servers =
526 " bincimap = Binc IMAP server\n" .
527 " courier = Courier IMAP server\n" .
528 " cyrus = Cyrus IMAP server\n" .
529 " dovecot = Dovecot Secure IMAP server\n" .
530 " exchange = Microsoft Exchange IMAP server\n" .
531 " hmailserver = hMailServer\n" .
532 " macosx = Mac OS X Mailserver\n" .
533 " mercury32 = Mercury/32\n" .
534 " uw = University of Washington's IMAP server\n";
536 #####################################################################################
537 if ( $config_use_color == 1 ) {
543 $config_use_color = 2;
546 # lists can be printed in more than one column; default is just one
551 while ( ( $command ne "q" ) && ( $command ne "Q" ) && ( $command ne ":q" ) ) {
553 print $WHT. "SquirrelMail Configuration : " . $NRM;
554 if ( $config == 1 ) { print "Read: config.php"; }
555 elsif ( $config == 2 ) { print "Read: config_default.php"; }
556 print " ($print_config_version)\n";
557 print "---------------------------------------------------------\n";
560 print $WHT. "Main Menu --\n" . $NRM;
561 print "1. Organization Preferences\n";
562 print "2. Server Settings\n";
563 print "3. Folder Defaults\n";
564 print "4. General Options\n";
565 print "5. User Interface\n";
566 print "6. Address Books\n";
567 print "7. Message of the Day (MOTD)\n";
568 print "8. Plugins\n";
569 print "9. Database\n";
570 print "10. Language settings\n";
571 print "11. Tweaks\n";
573 print "D. Set pre-defined settings for specific IMAP servers\n";
575 } elsif ( $menu == 1 ) {
576 print $WHT. "Organization Preferences\n" . $NRM;
577 print "1. Organization Name : $WHT$org_name$NRM\n";
578 print "2. Organization Logo : $WHT$org_logo$NRM\n";
579 print "3. Org. Logo Width/Height : $WHT($org_logo_width/$org_logo_height)$NRM\n";
580 print "4. Organization Title : $WHT$org_title$NRM\n";
581 print "5. Signout Page : $WHT$signout_page$NRM\n";
582 print "6. Top Frame : $WHT$frame_top$NRM\n";
583 print "7. Provider link : $WHT$provider_uri$NRM\n";
584 print "8. Provider link text : $WHT$provider_name$NRM\n";
587 print "R Return to Main Menu\n";
588 } elsif ( $menu == 2 ) {
589 print $WHT. "Server Settings\n\n" . $NRM;
590 print $WHT . "General" . $NRM . "\n";
592 print "1. Domain : $WHT$domain$NRM\n";
593 print "2. Invert Time : $WHT$invert_time$NRM\n";
594 print "3. Sendmail or SMTP : $WHT";
595 if ( lc($useSendmail) eq 'true' ) {
603 if ( $show_imap_settings ) {
604 print $WHT . "IMAP Settings". $NRM . "\n--------------\n";
605 print "4. IMAP Server : $WHT$imapServerAddress$NRM\n";
606 print "5. IMAP Port : $WHT$imapPort$NRM\n";
607 print "6. Authentication type : $WHT$imap_auth_mech$NRM\n";
608 print "7. Secure IMAP (TLS) : $WHT" . display_use_tls
($use_imap_tls) . "$NRM\n";
609 print "8. Server software : $WHT$imap_server_type$NRM\n";
610 print "9. Delimiter : $WHT$optional_delimiter$NRM\n";
612 } elsif ( $show_smtp_settings ) {
613 if ( lc($useSendmail) eq 'true' ) {
614 print $WHT . "Sendmail" . $NRM . "\n--------\n";
615 print "4. Sendmail Path : $WHT$sendmail_path$NRM\n";
616 print "5. Sendmail arguments : $WHT$sendmail_args$NRM\n";
617 print "6. Header encryption key : $WHT$encode_header_key$NRM\n";
620 print $WHT . "SMTP Settings" . $NRM . "\n-------------\n";
621 print "4. SMTP Server : $WHT$smtpServerAddress$NRM\n";
622 print "5. SMTP Port : $WHT$smtpPort$NRM\n";
623 print "6. POP before SMTP : $WHT$pop_before_smtp$NRM\n";
624 print "7. SMTP Authentication : $WHT$smtp_auth_mech" . display_smtp_sitewide_userpass
() ."$NRM\n";
625 print "8. Secure SMTP (TLS) : $WHT" . display_use_tls
($use_smtp_tls) . "$NRM\n";
626 print "9. Header encryption key : $WHT$encode_header_key$NRM\n";
631 if ($show_imap_settings == 0) {
632 print "A. Update IMAP Settings : ";
633 print "$WHT$imapServerAddress$NRM:";
634 print "$WHT$imapPort$NRM ";
635 print "($WHT$imap_server_type$NRM)\n";
637 if ($show_smtp_settings == 0) {
638 if ( lc($useSendmail) eq 'true' ) {
639 print "B. Change Sendmail Config : $WHT$sendmail_path$NRM\n";
641 print "B. Update SMTP Settings : ";
642 print "$WHT$smtpServerAddress$NRM:";
643 print "$WHT$smtpPort$NRM\n";
646 if ( $show_smtp_settings || $show_imap_settings )
649 ($show_imap_settings ?
"IMAP Server" :
650 (lc($useSendmail) eq 'true') ?
"Sendmail" : "SMTP") . " Settings\n";
654 print "R Return to Main Menu\n";
655 } elsif ( $menu == 3 ) {
656 print $WHT. "Folder Defaults\n" . $NRM;
657 print "1. Default Folder Prefix : $WHT$default_folder_prefix$NRM\n";
658 print "2. Show Folder Prefix Option : $WHT$show_prefix_option$NRM\n";
659 print "3. Trash Folder : $WHT$trash_folder$NRM\n";
660 print "4. Sent Folder : $WHT$sent_folder$NRM\n";
661 print "5. Drafts Folder : $WHT$draft_folder$NRM\n";
662 print "6. By default, move to trash : $WHT$default_move_to_trash$NRM\n";
663 print "7. By default, save sent messages : $WHT$default_move_to_sent$NRM\n";
664 print "8. By default, save as draft : $WHT$default_save_as_draft$NRM\n";
665 print "9. List Special Folders First : $WHT$list_special_folders_first$NRM\n";
666 print "10. Show Special Folders Color : $WHT$use_special_folder_color$NRM\n";
667 print "11. Auto Expunge : $WHT$auto_expunge$NRM\n";
668 print "12. Default Sub. of INBOX : $WHT$default_sub_of_inbox$NRM\n";
669 print "13. Show 'Contain Sub.' Option : $WHT$show_contain_subfolders_option$NRM\n";
670 print "14. Default Unseen Notify : $WHT$default_unseen_notify$NRM\n";
671 print "15. Default Unseen Type : $WHT$default_unseen_type$NRM\n";
672 print "16. Auto Create Special Folders : $WHT$auto_create_special$NRM\n";
673 print "17. Folder Delete Bypasses Trash : $WHT$delete_folder$NRM\n";
674 print "18. Enable /NoSelect folder fix : $WHT$noselect_fix_enable$NRM\n";
676 print "R Return to Main Menu\n";
677 } elsif ( $menu == 4 ) {
678 print $WHT. "General Options\n" . $NRM;
679 print "1. Data Directory : $WHT$data_dir$NRM\n";
680 print "2. Attachment Directory : $WHT$attachment_dir$NRM\n";
681 print "3. Directory Hash Level : $WHT$dir_hash_level$NRM\n";
682 print "4. Default Left Size : $WHT$default_left_size$NRM\n";
683 print "5. Usernames in Lowercase : $WHT$force_username_lowercase$NRM\n";
684 print "6. Allow use of priority : $WHT$default_use_priority$NRM\n";
685 print "7. Hide SM attributions : $WHT$hide_sm_attributions$NRM\n";
686 print "8. Allow use of receipts : $WHT$default_use_mdn$NRM\n";
687 print "9. Allow editing of identity : $WHT$edit_identity$NRM\n";
688 print " Allow editing of name : $WHT$edit_name$NRM\n";
689 print " Remove username from header : $WHT$hide_auth_header$NRM\n";
690 print "10. Disable server thread sort : $WHT$disable_thread_sort$NRM\n";
691 print "11. Disable server-side sorting : $WHT$disable_server_sort$NRM\n";
692 print "12. Allow server charset search : $WHT$allow_charset_search$NRM\n";
693 print "13. Allow advanced search : $WHT$allow_advanced_search$NRM\n";
694 print "14. PHP session name : $WHT$session_name$NRM\n";
695 print "15. Time zone configuration : $WHT$time_zone_type$NRM\n";
696 print "16. Location base : $WHT$config_location_base$NRM\n";
697 print "17. Only secure cookies if poss. : $WHT$only_secure_cookies$NRM\n";
699 print "R Return to Main Menu\n";
700 } elsif ( $menu == 5 ) {
701 print $WHT. "User Interface\n" . $NRM;
702 print "1. Use Icons? : $WHT$use_icons$NRM\n";
703 # print "3. Default Icon Set : $WHT$icon_theme_def$NRM\n";
704 print "2. Default font size : $WHT$default_fontsize$NRM\n";
705 print "3. Manage template sets (skins)\n";
706 print "4. Manage user themes\n";
707 print "5. Manage font sets\n";
708 print "6. Manage icon themes\n";
711 print "R Return to Main Menu\n";
712 } elsif ( $menu == 6 ) {
713 print $WHT. "Address Books\n" . $NRM;
714 print "1. Change LDAP Servers\n";
715 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
716 print " > $ldap_host[$count]\n";
718 print "2. Use Javascript address book search : $WHT$default_use_javascript_addr_book$NRM\n";
719 print "3. Global address book file : $WHT$abook_global_file$NRM\n";
720 print "4. Allow writing into global file address book : $WHT$abook_global_file_writeable$NRM\n";
721 print "5. Allow listing of global file address book : $WHT$abook_global_file_listing$NRM\n";
722 print "6. Allowed address book line length : $WHT$abook_file_line_length$NRM\n";
724 print "R Return to Main Menu\n";
725 } elsif ( $menu == 7 ) {
726 print $WHT. "Message of the Day (MOTD)\n" . $NRM;
729 print "1 Edit the MOTD\n";
731 print "R Return to Main Menu\n";
732 } elsif ( $menu == 8 ) {
733 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
734 print $WHT. "Plugins (WARNING: All plugins are currently disabled\n for the user \"$disable_plugins_user\"!)\n" . $NRM;
735 } elsif (lc($disable_plugins) eq 'true') {
736 print $WHT. "Plugins (WARNING: All plugins are currently disabled!)\n" . $NRM;
738 print $WHT. "Plugins\n" . $NRM;
740 print " Installed Plugins\n";
742 $num = print_multi_col_list
(1, $columns, $screen_width, 1, @plugins);
745 for ( $count = 0 ; $count <= $#plugins ; $count++ ) {
747 $english_name = get_plugin_english_name
($plugins[$count]);
748 if ( $english_name eq "" ) {
749 print " $WHT$num.$NRM $plugins[$count]" . get_plugin_version
($plugins[$count]) . "\n";
751 print " $WHT$num.$NRM $english_name ($plugins[$count])" . get_plugin_version
($plugins[$count]) . "\n";
755 print "\n Available Plugins:\n";
756 opendir( DIR
, "../plugins" );
757 @files = sort(readdir(DIR
));
759 @unused_plugins = ();
760 for ( $i = 0 ; $i <= $#files ; $i++ ) {
761 if ( -d
"../plugins/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne ".svn" ) {
763 for ( $k = 0 ; $k <= $#plugins ; $k++ ) {
764 if ( $plugins[$k] eq $files[$i] ) {
769 $unused_plugins[$pos] = $files[$i];
776 $num = print_multi_col_list
($num + 1, $columns, $screen_width, 1, @unused_plugins);
778 for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
780 $english_name = get_plugin_english_name
($unused_plugins[$i]);
781 if ( $english_name eq "" ) {
782 print " $WHT$num.$NRM $unused_plugins[$i]" . get_plugin_version
($unused_plugins[$i]) . "\n";
784 print " $WHT$num.$NRM $english_name ($unused_plugins[$i])" . get_plugin_version
($unused_plugins[$i]) . "\n";
791 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
792 print "E Enable active plugins (all plugins currently\n disabled for the user \"$disable_plugins_user\")\n";
793 } elsif (lc($disable_plugins) eq 'true') {
794 print "E Enable active plugins (all plugins currently\n disabled)\n";
796 print "D Disable all plugins\n";
798 print "U Set the user for whom plugins can be disabled\n";
799 print "R Return to Main Menu\n";
800 print "C# List plugins in <#> number of columns\n";
801 print "W# Change screen width to <#>\n";
802 } elsif ( $menu == 9 ) {
803 print $WHT. "Database\n" . $NRM;
804 print "1. DSN for Address Book : $WHT$addrbook_dsn$NRM\n";
805 print "2. Table for Address Book : $WHT$addrbook_table$NRM\n";
807 print "3. DSN for Preferences : $WHT$prefs_dsn$NRM\n";
808 print "4. Table for Preferences : $WHT$prefs_table$NRM\n";
809 print "5. Field for username : $WHT$prefs_user_field$NRM ($prefs_user_size)\n";
810 print "6. Field for prefs key : $WHT$prefs_key_field$NRM ($prefs_key_size)\n";
811 print "7. Field for prefs value : $WHT$prefs_val_field$NRM ($prefs_val_size)\n";
813 print "8. DSN for Global Address Book : $WHT$addrbook_global_dsn$NRM\n";
814 print "9. Table for Global Address Book : $WHT$addrbook_global_table$NRM\n";
815 print "10. Allow writing into Global Address Book : $WHT$addrbook_global_writeable$NRM\n";
816 print "11. Allow listing of Global Address Book : $WHT$addrbook_global_listing$NRM\n";
818 print "R Return to Main Menu\n";
819 } elsif ( $menu == 10 ) {
820 print $WHT. "Language settings\n" . $NRM;
821 print "1. Default Language : $WHT$squirrelmail_default_language$NRM\n";
822 print "2. Default Charset : $WHT$default_charset$NRM\n";
823 print "3. Show alternative language names : $WHT$show_alternative_names$NRM\n";
824 print "4. Enable aggressive decoding : $WHT$aggressive_decoding$NRM\n";
825 print "5. Enable lossy encoding : $WHT$lossy_encoding$NRM\n";
827 print "R Return to Main Menu\n";
828 } elsif ( $menu == 11 ) {
829 print $WHT. "Interface tweaks\n" . $NRM;
830 print "1. Display html mails in iframe : $WHT$use_iframe$NRM\n";
831 print "2. Ask user info on first login : $WHT$ask_user_info$NRM\n";
833 print $WHT. "PHP tweaks\n" . $NRM;
834 print "4. Use php recode functions : $WHT$use_php_recode$NRM\n";
835 print "5. Use php iconv functions : $WHT$use_php_iconv$NRM\n";
837 print $WHT. "Configuration tweaks\n" . $NRM;
838 print "6. Allow remote configtest : $WHT$allow_remote_configtest$NRM\n";
839 print "7. Debug mode : $WHT$sm_debug_mode$NRM\n";
840 print "8. Secured configuration mode : $WHT$secured_config$NRM\n";
842 print "R Return to Main Menu\n";
844 if ( $config_use_color == 1 ) {
845 print "C Turn color off\n";
847 print "C Turn color on\n";
849 print "S Save data\n";
853 print "Command >> " . $WHT;
855 $command =~ s/[\n\r]//g;
856 $command =~ tr/A-Z/a-z/;
859 # Read the commands they entered.
860 if ( $command eq "r" ) {
862 } elsif ( $command eq "s" ) {
864 print "Press enter to continue...";
867 } elsif ( ( $command eq "q" ) && ( $saved == 0 ) ) {
868 print "You have not saved your data.\n";
869 print "Save? [" . $WHT . "Y" . $NRM . "/n]: ";
871 if ( ( $save =~ /^y/i ) || ( $save =~ /^\s*$/ ) ) {
874 } elsif ( $command eq "c" ) {
875 if ( $config_use_color == 1 ) {
876 $config_use_color = 2;
880 $config_use_color = 1;
884 } elsif ( $command =~ /^w([0-9]+)/ ) {
886 } elsif ( $command eq "d" && $menu == 0 ) {
891 if ( ( $command > 0 ) && ( $command < 12 ) ) {
894 } elsif ( $menu == 1 ) {
895 if ( $command == 1 ) { $org_name = command1
(); }
896 elsif ( $command == 2 ) { $org_logo = command2
(); }
897 elsif ( $command == 3 ) { ($org_logo_width,$org_logo_height) = command2a
(); }
898 elsif ( $command == 4 ) { $org_title = command3
(); }
899 elsif ( $command == 5 ) { $signout_page = command4
(); }
900 elsif ( $command == 6 ) { $frame_top = command6
(); }
901 elsif ( $command == 7 ) { $provider_uri = command7
(); }
902 elsif ( $command == 8 ) { $provider_name = command8
(); }
904 } elsif ( $menu == 2 ) {
905 if ( $command eq "a" ) { $show_imap_settings = 1; $show_smtp_settings = 0; }
906 elsif ( $command eq "b" ) { $show_imap_settings = 0; $show_smtp_settings = 1; }
907 elsif ( $command eq "h" ) { $show_imap_settings = 0; $show_smtp_settings = 0; }
908 elsif ( $command <= 3 ) {
909 if ( $command == 1 ) { $domain = command11
(); }
910 elsif ( $command == 2 ) { $invert_time = command110
(); }
911 elsif ( $command == 3 ) { $useSendmail = command14
(); }
912 $show_imap_settings = 0; $show_smtp_settings = 0;
913 } elsif ( $show_imap_settings ) {
914 if ( $command == 4 ) { $imapServerAddress = command12
(); }
915 elsif ( $command == 5 ) { $imapPort = command13
(); }
916 elsif ( $command == 6 ) { $imap_auth_mech = command112a
(); }
917 elsif ( $command == 7 ) { $use_imap_tls = command_use_tls
("IMAP",$use_imap_tls); }
918 elsif ( $command == 8 ) { $imap_server_type = command19
(); }
919 elsif ( $command == 9 ) { $optional_delimiter = command111
(); }
920 } elsif ( $show_smtp_settings && lc($useSendmail) eq 'true' ) {
921 if ( $command == 4 ) { $sendmail_path = command15
(); }
922 elsif ( $command == 5 ) { $sendmail_args = command_sendmail_args
(); }
923 elsif ( $command == 6 ) { $encode_header_key = command114
(); }
924 } elsif ( $show_smtp_settings ) {
925 if ( $command == 4 ) { $smtpServerAddress = command16
(); }
926 elsif ( $command == 5 ) { $smtpPort = command17
(); }
927 elsif ( $command == 6 ) { $pop_before_smtp = command18a
(); }
928 elsif ( $command == 7 ) { $smtp_auth_mech = command112b
(); }
929 elsif ( $command == 8 ) { $use_smtp_tls = command_use_tls
("SMTP",$use_smtp_tls); }
930 elsif ( $command == 9 ) { $encode_header_key = command114
(); }
932 } elsif ( $menu == 3 ) {
933 if ( $command == 1 ) { $default_folder_prefix = command21
(); }
934 elsif ( $command == 2 ) { $show_prefix_option = command22
(); }
935 elsif ( $command == 3 ) { $trash_folder = command23a
(); }
936 elsif ( $command == 4 ) { $sent_folder = command23b
(); }
937 elsif ( $command == 5 ) { $draft_folder = command23c
(); }
938 elsif ( $command == 6 ) { $default_move_to_trash = command24a
(); }
939 elsif ( $command == 7 ) { $default_move_to_sent = command24b
(); }
940 elsif ( $command == 8 ) { $default_save_as_draft = command24c
(); }
941 elsif ( $command == 9 ) { $list_special_folders_first = command27
(); }
942 elsif ( $command == 10 ) { $use_special_folder_color = command28
(); }
943 elsif ( $command == 11 ) { $auto_expunge = command29
(); }
944 elsif ( $command == 12 ) { $default_sub_of_inbox = command210
(); }
945 elsif ( $command == 13 ) { $show_contain_subfolders_option = command211
(); }
946 elsif ( $command == 14 ) { $default_unseen_notify = command212
(); }
947 elsif ( $command == 15 ) { $default_unseen_type = command213
(); }
948 elsif ( $command == 16 ) { $auto_create_special = command214
(); }
949 elsif ( $command == 17 ) { $delete_folder = command215
(); }
950 elsif ( $command == 18 ) { $noselect_fix_enable = command216
(); }
951 } elsif ( $menu == 4 ) {
952 if ( $command == 1 ) { $data_dir = command33a
(); }
953 elsif ( $command == 2 ) { $attachment_dir = command33b
(); }
954 elsif ( $command == 3 ) { $dir_hash_level = command33c
(); }
955 elsif ( $command == 4 ) { $default_left_size = command35
(); }
956 elsif ( $command == 5 ) { $force_username_lowercase = command36
(); }
957 elsif ( $command == 6 ) { $default_use_priority = command37
(); }
958 elsif ( $command == 7 ) { $hide_sm_attributions = command38
(); }
959 elsif ( $command == 8 ) { $default_use_mdn = command39
(); }
960 elsif ( $command == 9 ) { $edit_identity = command310
(); }
961 elsif ( $command == 10 ) { $disable_thread_sort = command312
(); }
962 elsif ( $command == 11 ) { $disable_server_sort = command313
(); }
963 elsif ( $command == 12 ) { $allow_charset_search = command314
(); }
964 elsif ( $command == 13 ) { $allow_advanced_search = command316
(); }
965 elsif ( $command == 14 ) { $session_name = command317
(); }
966 elsif ( $command == 15 ) { $time_zone_type = command318
(); }
967 elsif ( $command == 16 ) { $config_location_base = command_config_location_base
(); }
968 elsif ( $command == 17 ) { $only_secure_cookies = command319
(); }
969 } elsif ( $menu == 5 ) {
970 if ( $command == 1 ) { $use_icons = commandB3
(); }
971 # elsif ( $command == 3 ) { $icon_theme_def = commandB7(); }
972 elsif ( $command == 2 ) { $default_fontsize = command_default_fontsize
(); }
973 elsif ( $command == 3 ) { $templateset_default = command_templates
(); }
974 elsif ( $command == 4 ) { command_userThemes
(); }
975 elsif ( $command == 5 ) { command_fontsets
(); }
976 elsif ( $command == 6 ) { command_iconSets
(); }
977 } elsif ( $menu == 6 ) {
978 if ( $command == 1 ) { command61
(); }
979 elsif ( $command == 2 ) { command62
(); }
980 elsif ( $command == 3 ) { $abook_global_file=command63
(); }
981 elsif ( $command == 4 ) { command64
(); }
982 elsif ( $command == 5 ) { command65
(); }
983 elsif ( $command == 6 ) { command_abook_file_line_length
(); }
984 } elsif ( $menu == 7 ) {
985 if ( $command == 1 ) { $motd = command71
(); }
986 } elsif ( $menu == 8 ) {
987 if ( $command =~ /^[0-9]+/ ) { @plugins = command81
(); }
988 elsif ( $command eq "u" ) { $disable_plugins_user = command82
(); }
989 elsif ( $command eq "d" ) { $disable_plugins = 'true'; }
990 elsif ( $command eq "e" ) { $disable_plugins = 'false'; }
991 elsif ( $command =~ /^c([0-9]+)/ ) { $columns = $1; }
992 } elsif ( $menu == 9 ) {
993 if ( $command == 1 ) { $addrbook_dsn = command91
(); }
994 elsif ( $command == 2 ) { $addrbook_table = command92
(); }
995 elsif ( $command == 3 ) { $prefs_dsn = command93
(); }
996 elsif ( $command == 4 ) { $prefs_table = command94
(); }
997 elsif ( $command == 5 ) { $prefs_user_field = command95
(); }
998 elsif ( $command == 6 ) { $prefs_key_field = command96
(); }
999 elsif ( $command == 7 ) { $prefs_val_field = command97
(); }
1000 elsif ( $command == 8 ) { $addrbook_global_dsn = command98
(); }
1001 elsif ( $command == 9 ) { $addrbook_global_table = command99
(); }
1002 elsif ( $command == 10 ) { $addrbook_global_writeable = command910
(); }
1003 elsif ( $command == 11 ) { $addrbook_global_listing = command911
(); }
1004 } elsif ( $menu == 10 ) {
1005 if ( $command == 1 ) { $squirrelmail_default_language = commandA1
(); }
1006 elsif ( $command == 2 ) { $default_charset = commandA2
(); }
1007 elsif ( $command == 3 ) { $show_alternative_names = commandA3
(); }
1008 elsif ( $command == 4 ) { $aggressive_decoding = commandA4
(); }
1009 elsif ( $command == 5 ) { $lossy_encoding = commandA5
(); }
1010 } elsif ( $menu == 11 ) {
1011 if ( $command == 1 ) { $use_iframe = commandB2
(); }
1012 elsif ( $command == 2 ) { $ask_user_info = command_ask_user_info
(); }
1013 elsif ( $command == 4 ) { $use_php_recode = commandB4
(); }
1014 elsif ( $command == 5 ) { $use_php_iconv = commandB5
(); }
1015 elsif ( $command == 6 ) { $allow_remote_configtest = commandB6
(); }
1016 elsif ( $command == 7 ) { $sm_debug_mode = commandB8
(); }
1017 elsif ( $command == 8 ) { $secured_config = commandB9
(); }
1023 print "\nExiting conf.pl.\n".
1024 "You might want to test your configuration by browsing to\n".
1025 "http://your-squirrelmail-location/src/configtest.php\n".
1026 "Happy SquirrelMailing!\n\n";
1029 ####################################################################################
1033 print "We have tried to make the name SquirrelMail as transparent as\n";
1034 print "possible. If you set up an organization name, most places where\n";
1035 print "SquirrelMail would take credit will be credited to your organization.\n";
1037 print "If your Organization Name includes a '\$', please precede it with a \\. \n";
1038 print "Other '\$' will be considered the beginning of a variable that\n";
1039 print "must be defined before the \$org_name is printed.\n";
1041 print "[$WHT$org_name$NRM]: $WHT";
1042 $new_org_name = <STDIN
>;
1043 if ( $new_org_name eq "\n" ) {
1044 $new_org_name = $org_name;
1046 $new_org_name =~ s/[\r\n]//g;
1047 $new_org_name =~ s/\"/"/g;
1049 return $new_org_name;
1054 print "Your organization's logo is an image that will be displayed at\n";
1055 print "different times throughout SquirrelMail. ";
1057 print "Please be aware of the following: \n";
1058 print " - Relative URLs are relative to the config dir\n";
1059 print " to use the default logo, use ../images/sm_logo.png\n";
1060 print " - To specify a logo defined outside the SquirrelMail source tree\n";
1061 print " use the absolute URL the webserver would use to include the file\n";
1062 print " e.g. http://example.com/images/mylogo.gif or /images/mylogo.jpg\n";
1064 print "[$WHT$org_logo$NRM]: $WHT";
1065 $new_org_logo = <STDIN
>;
1066 if ( $new_org_logo eq "\n" ) {
1067 $new_org_logo = $org_logo;
1069 $new_org_logo =~ s/[\r\n]//g;
1071 return $new_org_logo;
1076 print "Your organization's logo is an image that will be displayed at\n";
1077 print "different times throughout SquirrelMail. Width\n";
1078 print "and Height of your logo image. Use '0' to disable.\n";
1080 print "Width: [$WHT$org_logo_width$NRM]: $WHT";
1081 $new_org_logo_width = <STDIN
>;
1082 $new_org_logo_width =~ tr/0-9//cd; # only want digits!
1083 if ( $new_org_logo_width eq '' ) {
1084 $new_org_logo_width = $org_logo_width;
1086 if ( $new_org_logo_width > 0 ) {
1087 print "Height: [$WHT$org_logo_height$NRM]: $WHT";
1088 $new_org_logo_height = <STDIN
>;
1089 $new_org_logo_height =~ tr/0-9//cd; # only want digits!
1090 if( $new_org_logo_height eq '' ) {
1091 $new_org_logo_height = $org_logo_height;
1094 $new_org_logo_height = 0;
1096 return ($new_org_logo_width, $new_org_logo_height);
1101 print "A title is what is displayed at the top of the browser window in\n";
1102 print "the titlebar. Usually this will end up looking something like:\n";
1103 print "\"Netscape: $org_title\"\n";
1105 print "If your Organization Title includes a '\$', please precede it with a \\. \n";
1106 print "Other '\$' will be considered the beginning of a variable that\n";
1107 print "must be defined before the \$org_title is printed.\n";
1109 print "[$WHT$org_title$NRM]: $WHT";
1110 $new_org_title = <STDIN
>;
1111 if ( $new_org_title eq "\n" ) {
1112 $new_org_title = $org_title;
1114 $new_org_title =~ s/[\r\n]//g;
1115 $new_org_title =~ s/\"/\'/g;
1117 return $new_org_title;
1122 print "When users click the Sign Out button they will be logged out and\n";
1123 print "then sent to signout_page. If signout_page is left empty,\n";
1124 print "(hit space and then return) they will be taken, as normal,\n";
1125 print "to the default and rather sparse SquirrelMail signout page.\n";
1127 print "[$WHT$signout_page$NRM]: $WHT";
1128 $new_signout_page = <STDIN
>;
1129 if ( $new_signout_page eq "\n" ) {
1130 $new_signout_page = $signout_page;
1132 $new_signout_page =~ s/[\r\n]//g;
1133 $new_signout_page =~ s/^\s+$//g;
1135 return $new_signout_page;
1140 print "SquirrelMail defaults to using the whole of the browser window.\n";
1141 print "This allows you to keep it within a specified frame. The default\n";
1142 print "is '_top'\n";
1144 print "[$WHT$frame_top$NRM]: $WHT";
1145 $new_frame_top = <STDIN
>;
1146 if ( $new_frame_top eq "\n" ) {
1147 $new_frame_top = '_top';
1149 $new_frame_top =~ s/[\r\n]//g;
1150 $new_frame_top =~ s/^\s+$//g;
1152 return $new_frame_top;
1155 # Default link to provider
1157 print "Here you can set the link on the top-right of the message list.\n";
1158 print "If empty, it will not be displayed.\n";
1160 print "[$WHT$provider_uri$NRM]: $WHT";
1161 $new_provider_uri = <STDIN
>;
1162 if ( $new_provider_uri eq "\n" ) {
1163 $new_provider_uri = '';
1165 $new_provider_uri =~ s/[\r\n]//g;
1166 $new_provider_uri =~ s/^\s+$//g;
1168 return $new_provider_uri;
1172 print "Here you can set the name of the link on the top-right of the message list.\n";
1173 print "The default is empty (do not display anything).'\n";
1175 print "[$WHT$provider_name$NRM]: $WHT";
1176 $new_provider_name = <STDIN
>;
1177 if ( $new_provider_name eq "\n" ) {
1178 $new_provider_name = '';
1180 $new_provider_name =~ s/[\r\n]//g;
1181 $new_provider_name =~ s/^\s+$//g;
1182 $new_provider_name =~ s/\'/\\'/g;
1184 return $new_provider_name;
1187 ####################################################################################
1191 print "The domain name is the suffix at the end of all email addresses. If\n";
1192 print "for example, your email address is jdoe\@example.com, then your domain\n";
1193 print "would be example.com.\n";
1195 print "[$WHT$domain$NRM]: $WHT";
1196 $new_domain = <STDIN
>;
1197 if ( $new_domain eq "\n" ) {
1198 $new_domain = $domain;
1200 $new_domain =~ s/\s//g;
1207 print "This is the hostname where your IMAP server can be contacted.\n";
1208 print "[$WHT$imapServerAddress$NRM]: $WHT";
1209 $new_imapServerAddress = <STDIN
>;
1210 if ( $new_imapServerAddress eq "\n" ) {
1211 $new_imapServerAddress = $imapServerAddress;
1213 $new_imapServerAddress =~ s/[\r\n]//g;
1215 return $new_imapServerAddress;
1220 print "This is the port that your IMAP server is on. Usually this is 143.\n";
1221 print "[$WHT$imapPort$NRM]: $WHT";
1222 $new_imapPort = <STDIN
>;
1223 if ( $new_imapPort eq "\n" ) {
1224 $new_imapPort = $imapPort;
1226 $new_imapPort =~ s/[\r\n]//g;
1228 return $new_imapPort;
1233 print "You now need to choose the method that you will use for sending\n";
1234 print "messages in SquirrelMail. You can either connect to an SMTP server\n";
1235 print "or use sendmail directly.\n";
1236 if ( lc($useSendmail) eq 'true' ) {
1237 $default_value = "1";
1239 $default_value = "2";
1242 print " 1. Sendmail\n";
1244 print "Your choice [1/2] [$WHT$default_value$NRM]: $WHT";
1245 $use_sendmail = <STDIN
>;
1246 if ( ( $use_sendmail =~ /^1\n/i )
1247 || ( ( $use_sendmail =~ /^\n/ ) && ( $default_value eq "1" ) ) ) {
1248 $useSendmail = 'true';
1250 $useSendmail = 'false';
1252 return $useSendmail;
1257 print "Specify where the sendmail executable is located. Usually /usr/sbin/sendmail\n";
1258 print "[$WHT$sendmail_path$NRM]: $WHT";
1259 $new_sendmail_path = <STDIN
>;
1260 if ( $new_sendmail_path eq "\n" ) {
1261 $new_sendmail_path = $sendmail_path;
1263 $new_sendmail_path =~ s/[\r\n]//g;
1265 return $new_sendmail_path;
1268 # Extra sendmail arguments
1269 sub command_sendmail_args
{
1270 print "Specify additional sendmail program arguments.\n";
1272 print "Make sure that arguments are supported by your sendmail program. -f argument \n";
1273 print "is added automatically by SquirrelMail scripts. Variable defaults to standard\n";
1274 print "/usr/sbin/sendmail arguments. If you use qmail-inject, nbsmtp or any other \n";
1275 print "sendmail wrapper, which does not support -i and -t arguments, set variable to\n";
1276 print "empty string or use arguments suitable for your mailer.\n";
1278 print "[$WHT$sendmail_args$NRM]: $WHT";
1279 $new_sendmail_args = <STDIN
>;
1280 if ( $new_sendmail_args eq "\n" ) {
1281 $new_sendmail_args = $sendmail_args;
1283 # strip linefeeds and crs.
1284 $new_sendmail_args =~ s/[\r\n]//g;
1286 return trim
($new_sendmail_args);
1291 print "This is the hostname of your SMTP server.\n";
1292 print "[$WHT$smtpServerAddress$NRM]: $WHT";
1293 $new_smtpServerAddress = <STDIN
>;
1294 if ( $new_smtpServerAddress eq "\n" ) {
1295 $new_smtpServerAddress = $smtpServerAddress;
1297 $new_smtpServerAddress =~ s/[\r\n]//g;
1299 return $new_smtpServerAddress;
1304 print "This is the port to connect to for SMTP. Usually 25.\n";
1305 print "[$WHT$smtpPort$NRM]: $WHT";
1306 $new_smtpPort = <STDIN
>;
1307 if ( $new_smtpPort eq "\n" ) {
1308 $new_smtpPort = $smtpPort;
1310 $new_smtpPort =~ s/[\r\n]//g;
1312 return $new_smtpPort;
1317 print "Do you wish to use POP3 before SMTP? Your server must\n";
1318 print "support this in order for SquirrelMail to work with it.\n";
1321 $YesNo = 'y' if ( lc($pop_before_smtp) eq 'true' );
1323 print "Use pop before SMTP (y/n) [$WHT$YesNo$NRM]: $WHT";
1325 $new_pop_before_smtp = <STDIN
>;
1326 $new_pop_before_smtp =~ tr/yn//cd;
1327 return 'true' if ( $new_pop_before_smtp eq "y" );
1328 return 'false' if ( $new_pop_before_smtp eq "n" );
1329 return $pop_before_smtp;
1334 print "Each IMAP server has its own quirks. As much as we tried to stick\n";
1335 print "to standards, it doesn't help much if the IMAP server doesn't follow\n";
1336 print "the same principles. We have made some work-arounds for some of\n";
1337 print "these servers. If you would like to use them, please select your\n";
1338 print "IMAP server. If you do not wish to use these work-arounds, you can\n";
1339 print "set this to \"other\", and none will be used.\n";
1340 print $list_supported_imap_servers;
1342 print " other = Not one of the above servers\n";
1344 print "[$WHT$imap_server_type$NRM]: $WHT";
1345 $new_imap_server_type = <STDIN
>;
1347 if ( $new_imap_server_type eq "\n" ) {
1348 $new_imap_server_type = $imap_server_type;
1350 $new_imap_server_type =~ s/[\r\n]//g;
1352 return $new_imap_server_type;
1357 print "Sometimes the date of messages sent is messed up (off by a few hours\n";
1358 print "on some machines). Typically this happens if the system doesn't support\n";
1359 print "tm_gmtoff. It will happen only if your time zone is \"negative\".\n";
1360 print "This most often occurs on Solaris 7 machines in the United States.\n";
1361 print "By default, this is off. It should be kept off unless problems surface\n";
1362 print "about the time that messages are sent.\n";
1363 print " no = Do NOT fix time -- almost always correct\n";
1364 print " yes = Fix the time for this system\n";
1367 $YesNo = 'y' if ( lc($invert_time) eq 'true' );
1369 print "Fix the time for this system (y/n) [$WHT$YesNo$NRM]: $WHT";
1371 $new_invert_time = <STDIN
>;
1372 $new_invert_time =~ tr/yn//cd;
1373 return 'true' if ( $new_invert_time eq "y" );
1374 return 'false' if ( $new_invert_time eq "n" );
1375 return $invert_time;
1379 print "This is the delimiter that your IMAP server uses to distinguish between\n";
1380 print "folders. For example, Cyrus uses '.' as the delimiter and a complete\n";
1381 print "folder would look like 'INBOX.Friends.Bob', while UW uses '/' and would\n";
1382 print "look like 'INBOX/Friends/Bob'. Normally this should be left at 'detect'\n";
1383 print "but if you are sure you know what delimiter your server uses, you can\n";
1384 print "specify it here.\n";
1385 print "\nTo have it autodetect the delimiter, set it to 'detect'.\n\n";
1386 print "[$WHT$optional_delimiter$NRM]: $WHT";
1387 $new_optional_delimiter = <STDIN
>;
1389 if ( $new_optional_delimiter eq "\n" ) {
1390 $new_optional_delimiter = $optional_delimiter;
1392 $new_optional_delimiter =~ s/[\r\n]//g;
1394 return $new_optional_delimiter;
1396 # IMAP authentication type
1397 # Possible values: login, plain, cram-md5, digest-md5
1398 # Now offers to detect supported mechs, assuming server & port are set correctly
1401 if ($use_imap_tls ne "0") {
1402 # 1. Script does not handle TLS.
1403 # 2. Server does not have to declare all supported authentication mechs when
1404 # STARTTLS is used. Supported mechs are declared only after STARTTLS.
1405 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1407 print "If you have already set the hostname and port number, I can try to\n";
1408 print "detect the mechanisms your IMAP server supports.\n";
1409 print "I will try to detect CRAM-MD5 and DIGEST-MD5 support. I can't test\n";
1410 print "for \"login\" or \"plain\" without knowing a username and password.\n";
1411 print "Auto-detecting is optional - you can safely say \"n\" here.\n";
1412 print "\nTry to detect supported mechanisms? [y/N]: ";
1415 if ($inval =~ /^y\b/i) {
1416 # Yes, let's try to detect.
1417 print "Trying to detect IMAP capabilities...\n";
1418 my $host = $imapServerAddress . ':'. $imapPort;
1419 print "CRAM-MD5:\t";
1420 my $tmp = detect_auth_support
('IMAP',$host,'CRAM-MD5');
1421 if (defined($tmp)) {
1422 if ($tmp eq 'YES') {
1423 print "$WHT SUPPORTED$NRM\n";
1425 print "$WHT NOT SUPPORTED$NRM\n";
1428 print $WHT . " ERROR DETECTING$NRM\n";
1431 print "DIGEST-MD5:\t";
1432 $tmp = detect_auth_support
('IMAP',$host,'DIGEST-MD5');
1433 if (defined($tmp)) {
1434 if ($tmp eq 'YES') {
1435 print "$WHT SUPPORTED$NRM\n";
1437 print "$WHT NOT SUPPORTED$NRM\n";
1440 print $WHT . " ERROR DETECTING$NRM\n";
1445 print "\nWhat authentication mechanism do you want to use for IMAP connections?\n\n";
1446 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1447 print $WHT . "plain" . $NRM . " - SASL PLAIN. If you need this, you already know it.\n";
1448 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext methods.\n";
1449 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1450 print "\n*** YOUR IMAP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n";
1451 print "If you don't understand or are unsure, you probably want \"login\"\n\n";
1452 print "login, plain, cram-md5, or digest-md5 [$WHT$imap_auth_mech$NRM]: $WHT";
1455 if ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) || ($inval =~ /^login\b/i) || ($inval =~ /^plain\b/i)) {
1458 # user entered garbage or default value so nothing needs to be set
1459 return $imap_auth_mech;
1464 # SMTP authentication type
1465 # Possible choices: none, plain, cram-md5, digest-md5
1467 if ($use_smtp_tls ne "0") {
1468 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1469 } elsif (eval ("use IO::Socket; 1")) {
1470 # try loading IO::Socket module
1471 print "If you have already set the hostname and port number, I can try to\n";
1472 print "automatically detect some of the mechanisms your SMTP server supports.\n";
1473 print "Auto-detection is *optional* - you can safely say \"n\" here.\n";
1474 print "\nTry to detect auth mechanisms? [y/N]: ";
1477 if ($inval =~ /^y\b/i) {
1478 # Yes, let's try to detect.
1479 print "Trying to detect supported methods (SMTP)...\n";
1482 # Check none by trying to relay to junk@microsoft.com
1483 $host = $smtpServerAddress . ':' . $smtpPort;
1484 my $sock = IO
::Socket
::INET
->new($host);
1485 print "Testing none:\t\t$WHT";
1486 if (!defined($sock)) {
1487 print " ERROR TESTING\n";
1490 $got = <$sock>; # Discard greeting
1491 print $sock "HELO $domain\r\n";
1492 $got = <$sock>; # Discard
1493 print $sock "MAIL FROM:<tester\@squirrelmail.org>\r\n";
1494 $got = <$sock>; # Discard
1495 print $sock "RCPT TO:<junk\@microsoft.com\r\n";
1496 $got = <$sock>; # This is the important line
1497 if ($got =~ /^250\b/) { # SMTP will relay without auth
1498 print "SUPPORTED$NRM\n";
1500 print "NOT SUPPORTED$NRM\n";
1502 print $sock "RSET\r\n";
1503 print $sock "QUIT\r\n";
1506 # Try login (SquirrelMail default)
1507 print "Testing login:\t\t";
1508 $tmp=detect_auth_support
('SMTP',$host,'LOGIN');
1509 if (defined($tmp)) {
1510 if ($tmp eq 'YES') {
1511 print $WHT . "SUPPORTED$NRM\n";
1513 print $WHT . "NOT SUPPORTED$NRM\n";
1516 print $WHT . "ERROR DETECTING$NRM\n";
1520 print "Testing CRAM-MD5:\t";
1521 $tmp=detect_auth_support
('SMTP',$host,'CRAM-MD5');
1522 if (defined($tmp)) {
1523 if ($tmp eq 'YES') {
1524 print $WHT . "SUPPORTED$NRM\n";
1526 print $WHT . "NOT SUPPORTED$NRM\n";
1529 print $WHT . "ERROR DETECTING$NRM\n";
1533 print "Testing DIGEST-MD5:\t";
1534 $tmp=detect_auth_support
('SMTP',$host,'DIGEST-MD5');
1535 if (defined($tmp)) {
1536 if ($tmp eq 'YES') {
1537 print $WHT . "SUPPORTED$NRM\n";
1539 print $WHT . "NOT SUPPORTED$NRM\n";
1542 print $WHT . "ERROR DETECTING$NRM\n";
1546 print "\nWhat authentication mechanism do you want to use for SMTP connections?\n";
1547 print $WHT . "none" . $NRM . " - Your SMTP server does not require authorization.\n";
1548 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1549 print $WHT . "plain" . $NRM . " - SASL PLAIN. You already know it if you need this.\n";
1550 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext.\n";
1551 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1552 print $WHT . "\n*** YOUR SMTP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n" . $NRM;
1553 print "If you don't understand or are unsure, you probably want \"none\"\n\n";
1554 print "none, login, cram-md5, or digest-md5 [$WHT$smtp_auth_mech$NRM]: $WHT";
1557 if ($inval =~ /^none\b/i) {
1558 # remove sitewide smtp authentication information
1559 $smtp_sitewide_user = '';
1560 $smtp_sitewide_pass = '';
1561 # SMTP doesn't necessarily require logins
1563 } elsif ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) ||
1564 ($inval =~ /^login\b/i) || ($inval =~/^plain\b/i)) {
1565 command_smtp_sitewide_userpass
($inval);
1567 } elsif (trim
($inval) eq '') {
1568 # user selected default value
1569 command_smtp_sitewide_userpass
($smtp_auth_mech);
1570 return $smtp_auth_mech;
1572 # user entered garbage
1573 return $smtp_auth_mech;
1577 sub command_smtp_sitewide_userpass
($) {
1578 # get first function argument
1579 my $auth_mech = shift(@_);
1581 $auth_mech = lc(trim
($auth_mech));
1582 if ($auth_mech eq 'none') {
1585 print "SMTP authentication uses IMAP username and password by default.\n";
1587 print "Would you like to use other login and password for all SquirrelMail \n";
1588 print "SMTP connections?";
1589 if ($smtp_sitewide_user ne '') {
1606 $smtp_sitewide_user = '';
1607 $smtp_sitewide_pass = '';
1608 } elsif ($tmp eq 'y') {
1609 print "Enter username [$smtp_sitewide_user]:";
1610 my $new_user = <STDIN
>;
1611 $new_user = trim
($new_user);
1612 if ($new_user ne '') {
1613 $smtp_sitewide_user = $new_user;
1615 if ($smtp_sitewide_user ne '') {
1616 print "If you don't enter any password, current sitewide password will be used.\n";
1617 print "If you enter space, password will be set to empty string.\n";
1618 print "Enter password:";
1619 my $new_pass = <STDIN
>;
1620 if ($new_pass ne "\n") {
1621 $smtp_sitewide_pass = trim
($new_pass);
1624 print "Invalid input. You must set username used for SMTP authentication.\n";
1625 print "Click enter to continue\n";
1629 print "Invalid input\n";
1630 print "Click enter to continue\n";
1635 # Sub adds information about SMTP authentication type to menu
1636 sub display_smtp_sitewide_userpass
() {
1638 if ($smtp_auth_mech ne 'none') {
1639 if ($smtp_sitewide_user ne '') {
1640 $ret = ' (with custom username and password)';
1642 $ret = ' (with IMAP username and password)';
1649 # This sub is reused for IMAP and SMTP
1650 # Args: service name, default value
1651 sub command_use_tls
{
1652 my($default_val,$service,$inval);
1655 print "TLS (Transport Layer Security) encrypts the traffic between server and client.\n";
1656 print "STARTTLS extensions allow to start encryption on existing plain text connection.\n";
1657 print "These options add specific PHP and IMAP server configuration requirements.\n";
1658 print "See SquirrelMail documentation about connection security.\n";
1660 print "If your " . $service . " server is localhost, you can safely disable this.\n";
1661 print "If it is remote, you may wish to seriously consider enabling this.\n";
1663 while ($valid_input eq 0) {
1664 print "\nSelect connection security model:\n";
1665 print " 0 - Use plain text connection\n";
1666 print " 1 - Use TLS connection\n";
1667 print " 2 - Use STARTTLS extension\n";
1668 print "Select [$default_val]: ";
1670 $inval=trim
($inval);
1671 if ($inval =~ /^[012]$/ || $inval eq '') {
1675 if ($inval ne '') {$default_val = $inval};
1676 return $default_val;
1679 # This sub is used to display human readable text for
1680 # $use_imap_tls and $use_smtp_tls values in conf.pl menu
1681 sub display_use_tls
($) {
1682 my $val = shift(@_);
1683 my $ret = 'disabled';
1686 } elsif ($val eq '1') {
1692 # $encode_header_key
1694 print "Encryption key allows to hide SquirrelMail Received: headers\n";
1695 print "in outbound messages. Interface uses encryption key to encode\n";
1696 print "username, remote address and proxied address, then stores encoded\n";
1697 print "information in X-Squirrel-* headers.\n";
1699 print "Warning: used encryption function is not bulletproof. When used\n";
1700 print "with static encryption keys, it provides only minimal security\n";
1701 print "measures and information can be decoded quickly.\n";
1703 print "Encoded information can be decoded with decrypt_headers.php script\n";
1704 print "from SquirrelMail contrib/ directory.\n";
1706 print "Enter encryption key: ";
1707 $new_encode_header_key = <STDIN
>;
1708 if ( $new_encode_header_key eq "\n" ) {
1709 $new_encode_header_key = $encode_header_key;
1711 $new_encode_header_key =~ s/[\r\n]//g;
1713 return $new_encode_header_key;
1718 print "\nYou can now create the welcome message that is displayed\n";
1719 print "every time a user logs on. You can use HTML or just plain\n";
1721 "text. If you do not wish to have one, just make it blank.\n\n(Type @ on a blank line to exit)\n";
1727 $line =~ s/[\r\n]//g;
1728 if ( $line ne "@" ) {
1729 $line =~ s/ /\ \ /g;
1730 $line =~ s/\t/\ \ \ \ /g;
1732 $line =~ s/\"/\\\"/g;
1734 $new_motd = $new_motd . $line;
1736 } while ( $line ne "@" );
1740 ################# PLUGINS ###################
1743 $command =~ s/[\s\n\r]*//g;
1744 if ( $command > 0 ) {
1745 $command = $command - 1;
1746 if ( $command <= $#plugins ) {
1749 while ( $ct <= $#plugins ) {
1750 if ( $ct != $command ) {
1751 @newplugins = ( @newplugins, $plugins[$ct] );
1755 @plugins = @newplugins;
1756 } elsif ( $command <= $#plugins + $#unused_plugins + 1 ) {
1757 $num = $command - $#plugins - 1;
1758 @newplugins = @plugins;
1760 while ( $ct <= $#unused_plugins ) {
1761 if ( $ct == $num ) {
1762 @newplugins = ( @newplugins, $unused_plugins[$ct] );
1766 @plugins = @newplugins;
1772 # disable_plugins_user
1774 print "When all active plugins are disabled, they can be disabled only\n";
1775 print "for the one user named here. If left blank, plugins will be\n";
1776 print "disabled for ALL users. This setting has no effect if plugins\n";
1777 print "are not disabled.\n";
1779 print "This must be the exact IMAP login name for the desired user.\n";
1781 print "[$WHT$disable_plugins_user$NRM]: $WHT";
1782 $new_disable_plugins_user = <STDIN
>;
1783 if ( $new_disable_plugins_user eq "\n" ) {
1784 $new_disable_plugins_user = $disable_plugins_user;
1786 $new_disable_plugins_user =~ s/[\r\n]//g;
1788 return $new_disable_plugins_user;
1791 ################# FOLDERS ###################
1793 # default_folder_prefix
1795 print "Some IMAP servers (UW, for example) store mail and folders in\n";
1796 print "your user space in a separate subdirectory. This is where you\n";
1797 print "specify what that directory is.\n";
1799 print "EXAMPLE: mail/";
1801 print "NOTE: If you use Cyrus, or some server that would not use this\n";
1802 print " option, you must set this to 'none'.\n";
1804 print "[$WHT$default_folder_prefix$NRM]: $WHT";
1805 $new_default_folder_prefix = <STDIN
>;
1807 if ( $new_default_folder_prefix eq "\n" ) {
1808 $new_default_folder_prefix = $default_folder_prefix;
1810 $new_default_folder_prefix =~ s/[\r\n]//g;
1812 if ( ( $new_default_folder_prefix =~ /^\s*$/ ) || ( $new_default_folder_prefix =~ m/^none$/i ) ) {
1813 $new_default_folder_prefix = "";
1815 # add the trailing delimiter only if we know what the server is.
1816 if (($imap_server_type eq 'cyrus' and
1817 $optional_delimiter eq 'detect') or
1818 ($imap_server_type eq 'courier' and
1819 $optional_delimiter eq 'detect')) {
1820 $new_default_folder_prefix =~ s/\.*$/\./;
1821 } elsif ($imap_server_type eq 'uw' and
1822 $optional_delimiter eq 'detect') {
1823 $new_default_folder_prefix =~ s/\/*$/\
//;
1826 return $new_default_folder_prefix;
1829 # Show Folder Prefix
1831 print "It is possible to set up the default folder prefix as a user\n";
1832 print "specific option, where each user can specify what their mail\n";
1833 print "folder is. If you set this to false, they will never see the\n";
1834 print "option, but if it is true, this option will appear in the\n";
1835 print "'options' section.\n";
1837 print "NOTE: You set the default folder prefix in option '1' of this\n";
1838 print " section. That will be the default if the user doesn't\n";
1839 print " specify anything different.\n";
1842 if ( lc($show_prefix_option) eq 'true' ) {
1843 $default_value = "y";
1845 $default_value = "n";
1848 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
1849 $new_show = <STDIN
>;
1850 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1851 $show_prefix_option = 'true';
1853 $show_prefix_option = 'false';
1855 return $show_prefix_option;
1860 print "You can now specify where the default trash folder is located.\n";
1861 print "On servers where you do not want this, you can set it to anything\n";
1862 print "and set option 6 to false.\n";
1864 print "This is relative to where the rest of your email is kept. You do\n";
1865 print "not need to worry about their mail directory. If this folder\n";
1866 print "would be ~/mail/trash on the filesystem, you only need to specify\n";
1867 print "that this is 'trash', and be sure to put 'mail/' in option 1.\n";
1870 print "[$WHT$trash_folder$NRM]: $WHT";
1871 $new_trash_folder = <STDIN
>;
1872 if ( $new_trash_folder eq "\n" ) {
1873 $new_trash_folder = $trash_folder;
1875 if (check_imap_folder
($new_trash_folder)) {
1876 $new_trash_folder =~ s/[\r\n]//g;
1878 $new_trash_folder = $trash_folder;
1881 return $new_trash_folder;
1886 print "This is where messages that are sent will be stored. SquirrelMail\n";
1887 print "by default puts a copy of all outgoing messages in this folder.\n";
1889 print "This is relative to where the rest of your email is kept. You do\n";
1890 print "not need to worry about their mail directory. If this folder\n";
1891 print "would be ~/mail/sent on the filesystem, you only need to specify\n";
1892 print "that this is 'sent', and be sure to put 'mail/' in option 1.\n";
1895 print "[$WHT$sent_folder$NRM]: $WHT";
1896 $new_sent_folder = <STDIN
>;
1897 if ( $new_sent_folder eq "\n" ) {
1898 $new_sent_folder = $sent_folder;
1900 if (check_imap_folder
($new_sent_folder)) {
1901 $new_sent_folder =~ s/[\r\n]//g;
1903 $new_sent_folder = $sent_folder;
1906 return $new_sent_folder;
1911 print "You can now specify where the default draft folder is located.\n";
1912 print "On servers where you do not want this, you can set it to anything\n";
1913 print "and set option 9 to false.\n";
1915 print "This is relative to where the rest of your email is kept. You do\n";
1916 print "not need to worry about their mail directory. If this folder\n";
1917 print "would be ~/mail/drafts on the filesystem, you only need to specify\n";
1918 print "that this is 'drafts', and be sure to put 'mail/' in option 1.\n";
1921 print "[$WHT$draft_folder$NRM]: $WHT";
1922 $new_draft_folder = <STDIN
>;
1923 if ( $new_draft_folder eq "\n" ) {
1924 $new_draft_folder = $draft_folder;
1926 if (check_imap_folder
($new_draft_folder)) {
1927 $new_draft_folder =~ s/[\r\n]//g;
1929 $new_draft_folder = $draft_folder;
1932 return $new_draft_folder;
1935 # default move to trash
1937 print "By default, should messages get moved to the trash folder? You\n";
1938 print "can specify the default trash folder in option 3. If this is set\n";
1939 print "to false, messages will get deleted immediately without moving\n";
1940 print "to the trash folder.\n";
1942 print "Trash folder is currently: $trash_folder\n";
1945 if ( lc($default_move_to_trash) eq 'true' ) {
1946 $default_value = "y";
1948 $default_value = "n";
1950 print "By default, move to trash (y/n) [$WHT$default_value$NRM]: $WHT";
1951 $new_show = <STDIN
>;
1952 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1953 $default_move_to_trash = 'true';
1955 $default_move_to_trash = 'false';
1957 return $default_move_to_trash;
1960 # default move to sent (save sent messages)
1962 print "By default, should copies of outgoing messages get saved in the\n";
1963 print "sent folder? You can specify the default sent folder in option 4.\n";
1964 print "If this is set to false, messages will get sent and no copy will\n";
1967 print "Sent folder is currently: $sent_folder\n";
1970 if ( lc($default_move_to_sent) eq 'true' ) {
1971 $default_value = "y";
1973 $default_value = "n";
1975 print "By default, save sent messages (y/n) [$WHT$default_value$NRM]: $WHT";
1976 $new_show = <STDIN
>;
1977 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1978 $default_move_to_sent = 'true';
1980 $default_move_to_sent = 'false';
1982 return $default_move_to_sent;
1985 # default save as draft
1987 print "By default, should the save to draft option be shown? You can\n";
1988 print "specify the default drafts folder in option 5. If this is set\n";
1989 print "to false, users will not be shown the save to draft option.\n";
1991 print "Drafts folder is currently: $draft_folder\n";
1994 if ( lc($default_save_as_draft) eq 'true' ) {
1995 $default_value = "y";
1997 $default_value = "n";
1999 print "By default, save as draft (y/n) [$WHT$default_value$NRM]: $WHT";
2000 $new_show = <STDIN
>;
2001 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2002 $default_save_as_draft = 'true';
2004 $default_save_as_draft = 'false';
2006 return $default_save_as_draft;
2009 # List special folders first
2011 print "SquirrelMail has what we call 'special folders' that are not\n";
2012 print "manipulated and viewed like normal folders. Some examples of\n";
2013 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
2014 print "Simply asks if you want these folders listed first in the folder\n";
2018 if ( lc($list_special_folders_first) eq 'true' ) {
2019 $default_value = "y";
2021 $default_value = "n";
2024 print "List first (y/n) [$WHT$default_value$NRM]: $WHT";
2025 $new_show = <STDIN
>;
2026 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2027 $list_special_folders_first = 'true';
2029 $list_special_folders_first = 'false';
2031 return $list_special_folders_first;
2034 # Show special folders color
2036 print "SquirrelMail has what we call 'special folders' that are not\n";
2037 print "manipulated and viewed like normal folders. Some examples of\n";
2038 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
2039 print "wants to know if we should display special folders in a\n";
2040 print "color than the other folders.\n";
2043 if ( lc($use_special_folder_color) eq 'true' ) {
2044 $default_value = "y";
2046 $default_value = "n";
2049 print "Show color (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 $use_special_folder_color = 'true';
2054 $use_special_folder_color = 'false';
2056 return $use_special_folder_color;
2061 print "The way that IMAP handles deleting messages is as follows. You\n";
2062 print "mark the message as deleted, and then to 'really' delete it, you\n";
2063 print "expunge it. This option asks if you want to just have messages\n";
2064 print "marked as deleted, or if you want SquirrelMail to expunge the \n";
2065 print "messages too.\n";
2068 if ( lc($auto_expunge) eq 'true' ) {
2069 $default_value = "y";
2071 $default_value = "n";
2073 print "Auto expunge (y/n) [$WHT$default_value$NRM]: $WHT";
2074 $new_show = <STDIN
>;
2075 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2076 $auto_expunge = 'true';
2078 $auto_expunge = 'false';
2080 return $auto_expunge;
2083 # Default sub of inbox
2085 print "Some IMAP servers (Cyrus) have all folders as subfolders of INBOX.\n";
2086 print "This can cause some confusion in folder creation for users when\n";
2087 print "they try to create folders and don't put it as a subfolder of INBOX\n";
2088 print "and get permission errors. This option asks if you want folders\n";
2089 print "to be subfolders of INBOX by default.\n";
2092 if ( lc($default_sub_of_inbox) eq 'true' ) {
2093 $default_value = "y";
2095 $default_value = "n";
2097 print "Default sub of INBOX (y/n) [$WHT$default_value$NRM]: $WHT";
2098 $new_show = <STDIN
>;
2099 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2100 $default_sub_of_inbox = 'true';
2102 $default_sub_of_inbox = 'false';
2104 return $default_sub_of_inbox;
2107 # Show contain subfolder option
2109 print "Some IMAP servers (UW) make it so that there are two types of\n";
2110 print "folders. Those that contain messages, and those that contain\n";
2111 print "subfolders. If this is the case for your server, set this to\n";
2112 print "true, and it will ask the user whether the folder they are\n";
2113 print "creating contains subfolders or messages.\n";
2116 if ( lc($show_contain_subfolders_option) eq 'true' ) {
2117 $default_value = "y";
2119 $default_value = "n";
2121 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
2122 $new_show = <STDIN
>;
2123 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2124 $show_contain_subfolders_option = 'true';
2126 $show_contain_subfolders_option = 'false';
2128 return $show_contain_subfolders_option;
2131 # Default Unseen Notify
2133 print "This option specifies where the users will receive notification\n";
2134 print "about unseen messages by default. This is of course an option that\n";
2135 print "can be changed on a user level.\n";
2136 print " 1 = No notification\n";
2137 print " 2 = Only on the INBOX\n";
2138 print " 3 = On all folders\n";
2141 print "Which one should be default (1,2,3)? [$WHT$default_unseen_notify$NRM]: $WHT";
2142 $new_show = <STDIN
>;
2143 if ( $new_show =~ /^[123]\n/i ) {
2144 $default_unseen_notify = $new_show;
2146 $default_unseen_notify =~ s/[\r\n]//g;
2147 return $default_unseen_notify;
2150 # Default Unseen Type
2152 print "Here you can define the default way that unseen messages will be displayed\n";
2153 print "to the user in the folder listing on the left side.\n";
2154 print " 1 = Only unseen messages (4)\n";
2155 print " 2 = Unseen and Total messages (4/27)\n";
2158 print "Which one should be default (1,2)? [$WHT$default_unseen_type$NRM]: $WHT";
2159 $new_show = <STDIN
>;
2160 if ( $new_show =~ /^[12]\n/i ) {
2161 $default_unseen_type = $new_show;
2163 $default_unseen_type =~ s/[\r\n]//g;
2164 return $default_unseen_type;
2167 # Auto create special folders
2169 print "Would you like the Sent, Trash, and Drafts folders to be created\n";
2170 print "automatically print for you when a user logs in? If the user\n";
2171 print "accidentally deletes their special folders, this option will\n";
2172 print "automatically create it again for them.\n";
2175 if ( lc($auto_create_special) eq 'true' ) {
2176 $default_value = "y";
2178 $default_value = "n";
2180 print "Auto create special folders? (y/n) [$WHT$default_value$NRM]: $WHT";
2181 $new_show = <STDIN
>;
2182 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2183 $auto_create_special = 'true';
2185 $auto_create_special = 'false';
2187 return $auto_create_special;
2190 # Automatically delete folders
2192 if ( $imap_server_type eq "uw" ) {
2193 print "UW IMAP servers will not allow folders containing mail to also contain folders.\n";
2194 print "Deleting folders will bypass the trash folder and be immediately deleted\n\n";
2195 print "If this is not the correct value for your server,\n";
2196 print "please use option D on the Main Menu to configure your server correctly.\n\n";
2197 print "Press enter to continue...\n";
2198 $new_delete = <STDIN
>;
2199 $delete_folder = 'true';
2201 if ( $imap_server_type eq "courier" ) {
2202 print "Courier (or Courier-IMAP) IMAP servers may not support ";
2203 print "subfolders of Trash. \n";
2204 print "Specifically, if Courier is set to always move messages to Trash, \n";
2205 print "Trash will be treated by Courier as a special folder that does not \n";
2206 print "allow subfolders. \n\n";
2207 print "Please verify your Courier configuration, and test folder deletion \n";
2208 print "when changing this setting.\n\n";
2211 print "Are subfolders of the Trash supported by your IMAP server?\n";
2212 print "If so, should deleted folders be sent to Trash?\n";
2213 print "If not, say no (deleted folders should not be sent to Trash)\n\n";
2214 # reversal of logic.
2215 # question was: Should folders be automatically deleted instead of sent to trash..
2216 # we've changed the question to make it more clear,
2217 # and are here handling that to avoid changing the answers..
2218 if ( lc($delete_folder) eq 'true' ) {
2219 $default_value = "n";
2221 $default_value = "y";
2223 print "Send deleted folders to Trash? (y/n) [$WHT$default_value$NRM]: $WHT";
2224 $new_delete = <STDIN
>;
2225 if ( ( $new_delete =~ /^y\n/i ) || ( ( $new_delete =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2226 $delete_folder = 'false';
2228 $delete_folder = 'true';
2231 return $delete_folder;
2236 print "Some IMAP servers allow subfolders to exist even if the parent\n";
2237 print "folders do not. This fixes some problems with the folder list\n";
2238 print "when this is the case, causing the /NoSelect folders to be displayed\n";
2241 if ( lc($noselect_fix_enable) eq 'true' ) {
2242 $default_value = "y";
2244 $default_value = "n";
2246 print "enable noselect fix? (y/n) [$WHT$noselect_fix_enable$NRM]: $WHT";
2247 $noselect_fix_enable = <STDIN
>;
2248 if ( ( $noselect_fix_enable =~ /^y\n/i ) || ( ( $noselect_fix_enable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2249 $noselect_fix_enable = 'true';
2251 $noselect_fix_enable = 'false';
2253 return $noselect_fix_enable;
2255 ############# GENERAL OPTIONS #####################
2259 print "Specify the location for your data directory.\n";
2260 print "You need to create this directory yourself.\n";
2261 print "The path name can be absolute or relative (to the config directory).\n";
2262 print "Here are two examples:\n";
2263 print " Absolute: /var/local/squirrelmail/data/\n";
2264 print " Relative: ../data/\n";
2265 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2266 print "will be converted to their absolute path equivalents in config.php.\n\n";
2267 print "Note: There are potential security risks with having a writeable directory\n";
2268 print "under the web server's root directory (ex: /home/httpd/html).\n";
2269 print "For this reason, it is recommended to put the data directory\n";
2270 print "in an alternate location of your choice. \n";
2273 print "[$WHT$data_dir$NRM]: $WHT";
2274 $new_data_dir = <STDIN
>;
2275 if ( $new_data_dir eq "\n" ) {
2276 $new_data_dir = $data_dir;
2278 $new_data_dir =~ s/[\r\n]//g;
2280 if ( $new_data_dir =~ /^\s*$/ ) {
2283 $new_data_dir =~ s/\/*$//g
;
2284 $new_data_dir =~ s/$/\//g
;
2286 return $new_data_dir;
2289 # Attachment directory
2291 print "Path to directory used for storing attachments while a mail is\n";
2292 print "being composed. The path name can be absolute or relative (to the\n";
2293 print "config directory). Here are two examples:\n";
2294 print " Absolute: /var/local/squirrelmail/attach/\n";
2295 print " Relative: ../attach/\n";
2296 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2297 print "will be converted to their absolute path equivalents in config.php.\n\n";
2298 print "Note: There are a few security considerations regarding this\n";
2299 print "directory:\n";
2300 print " 1. It should have the permission 733 (rwx-wx-wx) to make it\n";
2301 print " impossible for a random person with access to the webserver\n";
2302 print " to list files in this directory. Confidential data might\n";
2303 print " be laying around in there.\n";
2304 print " Depending on your user:group assignments, 730 (rwx-wx---)\n";
2305 print " may be possible, and more secure (e.g. root:apache)\n";
2306 print " 2. Since the webserver is not able to list the files in the\n";
2307 print " content is also impossible for the webserver to delete files\n";
2308 print " lying around there for too long.\n";
2309 print " 3. It should probably be another directory than the data\n";
2310 print " directory specified in option 3.\n";
2313 print "[$WHT$attachment_dir$NRM]: $WHT";
2314 $new_attachment_dir = <STDIN
>;
2315 if ( $new_attachment_dir eq "\n" ) {
2316 $new_attachment_dir = $attachment_dir;
2318 $new_attachment_dir =~ s/[\r\n]//g;
2320 if ( $new_attachment_dir =~ /^\s*$/ ) {
2321 $new_attachment_dir = "";
2323 $new_attachment_dir =~ s/\/*$//g
;
2324 $new_attachment_dir =~ s/$/\//g
;
2326 return $new_attachment_dir;
2330 print "The directory hash level setting allows you to configure the level\n";
2331 print "of hashing that SquirrelMail employs in your data and attachment\n";
2332 print "directories. This value must be an integer ranging from 0 to 4.\n";
2333 print "When this value is set to 0, SquirrelMail will simply store all\n";
2334 print "files as normal in the data and attachment directories. However,\n";
2335 print "when set to a value from 1 to 4, a simple hashing scheme will be\n";
2336 print "used to organize the files in this directory. In short, the crc32\n";
2337 print "value for a username will be computed. Then, up to the first 4\n";
2338 print "digits of the hash, as set by this configuration value, will be\n";
2339 print "used to directory hash the files for that user in the data and\n";
2340 print "attachment directory. This allows for better performance on\n";
2341 print "servers with larger numbers of users.\n";
2344 print "[$WHT$dir_hash_level$NRM]: $WHT";
2345 $new_dir_hash_level = <STDIN
>;
2346 if ( $new_dir_hash_level eq "\n" ) {
2347 $new_dir_hash_level = $dir_hash_level;
2349 $new_dir_hash_level =~ s/[\r\n]//g;
2351 if ( ( int($new_dir_hash_level) < 0 )
2352 || ( int($new_dir_hash_level) > 4 )
2353 || !( int($new_dir_hash_level) eq $new_dir_hash_level ) ) {
2354 print "Invalid Directory Hash Level.\n";
2355 print "Value must be an integer ranging from 0 to 4\n";
2356 print "Hit enter to continue.\n";
2357 $enter_key = <STDIN
>;
2359 $new_dir_hash_level = $dir_hash_level;
2362 return $new_dir_hash_level;
2366 print "This is the default size (in pixels) of the left folder list.\n";
2367 print "Default is 200, but you can set it to whatever you wish. This\n";
2368 print "is a user preference, so this will only show up as their default.\n";
2370 print "[$WHT$default_left_size$NRM]: $WHT";
2371 $new_default_left_size = <STDIN
>;
2372 if ( $new_default_left_size eq "\n" ) {
2373 $new_default_left_size = $default_left_size;
2375 $new_default_left_size =~ s/[\r\n]//g;
2377 return $new_default_left_size;
2381 print "Some IMAP servers only have lowercase letters in the usernames\n";
2382 print "but they still allow people with uppercase to log in. This\n";
2383 print "causes a problem with the user's preference files. This option\n";
2384 print "transparently changes all usernames to lowercase.";
2387 if ( lc($force_username_lowercase) eq 'true' ) {
2388 $default_value = "y";
2390 $default_value = "n";
2392 print "Convert usernames to lowercase (y/n) [$WHT$default_value$NRM]: $WHT";
2393 $new_show = <STDIN
>;
2394 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2404 if ( lc($default_use_priority) eq 'true' ) {
2405 $default_value = "y";
2407 $default_value = "n";
2410 print "Allow users to specify priority of outgoing mail (y/n) [$WHT$default_value$NRM]: $WHT";
2411 $new_show = <STDIN
>;
2412 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2422 if ( lc($hide_sm_attributions) eq 'true' ) {
2423 $default_value = "y";
2425 $default_value = "n";
2428 print "Hide SM attributions (y/n) [$WHT$default_value$NRM]: $WHT";
2429 $new_show = <STDIN
>;
2430 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2440 if ( lc($default_use_mdn) eq 'true' ) {
2441 $default_value = "y";
2443 $default_value = "n";
2446 print "Enable support for read/delivery receipt support (y/n) [$WHT$default_value$NRM]: $WHT";
2447 $new_show = <STDIN
>;
2448 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2456 print " In loosely managed environments, you may want to allow users
2457 to edit their full name and email address. In strictly managed
2458 environments, you may want to force users to use the name
2459 and email address assigned to them.
2461 'y' - allow a user to edit their full name and email address,
2462 'n' - users must use the assigned values.
2466 if ( lc($edit_identity) eq 'true' ) {
2467 $default_value = "y";
2469 $default_value = "n";
2471 print "Allow editing of user's identity? (y/n) [$WHT$default_value$NRM]: $WHT";
2472 $new_edit = <STDIN
>;
2473 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2474 $edit_identity = 'true';
2475 $edit_name = 'true';
2476 $hide_auth_header = command311b
();
2478 $edit_identity = 'false';
2479 $edit_name = command311
();
2480 $hide_auth_header = command311b
();
2482 return $edit_identity;
2486 print " Given that users are not allowed to modify their
2487 email address, can they edit their full name?
2491 if ( lc($edit_name) eq 'true' ) {
2492 $default_value = "y";
2494 $default_value = "n";
2496 print "Allow the user to edit their full name? (y/n) [$WHT$default_value$NRM]: $WHT";
2497 $new_edit = <STDIN
>;
2498 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2499 $edit_name = 'true';
2501 $edit_name = 'false';
2507 print " SquirrelMail adds username information to every sent email
2508 in order to prevent possible sender forging when users are allowed
2509 to change their email and/or full name.
2511 You can remove user information from this header (y), if you think that
2512 it violates privacy or security.
2514 Note: If users are allowed to change their email addresses,
2515 this setting will make it difficult to determine who sent what where.
2516 Use at your own risk.
2520 if ( lc($hide_auth_header) eq "true" ) {
2521 $default_value = "y";
2523 $default_value = "n";
2525 print "Remove username from email headers? (y/n) [$WHT$default_value$NRM]: $WHT";
2526 $new_header = <STDIN
>;
2527 if ( ( $new_header =~ /^y\n/i ) || ( ( $new_header =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2528 $hide_auth_header = "true";
2530 $hide_auth_header = "false";
2532 return $hide_auth_header;
2536 print "This option allows you to disable server side thread sorting if your server \n";
2537 print "declares THREAD support, but you don't want to provide threading options \n";
2538 print "to end users or THREAD extension is broken or extension does not work with \n";
2539 print "options used by SquirrelMail. Option is not used, if THREAD extension is \n";
2540 print "not declared in IMAP CAPABILITY.\n";
2543 if ( lc($disable_thread_sort) eq 'true' ) {
2544 $default_value = "y";
2546 $default_value = "n";
2548 print "Disable server side thread sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2549 $disable_thread_sort = <STDIN
>;
2550 if ( ( $disable_thread_sort =~ /^y\n/i ) || ( ( $disable_thread_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2551 $disable_thread_sort = 'true';
2553 $disable_thread_sort = 'false';
2555 return $disable_thread_sort;
2559 print "This option allows you to disable server side sorting if your server declares \n";
2560 print "SORT support, but SORT extension is broken or does not work with options \n";
2561 print "used by SquirrelMail. Option is not used, if SORT extension is not declared \n";
2562 print "in IMAP CAPABILITY.\n";
2564 print "It is strongly recommended to keep server side sorting enabled, if your ";
2565 print "IMAP server supports it.";
2568 if ( lc($disable_server_sort) eq 'true' ) {
2569 $default_value = "y";
2571 $default_value = "n";
2573 print "Disable server-side sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2574 $disable_server_sort = <STDIN
>;
2575 if ( ( $disable_server_sort =~ /^y\n/i ) || ( ( $disable_server_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2576 $disable_server_sort = 'true';
2578 $disable_server_sort = 'false';
2580 return $disable_server_sort;
2584 print "This option allows you to choose if SM uses charset search\n";
2585 print "Your IMAP server must support the SEARCH CHARSET command for this to work\n";
2588 if ( lc($allow_charset_search) eq 'true' ) {
2589 $default_value = "y";
2591 $default_value = "n";
2593 print "Allow charset searching? (y/n) [$WHT$default_value$NRM]: $WHT";
2594 $allow_charset_search = <STDIN
>;
2595 if ( ( $allow_charset_search =~ /^y\n/i ) || ( ( $allow_charset_search =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2596 $allow_charset_search = 'true';
2598 $allow_charset_search = 'false';
2600 return $allow_charset_search;
2603 # command315 (UID support) obsoleted.
2605 # advanced search option
2607 print "This option allows you to control the use of advanced search form.\n";
2608 print " 0 = enable basic search only\n";
2609 print " 1 = enable advanced search only\n";
2610 print " 2 = enable both\n";
2613 print "Allowed search (0,1,2)? [$WHT$allow_advanced_search$NRM]: $WHT";
2614 $new_allow_advanced_search = <STDIN
>;
2615 if ( $new_allow_advanced_search =~ /^[012]\n/i ) {
2616 $allow_advanced_search = $new_allow_advanced_search;
2618 $allow_advanced_search =~ s/[\r\n]//g;
2619 return $allow_advanced_search;
2624 print "This option allows you to change the name of the PHP session used\n";
2625 print "by SquirrelMail. Unless you know what you are doing, you probably\n";
2626 print "don't need or want to change this from the default of SQMSESSID.\n";
2627 print "[$WHT$session_name$NRM]: $WHT";
2628 $new_session_name = <STDIN
>;
2629 chomp($new_session_name);
2630 if ( $new_session_name eq "" ) {
2631 $new_session_name = $session_name;
2633 return $new_session_name;
2636 # time zone config (since 1.5.1)
2638 print "This option allows you to control the use of time zones.\n";
2639 print " 0 = (default) standard, GNU C time zone names\n";
2640 print " 1 = strict, generic time zone codes with offsets\n";
2641 print " 2 = custom, GNU C time zones loaded from config/timezones.php\n";
2642 print " 3 = custom strict, generic time zone codes with offsets loaded \n";
2643 print " from config/timezones.php\n";
2644 print "See SquirrelMail documentation about format of config/timezones.php file.\n";
2647 print "Desired time zone configuration (0,1,2,3)? [$WHT$time_zone_type$NRM]: $WHT";
2648 $new_time_zone_type = <STDIN
>;
2649 if ( $new_time_zone_type =~ /^[0123]\n/i ) {
2650 $time_zone_type = $new_time_zone_type;
2652 print "\nInvalid configuration value.\n";
2653 print "\nPress enter to continue...";
2656 $time_zone_type =~ s/[\r\n]//g;
2657 return $time_zone_type;
2660 # set the location base for redirects (since 1.5.2)
2661 sub command_config_location_base
{
2662 print "Here you can set the base part of the SquirrelMail URL.\n";
2663 print "It is normally autodetected but if that fails, use this\n";
2664 print "option to override.\n";
2665 print "It should contain only the protocol and hostname/port parts\n";
2666 print "of the URL; the full path will be appended automatically.\n\n";
2667 print "Examples:\nhttp://webmail.example.org\nhttp://webmail.example.com:8080\nhttps://webmail.example.com:6691\n\n";
2668 print "Do not add any path elements.\n";
2670 print "URL base? [" .$WHT."autodetect$NRM]: $WHT";
2671 $new_config_location_base = <STDIN
>;
2672 chomp($new_config_location_base);
2673 $config_location_base = $new_config_location_base;
2675 return $config_location_base;
2678 # only_secure_cookies (since 1.5.2)
2680 print "This option allows you to specify that if a user session is initiated\n";
2681 print "under a secure (HTTPS, SSL-encrypted) connection, the cookies given to\n";
2682 print "the browser will ONLY be transmitted via a secure connection henceforth.\n\n";
2683 print "Generally this is a Good Thing, and should NOT be disabled. However,\n";
2684 print "if you intend to use the Secure Login or Show SSL Link plugins to\n";
2685 print "encrypt the user login, but not the rest of the SquirrelMail session,\n";
2686 print "this can be turned off. Think twice before doing so.\n";
2689 if ( lc($only_secure_cookies) eq 'true' ) {
2690 $default_value = "y";
2692 $default_value = "n";
2694 print "Transmit cookies only on secure connection when available? (y/n) [$WHT$default_value$NRM]: $WHT";
2695 $only_secure_cookies = <STDIN
>;
2696 if ( ( $only_secure_cookies =~ /^y\n/i ) || ( ( $only_secure_cookies =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2697 $only_secure_cookies = 'true';
2699 $only_secure_cookies = 'false';
2701 return $only_secure_cookies;
2705 sub command_userThemes
{
2706 print "\nDefine the user themes that you wish to use. If you have added\n";
2707 print "a theme of your own, just follow the instructions (?) about\n";
2708 print "how to add them. You can also change the default theme.\n\n";
2710 print "Available user themes:\n";
2712 while ( $count <= $#user_theme_name ) {
2713 if ( $count == $user_theme_default ) {
2718 if ( $count < 10 ) {
2721 $name = $user_theme_name[$count];
2722 $num_spaces = 35 - length($name);
2723 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2724 $name = $name . " ";
2727 print " $count. $name";
2728 print "($user_theme_path[$count])\n";
2734 print ".------------------------------------.\n";
2735 print "| t (detect user themes) |\n";
2736 print "| + (add user theme) |\n";
2737 print "| - N (remove user theme) |\n";
2738 print "| m N (mark default user theme) |\n";
2739 print "| l (list user themes) |\n";
2740 print "| d (done) |\n";
2741 print "`------------------------------------'\n";
2743 print "\n[user_themes] command (?=help) > ";
2745 $input =~ s/[\r\n]//g;
2746 while ( $input ne "d" ) {
2747 if ( $input =~ /^\s*l\s*/i ) {
2749 while ( $count <= $#user_theme_name ) {
2750 if ( $count == $user_theme_default ) {
2755 if ( $count < 10 ) {
2758 $name = $user_theme_name[$count];
2759 $num_spaces = 35 - length($name);
2760 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2761 $name = $name . " ";
2764 print " $count. $name";
2765 print "($user_theme_path[$count])\n";
2769 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2770 $old_def = $user_theme_default;
2771 $user_theme_default = $input;
2772 $user_theme_default =~ s/^\s*m\s*//;
2773 if ( ( $user_theme_default > $#user_theme_name ) || ( $user_theme_default < 0 ) ) {
2774 print "Cannot set default theme to $user_theme_default. That theme does not exist.\n";
2775 $user_theme_default = $old_def;
2777 } elsif ( $input =~ /^\s*\+/ ) {
2778 print "What is the name of this theme? ";
2780 $name =~ s/[\r\n]//g;
2781 $user_theme_name[ $#user_theme_name + 1 ] = $name;
2782 print "Be sure to put ../css/ before the filename.\n";
2783 print "What file is this stored in (ex: ../css/my_theme/): ";
2785 $name =~ s/[\r\n]//g;
2786 $user_theme_path[ $#user_theme_path + 1 ] = $name;
2787 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2788 if ( $input =~ /[0-9]+\s*$/ ) {
2790 $rem_num =~ s/^\s*-\s*//g;
2791 $rem_num =~ s/\s*$//;
2793 $rem_num = $#user_theme_name;
2795 if ( $rem_num == $user_theme_default ) {
2796 print "You cannot remove the default theme!\n";
2799 @new_theme_name = ();
2800 @new_theme_path = ();
2801 while ( $count <= $#user_theme_name ) {
2802 if ( $count != $rem_num ) {
2803 @new_theme_name = ( @new_theme_name, $user_theme_name[$count] );
2804 @new_theme_path = ( @new_theme_path, $user_theme_path[$count] );
2808 @user_theme_name = @new_theme_name;
2809 @user_theme_path = @new_theme_path;
2810 if ( $user_theme_default > $rem_num ) {
2811 $user_theme_default--;
2814 } elsif ( $input =~ /^\s*t\s*/i ) {
2815 print "\nStarting detection...\n\n";
2817 opendir( DIR
, "../css" );
2818 @files = sort(readdir(DIR
));
2820 while ( $cnt <= $#files ) {
2821 $filename = "../css/" . $files[$cnt] .'/';
2822 if ( $files[$cnt] !~ /^\./ && $filename ne "../css/rtl.css" && -e
$filename . "default.css" ) {
2824 for ( $x = 0 ; $x <= $#user_theme_path ; $x++ ) {
2825 if ( $user_theme_path[$x] eq $filename ) {
2829 if ( $found != 1 ) {
2830 print "** Found user theme: $filename\n";
2831 $def = $files[$cnt];
2834 #$def =~ s/(^\w+)/ucfirst $1/eg;
2835 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
2836 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
2837 print " What is its name? [$def]: ";
2839 $nm =~ s/^\s+|\s+$|[\n\r]//g;
2840 if ( $nm eq '' ) { $nm = $def; }
2841 $user_theme_name[ $#user_theme_name + 1 ] = $nm;
2842 $user_theme_path[ $#user_theme_path + 1 ] = $filename;
2848 for ( $cnt = 0 ; $cnt <= $#user_theme_path ; $cnt++ ) {
2849 $filename = $user_theme_path[$cnt];
2850 if ( $filename != 'none' && !( -e
$filename ."/default.css" ) ) {
2851 print " Removing $filename (file not found)\n";
2853 @new_user_theme_name = ();
2854 @new_user_theme_path = ();
2855 for ( $x = 0 ; $x < $#user_theme_path ; $x++ ) {
2856 if ( $user_theme_path[$x] eq $filename ) {
2859 if ( $offset == 1 ) {
2860 $new_user_theme_name[$x] = $user_theme_name[ $x + 1 ];
2861 $new_user_theme_path[$x] = $user_theme_path[ $x + 1 ];
2863 $new_user_theme_name[$x] = $user_theme_name[$x];
2864 $new_user_theme_path[$x] = $user_theme_path[$x];
2867 @user_theme_name = @new_user_theme_name;
2868 @user_theme_path = @new_user_theme_path;
2871 print "\nDetection complete!\n\n";
2874 } elsif ( $input =~ /^\s*\?\s*/ ) {
2875 print ".------------------------------------.\n";
2876 print "| t (detect user themes) |\n";
2877 print "| + (add user theme) |\n";
2878 print "| - N (remove user theme) |\n";
2879 print "| m N (mark default user theme) |\n";
2880 print "| l (list user themes) |\n";
2881 print "| d (done) |\n";
2882 print "`------------------------------------'\n";
2884 print "[user_themes] command (?=help) > ";
2886 $input =~ s/[\r\n]//g;
2890 sub command_iconSets
{
2891 print "\nDefine the icon themes that you wish to use. If you have added\n";
2892 print "a theme of your own, just follow the instructions (?) about\n";
2893 print "how to add them. You can also change the default and fallback\n";
2894 print "themes. The default theme will be used when no icon theme is\n";
2895 print "set by the user. The fallback theme will be used if an icon\n";
2896 print "cannot be found in the currently selected icon theme.\n\n";
2898 print "Available icon themes:\n\n";
2901 while ( $count <= $#icon_theme_name ) {
2902 if ( $count == $icon_theme_def ) {
2907 if ( $count eq $icon_theme_fallback ) {
2912 if ( $count < 10 ) {
2915 $name = $icon_theme_name[$count];
2916 $num_spaces = 35 - length($name);
2917 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2918 $name = $name . " ";
2921 print " $count. $name";
2922 print "($icon_theme_path[$count])\n";
2927 print "\n d = Default icon theme\n";
2928 print " f = Fallback icon theme\n";
2930 print ".------------------------------------.\n";
2931 print "| t (detect icon themes) |\n";
2932 print "| + (add icon theme) |\n";
2933 print "| - N (remove icon theme) |\n";
2934 print "| m N (mark default icon theme) |\n";
2935 print "| f N (set fallback icon set) |\n";
2936 print "| l (list icon themes) |\n";
2937 print "| d (done) |\n";
2938 print "`------------------------------------'\n";
2940 print "\n[icon_themes] command (?=help) > ";
2942 $input =~ s/[\r\n]//g;
2943 while ( $input ne "d" ) {
2944 if ( $input =~ /^\s*l\s*/i ) {
2947 while ( $count <= $#icon_theme_name ) {
2948 if ( $count == $icon_theme_def ) {
2953 if ( $count eq $icon_theme_fallback ) {
2958 $name = $icon_theme_name[$count];
2959 $num_spaces = 35 - length($name);
2960 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2961 $name = $name . " ";
2964 print " $count. $name";
2965 print "($icon_theme_path[$count])\n";
2969 print "\n d = Default icon theme\n";
2970 print " f = Fallback icon theme\n\n";
2971 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2972 $old_def = $icon_theme_def;
2973 $icon_theme_def = $input;
2974 $icon_theme_def =~ s/^\s*m\s*//;
2975 if ( ( $icon_theme_default > $#icon_theme_name ) || ( $icon_theme_default < 0 ) ) {
2976 print "Cannot set default icon theme to $icon_theme_default. That theme does not exist.\n";
2977 $icon_theme_def = $old_def;
2979 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
2980 $old_fb = $icon_theme_fallback;
2981 $icon_theme_fallback = $input;
2982 $icon_theme_fallback =~ s/^\s*f\s*//;
2983 if ( ( $icon_theme_fallback > $#icon_theme_name ) || ( $icon_theme_fallback < 0 ) ) {
2984 print "Cannot set fallback icon theme to $icon_theme_fallback. That theme does not exist.\n";
2985 $icon_theme_fallback = $old_fb;
2987 } elsif ( $input =~ /^\s*\+/ ) {
2988 print "What is the name of this icon theme? ";
2990 $name =~ s/[\r\n]//g;
2991 $icon_theme_name[ $#icon_theme_name + 1 ] = $name;
2992 print "Be sure to put ../images/themes/ before the filename.\n";
2993 print "What directory is this icon theme stored in (ex: ../images/themes/my_theme/)? ";
2995 $name =~ s/[\r\n]//g;
2996 $icon_theme_path[ $#icon_theme_path + 1 ] = $name;
2997 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2998 if ( $input =~ /[0-9]+\s*$/ ) {
3000 $rem_num =~ s/^\s*-\s*//g;
3001 $rem_num =~ s/\s*$//;
3003 $rem_num = $#icon_theme_name;
3005 if ( $rem_num == $icon_theme_def ) {
3006 print "You cannot remove the default icon theme!\n";
3007 } elsif ( $rem_num == $icon_theme_fallback ) {
3008 print "You cannot remove the fallback icon theme!\n";
3011 @new_theme_name = ();
3012 @new_theme_path = ();
3013 while ( $count <= $#icon_theme_name ) {
3014 if ( $count != $rem_num ) {
3015 @new_theme_name = ( @new_theme_name, $icon_theme_name[$count] );
3016 @new_theme_path = ( @new_theme_path, $icon_theme_path[$count] );
3020 @icon_theme_name = @new_theme_name;
3021 @icon_theme_path = @new_theme_path;
3022 if ( $icon_theme_def > $rem_num ) {
3026 } elsif ( $input =~ /^\s*t\s*/i ) {
3027 print "\nStarting detection...\n\n";
3029 opendir( DIR
, "../images/themes/" );
3030 @files = sort(readdir(DIR
));
3032 while ( $cnt <= $#files ) {
3033 $filename = "../images/themes/" . $files[$cnt] .'/';
3034 if ( -d
"../images/themes/" . $files[$cnt] && $files[$cnt] !~ /^\
./ && $files[$cnt] ne ".svn" ) {
3036 for ( $x = 0 ; $x <= $#icon_theme_path ; $x++ ) {
3037 if ( $icon_theme_path[$x] eq $filename ) {
3041 if ( $found != 1 ) {
3042 print "** Found icon theme: $filename\n";
3043 $def = $files[$cnt];
3046 #$def =~ s/(^\w+)/ucfirst $1/eg;
3047 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3048 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3049 print " What is its name? [$def]: ";
3051 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3052 if ( $nm eq '' ) { $nm = $def; }
3053 $icon_theme_name[ $#icon_theme_name + 1 ] = $nm;
3054 $icon_theme_path[ $#icon_theme_path + 1 ] = $filename;
3060 for ( $cnt = 0 ; $cnt <= $#icon_theme_path ; $cnt++ ) {
3061 $filename = $icon_theme_path[$cnt];
3062 if ( $filename ne "none" && $filename ne "template" && ! -d
$filename ) {
3063 print " Removing $filename (file not found)\n";
3065 @new_icon_theme_name = ();
3066 @new_icon_theme_path = ();
3067 for ( $x = 0 ; $x < $#icon_theme_path ; $x++ ) {
3068 if ( $icon_theme_path[$x] eq $filename ) {
3071 if ( $offset == 1 ) {
3072 $new_icon_theme_name[$x] = $icon_theme_name[ $x + 1 ];
3073 $new_icon_theme_path[$x] = $icon_theme_path[ $x + 1 ];
3075 $new_icon_theme_name[$x] = $icon_theme_name[$x];
3076 $new_icon_theme_path[$x] = $icon_theme_path[$x];
3079 @icon_theme_name = @new_icon_theme_name;
3080 @icon_theme_path = @new_icon_theme_path;
3083 print "\nDetection complete!\n\n";
3086 } elsif ( $input =~ /^\s*\?\s*/ ) {
3087 print ".------------------------------------.\n";
3088 print "| t (detect icon themes) |\n";
3089 print "| + (add icon theme) |\n";
3090 print "| - N (remove icon theme) |\n";
3091 print "| m N (mark default icon theme) |\n";
3092 print "| f N (set fallback icon set) |\n";
3093 print "| l (list icon themes) |\n";
3094 print "| d (done) |\n";
3095 print "`------------------------------------'\n";
3097 print "[icon_themes] command (?=help) > ";
3099 $input =~ s/[\r\n]//g;
3103 sub command_templates
{
3104 print "\nDefine the template sets (skins) that you wish to use. If you have added\n";
3105 print "a template set of your own, just follow the instructions (?) about\n";
3106 print "how to add them. You can also change the default template.\n";
3108 print "\n Available Templates:\n";
3111 while ( $count <= $#templateset_name ) {
3112 if ( $templateset_id[$count] eq $templateset_default ) {
3117 if ( $templateset_id[$count] eq $templateset_fallback ) {
3122 if ( $count < 10 ) {
3125 $name = $templateset_name[$count];
3126 $num_spaces = 35 - length($name);
3127 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3128 $name = $name . " ";
3131 print " $count. $name";
3132 print "($templateset_id[$count])\n";
3136 print "\n d = default template set\n"
3137 . " f = fallback template set\n\n";
3139 $menu_text = ".-------------------------------------.\n"
3140 . "| t (detect template set) |\n"
3141 . "| + (add template set) |\n"
3142 . "| - N (remove template set) |\n"
3143 . "| m N (mark default template set) |\n"
3144 . "| f N (set fallback template set) |\n"
3145 . "| l (list template sets/skins) |\n"
3147 . "|-------------------------------------|\n"
3148 . "| where N is a template set number |\n"
3149 . "`-------------------------------------'\n";
3152 print "\n[template set] command (?=help) > ";
3155 $input =~ s/[\r\n]//g;
3156 while ( $input ne "d" ) {
3158 # list template sets
3160 if ( $input =~ /^\s*l\s*/i ) {
3162 while ( $count <= $#templateset_name ) {
3163 if ( $templateset_id[$count] eq $templateset_default ) {
3168 if ( $templateset_id[$count] eq $templateset_fallback ) {
3173 if ( $count < 10 ) {
3176 $name = $templateset_name[$count];
3177 $num_spaces = 35 - length($name);
3178 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3179 $name = $name . " ";
3182 print " $count. $name";
3183 print "($templateset_id[$count])\n";
3187 print "\n d = default template set\n"
3188 . " f = fallback template set\n\n";
3190 # mark default template set
3192 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
3193 $old_def = $templateset_default;
3194 $input =~ s/^\s*m\s*//;
3195 $templateset_default = $templateset_id[$input];
3196 if ( $templateset_default =~ /^\s*$/ ) {
3197 print "Cannot set default template set to $input. That template set does not exist.\n";
3198 $templateset_default = $old_def;
3201 # set fallback template set
3203 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
3204 $old_def = $templateset_fallback;
3205 $input =~ s/^\s*f\s*//;
3206 $templateset_fallback = $templateset_id[$input];
3207 if ( $templateset_fallback =~ /^\s*$/ ) {
3208 print "Cannot set fallback template set to $input. That template set does not exist.\n";
3209 $templateset_fallback = $old_def;
3214 } elsif ( $input =~ /^\s*\+/ ) {
3215 print "\nWhat is the name of this template (as shown to your users): ";
3217 $name =~ s/[\r\n]//g;
3218 $templateset_name[ $#templateset_name + 1 ] = $name;
3219 print "\n\nThe directory name should not contain any path information\n"
3220 . "or slashes, and should be the name of the directory that the\n"
3221 . "template set is found in within the SquirrelMail templates\n"
3223 print "What directory is this stored in (ex: default_advanced): ";
3225 $name =~ s/[\r\n]//g;
3226 $templateset_id[ $#templateset_id + 1 ] = $name;
3228 # detect template sets
3230 } elsif ( $input =~ /^\s*t\s*/i ) {
3231 print "\nStarting detection...\n\n";
3232 opendir( DIR
, "../templates" );
3233 @files = sort(readdir(DIR
));
3235 while ( $cnt <= $#files ) {
3236 if ( -d
"../templates/" . $files[$cnt] && $files[$cnt] !~ /^\./ && $files[$cnt] ne ".svn" ) {
3237 $filename = $files[$cnt];
3239 for ( $x = 0 ; $x <= $#templateset_id ; $x++ ) {
3240 if ( $templateset_id[$x] eq $filename ) {
3246 print "** Found template set: $filename\n";
3247 $def = $files[$cnt];
3250 #$def =~ s/(^\w+)/ucfirst $1/eg;
3251 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3252 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3253 print " What is it's name (as shown to your users)? [$def]: ";
3255 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3256 if ( $nm eq '' ) { $nm = $def; }
3257 $templateset_id[ $#templateset_id + 1 ] = $filename;
3258 $templateset_name[ $#templateset_name + 1 ] = $nm;
3264 for ( $cnt= 0 ; $cnt <= $#templateset_id ; ) {
3265 $filename = $templateset_id[$cnt];
3266 if ( !(-d change_to_rel_path
('SM_PATH . \'templates/' . $filename)) ) {
3267 print " Removing \"$filename\" (template set directory not found)\n";
3268 if ( $templateset_default eq $filename ) { $templateset_default = 'default'; }
3269 if ( $templateset_fallback eq $filename ) { $templateset_fallback = 'default'; }
3271 @new_templateset_name = ();
3272 @new_templateset_id = ();
3273 for ( $x = 0 ; $x < $#templateset_id ; $x++ ) {
3274 if ( $templateset_id[$x] eq $filename ) {
3277 if ( $offset == 1 ) {
3278 $new_templateset_name[$x] = $templateset_name[ $x + 1 ];
3279 $new_templateset_id[$x] = $templateset_id[ $x + 1 ];
3281 $new_templateset_name[$x] = $templateset_name[$x];
3282 $new_templateset_id[$x] = $templateset_id[$x];
3285 @templateset_name = @new_templateset_name;
3286 @templateset_id = @new_templateset_id;
3289 print "\nDetection complete!\n\n";
3293 # remove template set
3295 # undocumented functionality of removing last template set isn't that great
3296 #} elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3297 } elsif ( $input =~ /^\s*-\s*[0-9]+/ ) {
3298 if ( $input =~ /[0-9]+\s*$/ ) {
3300 $rem_num =~ s/^\s*-\s*//g;
3301 $rem_num =~ s/\s*$//;
3303 $rem_num = $#templateset_name;
3305 if ( $templateset_id[$rem_num] eq $templateset_default ) {
3306 print "You cannot remove the default template set!\n";
3307 } elsif ( $templateset_id[$rem_num] eq $templateset_fallback ) {
3308 print "You cannot remove the fallback template set!\n";
3311 @new_templateset_name = ();
3312 @new_templateset_id = ();
3313 while ( $count <= $#templateset_name ) {
3314 if ( $count != $rem_num ) {
3315 @new_templateset_name = ( @new_templateset_name, $templateset_name[$count] );
3316 @new_templateset_id = ( @new_templateset_id, $templateset_id[$count] );
3320 @templateset_name = @new_templateset_name;
3321 @templateset_id = @new_templateset_id;
3326 } elsif ( $input =~ /^\s*\?\s*/ ) {
3329 # command not understood
3332 print "Command not understood\n";
3335 print "[template set] command (?=help) > ";
3337 $input =~ s/[\r\n]//g;
3339 return $templateset_default;
3343 # sets default font size option
3344 sub command_default_fontsize
{
3345 print "Enter default font size [$WHT$$default_fontsize$NRM]: $WHT";
3346 $new_size = <STDIN
>;
3347 if ( $new_size eq "\n" ) {
3350 $new_size =~ s/[\r\n]//g;
3355 # controls available fontsets
3356 sub command_fontsets
{
3358 print "You can control fontsets available to end users here.\n";
3359 # set initial $input value
3361 while ( $input ne "x" ) {
3362 if ( $input =~ /^\s*a\s*/i ) {
3364 print "\nFontset name: ";
3366 if (! $fontsets{trim
($name)}) {
3367 print "Fontset string: ";
3369 $fontsets{trim
($name)} = trim
($value);
3371 print "\nERROR: Such fontset already exists.\n";
3373 } elsif ( $input =~ /^\s*e\s*/i ) {
3374 # edit existing fontset
3375 print "\nFontset name: ";
3377 if (! $fontsets{trim
($name)}) {
3378 print "\nERROR: No such fontset.\n";
3380 print "Fontset string [$fontsets{trim($name)}]: ";
3382 $fontsets{trim
($name)} = trim
($value);
3384 } elsif ( $input =~ /^\s*d\s*/ ) {
3385 # delete existing fontset
3386 print "\nFontset name: ";
3388 if (! $fontsets{trim
($name)}) {
3389 print "\nERROR: No such fontset.\n";
3391 delete $fontsets{trim
($name)};
3393 } elsif ( $input =~ /^\s*l\s*/ ) {
3395 print "\nConfigured fontsets:\n";
3396 while (($fontset_name, $fontset_string) = each(%fontsets)) {
3397 print " $fontset_name = $fontset_string\n";
3399 print "Default fontset: $default_fontset\n";
3400 } elsif ( $input =~ /^\s*m\s*/ ) {
3401 # set default fontset
3402 print "\nSet default fontset [$default_fontset]: ";
3404 if (trim
($name) ne '' and ! $fontsets{trim
($name)}) {
3405 print "\nERROR: No such fontset.\n";
3407 $default_fontset = trim
($name);
3410 # print available commands on any other input
3411 print "\nAvailable commands:\n";
3412 print " a - Adds new fontset.\n";
3413 print " d - Deletes existing fontset.\n";
3414 print " e - Edits existing fontset.\n";
3415 print " h or ? - Shows this help screen.\n";
3416 print " l - Lists available fontsets.\n";
3417 print " m - Sets default fontset.\n";
3418 print " x - Exits fontset editor mode.\n";
3420 print "\nCommand [fontsets] (a,d,e,h,?=help,l,m,x)> ";
3422 $input =~ s/[\r\n]//g;
3427 print "You can now define different LDAP servers.\n";
3428 print "Please ensure proper permissions for config.php when including\n";
3429 print "sensitive passwords.\n\n";
3430 print "[ldap] command (?=help) > ";
3432 $input =~ s/[\r\n]//g;
3433 while ( $input ne "d" ) {
3434 if ( $input =~ /^\s*l\s*/i ) {
3436 while ( $count <= $#ldap_host ) {
3437 print "$count. $ldap_host[$count]\n";
3438 print " base: $ldap_base[$count]\n";
3439 if ( $ldap_charset[$count] ) {
3440 print " charset: $ldap_charset[$count]\n";
3442 if ( $ldap_port[$count] ) {
3443 print " port: $ldap_port[$count]\n";
3445 if ( $ldap_name[$count] ) {
3446 print " name: $ldap_name[$count]\n";
3448 if ( $ldap_maxrows[$count] ) {
3449 print " maxrows: $ldap_maxrows[$count]\n";
3451 if ( $ldap_filter[$count] ) {
3452 print " filter: $ldap_filter[$count]\n";
3454 if ( $ldap_binddn[$count] ) {
3455 print " binddn: $ldap_binddn[$count]\n";
3456 if ( $ldap_bindpw[$count] ) {
3457 print " bindpw: $ldap_bindpw[$count]\n";
3460 if ( $ldap_protocol[$count] ) {
3461 print " protocol: $ldap_protocol[$count]\n";
3463 if ( $ldap_limit_scope[$count] ) {
3464 print " limit_scope: $ldap_limit_scope[$count]\n";
3466 if ( $ldap_listing[$count] ) {
3467 print " listing: $ldap_listing[$count]\n";
3469 if ( $ldap_writeable[$count] ) {
3470 print " writeable: $ldap_writeable[$count]\n";
3472 if ( $ldap_search_tree[$count] ) {
3473 print " search_tree: $ldap_search_tree[$count]\n";
3475 if ( $ldap_starttls[$count] ) {
3476 print " starttls: $ldap_starttls[$count]\n";
3482 } elsif ( $input =~ /^\s*\+/ ) {
3483 $sub = $#ldap_host + 1;
3485 print "First, we need to have the hostname or the IP address where\n";
3486 print "this LDAP server resides. Example: ldap.bigfoot.com\n";
3488 print "You can use any URI compatible with your LDAP library. Please\n";
3489 print "note that StartTLS option is not compatible with ldaps and\n";
3490 print "ldapi URIs.\n";
3493 $name =~ s/[\r\n]//g;
3494 $ldap_host[$sub] = $name;
3498 print "Next, we need the server root (base dn). For this, an empty\n";
3499 print "string is allowed.\n";
3500 print "Example: ou=member_directory,o=netcenter.com\n";
3503 $name =~ s/[\r\n]//g;
3504 $ldap_base[$sub] = $name;
3508 print "This is the TCP/IP port number for the LDAP server. Default\n";
3509 print "port is 389. This is optional. Press ENTER for default.\n";
3512 $name =~ s/[\r\n]//g;
3513 $ldap_port[$sub] = $name;
3517 print "This is the charset for the server. Default is utf-8. This\n";
3518 print "is also optional. Press ENTER for default.\n";
3521 $name =~ s/[\r\n]//g;
3522 $ldap_charset[$sub] = $name;
3526 print "This is the name for the server, used to tag the results of\n";
3527 print "the search. Default it \"LDAP: hostname\". Press ENTER for default\n";
3530 $name =~ s/[\r\n]//g;
3531 $ldap_name[$sub] = $name;
3535 print "You can specify the maximum number of rows in the search result.\n";
3536 print "Default value is equal to 250 rows. Press ENTER for default.\n";
3539 $name =~ s/[\r\n]//g;
3540 $ldap_maxrows[$sub] = $name;
3545 print "If your LDAP server does not like anonymous logins, you can specify bind DN.\n";
3546 print "Default is none, anonymous bind. Press ENTER for default.\n";
3549 $name =~ s/[\r\n]//g;
3550 $ldap_binddn[$sub] = $name;
3554 if ( $ldap_binddn[$sub] ne '' ) {
3556 print "Now, please specify password for that DN.\n";
3559 $name =~ s/[\r\n]//g;
3560 $ldap_bindpw[$sub] = $name;
3565 print "You can specify bind protocol version here.\n";
3566 print "Default protocol version depends on your php ldap settings.\n";
3567 print "Press ENTER for default.\n";
3570 $name =~ s/[\r\n]//g;
3571 $ldap_protocol[$sub] = $name;
3575 print "This configuration section allows to set some rarely used\n";
3576 print "options and options specific to some LDAP implementations.\n";
3578 print "Do you want to set advanced LDAP directory settings? (y/N):";
3579 $ldap_advanced_settings = <STDIN
>;
3580 if ( $ldap_advanced_settings =~ /^y\n/i ) {
3581 $ldap_advanced_settings = 'true';
3583 $ldap_advanced_settings = 'false';
3586 if ($ldap_advanced_settings eq 'true') {
3589 print "You can control LDAP directory listing here. This option can\n";
3590 print "be useful if you run small LDAP server and want to provide listing\n";
3591 print "of all addresses stored in LDAP to users of webmail interface.\n";
3592 print "Number of displayed entries is limited by maxrows setting.\n";
3594 print "Don't enable this option for public LDAP directories.\n";
3596 print "Allow listing of LDAP directory? (y/N):";
3598 if ( $name =~ /^y\n/i ) {
3603 $ldap_listing[$sub] = $name;
3607 print "You can control write access to LDAP address book here. This option can\n";
3608 print "be useful if you run small LDAP server and want to provide writable\n";
3609 print "shared address book stored in LDAP to users of webmail interface.\n";
3611 print "Don't enable this option for public LDAP directories.\n";
3613 print "Allow writing to LDAP directory? (y/N):";
3615 if ( $name =~ /^y\n/i ) {
3620 $ldap_writeable[$sub] = $name;
3624 print "You can specify an additional search filter.\n";
3625 print "This could be something like \"(objectclass=posixAccount)\".\n";
3626 print "No filtering is performed by default. Press ENTER for default.\n";
3629 $name =~ s/[\r|\n]//g;
3630 $ldap_filter[$sub] = $name;
3634 print "You can control search scope here.\n";
3635 print "This option is specific to Microsoft ADS implementation.\n";
3636 print "It requires use of v3 or newer LDAP protocol.\n";
3637 print "Don't enable it, if you use other LDAP server.\n";
3639 print "Limit ldap scope? (y/N):";
3641 if ( $name =~ /^y\n/i ) {
3646 $ldap_limit_scope[$sub] = $name;
3650 print "You can control ldap search type here.\n";
3651 print "Addresses can be searched in entire LDAP subtree (default)\n";
3652 print "or only first level entries are returned.\n";
3654 print "Search entire LDAP subtree? (Y/n):";
3656 if ( $name =~ /^n\n/i ) {
3661 $ldap_search_tree[$sub] = $name;
3665 print "You can control use of StartTLS on LDAP connection here.\n";
3666 print "This option requires use of v3 or newer LDAP protocol and php 4.2+.\n";
3668 print "Use StartTLS? (y/N):";
3670 if ( $name =~ /^y\n/i ) {
3675 $ldap_starttls[$sub] = $name;
3679 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3680 if ( $input =~ /[0-9]+\s*$/ ) {
3682 $rem_num =~ s/^\s*-\s*//g;
3683 $rem_num =~ s/\s*$//;
3685 $rem_num = $#ldap_host;
3688 @new_ldap_host = ();
3689 @new_ldap_base = ();
3690 @new_ldap_port = ();
3691 @new_ldap_name = ();
3692 @new_ldap_charset = ();
3693 @new_ldap_maxrows = ();
3694 @new_ldap_filter = ();
3695 @new_ldap_bindpw = ();
3696 @new_ldap_binddn = ();
3697 @new_ldap_protocol = ();
3698 @new_ldap_limit_scope = ();
3699 @new_ldap_listing = ();
3700 @new_ldap_writeable = ();
3701 @new_ldap_search_tree = ();
3702 @new_ldap_starttls = ();
3704 while ( $count <= $#ldap_host ) {
3705 if ( $count != $rem_num ) {
3706 @new_ldap_host = ( @new_ldap_host, $ldap_host[$count] );
3707 @new_ldap_base = ( @new_ldap_base, $ldap_base[$count] );
3708 @new_ldap_port = ( @new_ldap_port, $ldap_port[$count] );
3709 @new_ldap_name = ( @new_ldap_name, $ldap_name[$count] );
3710 @new_ldap_charset = ( @new_ldap_charset, $ldap_charset[$count] );
3711 @new_ldap_maxrows = ( @new_ldap_maxrows, $ldap_maxrows[$count] );
3712 @new_ldap_filter = ( @new_ldap_filter, $ldap_filter[$count] );
3713 @new_ldap_binddn = ( @new_ldap_binddn, $ldap_binddn[$count] );
3714 @new_ldap_bindpw = ( @new_ldap_bindpw, $ldap_bindpw[$count] );
3715 @new_ldap_protocol = ( @new_ldap_protocol, $ldap_protocol[$count] );
3716 @new_ldap_limit_scope = ( @new_ldap_limit_scope, $ldap_limit_scope[$count] );
3717 @new_ldap_listing = ( @new_ldap_listing, $ldap_listing[$count] );
3718 @new_ldap_writeable = ( @new_ldap_writeable, $ldap_writeable[$count] );
3719 @new_ldap_search_tree = ( @new_ldap_search_tree, $ldap_search_tree[$count] );
3720 @new_ldap_starttls = ( @new_ldap_starttls, $ldap_starttls[$count] );
3724 @ldap_host = @new_ldap_host;
3725 @ldap_base = @new_ldap_base;
3726 @ldap_port = @new_ldap_port;
3727 @ldap_name = @new_ldap_name;
3728 @ldap_charset = @new_ldap_charset;
3729 @ldap_maxrows = @new_ldap_maxrows;
3730 @ldap_filter = @new_ldap_filter;
3731 @ldap_binddn = @new_ldap_binddn;
3732 @ldap_bindpw = @new_ldap_bindpw;
3733 @ldap_protocol = @new_ldap_protocol;
3734 @ldap_limit_scope = @new_ldap_limit_scope;
3735 @ldap_listing = @new_ldap_listing;
3736 @ldap_writeable = @new_ldap_writeable;
3737 @ldap_search_tree = @new_ldap_search_tree;
3738 @ldap_starttls = @new_ldap_starttls;
3740 } elsif ( $input =~ /^\s*\?\s*/ ) {
3741 print ".-------------------------.\n";
3742 print "| + (add host) |\n";
3743 print "| - N (remove host) |\n";
3744 print "| l (list hosts) |\n";
3745 print "| d (done) |\n";
3746 print "`-------------------------'\n";
3748 print "[ldap] command (?=help) > ";
3750 $input =~ s/[\r\n]//g;
3755 print "Some of our developers have come up with very good javascript interface\n";
3756 print "for searching through address books, however, our original goals said\n";
3757 print "that we would be 100% HTML. In order to make it possible to use their\n";
3758 print "interface, and yet stick with our goals, we have also written a plain\n";
3759 print "HTML version of the search. Here, you can choose which version to use.\n";
3761 print "This is just the default value. It is also a user option that each\n";
3762 print "user can configure individually\n";
3765 if ( lc($default_use_javascript_addr_book) eq 'true' ) {
3766 $default_value = "y";
3768 $default_use_javascript_addr_book = 'false';
3769 $default_value = "n";
3771 print "Use javascript version by default (y/n) [$WHT$default_value$NRM]: $WHT";
3772 $new_show = <STDIN
>;
3773 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3774 $default_use_javascript_addr_book = 'true';
3776 $default_use_javascript_addr_book = 'false';
3778 return $default_use_javascript_addr_book;
3781 # global filebased address book
3783 print "If you want to use global file address book, then you\n";
3784 print "must set this option to a valid value. If option does\n";
3785 print "not have path elements, system assumes that file is\n";
3786 print "stored in data directory. If relative path is set, it is\n";
3787 print "relative to main SquirrelMail directory. If value is empty,\n";
3788 print "address book is not enabled.\n";
3791 print "[$WHT$abook_global_file$NRM]: $WHT";
3792 $new_abook_global_file = <STDIN
>;
3793 if ( $new_abook_global_file eq "\n" ) {
3794 $new_abook_global_file = $abook_global_file;
3796 $new_abook_global_file =~ s/[\r\n]//g;
3798 return $new_abook_global_file;
3801 # writing into global filebased abook control
3803 print "This setting controls writing into global file address\n";
3804 print "book options. Address book file must be writeable by\n";
3805 print "webserver's user, if you want to enable this option.\n";
3808 if ( lc($abook_global_file_writeable) eq 'true' ) {
3809 $default_value = "y";
3811 $abook_global_file_writeable = 'false';
3812 $default_value = "n";
3814 print "Allow writing into global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
3815 $new_show = <STDIN
>;
3816 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3817 $abook_global_file_writeable = 'true';
3819 $abook_global_file_writeable = 'false';
3821 return $abook_global_file_writeable;
3824 # listing of global filebased abook control
3826 print "This setting controls listing of global file address\n";
3827 print "book in addresses page.\n";
3830 if ( lc($abook_global_file_listing) eq 'true' ) {
3831 $default_value = "y";
3833 $abook_global_file_listing = 'false';
3834 $default_value = "n";
3836 print "Allow listing of global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
3837 $new_show = <STDIN
>;
3838 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3839 $abook_global_file_listing = 'true';
3841 $abook_global_file_listing = 'false';
3843 return $abook_global_file_listing;
3846 # controls $abook_file_line_length setting
3847 sub command_abook_file_line_length
{
3848 print "This setting controls space allocated to file based address book records.\n";
3849 print "End users will be unable to save address book entry, if total entry size \n";
3850 print "(quoted address book fields + 4 delimiters + linefeed) exceeds allowed \n";
3851 print "address book length size.\n";
3853 print "Same setting is applied to personal and global file based address books.\n";
3855 print "It is strongly recommended to keep default setting value. Change it only\n";
3856 print "if you really want to store address book entries that are bigger than two\n";
3857 print "kilobytes (2048).\n";
3860 print "Enter allowed address book line length [$abook_file_line_length]: ";
3863 # value is not modified, if user hits Enter or enters space
3865 # make sure that input is numeric
3866 if ($tmp =~ /^\d+$/) {
3867 $abook_file_line_length = $tmp;
3869 print "If you want to change this setting, you must enter number.\n";
3870 print "If you want to keep original setting - enter space.\n\n";
3871 print "Press Enter to continue...";
3878 print "If you want to store your users address book details in a database then\n";
3879 print "you need to set this DSN to a valid value. The format for this is:\n";
3880 print "mysql://user:pass\@hostname/dbname\n";
3881 print "Where mysql can be one of the databases PHP supports, the most common\n";
3882 print "of these are mysql, msql and pgsql.\n";
3883 print "Please ensure proper permissions for config.php when including\n";
3884 print "sensitive passwords.\n\n";
3885 print "If the DSN is left empty (hit space and then return) the database\n";
3886 print "related code for address books will not be used.\n";
3889 if ( $addrbook_dsn eq "" ) {
3890 $default_value = "Disabled";
3892 $default_value = $addrbook_dsn;
3894 print "[$WHT$addrbook_dsn$NRM]: $WHT";
3896 if ( $new_dsn eq "\n" ) {
3899 $new_dsn =~ s/[\r\n]//g;
3900 $new_dsn =~ s/^\s+$//g;
3906 print "This is the name of the table you want to store the address book\n";
3907 print "data in, it defaults to 'address'\n";
3909 print "[$WHT$addrbook_table$NRM]: $WHT";
3910 $new_table = <STDIN
>;
3911 if ( $new_table eq "\n" ) {
3912 $new_table = $addrbook_table;
3914 $new_table =~ s/[\r\n]//g;
3920 print "If you want to store your users preferences in a database then\n";
3921 print "you need to set this DSN to a valid value. The format for this is:\n";
3922 print "mysql://user:pass\@hostname/dbname\n";
3923 print "Where mysql can be one of the databases PHP supports, the most common\n";
3924 print "of these are mysql, msql and pgsql.\n";
3925 print "Please ensure proper permissions for config.php when including\n";
3926 print "sensitive passwords.\n\n";
3927 print "If the DSN is left empty (hit space and then return) the database\n";
3928 print "related code for address books will not be used.\n";
3931 if ( $prefs_dsn eq "" ) {
3932 $default_value = "Disabled";
3934 $default_value = $prefs_dsn;
3936 print "[$WHT$prefs_dsn$NRM]: $WHT";
3938 if ( $new_dsn eq "\n" ) {
3941 $new_dsn =~ s/[\r\n]//g;
3942 $new_dsn =~ s/^\s+$//g;
3948 print "This is the name of the table you want to store the preferences\n";
3949 print "data in, it defaults to 'userprefs'\n";
3951 print "[$WHT$prefs_table$NRM]: $WHT";
3952 $new_table = <STDIN
>;
3953 if ( $new_table eq "\n" ) {
3954 $new_table = $prefs_table;
3956 $new_table =~ s/[\r\n]//g;
3962 print "This is the name of the field in which you want to store the\n";
3963 print "username of the person the prefs are for. It default to 'user'\n";
3964 print "which clashes with a reserved keyword in PostgreSQL so this\n";
3965 print "will need to be changed for that database at least\n";
3967 print "[$WHT$prefs_user_field$NRM]: $WHT";
3968 $new_field = <STDIN
>;
3969 if ( $new_field eq "\n" ) {
3970 $new_field = $prefs_user_field;
3972 $new_field =~ s/[\r\n]//g;
3974 $prefs_user_size = db_pref_size
($prefs_user_size);
3979 print "This is the name of the field in which you want to store the\n";
3980 print "preferences keyword. It defaults to 'prefkey'\n";
3982 print "[$WHT$prefs_key_field$NRM]: $WHT";
3983 $new_field = <STDIN
>;
3984 if ( $new_field eq "\n" ) {
3985 $new_field = $prefs_key_field;
3987 $new_field =~ s/[\r\n]//g;
3989 $prefs_key_size = db_pref_size
($prefs_key_size);
3994 print "This is the name of the field in which you want to store the\n";
3995 print "preferences value. It defaults to 'prefval'\n";
3997 print "[$WHT$prefs_val_field$NRM]: $WHT";
3998 $new_field = <STDIN
>;
3999 if ( $new_field eq "\n" ) {
4000 $new_field = $prefs_val_field;
4002 $new_field =~ s/[\r\n]//g;
4004 $prefs_val_size = db_pref_size
($prefs_val_size);
4008 # routine is used to set database field limits
4009 # it needs one argument
4010 sub db_pref_size
() {
4012 print "\nDatabase fields have size limits.\n";
4014 print "What limit is set for this field? [$WHT$size$NRM]: $WHT";
4015 $new_size = <STDIN
>;
4016 if ( $new_size eq "\n" ) {
4019 $new_size =~ s/[\r\n]//g;
4025 print "If you want to store your global address book in a database then\n";
4026 print "you need to set this DSN to a valid value. The format for this is:\n";
4027 print "mysql://user:pass\@hostname/dbname\n";
4028 print "Where mysql can be one of the databases PHP supports, the most common\n";
4029 print "of these are mysql, msql and pgsql.\n";
4030 print "Please ensure proper permissions for config.php when including\n";
4031 print "sensitive passwords.\n\n";
4032 print "If the DSN is left empty (hit space and then return) the database\n";
4033 print "related code for global SQL address book will not be used.\n";
4036 if ( $addrbook_global_dsn eq "" ) {
4037 $default_value = "Disabled";
4039 $default_value = $addrbook_global_dsn;
4041 print "[$WHT$addrbook_global_dsn$NRM]: $WHT";
4043 if ( $new_dsn eq "\n" ) {
4046 $new_dsn =~ s/[\r\n]//g;
4047 $new_dsn =~ s/^\s+$//g;
4053 print "This is the name of the table you want to store the global address book\n";
4054 print "data in. Default table name is 'global_abook'. Address book uses same\n";
4055 print "database format as personal address book.\n";
4057 print "[$WHT$addrbook_global_table$NRM]: $WHT";
4058 $new_table = <STDIN
>;
4059 if ( $new_table eq "\n" ) {
4060 $new_table = $addrbook_global_table;
4062 $new_table =~ s/[\r\n]//g;
4068 print "This option controls users\' ability to add or modify records stored \n";
4069 print "in global address book\n";
4071 if ( lc($addrbook_global_writeable) eq 'true' ) {
4072 $default_value = "y";
4074 $default_value = "n";
4076 print "Allow writing into global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
4077 $addrbook_global_writeable = <STDIN
>;
4078 if ( ( $addrbook_global_writeable =~ /^y\n/i ) || ( ( $addrbook_global_writeable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4079 $addrbook_global_writeable = 'true';
4081 $addrbook_global_writeable = 'false';
4083 return $addrbook_global_writeable;
4087 print "Enable this option if you want to see listing of addresses stored \n";
4088 print "in global address book\n";
4090 if ( lc($addrbook_global_listing) eq 'true' ) {
4091 $default_value = "y";
4093 $default_value = "n";
4095 print "Allow listing of global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
4096 $addrbook_global_listing = <STDIN
>;
4097 if ( ( $addrbook_global_listing =~ /^y\n/i ) || ( ( $addrbook_global_listing =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4098 $addrbook_global_listing = 'true';
4100 $addrbook_global_listing = 'false';
4102 return $addrbook_global_listing;
4108 print "SquirrelMail attempts to set the language in many ways. If it\n";
4109 print "can not figure it out in another way, it will default to this\n";
4110 print "language. Please use the code for the desired language.\n";
4112 print "[$WHT$squirrelmail_default_language$NRM]: $WHT";
4113 $new_squirrelmail_default_language = <STDIN
>;
4114 if ( $new_squirrelmail_default_language eq "\n" ) {
4115 $new_squirrelmail_default_language = $squirrelmail_default_language;
4117 $new_squirrelmail_default_language =~ s/[\r\n]//g;
4118 $new_squirrelmail_default_language =~ s/^\s+$//g;
4120 return $new_squirrelmail_default_language;
4124 print "This option controls what character set is used when sending\n";
4125 print "mail and when sending HTML to the browser. Option works only\n";
4126 print "with US English (en_US) translation. Other translations use\n";
4127 print "charsets that are set in translation settings.\n";
4130 print "[$WHT$default_charset$NRM]: $WHT";
4131 $new_default_charset = <STDIN
>;
4132 if ( $new_default_charset eq "\n" ) {
4133 $new_default_charset = $default_charset;
4135 $new_default_charset =~ s/[\r\n]//g;
4137 return $new_default_charset;
4139 # Alternative language names
4141 print "Enable this option if you want to see localized language names in\n";
4142 print "language selection box. Note, that this option can trigger\n";
4143 print "installation of foreign language support modules in some browsers.\n";
4146 if ( lc($show_alternative_names) eq 'true' ) {
4147 $default_value = "y";
4149 $default_value = "n";
4151 print "Show alternative language names? (y/n) [$WHT$default_value$NRM]: $WHT";
4152 $show_alternative_names = <STDIN
>;
4153 if ( ( $show_alternative_names =~ /^y\n/i ) || ( ( $show_alternative_names =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4154 $show_alternative_names = 'true';
4156 $show_alternative_names = 'false';
4158 return $show_alternative_names;
4161 # Aggressive decoding
4163 print "Enable this option if you want to use CPU and memory intensive decoding\n";
4164 print "functions. This option allows reading multibyte charset, that are used\n";
4165 print "in Eastern Asia. SquirrelMail will try to use recode functions here,\n";
4166 print "even when you have disabled use of recode in Tweaks section.\n";
4169 if ( lc($aggressive_decoding) eq 'true' ) {
4170 $default_value = "y";
4172 $default_value = "n";
4174 print "Enable aggressive decoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4175 $aggressive_decoding = <STDIN
>;
4176 if ( ( $aggressive_decoding =~ /^y\n/i ) || ( ( $aggressive_decoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4177 $aggressive_decoding = 'true';
4179 $aggressive_decoding = 'false';
4181 return $aggressive_decoding;
4186 print "Enable this option if you want to allow lossy charset encoding in message\n";
4187 print "composition pages. This option allows charset conversions when output\n";
4188 print "charset does not support all symbols used in original charset. Symbols\n";
4189 print "unsupported by output charset will be replaced with question marks.\n";
4192 if ( lc($lossy_encoding) eq 'true' ) {
4193 $default_value = "y";
4195 $default_value = "n";
4197 print "Enable lossy encoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4198 $lossy_encoding = <STDIN
>;
4199 if ( ( $lossy_encoding =~ /^y\n/i ) || ( ( $lossy_encoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4200 $lossy_encoding = 'true';
4202 $lossy_encoding = 'false';
4204 return $lossy_encoding;
4207 # display html emails in iframe
4209 print "This option can enable html email rendering inside iframe.\n";
4210 print "Inline frames are used in order to provide sandbox environment";
4211 print "for html code included in html formated emails.";
4212 print "Option is experimental and might have glitches in some parts of code.";
4215 if ( lc($use_iframe) eq 'true' ) {
4216 $default_value = "y";
4218 $default_value = "n";
4220 print "Display html emails in iframe? (y/n) [$WHT$default_value$NRM]: $WHT";
4221 $use_iframe = <STDIN
>;
4222 if ( ( $use_iframe =~ /^y\n/i ) || ( ( $use_iframe =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4223 $use_iframe = 'true';
4225 $use_iframe = 'false';
4231 sub command_ask_user_info
{
4232 print "New users need to supply their real name and email address to\n";
4233 print "send out proper mails. When this option is enabled, a user that\n";
4234 print "logs in for the first time will be redirected to the Personal\n";
4235 print "Options screen and asked to supply their personal data.\n";
4238 if ( lc($ask_user_info) eq 'true' ) {
4239 $default_value = "y";
4241 $default_value = "n";
4243 print "Ask user info? (y/n) [$WHT$default_value$NRM]: $WHT";
4244 $ask_user_info = <STDIN
>;
4245 if ( ( $ask_user_info =~ /^y\n/i ) || ( ( $ask_user_info =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4246 $ask_user_info = 'true';
4248 $ask_user_info = 'false';
4250 return $ask_user_info;
4255 print "Enabling this option will cause icons to be used instead of text\n";
4256 print "markers next to each message in mailbox lists that represent\n";
4257 print "new, read, flagged, and deleted messages, as well as those that\n";
4258 print "have been replied to and forwarded. Icons are also used next to\n";
4259 print "(un)expanded folders in the folder list (Oldway = false). These\n";
4260 print "icons are quite small, but will obviously be more of a resource\n";
4261 print "drain than text markers.\n";
4264 if ( lc($use_icons) eq 'true' ) {
4265 $default_value = "y";
4267 $default_value = "n";
4269 print "Use icons? (y/n) [$WHT$default_value$NRM]: $WHT";
4270 $use_icons = <STDIN
>;
4271 if ( ( $use_icons =~ /^y\n/i ) || ( ( $use_icons =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4272 $use_icons = 'true';
4274 $use_icons = 'false';
4280 print "Enable this option if you want to use php recode functions to read\n";
4281 print "emails written in charset that differs from the one that is set in\n";
4282 print "translation selected by user. Code is experimental, it might cause\n";
4283 print "errors, if email contains charset unsupported by recode or if your\n";
4284 print "php does not have recode support.\n";
4287 if ( lc($use_php_recode) eq 'true' ) {
4288 $default_value = "y";
4290 $default_value = "n";
4292 print "Use php recode functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4293 $use_php_recode = <STDIN
>;
4294 if ( ( $use_php_recode =~ /^y\n/i ) || ( ( $use_php_recode =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4295 $use_php_recode = 'true';
4297 $use_php_recode = 'false';
4299 return $use_php_recode;
4303 print "Enable this option if you want to use php iconv functions to read\n";
4304 print "emails written in charset that differs from the one that is set in\n";
4305 print "translation selected by user. Code is experimental, it works only\n";
4306 print "with translations that use utf-8 charset. Code might cause errors,\n";
4307 print "if email contains charset unsupported by iconv or if your php does\n";
4308 print "not have iconv support.\n";
4311 if ( lc($use_php_iconv) eq 'true' ) {
4312 $default_value = "y";
4314 $default_value = "n";
4316 print "Use php iconv functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4317 $use_php_iconv = <STDIN
>;
4318 if ( ( $use_php_iconv =~ /^y\n/i ) || ( ( $use_php_iconv =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4319 $use_php_iconv = 'true';
4321 $use_php_iconv = 'false';
4323 return $use_php_iconv;
4328 print "Enable this option if you want to check SquirrelMail configuration\n";
4329 print "remotely with configtest.php script.\n";
4332 if ( lc($allow_remote_configtest) eq 'true' ) {
4333 $default_value = "y";
4335 $default_value = "n";
4337 print "Allow remote configuration tests? (y/n) [$WHT$default_value$NRM]: $WHT";
4338 $allow_remote_configtest = <STDIN
>;
4339 if ( ( $allow_remote_configtest =~ /^y\n/i ) || ( ( $allow_remote_configtest =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4340 $allow_remote_configtest = 'true';
4342 $allow_remote_configtest = 'false';
4344 return $allow_remote_configtest;
4347 # Default Icon theme
4349 print "You may change the path to the default icon theme to be used, if icons\n";
4350 print "have been enabled. This theme will be used when an icon cannot be\n";
4351 print "found in the current theme, or when no icon theme is specified. If\n";
4352 print "left blank, and icons are enabled, the default theme will be used\n";
4353 print "from images/themes/default/.\n";
4355 print "To clear out an existing value, just type a space for the input.\n";
4357 print "Please be aware of the following: \n";
4358 print " - Relative URLs are relative to the config dir\n";
4359 print " to use the icon themes directory, use ../images/themes/newtheme/\n";
4360 print " - The icon theme may be outside the SquirrelMail directory, but\n";
4361 print " it must be web accessible.\n";
4362 print "[$WHT$icon_theme_def$NRM]: $WHT";
4363 $new_icon_theme_def = <STDIN
>;
4365 if ( $new_icon_theme_def eq "\n" ) {
4366 $new_icon_theme_def = $icon_theme_def;
4368 $new_icon_theme_def =~ s/[\r\n]//g;
4370 $new_icon_theme_def =~ s/^\s*//;
4371 return $new_icon_theme_def;
4374 # SquirrelMail debug mode (since 1.5.2)
4376 print "When debugging or developing SquirrelMail, you may want to increase\n";
4377 print "the verbosity of certain kinds of errors, notices, and/or diagnostics.\n";
4378 print "You may enable one or more of the debugging modes here. Please make\n";
4379 print "sure that you have turned off debugging if you are using SquirrelMail\n";
4380 print "in a production environment.\n\n";
4383 while ( $input ne "d\n" ) {
4384 $sm_debug_mode = convert_debug_constants_to_binary_integer
($sm_debug_mode);
4386 # per include/constants.php, here are the debug mode values:
4388 # 0 SM_DEBUG_MODE_OFF
4389 # 1 SM_DEBUG_MODE_SIMPLE
4390 # 512 SM_DEBUG_MODE_MODERATE
4391 # 524288 SM_DEBUG_MODE_ADVANCED
4392 # 536870912 SM_DEBUG_MODE_STRICT
4394 print "\n# Enabled? Description\n";
4395 print "---------------------------------------------------------------------\n";
4396 print "0 " . ($sm_debug_mode == 0 ?
"y" : " ")
4397 . " No debugging (recommended in production environments)\n";
4398 print "1 " . ($sm_debug_mode & 1 ?
"y" : " ")
4399 . " Simple debugging (PHP E_ERROR)\n";
4400 print "2 " . ($sm_debug_mode & 512 ?
"y" : " ")
4401 . " Moderate debugging (PHP E_ALL)\n";
4402 print "3 " . ($sm_debug_mode & 524288 ?
"y" : " ")
4403 . " Advanced debugging (PHP E_ALL plus log errors\n";
4404 print " intentionally suppressed)\n";
4405 print "4 " . ($sm_debug_mode & 536870912 ?
"y" : " ")
4406 . " Strict debugging (PHP E_STRICT)\n";
4409 print "SquirrelMail debug mode (0,1,2,3,4) or d when done? : $WHT";
4411 if ( $input eq "d\n" ) {
4413 } elsif ($input !~ /^[0-9]+\n$/) {
4414 print "\nInvalid configuration value.\n";
4415 print "\nPress enter to continue...";
4417 } elsif ( $input == "0\n" ) {
4419 } elsif ( $input == "1\n" ) {
4420 if ($sm_debug_mode & 1) {
4421 $sm_debug_mode ^= 1;
4423 $sm_debug_mode |= 1;
4425 } elsif ( $input == "2\n" ) {
4426 if ($sm_debug_mode & 512) {
4427 $sm_debug_mode ^= 512;
4429 $sm_debug_mode |= 512;
4431 } elsif ( $input == "3\n" ) {
4432 if ($sm_debug_mode & 524288) {
4433 $sm_debug_mode ^= 524288;
4435 $sm_debug_mode |= 524288;
4437 } elsif ( $input == "4\n" ) {
4438 if ($sm_debug_mode & 536870912) {
4439 $sm_debug_mode ^= 536870912;
4441 $sm_debug_mode |= 536870912;
4444 print "\nInvalid configuration value.\n";
4445 print "\nPress enter to continue...";
4450 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
4451 return $sm_debug_mode;
4454 # Secured configuration mode (since 1.5.2)
4456 print "This option allows you to enable \"Secured Configuration\" mode,\n";
4457 print "which will guarantee that certain settings made herein will be\n";
4458 print "made immutable and will not be subject to override by either friendly\n";
4459 print "or unfriendly code/plugins. Only a small number of settings herein\n";
4460 print "will be used in this manner - just those that are deemed to be a\n";
4461 print "potential security threat when rouge plugin or other code may be\n";
4462 print "executed inside SquirrelMail.\n";
4465 if ( lc($secured_config) eq 'true' ) {
4466 $default_value = "y";
4468 $default_value = "n";
4470 print "Enable secured configuration mode? (y/n) [$WHT$default_value$NRM]: $WHT";
4471 $secured_config = <STDIN
>;
4472 if ( ( $secured_config =~ /^y\n/i ) || ( ( $secured_config =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4473 $secured_config = 'true';
4475 $secured_config = 'false';
4477 return $secured_config;
4482 if ( open( CF
, ">config.php" ) ) {
4487 print CF
" * SquirrelMail Configuration File\n";
4488 print CF
" * Created using the configure script, conf.pl\n";
4492 if ($print_config_version) {
4493 print CF
"\$config_version = '$print_config_version';\n";
4496 print CF
"\$config_use_color = $config_use_color;\n";
4500 print CF
"\$org_name = \"$org_name\";\n";
4502 print CF
"\$org_logo = " . &change_to_SM_path
($org_logo) . ";\n";
4503 $org_logo_width |= 0;
4504 $org_logo_height |= 0;
4506 print CF
"\$org_logo_width = '$org_logo_width';\n";
4508 print CF
"\$org_logo_height = '$org_logo_height';\n";
4509 # string that can contain variables.
4510 print CF
"\$org_title = \"$org_title\";\n";
4512 print CF
"\$signout_page = " . &change_to_SM_path
($signout_page) . ";\n";
4514 print CF
"\$frame_top = '$frame_top';\n";
4517 print CF
"\$provider_uri = '$provider_uri';\n";
4520 print CF
"\$provider_name = '$provider_name';\n";
4523 # string that can contain variables
4524 print CF
"\$motd = \"$motd\";\n";
4528 print CF
"\$squirrelmail_default_language = '$squirrelmail_default_language';\n";
4530 print CF
"\$default_charset = '$default_charset';\n";
4532 print CF
"\$show_alternative_names = $show_alternative_names;\n";
4534 print CF
"\$aggressive_decoding = $aggressive_decoding;\n";
4536 print CF
"\$lossy_encoding = $lossy_encoding;\n";
4540 print CF
"\$domain = '$domain';\n";
4542 print CF
"\$imapServerAddress = '$imapServerAddress';\n";
4544 print CF
"\$imapPort = $imapPort;\n";
4546 print CF
"\$useSendmail = $useSendmail;\n";
4548 print CF
"\$smtpServerAddress = '$smtpServerAddress';\n";
4550 print CF
"\$smtpPort = $smtpPort;\n";
4552 print CF
"\$sendmail_path = '$sendmail_path';\n";
4554 print CF
"\$sendmail_args = '$sendmail_args';\n";
4556 # print CF "\$use_authenticated_smtp = $use_authenticated_smtp;\n";
4558 print CF
"\$pop_before_smtp = $pop_before_smtp;\n";
4560 print CF
"\$imap_server_type = '$imap_server_type';\n";
4562 print CF
"\$invert_time = $invert_time;\n";
4564 print CF
"\$optional_delimiter = '$optional_delimiter';\n";
4566 print CF
"\$encode_header_key = '$encode_header_key';\n";
4570 print CF
"\$default_folder_prefix = '$default_folder_prefix';\n";
4572 print CF
"\$trash_folder = '$trash_folder';\n";
4574 print CF
"\$sent_folder = '$sent_folder';\n";
4576 print CF
"\$draft_folder = '$draft_folder';\n";
4578 print CF
"\$default_move_to_trash = $default_move_to_trash;\n";
4580 print CF
"\$default_move_to_sent = $default_move_to_sent;\n";
4582 print CF
"\$default_save_as_draft = $default_save_as_draft;\n";
4584 print CF
"\$show_prefix_option = $show_prefix_option;\n";
4586 print CF
"\$list_special_folders_first = $list_special_folders_first;\n";
4588 print CF
"\$use_special_folder_color = $use_special_folder_color;\n";
4590 print CF
"\$auto_expunge = $auto_expunge;\n";
4592 print CF
"\$default_sub_of_inbox = $default_sub_of_inbox;\n";
4594 print CF
"\$show_contain_subfolders_option = $show_contain_subfolders_option;\n";
4596 print CF
"\$default_unseen_notify = $default_unseen_notify;\n";
4598 print CF
"\$default_unseen_type = $default_unseen_type;\n";
4600 print CF
"\$auto_create_special = $auto_create_special;\n";
4602 print CF
"\$delete_folder = $delete_folder;\n";
4604 print CF
"\$noselect_fix_enable = $noselect_fix_enable;\n";
4609 print CF
"\$data_dir = " . &change_to_SM_path
($data_dir) . ";\n";
4610 # string that can contain a variable
4611 print CF
"\$attachment_dir = " . &change_to_SM_path
($attachment_dir) . ";\n";
4613 print CF
"\$dir_hash_level = $dir_hash_level;\n";
4615 print CF
"\$default_left_size = '$default_left_size';\n";
4617 print CF
"\$force_username_lowercase = $force_username_lowercase;\n";
4619 print CF
"\$default_use_priority = $default_use_priority;\n";
4621 print CF
"\$hide_sm_attributions = $hide_sm_attributions;\n";
4623 print CF
"\$default_use_mdn = $default_use_mdn;\n";
4625 print CF
"\$edit_identity = $edit_identity;\n";
4627 print CF
"\$edit_name = $edit_name;\n";
4629 print CF
"\$hide_auth_header = $hide_auth_header;\n";
4631 print CF
"\$disable_thread_sort = $disable_thread_sort;\n";
4633 print CF
"\$disable_server_sort = $disable_server_sort;\n";
4635 print CF
"\$allow_charset_search = $allow_charset_search;\n";
4637 print CF
"\$allow_advanced_search = $allow_advanced_search;\n";
4640 print CF
"\$time_zone_type = $time_zone_type;\n";
4643 print CF
"\$config_location_base = '$config_location_base';\n";
4646 print CF
"\$disable_plugins = $disable_plugins;\n";
4648 print CF
"\$disable_plugins_user = '$disable_plugins_user';\n";
4651 # all plugins are strings
4652 for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
4653 print CF
"\$plugins[] = '$plugins[$ct]';\n";
4658 if ( $user_theme_default eq '' ) { $user_theme_default = '0'; }
4659 print CF
"\$user_theme_default = $user_theme_default;\n";
4661 for ( $count = 0 ; $count <= $#user_theme_name ; $count++ ) {
4662 if ($user_theme_path[$count] eq 'none') {
4665 $path = &change_to_SM_path
($user_theme_path[$count]);
4667 print CF
"\$user_themes[$count]['PATH'] = " . $path . ";\n";
4668 # escape theme name so it can contain single quotes.
4669 $esc_name = $user_theme_name[$count];
4670 $esc_name =~ s/\\/\\\\/g;
4671 $esc_name =~ s/'/\\'/g;
4672 print CF
"\$user_themes[$count]['NAME'] = '$esc_name';\n";
4676 if ( $icon_theme_def eq '' ) { $icon_theme_def = '0'; }
4677 print CF
"\$icon_theme_def = $icon_theme_def;\n";
4678 if ( $icon_theme_fallback eq '' ) { $icon_theme_fallback = '0'; }
4679 print CF
"\$icon_theme_fallback = $icon_theme_fallback;\n";
4681 for ( $count = 0 ; $count <= $#icon_theme_name ; $count++ ) {
4682 $path = $icon_theme_path[$count];
4683 if ($path eq 'none' || $path eq 'template') {
4684 $path = "'".$path."'";
4686 $path = &change_to_SM_path
($icon_theme_path[$count]);
4688 print CF
"\$icon_themes[$count]['PATH'] = " . $path . ";\n";
4689 # escape theme name so it can contain single quotes.
4690 $esc_name = $icon_theme_name[$count];
4691 $esc_name =~ s/\\/\\\\/g;
4692 $esc_name =~ s/'/\\'/g;
4693 print CF
"\$icon_themes[$count]['NAME'] = '$esc_name';\n";
4697 if ( $templateset_default eq '' ) { $templateset_default = 'default'; }
4698 print CF
"\$templateset_default = '$templateset_default';\n";
4700 if ( $templateset_fallback eq '' ) { $templateset_fallback = 'default'; }
4701 print CF
"\$templateset_fallback = '$templateset_fallback';\n";
4703 for ( $count = 0 ; $count <= $#templateset_name ; $count++ ) {
4704 print CF
"\$aTemplateSet[$count]['ID'] = '" . $templateset_id[$count] . "';\n";
4705 # escape theme name so it can contain single quotes.
4706 $esc_name = $templateset_name[$count];
4707 $esc_name =~ s/\\/\\\\/g;
4708 $esc_name =~ s/'/\\'/g;
4709 print CF
"\$aTemplateSet[$count]['NAME'] = '$esc_name';\n";
4715 print CF
"\$default_fontsize = '$default_fontsize';\n";
4717 print CF
"\$default_fontset = '$default_fontset';\n";
4719 # assoc. array (maybe initial value should be set somewhere else)
4720 print CF
'$fontsets = array();'."\n";
4721 while (($fontset_name, $fontset_value) = each(%fontsets)) {
4722 print CF
"\$fontsets\['$fontset_name'\] = '$fontset_value';\n";
4728 print CF
"\$default_use_javascript_addr_book = $default_use_javascript_addr_book;\n";
4729 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
4730 print CF
"\$ldap_server[$count] = array(\n";
4732 print CF
" 'host' => '$ldap_host[$count]',\n";
4734 print CF
" 'base' => '$ldap_base[$count]'";
4735 if ( $ldap_name[$count] ) {
4738 print CF
" 'name' => '$ldap_name[$count]'";
4740 if ( $ldap_port[$count] ) {
4743 print CF
" 'port' => $ldap_port[$count]";
4745 if ( $ldap_charset[$count] ) {
4748 print CF
" 'charset' => '$ldap_charset[$count]'";
4750 if ( $ldap_maxrows[$count] ) {
4753 print CF
" 'maxrows' => $ldap_maxrows[$count]";
4756 if ( $ldap_filter[$count] ) {
4758 print CF
" 'filter' => '$ldap_filter[$count]'";
4760 if ( $ldap_binddn[$count] ) {
4763 print CF
" 'binddn' => '$ldap_binddn[$count]'";
4764 if ( $ldap_bindpw[$count] ) {
4767 print CF
" 'bindpw' => '$ldap_bindpw[$count]'";
4770 if ( $ldap_protocol[$count] ) {
4773 print CF
" 'protocol' => $ldap_protocol[$count]";
4775 if ( $ldap_limit_scope[$count] ) {
4778 print CF
" 'limit_scope' => $ldap_limit_scope[$count]";
4780 if ( $ldap_listing[$count] ) {
4783 print CF
" 'listing' => $ldap_listing[$count]";
4785 if ( $ldap_writeable[$count] ) {
4788 print CF
" 'writeable' => $ldap_writeable[$count]";
4790 if ( $ldap_search_tree[$count] ) {
4793 print CF
" 'search_tree' => $ldap_search_tree[$count]";
4795 if ( $ldap_listing[$count] ) {
4798 print CF
" 'starttls' => $ldap_starttls[$count]";
4806 print CF
"\$addrbook_dsn = '$addrbook_dsn';\n";
4808 print CF
"\$addrbook_table = '$addrbook_table';\n\n";
4810 print CF
"\$prefs_dsn = '$prefs_dsn';\n";
4812 print CF
"\$prefs_table = '$prefs_table';\n";
4814 print CF
"\$prefs_user_field = '$prefs_user_field';\n";
4816 print CF
"\$prefs_user_size = $prefs_user_size;\n";
4818 print CF
"\$prefs_key_field = '$prefs_key_field';\n";
4820 print CF
"\$prefs_key_size = $prefs_key_size;\n";
4822 print CF
"\$prefs_val_field = '$prefs_val_field';\n";
4824 print CF
"\$prefs_val_size = $prefs_val_size;\n\n";
4826 print CF
"\$addrbook_global_dsn = '$addrbook_global_dsn';\n";
4828 print CF
"\$addrbook_global_table = '$addrbook_global_table';\n";
4830 print CF
"\$addrbook_global_writeable = $addrbook_global_writeable;\n";
4832 print CF
"\$addrbook_global_listing = $addrbook_global_listing;\n\n";
4834 print CF
"\$abook_global_file = '$abook_global_file';\n";
4836 print CF
"\$abook_global_file_writeable = $abook_global_file_writeable;\n\n";
4838 print CF
"\$abook_global_file_listing = $abook_global_file_listing;\n\n";
4840 print CF
"\$abook_file_line_length = $abook_file_line_length;\n\n";
4842 print CF
"\$no_list_for_subscribe = $no_list_for_subscribe;\n";
4845 print CF
"\$smtp_auth_mech = '$smtp_auth_mech';\n";
4846 print CF
"\$smtp_sitewide_user = '". quote_single
($smtp_sitewide_user) ."';\n";
4847 print CF
"\$smtp_sitewide_pass = '". quote_single
($smtp_sitewide_pass) ."';\n";
4849 print CF
"\$imap_auth_mech = '$imap_auth_mech';\n";
4851 print CF
"\$use_imap_tls = $use_imap_tls;\n";
4853 print CF
"\$use_smtp_tls = $use_smtp_tls;\n";
4855 print CF
"\$session_name = '$session_name';\n";
4857 print CF
"\$only_secure_cookies = $only_secure_cookies;\n";
4862 print CF
"\$use_iframe = $use_iframe;\n";
4864 print CF
"\$ask_user_info = $ask_user_info;\n";
4866 print CF
"\$use_icons = $use_icons;\n";
4869 print CF
"\$use_php_recode = $use_php_recode;\n";
4871 print CF
"\$use_php_iconv = $use_php_iconv;\n";
4874 print CF
"\$allow_remote_configtest = $allow_remote_configtest;\n";
4875 print CF
"\$secured_config = $secured_config;\n";
4876 # (binary) integer or constant - convert integer
4877 # values to constants before output
4878 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
4879 print CF
"\$sm_debug_mode = $sm_debug_mode;\n";
4884 print "Data saved in config.php\n";
4886 build_plugin_hook_array
();
4889 print "Error saving config.php: $!\n";
4895 print $WHT. "SquirrelMail Configuration : " . $NRM;
4896 if ( $config == 1 ) { print "Read: config.php"; }
4897 elsif ( $config == 2 ) { print "Read: config_default.php"; }
4899 print "---------------------------------------------------------\n";
4901 print "While we have been building SquirrelMail, we have discovered some\n";
4902 print "preferences that work better with some servers that don't work so\n";
4903 print "well with others. If you select your IMAP server, this option will\n";
4904 print "set some pre-defined settings for that server.\n";
4906 print "Please note that you will still need to go through and make sure\n";
4907 print "everything is correct. This does not change everything. There are\n";
4908 print "only a few settings that this will change.\n";
4912 while ( $continue != 1 ) {
4913 print "Please select your IMAP server:\n";
4914 print $list_supported_imap_servers;
4916 print " quit = Do not change anything\n";
4918 print "Command >> ";
4920 $server =~ s/[\r\n]//g;
4922 # variable is used to display additional messages.
4926 if ( $server eq "cyrus" ) {
4927 $imap_server_type = "cyrus";
4928 $default_folder_prefix = "";
4929 $trash_folder = "INBOX.Trash";
4930 $sent_folder = "INBOX.Sent";
4931 $draft_folder = "INBOX.Drafts";
4932 $show_prefix_option = false
;
4933 $default_sub_of_inbox = true
;
4934 $show_contain_subfolders_option = false
;
4935 $optional_delimiter = ".";
4936 $disp_default_folder_prefix = "<none>";
4937 $force_username_lowercase = false
;
4939 # Delimiter might differ if unixhierarchysep is set to yes.
4940 $message = "\nIf you have enabled unixhierarchysep, you must change delimiter and special folder names.\n";
4943 } elsif ( $server eq "uw" ) {
4944 $imap_server_type = "uw";
4945 $default_folder_prefix = "mail/";
4946 $trash_folder = "Trash";
4947 $sent_folder = "Sent";
4948 $draft_folder = "Drafts";
4949 $show_prefix_option = true
;
4950 $default_sub_of_inbox = false
;
4951 $show_contain_subfolders_option = true
;
4952 $optional_delimiter = "/";
4953 $disp_default_folder_prefix = $default_folder_prefix;
4954 $delete_folder = true
;
4955 $force_username_lowercase = true
;
4958 } elsif ( $server eq "exchange" ) {
4959 $imap_server_type = "exchange";
4960 $default_folder_prefix = "";
4961 $default_sub_of_inbox = true
;
4962 $trash_folder = "INBOX/Deleted Items";
4963 $sent_folder = "INBOX/Sent Items";
4964 $drafts_folder = "INBOX/Drafts";
4965 $show_prefix_option = false
;
4966 $show_contain_subfolders_option = false
;
4967 $optional_delimiter = "detect";
4968 $disp_default_folder_prefix = "<none>";
4969 $force_username_lowercase = true
;
4972 } elsif ( $server eq "courier" ) {
4973 $imap_server_type = "courier";
4974 $default_folder_prefix = "INBOX.";
4975 $trash_folder = "Trash";
4976 $sent_folder = "Sent";
4977 $draft_folder = "Drafts";
4978 $show_prefix_option = false
;
4979 $default_sub_of_inbox = false
;
4980 $show_contain_subfolders_option = false
;
4981 $optional_delimiter = ".";
4982 $disp_default_folder_prefix = $default_folder_prefix;
4983 $delete_folder = true
;
4984 $force_username_lowercase = false
;
4987 } elsif ( $server eq "macosx" ) {
4988 $imap_server_type = "macosx";
4989 $default_folder_prefix = "INBOX/";
4990 $trash_folder = "Trash";
4991 $sent_folder = "Sent";
4992 $draft_folder = "Drafts";
4993 $show_prefix_option = false
;
4994 $default_sub_of_inbox = true
;
4995 $show_contain_subfolders_option = false
;
4996 $optional_delimiter = "detect";
4997 $allow_charset_search = false
;
4998 $disp_default_folder_prefix = $default_folder_prefix;
5001 } elsif ( $server eq "hmailserver" ) {
5002 $imap_server_type = "hmailserver";
5003 $default_folder_prefix = "";
5004 $trash_folder = "INBOX.Trash";
5005 $sent_folder = "INBOX.Sent";
5006 $draft_folder = "INBOX.Drafts";
5007 $show_prefix_option = false
;
5008 $default_sub_of_inbox = true
;
5009 $show_contain_subfolders_option = false
;
5010 $optional_delimiter = "detect";
5011 $allow_charset_search = false
;
5012 $disp_default_folder_prefix = $default_folder_prefix;
5013 $delete_folder = false
;
5014 $force_username_lowercase = false
;
5017 } elsif ( $server eq "mercury32" ) {
5018 $imap_server_type = "mercury32";
5019 $default_folder_prefix = "";
5020 $trash_folder = "Trash";
5021 $sent_folder = "Sent";
5022 $draft_folder = "Drafts";
5023 $show_prefix_option = false
;
5024 $default_sub_of_inbox = true
;
5025 $show_contain_subfolders_option = true
;
5026 $optional_delimiter = "detect";
5027 $delete_folder = true
;
5028 $force_username_lowercase = true
;
5031 } elsif ( $server eq "dovecot" ) {
5032 $imap_server_type = "dovecot";
5033 $default_folder_prefix = "";
5034 $trash_folder = "Trash";
5035 $sent_folder = "Sent";
5036 $draft_folder = "Drafts";
5037 $show_prefix_option = false
;
5038 $default_sub_of_inbox = false
;
5039 $show_contain_subfolders_option = false
;
5040 $delete_folder = false
;
5041 $force_username_lowercase = true
;
5042 $optional_delimiter = "detect";
5043 $disp_default_folder_prefix = "<none>";
5046 } elsif ( $server eq "bincimap" ) {
5047 $imap_server_type = "bincimap";
5048 $default_folder_prefix = "INBOX/";
5049 $trash_folder = "Trash";
5050 $sent_folder = "Sent";
5051 $draft_folder = "Drafts";
5052 $show_prefix_option = false
;
5053 $default_sub_of_inbox = false
;
5054 $show_contain_subfolders_option = false
;
5055 $delete_folder = true
;
5056 $force_username_lowercase = false
;
5057 $optional_delimiter = "detect";
5058 $disp_default_folder_prefix = $default_folder_prefix;
5060 # Default folder prefix depends on used depot.
5061 $message = "\nIf you use IMAPdir depot, you must set default folder prefix to empty string.\n";
5064 } elsif ( $server eq "quit" ) {
5067 $disp_default_folder_prefix = $default_folder_prefix;
5068 print "Unrecognized server: $server\n";
5072 print " imap_server_type = $imap_server_type\n";
5073 print " default_folder_prefix = $disp_default_folder_prefix\n";
5074 print " trash_folder = $trash_folder\n";
5075 print " sent_folder = $sent_folder\n";
5076 print " draft_folder = $draft_folder\n";
5077 print " show_prefix_option = $show_prefix_option\n";
5078 print " default_sub_of_inbox = $default_sub_of_inbox\n";
5079 print "show_contain_subfolders_option = $show_contain_subfolders_option\n";
5080 print " optional_delimiter = $optional_delimiter\n";
5081 print " delete_folder = $delete_folder\n";
5082 print " force_username_lowercase = $force_username_lowercase\n";
5086 print "\nPress enter to continue...";
5090 # This subroutine corrects relative paths to ensure they
5091 # will work within the SM space. If the path falls within
5092 # the SM directory tree, the SM_PATH variable will be
5093 # prepended to the path, if not, then the path will be
5094 # converted to an absolute path, e.g.
5095 # '../images/logo.gif' --> SM_PATH . 'images/logo.gif'
5096 # '../../someplace/data' --> '/absolute/path/someplace/data'
5097 # 'images/logo.gif' --> SM_PATH . 'config/images/logo.gif'
5098 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
5099 # 'http://whatever/' --> 'http://whatever'
5100 # $some_var/path --> "$some_var/path"
5101 sub change_to_SM_path
() {
5102 my ($old_path) = @_;
5108 # If the path is absolute, don't bother.
5109 return "\'" . $old_path . "\'" if ( $old_path eq '');
5110 return "\'" . $old_path . "\'" if ( $old_path =~ /^(\/|http
)/ );
5111 return "\'" . $old_path . "\'" if ( $old_path =~ /^\w:\// );
5112 return $old_path if ( $old_path =~ /^\'(\/|http
)/ );
5113 return $old_path if ( $old_path =~ /^\'\w:\// );
5114 return $old_path if ( $old_path =~ /^SM_PATH/);
5116 if ( $old_path =~ /^\$/ ) {
5117 # check if it's a single var, or a $var/path combination
5118 # if it's $var/path, enclose in ""
5119 if ( $old_path =~ /\// ) {
5120 return '"'.$old_path.'"';
5125 # Remove remaining '
5126 $old_path =~ s/\'//g;
5128 # For relative paths, split on '../'
5129 @rel_path = split(/\.\.\//, $old_path);
5131 if ( $#rel_path > 1 ) {
5132 # more than two levels away. Make it absolute.
5133 @abs_path = split(/\//, $dir);
5135 # Lop off the relative pieces of the absolute path..
5136 for ( $i = 0; $i <= $#rel_path; $i++ ) {
5140 push @abs_path, @rel_path;
5141 $new_path = "\'" . join('/', @abs_path) . "\'";
5142 } elsif ( $#rel_path > 0 ) {
5143 # it's within the SM tree, prepend SM_PATH
5144 $new_path = $old_path;
5145 $new_path =~ s/^\.\.\//SM_PATH
. \'/;
5148 # Last, it's a relative path without any leading '.'
5149 # Prepend SM_PATH and config, since the paths are
5150 # relative to the config directory
5151 $new_path = "SM_PATH . \'config/" . $old_path . "\'";
5157 # Change SM_PATH to admin-friendly version, e.g.:
5158 # SM_PATH . 'images/logo.gif' --> '../images/logo.gif'
5159 # SM_PATH . 'config/some.php' --> 'some.php'
5160 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
5161 # 'http://whatever/' --> 'http://whatever'
5162 sub change_to_rel_path
() {
5163 my ($old_path) = @_;
5164 my $new_path = $old_path;
5166 if ( $old_path =~ /^SM_PATH/ ) {
5167 # FIXME: the following replacement loses the opening quote mark!
5168 $new_path =~ s/^SM_PATH . \'/\.\.\//;
5169 $new_path =~ s/\.\.\/config\///;
5175 # Attempts to auto-detect if a specific auth mechanism is supported.
5176 # Called by 'command112a' and 'command112b'
5177 # ARGS: service-name (IMAP or SMTP), host:port, mech-name (ie. CRAM-MD5)
5178 sub detect_auth_support
{
5179 # Try loading IO::Socket
5180 unless (eval("use IO::Socket; 1")) {
5181 print "Perl IO::Socket module is not available.";
5185 my $service = shift;
5189 if ((!defined($service)) or (!defined($host)) or (!defined($mech))) {
5190 # Error - wrong # of args
5191 print "BAD ARGS!\n";
5195 if ($service eq 'SMTP') {
5196 $cmd = "AUTH $mech\r\n";
5197 $logout = "QUIT\r\n";
5198 } elsif ($service eq 'IMAP') {
5199 $cmd = "A01 AUTHENTICATE $mech\n";
5200 $logout = "C01 LOGOUT\n";
5202 # unknown service - whoops.
5206 # Get this show on the road
5207 my $sock=IO
::Socket
::INET
->new($host);
5208 if (!defined($sock)) {
5212 my $discard = <$sock>; # Server greeting/banner - who cares..
5214 if ($service eq 'SMTP') {
5216 print $sock "HELO $domain\r\n";
5217 $discard = <$sock>; # Yeah yeah, you're happy to see me..
5221 my $response = <$sock>;
5223 if (!defined($response)) {
5227 # So at this point, we have a response, and it is (hopefully) valid.
5228 if ($service eq 'SMTP') {
5229 if (!($response =~ /^334/)) {
5231 print $sock $logout;
5235 } elsif ($service eq 'IMAP') {
5236 if ($response =~ /^A01/) {
5238 print $sock $logout;
5243 # Unknown service - this shouldn't be able to happen.
5248 # If it gets here, the mech is supported
5249 print $sock "*\n"; # Attempt to cancel authentication
5250 print $sock $logout; # Try to log out, but we don't really care if this fails
5256 # Example code from O'Reilly Perl Cookbook
5263 return wantarray ?
@out : $out[0];
5266 sub clear_screen
() {
5267 if ( $^O
=~ /^mswin/i) {
5274 # checks IMAP mailbox name. Refuses to accept 8bit folders
5275 # returns 0 (folder name is not correct) or 1 (folder name is correct)
5276 sub check_imap_folder
($) {
5277 my $folder_name = shift(@_);
5279 if ($folder_name =~ /[\x80-\xFFFF]/) {
5280 print "Folder name contains 8bit characters. Configuration utility requires\n";
5281 print "UTF7-IMAP encoded folder names.\n";
5282 print "Press enter to continue...";
5285 } elsif ($folder_name =~ /[&\*\%]/) {
5286 # check for ampersand and list-wildcards
5287 print "Folder name contains special UTF7-IMAP characters.\n";
5288 print "Are you sure that folder name is correct? (y/N): ";
5290 $tmp = lc(trim
($tmp));
5291 if ($tmp =~ /^y$/) {
5301 # quotes string written in single quotes
5302 sub quote_single
($) {
5303 my $string = shift(@_);
5304 $string =~ s/\'/\\'/g;
5308 # determine a plugin's version number
5310 # parses the setup.php file, looking for the
5311 # version string in the <plugin>_info() or the
5312 # <plugin>_version functions.
5314 sub get_plugin_version
() {
5316 my $plugin_name = shift(@_);
5318 $setup_file = '../plugins/' . $plugin_name . '/setup.php';
5319 if ( -e
"$setup_file" ) {
5320 # Make sure that file is readable
5321 if (! -r
"$setup_file") {
5324 print "The file \"$setup_file\" was found, but you don't\n";
5325 print "have rights to read it. The plugin \"";
5326 print $plugin_name . "\" may not work correctly until you fix this.\n";
5327 print "\nPress enter to continue";
5334 # FIXME: grep the file instead of reading it into memory?
5336 open( FILE
, "$setup_file" );
5337 while ( $line = <FILE
> ) {
5338 $whole_file .= $line;
5342 # ideally, there is a version in the <plugin>_info function...
5344 if ($whole_file =~ /('version'\s*=>\s*['"](.*?)['"])/) {
5347 # this assumes there is only one function that returns
5348 # a static string in the setup file
5350 } elsif ($whole_file =~ /(return\s*['"](.*?)['"])/) {
5359 print "The file \"$setup_file\" was not found.\n";
5360 print "The plugin \"" . $plugin_name;
5361 print "\" may not work correctly until you fix this.\n";
5362 print "\nPress enter to continue";
5370 # determine a plugin's English name
5372 # parses the setup.php file, looking for the
5373 # English name in the <plugin>_info() function.
5375 sub get_plugin_english_name
() {
5377 my $plugin_name = shift(@_);
5379 $setup_file = '../plugins/' . $plugin_name . '/setup.php';
5380 if ( -e
"$setup_file" ) {
5381 # Make sure that file is readable
5382 if (! -r
"$setup_file") {
5385 print "The file \"$setup_file\" was found, but you don't\n";
5386 print "have rights to read it. The plugin \"";
5387 print $plugin_name . "\" may not work correctly until you fix this.\n";
5388 print "\nPress enter to continue";
5395 # FIXME: grep the file instead of reading it into memory?
5397 open( FILE
, "$setup_file" );
5398 while ( $line = <FILE
> ) {
5399 $whole_file .= $line;
5403 # the English name is in the <plugin>_info function or nothing...
5405 if ($whole_file =~ /('english_name'\s*=>\s*['"](.*?)['"])/) {
5406 $english_name .= $2;
5409 return $english_name;
5414 print "The file \"$setup_file\" was not found.\n";
5415 print "The plugin \"" . $plugin_name;
5416 print "\" may not work correctly until you fix this.\n";
5417 print "\nPress enter to continue";
5425 # parses the setup.php files for all activated plugins and
5426 # builds static plugin hooks array so we don't have to load
5427 # ALL plugins are runtime and build the hook array on every
5430 # hook array is saved in config/plugin_hooks.php
5432 # Note the $verbose variable at the top of this routine
5433 # can be set to zero to quiet it down.
5435 # NOTE/FIXME: we aren't necessarily interested in writing
5436 # a full-blown PHP parsing engine, so plenty
5437 # of assumptions are included herein about the
5438 # coding of the plugin setup files, and things
5439 # like commented out curly braces or other
5440 # such oddities can break this in a bad way.
5442 sub build_plugin_hook_array
() {
5450 if ( open( HOOKFILE
, ">plugin_hooks.php" ) ) {
5451 print HOOKFILE
"<?php\n";
5452 print HOOKFILE
"\n";
5454 print HOOKFILE
"/**\n";
5455 print HOOKFILE
" * SquirrelMail Plugin Hook Registration File\n";
5456 print HOOKFILE
" * Auto-generated using the configure script, conf.pl\n";
5457 print HOOKFILE
" */\n";
5458 print HOOKFILE
"\n";
5459 print HOOKFILE
"global \$squirrelmail_plugin_hooks;\n";
5460 print HOOKFILE
"\n";
5462 PLUGIN
: for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
5465 print "Activating plugin \"" . $plugins[$ct] . "\"...\n";
5468 $setup_file = '../plugins/' . $plugins[$ct] . '/setup.php';
5469 if ( -e
"$setup_file" ) {
5470 # Make sure that file is readable
5471 if (! -r
"$setup_file") {
5474 print "The file \"$setup_file\" was found, but you don't\n";
5475 print "have rights to read it. The plugin \"";
5476 print $plugins[$ct] . "\" will not be activated until you fix this.\n";
5477 print "\nPress enter to continue";
5482 open( FILE
, "$setup_file" );
5483 $inside_init_fxn = 0;
5485 while ( $line = <FILE
> ) {
5487 # throw away lines until we get to target function
5489 if (!$inside_init_fxn
5490 && $line !~ /^\s*function\s*squirrelmail_plugin_init_/i) {
5493 $inside_init_fxn = 1;
5503 # count close braces
5508 # leaving <plugin>_init() function...
5509 if ($brace_count == 0) {
5517 # throw away lines that are not exactly one "brace set" deep
5519 if ($brace_count > 1) {
5524 # also not interested in lines that are not
5525 # hook registration points
5527 if ($line !~ /^\s*\$squirrelmail_plugin_hooks/i) {
5532 # if $line does not have an ending semicolon,
5533 # we need to recursively read in subsequent
5534 # lines until we find one
5535 while ( $line !~ /;\s*$/ ) {
5536 $line =~ s/[\n\r]\s*$//;
5545 $var =~ s/=/EQUALS/;
5546 if ( $var =~ /^([a-z])/i ) {
5547 @options = split ( /\s*EQUALS\s*/, $var );
5548 $options[1] =~ s/[\n\r]//g;
5549 $options[1] =~ s/[\'\"];\s*$//;
5550 $options[1] =~ s/;$//;
5551 $options[1] =~ s/^[\'\"]//;
5552 # de-escape escaped strings
5553 $options[1] =~ s/\\'/'/g;
5554 $options[1] =~ s/\\\\/\\/g;
5556 if ( $options[0] =~ /^squirrelmail_plugin_hooks\s*\[\s*['"]([a-z0-9 \/._
*-]+)['"]\s*\]\s*\[\s*['"]([0-9a-z._-]+)['"]\s
*\
]/i
) {
5558 $hooked_plugin_name = $2;
5559 # Note: if we wanted to stop plugins from registering
5560 # a *different* plugin on a hook, we could catch
5561 # it here, however this has actually proven to be
5562 # a useful *feature*
5563 #if ($hooked_plugin_name ne $plugins[$ct]) {
5564 # print "...plugin is tring to hook in under different name...\n";
5567 #FIXME: do we want to count the number of hook registrations for each plugin and warn if a plugin doesn't have any?
5568 # hook registration has been found!
5570 if ($hooked_plugin_name ne $plugins[$ct]) {
5571 print " registering on hook \"" . $hook_name . "\" (as \"$hooked_plugin_name\" plugin)\n";
5573 print " registering on hook \"" . $hook_name . "\"\n";
5576 $line =~ s/ {2,}/ /g;
5578 print HOOKFILE
"\$$line";
5590 print "The file \"$setup_file\" was not found.\n";
5591 print "The plugin \"" . $plugins[$ct];
5592 print "\" will not be activated until you fix this.\n";
5593 print "\nPress enter to continue";
5601 print HOOKFILE
"\n\n";
5604 print "\nDone activating plugins; registration data saved in plugin_hooks.php\n\n";
5611 print "The file \"plugin_hooks.php\" was not able to be written to.\n";
5612 print "No plugins will be activated until you fix this.\n";
5613 print "\nPress enter to continue";
5621 # converts (binary) integer values that correspond
5622 # to the SquirrelMail debug mode constants (see
5623 # include/constants.php) into those constant strings
5624 # (bitwise or'd if more than one is enabled)
5626 # if the value passed in is not an integer, it is
5627 # returned unmolested
5629 sub convert_debug_binary_integer_to_constants
() {
5631 my ($debug_mode) = @_;
5632 if ($debug_mode =~ /^[^0-9]/) {
5635 $debug_mode = int($debug_mode);
5636 $new_debug_mode = '';
5638 # per include/constants.php, here are their values:
5640 # 0 SM_DEBUG_MODE_OFF
5641 # 1 SM_DEBUG_MODE_SIMPLE
5642 # 512 SM_DEBUG_MODE_MODERATE
5643 # 524288 SM_DEBUG_MODE_ADVANCED
5644 # 536870912 SM_DEBUG_MODE_STRICT
5646 if ($debug_mode & 1) {
5647 $new_debug_mode .= ' | SM_DEBUG_MODE_SIMPLE';
5649 if ($debug_mode & 512) {
5650 $new_debug_mode .= ' | SM_DEBUG_MODE_MODERATE';
5652 if ($debug_mode & 524288) {
5653 $new_debug_mode .= ' | SM_DEBUG_MODE_ADVANCED';
5655 if ($debug_mode & 536870912) {
5656 $new_debug_mode .= ' | SM_DEBUG_MODE_STRICT';
5659 $new_debug_mode =~ s/^ \| //;
5660 if (!$new_debug_mode) {
5661 $new_debug_mode = 'SM_DEBUG_MODE_OFF';
5664 return $new_debug_mode;
5667 # converts SquirrelMail debug mode constants (see
5668 # include/constants.php) into their corresponding
5669 # (binary) integer values
5671 # if the value passed in is an integer already, it
5672 # is returned unmolested
5674 sub convert_debug_constants_to_binary_integer
() {
5676 my ($debug_mode) = @_;
5677 if ($debug_mode =~ /^[0-9]/) {
5680 $new_debug_mode = 0;
5682 # per include/constants.php, here are their values:
5684 # 0 SM_DEBUG_MODE_OFF
5685 # 1 SM_DEBUG_MODE_SIMPLE
5686 # 512 SM_DEBUG_MODE_MODERATE
5687 # 524288 SM_DEBUG_MODE_ADVANCED
5688 # 536870912 SM_DEBUG_MODE_STRICT
5690 if ($debug_mode =~ /\bSM_DEBUG_MODE_OFF\b/) {
5691 $new_debug_mode = 0;
5693 if ($debug_mode =~ /\bSM_DEBUG_MODE_SIMPLE\b/) {
5694 $new_debug_mode |= 1;
5696 if ($debug_mode =~ /\bSM_DEBUG_MODE_MODERATE\b/) {
5697 $new_debug_mode |= 512;
5699 if ($debug_mode =~ /\bSM_DEBUG_MODE_ADVANCED\b/) {
5700 $new_debug_mode |= 524288;
5702 if ($debug_mode =~ /\bSM_DEBUG_MODE_STRICT\b/) {
5703 $new_debug_mode |= 536870912;
5706 return $new_debug_mode;
5709 # Function to print n column numbered lists
5711 # WARNING: the names in the list will be truncated
5712 # to fit in their respective columns based on the
5713 # screen width and number of columns.
5715 # Expected arguments (in this order):
5717 # * The start number to use for the list
5718 # * The number of columns to use
5719 # * The screen width
5720 # * Boolean (zero/one), indicating
5721 # whether or not to show item numbers
5722 # * The list of strings to be shown
5724 # Returns: The number printed on screen of the last item in the list
5726 sub print_multi_col_list
{
5727 my ($num, $cols, $screen_width, $show_numbering, @list) = @_;
5737 $rows = int(@list / $cols);
5738 if (@list % $cols) { $rows++; }
5739 if ($show_numbering) { $col_width = int(($screen_width - 2) / $cols) - 5; }
5740 else { $col_width = int(($screen_width - 2) / $cols) - 2; }
5742 # build the layout array so numbers run down each column
5744 for ( $x = 0; $x < @list; $x++ ) {
5746 $layout[$row_cnt][$col_cnt] = $list[$x];
5747 $numbers[$row_cnt][$col_cnt] = $num++;
5749 # move to next column
5751 if ($row_cnt == $rows - 1) {
5755 else { $row_cnt++; }
5759 # if we filled up fewer rows than needed, recalc column width
5761 if ($rows * $col_cnt == @list) { $col_cnt--; } # loop above ended right after increment
5762 if ($col_cnt + 1 < $cols) {
5763 if ($show_numbering) { $col_width = int(($screen_width - 2) / ($col_cnt + 1)) - 5; }
5764 else { $col_width = int(($screen_width - 2) / ($col_cnt + 1)) - 2; }
5770 for ( $row_cnt = 0; $row_cnt <= $rows; $row_cnt++ ) {
5776 # iterate columns for this row
5778 for ( $col_cnt = 0; $col_cnt <= $cols; $col_cnt++ ) {
5779 if ($layout[$row_cnt][$col_cnt]) {
5781 if ($show_numbering) { printf "$WHT% 2u.$NRM", $numbers[$row_cnt][$col_cnt]; }
5782 printf " %-$col_width." . $col_width . "s", $layout[$row_cnt][$col_cnt];