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, save sent messages : $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 (save sent messages)
1944 print "By default, should copies of outgoing messages get saved in the\n";
1945 print "sent folder? You can specify the default sent folder in option 4.\n";
1946 print "If this is set to false, messages will get sent and no copy will\n";
1949 print "Sent folder is currently: $sent_folder\n";
1952 if ( lc($default_move_to_sent) eq 'true' ) {
1953 $default_value = "y";
1955 $default_value = "n";
1957 print "By default, save sent messages (y/n) [$WHT$default_value$NRM]: $WHT";
1958 $new_show = <STDIN
>;
1959 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1960 $default_move_to_sent = 'true';
1962 $default_move_to_sent = 'false';
1964 return $default_move_to_sent;
1967 # default save as draft
1969 print "By default, should the save to draft option be shown? You can\n";
1970 print "specify the default drafts folder in option 5. If this is set\n";
1971 print "to false, users will not be shown the save to draft option.\n";
1973 print "Drafts folder is currently: $draft_folder\n";
1976 if ( lc($default_save_as_draft) eq 'true' ) {
1977 $default_value = "y";
1979 $default_value = "n";
1981 print "By default, save as draft (y/n) [$WHT$default_value$NRM]: $WHT";
1982 $new_show = <STDIN
>;
1983 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1984 $default_save_as_draft = 'true';
1986 $default_save_as_draft = 'false';
1988 return $default_save_as_draft;
1991 # List special folders first
1993 print "SquirrelMail has what we call 'special folders' that are not\n";
1994 print "manipulated and viewed like normal folders. Some examples of\n";
1995 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
1996 print "Simply asks if you want these folders listed first in the folder\n";
2000 if ( lc($list_special_folders_first) eq 'true' ) {
2001 $default_value = "y";
2003 $default_value = "n";
2006 print "List first (y/n) [$WHT$default_value$NRM]: $WHT";
2007 $new_show = <STDIN
>;
2008 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2009 $list_special_folders_first = 'true';
2011 $list_special_folders_first = 'false';
2013 return $list_special_folders_first;
2016 # Show special folders color
2018 print "SquirrelMail has what we call 'special folders' that are not\n";
2019 print "manipulated and viewed like normal folders. Some examples of\n";
2020 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
2021 print "wants to know if we should display special folders in a\n";
2022 print "color than the other folders.\n";
2025 if ( lc($use_special_folder_color) eq 'true' ) {
2026 $default_value = "y";
2028 $default_value = "n";
2031 print "Show color (y/n) [$WHT$default_value$NRM]: $WHT";
2032 $new_show = <STDIN
>;
2033 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2034 $use_special_folder_color = 'true';
2036 $use_special_folder_color = 'false';
2038 return $use_special_folder_color;
2043 print "The way that IMAP handles deleting messages is as follows. You\n";
2044 print "mark the message as deleted, and then to 'really' delete it, you\n";
2045 print "expunge it. This option asks if you want to just have messages\n";
2046 print "marked as deleted, or if you want SquirrelMail to expunge the \n";
2047 print "messages too.\n";
2050 if ( lc($auto_expunge) eq 'true' ) {
2051 $default_value = "y";
2053 $default_value = "n";
2055 print "Auto expunge (y/n) [$WHT$default_value$NRM]: $WHT";
2056 $new_show = <STDIN
>;
2057 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2058 $auto_expunge = 'true';
2060 $auto_expunge = 'false';
2062 return $auto_expunge;
2065 # Default sub of inbox
2067 print "Some IMAP servers (Cyrus) have all folders as subfolders of INBOX.\n";
2068 print "This can cause some confusion in folder creation for users when\n";
2069 print "they try to create folders and don't put it as a subfolder of INBOX\n";
2070 print "and get permission errors. This option asks if you want folders\n";
2071 print "to be subfolders of INBOX by default.\n";
2074 if ( lc($default_sub_of_inbox) eq 'true' ) {
2075 $default_value = "y";
2077 $default_value = "n";
2079 print "Default sub of INBOX (y/n) [$WHT$default_value$NRM]: $WHT";
2080 $new_show = <STDIN
>;
2081 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2082 $default_sub_of_inbox = 'true';
2084 $default_sub_of_inbox = 'false';
2086 return $default_sub_of_inbox;
2089 # Show contain subfolder option
2091 print "Some IMAP servers (UW) make it so that there are two types of\n";
2092 print "folders. Those that contain messages, and those that contain\n";
2093 print "subfolders. If this is the case for your server, set this to\n";
2094 print "true, and it will ask the user whether the folder they are\n";
2095 print "creating contains subfolders or messages.\n";
2098 if ( lc($show_contain_subfolders_option) eq 'true' ) {
2099 $default_value = "y";
2101 $default_value = "n";
2103 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
2104 $new_show = <STDIN
>;
2105 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2106 $show_contain_subfolders_option = 'true';
2108 $show_contain_subfolders_option = 'false';
2110 return $show_contain_subfolders_option;
2113 # Default Unseen Notify
2115 print "This option specifies where the users will receive notification\n";
2116 print "about unseen messages by default. This is of course an option that\n";
2117 print "can be changed on a user level.\n";
2118 print " 1 = No notification\n";
2119 print " 2 = Only on the INBOX\n";
2120 print " 3 = On all folders\n";
2123 print "Which one should be default (1,2,3)? [$WHT$default_unseen_notify$NRM]: $WHT";
2124 $new_show = <STDIN
>;
2125 if ( $new_show =~ /^[123]\n/i ) {
2126 $default_unseen_notify = $new_show;
2128 $default_unseen_notify =~ s/[\r\n]//g;
2129 return $default_unseen_notify;
2132 # Default Unseen Type
2134 print "Here you can define the default way that unseen messages will be displayed\n";
2135 print "to the user in the folder listing on the left side.\n";
2136 print " 1 = Only unseen messages (4)\n";
2137 print " 2 = Unseen and Total messages (4/27)\n";
2140 print "Which one should be default (1,2)? [$WHT$default_unseen_type$NRM]: $WHT";
2141 $new_show = <STDIN
>;
2142 if ( $new_show =~ /^[12]\n/i ) {
2143 $default_unseen_type = $new_show;
2145 $default_unseen_type =~ s/[\r\n]//g;
2146 return $default_unseen_type;
2149 # Auto create special folders
2151 print "Would you like the Sent, Trash, and Drafts folders to be created\n";
2152 print "automatically print for you when a user logs in? If the user\n";
2153 print "accidentally deletes their special folders, this option will\n";
2154 print "automatically create it again for them.\n";
2157 if ( lc($auto_create_special) eq 'true' ) {
2158 $default_value = "y";
2160 $default_value = "n";
2162 print "Auto create special folders? (y/n) [$WHT$default_value$NRM]: $WHT";
2163 $new_show = <STDIN
>;
2164 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2165 $auto_create_special = 'true';
2167 $auto_create_special = 'false';
2169 return $auto_create_special;
2172 # Automatically delete folders
2174 if ( $imap_server_type eq "uw" ) {
2175 print "UW IMAP servers will not allow folders containing mail to also contain folders.\n";
2176 print "Deleting folders will bypass the trash folder and be immediately deleted\n\n";
2177 print "If this is not the correct value for your server,\n";
2178 print "please use option D on the Main Menu to configure your server correctly.\n\n";
2179 print "Press enter to continue...\n";
2180 $new_delete = <STDIN
>;
2181 $delete_folder = 'true';
2183 if ( $imap_server_type eq "courier" ) {
2184 print "Courier (or Courier-IMAP) IMAP servers may not support ";
2185 print "subfolders of Trash. \n";
2186 print "Specifically, if Courier is set to always move messages to Trash, \n";
2187 print "Trash will be treated by Courier as a special folder that does not \n";
2188 print "allow subfolders. \n\n";
2189 print "Please verify your Courier configuration, and test folder deletion \n";
2190 print "when changing this setting.\n\n";
2193 print "Are subfolders of the Trash supported by your IMAP server?\n";
2194 print "If so, should deleted folders be sent to Trash?\n";
2195 print "If not, say no (deleted folders should not be sent to Trash)\n\n";
2196 # reversal of logic.
2197 # question was: Should folders be automatically deleted instead of sent to trash..
2198 # we've changed the question to make it more clear,
2199 # and are here handling that to avoid changing the answers..
2200 if ( lc($delete_folder) eq 'true' ) {
2201 $default_value = "n";
2203 $default_value = "y";
2205 print "Send deleted folders to Trash? (y/n) [$WHT$default_value$NRM]: $WHT";
2206 $new_delete = <STDIN
>;
2207 if ( ( $new_delete =~ /^y\n/i ) || ( ( $new_delete =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2208 $delete_folder = 'false';
2210 $delete_folder = 'true';
2213 return $delete_folder;
2218 print "Some IMAP servers allow subfolders to exist even if the parent\n";
2219 print "folders do not. This fixes some problems with the folder list\n";
2220 print "when this is the case, causing the /NoSelect folders to be displayed\n";
2223 if ( lc($noselect_fix_enable) eq 'true' ) {
2224 $default_value = "y";
2226 $default_value = "n";
2228 print "enable noselect fix? (y/n) [$WHT$noselect_fix_enable$NRM]: $WHT";
2229 $noselect_fix_enable = <STDIN
>;
2230 if ( ( $noselect_fix_enable =~ /^y\n/i ) || ( ( $noselect_fix_enable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2231 $noselect_fix_enable = 'true';
2233 $noselect_fix_enable = 'false';
2235 return $noselect_fix_enable;
2237 ############# GENERAL OPTIONS #####################
2241 print "Specify the location for your data directory.\n";
2242 print "You need to create this directory yourself.\n";
2243 print "The path name can be absolute or relative (to the config directory).\n";
2244 print "Here are two examples:\n";
2245 print " Absolute: /var/local/squirrelmail/data/\n";
2246 print " Relative: ../data/\n";
2247 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2248 print "will be converted to their absolute path equivalents in config.php.\n\n";
2249 print "Note: There are potential security risks with having a writeable directory\n";
2250 print "under the web server's root directory (ex: /home/httpd/html).\n";
2251 print "For this reason, it is recommended to put the data directory\n";
2252 print "in an alternate location of your choice. \n";
2255 print "[$WHT$data_dir$NRM]: $WHT";
2256 $new_data_dir = <STDIN
>;
2257 if ( $new_data_dir eq "\n" ) {
2258 $new_data_dir = $data_dir;
2260 $new_data_dir =~ s/[\r\n]//g;
2262 if ( $new_data_dir =~ /^\s*$/ ) {
2265 $new_data_dir =~ s/\/*$//g
;
2266 $new_data_dir =~ s/$/\//g
;
2268 return $new_data_dir;
2271 # Attachment directory
2273 print "Path to directory used for storing attachments while a mail is\n";
2274 print "being composed. The path name can be absolute or relative (to the\n";
2275 print "config directory). Here are two examples:\n";
2276 print " Absolute: /var/local/squirrelmail/attach/\n";
2277 print " Relative: ../attach/\n";
2278 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2279 print "will be converted to their absolute path equivalents in config.php.\n\n";
2280 print "Note: There are a few security considerations regarding this\n";
2281 print "directory:\n";
2282 print " 1. It should have the permission 733 (rwx-wx-wx) to make it\n";
2283 print " impossible for a random person with access to the webserver\n";
2284 print " to list files in this directory. Confidential data might\n";
2285 print " be laying around in there.\n";
2286 print " Depending on your user:group assignments, 730 (rwx-wx---)\n";
2287 print " may be possible, and more secure (e.g. root:apache)\n";
2288 print " 2. Since the webserver is not able to list the files in the\n";
2289 print " content is also impossible for the webserver to delete files\n";
2290 print " lying around there for too long.\n";
2291 print " 3. It should probably be another directory than the data\n";
2292 print " directory specified in option 3.\n";
2295 print "[$WHT$attachment_dir$NRM]: $WHT";
2296 $new_attachment_dir = <STDIN
>;
2297 if ( $new_attachment_dir eq "\n" ) {
2298 $new_attachment_dir = $attachment_dir;
2300 $new_attachment_dir =~ s/[\r\n]//g;
2302 if ( $new_attachment_dir =~ /^\s*$/ ) {
2303 $new_attachment_dir = "";
2305 $new_attachment_dir =~ s/\/*$//g
;
2306 $new_attachment_dir =~ s/$/\//g
;
2308 return $new_attachment_dir;
2312 print "The directory hash level setting allows you to configure the level\n";
2313 print "of hashing that SquirrelMail employs in your data and attachment\n";
2314 print "directories. This value must be an integer ranging from 0 to 4.\n";
2315 print "When this value is set to 0, SquirrelMail will simply store all\n";
2316 print "files as normal in the data and attachment directories. However,\n";
2317 print "when set to a value from 1 to 4, a simple hashing scheme will be\n";
2318 print "used to organize the files in this directory. In short, the crc32\n";
2319 print "value for a username will be computed. Then, up to the first 4\n";
2320 print "digits of the hash, as set by this configuration value, will be\n";
2321 print "used to directory hash the files for that user in the data and\n";
2322 print "attachment directory. This allows for better performance on\n";
2323 print "servers with larger numbers of users.\n";
2326 print "[$WHT$dir_hash_level$NRM]: $WHT";
2327 $new_dir_hash_level = <STDIN
>;
2328 if ( $new_dir_hash_level eq "\n" ) {
2329 $new_dir_hash_level = $dir_hash_level;
2331 $new_dir_hash_level =~ s/[\r\n]//g;
2333 if ( ( int($new_dir_hash_level) < 0 )
2334 || ( int($new_dir_hash_level) > 4 )
2335 || !( int($new_dir_hash_level) eq $new_dir_hash_level ) ) {
2336 print "Invalid Directory Hash Level.\n";
2337 print "Value must be an integer ranging from 0 to 4\n";
2338 print "Hit enter to continue.\n";
2339 $enter_key = <STDIN
>;
2341 $new_dir_hash_level = $dir_hash_level;
2344 return $new_dir_hash_level;
2348 print "This is the default size (in pixels) of the left folder list.\n";
2349 print "Default is 200, but you can set it to whatever you wish. This\n";
2350 print "is a user preference, so this will only show up as their default.\n";
2352 print "[$WHT$default_left_size$NRM]: $WHT";
2353 $new_default_left_size = <STDIN
>;
2354 if ( $new_default_left_size eq "\n" ) {
2355 $new_default_left_size = $default_left_size;
2357 $new_default_left_size =~ s/[\r\n]//g;
2359 return $new_default_left_size;
2363 print "Some IMAP servers only have lowercase letters in the usernames\n";
2364 print "but they still allow people with uppercase to log in. This\n";
2365 print "causes a problem with the user's preference files. This option\n";
2366 print "transparently changes all usernames to lowercase.";
2369 if ( lc($force_username_lowercase) eq 'true' ) {
2370 $default_value = "y";
2372 $default_value = "n";
2374 print "Convert usernames to lowercase (y/n) [$WHT$default_value$NRM]: $WHT";
2375 $new_show = <STDIN
>;
2376 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2386 if ( lc($default_use_priority) eq 'true' ) {
2387 $default_value = "y";
2389 $default_value = "n";
2392 print "Allow users to specify priority of outgoing mail (y/n) [$WHT$default_value$NRM]: $WHT";
2393 $new_show = <STDIN
>;
2394 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2404 if ( lc($hide_sm_attributions) eq 'true' ) {
2405 $default_value = "y";
2407 $default_value = "n";
2410 print "Hide SM attributions (y/n) [$WHT$default_value$NRM]: $WHT";
2411 $new_show = <STDIN
>;
2412 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2422 if ( lc($default_use_mdn) eq 'true' ) {
2423 $default_value = "y";
2425 $default_value = "n";
2428 print "Enable support for read/delivery receipt support (y/n) [$WHT$default_value$NRM]: $WHT";
2429 $new_show = <STDIN
>;
2430 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2438 print " In loosely managed environments, you may want to allow users
2439 to edit their full name and email address. In strictly managed
2440 environments, you may want to force users to use the name
2441 and email address assigned to them.
2443 'y' - allow a user to edit their full name and email address,
2444 'n' - users must use the assigned values.
2448 if ( lc($edit_identity) eq 'true' ) {
2449 $default_value = "y";
2451 $default_value = "n";
2453 print "Allow editing of user's identity? (y/n) [$WHT$default_value$NRM]: $WHT";
2454 $new_edit = <STDIN
>;
2455 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2456 $edit_identity = 'true';
2457 $edit_name = 'true';
2458 $hide_auth_header = command311b
();
2460 $edit_identity = 'false';
2461 $edit_name = command311
();
2462 $hide_auth_header = command311b
();
2464 return $edit_identity;
2468 print " Given that users are not allowed to modify their
2469 email address, can they edit their full name?
2473 if ( lc($edit_name) eq 'true' ) {
2474 $default_value = "y";
2476 $default_value = "n";
2478 print "Allow the user to edit their full name? (y/n) [$WHT$default_value$NRM]: $WHT";
2479 $new_edit = <STDIN
>;
2480 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2481 $edit_name = 'true';
2483 $edit_name = 'false';
2489 print " SquirrelMail adds username information to every sent email
2490 in order to prevent possible sender forging when users are allowed
2491 to change their email and/or full name.
2493 You can remove user information from this header (y), if you think that
2494 it violates privacy or security.
2496 Note: If users are allowed to change their email addresses,
2497 this setting will make it difficult to determine who sent what where.
2498 Use at your own risk.
2502 if ( lc($hide_auth_header) eq "true" ) {
2503 $default_value = "y";
2505 $default_value = "n";
2507 print "Remove username from email headers? (y/n) [$WHT$default_value$NRM]: $WHT";
2508 $new_header = <STDIN
>;
2509 if ( ( $new_header =~ /^y\n/i ) || ( ( $new_header =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2510 $hide_auth_header = "true";
2512 $hide_auth_header = "false";
2514 return $hide_auth_header;
2518 print "This option allows you to disable server side thread sorting if your server \n";
2519 print "declares THREAD support, but you don't want to provide threading options \n";
2520 print "to end users or THREAD extension is broken or extension does not work with \n";
2521 print "options used by SquirrelMail. Option is not used, if THREAD extension is \n";
2522 print "not declared in IMAP CAPABILITY.\n";
2525 if ( lc($disable_thread_sort) eq 'true' ) {
2526 $default_value = "y";
2528 $default_value = "n";
2530 print "Disable server side thread sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2531 $disable_thread_sort = <STDIN
>;
2532 if ( ( $disable_thread_sort =~ /^y\n/i ) || ( ( $disable_thread_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2533 $disable_thread_sort = 'true';
2535 $disable_thread_sort = 'false';
2537 return $disable_thread_sort;
2541 print "This option allows you to disable server side sorting if your server declares \n";
2542 print "SORT support, but SORT extension is broken or does not work with options \n";
2543 print "used by SquirrelMail. Option is not used, if SORT extension is not declared \n";
2544 print "in IMAP CAPABILITY.\n";
2546 print "It is strongly recommended to keep server side sorting enabled, if your ";
2547 print "IMAP server supports it.";
2550 if ( lc($disable_server_sort) eq 'true' ) {
2551 $default_value = "y";
2553 $default_value = "n";
2555 print "Disable server-side sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2556 $disable_server_sort = <STDIN
>;
2557 if ( ( $disable_server_sort =~ /^y\n/i ) || ( ( $disable_server_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2558 $disable_server_sort = 'true';
2560 $disable_server_sort = 'false';
2562 return $disable_server_sort;
2566 print "This option allows you to choose if SM uses charset search\n";
2567 print "Your IMAP server must support the SEARCH CHARSET command for this to work\n";
2570 if ( lc($allow_charset_search) eq 'true' ) {
2571 $default_value = "y";
2573 $default_value = "n";
2575 print "Allow charset searching? (y/n) [$WHT$default_value$NRM]: $WHT";
2576 $allow_charset_search = <STDIN
>;
2577 if ( ( $allow_charset_search =~ /^y\n/i ) || ( ( $allow_charset_search =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2578 $allow_charset_search = 'true';
2580 $allow_charset_search = 'false';
2582 return $allow_charset_search;
2585 # command315 (UID support) obsoleted.
2587 # advanced search option
2589 print "This option allows you to control the use of advanced search form.\n";
2590 print " 0 = enable basic search only\n";
2591 print " 1 = enable advanced search only\n";
2592 print " 2 = enable both\n";
2595 print "Allowed search (0,1,2)? [$WHT$allow_advanced_search$NRM]: $WHT";
2596 $new_allow_advanced_search = <STDIN
>;
2597 if ( $new_allow_advanced_search =~ /^[012]\n/i ) {
2598 $allow_advanced_search = $new_allow_advanced_search;
2600 $allow_advanced_search =~ s/[\r\n]//g;
2601 return $allow_advanced_search;
2606 print "This option allows you to change the name of the PHP session used\n";
2607 print "by SquirrelMail. Unless you know what you are doing, you probably\n";
2608 print "don't need or want to change this from the default of SQMSESSID.\n";
2609 print "[$WHT$session_name$NRM]: $WHT";
2610 $new_session_name = <STDIN
>;
2611 chomp($new_session_name);
2612 if ( $new_session_name eq "" ) {
2613 $new_session_name = $session_name;
2615 return $new_session_name;
2618 # time zone config (since 1.5.1)
2620 print "This option allows you to control the use of time zones.\n";
2621 print " 0 = (default) standard, GNU C time zone names\n";
2622 print " 1 = strict, generic time zone codes with offsets\n";
2623 print " 2 = custom, GNU C time zones loaded from config/timezones.php\n";
2624 print " 3 = custom strict, generic time zone codes with offsets loaded \n";
2625 print " from config/timezones.php\n";
2626 print "See SquirrelMail documentation about format of config/timezones.php file.\n";
2629 print "Desired time zone configuration (0,1,2,3)? [$WHT$time_zone_type$NRM]: $WHT";
2630 $new_time_zone_type = <STDIN
>;
2631 if ( $new_time_zone_type =~ /^[0123]\n/i ) {
2632 $time_zone_type = $new_time_zone_type;
2634 print "\nInvalid configuration value.\n";
2635 print "\nPress enter to continue...";
2638 $time_zone_type =~ s/[\r\n]//g;
2639 return $time_zone_type;
2642 # set the location base for redirects (since 1.5.2)
2643 sub command_config_location_base
{
2644 print "Here you can set the base part of the SquirrelMail URL.\n";
2645 print "It is normally autodetected but if that fails, use this\n";
2646 print "option to override.\n";
2647 print "It should contain only the protocol and hostname/port parts\n";
2648 print "of the URL; the full path will be appended automatically.\n\n";
2649 print "Examples:\nhttp://webmail.example.org\nhttp://webmail.example.com:8080\nhttps://webmail.example.com:6691\n\n";
2650 print "Do not add any path elements.\n";
2652 print "URL base? [" .$WHT."autodetect$NRM]: $WHT";
2653 $new_config_location_base = <STDIN
>;
2654 chomp($new_config_location_base);
2655 $config_location_base = $new_config_location_base;
2657 return $config_location_base;
2660 # only_secure_cookies (since 1.5.2)
2662 print "This option allows you to specify that if a user session is initiated\n";
2663 print "under a secure (HTTPS, SSL-encrypted) connection, the cookies given to\n";
2664 print "the browser will ONLY be transmitted via a secure connection henceforth.\n\n";
2665 print "Generally this is a Good Thing, and should NOT be disabled. However,\n";
2666 print "if you intend to use the Secure Login or Show SSL Link plugins to\n";
2667 print "encrypt the user login, but not the rest of the SquirrelMail session,\n";
2668 print "this can be turned off. Think twice before doing so.\n";
2671 if ( lc($only_secure_cookies) eq 'true' ) {
2672 $default_value = "y";
2674 $default_value = "n";
2676 print "Transmit cookies only on secure connection when available? (y/n) [$WHT$default_value$NRM]: $WHT";
2677 $only_secure_cookies = <STDIN
>;
2678 if ( ( $only_secure_cookies =~ /^y\n/i ) || ( ( $only_secure_cookies =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2679 $only_secure_cookies = 'true';
2681 $only_secure_cookies = 'false';
2683 return $only_secure_cookies;
2687 sub command_userThemes
{
2688 print "\nDefine the user themes that you wish to use. If you have added\n";
2689 print "a theme of your own, just follow the instructions (?) about\n";
2690 print "how to add them. You can also change the default theme.\n\n";
2692 print "Available user themes:\n";
2694 while ( $count <= $#user_theme_name ) {
2695 if ( $count == $user_theme_default ) {
2700 if ( $count < 10 ) {
2703 $name = $user_theme_name[$count];
2704 $num_spaces = 35 - length($name);
2705 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2706 $name = $name . " ";
2709 print " $count. $name";
2710 print "($user_theme_path[$count])\n";
2716 print ".------------------------------------.\n";
2717 print "| t (detect user themes) |\n";
2718 print "| + (add user theme) |\n";
2719 print "| - N (remove user theme) |\n";
2720 print "| m N (mark default user theme) |\n";
2721 print "| l (list user themes) |\n";
2722 print "| d (done) |\n";
2723 print "`------------------------------------'\n";
2725 print "\n[user_themes] command (?=help) > ";
2727 $input =~ s/[\r\n]//g;
2728 while ( $input ne "d" ) {
2729 if ( $input =~ /^\s*l\s*/i ) {
2731 while ( $count <= $#user_theme_name ) {
2732 if ( $count == $user_theme_default ) {
2737 if ( $count < 10 ) {
2740 $name = $user_theme_name[$count];
2741 $num_spaces = 35 - length($name);
2742 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2743 $name = $name . " ";
2746 print " $count. $name";
2747 print "($user_theme_path[$count])\n";
2751 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2752 $old_def = $user_theme_default;
2753 $user_theme_default = $input;
2754 $user_theme_default =~ s/^\s*m\s*//;
2755 if ( ( $user_theme_default > $#user_theme_name ) || ( $user_theme_default < 0 ) ) {
2756 print "Cannot set default theme to $user_theme_default. That theme does not exist.\n";
2757 $user_theme_default = $old_def;
2759 } elsif ( $input =~ /^\s*\+/ ) {
2760 print "What is the name of this theme? ";
2762 $name =~ s/[\r\n]//g;
2763 $user_theme_name[ $#user_theme_name + 1 ] = $name;
2764 print "Be sure to put ../css/ before the filename.\n";
2765 print "What file is this stored in (ex: ../css/my_theme/): ";
2767 $name =~ s/[\r\n]//g;
2768 $user_theme_path[ $#user_theme_path + 1 ] = $name;
2769 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2770 if ( $input =~ /[0-9]+\s*$/ ) {
2772 $rem_num =~ s/^\s*-\s*//g;
2773 $rem_num =~ s/\s*$//;
2775 $rem_num = $#user_theme_name;
2777 if ( $rem_num == $user_theme_default ) {
2778 print "You cannot remove the default theme!\n";
2781 @new_theme_name = ();
2782 @new_theme_path = ();
2783 while ( $count <= $#user_theme_name ) {
2784 if ( $count != $rem_num ) {
2785 @new_theme_name = ( @new_theme_name, $user_theme_name[$count] );
2786 @new_theme_path = ( @new_theme_path, $user_theme_path[$count] );
2790 @user_theme_name = @new_theme_name;
2791 @user_theme_path = @new_theme_path;
2792 if ( $user_theme_default > $rem_num ) {
2793 $user_theme_default--;
2796 } elsif ( $input =~ /^\s*t\s*/i ) {
2797 print "\nStarting detection...\n\n";
2799 opendir( DIR
, "../css" );
2800 @files = sort(readdir(DIR
));
2802 while ( $cnt <= $#files ) {
2803 $filename = "../css/" . $files[$cnt] .'/';
2804 if ( $files[$cnt] !~ /^\./ && $filename ne "../css/rtl.css" && -e
$filename . "default.css" ) {
2806 for ( $x = 0 ; $x <= $#user_theme_path ; $x++ ) {
2807 if ( $user_theme_path[$x] eq $filename ) {
2811 if ( $found != 1 ) {
2812 print "** Found user theme: $filename\n";
2813 $def = $files[$cnt];
2816 #$def =~ s/(^\w+)/ucfirst $1/eg;
2817 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
2818 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
2819 print " What is its name? [$def]: ";
2821 $nm =~ s/^\s+|\s+$|[\n\r]//g;
2822 if ( $nm eq '' ) { $nm = $def; }
2823 $user_theme_name[ $#user_theme_name + 1 ] = $nm;
2824 $user_theme_path[ $#user_theme_path + 1 ] = $filename;
2830 for ( $cnt = 0 ; $cnt <= $#user_theme_path ; $cnt++ ) {
2831 $filename = $user_theme_path[$cnt];
2832 if ( $filename != 'none' && !( -e
$filename ."/default.css" ) ) {
2833 print " Removing $filename (file not found)\n";
2835 @new_user_theme_name = ();
2836 @new_user_theme_path = ();
2837 for ( $x = 0 ; $x < $#user_theme_path ; $x++ ) {
2838 if ( $user_theme_path[$x] eq $filename ) {
2841 if ( $offset == 1 ) {
2842 $new_user_theme_name[$x] = $user_theme_name[ $x + 1 ];
2843 $new_user_theme_path[$x] = $user_theme_path[ $x + 1 ];
2845 $new_user_theme_name[$x] = $user_theme_name[$x];
2846 $new_user_theme_path[$x] = $user_theme_path[$x];
2849 @user_theme_name = @new_user_theme_name;
2850 @user_theme_path = @new_user_theme_path;
2853 print "\nDetection complete!\n\n";
2856 } elsif ( $input =~ /^\s*\?\s*/ ) {
2857 print ".------------------------------------.\n";
2858 print "| t (detect user themes) |\n";
2859 print "| + (add user theme) |\n";
2860 print "| - N (remove user theme) |\n";
2861 print "| m N (mark default user theme) |\n";
2862 print "| l (list user themes) |\n";
2863 print "| d (done) |\n";
2864 print "`------------------------------------'\n";
2866 print "[user_themes] command (?=help) > ";
2868 $input =~ s/[\r\n]//g;
2872 sub command_iconSets
{
2873 print "\nDefine the icon themes that you wish to use. If you have added\n";
2874 print "a theme of your own, just follow the instructions (?) about\n";
2875 print "how to add them. You can also change the default and fallback\n";
2876 print "themes. The default theme will be used when no icon theme is\n";
2877 print "set by the user. The fallback theme will be used if an icon\n";
2878 print "cannot be found in the currently selected icon theme.\n\n";
2880 print "Available icon themes:\n\n";
2883 while ( $count <= $#icon_theme_name ) {
2884 if ( $count == $icon_theme_def ) {
2889 if ( $count eq $icon_theme_fallback ) {
2894 if ( $count < 10 ) {
2897 $name = $icon_theme_name[$count];
2898 $num_spaces = 35 - length($name);
2899 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2900 $name = $name . " ";
2903 print " $count. $name";
2904 print "($icon_theme_path[$count])\n";
2909 print "\n d = Default icon theme\n";
2910 print " f = Fallback icon theme\n";
2912 print ".------------------------------------.\n";
2913 print "| t (detect icon themes) |\n";
2914 print "| + (add icon theme) |\n";
2915 print "| - N (remove icon theme) |\n";
2916 print "| m N (mark default icon theme) |\n";
2917 print "| f N (set fallback icon set) |\n";
2918 print "| l (list icon themes) |\n";
2919 print "| d (done) |\n";
2920 print "`------------------------------------'\n";
2922 print "\n[icon_themes] command (?=help) > ";
2924 $input =~ s/[\r\n]//g;
2925 while ( $input ne "d" ) {
2926 if ( $input =~ /^\s*l\s*/i ) {
2929 while ( $count <= $#icon_theme_name ) {
2930 if ( $count == $icon_theme_def ) {
2935 if ( $count eq $icon_theme_fallback ) {
2940 $name = $icon_theme_name[$count];
2941 $num_spaces = 35 - length($name);
2942 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2943 $name = $name . " ";
2946 print " $count. $name";
2947 print "($icon_theme_path[$count])\n";
2951 print "\n d = Default icon theme\n";
2952 print " f = Fallback icon theme\n\n";
2953 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2954 $old_def = $icon_theme_def;
2955 $icon_theme_def = $input;
2956 $icon_theme_def =~ s/^\s*m\s*//;
2957 if ( ( $icon_theme_default > $#icon_theme_name ) || ( $icon_theme_default < 0 ) ) {
2958 print "Cannot set default icon theme to $icon_theme_default. That theme does not exist.\n";
2959 $icon_theme_def = $old_def;
2961 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
2962 $old_fb = $icon_theme_fallback;
2963 $icon_theme_fallback = $input;
2964 $icon_theme_fallback =~ s/^\s*f\s*//;
2965 if ( ( $icon_theme_fallback > $#icon_theme_name ) || ( $icon_theme_fallback < 0 ) ) {
2966 print "Cannot set fallback icon theme to $icon_theme_fallback. That theme does not exist.\n";
2967 $icon_theme_fallback = $old_fb;
2969 } elsif ( $input =~ /^\s*\+/ ) {
2970 print "What is the name of this icon theme? ";
2972 $name =~ s/[\r\n]//g;
2973 $icon_theme_name[ $#icon_theme_name + 1 ] = $name;
2974 print "Be sure to put ../images/themes/ before the filename.\n";
2975 print "What directory is this icon theme stored in (ex: ../images/themes/my_theme/)? ";
2977 $name =~ s/[\r\n]//g;
2978 $icon_theme_path[ $#icon_theme_path + 1 ] = $name;
2979 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2980 if ( $input =~ /[0-9]+\s*$/ ) {
2982 $rem_num =~ s/^\s*-\s*//g;
2983 $rem_num =~ s/\s*$//;
2985 $rem_num = $#icon_theme_name;
2987 if ( $rem_num == $icon_theme_def ) {
2988 print "You cannot remove the default icon theme!\n";
2989 } elsif ( $rem_num == $icon_theme_fallback ) {
2990 print "You cannot remove the fallback icon theme!\n";
2993 @new_theme_name = ();
2994 @new_theme_path = ();
2995 while ( $count <= $#icon_theme_name ) {
2996 if ( $count != $rem_num ) {
2997 @new_theme_name = ( @new_theme_name, $icon_theme_name[$count] );
2998 @new_theme_path = ( @new_theme_path, $icon_theme_path[$count] );
3002 @icon_theme_name = @new_theme_name;
3003 @icon_theme_path = @new_theme_path;
3004 if ( $icon_theme_def > $rem_num ) {
3008 } elsif ( $input =~ /^\s*t\s*/i ) {
3009 print "\nStarting detection...\n\n";
3011 opendir( DIR
, "../images/themes/" );
3012 @files = sort(readdir(DIR
));
3014 while ( $cnt <= $#files ) {
3015 $filename = "../images/themes/" . $files[$cnt] .'/';
3016 if ( -d
"../images/themes/" . $files[$cnt] && $files[$cnt] !~ /^\
./ && $files[$cnt] ne ".svn" ) {
3018 for ( $x = 0 ; $x <= $#icon_theme_path ; $x++ ) {
3019 if ( $icon_theme_path[$x] eq $filename ) {
3023 if ( $found != 1 ) {
3024 print "** Found icon theme: $filename\n";
3025 $def = $files[$cnt];
3028 #$def =~ s/(^\w+)/ucfirst $1/eg;
3029 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3030 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3031 print " What is its name? [$def]: ";
3033 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3034 if ( $nm eq '' ) { $nm = $def; }
3035 $icon_theme_name[ $#icon_theme_name + 1 ] = $nm;
3036 $icon_theme_path[ $#icon_theme_path + 1 ] = $filename;
3042 for ( $cnt = 0 ; $cnt <= $#icon_theme_path ; $cnt++ ) {
3043 $filename = $icon_theme_path[$cnt];
3044 if ( $filename ne "none" && $filename ne "template" && ! -d
$filename ) {
3045 print " Removing $filename (file not found)\n";
3047 @new_icon_theme_name = ();
3048 @new_icon_theme_path = ();
3049 for ( $x = 0 ; $x < $#icon_theme_path ; $x++ ) {
3050 if ( $icon_theme_path[$x] eq $filename ) {
3053 if ( $offset == 1 ) {
3054 $new_icon_theme_name[$x] = $icon_theme_name[ $x + 1 ];
3055 $new_icon_theme_path[$x] = $icon_theme_path[ $x + 1 ];
3057 $new_icon_theme_name[$x] = $icon_theme_name[$x];
3058 $new_icon_theme_path[$x] = $icon_theme_path[$x];
3061 @icon_theme_name = @new_icon_theme_name;
3062 @icon_theme_path = @new_icon_theme_path;
3065 print "\nDetection complete!\n\n";
3068 } elsif ( $input =~ /^\s*\?\s*/ ) {
3069 print ".------------------------------------.\n";
3070 print "| t (detect icon themes) |\n";
3071 print "| + (add icon theme) |\n";
3072 print "| - N (remove icon theme) |\n";
3073 print "| m N (mark default icon theme) |\n";
3074 print "| f N (set fallback icon set) |\n";
3075 print "| l (list icon themes) |\n";
3076 print "| d (done) |\n";
3077 print "`------------------------------------'\n";
3079 print "[icon_themes] command (?=help) > ";
3081 $input =~ s/[\r\n]//g;
3085 sub command_templates
{
3086 print "\nDefine the template sets (skins) that you wish to use. If you have added\n";
3087 print "a template set of your own, just follow the instructions (?) about\n";
3088 print "how to add them. You can also change the default template.\n";
3090 print "\n Available Templates:\n";
3093 while ( $count <= $#templateset_name ) {
3094 if ( $templateset_id[$count] eq $templateset_default ) {
3099 if ( $templateset_id[$count] eq $templateset_fallback ) {
3104 if ( $count < 10 ) {
3107 $name = $templateset_name[$count];
3108 $num_spaces = 35 - length($name);
3109 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3110 $name = $name . " ";
3113 print " $count. $name";
3114 print "($templateset_id[$count])\n";
3118 print "\n d = default template set\n"
3119 . " f = fallback template set\n\n";
3121 $menu_text = ".-------------------------------------.\n"
3122 . "| t (detect template set) |\n"
3123 . "| + (add template set) |\n"
3124 . "| - N (remove template set) |\n"
3125 . "| m N (mark default template set) |\n"
3126 . "| f N (set fallback template set) |\n"
3127 . "| l (list template sets/skins) |\n"
3129 . "|-------------------------------------|\n"
3130 . "| where N is a template set number |\n"
3131 . "`-------------------------------------'\n";
3134 print "\n[template set] command (?=help) > ";
3137 $input =~ s/[\r\n]//g;
3138 while ( $input ne "d" ) {
3140 # list template sets
3142 if ( $input =~ /^\s*l\s*/i ) {
3144 while ( $count <= $#templateset_name ) {
3145 if ( $templateset_id[$count] eq $templateset_default ) {
3150 if ( $templateset_id[$count] eq $templateset_fallback ) {
3155 if ( $count < 10 ) {
3158 $name = $templateset_name[$count];
3159 $num_spaces = 35 - length($name);
3160 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3161 $name = $name . " ";
3164 print " $count. $name";
3165 print "($templateset_id[$count])\n";
3169 print "\n d = default template set\n"
3170 . " f = fallback template set\n\n";
3172 # mark default template set
3174 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
3175 $old_def = $templateset_default;
3176 $input =~ s/^\s*m\s*//;
3177 $templateset_default = $templateset_id[$input];
3178 if ( $templateset_default =~ /^\s*$/ ) {
3179 print "Cannot set default template set to $input. That template set does not exist.\n";
3180 $templateset_default = $old_def;
3183 # set fallback template set
3185 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
3186 $old_def = $templateset_fallback;
3187 $input =~ s/^\s*f\s*//;
3188 $templateset_fallback = $templateset_id[$input];
3189 if ( $templateset_fallback =~ /^\s*$/ ) {
3190 print "Cannot set fallback template set to $input. That template set does not exist.\n";
3191 $templateset_fallback = $old_def;
3196 } elsif ( $input =~ /^\s*\+/ ) {
3197 print "\nWhat is the name of this template (as shown to your users): ";
3199 $name =~ s/[\r\n]//g;
3200 $templateset_name[ $#templateset_name + 1 ] = $name;
3201 print "\n\nThe directory name should not contain any path information\n"
3202 . "or slashes, and should be the name of the directory that the\n"
3203 . "template set is found in within the SquirrelMail templates\n"
3205 print "What directory is this stored in (ex: default_advanced): ";
3207 $name =~ s/[\r\n]//g;
3208 $templateset_id[ $#templateset_id + 1 ] = $name;
3210 # detect template sets
3212 } elsif ( $input =~ /^\s*t\s*/i ) {
3213 print "\nStarting detection...\n\n";
3214 opendir( DIR
, "../templates" );
3215 @files = sort(readdir(DIR
));
3217 while ( $cnt <= $#files ) {
3218 if ( -d
"../templates/" . $files[$cnt] && $files[$cnt] !~ /^\./ && $files[$cnt] ne ".svn" ) {
3219 $filename = $files[$cnt];
3221 for ( $x = 0 ; $x <= $#templateset_id ; $x++ ) {
3222 if ( $templateset_id[$x] eq $filename ) {
3228 print "** Found template set: $filename\n";
3229 $def = $files[$cnt];
3232 #$def =~ s/(^\w+)/ucfirst $1/eg;
3233 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3234 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3235 print " What is it's name (as shown to your users)? [$def]: ";
3237 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3238 if ( $nm eq '' ) { $nm = $def; }
3239 $templateset_id[ $#templateset_id + 1 ] = $filename;
3240 $templateset_name[ $#templateset_name + 1 ] = $nm;
3246 for ( $cnt= 0 ; $cnt <= $#templateset_id ; ) {
3247 $filename = $templateset_id[$cnt];
3248 if ( !(-d change_to_rel_path
('SM_PATH . \'templates/' . $filename)) ) {
3249 print " Removing \"$filename\" (template set directory not found)\n";
3250 if ( $templateset_default eq $filename ) { $templateset_default = 'default'; }
3251 if ( $templateset_fallback eq $filename ) { $templateset_fallback = 'default'; }
3253 @new_templateset_name = ();
3254 @new_templateset_id = ();
3255 for ( $x = 0 ; $x < $#templateset_id ; $x++ ) {
3256 if ( $templateset_id[$x] eq $filename ) {
3259 if ( $offset == 1 ) {
3260 $new_templateset_name[$x] = $templateset_name[ $x + 1 ];
3261 $new_templateset_id[$x] = $templateset_id[ $x + 1 ];
3263 $new_templateset_name[$x] = $templateset_name[$x];
3264 $new_templateset_id[$x] = $templateset_id[$x];
3267 @templateset_name = @new_templateset_name;
3268 @templateset_id = @new_templateset_id;
3271 print "\nDetection complete!\n\n";
3275 # remove template set
3277 # undocumented functionality of removing last template set isn't that great
3278 #} elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3279 } elsif ( $input =~ /^\s*-\s*[0-9]+/ ) {
3280 if ( $input =~ /[0-9]+\s*$/ ) {
3282 $rem_num =~ s/^\s*-\s*//g;
3283 $rem_num =~ s/\s*$//;
3285 $rem_num = $#templateset_name;
3287 if ( $templateset_id[$rem_num] eq $templateset_default ) {
3288 print "You cannot remove the default template set!\n";
3289 } elsif ( $templateset_id[$rem_num] eq $templateset_fallback ) {
3290 print "You cannot remove the fallback template set!\n";
3293 @new_templateset_name = ();
3294 @new_templateset_id = ();
3295 while ( $count <= $#templateset_name ) {
3296 if ( $count != $rem_num ) {
3297 @new_templateset_name = ( @new_templateset_name, $templateset_name[$count] );
3298 @new_templateset_id = ( @new_templateset_id, $templateset_id[$count] );
3302 @templateset_name = @new_templateset_name;
3303 @templateset_id = @new_templateset_id;
3308 } elsif ( $input =~ /^\s*\?\s*/ ) {
3311 # command not understood
3314 print "Command not understood\n";
3317 print "[template set] command (?=help) > ";
3319 $input =~ s/[\r\n]//g;
3321 return $templateset_default;
3325 # sets default font size option
3326 sub command_default_fontsize
{
3327 print "Enter default font size [$WHT$$default_fontsize$NRM]: $WHT";
3328 $new_size = <STDIN
>;
3329 if ( $new_size eq "\n" ) {
3332 $new_size =~ s/[\r\n]//g;
3337 # controls available fontsets
3338 sub command_fontsets
{
3340 print "You can control fontsets available to end users here.\n";
3341 # set initial $input value
3343 while ( $input ne "x" ) {
3344 if ( $input =~ /^\s*a\s*/i ) {
3346 print "\nFontset name: ";
3348 if (! $fontsets{trim
($name)}) {
3349 print "Fontset string: ";
3351 $fontsets{trim
($name)} = trim
($value);
3353 print "\nERROR: Such fontset already exists.\n";
3355 } elsif ( $input =~ /^\s*e\s*/i ) {
3356 # edit existing fontset
3357 print "\nFontset name: ";
3359 if (! $fontsets{trim
($name)}) {
3360 print "\nERROR: No such fontset.\n";
3362 print "Fontset string [$fontsets{trim($name)}]: ";
3364 $fontsets{trim
($name)} = trim
($value);
3366 } elsif ( $input =~ /^\s*d\s*/ ) {
3367 # delete existing fontset
3368 print "\nFontset name: ";
3370 if (! $fontsets{trim
($name)}) {
3371 print "\nERROR: No such fontset.\n";
3373 delete $fontsets{trim
($name)};
3375 } elsif ( $input =~ /^\s*l\s*/ ) {
3377 print "\nConfigured fontsets:\n";
3378 while (($fontset_name, $fontset_string) = each(%fontsets)) {
3379 print " $fontset_name = $fontset_string\n";
3381 print "Default fontset: $default_fontset\n";
3382 } elsif ( $input =~ /^\s*m\s*/ ) {
3383 # set default fontset
3384 print "\nSet default fontset [$default_fontset]: ";
3386 if (trim
($name) ne '' and ! $fontsets{trim
($name)}) {
3387 print "\nERROR: No such fontset.\n";
3389 $default_fontset = trim
($name);
3392 # print available commands on any other input
3393 print "\nAvailable commands:\n";
3394 print " a - Adds new fontset.\n";
3395 print " d - Deletes existing fontset.\n";
3396 print " e - Edits existing fontset.\n";
3397 print " h or ? - Shows this help screen.\n";
3398 print " l - Lists available fontsets.\n";
3399 print " m - Sets default fontset.\n";
3400 print " x - Exits fontset editor mode.\n";
3402 print "\nCommand [fontsets] (a,d,e,h,?=help,l,m,x)> ";
3404 $input =~ s/[\r\n]//g;
3409 print "You can now define different LDAP servers.\n";
3410 print "Please ensure proper permissions for config.php when including\n";
3411 print "sensitive passwords.\n\n";
3412 print "[ldap] command (?=help) > ";
3414 $input =~ s/[\r\n]//g;
3415 while ( $input ne "d" ) {
3416 if ( $input =~ /^\s*l\s*/i ) {
3418 while ( $count <= $#ldap_host ) {
3419 print "$count. $ldap_host[$count]\n";
3420 print " base: $ldap_base[$count]\n";
3421 if ( $ldap_charset[$count] ) {
3422 print " charset: $ldap_charset[$count]\n";
3424 if ( $ldap_port[$count] ) {
3425 print " port: $ldap_port[$count]\n";
3427 if ( $ldap_name[$count] ) {
3428 print " name: $ldap_name[$count]\n";
3430 if ( $ldap_maxrows[$count] ) {
3431 print " maxrows: $ldap_maxrows[$count]\n";
3433 if ( $ldap_filter[$count] ) {
3434 print " filter: $ldap_filter[$count]\n";
3436 if ( $ldap_binddn[$count] ) {
3437 print " binddn: $ldap_binddn[$count]\n";
3438 if ( $ldap_bindpw[$count] ) {
3439 print " bindpw: $ldap_bindpw[$count]\n";
3442 if ( $ldap_protocol[$count] ) {
3443 print " protocol: $ldap_protocol[$count]\n";
3445 if ( $ldap_limit_scope[$count] ) {
3446 print " limit_scope: $ldap_limit_scope[$count]\n";
3448 if ( $ldap_listing[$count] ) {
3449 print " listing: $ldap_listing[$count]\n";
3451 if ( $ldap_writeable[$count] ) {
3452 print " writeable: $ldap_writeable[$count]\n";
3454 if ( $ldap_search_tree[$count] ) {
3455 print " search_tree: $ldap_search_tree[$count]\n";
3457 if ( $ldap_starttls[$count] ) {
3458 print " starttls: $ldap_starttls[$count]\n";
3464 } elsif ( $input =~ /^\s*\+/ ) {
3465 $sub = $#ldap_host + 1;
3467 print "First, we need to have the hostname or the IP address where\n";
3468 print "this LDAP server resides. Example: ldap.bigfoot.com\n";
3470 print "You can use any URI compatible with your LDAP library. Please\n";
3471 print "note that StartTLS option is not compatible with ldaps and\n";
3472 print "ldapi URIs.\n";
3475 $name =~ s/[\r\n]//g;
3476 $ldap_host[$sub] = $name;
3480 print "Next, we need the server root (base dn). For this, an empty\n";
3481 print "string is allowed.\n";
3482 print "Example: ou=member_directory,o=netcenter.com\n";
3485 $name =~ s/[\r\n]//g;
3486 $ldap_base[$sub] = $name;
3490 print "This is the TCP/IP port number for the LDAP server. Default\n";
3491 print "port is 389. This is optional. Press ENTER for default.\n";
3494 $name =~ s/[\r\n]//g;
3495 $ldap_port[$sub] = $name;
3499 print "This is the charset for the server. Default is utf-8. This\n";
3500 print "is also optional. Press ENTER for default.\n";
3503 $name =~ s/[\r\n]//g;
3504 $ldap_charset[$sub] = $name;
3508 print "This is the name for the server, used to tag the results of\n";
3509 print "the search. Default it \"LDAP: hostname\". Press ENTER for default\n";
3512 $name =~ s/[\r\n]//g;
3513 $ldap_name[$sub] = $name;
3517 print "You can specify the maximum number of rows in the search result.\n";
3518 print "Default value is equal to 250 rows. Press ENTER for default.\n";
3521 $name =~ s/[\r\n]//g;
3522 $ldap_maxrows[$sub] = $name;
3527 print "If your LDAP server does not like anonymous logins, you can specify bind DN.\n";
3528 print "Default is none, anonymous bind. Press ENTER for default.\n";
3531 $name =~ s/[\r\n]//g;
3532 $ldap_binddn[$sub] = $name;
3536 if ( $ldap_binddn[$sub] ne '' ) {
3538 print "Now, please specify password for that DN.\n";
3541 $name =~ s/[\r\n]//g;
3542 $ldap_bindpw[$sub] = $name;
3547 print "You can specify bind protocol version here.\n";
3548 print "Default protocol version depends on your php ldap settings.\n";
3549 print "Press ENTER for default.\n";
3552 $name =~ s/[\r\n]//g;
3553 $ldap_protocol[$sub] = $name;
3557 print "This configuration section allows to set some rarely used\n";
3558 print "options and options specific to some LDAP implementations.\n";
3560 print "Do you want to set advanced LDAP directory settings? (y/N):";
3561 $ldap_advanced_settings = <STDIN
>;
3562 if ( $ldap_advanced_settings =~ /^y\n/i ) {
3563 $ldap_advanced_settings = 'true';
3565 $ldap_advanced_settings = 'false';
3568 if ($ldap_advanced_settings eq 'true') {
3571 print "You can control LDAP directory listing here. This option can\n";
3572 print "be useful if you run small LDAP server and want to provide listing\n";
3573 print "of all addresses stored in LDAP to users of webmail interface.\n";
3574 print "Number of displayed entries is limited by maxrows setting.\n";
3576 print "Don't enable this option for public LDAP directories.\n";
3578 print "Allow listing of LDAP directory? (y/N):";
3580 if ( $name =~ /^y\n/i ) {
3585 $ldap_listing[$sub] = $name;
3589 print "You can control write access to LDAP address book here. This option can\n";
3590 print "be useful if you run small LDAP server and want to provide writable\n";
3591 print "shared address book stored in LDAP to users of webmail interface.\n";
3593 print "Don't enable this option for public LDAP directories.\n";
3595 print "Allow writing to LDAP directory? (y/N):";
3597 if ( $name =~ /^y\n/i ) {
3602 $ldap_writeable[$sub] = $name;
3606 print "You can specify an additional search filter.\n";
3607 print "This could be something like \"(objectclass=posixAccount)\".\n";
3608 print "No filtering is performed by default. Press ENTER for default.\n";
3611 $name =~ s/[\r|\n]//g;
3612 $ldap_filter[$sub] = $name;
3616 print "You can control search scope here.\n";
3617 print "This option is specific to Microsoft ADS implementation.\n";
3618 print "It requires use of v3 or newer LDAP protocol.\n";
3619 print "Don't enable it, if you use other LDAP server.\n";
3621 print "Limit ldap scope? (y/N):";
3623 if ( $name =~ /^y\n/i ) {
3628 $ldap_limit_scope[$sub] = $name;
3632 print "You can control ldap search type here.\n";
3633 print "Addresses can be searched in entire LDAP subtree (default)\n";
3634 print "or only first level entries are returned.\n";
3636 print "Search entire LDAP subtree? (Y/n):";
3638 if ( $name =~ /^n\n/i ) {
3643 $ldap_search_tree[$sub] = $name;
3647 print "You can control use of StartTLS on LDAP connection here.\n";
3648 print "This option requires use of v3 or newer LDAP protocol and php 4.2+.\n";
3650 print "Use StartTLS? (y/N):";
3652 if ( $name =~ /^y\n/i ) {
3657 $ldap_starttls[$sub] = $name;
3661 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3662 if ( $input =~ /[0-9]+\s*$/ ) {
3664 $rem_num =~ s/^\s*-\s*//g;
3665 $rem_num =~ s/\s*$//;
3667 $rem_num = $#ldap_host;
3670 @new_ldap_host = ();
3671 @new_ldap_base = ();
3672 @new_ldap_port = ();
3673 @new_ldap_name = ();
3674 @new_ldap_charset = ();
3675 @new_ldap_maxrows = ();
3676 @new_ldap_filter = ();
3677 @new_ldap_bindpw = ();
3678 @new_ldap_binddn = ();
3679 @new_ldap_protocol = ();
3680 @new_ldap_limit_scope = ();
3681 @new_ldap_listing = ();
3682 @new_ldap_writeable = ();
3683 @new_ldap_search_tree = ();
3684 @new_ldap_starttls = ();
3686 while ( $count <= $#ldap_host ) {
3687 if ( $count != $rem_num ) {
3688 @new_ldap_host = ( @new_ldap_host, $ldap_host[$count] );
3689 @new_ldap_base = ( @new_ldap_base, $ldap_base[$count] );
3690 @new_ldap_port = ( @new_ldap_port, $ldap_port[$count] );
3691 @new_ldap_name = ( @new_ldap_name, $ldap_name[$count] );
3692 @new_ldap_charset = ( @new_ldap_charset, $ldap_charset[$count] );
3693 @new_ldap_maxrows = ( @new_ldap_maxrows, $ldap_maxrows[$count] );
3694 @new_ldap_filter = ( @new_ldap_filter, $ldap_filter[$count] );
3695 @new_ldap_binddn = ( @new_ldap_binddn, $ldap_binddn[$count] );
3696 @new_ldap_bindpw = ( @new_ldap_bindpw, $ldap_bindpw[$count] );
3697 @new_ldap_protocol = ( @new_ldap_protocol, $ldap_protocol[$count] );
3698 @new_ldap_limit_scope = ( @new_ldap_limit_scope, $ldap_limit_scope[$count] );
3699 @new_ldap_listing = ( @new_ldap_listing, $ldap_listing[$count] );
3700 @new_ldap_writeable = ( @new_ldap_writeable, $ldap_writeable[$count] );
3701 @new_ldap_search_tree = ( @new_ldap_search_tree, $ldap_search_tree[$count] );
3702 @new_ldap_starttls = ( @new_ldap_starttls, $ldap_starttls[$count] );
3706 @ldap_host = @new_ldap_host;
3707 @ldap_base = @new_ldap_base;
3708 @ldap_port = @new_ldap_port;
3709 @ldap_name = @new_ldap_name;
3710 @ldap_charset = @new_ldap_charset;
3711 @ldap_maxrows = @new_ldap_maxrows;
3712 @ldap_filter = @new_ldap_filter;
3713 @ldap_binddn = @new_ldap_binddn;
3714 @ldap_bindpw = @new_ldap_bindpw;
3715 @ldap_protocol = @new_ldap_protocol;
3716 @ldap_limit_scope = @new_ldap_limit_scope;
3717 @ldap_listing = @new_ldap_listing;
3718 @ldap_writeable = @new_ldap_writeable;
3719 @ldap_search_tree = @new_ldap_search_tree;
3720 @ldap_starttls = @new_ldap_starttls;
3722 } elsif ( $input =~ /^\s*\?\s*/ ) {
3723 print ".-------------------------.\n";
3724 print "| + (add host) |\n";
3725 print "| - N (remove host) |\n";
3726 print "| l (list hosts) |\n";
3727 print "| d (done) |\n";
3728 print "`-------------------------'\n";
3730 print "[ldap] command (?=help) > ";
3732 $input =~ s/[\r\n]//g;
3737 print "Some of our developers have come up with very good javascript interface\n";
3738 print "for searching through address books, however, our original goals said\n";
3739 print "that we would be 100% HTML. In order to make it possible to use their\n";
3740 print "interface, and yet stick with our goals, we have also written a plain\n";
3741 print "HTML version of the search. Here, you can choose which version to use.\n";
3743 print "This is just the default value. It is also a user option that each\n";
3744 print "user can configure individually\n";
3747 if ( lc($default_use_javascript_addr_book) eq 'true' ) {
3748 $default_value = "y";
3750 $default_use_javascript_addr_book = 'false';
3751 $default_value = "n";
3753 print "Use javascript version by default (y/n) [$WHT$default_value$NRM]: $WHT";
3754 $new_show = <STDIN
>;
3755 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3756 $default_use_javascript_addr_book = 'true';
3758 $default_use_javascript_addr_book = 'false';
3760 return $default_use_javascript_addr_book;
3763 # global filebased address book
3765 print "If you want to use global file address book, then you\n";
3766 print "must set this option to a valid value. If option does\n";
3767 print "not have path elements, system assumes that file is\n";
3768 print "stored in data directory. If relative path is set, it is\n";
3769 print "relative to main SquirrelMail directory. If value is empty,\n";
3770 print "address book is not enabled.\n";
3773 print "[$WHT$abook_global_file$NRM]: $WHT";
3774 $new_abook_global_file = <STDIN
>;
3775 if ( $new_abook_global_file eq "\n" ) {
3776 $new_abook_global_file = $abook_global_file;
3778 $new_abook_global_file =~ s/[\r\n]//g;
3780 return $new_abook_global_file;
3783 # writing into global filebased abook control
3785 print "This setting controls writing into global file address\n";
3786 print "book options. Address book file must be writeable by\n";
3787 print "webserver's user, if you want to enable this option.\n";
3790 if ( lc($abook_global_file_writeable) eq 'true' ) {
3791 $default_value = "y";
3793 $abook_global_file_writeable = 'false';
3794 $default_value = "n";
3796 print "Allow writing into global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
3797 $new_show = <STDIN
>;
3798 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3799 $abook_global_file_writeable = 'true';
3801 $abook_global_file_writeable = 'false';
3803 return $abook_global_file_writeable;
3806 # listing of global filebased abook control
3808 print "This setting controls listing of global file address\n";
3809 print "book in addresses page.\n";
3812 if ( lc($abook_global_file_listing) eq 'true' ) {
3813 $default_value = "y";
3815 $abook_global_file_listing = 'false';
3816 $default_value = "n";
3818 print "Allow listing of global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
3819 $new_show = <STDIN
>;
3820 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3821 $abook_global_file_listing = 'true';
3823 $abook_global_file_listing = 'false';
3825 return $abook_global_file_listing;
3828 # controls $abook_file_line_length setting
3829 sub command_abook_file_line_length
{
3830 print "This setting controls space allocated to file based address book records.\n";
3831 print "End users will be unable to save address book entry, if total entry size \n";
3832 print "(quoted address book fields + 4 delimiters + linefeed) exceeds allowed \n";
3833 print "address book length size.\n";
3835 print "Same setting is applied to personal and global file based address books.\n";
3837 print "It is strongly recommended to keep default setting value. Change it only\n";
3838 print "if you really want to store address book entries that are bigger than two\n";
3839 print "kilobytes (2048).\n";
3842 print "Enter allowed address book line length [$abook_file_line_length]: ";
3845 # value is not modified, if user hits Enter or enters space
3847 # make sure that input is numeric
3848 if ($tmp =~ /^\d+$/) {
3849 $abook_file_line_length = $tmp;
3851 print "If you want to change this setting, you must enter number.\n";
3852 print "If you want to keep original setting - enter space.\n\n";
3853 print "Press Enter to continue...";
3860 print "If you want to store your users address book details in a database then\n";
3861 print "you need to set this DSN to a valid value. The format for this is:\n";
3862 print "mysql://user:pass\@hostname/dbname\n";
3863 print "Where mysql can be one of the databases PHP supports, the most common\n";
3864 print "of these are mysql, msql and pgsql.\n";
3865 print "Please ensure proper permissions for config.php when including\n";
3866 print "sensitive passwords.\n\n";
3867 print "If the DSN is left empty (hit space and then return) the database\n";
3868 print "related code for address books will not be used.\n";
3871 if ( $addrbook_dsn eq "" ) {
3872 $default_value = "Disabled";
3874 $default_value = $addrbook_dsn;
3876 print "[$WHT$addrbook_dsn$NRM]: $WHT";
3878 if ( $new_dsn eq "\n" ) {
3881 $new_dsn =~ s/[\r\n]//g;
3882 $new_dsn =~ s/^\s+$//g;
3888 print "This is the name of the table you want to store the address book\n";
3889 print "data in, it defaults to 'address'\n";
3891 print "[$WHT$addrbook_table$NRM]: $WHT";
3892 $new_table = <STDIN
>;
3893 if ( $new_table eq "\n" ) {
3894 $new_table = $addrbook_table;
3896 $new_table =~ s/[\r\n]//g;
3902 print "If you want to store your users preferences in a database then\n";
3903 print "you need to set this DSN to a valid value. The format for this is:\n";
3904 print "mysql://user:pass\@hostname/dbname\n";
3905 print "Where mysql can be one of the databases PHP supports, the most common\n";
3906 print "of these are mysql, msql and pgsql.\n";
3907 print "Please ensure proper permissions for config.php when including\n";
3908 print "sensitive passwords.\n\n";
3909 print "If the DSN is left empty (hit space and then return) the database\n";
3910 print "related code for address books will not be used.\n";
3913 if ( $prefs_dsn eq "" ) {
3914 $default_value = "Disabled";
3916 $default_value = $prefs_dsn;
3918 print "[$WHT$prefs_dsn$NRM]: $WHT";
3920 if ( $new_dsn eq "\n" ) {
3923 $new_dsn =~ s/[\r\n]//g;
3924 $new_dsn =~ s/^\s+$//g;
3930 print "This is the name of the table you want to store the preferences\n";
3931 print "data in, it defaults to 'userprefs'\n";
3933 print "[$WHT$prefs_table$NRM]: $WHT";
3934 $new_table = <STDIN
>;
3935 if ( $new_table eq "\n" ) {
3936 $new_table = $prefs_table;
3938 $new_table =~ s/[\r\n]//g;
3944 print "This is the name of the field in which you want to store the\n";
3945 print "username of the person the prefs are for. It default to 'user'\n";
3946 print "which clashes with a reserved keyword in PostgreSQL so this\n";
3947 print "will need to be changed for that database at least\n";
3949 print "[$WHT$prefs_user_field$NRM]: $WHT";
3950 $new_field = <STDIN
>;
3951 if ( $new_field eq "\n" ) {
3952 $new_field = $prefs_user_field;
3954 $new_field =~ s/[\r\n]//g;
3956 $prefs_user_size = db_pref_size
($prefs_user_size);
3961 print "This is the name of the field in which you want to store the\n";
3962 print "preferences keyword. It defaults to 'prefkey'\n";
3964 print "[$WHT$prefs_key_field$NRM]: $WHT";
3965 $new_field = <STDIN
>;
3966 if ( $new_field eq "\n" ) {
3967 $new_field = $prefs_key_field;
3969 $new_field =~ s/[\r\n]//g;
3971 $prefs_key_size = db_pref_size
($prefs_key_size);
3976 print "This is the name of the field in which you want to store the\n";
3977 print "preferences value. It defaults to 'prefval'\n";
3979 print "[$WHT$prefs_val_field$NRM]: $WHT";
3980 $new_field = <STDIN
>;
3981 if ( $new_field eq "\n" ) {
3982 $new_field = $prefs_val_field;
3984 $new_field =~ s/[\r\n]//g;
3986 $prefs_val_size = db_pref_size
($prefs_val_size);
3990 # routine is used to set database field limits
3991 # it needs one argument
3992 sub db_pref_size
() {
3994 print "\nDatabase fields have size limits.\n";
3996 print "What limit is set for this field? [$WHT$size$NRM]: $WHT";
3997 $new_size = <STDIN
>;
3998 if ( $new_size eq "\n" ) {
4001 $new_size =~ s/[\r\n]//g;
4007 print "If you want to store your global address book in a database then\n";
4008 print "you need to set this DSN to a valid value. The format for this is:\n";
4009 print "mysql://user:pass\@hostname/dbname\n";
4010 print "Where mysql can be one of the databases PHP supports, the most common\n";
4011 print "of these are mysql, msql and pgsql.\n";
4012 print "Please ensure proper permissions for config.php when including\n";
4013 print "sensitive passwords.\n\n";
4014 print "If the DSN is left empty (hit space and then return) the database\n";
4015 print "related code for global SQL address book will not be used.\n";
4018 if ( $addrbook_global_dsn eq "" ) {
4019 $default_value = "Disabled";
4021 $default_value = $addrbook_global_dsn;
4023 print "[$WHT$addrbook_global_dsn$NRM]: $WHT";
4025 if ( $new_dsn eq "\n" ) {
4028 $new_dsn =~ s/[\r\n]//g;
4029 $new_dsn =~ s/^\s+$//g;
4035 print "This is the name of the table you want to store the global address book\n";
4036 print "data in. Default table name is 'global_abook'. Address book uses same\n";
4037 print "database format as personal address book.\n";
4039 print "[$WHT$addrbook_global_table$NRM]: $WHT";
4040 $new_table = <STDIN
>;
4041 if ( $new_table eq "\n" ) {
4042 $new_table = $addrbook_global_table;
4044 $new_table =~ s/[\r\n]//g;
4050 print "This option controls users\' ability to add or modify records stored \n";
4051 print "in global address book\n";
4053 if ( lc($addrbook_global_writeable) eq 'true' ) {
4054 $default_value = "y";
4056 $default_value = "n";
4058 print "Allow writing into global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
4059 $addrbook_global_writeable = <STDIN
>;
4060 if ( ( $addrbook_global_writeable =~ /^y\n/i ) || ( ( $addrbook_global_writeable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4061 $addrbook_global_writeable = 'true';
4063 $addrbook_global_writeable = 'false';
4065 return $addrbook_global_writeable;
4069 print "Enable this option if you want to see listing of addresses stored \n";
4070 print "in global address book\n";
4072 if ( lc($addrbook_global_listing) eq 'true' ) {
4073 $default_value = "y";
4075 $default_value = "n";
4077 print "Allow listing of global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
4078 $addrbook_global_listing = <STDIN
>;
4079 if ( ( $addrbook_global_listing =~ /^y\n/i ) || ( ( $addrbook_global_listing =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4080 $addrbook_global_listing = 'true';
4082 $addrbook_global_listing = 'false';
4084 return $addrbook_global_listing;
4090 print "SquirrelMail attempts to set the language in many ways. If it\n";
4091 print "can not figure it out in another way, it will default to this\n";
4092 print "language. Please use the code for the desired language.\n";
4094 print "[$WHT$squirrelmail_default_language$NRM]: $WHT";
4095 $new_squirrelmail_default_language = <STDIN
>;
4096 if ( $new_squirrelmail_default_language eq "\n" ) {
4097 $new_squirrelmail_default_language = $squirrelmail_default_language;
4099 $new_squirrelmail_default_language =~ s/[\r\n]//g;
4100 $new_squirrelmail_default_language =~ s/^\s+$//g;
4102 return $new_squirrelmail_default_language;
4106 print "This option controls what character set is used when sending\n";
4107 print "mail and when sending HTML to the browser. Option works only\n";
4108 print "with US English (en_US) translation. Other translations use\n";
4109 print "charsets that are set in translation settings.\n";
4112 print "[$WHT$default_charset$NRM]: $WHT";
4113 $new_default_charset = <STDIN
>;
4114 if ( $new_default_charset eq "\n" ) {
4115 $new_default_charset = $default_charset;
4117 $new_default_charset =~ s/[\r\n]//g;
4119 return $new_default_charset;
4121 # Alternative language names
4123 print "Enable this option if you want to see localized language names in\n";
4124 print "language selection box. Note, that this option can trigger\n";
4125 print "installation of foreign language support modules in some browsers.\n";
4128 if ( lc($show_alternative_names) eq 'true' ) {
4129 $default_value = "y";
4131 $default_value = "n";
4133 print "Show alternative language names? (y/n) [$WHT$default_value$NRM]: $WHT";
4134 $show_alternative_names = <STDIN
>;
4135 if ( ( $show_alternative_names =~ /^y\n/i ) || ( ( $show_alternative_names =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4136 $show_alternative_names = 'true';
4138 $show_alternative_names = 'false';
4140 return $show_alternative_names;
4143 # Aggressive decoding
4145 print "Enable this option if you want to use CPU and memory intensive decoding\n";
4146 print "functions. This option allows reading multibyte charset, that are used\n";
4147 print "in Eastern Asia. SquirrelMail will try to use recode functions here,\n";
4148 print "even when you have disabled use of recode in Tweaks section.\n";
4151 if ( lc($aggressive_decoding) eq 'true' ) {
4152 $default_value = "y";
4154 $default_value = "n";
4156 print "Enable aggressive decoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4157 $aggressive_decoding = <STDIN
>;
4158 if ( ( $aggressive_decoding =~ /^y\n/i ) || ( ( $aggressive_decoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4159 $aggressive_decoding = 'true';
4161 $aggressive_decoding = 'false';
4163 return $aggressive_decoding;
4168 print "Enable this option if you want to allow lossy charset encoding in message\n";
4169 print "composition pages. This option allows charset conversions when output\n";
4170 print "charset does not support all symbols used in original charset. Symbols\n";
4171 print "unsupported by output charset will be replaced with question marks.\n";
4174 if ( lc($lossy_encoding) eq 'true' ) {
4175 $default_value = "y";
4177 $default_value = "n";
4179 print "Enable lossy encoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4180 $lossy_encoding = <STDIN
>;
4181 if ( ( $lossy_encoding =~ /^y\n/i ) || ( ( $lossy_encoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4182 $lossy_encoding = 'true';
4184 $lossy_encoding = 'false';
4186 return $lossy_encoding;
4189 # display html emails in iframe
4191 print "This option can enable html email rendering inside iframe.\n";
4192 print "Inline frames are used in order to provide sandbox environment";
4193 print "for html code included in html formated emails.";
4194 print "Option is experimental and might have glitches in some parts of code.";
4197 if ( lc($use_iframe) eq 'true' ) {
4198 $default_value = "y";
4200 $default_value = "n";
4202 print "Display html emails in iframe? (y/n) [$WHT$default_value$NRM]: $WHT";
4203 $use_iframe = <STDIN
>;
4204 if ( ( $use_iframe =~ /^y\n/i ) || ( ( $use_iframe =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4205 $use_iframe = 'true';
4207 $use_iframe = 'false';
4213 sub command_ask_user_info
{
4214 print "New users need to supply their real name and email address to\n";
4215 print "send out proper mails. When this option is enabled, a user that\n";
4216 print "logs in for the first time will be redirected to the Personal\n";
4217 print "Options screen and asked to supply their personal data.\n";
4220 if ( lc($ask_user_info) eq 'true' ) {
4221 $default_value = "y";
4223 $default_value = "n";
4225 print "Ask user info? (y/n) [$WHT$default_value$NRM]: $WHT";
4226 $ask_user_info = <STDIN
>;
4227 if ( ( $ask_user_info =~ /^y\n/i ) || ( ( $ask_user_info =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4228 $ask_user_info = 'true';
4230 $ask_user_info = 'false';
4232 return $ask_user_info;
4237 print "Enabling this option will cause icons to be used instead of text\n";
4238 print "markers next to each message in mailbox lists that represent\n";
4239 print "new, read, flagged, and deleted messages, as well as those that\n";
4240 print "have been replied to and forwarded. Icons are also used next to\n";
4241 print "(un)expanded folders in the folder list (Oldway = false). These\n";
4242 print "icons are quite small, but will obviously be more of a resource\n";
4243 print "drain than text markers.\n";
4246 if ( lc($use_icons) eq 'true' ) {
4247 $default_value = "y";
4249 $default_value = "n";
4251 print "Use icons? (y/n) [$WHT$default_value$NRM]: $WHT";
4252 $use_icons = <STDIN
>;
4253 if ( ( $use_icons =~ /^y\n/i ) || ( ( $use_icons =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4254 $use_icons = 'true';
4256 $use_icons = 'false';
4262 print "Enable this option if you want to use php recode functions to read\n";
4263 print "emails written in charset that differs from the one that is set in\n";
4264 print "translation selected by user. Code is experimental, it might cause\n";
4265 print "errors, if email contains charset unsupported by recode or if your\n";
4266 print "php does not have recode support.\n";
4269 if ( lc($use_php_recode) eq 'true' ) {
4270 $default_value = "y";
4272 $default_value = "n";
4274 print "Use php recode functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4275 $use_php_recode = <STDIN
>;
4276 if ( ( $use_php_recode =~ /^y\n/i ) || ( ( $use_php_recode =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4277 $use_php_recode = 'true';
4279 $use_php_recode = 'false';
4281 return $use_php_recode;
4285 print "Enable this option if you want to use php iconv functions to read\n";
4286 print "emails written in charset that differs from the one that is set in\n";
4287 print "translation selected by user. Code is experimental, it works only\n";
4288 print "with translations that use utf-8 charset. Code might cause errors,\n";
4289 print "if email contains charset unsupported by iconv or if your php does\n";
4290 print "not have iconv support.\n";
4293 if ( lc($use_php_iconv) eq 'true' ) {
4294 $default_value = "y";
4296 $default_value = "n";
4298 print "Use php iconv functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4299 $use_php_iconv = <STDIN
>;
4300 if ( ( $use_php_iconv =~ /^y\n/i ) || ( ( $use_php_iconv =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4301 $use_php_iconv = 'true';
4303 $use_php_iconv = 'false';
4305 return $use_php_iconv;
4310 print "Enable this option if you want to check SquirrelMail configuration\n";
4311 print "remotely with configtest.php script.\n";
4314 if ( lc($allow_remote_configtest) eq 'true' ) {
4315 $default_value = "y";
4317 $default_value = "n";
4319 print "Allow remote configuration tests? (y/n) [$WHT$default_value$NRM]: $WHT";
4320 $allow_remote_configtest = <STDIN
>;
4321 if ( ( $allow_remote_configtest =~ /^y\n/i ) || ( ( $allow_remote_configtest =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4322 $allow_remote_configtest = 'true';
4324 $allow_remote_configtest = 'false';
4326 return $allow_remote_configtest;
4329 # Default Icon theme
4331 print "You may change the path to the default icon theme to be used, if icons\n";
4332 print "have been enabled. This theme will be used when an icon cannot be\n";
4333 print "found in the current theme, or when no icon theme is specified. If\n";
4334 print "left blank, and icons are enabled, the default theme will be used\n";
4335 print "from images/themes/default/.\n";
4337 print "To clear out an existing value, just type a space for the input.\n";
4339 print "Please be aware of the following: \n";
4340 print " - Relative URLs are relative to the config dir\n";
4341 print " to use the icon themes directory, use ../images/themes/newtheme/\n";
4342 print " - The icon theme may be outside the SquirrelMail directory, but\n";
4343 print " it must be web accessible.\n";
4344 print "[$WHT$icon_theme_def$NRM]: $WHT";
4345 $new_icon_theme_def = <STDIN
>;
4347 if ( $new_icon_theme_def eq "\n" ) {
4348 $new_icon_theme_def = $icon_theme_def;
4350 $new_icon_theme_def =~ s/[\r\n]//g;
4352 $new_icon_theme_def =~ s/^\s*//;
4353 return $new_icon_theme_def;
4356 # SquirrelMail debug mode (since 1.5.2)
4358 print "When debugging or developing SquirrelMail, you may want to increase\n";
4359 print "the verbosity of certain kinds of errors, notices, and/or diagnostics.\n";
4360 print "You may enable one or more of the debugging modes here. Please make\n";
4361 print "sure that you have turned off debugging if you are using SquirrelMail\n";
4362 print "in a production environment.\n\n";
4365 while ( $input ne "d\n" ) {
4366 $sm_debug_mode = convert_debug_constants_to_binary_integer
($sm_debug_mode);
4368 # per include/constants.php, here are the debug mode values:
4370 # 0 SM_DEBUG_MODE_OFF
4371 # 1 SM_DEBUG_MODE_SIMPLE
4372 # 512 SM_DEBUG_MODE_MODERATE
4373 # 524288 SM_DEBUG_MODE_ADVANCED
4374 # 536870912 SM_DEBUG_MODE_STRICT
4376 print "\n# Enabled? Description\n";
4377 print "---------------------------------------------------------------------\n";
4378 print "0 " . ($sm_debug_mode == 0 ?
"y" : " ")
4379 . " No debugging (recommended in production environments)\n";
4380 print "1 " . ($sm_debug_mode & 1 ?
"y" : " ")
4381 . " Simple debugging (PHP E_ERROR)\n";
4382 print "2 " . ($sm_debug_mode & 512 ?
"y" : " ")
4383 . " Moderate debugging (PHP E_ALL)\n";
4384 print "3 " . ($sm_debug_mode & 524288 ?
"y" : " ")
4385 . " Advanced debugging (PHP E_ALL plus log errors\n";
4386 print " intentionally suppressed)\n";
4387 print "4 " . ($sm_debug_mode & 536870912 ?
"y" : " ")
4388 . " Strict debugging (PHP E_STRICT)\n";
4391 print "SquirrelMail debug mode (0,1,2,3,4) or d when done? : $WHT";
4393 if ( $input eq "d\n" ) {
4395 } elsif ($input !~ /^[0-9]+\n$/) {
4396 print "\nInvalid configuration value.\n";
4397 print "\nPress enter to continue...";
4399 } elsif ( $input == "0\n" ) {
4401 } elsif ( $input == "1\n" ) {
4402 if ($sm_debug_mode & 1) {
4403 $sm_debug_mode ^= 1;
4405 $sm_debug_mode |= 1;
4407 } elsif ( $input == "2\n" ) {
4408 if ($sm_debug_mode & 512) {
4409 $sm_debug_mode ^= 512;
4411 $sm_debug_mode |= 512;
4413 } elsif ( $input == "3\n" ) {
4414 if ($sm_debug_mode & 524288) {
4415 $sm_debug_mode ^= 524288;
4417 $sm_debug_mode |= 524288;
4419 } elsif ( $input == "4\n" ) {
4420 if ($sm_debug_mode & 536870912) {
4421 $sm_debug_mode ^= 536870912;
4423 $sm_debug_mode |= 536870912;
4426 print "\nInvalid configuration value.\n";
4427 print "\nPress enter to continue...";
4432 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
4433 return $sm_debug_mode;
4436 # Secured configuration mode (since 1.5.2)
4438 print "This option allows you to enable \"Secured Configuration\" mode,\n";
4439 print "which will guarantee that certain settings made herein will be\n";
4440 print "made immutable and will not be subject to override by either friendly\n";
4441 print "or unfriendly code/plugins. Only a small number of settings herein\n";
4442 print "will be used in this manner - just those that are deemed to be a\n";
4443 print "potential security threat when rouge plugin or other code may be\n";
4444 print "executed inside SquirrelMail.\n";
4447 if ( lc($secured_config) eq 'true' ) {
4448 $default_value = "y";
4450 $default_value = "n";
4452 print "Enable secured configuration mode? (y/n) [$WHT$default_value$NRM]: $WHT";
4453 $secured_config = <STDIN
>;
4454 if ( ( $secured_config =~ /^y\n/i ) || ( ( $secured_config =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4455 $secured_config = 'true';
4457 $secured_config = 'false';
4459 return $secured_config;
4464 if ( open( CF
, ">config.php" ) ) {
4469 print CF
" * SquirrelMail Configuration File\n";
4470 print CF
" * Created using the configure script, conf.pl\n";
4474 if ($print_config_version) {
4475 print CF
"\$config_version = '$print_config_version';\n";
4478 print CF
"\$config_use_color = $config_use_color;\n";
4482 print CF
"\$org_name = \"$org_name\";\n";
4484 print CF
"\$org_logo = " . &change_to_SM_path
($org_logo) . ";\n";
4485 $org_logo_width |= 0;
4486 $org_logo_height |= 0;
4488 print CF
"\$org_logo_width = '$org_logo_width';\n";
4490 print CF
"\$org_logo_height = '$org_logo_height';\n";
4491 # string that can contain variables.
4492 print CF
"\$org_title = \"$org_title\";\n";
4494 print CF
"\$signout_page = " . &change_to_SM_path
($signout_page) . ";\n";
4496 print CF
"\$frame_top = '$frame_top';\n";
4499 print CF
"\$provider_uri = '$provider_uri';\n";
4502 print CF
"\$provider_name = '$provider_name';\n";
4505 # string that can contain variables
4506 print CF
"\$motd = \"$motd\";\n";
4510 print CF
"\$squirrelmail_default_language = '$squirrelmail_default_language';\n";
4512 print CF
"\$default_charset = '$default_charset';\n";
4514 print CF
"\$show_alternative_names = $show_alternative_names;\n";
4516 print CF
"\$aggressive_decoding = $aggressive_decoding;\n";
4518 print CF
"\$lossy_encoding = $lossy_encoding;\n";
4522 print CF
"\$domain = '$domain';\n";
4524 print CF
"\$imapServerAddress = '$imapServerAddress';\n";
4526 print CF
"\$imapPort = $imapPort;\n";
4528 print CF
"\$useSendmail = $useSendmail;\n";
4530 print CF
"\$smtpServerAddress = '$smtpServerAddress';\n";
4532 print CF
"\$smtpPort = $smtpPort;\n";
4534 print CF
"\$sendmail_path = '$sendmail_path';\n";
4536 print CF
"\$sendmail_args = '$sendmail_args';\n";
4538 # print CF "\$use_authenticated_smtp = $use_authenticated_smtp;\n";
4540 print CF
"\$pop_before_smtp = $pop_before_smtp;\n";
4542 print CF
"\$imap_server_type = '$imap_server_type';\n";
4544 print CF
"\$invert_time = $invert_time;\n";
4546 print CF
"\$optional_delimiter = '$optional_delimiter';\n";
4548 print CF
"\$encode_header_key = '$encode_header_key';\n";
4552 print CF
"\$default_folder_prefix = '$default_folder_prefix';\n";
4554 print CF
"\$trash_folder = '$trash_folder';\n";
4556 print CF
"\$sent_folder = '$sent_folder';\n";
4558 print CF
"\$draft_folder = '$draft_folder';\n";
4560 print CF
"\$default_move_to_trash = $default_move_to_trash;\n";
4562 print CF
"\$default_move_to_sent = $default_move_to_sent;\n";
4564 print CF
"\$default_save_as_draft = $default_save_as_draft;\n";
4566 print CF
"\$show_prefix_option = $show_prefix_option;\n";
4568 print CF
"\$list_special_folders_first = $list_special_folders_first;\n";
4570 print CF
"\$use_special_folder_color = $use_special_folder_color;\n";
4572 print CF
"\$auto_expunge = $auto_expunge;\n";
4574 print CF
"\$default_sub_of_inbox = $default_sub_of_inbox;\n";
4576 print CF
"\$show_contain_subfolders_option = $show_contain_subfolders_option;\n";
4578 print CF
"\$default_unseen_notify = $default_unseen_notify;\n";
4580 print CF
"\$default_unseen_type = $default_unseen_type;\n";
4582 print CF
"\$auto_create_special = $auto_create_special;\n";
4584 print CF
"\$delete_folder = $delete_folder;\n";
4586 print CF
"\$noselect_fix_enable = $noselect_fix_enable;\n";
4591 print CF
"\$data_dir = " . &change_to_SM_path
($data_dir) . ";\n";
4592 # string that can contain a variable
4593 print CF
"\$attachment_dir = " . &change_to_SM_path
($attachment_dir) . ";\n";
4595 print CF
"\$dir_hash_level = $dir_hash_level;\n";
4597 print CF
"\$default_left_size = '$default_left_size';\n";
4599 print CF
"\$force_username_lowercase = $force_username_lowercase;\n";
4601 print CF
"\$default_use_priority = $default_use_priority;\n";
4603 print CF
"\$hide_sm_attributions = $hide_sm_attributions;\n";
4605 print CF
"\$default_use_mdn = $default_use_mdn;\n";
4607 print CF
"\$edit_identity = $edit_identity;\n";
4609 print CF
"\$edit_name = $edit_name;\n";
4611 print CF
"\$hide_auth_header = $hide_auth_header;\n";
4613 print CF
"\$disable_thread_sort = $disable_thread_sort;\n";
4615 print CF
"\$disable_server_sort = $disable_server_sort;\n";
4617 print CF
"\$allow_charset_search = $allow_charset_search;\n";
4619 print CF
"\$allow_advanced_search = $allow_advanced_search;\n";
4622 print CF
"\$time_zone_type = $time_zone_type;\n";
4625 print CF
"\$config_location_base = '$config_location_base';\n";
4628 print CF
"\$disable_plugins = $disable_plugins;\n";
4630 print CF
"\$disable_plugins_user = '$disable_plugins_user';\n";
4633 # all plugins are strings
4634 for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
4635 print CF
"\$plugins[] = '$plugins[$ct]';\n";
4640 if ( $user_theme_default eq '' ) { $user_theme_default = '0'; }
4641 print CF
"\$user_theme_default = $user_theme_default;\n";
4643 for ( $count = 0 ; $count <= $#user_theme_name ; $count++ ) {
4644 if ($user_theme_path[$count] eq 'none') {
4647 $path = &change_to_SM_path
($user_theme_path[$count]);
4649 print CF
"\$user_themes[$count]['PATH'] = " . $path . ";\n";
4650 # escape theme name so it can contain single quotes.
4651 $esc_name = $user_theme_name[$count];
4652 $esc_name =~ s/\\/\\\\/g;
4653 $esc_name =~ s/'/\\'/g;
4654 print CF
"\$user_themes[$count]['NAME'] = '$esc_name';\n";
4658 if ( $icon_theme_def eq '' ) { $icon_theme_def = '0'; }
4659 print CF
"\$icon_theme_def = $icon_theme_def;\n";
4660 if ( $icon_theme_fallback eq '' ) { $icon_theme_fallback = '0'; }
4661 print CF
"\$icon_theme_fallback = $icon_theme_fallback;\n";
4663 for ( $count = 0 ; $count <= $#icon_theme_name ; $count++ ) {
4664 $path = $icon_theme_path[$count];
4665 if ($path eq 'none' || $path eq 'template') {
4666 $path = "'".$path."'";
4668 $path = &change_to_SM_path
($icon_theme_path[$count]);
4670 print CF
"\$icon_themes[$count]['PATH'] = " . $path . ";\n";
4671 # escape theme name so it can contain single quotes.
4672 $esc_name = $icon_theme_name[$count];
4673 $esc_name =~ s/\\/\\\\/g;
4674 $esc_name =~ s/'/\\'/g;
4675 print CF
"\$icon_themes[$count]['NAME'] = '$esc_name';\n";
4679 if ( $templateset_default eq '' ) { $templateset_default = 'default'; }
4680 print CF
"\$templateset_default = '$templateset_default';\n";
4682 if ( $templateset_fallback eq '' ) { $templateset_fallback = 'default'; }
4683 print CF
"\$templateset_fallback = '$templateset_fallback';\n";
4685 for ( $count = 0 ; $count <= $#templateset_name ; $count++ ) {
4686 print CF
"\$aTemplateSet[$count]['ID'] = '" . $templateset_id[$count] . "';\n";
4687 # escape theme name so it can contain single quotes.
4688 $esc_name = $templateset_name[$count];
4689 $esc_name =~ s/\\/\\\\/g;
4690 $esc_name =~ s/'/\\'/g;
4691 print CF
"\$aTemplateSet[$count]['NAME'] = '$esc_name';\n";
4697 print CF
"\$default_fontsize = '$default_fontsize';\n";
4699 print CF
"\$default_fontset = '$default_fontset';\n";
4701 # assoc. array (maybe initial value should be set somewhere else)
4702 print CF
'$fontsets = array();'."\n";
4703 while (($fontset_name, $fontset_value) = each(%fontsets)) {
4704 print CF
"\$fontsets\['$fontset_name'\] = '$fontset_value';\n";
4710 print CF
"\$default_use_javascript_addr_book = $default_use_javascript_addr_book;\n";
4711 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
4712 print CF
"\$ldap_server[$count] = array(\n";
4714 print CF
" 'host' => '$ldap_host[$count]',\n";
4716 print CF
" 'base' => '$ldap_base[$count]'";
4717 if ( $ldap_name[$count] ) {
4720 print CF
" 'name' => '$ldap_name[$count]'";
4722 if ( $ldap_port[$count] ) {
4725 print CF
" 'port' => $ldap_port[$count]";
4727 if ( $ldap_charset[$count] ) {
4730 print CF
" 'charset' => '$ldap_charset[$count]'";
4732 if ( $ldap_maxrows[$count] ) {
4735 print CF
" 'maxrows' => $ldap_maxrows[$count]";
4738 if ( $ldap_filter[$count] ) {
4740 print CF
" 'filter' => '$ldap_filter[$count]'";
4742 if ( $ldap_binddn[$count] ) {
4745 print CF
" 'binddn' => '$ldap_binddn[$count]'";
4746 if ( $ldap_bindpw[$count] ) {
4749 print CF
" 'bindpw' => '$ldap_bindpw[$count]'";
4752 if ( $ldap_protocol[$count] ) {
4755 print CF
" 'protocol' => $ldap_protocol[$count]";
4757 if ( $ldap_limit_scope[$count] ) {
4760 print CF
" 'limit_scope' => $ldap_limit_scope[$count]";
4762 if ( $ldap_listing[$count] ) {
4765 print CF
" 'listing' => $ldap_listing[$count]";
4767 if ( $ldap_writeable[$count] ) {
4770 print CF
" 'writeable' => $ldap_writeable[$count]";
4772 if ( $ldap_search_tree[$count] ) {
4775 print CF
" 'search_tree' => $ldap_search_tree[$count]";
4777 if ( $ldap_listing[$count] ) {
4780 print CF
" 'starttls' => $ldap_starttls[$count]";
4788 print CF
"\$addrbook_dsn = '$addrbook_dsn';\n";
4790 print CF
"\$addrbook_table = '$addrbook_table';\n\n";
4792 print CF
"\$prefs_dsn = '$prefs_dsn';\n";
4794 print CF
"\$prefs_table = '$prefs_table';\n";
4796 print CF
"\$prefs_user_field = '$prefs_user_field';\n";
4798 print CF
"\$prefs_user_size = $prefs_user_size;\n";
4800 print CF
"\$prefs_key_field = '$prefs_key_field';\n";
4802 print CF
"\$prefs_key_size = $prefs_key_size;\n";
4804 print CF
"\$prefs_val_field = '$prefs_val_field';\n";
4806 print CF
"\$prefs_val_size = $prefs_val_size;\n\n";
4808 print CF
"\$addrbook_global_dsn = '$addrbook_global_dsn';\n";
4810 print CF
"\$addrbook_global_table = '$addrbook_global_table';\n";
4812 print CF
"\$addrbook_global_writeable = $addrbook_global_writeable;\n";
4814 print CF
"\$addrbook_global_listing = $addrbook_global_listing;\n\n";
4816 print CF
"\$abook_global_file = '$abook_global_file';\n";
4818 print CF
"\$abook_global_file_writeable = $abook_global_file_writeable;\n\n";
4820 print CF
"\$abook_global_file_listing = $abook_global_file_listing;\n\n";
4822 print CF
"\$abook_file_line_length = $abook_file_line_length;\n\n";
4824 print CF
"\$no_list_for_subscribe = $no_list_for_subscribe;\n";
4827 print CF
"\$smtp_auth_mech = '$smtp_auth_mech';\n";
4828 print CF
"\$smtp_sitewide_user = '". quote_single
($smtp_sitewide_user) ."';\n";
4829 print CF
"\$smtp_sitewide_pass = '". quote_single
($smtp_sitewide_pass) ."';\n";
4831 print CF
"\$imap_auth_mech = '$imap_auth_mech';\n";
4833 print CF
"\$use_imap_tls = $use_imap_tls;\n";
4835 print CF
"\$use_smtp_tls = $use_smtp_tls;\n";
4837 print CF
"\$session_name = '$session_name';\n";
4839 print CF
"\$only_secure_cookies = $only_secure_cookies;\n";
4844 print CF
"\$use_iframe = $use_iframe;\n";
4846 print CF
"\$ask_user_info = $ask_user_info;\n";
4848 print CF
"\$use_icons = $use_icons;\n";
4851 print CF
"\$use_php_recode = $use_php_recode;\n";
4853 print CF
"\$use_php_iconv = $use_php_iconv;\n";
4856 print CF
"\$allow_remote_configtest = $allow_remote_configtest;\n";
4857 print CF
"\$secured_config = $secured_config;\n";
4858 # (binary) integer or constant - convert integer
4859 # values to constants before output
4860 $sm_debug_mode = convert_debug_binary_integer_to_constants
($sm_debug_mode);
4861 print CF
"\$sm_debug_mode = $sm_debug_mode;\n";
4866 print "Data saved in config.php\n";
4868 build_plugin_hook_array
();
4871 print "Error saving config.php: $!\n";
4877 print $WHT. "SquirrelMail Configuration : " . $NRM;
4878 if ( $config == 1 ) { print "Read: config.php"; }
4879 elsif ( $config == 2 ) { print "Read: config_default.php"; }
4881 print "---------------------------------------------------------\n";
4883 print "While we have been building SquirrelMail, we have discovered some\n";
4884 print "preferences that work better with some servers that don't work so\n";
4885 print "well with others. If you select your IMAP server, this option will\n";
4886 print "set some pre-defined settings for that server.\n";
4888 print "Please note that you will still need to go through and make sure\n";
4889 print "everything is correct. This does not change everything. There are\n";
4890 print "only a few settings that this will change.\n";
4894 while ( $continue != 1 ) {
4895 print "Please select your IMAP server:\n";
4896 print $list_supported_imap_servers;
4898 print " quit = Do not change anything\n";
4900 print "Command >> ";
4902 $server =~ s/[\r\n]//g;
4904 # variable is used to display additional messages.
4908 if ( $server eq "cyrus" ) {
4909 $imap_server_type = "cyrus";
4910 $default_folder_prefix = "";
4911 $trash_folder = "INBOX.Trash";
4912 $sent_folder = "INBOX.Sent";
4913 $draft_folder = "INBOX.Drafts";
4914 $show_prefix_option = false
;
4915 $default_sub_of_inbox = true
;
4916 $show_contain_subfolders_option = false
;
4917 $optional_delimiter = ".";
4918 $disp_default_folder_prefix = "<none>";
4919 $force_username_lowercase = false
;
4921 # Delimiter might differ if unixhierarchysep is set to yes.
4922 $message = "\nIf you have enabled unixhierarchysep, you must change delimiter and special folder names.\n";
4925 } elsif ( $server eq "uw" ) {
4926 $imap_server_type = "uw";
4927 $default_folder_prefix = "mail/";
4928 $trash_folder = "Trash";
4929 $sent_folder = "Sent";
4930 $draft_folder = "Drafts";
4931 $show_prefix_option = true
;
4932 $default_sub_of_inbox = false
;
4933 $show_contain_subfolders_option = true
;
4934 $optional_delimiter = "/";
4935 $disp_default_folder_prefix = $default_folder_prefix;
4936 $delete_folder = true
;
4937 $force_username_lowercase = true
;
4940 } elsif ( $server eq "exchange" ) {
4941 $imap_server_type = "exchange";
4942 $default_folder_prefix = "";
4943 $default_sub_of_inbox = true
;
4944 $trash_folder = "INBOX/Deleted Items";
4945 $sent_folder = "INBOX/Sent Items";
4946 $drafts_folder = "INBOX/Drafts";
4947 $show_prefix_option = false
;
4948 $show_contain_subfolders_option = false
;
4949 $optional_delimiter = "detect";
4950 $disp_default_folder_prefix = "<none>";
4951 $force_username_lowercase = true
;
4954 } elsif ( $server eq "courier" ) {
4955 $imap_server_type = "courier";
4956 $default_folder_prefix = "INBOX.";
4957 $trash_folder = "Trash";
4958 $sent_folder = "Sent";
4959 $draft_folder = "Drafts";
4960 $show_prefix_option = false
;
4961 $default_sub_of_inbox = false
;
4962 $show_contain_subfolders_option = false
;
4963 $optional_delimiter = ".";
4964 $disp_default_folder_prefix = $default_folder_prefix;
4965 $delete_folder = true
;
4966 $force_username_lowercase = false
;
4969 } elsif ( $server eq "macosx" ) {
4970 $imap_server_type = "macosx";
4971 $default_folder_prefix = "INBOX/";
4972 $trash_folder = "Trash";
4973 $sent_folder = "Sent";
4974 $draft_folder = "Drafts";
4975 $show_prefix_option = false
;
4976 $default_sub_of_inbox = true
;
4977 $show_contain_subfolders_option = false
;
4978 $optional_delimiter = "detect";
4979 $allow_charset_search = false
;
4980 $disp_default_folder_prefix = $default_folder_prefix;
4983 } elsif ( $server eq "hmailserver" ) {
4984 $imap_server_type = "hmailserver";
4985 $default_folder_prefix = "";
4986 $trash_folder = "INBOX.Trash";
4987 $sent_folder = "INBOX.Sent";
4988 $draft_folder = "INBOX.Drafts";
4989 $show_prefix_option = false
;
4990 $default_sub_of_inbox = true
;
4991 $show_contain_subfolders_option = false
;
4992 $optional_delimiter = "detect";
4993 $allow_charset_search = false
;
4994 $disp_default_folder_prefix = $default_folder_prefix;
4995 $delete_folder = false
;
4996 $force_username_lowercase = false
;
4999 } elsif ( $server eq "mercury32" ) {
5000 $imap_server_type = "mercury32";
5001 $default_folder_prefix = "";
5002 $trash_folder = "Trash";
5003 $sent_folder = "Sent";
5004 $draft_folder = "Drafts";
5005 $show_prefix_option = false
;
5006 $default_sub_of_inbox = true
;
5007 $show_contain_subfolders_option = true
;
5008 $optional_delimiter = "detect";
5009 $delete_folder = true
;
5010 $force_username_lowercase = true
;
5013 } elsif ( $server eq "dovecot" ) {
5014 $imap_server_type = "dovecot";
5015 $default_folder_prefix = "";
5016 $trash_folder = "Trash";
5017 $sent_folder = "Sent";
5018 $draft_folder = "Drafts";
5019 $show_prefix_option = false
;
5020 $default_sub_of_inbox = false
;
5021 $show_contain_subfolders_option = false
;
5022 $delete_folder = false
;
5023 $force_username_lowercase = true
;
5024 $optional_delimiter = "detect";
5025 $disp_default_folder_prefix = "<none>";
5028 } elsif ( $server eq "bincimap" ) {
5029 $imap_server_type = "bincimap";
5030 $default_folder_prefix = "INBOX/";
5031 $trash_folder = "Trash";
5032 $sent_folder = "Sent";
5033 $draft_folder = "Drafts";
5034 $show_prefix_option = false
;
5035 $default_sub_of_inbox = false
;
5036 $show_contain_subfolders_option = false
;
5037 $delete_folder = true
;
5038 $force_username_lowercase = false
;
5039 $optional_delimiter = "detect";
5040 $disp_default_folder_prefix = $default_folder_prefix;
5042 # Default folder prefix depends on used depot.
5043 $message = "\nIf you use IMAPdir depot, you must set default folder prefix to empty string.\n";
5046 } elsif ( $server eq "quit" ) {
5049 $disp_default_folder_prefix = $default_folder_prefix;
5050 print "Unrecognized server: $server\n";
5054 print " imap_server_type = $imap_server_type\n";
5055 print " default_folder_prefix = $disp_default_folder_prefix\n";
5056 print " trash_folder = $trash_folder\n";
5057 print " sent_folder = $sent_folder\n";
5058 print " draft_folder = $draft_folder\n";
5059 print " show_prefix_option = $show_prefix_option\n";
5060 print " default_sub_of_inbox = $default_sub_of_inbox\n";
5061 print "show_contain_subfolders_option = $show_contain_subfolders_option\n";
5062 print " optional_delimiter = $optional_delimiter\n";
5063 print " delete_folder = $delete_folder\n";
5064 print " force_username_lowercase = $force_username_lowercase\n";
5068 print "\nPress enter to continue...";
5072 # This subroutine corrects relative paths to ensure they
5073 # will work within the SM space. If the path falls within
5074 # the SM directory tree, the SM_PATH variable will be
5075 # prepended to the path, if not, then the path will be
5076 # converted to an absolute path, e.g.
5077 # '../images/logo.gif' --> SM_PATH . 'images/logo.gif'
5078 # '../../someplace/data' --> '/absolute/path/someplace/data'
5079 # 'images/logo.gif' --> SM_PATH . 'config/images/logo.gif'
5080 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
5081 # 'http://whatever/' --> 'http://whatever'
5082 # $some_var/path --> "$some_var/path"
5083 sub change_to_SM_path
() {
5084 my ($old_path) = @_;
5090 # If the path is absolute, don't bother.
5091 return "\'" . $old_path . "\'" if ( $old_path eq '');
5092 return "\'" . $old_path . "\'" if ( $old_path =~ /^(\/|http
)/ );
5093 return "\'" . $old_path . "\'" if ( $old_path =~ /^\w:\// );
5094 return $old_path if ( $old_path =~ /^\'(\/|http
)/ );
5095 return $old_path if ( $old_path =~ /^\'\w:\// );
5096 return $old_path if ( $old_path =~ /^SM_PATH/);
5098 if ( $old_path =~ /^\$/ ) {
5099 # check if it's a single var, or a $var/path combination
5100 # if it's $var/path, enclose in ""
5101 if ( $old_path =~ /\// ) {
5102 return '"'.$old_path.'"';
5107 # Remove remaining '
5108 $old_path =~ s/\'//g;
5110 # For relative paths, split on '../'
5111 @rel_path = split(/\.\.\//, $old_path);
5113 if ( $#rel_path > 1 ) {
5114 # more than two levels away. Make it absolute.
5115 @abs_path = split(/\//, $dir);
5117 # Lop off the relative pieces of the absolute path..
5118 for ( $i = 0; $i <= $#rel_path; $i++ ) {
5122 push @abs_path, @rel_path;
5123 $new_path = "\'" . join('/', @abs_path) . "\'";
5124 } elsif ( $#rel_path > 0 ) {
5125 # it's within the SM tree, prepend SM_PATH
5126 $new_path = $old_path;
5127 $new_path =~ s/^\.\.\//SM_PATH
. \'/;
5130 # Last, it's a relative path without any leading '.'
5131 # Prepend SM_PATH and config, since the paths are
5132 # relative to the config directory
5133 $new_path = "SM_PATH . \'config/" . $old_path . "\'";
5139 # Change SM_PATH to admin-friendly version, e.g.:
5140 # SM_PATH . 'images/logo.gif' --> '../images/logo.gif'
5141 # SM_PATH . 'config/some.php' --> 'some.php'
5142 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
5143 # 'http://whatever/' --> 'http://whatever'
5144 sub change_to_rel_path
() {
5145 my ($old_path) = @_;
5146 my $new_path = $old_path;
5148 if ( $old_path =~ /^SM_PATH/ ) {
5149 # FIXME: the following replacement loses the opening quote mark!
5150 $new_path =~ s/^SM_PATH . \'/\.\.\//;
5151 $new_path =~ s/\.\.\/config\///;
5157 # Attempts to auto-detect if a specific auth mechanism is supported.
5158 # Called by 'command112a' and 'command112b'
5159 # ARGS: service-name (IMAP or SMTP), host:port, mech-name (ie. CRAM-MD5)
5160 sub detect_auth_support
{
5161 # Try loading IO::Socket
5162 unless (eval("use IO::Socket; 1")) {
5163 print "Perl IO::Socket module is not available.";
5167 my $service = shift;
5171 if ((!defined($service)) or (!defined($host)) or (!defined($mech))) {
5172 # Error - wrong # of args
5173 print "BAD ARGS!\n";
5177 if ($service eq 'SMTP') {
5178 $cmd = "AUTH $mech\r\n";
5179 $logout = "QUIT\r\n";
5180 } elsif ($service eq 'IMAP') {
5181 $cmd = "A01 AUTHENTICATE $mech\n";
5182 $logout = "C01 LOGOUT\n";
5184 # unknown service - whoops.
5188 # Get this show on the road
5189 my $sock=IO
::Socket
::INET
->new($host);
5190 if (!defined($sock)) {
5194 my $discard = <$sock>; # Server greeting/banner - who cares..
5196 if ($service eq 'SMTP') {
5198 print $sock "HELO $domain\r\n";
5199 $discard = <$sock>; # Yeah yeah, you're happy to see me..
5203 my $response = <$sock>;
5205 if (!defined($response)) {
5209 # So at this point, we have a response, and it is (hopefully) valid.
5210 if ($service eq 'SMTP') {
5211 if (!($response =~ /^334/)) {
5213 print $sock $logout;
5217 } elsif ($service eq 'IMAP') {
5218 if ($response =~ /^A01/) {
5220 print $sock $logout;
5225 # Unknown service - this shouldn't be able to happen.
5230 # If it gets here, the mech is supported
5231 print $sock "*\n"; # Attempt to cancel authentication
5232 print $sock $logout; # Try to log out, but we don't really care if this fails
5238 # Example code from O'Reilly Perl Cookbook
5245 return wantarray ?
@out : $out[0];
5248 sub clear_screen
() {
5249 if ( $^O
=~ /^mswin/i) {
5256 # checks IMAP mailbox name. Refuses to accept 8bit folders
5257 # returns 0 (folder name is not correct) or 1 (folder name is correct)
5258 sub check_imap_folder
($) {
5259 my $folder_name = shift(@_);
5261 if ($folder_name =~ /[\x80-\xFFFF]/) {
5262 print "Folder name contains 8bit characters. Configuration utility requires\n";
5263 print "UTF7-IMAP encoded folder names.\n";
5264 print "Press enter to continue...";
5267 } elsif ($folder_name =~ /[&\*\%]/) {
5268 # check for ampersand and list-wildcards
5269 print "Folder name contains special UTF7-IMAP characters.\n";
5270 print "Are you sure that folder name is correct? (y/N): ";
5272 $tmp = lc(trim
($tmp));
5273 if ($tmp =~ /^y$/) {
5283 # quotes string written in single quotes
5284 sub quote_single
($) {
5285 my $string = shift(@_);
5286 $string =~ s/\'/\\'/g;
5290 # determine a plugin's version number
5292 # parses the setup.php file, looking for the
5293 # version string in the <plugin>_info() or the
5294 # <plugin>_version functions.
5296 sub get_plugin_version
() {
5298 my $plugin_name = shift(@_);
5300 $setup_file = '../plugins/' . $plugin_name . '/setup.php';
5301 if ( -e
"$setup_file" ) {
5302 # Make sure that file is readable
5303 if (! -r
"$setup_file") {
5306 print "The file \"$setup_file\" was found, but you don't\n";
5307 print "have rights to read it. The plugin \"";
5308 print $plugin_name . "\" may not work correctly until you fix this.\n";
5309 print "\nPress enter to continue";
5316 # FIXME: grep the file instead of reading it into memory?
5318 open( FILE
, "$setup_file" );
5319 while ( $line = <FILE
> ) {
5320 $whole_file .= $line;
5324 # ideally, there is a version in the <plugin>_info function...
5326 if ($whole_file =~ /('version'\s*=>\s*['"](.*?)['"])/) {
5329 # this assumes there is only one function that returns
5330 # a static string in the setup file
5332 } elsif ($whole_file =~ /(return\s*['"](.*?)['"])/) {
5341 print "The file \"$setup_file\" was not found.\n";
5342 print "The plugin \"" . $plugin_name;
5343 print "\" may not work correctly until you fix this.\n";
5344 print "\nPress enter to continue";
5352 # determine a plugin's English name
5354 # parses the setup.php file, looking for the
5355 # English name in the <plugin>_info() function.
5357 sub get_plugin_english_name
() {
5359 my $plugin_name = shift(@_);
5361 $setup_file = '../plugins/' . $plugin_name . '/setup.php';
5362 if ( -e
"$setup_file" ) {
5363 # Make sure that file is readable
5364 if (! -r
"$setup_file") {
5367 print "The file \"$setup_file\" was found, but you don't\n";
5368 print "have rights to read it. The plugin \"";
5369 print $plugin_name . "\" may not work correctly until you fix this.\n";
5370 print "\nPress enter to continue";
5377 # FIXME: grep the file instead of reading it into memory?
5379 open( FILE
, "$setup_file" );
5380 while ( $line = <FILE
> ) {
5381 $whole_file .= $line;
5385 # the English name is in the <plugin>_info function or nothing...
5387 if ($whole_file =~ /('english_name'\s*=>\s*['"](.*?)['"])/) {
5388 $english_name .= $2;
5391 return $english_name;
5396 print "The file \"$setup_file\" was not found.\n";
5397 print "The plugin \"" . $plugin_name;
5398 print "\" may not work correctly until you fix this.\n";
5399 print "\nPress enter to continue";
5407 # parses the setup.php files for all activated plugins and
5408 # builds static plugin hooks array so we don't have to load
5409 # ALL plugins are runtime and build the hook array on every
5412 # hook array is saved in config/plugin_hooks.php
5414 # Note the $verbose variable at the top of this routine
5415 # can be set to zero to quiet it down.
5417 # NOTE/FIXME: we aren't necessarily interested in writing
5418 # a full-blown PHP parsing engine, so plenty
5419 # of assumptions are included herein about the
5420 # coding of the plugin setup files, and things
5421 # like commented out curly braces or other
5422 # such oddities can break this in a bad way.
5424 sub build_plugin_hook_array
() {
5432 if ( open( HOOKFILE
, ">plugin_hooks.php" ) ) {
5433 print HOOKFILE
"<?php\n";
5434 print HOOKFILE
"\n";
5436 print HOOKFILE
"/**\n";
5437 print HOOKFILE
" * SquirrelMail Plugin Hook Registration File\n";
5438 print HOOKFILE
" * Auto-generated using the configure script, conf.pl\n";
5439 print HOOKFILE
" */\n";
5440 print HOOKFILE
"\n";
5441 print HOOKFILE
"global \$squirrelmail_plugin_hooks;\n";
5442 print HOOKFILE
"\n";
5444 PLUGIN
: for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
5447 print "Activating plugin \"" . $plugins[$ct] . "\"...\n";
5450 $setup_file = '../plugins/' . $plugins[$ct] . '/setup.php';
5451 if ( -e
"$setup_file" ) {
5452 # Make sure that file is readable
5453 if (! -r
"$setup_file") {
5456 print "The file \"$setup_file\" was found, but you don't\n";
5457 print "have rights to read it. The plugin \"";
5458 print $plugins[$ct] . "\" will not be activated until you fix this.\n";
5459 print "\nPress enter to continue";
5464 open( FILE
, "$setup_file" );
5465 $inside_init_fxn = 0;
5467 while ( $line = <FILE
> ) {
5469 # throw away lines until we get to target function
5471 if (!$inside_init_fxn
5472 && $line !~ /^\s*function\s*squirrelmail_plugin_init_/i) {
5475 $inside_init_fxn = 1;
5485 # count close braces
5490 # leaving <plugin>_init() function...
5491 if ($brace_count == 0) {
5499 # throw away lines that are not exactly one "brace set" deep
5501 if ($brace_count > 1) {
5506 # also not interested in lines that are not
5507 # hook registration points
5509 if ($line !~ /^\s*\$squirrelmail_plugin_hooks/i) {
5514 # if $line does not have an ending semicolon,
5515 # we need to recursively read in subsequent
5516 # lines until we find one
5517 while ( $line !~ /;\s*$/ ) {
5518 $line =~ s/[\n\r]\s*$//;
5527 $var =~ s/=/EQUALS/;
5528 if ( $var =~ /^([a-z])/i ) {
5529 @options = split ( /\s*EQUALS\s*/, $var );
5530 $options[1] =~ s/[\n\r]//g;
5531 $options[1] =~ s/[\'\"];\s*$//;
5532 $options[1] =~ s/;$//;
5533 $options[1] =~ s/^[\'\"]//;
5534 # de-escape escaped strings
5535 $options[1] =~ s/\\'/'/g;
5536 $options[1] =~ s/\\\\/\\/g;
5538 if ( $options[0] =~ /^squirrelmail_plugin_hooks\s*\[\s*['"]([a-z0-9 \/._
*-]+)['"]\s*\]\s*\[\s*['"]([0-9a-z._-]+)['"]\s
*\
]/i
) {
5540 $hooked_plugin_name = $2;
5541 # Note: if we wanted to stop plugins from registering
5542 # a *different* plugin on a hook, we could catch
5543 # it here, however this has actually proven to be
5544 # a useful *feature*
5545 #if ($hooked_plugin_name ne $plugins[$ct]) {
5546 # print "...plugin is tring to hook in under different name...\n";
5549 #FIXME: do we want to count the number of hook registrations for each plugin and warn if a plugin doesn't have any?
5550 # hook registration has been found!
5552 if ($hooked_plugin_name ne $plugins[$ct]) {
5553 print " registering on hook \"" . $hook_name . "\" (as \"$hooked_plugin_name\" plugin)\n";
5555 print " registering on hook \"" . $hook_name . "\"\n";
5558 $line =~ s/ {2,}/ /g;
5560 print HOOKFILE
"\$$line";
5572 print "The file \"$setup_file\" was not found.\n";
5573 print "The plugin \"" . $plugins[$ct];
5574 print "\" will not be activated until you fix this.\n";
5575 print "\nPress enter to continue";
5583 print HOOKFILE
"\n\n";
5586 print "\nDone activating plugins; registration data saved in plugin_hooks.php\n\n";
5593 print "The file \"plugin_hooks.php\" was not able to be written to.\n";
5594 print "No plugins will be activated until you fix this.\n";
5595 print "\nPress enter to continue";
5603 # converts (binary) integer values that correspond
5604 # to the SquirrelMail debug mode constants (see
5605 # include/constants.php) into those constant strings
5606 # (bitwise or'd if more than one is enabled)
5608 # if the value passed in is not an integer, it is
5609 # returned unmolested
5611 sub convert_debug_binary_integer_to_constants
() {
5613 my ($debug_mode) = @_;
5614 if ($debug_mode =~ /^[^0-9]/) {
5617 $debug_mode = int($debug_mode);
5618 $new_debug_mode = '';
5620 # per include/constants.php, here are their values:
5622 # 0 SM_DEBUG_MODE_OFF
5623 # 1 SM_DEBUG_MODE_SIMPLE
5624 # 512 SM_DEBUG_MODE_MODERATE
5625 # 524288 SM_DEBUG_MODE_ADVANCED
5626 # 536870912 SM_DEBUG_MODE_STRICT
5628 if ($debug_mode & 1) {
5629 $new_debug_mode .= ' | SM_DEBUG_MODE_SIMPLE';
5631 if ($debug_mode & 512) {
5632 $new_debug_mode .= ' | SM_DEBUG_MODE_MODERATE';
5634 if ($debug_mode & 524288) {
5635 $new_debug_mode .= ' | SM_DEBUG_MODE_ADVANCED';
5637 if ($debug_mode & 536870912) {
5638 $new_debug_mode .= ' | SM_DEBUG_MODE_STRICT';
5641 $new_debug_mode =~ s/^ \| //;
5642 if (!$new_debug_mode) {
5643 $new_debug_mode = 'SM_DEBUG_MODE_OFF';
5646 return $new_debug_mode;
5649 # converts SquirrelMail debug mode constants (see
5650 # include/constants.php) into their corresponding
5651 # (binary) integer values
5653 # if the value passed in is an integer already, it
5654 # is returned unmolested
5656 sub convert_debug_constants_to_binary_integer
() {
5658 my ($debug_mode) = @_;
5659 if ($debug_mode =~ /^[0-9]/) {
5662 $new_debug_mode = 0;
5664 # per include/constants.php, here are their values:
5666 # 0 SM_DEBUG_MODE_OFF
5667 # 1 SM_DEBUG_MODE_SIMPLE
5668 # 512 SM_DEBUG_MODE_MODERATE
5669 # 524288 SM_DEBUG_MODE_ADVANCED
5670 # 536870912 SM_DEBUG_MODE_STRICT
5672 if ($debug_mode =~ /\bSM_DEBUG_MODE_OFF\b/) {
5673 $new_debug_mode = 0;
5675 if ($debug_mode =~ /\bSM_DEBUG_MODE_SIMPLE\b/) {
5676 $new_debug_mode |= 1;
5678 if ($debug_mode =~ /\bSM_DEBUG_MODE_MODERATE\b/) {
5679 $new_debug_mode |= 512;
5681 if ($debug_mode =~ /\bSM_DEBUG_MODE_ADVANCED\b/) {
5682 $new_debug_mode |= 524288;
5684 if ($debug_mode =~ /\bSM_DEBUG_MODE_STRICT\b/) {
5685 $new_debug_mode |= 536870912;
5688 return $new_debug_mode;