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
550 # try to get screen width dynamically if possible; default to 80
551 # (user can override with "w#" command)
553 eval { require "sys/ioctl.ph" };
555 || !defined &TIOCGWINSZ
556 || !open(TTY
, "+</dev/tty")
557 || !ioctl(TTY
, &TIOCGWINSZ
, $winsize='')) {
560 ($row, $col, $xpixel, $ypixel) = unpack('S4', $winsize);
561 $screen_width = $col;
564 while ( ( $command ne "q" ) && ( $command ne "Q" ) && ( $command ne ":q" ) ) {
566 print $WHT. "SquirrelMail Configuration : " . $NRM;
567 if ( $config == 1 ) { print "Read: config.php"; }
568 elsif ( $config == 2 ) { print "Read: config_default.php"; }
569 print " ($print_config_version)\n";
570 print "---------------------------------------------------------\n";
573 print $WHT. "Main Menu --\n" . $NRM;
574 print "1. Organization Preferences\n";
575 print "2. Server Settings\n";
576 print "3. Folder Defaults\n";
577 print "4. General Options\n";
578 print "5. User Interface\n";
579 print "6. Address Books\n";
580 print "7. Message of the Day (MOTD)\n";
581 print "8. Plugins\n";
582 print "9. Database\n";
583 print "10. Language settings\n";
584 print "11. Tweaks\n";
586 print "D. Set pre-defined settings for specific IMAP servers\n";
588 } elsif ( $menu == 1 ) {
589 print $WHT. "Organization Preferences\n" . $NRM;
590 print "1. Organization Name : $WHT$org_name$NRM\n";
591 print "2. Organization Logo : $WHT$org_logo$NRM\n";
592 print "3. Org. Logo Width/Height : $WHT($org_logo_width/$org_logo_height)$NRM\n";
593 print "4. Organization Title : $WHT$org_title$NRM\n";
594 print "5. Signout Page : $WHT$signout_page$NRM\n";
595 print "6. Top Frame : $WHT$frame_top$NRM\n";
596 print "7. Provider link : $WHT$provider_uri$NRM\n";
597 print "8. Provider link text : $WHT$provider_name$NRM\n";
600 print "R Return to Main Menu\n";
601 } elsif ( $menu == 2 ) {
602 print $WHT. "Server Settings\n\n" . $NRM;
603 print $WHT . "General" . $NRM . "\n";
605 print "1. Domain : $WHT$domain$NRM\n";
606 print "2. Invert Time : $WHT$invert_time$NRM\n";
607 print "3. Sendmail or SMTP : $WHT";
608 if ( lc($useSendmail) eq 'true' ) {
616 if ( $show_imap_settings ) {
617 print $WHT . "IMAP Settings". $NRM . "\n--------------\n";
618 print "4. IMAP Server : $WHT$imapServerAddress$NRM\n";
619 print "5. IMAP Port : $WHT$imapPort$NRM\n";
620 print "6. Authentication type : $WHT$imap_auth_mech$NRM\n";
621 print "7. Secure IMAP (TLS) : $WHT" . display_use_tls
($use_imap_tls) . "$NRM\n";
622 print "8. Server software : $WHT$imap_server_type$NRM\n";
623 print "9. Delimiter : $WHT$optional_delimiter$NRM\n";
625 } elsif ( $show_smtp_settings ) {
626 if ( lc($useSendmail) eq 'true' ) {
627 print $WHT . "Sendmail" . $NRM . "\n--------\n";
628 print "4. Sendmail Path : $WHT$sendmail_path$NRM\n";
629 print "5. Sendmail arguments : $WHT$sendmail_args$NRM\n";
630 print "6. Header encryption key : $WHT$encode_header_key$NRM\n";
633 print $WHT . "SMTP Settings" . $NRM . "\n-------------\n";
634 print "4. SMTP Server : $WHT$smtpServerAddress$NRM\n";
635 print "5. SMTP Port : $WHT$smtpPort$NRM\n";
636 print "6. POP before SMTP : $WHT$pop_before_smtp$NRM\n";
637 print "7. SMTP Authentication : $WHT$smtp_auth_mech" . display_smtp_sitewide_userpass
() ."$NRM\n";
638 print "8. Secure SMTP (TLS) : $WHT" . display_use_tls
($use_smtp_tls) . "$NRM\n";
639 print "9. Header encryption key : $WHT$encode_header_key$NRM\n";
644 if ($show_imap_settings == 0) {
645 print "A. Update IMAP Settings : ";
646 print "$WHT$imapServerAddress$NRM:";
647 print "$WHT$imapPort$NRM ";
648 print "($WHT$imap_server_type$NRM)\n";
650 if ($show_smtp_settings == 0) {
651 if ( lc($useSendmail) eq 'true' ) {
652 print "B. Change Sendmail Config : $WHT$sendmail_path$NRM\n";
654 print "B. Update SMTP Settings : ";
655 print "$WHT$smtpServerAddress$NRM:";
656 print "$WHT$smtpPort$NRM\n";
659 if ( $show_smtp_settings || $show_imap_settings )
662 ($show_imap_settings ?
"IMAP Server" :
663 (lc($useSendmail) eq 'true') ?
"Sendmail" : "SMTP") . " Settings\n";
667 print "R Return to Main Menu\n";
668 } elsif ( $menu == 3 ) {
669 print $WHT. "Folder Defaults\n" . $NRM;
670 print "1. Default Folder Prefix : $WHT$default_folder_prefix$NRM\n";
671 print "2. Show Folder Prefix Option : $WHT$show_prefix_option$NRM\n";
672 print "3. Trash Folder : $WHT$trash_folder$NRM\n";
673 print "4. Sent Folder : $WHT$sent_folder$NRM\n";
674 print "5. Drafts Folder : $WHT$draft_folder$NRM\n";
675 print "6. By default, move to trash : $WHT$default_move_to_trash$NRM\n";
676 print "7. By default, save sent messages : $WHT$default_move_to_sent$NRM\n";
677 print "8. By default, save as draft : $WHT$default_save_as_draft$NRM\n";
678 print "9. List Special Folders First : $WHT$list_special_folders_first$NRM\n";
679 print "10. Show Special Folders Color : $WHT$use_special_folder_color$NRM\n";
680 print "11. Auto Expunge : $WHT$auto_expunge$NRM\n";
681 print "12. Default Sub. of INBOX : $WHT$default_sub_of_inbox$NRM\n";
682 print "13. Show 'Contain Sub.' Option : $WHT$show_contain_subfolders_option$NRM\n";
683 print "14. Default Unseen Notify : $WHT$default_unseen_notify$NRM\n";
684 print "15. Default Unseen Type : $WHT$default_unseen_type$NRM\n";
685 print "16. Auto Create Special Folders : $WHT$auto_create_special$NRM\n";
686 print "17. Folder Delete Bypasses Trash : $WHT$delete_folder$NRM\n";
687 print "18. Enable /NoSelect folder fix : $WHT$noselect_fix_enable$NRM\n";
689 print "R Return to Main Menu\n";
690 } elsif ( $menu == 4 ) {
691 print $WHT. "General Options\n" . $NRM;
692 print "1. Data Directory : $WHT$data_dir$NRM\n";
693 print "2. Attachment Directory : $WHT$attachment_dir$NRM\n";
694 print "3. Directory Hash Level : $WHT$dir_hash_level$NRM\n";
695 print "4. Default Left Size : $WHT$default_left_size$NRM\n";
696 print "5. Usernames in Lowercase : $WHT$force_username_lowercase$NRM\n";
697 print "6. Allow use of priority : $WHT$default_use_priority$NRM\n";
698 print "7. Hide SM attributions : $WHT$hide_sm_attributions$NRM\n";
699 print "8. Allow use of receipts : $WHT$default_use_mdn$NRM\n";
700 print "9. Allow editing of identity : $WHT$edit_identity$NRM\n";
701 print " Allow editing of name : $WHT$edit_name$NRM\n";
702 print " Remove username from header : $WHT$hide_auth_header$NRM\n";
703 print "10. Disable server thread sort : $WHT$disable_thread_sort$NRM\n";
704 print "11. Disable server-side sorting : $WHT$disable_server_sort$NRM\n";
705 print "12. Allow server charset search : $WHT$allow_charset_search$NRM\n";
706 print "13. Allow advanced search : $WHT$allow_advanced_search$NRM\n";
707 print "14. PHP session name : $WHT$session_name$NRM\n";
708 print "15. Time zone configuration : $WHT$time_zone_type$NRM\n";
709 print "16. Location base : $WHT$config_location_base$NRM\n";
710 print "17. Only secure cookies if poss. : $WHT$only_secure_cookies$NRM\n";
712 print "R Return to Main Menu\n";
713 } elsif ( $menu == 5 ) {
714 print $WHT. "User Interface\n" . $NRM;
715 print "1. Use Icons? : $WHT$use_icons$NRM\n";
716 # print "3. Default Icon Set : $WHT$icon_theme_def$NRM\n";
717 print "2. Default font size : $WHT$default_fontsize$NRM\n";
718 print "3. Manage template sets (skins)\n";
719 print "4. Manage user themes\n";
720 print "5. Manage font sets\n";
721 print "6. Manage icon themes\n";
724 print "R Return to Main Menu\n";
725 } elsif ( $menu == 6 ) {
726 print $WHT. "Address Books\n" . $NRM;
727 print "1. Change LDAP Servers\n";
728 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
729 print " > $ldap_host[$count]\n";
731 print "2. Use Javascript address book search : $WHT$default_use_javascript_addr_book$NRM\n";
732 print "3. Global address book file : $WHT$abook_global_file$NRM\n";
733 print "4. Allow writing into global file address book : $WHT$abook_global_file_writeable$NRM\n";
734 print "5. Allow listing of global file address book : $WHT$abook_global_file_listing$NRM\n";
735 print "6. Allowed address book line length : $WHT$abook_file_line_length$NRM\n";
737 print "R Return to Main Menu\n";
738 } elsif ( $menu == 7 ) {
739 print $WHT. "Message of the Day (MOTD)\n" . $NRM;
742 print "1 Edit the MOTD\n";
744 print "R Return to Main Menu\n";
745 } elsif ( $menu == 8 ) {
746 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
747 print $WHT. "Plugins (WARNING: All plugins are currently disabled\n for the user \"$disable_plugins_user\"!)\n" . $NRM;
748 } elsif (lc($disable_plugins) eq 'true') {
749 print $WHT. "Plugins (WARNING: All plugins are currently disabled!)\n" . $NRM;
751 print $WHT. "Plugins\n" . $NRM;
753 print " Installed Plugins\n";
755 $num = print_multi_col_list
(1, $columns, $screen_width, 1, @plugins);
758 for ( $count = 0 ; $count <= $#plugins ; $count++ ) {
760 $english_name = get_plugin_english_name
($plugins[$count]);
761 if ( $english_name eq "" ) {
762 print " $WHT$num.$NRM $plugins[$count]" . get_plugin_version
($plugins[$count]) . "\n";
764 print " $WHT$num.$NRM $english_name ($plugins[$count])" . get_plugin_version
($plugins[$count]) . "\n";
768 print "\n Available Plugins:\n";
769 opendir( DIR
, "../plugins" );
770 @files = sort(readdir(DIR
));
772 @unused_plugins = ();
773 for ( $i = 0 ; $i <= $#files ; $i++ ) {
774 if ( -d
"../plugins/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne ".svn" ) {
776 for ( $k = 0 ; $k <= $#plugins ; $k++ ) {
777 if ( $plugins[$k] eq $files[$i] ) {
782 $unused_plugins[$pos] = $files[$i];
789 $num = print_multi_col_list
($num + 1, $columns, $screen_width, 1, @unused_plugins);
791 for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
793 $english_name = get_plugin_english_name
($unused_plugins[$i]);
794 if ( $english_name eq "" ) {
795 print " $WHT$num.$NRM $unused_plugins[$i]" . get_plugin_version
($unused_plugins[$i]) . "\n";
797 print " $WHT$num.$NRM $english_name ($unused_plugins[$i])" . get_plugin_version
($unused_plugins[$i]) . "\n";
804 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
805 print "E Enable active plugins (all plugins currently\n disabled for the user \"$disable_plugins_user\")\n";
806 } elsif (lc($disable_plugins) eq 'true') {
807 print "E Enable active plugins (all plugins currently\n disabled)\n";
809 print "D Disable all plugins\n";
811 print "U Set the user for whom plugins can be disabled\n";
812 print "R Return to Main Menu\n";
813 print "C# List plugins in <#> number of columns\n";
814 print "W# Change screen width to <#> (currently $screen_width)\n";
815 } elsif ( $menu == 9 ) {
816 print $WHT. "Database\n" . $NRM;
817 print "1. DSN for Address Book : $WHT$addrbook_dsn$NRM\n";
818 print "2. Table for Address Book : $WHT$addrbook_table$NRM\n";
820 print "3. DSN for Preferences : $WHT$prefs_dsn$NRM\n";
821 print "4. Table for Preferences : $WHT$prefs_table$NRM\n";
822 print "5. Field for username : $WHT$prefs_user_field$NRM ($prefs_user_size)\n";
823 print "6. Field for prefs key : $WHT$prefs_key_field$NRM ($prefs_key_size)\n";
824 print "7. Field for prefs value : $WHT$prefs_val_field$NRM ($prefs_val_size)\n";
826 print "8. DSN for Global Address Book : $WHT$addrbook_global_dsn$NRM\n";
827 print "9. Table for Global Address Book : $WHT$addrbook_global_table$NRM\n";
828 print "10. Allow writing into Global Address Book : $WHT$addrbook_global_writeable$NRM\n";
829 print "11. Allow listing of Global Address Book : $WHT$addrbook_global_listing$NRM\n";
831 print "R Return to Main Menu\n";
832 } elsif ( $menu == 10 ) {
833 print $WHT. "Language settings\n" . $NRM;
834 print "1. Default Language : $WHT$squirrelmail_default_language$NRM\n";
835 print "2. Default Charset : $WHT$default_charset$NRM\n";
836 print "3. Show alternative language names : $WHT$show_alternative_names$NRM\n";
837 print "4. Enable aggressive decoding : $WHT$aggressive_decoding$NRM\n";
838 print "5. Enable lossy encoding : $WHT$lossy_encoding$NRM\n";
840 print "R Return to Main Menu\n";
841 } elsif ( $menu == 11 ) {
842 print $WHT. "Interface tweaks\n" . $NRM;
843 print "1. Display html mails in iframe : $WHT$use_iframe$NRM\n";
844 print "2. Ask user info on first login : $WHT$ask_user_info$NRM\n";
846 print $WHT. "PHP tweaks\n" . $NRM;
847 print "4. Use php recode functions : $WHT$use_php_recode$NRM\n";
848 print "5. Use php iconv functions : $WHT$use_php_iconv$NRM\n";
850 print $WHT. "Configuration tweaks\n" . $NRM;
851 print "6. Allow remote configtest : $WHT$allow_remote_configtest$NRM\n";
852 print "7. Debug mode : $WHT$sm_debug_mode$NRM\n";
853 print "8. Secured configuration mode : $WHT$secured_config$NRM\n";
855 print "R Return to Main Menu\n";
857 if ( $config_use_color == 1 ) {
858 print "C Turn color off\n";
860 print "C Turn color on\n";
862 print "S Save data\n";
866 print "Command >> " . $WHT;
868 $command =~ s/[\n\r]//g;
869 $command =~ tr/A-Z/a-z/;
872 # Read the commands they entered.
873 if ( $command eq "r" ) {
875 } elsif ( $command eq "s" ) {
877 print "Press enter to continue...";
880 } elsif ( ( $command eq "q" ) && ( $saved == 0 ) ) {
881 print "You have not saved your data.\n";
882 print "Save? [" . $WHT . "Y" . $NRM . "/n]: ";
884 if ( ( $save =~ /^y/i ) || ( $save =~ /^\s*$/ ) ) {
887 } elsif ( $command eq "c" ) {
888 if ( $config_use_color == 1 ) {
889 $config_use_color = 2;
893 $config_use_color = 1;
897 } elsif ( $command =~ /^w([0-9]+)/ ) {
899 } elsif ( $command eq "d" && $menu == 0 ) {
904 if ( ( $command > 0 ) && ( $command < 12 ) ) {
907 } elsif ( $menu == 1 ) {
908 if ( $command == 1 ) { $org_name = command1
(); }
909 elsif ( $command == 2 ) { $org_logo = command2
(); }
910 elsif ( $command == 3 ) { ($org_logo_width,$org_logo_height) = command2a
(); }
911 elsif ( $command == 4 ) { $org_title = command3
(); }
912 elsif ( $command == 5 ) { $signout_page = command4
(); }
913 elsif ( $command == 6 ) { $frame_top = command6
(); }
914 elsif ( $command == 7 ) { $provider_uri = command7
(); }
915 elsif ( $command == 8 ) { $provider_name = command8
(); }
917 } elsif ( $menu == 2 ) {
918 if ( $command eq "a" ) { $show_imap_settings = 1; $show_smtp_settings = 0; }
919 elsif ( $command eq "b" ) { $show_imap_settings = 0; $show_smtp_settings = 1; }
920 elsif ( $command eq "h" ) { $show_imap_settings = 0; $show_smtp_settings = 0; }
921 elsif ( $command <= 3 ) {
922 if ( $command == 1 ) { $domain = command11
(); }
923 elsif ( $command == 2 ) { $invert_time = command110
(); }
924 elsif ( $command == 3 ) { $useSendmail = command14
(); }
925 $show_imap_settings = 0; $show_smtp_settings = 0;
926 } elsif ( $show_imap_settings ) {
927 if ( $command == 4 ) { $imapServerAddress = command12
(); }
928 elsif ( $command == 5 ) { $imapPort = command13
(); }
929 elsif ( $command == 6 ) { $imap_auth_mech = command112a
(); }
930 elsif ( $command == 7 ) { $use_imap_tls = command_use_tls
("IMAP",$use_imap_tls); }
931 elsif ( $command == 8 ) { $imap_server_type = command19
(); }
932 elsif ( $command == 9 ) { $optional_delimiter = command111
(); }
933 } elsif ( $show_smtp_settings && lc($useSendmail) eq 'true' ) {
934 if ( $command == 4 ) { $sendmail_path = command15
(); }
935 elsif ( $command == 5 ) { $sendmail_args = command_sendmail_args
(); }
936 elsif ( $command == 6 ) { $encode_header_key = command114
(); }
937 } elsif ( $show_smtp_settings ) {
938 if ( $command == 4 ) { $smtpServerAddress = command16
(); }
939 elsif ( $command == 5 ) { $smtpPort = command17
(); }
940 elsif ( $command == 6 ) { $pop_before_smtp = command18a
(); }
941 elsif ( $command == 7 ) { $smtp_auth_mech = command112b
(); }
942 elsif ( $command == 8 ) { $use_smtp_tls = command_use_tls
("SMTP",$use_smtp_tls); }
943 elsif ( $command == 9 ) { $encode_header_key = command114
(); }
945 } elsif ( $menu == 3 ) {
946 if ( $command == 1 ) { $default_folder_prefix = command21
(); }
947 elsif ( $command == 2 ) { $show_prefix_option = command22
(); }
948 elsif ( $command == 3 ) { $trash_folder = command23a
(); }
949 elsif ( $command == 4 ) { $sent_folder = command23b
(); }
950 elsif ( $command == 5 ) { $draft_folder = command23c
(); }
951 elsif ( $command == 6 ) { $default_move_to_trash = command24a
(); }
952 elsif ( $command == 7 ) { $default_move_to_sent = command24b
(); }
953 elsif ( $command == 8 ) { $default_save_as_draft = command24c
(); }
954 elsif ( $command == 9 ) { $list_special_folders_first = command27
(); }
955 elsif ( $command == 10 ) { $use_special_folder_color = command28
(); }
956 elsif ( $command == 11 ) { $auto_expunge = command29
(); }
957 elsif ( $command == 12 ) { $default_sub_of_inbox = command210
(); }
958 elsif ( $command == 13 ) { $show_contain_subfolders_option = command211
(); }
959 elsif ( $command == 14 ) { $default_unseen_notify = command212
(); }
960 elsif ( $command == 15 ) { $default_unseen_type = command213
(); }
961 elsif ( $command == 16 ) { $auto_create_special = command214
(); }
962 elsif ( $command == 17 ) { $delete_folder = command215
(); }
963 elsif ( $command == 18 ) { $noselect_fix_enable = command216
(); }
964 } elsif ( $menu == 4 ) {
965 if ( $command == 1 ) { $data_dir = command33a
(); }
966 elsif ( $command == 2 ) { $attachment_dir = command33b
(); }
967 elsif ( $command == 3 ) { $dir_hash_level = command33c
(); }
968 elsif ( $command == 4 ) { $default_left_size = command35
(); }
969 elsif ( $command == 5 ) { $force_username_lowercase = command36
(); }
970 elsif ( $command == 6 ) { $default_use_priority = command37
(); }
971 elsif ( $command == 7 ) { $hide_sm_attributions = command38
(); }
972 elsif ( $command == 8 ) { $default_use_mdn = command39
(); }
973 elsif ( $command == 9 ) { $edit_identity = command310
(); }
974 elsif ( $command == 10 ) { $disable_thread_sort = command312
(); }
975 elsif ( $command == 11 ) { $disable_server_sort = command313
(); }
976 elsif ( $command == 12 ) { $allow_charset_search = command314
(); }
977 elsif ( $command == 13 ) { $allow_advanced_search = command316
(); }
978 elsif ( $command == 14 ) { $session_name = command317
(); }
979 elsif ( $command == 15 ) { $time_zone_type = command318
(); }
980 elsif ( $command == 16 ) { $config_location_base = command_config_location_base
(); }
981 elsif ( $command == 17 ) { $only_secure_cookies = command319
(); }
982 } elsif ( $menu == 5 ) {
983 if ( $command == 1 ) { $use_icons = commandB3
(); }
984 # elsif ( $command == 3 ) { $icon_theme_def = commandB7(); }
985 elsif ( $command == 2 ) { $default_fontsize = command_default_fontsize
(); }
986 elsif ( $command == 3 ) { $templateset_default = command_templates
(); }
987 elsif ( $command == 4 ) { command_userThemes
(); }
988 elsif ( $command == 5 ) { command_fontsets
(); }
989 elsif ( $command == 6 ) { command_iconSets
(); }
990 } elsif ( $menu == 6 ) {
991 if ( $command == 1 ) { command61
(); }
992 elsif ( $command == 2 ) { command62
(); }
993 elsif ( $command == 3 ) { $abook_global_file=command63
(); }
994 elsif ( $command == 4 ) { command64
(); }
995 elsif ( $command == 5 ) { command65
(); }
996 elsif ( $command == 6 ) { command_abook_file_line_length
(); }
997 } elsif ( $menu == 7 ) {
998 if ( $command == 1 ) { $motd = command71
(); }
999 } elsif ( $menu == 8 ) {
1000 if ( $command =~ /^[0-9]+/ ) { @plugins = command81
(); }
1001 elsif ( $command eq "u" ) { $disable_plugins_user = command82
(); }
1002 elsif ( $command eq "d" ) { $disable_plugins = 'true'; }
1003 elsif ( $command eq "e" ) { $disable_plugins = 'false'; }
1004 elsif ( $command =~ /^c([0-9]+)/ ) { $columns = $1; }
1005 } elsif ( $menu == 9 ) {
1006 if ( $command == 1 ) { $addrbook_dsn = command91
(); }
1007 elsif ( $command == 2 ) { $addrbook_table = command92
(); }
1008 elsif ( $command == 3 ) { $prefs_dsn = command93
(); }
1009 elsif ( $command == 4 ) { $prefs_table = command94
(); }
1010 elsif ( $command == 5 ) { $prefs_user_field = command95
(); }
1011 elsif ( $command == 6 ) { $prefs_key_field = command96
(); }
1012 elsif ( $command == 7 ) { $prefs_val_field = command97
(); }
1013 elsif ( $command == 8 ) { $addrbook_global_dsn = command98
(); }
1014 elsif ( $command == 9 ) { $addrbook_global_table = command99
(); }
1015 elsif ( $command == 10 ) { $addrbook_global_writeable = command910
(); }
1016 elsif ( $command == 11 ) { $addrbook_global_listing = command911
(); }
1017 } elsif ( $menu == 10 ) {
1018 if ( $command == 1 ) { $squirrelmail_default_language = commandA1
(); }
1019 elsif ( $command == 2 ) { $default_charset = commandA2
(); }
1020 elsif ( $command == 3 ) { $show_alternative_names = commandA3
(); }
1021 elsif ( $command == 4 ) { $aggressive_decoding = commandA4
(); }
1022 elsif ( $command == 5 ) { $lossy_encoding = commandA5
(); }
1023 } elsif ( $menu == 11 ) {
1024 if ( $command == 1 ) { $use_iframe = commandB2
(); }
1025 elsif ( $command == 2 ) { $ask_user_info = command_ask_user_info
(); }
1026 elsif ( $command == 4 ) { $use_php_recode = commandB4
(); }
1027 elsif ( $command == 5 ) { $use_php_iconv = commandB5
(); }
1028 elsif ( $command == 6 ) { $allow_remote_configtest = commandB6
(); }
1029 elsif ( $command == 7 ) { $sm_debug_mode = commandB8
(); }
1030 elsif ( $command == 8 ) { $secured_config = commandB9
(); }
1036 print "\nExiting conf.pl.\n".
1037 "You might want to test your configuration by browsing to\n".
1038 "http://your-squirrelmail-location/src/configtest.php\n".
1039 "Happy SquirrelMailing!\n\n";
1042 ####################################################################################
1046 print "We have tried to make the name SquirrelMail as transparent as\n";
1047 print "possible. If you set up an organization name, most places where\n";
1048 print "SquirrelMail would take credit will be credited to your organization.\n";
1050 print "If your Organization Name includes a '\$', please precede it with a \\. \n";
1051 print "Other '\$' will be considered the beginning of a variable that\n";
1052 print "must be defined before the \$org_name is printed.\n";
1054 print "[$WHT$org_name$NRM]: $WHT";
1055 $new_org_name = <STDIN
>;
1056 if ( $new_org_name eq "\n" ) {
1057 $new_org_name = $org_name;
1059 $new_org_name =~ s/[\r\n]//g;
1060 $new_org_name =~ s/\"/"/g;
1062 return $new_org_name;
1067 print "Your organization's logo is an image that will be displayed at\n";
1068 print "different times throughout SquirrelMail. ";
1070 print "Please be aware of the following: \n";
1071 print " - Relative URLs are relative to the config dir\n";
1072 print " to use the default logo, use ../images/sm_logo.png\n";
1073 print " - To specify a logo defined outside the SquirrelMail source tree\n";
1074 print " use the absolute URL the webserver would use to include the file\n";
1075 print " e.g. http://example.com/images/mylogo.gif or /images/mylogo.jpg\n";
1077 print "[$WHT$org_logo$NRM]: $WHT";
1078 $new_org_logo = <STDIN
>;
1079 if ( $new_org_logo eq "\n" ) {
1080 $new_org_logo = $org_logo;
1082 $new_org_logo =~ s/[\r\n]//g;
1084 return $new_org_logo;
1089 print "Your organization's logo is an image that will be displayed at\n";
1090 print "different times throughout SquirrelMail. Width\n";
1091 print "and Height of your logo image. Use '0' to disable.\n";
1093 print "Width: [$WHT$org_logo_width$NRM]: $WHT";
1094 $new_org_logo_width = <STDIN
>;
1095 $new_org_logo_width =~ tr/0-9//cd; # only want digits!
1096 if ( $new_org_logo_width eq '' ) {
1097 $new_org_logo_width = $org_logo_width;
1099 if ( $new_org_logo_width > 0 ) {
1100 print "Height: [$WHT$org_logo_height$NRM]: $WHT";
1101 $new_org_logo_height = <STDIN
>;
1102 $new_org_logo_height =~ tr/0-9//cd; # only want digits!
1103 if( $new_org_logo_height eq '' ) {
1104 $new_org_logo_height = $org_logo_height;
1107 $new_org_logo_height = 0;
1109 return ($new_org_logo_width, $new_org_logo_height);
1114 print "A title is what is displayed at the top of the browser window in\n";
1115 print "the titlebar. Usually this will end up looking something like:\n";
1116 print "\"Netscape: $org_title\"\n";
1118 print "If your Organization Title includes a '\$', please precede it with a \\. \n";
1119 print "Other '\$' will be considered the beginning of a variable that\n";
1120 print "must be defined before the \$org_title is printed.\n";
1122 print "[$WHT$org_title$NRM]: $WHT";
1123 $new_org_title = <STDIN
>;
1124 if ( $new_org_title eq "\n" ) {
1125 $new_org_title = $org_title;
1127 $new_org_title =~ s/[\r\n]//g;
1128 $new_org_title =~ s/\"/\'/g;
1130 return $new_org_title;
1135 print "When users click the Sign Out button they will be logged out and\n";
1136 print "then sent to signout_page. If signout_page is left empty,\n";
1137 print "(hit space and then return) they will be taken, as normal,\n";
1138 print "to the default and rather sparse SquirrelMail signout page.\n";
1140 print "[$WHT$signout_page$NRM]: $WHT";
1141 $new_signout_page = <STDIN
>;
1142 if ( $new_signout_page eq "\n" ) {
1143 $new_signout_page = $signout_page;
1145 $new_signout_page =~ s/[\r\n]//g;
1146 $new_signout_page =~ s/^\s+$//g;
1148 return $new_signout_page;
1153 print "SquirrelMail defaults to using the whole of the browser window.\n";
1154 print "This allows you to keep it within a specified frame. The default\n";
1155 print "is '_top'\n";
1157 print "[$WHT$frame_top$NRM]: $WHT";
1158 $new_frame_top = <STDIN
>;
1159 if ( $new_frame_top eq "\n" ) {
1160 $new_frame_top = '_top';
1162 $new_frame_top =~ s/[\r\n]//g;
1163 $new_frame_top =~ s/^\s+$//g;
1165 return $new_frame_top;
1168 # Default link to provider
1170 print "Here you can set the link on the top-right of the message list.\n";
1171 print "If empty, it will not be displayed.\n";
1173 print "[$WHT$provider_uri$NRM]: $WHT";
1174 $new_provider_uri = <STDIN
>;
1175 if ( $new_provider_uri eq "\n" ) {
1176 $new_provider_uri = '';
1178 $new_provider_uri =~ s/[\r\n]//g;
1179 $new_provider_uri =~ s/^\s+$//g;
1181 return $new_provider_uri;
1185 print "Here you can set the name of the link on the top-right of the message list.\n";
1186 print "The default is empty (do not display anything).'\n";
1188 print "[$WHT$provider_name$NRM]: $WHT";
1189 $new_provider_name = <STDIN
>;
1190 if ( $new_provider_name eq "\n" ) {
1191 $new_provider_name = '';
1193 $new_provider_name =~ s/[\r\n]//g;
1194 $new_provider_name =~ s/^\s+$//g;
1195 $new_provider_name =~ s/\'/\\'/g;
1197 return $new_provider_name;
1200 ####################################################################################
1204 print "The domain name is the suffix at the end of all email addresses. If\n";
1205 print "for example, your email address is jdoe\@example.com, then your domain\n";
1206 print "would be example.com.\n";
1208 print "[$WHT$domain$NRM]: $WHT";
1209 $new_domain = <STDIN
>;
1210 if ( $new_domain eq "\n" ) {
1211 $new_domain = $domain;
1213 $new_domain =~ s/\s//g;
1220 print "This is the hostname where your IMAP server can be contacted.\n";
1221 print "[$WHT$imapServerAddress$NRM]: $WHT";
1222 $new_imapServerAddress = <STDIN
>;
1223 if ( $new_imapServerAddress eq "\n" ) {
1224 $new_imapServerAddress = $imapServerAddress;
1226 $new_imapServerAddress =~ s/[\r\n]//g;
1228 return $new_imapServerAddress;
1233 print "This is the port that your IMAP server is on. Usually this is 143.\n";
1234 print "[$WHT$imapPort$NRM]: $WHT";
1235 $new_imapPort = <STDIN
>;
1236 if ( $new_imapPort eq "\n" ) {
1237 $new_imapPort = $imapPort;
1239 $new_imapPort =~ s/[\r\n]//g;
1241 return $new_imapPort;
1246 print "You now need to choose the method that you will use for sending\n";
1247 print "messages in SquirrelMail. You can either connect to an SMTP server\n";
1248 print "or use sendmail directly.\n";
1249 if ( lc($useSendmail) eq 'true' ) {
1250 $default_value = "1";
1252 $default_value = "2";
1255 print " 1. Sendmail\n";
1257 print "Your choice [1/2] [$WHT$default_value$NRM]: $WHT";
1258 $use_sendmail = <STDIN
>;
1259 if ( ( $use_sendmail =~ /^1\n/i )
1260 || ( ( $use_sendmail =~ /^\n/ ) && ( $default_value eq "1" ) ) ) {
1261 $useSendmail = 'true';
1263 $useSendmail = 'false';
1265 return $useSendmail;
1270 print "Specify where the sendmail executable is located. Usually /usr/sbin/sendmail\n";
1271 print "[$WHT$sendmail_path$NRM]: $WHT";
1272 $new_sendmail_path = <STDIN
>;
1273 if ( $new_sendmail_path eq "\n" ) {
1274 $new_sendmail_path = $sendmail_path;
1276 $new_sendmail_path =~ s/[\r\n]//g;
1278 return $new_sendmail_path;
1281 # Extra sendmail arguments
1282 sub command_sendmail_args
{
1283 print "Specify additional sendmail program arguments.\n";
1285 print "Make sure that arguments are supported by your sendmail program. -f argument \n";
1286 print "is added automatically by SquirrelMail scripts. Variable defaults to standard\n";
1287 print "/usr/sbin/sendmail arguments. If you use qmail-inject, nbsmtp or any other \n";
1288 print "sendmail wrapper, which does not support -i and -t arguments, set variable to\n";
1289 print "empty string or use arguments suitable for your mailer.\n";
1291 print "[$WHT$sendmail_args$NRM]: $WHT";
1292 $new_sendmail_args = <STDIN
>;
1293 if ( $new_sendmail_args eq "\n" ) {
1294 $new_sendmail_args = $sendmail_args;
1296 # strip linefeeds and crs.
1297 $new_sendmail_args =~ s/[\r\n]//g;
1299 return trim
($new_sendmail_args);
1304 print "This is the hostname of your SMTP server.\n";
1305 print "[$WHT$smtpServerAddress$NRM]: $WHT";
1306 $new_smtpServerAddress = <STDIN
>;
1307 if ( $new_smtpServerAddress eq "\n" ) {
1308 $new_smtpServerAddress = $smtpServerAddress;
1310 $new_smtpServerAddress =~ s/[\r\n]//g;
1312 return $new_smtpServerAddress;
1317 print "This is the port to connect to for SMTP. Usually 25.\n";
1318 print "[$WHT$smtpPort$NRM]: $WHT";
1319 $new_smtpPort = <STDIN
>;
1320 if ( $new_smtpPort eq "\n" ) {
1321 $new_smtpPort = $smtpPort;
1323 $new_smtpPort =~ s/[\r\n]//g;
1325 return $new_smtpPort;
1330 print "Do you wish to use POP3 before SMTP? Your server must\n";
1331 print "support this in order for SquirrelMail to work with it.\n";
1334 $YesNo = 'y' if ( lc($pop_before_smtp) eq 'true' );
1336 print "Use pop before SMTP (y/n) [$WHT$YesNo$NRM]: $WHT";
1338 $new_pop_before_smtp = <STDIN
>;
1339 $new_pop_before_smtp =~ tr/yn//cd;
1340 return 'true' if ( $new_pop_before_smtp eq "y" );
1341 return 'false' if ( $new_pop_before_smtp eq "n" );
1342 return $pop_before_smtp;
1347 print "Each IMAP server has its own quirks. As much as we tried to stick\n";
1348 print "to standards, it doesn't help much if the IMAP server doesn't follow\n";
1349 print "the same principles. We have made some work-arounds for some of\n";
1350 print "these servers. If you would like to use them, please select your\n";
1351 print "IMAP server. If you do not wish to use these work-arounds, you can\n";
1352 print "set this to \"other\", and none will be used.\n";
1353 print $list_supported_imap_servers;
1355 print " other = Not one of the above servers\n";
1357 print "[$WHT$imap_server_type$NRM]: $WHT";
1358 $new_imap_server_type = <STDIN
>;
1360 if ( $new_imap_server_type eq "\n" ) {
1361 $new_imap_server_type = $imap_server_type;
1363 $new_imap_server_type =~ s/[\r\n]//g;
1365 return $new_imap_server_type;
1370 print "Sometimes the date of messages sent is messed up (off by a few hours\n";
1371 print "on some machines). Typically this happens if the system doesn't support\n";
1372 print "tm_gmtoff. It will happen only if your time zone is \"negative\".\n";
1373 print "This most often occurs on Solaris 7 machines in the United States.\n";
1374 print "By default, this is off. It should be kept off unless problems surface\n";
1375 print "about the time that messages are sent.\n";
1376 print " no = Do NOT fix time -- almost always correct\n";
1377 print " yes = Fix the time for this system\n";
1380 $YesNo = 'y' if ( lc($invert_time) eq 'true' );
1382 print "Fix the time for this system (y/n) [$WHT$YesNo$NRM]: $WHT";
1384 $new_invert_time = <STDIN
>;
1385 $new_invert_time =~ tr/yn//cd;
1386 return 'true' if ( $new_invert_time eq "y" );
1387 return 'false' if ( $new_invert_time eq "n" );
1388 return $invert_time;
1392 print "This is the delimiter that your IMAP server uses to distinguish between\n";
1393 print "folders. For example, Cyrus uses '.' as the delimiter and a complete\n";
1394 print "folder would look like 'INBOX.Friends.Bob', while UW uses '/' and would\n";
1395 print "look like 'INBOX/Friends/Bob'. Normally this should be left at 'detect'\n";
1396 print "but if you are sure you know what delimiter your server uses, you can\n";
1397 print "specify it here.\n";
1398 print "\nTo have it autodetect the delimiter, set it to 'detect'.\n\n";
1399 print "[$WHT$optional_delimiter$NRM]: $WHT";
1400 $new_optional_delimiter = <STDIN
>;
1402 if ( $new_optional_delimiter eq "\n" ) {
1403 $new_optional_delimiter = $optional_delimiter;
1405 $new_optional_delimiter =~ s/[\r\n]//g;
1407 return $new_optional_delimiter;
1409 # IMAP authentication type
1410 # Possible values: login, plain, cram-md5, digest-md5
1411 # Now offers to detect supported mechs, assuming server & port are set correctly
1414 if ($use_imap_tls ne "0") {
1415 # 1. Script does not handle TLS.
1416 # 2. Server does not have to declare all supported authentication mechs when
1417 # STARTTLS is used. Supported mechs are declared only after STARTTLS.
1418 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1420 print "If you have already set the hostname and port number, I can try to\n";
1421 print "detect the mechanisms your IMAP server supports.\n";
1422 print "I will try to detect CRAM-MD5 and DIGEST-MD5 support. I can't test\n";
1423 print "for \"login\" or \"plain\" without knowing a username and password.\n";
1424 print "Auto-detecting is optional - you can safely say \"n\" here.\n";
1425 print "\nTry to detect supported mechanisms? [y/N]: ";
1428 if ($inval =~ /^y\b/i) {
1429 # Yes, let's try to detect.
1430 print "Trying to detect IMAP capabilities...\n";
1431 my $host = $imapServerAddress . ':'. $imapPort;
1432 print "CRAM-MD5:\t";
1433 my $tmp = detect_auth_support
('IMAP',$host,'CRAM-MD5');
1434 if (defined($tmp)) {
1435 if ($tmp eq 'YES') {
1436 print "$WHT SUPPORTED$NRM\n";
1438 print "$WHT NOT SUPPORTED$NRM\n";
1441 print $WHT . " ERROR DETECTING$NRM\n";
1444 print "DIGEST-MD5:\t";
1445 $tmp = detect_auth_support
('IMAP',$host,'DIGEST-MD5');
1446 if (defined($tmp)) {
1447 if ($tmp eq 'YES') {
1448 print "$WHT SUPPORTED$NRM\n";
1450 print "$WHT NOT SUPPORTED$NRM\n";
1453 print $WHT . " ERROR DETECTING$NRM\n";
1458 print "\nWhat authentication mechanism do you want to use for IMAP connections?\n\n";
1459 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1460 print $WHT . "plain" . $NRM . " - SASL PLAIN. If you need this, you already know it.\n";
1461 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext methods.\n";
1462 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1463 print "\n*** YOUR IMAP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n";
1464 print "If you don't understand or are unsure, you probably want \"login\"\n\n";
1465 print "login, plain, cram-md5, or digest-md5 [$WHT$imap_auth_mech$NRM]: $WHT";
1468 if ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) || ($inval =~ /^login\b/i) || ($inval =~ /^plain\b/i)) {
1471 # user entered garbage or default value so nothing needs to be set
1472 return $imap_auth_mech;
1477 # SMTP authentication type
1478 # Possible choices: none, plain, cram-md5, digest-md5
1480 if ($use_smtp_tls ne "0") {
1481 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1482 } elsif (eval ("use IO::Socket; 1")) {
1483 # try loading IO::Socket module
1484 print "If you have already set the hostname and port number, I can try to\n";
1485 print "automatically detect some of the mechanisms your SMTP server supports.\n";
1486 print "Auto-detection is *optional* - you can safely say \"n\" here.\n";
1487 print "\nTry to detect auth mechanisms? [y/N]: ";
1490 if ($inval =~ /^y\b/i) {
1491 # Yes, let's try to detect.
1492 print "Trying to detect supported methods (SMTP)...\n";
1495 # Check none by trying to relay to junk@microsoft.com
1496 $host = $smtpServerAddress . ':' . $smtpPort;
1497 my $sock = IO
::Socket
::INET
->new($host);
1498 print "Testing none:\t\t$WHT";
1499 if (!defined($sock)) {
1500 print " ERROR TESTING\n";
1503 $got = <$sock>; # Discard greeting
1504 print $sock "HELO $domain\r\n";
1505 $got = <$sock>; # Discard
1506 print $sock "MAIL FROM:<tester\@squirrelmail.org>\r\n";
1507 $got = <$sock>; # Discard
1508 print $sock "RCPT TO:<junk\@microsoft.com\r\n";
1509 $got = <$sock>; # This is the important line
1510 if ($got =~ /^250\b/) { # SMTP will relay without auth
1511 print "SUPPORTED$NRM\n";
1513 print "NOT SUPPORTED$NRM\n";
1515 print $sock "RSET\r\n";
1516 print $sock "QUIT\r\n";
1519 # Try login (SquirrelMail default)
1520 print "Testing login:\t\t";
1521 $tmp=detect_auth_support
('SMTP',$host,'LOGIN');
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 CRAM-MD5:\t";
1534 $tmp=detect_auth_support
('SMTP',$host,'CRAM-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 "Testing DIGEST-MD5:\t";
1547 $tmp=detect_auth_support
('SMTP',$host,'DIGEST-MD5');
1548 if (defined($tmp)) {
1549 if ($tmp eq 'YES') {
1550 print $WHT . "SUPPORTED$NRM\n";
1552 print $WHT . "NOT SUPPORTED$NRM\n";
1555 print $WHT . "ERROR DETECTING$NRM\n";
1559 print "\nWhat authentication mechanism do you want to use for SMTP connections?\n";
1560 print $WHT . "none" . $NRM . " - Your SMTP server does not require authorization.\n";
1561 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1562 print $WHT . "plain" . $NRM . " - SASL PLAIN. You already know it if you need this.\n";
1563 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext.\n";
1564 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1565 print $WHT . "\n*** YOUR SMTP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n" . $NRM;
1566 print "If you don't understand or are unsure, you probably want \"none\"\n\n";
1567 print "none, login, cram-md5, or digest-md5 [$WHT$smtp_auth_mech$NRM]: $WHT";
1570 if ($inval =~ /^none\b/i) {
1571 # remove sitewide smtp authentication information
1572 $smtp_sitewide_user = '';
1573 $smtp_sitewide_pass = '';
1574 # SMTP doesn't necessarily require logins
1576 } elsif ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) ||
1577 ($inval =~ /^login\b/i) || ($inval =~/^plain\b/i)) {
1578 command_smtp_sitewide_userpass
($inval);
1580 } elsif (trim
($inval) eq '') {
1581 # user selected default value
1582 command_smtp_sitewide_userpass
($smtp_auth_mech);
1583 return $smtp_auth_mech;
1585 # user entered garbage
1586 return $smtp_auth_mech;
1590 sub command_smtp_sitewide_userpass
($) {
1591 # get first function argument
1592 my $auth_mech = shift(@_);
1594 $auth_mech = lc(trim
($auth_mech));
1595 if ($auth_mech eq 'none') {
1598 print "SMTP authentication uses IMAP username and password by default.\n";
1600 print "Would you like to use other login and password for all SquirrelMail \n";
1601 print "SMTP connections?";
1602 if ($smtp_sitewide_user ne '') {
1619 $smtp_sitewide_user = '';
1620 $smtp_sitewide_pass = '';
1621 } elsif ($tmp eq 'y') {
1622 print "Enter username [$smtp_sitewide_user]:";
1623 my $new_user = <STDIN
>;
1624 $new_user = trim
($new_user);
1625 if ($new_user ne '') {
1626 $smtp_sitewide_user = $new_user;
1628 if ($smtp_sitewide_user ne '') {
1629 print "If you don't enter any password, current sitewide password will be used.\n";
1630 print "If you enter space, password will be set to empty string.\n";
1631 print "Enter password:";
1632 my $new_pass = <STDIN
>;
1633 if ($new_pass ne "\n") {
1634 $smtp_sitewide_pass = trim
($new_pass);
1637 print "Invalid input. You must set username used for SMTP authentication.\n";
1638 print "Click enter to continue\n";
1642 print "Invalid input\n";
1643 print "Click enter to continue\n";
1648 # Sub adds information about SMTP authentication type to menu
1649 sub display_smtp_sitewide_userpass
() {
1651 if ($smtp_auth_mech ne 'none') {
1652 if ($smtp_sitewide_user ne '') {
1653 $ret = ' (with custom username and password)';
1655 $ret = ' (with IMAP username and password)';
1662 # This sub is reused for IMAP and SMTP
1663 # Args: service name, default value
1664 sub command_use_tls
{
1665 my($default_val,$service,$inval);
1668 print "TLS (Transport Layer Security) encrypts the traffic between server and client.\n";
1669 print "STARTTLS extensions allow to start encryption on existing plain text connection.\n";
1670 print "These options add specific PHP and IMAP server configuration requirements.\n";
1671 print "See SquirrelMail documentation about connection security.\n";
1673 print "If your " . $service . " server is localhost, you can safely disable this.\n";
1674 print "If it is remote, you may wish to seriously consider enabling this.\n";
1676 while ($valid_input eq 0) {
1677 print "\nSelect connection security model:\n";
1678 print " 0 - Use plain text connection\n";
1679 print " 1 - Use TLS connection\n";
1680 print " 2 - Use STARTTLS extension\n";
1681 print "Select [$default_val]: ";
1683 $inval=trim
($inval);
1684 if ($inval =~ /^[012]$/ || $inval eq '') {
1688 if ($inval ne '') {$default_val = $inval};
1689 return $default_val;
1692 # This sub is used to display human readable text for
1693 # $use_imap_tls and $use_smtp_tls values in conf.pl menu
1694 sub display_use_tls
($) {
1695 my $val = shift(@_);
1696 my $ret = 'disabled';
1699 } elsif ($val eq '1') {
1705 # $encode_header_key
1707 print "Encryption key allows to hide SquirrelMail Received: headers\n";
1708 print "in outbound messages. Interface uses encryption key to encode\n";
1709 print "username, remote address and proxied address, then stores encoded\n";
1710 print "information in X-Squirrel-* headers.\n";
1712 print "Warning: used encryption function is not bulletproof. When used\n";
1713 print "with static encryption keys, it provides only minimal security\n";
1714 print "measures and information can be decoded quickly.\n";
1716 print "Encoded information can be decoded with decrypt_headers.php script\n";
1717 print "from SquirrelMail contrib/ directory.\n";
1719 print "Enter encryption key: ";
1720 $new_encode_header_key = <STDIN
>;
1721 if ( $new_encode_header_key eq "\n" ) {
1722 $new_encode_header_key = $encode_header_key;
1724 $new_encode_header_key =~ s/[\r\n]//g;
1726 return $new_encode_header_key;
1731 print "\nYou can now create the welcome message that is displayed\n";
1732 print "every time a user logs on. You can use HTML or just plain\n";
1734 "text. If you do not wish to have one, just make it blank.\n\n(Type @ on a blank line to exit)\n";
1740 $line =~ s/[\r\n]//g;
1741 if ( $line ne "@" ) {
1742 $line =~ s/ /\ \ /g;
1743 $line =~ s/\t/\ \ \ \ /g;
1745 $line =~ s/\"/\\\"/g;
1747 $new_motd = $new_motd . $line;
1749 } while ( $line ne "@" );
1753 ################# PLUGINS ###################
1756 $command =~ s/[\s\n\r]*//g;
1757 if ( $command > 0 ) {
1758 $command = $command - 1;
1759 if ( $command <= $#plugins ) {
1762 while ( $ct <= $#plugins ) {
1763 if ( $ct != $command ) {
1764 @newplugins = ( @newplugins, $plugins[$ct] );
1768 @plugins = @newplugins;
1769 } elsif ( $command <= $#plugins + $#unused_plugins + 1 ) {
1770 $num = $command - $#plugins - 1;
1771 @newplugins = @plugins;
1773 while ( $ct <= $#unused_plugins ) {
1774 if ( $ct == $num ) {
1775 @newplugins = ( @newplugins, $unused_plugins[$ct] );
1779 @plugins = @newplugins;
1785 # disable_plugins_user
1787 print "When all active plugins are disabled, they can be disabled only\n";
1788 print "for the one user named here. If left blank, plugins will be\n";
1789 print "disabled for ALL users. This setting has no effect if plugins\n";
1790 print "are not disabled.\n";
1792 print "This must be the exact IMAP login name for the desired user.\n";
1794 print "[$WHT$disable_plugins_user$NRM]: $WHT";
1795 $new_disable_plugins_user = <STDIN
>;
1796 if ( $new_disable_plugins_user eq "\n" ) {
1797 $new_disable_plugins_user = $disable_plugins_user;
1799 $new_disable_plugins_user =~ s/[\r\n]//g;
1801 return $new_disable_plugins_user;
1804 ################# FOLDERS ###################
1806 # default_folder_prefix
1808 print "Some IMAP servers (UW, for example) store mail and folders in\n";
1809 print "your user space in a separate subdirectory. This is where you\n";
1810 print "specify what that directory is.\n";
1812 print "EXAMPLE: mail/";
1814 print "NOTE: If you use Cyrus, or some server that would not use this\n";
1815 print " option, you must set this to 'none'.\n";
1817 print "[$WHT$default_folder_prefix$NRM]: $WHT";
1818 $new_default_folder_prefix = <STDIN
>;
1820 if ( $new_default_folder_prefix eq "\n" ) {
1821 $new_default_folder_prefix = $default_folder_prefix;
1823 $new_default_folder_prefix =~ s/[\r\n]//g;
1825 if ( ( $new_default_folder_prefix =~ /^\s*$/ ) || ( $new_default_folder_prefix =~ m/^none$/i ) ) {
1826 $new_default_folder_prefix = "";
1828 # add the trailing delimiter only if we know what the server is.
1829 if (($imap_server_type eq 'cyrus' and
1830 $optional_delimiter eq 'detect') or
1831 ($imap_server_type eq 'courier' and
1832 $optional_delimiter eq 'detect')) {
1833 $new_default_folder_prefix =~ s/\.*$/\./;
1834 } elsif ($imap_server_type eq 'uw' and
1835 $optional_delimiter eq 'detect') {
1836 $new_default_folder_prefix =~ s/\/*$/\
//;
1839 return $new_default_folder_prefix;
1842 # Show Folder Prefix
1844 print "It is possible to set up the default folder prefix as a user\n";
1845 print "specific option, where each user can specify what their mail\n";
1846 print "folder is. If you set this to false, they will never see the\n";
1847 print "option, but if it is true, this option will appear in the\n";
1848 print "'options' section.\n";
1850 print "NOTE: You set the default folder prefix in option '1' of this\n";
1851 print " section. That will be the default if the user doesn't\n";
1852 print " specify anything different.\n";
1855 if ( lc($show_prefix_option) eq 'true' ) {
1856 $default_value = "y";
1858 $default_value = "n";
1861 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
1862 $new_show = <STDIN
>;
1863 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1864 $show_prefix_option = 'true';
1866 $show_prefix_option = 'false';
1868 return $show_prefix_option;
1873 print "You can now specify where the default trash folder is located.\n";
1874 print "On servers where you do not want this, you can set it to anything\n";
1875 print "and set option 6 to false.\n";
1877 print "This is relative to where the rest of your email is kept. You do\n";
1878 print "not need to worry about their mail directory. If this folder\n";
1879 print "would be ~/mail/trash on the filesystem, you only need to specify\n";
1880 print "that this is 'trash', and be sure to put 'mail/' in option 1.\n";
1883 print "[$WHT$trash_folder$NRM]: $WHT";
1884 $new_trash_folder = <STDIN
>;
1885 if ( $new_trash_folder eq "\n" ) {
1886 $new_trash_folder = $trash_folder;
1888 if (check_imap_folder
($new_trash_folder)) {
1889 $new_trash_folder =~ s/[\r\n]//g;
1891 $new_trash_folder = $trash_folder;
1894 return $new_trash_folder;
1899 print "This is where messages that are sent will be stored. SquirrelMail\n";
1900 print "by default puts a copy of all outgoing messages in this folder.\n";
1902 print "This is relative to where the rest of your email is kept. You do\n";
1903 print "not need to worry about their mail directory. If this folder\n";
1904 print "would be ~/mail/sent on the filesystem, you only need to specify\n";
1905 print "that this is 'sent', and be sure to put 'mail/' in option 1.\n";
1908 print "[$WHT$sent_folder$NRM]: $WHT";
1909 $new_sent_folder = <STDIN
>;
1910 if ( $new_sent_folder eq "\n" ) {
1911 $new_sent_folder = $sent_folder;
1913 if (check_imap_folder
($new_sent_folder)) {
1914 $new_sent_folder =~ s/[\r\n]//g;
1916 $new_sent_folder = $sent_folder;
1919 return $new_sent_folder;
1924 print "You can now specify where the default draft folder is located.\n";
1925 print "On servers where you do not want this, you can set it to anything\n";
1926 print "and set option 9 to false.\n";
1928 print "This is relative to where the rest of your email is kept. You do\n";
1929 print "not need to worry about their mail directory. If this folder\n";
1930 print "would be ~/mail/drafts on the filesystem, you only need to specify\n";
1931 print "that this is 'drafts', and be sure to put 'mail/' in option 1.\n";
1934 print "[$WHT$draft_folder$NRM]: $WHT";
1935 $new_draft_folder = <STDIN
>;
1936 if ( $new_draft_folder eq "\n" ) {
1937 $new_draft_folder = $draft_folder;
1939 if (check_imap_folder
($new_draft_folder)) {
1940 $new_draft_folder =~ s/[\r\n]//g;
1942 $new_draft_folder = $draft_folder;
1945 return $new_draft_folder;
1948 # default move to trash
1950 print "By default, should messages get moved to the trash folder? You\n";
1951 print "can specify the default trash folder in option 3. If this is set\n";
1952 print "to false, messages will get deleted immediately without moving\n";
1953 print "to the trash folder.\n";
1955 print "Trash folder is currently: $trash_folder\n";
1958 if ( lc($default_move_to_trash) eq 'true' ) {
1959 $default_value = "y";
1961 $default_value = "n";
1963 print "By default, move to trash (y/n) [$WHT$default_value$NRM]: $WHT";
1964 $new_show = <STDIN
>;
1965 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1966 $default_move_to_trash = 'true';
1968 $default_move_to_trash = 'false';
1970 return $default_move_to_trash;
1973 # default move to sent (save sent messages)
1975 print "By default, should copies of outgoing messages get saved in the\n";
1976 print "sent folder? You can specify the default sent folder in option 4.\n";
1977 print "If this is set to false, messages will get sent and no copy will\n";
1980 print "Sent folder is currently: $sent_folder\n";
1983 if ( lc($default_move_to_sent) eq 'true' ) {
1984 $default_value = "y";
1986 $default_value = "n";
1988 print "By default, save sent messages (y/n) [$WHT$default_value$NRM]: $WHT";
1989 $new_show = <STDIN
>;
1990 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1991 $default_move_to_sent = 'true';
1993 $default_move_to_sent = 'false';
1995 return $default_move_to_sent;
1998 # default save as draft
2000 print "By default, should the save to draft option be shown? You can\n";
2001 print "specify the default drafts folder in option 5. If this is set\n";
2002 print "to false, users will not be shown the save to draft option.\n";
2004 print "Drafts folder is currently: $draft_folder\n";
2007 if ( lc($default_save_as_draft) eq 'true' ) {
2008 $default_value = "y";
2010 $default_value = "n";
2012 print "By default, save as draft (y/n) [$WHT$default_value$NRM]: $WHT";
2013 $new_show = <STDIN
>;
2014 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2015 $default_save_as_draft = 'true';
2017 $default_save_as_draft = 'false';
2019 return $default_save_as_draft;
2022 # List special folders first
2024 print "SquirrelMail has what we call 'special folders' that are not\n";
2025 print "manipulated and viewed like normal folders. Some examples of\n";
2026 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
2027 print "Simply asks if you want these folders listed first in the folder\n";
2031 if ( lc($list_special_folders_first) eq 'true' ) {
2032 $default_value = "y";
2034 $default_value = "n";
2037 print "List first (y/n) [$WHT$default_value$NRM]: $WHT";
2038 $new_show = <STDIN
>;
2039 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2040 $list_special_folders_first = 'true';
2042 $list_special_folders_first = 'false';
2044 return $list_special_folders_first;
2047 # Show special folders color
2049 print "SquirrelMail has what we call 'special folders' that are not\n";
2050 print "manipulated and viewed like normal folders. Some examples of\n";
2051 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
2052 print "wants to know if we should display special folders in a\n";
2053 print "color than the other folders.\n";
2056 if ( lc($use_special_folder_color) eq 'true' ) {
2057 $default_value = "y";
2059 $default_value = "n";
2062 print "Show color (y/n) [$WHT$default_value$NRM]: $WHT";
2063 $new_show = <STDIN
>;
2064 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2065 $use_special_folder_color = 'true';
2067 $use_special_folder_color = 'false';
2069 return $use_special_folder_color;
2074 print "The way that IMAP handles deleting messages is as follows. You\n";
2075 print "mark the message as deleted, and then to 'really' delete it, you\n";
2076 print "expunge it. This option asks if you want to just have messages\n";
2077 print "marked as deleted, or if you want SquirrelMail to expunge the \n";
2078 print "messages too.\n";
2081 if ( lc($auto_expunge) eq 'true' ) {
2082 $default_value = "y";
2084 $default_value = "n";
2086 print "Auto expunge (y/n) [$WHT$default_value$NRM]: $WHT";
2087 $new_show = <STDIN
>;
2088 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2089 $auto_expunge = 'true';
2091 $auto_expunge = 'false';
2093 return $auto_expunge;
2096 # Default sub of inbox
2098 print "Some IMAP servers (Cyrus) have all folders as subfolders of INBOX.\n";
2099 print "This can cause some confusion in folder creation for users when\n";
2100 print "they try to create folders and don't put it as a subfolder of INBOX\n";
2101 print "and get permission errors. This option asks if you want folders\n";
2102 print "to be subfolders of INBOX by default.\n";
2105 if ( lc($default_sub_of_inbox) eq 'true' ) {
2106 $default_value = "y";
2108 $default_value = "n";
2110 print "Default sub of INBOX (y/n) [$WHT$default_value$NRM]: $WHT";
2111 $new_show = <STDIN
>;
2112 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2113 $default_sub_of_inbox = 'true';
2115 $default_sub_of_inbox = 'false';
2117 return $default_sub_of_inbox;
2120 # Show contain subfolder option
2122 print "Some IMAP servers (UW) make it so that there are two types of\n";
2123 print "folders. Those that contain messages, and those that contain\n";
2124 print "subfolders. If this is the case for your server, set this to\n";
2125 print "true, and it will ask the user whether the folder they are\n";
2126 print "creating contains subfolders or messages.\n";
2129 if ( lc($show_contain_subfolders_option) eq 'true' ) {
2130 $default_value = "y";
2132 $default_value = "n";
2134 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
2135 $new_show = <STDIN
>;
2136 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2137 $show_contain_subfolders_option = 'true';
2139 $show_contain_subfolders_option = 'false';
2141 return $show_contain_subfolders_option;
2144 # Default Unseen Notify
2146 print "This option specifies where the users will receive notification\n";
2147 print "about unseen messages by default. This is of course an option that\n";
2148 print "can be changed on a user level.\n";
2149 print " 1 = No notification\n";
2150 print " 2 = Only on the INBOX\n";
2151 print " 3 = On all folders\n";
2154 print "Which one should be default (1,2,3)? [$WHT$default_unseen_notify$NRM]: $WHT";
2155 $new_show = <STDIN
>;
2156 if ( $new_show =~ /^[123]\n/i ) {
2157 $default_unseen_notify = $new_show;
2159 $default_unseen_notify =~ s/[\r\n]//g;
2160 return $default_unseen_notify;
2163 # Default Unseen Type
2165 print "Here you can define the default way that unseen messages will be displayed\n";
2166 print "to the user in the folder listing on the left side.\n";
2167 print " 1 = Only unseen messages (4)\n";
2168 print " 2 = Unseen and Total messages (4/27)\n";
2171 print "Which one should be default (1,2)? [$WHT$default_unseen_type$NRM]: $WHT";
2172 $new_show = <STDIN
>;
2173 if ( $new_show =~ /^[12]\n/i ) {
2174 $default_unseen_type = $new_show;
2176 $default_unseen_type =~ s/[\r\n]//g;
2177 return $default_unseen_type;
2180 # Auto create special folders
2182 print "Would you like the Sent, Trash, and Drafts folders to be created\n";
2183 print "automatically print for you when a user logs in? If the user\n";
2184 print "accidentally deletes their special folders, this option will\n";
2185 print "automatically create it again for them.\n";
2188 if ( lc($auto_create_special) eq 'true' ) {
2189 $default_value = "y";
2191 $default_value = "n";
2193 print "Auto create special folders? (y/n) [$WHT$default_value$NRM]: $WHT";
2194 $new_show = <STDIN
>;
2195 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2196 $auto_create_special = 'true';
2198 $auto_create_special = 'false';
2200 return $auto_create_special;
2203 # Automatically delete folders
2205 if ( $imap_server_type eq "uw" ) {
2206 print "UW IMAP servers will not allow folders containing mail to also contain folders.\n";
2207 print "Deleting folders will bypass the trash folder and be immediately deleted\n\n";
2208 print "If this is not the correct value for your server,\n";
2209 print "please use option D on the Main Menu to configure your server correctly.\n\n";
2210 print "Press enter to continue...\n";
2211 $new_delete = <STDIN
>;
2212 $delete_folder = 'true';
2214 if ( $imap_server_type eq "courier" ) {
2215 print "Courier (or Courier-IMAP) IMAP servers may not support ";
2216 print "subfolders of Trash. \n";
2217 print "Specifically, if Courier is set to always move messages to Trash, \n";
2218 print "Trash will be treated by Courier as a special folder that does not \n";
2219 print "allow subfolders. \n\n";
2220 print "Please verify your Courier configuration, and test folder deletion \n";
2221 print "when changing this setting.\n\n";
2224 print "Are subfolders of the Trash supported by your IMAP server?\n";
2225 print "If so, should deleted folders be sent to Trash?\n";
2226 print "If not, say no (deleted folders should not be sent to Trash)\n\n";
2227 # reversal of logic.
2228 # question was: Should folders be automatically deleted instead of sent to trash..
2229 # we've changed the question to make it more clear,
2230 # and are here handling that to avoid changing the answers..
2231 if ( lc($delete_folder) eq 'true' ) {
2232 $default_value = "n";
2234 $default_value = "y";
2236 print "Send deleted folders to Trash? (y/n) [$WHT$default_value$NRM]: $WHT";
2237 $new_delete = <STDIN
>;
2238 if ( ( $new_delete =~ /^y\n/i ) || ( ( $new_delete =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2239 $delete_folder = 'false';
2241 $delete_folder = 'true';
2244 return $delete_folder;
2249 print "Some IMAP servers allow subfolders to exist even if the parent\n";
2250 print "folders do not. This fixes some problems with the folder list\n";
2251 print "when this is the case, causing the /NoSelect folders to be displayed\n";
2254 if ( lc($noselect_fix_enable) eq 'true' ) {
2255 $default_value = "y";
2257 $default_value = "n";
2259 print "enable noselect fix? (y/n) [$WHT$noselect_fix_enable$NRM]: $WHT";
2260 $noselect_fix_enable = <STDIN
>;
2261 if ( ( $noselect_fix_enable =~ /^y\n/i ) || ( ( $noselect_fix_enable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2262 $noselect_fix_enable = 'true';
2264 $noselect_fix_enable = 'false';
2266 return $noselect_fix_enable;
2268 ############# GENERAL OPTIONS #####################
2272 print "Specify the location for your data directory.\n";
2273 print "You need to create this directory yourself.\n";
2274 print "The path name can be absolute or relative (to the config directory).\n";
2275 print "Here are two examples:\n";
2276 print " Absolute: /var/local/squirrelmail/data/\n";
2277 print " Relative: ../data/\n";
2278 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2279 print "will be converted to their absolute path equivalents in config.php.\n\n";
2280 print "Note: There are potential security risks with having a writeable directory\n";
2281 print "under the web server's root directory (ex: /home/httpd/html).\n";
2282 print "For this reason, it is recommended to put the data directory\n";
2283 print "in an alternate location of your choice. \n";
2286 print "[$WHT$data_dir$NRM]: $WHT";
2287 $new_data_dir = <STDIN
>;
2288 if ( $new_data_dir eq "\n" ) {
2289 $new_data_dir = $data_dir;
2291 $new_data_dir =~ s/[\r\n]//g;
2293 if ( $new_data_dir =~ /^\s*$/ ) {
2296 $new_data_dir =~ s/\/*$//g
;
2297 $new_data_dir =~ s/$/\//g
;
2299 return $new_data_dir;
2302 # Attachment directory
2304 print "Path to directory used for storing attachments while a mail is\n";
2305 print "being composed. The path name can be absolute or relative (to the\n";
2306 print "config directory). Here are two examples:\n";
2307 print " Absolute: /var/local/squirrelmail/attach/\n";
2308 print " Relative: ../attach/\n";
2309 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2310 print "will be converted to their absolute path equivalents in config.php.\n\n";
2311 print "Note: There are a few security considerations regarding this\n";
2312 print "directory:\n";
2313 print " 1. It should have the permission 733 (rwx-wx-wx) to make it\n";
2314 print " impossible for a random person with access to the webserver\n";
2315 print " to list files in this directory. Confidential data might\n";
2316 print " be laying around in there.\n";
2317 print " Depending on your user:group assignments, 730 (rwx-wx---)\n";
2318 print " may be possible, and more secure (e.g. root:apache)\n";
2319 print " 2. Since the webserver is not able to list the files in the\n";
2320 print " content is also impossible for the webserver to delete files\n";
2321 print " lying around there for too long.\n";
2322 print " 3. It should probably be another directory than the data\n";
2323 print " directory specified in option 3.\n";
2326 print "[$WHT$attachment_dir$NRM]: $WHT";
2327 $new_attachment_dir = <STDIN
>;
2328 if ( $new_attachment_dir eq "\n" ) {
2329 $new_attachment_dir = $attachment_dir;
2331 $new_attachment_dir =~ s/[\r\n]//g;
2333 if ( $new_attachment_dir =~ /^\s*$/ ) {
2334 $new_attachment_dir = "";
2336 $new_attachment_dir =~ s/\/*$//g
;
2337 $new_attachment_dir =~ s/$/\//g
;
2339 return $new_attachment_dir;
2343 print "The directory hash level setting allows you to configure the level\n";
2344 print "of hashing that SquirrelMail employs in your data and attachment\n";
2345 print "directories. This value must be an integer ranging from 0 to 4.\n";
2346 print "When this value is set to 0, SquirrelMail will simply store all\n";
2347 print "files as normal in the data and attachment directories. However,\n";
2348 print "when set to a value from 1 to 4, a simple hashing scheme will be\n";
2349 print "used to organize the files in this directory. In short, the crc32\n";
2350 print "value for a username will be computed. Then, up to the first 4\n";
2351 print "digits of the hash, as set by this configuration value, will be\n";
2352 print "used to directory hash the files for that user in the data and\n";
2353 print "attachment directory. This allows for better performance on\n";
2354 print "servers with larger numbers of users.\n";
2357 print "[$WHT$dir_hash_level$NRM]: $WHT";
2358 $new_dir_hash_level = <STDIN
>;
2359 if ( $new_dir_hash_level eq "\n" ) {
2360 $new_dir_hash_level = $dir_hash_level;
2362 $new_dir_hash_level =~ s/[\r\n]//g;
2364 if ( ( int($new_dir_hash_level) < 0 )
2365 || ( int($new_dir_hash_level) > 4 )
2366 || !( int($new_dir_hash_level) eq $new_dir_hash_level ) ) {
2367 print "Invalid Directory Hash Level.\n";
2368 print "Value must be an integer ranging from 0 to 4\n";
2369 print "Hit enter to continue.\n";
2370 $enter_key = <STDIN
>;
2372 $new_dir_hash_level = $dir_hash_level;
2375 return $new_dir_hash_level;
2379 print "This is the default size (in pixels) of the left folder list.\n";
2380 print "Default is 200, but you can set it to whatever you wish. This\n";
2381 print "is a user preference, so this will only show up as their default.\n";
2383 print "[$WHT$default_left_size$NRM]: $WHT";
2384 $new_default_left_size = <STDIN
>;
2385 if ( $new_default_left_size eq "\n" ) {
2386 $new_default_left_size = $default_left_size;
2388 $new_default_left_size =~ s/[\r\n]//g;
2390 return $new_default_left_size;
2394 print "Some IMAP servers only have lowercase letters in the usernames\n";
2395 print "but they still allow people with uppercase to log in. This\n";
2396 print "causes a problem with the user's preference files. This option\n";
2397 print "transparently changes all usernames to lowercase.";
2400 if ( lc($force_username_lowercase) eq 'true' ) {
2401 $default_value = "y";
2403 $default_value = "n";
2405 print "Convert usernames to lowercase (y/n) [$WHT$default_value$NRM]: $WHT";
2406 $new_show = <STDIN
>;
2407 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2417 if ( lc($default_use_priority) eq 'true' ) {
2418 $default_value = "y";
2420 $default_value = "n";
2423 print "Allow users to specify priority of outgoing mail (y/n) [$WHT$default_value$NRM]: $WHT";
2424 $new_show = <STDIN
>;
2425 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2435 if ( lc($hide_sm_attributions) eq 'true' ) {
2436 $default_value = "y";
2438 $default_value = "n";
2441 print "Hide SM attributions (y/n) [$WHT$default_value$NRM]: $WHT";
2442 $new_show = <STDIN
>;
2443 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2453 if ( lc($default_use_mdn) eq 'true' ) {
2454 $default_value = "y";
2456 $default_value = "n";
2459 print "Enable support for read/delivery receipt support (y/n) [$WHT$default_value$NRM]: $WHT";
2460 $new_show = <STDIN
>;
2461 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2469 print " In loosely managed environments, you may want to allow users
2470 to edit their full name and email address. In strictly managed
2471 environments, you may want to force users to use the name
2472 and email address assigned to them.
2474 'y' - allow a user to edit their full name and email address,
2475 'n' - users must use the assigned values.
2479 if ( lc($edit_identity) eq 'true' ) {
2480 $default_value = "y";
2482 $default_value = "n";
2484 print "Allow editing of user's identity? (y/n) [$WHT$default_value$NRM]: $WHT";
2485 $new_edit = <STDIN
>;
2486 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2487 $edit_identity = 'true';
2488 $edit_name = 'true';
2489 $hide_auth_header = command311b
();
2491 $edit_identity = 'false';
2492 $edit_name = command311
();
2493 $hide_auth_header = command311b
();
2495 return $edit_identity;
2499 print " Given that users are not allowed to modify their
2500 email address, can they edit their full name?
2504 if ( lc($edit_name) eq 'true' ) {
2505 $default_value = "y";
2507 $default_value = "n";
2509 print "Allow the user to edit their full name? (y/n) [$WHT$default_value$NRM]: $WHT";
2510 $new_edit = <STDIN
>;
2511 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2512 $edit_name = 'true';
2514 $edit_name = 'false';
2520 print " SquirrelMail adds username information to every sent email
2521 in order to prevent possible sender forging when users are allowed
2522 to change their email and/or full name.
2524 You can remove user information from this header (y), if you think that
2525 it violates privacy or security.
2527 Note: If users are allowed to change their email addresses,
2528 this setting will make it difficult to determine who sent what where.
2529 Use at your own risk.
2533 if ( lc($hide_auth_header) eq "true" ) {
2534 $default_value = "y";
2536 $default_value = "n";
2538 print "Remove username from email headers? (y/n) [$WHT$default_value$NRM]: $WHT";
2539 $new_header = <STDIN
>;
2540 if ( ( $new_header =~ /^y\n/i ) || ( ( $new_header =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2541 $hide_auth_header = "true";
2543 $hide_auth_header = "false";
2545 return $hide_auth_header;
2549 print "This option allows you to disable server side thread sorting if your server \n";
2550 print "declares THREAD support, but you don't want to provide threading options \n";
2551 print "to end users or THREAD extension is broken or extension does not work with \n";
2552 print "options used by SquirrelMail. Option is not used, if THREAD extension is \n";
2553 print "not declared in IMAP CAPABILITY.\n";
2556 if ( lc($disable_thread_sort) eq 'true' ) {
2557 $default_value = "y";
2559 $default_value = "n";
2561 print "Disable server side thread sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2562 $disable_thread_sort = <STDIN
>;
2563 if ( ( $disable_thread_sort =~ /^y\n/i ) || ( ( $disable_thread_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2564 $disable_thread_sort = 'true';
2566 $disable_thread_sort = 'false';
2568 return $disable_thread_sort;
2572 print "This option allows you to disable server side sorting if your server declares \n";
2573 print "SORT support, but SORT extension is broken or does not work with options \n";
2574 print "used by SquirrelMail. Option is not used, if SORT extension is not declared \n";
2575 print "in IMAP CAPABILITY.\n";
2577 print "It is strongly recommended to keep server side sorting enabled, if your ";
2578 print "IMAP server supports it.";
2581 if ( lc($disable_server_sort) eq 'true' ) {
2582 $default_value = "y";
2584 $default_value = "n";
2586 print "Disable server-side sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2587 $disable_server_sort = <STDIN
>;
2588 if ( ( $disable_server_sort =~ /^y\n/i ) || ( ( $disable_server_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2589 $disable_server_sort = 'true';
2591 $disable_server_sort = 'false';
2593 return $disable_server_sort;
2597 print "This option allows you to choose if SM uses charset search\n";
2598 print "Your IMAP server must support the SEARCH CHARSET command for this to work\n";
2601 if ( lc($allow_charset_search) eq 'true' ) {
2602 $default_value = "y";
2604 $default_value = "n";
2606 print "Allow charset searching? (y/n) [$WHT$default_value$NRM]: $WHT";
2607 $allow_charset_search = <STDIN
>;
2608 if ( ( $allow_charset_search =~ /^y\n/i ) || ( ( $allow_charset_search =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2609 $allow_charset_search = 'true';
2611 $allow_charset_search = 'false';
2613 return $allow_charset_search;
2616 # command315 (UID support) obsoleted.
2618 # advanced search option
2620 print "This option allows you to control the use of advanced search form.\n";
2621 print " 0 = enable basic search only\n";
2622 print " 1 = enable advanced search only\n";
2623 print " 2 = enable both\n";
2626 print "Allowed search (0,1,2)? [$WHT$allow_advanced_search$NRM]: $WHT";
2627 $new_allow_advanced_search = <STDIN
>;
2628 if ( $new_allow_advanced_search =~ /^[012]\n/i ) {
2629 $allow_advanced_search = $new_allow_advanced_search;
2631 $allow_advanced_search =~ s/[\r\n]//g;
2632 return $allow_advanced_search;
2637 print "This option allows you to change the name of the PHP session used\n";
2638 print "by SquirrelMail. Unless you know what you are doing, you probably\n";
2639 print "don't need or want to change this from the default of SQMSESSID.\n";
2640 print "[$WHT$session_name$NRM]: $WHT";
2641 $new_session_name = <STDIN
>;
2642 chomp($new_session_name);
2643 if ( $new_session_name eq "" ) {
2644 $new_session_name = $session_name;
2646 return $new_session_name;
2649 # time zone config (since 1.5.1)
2651 print "This option allows you to control the use of time zones.\n";
2652 print " 0 = (default) standard, GNU C time zone names\n";
2653 print " 1 = strict, generic time zone codes with offsets\n";
2654 print " 2 = custom, GNU C time zones loaded from config/timezones.php\n";
2655 print " 3 = custom strict, generic time zone codes with offsets loaded \n";
2656 print " from config/timezones.php\n";
2657 print "See SquirrelMail documentation about format of config/timezones.php file.\n";
2660 print "Desired time zone configuration (0,1,2,3)? [$WHT$time_zone_type$NRM]: $WHT";
2661 $new_time_zone_type = <STDIN
>;
2662 if ( $new_time_zone_type =~ /^[0123]\n/i ) {
2663 $time_zone_type = $new_time_zone_type;
2665 print "\nInvalid configuration value.\n";
2666 print "\nPress enter to continue...";
2669 $time_zone_type =~ s/[\r\n]//g;
2670 return $time_zone_type;
2673 # set the location base for redirects (since 1.5.2)
2674 sub command_config_location_base
{
2675 print "Here you can set the base part of the SquirrelMail URL.\n";
2676 print "It is normally autodetected but if that fails, use this\n";
2677 print "option to override.\n";
2678 print "It should contain only the protocol and hostname/port parts\n";
2679 print "of the URL; the full path will be appended automatically.\n\n";
2680 print "Examples:\nhttp://webmail.example.org\nhttp://webmail.example.com:8080\nhttps://webmail.example.com:6691\n\n";
2681 print "Do not add any path elements.\n";
2683 print "URL base? [" .$WHT."autodetect$NRM]: $WHT";
2684 $new_config_location_base = <STDIN
>;
2685 chomp($new_config_location_base);
2686 $config_location_base = $new_config_location_base;
2688 return $config_location_base;
2691 # only_secure_cookies (since 1.5.2)
2693 print "This option allows you to specify that if a user session is initiated\n";
2694 print "under a secure (HTTPS, SSL-encrypted) connection, the cookies given to\n";
2695 print "the browser will ONLY be transmitted via a secure connection henceforth.\n\n";
2696 print "Generally this is a Good Thing, and should NOT be disabled. However,\n";
2697 print "if you intend to use the Secure Login or Show SSL Link plugins to\n";
2698 print "encrypt the user login, but not the rest of the SquirrelMail session,\n";
2699 print "this can be turned off. Think twice before doing so.\n";
2702 if ( lc($only_secure_cookies) eq 'true' ) {
2703 $default_value = "y";
2705 $default_value = "n";
2707 print "Transmit cookies only on secure connection when available? (y/n) [$WHT$default_value$NRM]: $WHT";
2708 $only_secure_cookies = <STDIN
>;
2709 if ( ( $only_secure_cookies =~ /^y\n/i ) || ( ( $only_secure_cookies =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2710 $only_secure_cookies = 'true';
2712 $only_secure_cookies = 'false';
2714 return $only_secure_cookies;
2718 sub command_userThemes
{
2719 print "\nDefine the user themes that you wish to use. If you have added\n";
2720 print "a theme of your own, just follow the instructions (?) about\n";
2721 print "how to add them. You can also change the default theme.\n\n";
2723 print "Available user themes:\n";
2725 while ( $count <= $#user_theme_name ) {
2726 if ( $count == $user_theme_default ) {
2731 if ( $count < 10 ) {
2734 $name = $user_theme_name[$count];
2735 $num_spaces = 35 - length($name);
2736 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2737 $name = $name . " ";
2740 print " $count. $name";
2741 print "($user_theme_path[$count])\n";
2747 print ".------------------------------------.\n";
2748 print "| t (detect user themes) |\n";
2749 print "| + (add user theme) |\n";
2750 print "| - N (remove user theme) |\n";
2751 print "| m N (mark default user theme) |\n";
2752 print "| l (list user themes) |\n";
2753 print "| d (done) |\n";
2754 print "`------------------------------------'\n";
2756 print "\n[user_themes] command (?=help) > ";
2758 $input =~ s/[\r\n]//g;
2759 while ( $input ne "d" ) {
2760 if ( $input =~ /^\s*l\s*/i ) {
2762 while ( $count <= $#user_theme_name ) {
2763 if ( $count == $user_theme_default ) {
2768 if ( $count < 10 ) {
2771 $name = $user_theme_name[$count];
2772 $num_spaces = 35 - length($name);
2773 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2774 $name = $name . " ";
2777 print " $count. $name";
2778 print "($user_theme_path[$count])\n";
2782 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2783 $old_def = $user_theme_default;
2784 $user_theme_default = $input;
2785 $user_theme_default =~ s/^\s*m\s*//;
2786 if ( ( $user_theme_default > $#user_theme_name ) || ( $user_theme_default < 0 ) ) {
2787 print "Cannot set default theme to $user_theme_default. That theme does not exist.\n";
2788 $user_theme_default = $old_def;
2790 } elsif ( $input =~ /^\s*\+/ ) {
2791 print "What is the name of this theme? ";
2793 $name =~ s/[\r\n]//g;
2794 $user_theme_name[ $#user_theme_name + 1 ] = $name;
2795 print "Be sure to put ../css/ before the filename.\n";
2796 print "What file is this stored in (ex: ../css/my_theme/): ";
2798 $name =~ s/[\r\n]//g;
2799 $user_theme_path[ $#user_theme_path + 1 ] = $name;
2800 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2801 if ( $input =~ /[0-9]+\s*$/ ) {
2803 $rem_num =~ s/^\s*-\s*//g;
2804 $rem_num =~ s/\s*$//;
2806 $rem_num = $#user_theme_name;
2808 if ( $rem_num == $user_theme_default ) {
2809 print "You cannot remove the default theme!\n";
2812 @new_theme_name = ();
2813 @new_theme_path = ();
2814 while ( $count <= $#user_theme_name ) {
2815 if ( $count != $rem_num ) {
2816 @new_theme_name = ( @new_theme_name, $user_theme_name[$count] );
2817 @new_theme_path = ( @new_theme_path, $user_theme_path[$count] );
2821 @user_theme_name = @new_theme_name;
2822 @user_theme_path = @new_theme_path;
2823 if ( $user_theme_default > $rem_num ) {
2824 $user_theme_default--;
2827 } elsif ( $input =~ /^\s*t\s*/i ) {
2828 print "\nStarting detection...\n\n";
2830 opendir( DIR
, "../css" );
2831 @files = sort(readdir(DIR
));
2833 while ( $cnt <= $#files ) {
2834 $filename = "../css/" . $files[$cnt] .'/';
2835 if ( $files[$cnt] !~ /^\./ && $filename ne "../css/rtl.css" && -e
$filename . "default.css" ) {
2837 for ( $x = 0 ; $x <= $#user_theme_path ; $x++ ) {
2838 if ( $user_theme_path[$x] eq $filename ) {
2842 if ( $found != 1 ) {
2843 print "** Found user theme: $filename\n";
2844 $def = $files[$cnt];
2847 #$def =~ s/(^\w+)/ucfirst $1/eg;
2848 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
2849 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
2850 print " What is its name? [$def]: ";
2852 $nm =~ s/^\s+|\s+$|[\n\r]//g;
2853 if ( $nm eq '' ) { $nm = $def; }
2854 $user_theme_name[ $#user_theme_name + 1 ] = $nm;
2855 $user_theme_path[ $#user_theme_path + 1 ] = $filename;
2861 for ( $cnt = 0 ; $cnt <= $#user_theme_path ; $cnt++ ) {
2862 $filename = $user_theme_path[$cnt];
2863 if ( $filename != 'none' && !( -e
$filename ."/default.css" ) ) {
2864 print " Removing $filename (file not found)\n";
2866 @new_user_theme_name = ();
2867 @new_user_theme_path = ();
2868 for ( $x = 0 ; $x < $#user_theme_path ; $x++ ) {
2869 if ( $user_theme_path[$x] eq $filename ) {
2872 if ( $offset == 1 ) {
2873 $new_user_theme_name[$x] = $user_theme_name[ $x + 1 ];
2874 $new_user_theme_path[$x] = $user_theme_path[ $x + 1 ];
2876 $new_user_theme_name[$x] = $user_theme_name[$x];
2877 $new_user_theme_path[$x] = $user_theme_path[$x];
2880 @user_theme_name = @new_user_theme_name;
2881 @user_theme_path = @new_user_theme_path;
2884 print "\nDetection complete!\n\n";
2887 } elsif ( $input =~ /^\s*\?\s*/ ) {
2888 print ".------------------------------------.\n";
2889 print "| t (detect user themes) |\n";
2890 print "| + (add user theme) |\n";
2891 print "| - N (remove user theme) |\n";
2892 print "| m N (mark default user theme) |\n";
2893 print "| l (list user themes) |\n";
2894 print "| d (done) |\n";
2895 print "`------------------------------------'\n";
2897 print "[user_themes] command (?=help) > ";
2899 $input =~ s/[\r\n]//g;
2903 sub command_iconSets
{
2904 print "\nDefine the icon themes that you wish to use. If you have added\n";
2905 print "a theme of your own, just follow the instructions (?) about\n";
2906 print "how to add them. You can also change the default and fallback\n";
2907 print "themes. The default theme will be used when no icon theme is\n";
2908 print "set by the user. The fallback theme will be used if an icon\n";
2909 print "cannot be found in the currently selected icon theme.\n\n";
2911 print "Available icon themes:\n\n";
2914 while ( $count <= $#icon_theme_name ) {
2915 if ( $count == $icon_theme_def ) {
2920 if ( $count eq $icon_theme_fallback ) {
2925 if ( $count < 10 ) {
2928 $name = $icon_theme_name[$count];
2929 $num_spaces = 35 - length($name);
2930 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2931 $name = $name . " ";
2934 print " $count. $name";
2935 print "($icon_theme_path[$count])\n";
2940 print "\n d = Default icon theme\n";
2941 print " f = Fallback icon theme\n";
2943 print ".------------------------------------.\n";
2944 print "| t (detect icon themes) |\n";
2945 print "| + (add icon theme) |\n";
2946 print "| - N (remove icon theme) |\n";
2947 print "| m N (mark default icon theme) |\n";
2948 print "| f N (set fallback icon set) |\n";
2949 print "| l (list icon themes) |\n";
2950 print "| d (done) |\n";
2951 print "`------------------------------------'\n";
2953 print "\n[icon_themes] command (?=help) > ";
2955 $input =~ s/[\r\n]//g;
2956 while ( $input ne "d" ) {
2957 if ( $input =~ /^\s*l\s*/i ) {
2960 while ( $count <= $#icon_theme_name ) {
2961 if ( $count == $icon_theme_def ) {
2966 if ( $count eq $icon_theme_fallback ) {
2971 $name = $icon_theme_name[$count];
2972 $num_spaces = 35 - length($name);
2973 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2974 $name = $name . " ";
2977 print " $count. $name";
2978 print "($icon_theme_path[$count])\n";
2982 print "\n d = Default icon theme\n";
2983 print " f = Fallback icon theme\n\n";
2984 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2985 $old_def = $icon_theme_def;
2986 $icon_theme_def = $input;
2987 $icon_theme_def =~ s/^\s*m\s*//;
2988 if ( ( $icon_theme_default > $#icon_theme_name ) || ( $icon_theme_default < 0 ) ) {
2989 print "Cannot set default icon theme to $icon_theme_default. That theme does not exist.\n";
2990 $icon_theme_def = $old_def;
2992 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
2993 $old_fb = $icon_theme_fallback;
2994 $icon_theme_fallback = $input;
2995 $icon_theme_fallback =~ s/^\s*f\s*//;
2996 if ( ( $icon_theme_fallback > $#icon_theme_name ) || ( $icon_theme_fallback < 0 ) ) {
2997 print "Cannot set fallback icon theme to $icon_theme_fallback. That theme does not exist.\n";
2998 $icon_theme_fallback = $old_fb;
3000 } elsif ( $input =~ /^\s*\+/ ) {
3001 print "What is the name of this icon theme? ";
3003 $name =~ s/[\r\n]//g;
3004 $icon_theme_name[ $#icon_theme_name + 1 ] = $name;
3005 print "Be sure to put ../images/themes/ before the filename.\n";
3006 print "What directory is this icon theme stored in (ex: ../images/themes/my_theme/)? ";
3008 $name =~ s/[\r\n]//g;
3009 $icon_theme_path[ $#icon_theme_path + 1 ] = $name;
3010 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3011 if ( $input =~ /[0-9]+\s*$/ ) {
3013 $rem_num =~ s/^\s*-\s*//g;
3014 $rem_num =~ s/\s*$//;
3016 $rem_num = $#icon_theme_name;
3018 if ( $rem_num == $icon_theme_def ) {
3019 print "You cannot remove the default icon theme!\n";
3020 } elsif ( $rem_num == $icon_theme_fallback ) {
3021 print "You cannot remove the fallback icon theme!\n";
3024 @new_theme_name = ();
3025 @new_theme_path = ();
3026 while ( $count <= $#icon_theme_name ) {
3027 if ( $count != $rem_num ) {
3028 @new_theme_name = ( @new_theme_name, $icon_theme_name[$count] );
3029 @new_theme_path = ( @new_theme_path, $icon_theme_path[$count] );
3033 @icon_theme_name = @new_theme_name;
3034 @icon_theme_path = @new_theme_path;
3035 if ( $icon_theme_def > $rem_num ) {
3039 } elsif ( $input =~ /^\s*t\s*/i ) {
3040 print "\nStarting detection...\n\n";
3042 opendir( DIR
, "../images/themes/" );
3043 @files = sort(readdir(DIR
));
3045 while ( $cnt <= $#files ) {
3046 $filename = "../images/themes/" . $files[$cnt] .'/';
3047 if ( -d
"../images/themes/" . $files[$cnt] && $files[$cnt] !~ /^\
./ && $files[$cnt] ne ".svn" ) {
3049 for ( $x = 0 ; $x <= $#icon_theme_path ; $x++ ) {
3050 if ( $icon_theme_path[$x] eq $filename ) {
3054 if ( $found != 1 ) {
3055 print "** Found icon theme: $filename\n";
3056 $def = $files[$cnt];
3059 #$def =~ s/(^\w+)/ucfirst $1/eg;
3060 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3061 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3062 print " What is its name? [$def]: ";
3064 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3065 if ( $nm eq '' ) { $nm = $def; }
3066 $icon_theme_name[ $#icon_theme_name + 1 ] = $nm;
3067 $icon_theme_path[ $#icon_theme_path + 1 ] = $filename;
3073 for ( $cnt = 0 ; $cnt <= $#icon_theme_path ; $cnt++ ) {
3074 $filename = $icon_theme_path[$cnt];
3075 if ( $filename ne "none" && $filename ne "template" && ! -d
$filename ) {
3076 print " Removing $filename (file not found)\n";
3078 @new_icon_theme_name = ();
3079 @new_icon_theme_path = ();
3080 for ( $x = 0 ; $x < $#icon_theme_path ; $x++ ) {
3081 if ( $icon_theme_path[$x] eq $filename ) {
3084 if ( $offset == 1 ) {
3085 $new_icon_theme_name[$x] = $icon_theme_name[ $x + 1 ];
3086 $new_icon_theme_path[$x] = $icon_theme_path[ $x + 1 ];
3088 $new_icon_theme_name[$x] = $icon_theme_name[$x];
3089 $new_icon_theme_path[$x] = $icon_theme_path[$x];
3092 @icon_theme_name = @new_icon_theme_name;
3093 @icon_theme_path = @new_icon_theme_path;
3096 print "\nDetection complete!\n\n";
3099 } elsif ( $input =~ /^\s*\?\s*/ ) {
3100 print ".------------------------------------.\n";
3101 print "| t (detect icon themes) |\n";
3102 print "| + (add icon theme) |\n";
3103 print "| - N (remove icon theme) |\n";
3104 print "| m N (mark default icon theme) |\n";
3105 print "| f N (set fallback icon set) |\n";
3106 print "| l (list icon themes) |\n";
3107 print "| d (done) |\n";
3108 print "`------------------------------------'\n";
3110 print "[icon_themes] command (?=help) > ";
3112 $input =~ s/[\r\n]//g;
3116 sub command_templates
{
3117 print "\nDefine the template sets (skins) that you wish to use. If you have added\n";
3118 print "a template set of your own, just follow the instructions (?) about\n";
3119 print "how to add them. You can also change the default template.\n";
3121 print "\n Available Templates:\n";
3124 while ( $count <= $#templateset_name ) {
3125 if ( $templateset_id[$count] eq $templateset_default ) {
3130 if ( $templateset_id[$count] eq $templateset_fallback ) {
3135 if ( $count < 10 ) {
3138 $name = $templateset_name[$count];
3139 $num_spaces = 35 - length($name);
3140 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3141 $name = $name . " ";
3144 print " $count. $name";
3145 print "($templateset_id[$count])\n";
3149 print "\n d = default template set\n"
3150 . " f = fallback template set\n\n";
3152 $menu_text = ".-------------------------------------.\n"
3153 . "| t (detect template set) |\n"
3154 . "| + (add template set) |\n"
3155 . "| - N (remove template set) |\n"
3156 . "| m N (mark default template set) |\n"
3157 . "| f N (set fallback template set) |\n"
3158 . "| l (list template sets/skins) |\n"
3160 . "|-------------------------------------|\n"
3161 . "| where N is a template set number |\n"
3162 . "`-------------------------------------'\n";
3165 print "\n[template set] command (?=help) > ";
3168 $input =~ s/[\r\n]//g;
3169 while ( $input ne "d" ) {
3171 # list template sets
3173 if ( $input =~ /^\s*l\s*/i ) {
3175 while ( $count <= $#templateset_name ) {
3176 if ( $templateset_id[$count] eq $templateset_default ) {
3181 if ( $templateset_id[$count] eq $templateset_fallback ) {
3186 if ( $count < 10 ) {
3189 $name = $templateset_name[$count];
3190 $num_spaces = 35 - length($name);
3191 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3192 $name = $name . " ";
3195 print " $count. $name";
3196 print "($templateset_id[$count])\n";
3200 print "\n d = default template set\n"
3201 . " f = fallback template set\n\n";
3203 # mark default template set
3205 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
3206 $old_def = $templateset_default;
3207 $input =~ s/^\s*m\s*//;
3208 $templateset_default = $templateset_id[$input];
3209 if ( $templateset_default =~ /^\s*$/ ) {
3210 print "Cannot set default template set to $input. That template set does not exist.\n";
3211 $templateset_default = $old_def;
3214 # set fallback template set
3216 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
3217 $old_def = $templateset_fallback;
3218 $input =~ s/^\s*f\s*//;
3219 $templateset_fallback = $templateset_id[$input];
3220 if ( $templateset_fallback =~ /^\s*$/ ) {
3221 print "Cannot set fallback template set to $input. That template set does not exist.\n";
3222 $templateset_fallback = $old_def;
3227 } elsif ( $input =~ /^\s*\+/ ) {
3228 print "\nWhat is the name of this template (as shown to your users): ";
3230 $name =~ s/[\r\n]//g;
3231 $templateset_name[ $#templateset_name + 1 ] = $name;
3232 print "\n\nThe directory name should not contain any path information\n"
3233 . "or slashes, and should be the name of the directory that the\n"
3234 . "template set is found in within the SquirrelMail templates\n"
3236 print "What directory is this stored in (ex: default_advanced): ";
3238 $name =~ s/[\r\n]//g;
3239 $templateset_id[ $#templateset_id + 1 ] = $name;
3241 # detect template sets
3243 } elsif ( $input =~ /^\s*t\s*/i ) {
3244 print "\nStarting detection...\n\n";
3245 opendir( DIR
, "../templates" );
3246 @files = sort(readdir(DIR
));
3248 while ( $cnt <= $#files ) {
3249 if ( -d
"../templates/" . $files[$cnt] && $files[$cnt] !~ /^\./ && $files[$cnt] ne ".svn" ) {
3250 $filename = $files[$cnt];
3252 for ( $x = 0 ; $x <= $#templateset_id ; $x++ ) {
3253 if ( $templateset_id[$x] eq $filename ) {
3259 print "** Found template set: $filename\n";
3260 $def = $files[$cnt];
3263 #$def =~ s/(^\w+)/ucfirst $1/eg;
3264 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3265 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3266 print " What is it's name (as shown to your users)? [$def]: ";
3268 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3269 if ( $nm eq '' ) { $nm = $def; }
3270 $templateset_id[ $#templateset_id + 1 ] = $filename;
3271 $templateset_name[ $#templateset_name + 1 ] = $nm;
3277 for ( $cnt= 0 ; $cnt <= $#templateset_id ; ) {
3278 $filename = $templateset_id[$cnt];
3279 if ( !(-d change_to_rel_path
('SM_PATH . \'templates/' . $filename)) ) {
3280 print " Removing \"$filename\" (template set directory not found)\n";
3281 if ( $templateset_default eq $filename ) { $templateset_default = 'default'; }
3282 if ( $templateset_fallback eq $filename ) { $templateset_fallback = 'default'; }
3284 @new_templateset_name = ();
3285 @new_templateset_id = ();
3286 for ( $x = 0 ; $x < $#templateset_id ; $x++ ) {
3287 if ( $templateset_id[$x] eq $filename ) {
3290 if ( $offset == 1 ) {
3291 $new_templateset_name[$x] = $templateset_name[ $x + 1 ];
3292 $new_templateset_id[$x] = $templateset_id[ $x + 1 ];
3294 $new_templateset_name[$x] = $templateset_name[$x];
3295 $new_templateset_id[$x] = $templateset_id[$x];
3298 @templateset_name = @new_templateset_name;
3299 @templateset_id = @new_templateset_id;
3302 print "\nDetection complete!\n\n";
3306 # remove template set
3308 # undocumented functionality of removing last template set isn't that great
3309 #} elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3310 } elsif ( $input =~ /^\s*-\s*[0-9]+/ ) {
3311 if ( $input =~ /[0-9]+\s*$/ ) {
3313 $rem_num =~ s/^\s*-\s*//g;
3314 $rem_num =~ s/\s*$//;
3316 $rem_num = $#templateset_name;
3318 if ( $templateset_id[$rem_num] eq $templateset_default ) {
3319 print "You cannot remove the default template set!\n";
3320 } elsif ( $templateset_id[$rem_num] eq $templateset_fallback ) {
3321 print "You cannot remove the fallback template set!\n";
3324 @new_templateset_name = ();
3325 @new_templateset_id = ();
3326 while ( $count <= $#templateset_name ) {
3327 if ( $count != $rem_num ) {
3328 @new_templateset_name = ( @new_templateset_name, $templateset_name[$count] );
3329 @new_templateset_id = ( @new_templateset_id, $templateset_id[$count] );
3333 @templateset_name = @new_templateset_name;
3334 @templateset_id = @new_templateset_id;
3339 } elsif ( $input =~ /^\s*\?\s*/ ) {
3342 # command not understood
3345 print "Command not understood\n";
3348 print "[template set] command (?=help) > ";
3350 $input =~ s/[\r\n]//g;
3352 return $templateset_default;
3356 # sets default font size option
3357 sub command_default_fontsize
{
3358 print "Enter default font size [$WHT$$default_fontsize$NRM]: $WHT";
3359 $new_size = <STDIN
>;
3360 if ( $new_size eq "\n" ) {
3363 $new_size =~ s/[\r\n]//g;
3368 # controls available fontsets
3369 sub command_fontsets
{
3371 print "You can control fontsets available to end users here.\n";
3372 # set initial $input value
3374 while ( $input ne "x" ) {
3375 if ( $input =~ /^\s*a\s*/i ) {
3377 print "\nFontset name: ";
3379 if (! $fontsets{trim
($name)}) {
3380 print "Fontset string: ";
3382 $fontsets{trim
($name)} = trim
($value);
3384 print "\nERROR: Such fontset already exists.\n";
3386 } elsif ( $input =~ /^\s*e\s*/i ) {
3387 # edit existing fontset
3388 print "\nFontset name: ";
3390 if (! $fontsets{trim
($name)}) {
3391 print "\nERROR: No such fontset.\n";
3393 print "Fontset string [$fontsets{trim($name)}]: ";
3395 $fontsets{trim
($name)} = trim
($value);
3397 } elsif ( $input =~ /^\s*d\s*/ ) {
3398 # delete existing fontset
3399 print "\nFontset name: ";
3401 if (! $fontsets{trim
($name)}) {
3402 print "\nERROR: No such fontset.\n";
3404 delete $fontsets{trim
($name)};
3406 } elsif ( $input =~ /^\s*l\s*/ ) {
3408 print "\nConfigured fontsets:\n";
3409 while (($fontset_name, $fontset_string) = each(%fontsets)) {
3410 print " $fontset_name = $fontset_string\n";
3412 print "Default fontset: $default_fontset\n";
3413 } elsif ( $input =~ /^\s*m\s*/ ) {
3414 # set default fontset
3415 print "\nSet default fontset [$default_fontset]: ";
3417 if (trim
($name) ne '' and ! $fontsets{trim
($name)}) {
3418 print "\nERROR: No such fontset.\n";
3420 $default_fontset = trim
($name);
3423 # print available commands on any other input
3424 print "\nAvailable commands:\n";
3425 print " a - Adds new fontset.\n";
3426 print " d - Deletes existing fontset.\n";
3427 print " e - Edits existing fontset.\n";
3428 print " h or ? - Shows this help screen.\n";
3429 print " l - Lists available fontsets.\n";
3430 print " m - Sets default fontset.\n";
3431 print " x - Exits fontset editor mode.\n";
3433 print "\nCommand [fontsets] (a,d,e,h,?=help,l,m,x)> ";
3435 $input =~ s/[\r\n]//g;
3440 print "You can now define different LDAP servers.\n";
3441 print "Please ensure proper permissions for config.php when including\n";
3442 print "sensitive passwords.\n\n";
3443 print "[ldap] command (?=help) > ";
3445 $input =~ s/[\r\n]//g;
3446 while ( $input ne "d" ) {
3447 if ( $input =~ /^\s*l\s*/i ) {
3449 while ( $count <= $#ldap_host ) {
3450 print "$count. $ldap_host[$count]\n";
3451 print " base: $ldap_base[$count]\n";
3452 if ( $ldap_charset[$count] ) {
3453 print " charset: $ldap_charset[$count]\n";
3455 if ( $ldap_port[$count] ) {
3456 print " port: $ldap_port[$count]\n";
3458 if ( $ldap_name[$count] ) {
3459 print " name: $ldap_name[$count]\n";
3461 if ( $ldap_maxrows[$count] ) {
3462 print " maxrows: $ldap_maxrows[$count]\n";
3464 if ( $ldap_filter[$count] ) {
3465 print " filter: $ldap_filter[$count]\n";
3467 if ( $ldap_binddn[$count] ) {
3468 print " binddn: $ldap_binddn[$count]\n";
3469 if ( $ldap_bindpw[$count] ) {
3470 print " bindpw: $ldap_bindpw[$count]\n";
3473 if ( $ldap_protocol[$count] ) {
3474 print " protocol: $ldap_protocol[$count]\n";
3476 if ( $ldap_limit_scope[$count] ) {
3477 print " limit_scope: $ldap_limit_scope[$count]\n";
3479 if ( $ldap_listing[$count] ) {
3480 print " listing: $ldap_listing[$count]\n";
3482 if ( $ldap_writeable[$count] ) {
3483 print " writeable: $ldap_writeable[$count]\n";
3485 if ( $ldap_search_tree[$count] ) {
3486 print " search_tree: $ldap_search_tree[$count]\n";
3488 if ( $ldap_starttls[$count] ) {
3489 print " starttls: $ldap_starttls[$count]\n";
3495 } elsif ( $input =~ /^\s*\+/ ) {
3496 $sub = $#ldap_host + 1;
3498 print "First, we need to have the hostname or the IP address where\n";
3499 print "this LDAP server resides. Example: ldap.bigfoot.com\n";
3501 print "You can use any URI compatible with your LDAP library. Please\n";
3502 print "note that StartTLS option is not compatible with ldaps and\n";
3503 print "ldapi URIs.\n";
3506 $name =~ s/[\r\n]//g;
3507 $ldap_host[$sub] = $name;
3511 print "Next, we need the server root (base dn). For this, an empty\n";
3512 print "string is allowed.\n";
3513 print "Example: ou=member_directory,o=netcenter.com\n";
3516 $name =~ s/[\r\n]//g;
3517 $ldap_base[$sub] = $name;
3521 print "This is the TCP/IP port number for the LDAP server. Default\n";
3522 print "port is 389. This is optional. Press ENTER for default.\n";
3525 $name =~ s/[\r\n]//g;
3526 $ldap_port[$sub] = $name;
3530 print "This is the charset for the server. Default is utf-8. This\n";
3531 print "is also optional. Press ENTER for default.\n";
3534 $name =~ s/[\r\n]//g;
3535 $ldap_charset[$sub] = $name;
3539 print "This is the name for the server, used to tag the results of\n";
3540 print "the search. Default it \"LDAP: hostname\". Press ENTER for default\n";
3543 $name =~ s/[\r\n]//g;
3544 $ldap_name[$sub] = $name;
3548 print "You can specify the maximum number of rows in the search result.\n";
3549 print "Default value is equal to 250 rows. Press ENTER for default.\n";
3552 $name =~ s/[\r\n]//g;
3553 $ldap_maxrows[$sub] = $name;
3558 print "If your LDAP server does not like anonymous logins, you can specify bind DN.\n";
3559 print "Default is none, anonymous bind. Press ENTER for default.\n";
3562 $name =~ s/[\r\n]//g;
3563 $ldap_binddn[$sub] = $name;
3567 if ( $ldap_binddn[$sub] ne '' ) {
3569 print "Now, please specify password for that DN.\n";
3572 $name =~ s/[\r\n]//g;
3573 $ldap_bindpw[$sub] = $name;
3578 print "You can specify bind protocol version here.\n";
3579 print "Default protocol version depends on your php ldap settings.\n";
3580 print "Press ENTER for default.\n";
3583 $name =~ s/[\r\n]//g;
3584 $ldap_protocol[$sub] = $name;
3588 print "This configuration section allows to set some rarely used\n";
3589 print "options and options specific to some LDAP implementations.\n";
3591 print "Do you want to set advanced LDAP directory settings? (y/N):";
3592 $ldap_advanced_settings = <STDIN
>;
3593 if ( $ldap_advanced_settings =~ /^y\n/i ) {
3594 $ldap_advanced_settings = 'true';
3596 $ldap_advanced_settings = 'false';
3599 if ($ldap_advanced_settings eq 'true') {
3602 print "You can control LDAP directory listing here. This option can\n";
3603 print "be useful if you run small LDAP server and want to provide listing\n";
3604 print "of all addresses stored in LDAP to users of webmail interface.\n";
3605 print "Number of displayed entries is limited by maxrows setting.\n";
3607 print "Don't enable this option for public LDAP directories.\n";
3609 print "Allow listing of LDAP directory? (y/N):";
3611 if ( $name =~ /^y\n/i ) {
3616 $ldap_listing[$sub] = $name;
3620 print "You can control write access to LDAP address book here. This option can\n";
3621 print "be useful if you run small LDAP server and want to provide writable\n";
3622 print "shared address book stored in LDAP to users of webmail interface.\n";
3624 print "Don't enable this option for public LDAP directories.\n";
3626 print "Allow writing to LDAP directory? (y/N):";
3628 if ( $name =~ /^y\n/i ) {
3633 $ldap_writeable[$sub] = $name;
3637 print "You can specify an additional search filter.\n";
3638 print "This could be something like \"(objectclass=posixAccount)\".\n";
3639 print "No filtering is performed by default. Press ENTER for default.\n";
3642 $name =~ s/[\r|\n]//g;
3643 $ldap_filter[$sub] = $name;
3647 print "You can control search scope here.\n";
3648 print "This option is specific to Microsoft ADS implementation.\n";
3649 print "It requires use of v3 or newer LDAP protocol.\n";
3650 print "Don't enable it, if you use other LDAP server.\n";
3652 print "Limit ldap scope? (y/N):";
3654 if ( $name =~ /^y\n/i ) {
3659 $ldap_limit_scope[$sub] = $name;
3663 print "You can control ldap search type here.\n";
3664 print "Addresses can be searched in entire LDAP subtree (default)\n";
3665 print "or only first level entries are returned.\n";
3667 print "Search entire LDAP subtree? (Y/n):";
3669 if ( $name =~ /^n\n/i ) {
3674 $ldap_search_tree[$sub] = $name;
3678 print "You can control use of StartTLS on LDAP connection here.\n";
3679 print "This option requires use of v3 or newer LDAP protocol and php 4.2+.\n";
3681 print "Use StartTLS? (y/N):";
3683 if ( $name =~ /^y\n/i ) {
3688 $ldap_starttls[$sub] = $name;
3692 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3693 if ( $input =~ /[0-9]+\s*$/ ) {
3695 $rem_num =~ s/^\s*-\s*//g;
3696 $rem_num =~ s/\s*$//;
3698 $rem_num = $#ldap_host;
3701 @new_ldap_host = ();
3702 @new_ldap_base = ();
3703 @new_ldap_port = ();
3704 @new_ldap_name = ();
3705 @new_ldap_charset = ();
3706 @new_ldap_maxrows = ();
3707 @new_ldap_filter = ();
3708 @new_ldap_bindpw = ();
3709 @new_ldap_binddn = ();
3710 @new_ldap_protocol = ();
3711 @new_ldap_limit_scope = ();
3712 @new_ldap_listing = ();
3713 @new_ldap_writeable = ();
3714 @new_ldap_search_tree = ();
3715 @new_ldap_starttls = ();
3717 while ( $count <= $#ldap_host ) {
3718 if ( $count != $rem_num ) {
3719 @new_ldap_host = ( @new_ldap_host, $ldap_host[$count] );
3720 @new_ldap_base = ( @new_ldap_base, $ldap_base[$count] );
3721 @new_ldap_port = ( @new_ldap_port, $ldap_port[$count] );
3722 @new_ldap_name = ( @new_ldap_name, $ldap_name[$count] );
3723 @new_ldap_charset = ( @new_ldap_charset, $ldap_charset[$count] );
3724 @new_ldap_maxrows = ( @new_ldap_maxrows, $ldap_maxrows[$count] );
3725 @new_ldap_filter = ( @new_ldap_filter, $ldap_filter[$count] );
3726 @new_ldap_binddn = ( @new_ldap_binddn, $ldap_binddn[$count] );
3727 @new_ldap_bindpw = ( @new_ldap_bindpw, $ldap_bindpw[$count] );
3728 @new_ldap_protocol = ( @new_ldap_protocol, $ldap_protocol[$count] );
3729 @new_ldap_limit_scope = ( @new_ldap_limit_scope, $ldap_limit_scope[$count] );
3730 @new_ldap_listing = ( @new_ldap_listing, $ldap_listing[$count] );
3731 @new_ldap_writeable = ( @new_ldap_writeable, $ldap_writeable[$count] );
3732 @new_ldap_search_tree = ( @new_ldap_search_tree, $ldap_search_tree[$count] );
3733 @new_ldap_starttls = ( @new_ldap_starttls, $ldap_starttls[$count] );
3737 @ldap_host = @new_ldap_host;
3738 @ldap_base = @new_ldap_base;
3739 @ldap_port = @new_ldap_port;
3740 @ldap_name = @new_ldap_name;
3741 @ldap_charset = @new_ldap_charset;
3742 @ldap_maxrows = @new_ldap_maxrows;
3743 @ldap_filter = @new_ldap_filter;
3744 @ldap_binddn = @new_ldap_binddn;
3745 @ldap_bindpw = @new_ldap_bindpw;
3746 @ldap_protocol = @new_ldap_protocol;
3747 @ldap_limit_scope = @new_ldap_limit_scope;
3748 @ldap_listing = @new_ldap_listing;
3749 @ldap_writeable = @new_ldap_writeable;
3750 @ldap_search_tree = @new_ldap_search_tree;
3751 @ldap_starttls = @new_ldap_starttls;
3753 } elsif ( $input =~ /^\s*\?\s*/ ) {
3754 print ".-------------------------.\n";
3755 print "| + (add host) |\n";
3756 print "| - N (remove host) |\n";
3757 print "| l (list hosts) |\n";
3758 print "| d (done) |\n";
3759 print "`-------------------------'\n";
3761 print "[ldap] command (?=help) > ";
3763 $input =~ s/[\r\n]//g;
3768 print "Some of our developers have come up with very good javascript interface\n";
3769 print "for searching through address books, however, our original goals said\n";
3770 print "that we would be 100% HTML. In order to make it possible to use their\n";
3771 print "interface, and yet stick with our goals, we have also written a plain\n";
3772 print "HTML version of the search. Here, you can choose which version to use.\n";
3774 print "This is just the default value. It is also a user option that each\n";
3775 print "user can configure individually\n";
3778 if ( lc($default_use_javascript_addr_book) eq 'true' ) {
3779 $default_value = "y";
3781 $default_use_javascript_addr_book = 'false';
3782 $default_value = "n";
3784 print "Use javascript version by default (y/n) [$WHT$default_value$NRM]: $WHT";
3785 $new_show = <STDIN
>;
3786 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3787 $default_use_javascript_addr_book = 'true';
3789 $default_use_javascript_addr_book = 'false';
3791 return $default_use_javascript_addr_book;
3794 # global filebased address book
3796 print "If you want to use global file address book, then you\n";
3797 print "must set this option to a valid value. If option does\n";
3798 print "not have path elements, system assumes that file is\n";
3799 print "stored in data directory. If relative path is set, it is\n";
3800 print "relative to main SquirrelMail directory. If value is empty,\n";
3801 print "address book is not enabled.\n";
3804 print "[$WHT$abook_global_file$NRM]: $WHT";
3805 $new_abook_global_file = <STDIN
>;
3806 if ( $new_abook_global_file eq "\n" ) {
3807 $new_abook_global_file = $abook_global_file;
3809 $new_abook_global_file =~ s/[\r\n]//g;
3811 return $new_abook_global_file;
3814 # writing into global filebased abook control
3816 print "This setting controls writing into global file address\n";
3817 print "book options. Address book file must be writeable by\n";
3818 print "webserver's user, if you want to enable this option.\n";
3821 if ( lc($abook_global_file_writeable) eq 'true' ) {
3822 $default_value = "y";
3824 $abook_global_file_writeable = 'false';
3825 $default_value = "n";
3827 print "Allow writing into global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
3828 $new_show = <STDIN
>;
3829 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3830 $abook_global_file_writeable = 'true';
3832 $abook_global_file_writeable = 'false';
3834 return $abook_global_file_writeable;
3837 # listing of global filebased abook control
3839 print "This setting controls listing of global file address\n";
3840 print "book in addresses page.\n";
3843 if ( lc($abook_global_file_listing) eq 'true' ) {
3844 $default_value = "y";
3846 $abook_global_file_listing = 'false';
3847 $default_value = "n";
3849 print "Allow listing of global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
3850 $new_show = <STDIN
>;
3851 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3852 $abook_global_file_listing = 'true';
3854 $abook_global_file_listing = 'false';
3856 return $abook_global_file_listing;
3859 # controls $abook_file_line_length setting
3860 sub command_abook_file_line_length
{
3861 print "This setting controls space allocated to file based address book records.\n";
3862 print "End users will be unable to save address book entry, if total entry size \n";
3863 print "(quoted address book fields + 4 delimiters + linefeed) exceeds allowed \n";
3864 print "address book length size.\n";
3866 print "Same setting is applied to personal and global file based address books.\n";
3868 print "It is strongly recommended to keep default setting value. Change it only\n";
3869 print "if you really want to store address book entries that are bigger than two\n";
3870 print "kilobytes (2048).\n";
3873 print "Enter allowed address book line length [$abook_file_line_length]: ";
3876 # value is not modified, if user hits Enter or enters space
3878 # make sure that input is numeric
3879 if ($tmp =~ /^\d+$/) {
3880 $abook_file_line_length = $tmp;
3882 print "If you want to change this setting, you must enter number.\n";
3883 print "If you want to keep original setting - enter space.\n\n";
3884 print "Press Enter to continue...";
3891 print "If you want to store your users address book details in a database then\n";
3892 print "you need to set this DSN to a valid value. The format for this is:\n";
3893 print "mysql://user:pass\@hostname/dbname\n";
3894 print "Where mysql can be one of the databases PHP supports, the most common\n";
3895 print "of these are mysql, msql and pgsql.\n";
3896 print "Please ensure proper permissions for config.php when including\n";
3897 print "sensitive passwords.\n\n";
3898 print "If the DSN is left empty (hit space and then return) the database\n";
3899 print "related code for address books will not be used.\n";
3902 if ( $addrbook_dsn eq "" ) {
3903 $default_value = "Disabled";
3905 $default_value = $addrbook_dsn;
3907 print "[$WHT$addrbook_dsn$NRM]: $WHT";
3909 if ( $new_dsn eq "\n" ) {
3912 $new_dsn =~ s/[\r\n]//g;
3913 $new_dsn =~ s/^\s+$//g;
3919 print "This is the name of the table you want to store the address book\n";
3920 print "data in, it defaults to 'address'\n";
3922 print "[$WHT$addrbook_table$NRM]: $WHT";
3923 $new_table = <STDIN
>;
3924 if ( $new_table eq "\n" ) {
3925 $new_table = $addrbook_table;
3927 $new_table =~ s/[\r\n]//g;
3933 print "If you want to store your users preferences in a database then\n";
3934 print "you need to set this DSN to a valid value. The format for this is:\n";
3935 print "mysql://user:pass\@hostname/dbname\n";
3936 print "Where mysql can be one of the databases PHP supports, the most common\n";
3937 print "of these are mysql, msql and pgsql.\n";
3938 print "Please ensure proper permissions for config.php when including\n";
3939 print "sensitive passwords.\n\n";
3940 print "If the DSN is left empty (hit space and then return) the database\n";
3941 print "related code for address books will not be used.\n";
3944 if ( $prefs_dsn eq "" ) {
3945 $default_value = "Disabled";
3947 $default_value = $prefs_dsn;
3949 print "[$WHT$prefs_dsn$NRM]: $WHT";
3951 if ( $new_dsn eq "\n" ) {
3954 $new_dsn =~ s/[\r\n]//g;
3955 $new_dsn =~ s/^\s+$//g;
3961 print "This is the name of the table you want to store the preferences\n";
3962 print "data in, it defaults to 'userprefs'\n";
3964 print "[$WHT$prefs_table$NRM]: $WHT";
3965 $new_table = <STDIN
>;
3966 if ( $new_table eq "\n" ) {
3967 $new_table = $prefs_table;
3969 $new_table =~ s/[\r\n]//g;
3975 print "This is the name of the field in which you want to store the\n";
3976 print "username of the person the prefs are for. It default to 'user'\n";
3977 print "which clashes with a reserved keyword in PostgreSQL so this\n";
3978 print "will need to be changed for that database at least\n";
3980 print "[$WHT$prefs_user_field$NRM]: $WHT";
3981 $new_field = <STDIN
>;
3982 if ( $new_field eq "\n" ) {
3983 $new_field = $prefs_user_field;
3985 $new_field =~ s/[\r\n]//g;
3987 $prefs_user_size = db_pref_size
($prefs_user_size);
3992 print "This is the name of the field in which you want to store the\n";
3993 print "preferences keyword. It defaults to 'prefkey'\n";
3995 print "[$WHT$prefs_key_field$NRM]: $WHT";
3996 $new_field = <STDIN
>;
3997 if ( $new_field eq "\n" ) {
3998 $new_field = $prefs_key_field;
4000 $new_field =~ s/[\r\n]//g;
4002 $prefs_key_size = db_pref_size
($prefs_key_size);
4007 print "This is the name of the field in which you want to store the\n";
4008 print "preferences value. It defaults to 'prefval'\n";
4010 print "[$WHT$prefs_val_field$NRM]: $WHT";
4011 $new_field = <STDIN
>;
4012 if ( $new_field eq "\n" ) {
4013 $new_field = $prefs_val_field;
4015 $new_field =~ s/[\r\n]//g;
4017 $prefs_val_size = db_pref_size
($prefs_val_size);
4021 # routine is used to set database field limits
4022 # it needs one argument
4023 sub db_pref_size
() {
4025 print "\nDatabase fields have size limits.\n";
4027 print "What limit is set for this field? [$WHT$size$NRM]: $WHT";
4028 $new_size = <STDIN
>;
4029 if ( $new_size eq "\n" ) {
4032 $new_size =~ s/[\r\n]//g;
4038 print "If you want to store your global address book in a database then\n";
4039 print "you need to set this DSN to a valid value. The format for this is:\n";
4040 print "mysql://user:pass\@hostname/dbname\n";
4041 print "Where mysql can be one of the databases PHP supports, the most common\n";
4042 print "of these are mysql, msql and pgsql.\n";
4043 print "Please ensure proper permissions for config.php when including\n";
4044 print "sensitive passwords.\n\n";
4045 print "If the DSN is left empty (hit space and then return) the database\n";
4046 print "related code for global SQL address book will not be used.\n";
4049 if ( $addrbook_global_dsn eq "" ) {
4050 $default_value = "Disabled";
4052 $default_value = $addrbook_global_dsn;
4054 print "[$WHT$addrbook_global_dsn$NRM]: $WHT";
4056 if ( $new_dsn eq "\n" ) {
4059 $new_dsn =~ s/[\r\n]//g;
4060 $new_dsn =~ s/^\s+$//g;
4066 print "This is the name of the table you want to store the global address book\n";
4067 print "data in. Default table name is 'global_abook'. Address book uses same\n";
4068 print "database format as personal address book.\n";
4070 print "[$WHT$addrbook_global_table$NRM]: $WHT";
4071 $new_table = <STDIN
>;
4072 if ( $new_table eq "\n" ) {
4073 $new_table = $addrbook_global_table;
4075 $new_table =~ s/[\r\n]//g;
4081 print "This option controls users\' ability to add or modify records stored \n";
4082 print "in global address book\n";
4084 if ( lc($addrbook_global_writeable) eq 'true' ) {
4085 $default_value = "y";
4087 $default_value = "n";
4089 print "Allow writing into global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
4090 $addrbook_global_writeable = <STDIN
>;
4091 if ( ( $addrbook_global_writeable =~ /^y\n/i ) || ( ( $addrbook_global_writeable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4092 $addrbook_global_writeable = 'true';
4094 $addrbook_global_writeable = 'false';
4096 return $addrbook_global_writeable;
4100 print "Enable this option if you want to see listing of addresses stored \n";
4101 print "in global address book\n";
4103 if ( lc($addrbook_global_listing) eq 'true' ) {
4104 $default_value = "y";
4106 $default_value = "n";
4108 print "Allow listing of global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
4109 $addrbook_global_listing = <STDIN
>;
4110 if ( ( $addrbook_global_listing =~ /^y\n/i ) || ( ( $addrbook_global_listing =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4111 $addrbook_global_listing = 'true';
4113 $addrbook_global_listing = 'false';
4115 return $addrbook_global_listing;
4121 print "SquirrelMail attempts to set the language in many ways. If it\n";
4122 print "can not figure it out in another way, it will default to this\n";
4123 print "language. Please use the code for the desired language.\n";
4125 print "[$WHT$squirrelmail_default_language$NRM]: $WHT";
4126 $new_squirrelmail_default_language = <STDIN
>;
4127 if ( $new_squirrelmail_default_language eq "\n" ) {
4128 $new_squirrelmail_default_language = $squirrelmail_default_language;
4130 $new_squirrelmail_default_language =~ s/[\r\n]//g;
4131 $new_squirrelmail_default_language =~ s/^\s+$//g;
4133 return $new_squirrelmail_default_language;
4137 print "This option controls what character set is used when sending\n";
4138 print "mail and when sending HTML to the browser. Option works only\n";
4139 print "with US English (en_US) translation. Other translations use\n";
4140 print "charsets that are set in translation settings.\n";
4143 print "[$WHT$default_charset$NRM]: $WHT";
4144 $new_default_charset = <STDIN
>;
4145 if ( $new_default_charset eq "\n" ) {
4146 $new_default_charset = $default_charset;
4148 $new_default_charset =~ s/[\r\n]//g;
4150 return $new_default_charset;
4152 # Alternative language names
4154 print "Enable this option if you want to see localized language names in\n";
4155 print "language selection box. Note, that this option can trigger\n";
4156 print "installation of foreign language support modules in some browsers.\n";
4159 if ( lc($show_alternative_names) eq 'true' ) {
4160 $default_value = "y";
4162 $default_value = "n";
4164 print "Show alternative language names? (y/n) [$WHT$default_value$NRM]: $WHT";
4165 $show_alternative_names = <STDIN
>;
4166 if ( ( $show_alternative_names =~ /^y\n/i ) || ( ( $show_alternative_names =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4167 $show_alternative_names = 'true';
4169 $show_alternative_names = 'false';
4171 return $show_alternative_names;
4174 # Aggressive decoding
4176 print "Enable this option if you want to use CPU and memory intensive decoding\n";
4177 print "functions. This option allows reading multibyte charset, that are used\n";
4178 print "in Eastern Asia. SquirrelMail will try to use recode functions here,\n";
4179 print "even when you have disabled use of recode in Tweaks section.\n";
4182 if ( lc($aggressive_decoding) eq 'true' ) {
4183 $default_value = "y";
4185 $default_value = "n";
4187 print "Enable aggressive decoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4188 $aggressive_decoding = <STDIN
>;
4189 if ( ( $aggressive_decoding =~ /^y\n/i ) || ( ( $aggressive_decoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4190 $aggressive_decoding = 'true';
4192 $aggressive_decoding = 'false';
4194 return $aggressive_decoding;
4199 print "Enable this option if you want to allow lossy charset encoding in message\n";
4200 print "composition pages. This option allows charset conversions when output\n";
4201 print "charset does not support all symbols used in original charset. Symbols\n";
4202 print "unsupported by output charset will be replaced with question marks.\n";
4205 if ( lc($lossy_encoding) eq 'true' ) {
4206 $default_value = "y";
4208 $default_value = "n";
4210 print "Enable lossy encoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4211 $lossy_encoding = <STDIN
>;
4212 if ( ( $lossy_encoding =~ /^y\n/i ) || ( ( $lossy_encoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4213 $lossy_encoding = 'true';
4215 $lossy_encoding = 'false';
4217 return $lossy_encoding;
4220 # display html emails in iframe
4222 print "This option can enable html email rendering inside iframe.\n";
4223 print "Inline frames are used in order to provide sandbox environment";
4224 print "for html code included in html formated emails.";
4225 print "Option is experimental and might have glitches in some parts of code.";
4228 if ( lc($use_iframe) eq 'true' ) {
4229 $default_value = "y";
4231 $default_value = "n";
4233 print "Display html emails in iframe? (y/n) [$WHT$default_value$NRM]: $WHT";
4234 $use_iframe = <STDIN
>;
4235 if ( ( $use_iframe =~ /^y\n/i ) || ( ( $use_iframe =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4236 $use_iframe = 'true';
4238 $use_iframe = 'false';
4244 sub command_ask_user_info
{
4245 print "New users need to supply their real name and email address to\n";
4246 print "send out proper mails. When this option is enabled, a user that\n";
4247 print "logs in for the first time will be redirected to the Personal\n";
4248 print "Options screen and asked to supply their personal data.\n";
4251 if ( lc($ask_user_info) eq 'true' ) {
4252 $default_value = "y";
4254 $default_value = "n";
4256 print "Ask user info? (y/n) [$WHT$default_value$NRM]: $WHT";
4257 $ask_user_info = <STDIN
>;
4258 if ( ( $ask_user_info =~ /^y\n/i ) || ( ( $ask_user_info =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4259 $ask_user_info = 'true';
4261 $ask_user_info = 'false';
4263 return $ask_user_info;
4268 print "Enabling this option will cause icons to be used instead of text\n";
4269 print "markers next to each message in mailbox lists that represent\n";
4270 print "new, read, flagged, and deleted messages, as well as those that\n";
4271 print "have been replied to and forwarded. Icons are also used next to\n";
4272 print "(un)expanded folders in the folder list (Oldway = false). These\n";
4273 print "icons are quite small, but will obviously be more of a resource\n";
4274 print "drain than text markers.\n";
4277 if ( lc($use_icons) eq 'true' ) {
4278 $default_value = "y";
4280 $default_value = "n";
4282 print "Use icons? (y/n) [$WHT$default_value$NRM]: $WHT";
4283 $use_icons = <STDIN
>;
4284 if ( ( $use_icons =~ /^y\n/i ) || ( ( $use_icons =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4285 $use_icons = 'true';
4287 $use_icons = 'false';
4293 print "Enable this option if you want to use php recode functions to read\n";
4294 print "emails written in charset that differs from the one that is set in\n";
4295 print "translation selected by user. Code is experimental, it might cause\n";
4296 print "errors, if email contains charset unsupported by recode or if your\n";
4297 print "php does not have recode support.\n";
4300 if ( lc($use_php_recode) eq 'true' ) {
4301 $default_value = "y";
4303 $default_value = "n";
4305 print "Use php recode functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4306 $use_php_recode = <STDIN
>;
4307 if ( ( $use_php_recode =~ /^y\n/i ) || ( ( $use_php_recode =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4308 $use_php_recode = 'true';
4310 $use_php_recode = 'false';
4312 return $use_php_recode;
4316 print "Enable this option if you want to use php iconv functions to read\n";
4317 print "emails written in charset that differs from the one that is set in\n";
4318 print "translation selected by user. Code is experimental, it works only\n";
4319 print "with translations that use utf-8 charset. Code might cause errors,\n";
4320 print "if email contains charset unsupported by iconv or if your php does\n";
4321 print "not have iconv support.\n";
4324 if ( lc($use_php_iconv) eq 'true' ) {
4325 $default_value = "y";
4327 $default_value = "n";
4329 print "Use php iconv functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4330 $use_php_iconv = <STDIN
>;
4331 if ( ( $use_php_iconv =~ /^y\n/i ) || ( ( $use_php_iconv =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4332 $use_php_iconv = 'true';
4334 $use_php_iconv = 'false';
4336 return $use_php_iconv;
4341 print "Enable this option if you want to check SquirrelMail configuration\n";
4342 print "remotely with configtest.php script.\n";
4345 if ( lc($allow_remote_configtest) eq 'true' ) {
4346 $default_value = "y";
4348 $default_value = "n";
4350 print "Allow remote configuration tests? (y/n) [$WHT$default_value$NRM]: $WHT";
4351 $allow_remote_configtest = <STDIN
>;
4352 if ( ( $allow_remote_configtest =~ /^y\n/i ) || ( ( $allow_remote_configtest =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4353 $allow_remote_configtest = 'true';
4355 $allow_remote_configtest = 'false';
4357 return $allow_remote_configtest;
4360 # Default Icon theme
4362 print "You may change the path to the default icon theme to be used, if icons\n";
4363 print "have been enabled. This theme will be used when an icon cannot be\n";
4364 print "found in the current theme, or when no icon theme is specified. If\n";
4365 print "left blank, and icons are enabled, the default theme will be used\n";
4366 print "from images/themes/default/.\n";
4368 print "To clear out an existing value, just type a space for the input.\n";
4370 print "Please be aware of the following: \n";
4371 print " - Relative URLs are relative to the config dir\n";
4372 print " to use the icon themes directory, use ../images/themes/newtheme/\n";
4373 print " - The icon theme may be outside the SquirrelMail directory, but\n";
4374 print " it must be web accessible.\n";
4375 print "[$WHT$icon_theme_def$NRM]: $WHT";
4376 $new_icon_theme_def = <STDIN
>;
4378 if ( $new_icon_theme_def eq "\n" ) {
4379 $new_icon_theme_def = $icon_theme_def;
4381 $new_icon_theme_def =~ s/[\r\n]//g;
4383 $new_icon_theme_def =~ s/^\s*//;
4384 return $new_icon_theme_def;
4387 # SquirrelMail debug mode (since 1.5.2)
4389 print "When debugging or developing SquirrelMail, you may want to increase\n";
4390 print "the verbosity of certain kinds of errors, notices, and/or diagnostics.\n";
4391 print "You may enable one or more of the debugging modes here. Please make\n";
4392 print "sure that you have turned off debugging if you are using SquirrelMail\n";
4393 print "in a production environment.\n\n";
4396 while ( $input ne "d\n" ) {
4397 $sm_debug_mode = convert_debug_constants_to_binary_integer
($sm_debug_mode);
4399 # per include/constants.php, here are the debug mode values:
4401 # 0 SM_DEBUG_MODE_OFF
4402 # 1 SM_DEBUG_MODE_SIMPLE
4403 # 512 SM_DEBUG_MODE_MODERATE
4404 # 524288 SM_DEBUG_MODE_ADVANCED
4405 # 536870912 SM_DEBUG_MODE_STRICT
4407 print "\n# Enabled? Description\n";
4408 print "---------------------------------------------------------------------\n";
4409 print "0 " . ($sm_debug_mode == 0 ?
"y" : " ")
4410 . " No debugging (recommended in production environments)\n";
4411 print "1 " . ($sm_debug_mode & 1 ?
"y" : " ")
4412 . " Simple debugging (PHP E_ERROR)\n";
4413 print "2 " . ($sm_debug_mode & 512 ?
"y" : " ")
4414 . " Moderate debugging (PHP E_ALL)\n";
4415 print "3 " . ($sm_debug_mode & 524288 ?
"y" : " ")
4416 . " Advanced debugging (PHP E_ALL plus log errors\n";
4417 print " intentionally suppressed)\n";
4418 print "4 " . ($sm_debug_mode & 536870912 ?
"y" : " ")
4419 . " Strict debugging (PHP E_STRICT)\n";
4422 print "SquirrelMail debug mode (0,1,2,3,4) or d when done? : $WHT";
4424 if ( $input eq "d\n" ) {
4426 } elsif ($input !~ /^[0-9]+\n$/) {
4427 print "\nInvalid configuration value.\n";
4428 print "\nPress enter to continue...";
4430 } elsif ( $input == "0\n" ) {
4432 } elsif ( $input == "1\n" ) {
4433 if ($sm_debug_mode & 1) {
4434 $sm_debug_mode ^= 1;
4436 $sm_debug_mode |= 1;
4438 } elsif ( $input == "2\n" ) {
4439 if ($sm_debug_mode & 512) {
4440 $sm_debug_mode ^= 512;
4442 $sm_debug_mode |= 512;
4444 } elsif ( $input == "3\n" ) {
4445 if ($sm_debug_mode & 524288) {
4446 $sm_debug_mode ^= 524288;
4448 $sm_debug_mode |= 524288;
4450 } elsif ( $input == "4\n" ) {
4451 if ($sm_debug_mode & 536870912) {
4452 $sm_debug_mode ^= 536870912;
4454 $sm_debug_mode |= 536870912;
4457 print "\nInvalid configuration value.\n";
4458 print "\nPress enter to continue...";
4463 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
4464 return $sm_debug_mode;
4467 # Secured configuration mode (since 1.5.2)
4469 print "This option allows you to enable \"Secured Configuration\" mode,\n";
4470 print "which will guarantee that certain settings made herein will be\n";
4471 print "made immutable and will not be subject to override by either friendly\n";
4472 print "or unfriendly code/plugins. Only a small number of settings herein\n";
4473 print "will be used in this manner - just those that are deemed to be a\n";
4474 print "potential security threat when rouge plugin or other code may be\n";
4475 print "executed inside SquirrelMail.\n";
4478 if ( lc($secured_config) eq 'true' ) {
4479 $default_value = "y";
4481 $default_value = "n";
4483 print "Enable secured configuration mode? (y/n) [$WHT$default_value$NRM]: $WHT";
4484 $secured_config = <STDIN
>;
4485 if ( ( $secured_config =~ /^y\n/i ) || ( ( $secured_config =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4486 $secured_config = 'true';
4488 $secured_config = 'false';
4490 return $secured_config;
4495 if ( open( CF
, ">config.php" ) ) {
4500 print CF
" * SquirrelMail Configuration File\n";
4501 print CF
" * Created using the configure script, conf.pl\n";
4505 if ($print_config_version) {
4506 print CF
"\$config_version = '$print_config_version';\n";
4509 print CF
"\$config_use_color = $config_use_color;\n";
4513 print CF
"\$org_name = \"$org_name\";\n";
4515 print CF
"\$org_logo = " . &change_to_SM_path
($org_logo) . ";\n";
4516 $org_logo_width |= 0;
4517 $org_logo_height |= 0;
4519 print CF
"\$org_logo_width = '$org_logo_width';\n";
4521 print CF
"\$org_logo_height = '$org_logo_height';\n";
4522 # string that can contain variables.
4523 print CF
"\$org_title = \"$org_title\";\n";
4525 print CF
"\$signout_page = " . &change_to_SM_path
($signout_page) . ";\n";
4527 print CF
"\$frame_top = '$frame_top';\n";
4530 print CF
"\$provider_uri = '$provider_uri';\n";
4533 print CF
"\$provider_name = '$provider_name';\n";
4536 # string that can contain variables
4537 print CF
"\$motd = \"$motd\";\n";
4541 print CF
"\$squirrelmail_default_language = '$squirrelmail_default_language';\n";
4543 print CF
"\$default_charset = '$default_charset';\n";
4545 print CF
"\$show_alternative_names = $show_alternative_names;\n";
4547 print CF
"\$aggressive_decoding = $aggressive_decoding;\n";
4549 print CF
"\$lossy_encoding = $lossy_encoding;\n";
4553 print CF
"\$domain = '$domain';\n";
4555 print CF
"\$imapServerAddress = '$imapServerAddress';\n";
4557 print CF
"\$imapPort = $imapPort;\n";
4559 print CF
"\$useSendmail = $useSendmail;\n";
4561 print CF
"\$smtpServerAddress = '$smtpServerAddress';\n";
4563 print CF
"\$smtpPort = $smtpPort;\n";
4565 print CF
"\$sendmail_path = '$sendmail_path';\n";
4567 print CF
"\$sendmail_args = '$sendmail_args';\n";
4569 # print CF "\$use_authenticated_smtp = $use_authenticated_smtp;\n";
4571 print CF
"\$pop_before_smtp = $pop_before_smtp;\n";
4573 print CF
"\$imap_server_type = '$imap_server_type';\n";
4575 print CF
"\$invert_time = $invert_time;\n";
4577 print CF
"\$optional_delimiter = '$optional_delimiter';\n";
4579 print CF
"\$encode_header_key = '$encode_header_key';\n";
4583 print CF
"\$default_folder_prefix = '$default_folder_prefix';\n";
4585 print CF
"\$trash_folder = '$trash_folder';\n";
4587 print CF
"\$sent_folder = '$sent_folder';\n";
4589 print CF
"\$draft_folder = '$draft_folder';\n";
4591 print CF
"\$default_move_to_trash = $default_move_to_trash;\n";
4593 print CF
"\$default_move_to_sent = $default_move_to_sent;\n";
4595 print CF
"\$default_save_as_draft = $default_save_as_draft;\n";
4597 print CF
"\$show_prefix_option = $show_prefix_option;\n";
4599 print CF
"\$list_special_folders_first = $list_special_folders_first;\n";
4601 print CF
"\$use_special_folder_color = $use_special_folder_color;\n";
4603 print CF
"\$auto_expunge = $auto_expunge;\n";
4605 print CF
"\$default_sub_of_inbox = $default_sub_of_inbox;\n";
4607 print CF
"\$show_contain_subfolders_option = $show_contain_subfolders_option;\n";
4609 print CF
"\$default_unseen_notify = $default_unseen_notify;\n";
4611 print CF
"\$default_unseen_type = $default_unseen_type;\n";
4613 print CF
"\$auto_create_special = $auto_create_special;\n";
4615 print CF
"\$delete_folder = $delete_folder;\n";
4617 print CF
"\$noselect_fix_enable = $noselect_fix_enable;\n";
4622 print CF
"\$data_dir = " . &change_to_SM_path
($data_dir) . ";\n";
4623 # string that can contain a variable
4624 print CF
"\$attachment_dir = " . &change_to_SM_path
($attachment_dir) . ";\n";
4626 print CF
"\$dir_hash_level = $dir_hash_level;\n";
4628 print CF
"\$default_left_size = '$default_left_size';\n";
4630 print CF
"\$force_username_lowercase = $force_username_lowercase;\n";
4632 print CF
"\$default_use_priority = $default_use_priority;\n";
4634 print CF
"\$hide_sm_attributions = $hide_sm_attributions;\n";
4636 print CF
"\$default_use_mdn = $default_use_mdn;\n";
4638 print CF
"\$edit_identity = $edit_identity;\n";
4640 print CF
"\$edit_name = $edit_name;\n";
4642 print CF
"\$hide_auth_header = $hide_auth_header;\n";
4644 print CF
"\$disable_thread_sort = $disable_thread_sort;\n";
4646 print CF
"\$disable_server_sort = $disable_server_sort;\n";
4648 print CF
"\$allow_charset_search = $allow_charset_search;\n";
4650 print CF
"\$allow_advanced_search = $allow_advanced_search;\n";
4653 print CF
"\$time_zone_type = $time_zone_type;\n";
4656 print CF
"\$config_location_base = '$config_location_base';\n";
4659 print CF
"\$disable_plugins = $disable_plugins;\n";
4661 print CF
"\$disable_plugins_user = '$disable_plugins_user';\n";
4664 # all plugins are strings
4665 for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
4666 print CF
"\$plugins[] = '$plugins[$ct]';\n";
4671 if ( $user_theme_default eq '' ) { $user_theme_default = '0'; }
4672 print CF
"\$user_theme_default = $user_theme_default;\n";
4674 for ( $count = 0 ; $count <= $#user_theme_name ; $count++ ) {
4675 if ($user_theme_path[$count] eq 'none') {
4678 $path = &change_to_SM_path
($user_theme_path[$count]);
4680 print CF
"\$user_themes[$count]['PATH'] = " . $path . ";\n";
4681 # escape theme name so it can contain single quotes.
4682 $esc_name = $user_theme_name[$count];
4683 $esc_name =~ s/\\/\\\\/g;
4684 $esc_name =~ s/'/\\'/g;
4685 print CF
"\$user_themes[$count]['NAME'] = '$esc_name';\n";
4689 if ( $icon_theme_def eq '' ) { $icon_theme_def = '0'; }
4690 print CF
"\$icon_theme_def = $icon_theme_def;\n";
4691 if ( $icon_theme_fallback eq '' ) { $icon_theme_fallback = '0'; }
4692 print CF
"\$icon_theme_fallback = $icon_theme_fallback;\n";
4694 for ( $count = 0 ; $count <= $#icon_theme_name ; $count++ ) {
4695 $path = $icon_theme_path[$count];
4696 if ($path eq 'none' || $path eq 'template') {
4697 $path = "'".$path."'";
4699 $path = &change_to_SM_path
($icon_theme_path[$count]);
4701 print CF
"\$icon_themes[$count]['PATH'] = " . $path . ";\n";
4702 # escape theme name so it can contain single quotes.
4703 $esc_name = $icon_theme_name[$count];
4704 $esc_name =~ s/\\/\\\\/g;
4705 $esc_name =~ s/'/\\'/g;
4706 print CF
"\$icon_themes[$count]['NAME'] = '$esc_name';\n";
4710 if ( $templateset_default eq '' ) { $templateset_default = 'default'; }
4711 print CF
"\$templateset_default = '$templateset_default';\n";
4713 if ( $templateset_fallback eq '' ) { $templateset_fallback = 'default'; }
4714 print CF
"\$templateset_fallback = '$templateset_fallback';\n";
4716 for ( $count = 0 ; $count <= $#templateset_name ; $count++ ) {
4717 print CF
"\$aTemplateSet[$count]['ID'] = '" . $templateset_id[$count] . "';\n";
4718 # escape theme name so it can contain single quotes.
4719 $esc_name = $templateset_name[$count];
4720 $esc_name =~ s/\\/\\\\/g;
4721 $esc_name =~ s/'/\\'/g;
4722 print CF
"\$aTemplateSet[$count]['NAME'] = '$esc_name';\n";
4728 print CF
"\$default_fontsize = '$default_fontsize';\n";
4730 print CF
"\$default_fontset = '$default_fontset';\n";
4732 # assoc. array (maybe initial value should be set somewhere else)
4733 print CF
'$fontsets = array();'."\n";
4734 while (($fontset_name, $fontset_value) = each(%fontsets)) {
4735 print CF
"\$fontsets\['$fontset_name'\] = '$fontset_value';\n";
4741 print CF
"\$default_use_javascript_addr_book = $default_use_javascript_addr_book;\n";
4742 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
4743 print CF
"\$ldap_server[$count] = array(\n";
4745 print CF
" 'host' => '$ldap_host[$count]',\n";
4747 print CF
" 'base' => '$ldap_base[$count]'";
4748 if ( $ldap_name[$count] ) {
4751 print CF
" 'name' => '$ldap_name[$count]'";
4753 if ( $ldap_port[$count] ) {
4756 print CF
" 'port' => $ldap_port[$count]";
4758 if ( $ldap_charset[$count] ) {
4761 print CF
" 'charset' => '$ldap_charset[$count]'";
4763 if ( $ldap_maxrows[$count] ) {
4766 print CF
" 'maxrows' => $ldap_maxrows[$count]";
4769 if ( $ldap_filter[$count] ) {
4771 print CF
" 'filter' => '$ldap_filter[$count]'";
4773 if ( $ldap_binddn[$count] ) {
4776 print CF
" 'binddn' => '$ldap_binddn[$count]'";
4777 if ( $ldap_bindpw[$count] ) {
4780 print CF
" 'bindpw' => '$ldap_bindpw[$count]'";
4783 if ( $ldap_protocol[$count] ) {
4786 print CF
" 'protocol' => $ldap_protocol[$count]";
4788 if ( $ldap_limit_scope[$count] ) {
4791 print CF
" 'limit_scope' => $ldap_limit_scope[$count]";
4793 if ( $ldap_listing[$count] ) {
4796 print CF
" 'listing' => $ldap_listing[$count]";
4798 if ( $ldap_writeable[$count] ) {
4801 print CF
" 'writeable' => $ldap_writeable[$count]";
4803 if ( $ldap_search_tree[$count] ) {
4806 print CF
" 'search_tree' => $ldap_search_tree[$count]";
4808 if ( $ldap_listing[$count] ) {
4811 print CF
" 'starttls' => $ldap_starttls[$count]";
4819 print CF
"\$addrbook_dsn = '$addrbook_dsn';\n";
4821 print CF
"\$addrbook_table = '$addrbook_table';\n\n";
4823 print CF
"\$prefs_dsn = '$prefs_dsn';\n";
4825 print CF
"\$prefs_table = '$prefs_table';\n";
4827 print CF
"\$prefs_user_field = '$prefs_user_field';\n";
4829 print CF
"\$prefs_user_size = $prefs_user_size;\n";
4831 print CF
"\$prefs_key_field = '$prefs_key_field';\n";
4833 print CF
"\$prefs_key_size = $prefs_key_size;\n";
4835 print CF
"\$prefs_val_field = '$prefs_val_field';\n";
4837 print CF
"\$prefs_val_size = $prefs_val_size;\n\n";
4839 print CF
"\$addrbook_global_dsn = '$addrbook_global_dsn';\n";
4841 print CF
"\$addrbook_global_table = '$addrbook_global_table';\n";
4843 print CF
"\$addrbook_global_writeable = $addrbook_global_writeable;\n";
4845 print CF
"\$addrbook_global_listing = $addrbook_global_listing;\n\n";
4847 print CF
"\$abook_global_file = '$abook_global_file';\n";
4849 print CF
"\$abook_global_file_writeable = $abook_global_file_writeable;\n\n";
4851 print CF
"\$abook_global_file_listing = $abook_global_file_listing;\n\n";
4853 print CF
"\$abook_file_line_length = $abook_file_line_length;\n\n";
4855 print CF
"\$no_list_for_subscribe = $no_list_for_subscribe;\n";
4858 print CF
"\$smtp_auth_mech = '$smtp_auth_mech';\n";
4859 print CF
"\$smtp_sitewide_user = '". quote_single
($smtp_sitewide_user) ."';\n";
4860 print CF
"\$smtp_sitewide_pass = '". quote_single
($smtp_sitewide_pass) ."';\n";
4862 print CF
"\$imap_auth_mech = '$imap_auth_mech';\n";
4864 print CF
"\$use_imap_tls = $use_imap_tls;\n";
4866 print CF
"\$use_smtp_tls = $use_smtp_tls;\n";
4868 print CF
"\$session_name = '$session_name';\n";
4870 print CF
"\$only_secure_cookies = $only_secure_cookies;\n";
4875 print CF
"\$use_iframe = $use_iframe;\n";
4877 print CF
"\$ask_user_info = $ask_user_info;\n";
4879 print CF
"\$use_icons = $use_icons;\n";
4882 print CF
"\$use_php_recode = $use_php_recode;\n";
4884 print CF
"\$use_php_iconv = $use_php_iconv;\n";
4887 print CF
"\$allow_remote_configtest = $allow_remote_configtest;\n";
4888 print CF
"\$secured_config = $secured_config;\n";
4889 # (binary) integer or constant - convert integer
4890 # values to constants before output
4891 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
4892 print CF
"\$sm_debug_mode = $sm_debug_mode;\n";
4897 print "Data saved in config.php\n";
4899 build_plugin_hook_array
();
4902 print "Error saving config.php: $!\n";
4908 print $WHT. "SquirrelMail Configuration : " . $NRM;
4909 if ( $config == 1 ) { print "Read: config.php"; }
4910 elsif ( $config == 2 ) { print "Read: config_default.php"; }
4912 print "---------------------------------------------------------\n";
4914 print "While we have been building SquirrelMail, we have discovered some\n";
4915 print "preferences that work better with some servers that don't work so\n";
4916 print "well with others. If you select your IMAP server, this option will\n";
4917 print "set some pre-defined settings for that server.\n";
4919 print "Please note that you will still need to go through and make sure\n";
4920 print "everything is correct. This does not change everything. There are\n";
4921 print "only a few settings that this will change.\n";
4925 while ( $continue != 1 ) {
4926 print "Please select your IMAP server:\n";
4927 print $list_supported_imap_servers;
4929 print " quit = Do not change anything\n";
4931 print "Command >> ";
4933 $server =~ s/[\r\n]//g;
4935 # variable is used to display additional messages.
4939 if ( $server eq "cyrus" ) {
4940 $imap_server_type = "cyrus";
4941 $default_folder_prefix = "";
4942 $trash_folder = "INBOX.Trash";
4943 $sent_folder = "INBOX.Sent";
4944 $draft_folder = "INBOX.Drafts";
4945 $show_prefix_option = false
;
4946 $default_sub_of_inbox = true
;
4947 $show_contain_subfolders_option = false
;
4948 $optional_delimiter = ".";
4949 $disp_default_folder_prefix = "<none>";
4950 $force_username_lowercase = false
;
4952 # Delimiter might differ if unixhierarchysep is set to yes.
4953 $message = "\nIf you have enabled unixhierarchysep, you must change delimiter and special folder names.\n";
4956 } elsif ( $server eq "uw" ) {
4957 $imap_server_type = "uw";
4958 $default_folder_prefix = "mail/";
4959 $trash_folder = "Trash";
4960 $sent_folder = "Sent";
4961 $draft_folder = "Drafts";
4962 $show_prefix_option = true
;
4963 $default_sub_of_inbox = false
;
4964 $show_contain_subfolders_option = true
;
4965 $optional_delimiter = "/";
4966 $disp_default_folder_prefix = $default_folder_prefix;
4967 $delete_folder = true
;
4968 $force_username_lowercase = true
;
4971 } elsif ( $server eq "exchange" ) {
4972 $imap_server_type = "exchange";
4973 $default_folder_prefix = "";
4974 $default_sub_of_inbox = true
;
4975 $trash_folder = "INBOX/Deleted Items";
4976 $sent_folder = "INBOX/Sent Items";
4977 $drafts_folder = "INBOX/Drafts";
4978 $show_prefix_option = false
;
4979 $show_contain_subfolders_option = false
;
4980 $optional_delimiter = "detect";
4981 $disp_default_folder_prefix = "<none>";
4982 $force_username_lowercase = true
;
4985 } elsif ( $server eq "courier" ) {
4986 $imap_server_type = "courier";
4987 $default_folder_prefix = "INBOX.";
4988 $trash_folder = "Trash";
4989 $sent_folder = "Sent";
4990 $draft_folder = "Drafts";
4991 $show_prefix_option = false
;
4992 $default_sub_of_inbox = false
;
4993 $show_contain_subfolders_option = false
;
4994 $optional_delimiter = ".";
4995 $disp_default_folder_prefix = $default_folder_prefix;
4996 $delete_folder = true
;
4997 $force_username_lowercase = false
;
5000 } elsif ( $server eq "macosx" ) {
5001 $imap_server_type = "macosx";
5002 $default_folder_prefix = "INBOX/";
5003 $trash_folder = "Trash";
5004 $sent_folder = "Sent";
5005 $draft_folder = "Drafts";
5006 $show_prefix_option = false
;
5007 $default_sub_of_inbox = true
;
5008 $show_contain_subfolders_option = false
;
5009 $optional_delimiter = "detect";
5010 $allow_charset_search = false
;
5011 $disp_default_folder_prefix = $default_folder_prefix;
5014 } elsif ( $server eq "hmailserver" ) {
5015 $imap_server_type = "hmailserver";
5016 $default_folder_prefix = "";
5017 $trash_folder = "INBOX.Trash";
5018 $sent_folder = "INBOX.Sent";
5019 $draft_folder = "INBOX.Drafts";
5020 $show_prefix_option = false
;
5021 $default_sub_of_inbox = true
;
5022 $show_contain_subfolders_option = false
;
5023 $optional_delimiter = "detect";
5024 $allow_charset_search = false
;
5025 $disp_default_folder_prefix = $default_folder_prefix;
5026 $delete_folder = false
;
5027 $force_username_lowercase = false
;
5030 } elsif ( $server eq "mercury32" ) {
5031 $imap_server_type = "mercury32";
5032 $default_folder_prefix = "";
5033 $trash_folder = "Trash";
5034 $sent_folder = "Sent";
5035 $draft_folder = "Drafts";
5036 $show_prefix_option = false
;
5037 $default_sub_of_inbox = true
;
5038 $show_contain_subfolders_option = true
;
5039 $optional_delimiter = "detect";
5040 $delete_folder = true
;
5041 $force_username_lowercase = true
;
5044 } elsif ( $server eq "dovecot" ) {
5045 $imap_server_type = "dovecot";
5046 $default_folder_prefix = "";
5047 $trash_folder = "Trash";
5048 $sent_folder = "Sent";
5049 $draft_folder = "Drafts";
5050 $show_prefix_option = false
;
5051 $default_sub_of_inbox = false
;
5052 $show_contain_subfolders_option = false
;
5053 $delete_folder = false
;
5054 $force_username_lowercase = true
;
5055 $optional_delimiter = "detect";
5056 $disp_default_folder_prefix = "<none>";
5059 } elsif ( $server eq "bincimap" ) {
5060 $imap_server_type = "bincimap";
5061 $default_folder_prefix = "INBOX/";
5062 $trash_folder = "Trash";
5063 $sent_folder = "Sent";
5064 $draft_folder = "Drafts";
5065 $show_prefix_option = false
;
5066 $default_sub_of_inbox = false
;
5067 $show_contain_subfolders_option = false
;
5068 $delete_folder = true
;
5069 $force_username_lowercase = false
;
5070 $optional_delimiter = "detect";
5071 $disp_default_folder_prefix = $default_folder_prefix;
5073 # Default folder prefix depends on used depot.
5074 $message = "\nIf you use IMAPdir depot, you must set default folder prefix to empty string.\n";
5077 } elsif ( $server eq "quit" ) {
5080 $disp_default_folder_prefix = $default_folder_prefix;
5081 print "Unrecognized server: $server\n";
5085 print " imap_server_type = $imap_server_type\n";
5086 print " default_folder_prefix = $disp_default_folder_prefix\n";
5087 print " trash_folder = $trash_folder\n";
5088 print " sent_folder = $sent_folder\n";
5089 print " draft_folder = $draft_folder\n";
5090 print " show_prefix_option = $show_prefix_option\n";
5091 print " default_sub_of_inbox = $default_sub_of_inbox\n";
5092 print "show_contain_subfolders_option = $show_contain_subfolders_option\n";
5093 print " optional_delimiter = $optional_delimiter\n";
5094 print " delete_folder = $delete_folder\n";
5095 print " force_username_lowercase = $force_username_lowercase\n";
5099 print "\nPress enter to continue...";
5103 # This subroutine corrects relative paths to ensure they
5104 # will work within the SM space. If the path falls within
5105 # the SM directory tree, the SM_PATH variable will be
5106 # prepended to the path, if not, then the path will be
5107 # converted to an absolute path, e.g.
5108 # '../images/logo.gif' --> SM_PATH . 'images/logo.gif'
5109 # '../../someplace/data' --> '/absolute/path/someplace/data'
5110 # 'images/logo.gif' --> SM_PATH . 'config/images/logo.gif'
5111 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
5112 # 'http://whatever/' --> 'http://whatever'
5113 # $some_var/path --> "$some_var/path"
5114 sub change_to_SM_path
() {
5115 my ($old_path) = @_;
5121 # If the path is absolute, don't bother.
5122 return "\'" . $old_path . "\'" if ( $old_path eq '');
5123 return "\'" . $old_path . "\'" if ( $old_path =~ /^(\/|http
)/ );
5124 return "\'" . $old_path . "\'" if ( $old_path =~ /^\w:\// );
5125 return $old_path if ( $old_path =~ /^\'(\/|http
)/ );
5126 return $old_path if ( $old_path =~ /^\'\w:\// );
5127 return $old_path if ( $old_path =~ /^SM_PATH/);
5129 if ( $old_path =~ /^\$/ ) {
5130 # check if it's a single var, or a $var/path combination
5131 # if it's $var/path, enclose in ""
5132 if ( $old_path =~ /\// ) {
5133 return '"'.$old_path.'"';
5138 # Remove remaining '
5139 $old_path =~ s/\'//g;
5141 # For relative paths, split on '../'
5142 @rel_path = split(/\.\.\//, $old_path);
5144 if ( $#rel_path > 1 ) {
5145 # more than two levels away. Make it absolute.
5146 @abs_path = split(/\//, $dir);
5148 # Lop off the relative pieces of the absolute path..
5149 for ( $i = 0; $i <= $#rel_path; $i++ ) {
5153 push @abs_path, @rel_path;
5154 $new_path = "\'" . join('/', @abs_path) . "\'";
5155 } elsif ( $#rel_path > 0 ) {
5156 # it's within the SM tree, prepend SM_PATH
5157 $new_path = $old_path;
5158 $new_path =~ s/^\.\.\//SM_PATH
. \'/;
5161 # Last, it's a relative path without any leading '.'
5162 # Prepend SM_PATH and config, since the paths are
5163 # relative to the config directory
5164 $new_path = "SM_PATH . \'config/" . $old_path . "\'";
5170 # Change SM_PATH to admin-friendly version, e.g.:
5171 # SM_PATH . 'images/logo.gif' --> '../images/logo.gif'
5172 # SM_PATH . 'config/some.php' --> 'some.php'
5173 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
5174 # 'http://whatever/' --> 'http://whatever'
5175 sub change_to_rel_path
() {
5176 my ($old_path) = @_;
5177 my $new_path = $old_path;
5179 if ( $old_path =~ /^SM_PATH/ ) {
5180 # FIXME: the following replacement loses the opening quote mark!
5181 $new_path =~ s/^SM_PATH . \'/\.\.\//;
5182 $new_path =~ s/\.\.\/config\///;
5188 # Attempts to auto-detect if a specific auth mechanism is supported.
5189 # Called by 'command112a' and 'command112b'
5190 # ARGS: service-name (IMAP or SMTP), host:port, mech-name (ie. CRAM-MD5)
5191 sub detect_auth_support
{
5192 # Try loading IO::Socket
5193 unless (eval("use IO::Socket; 1")) {
5194 print "Perl IO::Socket module is not available.";
5198 my $service = shift;
5202 if ((!defined($service)) or (!defined($host)) or (!defined($mech))) {
5203 # Error - wrong # of args
5204 print "BAD ARGS!\n";
5208 if ($service eq 'SMTP') {
5209 $cmd = "AUTH $mech\r\n";
5210 $logout = "QUIT\r\n";
5211 } elsif ($service eq 'IMAP') {
5212 $cmd = "A01 AUTHENTICATE $mech\n";
5213 $logout = "C01 LOGOUT\n";
5215 # unknown service - whoops.
5219 # Get this show on the road
5220 my $sock=IO
::Socket
::INET
->new($host);
5221 if (!defined($sock)) {
5225 my $discard = <$sock>; # Server greeting/banner - who cares..
5227 if ($service eq 'SMTP') {
5229 print $sock "HELO $domain\r\n";
5230 $discard = <$sock>; # Yeah yeah, you're happy to see me..
5234 my $response = <$sock>;
5236 if (!defined($response)) {
5240 # So at this point, we have a response, and it is (hopefully) valid.
5241 if ($service eq 'SMTP') {
5242 if (!($response =~ /^334/)) {
5244 print $sock $logout;
5248 } elsif ($service eq 'IMAP') {
5249 if ($response =~ /^A01/) {
5251 print $sock $logout;
5256 # Unknown service - this shouldn't be able to happen.
5261 # If it gets here, the mech is supported
5262 print $sock "*\n"; # Attempt to cancel authentication
5263 print $sock $logout; # Try to log out, but we don't really care if this fails
5269 # Example code from O'Reilly Perl Cookbook
5276 return wantarray ?
@out : $out[0];
5279 sub clear_screen
() {
5280 if ( $^O
=~ /^mswin/i) {
5287 # checks IMAP mailbox name. Refuses to accept 8bit folders
5288 # returns 0 (folder name is not correct) or 1 (folder name is correct)
5289 sub check_imap_folder
($) {
5290 my $folder_name = shift(@_);
5292 if ($folder_name =~ /[\x80-\xFFFF]/) {
5293 print "Folder name contains 8bit characters. Configuration utility requires\n";
5294 print "UTF7-IMAP encoded folder names.\n";
5295 print "Press enter to continue...";
5298 } elsif ($folder_name =~ /[&\*\%]/) {
5299 # check for ampersand and list-wildcards
5300 print "Folder name contains special UTF7-IMAP characters.\n";
5301 print "Are you sure that folder name is correct? (y/N): ";
5303 $tmp = lc(trim
($tmp));
5304 if ($tmp =~ /^y$/) {
5314 # quotes string written in single quotes
5315 sub quote_single
($) {
5316 my $string = shift(@_);
5317 $string =~ s/\'/\\'/g;
5321 # determine a plugin's version number
5323 # parses the setup.php file, looking for the
5324 # version string in the <plugin>_info() or the
5325 # <plugin>_version functions.
5327 sub get_plugin_version
() {
5329 my $plugin_name = shift(@_);
5331 $setup_file = '../plugins/' . $plugin_name . '/setup.php';
5332 if ( -e
"$setup_file" ) {
5333 # Make sure that file is readable
5334 if (! -r
"$setup_file") {
5337 print "The file \"$setup_file\" was found, but you don't\n";
5338 print "have rights to read it. The plugin \"";
5339 print $plugin_name . "\" may not work correctly until you fix this.\n";
5340 print "\nPress enter to continue";
5347 # FIXME: grep the file instead of reading it into memory?
5349 open( FILE
, "$setup_file" );
5350 while ( $line = <FILE
> ) {
5351 $whole_file .= $line;
5355 # ideally, there is a version in the <plugin>_info function...
5357 if ($whole_file =~ /('version'\s*=>\s*['"](.*?)['"])/) {
5360 # this assumes there is only one function that returns
5361 # a static string in the setup file
5363 } elsif ($whole_file =~ /(return\s*['"](.*?)['"])/) {
5372 print "The file \"$setup_file\" was not found.\n";
5373 print "The plugin \"" . $plugin_name;
5374 print "\" may not work correctly until you fix this.\n";
5375 print "\nPress enter to continue";
5383 # determine a plugin's English name
5385 # parses the setup.php file, looking for the
5386 # English name in the <plugin>_info() function.
5388 sub get_plugin_english_name
() {
5390 my $plugin_name = shift(@_);
5392 $setup_file = '../plugins/' . $plugin_name . '/setup.php';
5393 if ( -e
"$setup_file" ) {
5394 # Make sure that file is readable
5395 if (! -r
"$setup_file") {
5398 print "The file \"$setup_file\" was found, but you don't\n";
5399 print "have rights to read it. The plugin \"";
5400 print $plugin_name . "\" may not work correctly until you fix this.\n";
5401 print "\nPress enter to continue";
5408 # FIXME: grep the file instead of reading it into memory?
5410 open( FILE
, "$setup_file" );
5411 while ( $line = <FILE
> ) {
5412 $whole_file .= $line;
5416 # the English name is in the <plugin>_info function or nothing...
5418 if ($whole_file =~ /('english_name'\s*=>\s*['"](.*?)['"])/) {
5419 $english_name .= $2;
5422 return $english_name;
5427 print "The file \"$setup_file\" was not found.\n";
5428 print "The plugin \"" . $plugin_name;
5429 print "\" may not work correctly until you fix this.\n";
5430 print "\nPress enter to continue";
5438 # parses the setup.php files for all activated plugins and
5439 # builds static plugin hooks array so we don't have to load
5440 # ALL plugins are runtime and build the hook array on every
5443 # hook array is saved in config/plugin_hooks.php
5445 # Note the $verbose variable at the top of this routine
5446 # can be set to zero to quiet it down.
5448 # NOTE/FIXME: we aren't necessarily interested in writing
5449 # a full-blown PHP parsing engine, so plenty
5450 # of assumptions are included herein about the
5451 # coding of the plugin setup files, and things
5452 # like commented out curly braces or other
5453 # such oddities can break this in a bad way.
5455 sub build_plugin_hook_array
() {
5463 if ( open( HOOKFILE
, ">plugin_hooks.php" ) ) {
5464 print HOOKFILE
"<?php\n";
5465 print HOOKFILE
"\n";
5467 print HOOKFILE
"/**\n";
5468 print HOOKFILE
" * SquirrelMail Plugin Hook Registration File\n";
5469 print HOOKFILE
" * Auto-generated using the configure script, conf.pl\n";
5470 print HOOKFILE
" */\n";
5471 print HOOKFILE
"\n";
5472 print HOOKFILE
"global \$squirrelmail_plugin_hooks;\n";
5473 print HOOKFILE
"\n";
5475 PLUGIN
: for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
5478 print "Activating plugin \"" . $plugins[$ct] . "\"...\n";
5481 $setup_file = '../plugins/' . $plugins[$ct] . '/setup.php';
5482 if ( -e
"$setup_file" ) {
5483 # Make sure that file is readable
5484 if (! -r
"$setup_file") {
5487 print "The file \"$setup_file\" was found, but you don't\n";
5488 print "have rights to read it. The plugin \"";
5489 print $plugins[$ct] . "\" will not be activated until you fix this.\n";
5490 print "\nPress enter to continue";
5495 open( FILE
, "$setup_file" );
5496 $inside_init_fxn = 0;
5498 while ( $line = <FILE
> ) {
5500 # throw away lines until we get to target function
5502 if (!$inside_init_fxn
5503 && $line !~ /^\s*function\s*squirrelmail_plugin_init_/i) {
5506 $inside_init_fxn = 1;
5516 # count close braces
5521 # leaving <plugin>_init() function...
5522 if ($brace_count == 0) {
5530 # throw away lines that are not exactly one "brace set" deep
5532 if ($brace_count > 1) {
5537 # also not interested in lines that are not
5538 # hook registration points
5540 if ($line !~ /^\s*\$squirrelmail_plugin_hooks/i) {
5545 # if $line does not have an ending semicolon,
5546 # we need to recursively read in subsequent
5547 # lines until we find one
5548 while ( $line !~ /;\s*$/ ) {
5549 $line =~ s/[\n\r]\s*$//;
5558 $var =~ s/=/EQUALS/;
5559 if ( $var =~ /^([a-z])/i ) {
5560 @options = split ( /\s*EQUALS\s*/, $var );
5561 $options[1] =~ s/[\n\r]//g;
5562 $options[1] =~ s/[\'\"];\s*$//;
5563 $options[1] =~ s/;$//;
5564 $options[1] =~ s/^[\'\"]//;
5565 # de-escape escaped strings
5566 $options[1] =~ s/\\'/'/g;
5567 $options[1] =~ s/\\\\/\\/g;
5569 if ( $options[0] =~ /^squirrelmail_plugin_hooks\s*\[\s*['"]([a-z0-9 \/._
*-]+)['"]\s*\]\s*\[\s*['"]([0-9a-z._-]+)['"]\s
*\
]/i
) {
5571 $hooked_plugin_name = $2;
5572 # Note: if we wanted to stop plugins from registering
5573 # a *different* plugin on a hook, we could catch
5574 # it here, however this has actually proven to be
5575 # a useful *feature*
5576 #if ($hooked_plugin_name ne $plugins[$ct]) {
5577 # print "...plugin is tring to hook in under different name...\n";
5580 #FIXME: do we want to count the number of hook registrations for each plugin and warn if a plugin doesn't have any?
5581 # hook registration has been found!
5583 if ($hooked_plugin_name ne $plugins[$ct]) {
5584 print " registering on hook \"" . $hook_name . "\" (as \"$hooked_plugin_name\" plugin)\n";
5586 print " registering on hook \"" . $hook_name . "\"\n";
5589 $line =~ s/ {2,}/ /g;
5591 print HOOKFILE
"\$$line";
5603 print "The file \"$setup_file\" was not found.\n";
5604 print "The plugin \"" . $plugins[$ct];
5605 print "\" will not be activated until you fix this.\n";
5606 print "\nPress enter to continue";
5614 print HOOKFILE
"\n\n";
5617 print "\nDone activating plugins; registration data saved in plugin_hooks.php\n\n";
5624 print "The file \"plugin_hooks.php\" was not able to be written to.\n";
5625 print "No plugins will be activated until you fix this.\n";
5626 print "\nPress enter to continue";
5634 # converts (binary) integer values that correspond
5635 # to the SquirrelMail debug mode constants (see
5636 # include/constants.php) into those constant strings
5637 # (bitwise or'd if more than one is enabled)
5639 # if the value passed in is not an integer, it is
5640 # returned unmolested
5642 sub convert_debug_binary_integer_to_constants
() {
5644 my ($debug_mode) = @_;
5645 if ($debug_mode =~ /^[^0-9]/) {
5648 $debug_mode = int($debug_mode);
5649 $new_debug_mode = '';
5651 # per include/constants.php, here are their values:
5653 # 0 SM_DEBUG_MODE_OFF
5654 # 1 SM_DEBUG_MODE_SIMPLE
5655 # 512 SM_DEBUG_MODE_MODERATE
5656 # 524288 SM_DEBUG_MODE_ADVANCED
5657 # 536870912 SM_DEBUG_MODE_STRICT
5659 if ($debug_mode & 1) {
5660 $new_debug_mode .= ' | SM_DEBUG_MODE_SIMPLE';
5662 if ($debug_mode & 512) {
5663 $new_debug_mode .= ' | SM_DEBUG_MODE_MODERATE';
5665 if ($debug_mode & 524288) {
5666 $new_debug_mode .= ' | SM_DEBUG_MODE_ADVANCED';
5668 if ($debug_mode & 536870912) {
5669 $new_debug_mode .= ' | SM_DEBUG_MODE_STRICT';
5672 $new_debug_mode =~ s/^ \| //;
5673 if (!$new_debug_mode) {
5674 $new_debug_mode = 'SM_DEBUG_MODE_OFF';
5677 return $new_debug_mode;
5680 # converts SquirrelMail debug mode constants (see
5681 # include/constants.php) into their corresponding
5682 # (binary) integer values
5684 # if the value passed in is an integer already, it
5685 # is returned unmolested
5687 sub convert_debug_constants_to_binary_integer
() {
5689 my ($debug_mode) = @_;
5690 if ($debug_mode =~ /^[0-9]/) {
5693 $new_debug_mode = 0;
5695 # per include/constants.php, here are their values:
5697 # 0 SM_DEBUG_MODE_OFF
5698 # 1 SM_DEBUG_MODE_SIMPLE
5699 # 512 SM_DEBUG_MODE_MODERATE
5700 # 524288 SM_DEBUG_MODE_ADVANCED
5701 # 536870912 SM_DEBUG_MODE_STRICT
5703 if ($debug_mode =~ /\bSM_DEBUG_MODE_OFF\b/) {
5704 $new_debug_mode = 0;
5706 if ($debug_mode =~ /\bSM_DEBUG_MODE_SIMPLE\b/) {
5707 $new_debug_mode |= 1;
5709 if ($debug_mode =~ /\bSM_DEBUG_MODE_MODERATE\b/) {
5710 $new_debug_mode |= 512;
5712 if ($debug_mode =~ /\bSM_DEBUG_MODE_ADVANCED\b/) {
5713 $new_debug_mode |= 524288;
5715 if ($debug_mode =~ /\bSM_DEBUG_MODE_STRICT\b/) {
5716 $new_debug_mode |= 536870912;
5719 return $new_debug_mode;
5722 # Function to print n column numbered lists
5724 # WARNING: the names in the list will be truncated
5725 # to fit in their respective columns based on the
5726 # screen width and number of columns.
5728 # Expected arguments (in this order):
5730 # * The start number to use for the list
5731 # * The number of columns to use
5732 # * The screen width
5733 # * Boolean (zero/one), indicating
5734 # whether or not to show item numbers
5735 # * The list of strings to be shown
5737 # Returns: The number printed on screen of the last item in the list
5739 sub print_multi_col_list
{
5740 my ($num, $cols, $screen_width, $show_numbering, @list) = @_;
5750 $rows = int(@list / $cols);
5751 if (@list % $cols) { $rows++; }
5752 if ($show_numbering) { $col_width = int(($screen_width - 2) / $cols) - 5; }
5753 else { $col_width = int(($screen_width - 2) / $cols) - 2; }
5755 # build the layout array so numbers run down each column
5757 for ( $x = 0; $x < @list; $x++ ) {
5759 $layout[$row_cnt][$col_cnt] = $list[$x];
5760 $numbers[$row_cnt][$col_cnt] = $num++;
5762 # move to next column
5764 if ($row_cnt == $rows - 1) {
5768 else { $row_cnt++; }
5772 # if we filled up fewer rows than needed, recalc column width
5774 if ($rows * $col_cnt == @list) { $col_cnt--; } # loop above ended right after increment
5775 if ($col_cnt + 1 < $cols) {
5776 if ($show_numbering) { $col_width = int(($screen_width - 2) / ($col_cnt + 1)) - 5; }
5777 else { $col_width = int(($screen_width - 2) / ($col_cnt + 1)) - 2; }
5783 for ( $row_cnt = 0; $row_cnt <= $rows; $row_cnt++ ) {
5789 # iterate columns for this row
5791 for ( $col_cnt = 0; $col_cnt <= $cols; $col_cnt++ ) {
5792 if ($layout[$row_cnt][$col_cnt]) {
5794 if ($show_numbering) { printf "$WHT% 2u.$NRM", $numbers[$row_cnt][$col_cnt]; }
5795 printf " %-$col_width." . $col_width . "s", $layout[$row_cnt][$col_cnt];