4 # Copyright (c) 1999-2007 The SquirrelMail Project Team
5 # Licensed under the GNU GPL. For full terms see COPYING.
7 # A simple configure script to configure SquirrelMail
10 ############################################################
11 $conf_pl_version = "1.5.0";
13 ############################################################
14 # Check what directory we're supposed to be running in, and
15 # change there if necessary. File::Basename has been in
16 # Perl since at least 5.003_7, and nobody sane runs anything
17 # before that, but just in case.
18 ############################################################
20 if ( eval q{require "File/Basename.pm"} ) {
21 $dir = File
::Basename
::dirname
($0);
25 ############################################################
26 # Some people try to run this as a CGI. That's wrong!
27 ############################################################
28 if ( defined( $ENV{'PATH_INFO'} )
29 || defined( $ENV{'QUERY_STRING'} )
30 || defined( $ENV{'REQUEST_METHOD'} ) ) {
31 print "Content-Type: text/html\n\n";
32 print "You must run this script from the command line.";
36 ############################################################
37 # If we got here, use Cwd to get the full directory path
38 # (the Basename stuff above will sometimes return '.' as
39 # the base directory, which is not helpful here).
40 ############################################################
45 ############################################################
46 # First, lets read in the data already in there...
47 ############################################################
48 if ( -e
"config.php" ) {
49 # Make sure that file is readable
50 if (! -r
"config.php") {
53 print "The file \"config/config.php\" was found, but you don't\n";
54 print "have rights to read it.\n";
56 print "Press enter to continue";
60 open( FILE
, "config.php" );
61 while ( $line = <FILE
> ) {
67 if ( $var =~ /^([a-z])/i ) {
68 @o = split ( /\s*EQUALS\s*/, $var );
69 if ( $o[0] eq "config_version" ) {
71 $o[1] =~ s/[\'\"];\s*$//;
75 $config_version = $o[1];
82 if ( $config_version ne $conf_pl_version ) {
85 print " The file \"config/config.php\" was found, but it is for\n";
86 print " an older version of SquirrelMail. It is possible to still\n";
87 print " read the defaults from this file but be warned that many\n";
88 print " preferences change between versions. It is recommended that\n";
89 print " you start with a clean config.php for each upgrade that you\n";
90 print " do. To do this, just move config/config.php out of the way.\n";
92 print "Continue loading with the old config.php [y/N]? ";
95 if ( ( $ctu !~ /^y\n/i ) || ( $ctu =~ /^\n/ ) ) {
99 print "\nDo you want me to stop warning you [y/N]? ";
101 if ( $ctu =~ /^y\n/i ) {
102 $print_config_version = $conf_pl_version;
104 $print_config_version = $config_version;
107 $print_config_version = $config_version;
111 open( FILE
, "config.php" );
112 } elsif ( -e
"config_default.php" ) {
113 open( FILE
, "config_default.php" );
114 while ( $line = <FILE
> ) {
120 if ( $var =~ /^([a-z])/i ) {
121 @o = split ( /\s*EQUALS\s*/, $var );
122 if ( $o[0] eq "config_version" ) {
123 $o[1] =~ s/[\n\r]//g;
124 $o[1] =~ s/[\'\"];\s*$//;
126 $o[1] =~ s/^[\'\"]//;
128 $config_version = $o[1];
135 if ( $config_version ne $conf_pl_version ) {
138 print " You are trying to use a 'config_default.php' from an older\n";
139 print " version of SquirrelMail. This is HIGHLY unrecommended. You\n";
140 print " should get the 'config_default.php' that matches the version\n";
141 print " of SquirrelMail that you are running. You can get this from\n";
142 print " the SquirrelMail web page by going to the following URL:\n";
143 print " http://squirrelmail.org.\n";
145 print "Continue loading with old config_default.php (a bad idea) [y/N]? ";
148 if ( ( $ctu !~ /^y\n/i ) || ( $ctu =~ /^\n/ ) ) {
152 print "\nDo you want me to stop warning you [y/N]? ";
154 if ( $ctu =~ /^y\n/i ) {
155 $print_config_version = $conf_pl_version;
157 $print_config_version = $config_version;
160 $print_config_version = $config_version;
163 open( FILE
, "config_default.php" );
165 print "No configuration file found. Please get config_default.php\n";
166 print "or config.php before running this again. This program needs\n";
167 print "a default config file to get default values.\n";
171 # Read and parse the current configuration file
172 # (either config.php or config_default.php).
173 while ( $line = <FILE
> ) {
179 if ( $var =~ /^([a-z])/i ) {
180 @options = split ( /\s*EQUALS\s*/, $var );
181 $options[1] =~ s/[\n\r]//g;
182 $options[1] =~ s/[\'\"];\s*$//;
183 $options[1] =~ s/;$//;
184 $options[1] =~ s/^[\'\"]//;
185 # de-escape escaped strings
186 $options[1] =~ s/\\'/'/g;
187 $options[1] =~ s/\\\\/\\/g;
189 if ( $options[0] =~ /^user_themes\[[0-9]+\]\[['"]PATH['"]\]/ ) {
191 $sub =~ s/\]\[['"]PATH['"]\]//;
193 if ( -e
"../css/" ) {
194 $options[1] =~ s/^\.\.\/config/\
.\
.\
/css/;
196 $user_theme_path[$sub] = &change_to_rel_path
($options[1]);
197 } elsif ( $options[0] =~ /^user_themes\[[0-9]+\]\[['"]NAME['"]\]/ ) {
199 $sub =~ s/\]\[['"]NAME['"]\]//;
201 $user_theme_name[$sub] = $options[1];
202 } elsif ( $options[0] =~ /^icon_themes\[[0-9]+\]\[['"]PATH['"]\]/ ) {
204 $sub =~ s/\]\[['"]PATH['"]\]//;
206 if ( -e
"../images/" ) {
207 $options[1] =~ s/^\.\.\/config/\
.\
.\
/images/;
209 $icon_theme_path[$sub] = &change_to_rel_path
($options[1]);
210 } elsif ( $options[0] =~ /^icon_themes\[[0-9]+\]\[['"]NAME['"]\]/ ) {
212 $sub =~ s/\]\[['"]NAME['"]\]//;
214 $icon_theme_name[$sub] = $options[1];
215 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]ID['"]\]/ ) {
217 $sub =~ s/\]\[['"]ID['"]\]//;
219 if ( -e
"../templates" ) {
220 $options[1] =~ s/^\.\.\/config/\
.\
.\
/templates/;
222 $templateset_id[$sub] = $options[1];
223 ##### FIXME: This section BELOW here so old prefs files don't blow up when running conf.pl
224 ##### Remove after a month or two
225 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]PATH['"]\]/ ) {
227 $sub =~ s/\]\[['"]PATH['"]\]//;
229 if ( -e
"../templates" ) {
230 $options[1] =~ s/^\.\.\/config/\
.\
.\
/templates/;
232 $templateset_id[$sub] = $options[1];
233 ##### FIXME: This section ABOVE here so old prefs files don't blow up when running conf.pl
234 ##### Remove after a month or two
235 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]NAME['"]\]/ ) {
237 $sub =~ s/\]\[['"]NAME['"]\]//;
239 $templateset_name[$sub] = $options[1];
240 } elsif ( $options[0] =~ /^plugins\[[0-9]*\]/ ) {
243 $sub =~ s/^plugins\[//;
245 push @plugins, $options[1];
247 $plugins[$sub] = $options[1];
249 } elsif ($options[0] =~ /^fontsets\[\'[a-z]*\'\]/) {
250 # parse associative $fontsets array
253 $sub =~ s/^fontsets\[\'//;
254 $fontsets{$sub} = $options[1];
255 } elsif ( $options[0] =~ /^theme\[[0-9]+\]\[['"]PATH|NAME['"]\]/ ) {
257 ## $color themes are no longer supported. Please leave this
258 ## so conf.pl doesn't barf if it encounters a $theme.
260 } elsif ( $options[0] =~ /^ldap_server\[[0-9]+\]/ ) {
263 $sub =~ s/^ldap_server\[//;
265 while ( ( $tmp = <FILE
> ) && ( $continue != 1 ) ) {
266 if ( $tmp =~ /\);\s*$/ ) {
270 if ( $tmp =~ /^\s*[\'\"]host[\'\"]/i ) {
271 $tmp =~ s/^\s*[\'\"]host[\'\"]\s*=>\s*[\'\"]//i;
272 $tmp =~ s/[\'\"],?\s*$//;
273 $tmp =~ s/[\'\"]\);\s*$//;
275 } elsif ( $tmp =~ /^\s*[\'\"]base[\'\"]/i ) {
276 $tmp =~ s/^\s*[\'\"]base[\'\"]\s*=>\s*[\'\"]//i;
277 $tmp =~ s/[\'\"],?\s*$//;
278 $tmp =~ s/[\'\"]\);\s*$//;
280 } elsif ( $tmp =~ /^\s*[\'\"]charset[\'\"]/i ) {
281 $tmp =~ s/^\s*[\'\"]charset[\'\"]\s*=>\s*[\'\"]//i;
282 $tmp =~ s/[\'\"],?\s*$//;
283 $tmp =~ s/[\'\"]\);\s*$//;
285 } elsif ( $tmp =~ /^\s*[\'\"]port[\'\"]/i ) {
286 $tmp =~ s/^\s*[\'\"]port[\'\"]\s*=>\s*[\'\"]?//i;
287 $tmp =~ s/[\'\"]?,?\s*$//;
288 $tmp =~ s/[\'\"]?\);\s*$//;
290 } elsif ( $tmp =~ /^\s*[\'\"]maxrows[\'\"]/i ) {
291 $tmp =~ s/^\s*[\'\"]maxrows[\'\"]\s*=>\s*[\'\"]?//i;
292 $tmp =~ s/[\'\"]?,?\s*$//;
293 $tmp =~ s/[\'\"]?\);\s*$//;
295 } elsif ( $tmp =~ /^\s*[\'\"]filter[\'\"]/i ) {
296 $tmp =~ s/^\s*[\'\"]filter[\'\"]\s*=>\s*[\'\"]?//i;
297 $tmp =~ s/[\'\"]?,?\s*$//;
298 $tmp =~ s/[\'\"]?\);\s*$//;
300 } elsif ( $tmp =~ /^\s*[\'\"]name[\'\"]/i ) {
301 $tmp =~ s/^\s*[\'\"]name[\'\"]\s*=>\s*[\'\"]//i;
302 $tmp =~ s/[\'\"],?\s*$//;
303 $tmp =~ s/[\'\"]\);\s*$//;
305 } elsif ( $tmp =~ /^\s*[\'\"]binddn[\'\"]/i ) {
306 $tmp =~ s/^\s*[\'\"]binddn[\'\"]\s*=>\s*[\'\"]//i;
307 $tmp =~ s/[\'\"],?\s*$//;
308 $tmp =~ s/[\'\"]\);\s*$//;
310 } elsif ( $tmp =~ /^\s*[\'\"]bindpw[\'\"]/i ) {
311 $tmp =~ s/^\s*[\'\"]bindpw[\'\"]\s*=>\s*[\'\"]//i;
312 $tmp =~ s/[\'\"],?\s*$//;
313 $tmp =~ s/[\'\"]\);\s*$//;
315 } elsif ( $tmp =~ /^\s*[\'\"]protocol[\'\"]/i ) {
316 $tmp =~ s/^\s*[\'\"]protocol[\'\"]\s*=>\s*[\'\"]?//i;
317 $tmp =~ s/[\'\"]?,?\s*$//;
318 $tmp =~ s/[\'\"]?\);\s*$//;
320 } elsif ( $tmp =~ /^\s*[\'\"]limit_scope[\'\"]/i ) {
321 $tmp =~ s/^\s*[\'\"]limit_scope[\'\"]\s*=>\s*[\'\"]?//i;
322 $tmp =~ s/[\'\"]?,?\s*$//;
323 $tmp =~ s/[\'\"]?\);\s*$//;
325 } elsif ( $tmp =~ /^\s*[\'\"]listing[\'\"]/i ) {
326 $tmp =~ s/^\s*[\'\"]listing[\'\"]\s*=>\s*[\'\"]?//i;
327 $tmp =~ s/[\'\"]?,?\s*$//;
328 $tmp =~ s/[\'\"]?\);\s*$//;
330 } elsif ( $tmp =~ /^\s*[\'\"]writeable[\'\"]/i ) {
331 $tmp =~ s/^\s*[\'\"]writeable[\'\"]\s*=>\s*[\'\"]?//i;
332 $tmp =~ s/[\'\"]?,?\s*$//;
333 $tmp =~ s/[\'\"]?\);\s*$//;
335 } elsif ( $tmp =~ /^\s*[\'\"]search_tree[\'\"]/i ) {
336 $tmp =~ s/^\s*[\'\"]search_tree[\'\"]\s*=>\s*[\'\"]?//i;
337 $tmp =~ s/[\'\"]?,?\s*$//;
338 $tmp =~ s/[\'\"]?\);\s*$//;
340 } elsif ( $tmp =~ /^\s*[\'\"]starttls[\'\"]/i ) {
341 $tmp =~ s/^\s*[\'\"]starttls[\'\"]\s*=>\s*[\'\"]?//i;
342 $tmp =~ s/[\'\"]?,?\s*$//;
343 $tmp =~ s/[\'\"]?\);\s*$//;
347 $ldap_host[$sub] = $host;
348 $ldap_base[$sub] = $base;
349 $ldap_name[$sub] = $name;
350 $ldap_port[$sub] = $port;
351 $ldap_maxrows[$sub] = $maxrows;
352 $ldap_filter[$sub] = $filter;
353 $ldap_charset[$sub] = $charset;
354 $ldap_binddn[$sub] = $binddn;
355 $ldap_bindpw[$sub] = $bindpw;
356 $ldap_protocol[$sub] = $protocol;
357 $ldap_limit_scope[$sub] = $limit_scope;
358 $ldap_listing[$sub] = $listing;
359 $ldap_writeable[$sub] = $writeable;
360 $ldap_search_tree[$sub] = $search_tree;
361 $ldap_starttls[$sub] = $starttls;
362 } elsif ( $options[0] =~ /^(data_dir|attachment_dir|org_logo|signout_page|icon_theme_def)$/ ) {
363 ${ $options[0] } = &change_to_rel_path
($options[1]);
365 ${ $options[0] } = $options[1];
371 # FIXME: unknown introduction date
372 $useSendmail = 'false' if ( lc($useSendmail) ne 'true' );
373 $sendmail_path = "/usr/sbin/sendmail" if ( !$sendmail_path );
374 $pop_before_smtp = 'false' if ( !$pop_before_smtp );
375 $default_unseen_notify = 2 if ( !$default_unseen_notify );
376 $default_unseen_type = 1 if ( !$default_unseen_type );
377 $config_use_color = 0 if ( !$config_use_color );
378 $invert_time = 'false' if ( !$invert_time );
379 $force_username_lowercase = 'false' if ( !$force_username_lowercase );
380 $optional_delimiter = "detect" if ( !$optional_delimiter );
381 $auto_create_special = 'false' if ( !$auto_create_special );
382 $default_use_priority = 'true' if ( !$default_use_priority );
383 $default_use_mdn = 'true' if ( !$default_use_mdn );
384 $delete_folder = 'false' if ( !$delete_folder );
385 $noselect_fix_enable = 'false' if ( !$noselect_fix_enable );
386 $frame_top = "_top" if ( !$frame_top );
387 $provider_uri = '' if ( !$provider_uri );
388 $provider_name = '' if ( !$provider_name || $provider_name eq 'SquirrelMail');
389 $no_list_for_subscribe = 'false' if ( !$no_list_for_subscribe );
390 $allow_charset_search = 'true' if ( !$allow_charset_search );
391 $allow_advanced_search = 0 if ( !$allow_advanced_search) ;
392 $prefs_user_field = 'user' if ( !$prefs_user_field );
393 $prefs_key_field = 'prefkey' if ( !$prefs_key_field );
394 $prefs_val_field = 'prefval' if ( !$prefs_val_field );
395 $session_name = 'SQMSESSID' if ( !$session_name );
396 $skip_SM_header = 'false' if ( !$skip_SM_header );
397 $default_use_javascript_addr_book = 'false' if (! $default_use_javascript_addr_book);
400 $hide_sm_attributions = 'false' if ( !$hide_sm_attributions );
402 $edit_identity = 'true' if ( !$edit_identity );
403 $edit_name = 'true' if ( !$edit_name );
406 $use_smtp_tls= 'false' if ( !$use_smtp_tls);
407 $smtp_auth_mech = 'none' if ( !$smtp_auth_mech );
408 $use_imap_tls = 'false' if ( !$use_imap_tls );
409 $imap_auth_mech = 'login' if ( !$imap_auth_mech );
412 $show_alternative_names = 'false' if ( !$show_alternative_names );
413 # $available_languages option available only in 1.5.0. removed due to $languages
414 # implementation changes. options are provided by limit_languages plugin
415 # $available_languages = 'all' if ( !$available_languages );
416 $aggressive_decoding = 'false' if ( !$aggressive_decoding );
417 # available only in 1.5.0 and 1.5.1
418 # $advanced_tree = 'false' if ( !$advanced_tree );
419 $use_php_recode = 'false' if ( !$use_php_recode );
420 $use_php_iconv = 'false' if ( !$use_php_iconv );
423 $use_icons = 'false' if ( !$use_icons );
424 $use_iframe = 'false' if ( !$use_iframe );
425 $lossy_encoding = 'false' if ( !$lossy_encoding );
426 $allow_remote_configtest = 'false' if ( !$allow_remote_configtest );
427 $secured_config = 'true' if ( !$secured_config );
429 $sm_debug_mode = 'SM_DEBUG_MODE_MODERATE' if ( !$sm_debug_mode );
430 #FIXME: When this is STABLE software, remove the line above and uncomment the one below:
431 #$sm_debug_mode = 'SM_DEBUG_MODE_OFF' if ( !$sm_debug_mode );
432 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
434 $addrbook_global_table = 'global_abook' if ( !$addrbook_global_table );
435 $addrbook_global_writeable = 'false' if ( !$addrbook_global_writeable );
436 $addrbook_global_listing = 'false' if ( !$addrbook_global_listing );
437 $abook_global_file = '' if ( !$abook_global_file);
438 $abook_global_file_writeable = 'false' if ( !$abook_global_file_writeable);
439 $abook_global_file_listing = 'true' if ( !$abook_global_file_listing );
440 $encode_header_key = '' if ( !$encode_header_key );
441 $hide_auth_header = 'false' if ( !$hide_auth_header );
442 $time_zone_type = '0' if ( !$time_zone_type );
443 $prefs_user_size = 128 if ( !$prefs_user_size );
444 $prefs_key_size = 64 if ( !$prefs_key_size );
445 $prefs_val_size = 65536 if ( !$prefs_val_size );
447 # add qmail-inject test here for backwards compatibility
448 if ( !$sendmail_args && $sendmail_path =~ /qmail-inject/ ) {
450 } elsif ( !$sendmail_args ) {
451 $sendmail_args = '-i -t';
454 $default_fontsize = '' if ( !$default_fontsize);
455 $default_fontset = '' if ( !$default_fontset);
457 %fontsets = ('serif', 'serif',
458 'sans', 'helvetica,arial,sans-serif',
459 'comicsans', 'comic sans ms,sans-serif',
460 'tahoma', 'tahoma,sans-serif',
461 'verasans', 'bitstream vera sans,verdana,sans-serif');
464 # $use_imap_tls and $use_smtp_tls are switched to integer since 1.5.1
465 $use_imap_tls = 0 if ( $use_imap_tls eq 'false');
466 $use_imap_tls = 1 if ( $use_imap_tls eq 'true');
467 $use_smtp_tls = 0 if ( $use_smtp_tls eq 'false');
468 $use_smtp_tls = 1 if ( $use_smtp_tls eq 'true');
469 # sorting options changed names and reversed values in 1.5.1
470 $disable_thread_sort = 'false' if ( !$disable_thread_sort );
471 $disable_server_sort = 'false' if ( !$disable_server_sort );
474 $abook_file_line_length = 2048 if ( !$abook_file_line_length );
475 $config_location_base = '' if ( !$config_location_base );
476 $smtp_sitewide_user = '' if ( !$smtp_sitewide_user );
477 $smtp_sitewide_pass = '' if ( !$smtp_sitewide_pass );
478 $icon_theme_def = '' if ( !$icon_theme_def );
479 $disable_plugins = 'false' if ( !$disable_plugins );
480 $disable_plugins_user = '' if ( !$disable_plugins_user );
481 $only_secure_cookies = 'true' if ( !$only_secure_cookies );
482 $ask_user_info = 'true' if ( !$ask_user_info );
484 if ( $ARGV[0] eq '--install-plugin' ) {
485 print "Activating plugin " . $ARGV[1] . "\n";
486 if ( -d
"../plugins/" . $ARGV[1]) {
487 push @plugins, $ARGV[1];
491 print "No such plugin.\n";
494 } elsif ( $ARGV[0] eq '--remove-plugin' ) {
495 print "Removing plugin " . $ARGV[1] . "\n";
496 foreach $plugin (@plugins) {
497 if ( $plugin ne $ARGV[1] ) {
498 push @newplugins, $plugin;
501 @plugins = @newplugins;
504 } elsif ( $ARGV[0] eq '--update-plugins' or $ARGV[0] eq '-u') {
505 build_plugin_hook_array
();
507 } elsif ( $ARGV[0] eq '--help' or $ARGV[0] eq '-h') {
508 print "SquirrelMail Configuration Script\n";
510 print " * No arguments: initiates the configuration dialog\n";
511 print " * --install-plugin <plugin> : activates the specified plugin\n";
512 print " * --remove-plugin <plugin> : deactivates the specified plugin\n";
513 print " * --update-plugins , -u : rebuilds plugin_hooks.php according\n";
514 print " to plugins activated in config.php\n";
515 print " * --help , -h : Displays this help\n";
522 ####################################################################################
524 # used in multiple places, define once
525 $list_supported_imap_servers =
526 " bincimap = Binc IMAP server\n" .
527 " courier = Courier IMAP server\n" .
528 " cyrus = Cyrus IMAP server\n" .
529 " dovecot = Dovecot Secure IMAP server\n" .
530 " exchange = Microsoft Exchange IMAP server\n" .
531 " hmailserver = hMailServer\n" .
532 " macosx = Mac OS X Mailserver\n" .
533 " mercury32 = Mercury/32\n" .
534 " uw = University of Washington's IMAP server\n";
536 #####################################################################################
537 if ( $config_use_color == 1 ) {
543 $config_use_color = 2;
546 while ( ( $command ne "q" ) && ( $command ne "Q" ) && ( $command ne ":q" ) ) {
548 print $WHT. "SquirrelMail Configuration : " . $NRM;
549 if ( $config == 1 ) { print "Read: config.php"; }
550 elsif ( $config == 2 ) { print "Read: config_default.php"; }
551 print " ($print_config_version)\n";
552 print "---------------------------------------------------------\n";
555 print $WHT. "Main Menu --\n" . $NRM;
556 print "1. Organization Preferences\n";
557 print "2. Server Settings\n";
558 print "3. Folder Defaults\n";
559 print "4. General Options\n";
560 print "5. User Interface\n";
561 print "6. Address Books\n";
562 print "7. Message of the Day (MOTD)\n";
563 print "8. Plugins\n";
564 print "9. Database\n";
565 print "10. Language settings\n";
566 print "11. Tweaks\n";
568 print "D. Set pre-defined settings for specific IMAP servers\n";
570 } elsif ( $menu == 1 ) {
571 print $WHT. "Organization Preferences\n" . $NRM;
572 print "1. Organization Name : $WHT$org_name$NRM\n";
573 print "2. Organization Logo : $WHT$org_logo$NRM\n";
574 print "3. Org. Logo Width/Height : $WHT($org_logo_width/$org_logo_height)$NRM\n";
575 print "4. Organization Title : $WHT$org_title$NRM\n";
576 print "5. Signout Page : $WHT$signout_page$NRM\n";
577 print "6. Top Frame : $WHT$frame_top$NRM\n";
578 print "7. Provider link : $WHT$provider_uri$NRM\n";
579 print "8. Provider link text : $WHT$provider_name$NRM\n";
582 print "R Return to Main Menu\n";
583 } elsif ( $menu == 2 ) {
584 print $WHT. "Server Settings\n\n" . $NRM;
585 print $WHT . "General" . $NRM . "\n";
587 print "1. Domain : $WHT$domain$NRM\n";
588 print "2. Invert Time : $WHT$invert_time$NRM\n";
589 print "3. Sendmail or SMTP : $WHT";
590 if ( lc($useSendmail) eq 'true' ) {
598 if ( $show_imap_settings ) {
599 print $WHT . "IMAP Settings". $NRM . "\n--------------\n";
600 print "4. IMAP Server : $WHT$imapServerAddress$NRM\n";
601 print "5. IMAP Port : $WHT$imapPort$NRM\n";
602 print "6. Authentication type : $WHT$imap_auth_mech$NRM\n";
603 print "7. Secure IMAP (TLS) : $WHT" . display_use_tls
($use_imap_tls) . "$NRM\n";
604 print "8. Server software : $WHT$imap_server_type$NRM\n";
605 print "9. Delimiter : $WHT$optional_delimiter$NRM\n";
607 } elsif ( $show_smtp_settings ) {
608 if ( lc($useSendmail) eq 'true' ) {
609 print $WHT . "Sendmail" . $NRM . "\n--------\n";
610 print "4. Sendmail Path : $WHT$sendmail_path$NRM\n";
611 print "5. Sendmail arguments : $WHT$sendmail_args$NRM\n";
612 print "6. Header encryption key : $WHT$encode_header_key$NRM\n";
615 print $WHT . "SMTP Settings" . $NRM . "\n-------------\n";
616 print "4. SMTP Server : $WHT$smtpServerAddress$NRM\n";
617 print "5. SMTP Port : $WHT$smtpPort$NRM\n";
618 print "6. POP before SMTP : $WHT$pop_before_smtp$NRM\n";
619 print "7. SMTP Authentication : $WHT$smtp_auth_mech" . display_smtp_sitewide_userpass
() ."$NRM\n";
620 print "8. Secure SMTP (TLS) : $WHT" . display_use_tls
($use_smtp_tls) . "$NRM\n";
621 print "9. Header encryption key : $WHT$encode_header_key$NRM\n";
626 if ($show_imap_settings == 0) {
627 print "A. Update IMAP Settings : ";
628 print "$WHT$imapServerAddress$NRM:";
629 print "$WHT$imapPort$NRM ";
630 print "($WHT$imap_server_type$NRM)\n";
632 if ($show_smtp_settings == 0) {
633 if ( lc($useSendmail) eq 'true' ) {
634 print "B. Change Sendmail Config : $WHT$sendmail_path$NRM\n";
636 print "B. Update SMTP Settings : ";
637 print "$WHT$smtpServerAddress$NRM:";
638 print "$WHT$smtpPort$NRM\n";
641 if ( $show_smtp_settings || $show_imap_settings )
644 ($show_imap_settings ?
"IMAP Server" :
645 (lc($useSendmail) eq 'true') ?
"Sendmail" : "SMTP") . " Settings\n";
649 print "R Return to Main Menu\n";
650 } elsif ( $menu == 3 ) {
651 print $WHT. "Folder Defaults\n" . $NRM;
652 print "1. Default Folder Prefix : $WHT$default_folder_prefix$NRM\n";
653 print "2. Show Folder Prefix Option : $WHT$show_prefix_option$NRM\n";
654 print "3. Trash Folder : $WHT$trash_folder$NRM\n";
655 print "4. Sent Folder : $WHT$sent_folder$NRM\n";
656 print "5. Drafts Folder : $WHT$draft_folder$NRM\n";
657 print "6. By default, move to trash : $WHT$default_move_to_trash$NRM\n";
658 print "7. By default, move to sent : $WHT$default_move_to_sent$NRM\n";
659 print "8. By default, save as draft : $WHT$default_save_as_draft$NRM\n";
660 print "9. List Special Folders First : $WHT$list_special_folders_first$NRM\n";
661 print "10. Show Special Folders Color : $WHT$use_special_folder_color$NRM\n";
662 print "11. Auto Expunge : $WHT$auto_expunge$NRM\n";
663 print "12. Default Sub. of INBOX : $WHT$default_sub_of_inbox$NRM\n";
664 print "13. Show 'Contain Sub.' Option : $WHT$show_contain_subfolders_option$NRM\n";
665 print "14. Default Unseen Notify : $WHT$default_unseen_notify$NRM\n";
666 print "15. Default Unseen Type : $WHT$default_unseen_type$NRM\n";
667 print "16. Auto Create Special Folders : $WHT$auto_create_special$NRM\n";
668 print "17. Folder Delete Bypasses Trash : $WHT$delete_folder$NRM\n";
669 print "18. Enable /NoSelect folder fix : $WHT$noselect_fix_enable$NRM\n";
671 print "R Return to Main Menu\n";
672 } elsif ( $menu == 4 ) {
673 print $WHT. "General Options\n" . $NRM;
674 print "1. Data Directory : $WHT$data_dir$NRM\n";
675 print "2. Attachment Directory : $WHT$attachment_dir$NRM\n";
676 print "3. Directory Hash Level : $WHT$dir_hash_level$NRM\n";
677 print "4. Default Left Size : $WHT$default_left_size$NRM\n";
678 print "5. Usernames in Lowercase : $WHT$force_username_lowercase$NRM\n";
679 print "6. Allow use of priority : $WHT$default_use_priority$NRM\n";
680 print "7. Hide SM attributions : $WHT$hide_sm_attributions$NRM\n";
681 print "8. Allow use of receipts : $WHT$default_use_mdn$NRM\n";
682 print "9. Allow editing of identity : $WHT$edit_identity$NRM\n";
683 print " Allow editing of name : $WHT$edit_name$NRM\n";
684 print " Remove username from header : $WHT$hide_auth_header$NRM\n";
685 print "10. Disable server thread sort : $WHT$disable_thread_sort$NRM\n";
686 print "11. Disable server-side sorting : $WHT$disable_server_sort$NRM\n";
687 print "12. Allow server charset search : $WHT$allow_charset_search$NRM\n";
688 print "13. Allow advanced search : $WHT$allow_advanced_search$NRM\n";
689 print "14. PHP session name : $WHT$session_name$NRM\n";
690 print "15. Time zone configuration : $WHT$time_zone_type$NRM\n";
691 print "16. Location base : $WHT$config_location_base$NRM\n";
692 print "17. Only secure cookies if poss. : $WHT$only_secure_cookies$NRM\n";
694 print "R Return to Main Menu\n";
695 } elsif ( $menu == 5 ) {
696 print $WHT. "User Interface\n" . $NRM;
697 print "1. Use Icons? : $WHT$use_icons$NRM\n";
698 # print "3. Default Icon Set : $WHT$icon_theme_def$NRM\n";
699 print "2. Default font size : $WHT$default_fontsize$NRM\n";
700 print "3. Manage template sets (skins)\n";
701 print "4. Manage user themes\n";
702 print "5. Manage font sets\n";
703 print "6. Manage icon themes\n";
706 print "R Return to Main Menu\n";
707 } elsif ( $menu == 6 ) {
708 print $WHT. "Address Books\n" . $NRM;
709 print "1. Change LDAP Servers\n";
710 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
711 print " > $ldap_host[$count]\n";
713 print "2. Use Javascript address book search : $WHT$default_use_javascript_addr_book$NRM\n";
714 print "3. Global address book file : $WHT$abook_global_file$NRM\n";
715 print "4. Allow writing into global file address book : $WHT$abook_global_file_writeable$NRM\n";
716 print "5. Allow listing of global file address book : $WHT$abook_global_file_listing$NRM\n";
717 print "6. Allowed address book line length : $WHT$abook_file_line_length$NRM\n";
719 print "R Return to Main Menu\n";
720 } elsif ( $menu == 7 ) {
721 print $WHT. "Message of the Day (MOTD)\n" . $NRM;
724 print "1 Edit the MOTD\n";
726 print "R Return to Main Menu\n";
727 } elsif ( $menu == 8 ) {
728 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
729 print $WHT. "Plugins (WARNING: All plugins are currently disabled\n for the user \"$disable_plugins_user\"!)\n" . $NRM;
730 } elsif (lc($disable_plugins) eq 'true') {
731 print $WHT. "Plugins (WARNING: All plugins are currently disabled!)\n" . $NRM;
733 print $WHT. "Plugins\n" . $NRM;
735 print " Installed Plugins\n";
737 for ( $count = 0 ; $count <= $#plugins ; $count++ ) {
739 $english_name = get_plugin_english_name
($plugins[$count]);
740 if ( $english_name eq "" ) {
741 print " $num. $plugins[$count]" . get_plugin_version
($plugins[$count]) . "\n";
743 print " $num. $english_name ($plugins[$count])" . get_plugin_version
($plugins[$count]) . "\n";
746 print "\n Available Plugins:\n";
747 opendir( DIR
, "../plugins" );
748 @files = sort(readdir(DIR
));
750 @unused_plugins = ();
751 for ( $i = 0 ; $i <= $#files ; $i++ ) {
752 if ( -d
"../plugins/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne ".svn" ) {
754 for ( $k = 0 ; $k <= $#plugins ; $k++ ) {
755 if ( $plugins[$k] eq $files[$i] ) {
760 $unused_plugins[$pos] = $files[$i];
766 for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
768 $english_name = get_plugin_english_name
($unused_plugins[$i]);
769 if ( $english_name eq "" ) {
770 print " $num. $unused_plugins[$i]" . get_plugin_version
($unused_plugins[$i]) . "\n";
772 print " $num. $english_name ($unused_plugins[$i])" . get_plugin_version
($unused_plugins[$i]) . "\n";
778 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
779 print "E Enable active plugins (all plugins currently\n disabled for the user \"$disable_plugins_user\")\n";
780 } elsif (lc($disable_plugins) eq 'true') {
781 print "E Enable active plugins (all plugins currently\n disabled)\n";
783 print "D Disable all plugins\n";
785 print "U Set the user for whom plugins can be disabled\n";
786 print "R Return to Main Menu\n";
787 } elsif ( $menu == 9 ) {
788 print $WHT. "Database\n" . $NRM;
789 print "1. DSN for Address Book : $WHT$addrbook_dsn$NRM\n";
790 print "2. Table for Address Book : $WHT$addrbook_table$NRM\n";
792 print "3. DSN for Preferences : $WHT$prefs_dsn$NRM\n";
793 print "4. Table for Preferences : $WHT$prefs_table$NRM\n";
794 print "5. Field for username : $WHT$prefs_user_field$NRM ($prefs_user_size)\n";
795 print "6. Field for prefs key : $WHT$prefs_key_field$NRM ($prefs_key_size)\n";
796 print "7. Field for prefs value : $WHT$prefs_val_field$NRM ($prefs_val_size)\n";
798 print "8. DSN for Global Address Book : $WHT$addrbook_global_dsn$NRM\n";
799 print "9. Table for Global Address Book : $WHT$addrbook_global_table$NRM\n";
800 print "10. Allow writing into Global Address Book : $WHT$addrbook_global_writeable$NRM\n";
801 print "11. Allow listing of Global Address Book : $WHT$addrbook_global_listing$NRM\n";
803 print "R Return to Main Menu\n";
804 } elsif ( $menu == 10 ) {
805 print $WHT. "Language settings\n" . $NRM;
806 print "1. Default Language : $WHT$squirrelmail_default_language$NRM\n";
807 print "2. Default Charset : $WHT$default_charset$NRM\n";
808 print "3. Show alternative language names : $WHT$show_alternative_names$NRM\n";
809 print "4. Enable aggressive decoding : $WHT$aggressive_decoding$NRM\n";
810 print "5. Enable lossy encoding : $WHT$lossy_encoding$NRM\n";
812 print "R Return to Main Menu\n";
813 } elsif ( $menu == 11 ) {
814 print $WHT. "Interface tweaks\n" . $NRM;
815 print "1. Display html mails in iframe : $WHT$use_iframe$NRM\n";
816 print "2. Ask user info on first login : $WHT$ask_user_info$NRM\n";
818 print $WHT. "PHP tweaks\n" . $NRM;
819 print "4. Use php recode functions : $WHT$use_php_recode$NRM\n";
820 print "5. Use php iconv functions : $WHT$use_php_iconv$NRM\n";
822 print $WHT. "Configuration tweaks\n" . $NRM;
823 print "6. Allow remote configtest : $WHT$allow_remote_configtest$NRM\n";
824 print "7. Debug mode : $WHT$sm_debug_mode$NRM\n";
825 print "8. Secured configuration mode : $WHT$secured_config$NRM\n";
827 print "R Return to Main Menu\n";
829 if ( $config_use_color == 1 ) {
830 print "C Turn color off\n";
832 print "C Turn color on\n";
834 print "S Save data\n";
838 print "Command >> " . $WHT;
840 $command =~ s/[\n\r]//g;
841 $command =~ tr/A-Z/a-z/;
844 # Read the commands they entered.
845 if ( $command eq "r" ) {
847 } elsif ( $command eq "s" ) {
849 print "Press enter to continue...";
852 } elsif ( ( $command eq "q" ) && ( $saved == 0 ) ) {
853 print "You have not saved your data.\n";
854 print "Save? [" . $WHT . "Y" . $NRM . "/n]: ";
856 if ( ( $save =~ /^y/i ) || ( $save =~ /^\s*$/ ) ) {
859 } elsif ( $command eq "c" ) {
860 if ( $config_use_color == 1 ) {
861 $config_use_color = 2;
865 $config_use_color = 1;
869 } elsif ( $command eq "d" && $menu == 0 ) {
874 if ( ( $command > 0 ) && ( $command < 12 ) ) {
877 } elsif ( $menu == 1 ) {
878 if ( $command == 1 ) { $org_name = command1
(); }
879 elsif ( $command == 2 ) { $org_logo = command2
(); }
880 elsif ( $command == 3 ) { ($org_logo_width,$org_logo_height) = command2a
(); }
881 elsif ( $command == 4 ) { $org_title = command3
(); }
882 elsif ( $command == 5 ) { $signout_page = command4
(); }
883 elsif ( $command == 6 ) { $frame_top = command6
(); }
884 elsif ( $command == 7 ) { $provider_uri = command7
(); }
885 elsif ( $command == 8 ) { $provider_name = command8
(); }
887 } elsif ( $menu == 2 ) {
888 if ( $command eq "a" ) { $show_imap_settings = 1; $show_smtp_settings = 0; }
889 elsif ( $command eq "b" ) { $show_imap_settings = 0; $show_smtp_settings = 1; }
890 elsif ( $command eq "h" ) { $show_imap_settings = 0; $show_smtp_settings = 0; }
891 elsif ( $command <= 3 ) {
892 if ( $command == 1 ) { $domain = command11
(); }
893 elsif ( $command == 2 ) { $invert_time = command110
(); }
894 elsif ( $command == 3 ) { $useSendmail = command14
(); }
895 $show_imap_settings = 0; $show_smtp_settings = 0;
896 } elsif ( $show_imap_settings ) {
897 if ( $command == 4 ) { $imapServerAddress = command12
(); }
898 elsif ( $command == 5 ) { $imapPort = command13
(); }
899 elsif ( $command == 6 ) { $imap_auth_mech = command112a
(); }
900 elsif ( $command == 7 ) { $use_imap_tls = command_use_tls
("IMAP",$use_imap_tls); }
901 elsif ( $command == 8 ) { $imap_server_type = command19
(); }
902 elsif ( $command == 9 ) { $optional_delimiter = command111
(); }
903 } elsif ( $show_smtp_settings && lc($useSendmail) eq 'true' ) {
904 if ( $command == 4 ) { $sendmail_path = command15
(); }
905 elsif ( $command == 5 ) { $sendmail_args = command_sendmail_args
(); }
906 elsif ( $command == 6 ) { $encode_header_key = command114
(); }
907 } elsif ( $show_smtp_settings ) {
908 if ( $command == 4 ) { $smtpServerAddress = command16
(); }
909 elsif ( $command == 5 ) { $smtpPort = command17
(); }
910 elsif ( $command == 6 ) { $pop_before_smtp = command18a
(); }
911 elsif ( $command == 7 ) { $smtp_auth_mech = command112b
(); }
912 elsif ( $command == 8 ) { $use_smtp_tls = command_use_tls
("SMTP",$use_smtp_tls); }
913 elsif ( $command == 9 ) { $encode_header_key = command114
(); }
915 } elsif ( $menu == 3 ) {
916 if ( $command == 1 ) { $default_folder_prefix = command21
(); }
917 elsif ( $command == 2 ) { $show_prefix_option = command22
(); }
918 elsif ( $command == 3 ) { $trash_folder = command23a
(); }
919 elsif ( $command == 4 ) { $sent_folder = command23b
(); }
920 elsif ( $command == 5 ) { $draft_folder = command23c
(); }
921 elsif ( $command == 6 ) { $default_move_to_trash = command24a
(); }
922 elsif ( $command == 7 ) { $default_move_to_sent = command24b
(); }
923 elsif ( $command == 8 ) { $default_save_as_draft = command24c
(); }
924 elsif ( $command == 9 ) { $list_special_folders_first = command27
(); }
925 elsif ( $command == 10 ) { $use_special_folder_color = command28
(); }
926 elsif ( $command == 11 ) { $auto_expunge = command29
(); }
927 elsif ( $command == 12 ) { $default_sub_of_inbox = command210
(); }
928 elsif ( $command == 13 ) { $show_contain_subfolders_option = command211
(); }
929 elsif ( $command == 14 ) { $default_unseen_notify = command212
(); }
930 elsif ( $command == 15 ) { $default_unseen_type = command213
(); }
931 elsif ( $command == 16 ) { $auto_create_special = command214
(); }
932 elsif ( $command == 17 ) { $delete_folder = command215
(); }
933 elsif ( $command == 18 ) { $noselect_fix_enable = command216
(); }
934 } elsif ( $menu == 4 ) {
935 if ( $command == 1 ) { $data_dir = command33a
(); }
936 elsif ( $command == 2 ) { $attachment_dir = command33b
(); }
937 elsif ( $command == 3 ) { $dir_hash_level = command33c
(); }
938 elsif ( $command == 4 ) { $default_left_size = command35
(); }
939 elsif ( $command == 5 ) { $force_username_lowercase = command36
(); }
940 elsif ( $command == 6 ) { $default_use_priority = command37
(); }
941 elsif ( $command == 7 ) { $hide_sm_attributions = command38
(); }
942 elsif ( $command == 8 ) { $default_use_mdn = command39
(); }
943 elsif ( $command == 9 ) { $edit_identity = command310
(); }
944 elsif ( $command == 10 ) { $disable_thread_sort = command312
(); }
945 elsif ( $command == 11 ) { $disable_server_sort = command313
(); }
946 elsif ( $command == 12 ) { $allow_charset_search = command314
(); }
947 elsif ( $command == 13 ) { $allow_advanced_search = command316
(); }
948 elsif ( $command == 14 ) { $session_name = command317
(); }
949 elsif ( $command == 15 ) { $time_zone_type = command318
(); }
950 elsif ( $command == 16 ) { $config_location_base = command_config_location_base
(); }
951 elsif ( $command == 17 ) { $only_secure_cookies = command319
(); }
952 } elsif ( $menu == 5 ) {
953 if ( $command == 1 ) { $use_icons = commandB3
(); }
954 # elsif ( $command == 3 ) { $icon_theme_def = commandB7(); }
955 elsif ( $command == 2 ) { $default_fontsize = command_default_fontsize
(); }
956 elsif ( $command == 3 ) { $templateset_default = command_templates
(); }
957 elsif ( $command == 4 ) { command_userThemes
(); }
958 elsif ( $command == 5 ) { command_fontsets
(); }
959 elsif ( $command == 6 ) { command_iconSets
(); }
960 } elsif ( $menu == 6 ) {
961 if ( $command == 1 ) { command61
(); }
962 elsif ( $command == 2 ) { command62
(); }
963 elsif ( $command == 3 ) { $abook_global_file=command63
(); }
964 elsif ( $command == 4 ) { command64
(); }
965 elsif ( $command == 5 ) { command65
(); }
966 elsif ( $command == 6 ) { command_abook_file_line_length
(); }
967 } elsif ( $menu == 7 ) {
968 if ( $command == 1 ) { $motd = command71
(); }
969 } elsif ( $menu == 8 ) {
970 if ( $command =~ /^[0-9]+/ ) { @plugins = command81
(); }
971 elsif ( $command eq "u" ) { $disable_plugins_user = command82
(); }
972 elsif ( $command eq "d" ) { $disable_plugins = 'true'; }
973 elsif ( $command eq "e" ) { $disable_plugins = 'false'; }
974 } elsif ( $menu == 9 ) {
975 if ( $command == 1 ) { $addrbook_dsn = command91
(); }
976 elsif ( $command == 2 ) { $addrbook_table = command92
(); }
977 elsif ( $command == 3 ) { $prefs_dsn = command93
(); }
978 elsif ( $command == 4 ) { $prefs_table = command94
(); }
979 elsif ( $command == 5 ) { $prefs_user_field = command95
(); }
980 elsif ( $command == 6 ) { $prefs_key_field = command96
(); }
981 elsif ( $command == 7 ) { $prefs_val_field = command97
(); }
982 elsif ( $command == 8 ) { $addrbook_global_dsn = command98
(); }
983 elsif ( $command == 9 ) { $addrbook_global_table = command99
(); }
984 elsif ( $command == 10 ) { $addrbook_global_writeable = command910
(); }
985 elsif ( $command == 11 ) { $addrbook_global_listing = command911
(); }
986 } elsif ( $menu == 10 ) {
987 if ( $command == 1 ) { $squirrelmail_default_language = commandA1
(); }
988 elsif ( $command == 2 ) { $default_charset = commandA2
(); }
989 elsif ( $command == 3 ) { $show_alternative_names = commandA3
(); }
990 elsif ( $command == 4 ) { $aggressive_decoding = commandA4
(); }
991 elsif ( $command == 5 ) { $lossy_encoding = commandA5
(); }
992 } elsif ( $menu == 11 ) {
993 if ( $command == 1 ) { $use_iframe = commandB2
(); }
994 elsif ( $command == 2 ) { $ask_user_info = command_ask_user_info
(); }
995 elsif ( $command == 4 ) { $use_php_recode = commandB4
(); }
996 elsif ( $command == 5 ) { $use_php_iconv = commandB5
(); }
997 elsif ( $command == 6 ) { $allow_remote_configtest = commandB6
(); }
998 elsif ( $command == 7 ) { $sm_debug_mode = commandB8
(); }
999 elsif ( $command == 8 ) { $secured_config = commandB9
(); }
1005 print "\nExiting conf.pl.\n".
1006 "You might want to test your configuration by browsing to\n".
1007 "http://your-squirrelmail-location/src/configtest.php\n".
1008 "Happy SquirrelMailing!\n\n";
1011 ####################################################################################
1015 print "We have tried to make the name SquirrelMail as transparent as\n";
1016 print "possible. If you set up an organization name, most places where\n";
1017 print "SquirrelMail would take credit will be credited to your organization.\n";
1019 print "If your Organization Name includes a '\$', please precede it with a \\. \n";
1020 print "Other '\$' will be considered the beginning of a variable that\n";
1021 print "must be defined before the \$org_name is printed.\n";
1023 print "[$WHT$org_name$NRM]: $WHT";
1024 $new_org_name = <STDIN
>;
1025 if ( $new_org_name eq "\n" ) {
1026 $new_org_name = $org_name;
1028 $new_org_name =~ s/[\r\n]//g;
1029 $new_org_name =~ s/\"/"/g;
1031 return $new_org_name;
1036 print "Your organization's logo is an image that will be displayed at\n";
1037 print "different times throughout SquirrelMail. ";
1039 print "Please be aware of the following: \n";
1040 print " - Relative URLs are relative to the config dir\n";
1041 print " to use the default logo, use ../images/sm_logo.png\n";
1042 print " - To specify a logo defined outside the SquirrelMail source tree\n";
1043 print " use the absolute URL the webserver would use to include the file\n";
1044 print " e.g. http://example.com/images/mylogo.gif or /images/mylogo.jpg\n";
1046 print "[$WHT$org_logo$NRM]: $WHT";
1047 $new_org_logo = <STDIN
>;
1048 if ( $new_org_logo eq "\n" ) {
1049 $new_org_logo = $org_logo;
1051 $new_org_logo =~ s/[\r\n]//g;
1053 return $new_org_logo;
1058 print "Your organization's logo is an image that will be displayed at\n";
1059 print "different times throughout SquirrelMail. Width\n";
1060 print "and Height of your logo image. Use '0' to disable.\n";
1062 print "Width: [$WHT$org_logo_width$NRM]: $WHT";
1063 $new_org_logo_width = <STDIN
>;
1064 $new_org_logo_width =~ tr/0-9//cd; # only want digits!
1065 if ( $new_org_logo_width eq '' ) {
1066 $new_org_logo_width = $org_logo_width;
1068 if ( $new_org_logo_width > 0 ) {
1069 print "Height: [$WHT$org_logo_height$NRM]: $WHT";
1070 $new_org_logo_height = <STDIN
>;
1071 $new_org_logo_height =~ tr/0-9//cd; # only want digits!
1072 if( $new_org_logo_height eq '' ) {
1073 $new_org_logo_height = $org_logo_height;
1076 $new_org_logo_height = 0;
1078 return ($new_org_logo_width, $new_org_logo_height);
1083 print "A title is what is displayed at the top of the browser window in\n";
1084 print "the titlebar. Usually this will end up looking something like:\n";
1085 print "\"Netscape: $org_title\"\n";
1087 print "If your Organization Title includes a '\$', please precede it with a \\. \n";
1088 print "Other '\$' will be considered the beginning of a variable that\n";
1089 print "must be defined before the \$org_title is printed.\n";
1091 print "[$WHT$org_title$NRM]: $WHT";
1092 $new_org_title = <STDIN
>;
1093 if ( $new_org_title eq "\n" ) {
1094 $new_org_title = $org_title;
1096 $new_org_title =~ s/[\r\n]//g;
1097 $new_org_title =~ s/\"/\'/g;
1099 return $new_org_title;
1104 print "When users click the Sign Out button they will be logged out and\n";
1105 print "then sent to signout_page. If signout_page is left empty,\n";
1106 print "(hit space and then return) they will be taken, as normal,\n";
1107 print "to the default and rather sparse SquirrelMail signout page.\n";
1109 print "[$WHT$signout_page$NRM]: $WHT";
1110 $new_signout_page = <STDIN
>;
1111 if ( $new_signout_page eq "\n" ) {
1112 $new_signout_page = $signout_page;
1114 $new_signout_page =~ s/[\r\n]//g;
1115 $new_signout_page =~ s/^\s+$//g;
1117 return $new_signout_page;
1122 print "SquirrelMail defaults to using the whole of the browser window.\n";
1123 print "This allows you to keep it within a specified frame. The default\n";
1124 print "is '_top'\n";
1126 print "[$WHT$frame_top$NRM]: $WHT";
1127 $new_frame_top = <STDIN
>;
1128 if ( $new_frame_top eq "\n" ) {
1129 $new_frame_top = '_top';
1131 $new_frame_top =~ s/[\r\n]//g;
1132 $new_frame_top =~ s/^\s+$//g;
1134 return $new_frame_top;
1137 # Default link to provider
1139 print "Here you can set the link on the top-right of the message list.\n";
1140 print "If empty, it will not be displayed.\n";
1142 print "[$WHT$provider_uri$NRM]: $WHT";
1143 $new_provider_uri = <STDIN
>;
1144 if ( $new_provider_uri eq "\n" ) {
1145 $new_provider_uri = '';
1147 $new_provider_uri =~ s/[\r\n]//g;
1148 $new_provider_uri =~ s/^\s+$//g;
1150 return $new_provider_uri;
1154 print "Here you can set the name of the link on the top-right of the message list.\n";
1155 print "The default is empty (do not display anything).'\n";
1157 print "[$WHT$provider_name$NRM]: $WHT";
1158 $new_provider_name = <STDIN
>;
1159 if ( $new_provider_name eq "\n" ) {
1160 $new_provider_name = '';
1162 $new_provider_name =~ s/[\r\n]//g;
1163 $new_provider_name =~ s/^\s+$//g;
1164 $new_provider_name =~ s/\'/\\'/g;
1166 return $new_provider_name;
1169 ####################################################################################
1173 print "The domain name is the suffix at the end of all email addresses. If\n";
1174 print "for example, your email address is jdoe\@example.com, then your domain\n";
1175 print "would be example.com.\n";
1177 print "[$WHT$domain$NRM]: $WHT";
1178 $new_domain = <STDIN
>;
1179 if ( $new_domain eq "\n" ) {
1180 $new_domain = $domain;
1182 $new_domain =~ s/\s//g;
1189 print "This is the hostname where your IMAP server can be contacted.\n";
1190 print "[$WHT$imapServerAddress$NRM]: $WHT";
1191 $new_imapServerAddress = <STDIN
>;
1192 if ( $new_imapServerAddress eq "\n" ) {
1193 $new_imapServerAddress = $imapServerAddress;
1195 $new_imapServerAddress =~ s/[\r\n]//g;
1197 return $new_imapServerAddress;
1202 print "This is the port that your IMAP server is on. Usually this is 143.\n";
1203 print "[$WHT$imapPort$NRM]: $WHT";
1204 $new_imapPort = <STDIN
>;
1205 if ( $new_imapPort eq "\n" ) {
1206 $new_imapPort = $imapPort;
1208 $new_imapPort =~ s/[\r\n]//g;
1210 return $new_imapPort;
1215 print "You now need to choose the method that you will use for sending\n";
1216 print "messages in SquirrelMail. You can either connect to an SMTP server\n";
1217 print "or use sendmail directly.\n";
1218 if ( lc($useSendmail) eq 'true' ) {
1219 $default_value = "1";
1221 $default_value = "2";
1224 print " 1. Sendmail\n";
1226 print "Your choice [1/2] [$WHT$default_value$NRM]: $WHT";
1227 $use_sendmail = <STDIN
>;
1228 if ( ( $use_sendmail =~ /^1\n/i )
1229 || ( ( $use_sendmail =~ /^\n/ ) && ( $default_value eq "1" ) ) ) {
1230 $useSendmail = 'true';
1232 $useSendmail = 'false';
1234 return $useSendmail;
1239 print "Specify where the sendmail executable is located. Usually /usr/sbin/sendmail\n";
1240 print "[$WHT$sendmail_path$NRM]: $WHT";
1241 $new_sendmail_path = <STDIN
>;
1242 if ( $new_sendmail_path eq "\n" ) {
1243 $new_sendmail_path = $sendmail_path;
1245 $new_sendmail_path =~ s/[\r\n]//g;
1247 return $new_sendmail_path;
1250 # Extra sendmail arguments
1251 sub command_sendmail_args
{
1252 print "Specify additional sendmail program arguments.\n";
1254 print "Make sure that arguments are supported by your sendmail program. -f argument \n";
1255 print "is added automatically by SquirrelMail scripts. Variable defaults to standard\n";
1256 print "/usr/sbin/sendmail arguments. If you use qmail-inject, nbsmtp or any other \n";
1257 print "sendmail wrapper, which does not support -i and -t arguments, set variable to\n";
1258 print "empty string or use arguments suitable for your mailer.\n";
1260 print "[$WHT$sendmail_args$NRM]: $WHT";
1261 $new_sendmail_args = <STDIN
>;
1262 if ( $new_sendmail_args eq "\n" ) {
1263 $new_sendmail_args = $sendmail_args;
1265 # strip linefeeds and crs.
1266 $new_sendmail_args =~ s/[\r\n]//g;
1268 return trim
($new_sendmail_args);
1273 print "This is the hostname of your SMTP server.\n";
1274 print "[$WHT$smtpServerAddress$NRM]: $WHT";
1275 $new_smtpServerAddress = <STDIN
>;
1276 if ( $new_smtpServerAddress eq "\n" ) {
1277 $new_smtpServerAddress = $smtpServerAddress;
1279 $new_smtpServerAddress =~ s/[\r\n]//g;
1281 return $new_smtpServerAddress;
1286 print "This is the port to connect to for SMTP. Usually 25.\n";
1287 print "[$WHT$smtpPort$NRM]: $WHT";
1288 $new_smtpPort = <STDIN
>;
1289 if ( $new_smtpPort eq "\n" ) {
1290 $new_smtpPort = $smtpPort;
1292 $new_smtpPort =~ s/[\r\n]//g;
1294 return $new_smtpPort;
1299 print "Do you wish to use POP3 before SMTP? Your server must\n";
1300 print "support this in order for SquirrelMail to work with it.\n";
1303 $YesNo = 'y' if ( lc($pop_before_smtp) eq 'true' );
1305 print "Use pop before SMTP (y/n) [$WHT$YesNo$NRM]: $WHT";
1307 $new_pop_before_smtp = <STDIN
>;
1308 $new_pop_before_smtp =~ tr/yn//cd;
1309 return 'true' if ( $new_pop_before_smtp eq "y" );
1310 return 'false' if ( $new_pop_before_smtp eq "n" );
1311 return $pop_before_smtp;
1316 print "Each IMAP server has its own quirks. As much as we tried to stick\n";
1317 print "to standards, it doesn't help much if the IMAP server doesn't follow\n";
1318 print "the same principles. We have made some work-arounds for some of\n";
1319 print "these servers. If you would like to use them, please select your\n";
1320 print "IMAP server. If you do not wish to use these work-arounds, you can\n";
1321 print "set this to \"other\", and none will be used.\n";
1322 print $list_supported_imap_servers;
1324 print " other = Not one of the above servers\n";
1326 print "[$WHT$imap_server_type$NRM]: $WHT";
1327 $new_imap_server_type = <STDIN
>;
1329 if ( $new_imap_server_type eq "\n" ) {
1330 $new_imap_server_type = $imap_server_type;
1332 $new_imap_server_type =~ s/[\r\n]//g;
1334 return $new_imap_server_type;
1339 print "Sometimes the date of messages sent is messed up (off by a few hours\n";
1340 print "on some machines). Typically this happens if the system doesn't support\n";
1341 print "tm_gmtoff. It will happen only if your time zone is \"negative\".\n";
1342 print "This most often occurs on Solaris 7 machines in the United States.\n";
1343 print "By default, this is off. It should be kept off unless problems surface\n";
1344 print "about the time that messages are sent.\n";
1345 print " no = Do NOT fix time -- almost always correct\n";
1346 print " yes = Fix the time for this system\n";
1349 $YesNo = 'y' if ( lc($invert_time) eq 'true' );
1351 print "Fix the time for this system (y/n) [$WHT$YesNo$NRM]: $WHT";
1353 $new_invert_time = <STDIN
>;
1354 $new_invert_time =~ tr/yn//cd;
1355 return 'true' if ( $new_invert_time eq "y" );
1356 return 'false' if ( $new_invert_time eq "n" );
1357 return $invert_time;
1361 print "This is the delimiter that your IMAP server uses to distinguish between\n";
1362 print "folders. For example, Cyrus uses '.' as the delimiter and a complete\n";
1363 print "folder would look like 'INBOX.Friends.Bob', while UW uses '/' and would\n";
1364 print "look like 'INBOX/Friends/Bob'. Normally this should be left at 'detect'\n";
1365 print "but if you are sure you know what delimiter your server uses, you can\n";
1366 print "specify it here.\n";
1367 print "\nTo have it autodetect the delimiter, set it to 'detect'.\n\n";
1368 print "[$WHT$optional_delimiter$NRM]: $WHT";
1369 $new_optional_delimiter = <STDIN
>;
1371 if ( $new_optional_delimiter eq "\n" ) {
1372 $new_optional_delimiter = $optional_delimiter;
1374 $new_optional_delimiter =~ s/[\r\n]//g;
1376 return $new_optional_delimiter;
1378 # IMAP authentication type
1379 # Possible values: login, plain, cram-md5, digest-md5
1380 # Now offers to detect supported mechs, assuming server & port are set correctly
1383 if ($use_imap_tls ne "0") {
1384 # 1. Script does not handle TLS.
1385 # 2. Server does not have to declare all supported authentication mechs when
1386 # STARTTLS is used. Supported mechs are declared only after STARTTLS.
1387 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1389 print "If you have already set the hostname and port number, I can try to\n";
1390 print "detect the mechanisms your IMAP server supports.\n";
1391 print "I will try to detect CRAM-MD5 and DIGEST-MD5 support. I can't test\n";
1392 print "for \"login\" or \"plain\" without knowing a username and password.\n";
1393 print "Auto-detecting is optional - you can safely say \"n\" here.\n";
1394 print "\nTry to detect supported mechanisms? [y/N]: ";
1397 if ($inval =~ /^y\b/i) {
1398 # Yes, let's try to detect.
1399 print "Trying to detect IMAP capabilities...\n";
1400 my $host = $imapServerAddress . ':'. $imapPort;
1401 print "CRAM-MD5:\t";
1402 my $tmp = detect_auth_support
('IMAP',$host,'CRAM-MD5');
1403 if (defined($tmp)) {
1404 if ($tmp eq 'YES') {
1405 print "$WHT SUPPORTED$NRM\n";
1407 print "$WHT NOT SUPPORTED$NRM\n";
1410 print $WHT . " ERROR DETECTING$NRM\n";
1413 print "DIGEST-MD5:\t";
1414 $tmp = detect_auth_support
('IMAP',$host,'DIGEST-MD5');
1415 if (defined($tmp)) {
1416 if ($tmp eq 'YES') {
1417 print "$WHT SUPPORTED$NRM\n";
1419 print "$WHT NOT SUPPORTED$NRM\n";
1422 print $WHT . " ERROR DETECTING$NRM\n";
1427 print "\nWhat authentication mechanism do you want to use for IMAP connections?\n\n";
1428 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1429 print $WHT . "plain" . $NRM . " - SASL PLAIN. If you need this, you already know it.\n";
1430 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext methods.\n";
1431 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1432 print "\n*** YOUR IMAP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n";
1433 print "If you don't understand or are unsure, you probably want \"login\"\n\n";
1434 print "login, plain, cram-md5, or digest-md5 [$WHT$imap_auth_mech$NRM]: $WHT";
1437 if ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) || ($inval =~ /^login\b/i) || ($inval =~ /^plain\b/i)) {
1440 # user entered garbage or default value so nothing needs to be set
1441 return $imap_auth_mech;
1446 # SMTP authentication type
1447 # Possible choices: none, plain, cram-md5, digest-md5
1449 if ($use_smtp_tls ne "0") {
1450 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1451 } elsif (eval ("use IO::Socket; 1")) {
1452 # try loading IO::Socket module
1453 print "If you have already set the hostname and port number, I can try to\n";
1454 print "automatically detect some of the mechanisms your SMTP server supports.\n";
1455 print "Auto-detection is *optional* - you can safely say \"n\" here.\n";
1456 print "\nTry to detect auth mechanisms? [y/N]: ";
1459 if ($inval =~ /^y\b/i) {
1460 # Yes, let's try to detect.
1461 print "Trying to detect supported methods (SMTP)...\n";
1464 # Check none by trying to relay to junk@microsoft.com
1465 $host = $smtpServerAddress . ':' . $smtpPort;
1466 my $sock = IO
::Socket
::INET
->new($host);
1467 print "Testing none:\t\t$WHT";
1468 if (!defined($sock)) {
1469 print " ERROR TESTING\n";
1472 $got = <$sock>; # Discard greeting
1473 print $sock "HELO $domain\r\n";
1474 $got = <$sock>; # Discard
1475 print $sock "MAIL FROM:<tester\@squirrelmail.org>\r\n";
1476 $got = <$sock>; # Discard
1477 print $sock "RCPT TO:<junk\@microsoft.com\r\n";
1478 $got = <$sock>; # This is the important line
1479 if ($got =~ /^250\b/) { # SMTP will relay without auth
1480 print "SUPPORTED$NRM\n";
1482 print "NOT SUPPORTED$NRM\n";
1484 print $sock "RSET\r\n";
1485 print $sock "QUIT\r\n";
1488 # Try login (SquirrelMail default)
1489 print "Testing login:\t\t";
1490 $tmp=detect_auth_support
('SMTP',$host,'LOGIN');
1491 if (defined($tmp)) {
1492 if ($tmp eq 'YES') {
1493 print $WHT . "SUPPORTED$NRM\n";
1495 print $WHT . "NOT SUPPORTED$NRM\n";
1498 print $WHT . "ERROR DETECTING$NRM\n";
1502 print "Testing CRAM-MD5:\t";
1503 $tmp=detect_auth_support
('SMTP',$host,'CRAM-MD5');
1504 if (defined($tmp)) {
1505 if ($tmp eq 'YES') {
1506 print $WHT . "SUPPORTED$NRM\n";
1508 print $WHT . "NOT SUPPORTED$NRM\n";
1511 print $WHT . "ERROR DETECTING$NRM\n";
1515 print "Testing DIGEST-MD5:\t";
1516 $tmp=detect_auth_support
('SMTP',$host,'DIGEST-MD5');
1517 if (defined($tmp)) {
1518 if ($tmp eq 'YES') {
1519 print $WHT . "SUPPORTED$NRM\n";
1521 print $WHT . "NOT SUPPORTED$NRM\n";
1524 print $WHT . "ERROR DETECTING$NRM\n";
1528 print "\nWhat authentication mechanism do you want to use for SMTP connections?\n";
1529 print $WHT . "none" . $NRM . " - Your SMTP server does not require authorization.\n";
1530 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1531 print $WHT . "plain" . $NRM . " - SASL PLAIN. You already know it if you need this.\n";
1532 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext.\n";
1533 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1534 print $WHT . "\n*** YOUR SMTP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n" . $NRM;
1535 print "If you don't understand or are unsure, you probably want \"none\"\n\n";
1536 print "none, login, cram-md5, or digest-md5 [$WHT$smtp_auth_mech$NRM]: $WHT";
1539 if ($inval =~ /^none\b/i) {
1540 # remove sitewide smtp authentication information
1541 $smtp_sitewide_user = '';
1542 $smtp_sitewide_pass = '';
1543 # SMTP doesn't necessarily require logins
1545 } elsif ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) ||
1546 ($inval =~ /^login\b/i) || ($inval =~/^plain\b/i)) {
1547 command_smtp_sitewide_userpass
($inval);
1549 } elsif (trim
($inval) eq '') {
1550 # user selected default value
1551 command_smtp_sitewide_userpass
($smtp_auth_mech);
1552 return $smtp_auth_mech;
1554 # user entered garbage
1555 return $smtp_auth_mech;
1559 sub command_smtp_sitewide_userpass
($) {
1560 # get first function argument
1561 my $auth_mech = shift(@_);
1563 $auth_mech = lc(trim
($auth_mech));
1564 if ($auth_mech eq 'none') {
1567 print "SMTP authentication uses IMAP username and password by default.\n";
1569 print "Would you like to use other login and password for all SquirrelMail \n";
1570 print "SMTP connections?";
1571 if ($smtp_sitewide_user ne '') {
1588 $smtp_sitewide_user = '';
1589 $smtp_sitewide_pass = '';
1590 } elsif ($tmp eq 'y') {
1591 print "Enter username [$smtp_sitewide_user]:";
1592 my $new_user = <STDIN
>;
1593 $new_user = trim
($new_user);
1594 if ($new_user ne '') {
1595 $smtp_sitewide_user = $new_user;
1597 if ($smtp_sitewide_user ne '') {
1598 print "If you don't enter any password, current sitewide password will be used.\n";
1599 print "If you enter space, password will be set to empty string.\n";
1600 print "Enter password:";
1601 my $new_pass = <STDIN
>;
1602 if ($new_pass ne "\n") {
1603 $smtp_sitewide_pass = trim
($new_pass);
1606 print "Invalid input. You must set username used for SMTP authentication.\n";
1607 print "Click enter to continue\n";
1611 print "Invalid input\n";
1612 print "Click enter to continue\n";
1617 # Sub adds information about SMTP authentication type to menu
1618 sub display_smtp_sitewide_userpass
() {
1620 if ($smtp_auth_mech ne 'none') {
1621 if ($smtp_sitewide_user ne '') {
1622 $ret = ' (with custom username and password)';
1624 $ret = ' (with IMAP username and password)';
1631 # This sub is reused for IMAP and SMTP
1632 # Args: service name, default value
1633 sub command_use_tls
{
1634 my($default_val,$service,$inval);
1637 print "TLS (Transport Layer Security) encrypts the traffic between server and client.\n";
1638 print "STARTTLS extensions allow to start encryption on existing plain text connection.\n";
1639 print "These options add specific PHP and IMAP server configuration requirements.\n";
1640 print "See SquirrelMail documentation about connection security.\n";
1642 print "If your " . $service . " server is localhost, you can safely disable this.\n";
1643 print "If it is remote, you may wish to seriously consider enabling this.\n";
1645 while ($valid_input eq 0) {
1646 print "\nSelect connection security model:\n";
1647 print " 0 - Use plain text connection\n";
1648 print " 1 - Use TLS connection\n";
1649 print " 2 - Use STARTTLS extension\n";
1650 print "Select [$default_val]: ";
1652 $inval=trim
($inval);
1653 if ($inval =~ /^[012]$/ || $inval eq '') {
1657 if ($inval ne '') {$default_val = $inval};
1658 return $default_val;
1661 # This sub is used to display human readable text for
1662 # $use_imap_tls and $use_smtp_tls values in conf.pl menu
1663 sub display_use_tls
($) {
1664 my $val = shift(@_);
1665 my $ret = 'disabled';
1668 } elsif ($val eq '1') {
1674 # $encode_header_key
1676 print "Encryption key allows to hide SquirrelMail Received: headers\n";
1677 print "in outbound messages. Interface uses encryption key to encode\n";
1678 print "username, remote address and proxied address, then stores encoded\n";
1679 print "information in X-Squirrel-* headers.\n";
1681 print "Warning: used encryption function is not bulletproof. When used\n";
1682 print "with static encryption keys, it provides only minimal security\n";
1683 print "measures and information can be decoded quickly.\n";
1685 print "Encoded information can be decoded with decrypt_headers.php script\n";
1686 print "from SquirrelMail contrib/ directory.\n";
1688 print "Enter encryption key: ";
1689 $new_encode_header_key = <STDIN
>;
1690 if ( $new_encode_header_key eq "\n" ) {
1691 $new_encode_header_key = $encode_header_key;
1693 $new_encode_header_key =~ s/[\r\n]//g;
1695 return $new_encode_header_key;
1700 print "\nYou can now create the welcome message that is displayed\n";
1701 print "every time a user logs on. You can use HTML or just plain\n";
1703 "text. If you do not wish to have one, just make it blank.\n\n(Type @ on a blank line to exit)\n";
1709 $line =~ s/[\r\n]//g;
1710 if ( $line ne "@" ) {
1711 $line =~ s/ /\ \ /g;
1712 $line =~ s/\t/\ \ \ \ /g;
1714 $line =~ s/\"/\\\"/g;
1716 $new_motd = $new_motd . $line;
1718 } while ( $line ne "@" );
1722 ################# PLUGINS ###################
1725 $command =~ s/[\s\n\r]*//g;
1726 if ( $command > 0 ) {
1727 $command = $command - 1;
1728 if ( $command <= $#plugins ) {
1731 while ( $ct <= $#plugins ) {
1732 if ( $ct != $command ) {
1733 @newplugins = ( @newplugins, $plugins[$ct] );
1737 @plugins = @newplugins;
1738 } elsif ( $command <= $#plugins + $#unused_plugins + 1 ) {
1739 $num = $command - $#plugins - 1;
1740 @newplugins = @plugins;
1742 while ( $ct <= $#unused_plugins ) {
1743 if ( $ct == $num ) {
1744 @newplugins = ( @newplugins, $unused_plugins[$ct] );
1748 @plugins = @newplugins;
1754 # disable_plugins_user
1756 print "When all active plugins are disabled, they can be disabled only\n";
1757 print "for the one user named here. If left blank, plugins will be\n";
1758 print "disabled for ALL users. This setting has no effect if plugins\n";
1759 print "are not disabled.\n";
1761 print "This must be the exact IMAP login name for the desired user.\n";
1763 print "[$WHT$disable_plugins_user$NRM]: $WHT";
1764 $new_disable_plugins_user = <STDIN
>;
1765 if ( $new_disable_plugins_user eq "\n" ) {
1766 $new_disable_plugins_user = $disable_plugins_user;
1768 $new_disable_plugins_user =~ s/[\r\n]//g;
1770 return $new_disable_plugins_user;
1773 ################# FOLDERS ###################
1775 # default_folder_prefix
1777 print "Some IMAP servers (UW, for example) store mail and folders in\n";
1778 print "your user space in a separate subdirectory. This is where you\n";
1779 print "specify what that directory is.\n";
1781 print "EXAMPLE: mail/";
1783 print "NOTE: If you use Cyrus, or some server that would not use this\n";
1784 print " option, you must set this to 'none'.\n";
1786 print "[$WHT$default_folder_prefix$NRM]: $WHT";
1787 $new_default_folder_prefix = <STDIN
>;
1789 if ( $new_default_folder_prefix eq "\n" ) {
1790 $new_default_folder_prefix = $default_folder_prefix;
1792 $new_default_folder_prefix =~ s/[\r\n]//g;
1794 if ( ( $new_default_folder_prefix =~ /^\s*$/ ) || ( $new_default_folder_prefix =~ m/^none$/i ) ) {
1795 $new_default_folder_prefix = "";
1797 # add the trailing delimiter only if we know what the server is.
1798 if (($imap_server_type eq 'cyrus' and
1799 $optional_delimiter eq 'detect') or
1800 ($imap_server_type eq 'courier' and
1801 $optional_delimiter eq 'detect')) {
1802 $new_default_folder_prefix =~ s/\.*$/\./;
1803 } elsif ($imap_server_type eq 'uw' and
1804 $optional_delimiter eq 'detect') {
1805 $new_default_folder_prefix =~ s/\/*$/\
//;
1808 return $new_default_folder_prefix;
1811 # Show Folder Prefix
1813 print "It is possible to set up the default folder prefix as a user\n";
1814 print "specific option, where each user can specify what their mail\n";
1815 print "folder is. If you set this to false, they will never see the\n";
1816 print "option, but if it is true, this option will appear in the\n";
1817 print "'options' section.\n";
1819 print "NOTE: You set the default folder prefix in option '1' of this\n";
1820 print " section. That will be the default if the user doesn't\n";
1821 print " specify anything different.\n";
1824 if ( lc($show_prefix_option) eq 'true' ) {
1825 $default_value = "y";
1827 $default_value = "n";
1830 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
1831 $new_show = <STDIN
>;
1832 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1833 $show_prefix_option = 'true';
1835 $show_prefix_option = 'false';
1837 return $show_prefix_option;
1842 print "You can now specify where the default trash folder is located.\n";
1843 print "On servers where you do not want this, you can set it to anything\n";
1844 print "and set option 6 to false.\n";
1846 print "This is relative to where the rest of your email is kept. You do\n";
1847 print "not need to worry about their mail directory. If this folder\n";
1848 print "would be ~/mail/trash on the filesystem, you only need to specify\n";
1849 print "that this is 'trash', and be sure to put 'mail/' in option 1.\n";
1852 print "[$WHT$trash_folder$NRM]: $WHT";
1853 $new_trash_folder = <STDIN
>;
1854 if ( $new_trash_folder eq "\n" ) {
1855 $new_trash_folder = $trash_folder;
1857 if (check_imap_folder
($new_trash_folder)) {
1858 $new_trash_folder =~ s/[\r\n]//g;
1860 $new_trash_folder = $trash_folder;
1863 return $new_trash_folder;
1868 print "This is where messages that are sent will be stored. SquirrelMail\n";
1869 print "by default puts a copy of all outgoing messages in this folder.\n";
1871 print "This is relative to where the rest of your email is kept. You do\n";
1872 print "not need to worry about their mail directory. If this folder\n";
1873 print "would be ~/mail/sent on the filesystem, you only need to specify\n";
1874 print "that this is 'sent', and be sure to put 'mail/' in option 1.\n";
1877 print "[$WHT$sent_folder$NRM]: $WHT";
1878 $new_sent_folder = <STDIN
>;
1879 if ( $new_sent_folder eq "\n" ) {
1880 $new_sent_folder = $sent_folder;
1882 if (check_imap_folder
($new_sent_folder)) {
1883 $new_sent_folder =~ s/[\r\n]//g;
1885 $new_sent_folder = $sent_folder;
1888 return $new_sent_folder;
1893 print "You can now specify where the default draft folder is located.\n";
1894 print "On servers where you do not want this, you can set it to anything\n";
1895 print "and set option 9 to false.\n";
1897 print "This is relative to where the rest of your email is kept. You do\n";
1898 print "not need to worry about their mail directory. If this folder\n";
1899 print "would be ~/mail/drafts on the filesystem, you only need to specify\n";
1900 print "that this is 'drafts', and be sure to put 'mail/' in option 1.\n";
1903 print "[$WHT$draft_folder$NRM]: $WHT";
1904 $new_draft_folder = <STDIN
>;
1905 if ( $new_draft_folder eq "\n" ) {
1906 $new_draft_folder = $draft_folder;
1908 if (check_imap_folder
($new_draft_folder)) {
1909 $new_draft_folder =~ s/[\r\n]//g;
1911 $new_draft_folder = $draft_folder;
1914 return $new_draft_folder;
1917 # default move to trash
1919 print "By default, should messages get moved to the trash folder? You\n";
1920 print "can specify the default trash folder in option 3. If this is set\n";
1921 print "to false, messages will get deleted immediately without moving\n";
1922 print "to the trash folder.\n";
1924 print "Trash folder is currently: $trash_folder\n";
1927 if ( lc($default_move_to_trash) eq 'true' ) {
1928 $default_value = "y";
1930 $default_value = "n";
1932 print "By default, move to trash (y/n) [$WHT$default_value$NRM]: $WHT";
1933 $new_show = <STDIN
>;
1934 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1935 $default_move_to_trash = 'true';
1937 $default_move_to_trash = 'false';
1939 return $default_move_to_trash;
1942 # default move to sent
1944 print "By default, should messages get moved to the sent folder? You\n";
1945 print "can specify the default sent folder in option 4. If this is set\n";
1946 print "to false, messages will get sent and no copy will be made.\n";
1948 print "Sent folder is currently: $sent_folder\n";
1951 if ( lc($default_move_to_sent) eq 'true' ) {
1952 $default_value = "y";
1954 $default_value = "n";
1956 print "By default, move to sent (y/n) [$WHT$default_value$NRM]: $WHT";
1957 $new_show = <STDIN
>;
1958 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1959 $default_move_to_sent = 'true';
1961 $default_move_to_sent = 'false';
1963 return $default_move_to_sent;
1966 # default save as draft
1968 print "By default, should the save to draft option be shown? You can\n";
1969 print "specify the default drafts folder in option 5. If this is set\n";
1970 print "to false, users will not be shown the save to draft option.\n";
1972 print "Drafts folder is currently: $draft_folder\n";
1975 if ( lc($default_move_to_draft) eq 'true' ) {
1976 $default_value = "y";
1978 $default_value = "n";
1980 print "By default, save as draft (y/n) [$WHT$default_value$NRM]: $WHT";
1981 $new_show = <STDIN
>;
1982 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1983 $default_save_as_draft = 'true';
1985 $default_save_as_draft = 'false';
1987 return $default_save_as_draft;
1990 # List special folders first
1992 print "SquirrelMail has what we call 'special folders' that are not\n";
1993 print "manipulated and viewed like normal folders. Some examples of\n";
1994 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
1995 print "Simply asks if you want these folders listed first in the folder\n";
1999 if ( lc($list_special_folders_first) eq 'true' ) {
2000 $default_value = "y";
2002 $default_value = "n";
2005 print "List first (y/n) [$WHT$default_value$NRM]: $WHT";
2006 $new_show = <STDIN
>;
2007 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2008 $list_special_folders_first = 'true';
2010 $list_special_folders_first = 'false';
2012 return $list_special_folders_first;
2015 # Show special folders color
2017 print "SquirrelMail has what we call 'special folders' that are not\n";
2018 print "manipulated and viewed like normal folders. Some examples of\n";
2019 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
2020 print "wants to know if we should display special folders in a\n";
2021 print "color than the other folders.\n";
2024 if ( lc($use_special_folder_color) eq 'true' ) {
2025 $default_value = "y";
2027 $default_value = "n";
2030 print "Show color (y/n) [$WHT$default_value$NRM]: $WHT";
2031 $new_show = <STDIN
>;
2032 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2033 $use_special_folder_color = 'true';
2035 $use_special_folder_color = 'false';
2037 return $use_special_folder_color;
2042 print "The way that IMAP handles deleting messages is as follows. You\n";
2043 print "mark the message as deleted, and then to 'really' delete it, you\n";
2044 print "expunge it. This option asks if you want to just have messages\n";
2045 print "marked as deleted, or if you want SquirrelMail to expunge the \n";
2046 print "messages too.\n";
2049 if ( lc($auto_expunge) eq 'true' ) {
2050 $default_value = "y";
2052 $default_value = "n";
2054 print "Auto expunge (y/n) [$WHT$default_value$NRM]: $WHT";
2055 $new_show = <STDIN
>;
2056 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2057 $auto_expunge = 'true';
2059 $auto_expunge = 'false';
2061 return $auto_expunge;
2064 # Default sub of inbox
2066 print "Some IMAP servers (Cyrus) have all folders as subfolders of INBOX.\n";
2067 print "This can cause some confusion in folder creation for users when\n";
2068 print "they try to create folders and don't put it as a subfolder of INBOX\n";
2069 print "and get permission errors. This option asks if you want folders\n";
2070 print "to be subfolders of INBOX by default.\n";
2073 if ( lc($default_sub_of_inbox) eq 'true' ) {
2074 $default_value = "y";
2076 $default_value = "n";
2078 print "Default sub of INBOX (y/n) [$WHT$default_value$NRM]: $WHT";
2079 $new_show = <STDIN
>;
2080 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2081 $default_sub_of_inbox = 'true';
2083 $default_sub_of_inbox = 'false';
2085 return $default_sub_of_inbox;
2088 # Show contain subfolder option
2090 print "Some IMAP servers (UW) make it so that there are two types of\n";
2091 print "folders. Those that contain messages, and those that contain\n";
2092 print "subfolders. If this is the case for your server, set this to\n";
2093 print "true, and it will ask the user whether the folder they are\n";
2094 print "creating contains subfolders or messages.\n";
2097 if ( lc($show_contain_subfolders_option) eq 'true' ) {
2098 $default_value = "y";
2100 $default_value = "n";
2102 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
2103 $new_show = <STDIN
>;
2104 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2105 $show_contain_subfolders_option = 'true';
2107 $show_contain_subfolders_option = 'false';
2109 return $show_contain_subfolders_option;
2112 # Default Unseen Notify
2114 print "This option specifies where the users will receive notification\n";
2115 print "about unseen messages by default. This is of course an option that\n";
2116 print "can be changed on a user level.\n";
2117 print " 1 = No notification\n";
2118 print " 2 = Only on the INBOX\n";
2119 print " 3 = On all folders\n";
2122 print "Which one should be default (1,2,3)? [$WHT$default_unseen_notify$NRM]: $WHT";
2123 $new_show = <STDIN
>;
2124 if ( $new_show =~ /^[123]\n/i ) {
2125 $default_unseen_notify = $new_show;
2127 $default_unseen_notify =~ s/[\r\n]//g;
2128 return $default_unseen_notify;
2131 # Default Unseen Type
2133 print "Here you can define the default way that unseen messages will be displayed\n";
2134 print "to the user in the folder listing on the left side.\n";
2135 print " 1 = Only unseen messages (4)\n";
2136 print " 2 = Unseen and Total messages (4/27)\n";
2139 print "Which one should be default (1,2)? [$WHT$default_unseen_type$NRM]: $WHT";
2140 $new_show = <STDIN
>;
2141 if ( $new_show =~ /^[12]\n/i ) {
2142 $default_unseen_type = $new_show;
2144 $default_unseen_type =~ s/[\r\n]//g;
2145 return $default_unseen_type;
2148 # Auto create special folders
2150 print "Would you like the Sent, Trash, and Drafts folders to be created\n";
2151 print "automatically print for you when a user logs in? If the user\n";
2152 print "accidentally deletes their special folders, this option will\n";
2153 print "automatically create it again for them.\n";
2156 if ( lc($auto_create_special) eq 'true' ) {
2157 $default_value = "y";
2159 $default_value = "n";
2161 print "Auto create special folders? (y/n) [$WHT$default_value$NRM]: $WHT";
2162 $new_show = <STDIN
>;
2163 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2164 $auto_create_special = 'true';
2166 $auto_create_special = 'false';
2168 return $auto_create_special;
2171 # Automatically delete folders
2173 if ( $imap_server_type eq "uw" ) {
2174 print "UW IMAP servers will not allow folders containing mail to also contain folders.\n";
2175 print "Deleting folders will bypass the trash folder and be immediately deleted\n\n";
2176 print "If this is not the correct value for your server,\n";
2177 print "please use option D on the Main Menu to configure your server correctly.\n\n";
2178 print "Press enter to continue...\n";
2179 $new_delete = <STDIN
>;
2180 $delete_folder = 'true';
2182 if ( $imap_server_type eq "courier" ) {
2183 print "Courier (or Courier-IMAP) IMAP servers may not support ";
2184 print "subfolders of Trash. \n";
2185 print "Specifically, if Courier is set to always move messages to Trash, \n";
2186 print "Trash will be treated by Courier as a special folder that does not \n";
2187 print "allow subfolders. \n\n";
2188 print "Please verify your Courier configuration, and test folder deletion \n";
2189 print "when changing this setting.\n\n";
2192 print "Are subfolders of the Trash supported by your IMAP server?\n";
2193 print "If so, should deleted folders be sent to Trash?\n";
2194 print "If not, say no (deleted folders should not be sent to Trash)\n\n";
2195 # reversal of logic.
2196 # question was: Should folders be automatically deleted instead of sent to trash..
2197 # we've changed the question to make it more clear,
2198 # and are here handling that to avoid changing the answers..
2199 if ( lc($delete_folder) eq 'true' ) {
2200 $default_value = "n";
2202 $default_value = "y";
2204 print "Send deleted folders to Trash? (y/n) [$WHT$default_value$NRM]: $WHT";
2205 $new_delete = <STDIN
>;
2206 if ( ( $new_delete =~ /^y\n/i ) || ( ( $new_delete =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2207 $delete_folder = 'false';
2209 $delete_folder = 'true';
2212 return $delete_folder;
2217 print "Some IMAP servers allow subfolders to exist even if the parent\n";
2218 print "folders do not. This fixes some problems with the folder list\n";
2219 print "when this is the case, causing the /NoSelect folders to be displayed\n";
2222 if ( lc($noselect_fix_enable) eq 'true' ) {
2223 $default_value = "y";
2225 $default_value = "n";
2227 print "enable noselect fix? (y/n) [$WHT$noselect_fix_enable$NRM]: $WHT";
2228 $noselect_fix_enable = <STDIN
>;
2229 if ( ( $noselect_fix_enable =~ /^y\n/i ) || ( ( $noselect_fix_enable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2230 $noselect_fix_enable = 'true';
2232 $noselect_fix_enable = 'false';
2234 return $noselect_fix_enable;
2236 ############# GENERAL OPTIONS #####################
2240 print "Specify the location for your data directory.\n";
2241 print "You need to create this directory yourself.\n";
2242 print "The path name can be absolute or relative (to the config directory).\n";
2243 print "Here are two examples:\n";
2244 print " Absolute: /var/local/squirrelmail/data/\n";
2245 print " Relative: ../data/\n";
2246 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2247 print "will be converted to their absolute path equivalents in config.php.\n\n";
2248 print "Note: There are potential security risks with having a writeable directory\n";
2249 print "under the web server's root directory (ex: /home/httpd/html).\n";
2250 print "For this reason, it is recommended to put the data directory\n";
2251 print "in an alternate location of your choice. \n";
2254 print "[$WHT$data_dir$NRM]: $WHT";
2255 $new_data_dir = <STDIN
>;
2256 if ( $new_data_dir eq "\n" ) {
2257 $new_data_dir = $data_dir;
2259 $new_data_dir =~ s/[\r\n]//g;
2261 if ( $new_data_dir =~ /^\s*$/ ) {
2264 $new_data_dir =~ s/\/*$//g
;
2265 $new_data_dir =~ s/$/\//g
;
2267 return $new_data_dir;
2270 # Attachment directory
2272 print "Path to directory used for storing attachments while a mail is\n";
2273 print "being composed. The path name can be absolute or relative (to the\n";
2274 print "config directory). Here are two examples:\n";
2275 print " Absolute: /var/local/squirrelmail/attach/\n";
2276 print " Relative: ../attach/\n";
2277 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2278 print "will be converted to their absolute path equivalents in config.php.\n\n";
2279 print "Note: There are a few security considerations regarding this\n";
2280 print "directory:\n";
2281 print " 1. It should have the permission 733 (rwx-wx-wx) to make it\n";
2282 print " impossible for a random person with access to the webserver\n";
2283 print " to list files in this directory. Confidential data might\n";
2284 print " be laying around in there.\n";
2285 print " Depending on your user:group assignments, 730 (rwx-wx---)\n";
2286 print " may be possible, and more secure (e.g. root:apache)\n";
2287 print " 2. Since the webserver is not able to list the files in the\n";
2288 print " content is also impossible for the webserver to delete files\n";
2289 print " lying around there for too long.\n";
2290 print " 3. It should probably be another directory than the data\n";
2291 print " directory specified in option 3.\n";
2294 print "[$WHT$attachment_dir$NRM]: $WHT";
2295 $new_attachment_dir = <STDIN
>;
2296 if ( $new_attachment_dir eq "\n" ) {
2297 $new_attachment_dir = $attachment_dir;
2299 $new_attachment_dir =~ s/[\r\n]//g;
2301 if ( $new_attachment_dir =~ /^\s*$/ ) {
2302 $new_attachment_dir = "";
2304 $new_attachment_dir =~ s/\/*$//g
;
2305 $new_attachment_dir =~ s/$/\//g
;
2307 return $new_attachment_dir;
2311 print "The directory hash level setting allows you to configure the level\n";
2312 print "of hashing that SquirrelMail employs in your data and attachment\n";
2313 print "directories. This value must be an integer ranging from 0 to 4.\n";
2314 print "When this value is set to 0, SquirrelMail will simply store all\n";
2315 print "files as normal in the data and attachment directories. However,\n";
2316 print "when set to a value from 1 to 4, a simple hashing scheme will be\n";
2317 print "used to organize the files in this directory. In short, the crc32\n";
2318 print "value for a username will be computed. Then, up to the first 4\n";
2319 print "digits of the hash, as set by this configuration value, will be\n";
2320 print "used to directory hash the files for that user in the data and\n";
2321 print "attachment directory. This allows for better performance on\n";
2322 print "servers with larger numbers of users.\n";
2325 print "[$WHT$dir_hash_level$NRM]: $WHT";
2326 $new_dir_hash_level = <STDIN
>;
2327 if ( $new_dir_hash_level eq "\n" ) {
2328 $new_dir_hash_level = $dir_hash_level;
2330 $new_dir_hash_level =~ s/[\r\n]//g;
2332 if ( ( int($new_dir_hash_level) < 0 )
2333 || ( int($new_dir_hash_level) > 4 )
2334 || !( int($new_dir_hash_level) eq $new_dir_hash_level ) ) {
2335 print "Invalid Directory Hash Level.\n";
2336 print "Value must be an integer ranging from 0 to 4\n";
2337 print "Hit enter to continue.\n";
2338 $enter_key = <STDIN
>;
2340 $new_dir_hash_level = $dir_hash_level;
2343 return $new_dir_hash_level;
2347 print "This is the default size (in pixels) of the left folder list.\n";
2348 print "Default is 200, but you can set it to whatever you wish. This\n";
2349 print "is a user preference, so this will only show up as their default.\n";
2351 print "[$WHT$default_left_size$NRM]: $WHT";
2352 $new_default_left_size = <STDIN
>;
2353 if ( $new_default_left_size eq "\n" ) {
2354 $new_default_left_size = $default_left_size;
2356 $new_default_left_size =~ s/[\r\n]//g;
2358 return $new_default_left_size;
2362 print "Some IMAP servers only have lowercase letters in the usernames\n";
2363 print "but they still allow people with uppercase to log in. This\n";
2364 print "causes a problem with the user's preference files. This option\n";
2365 print "transparently changes all usernames to lowercase.";
2368 if ( lc($force_username_lowercase) eq 'true' ) {
2369 $default_value = "y";
2371 $default_value = "n";
2373 print "Convert usernames to lowercase (y/n) [$WHT$default_value$NRM]: $WHT";
2374 $new_show = <STDIN
>;
2375 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2385 if ( lc($default_use_priority) eq 'true' ) {
2386 $default_value = "y";
2388 $default_value = "n";
2391 print "Allow users to specify priority of outgoing mail (y/n) [$WHT$default_value$NRM]: $WHT";
2392 $new_show = <STDIN
>;
2393 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2403 if ( lc($hide_sm_attributions) eq 'true' ) {
2404 $default_value = "y";
2406 $default_value = "n";
2409 print "Hide SM attributions (y/n) [$WHT$default_value$NRM]: $WHT";
2410 $new_show = <STDIN
>;
2411 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2421 if ( lc($default_use_mdn) eq 'true' ) {
2422 $default_value = "y";
2424 $default_value = "n";
2427 print "Enable support for read/delivery receipt support (y/n) [$WHT$default_value$NRM]: $WHT";
2428 $new_show = <STDIN
>;
2429 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2437 print " In loosely managed environments, you may want to allow users
2438 to edit their full name and email address. In strictly managed
2439 environments, you may want to force users to use the name
2440 and email address assigned to them.
2442 'y' - allow a user to edit their full name and email address,
2443 'n' - users must use the assigned values.
2447 if ( lc($edit_identity) eq 'true' ) {
2448 $default_value = "y";
2450 $default_value = "n";
2452 print "Allow editing of user's identity? (y/n) [$WHT$default_value$NRM]: $WHT";
2453 $new_edit = <STDIN
>;
2454 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2455 $edit_identity = 'true';
2456 $edit_name = 'true';
2457 $hide_auth_header = command311b
();
2459 $edit_identity = 'false';
2460 $edit_name = command311
();
2461 $hide_auth_header = command311b
();
2463 return $edit_identity;
2467 print " Given that users are not allowed to modify their
2468 email address, can they edit their full name?
2472 if ( lc($edit_name) eq 'true' ) {
2473 $default_value = "y";
2475 $default_value = "n";
2477 print "Allow the user to edit their full name? (y/n) [$WHT$default_value$NRM]: $WHT";
2478 $new_edit = <STDIN
>;
2479 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2480 $edit_name = 'true';
2482 $edit_name = 'false';
2488 print " SquirrelMail adds username information to every sent email
2489 in order to prevent possible sender forging when users are allowed
2490 to change their email and/or full name.
2492 You can remove user information from this header (y), if you think that
2493 it violates privacy or security.
2495 Note: If users are allowed to change their email addresses,
2496 this setting will make it difficult to determine who sent what where.
2497 Use at your own risk.
2501 if ( lc($hide_auth_header) eq "true" ) {
2502 $default_value = "y";
2504 $default_value = "n";
2506 print "Remove username from email headers? (y/n) [$WHT$default_value$NRM]: $WHT";
2507 $new_header = <STDIN
>;
2508 if ( ( $new_header =~ /^y\n/i ) || ( ( $new_header =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2509 $hide_auth_header = "true";
2511 $hide_auth_header = "false";
2513 return $hide_auth_header;
2517 print "This option allows you to disable server side thread sorting if your server \n";
2518 print "declares THREAD support, but you don't want to provide threading options \n";
2519 print "to end users or THREAD extension is broken or extension does not work with \n";
2520 print "options used by SquirrelMail. Option is not used, if THREAD extension is \n";
2521 print "not declared in IMAP CAPABILITY.\n";
2524 if ( lc($disable_thread_sort) eq 'true' ) {
2525 $default_value = "y";
2527 $default_value = "n";
2529 print "Disable server side thread sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2530 $disable_thread_sort = <STDIN
>;
2531 if ( ( $disable_thread_sort =~ /^y\n/i ) || ( ( $disable_thread_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2532 $disable_thread_sort = 'true';
2534 $disable_thread_sort = 'false';
2536 return $disable_thread_sort;
2540 print "This option allows you to disable server side sorting if your server declares \n";
2541 print "SORT support, but SORT extension is broken or does not work with options \n";
2542 print "used by SquirrelMail. Option is not used, if SORT extension is not declared \n";
2543 print "in IMAP CAPABILITY.\n";
2545 print "It is strongly recommended to keep server side sorting enabled, if your ";
2546 print "IMAP server supports it.";
2549 if ( lc($disable_server_sort) eq 'true' ) {
2550 $default_value = "y";
2552 $default_value = "n";
2554 print "Disable server-side sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2555 $disable_server_sort = <STDIN
>;
2556 if ( ( $disable_server_sort =~ /^y\n/i ) || ( ( $disable_server_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2557 $disable_server_sort = 'true';
2559 $disable_server_sort = 'false';
2561 return $disable_server_sort;
2565 print "This option allows you to choose if SM uses charset search\n";
2566 print "Your IMAP server must support the SEARCH CHARSET command for this to work\n";
2569 if ( lc($allow_charset_search) eq 'true' ) {
2570 $default_value = "y";
2572 $default_value = "n";
2574 print "Allow charset searching? (y/n) [$WHT$default_value$NRM]: $WHT";
2575 $allow_charset_search = <STDIN
>;
2576 if ( ( $allow_charset_search =~ /^y\n/i ) || ( ( $allow_charset_search =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2577 $allow_charset_search = 'true';
2579 $allow_charset_search = 'false';
2581 return $allow_charset_search;
2584 # command315 (UID support) obsoleted.
2586 # advanced search option
2588 print "This option allows you to control the use of advanced search form.\n";
2589 print " 0 = enable basic search only\n";
2590 print " 1 = enable advanced search only\n";
2591 print " 2 = enable both\n";
2594 print "Allowed search (0,1,2)? [$WHT$allow_advanced_search$NRM]: $WHT";
2595 $new_allow_advanced_search = <STDIN
>;
2596 if ( $new_allow_advanced_search =~ /^[012]\n/i ) {
2597 $allow_advanced_search = $new_allow_advanced_search;
2599 $allow_advanced_search =~ s/[\r\n]//g;
2600 return $allow_advanced_search;
2605 print "This option allows you to change the name of the PHP session used\n";
2606 print "by SquirrelMail. Unless you know what you are doing, you probably\n";
2607 print "don't need or want to change this from the default of SQMSESSID.\n";
2608 print "[$WHT$session_name$NRM]: $WHT";
2609 $new_session_name = <STDIN
>;
2610 chomp($new_session_name);
2611 if ( $new_session_name eq "" ) {
2612 $new_session_name = $session_name;
2614 return $new_session_name;
2617 # time zone config (since 1.5.1)
2619 print "This option allows you to control the use of time zones.\n";
2620 print " 0 = (default) standard, GNU C time zone names\n";
2621 print " 1 = strict, generic time zone codes with offsets\n";
2622 print " 2 = custom, GNU C time zones loaded from config/timezones.php\n";
2623 print " 3 = custom strict, generic time zone codes with offsets loaded \n";
2624 print " from config/timezones.php\n";
2625 print "See SquirrelMail documentation about format of config/timezones.php file.\n";
2628 print "Desired time zone configuration (0,1,2,3)? [$WHT$time_zone_type$NRM]: $WHT";
2629 $new_time_zone_type = <STDIN
>;
2630 if ( $new_time_zone_type =~ /^[0123]\n/i ) {
2631 $time_zone_type = $new_time_zone_type;
2633 print "\nInvalid configuration value.\n";
2634 print "\nPress enter to continue...";
2637 $time_zone_type =~ s/[\r\n]//g;
2638 return $time_zone_type;
2641 # set the location base for redirects (since 1.5.2)
2642 sub command_config_location_base
{
2643 print "Here you can set the base part of the SquirrelMail URL.\n";
2644 print "It is normally autodetected but if that fails, use this\n";
2645 print "option to override.\n";
2646 print "It should contain only the protocol and hostname/port parts\n";
2647 print "of the URL; the full path will be appended automatically.\n\n";
2648 print "Examples:\nhttp://webmail.example.org\nhttp://webmail.example.com:8080\nhttps://webmail.example.com:6691\n\n";
2649 print "Do not add any path elements.\n";
2651 print "URL base? [" .$WHT."autodetect$NRM]: $WHT";
2652 $new_config_location_base = <STDIN
>;
2653 chomp($new_config_location_base);
2654 $config_location_base = $new_config_location_base;
2656 return $config_location_base;
2659 # only_secure_cookies (since 1.5.2)
2661 print "This option allows you to specify that if a user session is initiated\n";
2662 print "under a secure (HTTPS, SSL-encrypted) connection, the cookies given to\n";
2663 print "the browser will ONLY be transmitted via a secure connection henceforth.\n\n";
2664 print "Generally this is a Good Thing, and should NOT be disabled. However,\n";
2665 print "if you intend to use the Secure Login or Show SSL Link plugins to\n";
2666 print "encrypt the user login, but not the rest of the SquirrelMail session,\n";
2667 print "this can be turned off. Think twice before doing so.\n";
2670 if ( lc($only_secure_cookies) eq 'true' ) {
2671 $default_value = "y";
2673 $default_value = "n";
2675 print "Transmit cookies only on secure connection when available? (y/n) [$WHT$default_value$NRM]: $WHT";
2676 $only_secure_cookies = <STDIN
>;
2677 if ( ( $only_secure_cookies =~ /^y\n/i ) || ( ( $only_secure_cookies =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2678 $only_secure_cookies = 'true';
2680 $only_secure_cookies = 'false';
2682 return $only_secure_cookies;
2686 sub command_userThemes
{
2687 print "\nDefine the user themes that you wish to use. If you have added\n";
2688 print "a theme of your own, just follow the instructions (?) about\n";
2689 print "how to add them. You can also change the default theme.\n\n";
2691 print "Available user themes:\n";
2693 while ( $count <= $#user_theme_name ) {
2694 if ( $count == $user_theme_default ) {
2699 if ( $count < 10 ) {
2702 $name = $user_theme_name[$count];
2703 $num_spaces = 35 - length($name);
2704 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2705 $name = $name . " ";
2708 print " $count. $name";
2709 print "($user_theme_path[$count])\n";
2715 print ".------------------------------------.\n";
2716 print "| t (detect user themes) |\n";
2717 print "| + (add user theme) |\n";
2718 print "| - N (remove user theme) |\n";
2719 print "| m N (mark default user theme) |\n";
2720 print "| l (list user themes) |\n";
2721 print "| d (done) |\n";
2722 print "`------------------------------------'\n";
2724 print "\n[user_themes] command (?=help) > ";
2726 $input =~ s/[\r\n]//g;
2727 while ( $input ne "d" ) {
2728 if ( $input =~ /^\s*l\s*/i ) {
2730 while ( $count <= $#user_theme_name ) {
2731 if ( $count == $user_theme_default ) {
2736 if ( $count < 10 ) {
2739 $name = $user_theme_name[$count];
2740 $num_spaces = 35 - length($name);
2741 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2742 $name = $name . " ";
2745 print " $count. $name";
2746 print "($user_theme_path[$count])\n";
2750 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2751 $old_def = $user_theme_default;
2752 $user_theme_default = $input;
2753 $user_theme_default =~ s/^\s*m\s*//;
2754 if ( ( $user_theme_default > $#user_theme_name ) || ( $user_theme_default < 0 ) ) {
2755 print "Cannot set default theme to $user_theme_default. That theme does not exist.\n";
2756 $user_theme_default = $old_def;
2758 } elsif ( $input =~ /^\s*\+/ ) {
2759 print "What is the name of this theme? ";
2761 $name =~ s/[\r\n]//g;
2762 $user_theme_name[ $#user_theme_name + 1 ] = $name;
2763 print "Be sure to put ../css/ before the filename.\n";
2764 print "What file is this stored in (ex: ../css/my_theme/): ";
2766 $name =~ s/[\r\n]//g;
2767 $user_theme_path[ $#user_theme_path + 1 ] = $name;
2768 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2769 if ( $input =~ /[0-9]+\s*$/ ) {
2771 $rem_num =~ s/^\s*-\s*//g;
2772 $rem_num =~ s/\s*$//;
2774 $rem_num = $#user_theme_name;
2776 if ( $rem_num == $user_theme_default ) {
2777 print "You cannot remove the default theme!\n";
2780 @new_theme_name = ();
2781 @new_theme_path = ();
2782 while ( $count <= $#user_theme_name ) {
2783 if ( $count != $rem_num ) {
2784 @new_theme_name = ( @new_theme_name, $user_theme_name[$count] );
2785 @new_theme_path = ( @new_theme_path, $user_theme_path[$count] );
2789 @user_theme_name = @new_theme_name;
2790 @user_theme_path = @new_theme_path;
2791 if ( $user_theme_default > $rem_num ) {
2792 $user_theme_default--;
2795 } elsif ( $input =~ /^\s*t\s*/i ) {
2796 print "\nStarting detection...\n\n";
2798 opendir( DIR
, "../css" );
2799 @files = sort(readdir(DIR
));
2801 while ( $cnt <= $#files ) {
2802 $filename = "../css/" . $files[$cnt] .'/';
2803 if ( $files[$cnt] !~ /^\./ && $filename ne "../css/rtl.css" && -e
$filename . "default.css" ) {
2805 for ( $x = 0 ; $x <= $#user_theme_path ; $x++ ) {
2806 if ( $user_theme_path[$x] eq $filename ) {
2810 if ( $found != 1 ) {
2811 print "** Found user theme: $filename\n";
2812 $def = $files[$cnt];
2815 #$def =~ s/(^\w+)/ucfirst $1/eg;
2816 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
2817 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
2818 print " What is its name? [$def]: ";
2820 $nm =~ s/^\s+|\s+$|[\n\r]//g;
2821 if ( $nm eq '' ) { $nm = $def; }
2822 $user_theme_name[ $#user_theme_name + 1 ] = $nm;
2823 $user_theme_path[ $#user_theme_path + 1 ] = $filename;
2829 for ( $cnt = 0 ; $cnt <= $#user_theme_path ; $cnt++ ) {
2830 $filename = $user_theme_path[$cnt];
2831 if ( $filename != 'none' && !( -e
$filename ."/default.css" ) ) {
2832 print " Removing $filename (file not found)\n";
2834 @new_user_theme_name = ();
2835 @new_user_theme_path = ();
2836 for ( $x = 0 ; $x < $#user_theme_path ; $x++ ) {
2837 if ( $user_theme_path[$x] eq $filename ) {
2840 if ( $offset == 1 ) {
2841 $new_user_theme_name[$x] = $user_theme_name[ $x + 1 ];
2842 $new_user_theme_path[$x] = $user_theme_path[ $x + 1 ];
2844 $new_user_theme_name[$x] = $user_theme_name[$x];
2845 $new_user_theme_path[$x] = $user_theme_path[$x];
2848 @user_theme_name = @new_user_theme_name;
2849 @user_theme_path = @new_user_theme_path;
2852 print "\nDetection complete!\n\n";
2855 } elsif ( $input =~ /^\s*\?\s*/ ) {
2856 print ".------------------------------------.\n";
2857 print "| t (detect user themes) |\n";
2858 print "| + (add user theme) |\n";
2859 print "| - N (remove user theme) |\n";
2860 print "| m N (mark default user theme) |\n";
2861 print "| l (list user themes) |\n";
2862 print "| d (done) |\n";
2863 print "`------------------------------------'\n";
2865 print "[user_themes] command (?=help) > ";
2867 $input =~ s/[\r\n]//g;
2871 sub command_iconSets
{
2872 print "\nDefine the icon themes that you wish to use. If you have added\n";
2873 print "a theme of your own, just follow the instructions (?) about\n";
2874 print "how to add them. You can also change the default and fallback\n";
2875 print "themes. The default theme will be used when no icon theme is\n";
2876 print "set by the user. The fallback theme will be used if an icon\n";
2877 print "cannot be found in the currently selected icon theme.\n\n";
2879 print "Available icon themes:\n\n";
2882 while ( $count <= $#icon_theme_name ) {
2883 if ( $count == $icon_theme_def ) {
2888 if ( $count eq $icon_theme_fallback ) {
2893 if ( $count < 10 ) {
2896 $name = $icon_theme_name[$count];
2897 $num_spaces = 35 - length($name);
2898 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2899 $name = $name . " ";
2902 print " $count. $name";
2903 print "($icon_theme_path[$count])\n";
2908 print "\n d = Default icon theme\n";
2909 print " f = Fallback icon theme\n";
2911 print ".------------------------------------.\n";
2912 print "| t (detect icon themes) |\n";
2913 print "| + (add icon theme) |\n";
2914 print "| - N (remove icon theme) |\n";
2915 print "| m N (mark default icon theme) |\n";
2916 print "| f N (set fallback icon set) |\n";
2917 print "| l (list icon themes) |\n";
2918 print "| d (done) |\n";
2919 print "`------------------------------------'\n";
2921 print "\n[icon_themes] command (?=help) > ";
2923 $input =~ s/[\r\n]//g;
2924 while ( $input ne "d" ) {
2925 if ( $input =~ /^\s*l\s*/i ) {
2928 while ( $count <= $#icon_theme_name ) {
2929 if ( $count == $icon_theme_def ) {
2934 if ( $count eq $icon_theme_fallback ) {
2939 $name = $icon_theme_name[$count];
2940 $num_spaces = 35 - length($name);
2941 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2942 $name = $name . " ";
2945 print " $count. $name";
2946 print "($icon_theme_path[$count])\n";
2950 print "\n d = Default icon theme\n";
2951 print " f = Fallback icon theme\n\n";
2952 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2953 $old_def = $icon_theme_def;
2954 $icon_theme_def = $input;
2955 $icon_theme_def =~ s/^\s*m\s*//;
2956 if ( ( $icon_theme_default > $#icon_theme_name ) || ( $icon_theme_default < 0 ) ) {
2957 print "Cannot set default icon theme to $icon_theme_default. That theme does not exist.\n";
2958 $icon_theme_def = $old_def;
2960 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
2961 $old_fb = $icon_theme_fallback;
2962 $icon_theme_fallback = $input;
2963 $icon_theme_fallback =~ s/^\s*f\s*//;
2964 if ( ( $icon_theme_fallback > $#icon_theme_name ) || ( $icon_theme_fallback < 0 ) ) {
2965 print "Cannot set fallback icon theme to $icon_theme_fallback. That theme does not exist.\n";
2966 $icon_theme_fallback = $old_fb;
2968 } elsif ( $input =~ /^\s*\+/ ) {
2969 print "What is the name of this icon theme? ";
2971 $name =~ s/[\r\n]//g;
2972 $icon_theme_name[ $#icon_theme_name + 1 ] = $name;
2973 print "Be sure to put ../images/themes/ before the filename.\n";
2974 print "What directory is this icon theme stored in (ex: ../images/themes/my_theme/)? ";
2976 $name =~ s/[\r\n]//g;
2977 $icon_theme_path[ $#icon_theme_path + 1 ] = $name;
2978 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2979 if ( $input =~ /[0-9]+\s*$/ ) {
2981 $rem_num =~ s/^\s*-\s*//g;
2982 $rem_num =~ s/\s*$//;
2984 $rem_num = $#icon_theme_name;
2986 if ( $rem_num == $icon_theme_def ) {
2987 print "You cannot remove the default icon theme!\n";
2988 } elsif ( $rem_num == $icon_theme_fallback ) {
2989 print "You cannot remove the fallback icon theme!\n";
2992 @new_theme_name = ();
2993 @new_theme_path = ();
2994 while ( $count <= $#icon_theme_name ) {
2995 if ( $count != $rem_num ) {
2996 @new_theme_name = ( @new_theme_name, $icon_theme_name[$count] );
2997 @new_theme_path = ( @new_theme_path, $icon_theme_path[$count] );
3001 @icon_theme_name = @new_theme_name;
3002 @icon_theme_path = @new_theme_path;
3003 if ( $icon_theme_def > $rem_num ) {
3007 } elsif ( $input =~ /^\s*t\s*/i ) {
3008 print "\nStarting detection...\n\n";
3010 opendir( DIR
, "../images/themes/" );
3011 @files = sort(readdir(DIR
));
3013 while ( $cnt <= $#files ) {
3014 $filename = "../images/themes/" . $files[$cnt] .'/';
3015 if ( -d
"../images/themes/" . $files[$cnt] && $files[$cnt] !~ /^\
./ && $files[$cnt] ne ".svn" ) {
3017 for ( $x = 0 ; $x <= $#icon_theme_path ; $x++ ) {
3018 if ( $icon_theme_path[$x] eq $filename ) {
3022 if ( $found != 1 ) {
3023 print "** Found icon theme: $filename\n";
3024 $def = $files[$cnt];
3027 #$def =~ s/(^\w+)/ucfirst $1/eg;
3028 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3029 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3030 print " What is its name? [$def]: ";
3032 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3033 if ( $nm eq '' ) { $nm = $def; }
3034 $icon_theme_name[ $#icon_theme_name + 1 ] = $nm;
3035 $icon_theme_path[ $#icon_theme_path + 1 ] = $filename;
3041 for ( $cnt = 0 ; $cnt <= $#icon_theme_path ; $cnt++ ) {
3042 $filename = $icon_theme_path[$cnt];
3043 if ( $filename ne "none" && $filename ne "template" && ! -d
$filename ) {
3044 print " Removing $filename (file not found)\n";
3046 @new_icon_theme_name = ();
3047 @new_icon_theme_path = ();
3048 for ( $x = 0 ; $x < $#icon_theme_path ; $x++ ) {
3049 if ( $icon_theme_path[$x] eq $filename ) {
3052 if ( $offset == 1 ) {
3053 $new_icon_theme_name[$x] = $icon_theme_name[ $x + 1 ];
3054 $new_icon_theme_path[$x] = $icon_theme_path[ $x + 1 ];
3056 $new_icon_theme_name[$x] = $icon_theme_name[$x];
3057 $new_icon_theme_path[$x] = $icon_theme_path[$x];
3060 @icon_theme_name = @new_icon_theme_name;
3061 @icon_theme_path = @new_icon_theme_path;
3064 print "\nDetection complete!\n\n";
3067 } elsif ( $input =~ /^\s*\?\s*/ ) {
3068 print ".------------------------------------.\n";
3069 print "| t (detect icon themes) |\n";
3070 print "| + (add icon theme) |\n";
3071 print "| - N (remove icon theme) |\n";
3072 print "| m N (mark default icon theme) |\n";
3073 print "| f N (set fallback icon set) |\n";
3074 print "| l (list icon themes) |\n";
3075 print "| d (done) |\n";
3076 print "`------------------------------------'\n";
3078 print "[icon_themes] command (?=help) > ";
3080 $input =~ s/[\r\n]//g;
3084 sub command_templates
{
3085 print "\nDefine the template sets (skins) that you wish to use. If you have added\n";
3086 print "a template set of your own, just follow the instructions (?) about\n";
3087 print "how to add them. You can also change the default template.\n";
3089 print "\n Available Templates:\n";
3092 while ( $count <= $#templateset_name ) {
3093 if ( $templateset_id[$count] eq $templateset_default ) {
3098 if ( $templateset_id[$count] eq $templateset_fallback ) {
3103 if ( $count < 10 ) {
3106 $name = $templateset_name[$count];
3107 $num_spaces = 35 - length($name);
3108 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3109 $name = $name . " ";
3112 print " $count. $name";
3113 print "($templateset_id[$count])\n";
3117 print "\n d = default template set\n"
3118 . " f = fallback template set\n\n";
3120 $menu_text = ".-------------------------------------.\n"
3121 . "| t (detect template set) |\n"
3122 . "| + (add template set) |\n"
3123 . "| - N (remove template set) |\n"
3124 . "| m N (mark default template set) |\n"
3125 . "| f N (set fallback template set) |\n"
3126 . "| l (list template sets/skins) |\n"
3128 . "|-------------------------------------|\n"
3129 . "| where N is a template set number |\n"
3130 . "`-------------------------------------'\n";
3133 print "\n[template set] command (?=help) > ";
3136 $input =~ s/[\r\n]//g;
3137 while ( $input ne "d" ) {
3139 # list template sets
3141 if ( $input =~ /^\s*l\s*/i ) {
3143 while ( $count <= $#templateset_name ) {
3144 if ( $templateset_id[$count] eq $templateset_default ) {
3149 if ( $templateset_id[$count] eq $templateset_fallback ) {
3154 if ( $count < 10 ) {
3157 $name = $templateset_name[$count];
3158 $num_spaces = 35 - length($name);
3159 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3160 $name = $name . " ";
3163 print " $count. $name";
3164 print "($templateset_id[$count])\n";
3168 print "\n d = default template set\n"
3169 . " f = fallback template set\n\n";
3171 # mark default template set
3173 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
3174 $old_def = $templateset_default;
3175 $input =~ s/^\s*m\s*//;
3176 $templateset_default = $templateset_id[$input];
3177 if ( $templateset_default =~ /^\s*$/ ) {
3178 print "Cannot set default template set to $input. That template set does not exist.\n";
3179 $templateset_default = $old_def;
3182 # set fallback template set
3184 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
3185 $old_def = $templateset_fallback;
3186 $input =~ s/^\s*f\s*//;
3187 $templateset_fallback = $templateset_id[$input];
3188 if ( $templateset_fallback =~ /^\s*$/ ) {
3189 print "Cannot set fallback template set to $input. That template set does not exist.\n";
3190 $templateset_fallback = $old_def;
3195 } elsif ( $input =~ /^\s*\+/ ) {
3196 print "\nWhat is the name of this template (as shown to your users): ";
3198 $name =~ s/[\r\n]//g;
3199 $templateset_name[ $#templateset_name + 1 ] = $name;
3200 print "\n\nThe directory name should not contain any path information\n"
3201 . "or slashes, and should be the name of the directory that the\n"
3202 . "template set is found in within the SquirrelMail templates\n"
3204 print "What directory is this stored in (ex: default_advanced): ";
3206 $name =~ s/[\r\n]//g;
3207 $templateset_id[ $#templateset_id + 1 ] = $name;
3209 # detect template sets
3211 } elsif ( $input =~ /^\s*t\s*/i ) {
3212 print "\nStarting detection...\n\n";
3213 opendir( DIR
, "../templates" );
3214 @files = sort(readdir(DIR
));
3216 while ( $cnt <= $#files ) {
3217 if ( -d
"../templates/" . $files[$cnt] && $files[$cnt] !~ /^\./ && $files[$cnt] ne ".svn" ) {
3218 $filename = $files[$cnt];
3220 for ( $x = 0 ; $x <= $#templateset_id ; $x++ ) {
3221 if ( $templateset_id[$x] eq $filename ) {
3227 print "** Found template set: $filename\n";
3228 $def = $files[$cnt];
3231 #$def =~ s/(^\w+)/ucfirst $1/eg;
3232 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3233 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3234 print " What is it's name (as shown to your users)? [$def]: ";
3236 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3237 if ( $nm eq '' ) { $nm = $def; }
3238 $templateset_id[ $#templateset_id + 1 ] = $filename;
3239 $templateset_name[ $#templateset_name + 1 ] = $nm;
3245 for ( $cnt= 0 ; $cnt <= $#templateset_id ; ) {
3246 $filename = $templateset_id[$cnt];
3247 if ( !(-d change_to_rel_path
('SM_PATH . \'templates/' . $filename)) ) {
3248 print " Removing \"$filename\" (template set directory not found)\n";
3249 if ( $templateset_default eq $filename ) { $templateset_default = 'default'; }
3250 if ( $templateset_fallback eq $filename ) { $templateset_fallback = 'default'; }
3252 @new_templateset_name = ();
3253 @new_templateset_id = ();
3254 for ( $x = 0 ; $x < $#templateset_id ; $x++ ) {
3255 if ( $templateset_id[$x] eq $filename ) {
3258 if ( $offset == 1 ) {
3259 $new_templateset_name[$x] = $templateset_name[ $x + 1 ];
3260 $new_templateset_id[$x] = $templateset_id[ $x + 1 ];
3262 $new_templateset_name[$x] = $templateset_name[$x];
3263 $new_templateset_id[$x] = $templateset_id[$x];
3266 @templateset_name = @new_templateset_name;
3267 @templateset_id = @new_templateset_id;
3270 print "\nDetection complete!\n\n";
3274 # remove template set
3276 # undocumented functionality of removing last template set isn't that great
3277 #} elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3278 } elsif ( $input =~ /^\s*-\s*[0-9]+/ ) {
3279 if ( $input =~ /[0-9]+\s*$/ ) {
3281 $rem_num =~ s/^\s*-\s*//g;
3282 $rem_num =~ s/\s*$//;
3284 $rem_num = $#templateset_name;
3286 if ( $templateset_id[$rem_num] eq $templateset_default ) {
3287 print "You cannot remove the default template set!\n";
3288 } elsif ( $templateset_id[$rem_num] eq $templateset_fallback ) {
3289 print "You cannot remove the fallback template set!\n";
3292 @new_templateset_name = ();
3293 @new_templateset_id = ();
3294 while ( $count <= $#templateset_name ) {
3295 if ( $count != $rem_num ) {
3296 @new_templateset_name = ( @new_templateset_name, $templateset_name[$count] );
3297 @new_templateset_id = ( @new_templateset_id, $templateset_id[$count] );
3301 @templateset_name = @new_templateset_name;
3302 @templateset_id = @new_templateset_id;
3307 } elsif ( $input =~ /^\s*\?\s*/ ) {
3310 # command not understood
3313 print "Command not understood\n";
3316 print "[template set] command (?=help) > ";
3318 $input =~ s/[\r\n]//g;
3320 return $templateset_default;
3324 # sets default font size option
3325 sub command_default_fontsize
{
3326 print "Enter default font size [$WHT$$default_fontsize$NRM]: $WHT";
3327 $new_size = <STDIN
>;
3328 if ( $new_size eq "\n" ) {
3331 $new_size =~ s/[\r\n]//g;
3336 # controls available fontsets
3337 sub command_fontsets
{
3339 print "You can control fontsets available to end users here.\n";
3340 # set initial $input value
3342 while ( $input ne "x" ) {
3343 if ( $input =~ /^\s*a\s*/i ) {
3345 print "\nFontset name: ";
3347 if (! $fontsets{trim
($name)}) {
3348 print "Fontset string: ";
3350 $fontsets{trim
($name)} = trim
($value);
3352 print "\nERROR: Such fontset already exists.\n";
3354 } elsif ( $input =~ /^\s*e\s*/i ) {
3355 # edit existing fontset
3356 print "\nFontset name: ";
3358 if (! $fontsets{trim
($name)}) {
3359 print "\nERROR: No such fontset.\n";
3361 print "Fontset string [$fontsets{trim($name)}]: ";
3363 $fontsets{trim
($name)} = trim
($value);
3365 } elsif ( $input =~ /^\s*d\s*/ ) {
3366 # delete existing fontset
3367 print "\nFontset name: ";
3369 if (! $fontsets{trim
($name)}) {
3370 print "\nERROR: No such fontset.\n";
3372 delete $fontsets{trim
($name)};
3374 } elsif ( $input =~ /^\s*l\s*/ ) {
3376 print "\nConfigured fontsets:\n";
3377 while (($fontset_name, $fontset_string) = each(%fontsets)) {
3378 print " $fontset_name = $fontset_string\n";
3380 print "Default fontset: $default_fontset\n";
3381 } elsif ( $input =~ /^\s*m\s*/ ) {
3382 # set default fontset
3383 print "\nSet default fontset [$default_fontset]: ";
3385 if (trim
($name) ne '' and ! $fontsets{trim
($name)}) {
3386 print "\nERROR: No such fontset.\n";
3388 $default_fontset = trim
($name);
3391 # print available commands on any other input
3392 print "\nAvailable commands:\n";
3393 print " a - Adds new fontset.\n";
3394 print " d - Deletes existing fontset.\n";
3395 print " e - Edits existing fontset.\n";
3396 print " h or ? - Shows this help screen.\n";
3397 print " l - Lists available fontsets.\n";
3398 print " m - Sets default fontset.\n";
3399 print " x - Exits fontset editor mode.\n";
3401 print "\nCommand [fontsets] (a,d,e,h,?=help,l,m,x)> ";
3403 $input =~ s/[\r\n]//g;
3408 print "You can now define different LDAP servers.\n";
3409 print "Please ensure proper permissions for config.php when including\n";
3410 print "sensitive passwords.\n\n";
3411 print "[ldap] command (?=help) > ";
3413 $input =~ s/[\r\n]//g;
3414 while ( $input ne "d" ) {
3415 if ( $input =~ /^\s*l\s*/i ) {
3417 while ( $count <= $#ldap_host ) {
3418 print "$count. $ldap_host[$count]\n";
3419 print " base: $ldap_base[$count]\n";
3420 if ( $ldap_charset[$count] ) {
3421 print " charset: $ldap_charset[$count]\n";
3423 if ( $ldap_port[$count] ) {
3424 print " port: $ldap_port[$count]\n";
3426 if ( $ldap_name[$count] ) {
3427 print " name: $ldap_name[$count]\n";
3429 if ( $ldap_maxrows[$count] ) {
3430 print " maxrows: $ldap_maxrows[$count]\n";
3432 if ( $ldap_filter[$count] ) {
3433 print " filter: $ldap_filter[$count]\n";
3435 if ( $ldap_binddn[$count] ) {
3436 print " binddn: $ldap_binddn[$count]\n";
3437 if ( $ldap_bindpw[$count] ) {
3438 print " bindpw: $ldap_bindpw[$count]\n";
3441 if ( $ldap_protocol[$count] ) {
3442 print " protocol: $ldap_protocol[$count]\n";
3444 if ( $ldap_limit_scope[$count] ) {
3445 print " limit_scope: $ldap_limit_scope[$count]\n";
3447 if ( $ldap_listing[$count] ) {
3448 print " listing: $ldap_listing[$count]\n";
3450 if ( $ldap_writeable[$count] ) {
3451 print " writeable: $ldap_writeable[$count]\n";
3453 if ( $ldap_search_tree[$count] ) {
3454 print " search_tree: $ldap_search_tree[$count]\n";
3456 if ( $ldap_starttls[$count] ) {
3457 print " starttls: $ldap_starttls[$count]\n";
3463 } elsif ( $input =~ /^\s*\+/ ) {
3464 $sub = $#ldap_host + 1;
3466 print "First, we need to have the hostname or the IP address where\n";
3467 print "this LDAP server resides. Example: ldap.bigfoot.com\n";
3469 print "You can use any URI compatible with your LDAP library. Please\n";
3470 print "note that StartTLS option is not compatible with ldaps and\n";
3471 print "ldapi URIs.\n";
3474 $name =~ s/[\r\n]//g;
3475 $ldap_host[$sub] = $name;
3479 print "Next, we need the server root (base dn). For this, an empty\n";
3480 print "string is allowed.\n";
3481 print "Example: ou=member_directory,o=netcenter.com\n";
3484 $name =~ s/[\r\n]//g;
3485 $ldap_base[$sub] = $name;
3489 print "This is the TCP/IP port number for the LDAP server. Default\n";
3490 print "port is 389. This is optional. Press ENTER for default.\n";
3493 $name =~ s/[\r\n]//g;
3494 $ldap_port[$sub] = $name;
3498 print "This is the charset for the server. Default is utf-8. This\n";
3499 print "is also optional. Press ENTER for default.\n";
3502 $name =~ s/[\r\n]//g;
3503 $ldap_charset[$sub] = $name;
3507 print "This is the name for the server, used to tag the results of\n";
3508 print "the search. Default it \"LDAP: hostname\". Press ENTER for default\n";
3511 $name =~ s/[\r\n]//g;
3512 $ldap_name[$sub] = $name;
3516 print "You can specify the maximum number of rows in the search result.\n";
3517 print "Default value is equal to 250 rows. Press ENTER for default.\n";
3520 $name =~ s/[\r\n]//g;
3521 $ldap_maxrows[$sub] = $name;
3526 print "If your LDAP server does not like anonymous logins, you can specify bind DN.\n";
3527 print "Default is none, anonymous bind. Press ENTER for default.\n";
3530 $name =~ s/[\r\n]//g;
3531 $ldap_binddn[$sub] = $name;
3535 if ( $ldap_binddn[$sub] ne '' ) {
3537 print "Now, please specify password for that DN.\n";
3540 $name =~ s/[\r\n]//g;
3541 $ldap_bindpw[$sub] = $name;
3546 print "You can specify bind protocol version here.\n";
3547 print "Default protocol version depends on your php ldap settings.\n";
3548 print "Press ENTER for default.\n";
3551 $name =~ s/[\r\n]//g;
3552 $ldap_protocol[$sub] = $name;
3556 print "This configuration section allows to set some rarely used\n";
3557 print "options and options specific to some LDAP implementations.\n";
3559 print "Do you want to set advanced LDAP directory settings? (y/N):";
3560 $ldap_advanced_settings = <STDIN
>;
3561 if ( $ldap_advanced_settings =~ /^y\n/i ) {
3562 $ldap_advanced_settings = 'true';
3564 $ldap_advanced_settings = 'false';
3567 if ($ldap_advanced_settings eq 'true') {
3570 print "You can control LDAP directory listing here. This option can\n";
3571 print "be useful if you run small LDAP server and want to provide listing\n";
3572 print "of all addresses stored in LDAP to users of webmail interface.\n";
3573 print "Number of displayed entries is limited by maxrows setting.\n";
3575 print "Don't enable this option for public LDAP directories.\n";
3577 print "Allow listing of LDAP directory? (y/N):";
3579 if ( $name =~ /^y\n/i ) {
3584 $ldap_listing[$sub] = $name;
3588 print "You can control write access to LDAP address book here. This option can\n";
3589 print "be useful if you run small LDAP server and want to provide writable\n";
3590 print "shared address book stored in LDAP to users of webmail interface.\n";
3592 print "Don't enable this option for public LDAP directories.\n";
3594 print "Allow writing to LDAP directory? (y/N):";
3596 if ( $name =~ /^y\n/i ) {
3601 $ldap_writeable[$sub] = $name;
3605 print "You can specify an additional search filter.\n";
3606 print "This could be something like \"(objectclass=posixAccount)\".\n";
3607 print "No filtering is performed by default. Press ENTER for default.\n";
3610 $name =~ s/[\r|\n]//g;
3611 $ldap_filter[$sub] = $name;
3615 print "You can control search scope here.\n";
3616 print "This option is specific to Microsoft ADS implementation.\n";
3617 print "It requires use of v3 or newer LDAP protocol.\n";
3618 print "Don't enable it, if you use other LDAP server.\n";
3620 print "Limit ldap scope? (y/N):";
3622 if ( $name =~ /^y\n/i ) {
3627 $ldap_limit_scope[$sub] = $name;
3631 print "You can control ldap search type here.\n";
3632 print "Addresses can be searched in entire LDAP subtree (default)\n";
3633 print "or only first level entries are returned.\n";
3635 print "Search entire LDAP subtree? (Y/n):";
3637 if ( $name =~ /^n\n/i ) {
3642 $ldap_search_tree[$sub] = $name;
3646 print "You can control use of StartTLS on LDAP connection here.\n";
3647 print "This option requires use of v3 or newer LDAP protocol and php 4.2+.\n";
3649 print "Use StartTLS? (y/N):";
3651 if ( $name =~ /^y\n/i ) {
3656 $ldap_starttls[$sub] = $name;
3660 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3661 if ( $input =~ /[0-9]+\s*$/ ) {
3663 $rem_num =~ s/^\s*-\s*//g;
3664 $rem_num =~ s/\s*$//;
3666 $rem_num = $#ldap_host;
3669 @new_ldap_host = ();
3670 @new_ldap_base = ();
3671 @new_ldap_port = ();
3672 @new_ldap_name = ();
3673 @new_ldap_charset = ();
3674 @new_ldap_maxrows = ();
3675 @new_ldap_filter = ();
3676 @new_ldap_bindpw = ();
3677 @new_ldap_binddn = ();
3678 @new_ldap_protocol = ();
3679 @new_ldap_limit_scope = ();
3680 @new_ldap_listing = ();
3681 @new_ldap_writeable = ();
3682 @new_ldap_search_tree = ();
3683 @new_ldap_starttls = ();
3685 while ( $count <= $#ldap_host ) {
3686 if ( $count != $rem_num ) {
3687 @new_ldap_host = ( @new_ldap_host, $ldap_host[$count] );
3688 @new_ldap_base = ( @new_ldap_base, $ldap_base[$count] );
3689 @new_ldap_port = ( @new_ldap_port, $ldap_port[$count] );
3690 @new_ldap_name = ( @new_ldap_name, $ldap_name[$count] );
3691 @new_ldap_charset = ( @new_ldap_charset, $ldap_charset[$count] );
3692 @new_ldap_maxrows = ( @new_ldap_maxrows, $ldap_maxrows[$count] );
3693 @new_ldap_filter = ( @new_ldap_filter, $ldap_filter[$count] );
3694 @new_ldap_binddn = ( @new_ldap_binddn, $ldap_binddn[$count] );
3695 @new_ldap_bindpw = ( @new_ldap_bindpw, $ldap_bindpw[$count] );
3696 @new_ldap_protocol = ( @new_ldap_protocol, $ldap_protocol[$count] );
3697 @new_ldap_limit_scope = ( @new_ldap_limit_scope, $ldap_limit_scope[$count] );
3698 @new_ldap_listing = ( @new_ldap_listing, $ldap_listing[$count] );
3699 @new_ldap_writeable = ( @new_ldap_writeable, $ldap_writeable[$count] );
3700 @new_ldap_search_tree = ( @new_ldap_search_tree, $ldap_search_tree[$count] );
3701 @new_ldap_starttls = ( @new_ldap_starttls, $ldap_starttls[$count] );
3705 @ldap_host = @new_ldap_host;
3706 @ldap_base = @new_ldap_base;
3707 @ldap_port = @new_ldap_port;
3708 @ldap_name = @new_ldap_name;
3709 @ldap_charset = @new_ldap_charset;
3710 @ldap_maxrows = @new_ldap_maxrows;
3711 @ldap_filter = @new_ldap_filter;
3712 @ldap_binddn = @new_ldap_binddn;
3713 @ldap_bindpw = @new_ldap_bindpw;
3714 @ldap_protocol = @new_ldap_protocol;
3715 @ldap_limit_scope = @new_ldap_limit_scope;
3716 @ldap_listing = @new_ldap_listing;
3717 @ldap_writeable = @new_ldap_writeable;
3718 @ldap_search_tree = @new_ldap_search_tree;
3719 @ldap_starttls = @new_ldap_starttls;
3721 } elsif ( $input =~ /^\s*\?\s*/ ) {
3722 print ".-------------------------.\n";
3723 print "| + (add host) |\n";
3724 print "| - N (remove host) |\n";
3725 print "| l (list hosts) |\n";
3726 print "| d (done) |\n";
3727 print "`-------------------------'\n";
3729 print "[ldap] command (?=help) > ";
3731 $input =~ s/[\r\n]//g;
3736 print "Some of our developers have come up with very good javascript interface\n";
3737 print "for searching through address books, however, our original goals said\n";
3738 print "that we would be 100% HTML. In order to make it possible to use their\n";
3739 print "interface, and yet stick with our goals, we have also written a plain\n";
3740 print "HTML version of the search. Here, you can choose which version to use.\n";
3742 print "This is just the default value. It is also a user option that each\n";
3743 print "user can configure individually\n";
3746 if ( lc($default_use_javascript_addr_book) eq 'true' ) {
3747 $default_value = "y";
3749 $default_use_javascript_addr_book = 'false';
3750 $default_value = "n";
3752 print "Use javascript version by default (y/n) [$WHT$default_value$NRM]: $WHT";
3753 $new_show = <STDIN
>;
3754 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3755 $default_use_javascript_addr_book = 'true';
3757 $default_use_javascript_addr_book = 'false';
3759 return $default_use_javascript_addr_book;
3762 # global filebased address book
3764 print "If you want to use global file address book, then you\n";
3765 print "must set this option to a valid value. If option does\n";
3766 print "not have path elements, system assumes that file is\n";
3767 print "stored in data directory. If relative path is set, it is\n";
3768 print "relative to main SquirrelMail directory. If value is empty,\n";
3769 print "address book is not enabled.\n";
3772 print "[$WHT$abook_global_file$NRM]: $WHT";
3773 $new_abook_global_file = <STDIN
>;
3774 if ( $new_abook_global_file eq "\n" ) {
3775 $new_abook_global_file = $abook_global_file;
3777 $new_abook_global_file =~ s/[\r\n]//g;
3779 return $new_abook_global_file;
3782 # writing into global filebased abook control
3784 print "This setting controls writing into global file address\n";
3785 print "book options. Address book file must be writeable by\n";
3786 print "webserver's user, if you want to enable this option.\n";
3789 if ( lc($abook_global_file_writeable) eq 'true' ) {
3790 $default_value = "y";
3792 $abook_global_file_writeable = 'false';
3793 $default_value = "n";
3795 print "Allow writing into global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
3796 $new_show = <STDIN
>;
3797 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3798 $abook_global_file_writeable = 'true';
3800 $abook_global_file_writeable = 'false';
3802 return $abook_global_file_writeable;
3805 # listing of global filebased abook control
3807 print "This setting controls listing of global file address\n";
3808 print "book in addresses page.\n";
3811 if ( lc($abook_global_file_listing) eq 'true' ) {
3812 $default_value = "y";
3814 $abook_global_file_listing = 'false';
3815 $default_value = "n";
3817 print "Allow listing of global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
3818 $new_show = <STDIN
>;
3819 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3820 $abook_global_file_listing = 'true';
3822 $abook_global_file_listing = 'false';
3824 return $abook_global_file_listing;
3827 # controls $abook_file_line_length setting
3828 sub command_abook_file_line_length
{
3829 print "This setting controls space allocated to file based address book records.\n";
3830 print "End users will be unable to save address book entry, if total entry size \n";
3831 print "(quoted address book fields + 4 delimiters + linefeed) exceeds allowed \n";
3832 print "address book length size.\n";
3834 print "Same setting is applied to personal and global file based address books.\n";
3836 print "It is strongly recommended to keep default setting value. Change it only\n";
3837 print "if you really want to store address book entries that are bigger than two\n";
3838 print "kilobytes (2048).\n";
3841 print "Enter allowed address book line length [$abook_file_line_length]: ";
3844 # value is not modified, if user hits Enter or enters space
3846 # make sure that input is numeric
3847 if ($tmp =~ /^\d+$/) {
3848 $abook_file_line_length = $tmp;
3850 print "If you want to change this setting, you must enter number.\n";
3851 print "If you want to keep original setting - enter space.\n\n";
3852 print "Press Enter to continue...";
3859 print "If you want to store your users address book details in a database then\n";
3860 print "you need to set this DSN to a valid value. The format for this is:\n";
3861 print "mysql://user:pass\@hostname/dbname\n";
3862 print "Where mysql can be one of the databases PHP supports, the most common\n";
3863 print "of these are mysql, msql and pgsql.\n";
3864 print "Please ensure proper permissions for config.php when including\n";
3865 print "sensitive passwords.\n\n";
3866 print "If the DSN is left empty (hit space and then return) the database\n";
3867 print "related code for address books will not be used.\n";
3870 if ( $addrbook_dsn eq "" ) {
3871 $default_value = "Disabled";
3873 $default_value = $addrbook_dsn;
3875 print "[$WHT$addrbook_dsn$NRM]: $WHT";
3877 if ( $new_dsn eq "\n" ) {
3880 $new_dsn =~ s/[\r\n]//g;
3881 $new_dsn =~ s/^\s+$//g;
3887 print "This is the name of the table you want to store the address book\n";
3888 print "data in, it defaults to 'address'\n";
3890 print "[$WHT$addrbook_table$NRM]: $WHT";
3891 $new_table = <STDIN
>;
3892 if ( $new_table eq "\n" ) {
3893 $new_table = $addrbook_table;
3895 $new_table =~ s/[\r\n]//g;
3901 print "If you want to store your users preferences in a database then\n";
3902 print "you need to set this DSN to a valid value. The format for this is:\n";
3903 print "mysql://user:pass\@hostname/dbname\n";
3904 print "Where mysql can be one of the databases PHP supports, the most common\n";
3905 print "of these are mysql, msql and pgsql.\n";
3906 print "Please ensure proper permissions for config.php when including\n";
3907 print "sensitive passwords.\n\n";
3908 print "If the DSN is left empty (hit space and then return) the database\n";
3909 print "related code for address books will not be used.\n";
3912 if ( $prefs_dsn eq "" ) {
3913 $default_value = "Disabled";
3915 $default_value = $prefs_dsn;
3917 print "[$WHT$prefs_dsn$NRM]: $WHT";
3919 if ( $new_dsn eq "\n" ) {
3922 $new_dsn =~ s/[\r\n]//g;
3923 $new_dsn =~ s/^\s+$//g;
3929 print "This is the name of the table you want to store the preferences\n";
3930 print "data in, it defaults to 'userprefs'\n";
3932 print "[$WHT$prefs_table$NRM]: $WHT";
3933 $new_table = <STDIN
>;
3934 if ( $new_table eq "\n" ) {
3935 $new_table = $prefs_table;
3937 $new_table =~ s/[\r\n]//g;
3943 print "This is the name of the field in which you want to store the\n";
3944 print "username of the person the prefs are for. It default to 'user'\n";
3945 print "which clashes with a reserved keyword in PostgreSQL so this\n";
3946 print "will need to be changed for that database at least\n";
3948 print "[$WHT$prefs_user_field$NRM]: $WHT";
3949 $new_field = <STDIN
>;
3950 if ( $new_field eq "\n" ) {
3951 $new_field = $prefs_user_field;
3953 $new_field =~ s/[\r\n]//g;
3955 $prefs_user_size = db_pref_size
($prefs_user_size);
3960 print "This is the name of the field in which you want to store the\n";
3961 print "preferences keyword. It defaults to 'prefkey'\n";
3963 print "[$WHT$prefs_key_field$NRM]: $WHT";
3964 $new_field = <STDIN
>;
3965 if ( $new_field eq "\n" ) {
3966 $new_field = $prefs_key_field;
3968 $new_field =~ s/[\r\n]//g;
3970 $prefs_key_size = db_pref_size
($prefs_key_size);
3975 print "This is the name of the field in which you want to store the\n";
3976 print "preferences value. It defaults to 'prefval'\n";
3978 print "[$WHT$prefs_val_field$NRM]: $WHT";
3979 $new_field = <STDIN
>;
3980 if ( $new_field eq "\n" ) {
3981 $new_field = $prefs_val_field;
3983 $new_field =~ s/[\r\n]//g;
3985 $prefs_val_size = db_pref_size
($prefs_val_size);
3989 # routine is used to set database field limits
3990 # it needs one argument
3991 sub db_pref_size
() {
3993 print "\nDatabase fields have size limits.\n";
3995 print "What limit is set for this field? [$WHT$size$NRM]: $WHT";
3996 $new_size = <STDIN
>;
3997 if ( $new_size eq "\n" ) {
4000 $new_size =~ s/[\r\n]//g;
4006 print "If you want to store your global address book in a database then\n";
4007 print "you need to set this DSN to a valid value. The format for this is:\n";
4008 print "mysql://user:pass\@hostname/dbname\n";
4009 print "Where mysql can be one of the databases PHP supports, the most common\n";
4010 print "of these are mysql, msql and pgsql.\n";
4011 print "Please ensure proper permissions for config.php when including\n";
4012 print "sensitive passwords.\n\n";
4013 print "If the DSN is left empty (hit space and then return) the database\n";
4014 print "related code for global SQL address book will not be used.\n";
4017 if ( $addrbook_global_dsn eq "" ) {
4018 $default_value = "Disabled";
4020 $default_value = $addrbook_global_dsn;
4022 print "[$WHT$addrbook_global_dsn$NRM]: $WHT";
4024 if ( $new_dsn eq "\n" ) {
4027 $new_dsn =~ s/[\r\n]//g;
4028 $new_dsn =~ s/^\s+$//g;
4034 print "This is the name of the table you want to store the global address book\n";
4035 print "data in. Default table name is 'global_abook'. Address book uses same\n";
4036 print "database format as personal address book.\n";
4038 print "[$WHT$addrbook_global_table$NRM]: $WHT";
4039 $new_table = <STDIN
>;
4040 if ( $new_table eq "\n" ) {
4041 $new_table = $addrbook_global_table;
4043 $new_table =~ s/[\r\n]//g;
4049 print "This option controls users\' ability to add or modify records stored \n";
4050 print "in global address book\n";
4052 if ( lc($addrbook_global_writeable) eq 'true' ) {
4053 $default_value = "y";
4055 $default_value = "n";
4057 print "Allow writing into global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
4058 $addrbook_global_writeable = <STDIN
>;
4059 if ( ( $addrbook_global_writeable =~ /^y\n/i ) || ( ( $addrbook_global_writeable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4060 $addrbook_global_writeable = 'true';
4062 $addrbook_global_writeable = 'false';
4064 return $addrbook_global_writeable;
4068 print "Enable this option if you want to see listing of addresses stored \n";
4069 print "in global address book\n";
4071 if ( lc($addrbook_global_listing) eq 'true' ) {
4072 $default_value = "y";
4074 $default_value = "n";
4076 print "Allow listing of global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
4077 $addrbook_global_listing = <STDIN
>;
4078 if ( ( $addrbook_global_listing =~ /^y\n/i ) || ( ( $addrbook_global_listing =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4079 $addrbook_global_listing = 'true';
4081 $addrbook_global_listing = 'false';
4083 return $addrbook_global_listing;
4089 print "SquirrelMail attempts to set the language in many ways. If it\n";
4090 print "can not figure it out in another way, it will default to this\n";
4091 print "language. Please use the code for the desired language.\n";
4093 print "[$WHT$squirrelmail_default_language$NRM]: $WHT";
4094 $new_squirrelmail_default_language = <STDIN
>;
4095 if ( $new_squirrelmail_default_language eq "\n" ) {
4096 $new_squirrelmail_default_language = $squirrelmail_default_language;
4098 $new_squirrelmail_default_language =~ s/[\r\n]//g;
4099 $new_squirrelmail_default_language =~ s/^\s+$//g;
4101 return $new_squirrelmail_default_language;
4105 print "This option controls what character set is used when sending\n";
4106 print "mail and when sending HTML to the browser. Option works only\n";
4107 print "with US English (en_US) translation. Other translations use\n";
4108 print "charsets that are set in translation settings.\n";
4111 print "[$WHT$default_charset$NRM]: $WHT";
4112 $new_default_charset = <STDIN
>;
4113 if ( $new_default_charset eq "\n" ) {
4114 $new_default_charset = $default_charset;
4116 $new_default_charset =~ s/[\r\n]//g;
4118 return $new_default_charset;
4120 # Alternative language names
4122 print "Enable this option if you want to see localized language names in\n";
4123 print "language selection box. Note, that this option can trigger\n";
4124 print "installation of foreign language support modules in some browsers.\n";
4127 if ( lc($show_alternative_names) eq 'true' ) {
4128 $default_value = "y";
4130 $default_value = "n";
4132 print "Show alternative language names? (y/n) [$WHT$default_value$NRM]: $WHT";
4133 $show_alternative_names = <STDIN
>;
4134 if ( ( $show_alternative_names =~ /^y\n/i ) || ( ( $show_alternative_names =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4135 $show_alternative_names = 'true';
4137 $show_alternative_names = 'false';
4139 return $show_alternative_names;
4142 # Aggressive decoding
4144 print "Enable this option if you want to use CPU and memory intensive decoding\n";
4145 print "functions. This option allows reading multibyte charset, that are used\n";
4146 print "in Eastern Asia. SquirrelMail will try to use recode functions here,\n";
4147 print "even when you have disabled use of recode in Tweaks section.\n";
4150 if ( lc($aggressive_decoding) eq 'true' ) {
4151 $default_value = "y";
4153 $default_value = "n";
4155 print "Enable aggressive decoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4156 $aggressive_decoding = <STDIN
>;
4157 if ( ( $aggressive_decoding =~ /^y\n/i ) || ( ( $aggressive_decoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4158 $aggressive_decoding = 'true';
4160 $aggressive_decoding = 'false';
4162 return $aggressive_decoding;
4167 print "Enable this option if you want to allow lossy charset encoding in message\n";
4168 print "composition pages. This option allows charset conversions when output\n";
4169 print "charset does not support all symbols used in original charset. Symbols\n";
4170 print "unsupported by output charset will be replaced with question marks.\n";
4173 if ( lc($lossy_encoding) eq 'true' ) {
4174 $default_value = "y";
4176 $default_value = "n";
4178 print "Enable lossy encoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4179 $lossy_encoding = <STDIN
>;
4180 if ( ( $lossy_encoding =~ /^y\n/i ) || ( ( $lossy_encoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4181 $lossy_encoding = 'true';
4183 $lossy_encoding = 'false';
4185 return $lossy_encoding;
4188 # display html emails in iframe
4190 print "This option can enable html email rendering inside iframe.\n";
4191 print "Inline frames are used in order to provide sandbox environment";
4192 print "for html code included in html formated emails.";
4193 print "Option is experimental and might have glitches in some parts of code.";
4196 if ( lc($use_iframe) eq 'true' ) {
4197 $default_value = "y";
4199 $default_value = "n";
4201 print "Display html emails in iframe? (y/n) [$WHT$default_value$NRM]: $WHT";
4202 $use_iframe = <STDIN
>;
4203 if ( ( $use_iframe =~ /^y\n/i ) || ( ( $use_iframe =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4204 $use_iframe = 'true';
4206 $use_iframe = 'false';
4212 sub command_ask_user_info
{
4213 print "New users need to supply their real name and email address to\n";
4214 print "send out proper mails. When this option is enabled, a user that\n";
4215 print "logs in for the first time will be redirected to the Personal\n";
4216 print "Options screen and asked to supply their personal data.\n";
4219 if ( lc($ask_user_info) eq 'true' ) {
4220 $default_value = "y";
4222 $default_value = "n";
4224 print "Ask user info? (y/n) [$WHT$default_value$NRM]: $WHT";
4225 $ask_user_info = <STDIN
>;
4226 if ( ( $ask_user_info =~ /^y\n/i ) || ( ( $ask_user_info =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4227 $ask_user_info = 'true';
4229 $ask_user_info = 'false';
4231 return $ask_user_info;
4236 print "Enabling this option will cause icons to be used instead of text\n";
4237 print "markers next to each message in mailbox lists that represent\n";
4238 print "new, read, flagged, and deleted messages, as well as those that\n";
4239 print "have been replied to and forwarded. Icons are also used next to\n";
4240 print "(un)expanded folders in the folder list (Oldway = false). These\n";
4241 print "icons are quite small, but will obviously be more of a resource\n";
4242 print "drain than text markers.\n";
4245 if ( lc($use_icons) eq 'true' ) {
4246 $default_value = "y";
4248 $default_value = "n";
4250 print "Use icons? (y/n) [$WHT$default_value$NRM]: $WHT";
4251 $use_icons = <STDIN
>;
4252 if ( ( $use_icons =~ /^y\n/i ) || ( ( $use_icons =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4253 $use_icons = 'true';
4255 $use_icons = 'false';
4261 print "Enable this option if you want to use php recode functions to read\n";
4262 print "emails written in charset that differs from the one that is set in\n";
4263 print "translation selected by user. Code is experimental, it might cause\n";
4264 print "errors, if email contains charset unsupported by recode or if your\n";
4265 print "php does not have recode support.\n";
4268 if ( lc($use_php_recode) eq 'true' ) {
4269 $default_value = "y";
4271 $default_value = "n";
4273 print "Use php recode functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4274 $use_php_recode = <STDIN
>;
4275 if ( ( $use_php_recode =~ /^y\n/i ) || ( ( $use_php_recode =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4276 $use_php_recode = 'true';
4278 $use_php_recode = 'false';
4280 return $use_php_recode;
4284 print "Enable this option if you want to use php iconv functions to read\n";
4285 print "emails written in charset that differs from the one that is set in\n";
4286 print "translation selected by user. Code is experimental, it works only\n";
4287 print "with translations that use utf-8 charset. Code might cause errors,\n";
4288 print "if email contains charset unsupported by iconv or if your php does\n";
4289 print "not have iconv support.\n";
4292 if ( lc($use_php_iconv) eq 'true' ) {
4293 $default_value = "y";
4295 $default_value = "n";
4297 print "Use php iconv functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4298 $use_php_iconv = <STDIN
>;
4299 if ( ( $use_php_iconv =~ /^y\n/i ) || ( ( $use_php_iconv =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4300 $use_php_iconv = 'true';
4302 $use_php_iconv = 'false';
4304 return $use_php_iconv;
4309 print "Enable this option if you want to check SquirrelMail configuration\n";
4310 print "remotely with configtest.php script.\n";
4313 if ( lc($allow_remote_configtest) eq 'true' ) {
4314 $default_value = "y";
4316 $default_value = "n";
4318 print "Allow remote configuration tests? (y/n) [$WHT$default_value$NRM]: $WHT";
4319 $allow_remote_configtest = <STDIN
>;
4320 if ( ( $allow_remote_configtest =~ /^y\n/i ) || ( ( $allow_remote_configtest =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4321 $allow_remote_configtest = 'true';
4323 $allow_remote_configtest = 'false';
4325 return $allow_remote_configtest;
4328 # Default Icon theme
4330 print "You may change the path to the default icon theme to be used, if icons\n";
4331 print "have been enabled. This theme will be used when an icon cannot be\n";
4332 print "found in the current theme, or when no icon theme is specified. If\n";
4333 print "left blank, and icons are enabled, the default theme will be used\n";
4334 print "from images/themes/default/.\n";
4336 print "To clear out an existing value, just type a space for the input.\n";
4338 print "Please be aware of the following: \n";
4339 print " - Relative URLs are relative to the config dir\n";
4340 print " to use the icon themes directory, use ../images/themes/newtheme/\n";
4341 print " - The icon theme may be outside the SquirrelMail directory, but\n";
4342 print " it must be web accessible.\n";
4343 print "[$WHT$icon_theme_def$NRM]: $WHT";
4344 $new_icon_theme_def = <STDIN
>;
4346 if ( $new_icon_theme_def eq "\n" ) {
4347 $new_icon_theme_def = $icon_theme_def;
4349 $new_icon_theme_def =~ s/[\r\n]//g;
4351 $new_icon_theme_def =~ s/^\s*//;
4352 return $new_icon_theme_def;
4355 # SquirrelMail debug mode (since 1.5.2)
4357 print "When debugging or developing SquirrelMail, you may want to increase\n";
4358 print "the verbosity of certain kinds of errors, notices, and/or diagnostics.\n";
4359 print "You may enable one or more of the debugging modes here. Please make\n";
4360 print "sure that you have turned off debugging if you are using SquirrelMail\n";
4361 print "in a production environment.\n\n";
4364 while ( $input ne "d\n" ) {
4365 $sm_debug_mode = convert_debug_constants_to_binary_integer
($sm_debug_mode);
4367 # per include/constants.php, here are the debug mode values:
4369 # 0 SM_DEBUG_MODE_OFF
4370 # 1 SM_DEBUG_MODE_SIMPLE
4371 # 512 SM_DEBUG_MODE_MODERATE
4372 # 524288 SM_DEBUG_MODE_ADVANCED
4373 # 536870912 SM_DEBUG_MODE_STRICT
4375 print "\n# Enabled? Description\n";
4376 print "---------------------------------------------------------------------\n";
4377 print "0 " . ($sm_debug_mode == 0 ?
"y" : " ")
4378 . " No debugging (recommended in production environments)\n";
4379 print "1 " . ($sm_debug_mode & 1 ?
"y" : " ")
4380 . " Simple debugging (PHP E_ERROR)\n";
4381 print "2 " . ($sm_debug_mode & 512 ?
"y" : " ")
4382 . " Moderate debugging (PHP E_ALL)\n";
4383 print "3 " . ($sm_debug_mode & 524288 ?
"y" : " ")
4384 . " Advanced debugging (PHP E_ALL plus log errors\n";
4385 print " intentionally suppressed)\n";
4386 print "4 " . ($sm_debug_mode & 536870912 ?
"y" : " ")
4387 . " Strict debugging (PHP E_STRICT)\n";
4390 print "SquirrelMail debug mode (0,1,2,3,4) or d when done? : $WHT";
4392 if ( $input eq "d\n" ) {
4394 } elsif ($input !~ /^[0-9]+\n$/) {
4395 print "\nInvalid configuration value.\n";
4396 print "\nPress enter to continue...";
4398 } elsif ( $input == "0\n" ) {
4400 } elsif ( $input == "1\n" ) {
4401 if ($sm_debug_mode & 1) {
4402 $sm_debug_mode ^= 1;
4404 $sm_debug_mode |= 1;
4406 } elsif ( $input == "2\n" ) {
4407 if ($sm_debug_mode & 512) {
4408 $sm_debug_mode ^= 512;
4410 $sm_debug_mode |= 512;
4412 } elsif ( $input == "3\n" ) {
4413 if ($sm_debug_mode & 524288) {
4414 $sm_debug_mode ^= 524288;
4416 $sm_debug_mode |= 524288;
4418 } elsif ( $input == "4\n" ) {
4419 if ($sm_debug_mode & 536870912) {
4420 $sm_debug_mode ^= 536870912;
4422 $sm_debug_mode |= 536870912;
4425 print "\nInvalid configuration value.\n";
4426 print "\nPress enter to continue...";
4431 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
4432 return $sm_debug_mode;
4435 # Secured configuration mode (since 1.5.2)
4437 print "This option allows you to enable \"Secured Configuration\" mode,\n";
4438 print "which will guarantee that certain settings made herein will be\n";
4439 print "made immutable and will not be subject to override by either friendly\n";
4440 print "or unfriendly code/plugins. Only a small number of settings herein\n";
4441 print "will be used in this manner - just those that are deemed to be a\n";
4442 print "potential security threat when rouge plugin or other code may be\n";
4443 print "executed inside SquirrelMail.\n";
4446 if ( lc($secured_config) eq 'true' ) {
4447 $default_value = "y";
4449 $default_value = "n";
4451 print "Enable secured configuration mode? (y/n) [$WHT$default_value$NRM]: $WHT";
4452 $secured_config = <STDIN
>;
4453 if ( ( $secured_config =~ /^y\n/i ) || ( ( $secured_config =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4454 $secured_config = 'true';
4456 $secured_config = 'false';
4458 return $secured_config;
4463 if ( open( CF
, ">config.php" ) ) {
4468 print CF
" * SquirrelMail Configuration File\n";
4469 print CF
" * Created using the configure script, conf.pl\n";
4473 if ($print_config_version) {
4474 print CF
"\$config_version = '$print_config_version';\n";
4477 print CF
"\$config_use_color = $config_use_color;\n";
4481 print CF
"\$org_name = \"$org_name\";\n";
4483 print CF
"\$org_logo = " . &change_to_SM_path
($org_logo) . ";\n";
4484 $org_logo_width |= 0;
4485 $org_logo_height |= 0;
4487 print CF
"\$org_logo_width = '$org_logo_width';\n";
4489 print CF
"\$org_logo_height = '$org_logo_height';\n";
4490 # string that can contain variables.
4491 print CF
"\$org_title = \"$org_title\";\n";
4493 print CF
"\$signout_page = " . &change_to_SM_path
($signout_page) . ";\n";
4495 print CF
"\$frame_top = '$frame_top';\n";
4498 print CF
"\$provider_uri = '$provider_uri';\n";
4501 print CF
"\$provider_name = '$provider_name';\n";
4504 # string that can contain variables
4505 print CF
"\$motd = \"$motd\";\n";
4509 print CF
"\$squirrelmail_default_language = '$squirrelmail_default_language';\n";
4511 print CF
"\$default_charset = '$default_charset';\n";
4513 print CF
"\$show_alternative_names = $show_alternative_names;\n";
4515 print CF
"\$aggressive_decoding = $aggressive_decoding;\n";
4517 print CF
"\$lossy_encoding = $lossy_encoding;\n";
4521 print CF
"\$domain = '$domain';\n";
4523 print CF
"\$imapServerAddress = '$imapServerAddress';\n";
4525 print CF
"\$imapPort = $imapPort;\n";
4527 print CF
"\$useSendmail = $useSendmail;\n";
4529 print CF
"\$smtpServerAddress = '$smtpServerAddress';\n";
4531 print CF
"\$smtpPort = $smtpPort;\n";
4533 print CF
"\$sendmail_path = '$sendmail_path';\n";
4535 print CF
"\$sendmail_args = '$sendmail_args';\n";
4537 # print CF "\$use_authenticated_smtp = $use_authenticated_smtp;\n";
4539 print CF
"\$pop_before_smtp = $pop_before_smtp;\n";
4541 print CF
"\$imap_server_type = '$imap_server_type';\n";
4543 print CF
"\$invert_time = $invert_time;\n";
4545 print CF
"\$optional_delimiter = '$optional_delimiter';\n";
4547 print CF
"\$encode_header_key = '$encode_header_key';\n";
4551 print CF
"\$default_folder_prefix = '$default_folder_prefix';\n";
4553 print CF
"\$trash_folder = '$trash_folder';\n";
4555 print CF
"\$sent_folder = '$sent_folder';\n";
4557 print CF
"\$draft_folder = '$draft_folder';\n";
4559 print CF
"\$default_move_to_trash = $default_move_to_trash;\n";
4561 print CF
"\$default_move_to_sent = $default_move_to_sent;\n";
4563 print CF
"\$default_save_as_draft = $default_save_as_draft;\n";
4565 print CF
"\$show_prefix_option = $show_prefix_option;\n";
4567 print CF
"\$list_special_folders_first = $list_special_folders_first;\n";
4569 print CF
"\$use_special_folder_color = $use_special_folder_color;\n";
4571 print CF
"\$auto_expunge = $auto_expunge;\n";
4573 print CF
"\$default_sub_of_inbox = $default_sub_of_inbox;\n";
4575 print CF
"\$show_contain_subfolders_option = $show_contain_subfolders_option;\n";
4577 print CF
"\$default_unseen_notify = $default_unseen_notify;\n";
4579 print CF
"\$default_unseen_type = $default_unseen_type;\n";
4581 print CF
"\$auto_create_special = $auto_create_special;\n";
4583 print CF
"\$delete_folder = $delete_folder;\n";
4585 print CF
"\$noselect_fix_enable = $noselect_fix_enable;\n";
4590 print CF
"\$data_dir = " . &change_to_SM_path
($data_dir) . ";\n";
4591 # string that can contain a variable
4592 print CF
"\$attachment_dir = " . &change_to_SM_path
($attachment_dir) . ";\n";
4594 print CF
"\$dir_hash_level = $dir_hash_level;\n";
4596 print CF
"\$default_left_size = '$default_left_size';\n";
4598 print CF
"\$force_username_lowercase = $force_username_lowercase;\n";
4600 print CF
"\$default_use_priority = $default_use_priority;\n";
4602 print CF
"\$hide_sm_attributions = $hide_sm_attributions;\n";
4604 print CF
"\$default_use_mdn = $default_use_mdn;\n";
4606 print CF
"\$edit_identity = $edit_identity;\n";
4608 print CF
"\$edit_name = $edit_name;\n";
4610 print CF
"\$hide_auth_header = $hide_auth_header;\n";
4612 print CF
"\$disable_thread_sort = $disable_thread_sort;\n";
4614 print CF
"\$disable_server_sort = $disable_server_sort;\n";
4616 print CF
"\$allow_charset_search = $allow_charset_search;\n";
4618 print CF
"\$allow_advanced_search = $allow_advanced_search;\n";
4621 print CF
"\$time_zone_type = $time_zone_type;\n";
4624 print CF
"\$config_location_base = '$config_location_base';\n";
4627 print CF
"\$disable_plugins = $disable_plugins;\n";
4629 print CF
"\$disable_plugins_user = '$disable_plugins_user';\n";
4632 # all plugins are strings
4633 for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
4634 print CF
"\$plugins[] = '$plugins[$ct]';\n";
4639 if ( $user_theme_default eq '' ) { $user_theme_default = '0'; }
4640 print CF
"\$user_theme_default = $user_theme_default;\n";
4642 for ( $count = 0 ; $count <= $#user_theme_name ; $count++ ) {
4643 if ($user_theme_path[$count] eq 'none') {
4646 $path = &change_to_SM_path
($user_theme_path[$count]);
4648 print CF
"\$user_themes[$count]['PATH'] = " . $path . ";\n";
4649 # escape theme name so it can contain single quotes.
4650 $esc_name = $user_theme_name[$count];
4651 $esc_name =~ s/\\/\\\\/g;
4652 $esc_name =~ s/'/\\'/g;
4653 print CF
"\$user_themes[$count]['NAME'] = '$esc_name';\n";
4657 if ( $icon_theme_def eq '' ) { $icon_theme_def = '0'; }
4658 print CF
"\$icon_theme_def = $icon_theme_def;\n";
4659 if ( $icon_theme_fallback eq '' ) { $icon_theme_fallback = '0'; }
4660 print CF
"\$icon_theme_fallback = $icon_theme_fallback;\n";
4662 for ( $count = 0 ; $count <= $#icon_theme_name ; $count++ ) {
4663 $path = $icon_theme_path[$count];
4664 if ($path eq 'none' || $path eq 'template') {
4665 $path = "'".$path."'";
4667 $path = &change_to_SM_path
($icon_theme_path[$count]);
4669 print CF
"\$icon_themes[$count]['PATH'] = " . $path . ";\n";
4670 # escape theme name so it can contain single quotes.
4671 $esc_name = $icon_theme_name[$count];
4672 $esc_name =~ s/\\/\\\\/g;
4673 $esc_name =~ s/'/\\'/g;
4674 print CF
"\$icon_themes[$count]['NAME'] = '$esc_name';\n";
4678 if ( $templateset_default eq '' ) { $templateset_default = 'default'; }
4679 print CF
"\$templateset_default = '$templateset_default';\n";
4681 if ( $templateset_fallback eq '' ) { $templateset_fallback = 'default'; }
4682 print CF
"\$templateset_fallback = '$templateset_fallback';\n";
4684 for ( $count = 0 ; $count <= $#templateset_name ; $count++ ) {
4685 print CF
"\$aTemplateSet[$count]['ID'] = '" . $templateset_id[$count] . "';\n";
4686 # escape theme name so it can contain single quotes.
4687 $esc_name = $templateset_name[$count];
4688 $esc_name =~ s/\\/\\\\/g;
4689 $esc_name =~ s/'/\\'/g;
4690 print CF
"\$aTemplateSet[$count]['NAME'] = '$esc_name';\n";
4696 print CF
"\$default_fontsize = '$default_fontsize';\n";
4698 print CF
"\$default_fontset = '$default_fontset';\n";
4700 # assoc. array (maybe initial value should be set somewhere else)
4701 print CF
'$fontsets = array();'."\n";
4702 while (($fontset_name, $fontset_value) = each(%fontsets)) {
4703 print CF
"\$fontsets\['$fontset_name'\] = '$fontset_value';\n";
4709 print CF
"\$default_use_javascript_addr_book = $default_use_javascript_addr_book;\n";
4710 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
4711 print CF
"\$ldap_server[$count] = array(\n";
4713 print CF
" 'host' => '$ldap_host[$count]',\n";
4715 print CF
" 'base' => '$ldap_base[$count]'";
4716 if ( $ldap_name[$count] ) {
4719 print CF
" 'name' => '$ldap_name[$count]'";
4721 if ( $ldap_port[$count] ) {
4724 print CF
" 'port' => $ldap_port[$count]";
4726 if ( $ldap_charset[$count] ) {
4729 print CF
" 'charset' => '$ldap_charset[$count]'";
4731 if ( $ldap_maxrows[$count] ) {
4734 print CF
" 'maxrows' => $ldap_maxrows[$count]";
4737 if ( $ldap_filter[$count] ) {
4739 print CF
" 'filter' => '$ldap_filter[$count]'";
4741 if ( $ldap_binddn[$count] ) {
4744 print CF
" 'binddn' => '$ldap_binddn[$count]'";
4745 if ( $ldap_bindpw[$count] ) {
4748 print CF
" 'bindpw' => '$ldap_bindpw[$count]'";
4751 if ( $ldap_protocol[$count] ) {
4754 print CF
" 'protocol' => $ldap_protocol[$count]";
4756 if ( $ldap_limit_scope[$count] ) {
4759 print CF
" 'limit_scope' => $ldap_limit_scope[$count]";
4761 if ( $ldap_listing[$count] ) {
4764 print CF
" 'listing' => $ldap_listing[$count]";
4766 if ( $ldap_writeable[$count] ) {
4769 print CF
" 'writeable' => $ldap_writeable[$count]";
4771 if ( $ldap_search_tree[$count] ) {
4774 print CF
" 'search_tree' => $ldap_search_tree[$count]";
4776 if ( $ldap_listing[$count] ) {
4779 print CF
" 'starttls' => $ldap_starttls[$count]";
4787 print CF
"\$addrbook_dsn = '$addrbook_dsn';\n";
4789 print CF
"\$addrbook_table = '$addrbook_table';\n\n";
4791 print CF
"\$prefs_dsn = '$prefs_dsn';\n";
4793 print CF
"\$prefs_table = '$prefs_table';\n";
4795 print CF
"\$prefs_user_field = '$prefs_user_field';\n";
4797 print CF
"\$prefs_user_size = $prefs_user_size;\n";
4799 print CF
"\$prefs_key_field = '$prefs_key_field';\n";
4801 print CF
"\$prefs_key_size = $prefs_key_size;\n";
4803 print CF
"\$prefs_val_field = '$prefs_val_field';\n";
4805 print CF
"\$prefs_val_size = $prefs_val_size;\n\n";
4807 print CF
"\$addrbook_global_dsn = '$addrbook_global_dsn';\n";
4809 print CF
"\$addrbook_global_table = '$addrbook_global_table';\n";
4811 print CF
"\$addrbook_global_writeable = $addrbook_global_writeable;\n";
4813 print CF
"\$addrbook_global_listing = $addrbook_global_listing;\n\n";
4815 print CF
"\$abook_global_file = '$abook_global_file';\n";
4817 print CF
"\$abook_global_file_writeable = $abook_global_file_writeable;\n\n";
4819 print CF
"\$abook_global_file_listing = $abook_global_file_listing;\n\n";
4821 print CF
"\$abook_file_line_length = $abook_file_line_length;\n\n";
4823 print CF
"\$no_list_for_subscribe = $no_list_for_subscribe;\n";
4826 print CF
"\$smtp_auth_mech = '$smtp_auth_mech';\n";
4827 print CF
"\$smtp_sitewide_user = '". quote_single
($smtp_sitewide_user) ."';\n";
4828 print CF
"\$smtp_sitewide_pass = '". quote_single
($smtp_sitewide_pass) ."';\n";
4830 print CF
"\$imap_auth_mech = '$imap_auth_mech';\n";
4832 print CF
"\$use_imap_tls = $use_imap_tls;\n";
4834 print CF
"\$use_smtp_tls = $use_smtp_tls;\n";
4836 print CF
"\$session_name = '$session_name';\n";
4838 print CF
"\$only_secure_cookies = $only_secure_cookies;\n";
4843 print CF
"\$use_iframe = $use_iframe;\n";
4845 print CF
"\$ask_user_info = $ask_user_info;\n";
4847 print CF
"\$use_icons = $use_icons;\n";
4850 print CF
"\$use_php_recode = $use_php_recode;\n";
4852 print CF
"\$use_php_iconv = $use_php_iconv;\n";
4855 print CF
"\$allow_remote_configtest = $allow_remote_configtest;\n";
4856 print CF
"\$secured_config = $secured_config;\n";
4857 # (binary) integer or constant - convert integer
4858 # values to constants before output
4859 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
4860 print CF
"\$sm_debug_mode = $sm_debug_mode;\n";
4865 print "Data saved in config.php\n";
4867 build_plugin_hook_array
();
4870 print "Error saving config.php: $!\n";
4876 print $WHT. "SquirrelMail Configuration : " . $NRM;
4877 if ( $config == 1 ) { print "Read: config.php"; }
4878 elsif ( $config == 2 ) { print "Read: config_default.php"; }
4880 print "---------------------------------------------------------\n";
4882 print "While we have been building SquirrelMail, we have discovered some\n";
4883 print "preferences that work better with some servers that don't work so\n";
4884 print "well with others. If you select your IMAP server, this option will\n";
4885 print "set some pre-defined settings for that server.\n";
4887 print "Please note that you will still need to go through and make sure\n";
4888 print "everything is correct. This does not change everything. There are\n";
4889 print "only a few settings that this will change.\n";
4893 while ( $continue != 1 ) {
4894 print "Please select your IMAP server:\n";
4895 print $list_supported_imap_servers;
4897 print " quit = Do not change anything\n";
4899 print "Command >> ";
4901 $server =~ s/[\r\n]//g;
4903 # variable is used to display additional messages.
4907 if ( $server eq "cyrus" ) {
4908 $imap_server_type = "cyrus";
4909 $default_folder_prefix = "";
4910 $trash_folder = "INBOX.Trash";
4911 $sent_folder = "INBOX.Sent";
4912 $draft_folder = "INBOX.Drafts";
4913 $show_prefix_option = false
;
4914 $default_sub_of_inbox = true
;
4915 $show_contain_subfolders_option = false
;
4916 $optional_delimiter = ".";
4917 $disp_default_folder_prefix = "<none>";
4918 $force_username_lowercase = false
;
4920 # Delimiter might differ if unixhierarchysep is set to yes.
4921 $message = "\nIf you have enabled unixhierarchysep, you must change delimiter and special folder names.\n";
4924 } elsif ( $server eq "uw" ) {
4925 $imap_server_type = "uw";
4926 $default_folder_prefix = "mail/";
4927 $trash_folder = "Trash";
4928 $sent_folder = "Sent";
4929 $draft_folder = "Drafts";
4930 $show_prefix_option = true
;
4931 $default_sub_of_inbox = false
;
4932 $show_contain_subfolders_option = true
;
4933 $optional_delimiter = "/";
4934 $disp_default_folder_prefix = $default_folder_prefix;
4935 $delete_folder = true
;
4936 $force_username_lowercase = true
;
4939 } elsif ( $server eq "exchange" ) {
4940 $imap_server_type = "exchange";
4941 $default_folder_prefix = "";
4942 $default_sub_of_inbox = true
;
4943 $trash_folder = "INBOX/Deleted Items";
4944 $sent_folder = "INBOX/Sent Items";
4945 $drafts_folder = "INBOX/Drafts";
4946 $show_prefix_option = false
;
4947 $show_contain_subfolders_option = false
;
4948 $optional_delimiter = "detect";
4949 $disp_default_folder_prefix = "<none>";
4950 $force_username_lowercase = true
;
4953 } elsif ( $server eq "courier" ) {
4954 $imap_server_type = "courier";
4955 $default_folder_prefix = "INBOX.";
4956 $trash_folder = "Trash";
4957 $sent_folder = "Sent";
4958 $draft_folder = "Drafts";
4959 $show_prefix_option = false
;
4960 $default_sub_of_inbox = false
;
4961 $show_contain_subfolders_option = false
;
4962 $optional_delimiter = ".";
4963 $disp_default_folder_prefix = $default_folder_prefix;
4964 $delete_folder = true
;
4965 $force_username_lowercase = false
;
4968 } elsif ( $server eq "macosx" ) {
4969 $imap_server_type = "macosx";
4970 $default_folder_prefix = "INBOX/";
4971 $trash_folder = "Trash";
4972 $sent_folder = "Sent";
4973 $draft_folder = "Drafts";
4974 $show_prefix_option = false
;
4975 $default_sub_of_inbox = true
;
4976 $show_contain_subfolders_option = false
;
4977 $optional_delimiter = "detect";
4978 $allow_charset_search = false
;
4979 $disp_default_folder_prefix = $default_folder_prefix;
4982 } elsif ( $server eq "hmailserver" ) {
4983 $imap_server_type = "hmailserver";
4984 $default_folder_prefix = "";
4985 $trash_folder = "INBOX.Trash";
4986 $sent_folder = "INBOX.Sent";
4987 $draft_folder = "INBOX.Drafts";
4988 $show_prefix_option = false
;
4989 $default_sub_of_inbox = true
;
4990 $show_contain_subfolders_option = false
;
4991 $optional_delimiter = "detect";
4992 $allow_charset_search = false
;
4993 $disp_default_folder_prefix = $default_folder_prefix;
4994 $delete_folder = false
;
4995 $force_username_lowercase = false
;
4998 } elsif ( $server eq "mercury32" ) {
4999 $imap_server_type = "mercury32";
5000 $default_folder_prefix = "";
5001 $trash_folder = "Trash";
5002 $sent_folder = "Sent";
5003 $draft_folder = "Drafts";
5004 $show_prefix_option = false
;
5005 $default_sub_of_inbox = true
;
5006 $show_contain_subfolders_option = true
;
5007 $optional_delimiter = "detect";
5008 $delete_folder = true
;
5009 $force_username_lowercase = true
;
5012 } elsif ( $server eq "dovecot" ) {
5013 $imap_server_type = "dovecot";
5014 $default_folder_prefix = "";
5015 $trash_folder = "Trash";
5016 $sent_folder = "Sent";
5017 $draft_folder = "Drafts";
5018 $show_prefix_option = false
;
5019 $default_sub_of_inbox = false
;
5020 $show_contain_subfolders_option = false
;
5021 $delete_folder = false
;
5022 $force_username_lowercase = true
;
5023 $optional_delimiter = "detect";
5024 $disp_default_folder_prefix = "<none>";
5027 } elsif ( $server eq "bincimap" ) {
5028 $imap_server_type = "bincimap";
5029 $default_folder_prefix = "INBOX/";
5030 $trash_folder = "Trash";
5031 $sent_folder = "Sent";
5032 $draft_folder = "Drafts";
5033 $show_prefix_option = false
;
5034 $default_sub_of_inbox = false
;
5035 $show_contain_subfolders_option = false
;
5036 $delete_folder = true
;
5037 $force_username_lowercase = false
;
5038 $optional_delimiter = "detect";
5039 $disp_default_folder_prefix = $default_folder_prefix;
5041 # Default folder prefix depends on used depot.
5042 $message = "\nIf you use IMAPdir depot, you must set default folder prefix to empty string.\n";
5045 } elsif ( $server eq "quit" ) {
5048 $disp_default_folder_prefix = $default_folder_prefix;
5049 print "Unrecognized server: $server\n";
5053 print " imap_server_type = $imap_server_type\n";
5054 print " default_folder_prefix = $disp_default_folder_prefix\n";
5055 print " trash_folder = $trash_folder\n";
5056 print " sent_folder = $sent_folder\n";
5057 print " draft_folder = $draft_folder\n";
5058 print " show_prefix_option = $show_prefix_option\n";
5059 print " default_sub_of_inbox = $default_sub_of_inbox\n";
5060 print "show_contain_subfolders_option = $show_contain_subfolders_option\n";
5061 print " optional_delimiter = $optional_delimiter\n";
5062 print " delete_folder = $delete_folder\n";
5063 print " force_username_lowercase = $force_username_lowercase\n";
5067 print "\nPress enter to continue...";
5071 # This subroutine corrects relative paths to ensure they
5072 # will work within the SM space. If the path falls within
5073 # the SM directory tree, the SM_PATH variable will be
5074 # prepended to the path, if not, then the path will be
5075 # converted to an absolute path, e.g.
5076 # '../images/logo.gif' --> SM_PATH . 'images/logo.gif'
5077 # '../../someplace/data' --> '/absolute/path/someplace/data'
5078 # 'images/logo.gif' --> SM_PATH . 'config/images/logo.gif'
5079 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
5080 # 'http://whatever/' --> 'http://whatever'
5081 # $some_var/path --> "$some_var/path"
5082 sub change_to_SM_path
() {
5083 my ($old_path) = @_;
5089 # If the path is absolute, don't bother.
5090 return "\'" . $old_path . "\'" if ( $old_path eq '');
5091 return "\'" . $old_path . "\'" if ( $old_path =~ /^(\/|http
)/ );
5092 return "\'" . $old_path . "\'" if ( $old_path =~ /^\w:\// );
5093 return $old_path if ( $old_path =~ /^\'(\/|http
)/ );
5094 return $old_path if ( $old_path =~ /^\'\w:\// );
5095 return $old_path if ( $old_path =~ /^SM_PATH/);
5097 if ( $old_path =~ /^\$/ ) {
5098 # check if it's a single var, or a $var/path combination
5099 # if it's $var/path, enclose in ""
5100 if ( $old_path =~ /\// ) {
5101 return '"'.$old_path.'"';
5106 # Remove remaining '
5107 $old_path =~ s/\'//g;
5109 # For relative paths, split on '../'
5110 @rel_path = split(/\.\.\//, $old_path);
5112 if ( $#rel_path > 1 ) {
5113 # more than two levels away. Make it absolute.
5114 @abs_path = split(/\//, $dir);
5116 # Lop off the relative pieces of the absolute path..
5117 for ( $i = 0; $i <= $#rel_path; $i++ ) {
5121 push @abs_path, @rel_path;
5122 $new_path = "\'" . join('/', @abs_path) . "\'";
5123 } elsif ( $#rel_path > 0 ) {
5124 # it's within the SM tree, prepend SM_PATH
5125 $new_path = $old_path;
5126 $new_path =~ s/^\.\.\//SM_PATH
. \'/;
5129 # Last, it's a relative path without any leading '.'
5130 # Prepend SM_PATH and config, since the paths are
5131 # relative to the config directory
5132 $new_path = "SM_PATH . \'config/" . $old_path . "\'";
5138 # Change SM_PATH to admin-friendly version, e.g.:
5139 # SM_PATH . 'images/logo.gif' --> '../images/logo.gif'
5140 # SM_PATH . 'config/some.php' --> 'some.php'
5141 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
5142 # 'http://whatever/' --> 'http://whatever'
5143 sub change_to_rel_path
() {
5144 my ($old_path) = @_;
5145 my $new_path = $old_path;
5147 if ( $old_path =~ /^SM_PATH/ ) {
5148 # FIXME: the following replacement loses the opening quote mark!
5149 $new_path =~ s/^SM_PATH . \'/\.\.\//;
5150 $new_path =~ s/\.\.\/config\///;
5156 # Attempts to auto-detect if a specific auth mechanism is supported.
5157 # Called by 'command112a' and 'command112b'
5158 # ARGS: service-name (IMAP or SMTP), host:port, mech-name (ie. CRAM-MD5)
5159 sub detect_auth_support
{
5160 # Try loading IO::Socket
5161 unless (eval("use IO::Socket; 1")) {
5162 print "Perl IO::Socket module is not available.";
5166 my $service = shift;
5170 if ((!defined($service)) or (!defined($host)) or (!defined($mech))) {
5171 # Error - wrong # of args
5172 print "BAD ARGS!\n";
5176 if ($service eq 'SMTP') {
5177 $cmd = "AUTH $mech\r\n";
5178 $logout = "QUIT\r\n";
5179 } elsif ($service eq 'IMAP') {
5180 $cmd = "A01 AUTHENTICATE $mech\n";
5181 $logout = "C01 LOGOUT\n";
5183 # unknown service - whoops.
5187 # Get this show on the road
5188 my $sock=IO
::Socket
::INET
->new($host);
5189 if (!defined($sock)) {
5193 my $discard = <$sock>; # Server greeting/banner - who cares..
5195 if ($service eq 'SMTP') {
5197 print $sock "HELO $domain\r\n";
5198 $discard = <$sock>; # Yeah yeah, you're happy to see me..
5202 my $response = <$sock>;
5204 if (!defined($response)) {
5208 # So at this point, we have a response, and it is (hopefully) valid.
5209 if ($service eq 'SMTP') {
5210 if (!($response =~ /^334/)) {
5212 print $sock $logout;
5216 } elsif ($service eq 'IMAP') {
5217 if ($response =~ /^A01/) {
5219 print $sock $logout;
5224 # Unknown service - this shouldn't be able to happen.
5229 # If it gets here, the mech is supported
5230 print $sock "*\n"; # Attempt to cancel authentication
5231 print $sock $logout; # Try to log out, but we don't really care if this fails
5237 # Example code from O'Reilly Perl Cookbook
5244 return wantarray ?
@out : $out[0];
5247 sub clear_screen
() {
5248 if ( $^O
=~ /^mswin/i) {
5255 # checks IMAP mailbox name. Refuses to accept 8bit folders
5256 # returns 0 (folder name is not correct) or 1 (folder name is correct)
5257 sub check_imap_folder
($) {
5258 my $folder_name = shift(@_);
5260 if ($folder_name =~ /[\x80-\xFFFF]/) {
5261 print "Folder name contains 8bit characters. Configuration utility requires\n";
5262 print "UTF7-IMAP encoded folder names.\n";
5263 print "Press enter to continue...";
5266 } elsif ($folder_name =~ /[&\*\%]/) {
5267 # check for ampersand and list-wildcards
5268 print "Folder name contains special UTF7-IMAP characters.\n";
5269 print "Are you sure that folder name is correct? (y/N): ";
5271 $tmp = lc(trim
($tmp));
5272 if ($tmp =~ /^y$/) {
5282 # quotes string written in single quotes
5283 sub quote_single
($) {
5284 my $string = shift(@_);
5285 $string =~ s/\'/\\'/g;
5289 # determine a plugin's version number
5291 # parses the setup.php file, looking for the
5292 # version string in the <plugin>_info() or the
5293 # <plugin>_version functions.
5295 sub get_plugin_version
() {
5297 my $plugin_name = shift(@_);
5299 $setup_file = '../plugins/' . $plugin_name . '/setup.php';
5300 if ( -e
"$setup_file" ) {
5301 # Make sure that file is readable
5302 if (! -r
"$setup_file") {
5305 print "The file \"$setup_file\" was found, but you don't\n";
5306 print "have rights to read it. The plugin \"";
5307 print $plugin_name . "\" may not work correctly until you fix this.\n";
5308 print "\nPress enter to continue";
5315 # FIXME: grep the file instead of reading it into memory?
5317 open( FILE
, "$setup_file" );
5318 while ( $line = <FILE
> ) {
5319 $whole_file .= $line;
5323 # ideally, there is a version in the <plugin>_info function...
5325 if ($whole_file =~ /('version'\s*=>\s*['"](.*?)['"])/) {
5328 # this assumes there is only one function that returns
5329 # a static string in the setup file
5331 } elsif ($whole_file =~ /(return\s*['"](.*?)['"])/) {
5340 print "The file \"$setup_file\" was not found.\n";
5341 print "The plugin \"" . $plugin_name;
5342 print "\" may not work correctly until you fix this.\n";
5343 print "\nPress enter to continue";
5351 # determine a plugin's English name
5353 # parses the setup.php file, looking for the
5354 # English name in the <plugin>_info() function.
5356 sub get_plugin_english_name
() {
5358 my $plugin_name = shift(@_);
5360 $setup_file = '../plugins/' . $plugin_name . '/setup.php';
5361 if ( -e
"$setup_file" ) {
5362 # Make sure that file is readable
5363 if (! -r
"$setup_file") {
5366 print "The file \"$setup_file\" was found, but you don't\n";
5367 print "have rights to read it. The plugin \"";
5368 print $plugin_name . "\" may not work correctly until you fix this.\n";
5369 print "\nPress enter to continue";
5376 # FIXME: grep the file instead of reading it into memory?
5378 open( FILE
, "$setup_file" );
5379 while ( $line = <FILE
> ) {
5380 $whole_file .= $line;
5384 # the English name is in the <plugin>_info function or nothing...
5386 if ($whole_file =~ /('english_name'\s*=>\s*['"](.*?)['"])/) {
5387 $english_name .= $2;
5390 return $english_name;
5395 print "The file \"$setup_file\" was not found.\n";
5396 print "The plugin \"" . $plugin_name;
5397 print "\" may not work correctly until you fix this.\n";
5398 print "\nPress enter to continue";
5406 # parses the setup.php files for all activated plugins and
5407 # builds static plugin hooks array so we don't have to load
5408 # ALL plugins are runtime and build the hook array on every
5411 # hook array is saved in config/plugin_hooks.php
5413 # Note the $verbose variable at the top of this routine
5414 # can be set to zero to quiet it down.
5416 # NOTE/FIXME: we aren't necessarily interested in writing
5417 # a full-blown PHP parsing engine, so plenty
5418 # of assumptions are included herein about the
5419 # coding of the plugin setup files, and things
5420 # like commented out curly braces or other
5421 # such oddities can break this in a bad way.
5423 sub build_plugin_hook_array
() {
5431 if ( open( HOOKFILE
, ">plugin_hooks.php" ) ) {
5432 print HOOKFILE
"<?php\n";
5433 print HOOKFILE
"\n";
5435 print HOOKFILE
"/**\n";
5436 print HOOKFILE
" * SquirrelMail Plugin Hook Registration File\n";
5437 print HOOKFILE
" * Auto-generated using the configure script, conf.pl\n";
5438 print HOOKFILE
" */\n";
5439 print HOOKFILE
"\n";
5440 print HOOKFILE
"global \$squirrelmail_plugin_hooks;\n";
5441 print HOOKFILE
"\n";
5443 PLUGIN
: for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
5446 print "Activating plugin \"" . $plugins[$ct] . "\"...\n";
5449 $setup_file = '../plugins/' . $plugins[$ct] . '/setup.php';
5450 if ( -e
"$setup_file" ) {
5451 # Make sure that file is readable
5452 if (! -r
"$setup_file") {
5455 print "The file \"$setup_file\" was found, but you don't\n";
5456 print "have rights to read it. The plugin \"";
5457 print $plugins[$ct] . "\" will not be activated until you fix this.\n";
5458 print "\nPress enter to continue";
5463 open( FILE
, "$setup_file" );
5464 $inside_init_fxn = 0;
5466 while ( $line = <FILE
> ) {
5468 # throw away lines until we get to target function
5470 if (!$inside_init_fxn
5471 && $line !~ /^\s*function\s*squirrelmail_plugin_init_/i) {
5474 $inside_init_fxn = 1;
5484 # count close braces
5489 # leaving <plugin>_init() function...
5490 if ($brace_count == 0) {
5498 # throw away lines that are not exactly one "brace set" deep
5500 if ($brace_count > 1) {
5505 # also not interested in lines that are not
5506 # hook registration points
5508 if ($line !~ /^\s*\$squirrelmail_plugin_hooks/i) {
5513 # if $line does not have an ending semicolon,
5514 # we need to recursively read in subsequent
5515 # lines until we find one
5516 while ( $line !~ /;\s*$/ ) {
5517 $line =~ s/[\n\r]\s*$//;
5526 $var =~ s/=/EQUALS/;
5527 if ( $var =~ /^([a-z])/i ) {
5528 @options = split ( /\s*EQUALS\s*/, $var );
5529 $options[1] =~ s/[\n\r]//g;
5530 $options[1] =~ s/[\'\"];\s*$//;
5531 $options[1] =~ s/;$//;
5532 $options[1] =~ s/^[\'\"]//;
5533 # de-escape escaped strings
5534 $options[1] =~ s/\\'/'/g;
5535 $options[1] =~ s/\\\\/\\/g;
5537 if ( $options[0] =~ /^squirrelmail_plugin_hooks\s*\[\s*['"]([a-z0-9 \/._
*-]+)['"]\s*\]\s*\[\s*['"]([0-9a-z._-]+)['"]\s
*\
]/i
) {
5539 $hooked_plugin_name = $2;
5540 # Note: if we wanted to stop plugins from registering
5541 # a *different* plugin on a hook, we could catch
5542 # it here, however this has actually proven to be
5543 # a useful *feature*
5544 #if ($hooked_plugin_name ne $plugins[$ct]) {
5545 # print "...plugin is tring to hook in under different name...\n";
5548 #FIXME: do we want to count the number of hook registrations for each plugin and warn if a plugin doesn't have any?
5549 # hook registration has been found!
5551 if ($hooked_plugin_name ne $plugins[$ct]) {
5552 print " registering on hook \"" . $hook_name . "\" (as \"$hooked_plugin_name\" plugin)\n";
5554 print " registering on hook \"" . $hook_name . "\"\n";
5557 $line =~ s/ {2,}/ /g;
5559 print HOOKFILE
"\$$line";
5571 print "The file \"$setup_file\" was not found.\n";
5572 print "The plugin \"" . $plugins[$ct];
5573 print "\" will not be activated until you fix this.\n";
5574 print "\nPress enter to continue";
5582 print HOOKFILE
"\n\n";
5585 print "\nDone activating plugins; registration data saved in plugin_hooks.php\n\n";
5592 print "The file \"plugin_hooks.php\" was not able to be written to.\n";
5593 print "No plugins will be activated until you fix this.\n";
5594 print "\nPress enter to continue";
5602 # converts (binary) integer values that correspond
5603 # to the SquirrelMail debug mode constants (see
5604 # include/constants.php) into those constant strings
5605 # (bitwise or'd if more than one is enabled)
5607 # if the value passed in is not an integer, it is
5608 # returned unmolested
5610 sub convert_debug_binary_integer_to_constants
() {
5612 my ($debug_mode) = @_;
5613 if ($debug_mode =~ /^[^0-9]/) {
5616 $debug_mode = int($debug_mode);
5617 $new_debug_mode = '';
5619 # per include/constants.php, here are their values:
5621 # 0 SM_DEBUG_MODE_OFF
5622 # 1 SM_DEBUG_MODE_SIMPLE
5623 # 512 SM_DEBUG_MODE_MODERATE
5624 # 524288 SM_DEBUG_MODE_ADVANCED
5625 # 536870912 SM_DEBUG_MODE_STRICT
5627 if ($debug_mode & 1) {
5628 $new_debug_mode .= ' | SM_DEBUG_MODE_SIMPLE';
5630 if ($debug_mode & 512) {
5631 $new_debug_mode .= ' | SM_DEBUG_MODE_MODERATE';
5633 if ($debug_mode & 524288) {
5634 $new_debug_mode .= ' | SM_DEBUG_MODE_ADVANCED';
5636 if ($debug_mode & 536870912) {
5637 $new_debug_mode .= ' | SM_DEBUG_MODE_STRICT';
5640 $new_debug_mode =~ s/^ \| //;
5641 if (!$new_debug_mode) {
5642 $new_debug_mode = 'SM_DEBUG_MODE_OFF';
5645 return $new_debug_mode;
5648 # converts SquirrelMail debug mode constants (see
5649 # include/constants.php) into their corresponding
5650 # (binary) integer values
5652 # if the value passed in is an integer already, it
5653 # is returned unmolested
5655 sub convert_debug_constants_to_binary_integer
() {
5657 my ($debug_mode) = @_;
5658 if ($debug_mode =~ /^[0-9]/) {
5661 $new_debug_mode = 0;
5663 # per include/constants.php, here are their values:
5665 # 0 SM_DEBUG_MODE_OFF
5666 # 1 SM_DEBUG_MODE_SIMPLE
5667 # 512 SM_DEBUG_MODE_MODERATE
5668 # 524288 SM_DEBUG_MODE_ADVANCED
5669 # 536870912 SM_DEBUG_MODE_STRICT
5671 if ($debug_mode =~ /\bSM_DEBUG_MODE_OFF\b/) {
5672 $new_debug_mode = 0;
5674 if ($debug_mode =~ /\bSM_DEBUG_MODE_SIMPLE\b/) {
5675 $new_debug_mode |= 1;
5677 if ($debug_mode =~ /\bSM_DEBUG_MODE_MODERATE\b/) {
5678 $new_debug_mode |= 512;
5680 if ($debug_mode =~ /\bSM_DEBUG_MODE_ADVANCED\b/) {
5681 $new_debug_mode |= 524288;
5683 if ($debug_mode =~ /\bSM_DEBUG_MODE_STRICT\b/) {
5684 $new_debug_mode |= 536870912;
5687 return $new_debug_mode;