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 $pop_before_smtp_host = '' if ( !$pop_before_smtp_host );
376 $default_unseen_notify = 2 if ( !$default_unseen_notify );
377 $default_unseen_type = 1 if ( !$default_unseen_type );
378 $config_use_color = 0 if ( !$config_use_color );
379 $invert_time = 'false' if ( !$invert_time );
380 $force_username_lowercase = 'false' if ( !$force_username_lowercase );
381 $optional_delimiter = "detect" if ( !$optional_delimiter );
382 $auto_create_special = 'false' if ( !$auto_create_special );
383 $default_use_priority = 'true' if ( !$default_use_priority );
384 $default_use_mdn = 'true' if ( !$default_use_mdn );
385 $delete_folder = 'false' if ( !$delete_folder );
386 $noselect_fix_enable = 'false' if ( !$noselect_fix_enable );
387 $frame_top = "_top" if ( !$frame_top );
388 $provider_uri = '' if ( !$provider_uri );
389 $provider_name = '' if ( !$provider_name || $provider_name eq 'SquirrelMail');
390 $no_list_for_subscribe = 'false' if ( !$no_list_for_subscribe );
391 $allow_charset_search = 'true' if ( !$allow_charset_search );
392 $allow_advanced_search = 0 if ( !$allow_advanced_search) ;
393 $prefs_user_field = 'user' if ( !$prefs_user_field );
394 $prefs_key_field = 'prefkey' if ( !$prefs_key_field );
395 $prefs_val_field = 'prefval' if ( !$prefs_val_field );
396 $session_name = 'SQMSESSID' if ( !$session_name );
397 $skip_SM_header = 'false' if ( !$skip_SM_header );
398 $default_use_javascript_addr_book = 'false' if (! $default_use_javascript_addr_book);
401 $hide_sm_attributions = 'false' if ( !$hide_sm_attributions );
403 $edit_identity = 'true' if ( !$edit_identity );
404 $edit_name = 'true' if ( !$edit_name );
407 $use_smtp_tls= 'false' if ( !$use_smtp_tls);
408 $smtp_auth_mech = 'none' if ( !$smtp_auth_mech );
409 $use_imap_tls = 'false' if ( !$use_imap_tls );
410 $imap_auth_mech = 'login' if ( !$imap_auth_mech );
413 $show_alternative_names = 'false' if ( !$show_alternative_names );
414 # $available_languages option available only in 1.5.0. removed due to $languages
415 # implementation changes. options are provided by limit_languages plugin
416 # $available_languages = 'all' if ( !$available_languages );
417 $aggressive_decoding = 'false' if ( !$aggressive_decoding );
418 # available only in 1.5.0 and 1.5.1
419 # $advanced_tree = 'false' if ( !$advanced_tree );
420 $use_php_recode = 'false' if ( !$use_php_recode );
421 $use_php_iconv = 'false' if ( !$use_php_iconv );
424 $use_icons = 'false' if ( !$use_icons );
425 $use_iframe = 'false' if ( !$use_iframe );
426 $lossy_encoding = 'false' if ( !$lossy_encoding );
427 $allow_remote_configtest = 'false' if ( !$allow_remote_configtest );
428 $secured_config = 'true' if ( !$secured_config );
430 $sm_debug_mode = 'SM_DEBUG_MODE_MODERATE' if ( !$sm_debug_mode );
431 #FIXME: When this is STABLE software, remove the line above and uncomment the one below:
432 #$sm_debug_mode = 'SM_DEBUG_MODE_OFF' if ( !$sm_debug_mode );
433 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
435 $addrbook_global_table = 'global_abook' if ( !$addrbook_global_table );
436 $addrbook_global_writeable = 'false' if ( !$addrbook_global_writeable );
437 $addrbook_global_listing = 'false' if ( !$addrbook_global_listing );
438 $abook_global_file = '' if ( !$abook_global_file);
439 $abook_global_file_writeable = 'false' if ( !$abook_global_file_writeable);
440 $abook_global_file_listing = 'true' if ( !$abook_global_file_listing );
441 $encode_header_key = '' if ( !$encode_header_key );
442 $hide_auth_header = 'false' if ( !$hide_auth_header );
443 $time_zone_type = '0' if ( !$time_zone_type );
444 $prefs_user_size = 128 if ( !$prefs_user_size );
445 $prefs_key_size = 64 if ( !$prefs_key_size );
446 $prefs_val_size = 65536 if ( !$prefs_val_size );
448 # add qmail-inject test here for backwards compatibility
449 if ( !$sendmail_args && $sendmail_path =~ /qmail-inject/ ) {
451 } elsif ( !$sendmail_args ) {
452 $sendmail_args = '-i -t';
455 $default_fontsize = '' if ( !$default_fontsize);
456 $default_fontset = '' if ( !$default_fontset);
458 %fontsets = ('serif', 'serif',
459 'sans', 'helvetica,arial,sans-serif',
460 'comicsans', 'comic sans ms,sans-serif',
461 'tahoma', 'tahoma,sans-serif',
462 'verasans', 'bitstream vera sans,verdana,sans-serif');
465 # $use_imap_tls and $use_smtp_tls are switched to integer since 1.5.1
466 $use_imap_tls = 0 if ( $use_imap_tls eq 'false');
467 $use_imap_tls = 1 if ( $use_imap_tls eq 'true');
468 $use_smtp_tls = 0 if ( $use_smtp_tls eq 'false');
469 $use_smtp_tls = 1 if ( $use_smtp_tls eq 'true');
470 # sorting options changed names and reversed values in 1.5.1
471 $disable_thread_sort = 'false' if ( !$disable_thread_sort );
472 $disable_server_sort = 'false' if ( !$disable_server_sort );
475 $abook_file_line_length = 2048 if ( !$abook_file_line_length );
476 $config_location_base = '' if ( !$config_location_base );
477 $smtp_sitewide_user = '' if ( !$smtp_sitewide_user );
478 $smtp_sitewide_pass = '' if ( !$smtp_sitewide_pass );
479 $icon_theme_def = '' if ( !$icon_theme_def );
480 $disable_plugins = 'false' if ( !$disable_plugins );
481 $disable_plugins_user = '' if ( !$disable_plugins_user );
482 $only_secure_cookies = 'true' if ( !$only_secure_cookies );
483 $ask_user_info = 'true' if ( !$ask_user_info );
485 if ( $ARGV[0] eq '--install-plugin' ) {
486 print "Activating plugin " . $ARGV[1] . "\n";
487 if ( -d
"../plugins/" . $ARGV[1]) {
488 push @plugins, $ARGV[1];
492 print "No such plugin.\n";
495 } elsif ( $ARGV[0] eq '--remove-plugin' ) {
496 print "Removing plugin " . $ARGV[1] . "\n";
497 foreach $plugin (@plugins) {
498 if ( $plugin ne $ARGV[1] ) {
499 push @newplugins, $plugin;
502 @plugins = @newplugins;
505 } elsif ( $ARGV[0] eq '--update-plugins' or $ARGV[0] eq '-u') {
506 build_plugin_hook_array
();
508 } elsif ( $ARGV[0] eq '--help' or $ARGV[0] eq '-h') {
509 print "SquirrelMail Configuration Script\n";
511 print " * No arguments: initiates the configuration dialog\n";
512 print " * --install-plugin <plugin> : activates the specified plugin\n";
513 print " * --remove-plugin <plugin> : deactivates the specified plugin\n";
514 print " * --update-plugins , -u : rebuilds plugin_hooks.php according\n";
515 print " to plugins activated in config.php\n";
516 print " * --help , -h : Displays this help\n";
523 ####################################################################################
525 # used in multiple places, define once
526 $list_supported_imap_servers =
527 " bincimap = Binc IMAP server\n" .
528 " courier = Courier IMAP server\n" .
529 " cyrus = Cyrus IMAP server\n" .
530 " dovecot = Dovecot Secure IMAP server\n" .
531 " exchange = Microsoft Exchange IMAP server\n" .
532 " hmailserver = hMailServer\n" .
533 " macosx = Mac OS X Mailserver\n" .
534 " mercury32 = Mercury/32\n" .
535 " uw = University of Washington's IMAP server\n";
537 #####################################################################################
538 if ( $config_use_color == 1 ) {
544 $config_use_color = 2;
547 # lists can be printed in more than one column; default is just one
551 # try to get screen width dynamically if possible; default to 80
552 # (user can override with "w#" command)
554 eval { require "sys/ioctl.ph" };
556 || !defined &TIOCGWINSZ
557 || !open(TTY
, "+</dev/tty")
558 || !ioctl(TTY
, &TIOCGWINSZ
, $winsize='')) {
561 ($row, $col, $xpixel, $ypixel) = unpack('S4', $winsize);
562 $screen_width = $col;
565 while ( ( $command ne "q" ) && ( $command ne "Q" ) && ( $command ne ":q" ) ) {
567 print $WHT. "SquirrelMail Configuration : " . $NRM;
568 if ( $config == 1 ) { print "Read: config.php"; }
569 elsif ( $config == 2 ) { print "Read: config_default.php"; }
570 print " ($print_config_version)\n";
571 print "---------------------------------------------------------\n";
574 print $WHT. "Main Menu --\n" . $NRM;
575 print "1. Organization Preferences\n";
576 print "2. Server Settings\n";
577 print "3. Folder Defaults\n";
578 print "4. General Options\n";
579 print "5. User Interface\n";
580 print "6. Address Books\n";
581 print "7. Message of the Day (MOTD)\n";
582 print "8. Plugins\n";
583 print "9. Database\n";
584 print "10. Language settings\n";
585 print "11. Tweaks\n";
587 print "D. Set pre-defined settings for specific IMAP servers\n";
589 } elsif ( $menu == 1 ) {
590 print $WHT. "Organization Preferences\n" . $NRM;
591 print "1. Organization Name : $WHT$org_name$NRM\n";
592 print "2. Organization Logo : $WHT$org_logo$NRM\n";
593 print "3. Org. Logo Width/Height : $WHT($org_logo_width/$org_logo_height)$NRM\n";
594 print "4. Organization Title : $WHT$org_title$NRM\n";
595 print "5. Signout Page : $WHT$signout_page$NRM\n";
596 print "6. Top Frame : $WHT$frame_top$NRM\n";
597 print "7. Provider link : $WHT$provider_uri$NRM\n";
598 print "8. Provider link text : $WHT$provider_name$NRM\n";
601 print "R Return to Main Menu\n";
602 } elsif ( $menu == 2 ) {
603 print $WHT. "Server Settings\n\n" . $NRM;
604 print $WHT . "General" . $NRM . "\n";
606 print "1. Domain : $WHT$domain$NRM\n";
607 print "2. Invert Time : $WHT$invert_time$NRM\n";
608 print "3. Sendmail or SMTP : $WHT";
609 if ( lc($useSendmail) eq 'true' ) {
617 if ( $show_imap_settings ) {
618 print $WHT . "IMAP Settings". $NRM . "\n--------------\n";
619 print "4. IMAP Server : $WHT$imapServerAddress$NRM\n";
620 print "5. IMAP Port : $WHT$imapPort$NRM\n";
621 print "6. Authentication type : $WHT$imap_auth_mech$NRM\n";
622 print "7. Secure IMAP (TLS) : $WHT" . display_use_tls
($use_imap_tls) . "$NRM\n";
623 print "8. Server software : $WHT$imap_server_type$NRM\n";
624 print "9. Delimiter : $WHT$optional_delimiter$NRM\n";
626 } elsif ( $show_smtp_settings ) {
627 if ( lc($useSendmail) eq 'true' ) {
628 print $WHT . "Sendmail" . $NRM . "\n--------\n";
629 print "4. Sendmail Path : $WHT$sendmail_path$NRM\n";
630 print "5. Sendmail arguments : $WHT$sendmail_args$NRM\n";
631 print "6. Header encryption key : $WHT$encode_header_key$NRM\n";
634 print $WHT . "SMTP Settings" . $NRM . "\n-------------\n";
635 print "4. SMTP Server : $WHT$smtpServerAddress$NRM\n";
636 print "5. SMTP Port : $WHT$smtpPort$NRM\n";
637 print "6. POP before SMTP : $WHT$pop_before_smtp$NRM\n";
638 print "7. SMTP Authentication : $WHT$smtp_auth_mech" . display_smtp_sitewide_userpass
() ."$NRM\n";
639 print "8. Secure SMTP (TLS) : $WHT" . display_use_tls
($use_smtp_tls) . "$NRM\n";
640 print "9. Header encryption key : $WHT$encode_header_key$NRM\n";
645 if ($show_imap_settings == 0) {
646 print "A. Update IMAP Settings : ";
647 print "$WHT$imapServerAddress$NRM:";
648 print "$WHT$imapPort$NRM ";
649 print "($WHT$imap_server_type$NRM)\n";
651 if ($show_smtp_settings == 0) {
652 if ( lc($useSendmail) eq 'true' ) {
653 print "B. Change Sendmail Config : $WHT$sendmail_path$NRM\n";
655 print "B. Update SMTP Settings : ";
656 print "$WHT$smtpServerAddress$NRM:";
657 print "$WHT$smtpPort$NRM\n";
660 if ( $show_smtp_settings || $show_imap_settings )
663 ($show_imap_settings ?
"IMAP Server" :
664 (lc($useSendmail) eq 'true') ?
"Sendmail" : "SMTP") . " Settings\n";
668 print "R Return to Main Menu\n";
669 } elsif ( $menu == 3 ) {
670 print $WHT. "Folder Defaults\n" . $NRM;
671 print "1. Default Folder Prefix : $WHT$default_folder_prefix$NRM\n";
672 print "2. Show Folder Prefix Option : $WHT$show_prefix_option$NRM\n";
673 print "3. Trash Folder : $WHT$trash_folder$NRM\n";
674 print "4. Sent Folder : $WHT$sent_folder$NRM\n";
675 print "5. Drafts Folder : $WHT$draft_folder$NRM\n";
676 print "6. By default, move to trash : $WHT$default_move_to_trash$NRM\n";
677 print "7. By default, save sent messages : $WHT$default_move_to_sent$NRM\n";
678 print "8. By default, save as draft : $WHT$default_save_as_draft$NRM\n";
679 print "9. List Special Folders First : $WHT$list_special_folders_first$NRM\n";
680 print "10. Show Special Folders Color : $WHT$use_special_folder_color$NRM\n";
681 print "11. Auto Expunge : $WHT$auto_expunge$NRM\n";
682 print "12. Default Sub. of INBOX : $WHT$default_sub_of_inbox$NRM\n";
683 print "13. Show 'Contain Sub.' Option : $WHT$show_contain_subfolders_option$NRM\n";
684 print "14. Default Unseen Notify : $WHT$default_unseen_notify$NRM\n";
685 print "15. Default Unseen Type : $WHT$default_unseen_type$NRM\n";
686 print "16. Auto Create Special Folders : $WHT$auto_create_special$NRM\n";
687 print "17. Folder Delete Bypasses Trash : $WHT$delete_folder$NRM\n";
688 print "18. Enable /NoSelect folder fix : $WHT$noselect_fix_enable$NRM\n";
690 print "R Return to Main Menu\n";
691 } elsif ( $menu == 4 ) {
692 print $WHT. "General Options\n" . $NRM;
693 print "1. Data Directory : $WHT$data_dir$NRM\n";
694 print "2. Attachment Directory : $WHT$attachment_dir$NRM\n";
695 print "3. Directory Hash Level : $WHT$dir_hash_level$NRM\n";
696 print "4. Default Left Size : $WHT$default_left_size$NRM\n";
697 print "5. Usernames in Lowercase : $WHT$force_username_lowercase$NRM\n";
698 print "6. Allow use of priority : $WHT$default_use_priority$NRM\n";
699 print "7. Hide SM attributions : $WHT$hide_sm_attributions$NRM\n";
700 print "8. Allow use of receipts : $WHT$default_use_mdn$NRM\n";
701 print "9. Allow editing of identity : $WHT$edit_identity$NRM\n";
702 print " Allow editing of name : $WHT$edit_name$NRM\n";
703 print " Remove username from header : $WHT$hide_auth_header$NRM\n";
704 print "10. Disable server thread sort : $WHT$disable_thread_sort$NRM\n";
705 print "11. Disable server-side sorting : $WHT$disable_server_sort$NRM\n";
706 print "12. Allow server charset search : $WHT$allow_charset_search$NRM\n";
707 print "13. Allow advanced search : $WHT$allow_advanced_search$NRM\n";
708 print "14. PHP session name : $WHT$session_name$NRM\n";
709 print "15. Time zone configuration : $WHT$time_zone_type$NRM\n";
710 print "16. Location base : $WHT$config_location_base$NRM\n";
711 print "17. Only secure cookies if poss. : $WHT$only_secure_cookies$NRM\n";
713 print "R Return to Main Menu\n";
714 } elsif ( $menu == 5 ) {
715 print $WHT. "User Interface\n" . $NRM;
716 print "1. Use Icons? : $WHT$use_icons$NRM\n";
717 # print "3. Default Icon Set : $WHT$icon_theme_def$NRM\n";
718 print "2. Default font size : $WHT$default_fontsize$NRM\n";
719 print "3. Manage template sets (skins)\n";
720 print "4. Manage user themes\n";
721 print "5. Manage font sets\n";
722 print "6. Manage icon themes\n";
725 print "R Return to Main Menu\n";
726 } elsif ( $menu == 6 ) {
727 print $WHT. "Address Books\n" . $NRM;
728 print "1. Change LDAP Servers\n";
729 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
730 print " > $ldap_host[$count]\n";
732 print "2. Use Javascript address book search : $WHT$default_use_javascript_addr_book$NRM\n";
733 print "3. Global address book file : $WHT$abook_global_file$NRM\n";
734 print "4. Allow writing into global file address book : $WHT$abook_global_file_writeable$NRM\n";
735 print "5. Allow listing of global file address book : $WHT$abook_global_file_listing$NRM\n";
736 print "6. Allowed address book line length : $WHT$abook_file_line_length$NRM\n";
738 print "R Return to Main Menu\n";
739 } elsif ( $menu == 7 ) {
740 print $WHT. "Message of the Day (MOTD)\n" . $NRM;
743 print "1 Edit the MOTD\n";
745 print "R Return to Main Menu\n";
746 } elsif ( $menu == 8 ) {
747 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
748 print $WHT. "Plugins (WARNING: All plugins are currently disabled\n for the user \"$disable_plugins_user\"!)\n" . $NRM;
749 } elsif (lc($disable_plugins) eq 'true') {
750 print $WHT. "Plugins (WARNING: All plugins are currently disabled!)\n" . $NRM;
752 print $WHT. "Plugins\n" . $NRM;
754 print " Installed Plugins\n";
756 $num = print_multi_col_list
(1, $columns, $screen_width, 1, @plugins);
759 for ( $count = 0 ; $count <= $#plugins ; $count++ ) {
761 $english_name = get_plugin_english_name
($plugins[$count]);
762 if ( $english_name eq "" ) {
763 print " $WHT$num.$NRM $plugins[$count]" . get_plugin_version
($plugins[$count]) . "\n";
765 print " $WHT$num.$NRM $english_name ($plugins[$count])" . get_plugin_version
($plugins[$count]) . "\n";
769 print "\n Available Plugins:\n";
770 opendir( DIR
, "../plugins" );
771 @files = sort(readdir(DIR
));
773 @unused_plugins = ();
774 for ( $i = 0 ; $i <= $#files ; $i++ ) {
775 if ( -d
"../plugins/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne ".svn" ) {
777 for ( $k = 0 ; $k <= $#plugins ; $k++ ) {
778 if ( $plugins[$k] eq $files[$i] ) {
783 $unused_plugins[$pos] = $files[$i];
790 $num = print_multi_col_list
($num + 1, $columns, $screen_width, 1, @unused_plugins);
792 for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
794 $english_name = get_plugin_english_name
($unused_plugins[$i]);
795 if ( $english_name eq "" ) {
796 print " $WHT$num.$NRM $unused_plugins[$i]" . get_plugin_version
($unused_plugins[$i]) . "\n";
798 print " $WHT$num.$NRM $english_name ($unused_plugins[$i])" . get_plugin_version
($unused_plugins[$i]) . "\n";
805 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
806 print "E Enable active plugins (all plugins currently\n disabled for the user \"$disable_plugins_user\")\n";
807 } elsif (lc($disable_plugins) eq 'true') {
808 print "E Enable active plugins (all plugins currently\n disabled)\n";
810 print "D Disable all plugins\n";
812 print "U Set the user for whom plugins can be disabled\n";
813 print "R Return to Main Menu\n";
814 print "C# List plugins in <#> number of columns\n";
815 print "W# Change screen width to <#> (currently $screen_width)\n";
816 } elsif ( $menu == 9 ) {
817 print $WHT. "Database\n" . $NRM;
818 print "1. DSN for Address Book : $WHT$addrbook_dsn$NRM\n";
819 print "2. Table for Address Book : $WHT$addrbook_table$NRM\n";
821 print "3. DSN for Preferences : $WHT$prefs_dsn$NRM\n";
822 print "4. Table for Preferences : $WHT$prefs_table$NRM\n";
823 print "5. Field for username : $WHT$prefs_user_field$NRM ($prefs_user_size)\n";
824 print "6. Field for prefs key : $WHT$prefs_key_field$NRM ($prefs_key_size)\n";
825 print "7. Field for prefs value : $WHT$prefs_val_field$NRM ($prefs_val_size)\n";
827 print "8. DSN for Global Address Book : $WHT$addrbook_global_dsn$NRM\n";
828 print "9. Table for Global Address Book : $WHT$addrbook_global_table$NRM\n";
829 print "10. Allow writing into Global Address Book : $WHT$addrbook_global_writeable$NRM\n";
830 print "11. Allow listing of Global Address Book : $WHT$addrbook_global_listing$NRM\n";
832 print "R Return to Main Menu\n";
833 } elsif ( $menu == 10 ) {
834 print $WHT. "Language settings\n" . $NRM;
835 print "1. Default Language : $WHT$squirrelmail_default_language$NRM\n";
836 print "2. Default Charset : $WHT$default_charset$NRM\n";
837 print "3. Show alternative language names : $WHT$show_alternative_names$NRM\n";
838 print "4. Enable aggressive decoding : $WHT$aggressive_decoding$NRM\n";
839 print "5. Enable lossy encoding : $WHT$lossy_encoding$NRM\n";
841 print "R Return to Main Menu\n";
842 } elsif ( $menu == 11 ) {
843 print $WHT. "Interface tweaks\n" . $NRM;
844 print "1. Display html mails in iframe : $WHT$use_iframe$NRM\n";
845 print "2. Ask user info on first login : $WHT$ask_user_info$NRM\n";
847 print $WHT. "PHP tweaks\n" . $NRM;
848 print "4. Use php recode functions : $WHT$use_php_recode$NRM\n";
849 print "5. Use php iconv functions : $WHT$use_php_iconv$NRM\n";
851 print $WHT. "Configuration tweaks\n" . $NRM;
852 print "6. Allow remote configtest : $WHT$allow_remote_configtest$NRM\n";
853 print "7. Debug mode : $WHT$sm_debug_mode$NRM\n";
854 print "8. Secured configuration mode : $WHT$secured_config$NRM\n";
856 print "R Return to Main Menu\n";
858 if ( $config_use_color == 1 ) {
859 print "C Turn color off\n";
861 print "C Turn color on\n";
863 print "S Save data\n";
867 print "Command >> " . $WHT;
869 $command =~ s/[\n\r]//g;
870 $command =~ tr/A-Z/a-z/;
873 # Read the commands they entered.
874 if ( $command eq "r" ) {
876 } elsif ( $command eq "s" ) {
878 print "Press enter to continue...";
881 } elsif ( ( $command eq "q" ) && ( $saved == 0 ) ) {
882 print "You have not saved your data.\n";
883 print "Save? [" . $WHT . "Y" . $NRM . "/n]: ";
885 if ( ( $save =~ /^y/i ) || ( $save =~ /^\s*$/ ) ) {
888 } elsif ( $command eq "c" ) {
889 if ( $config_use_color == 1 ) {
890 $config_use_color = 2;
894 $config_use_color = 1;
898 } elsif ( $command =~ /^w([0-9]+)/ ) {
900 } elsif ( $command eq "d" && $menu == 0 ) {
905 if ( ( $command > 0 ) && ( $command < 12 ) ) {
908 } elsif ( $menu == 1 ) {
909 if ( $command == 1 ) { $org_name = command1
(); }
910 elsif ( $command == 2 ) { $org_logo = command2
(); }
911 elsif ( $command == 3 ) { ($org_logo_width,$org_logo_height) = command2a
(); }
912 elsif ( $command == 4 ) { $org_title = command3
(); }
913 elsif ( $command == 5 ) { $signout_page = command4
(); }
914 elsif ( $command == 6 ) { $frame_top = command6
(); }
915 elsif ( $command == 7 ) { $provider_uri = command7
(); }
916 elsif ( $command == 8 ) { $provider_name = command8
(); }
918 } elsif ( $menu == 2 ) {
919 if ( $command eq "a" ) { $show_imap_settings = 1; $show_smtp_settings = 0; }
920 elsif ( $command eq "b" ) { $show_imap_settings = 0; $show_smtp_settings = 1; }
921 elsif ( $command eq "h" ) { $show_imap_settings = 0; $show_smtp_settings = 0; }
922 elsif ( $command <= 3 ) {
923 if ( $command == 1 ) { $domain = command11
(); }
924 elsif ( $command == 2 ) { $invert_time = command110
(); }
925 elsif ( $command == 3 ) { $useSendmail = command14
(); }
926 $show_imap_settings = 0; $show_smtp_settings = 0;
927 } elsif ( $show_imap_settings ) {
928 if ( $command == 4 ) { $imapServerAddress = command12
(); }
929 elsif ( $command == 5 ) { $imapPort = command13
(); }
930 elsif ( $command == 6 ) { $imap_auth_mech = command112a
(); }
931 elsif ( $command == 7 ) { $use_imap_tls = command_use_tls
("IMAP",$use_imap_tls); }
932 elsif ( $command == 8 ) { $imap_server_type = command19
(); }
933 elsif ( $command == 9 ) { $optional_delimiter = command111
(); }
934 } elsif ( $show_smtp_settings && lc($useSendmail) eq 'true' ) {
935 if ( $command == 4 ) { $sendmail_path = command15
(); }
936 elsif ( $command == 5 ) { $sendmail_args = command_sendmail_args
(); }
937 elsif ( $command == 6 ) { $encode_header_key = command114
(); }
938 } elsif ( $show_smtp_settings ) {
939 if ( $command == 4 ) { $smtpServerAddress = command16
(); }
940 elsif ( $command == 5 ) { $smtpPort = command17
(); }
941 elsif ( $command == 6 ) { $pop_before_smtp = command18a
(); }
942 elsif ( $command == 7 ) { $smtp_auth_mech = command112b
(); }
943 elsif ( $command == 8 ) { $use_smtp_tls = command_use_tls
("SMTP",$use_smtp_tls); }
944 elsif ( $command == 9 ) { $encode_header_key = command114
(); }
946 } elsif ( $menu == 3 ) {
947 if ( $command == 1 ) { $default_folder_prefix = command21
(); }
948 elsif ( $command == 2 ) { $show_prefix_option = command22
(); }
949 elsif ( $command == 3 ) { $trash_folder = command23a
(); }
950 elsif ( $command == 4 ) { $sent_folder = command23b
(); }
951 elsif ( $command == 5 ) { $draft_folder = command23c
(); }
952 elsif ( $command == 6 ) { $default_move_to_trash = command24a
(); }
953 elsif ( $command == 7 ) { $default_move_to_sent = command24b
(); }
954 elsif ( $command == 8 ) { $default_save_as_draft = command24c
(); }
955 elsif ( $command == 9 ) { $list_special_folders_first = command27
(); }
956 elsif ( $command == 10 ) { $use_special_folder_color = command28
(); }
957 elsif ( $command == 11 ) { $auto_expunge = command29
(); }
958 elsif ( $command == 12 ) { $default_sub_of_inbox = command210
(); }
959 elsif ( $command == 13 ) { $show_contain_subfolders_option = command211
(); }
960 elsif ( $command == 14 ) { $default_unseen_notify = command212
(); }
961 elsif ( $command == 15 ) { $default_unseen_type = command213
(); }
962 elsif ( $command == 16 ) { $auto_create_special = command214
(); }
963 elsif ( $command == 17 ) { $delete_folder = command215
(); }
964 elsif ( $command == 18 ) { $noselect_fix_enable = command216
(); }
965 } elsif ( $menu == 4 ) {
966 if ( $command == 1 ) { $data_dir = command33a
(); }
967 elsif ( $command == 2 ) { $attachment_dir = command33b
(); }
968 elsif ( $command == 3 ) { $dir_hash_level = command33c
(); }
969 elsif ( $command == 4 ) { $default_left_size = command35
(); }
970 elsif ( $command == 5 ) { $force_username_lowercase = command36
(); }
971 elsif ( $command == 6 ) { $default_use_priority = command37
(); }
972 elsif ( $command == 7 ) { $hide_sm_attributions = command38
(); }
973 elsif ( $command == 8 ) { $default_use_mdn = command39
(); }
974 elsif ( $command == 9 ) { $edit_identity = command310
(); }
975 elsif ( $command == 10 ) { $disable_thread_sort = command312
(); }
976 elsif ( $command == 11 ) { $disable_server_sort = command313
(); }
977 elsif ( $command == 12 ) { $allow_charset_search = command314
(); }
978 elsif ( $command == 13 ) { $allow_advanced_search = command316
(); }
979 elsif ( $command == 14 ) { $session_name = command317
(); }
980 elsif ( $command == 15 ) { $time_zone_type = command318
(); }
981 elsif ( $command == 16 ) { $config_location_base = command_config_location_base
(); }
982 elsif ( $command == 17 ) { $only_secure_cookies = command319
(); }
983 } elsif ( $menu == 5 ) {
984 if ( $command == 1 ) { $use_icons = commandB3
(); }
985 # elsif ( $command == 3 ) { $icon_theme_def = commandB7(); }
986 elsif ( $command == 2 ) { $default_fontsize = command_default_fontsize
(); }
987 elsif ( $command == 3 ) { $templateset_default = command_templates
(); }
988 elsif ( $command == 4 ) { command_userThemes
(); }
989 elsif ( $command == 5 ) { command_fontsets
(); }
990 elsif ( $command == 6 ) { command_iconSets
(); }
991 } elsif ( $menu == 6 ) {
992 if ( $command == 1 ) { command61
(); }
993 elsif ( $command == 2 ) { command62
(); }
994 elsif ( $command == 3 ) { $abook_global_file=command63
(); }
995 elsif ( $command == 4 ) { command64
(); }
996 elsif ( $command == 5 ) { command65
(); }
997 elsif ( $command == 6 ) { command_abook_file_line_length
(); }
998 } elsif ( $menu == 7 ) {
999 if ( $command == 1 ) { $motd = command71
(); }
1000 } elsif ( $menu == 8 ) {
1001 if ( $command =~ /^[0-9]+/ ) { @plugins = command81
(); }
1002 elsif ( $command eq "u" ) { $disable_plugins_user = command82
(); }
1003 elsif ( $command eq "d" ) { $disable_plugins = 'true'; }
1004 elsif ( $command eq "e" ) { $disable_plugins = 'false'; }
1005 elsif ( $command =~ /^c([0-9]+)/ ) { $columns = $1; }
1006 } elsif ( $menu == 9 ) {
1007 if ( $command == 1 ) { $addrbook_dsn = command91
(); }
1008 elsif ( $command == 2 ) { $addrbook_table = command92
(); }
1009 elsif ( $command == 3 ) { $prefs_dsn = command93
(); }
1010 elsif ( $command == 4 ) { $prefs_table = command94
(); }
1011 elsif ( $command == 5 ) { $prefs_user_field = command95
(); }
1012 elsif ( $command == 6 ) { $prefs_key_field = command96
(); }
1013 elsif ( $command == 7 ) { $prefs_val_field = command97
(); }
1014 elsif ( $command == 8 ) { $addrbook_global_dsn = command98
(); }
1015 elsif ( $command == 9 ) { $addrbook_global_table = command99
(); }
1016 elsif ( $command == 10 ) { $addrbook_global_writeable = command910
(); }
1017 elsif ( $command == 11 ) { $addrbook_global_listing = command911
(); }
1018 } elsif ( $menu == 10 ) {
1019 if ( $command == 1 ) { $squirrelmail_default_language = commandA1
(); }
1020 elsif ( $command == 2 ) { $default_charset = commandA2
(); }
1021 elsif ( $command == 3 ) { $show_alternative_names = commandA3
(); }
1022 elsif ( $command == 4 ) { $aggressive_decoding = commandA4
(); }
1023 elsif ( $command == 5 ) { $lossy_encoding = commandA5
(); }
1024 } elsif ( $menu == 11 ) {
1025 if ( $command == 1 ) { $use_iframe = commandB2
(); }
1026 elsif ( $command == 2 ) { $ask_user_info = command_ask_user_info
(); }
1027 elsif ( $command == 4 ) { $use_php_recode = commandB4
(); }
1028 elsif ( $command == 5 ) { $use_php_iconv = commandB5
(); }
1029 elsif ( $command == 6 ) { $allow_remote_configtest = commandB6
(); }
1030 elsif ( $command == 7 ) { $sm_debug_mode = commandB8
(); }
1031 elsif ( $command == 8 ) { $secured_config = commandB9
(); }
1037 print "\nExiting conf.pl.\n".
1038 "You might want to test your configuration by browsing to\n".
1039 "http://your-squirrelmail-location/src/configtest.php\n".
1040 "Happy SquirrelMailing!\n\n";
1043 ####################################################################################
1047 print "We have tried to make the name SquirrelMail as transparent as\n";
1048 print "possible. If you set up an organization name, most places where\n";
1049 print "SquirrelMail would take credit will be credited to your organization.\n";
1051 print "If your Organization Name includes a '\$', please precede it with a \\. \n";
1052 print "Other '\$' will be considered the beginning of a variable that\n";
1053 print "must be defined before the \$org_name is printed.\n";
1055 print "[$WHT$org_name$NRM]: $WHT";
1056 $new_org_name = <STDIN
>;
1057 if ( $new_org_name eq "\n" ) {
1058 $new_org_name = $org_name;
1060 $new_org_name =~ s/[\r\n]//g;
1061 $new_org_name =~ s/\"/"/g;
1063 return $new_org_name;
1068 print "Your organization's logo is an image that will be displayed at\n";
1069 print "different times throughout SquirrelMail. ";
1071 print "Please be aware of the following: \n";
1072 print " - Relative URLs are relative to the config dir\n";
1073 print " to use the default logo, use ../images/sm_logo.png\n";
1074 print " - To specify a logo defined outside the SquirrelMail source tree\n";
1075 print " use the absolute URL the webserver would use to include the file\n";
1076 print " e.g. http://example.com/images/mylogo.gif or /images/mylogo.jpg\n";
1078 print "[$WHT$org_logo$NRM]: $WHT";
1079 $new_org_logo = <STDIN
>;
1080 if ( $new_org_logo eq "\n" ) {
1081 $new_org_logo = $org_logo;
1083 $new_org_logo =~ s/[\r\n]//g;
1085 return $new_org_logo;
1090 print "Your organization's logo is an image that will be displayed at\n";
1091 print "different times throughout SquirrelMail. Width\n";
1092 print "and Height of your logo image. Use '0' to disable.\n";
1094 print "Width: [$WHT$org_logo_width$NRM]: $WHT";
1095 $new_org_logo_width = <STDIN
>;
1096 $new_org_logo_width =~ tr/0-9//cd; # only want digits!
1097 if ( $new_org_logo_width eq '' ) {
1098 $new_org_logo_width = $org_logo_width;
1100 if ( $new_org_logo_width > 0 ) {
1101 print "Height: [$WHT$org_logo_height$NRM]: $WHT";
1102 $new_org_logo_height = <STDIN
>;
1103 $new_org_logo_height =~ tr/0-9//cd; # only want digits!
1104 if( $new_org_logo_height eq '' ) {
1105 $new_org_logo_height = $org_logo_height;
1108 $new_org_logo_height = 0;
1110 return ($new_org_logo_width, $new_org_logo_height);
1115 print "A title is what is displayed at the top of the browser window in\n";
1116 print "the titlebar. Usually this will end up looking something like:\n";
1117 print "\"Netscape: $org_title\"\n";
1119 print "If your Organization Title includes a '\$', please precede it with a \\. \n";
1120 print "Other '\$' will be considered the beginning of a variable that\n";
1121 print "must be defined before the \$org_title is printed.\n";
1123 print "[$WHT$org_title$NRM]: $WHT";
1124 $new_org_title = <STDIN
>;
1125 if ( $new_org_title eq "\n" ) {
1126 $new_org_title = $org_title;
1128 $new_org_title =~ s/[\r\n]//g;
1129 $new_org_title =~ s/\"/\'/g;
1131 return $new_org_title;
1136 print "When users click the Sign Out button they will be logged out and\n";
1137 print "then sent to signout_page. If signout_page is left empty,\n";
1138 print "(hit space and then return) they will be taken, as normal,\n";
1139 print "to the default and rather sparse SquirrelMail signout page.\n";
1141 print "[$WHT$signout_page$NRM]: $WHT";
1142 $new_signout_page = <STDIN
>;
1143 if ( $new_signout_page eq "\n" ) {
1144 $new_signout_page = $signout_page;
1146 $new_signout_page =~ s/[\r\n]//g;
1147 $new_signout_page =~ s/^\s+$//g;
1149 return $new_signout_page;
1154 print "SquirrelMail defaults to using the whole of the browser window.\n";
1155 print "This allows you to keep it within a specified frame. The default\n";
1156 print "is '_top'\n";
1158 print "[$WHT$frame_top$NRM]: $WHT";
1159 $new_frame_top = <STDIN
>;
1160 if ( $new_frame_top eq "\n" ) {
1161 $new_frame_top = '_top';
1163 $new_frame_top =~ s/[\r\n]//g;
1164 $new_frame_top =~ s/^\s+$//g;
1166 return $new_frame_top;
1169 # Default link to provider
1171 print "Here you can set the link on the top-right of the message list.\n";
1172 print "If empty, it will not be displayed.\n";
1174 print "[$WHT$provider_uri$NRM]: $WHT";
1175 $new_provider_uri = <STDIN
>;
1176 if ( $new_provider_uri eq "\n" ) {
1177 $new_provider_uri = '';
1179 $new_provider_uri =~ s/[\r\n]//g;
1180 $new_provider_uri =~ s/^\s+$//g;
1182 return $new_provider_uri;
1186 print "Here you can set the name of the link on the top-right of the message list.\n";
1187 print "The default is empty (do not display anything).'\n";
1189 print "[$WHT$provider_name$NRM]: $WHT";
1190 $new_provider_name = <STDIN
>;
1191 if ( $new_provider_name eq "\n" ) {
1192 $new_provider_name = '';
1194 $new_provider_name =~ s/[\r\n]//g;
1195 $new_provider_name =~ s/^\s+$//g;
1196 $new_provider_name =~ s/\'/\\'/g;
1198 return $new_provider_name;
1201 ####################################################################################
1205 print "The domain name is the suffix at the end of all email addresses. If\n";
1206 print "for example, your email address is jdoe\@example.com, then your domain\n";
1207 print "would be example.com.\n";
1209 print "[$WHT$domain$NRM]: $WHT";
1210 $new_domain = <STDIN
>;
1211 if ( $new_domain eq "\n" ) {
1212 $new_domain = $domain;
1214 $new_domain =~ s/\s//g;
1221 print "This is the hostname where your IMAP server can be contacted.\n";
1222 print "[$WHT$imapServerAddress$NRM]: $WHT";
1223 $new_imapServerAddress = <STDIN
>;
1224 if ( $new_imapServerAddress eq "\n" ) {
1225 $new_imapServerAddress = $imapServerAddress;
1227 $new_imapServerAddress =~ s/[\r\n]//g;
1229 return $new_imapServerAddress;
1234 print "This is the port that your IMAP server is on. Usually this is 143.\n";
1235 print "[$WHT$imapPort$NRM]: $WHT";
1236 $new_imapPort = <STDIN
>;
1237 if ( $new_imapPort eq "\n" ) {
1238 $new_imapPort = $imapPort;
1240 $new_imapPort =~ s/[\r\n]//g;
1242 return $new_imapPort;
1247 print "You now need to choose the method that you will use for sending\n";
1248 print "messages in SquirrelMail. You can either connect to an SMTP server\n";
1249 print "or use sendmail directly.\n";
1250 if ( lc($useSendmail) eq 'true' ) {
1251 $default_value = "1";
1253 $default_value = "2";
1256 print " 1. Sendmail\n";
1258 print "Your choice [1/2] [$WHT$default_value$NRM]: $WHT";
1259 $use_sendmail = <STDIN
>;
1260 if ( ( $use_sendmail =~ /^1\n/i )
1261 || ( ( $use_sendmail =~ /^\n/ ) && ( $default_value eq "1" ) ) ) {
1262 $useSendmail = 'true';
1264 $useSendmail = 'false';
1266 return $useSendmail;
1271 print "Specify where the sendmail executable is located. Usually /usr/sbin/sendmail\n";
1272 print "[$WHT$sendmail_path$NRM]: $WHT";
1273 $new_sendmail_path = <STDIN
>;
1274 if ( $new_sendmail_path eq "\n" ) {
1275 $new_sendmail_path = $sendmail_path;
1277 $new_sendmail_path =~ s/[\r\n]//g;
1279 return $new_sendmail_path;
1282 # Extra sendmail arguments
1283 sub command_sendmail_args
{
1284 print "Specify additional sendmail program arguments.\n";
1286 print "Make sure that arguments are supported by your sendmail program. -f argument \n";
1287 print "is added automatically by SquirrelMail scripts. Variable defaults to standard\n";
1288 print "/usr/sbin/sendmail arguments. If you use qmail-inject, nbsmtp or any other \n";
1289 print "sendmail wrapper, which does not support -i and -t arguments, set variable to\n";
1290 print "empty string or use arguments suitable for your mailer.\n";
1292 print "[$WHT$sendmail_args$NRM]: $WHT";
1293 $new_sendmail_args = <STDIN
>;
1294 if ( $new_sendmail_args eq "\n" ) {
1295 $new_sendmail_args = $sendmail_args;
1297 # strip linefeeds and crs.
1298 $new_sendmail_args =~ s/[\r\n]//g;
1300 return trim
($new_sendmail_args);
1305 print "This is the hostname of your SMTP server.\n";
1306 print "[$WHT$smtpServerAddress$NRM]: $WHT";
1307 $new_smtpServerAddress = <STDIN
>;
1308 if ( $new_smtpServerAddress eq "\n" ) {
1309 $new_smtpServerAddress = $smtpServerAddress;
1311 $new_smtpServerAddress =~ s/[\r\n]//g;
1313 return $new_smtpServerAddress;
1318 print "This is the port to connect to for SMTP. Usually 25.\n";
1319 print "[$WHT$smtpPort$NRM]: $WHT";
1320 $new_smtpPort = <STDIN
>;
1321 if ( $new_smtpPort eq "\n" ) {
1322 $new_smtpPort = $smtpPort;
1324 $new_smtpPort =~ s/[\r\n]//g;
1326 return $new_smtpPort;
1331 print "Do you wish to use POP3 before SMTP? Your server must\n";
1332 print "support this in order for SquirrelMail to work with it.\n";
1335 $YesNo = 'y' if ( lc($pop_before_smtp) eq 'true' );
1337 print "Use POP before SMTP (y/n) [$WHT$YesNo$NRM]: $WHT";
1339 $new_pop_before_smtp = <STDIN
>;
1340 $new_pop_before_smtp =~ tr/yn//cd;
1341 if ( $new_pop_before_smtp eq "y" ) {
1342 $new_pop_before_smtp = "true";
1343 } elsif ( $new_pop_before_smtp eq "n" ) {
1344 $new_pop_before_smtp = "false";
1346 $new_pop_before_smtp = $pop_before_smtp;
1349 # if using POP before SMTP, allow setting of custom POP server address
1350 if ($new_pop_before_smtp eq "true") {
1351 print "$NRM\nIf the address of the POP server is not the same as\n";
1352 print "your SMTP server, you may specify it here. Leave blank (to\n";
1353 print "clear this, enter only spaces) to use the same address as\n";
1354 print "your SMTP server.\n";
1355 print "POP before SMTP server address [$WHT$pop_before_smtp_host$NRM]: $WHT";
1357 $new_pop_before_smtp_host = <STDIN
>;
1358 if ( $new_pop_before_smtp_host eq "\n" ) {
1359 $new_pop_before_smtp_host = $pop_before_smtp_host;
1360 } elsif ($new_pop_before_smtp_host =~ /^\s+$/) {
1361 $new_pop_before_smtp_host = '';
1363 $new_pop_before_smtp_host =~ s/[\r|\n]//g;
1365 $pop_before_smtp_host = $new_pop_before_smtp_host;
1368 return $new_pop_before_smtp;
1373 print "Each IMAP server has its own quirks. As much as we tried to stick\n";
1374 print "to standards, it doesn't help much if the IMAP server doesn't follow\n";
1375 print "the same principles. We have made some work-arounds for some of\n";
1376 print "these servers. If you would like to use them, please select your\n";
1377 print "IMAP server. If you do not wish to use these work-arounds, you can\n";
1378 print "set this to \"other\", and none will be used.\n";
1379 print $list_supported_imap_servers;
1381 print " other = Not one of the above servers\n";
1383 print "[$WHT$imap_server_type$NRM]: $WHT";
1384 $new_imap_server_type = <STDIN
>;
1386 if ( $new_imap_server_type eq "\n" ) {
1387 $new_imap_server_type = $imap_server_type;
1389 $new_imap_server_type =~ s/[\r\n]//g;
1391 return $new_imap_server_type;
1396 print "Sometimes the date of messages sent is messed up (off by a few hours\n";
1397 print "on some machines). Typically this happens if the system doesn't support\n";
1398 print "tm_gmtoff. It will happen only if your time zone is \"negative\".\n";
1399 print "This most often occurs on Solaris 7 machines in the United States.\n";
1400 print "By default, this is off. It should be kept off unless problems surface\n";
1401 print "about the time that messages are sent.\n";
1402 print " no = Do NOT fix time -- almost always correct\n";
1403 print " yes = Fix the time for this system\n";
1406 $YesNo = 'y' if ( lc($invert_time) eq 'true' );
1408 print "Fix the time for this system (y/n) [$WHT$YesNo$NRM]: $WHT";
1410 $new_invert_time = <STDIN
>;
1411 $new_invert_time =~ tr/yn//cd;
1412 return 'true' if ( $new_invert_time eq "y" );
1413 return 'false' if ( $new_invert_time eq "n" );
1414 return $invert_time;
1418 print "This is the delimiter that your IMAP server uses to distinguish between\n";
1419 print "folders. For example, Cyrus uses '.' as the delimiter and a complete\n";
1420 print "folder would look like 'INBOX.Friends.Bob', while UW uses '/' and would\n";
1421 print "look like 'INBOX/Friends/Bob'. Normally this should be left at 'detect'\n";
1422 print "but if you are sure you know what delimiter your server uses, you can\n";
1423 print "specify it here.\n";
1424 print "\nTo have it autodetect the delimiter, set it to 'detect'.\n\n";
1425 print "[$WHT$optional_delimiter$NRM]: $WHT";
1426 $new_optional_delimiter = <STDIN
>;
1428 if ( $new_optional_delimiter eq "\n" ) {
1429 $new_optional_delimiter = $optional_delimiter;
1431 $new_optional_delimiter =~ s/[\r\n]//g;
1433 return $new_optional_delimiter;
1435 # IMAP authentication type
1436 # Possible values: login, plain, cram-md5, digest-md5
1437 # Now offers to detect supported mechs, assuming server & port are set correctly
1440 if ($use_imap_tls ne "0") {
1441 # 1. Script does not handle TLS.
1442 # 2. Server does not have to declare all supported authentication mechs when
1443 # STARTTLS is used. Supported mechs are declared only after STARTTLS.
1444 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1446 print "If you have already set the hostname and port number, I can try to\n";
1447 print "detect the mechanisms your IMAP server supports.\n";
1448 print "I will try to detect CRAM-MD5 and DIGEST-MD5 support. I can't test\n";
1449 print "for \"login\" or \"plain\" without knowing a username and password.\n";
1450 print "Auto-detecting is optional - you can safely say \"n\" here.\n";
1451 print "\nTry to detect supported mechanisms? [y/N]: ";
1454 if ($inval =~ /^y\b/i) {
1455 # Yes, let's try to detect.
1456 print "Trying to detect IMAP capabilities...\n";
1457 my $host = $imapServerAddress . ':'. $imapPort;
1458 print "CRAM-MD5:\t";
1459 my $tmp = detect_auth_support
('IMAP',$host,'CRAM-MD5');
1460 if (defined($tmp)) {
1461 if ($tmp eq 'YES') {
1462 print "$WHT SUPPORTED$NRM\n";
1464 print "$WHT NOT SUPPORTED$NRM\n";
1467 print $WHT . " ERROR DETECTING$NRM\n";
1470 print "DIGEST-MD5:\t";
1471 $tmp = detect_auth_support
('IMAP',$host,'DIGEST-MD5');
1472 if (defined($tmp)) {
1473 if ($tmp eq 'YES') {
1474 print "$WHT SUPPORTED$NRM\n";
1476 print "$WHT NOT SUPPORTED$NRM\n";
1479 print $WHT . " ERROR DETECTING$NRM\n";
1484 print "\nWhat authentication mechanism do you want to use for IMAP connections?\n\n";
1485 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1486 print $WHT . "plain" . $NRM . " - SASL PLAIN. If you need this, you already know it.\n";
1487 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext methods.\n";
1488 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1489 print "\n*** YOUR IMAP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n";
1490 print "If you don't understand or are unsure, you probably want \"login\"\n\n";
1491 print "login, plain, cram-md5, or digest-md5 [$WHT$imap_auth_mech$NRM]: $WHT";
1494 if ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) || ($inval =~ /^login\b/i) || ($inval =~ /^plain\b/i)) {
1497 # user entered garbage or default value so nothing needs to be set
1498 return $imap_auth_mech;
1503 # SMTP authentication type
1504 # Possible choices: none, plain, cram-md5, digest-md5
1506 if ($use_smtp_tls ne "0") {
1507 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1508 } elsif (eval ("use IO::Socket; 1")) {
1509 # try loading IO::Socket module
1510 print "If you have already set the hostname and port number, I can try to\n";
1511 print "automatically detect some of the mechanisms your SMTP server supports.\n";
1512 print "Auto-detection is *optional* - you can safely say \"n\" here.\n";
1513 print "\nTry to detect auth mechanisms? [y/N]: ";
1516 if ($inval =~ /^y\b/i) {
1517 # Yes, let's try to detect.
1518 print "Trying to detect supported methods (SMTP)...\n";
1521 # Check none by trying to relay to junk@microsoft.com
1522 $host = $smtpServerAddress . ':' . $smtpPort;
1523 my $sock = IO
::Socket
::INET
->new($host);
1524 print "Testing none:\t\t$WHT";
1525 if (!defined($sock)) {
1526 print " ERROR TESTING\n";
1529 $got = <$sock>; # Discard greeting
1530 print $sock "HELO $domain\r\n";
1531 $got = <$sock>; # Discard
1532 print $sock "MAIL FROM:<tester\@squirrelmail.org>\r\n";
1533 $got = <$sock>; # Discard
1534 print $sock "RCPT TO:<junk\@microsoft.com\r\n";
1535 $got = <$sock>; # This is the important line
1536 if ($got =~ /^250\b/) { # SMTP will relay without auth
1537 print "SUPPORTED$NRM\n";
1539 print "NOT SUPPORTED$NRM\n";
1541 print $sock "RSET\r\n";
1542 print $sock "QUIT\r\n";
1545 # Try login (SquirrelMail default)
1546 print "Testing login:\t\t";
1547 $tmp=detect_auth_support
('SMTP',$host,'LOGIN');
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 "Testing CRAM-MD5:\t";
1560 $tmp=detect_auth_support
('SMTP',$host,'CRAM-MD5');
1561 if (defined($tmp)) {
1562 if ($tmp eq 'YES') {
1563 print $WHT . "SUPPORTED$NRM\n";
1565 print $WHT . "NOT SUPPORTED$NRM\n";
1568 print $WHT . "ERROR DETECTING$NRM\n";
1572 print "Testing DIGEST-MD5:\t";
1573 $tmp=detect_auth_support
('SMTP',$host,'DIGEST-MD5');
1574 if (defined($tmp)) {
1575 if ($tmp eq 'YES') {
1576 print $WHT . "SUPPORTED$NRM\n";
1578 print $WHT . "NOT SUPPORTED$NRM\n";
1581 print $WHT . "ERROR DETECTING$NRM\n";
1585 print "\nWhat authentication mechanism do you want to use for SMTP connections?\n";
1586 print $WHT . "none" . $NRM . " - Your SMTP server does not require authorization.\n";
1587 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1588 print $WHT . "plain" . $NRM . " - SASL PLAIN. You already know it if you need this.\n";
1589 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext.\n";
1590 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1591 print $WHT . "\n*** YOUR SMTP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n" . $NRM;
1592 print "If you don't understand or are unsure, you probably want \"none\"\n\n";
1593 print "none, login, cram-md5, or digest-md5 [$WHT$smtp_auth_mech$NRM]: $WHT";
1596 if ($inval =~ /^none\b/i) {
1597 # remove sitewide smtp authentication information
1598 $smtp_sitewide_user = '';
1599 $smtp_sitewide_pass = '';
1600 # SMTP doesn't necessarily require logins
1602 } elsif ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) ||
1603 ($inval =~ /^login\b/i) || ($inval =~/^plain\b/i)) {
1604 command_smtp_sitewide_userpass
($inval);
1606 } elsif (trim
($inval) eq '') {
1607 # user selected default value
1608 command_smtp_sitewide_userpass
($smtp_auth_mech);
1609 return $smtp_auth_mech;
1611 # user entered garbage
1612 return $smtp_auth_mech;
1616 sub command_smtp_sitewide_userpass
($) {
1617 # get first function argument
1618 my $auth_mech = shift(@_);
1620 $auth_mech = lc(trim
($auth_mech));
1621 if ($auth_mech eq 'none') {
1624 print "SMTP authentication uses IMAP username and password by default.\n";
1626 print "Would you like to use other login and password for all SquirrelMail \n";
1627 print "SMTP connections?";
1628 if ($smtp_sitewide_user ne '') {
1645 $smtp_sitewide_user = '';
1646 $smtp_sitewide_pass = '';
1647 } elsif ($tmp eq 'y') {
1648 print "Enter username [$smtp_sitewide_user]:";
1649 my $new_user = <STDIN
>;
1650 $new_user = trim
($new_user);
1651 if ($new_user ne '') {
1652 $smtp_sitewide_user = $new_user;
1654 if ($smtp_sitewide_user ne '') {
1655 print "If you don't enter any password, current sitewide password will be used.\n";
1656 print "If you enter space, password will be set to empty string.\n";
1657 print "Enter password:";
1658 my $new_pass = <STDIN
>;
1659 if ($new_pass ne "\n") {
1660 $smtp_sitewide_pass = trim
($new_pass);
1663 print "Invalid input. You must set username used for SMTP authentication.\n";
1664 print "Click enter to continue\n";
1668 print "Invalid input\n";
1669 print "Click enter to continue\n";
1674 # Sub adds information about SMTP authentication type to menu
1675 sub display_smtp_sitewide_userpass
() {
1677 if ($smtp_auth_mech ne 'none') {
1678 if ($smtp_sitewide_user ne '') {
1679 $ret = ' (with custom username and password)';
1681 $ret = ' (with IMAP username and password)';
1688 # This sub is reused for IMAP and SMTP
1689 # Args: service name, default value
1690 sub command_use_tls
{
1691 my($default_val,$service,$inval);
1694 print "TLS (Transport Layer Security) encrypts the traffic between server and client.\n";
1695 print "STARTTLS extensions allow to start encryption on existing plain text connection.\n";
1696 print "These options add specific PHP and IMAP server configuration requirements.\n";
1697 print "See SquirrelMail documentation about connection security.\n";
1699 print "If your " . $service . " server is localhost, you can safely disable this.\n";
1700 print "If it is remote, you may wish to seriously consider enabling this.\n";
1702 while ($valid_input eq 0) {
1703 print "\nSelect connection security model:\n";
1704 print " 0 - Use plain text connection\n";
1705 print " 1 - Use TLS connection\n";
1706 print " 2 - Use STARTTLS extension\n";
1707 print "Select [$default_val]: ";
1709 $inval=trim
($inval);
1710 if ($inval =~ /^[012]$/ || $inval eq '') {
1714 if ($inval ne '') {$default_val = $inval};
1715 return $default_val;
1718 # This sub is used to display human readable text for
1719 # $use_imap_tls and $use_smtp_tls values in conf.pl menu
1720 sub display_use_tls
($) {
1721 my $val = shift(@_);
1722 my $ret = 'disabled';
1725 } elsif ($val eq '1') {
1731 # $encode_header_key
1733 print "Encryption key allows to hide SquirrelMail Received: headers\n";
1734 print "in outbound messages. Interface uses encryption key to encode\n";
1735 print "username, remote address and proxied address, then stores encoded\n";
1736 print "information in X-Squirrel-* headers.\n";
1738 print "Warning: used encryption function is not bulletproof. When used\n";
1739 print "with static encryption keys, it provides only minimal security\n";
1740 print "measures and information can be decoded quickly.\n";
1742 print "Encoded information can be decoded with decrypt_headers.php script\n";
1743 print "from SquirrelMail contrib/ directory.\n";
1745 print "Enter encryption key: ";
1746 $new_encode_header_key = <STDIN
>;
1747 if ( $new_encode_header_key eq "\n" ) {
1748 $new_encode_header_key = $encode_header_key;
1750 $new_encode_header_key =~ s/[\r\n]//g;
1752 return $new_encode_header_key;
1757 print "\nYou can now create the welcome message that is displayed\n";
1758 print "every time a user logs on. You can use HTML or just plain\n";
1760 "text. If you do not wish to have one, just make it blank.\n\n(Type @ on a blank line to exit)\n";
1766 $line =~ s/[\r\n]//g;
1767 if ( $line ne "@" ) {
1768 $line =~ s/ /\ \ /g;
1769 $line =~ s/\t/\ \ \ \ /g;
1771 $line =~ s/\"/\\\"/g;
1773 $new_motd = $new_motd . $line;
1775 } while ( $line ne "@" );
1779 ################# PLUGINS ###################
1782 $command =~ s/[\s\n\r]*//g;
1783 if ( $command > 0 ) {
1784 $command = $command - 1;
1785 if ( $command <= $#plugins ) {
1788 while ( $ct <= $#plugins ) {
1789 if ( $ct != $command ) {
1790 @newplugins = ( @newplugins, $plugins[$ct] );
1794 @plugins = @newplugins;
1795 } elsif ( $command <= $#plugins + $#unused_plugins + 1 ) {
1796 $num = $command - $#plugins - 1;
1797 @newplugins = @plugins;
1799 while ( $ct <= $#unused_plugins ) {
1800 if ( $ct == $num ) {
1801 @newplugins = ( @newplugins, $unused_plugins[$ct] );
1805 @plugins = @newplugins;
1811 # disable_plugins_user
1813 print "When all active plugins are disabled, they can be disabled only\n";
1814 print "for the one user named here. If left blank, plugins will be\n";
1815 print "disabled for ALL users. This setting has no effect if plugins\n";
1816 print "are not disabled.\n";
1818 print "This must be the exact IMAP login name for the desired user.\n";
1820 print "[$WHT$disable_plugins_user$NRM]: $WHT";
1821 $new_disable_plugins_user = <STDIN
>;
1822 if ( $new_disable_plugins_user eq "\n" ) {
1823 $new_disable_plugins_user = $disable_plugins_user;
1825 $new_disable_plugins_user =~ s/[\r\n]//g;
1827 return $new_disable_plugins_user;
1830 ################# FOLDERS ###################
1832 # default_folder_prefix
1834 print "Some IMAP servers (UW, for example) store mail and folders in\n";
1835 print "your user space in a separate subdirectory. This is where you\n";
1836 print "specify what that directory is.\n";
1838 print "EXAMPLE: mail/";
1840 print "NOTE: If you use Cyrus, or some server that would not use this\n";
1841 print " option, you must set this to 'none'.\n";
1843 print "[$WHT$default_folder_prefix$NRM]: $WHT";
1844 $new_default_folder_prefix = <STDIN
>;
1846 if ( $new_default_folder_prefix eq "\n" ) {
1847 $new_default_folder_prefix = $default_folder_prefix;
1849 $new_default_folder_prefix =~ s/[\r\n]//g;
1851 if ( ( $new_default_folder_prefix =~ /^\s*$/ ) || ( $new_default_folder_prefix =~ m/^none$/i ) ) {
1852 $new_default_folder_prefix = "";
1854 # add the trailing delimiter only if we know what the server is.
1855 if (($imap_server_type eq 'cyrus' and
1856 $optional_delimiter eq 'detect') or
1857 ($imap_server_type eq 'courier' and
1858 $optional_delimiter eq 'detect')) {
1859 $new_default_folder_prefix =~ s/\.*$/\./;
1860 } elsif ($imap_server_type eq 'uw' and
1861 $optional_delimiter eq 'detect') {
1862 $new_default_folder_prefix =~ s/\/*$/\
//;
1865 return $new_default_folder_prefix;
1868 # Show Folder Prefix
1870 print "It is possible to set up the default folder prefix as a user\n";
1871 print "specific option, where each user can specify what their mail\n";
1872 print "folder is. If you set this to false, they will never see the\n";
1873 print "option, but if it is true, this option will appear in the\n";
1874 print "'options' section.\n";
1876 print "NOTE: You set the default folder prefix in option '1' of this\n";
1877 print " section. That will be the default if the user doesn't\n";
1878 print " specify anything different.\n";
1881 if ( lc($show_prefix_option) eq 'true' ) {
1882 $default_value = "y";
1884 $default_value = "n";
1887 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
1888 $new_show = <STDIN
>;
1889 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1890 $show_prefix_option = 'true';
1892 $show_prefix_option = 'false';
1894 return $show_prefix_option;
1899 print "You can now specify where the default trash folder is located.\n";
1900 print "On servers where you do not want this, you can set it to anything\n";
1901 print "and set option 6 to false.\n";
1903 print "This is relative to where the rest of your email is kept. You do\n";
1904 print "not need to worry about their mail directory. If this folder\n";
1905 print "would be ~/mail/trash on the filesystem, you only need to specify\n";
1906 print "that this is 'trash', and be sure to put 'mail/' in option 1.\n";
1909 print "[$WHT$trash_folder$NRM]: $WHT";
1910 $new_trash_folder = <STDIN
>;
1911 if ( $new_trash_folder eq "\n" ) {
1912 $new_trash_folder = $trash_folder;
1914 if (check_imap_folder
($new_trash_folder)) {
1915 $new_trash_folder =~ s/[\r\n]//g;
1917 $new_trash_folder = $trash_folder;
1920 return $new_trash_folder;
1925 print "This is where messages that are sent will be stored. SquirrelMail\n";
1926 print "by default puts a copy of all outgoing messages in this folder.\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/sent on the filesystem, you only need to specify\n";
1931 print "that this is 'sent', and be sure to put 'mail/' in option 1.\n";
1934 print "[$WHT$sent_folder$NRM]: $WHT";
1935 $new_sent_folder = <STDIN
>;
1936 if ( $new_sent_folder eq "\n" ) {
1937 $new_sent_folder = $sent_folder;
1939 if (check_imap_folder
($new_sent_folder)) {
1940 $new_sent_folder =~ s/[\r\n]//g;
1942 $new_sent_folder = $sent_folder;
1945 return $new_sent_folder;
1950 print "You can now specify where the default draft folder is located.\n";
1951 print "On servers where you do not want this, you can set it to anything\n";
1952 print "and set option 9 to false.\n";
1954 print "This is relative to where the rest of your email is kept. You do\n";
1955 print "not need to worry about their mail directory. If this folder\n";
1956 print "would be ~/mail/drafts on the filesystem, you only need to specify\n";
1957 print "that this is 'drafts', and be sure to put 'mail/' in option 1.\n";
1960 print "[$WHT$draft_folder$NRM]: $WHT";
1961 $new_draft_folder = <STDIN
>;
1962 if ( $new_draft_folder eq "\n" ) {
1963 $new_draft_folder = $draft_folder;
1965 if (check_imap_folder
($new_draft_folder)) {
1966 $new_draft_folder =~ s/[\r\n]//g;
1968 $new_draft_folder = $draft_folder;
1971 return $new_draft_folder;
1974 # default move to trash
1976 print "By default, should messages get moved to the trash folder? You\n";
1977 print "can specify the default trash folder in option 3. If this is set\n";
1978 print "to false, messages will get deleted immediately without moving\n";
1979 print "to the trash folder.\n";
1981 print "Trash folder is currently: $trash_folder\n";
1984 if ( lc($default_move_to_trash) eq 'true' ) {
1985 $default_value = "y";
1987 $default_value = "n";
1989 print "By default, move to trash (y/n) [$WHT$default_value$NRM]: $WHT";
1990 $new_show = <STDIN
>;
1991 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1992 $default_move_to_trash = 'true';
1994 $default_move_to_trash = 'false';
1996 return $default_move_to_trash;
1999 # default move to sent (save sent messages)
2001 print "By default, should copies of outgoing messages get saved in the\n";
2002 print "sent folder? You can specify the default sent folder in option 4.\n";
2003 print "If this is set to false, messages will get sent and no copy will\n";
2006 print "Sent folder is currently: $sent_folder\n";
2009 if ( lc($default_move_to_sent) eq 'true' ) {
2010 $default_value = "y";
2012 $default_value = "n";
2014 print "By default, save sent messages (y/n) [$WHT$default_value$NRM]: $WHT";
2015 $new_show = <STDIN
>;
2016 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2017 $default_move_to_sent = 'true';
2019 $default_move_to_sent = 'false';
2021 return $default_move_to_sent;
2024 # default save as draft
2026 print "By default, should the save to draft option be shown? You can\n";
2027 print "specify the default drafts folder in option 5. If this is set\n";
2028 print "to false, users will not be shown the save to draft option.\n";
2030 print "Drafts folder is currently: $draft_folder\n";
2033 if ( lc($default_save_as_draft) eq 'true' ) {
2034 $default_value = "y";
2036 $default_value = "n";
2038 print "By default, save as draft (y/n) [$WHT$default_value$NRM]: $WHT";
2039 $new_show = <STDIN
>;
2040 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2041 $default_save_as_draft = 'true';
2043 $default_save_as_draft = 'false';
2045 return $default_save_as_draft;
2048 # List special folders first
2050 print "SquirrelMail has what we call 'special folders' that are not\n";
2051 print "manipulated and viewed like normal folders. Some examples of\n";
2052 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
2053 print "Simply asks if you want these folders listed first in the folder\n";
2057 if ( lc($list_special_folders_first) eq 'true' ) {
2058 $default_value = "y";
2060 $default_value = "n";
2063 print "List first (y/n) [$WHT$default_value$NRM]: $WHT";
2064 $new_show = <STDIN
>;
2065 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2066 $list_special_folders_first = 'true';
2068 $list_special_folders_first = 'false';
2070 return $list_special_folders_first;
2073 # Show special folders color
2075 print "SquirrelMail has what we call 'special folders' that are not\n";
2076 print "manipulated and viewed like normal folders. Some examples of\n";
2077 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
2078 print "wants to know if we should display special folders in a\n";
2079 print "color than the other folders.\n";
2082 if ( lc($use_special_folder_color) eq 'true' ) {
2083 $default_value = "y";
2085 $default_value = "n";
2088 print "Show color (y/n) [$WHT$default_value$NRM]: $WHT";
2089 $new_show = <STDIN
>;
2090 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2091 $use_special_folder_color = 'true';
2093 $use_special_folder_color = 'false';
2095 return $use_special_folder_color;
2100 print "The way that IMAP handles deleting messages is as follows. You\n";
2101 print "mark the message as deleted, and then to 'really' delete it, you\n";
2102 print "expunge it. This option asks if you want to just have messages\n";
2103 print "marked as deleted, or if you want SquirrelMail to expunge the \n";
2104 print "messages too.\n";
2107 if ( lc($auto_expunge) eq 'true' ) {
2108 $default_value = "y";
2110 $default_value = "n";
2112 print "Auto expunge (y/n) [$WHT$default_value$NRM]: $WHT";
2113 $new_show = <STDIN
>;
2114 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2115 $auto_expunge = 'true';
2117 $auto_expunge = 'false';
2119 return $auto_expunge;
2122 # Default sub of inbox
2124 print "Some IMAP servers (Cyrus) have all folders as subfolders of INBOX.\n";
2125 print "This can cause some confusion in folder creation for users when\n";
2126 print "they try to create folders and don't put it as a subfolder of INBOX\n";
2127 print "and get permission errors. This option asks if you want folders\n";
2128 print "to be subfolders of INBOX by default.\n";
2131 if ( lc($default_sub_of_inbox) eq 'true' ) {
2132 $default_value = "y";
2134 $default_value = "n";
2136 print "Default sub of INBOX (y/n) [$WHT$default_value$NRM]: $WHT";
2137 $new_show = <STDIN
>;
2138 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2139 $default_sub_of_inbox = 'true';
2141 $default_sub_of_inbox = 'false';
2143 return $default_sub_of_inbox;
2146 # Show contain subfolder option
2148 print "Some IMAP servers (UW) make it so that there are two types of\n";
2149 print "folders. Those that contain messages, and those that contain\n";
2150 print "subfolders. If this is the case for your server, set this to\n";
2151 print "true, and it will ask the user whether the folder they are\n";
2152 print "creating contains subfolders or messages.\n";
2155 if ( lc($show_contain_subfolders_option) eq 'true' ) {
2156 $default_value = "y";
2158 $default_value = "n";
2160 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
2161 $new_show = <STDIN
>;
2162 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2163 $show_contain_subfolders_option = 'true';
2165 $show_contain_subfolders_option = 'false';
2167 return $show_contain_subfolders_option;
2170 # Default Unseen Notify
2172 print "This option specifies where the users will receive notification\n";
2173 print "about unseen messages by default. This is of course an option that\n";
2174 print "can be changed on a user level.\n";
2175 print " 1 = No notification\n";
2176 print " 2 = Only on the INBOX\n";
2177 print " 3 = On all folders\n";
2180 print "Which one should be default (1,2,3)? [$WHT$default_unseen_notify$NRM]: $WHT";
2181 $new_show = <STDIN
>;
2182 if ( $new_show =~ /^[123]\n/i ) {
2183 $default_unseen_notify = $new_show;
2185 $default_unseen_notify =~ s/[\r\n]//g;
2186 return $default_unseen_notify;
2189 # Default Unseen Type
2191 print "Here you can define the default way that unseen messages will be displayed\n";
2192 print "to the user in the folder listing on the left side.\n";
2193 print " 1 = Only unseen messages (4)\n";
2194 print " 2 = Unseen and Total messages (4/27)\n";
2197 print "Which one should be default (1,2)? [$WHT$default_unseen_type$NRM]: $WHT";
2198 $new_show = <STDIN
>;
2199 if ( $new_show =~ /^[12]\n/i ) {
2200 $default_unseen_type = $new_show;
2202 $default_unseen_type =~ s/[\r\n]//g;
2203 return $default_unseen_type;
2206 # Auto create special folders
2208 print "Would you like the Sent, Trash, and Drafts folders to be created\n";
2209 print "automatically print for you when a user logs in? If the user\n";
2210 print "accidentally deletes their special folders, this option will\n";
2211 print "automatically create it again for them.\n";
2214 if ( lc($auto_create_special) eq 'true' ) {
2215 $default_value = "y";
2217 $default_value = "n";
2219 print "Auto create special folders? (y/n) [$WHT$default_value$NRM]: $WHT";
2220 $new_show = <STDIN
>;
2221 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2222 $auto_create_special = 'true';
2224 $auto_create_special = 'false';
2226 return $auto_create_special;
2229 # Automatically delete folders
2231 if ( $imap_server_type eq "uw" ) {
2232 print "UW IMAP servers will not allow folders containing mail to also contain folders.\n";
2233 print "Deleting folders will bypass the trash folder and be immediately deleted\n\n";
2234 print "If this is not the correct value for your server,\n";
2235 print "please use option D on the Main Menu to configure your server correctly.\n\n";
2236 print "Press enter to continue...\n";
2237 $new_delete = <STDIN
>;
2238 $delete_folder = 'true';
2240 if ( $imap_server_type eq "courier" ) {
2241 print "Courier (or Courier-IMAP) IMAP servers may not support ";
2242 print "subfolders of Trash. \n";
2243 print "Specifically, if Courier is set to always move messages to Trash, \n";
2244 print "Trash will be treated by Courier as a special folder that does not \n";
2245 print "allow subfolders. \n\n";
2246 print "Please verify your Courier configuration, and test folder deletion \n";
2247 print "when changing this setting.\n\n";
2250 print "Are subfolders of the Trash supported by your IMAP server?\n";
2251 print "If so, should deleted folders be sent to Trash?\n";
2252 print "If not, say no (deleted folders should not be sent to Trash)\n\n";
2253 # reversal of logic.
2254 # question was: Should folders be automatically deleted instead of sent to trash..
2255 # we've changed the question to make it more clear,
2256 # and are here handling that to avoid changing the answers..
2257 if ( lc($delete_folder) eq 'true' ) {
2258 $default_value = "n";
2260 $default_value = "y";
2262 print "Send deleted folders to Trash? (y/n) [$WHT$default_value$NRM]: $WHT";
2263 $new_delete = <STDIN
>;
2264 if ( ( $new_delete =~ /^y\n/i ) || ( ( $new_delete =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2265 $delete_folder = 'false';
2267 $delete_folder = 'true';
2270 return $delete_folder;
2275 print "Some IMAP servers allow subfolders to exist even if the parent\n";
2276 print "folders do not. This fixes some problems with the folder list\n";
2277 print "when this is the case, causing the /NoSelect folders to be displayed\n";
2280 if ( lc($noselect_fix_enable) eq 'true' ) {
2281 $default_value = "y";
2283 $default_value = "n";
2285 print "enable noselect fix? (y/n) [$WHT$noselect_fix_enable$NRM]: $WHT";
2286 $noselect_fix_enable = <STDIN
>;
2287 if ( ( $noselect_fix_enable =~ /^y\n/i ) || ( ( $noselect_fix_enable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2288 $noselect_fix_enable = 'true';
2290 $noselect_fix_enable = 'false';
2292 return $noselect_fix_enable;
2294 ############# GENERAL OPTIONS #####################
2298 print "Specify the location for your data directory.\n";
2299 print "You need to create this directory yourself.\n";
2300 print "The path name can be absolute or relative (to the config directory).\n";
2301 print "Here are two examples:\n";
2302 print " Absolute: /var/local/squirrelmail/data/\n";
2303 print " Relative: ../data/\n";
2304 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2305 print "will be converted to their absolute path equivalents in config.php.\n\n";
2306 print "Note: There are potential security risks with having a writeable directory\n";
2307 print "under the web server's root directory (ex: /home/httpd/html).\n";
2308 print "For this reason, it is recommended to put the data directory\n";
2309 print "in an alternate location of your choice. \n";
2312 print "[$WHT$data_dir$NRM]: $WHT";
2313 $new_data_dir = <STDIN
>;
2314 if ( $new_data_dir eq "\n" ) {
2315 $new_data_dir = $data_dir;
2317 $new_data_dir =~ s/[\r\n]//g;
2319 if ( $new_data_dir =~ /^\s*$/ ) {
2322 $new_data_dir =~ s/\/*$//g
;
2323 $new_data_dir =~ s/$/\//g
;
2325 return $new_data_dir;
2328 # Attachment directory
2330 print "Path to directory used for storing attachments while a mail is\n";
2331 print "being composed. The path name can be absolute or relative (to the\n";
2332 print "config directory). Here are two examples:\n";
2333 print " Absolute: /var/local/squirrelmail/attach/\n";
2334 print " Relative: ../attach/\n";
2335 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2336 print "will be converted to their absolute path equivalents in config.php.\n\n";
2337 print "Note: There are a few security considerations regarding this\n";
2338 print "directory:\n";
2339 print " 1. It should have the permission 733 (rwx-wx-wx) to make it\n";
2340 print " impossible for a random person with access to the webserver\n";
2341 print " to list files in this directory. Confidential data might\n";
2342 print " be laying around in there.\n";
2343 print " Depending on your user:group assignments, 730 (rwx-wx---)\n";
2344 print " may be possible, and more secure (e.g. root:apache)\n";
2345 print " 2. Since the webserver is not able to list the files in the\n";
2346 print " content is also impossible for the webserver to delete files\n";
2347 print " lying around there for too long.\n";
2348 print " 3. It should probably be another directory than the data\n";
2349 print " directory specified in option 3.\n";
2352 print "[$WHT$attachment_dir$NRM]: $WHT";
2353 $new_attachment_dir = <STDIN
>;
2354 if ( $new_attachment_dir eq "\n" ) {
2355 $new_attachment_dir = $attachment_dir;
2357 $new_attachment_dir =~ s/[\r\n]//g;
2359 if ( $new_attachment_dir =~ /^\s*$/ ) {
2360 $new_attachment_dir = "";
2362 $new_attachment_dir =~ s/\/*$//g
;
2363 $new_attachment_dir =~ s/$/\//g
;
2365 return $new_attachment_dir;
2369 print "The directory hash level setting allows you to configure the level\n";
2370 print "of hashing that SquirrelMail employs in your data and attachment\n";
2371 print "directories. This value must be an integer ranging from 0 to 4.\n";
2372 print "When this value is set to 0, SquirrelMail will simply store all\n";
2373 print "files as normal in the data and attachment directories. However,\n";
2374 print "when set to a value from 1 to 4, a simple hashing scheme will be\n";
2375 print "used to organize the files in this directory. In short, the crc32\n";
2376 print "value for a username will be computed. Then, up to the first 4\n";
2377 print "digits of the hash, as set by this configuration value, will be\n";
2378 print "used to directory hash the files for that user in the data and\n";
2379 print "attachment directory. This allows for better performance on\n";
2380 print "servers with larger numbers of users.\n";
2383 print "[$WHT$dir_hash_level$NRM]: $WHT";
2384 $new_dir_hash_level = <STDIN
>;
2385 if ( $new_dir_hash_level eq "\n" ) {
2386 $new_dir_hash_level = $dir_hash_level;
2388 $new_dir_hash_level =~ s/[\r\n]//g;
2390 if ( ( int($new_dir_hash_level) < 0 )
2391 || ( int($new_dir_hash_level) > 4 )
2392 || !( int($new_dir_hash_level) eq $new_dir_hash_level ) ) {
2393 print "Invalid Directory Hash Level.\n";
2394 print "Value must be an integer ranging from 0 to 4\n";
2395 print "Hit enter to continue.\n";
2396 $enter_key = <STDIN
>;
2398 $new_dir_hash_level = $dir_hash_level;
2401 return $new_dir_hash_level;
2405 print "This is the default size (in pixels) of the left folder list.\n";
2406 print "Default is 200, but you can set it to whatever you wish. This\n";
2407 print "is a user preference, so this will only show up as their default.\n";
2409 print "[$WHT$default_left_size$NRM]: $WHT";
2410 $new_default_left_size = <STDIN
>;
2411 if ( $new_default_left_size eq "\n" ) {
2412 $new_default_left_size = $default_left_size;
2414 $new_default_left_size =~ s/[\r\n]//g;
2416 return $new_default_left_size;
2420 print "Some IMAP servers only have lowercase letters in the usernames\n";
2421 print "but they still allow people with uppercase to log in. This\n";
2422 print "causes a problem with the user's preference files. This option\n";
2423 print "transparently changes all usernames to lowercase.";
2426 if ( lc($force_username_lowercase) eq 'true' ) {
2427 $default_value = "y";
2429 $default_value = "n";
2431 print "Convert usernames to lowercase (y/n) [$WHT$default_value$NRM]: $WHT";
2432 $new_show = <STDIN
>;
2433 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2443 if ( lc($default_use_priority) eq 'true' ) {
2444 $default_value = "y";
2446 $default_value = "n";
2449 print "Allow users to specify priority of outgoing mail (y/n) [$WHT$default_value$NRM]: $WHT";
2450 $new_show = <STDIN
>;
2451 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2461 if ( lc($hide_sm_attributions) eq 'true' ) {
2462 $default_value = "y";
2464 $default_value = "n";
2467 print "Hide SM attributions (y/n) [$WHT$default_value$NRM]: $WHT";
2468 $new_show = <STDIN
>;
2469 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2479 if ( lc($default_use_mdn) eq 'true' ) {
2480 $default_value = "y";
2482 $default_value = "n";
2485 print "Enable support for read/delivery receipt support (y/n) [$WHT$default_value$NRM]: $WHT";
2486 $new_show = <STDIN
>;
2487 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2495 print " In loosely managed environments, you may want to allow users
2496 to edit their full name and email address. In strictly managed
2497 environments, you may want to force users to use the name
2498 and email address assigned to them.
2500 'y' - allow a user to edit their full name and email address,
2501 'n' - users must use the assigned values.
2505 if ( lc($edit_identity) eq 'true' ) {
2506 $default_value = "y";
2508 $default_value = "n";
2510 print "Allow editing of user's identity? (y/n) [$WHT$default_value$NRM]: $WHT";
2511 $new_edit = <STDIN
>;
2512 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2513 $edit_identity = 'true';
2514 $edit_name = 'true';
2515 $hide_auth_header = command311b
();
2517 $edit_identity = 'false';
2518 $edit_name = command311
();
2519 $hide_auth_header = command311b
();
2521 return $edit_identity;
2525 print " Given that users are not allowed to modify their
2526 email address, can they edit their full name?
2530 if ( lc($edit_name) eq 'true' ) {
2531 $default_value = "y";
2533 $default_value = "n";
2535 print "Allow the user to edit their full name? (y/n) [$WHT$default_value$NRM]: $WHT";
2536 $new_edit = <STDIN
>;
2537 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2538 $edit_name = 'true';
2540 $edit_name = 'false';
2546 print " SquirrelMail adds username information to every sent email
2547 in order to prevent possible sender forging when users are allowed
2548 to change their email and/or full name.
2550 You can remove user information from this header (y), if you think that
2551 it violates privacy or security.
2553 Note: If users are allowed to change their email addresses,
2554 this setting will make it difficult to determine who sent what where.
2555 Use at your own risk.
2559 if ( lc($hide_auth_header) eq "true" ) {
2560 $default_value = "y";
2562 $default_value = "n";
2564 print "Remove username from email headers? (y/n) [$WHT$default_value$NRM]: $WHT";
2565 $new_header = <STDIN
>;
2566 if ( ( $new_header =~ /^y\n/i ) || ( ( $new_header =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2567 $hide_auth_header = "true";
2569 $hide_auth_header = "false";
2571 return $hide_auth_header;
2575 print "This option allows you to disable server side thread sorting if your server \n";
2576 print "declares THREAD support, but you don't want to provide threading options \n";
2577 print "to end users or THREAD extension is broken or extension does not work with \n";
2578 print "options used by SquirrelMail. Option is not used, if THREAD extension is \n";
2579 print "not declared in IMAP CAPABILITY.\n";
2582 if ( lc($disable_thread_sort) eq 'true' ) {
2583 $default_value = "y";
2585 $default_value = "n";
2587 print "Disable server side thread sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2588 $disable_thread_sort = <STDIN
>;
2589 if ( ( $disable_thread_sort =~ /^y\n/i ) || ( ( $disable_thread_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2590 $disable_thread_sort = 'true';
2592 $disable_thread_sort = 'false';
2594 return $disable_thread_sort;
2598 print "This option allows you to disable server side sorting if your server declares \n";
2599 print "SORT support, but SORT extension is broken or does not work with options \n";
2600 print "used by SquirrelMail. Option is not used, if SORT extension is not declared \n";
2601 print "in IMAP CAPABILITY.\n";
2603 print "It is strongly recommended to keep server side sorting enabled, if your ";
2604 print "IMAP server supports it.";
2607 if ( lc($disable_server_sort) eq 'true' ) {
2608 $default_value = "y";
2610 $default_value = "n";
2612 print "Disable server-side sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2613 $disable_server_sort = <STDIN
>;
2614 if ( ( $disable_server_sort =~ /^y\n/i ) || ( ( $disable_server_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2615 $disable_server_sort = 'true';
2617 $disable_server_sort = 'false';
2619 return $disable_server_sort;
2623 print "This option allows you to choose if SM uses charset search\n";
2624 print "Your IMAP server must support the SEARCH CHARSET command for this to work\n";
2627 if ( lc($allow_charset_search) eq 'true' ) {
2628 $default_value = "y";
2630 $default_value = "n";
2632 print "Allow charset searching? (y/n) [$WHT$default_value$NRM]: $WHT";
2633 $allow_charset_search = <STDIN
>;
2634 if ( ( $allow_charset_search =~ /^y\n/i ) || ( ( $allow_charset_search =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2635 $allow_charset_search = 'true';
2637 $allow_charset_search = 'false';
2639 return $allow_charset_search;
2642 # command315 (UID support) obsoleted.
2644 # advanced search option
2646 print "This option allows you to control the use of advanced search form.\n";
2647 print " 0 = enable basic search only\n";
2648 print " 1 = enable advanced search only\n";
2649 print " 2 = enable both\n";
2652 print "Allowed search (0,1,2)? [$WHT$allow_advanced_search$NRM]: $WHT";
2653 $new_allow_advanced_search = <STDIN
>;
2654 if ( $new_allow_advanced_search =~ /^[012]\n/i ) {
2655 $allow_advanced_search = $new_allow_advanced_search;
2657 $allow_advanced_search =~ s/[\r\n]//g;
2658 return $allow_advanced_search;
2663 print "This option allows you to change the name of the PHP session used\n";
2664 print "by SquirrelMail. Unless you know what you are doing, you probably\n";
2665 print "don't need or want to change this from the default of SQMSESSID.\n";
2666 print "[$WHT$session_name$NRM]: $WHT";
2667 $new_session_name = <STDIN
>;
2668 chomp($new_session_name);
2669 if ( $new_session_name eq "" ) {
2670 $new_session_name = $session_name;
2672 return $new_session_name;
2675 # time zone config (since 1.5.1)
2677 print "This option allows you to control the use of time zones.\n";
2678 print " 0 = (default) standard, GNU C time zone names\n";
2679 print " 1 = strict, generic time zone codes with offsets\n";
2680 print " 2 = custom, GNU C time zones loaded from config/timezones.php\n";
2681 print " 3 = custom strict, generic time zone codes with offsets loaded \n";
2682 print " from config/timezones.php\n";
2683 print "See SquirrelMail documentation about format of config/timezones.php file.\n";
2686 print "Desired time zone configuration (0,1,2,3)? [$WHT$time_zone_type$NRM]: $WHT";
2687 $new_time_zone_type = <STDIN
>;
2688 if ( $new_time_zone_type =~ /^[0123]\n/i ) {
2689 $time_zone_type = $new_time_zone_type;
2691 print "\nInvalid configuration value.\n";
2692 print "\nPress enter to continue...";
2695 $time_zone_type =~ s/[\r\n]//g;
2696 return $time_zone_type;
2699 # set the location base for redirects (since 1.5.2)
2700 sub command_config_location_base
{
2701 print "Here you can set the base part of the SquirrelMail URL.\n";
2702 print "It is normally autodetected but if that fails, use this\n";
2703 print "option to override.\n";
2704 print "It should contain only the protocol and hostname/port parts\n";
2705 print "of the URL; the full path will be appended automatically.\n\n";
2706 print "Examples:\nhttp://webmail.example.org\nhttp://webmail.example.com:8080\nhttps://webmail.example.com:6691\n\n";
2707 print "Do not add any path elements.\n";
2709 print "URL base? [" .$WHT."autodetect$NRM]: $WHT";
2710 $new_config_location_base = <STDIN
>;
2711 chomp($new_config_location_base);
2712 $config_location_base = $new_config_location_base;
2714 return $config_location_base;
2717 # only_secure_cookies (since 1.5.2)
2719 print "This option allows you to specify that if a user session is initiated\n";
2720 print "under a secure (HTTPS, SSL-encrypted) connection, the cookies given to\n";
2721 print "the browser will ONLY be transmitted via a secure connection henceforth.\n\n";
2722 print "Generally this is a Good Thing, and should NOT be disabled. However,\n";
2723 print "if you intend to use the Secure Login or Show SSL Link plugins to\n";
2724 print "encrypt the user login, but not the rest of the SquirrelMail session,\n";
2725 print "this can be turned off. Think twice before doing so.\n";
2728 if ( lc($only_secure_cookies) eq 'true' ) {
2729 $default_value = "y";
2731 $default_value = "n";
2733 print "Transmit cookies only on secure connection when available? (y/n) [$WHT$default_value$NRM]: $WHT";
2734 $only_secure_cookies = <STDIN
>;
2735 if ( ( $only_secure_cookies =~ /^y\n/i ) || ( ( $only_secure_cookies =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2736 $only_secure_cookies = 'true';
2738 $only_secure_cookies = 'false';
2740 return $only_secure_cookies;
2744 sub command_userThemes
{
2745 print "\nDefine the user themes that you wish to use. If you have added\n";
2746 print "a theme of your own, just follow the instructions (?) about\n";
2747 print "how to add them. You can also change the default theme.\n\n";
2749 print "Available user themes:\n";
2751 while ( $count <= $#user_theme_name ) {
2752 if ( $count == $user_theme_default ) {
2757 if ( $count < 10 ) {
2760 $name = $user_theme_name[$count];
2761 $num_spaces = 35 - length($name);
2762 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2763 $name = $name . " ";
2766 print " $count. $name";
2767 print "($user_theme_path[$count])\n";
2773 print ".------------------------------------.\n";
2774 print "| t (detect user themes) |\n";
2775 print "| + (add user theme) |\n";
2776 print "| - N (remove user theme) |\n";
2777 print "| m N (mark default user theme) |\n";
2778 print "| l (list user themes) |\n";
2779 print "| d (done) |\n";
2780 print "`------------------------------------'\n";
2782 print "\n[user_themes] command (?=help) > ";
2784 $input =~ s/[\r\n]//g;
2785 while ( $input ne "d" ) {
2786 if ( $input =~ /^\s*l\s*/i ) {
2788 while ( $count <= $#user_theme_name ) {
2789 if ( $count == $user_theme_default ) {
2794 if ( $count < 10 ) {
2797 $name = $user_theme_name[$count];
2798 $num_spaces = 35 - length($name);
2799 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2800 $name = $name . " ";
2803 print " $count. $name";
2804 print "($user_theme_path[$count])\n";
2808 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2809 $old_def = $user_theme_default;
2810 $user_theme_default = $input;
2811 $user_theme_default =~ s/^\s*m\s*//;
2812 if ( ( $user_theme_default > $#user_theme_name ) || ( $user_theme_default < 0 ) ) {
2813 print "Cannot set default theme to $user_theme_default. That theme does not exist.\n";
2814 $user_theme_default = $old_def;
2816 } elsif ( $input =~ /^\s*\+/ ) {
2817 print "What is the name of this theme? ";
2819 $name =~ s/[\r\n]//g;
2820 $user_theme_name[ $#user_theme_name + 1 ] = $name;
2821 print "Be sure to put ../css/ before the filename.\n";
2822 print "What file is this stored in (ex: ../css/my_theme/): ";
2824 $name =~ s/[\r\n]//g;
2825 $user_theme_path[ $#user_theme_path + 1 ] = $name;
2826 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2827 if ( $input =~ /[0-9]+\s*$/ ) {
2829 $rem_num =~ s/^\s*-\s*//g;
2830 $rem_num =~ s/\s*$//;
2832 $rem_num = $#user_theme_name;
2834 if ( $rem_num == $user_theme_default ) {
2835 print "You cannot remove the default theme!\n";
2838 @new_theme_name = ();
2839 @new_theme_path = ();
2840 while ( $count <= $#user_theme_name ) {
2841 if ( $count != $rem_num ) {
2842 @new_theme_name = ( @new_theme_name, $user_theme_name[$count] );
2843 @new_theme_path = ( @new_theme_path, $user_theme_path[$count] );
2847 @user_theme_name = @new_theme_name;
2848 @user_theme_path = @new_theme_path;
2849 if ( $user_theme_default > $rem_num ) {
2850 $user_theme_default--;
2853 } elsif ( $input =~ /^\s*t\s*/i ) {
2854 print "\nStarting detection...\n\n";
2856 opendir( DIR
, "../css" );
2857 @files = sort(readdir(DIR
));
2859 while ( $cnt <= $#files ) {
2860 $filename = "../css/" . $files[$cnt] .'/';
2861 if ( $files[$cnt] !~ /^\./ && $filename ne "../css/rtl.css" && -e
$filename . "default.css" ) {
2863 for ( $x = 0 ; $x <= $#user_theme_path ; $x++ ) {
2864 if ( $user_theme_path[$x] eq $filename ) {
2868 if ( $found != 1 ) {
2869 print "** Found user theme: $filename\n";
2870 $def = $files[$cnt];
2873 #$def =~ s/(^\w+)/ucfirst $1/eg;
2874 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
2875 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
2876 print " What is its name? [$def]: ";
2878 $nm =~ s/^\s+|\s+$|[\n\r]//g;
2879 if ( $nm eq '' ) { $nm = $def; }
2880 $user_theme_name[ $#user_theme_name + 1 ] = $nm;
2881 $user_theme_path[ $#user_theme_path + 1 ] = $filename;
2887 for ( $cnt = 0 ; $cnt <= $#user_theme_path ; $cnt++ ) {
2888 $filename = $user_theme_path[$cnt];
2889 if ( $filename != 'none' && !( -e
$filename ."/default.css" ) ) {
2890 print " Removing $filename (file not found)\n";
2892 @new_user_theme_name = ();
2893 @new_user_theme_path = ();
2894 for ( $x = 0 ; $x < $#user_theme_path ; $x++ ) {
2895 if ( $user_theme_path[$x] eq $filename ) {
2898 if ( $offset == 1 ) {
2899 $new_user_theme_name[$x] = $user_theme_name[ $x + 1 ];
2900 $new_user_theme_path[$x] = $user_theme_path[ $x + 1 ];
2902 $new_user_theme_name[$x] = $user_theme_name[$x];
2903 $new_user_theme_path[$x] = $user_theme_path[$x];
2906 @user_theme_name = @new_user_theme_name;
2907 @user_theme_path = @new_user_theme_path;
2910 print "\nDetection complete!\n\n";
2913 } elsif ( $input =~ /^\s*\?\s*/ ) {
2914 print ".------------------------------------.\n";
2915 print "| t (detect user themes) |\n";
2916 print "| + (add user theme) |\n";
2917 print "| - N (remove user theme) |\n";
2918 print "| m N (mark default user theme) |\n";
2919 print "| l (list user themes) |\n";
2920 print "| d (done) |\n";
2921 print "`------------------------------------'\n";
2923 print "[user_themes] command (?=help) > ";
2925 $input =~ s/[\r\n]//g;
2929 sub command_iconSets
{
2930 print "\nDefine the icon themes that you wish to use. If you have added\n";
2931 print "a theme of your own, just follow the instructions (?) about\n";
2932 print "how to add them. You can also change the default and fallback\n";
2933 print "themes. The default theme will be used when no icon theme is\n";
2934 print "set by the user. The fallback theme will be used if an icon\n";
2935 print "cannot be found in the currently selected icon theme.\n\n";
2937 print "Available icon themes:\n\n";
2940 while ( $count <= $#icon_theme_name ) {
2941 if ( $count == $icon_theme_def ) {
2946 if ( $count eq $icon_theme_fallback ) {
2951 if ( $count < 10 ) {
2954 $name = $icon_theme_name[$count];
2955 $num_spaces = 35 - length($name);
2956 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2957 $name = $name . " ";
2960 print " $count. $name";
2961 print "($icon_theme_path[$count])\n";
2966 print "\n d = Default icon theme\n";
2967 print " f = Fallback icon theme\n";
2969 print ".------------------------------------.\n";
2970 print "| t (detect icon themes) |\n";
2971 print "| + (add icon theme) |\n";
2972 print "| - N (remove icon theme) |\n";
2973 print "| m N (mark default icon theme) |\n";
2974 print "| f N (set fallback icon set) |\n";
2975 print "| l (list icon themes) |\n";
2976 print "| d (done) |\n";
2977 print "`------------------------------------'\n";
2979 print "\n[icon_themes] command (?=help) > ";
2981 $input =~ s/[\r\n]//g;
2982 while ( $input ne "d" ) {
2983 if ( $input =~ /^\s*l\s*/i ) {
2986 while ( $count <= $#icon_theme_name ) {
2987 if ( $count == $icon_theme_def ) {
2992 if ( $count eq $icon_theme_fallback ) {
2997 $name = $icon_theme_name[$count];
2998 $num_spaces = 35 - length($name);
2999 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3000 $name = $name . " ";
3003 print " $count. $name";
3004 print "($icon_theme_path[$count])\n";
3008 print "\n d = Default icon theme\n";
3009 print " f = Fallback icon theme\n\n";
3010 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
3011 $old_def = $icon_theme_def;
3012 $icon_theme_def = $input;
3013 $icon_theme_def =~ s/^\s*m\s*//;
3014 if ( ( $icon_theme_default > $#icon_theme_name ) || ( $icon_theme_default < 0 ) ) {
3015 print "Cannot set default icon theme to $icon_theme_default. That theme does not exist.\n";
3016 $icon_theme_def = $old_def;
3018 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
3019 $old_fb = $icon_theme_fallback;
3020 $icon_theme_fallback = $input;
3021 $icon_theme_fallback =~ s/^\s*f\s*//;
3022 if ( ( $icon_theme_fallback > $#icon_theme_name ) || ( $icon_theme_fallback < 0 ) ) {
3023 print "Cannot set fallback icon theme to $icon_theme_fallback. That theme does not exist.\n";
3024 $icon_theme_fallback = $old_fb;
3026 } elsif ( $input =~ /^\s*\+/ ) {
3027 print "What is the name of this icon theme? ";
3029 $name =~ s/[\r\n]//g;
3030 $icon_theme_name[ $#icon_theme_name + 1 ] = $name;
3031 print "Be sure to put ../images/themes/ before the filename.\n";
3032 print "What directory is this icon theme stored in (ex: ../images/themes/my_theme/)? ";
3034 $name =~ s/[\r\n]//g;
3035 $icon_theme_path[ $#icon_theme_path + 1 ] = $name;
3036 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3037 if ( $input =~ /[0-9]+\s*$/ ) {
3039 $rem_num =~ s/^\s*-\s*//g;
3040 $rem_num =~ s/\s*$//;
3042 $rem_num = $#icon_theme_name;
3044 if ( $rem_num == $icon_theme_def ) {
3045 print "You cannot remove the default icon theme!\n";
3046 } elsif ( $rem_num == $icon_theme_fallback ) {
3047 print "You cannot remove the fallback icon theme!\n";
3050 @new_theme_name = ();
3051 @new_theme_path = ();
3052 while ( $count <= $#icon_theme_name ) {
3053 if ( $count != $rem_num ) {
3054 @new_theme_name = ( @new_theme_name, $icon_theme_name[$count] );
3055 @new_theme_path = ( @new_theme_path, $icon_theme_path[$count] );
3059 @icon_theme_name = @new_theme_name;
3060 @icon_theme_path = @new_theme_path;
3061 if ( $icon_theme_def > $rem_num ) {
3065 } elsif ( $input =~ /^\s*t\s*/i ) {
3066 print "\nStarting detection...\n\n";
3068 opendir( DIR
, "../images/themes/" );
3069 @files = sort(readdir(DIR
));
3071 while ( $cnt <= $#files ) {
3072 $filename = "../images/themes/" . $files[$cnt] .'/';
3073 if ( -d
"../images/themes/" . $files[$cnt] && $files[$cnt] !~ /^\
./ && $files[$cnt] ne ".svn" ) {
3075 for ( $x = 0 ; $x <= $#icon_theme_path ; $x++ ) {
3076 if ( $icon_theme_path[$x] eq $filename ) {
3080 if ( $found != 1 ) {
3081 print "** Found icon theme: $filename\n";
3082 $def = $files[$cnt];
3085 #$def =~ s/(^\w+)/ucfirst $1/eg;
3086 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3087 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3088 print " What is its name? [$def]: ";
3090 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3091 if ( $nm eq '' ) { $nm = $def; }
3092 $icon_theme_name[ $#icon_theme_name + 1 ] = $nm;
3093 $icon_theme_path[ $#icon_theme_path + 1 ] = $filename;
3099 for ( $cnt = 0 ; $cnt <= $#icon_theme_path ; $cnt++ ) {
3100 $filename = $icon_theme_path[$cnt];
3101 if ( $filename ne "none" && $filename ne "template" && ! -d
$filename ) {
3102 print " Removing $filename (file not found)\n";
3104 @new_icon_theme_name = ();
3105 @new_icon_theme_path = ();
3106 for ( $x = 0 ; $x < $#icon_theme_path ; $x++ ) {
3107 if ( $icon_theme_path[$x] eq $filename ) {
3110 if ( $offset == 1 ) {
3111 $new_icon_theme_name[$x] = $icon_theme_name[ $x + 1 ];
3112 $new_icon_theme_path[$x] = $icon_theme_path[ $x + 1 ];
3114 $new_icon_theme_name[$x] = $icon_theme_name[$x];
3115 $new_icon_theme_path[$x] = $icon_theme_path[$x];
3118 @icon_theme_name = @new_icon_theme_name;
3119 @icon_theme_path = @new_icon_theme_path;
3122 print "\nDetection complete!\n\n";
3125 } elsif ( $input =~ /^\s*\?\s*/ ) {
3126 print ".------------------------------------.\n";
3127 print "| t (detect icon themes) |\n";
3128 print "| + (add icon theme) |\n";
3129 print "| - N (remove icon theme) |\n";
3130 print "| m N (mark default icon theme) |\n";
3131 print "| f N (set fallback icon set) |\n";
3132 print "| l (list icon themes) |\n";
3133 print "| d (done) |\n";
3134 print "`------------------------------------'\n";
3136 print "[icon_themes] command (?=help) > ";
3138 $input =~ s/[\r\n]//g;
3142 sub command_templates
{
3143 print "\nDefine the template sets (skins) that you wish to use. If you have added\n";
3144 print "a template set of your own, just follow the instructions (?) about\n";
3145 print "how to add them. You can also change the default template.\n";
3147 print "\n Available Templates:\n";
3150 while ( $count <= $#templateset_name ) {
3151 if ( $templateset_id[$count] eq $templateset_default ) {
3156 if ( $templateset_id[$count] eq $templateset_fallback ) {
3161 if ( $count < 10 ) {
3164 $name = $templateset_name[$count];
3165 $num_spaces = 35 - length($name);
3166 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3167 $name = $name . " ";
3170 print " $count. $name";
3171 print "($templateset_id[$count])\n";
3175 print "\n d = default template set\n"
3176 . " f = fallback template set\n\n";
3178 $menu_text = ".-------------------------------------.\n"
3179 . "| t (detect template set) |\n"
3180 . "| + (add template set) |\n"
3181 . "| - N (remove template set) |\n"
3182 . "| m N (mark default template set) |\n"
3183 . "| f N (set fallback template set) |\n"
3184 . "| l (list template sets/skins) |\n"
3186 . "|-------------------------------------|\n"
3187 . "| where N is a template set number |\n"
3188 . "`-------------------------------------'\n";
3191 print "\n[template set] command (?=help) > ";
3194 $input =~ s/[\r\n]//g;
3195 while ( $input ne "d" ) {
3197 # list template sets
3199 if ( $input =~ /^\s*l\s*/i ) {
3201 while ( $count <= $#templateset_name ) {
3202 if ( $templateset_id[$count] eq $templateset_default ) {
3207 if ( $templateset_id[$count] eq $templateset_fallback ) {
3212 if ( $count < 10 ) {
3215 $name = $templateset_name[$count];
3216 $num_spaces = 35 - length($name);
3217 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3218 $name = $name . " ";
3221 print " $count. $name";
3222 print "($templateset_id[$count])\n";
3226 print "\n d = default template set\n"
3227 . " f = fallback template set\n\n";
3229 # mark default template set
3231 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
3232 $old_def = $templateset_default;
3233 $input =~ s/^\s*m\s*//;
3234 $templateset_default = $templateset_id[$input];
3235 if ( $templateset_default =~ /^\s*$/ ) {
3236 print "Cannot set default template set to $input. That template set does not exist.\n";
3237 $templateset_default = $old_def;
3240 # set fallback template set
3242 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
3243 $old_def = $templateset_fallback;
3244 $input =~ s/^\s*f\s*//;
3245 $templateset_fallback = $templateset_id[$input];
3246 if ( $templateset_fallback =~ /^\s*$/ ) {
3247 print "Cannot set fallback template set to $input. That template set does not exist.\n";
3248 $templateset_fallback = $old_def;
3253 } elsif ( $input =~ /^\s*\+/ ) {
3254 print "\nWhat is the name of this template (as shown to your users): ";
3256 $name =~ s/[\r\n]//g;
3257 $templateset_name[ $#templateset_name + 1 ] = $name;
3258 print "\n\nThe directory name should not contain any path information\n"
3259 . "or slashes, and should be the name of the directory that the\n"
3260 . "template set is found in within the SquirrelMail templates\n"
3262 print "What directory is this stored in (ex: default_advanced): ";
3264 $name =~ s/[\r\n]//g;
3265 $templateset_id[ $#templateset_id + 1 ] = $name;
3267 # detect template sets
3269 } elsif ( $input =~ /^\s*t\s*/i ) {
3270 print "\nStarting detection...\n\n";
3271 opendir( DIR
, "../templates" );
3272 @files = sort(readdir(DIR
));
3274 while ( $cnt <= $#files ) {
3275 if ( -d
"../templates/" . $files[$cnt] && $files[$cnt] !~ /^\./ && $files[$cnt] ne ".svn" ) {
3276 $filename = $files[$cnt];
3278 for ( $x = 0 ; $x <= $#templateset_id ; $x++ ) {
3279 if ( $templateset_id[$x] eq $filename ) {
3285 print "** Found template set: $filename\n";
3286 $def = $files[$cnt];
3289 #$def =~ s/(^\w+)/ucfirst $1/eg;
3290 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3291 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3292 print " What is it's name (as shown to your users)? [$def]: ";
3294 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3295 if ( $nm eq '' ) { $nm = $def; }
3296 $templateset_id[ $#templateset_id + 1 ] = $filename;
3297 $templateset_name[ $#templateset_name + 1 ] = $nm;
3303 for ( $cnt= 0 ; $cnt <= $#templateset_id ; ) {
3304 $filename = $templateset_id[$cnt];
3305 if ( !(-d change_to_rel_path
('SM_PATH . \'templates/' . $filename)) ) {
3306 print " Removing \"$filename\" (template set directory not found)\n";
3307 if ( $templateset_default eq $filename ) { $templateset_default = 'default'; }
3308 if ( $templateset_fallback eq $filename ) { $templateset_fallback = 'default'; }
3310 @new_templateset_name = ();
3311 @new_templateset_id = ();
3312 for ( $x = 0 ; $x < $#templateset_id ; $x++ ) {
3313 if ( $templateset_id[$x] eq $filename ) {
3316 if ( $offset == 1 ) {
3317 $new_templateset_name[$x] = $templateset_name[ $x + 1 ];
3318 $new_templateset_id[$x] = $templateset_id[ $x + 1 ];
3320 $new_templateset_name[$x] = $templateset_name[$x];
3321 $new_templateset_id[$x] = $templateset_id[$x];
3324 @templateset_name = @new_templateset_name;
3325 @templateset_id = @new_templateset_id;
3328 print "\nDetection complete!\n\n";
3332 # remove template set
3334 # undocumented functionality of removing last template set isn't that great
3335 #} elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3336 } elsif ( $input =~ /^\s*-\s*[0-9]+/ ) {
3337 if ( $input =~ /[0-9]+\s*$/ ) {
3339 $rem_num =~ s/^\s*-\s*//g;
3340 $rem_num =~ s/\s*$//;
3342 $rem_num = $#templateset_name;
3344 if ( $templateset_id[$rem_num] eq $templateset_default ) {
3345 print "You cannot remove the default template set!\n";
3346 } elsif ( $templateset_id[$rem_num] eq $templateset_fallback ) {
3347 print "You cannot remove the fallback template set!\n";
3350 @new_templateset_name = ();
3351 @new_templateset_id = ();
3352 while ( $count <= $#templateset_name ) {
3353 if ( $count != $rem_num ) {
3354 @new_templateset_name = ( @new_templateset_name, $templateset_name[$count] );
3355 @new_templateset_id = ( @new_templateset_id, $templateset_id[$count] );
3359 @templateset_name = @new_templateset_name;
3360 @templateset_id = @new_templateset_id;
3365 } elsif ( $input =~ /^\s*\?\s*/ ) {
3368 # command not understood
3371 print "Command not understood\n";
3374 print "[template set] command (?=help) > ";
3376 $input =~ s/[\r\n]//g;
3378 return $templateset_default;
3382 # sets default font size option
3383 sub command_default_fontsize
{
3384 print "Enter default font size [$WHT$$default_fontsize$NRM]: $WHT";
3385 $new_size = <STDIN
>;
3386 if ( $new_size eq "\n" ) {
3389 $new_size =~ s/[\r\n]//g;
3394 # controls available fontsets
3395 sub command_fontsets
{
3397 print "You can control fontsets available to end users here.\n";
3398 # set initial $input value
3400 while ( $input ne "x" ) {
3401 if ( $input =~ /^\s*a\s*/i ) {
3403 print "\nFontset name: ";
3405 if (! $fontsets{trim
($name)}) {
3406 print "Fontset string: ";
3408 $fontsets{trim
($name)} = trim
($value);
3410 print "\nERROR: Such fontset already exists.\n";
3412 } elsif ( $input =~ /^\s*e\s*/i ) {
3413 # edit existing fontset
3414 print "\nFontset name: ";
3416 if (! $fontsets{trim
($name)}) {
3417 print "\nERROR: No such fontset.\n";
3419 print "Fontset string [$fontsets{trim($name)}]: ";
3421 $fontsets{trim
($name)} = trim
($value);
3423 } elsif ( $input =~ /^\s*d\s*/ ) {
3424 # delete existing fontset
3425 print "\nFontset name: ";
3427 if (! $fontsets{trim
($name)}) {
3428 print "\nERROR: No such fontset.\n";
3430 delete $fontsets{trim
($name)};
3432 } elsif ( $input =~ /^\s*l\s*/ ) {
3434 print "\nConfigured fontsets:\n";
3435 while (($fontset_name, $fontset_string) = each(%fontsets)) {
3436 print " $fontset_name = $fontset_string\n";
3438 print "Default fontset: $default_fontset\n";
3439 } elsif ( $input =~ /^\s*m\s*/ ) {
3440 # set default fontset
3441 print "\nSet default fontset [$default_fontset]: ";
3443 if (trim
($name) ne '' and ! $fontsets{trim
($name)}) {
3444 print "\nERROR: No such fontset.\n";
3446 $default_fontset = trim
($name);
3449 # print available commands on any other input
3450 print "\nAvailable commands:\n";
3451 print " a - Adds new fontset.\n";
3452 print " d - Deletes existing fontset.\n";
3453 print " e - Edits existing fontset.\n";
3454 print " h or ? - Shows this help screen.\n";
3455 print " l - Lists available fontsets.\n";
3456 print " m - Sets default fontset.\n";
3457 print " x - Exits fontset editor mode.\n";
3459 print "\nCommand [fontsets] (a,d,e,h,?=help,l,m,x)> ";
3461 $input =~ s/[\r\n]//g;
3466 print "You can now define different LDAP servers.\n";
3467 print "Please ensure proper permissions for config.php when including\n";
3468 print "sensitive passwords.\n\n";
3469 print "[ldap] command (?=help) > ";
3471 $input =~ s/[\r\n]//g;
3472 while ( $input ne "d" ) {
3473 if ( $input =~ /^\s*l\s*/i ) {
3475 while ( $count <= $#ldap_host ) {
3476 print "$count. $ldap_host[$count]\n";
3477 print " base: $ldap_base[$count]\n";
3478 if ( $ldap_charset[$count] ) {
3479 print " charset: $ldap_charset[$count]\n";
3481 if ( $ldap_port[$count] ) {
3482 print " port: $ldap_port[$count]\n";
3484 if ( $ldap_name[$count] ) {
3485 print " name: $ldap_name[$count]\n";
3487 if ( $ldap_maxrows[$count] ) {
3488 print " maxrows: $ldap_maxrows[$count]\n";
3490 if ( $ldap_filter[$count] ) {
3491 print " filter: $ldap_filter[$count]\n";
3493 if ( $ldap_binddn[$count] ) {
3494 print " binddn: $ldap_binddn[$count]\n";
3495 if ( $ldap_bindpw[$count] ) {
3496 print " bindpw: $ldap_bindpw[$count]\n";
3499 if ( $ldap_protocol[$count] ) {
3500 print " protocol: $ldap_protocol[$count]\n";
3502 if ( $ldap_limit_scope[$count] ) {
3503 print " limit_scope: $ldap_limit_scope[$count]\n";
3505 if ( $ldap_listing[$count] ) {
3506 print " listing: $ldap_listing[$count]\n";
3508 if ( $ldap_writeable[$count] ) {
3509 print " writeable: $ldap_writeable[$count]\n";
3511 if ( $ldap_search_tree[$count] ) {
3512 print " search_tree: $ldap_search_tree[$count]\n";
3514 if ( $ldap_starttls[$count] ) {
3515 print " starttls: $ldap_starttls[$count]\n";
3521 } elsif ( $input =~ /^\s*\+/ ) {
3522 $sub = $#ldap_host + 1;
3524 print "First, we need to have the hostname or the IP address where\n";
3525 print "this LDAP server resides. Example: ldap.bigfoot.com\n";
3527 print "You can use any URI compatible with your LDAP library. Please\n";
3528 print "note that StartTLS option is not compatible with ldaps and\n";
3529 print "ldapi URIs.\n";
3532 $name =~ s/[\r\n]//g;
3533 $ldap_host[$sub] = $name;
3537 print "Next, we need the server root (base dn). For this, an empty\n";
3538 print "string is allowed.\n";
3539 print "Example: ou=member_directory,o=netcenter.com\n";
3542 $name =~ s/[\r\n]//g;
3543 $ldap_base[$sub] = $name;
3547 print "This is the TCP/IP port number for the LDAP server. Default\n";
3548 print "port is 389. This is optional. Press ENTER for default.\n";
3551 $name =~ s/[\r\n]//g;
3552 $ldap_port[$sub] = $name;
3556 print "This is the charset for the server. Default is utf-8. This\n";
3557 print "is also optional. Press ENTER for default.\n";
3560 $name =~ s/[\r\n]//g;
3561 $ldap_charset[$sub] = $name;
3565 print "This is the name for the server, used to tag the results of\n";
3566 print "the search. Default it \"LDAP: hostname\". Press ENTER for default\n";
3569 $name =~ s/[\r\n]//g;
3570 $ldap_name[$sub] = $name;
3574 print "You can specify the maximum number of rows in the search result.\n";
3575 print "Default value is equal to 250 rows. Press ENTER for default.\n";
3578 $name =~ s/[\r\n]//g;
3579 $ldap_maxrows[$sub] = $name;
3584 print "If your LDAP server does not like anonymous logins, you can specify bind DN.\n";
3585 print "Default is none, anonymous bind. Press ENTER for default.\n";
3588 $name =~ s/[\r\n]//g;
3589 $ldap_binddn[$sub] = $name;
3593 if ( $ldap_binddn[$sub] ne '' ) {
3595 print "Now, please specify password for that DN.\n";
3598 $name =~ s/[\r\n]//g;
3599 $ldap_bindpw[$sub] = $name;
3604 print "You can specify bind protocol version here.\n";
3605 print "Default protocol version depends on your php ldap settings.\n";
3606 print "Press ENTER for default.\n";
3609 $name =~ s/[\r\n]//g;
3610 $ldap_protocol[$sub] = $name;
3614 print "This configuration section allows to set some rarely used\n";
3615 print "options and options specific to some LDAP implementations.\n";
3617 print "Do you want to set advanced LDAP directory settings? (y/N):";
3618 $ldap_advanced_settings = <STDIN
>;
3619 if ( $ldap_advanced_settings =~ /^y\n/i ) {
3620 $ldap_advanced_settings = 'true';
3622 $ldap_advanced_settings = 'false';
3625 if ($ldap_advanced_settings eq 'true') {
3628 print "You can control LDAP directory listing here. This option can\n";
3629 print "be useful if you run small LDAP server and want to provide listing\n";
3630 print "of all addresses stored in LDAP to users of webmail interface.\n";
3631 print "Number of displayed entries is limited by maxrows setting.\n";
3633 print "Don't enable this option for public LDAP directories.\n";
3635 print "Allow listing of LDAP directory? (y/N):";
3637 if ( $name =~ /^y\n/i ) {
3642 $ldap_listing[$sub] = $name;
3646 print "You can control write access to LDAP address book here. This option can\n";
3647 print "be useful if you run small LDAP server and want to provide writable\n";
3648 print "shared address book stored in LDAP to users of webmail interface.\n";
3650 print "Don't enable this option for public LDAP directories.\n";
3652 print "Allow writing to LDAP directory? (y/N):";
3654 if ( $name =~ /^y\n/i ) {
3659 $ldap_writeable[$sub] = $name;
3663 print "You can specify an additional search filter.\n";
3664 print "This could be something like \"(objectclass=posixAccount)\".\n";
3665 print "No filtering is performed by default. Press ENTER for default.\n";
3668 $name =~ s/[\r|\n]//g;
3669 $ldap_filter[$sub] = $name;
3673 print "You can control search scope here.\n";
3674 print "This option is specific to Microsoft ADS implementation.\n";
3675 print "It requires use of v3 or newer LDAP protocol.\n";
3676 print "Don't enable it, if you use other LDAP server.\n";
3678 print "Limit ldap scope? (y/N):";
3680 if ( $name =~ /^y\n/i ) {
3685 $ldap_limit_scope[$sub] = $name;
3689 print "You can control ldap search type here.\n";
3690 print "Addresses can be searched in entire LDAP subtree (default)\n";
3691 print "or only first level entries are returned.\n";
3693 print "Search entire LDAP subtree? (Y/n):";
3695 if ( $name =~ /^n\n/i ) {
3700 $ldap_search_tree[$sub] = $name;
3704 print "You can control use of StartTLS on LDAP connection here.\n";
3705 print "This option requires use of v3 or newer LDAP protocol and php 4.2+.\n";
3707 print "Use StartTLS? (y/N):";
3709 if ( $name =~ /^y\n/i ) {
3714 $ldap_starttls[$sub] = $name;
3718 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3719 if ( $input =~ /[0-9]+\s*$/ ) {
3721 $rem_num =~ s/^\s*-\s*//g;
3722 $rem_num =~ s/\s*$//;
3724 $rem_num = $#ldap_host;
3727 @new_ldap_host = ();
3728 @new_ldap_base = ();
3729 @new_ldap_port = ();
3730 @new_ldap_name = ();
3731 @new_ldap_charset = ();
3732 @new_ldap_maxrows = ();
3733 @new_ldap_filter = ();
3734 @new_ldap_bindpw = ();
3735 @new_ldap_binddn = ();
3736 @new_ldap_protocol = ();
3737 @new_ldap_limit_scope = ();
3738 @new_ldap_listing = ();
3739 @new_ldap_writeable = ();
3740 @new_ldap_search_tree = ();
3741 @new_ldap_starttls = ();
3743 while ( $count <= $#ldap_host ) {
3744 if ( $count != $rem_num ) {
3745 @new_ldap_host = ( @new_ldap_host, $ldap_host[$count] );
3746 @new_ldap_base = ( @new_ldap_base, $ldap_base[$count] );
3747 @new_ldap_port = ( @new_ldap_port, $ldap_port[$count] );
3748 @new_ldap_name = ( @new_ldap_name, $ldap_name[$count] );
3749 @new_ldap_charset = ( @new_ldap_charset, $ldap_charset[$count] );
3750 @new_ldap_maxrows = ( @new_ldap_maxrows, $ldap_maxrows[$count] );
3751 @new_ldap_filter = ( @new_ldap_filter, $ldap_filter[$count] );
3752 @new_ldap_binddn = ( @new_ldap_binddn, $ldap_binddn[$count] );
3753 @new_ldap_bindpw = ( @new_ldap_bindpw, $ldap_bindpw[$count] );
3754 @new_ldap_protocol = ( @new_ldap_protocol, $ldap_protocol[$count] );
3755 @new_ldap_limit_scope = ( @new_ldap_limit_scope, $ldap_limit_scope[$count] );
3756 @new_ldap_listing = ( @new_ldap_listing, $ldap_listing[$count] );
3757 @new_ldap_writeable = ( @new_ldap_writeable, $ldap_writeable[$count] );
3758 @new_ldap_search_tree = ( @new_ldap_search_tree, $ldap_search_tree[$count] );
3759 @new_ldap_starttls = ( @new_ldap_starttls, $ldap_starttls[$count] );
3763 @ldap_host = @new_ldap_host;
3764 @ldap_base = @new_ldap_base;
3765 @ldap_port = @new_ldap_port;
3766 @ldap_name = @new_ldap_name;
3767 @ldap_charset = @new_ldap_charset;
3768 @ldap_maxrows = @new_ldap_maxrows;
3769 @ldap_filter = @new_ldap_filter;
3770 @ldap_binddn = @new_ldap_binddn;
3771 @ldap_bindpw = @new_ldap_bindpw;
3772 @ldap_protocol = @new_ldap_protocol;
3773 @ldap_limit_scope = @new_ldap_limit_scope;
3774 @ldap_listing = @new_ldap_listing;
3775 @ldap_writeable = @new_ldap_writeable;
3776 @ldap_search_tree = @new_ldap_search_tree;
3777 @ldap_starttls = @new_ldap_starttls;
3779 } elsif ( $input =~ /^\s*\?\s*/ ) {
3780 print ".-------------------------.\n";
3781 print "| + (add host) |\n";
3782 print "| - N (remove host) |\n";
3783 print "| l (list hosts) |\n";
3784 print "| d (done) |\n";
3785 print "`-------------------------'\n";
3787 print "[ldap] command (?=help) > ";
3789 $input =~ s/[\r\n]//g;
3794 print "Some of our developers have come up with very good javascript interface\n";
3795 print "for searching through address books, however, our original goals said\n";
3796 print "that we would be 100% HTML. In order to make it possible to use their\n";
3797 print "interface, and yet stick with our goals, we have also written a plain\n";
3798 print "HTML version of the search. Here, you can choose which version to use.\n";
3800 print "This is just the default value. It is also a user option that each\n";
3801 print "user can configure individually\n";
3804 if ( lc($default_use_javascript_addr_book) eq 'true' ) {
3805 $default_value = "y";
3807 $default_use_javascript_addr_book = 'false';
3808 $default_value = "n";
3810 print "Use javascript version by default (y/n) [$WHT$default_value$NRM]: $WHT";
3811 $new_show = <STDIN
>;
3812 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3813 $default_use_javascript_addr_book = 'true';
3815 $default_use_javascript_addr_book = 'false';
3817 return $default_use_javascript_addr_book;
3820 # global filebased address book
3822 print "If you want to use global file address book, then you\n";
3823 print "must set this option to a valid value. If option does\n";
3824 print "not have path elements, system assumes that file is\n";
3825 print "stored in data directory. If relative path is set, it is\n";
3826 print "relative to main SquirrelMail directory. If value is empty,\n";
3827 print "address book is not enabled.\n";
3830 print "[$WHT$abook_global_file$NRM]: $WHT";
3831 $new_abook_global_file = <STDIN
>;
3832 if ( $new_abook_global_file eq "\n" ) {
3833 $new_abook_global_file = $abook_global_file;
3835 $new_abook_global_file =~ s/[\r\n]//g;
3837 return $new_abook_global_file;
3840 # writing into global filebased abook control
3842 print "This setting controls writing into global file address\n";
3843 print "book options. Address book file must be writeable by\n";
3844 print "webserver's user, if you want to enable this option.\n";
3847 if ( lc($abook_global_file_writeable) eq 'true' ) {
3848 $default_value = "y";
3850 $abook_global_file_writeable = 'false';
3851 $default_value = "n";
3853 print "Allow writing into global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
3854 $new_show = <STDIN
>;
3855 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3856 $abook_global_file_writeable = 'true';
3858 $abook_global_file_writeable = 'false';
3860 return $abook_global_file_writeable;
3863 # listing of global filebased abook control
3865 print "This setting controls listing of global file address\n";
3866 print "book in addresses page.\n";
3869 if ( lc($abook_global_file_listing) eq 'true' ) {
3870 $default_value = "y";
3872 $abook_global_file_listing = 'false';
3873 $default_value = "n";
3875 print "Allow listing of global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
3876 $new_show = <STDIN
>;
3877 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3878 $abook_global_file_listing = 'true';
3880 $abook_global_file_listing = 'false';
3882 return $abook_global_file_listing;
3885 # controls $abook_file_line_length setting
3886 sub command_abook_file_line_length
{
3887 print "This setting controls space allocated to file based address book records.\n";
3888 print "End users will be unable to save address book entry, if total entry size \n";
3889 print "(quoted address book fields + 4 delimiters + linefeed) exceeds allowed \n";
3890 print "address book length size.\n";
3892 print "Same setting is applied to personal and global file based address books.\n";
3894 print "It is strongly recommended to keep default setting value. Change it only\n";
3895 print "if you really want to store address book entries that are bigger than two\n";
3896 print "kilobytes (2048).\n";
3899 print "Enter allowed address book line length [$abook_file_line_length]: ";
3902 # value is not modified, if user hits Enter or enters space
3904 # make sure that input is numeric
3905 if ($tmp =~ /^\d+$/) {
3906 $abook_file_line_length = $tmp;
3908 print "If you want to change this setting, you must enter number.\n";
3909 print "If you want to keep original setting - enter space.\n\n";
3910 print "Press Enter to continue...";
3917 print "If you want to store your users address book details in a database then\n";
3918 print "you need to set this DSN to a valid value. The format for this is:\n";
3919 print "mysql://user:pass\@hostname/dbname\n";
3920 print "Where mysql can be one of the databases PHP supports, the most common\n";
3921 print "of these are mysql, msql and pgsql.\n";
3922 print "Please ensure proper permissions for config.php when including\n";
3923 print "sensitive passwords.\n\n";
3924 print "If the DSN is left empty (hit space and then return) the database\n";
3925 print "related code for address books will not be used.\n";
3928 if ( $addrbook_dsn eq "" ) {
3929 $default_value = "Disabled";
3931 $default_value = $addrbook_dsn;
3933 print "[$WHT$addrbook_dsn$NRM]: $WHT";
3935 if ( $new_dsn eq "\n" ) {
3938 $new_dsn =~ s/[\r\n]//g;
3939 $new_dsn =~ s/^\s+$//g;
3945 print "This is the name of the table you want to store the address book\n";
3946 print "data in, it defaults to 'address'\n";
3948 print "[$WHT$addrbook_table$NRM]: $WHT";
3949 $new_table = <STDIN
>;
3950 if ( $new_table eq "\n" ) {
3951 $new_table = $addrbook_table;
3953 $new_table =~ s/[\r\n]//g;
3959 print "If you want to store your users preferences in a database then\n";
3960 print "you need to set this DSN to a valid value. The format for this is:\n";
3961 print "mysql://user:pass\@hostname/dbname\n";
3962 print "Where mysql can be one of the databases PHP supports, the most common\n";
3963 print "of these are mysql, msql and pgsql.\n";
3964 print "Please ensure proper permissions for config.php when including\n";
3965 print "sensitive passwords.\n\n";
3966 print "If the DSN is left empty (hit space and then return) the database\n";
3967 print "related code for address books will not be used.\n";
3970 if ( $prefs_dsn eq "" ) {
3971 $default_value = "Disabled";
3973 $default_value = $prefs_dsn;
3975 print "[$WHT$prefs_dsn$NRM]: $WHT";
3977 if ( $new_dsn eq "\n" ) {
3980 $new_dsn =~ s/[\r\n]//g;
3981 $new_dsn =~ s/^\s+$//g;
3987 print "This is the name of the table you want to store the preferences\n";
3988 print "data in, it defaults to 'userprefs'\n";
3990 print "[$WHT$prefs_table$NRM]: $WHT";
3991 $new_table = <STDIN
>;
3992 if ( $new_table eq "\n" ) {
3993 $new_table = $prefs_table;
3995 $new_table =~ s/[\r\n]//g;
4001 print "This is the name of the field in which you want to store the\n";
4002 print "username of the person the prefs are for. It default to 'user'\n";
4003 print "which clashes with a reserved keyword in PostgreSQL so this\n";
4004 print "will need to be changed for that database at least\n";
4006 print "[$WHT$prefs_user_field$NRM]: $WHT";
4007 $new_field = <STDIN
>;
4008 if ( $new_field eq "\n" ) {
4009 $new_field = $prefs_user_field;
4011 $new_field =~ s/[\r\n]//g;
4013 $prefs_user_size = db_pref_size
($prefs_user_size);
4018 print "This is the name of the field in which you want to store the\n";
4019 print "preferences keyword. It defaults to 'prefkey'\n";
4021 print "[$WHT$prefs_key_field$NRM]: $WHT";
4022 $new_field = <STDIN
>;
4023 if ( $new_field eq "\n" ) {
4024 $new_field = $prefs_key_field;
4026 $new_field =~ s/[\r\n]//g;
4028 $prefs_key_size = db_pref_size
($prefs_key_size);
4033 print "This is the name of the field in which you want to store the\n";
4034 print "preferences value. It defaults to 'prefval'\n";
4036 print "[$WHT$prefs_val_field$NRM]: $WHT";
4037 $new_field = <STDIN
>;
4038 if ( $new_field eq "\n" ) {
4039 $new_field = $prefs_val_field;
4041 $new_field =~ s/[\r\n]//g;
4043 $prefs_val_size = db_pref_size
($prefs_val_size);
4047 # routine is used to set database field limits
4048 # it needs one argument
4049 sub db_pref_size
() {
4051 print "\nDatabase fields have size limits.\n";
4053 print "What limit is set for this field? [$WHT$size$NRM]: $WHT";
4054 $new_size = <STDIN
>;
4055 if ( $new_size eq "\n" ) {
4058 $new_size =~ s/[\r\n]//g;
4064 print "If you want to store your global address book in a database then\n";
4065 print "you need to set this DSN to a valid value. The format for this is:\n";
4066 print "mysql://user:pass\@hostname/dbname\n";
4067 print "Where mysql can be one of the databases PHP supports, the most common\n";
4068 print "of these are mysql, msql and pgsql.\n";
4069 print "Please ensure proper permissions for config.php when including\n";
4070 print "sensitive passwords.\n\n";
4071 print "If the DSN is left empty (hit space and then return) the database\n";
4072 print "related code for global SQL address book will not be used.\n";
4075 if ( $addrbook_global_dsn eq "" ) {
4076 $default_value = "Disabled";
4078 $default_value = $addrbook_global_dsn;
4080 print "[$WHT$addrbook_global_dsn$NRM]: $WHT";
4082 if ( $new_dsn eq "\n" ) {
4085 $new_dsn =~ s/[\r\n]//g;
4086 $new_dsn =~ s/^\s+$//g;
4092 print "This is the name of the table you want to store the global address book\n";
4093 print "data in. Default table name is 'global_abook'. Address book uses same\n";
4094 print "database format as personal address book.\n";
4096 print "[$WHT$addrbook_global_table$NRM]: $WHT";
4097 $new_table = <STDIN
>;
4098 if ( $new_table eq "\n" ) {
4099 $new_table = $addrbook_global_table;
4101 $new_table =~ s/[\r\n]//g;
4107 print "This option controls users\' ability to add or modify records stored \n";
4108 print "in global address book\n";
4110 if ( lc($addrbook_global_writeable) eq 'true' ) {
4111 $default_value = "y";
4113 $default_value = "n";
4115 print "Allow writing into global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
4116 $addrbook_global_writeable = <STDIN
>;
4117 if ( ( $addrbook_global_writeable =~ /^y\n/i ) || ( ( $addrbook_global_writeable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4118 $addrbook_global_writeable = 'true';
4120 $addrbook_global_writeable = 'false';
4122 return $addrbook_global_writeable;
4126 print "Enable this option if you want to see listing of addresses stored \n";
4127 print "in global address book\n";
4129 if ( lc($addrbook_global_listing) eq 'true' ) {
4130 $default_value = "y";
4132 $default_value = "n";
4134 print "Allow listing of global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
4135 $addrbook_global_listing = <STDIN
>;
4136 if ( ( $addrbook_global_listing =~ /^y\n/i ) || ( ( $addrbook_global_listing =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4137 $addrbook_global_listing = 'true';
4139 $addrbook_global_listing = 'false';
4141 return $addrbook_global_listing;
4147 print "SquirrelMail attempts to set the language in many ways. If it\n";
4148 print "can not figure it out in another way, it will default to this\n";
4149 print "language. Please use the code for the desired language.\n";
4151 print "[$WHT$squirrelmail_default_language$NRM]: $WHT";
4152 $new_squirrelmail_default_language = <STDIN
>;
4153 if ( $new_squirrelmail_default_language eq "\n" ) {
4154 $new_squirrelmail_default_language = $squirrelmail_default_language;
4156 $new_squirrelmail_default_language =~ s/[\r\n]//g;
4157 $new_squirrelmail_default_language =~ s/^\s+$//g;
4159 return $new_squirrelmail_default_language;
4163 print "This option controls what character set is used when sending\n";
4164 print "mail and when sending HTML to the browser. Option works only\n";
4165 print "with US English (en_US) translation. Other translations use\n";
4166 print "charsets that are set in translation settings.\n";
4169 print "[$WHT$default_charset$NRM]: $WHT";
4170 $new_default_charset = <STDIN
>;
4171 if ( $new_default_charset eq "\n" ) {
4172 $new_default_charset = $default_charset;
4174 $new_default_charset =~ s/[\r\n]//g;
4176 return $new_default_charset;
4178 # Alternative language names
4180 print "Enable this option if you want to see localized language names in\n";
4181 print "language selection box. Note, that this option can trigger\n";
4182 print "installation of foreign language support modules in some browsers.\n";
4185 if ( lc($show_alternative_names) eq 'true' ) {
4186 $default_value = "y";
4188 $default_value = "n";
4190 print "Show alternative language names? (y/n) [$WHT$default_value$NRM]: $WHT";
4191 $show_alternative_names = <STDIN
>;
4192 if ( ( $show_alternative_names =~ /^y\n/i ) || ( ( $show_alternative_names =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4193 $show_alternative_names = 'true';
4195 $show_alternative_names = 'false';
4197 return $show_alternative_names;
4200 # Aggressive decoding
4202 print "Enable this option if you want to use CPU and memory intensive decoding\n";
4203 print "functions. This option allows reading multibyte charset, that are used\n";
4204 print "in Eastern Asia. SquirrelMail will try to use recode functions here,\n";
4205 print "even when you have disabled use of recode in Tweaks section.\n";
4208 if ( lc($aggressive_decoding) eq 'true' ) {
4209 $default_value = "y";
4211 $default_value = "n";
4213 print "Enable aggressive decoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4214 $aggressive_decoding = <STDIN
>;
4215 if ( ( $aggressive_decoding =~ /^y\n/i ) || ( ( $aggressive_decoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4216 $aggressive_decoding = 'true';
4218 $aggressive_decoding = 'false';
4220 return $aggressive_decoding;
4225 print "Enable this option if you want to allow lossy charset encoding in message\n";
4226 print "composition pages. This option allows charset conversions when output\n";
4227 print "charset does not support all symbols used in original charset. Symbols\n";
4228 print "unsupported by output charset will be replaced with question marks.\n";
4231 if ( lc($lossy_encoding) eq 'true' ) {
4232 $default_value = "y";
4234 $default_value = "n";
4236 print "Enable lossy encoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4237 $lossy_encoding = <STDIN
>;
4238 if ( ( $lossy_encoding =~ /^y\n/i ) || ( ( $lossy_encoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4239 $lossy_encoding = 'true';
4241 $lossy_encoding = 'false';
4243 return $lossy_encoding;
4246 # display html emails in iframe
4248 print "This option can enable html email rendering inside iframe.\n";
4249 print "Inline frames are used in order to provide sandbox environment";
4250 print "for html code included in html formated emails.";
4251 print "Option is experimental and might have glitches in some parts of code.";
4254 if ( lc($use_iframe) eq 'true' ) {
4255 $default_value = "y";
4257 $default_value = "n";
4259 print "Display html emails in iframe? (y/n) [$WHT$default_value$NRM]: $WHT";
4260 $use_iframe = <STDIN
>;
4261 if ( ( $use_iframe =~ /^y\n/i ) || ( ( $use_iframe =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4262 $use_iframe = 'true';
4264 $use_iframe = 'false';
4270 sub command_ask_user_info
{
4271 print "New users need to supply their real name and email address to\n";
4272 print "send out proper mails. When this option is enabled, a user that\n";
4273 print "logs in for the first time will be redirected to the Personal\n";
4274 print "Options screen and asked to supply their personal data.\n";
4277 if ( lc($ask_user_info) eq 'true' ) {
4278 $default_value = "y";
4280 $default_value = "n";
4282 print "Ask user info? (y/n) [$WHT$default_value$NRM]: $WHT";
4283 $ask_user_info = <STDIN
>;
4284 if ( ( $ask_user_info =~ /^y\n/i ) || ( ( $ask_user_info =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4285 $ask_user_info = 'true';
4287 $ask_user_info = 'false';
4289 return $ask_user_info;
4294 print "Enabling this option will cause icons to be used instead of text\n";
4295 print "markers next to each message in mailbox lists that represent\n";
4296 print "new, read, flagged, and deleted messages, as well as those that\n";
4297 print "have been replied to and forwarded. Icons are also used next to\n";
4298 print "(un)expanded folders in the folder list (Oldway = false). These\n";
4299 print "icons are quite small, but will obviously be more of a resource\n";
4300 print "drain than text markers.\n";
4303 if ( lc($use_icons) eq 'true' ) {
4304 $default_value = "y";
4306 $default_value = "n";
4308 print "Use icons? (y/n) [$WHT$default_value$NRM]: $WHT";
4309 $use_icons = <STDIN
>;
4310 if ( ( $use_icons =~ /^y\n/i ) || ( ( $use_icons =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4311 $use_icons = 'true';
4313 $use_icons = 'false';
4319 print "Enable this option if you want to use php recode functions to read\n";
4320 print "emails written in charset that differs from the one that is set in\n";
4321 print "translation selected by user. Code is experimental, it might cause\n";
4322 print "errors, if email contains charset unsupported by recode or if your\n";
4323 print "php does not have recode support.\n";
4326 if ( lc($use_php_recode) eq 'true' ) {
4327 $default_value = "y";
4329 $default_value = "n";
4331 print "Use php recode functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4332 $use_php_recode = <STDIN
>;
4333 if ( ( $use_php_recode =~ /^y\n/i ) || ( ( $use_php_recode =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4334 $use_php_recode = 'true';
4336 $use_php_recode = 'false';
4338 return $use_php_recode;
4342 print "Enable this option if you want to use php iconv functions to read\n";
4343 print "emails written in charset that differs from the one that is set in\n";
4344 print "translation selected by user. Code is experimental, it works only\n";
4345 print "with translations that use utf-8 charset. Code might cause errors,\n";
4346 print "if email contains charset unsupported by iconv or if your php does\n";
4347 print "not have iconv support.\n";
4350 if ( lc($use_php_iconv) eq 'true' ) {
4351 $default_value = "y";
4353 $default_value = "n";
4355 print "Use php iconv functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4356 $use_php_iconv = <STDIN
>;
4357 if ( ( $use_php_iconv =~ /^y\n/i ) || ( ( $use_php_iconv =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4358 $use_php_iconv = 'true';
4360 $use_php_iconv = 'false';
4362 return $use_php_iconv;
4367 print "Enable this option if you want to check SquirrelMail configuration\n";
4368 print "remotely with configtest.php script.\n";
4371 if ( lc($allow_remote_configtest) eq 'true' ) {
4372 $default_value = "y";
4374 $default_value = "n";
4376 print "Allow remote configuration tests? (y/n) [$WHT$default_value$NRM]: $WHT";
4377 $allow_remote_configtest = <STDIN
>;
4378 if ( ( $allow_remote_configtest =~ /^y\n/i ) || ( ( $allow_remote_configtest =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4379 $allow_remote_configtest = 'true';
4381 $allow_remote_configtest = 'false';
4383 return $allow_remote_configtest;
4386 # Default Icon theme
4388 print "You may change the path to the default icon theme to be used, if icons\n";
4389 print "have been enabled. This theme will be used when an icon cannot be\n";
4390 print "found in the current theme, or when no icon theme is specified. If\n";
4391 print "left blank, and icons are enabled, the default theme will be used\n";
4392 print "from images/themes/default/.\n";
4394 print "To clear out an existing value, just type a space for the input.\n";
4396 print "Please be aware of the following: \n";
4397 print " - Relative URLs are relative to the config dir\n";
4398 print " to use the icon themes directory, use ../images/themes/newtheme/\n";
4399 print " - The icon theme may be outside the SquirrelMail directory, but\n";
4400 print " it must be web accessible.\n";
4401 print "[$WHT$icon_theme_def$NRM]: $WHT";
4402 $new_icon_theme_def = <STDIN
>;
4404 if ( $new_icon_theme_def eq "\n" ) {
4405 $new_icon_theme_def = $icon_theme_def;
4407 $new_icon_theme_def =~ s/[\r\n]//g;
4409 $new_icon_theme_def =~ s/^\s*//;
4410 return $new_icon_theme_def;
4413 # SquirrelMail debug mode (since 1.5.2)
4415 print "When debugging or developing SquirrelMail, you may want to increase\n";
4416 print "the verbosity of certain kinds of errors, notices, and/or diagnostics.\n";
4417 print "You may enable one or more of the debugging modes here. Please make\n";
4418 print "sure that you have turned off debugging if you are using SquirrelMail\n";
4419 print "in a production environment.\n\n";
4422 while ( $input ne "d\n" ) {
4423 $sm_debug_mode = convert_debug_constants_to_binary_integer
($sm_debug_mode);
4425 # per include/constants.php, here are the debug mode values:
4427 # 0 SM_DEBUG_MODE_OFF
4428 # 1 SM_DEBUG_MODE_SIMPLE
4429 # 512 SM_DEBUG_MODE_MODERATE
4430 # 524288 SM_DEBUG_MODE_ADVANCED
4431 # 536870912 SM_DEBUG_MODE_STRICT
4433 print "\n# Enabled? Description\n";
4434 print "---------------------------------------------------------------------\n";
4435 print "0 " . ($sm_debug_mode == 0 ?
"y" : " ")
4436 . " No debugging (recommended in production environments)\n";
4437 print "1 " . ($sm_debug_mode & 1 ?
"y" : " ")
4438 . " Simple debugging (PHP E_ERROR)\n";
4439 print "2 " . ($sm_debug_mode & 512 ?
"y" : " ")
4440 . " Moderate debugging (PHP E_ALL)\n";
4441 print "3 " . ($sm_debug_mode & 524288 ?
"y" : " ")
4442 . " Advanced debugging (PHP E_ALL plus log errors\n";
4443 print " intentionally suppressed)\n";
4444 print "4 " . ($sm_debug_mode & 536870912 ?
"y" : " ")
4445 . " Strict debugging (PHP E_STRICT)\n";
4448 print "SquirrelMail debug mode (0,1,2,3,4) or d when done? : $WHT";
4450 if ( $input eq "d\n" ) {
4452 } elsif ($input !~ /^[0-9]+\n$/) {
4453 print "\nInvalid configuration value.\n";
4454 print "\nPress enter to continue...";
4456 } elsif ( $input == "0\n" ) {
4458 } elsif ( $input == "1\n" ) {
4459 if ($sm_debug_mode & 1) {
4460 $sm_debug_mode ^= 1;
4462 $sm_debug_mode |= 1;
4464 } elsif ( $input == "2\n" ) {
4465 if ($sm_debug_mode & 512) {
4466 $sm_debug_mode ^= 512;
4468 $sm_debug_mode |= 512;
4470 } elsif ( $input == "3\n" ) {
4471 if ($sm_debug_mode & 524288) {
4472 $sm_debug_mode ^= 524288;
4474 $sm_debug_mode |= 524288;
4476 } elsif ( $input == "4\n" ) {
4477 if ($sm_debug_mode & 536870912) {
4478 $sm_debug_mode ^= 536870912;
4480 $sm_debug_mode |= 536870912;
4483 print "\nInvalid configuration value.\n";
4484 print "\nPress enter to continue...";
4489 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
4490 return $sm_debug_mode;
4493 # Secured configuration mode (since 1.5.2)
4495 print "This option allows you to enable \"Secured Configuration\" mode,\n";
4496 print "which will guarantee that certain settings made herein will be\n";
4497 print "made immutable and will not be subject to override by either friendly\n";
4498 print "or unfriendly code/plugins. Only a small number of settings herein\n";
4499 print "will be used in this manner - just those that are deemed to be a\n";
4500 print "potential security threat when rouge plugin or other code may be\n";
4501 print "executed inside SquirrelMail.\n";
4504 if ( lc($secured_config) eq 'true' ) {
4505 $default_value = "y";
4507 $default_value = "n";
4509 print "Enable secured configuration mode? (y/n) [$WHT$default_value$NRM]: $WHT";
4510 $secured_config = <STDIN
>;
4511 if ( ( $secured_config =~ /^y\n/i ) || ( ( $secured_config =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4512 $secured_config = 'true';
4514 $secured_config = 'false';
4516 return $secured_config;
4521 if ( open( CF
, ">config.php" ) ) {
4526 print CF
" * SquirrelMail Configuration File\n";
4527 print CF
" * Created using the configure script, conf.pl\n";
4531 if ($print_config_version) {
4532 print CF
"\$config_version = '$print_config_version';\n";
4535 print CF
"\$config_use_color = $config_use_color;\n";
4539 print CF
"\$org_name = \"$org_name\";\n";
4541 print CF
"\$org_logo = " . &change_to_SM_path
($org_logo) . ";\n";
4542 $org_logo_width |= 0;
4543 $org_logo_height |= 0;
4545 print CF
"\$org_logo_width = '$org_logo_width';\n";
4547 print CF
"\$org_logo_height = '$org_logo_height';\n";
4548 # string that can contain variables.
4549 print CF
"\$org_title = \"$org_title\";\n";
4551 print CF
"\$signout_page = " . &change_to_SM_path
($signout_page) . ";\n";
4553 print CF
"\$frame_top = '$frame_top';\n";
4556 print CF
"\$provider_uri = '$provider_uri';\n";
4559 print CF
"\$provider_name = '$provider_name';\n";
4562 # string that can contain variables
4563 print CF
"\$motd = \"$motd\";\n";
4567 print CF
"\$squirrelmail_default_language = '$squirrelmail_default_language';\n";
4569 print CF
"\$default_charset = '$default_charset';\n";
4571 print CF
"\$show_alternative_names = $show_alternative_names;\n";
4573 print CF
"\$aggressive_decoding = $aggressive_decoding;\n";
4575 print CF
"\$lossy_encoding = $lossy_encoding;\n";
4579 print CF
"\$domain = '$domain';\n";
4581 print CF
"\$imapServerAddress = '$imapServerAddress';\n";
4583 print CF
"\$imapPort = $imapPort;\n";
4585 print CF
"\$useSendmail = $useSendmail;\n";
4587 print CF
"\$smtpServerAddress = '$smtpServerAddress';\n";
4589 print CF
"\$smtpPort = $smtpPort;\n";
4591 print CF
"\$sendmail_path = '$sendmail_path';\n";
4593 print CF
"\$sendmail_args = '$sendmail_args';\n";
4595 # print CF "\$use_authenticated_smtp = $use_authenticated_smtp;\n";
4597 print CF
"\$pop_before_smtp = $pop_before_smtp;\n";
4599 print CF
"\$pop_before_smtp_host = '$pop_before_smtp_host';\n";
4601 print CF
"\$imap_server_type = '$imap_server_type';\n";
4603 print CF
"\$invert_time = $invert_time;\n";
4605 print CF
"\$optional_delimiter = '$optional_delimiter';\n";
4607 print CF
"\$encode_header_key = '$encode_header_key';\n";
4611 print CF
"\$default_folder_prefix = '$default_folder_prefix';\n";
4613 print CF
"\$trash_folder = '$trash_folder';\n";
4615 print CF
"\$sent_folder = '$sent_folder';\n";
4617 print CF
"\$draft_folder = '$draft_folder';\n";
4619 print CF
"\$default_move_to_trash = $default_move_to_trash;\n";
4621 print CF
"\$default_move_to_sent = $default_move_to_sent;\n";
4623 print CF
"\$default_save_as_draft = $default_save_as_draft;\n";
4625 print CF
"\$show_prefix_option = $show_prefix_option;\n";
4627 print CF
"\$list_special_folders_first = $list_special_folders_first;\n";
4629 print CF
"\$use_special_folder_color = $use_special_folder_color;\n";
4631 print CF
"\$auto_expunge = $auto_expunge;\n";
4633 print CF
"\$default_sub_of_inbox = $default_sub_of_inbox;\n";
4635 print CF
"\$show_contain_subfolders_option = $show_contain_subfolders_option;\n";
4637 print CF
"\$default_unseen_notify = $default_unseen_notify;\n";
4639 print CF
"\$default_unseen_type = $default_unseen_type;\n";
4641 print CF
"\$auto_create_special = $auto_create_special;\n";
4643 print CF
"\$delete_folder = $delete_folder;\n";
4645 print CF
"\$noselect_fix_enable = $noselect_fix_enable;\n";
4650 print CF
"\$data_dir = " . &change_to_SM_path
($data_dir) . ";\n";
4651 # string that can contain a variable
4652 print CF
"\$attachment_dir = " . &change_to_SM_path
($attachment_dir) . ";\n";
4654 print CF
"\$dir_hash_level = $dir_hash_level;\n";
4656 print CF
"\$default_left_size = '$default_left_size';\n";
4658 print CF
"\$force_username_lowercase = $force_username_lowercase;\n";
4660 print CF
"\$default_use_priority = $default_use_priority;\n";
4662 print CF
"\$hide_sm_attributions = $hide_sm_attributions;\n";
4664 print CF
"\$default_use_mdn = $default_use_mdn;\n";
4666 print CF
"\$edit_identity = $edit_identity;\n";
4668 print CF
"\$edit_name = $edit_name;\n";
4670 print CF
"\$hide_auth_header = $hide_auth_header;\n";
4672 print CF
"\$disable_thread_sort = $disable_thread_sort;\n";
4674 print CF
"\$disable_server_sort = $disable_server_sort;\n";
4676 print CF
"\$allow_charset_search = $allow_charset_search;\n";
4678 print CF
"\$allow_advanced_search = $allow_advanced_search;\n";
4681 print CF
"\$time_zone_type = $time_zone_type;\n";
4684 print CF
"\$config_location_base = '$config_location_base';\n";
4687 print CF
"\$disable_plugins = $disable_plugins;\n";
4689 print CF
"\$disable_plugins_user = '$disable_plugins_user';\n";
4692 # all plugins are strings
4693 for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
4694 print CF
"\$plugins[] = '$plugins[$ct]';\n";
4699 if ( $user_theme_default eq '' ) { $user_theme_default = '0'; }
4700 print CF
"\$user_theme_default = $user_theme_default;\n";
4702 for ( $count = 0 ; $count <= $#user_theme_name ; $count++ ) {
4703 if ($user_theme_path[$count] eq 'none') {
4706 $path = &change_to_SM_path
($user_theme_path[$count]);
4708 print CF
"\$user_themes[$count]['PATH'] = " . $path . ";\n";
4709 # escape theme name so it can contain single quotes.
4710 $esc_name = $user_theme_name[$count];
4711 $esc_name =~ s/\\/\\\\/g;
4712 $esc_name =~ s/'/\\'/g;
4713 print CF
"\$user_themes[$count]['NAME'] = '$esc_name';\n";
4717 if ( $icon_theme_def eq '' ) { $icon_theme_def = '0'; }
4718 print CF
"\$icon_theme_def = $icon_theme_def;\n";
4719 if ( $icon_theme_fallback eq '' ) { $icon_theme_fallback = '0'; }
4720 print CF
"\$icon_theme_fallback = $icon_theme_fallback;\n";
4722 for ( $count = 0 ; $count <= $#icon_theme_name ; $count++ ) {
4723 $path = $icon_theme_path[$count];
4724 if ($path eq 'none' || $path eq 'template') {
4725 $path = "'".$path."'";
4727 $path = &change_to_SM_path
($icon_theme_path[$count]);
4729 print CF
"\$icon_themes[$count]['PATH'] = " . $path . ";\n";
4730 # escape theme name so it can contain single quotes.
4731 $esc_name = $icon_theme_name[$count];
4732 $esc_name =~ s/\\/\\\\/g;
4733 $esc_name =~ s/'/\\'/g;
4734 print CF
"\$icon_themes[$count]['NAME'] = '$esc_name';\n";
4738 if ( $templateset_default eq '' ) { $templateset_default = 'default'; }
4739 print CF
"\$templateset_default = '$templateset_default';\n";
4741 if ( $templateset_fallback eq '' ) { $templateset_fallback = 'default'; }
4742 print CF
"\$templateset_fallback = '$templateset_fallback';\n";
4744 for ( $count = 0 ; $count <= $#templateset_name ; $count++ ) {
4745 print CF
"\$aTemplateSet[$count]['ID'] = '" . $templateset_id[$count] . "';\n";
4746 # escape theme name so it can contain single quotes.
4747 $esc_name = $templateset_name[$count];
4748 $esc_name =~ s/\\/\\\\/g;
4749 $esc_name =~ s/'/\\'/g;
4750 print CF
"\$aTemplateSet[$count]['NAME'] = '$esc_name';\n";
4756 print CF
"\$default_fontsize = '$default_fontsize';\n";
4758 print CF
"\$default_fontset = '$default_fontset';\n";
4760 # assoc. array (maybe initial value should be set somewhere else)
4761 print CF
'$fontsets = array();'."\n";
4762 while (($fontset_name, $fontset_value) = each(%fontsets)) {
4763 print CF
"\$fontsets\['$fontset_name'\] = '$fontset_value';\n";
4769 print CF
"\$default_use_javascript_addr_book = $default_use_javascript_addr_book;\n";
4770 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
4771 print CF
"\$ldap_server[$count] = array(\n";
4773 print CF
" 'host' => '$ldap_host[$count]',\n";
4775 print CF
" 'base' => '$ldap_base[$count]'";
4776 if ( $ldap_name[$count] ) {
4779 print CF
" 'name' => '$ldap_name[$count]'";
4781 if ( $ldap_port[$count] ) {
4784 print CF
" 'port' => $ldap_port[$count]";
4786 if ( $ldap_charset[$count] ) {
4789 print CF
" 'charset' => '$ldap_charset[$count]'";
4791 if ( $ldap_maxrows[$count] ) {
4794 print CF
" 'maxrows' => $ldap_maxrows[$count]";
4797 if ( $ldap_filter[$count] ) {
4799 print CF
" 'filter' => '$ldap_filter[$count]'";
4801 if ( $ldap_binddn[$count] ) {
4804 print CF
" 'binddn' => '$ldap_binddn[$count]'";
4805 if ( $ldap_bindpw[$count] ) {
4808 print CF
" 'bindpw' => '$ldap_bindpw[$count]'";
4811 if ( $ldap_protocol[$count] ) {
4814 print CF
" 'protocol' => $ldap_protocol[$count]";
4816 if ( $ldap_limit_scope[$count] ) {
4819 print CF
" 'limit_scope' => $ldap_limit_scope[$count]";
4821 if ( $ldap_listing[$count] ) {
4824 print CF
" 'listing' => $ldap_listing[$count]";
4826 if ( $ldap_writeable[$count] ) {
4829 print CF
" 'writeable' => $ldap_writeable[$count]";
4831 if ( $ldap_search_tree[$count] ) {
4834 print CF
" 'search_tree' => $ldap_search_tree[$count]";
4836 if ( $ldap_listing[$count] ) {
4839 print CF
" 'starttls' => $ldap_starttls[$count]";
4847 print CF
"\$addrbook_dsn = '$addrbook_dsn';\n";
4849 print CF
"\$addrbook_table = '$addrbook_table';\n\n";
4851 print CF
"\$prefs_dsn = '$prefs_dsn';\n";
4853 print CF
"\$prefs_table = '$prefs_table';\n";
4855 print CF
"\$prefs_user_field = '$prefs_user_field';\n";
4857 print CF
"\$prefs_user_size = $prefs_user_size;\n";
4859 print CF
"\$prefs_key_field = '$prefs_key_field';\n";
4861 print CF
"\$prefs_key_size = $prefs_key_size;\n";
4863 print CF
"\$prefs_val_field = '$prefs_val_field';\n";
4865 print CF
"\$prefs_val_size = $prefs_val_size;\n\n";
4867 print CF
"\$addrbook_global_dsn = '$addrbook_global_dsn';\n";
4869 print CF
"\$addrbook_global_table = '$addrbook_global_table';\n";
4871 print CF
"\$addrbook_global_writeable = $addrbook_global_writeable;\n";
4873 print CF
"\$addrbook_global_listing = $addrbook_global_listing;\n\n";
4875 print CF
"\$abook_global_file = '$abook_global_file';\n";
4877 print CF
"\$abook_global_file_writeable = $abook_global_file_writeable;\n\n";
4879 print CF
"\$abook_global_file_listing = $abook_global_file_listing;\n\n";
4881 print CF
"\$abook_file_line_length = $abook_file_line_length;\n\n";
4883 print CF
"\$no_list_for_subscribe = $no_list_for_subscribe;\n";
4886 print CF
"\$smtp_auth_mech = '$smtp_auth_mech';\n";
4887 print CF
"\$smtp_sitewide_user = '". quote_single
($smtp_sitewide_user) ."';\n";
4888 print CF
"\$smtp_sitewide_pass = '". quote_single
($smtp_sitewide_pass) ."';\n";
4890 print CF
"\$imap_auth_mech = '$imap_auth_mech';\n";
4892 print CF
"\$use_imap_tls = $use_imap_tls;\n";
4894 print CF
"\$use_smtp_tls = $use_smtp_tls;\n";
4896 print CF
"\$session_name = '$session_name';\n";
4898 print CF
"\$only_secure_cookies = $only_secure_cookies;\n";
4903 print CF
"\$use_iframe = $use_iframe;\n";
4905 print CF
"\$ask_user_info = $ask_user_info;\n";
4907 print CF
"\$use_icons = $use_icons;\n";
4910 print CF
"\$use_php_recode = $use_php_recode;\n";
4912 print CF
"\$use_php_iconv = $use_php_iconv;\n";
4915 print CF
"\$allow_remote_configtest = $allow_remote_configtest;\n";
4916 print CF
"\$secured_config = $secured_config;\n";
4917 # (binary) integer or constant - convert integer
4918 # values to constants before output
4919 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
4920 print CF
"\$sm_debug_mode = $sm_debug_mode;\n";
4925 print "Data saved in config.php\n";
4927 build_plugin_hook_array
();
4930 print "Error saving config.php: $!\n";
4936 print $WHT. "SquirrelMail Configuration : " . $NRM;
4937 if ( $config == 1 ) { print "Read: config.php"; }
4938 elsif ( $config == 2 ) { print "Read: config_default.php"; }
4940 print "---------------------------------------------------------\n";
4942 print "While we have been building SquirrelMail, we have discovered some\n";
4943 print "preferences that work better with some servers that don't work so\n";
4944 print "well with others. If you select your IMAP server, this option will\n";
4945 print "set some pre-defined settings for that server.\n";
4947 print "Please note that you will still need to go through and make sure\n";
4948 print "everything is correct. This does not change everything. There are\n";
4949 print "only a few settings that this will change.\n";
4953 while ( $continue != 1 ) {
4954 print "Please select your IMAP server:\n";
4955 print $list_supported_imap_servers;
4957 print " quit = Do not change anything\n";
4959 print "Command >> ";
4961 $server =~ s/[\r\n]//g;
4963 # variable is used to display additional messages.
4967 if ( $server eq "cyrus" ) {
4968 $imap_server_type = "cyrus";
4969 $default_folder_prefix = "";
4970 $trash_folder = "INBOX.Trash";
4971 $sent_folder = "INBOX.Sent";
4972 $draft_folder = "INBOX.Drafts";
4973 $show_prefix_option = false
;
4974 $default_sub_of_inbox = true
;
4975 $show_contain_subfolders_option = false
;
4976 $optional_delimiter = ".";
4977 $disp_default_folder_prefix = "<none>";
4978 $force_username_lowercase = false
;
4980 # Delimiter might differ if unixhierarchysep is set to yes.
4981 $message = "\nIf you have enabled unixhierarchysep, you must change delimiter and special folder names.\n";
4984 } elsif ( $server eq "uw" ) {
4985 $imap_server_type = "uw";
4986 $default_folder_prefix = "mail/";
4987 $trash_folder = "Trash";
4988 $sent_folder = "Sent";
4989 $draft_folder = "Drafts";
4990 $show_prefix_option = true
;
4991 $default_sub_of_inbox = false
;
4992 $show_contain_subfolders_option = true
;
4993 $optional_delimiter = "/";
4994 $disp_default_folder_prefix = $default_folder_prefix;
4995 $delete_folder = true
;
4996 $force_username_lowercase = true
;
4999 } elsif ( $server eq "exchange" ) {
5000 $imap_server_type = "exchange";
5001 $default_folder_prefix = "";
5002 $default_sub_of_inbox = true
;
5003 $trash_folder = "INBOX/Deleted Items";
5004 $sent_folder = "INBOX/Sent Items";
5005 $drafts_folder = "INBOX/Drafts";
5006 $show_prefix_option = false
;
5007 $show_contain_subfolders_option = false
;
5008 $optional_delimiter = "detect";
5009 $disp_default_folder_prefix = "<none>";
5010 $force_username_lowercase = true
;
5013 } elsif ( $server eq "courier" ) {
5014 $imap_server_type = "courier";
5015 $default_folder_prefix = "INBOX.";
5016 $trash_folder = "Trash";
5017 $sent_folder = "Sent";
5018 $draft_folder = "Drafts";
5019 $show_prefix_option = false
;
5020 $default_sub_of_inbox = false
;
5021 $show_contain_subfolders_option = false
;
5022 $optional_delimiter = ".";
5023 $disp_default_folder_prefix = $default_folder_prefix;
5024 $delete_folder = true
;
5025 $force_username_lowercase = false
;
5028 } elsif ( $server eq "macosx" ) {
5029 $imap_server_type = "macosx";
5030 $default_folder_prefix = "INBOX/";
5031 $trash_folder = "Trash";
5032 $sent_folder = "Sent";
5033 $draft_folder = "Drafts";
5034 $show_prefix_option = false
;
5035 $default_sub_of_inbox = true
;
5036 $show_contain_subfolders_option = false
;
5037 $optional_delimiter = "detect";
5038 $allow_charset_search = false
;
5039 $disp_default_folder_prefix = $default_folder_prefix;
5042 } elsif ( $server eq "hmailserver" ) {
5043 $imap_server_type = "hmailserver";
5044 $default_folder_prefix = "";
5045 $trash_folder = "INBOX.Trash";
5046 $sent_folder = "INBOX.Sent";
5047 $draft_folder = "INBOX.Drafts";
5048 $show_prefix_option = false
;
5049 $default_sub_of_inbox = true
;
5050 $show_contain_subfolders_option = false
;
5051 $optional_delimiter = "detect";
5052 $allow_charset_search = false
;
5053 $disp_default_folder_prefix = $default_folder_prefix;
5054 $delete_folder = false
;
5055 $force_username_lowercase = false
;
5058 } elsif ( $server eq "mercury32" ) {
5059 $imap_server_type = "mercury32";
5060 $default_folder_prefix = "";
5061 $trash_folder = "Trash";
5062 $sent_folder = "Sent";
5063 $draft_folder = "Drafts";
5064 $show_prefix_option = false
;
5065 $default_sub_of_inbox = true
;
5066 $show_contain_subfolders_option = true
;
5067 $optional_delimiter = "detect";
5068 $delete_folder = true
;
5069 $force_username_lowercase = true
;
5072 } elsif ( $server eq "dovecot" ) {
5073 $imap_server_type = "dovecot";
5074 $default_folder_prefix = "";
5075 $trash_folder = "Trash";
5076 $sent_folder = "Sent";
5077 $draft_folder = "Drafts";
5078 $show_prefix_option = false
;
5079 $default_sub_of_inbox = false
;
5080 $show_contain_subfolders_option = false
;
5081 $delete_folder = false
;
5082 $force_username_lowercase = true
;
5083 $optional_delimiter = "detect";
5084 $disp_default_folder_prefix = "<none>";
5087 } elsif ( $server eq "bincimap" ) {
5088 $imap_server_type = "bincimap";
5089 $default_folder_prefix = "INBOX/";
5090 $trash_folder = "Trash";
5091 $sent_folder = "Sent";
5092 $draft_folder = "Drafts";
5093 $show_prefix_option = false
;
5094 $default_sub_of_inbox = false
;
5095 $show_contain_subfolders_option = false
;
5096 $delete_folder = true
;
5097 $force_username_lowercase = false
;
5098 $optional_delimiter = "detect";
5099 $disp_default_folder_prefix = $default_folder_prefix;
5101 # Default folder prefix depends on used depot.
5102 $message = "\nIf you use IMAPdir depot, you must set default folder prefix to empty string.\n";
5105 } elsif ( $server eq "quit" ) {
5108 $disp_default_folder_prefix = $default_folder_prefix;
5109 print "Unrecognized server: $server\n";
5113 print " imap_server_type = $imap_server_type\n";
5114 print " default_folder_prefix = $disp_default_folder_prefix\n";
5115 print " trash_folder = $trash_folder\n";
5116 print " sent_folder = $sent_folder\n";
5117 print " draft_folder = $draft_folder\n";
5118 print " show_prefix_option = $show_prefix_option\n";
5119 print " default_sub_of_inbox = $default_sub_of_inbox\n";
5120 print "show_contain_subfolders_option = $show_contain_subfolders_option\n";
5121 print " optional_delimiter = $optional_delimiter\n";
5122 print " delete_folder = $delete_folder\n";
5123 print " force_username_lowercase = $force_username_lowercase\n";
5127 print "\nPress enter to continue...";
5131 # This subroutine corrects relative paths to ensure they
5132 # will work within the SM space. If the path falls within
5133 # the SM directory tree, the SM_PATH variable will be
5134 # prepended to the path, if not, then the path will be
5135 # converted to an absolute path, e.g.
5136 # '../images/logo.gif' --> SM_PATH . 'images/logo.gif'
5137 # '../../someplace/data' --> '/absolute/path/someplace/data'
5138 # 'images/logo.gif' --> SM_PATH . 'config/images/logo.gif'
5139 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
5140 # 'http://whatever/' --> 'http://whatever'
5141 # $some_var/path --> "$some_var/path"
5142 sub change_to_SM_path
() {
5143 my ($old_path) = @_;
5149 # If the path is absolute, don't bother.
5150 return "\'" . $old_path . "\'" if ( $old_path eq '');
5151 return "\'" . $old_path . "\'" if ( $old_path =~ /^(\/|http
)/ );
5152 return "\'" . $old_path . "\'" if ( $old_path =~ /^\w:\// );
5153 return $old_path if ( $old_path =~ /^\'(\/|http
)/ );
5154 return $old_path if ( $old_path =~ /^\'\w:\// );
5155 return $old_path if ( $old_path =~ /^SM_PATH/);
5157 if ( $old_path =~ /^\$/ ) {
5158 # check if it's a single var, or a $var/path combination
5159 # if it's $var/path, enclose in ""
5160 if ( $old_path =~ /\// ) {
5161 return '"'.$old_path.'"';
5166 # Remove remaining '
5167 $old_path =~ s/\'//g;
5169 # For relative paths, split on '../'
5170 @rel_path = split(/\.\.\//, $old_path);
5172 if ( $#rel_path > 1 ) {
5173 # more than two levels away. Make it absolute.
5174 @abs_path = split(/\//, $dir);
5176 # Lop off the relative pieces of the absolute path..
5177 for ( $i = 0; $i <= $#rel_path; $i++ ) {
5181 push @abs_path, @rel_path;
5182 $new_path = "\'" . join('/', @abs_path) . "\'";
5183 } elsif ( $#rel_path > 0 ) {
5184 # it's within the SM tree, prepend SM_PATH
5185 $new_path = $old_path;
5186 $new_path =~ s/^\.\.\//SM_PATH
. \'/;
5189 # Last, it's a relative path without any leading '.'
5190 # Prepend SM_PATH and config, since the paths are
5191 # relative to the config directory
5192 $new_path = "SM_PATH . \'config/" . $old_path . "\'";
5198 # Change SM_PATH to admin-friendly version, e.g.:
5199 # SM_PATH . 'images/logo.gif' --> '../images/logo.gif'
5200 # SM_PATH . 'config/some.php' --> 'some.php'
5201 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
5202 # 'http://whatever/' --> 'http://whatever'
5203 sub change_to_rel_path
() {
5204 my ($old_path) = @_;
5205 my $new_path = $old_path;
5207 if ( $old_path =~ /^SM_PATH/ ) {
5208 # FIXME: the following replacement loses the opening quote mark!
5209 $new_path =~ s/^SM_PATH . \'/\.\.\//;
5210 $new_path =~ s/\.\.\/config\///;
5216 # Attempts to auto-detect if a specific auth mechanism is supported.
5217 # Called by 'command112a' and 'command112b'
5218 # ARGS: service-name (IMAP or SMTP), host:port, mech-name (ie. CRAM-MD5)
5219 sub detect_auth_support
{
5220 # Try loading IO::Socket
5221 unless (eval("use IO::Socket; 1")) {
5222 print "Perl IO::Socket module is not available.";
5226 my $service = shift;
5230 if ((!defined($service)) or (!defined($host)) or (!defined($mech))) {
5231 # Error - wrong # of args
5232 print "BAD ARGS!\n";
5236 if ($service eq 'SMTP') {
5237 $cmd = "AUTH $mech\r\n";
5238 $logout = "QUIT\r\n";
5239 } elsif ($service eq 'IMAP') {
5240 $cmd = "A01 AUTHENTICATE $mech\n";
5241 $logout = "C01 LOGOUT\n";
5243 # unknown service - whoops.
5247 # Get this show on the road
5248 my $sock=IO
::Socket
::INET
->new($host);
5249 if (!defined($sock)) {
5253 my $discard = <$sock>; # Server greeting/banner - who cares..
5255 if ($service eq 'SMTP') {
5257 print $sock "HELO $domain\r\n";
5258 $discard = <$sock>; # Yeah yeah, you're happy to see me..
5262 my $response = <$sock>;
5264 if (!defined($response)) {
5268 # So at this point, we have a response, and it is (hopefully) valid.
5269 if ($service eq 'SMTP') {
5270 if (!($response =~ /^334/)) {
5272 print $sock $logout;
5276 } elsif ($service eq 'IMAP') {
5277 if ($response =~ /^A01/) {
5279 print $sock $logout;
5284 # Unknown service - this shouldn't be able to happen.
5289 # If it gets here, the mech is supported
5290 print $sock "*\n"; # Attempt to cancel authentication
5291 print $sock $logout; # Try to log out, but we don't really care if this fails
5297 # Example code from O'Reilly Perl Cookbook
5304 return wantarray ?
@out : $out[0];
5307 sub clear_screen
() {
5308 if ( $^O
=~ /^mswin/i) {
5315 # checks IMAP mailbox name. Refuses to accept 8bit folders
5316 # returns 0 (folder name is not correct) or 1 (folder name is correct)
5317 sub check_imap_folder
($) {
5318 my $folder_name = shift(@_);
5320 if ($folder_name =~ /[\x80-\xFFFF]/) {
5321 print "Folder name contains 8bit characters. Configuration utility requires\n";
5322 print "UTF7-IMAP encoded folder names.\n";
5323 print "Press enter to continue...";
5326 } elsif ($folder_name =~ /[&\*\%]/) {
5327 # check for ampersand and list-wildcards
5328 print "Folder name contains special UTF7-IMAP characters.\n";
5329 print "Are you sure that folder name is correct? (y/N): ";
5331 $tmp = lc(trim
($tmp));
5332 if ($tmp =~ /^y$/) {
5342 # quotes string written in single quotes
5343 sub quote_single
($) {
5344 my $string = shift(@_);
5345 $string =~ s/\'/\\'/g;
5349 # determine a plugin's version number
5351 # parses the setup.php file, looking for the
5352 # version string in the <plugin>_info() or the
5353 # <plugin>_version functions.
5355 sub get_plugin_version
() {
5357 my $plugin_name = shift(@_);
5359 $setup_file = '../plugins/' . $plugin_name . '/setup.php';
5360 if ( -e
"$setup_file" ) {
5361 # Make sure that file is readable
5362 if (! -r
"$setup_file") {
5365 print "The file \"$setup_file\" was found, but you don't\n";
5366 print "have rights to read it. The plugin \"";
5367 print $plugin_name . "\" may not work correctly until you fix this.\n";
5368 print "\nPress enter to continue";
5375 # FIXME: grep the file instead of reading it into memory?
5377 open( FILE
, "$setup_file" );
5378 while ( $line = <FILE
> ) {
5379 $whole_file .= $line;
5383 # ideally, there is a version in the <plugin>_info function...
5385 if ($whole_file =~ /('version'\s*=>\s*['"](.*?)['"])/) {
5388 # this assumes there is only one function that returns
5389 # a static string in the setup file
5391 } elsif ($whole_file =~ /(return\s*['"](.*?)['"])/) {
5400 print "The file \"$setup_file\" was not found.\n";
5401 print "The plugin \"" . $plugin_name;
5402 print "\" may not work correctly until you fix this.\n";
5403 print "\nPress enter to continue";
5411 # determine a plugin's English name
5413 # parses the setup.php file, looking for the
5414 # English name in the <plugin>_info() function.
5416 sub get_plugin_english_name
() {
5418 my $plugin_name = shift(@_);
5420 $setup_file = '../plugins/' . $plugin_name . '/setup.php';
5421 if ( -e
"$setup_file" ) {
5422 # Make sure that file is readable
5423 if (! -r
"$setup_file") {
5426 print "The file \"$setup_file\" was found, but you don't\n";
5427 print "have rights to read it. The plugin \"";
5428 print $plugin_name . "\" may not work correctly until you fix this.\n";
5429 print "\nPress enter to continue";
5436 # FIXME: grep the file instead of reading it into memory?
5438 open( FILE
, "$setup_file" );
5439 while ( $line = <FILE
> ) {
5440 $whole_file .= $line;
5444 # the English name is in the <plugin>_info function or nothing...
5446 if ($whole_file =~ /('english_name'\s*=>\s*['"](.*?)['"])/) {
5447 $english_name .= $2;
5450 return $english_name;
5455 print "The file \"$setup_file\" was not found.\n";
5456 print "The plugin \"" . $plugin_name;
5457 print "\" may not work correctly until you fix this.\n";
5458 print "\nPress enter to continue";
5466 # parses the setup.php files for all activated plugins and
5467 # builds static plugin hooks array so we don't have to load
5468 # ALL plugins are runtime and build the hook array on every
5471 # hook array is saved in config/plugin_hooks.php
5473 # Note the $verbose variable at the top of this routine
5474 # can be set to zero to quiet it down.
5476 # NOTE/FIXME: we aren't necessarily interested in writing
5477 # a full-blown PHP parsing engine, so plenty
5478 # of assumptions are included herein about the
5479 # coding of the plugin setup files, and things
5480 # like commented out curly braces or other
5481 # such oddities can break this in a bad way.
5483 sub build_plugin_hook_array
() {
5491 if ( open( HOOKFILE
, ">plugin_hooks.php" ) ) {
5492 print HOOKFILE
"<?php\n";
5493 print HOOKFILE
"\n";
5495 print HOOKFILE
"/**\n";
5496 print HOOKFILE
" * SquirrelMail Plugin Hook Registration File\n";
5497 print HOOKFILE
" * Auto-generated using the configure script, conf.pl\n";
5498 print HOOKFILE
" */\n";
5499 print HOOKFILE
"\n";
5500 print HOOKFILE
"global \$squirrelmail_plugin_hooks;\n";
5501 print HOOKFILE
"\n";
5503 PLUGIN
: for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
5506 print "Activating plugin \"" . $plugins[$ct] . "\"...\n";
5509 $setup_file = '../plugins/' . $plugins[$ct] . '/setup.php';
5510 if ( -e
"$setup_file" ) {
5511 # Make sure that file is readable
5512 if (! -r
"$setup_file") {
5515 print "The file \"$setup_file\" was found, but you don't\n";
5516 print "have rights to read it. The plugin \"";
5517 print $plugins[$ct] . "\" will not be activated until you fix this.\n";
5518 print "\nPress enter to continue";
5523 open( FILE
, "$setup_file" );
5524 $inside_init_fxn = 0;
5526 while ( $line = <FILE
> ) {
5528 # throw away lines until we get to target function
5530 if (!$inside_init_fxn
5531 && $line !~ /^\s*function\s*squirrelmail_plugin_init_/i) {
5534 $inside_init_fxn = 1;
5544 # count close braces
5549 # leaving <plugin>_init() function...
5550 if ($brace_count == 0) {
5558 # throw away lines that are not exactly one "brace set" deep
5560 if ($brace_count > 1) {
5565 # also not interested in lines that are not
5566 # hook registration points
5568 if ($line !~ /^\s*\$squirrelmail_plugin_hooks/i) {
5573 # if $line does not have an ending semicolon,
5574 # we need to recursively read in subsequent
5575 # lines until we find one
5576 while ( $line !~ /;\s*$/ ) {
5577 $line =~ s/[\n\r]\s*$//;
5586 $var =~ s/=/EQUALS/;
5587 if ( $var =~ /^([a-z])/i ) {
5588 @options = split ( /\s*EQUALS\s*/, $var );
5589 $options[1] =~ s/[\n\r]//g;
5590 $options[1] =~ s/[\'\"];\s*$//;
5591 $options[1] =~ s/;$//;
5592 $options[1] =~ s/^[\'\"]//;
5593 # de-escape escaped strings
5594 $options[1] =~ s/\\'/'/g;
5595 $options[1] =~ s/\\\\/\\/g;
5597 if ( $options[0] =~ /^squirrelmail_plugin_hooks\s*\[\s*['"]([a-z0-9 \/._
*-]+)['"]\s*\]\s*\[\s*['"]([0-9a-z._-]+)['"]\s
*\
]/i
) {
5599 $hooked_plugin_name = $2;
5600 # Note: if we wanted to stop plugins from registering
5601 # a *different* plugin on a hook, we could catch
5602 # it here, however this has actually proven to be
5603 # a useful *feature*
5604 #if ($hooked_plugin_name ne $plugins[$ct]) {
5605 # print "...plugin is tring to hook in under different name...\n";
5608 #FIXME: do we want to count the number of hook registrations for each plugin and warn if a plugin doesn't have any?
5609 # hook registration has been found!
5611 if ($hooked_plugin_name ne $plugins[$ct]) {
5612 print " registering on hook \"" . $hook_name . "\" (as \"$hooked_plugin_name\" plugin)\n";
5614 print " registering on hook \"" . $hook_name . "\"\n";
5617 $line =~ s/ {2,}/ /g;
5619 print HOOKFILE
"\$$line";
5631 print "The file \"$setup_file\" was not found.\n";
5632 print "The plugin \"" . $plugins[$ct];
5633 print "\" will not be activated until you fix this.\n";
5634 print "\nPress enter to continue";
5642 print HOOKFILE
"\n\n";
5645 print "\nDone activating plugins; registration data saved in plugin_hooks.php\n\n";
5652 print "The file \"plugin_hooks.php\" was not able to be written to.\n";
5653 print "No plugins will be activated until you fix this.\n";
5654 print "\nPress enter to continue";
5662 # converts (binary) integer values that correspond
5663 # to the SquirrelMail debug mode constants (see
5664 # include/constants.php) into those constant strings
5665 # (bitwise or'd if more than one is enabled)
5667 # if the value passed in is not an integer, it is
5668 # returned unmolested
5670 sub convert_debug_binary_integer_to_constants
() {
5672 my ($debug_mode) = @_;
5673 if ($debug_mode =~ /^[^0-9]/) {
5676 $debug_mode = int($debug_mode);
5677 $new_debug_mode = '';
5679 # per include/constants.php, here are their values:
5681 # 0 SM_DEBUG_MODE_OFF
5682 # 1 SM_DEBUG_MODE_SIMPLE
5683 # 512 SM_DEBUG_MODE_MODERATE
5684 # 524288 SM_DEBUG_MODE_ADVANCED
5685 # 536870912 SM_DEBUG_MODE_STRICT
5687 if ($debug_mode & 1) {
5688 $new_debug_mode .= ' | SM_DEBUG_MODE_SIMPLE';
5690 if ($debug_mode & 512) {
5691 $new_debug_mode .= ' | SM_DEBUG_MODE_MODERATE';
5693 if ($debug_mode & 524288) {
5694 $new_debug_mode .= ' | SM_DEBUG_MODE_ADVANCED';
5696 if ($debug_mode & 536870912) {
5697 $new_debug_mode .= ' | SM_DEBUG_MODE_STRICT';
5700 $new_debug_mode =~ s/^ \| //;
5701 if (!$new_debug_mode) {
5702 $new_debug_mode = 'SM_DEBUG_MODE_OFF';
5705 return $new_debug_mode;
5708 # converts SquirrelMail debug mode constants (see
5709 # include/constants.php) into their corresponding
5710 # (binary) integer values
5712 # if the value passed in is an integer already, it
5713 # is returned unmolested
5715 sub convert_debug_constants_to_binary_integer
() {
5717 my ($debug_mode) = @_;
5718 if ($debug_mode =~ /^[0-9]/) {
5721 $new_debug_mode = 0;
5723 # per include/constants.php, here are their values:
5725 # 0 SM_DEBUG_MODE_OFF
5726 # 1 SM_DEBUG_MODE_SIMPLE
5727 # 512 SM_DEBUG_MODE_MODERATE
5728 # 524288 SM_DEBUG_MODE_ADVANCED
5729 # 536870912 SM_DEBUG_MODE_STRICT
5731 if ($debug_mode =~ /\bSM_DEBUG_MODE_OFF\b/) {
5732 $new_debug_mode = 0;
5734 if ($debug_mode =~ /\bSM_DEBUG_MODE_SIMPLE\b/) {
5735 $new_debug_mode |= 1;
5737 if ($debug_mode =~ /\bSM_DEBUG_MODE_MODERATE\b/) {
5738 $new_debug_mode |= 512;
5740 if ($debug_mode =~ /\bSM_DEBUG_MODE_ADVANCED\b/) {
5741 $new_debug_mode |= 524288;
5743 if ($debug_mode =~ /\bSM_DEBUG_MODE_STRICT\b/) {
5744 $new_debug_mode |= 536870912;
5747 return $new_debug_mode;
5750 # Function to print n column numbered lists
5752 # WARNING: the names in the list will be truncated
5753 # to fit in their respective columns based on the
5754 # screen width and number of columns.
5756 # Expected arguments (in this order):
5758 # * The start number to use for the list
5759 # * The number of columns to use
5760 # * The screen width
5761 # * Boolean (zero/one), indicating
5762 # whether or not to show item numbers
5763 # * The list of strings to be shown
5765 # Returns: The number printed on screen of the last item in the list
5767 sub print_multi_col_list
{
5768 my ($num, $cols, $screen_width, $show_numbering, @list) = @_;
5778 $rows = int(@list / $cols);
5779 if (@list % $cols) { $rows++; }
5780 if ($show_numbering) { $col_width = int(($screen_width - 2) / $cols) - 5; }
5781 else { $col_width = int(($screen_width - 2) / $cols) - 2; }
5783 # build the layout array so numbers run down each column
5785 for ( $x = 0; $x < @list; $x++ ) {
5787 $layout[$row_cnt][$col_cnt] = $list[$x];
5788 $numbers[$row_cnt][$col_cnt] = $num++;
5790 # move to next column
5792 if ($row_cnt == $rows - 1) {
5796 else { $row_cnt++; }
5800 # if we filled up fewer rows than needed, recalc column width
5802 if ($rows * $col_cnt == @list) { $col_cnt--; } # loop above ended right after increment
5803 if ($col_cnt + 1 < $cols) {
5804 if ($show_numbering) { $col_width = int(($screen_width - 2) / ($col_cnt + 1)) - 5; }
5805 else { $col_width = int(($screen_width - 2) / ($col_cnt + 1)) - 2; }
5811 for ( $row_cnt = 0; $row_cnt <= $rows; $row_cnt++ ) {
5817 # iterate columns for this row
5819 for ( $col_cnt = 0; $col_cnt <= $cols; $col_cnt++ ) {
5820 if ($layout[$row_cnt][$col_cnt]) {
5822 if ($show_numbering) { printf "$WHT% 2u.$NRM", $numbers[$row_cnt][$col_cnt]; }
5823 printf " %-$col_width." . $col_width . "s", $layout[$row_cnt][$col_cnt];