Change to store template ID and not path; also bug fixes and fine-tuning the detectio...
[squirrelmail.git] / config / conf.pl
1 #!/usr/bin/env perl
2 # conf.pl
3 #
4 # Copyright (c) 1999-2006 The SquirrelMail Project Team
5 # Licensed under the GNU GPL. For full terms see COPYING.
6 #
7 # A simple configure script to configure SquirrelMail
8 #
9 # $Id$
10 ############################################################
11 $conf_pl_version = "1.4.0";
12
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 ############################################################
19 my $dir;
20 if ( eval q{require "File/Basename.pm"} ) {
21 $dir = File::Basename::dirname($0);
22 chdir($dir);
23 }
24
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.";
33 exit;
34 }
35
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 ############################################################
41 use Cwd;
42 $dir = cwd();
43
44
45 ############################################################
46 # First, lets read in the data already in there...
47 ############################################################
48 if ( -e "config.php" ) {
49 open( FILE, "config.php" );
50 while ( $line = <FILE> ) {
51 $line =~ s/^\s+//;
52 $line =~ s/^\$//;
53 $var = $line;
54
55 $var =~ s/=/EQUALS/;
56 if ( $var =~ /^([a-z])/i ) {
57 @o = split ( /\s*EQUALS\s*/, $var );
58 if ( $o[0] eq "config_version" ) {
59 $o[1] =~ s/[\n\r]//g;
60 $o[1] =~ s/[\'\"];\s*$//;
61 $o[1] =~ s/;$//;
62 $o[1] =~ s/^[\'\"]//;
63
64 $config_version = $o[1];
65 close(FILE);
66 }
67 }
68 }
69 close(FILE);
70
71 if ( $config_version ne $conf_pl_version ) {
72 clear_screen();
73 print $WHT. "WARNING:\n" . $NRM;
74 print " The file \"config/config.php\" was found, but it is for\n";
75 print " an older version of SquirrelMail. It is possible to still\n";
76 print " read the defaults from this file but be warned that many\n";
77 print " preferences change between versions. It is recommended that\n";
78 print " you start with a clean config.php for each upgrade that you\n";
79 print " do. To do this, just move config/config.php out of the way.\n";
80 print "\n";
81 print "Continue loading with the old config.php [y/N]? ";
82 $ctu = <STDIN>;
83
84 if ( ( $ctu !~ /^y\n/i ) || ( $ctu =~ /^\n/ ) ) {
85 exit;
86 }
87
88 print "\nDo you want me to stop warning you [y/N]? ";
89 $ctu = <STDIN>;
90 if ( $ctu =~ /^y\n/i ) {
91 $print_config_version = $conf_pl_version;
92 } else {
93 $print_config_version = $config_version;
94 }
95 } else {
96 $print_config_version = $config_version;
97 }
98
99 $config = 1;
100 open( FILE, "config.php" );
101 } elsif ( -e "config_default.php" ) {
102 open( FILE, "config_default.php" );
103 while ( $line = <FILE> ) {
104 $line =~ s/^\s+//;
105 $line =~ s/^\$//;
106 $var = $line;
107
108 $var =~ s/=/EQUALS/;
109 if ( $var =~ /^([a-z])/i ) {
110 @o = split ( /\s*EQUALS\s*/, $var );
111 if ( $o[0] eq "config_version" ) {
112 $o[1] =~ s/[\n\r]//g;
113 $o[1] =~ s/[\'\"];\s*$//;
114 $o[1] =~ s/;$//;
115 $o[1] =~ s/^[\'\"]//;
116
117 $config_version = $o[1];
118 close(FILE);
119 }
120 }
121 }
122 close(FILE);
123
124 if ( $config_version ne $conf_pl_version ) {
125 clear_screen();
126 print $WHT. "WARNING:\n" . $NRM;
127 print " You are trying to use a 'config_default.php' from an older\n";
128 print " version of SquirrelMail. This is HIGHLY unrecommended. You\n";
129 print " should get the 'config_default.php' that matches the version\n";
130 print " of SquirrelMail that you are running. You can get this from\n";
131 print " the SquirrelMail web page by going to the following URL:\n";
132 print " http://www.squirrelmail.org.\n";
133 print "\n";
134 print "Continue loading with old config_default.php (a bad idea) [y/N]? ";
135 $ctu = <STDIN>;
136
137 if ( ( $ctu !~ /^y\n/i ) || ( $ctu =~ /^\n/ ) ) {
138 exit;
139 }
140
141 print "\nDo you want me to stop warning you [y/N]? ";
142 $ctu = <STDIN>;
143 if ( $ctu =~ /^y\n/i ) {
144 $print_config_version = $conf_pl_version;
145 } else {
146 $print_config_version = $config_version;
147 }
148 } else {
149 $print_config_version = $config_version;
150 }
151 $config = 2;
152 open( FILE, "config_default.php" );
153 } else {
154 print "No configuration file found. Please get config_default.php\n";
155 print "or config.php before running this again. This program needs\n";
156 print "a default config file to get default values.\n";
157 exit;
158 }
159
160 # Read and parse the current configuration file
161 # (either config.php or config_default.php).
162 while ( $line = <FILE> ) {
163 $line =~ s/^\s+//;
164 $line =~ s/^\$//;
165 $var = $line;
166
167 $var =~ s/=/EQUALS/;
168 if ( $var =~ /^([a-z])/i ) {
169 @options = split ( /\s*EQUALS\s*/, $var );
170 $options[1] =~ s/[\n\r]//g;
171 $options[1] =~ s/[\'\"];\s*$//;
172 $options[1] =~ s/;$//;
173 $options[1] =~ s/^[\'\"]//;
174 # de-escape escaped strings
175 $options[1] =~ s/\\'/'/g;
176 $options[1] =~ s/\\\\/\\/g;
177
178 if ( $options[0] =~ /^theme\[[0-9]+\]\[['"]PATH['"]\]/ ) {
179 $sub = $options[0];
180 $sub =~ s/\]\[['"]PATH['"]\]//;
181 $sub =~ s/.*\[//;
182 if ( -e "../themes" ) {
183 $options[1] =~ s/^\.\.\/config/\.\.\/themes/;
184 }
185 $theme_path[$sub] = &change_to_rel_path($options[1]);
186 } elsif ( $options[0] =~ /^theme\[[0-9]+\]\[['"]NAME['"]\]/ ) {
187 $sub = $options[0];
188 $sub =~ s/\]\[['"]NAME['"]\]//;
189 $sub =~ s/.*\[//;
190 $theme_name[$sub] = $options[1];
191 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]ID['"]\]/ ) {
192 $sub = $options[0];
193 $sub =~ s/\]\[['"]ID['"]\]//;
194 $sub =~ s/.*\[//;
195 if ( -e "../templates" ) {
196 $options[1] =~ s/^\.\.\/config/\.\.\/templates/;
197 }
198 $templateset_id[$sub] = $options[1];
199 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]NAME['"]\]/ ) {
200 $sub = $options[0];
201 $sub =~ s/\]\[['"]NAME['"]\]//;
202 $sub =~ s/.*\[//;
203 $templateset_name[$sub] = $options[1];
204 } elsif ( $options[0] =~ /^plugins\[[0-9]*\]/ ) {
205 $sub = $options[0];
206 $sub =~ s/\]//;
207 $sub =~ s/^plugins\[//;
208 if ($sub eq '') {
209 push @plugins, $options[1];
210 } else {
211 $plugins[$sub] = $options[1];
212 }
213 } elsif ($options[0] =~ /^fontsets\[\'[a-z]*\'\]/) {
214 # parse associative $fontsets array
215 $sub = $options[0];
216 $sub =~ s/\'\]//;
217 $sub =~ s/^fontsets\[\'//;
218 $fontsets{$sub} = $options[1];
219 } elsif ( $options[0] =~ /^ldap_server\[[0-9]+\]/ ) {
220 $sub = $options[0];
221 $sub =~ s/\]//;
222 $sub =~ s/^ldap_server\[//;
223 $continue = 0;
224 while ( ( $tmp = <FILE> ) && ( $continue != 1 ) ) {
225 if ( $tmp =~ /\);\s*$/ ) {
226 $continue = 1;
227 }
228
229 if ( $tmp =~ /^\s*[\'\"]host[\'\"]/i ) {
230 $tmp =~ s/^\s*[\'\"]host[\'\"]\s*=>\s*[\'\"]//i;
231 $tmp =~ s/[\'\"],?\s*$//;
232 $tmp =~ s/[\'\"]\);\s*$//;
233 $host = $tmp;
234 } elsif ( $tmp =~ /^\s*[\'\"]base[\'\"]/i ) {
235 $tmp =~ s/^\s*[\'\"]base[\'\"]\s*=>\s*[\'\"]//i;
236 $tmp =~ s/[\'\"],?\s*$//;
237 $tmp =~ s/[\'\"]\);\s*$//;
238 $base = $tmp;
239 } elsif ( $tmp =~ /^\s*[\'\"]charset[\'\"]/i ) {
240 $tmp =~ s/^\s*[\'\"]charset[\'\"]\s*=>\s*[\'\"]//i;
241 $tmp =~ s/[\'\"],?\s*$//;
242 $tmp =~ s/[\'\"]\);\s*$//;
243 $charset = $tmp;
244 } elsif ( $tmp =~ /^\s*[\'\"]port[\'\"]/i ) {
245 $tmp =~ s/^\s*[\'\"]port[\'\"]\s*=>\s*[\'\"]?//i;
246 $tmp =~ s/[\'\"]?,?\s*$//;
247 $tmp =~ s/[\'\"]?\);\s*$//;
248 $port = $tmp;
249 } elsif ( $tmp =~ /^\s*[\'\"]maxrows[\'\"]/i ) {
250 $tmp =~ s/^\s*[\'\"]maxrows[\'\"]\s*=>\s*[\'\"]?//i;
251 $tmp =~ s/[\'\"]?,?\s*$//;
252 $tmp =~ s/[\'\"]?\);\s*$//;
253 $maxrows = $tmp;
254 } elsif ( $tmp =~ /^\s*[\'\"]filter[\'\"]/i ) {
255 $tmp =~ s/^\s*[\'\"]filter[\'\"]\s*=>\s*[\'\"]?//i;
256 $tmp =~ s/[\'\"]?,?\s*$//;
257 $tmp =~ s/[\'\"]?\);\s*$//;
258 $filter = $tmp;
259 } elsif ( $tmp =~ /^\s*[\'\"]name[\'\"]/i ) {
260 $tmp =~ s/^\s*[\'\"]name[\'\"]\s*=>\s*[\'\"]//i;
261 $tmp =~ s/[\'\"],?\s*$//;
262 $tmp =~ s/[\'\"]\);\s*$//;
263 $name = $tmp;
264 } elsif ( $tmp =~ /^\s*[\'\"]binddn[\'\"]/i ) {
265 $tmp =~ s/^\s*[\'\"]binddn[\'\"]\s*=>\s*[\'\"]//i;
266 $tmp =~ s/[\'\"],?\s*$//;
267 $tmp =~ s/[\'\"]\);\s*$//;
268 $binddn = $tmp;
269 } elsif ( $tmp =~ /^\s*[\'\"]bindpw[\'\"]/i ) {
270 $tmp =~ s/^\s*[\'\"]bindpw[\'\"]\s*=>\s*[\'\"]//i;
271 $tmp =~ s/[\'\"],?\s*$//;
272 $tmp =~ s/[\'\"]\);\s*$//;
273 $bindpw = $tmp;
274 } elsif ( $tmp =~ /^\s*[\'\"]protocol[\'\"]/i ) {
275 $tmp =~ s/^\s*[\'\"]protocol[\'\"]\s*=>\s*[\'\"]?//i;
276 $tmp =~ s/[\'\"]?,?\s*$//;
277 $tmp =~ s/[\'\"]?\);\s*$//;
278 $protocol = $tmp;
279 } elsif ( $tmp =~ /^\s*[\'\"]limit_scope[\'\"]/i ) {
280 $tmp =~ s/^\s*[\'\"]limit_scope[\'\"]\s*=>\s*[\'\"]?//i;
281 $tmp =~ s/[\'\"]?,?\s*$//;
282 $tmp =~ s/[\'\"]?\);\s*$//;
283 $limit_scope = $tmp;
284 } elsif ( $tmp =~ /^\s*[\'\"]listing[\'\"]/i ) {
285 $tmp =~ s/^\s*[\'\"]listing[\'\"]\s*=>\s*[\'\"]?//i;
286 $tmp =~ s/[\'\"]?,?\s*$//;
287 $tmp =~ s/[\'\"]?\);\s*$//;
288 $listing = $tmp;
289 } elsif ( $tmp =~ /^\s*[\'\"]writeable[\'\"]/i ) {
290 $tmp =~ s/^\s*[\'\"]writeable[\'\"]\s*=>\s*[\'\"]?//i;
291 $tmp =~ s/[\'\"]?,?\s*$//;
292 $tmp =~ s/[\'\"]?\);\s*$//;
293 $writeable = $tmp;
294 } elsif ( $tmp =~ /^\s*[\'\"]search_tree[\'\"]/i ) {
295 $tmp =~ s/^\s*[\'\"]search_tree[\'\"]\s*=>\s*[\'\"]?//i;
296 $tmp =~ s/[\'\"]?,?\s*$//;
297 $tmp =~ s/[\'\"]?\);\s*$//;
298 $search_tree = $tmp;
299 } elsif ( $tmp =~ /^\s*[\'\"]starttls[\'\"]/i ) {
300 $tmp =~ s/^\s*[\'\"]starttls[\'\"]\s*=>\s*[\'\"]?//i;
301 $tmp =~ s/[\'\"]?,?\s*$//;
302 $tmp =~ s/[\'\"]?\);\s*$//;
303 $starttls = $tmp;
304 }
305 }
306 $ldap_host[$sub] = $host;
307 $ldap_base[$sub] = $base;
308 $ldap_name[$sub] = $name;
309 $ldap_port[$sub] = $port;
310 $ldap_maxrows[$sub] = $maxrows;
311 $ldap_filter[$sub] = $filter;
312 $ldap_charset[$sub] = $charset;
313 $ldap_binddn[$sub] = $binddn;
314 $ldap_bindpw[$sub] = $bindpw;
315 $ldap_protocol[$sub] = $protocol;
316 $ldap_limit_scope[$sub] = $limit_scope;
317 $ldap_listing[$sub] = $listing;
318 $ldap_writeable[$sub] = $writeable;
319 $ldap_search_tree[$sub] = $search_tree;
320 $ldap_starttls[$sub] = $starttls;
321 } elsif ( $options[0] =~ /^(data_dir|attachment_dir|theme_css|org_logo|signout_page|icon_theme_def)$/ ) {
322 ${ $options[0] } = &change_to_rel_path($options[1]);
323 } else {
324 ${ $options[0] } = $options[1];
325 }
326 }
327 }
328 close FILE;
329
330 # FIXME: unknown introduction date
331 $useSendmail = 'false' if ( lc($useSendmail) ne 'true' );
332 $sendmail_path = "/usr/sbin/sendmail" if ( !$sendmail_path );
333 $pop_before_smtp = 'false' if ( !$pop_before_smtp );
334 $default_unseen_notify = 2 if ( !$default_unseen_notify );
335 $default_unseen_type = 1 if ( !$default_unseen_type );
336 $config_use_color = 0 if ( !$config_use_color );
337 $invert_time = 'false' if ( !$invert_time );
338 $force_username_lowercase = 'false' if ( !$force_username_lowercase );
339 $optional_delimiter = "detect" if ( !$optional_delimiter );
340 $auto_create_special = 'false' if ( !$auto_create_special );
341 $default_use_priority = 'true' if ( !$default_use_priority );
342 $default_use_mdn = 'true' if ( !$default_use_mdn );
343 $delete_folder = 'false' if ( !$delete_folder );
344 $noselect_fix_enable = 'false' if ( !$noselect_fix_enable );
345 $frame_top = "_top" if ( !$frame_top );
346 $provider_uri = '' if ( !$provider_uri );
347 $provider_name = '' if ( !$provider_name );
348 $edit_identity = 'true' if ( !$edit_identity );
349 $edit_name = 'true' if ( !$edit_name );
350 $no_list_for_subscribe = 'false' if ( !$no_list_for_subscribe );
351 $allow_charset_search = 'true' if ( !$allow_charset_search );
352 $allow_advanced_search = 0 if ( !$allow_advanced_search) ;
353 $prefs_user_field = 'user' if ( !$prefs_user_field );
354 $prefs_key_field = 'prefkey' if ( !$prefs_key_field );
355 $prefs_val_field = 'prefval' if ( !$prefs_val_field );
356 $session_name = 'SQMSESSID' if ( !$session_name );
357 $skip_SM_header = 'false' if ( !$skip_SM_header );
358 $default_use_javascript_addr_book = 'false' if (! $default_use_javascript_addr_book);
359
360 # since 1.2.0
361 $hide_sm_attributions = 'false' if ( !$hide_sm_attributions );
362
363 # since 1.4.0
364 $use_smtp_tls= 'false' if ( !$use_smtp_tls);
365 $smtp_auth_mech = 'none' if ( !$smtp_auth_mech );
366 $use_imap_tls = 'false' if ( !$use_imap_tls );
367 $imap_auth_mech = 'login' if ( !$imap_auth_mech );
368
369 # since 1.5.0
370 $show_alternative_names = 'false' if ( !$show_alternative_names );
371 # $available_languages option available only in 1.5.0. removed due to $languages
372 # implementation changes. options are provided by limit_languages plugin
373 # $available_languages = 'all' if ( !$available_languages );
374 $aggressive_decoding = 'false' if ( !$aggressive_decoding );
375 # available only in 1.5.0 and 1.5.1
376 # $advanced_tree = 'false' if ( !$advanced_tree );
377 $use_php_recode = 'false' if ( !$use_php_recode );
378 $use_php_iconv = 'false' if ( !$use_php_iconv );
379
380 # since 1.5.1
381 $use_icons = 'false' if ( !$use_icons );
382 $use_iframe = 'false' if ( !$use_iframe );
383 $lossy_encoding = 'false' if ( !$lossy_encoding );
384 $allow_remote_configtest = 'false' if ( !$allow_remote_configtest );
385 $addrbook_global_table = 'global_abook' if ( !$addrbook_global_table );
386 $addrbook_global_writeable = 'false' if ( !$addrbook_global_writeable );
387 $addrbook_global_listing = 'false' if ( !$addrbook_global_listing );
388 $abook_global_file = '' if ( !$abook_global_file);
389 $abook_global_file_writeable = 'false' if ( !$abook_global_file_writeable);
390 $abook_global_file_listing = 'true' if ( !$abook_global_file_listing );
391 $encode_header_key = '' if ( !$encode_header_key );
392 $hide_auth_header = 'false' if ( !$hide_auth_header );
393 $time_zone_type = '0' if ( !$time_zone_type );
394 $prefs_user_size = 128 if ( !$prefs_user_size );
395 $prefs_key_size = 64 if ( !$prefs_key_size );
396 $prefs_val_size = 65536 if ( !$prefs_val_size );
397
398 # since 1.5.2
399 $icon_theme_def = '' if ( !$icon_theme_def );
400
401 # add qmail-inject test here for backwards compatibility
402 if ( !$sendmail_args && $sendmail_path =~ /qmail-inject/ ) {
403 $sendmail_args = '';
404 } elsif ( !$sendmail_args ) {
405 $sendmail_args = '-i -t';
406 }
407
408 $default_fontsize = '' if ( !$default_fontsize);
409 $default_fontset = '' if ( !$default_fontset);
410 if ( !%fontsets) {
411 %fontsets = ('serif', 'serif',
412 'sans', 'helvetica,arial,sans-serif',
413 'comicsans', 'comic sans ms,sans-serif',
414 'tahoma', 'tahoma,sans-serif',
415 'verasans', 'bitstream vera sans,verdana,sans-serif');
416 }
417
418 # $use_imap_tls and $use_smtp_tls are switched to integer since 1.5.1
419 $use_imap_tls = 0 if ( $use_imap_tls eq 'false');
420 $use_imap_tls = 1 if ( $use_imap_tls eq 'true');
421 $use_smtp_tls = 0 if ( $use_smtp_tls eq 'false');
422 $use_smtp_tls = 1 if ( $use_smtp_tls eq 'true');
423 # sorting options changed names and reversed values in 1.5.1
424 $disable_thread_sort = 'false' if ( !$disable_thread_sort );
425 $disable_server_sort = 'false' if ( !$disable_server_sort );
426
427 # since 1.5.2
428 $abook_file_line_length = 2048 if ( !$abook_file_line_length );
429 $config_location_base = '' if ( !$config_location_base );
430 $smtp_sitewide_user = '' if ( !$smtp_sitewide_user );
431 $smtp_sitewide_pass = '' if ( !$smtp_sitewide_pass );
432
433 if ( $ARGV[0] eq '--install-plugin' ) {
434 print "Activating plugin " . $ARGV[1] . "\n";
435 push @plugins, $ARGV[1];
436 save_data();
437 exit(0);
438 } elsif ( $ARGV[0] eq '--remove-plugin' ) {
439 print "Removing plugin " . $ARGV[1] . "\n";
440 foreach $plugin (@plugins) {
441 if ( $plugin ne $ARGV[1] ) {
442 push @newplugins, $plugin;
443 }
444 }
445 @plugins = @newplugins;
446 save_data();
447 exit(0);
448 }
449
450 #####################################################################################
451 if ( $config_use_color == 1 ) {
452 $WHT = "\x1B[37;1m";
453 $NRM = "\x1B[0m";
454 } else {
455 $WHT = "";
456 $NRM = "";
457 $config_use_color = 2;
458 }
459
460 while ( ( $command ne "q" ) && ( $command ne "Q" ) && ( $command ne ":q" ) ) {
461 clear_screen();
462 print $WHT. "SquirrelMail Configuration : " . $NRM;
463 if ( $config == 1 ) { print "Read: config.php"; }
464 elsif ( $config == 2 ) { print "Read: config_default.php"; }
465 print " ($print_config_version)\n";
466 print "---------------------------------------------------------\n";
467
468 if ( $menu == 0 ) {
469 print $WHT. "Main Menu --\n" . $NRM;
470 print "1. Organization Preferences\n";
471 print "2. Server Settings\n";
472 print "3. Folder Defaults\n";
473 print "4. General Options\n";
474 print "5. Templates\n";
475 print "6. Address Books\n";
476 print "7. Message of the Day (MOTD)\n";
477 print "8. Plugins\n";
478 print "9. Database\n";
479 print "10. Language settings\n";
480 print "11. Tweaks\n";
481 print "\n";
482 print "D. Set pre-defined settings for specific IMAP servers\n";
483 print "\n";
484 } elsif ( $menu == 1 ) {
485 print $WHT. "Organization Preferences\n" . $NRM;
486 print "1. Organization Name : $WHT$org_name$NRM\n";
487 print "2. Organization Logo : $WHT$org_logo$NRM\n";
488 print "3. Org. Logo Width/Height : $WHT($org_logo_width/$org_logo_height)$NRM\n";
489 print "4. Organization Title : $WHT$org_title$NRM\n";
490 print "5. Signout Page : $WHT$signout_page$NRM\n";
491 print "6. Top Frame : $WHT$frame_top$NRM\n";
492 print "7. Provider link : $WHT$provider_uri$NRM\n";
493 print "8. Provider name : $WHT$provider_name$NRM\n";
494
495 print "\n";
496 print "R Return to Main Menu\n";
497 } elsif ( $menu == 2 ) {
498 print $WHT. "Server Settings\n\n" . $NRM;
499 print $WHT . "General" . $NRM . "\n";
500 print "-------\n";
501 print "1. Domain : $WHT$domain$NRM\n";
502 print "2. Invert Time : $WHT$invert_time$NRM\n";
503 print "3. Sendmail or SMTP : $WHT";
504 if ( lc($useSendmail) eq 'true' ) {
505 print "Sendmail";
506 } else {
507 print "SMTP";
508 }
509 print "$NRM\n";
510 print "\n";
511
512 if ( $show_imap_settings ) {
513 print $WHT . "IMAP Settings". $NRM . "\n--------------\n";
514 print "4. IMAP Server : $WHT$imapServerAddress$NRM\n";
515 print "5. IMAP Port : $WHT$imapPort$NRM\n";
516 print "6. Authentication type : $WHT$imap_auth_mech$NRM\n";
517 print "7. Secure IMAP (TLS) : $WHT" . display_use_tls($use_imap_tls) . "$NRM\n";
518 print "8. Server software : $WHT$imap_server_type$NRM\n";
519 print "9. Delimiter : $WHT$optional_delimiter$NRM\n";
520 print "\n";
521 } elsif ( $show_smtp_settings ) {
522 if ( lc($useSendmail) eq 'true' ) {
523 print $WHT . "Sendmail" . $NRM . "\n--------\n";
524 print "4. Sendmail Path : $WHT$sendmail_path$NRM\n";
525 print "5. Sendmail arguments : $WHT$sendmail_args$NRM\n";
526 print "6. Header encryption key : $WHT$encode_header_key$NRM\n";
527 print "\n";
528 } else {
529 print $WHT . "SMTP Settings" . $NRM . "\n-------------\n";
530 print "4. SMTP Server : $WHT$smtpServerAddress$NRM\n";
531 print "5. SMTP Port : $WHT$smtpPort$NRM\n";
532 print "6. POP before SMTP : $WHT$pop_before_smtp$NRM\n";
533 print "7. SMTP Authentication : $WHT$smtp_auth_mech" . display_smtp_sitewide_userpass() ."$NRM\n";
534 print "8. Secure SMTP (TLS) : $WHT" . display_use_tls($use_smtp_tls) . "$NRM\n";
535 print "9. Header encryption key : $WHT$encode_header_key$NRM\n";
536 print "\n";
537 }
538 }
539
540 if ($show_imap_settings == 0) {
541 print "A. Update IMAP Settings : ";
542 print "$WHT$imapServerAddress$NRM:";
543 print "$WHT$imapPort$NRM ";
544 print "($WHT$imap_server_type$NRM)\n";
545 }
546 if ($show_smtp_settings == 0) {
547 if ( lc($useSendmail) eq 'true' ) {
548 print "B. Change Sendmail Config : $WHT$sendmail_path$NRM\n";
549 } else {
550 print "B. Update SMTP Settings : ";
551 print "$WHT$smtpServerAddress$NRM:";
552 print "$WHT$smtpPort$NRM\n";
553 }
554 }
555 if ( $show_smtp_settings || $show_imap_settings )
556 {
557 print "H. Hide " .
558 ($show_imap_settings ? "IMAP Server" :
559 (lc($useSendmail) eq 'true') ? "Sendmail" : "SMTP") . " Settings\n";
560 }
561
562 print "\n";
563 print "R Return to Main Menu\n";
564 } elsif ( $menu == 3 ) {
565 print $WHT. "Folder Defaults\n" . $NRM;
566 print "1. Default Folder Prefix : $WHT$default_folder_prefix$NRM\n";
567 print "2. Show Folder Prefix Option : $WHT$show_prefix_option$NRM\n";
568 print "3. Trash Folder : $WHT$trash_folder$NRM\n";
569 print "4. Sent Folder : $WHT$sent_folder$NRM\n";
570 print "5. Drafts Folder : $WHT$draft_folder$NRM\n";
571 print "6. By default, move to trash : $WHT$default_move_to_trash$NRM\n";
572 print "7. By default, move to sent : $WHT$default_move_to_sent$NRM\n";
573 print "8. By default, save as draft : $WHT$default_save_as_draft$NRM\n";
574 print "9. List Special Folders First : $WHT$list_special_folders_first$NRM\n";
575 print "10. Show Special Folders Color : $WHT$use_special_folder_color$NRM\n";
576 print "11. Auto Expunge : $WHT$auto_expunge$NRM\n";
577 print "12. Default Sub. of INBOX : $WHT$default_sub_of_inbox$NRM\n";
578 print "13. Show 'Contain Sub.' Option : $WHT$show_contain_subfolders_option$NRM\n";
579 print "14. Default Unseen Notify : $WHT$default_unseen_notify$NRM\n";
580 print "15. Default Unseen Type : $WHT$default_unseen_type$NRM\n";
581 print "16. Auto Create Special Folders : $WHT$auto_create_special$NRM\n";
582 print "17. Folder Delete Bypasses Trash : $WHT$delete_folder$NRM\n";
583 print "18. Enable /NoSelect folder fix : $WHT$noselect_fix_enable$NRM\n";
584 print "\n";
585 print "R Return to Main Menu\n";
586 } elsif ( $menu == 4 ) {
587 print $WHT. "General Options\n" . $NRM;
588 print "1. Data Directory : $WHT$data_dir$NRM\n";
589 print "2. Attachment Directory : $WHT$attachment_dir$NRM\n";
590 print "3. Directory Hash Level : $WHT$dir_hash_level$NRM\n";
591 print "4. Default Left Size : $WHT$default_left_size$NRM\n";
592 print "5. Usernames in Lowercase : $WHT$force_username_lowercase$NRM\n";
593 print "6. Allow use of priority : $WHT$default_use_priority$NRM\n";
594 print "7. Hide SM attributions : $WHT$hide_sm_attributions$NRM\n";
595 print "8. Allow use of receipts : $WHT$default_use_mdn$NRM\n";
596 print "9. Allow editing of identity : $WHT$edit_identity$NRM\n";
597 print " Allow editing of name : $WHT$edit_name$NRM\n";
598 print " Remove username from header : $WHT$hide_auth_header$NRM\n";
599 print "10. Disable server thread sort : $WHT$disable_thread_sort$NRM\n";
600 print "11. Disable server-side sorting : $WHT$disable_server_sort$NRM\n";
601 print "12. Allow server charset search : $WHT$allow_charset_search$NRM\n";
602 print "13. Allow advanced search : $WHT$allow_advanced_search$NRM\n";
603 print "14. PHP session name : $WHT$session_name$NRM\n";
604 print "15. Time zone configuration : $WHT$time_zone_type$NRM\n";
605 print "16. Location base : $WHT$config_location_base$NRM\n";
606 print "\n";
607 print "R Return to Main Menu\n";
608 } elsif ( $menu == 5 ) {
609 print $WHT. "Themes\n" . $NRM;
610 print "1. Change Template set\n";
611 # for ( $count = 0 ; $count <= $#theme_name/2 ; $count++ ) {
612 # $temp_name = $theme_name[$count*2];
613 # printf " %s%*s %s\n", $temp_name,
614 # 40 - length($temp_name), " ",
615 # $theme_name[($count*2)+1];
616 # }
617 print "2. CSS File : $WHT$theme_css$NRM\n";
618 print "3. Default font size: $WHT$default_fontsize$NRM\n";
619 print "4. Change available font sets\n";
620 print "5. Change Themes\n";
621
622 print "\n";
623 print "R Return to Main Menu\n";
624 } elsif ( $menu == 6 ) {
625 print $WHT. "Address Books\n" . $NRM;
626 print "1. Change LDAP Servers\n";
627 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
628 print " > $ldap_host[$count]\n";
629 }
630 print "2. Use Javascript address book search : $WHT$default_use_javascript_addr_book$NRM\n";
631 print "3. Global address book file : $WHT$abook_global_file$NRM\n";
632 print "4. Allow writing into global file address book : $WHT$abook_global_file_writeable$NRM\n";
633 print "5. Allow listing of global file address book : $WHT$abook_global_file_listing$NRM\n";
634 print "6. Allowed address book line length : $WHT$abook_file_line_length$NRM\n";
635 print "\n";
636 print "R Return to Main Menu\n";
637 } elsif ( $menu == 7 ) {
638 print $WHT. "Message of the Day (MOTD)\n" . $NRM;
639 print "\n$motd\n";
640 print "\n";
641 print "1 Edit the MOTD\n";
642 print "\n";
643 print "R Return to Main Menu\n";
644 } elsif ( $menu == 8 ) {
645 print $WHT. "Plugins\n" . $NRM;
646 print " Installed Plugins\n";
647 $num = 0;
648 for ( $count = 0 ; $count <= $#plugins ; $count++ ) {
649 $num = $count + 1;
650 print " $num. $plugins[$count]\n";
651 }
652 print "\n Available Plugins:\n";
653 opendir( DIR, "../plugins" );
654 @files = readdir(DIR);
655 $pos = 0;
656 @unused_plugins = ();
657 for ( $i = 0 ; $i <= $#files ; $i++ ) {
658 if ( -d "../plugins/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne "CVS" ) {
659 $match = 0;
660 for ( $k = 0 ; $k <= $#plugins ; $k++ ) {
661 if ( $plugins[$k] eq $files[$i] ) {
662 $match = 1;
663 }
664 }
665 if ( $match == 0 ) {
666 $unused_plugins[$pos] = $files[$i];
667 $pos++;
668 }
669 }
670 }
671
672 for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
673 $num = $num + 1;
674 print " $num. $unused_plugins[$i]\n";
675 }
676 closedir DIR;
677
678 print "\n";
679 print "R Return to Main Menu\n";
680 } elsif ( $menu == 9 ) {
681 print $WHT. "Database\n" . $NRM;
682 print "1. DSN for Address Book : $WHT$addrbook_dsn$NRM\n";
683 print "2. Table for Address Book : $WHT$addrbook_table$NRM\n";
684 print "\n";
685 print "3. DSN for Preferences : $WHT$prefs_dsn$NRM\n";
686 print "4. Table for Preferences : $WHT$prefs_table$NRM\n";
687 print "5. Field for username : $WHT$prefs_user_field$NRM ($prefs_user_size)\n";
688 print "6. Field for prefs key : $WHT$prefs_key_field$NRM ($prefs_key_size)\n";
689 print "7. Field for prefs value : $WHT$prefs_val_field$NRM ($prefs_val_size)\n";
690 print "\n";
691 print "8. DSN for Global Address Book : $WHT$addrbook_global_dsn$NRM\n";
692 print "9. Table for Global Address Book : $WHT$addrbook_global_table$NRM\n";
693 print "10. Allow writing into Global Address Book : $WHT$addrbook_global_writeable$NRM\n";
694 print "11. Allow listing of Global Address Book : $WHT$addrbook_global_listing$NRM\n";
695 print "\n";
696 print "R Return to Main Menu\n";
697 } elsif ( $menu == 10 ) {
698 print $WHT. "Language settings\n" . $NRM;
699 print "1. Default Language : $WHT$squirrelmail_default_language$NRM\n";
700 print "2. Default Charset : $WHT$default_charset$NRM\n";
701 print "3. Show alternative language names : $WHT$show_alternative_names$NRM\n";
702 print "4. Enable aggressive decoding : $WHT$aggressive_decoding$NRM\n";
703 print "5. Enable lossy encoding : $WHT$lossy_encoding$NRM\n";
704 print "\n";
705 print "R Return to Main Menu\n";
706 } elsif ( $menu == 11 ) {
707 print $WHT. "Interface tweaks\n" . $NRM;
708 print "1. Display html mails in iframe : $WHT$use_iframe$NRM\n";
709 print "2. Use Icons : $WHT$use_icons$NRM\n";
710 print "3. Default Icon Set : $WHT$icon_theme_def$NRM\n";
711 print "\n";
712 print $WHT. "PHP tweaks\n" . $NRM;
713 print "4. Use php recode functions : $WHT$use_php_recode$NRM\n";
714 print "5. Use php iconv functions : $WHT$use_php_iconv$NRM\n";
715 print "\n";
716 print $WHT. "Configuration tweaks\n" . $NRM;
717 print "6. Allow remote configtest : $WHT$allow_remote_configtest$NRM\n";
718 print "\n";
719 print "R Return to Main Menu\n";
720 }
721 if ( $config_use_color == 1 ) {
722 print "C Turn color off\n";
723 } else {
724 print "C Turn color on\n";
725 }
726 print "S Save data\n";
727 print "Q Quit\n";
728
729 print "\n";
730 print "Command >> " . $WHT;
731 $command = <STDIN>;
732 $command =~ s/[\n\r]//g;
733 $command =~ tr/A-Z/a-z/;
734 print "$NRM\n";
735
736 # Read the commands they entered.
737 if ( $command eq "r" ) {
738 $menu = 0;
739 } elsif ( $command eq "s" ) {
740 save_data();
741 print "Press enter to continue...";
742 $tmp = <STDIN>;
743 $saved = 1;
744 } elsif ( ( $command eq "q" ) && ( $saved == 0 ) ) {
745 print "You have not saved your data.\n";
746 print "Save? [" . $WHT . "Y" . $NRM . "/n]: ";
747 $save = <STDIN>;
748 if ( ( $save =~ /^y/i ) || ( $save =~ /^\s*$/ ) ) {
749 save_data();
750 }
751 } elsif ( $command eq "c" ) {
752 if ( $config_use_color == 1 ) {
753 $config_use_color = 2;
754 $WHT = "";
755 $NRM = "";
756 } else {
757 $config_use_color = 1;
758 $WHT = "\x1B[37;1m";
759 $NRM = "\x1B[0m";
760 }
761 } elsif ( $command eq "d" && $menu == 0 ) {
762 set_defaults();
763 } else {
764 $saved = 0;
765 if ( $menu == 0 ) {
766 if ( ( $command > 0 ) && ( $command < 12 ) ) {
767 $menu = $command;
768 }
769 } elsif ( $menu == 1 ) {
770 if ( $command == 1 ) { $org_name = command1(); }
771 elsif ( $command == 2 ) { $org_logo = command2(); }
772 elsif ( $command == 3 ) { ($org_logo_width,$org_logo_height) = command2a(); }
773 elsif ( $command == 4 ) { $org_title = command3(); }
774 elsif ( $command == 5 ) { $signout_page = command4(); }
775 elsif ( $command == 6 ) { $frame_top = command6(); }
776 elsif ( $command == 7 ) { $provider_uri = command7(); }
777 elsif ( $command == 8 ) { $provider_name = command8(); }
778
779 } elsif ( $menu == 2 ) {
780 if ( $command eq "a" ) { $show_imap_settings = 1; $show_smtp_settings = 0; }
781 elsif ( $command eq "b" ) { $show_imap_settings = 0; $show_smtp_settings = 1; }
782 elsif ( $command eq "h" ) { $show_imap_settings = 0; $show_smtp_settings = 0; }
783 elsif ( $command <= 3 ) {
784 if ( $command == 1 ) { $domain = command11(); }
785 elsif ( $command == 2 ) { $invert_time = command110(); }
786 elsif ( $command == 3 ) { $useSendmail = command14(); }
787 $show_imap_settings = 0; $show_smtp_settings = 0;
788 } elsif ( $show_imap_settings ) {
789 if ( $command == 4 ) { $imapServerAddress = command12(); }
790 elsif ( $command == 5 ) { $imapPort = command13(); }
791 elsif ( $command == 6 ) { $imap_auth_mech = command112a(); }
792 elsif ( $command == 7 ) { $use_imap_tls = command_use_tls("IMAP",$use_imap_tls); }
793 elsif ( $command == 8 ) { $imap_server_type = command19(); }
794 elsif ( $command == 9 ) { $optional_delimiter = command111(); }
795 } elsif ( $show_smtp_settings && lc($useSendmail) eq 'true' ) {
796 if ( $command == 4 ) { $sendmail_path = command15(); }
797 elsif ( $command == 5 ) { $sendmail_args = command_sendmail_args(); }
798 elsif ( $command == 6 ) { $encode_header_key = command114(); }
799 } elsif ( $show_smtp_settings ) {
800 if ( $command == 4 ) { $smtpServerAddress = command16(); }
801 elsif ( $command == 5 ) { $smtpPort = command17(); }
802 elsif ( $command == 6 ) { $pop_before_smtp = command18a(); }
803 elsif ( $command == 7 ) { $smtp_auth_mech = command112b(); }
804 elsif ( $command == 8 ) { $use_smtp_tls = command_use_tls("SMTP",$use_smtp_tls); }
805 elsif ( $command == 9 ) { $encode_header_key = command114(); }
806 }
807 } elsif ( $menu == 3 ) {
808 if ( $command == 1 ) { $default_folder_prefix = command21(); }
809 elsif ( $command == 2 ) { $show_prefix_option = command22(); }
810 elsif ( $command == 3 ) { $trash_folder = command23a(); }
811 elsif ( $command == 4 ) { $sent_folder = command23b(); }
812 elsif ( $command == 5 ) { $draft_folder = command23c(); }
813 elsif ( $command == 6 ) { $default_move_to_trash = command24a(); }
814 elsif ( $command == 7 ) { $default_move_to_sent = command24b(); }
815 elsif ( $command == 8 ) { $default_save_as_draft = command24c(); }
816 elsif ( $command == 9 ) { $list_special_folders_first = command27(); }
817 elsif ( $command == 10 ) { $use_special_folder_color = command28(); }
818 elsif ( $command == 11 ) { $auto_expunge = command29(); }
819 elsif ( $command == 12 ) { $default_sub_of_inbox = command210(); }
820 elsif ( $command == 13 ) { $show_contain_subfolders_option = command211(); }
821 elsif ( $command == 14 ) { $default_unseen_notify = command212(); }
822 elsif ( $command == 15 ) { $default_unseen_type = command213(); }
823 elsif ( $command == 16 ) { $auto_create_special = command214(); }
824 elsif ( $command == 17 ) { $delete_folder = command215(); }
825 elsif ( $command == 18 ) { $noselect_fix_enable = command216(); }
826 } elsif ( $menu == 4 ) {
827 if ( $command == 1 ) { $data_dir = command33a(); }
828 elsif ( $command == 2 ) { $attachment_dir = command33b(); }
829 elsif ( $command == 3 ) { $dir_hash_level = command33c(); }
830 elsif ( $command == 4 ) { $default_left_size = command35(); }
831 elsif ( $command == 5 ) { $force_username_lowercase = command36(); }
832 elsif ( $command == 6 ) { $default_use_priority = command37(); }
833 elsif ( $command == 7 ) { $hide_sm_attributions = command38(); }
834 elsif ( $command == 8 ) { $default_use_mdn = command39(); }
835 elsif ( $command == 9 ) { $edit_identity = command310(); }
836 elsif ( $command == 10 ) { $disable_thread_sort = command312(); }
837 elsif ( $command == 11 ) { $disable_server_sort = command313(); }
838 elsif ( $command == 12 ) { $allow_charset_search = command314(); }
839 elsif ( $command == 13 ) { $allow_advanced_search = command316(); }
840 elsif ( $command == 14 ) { $session_name = command317(); }
841 elsif ( $command == 15 ) { $time_zone_type = command318(); }
842 elsif ( $command == 16 ) { $config_location_base = command_config_location_base(); }
843 } elsif ( $menu == 5 ) {
844 if ( $command == 1 ) { $templateset_default = command_templates(); }
845 elsif ( $command == 2 ) { $theme_css = command42(); }
846 elsif ( $command == 3 ) { $default_fontsize = command_default_fontsize(); }
847 elsif ( $command == 4 ) { command_fontsets(); }
848 elsif ( $command == 5 ) { command41(); }
849 } elsif ( $menu == 6 ) {
850 if ( $command == 1 ) { command61(); }
851 elsif ( $command == 2 ) { command62(); }
852 elsif ( $command == 3 ) { $abook_global_file=command63(); }
853 elsif ( $command == 4 ) { command64(); }
854 elsif ( $command == 5 ) { command65(); }
855 elsif ( $command == 6 ) { command_abook_file_line_length(); }
856 } elsif ( $menu == 7 ) {
857 if ( $command == 1 ) { $motd = command71(); }
858 } elsif ( $menu == 8 ) {
859 if ( $command =~ /^[0-9]+/ ) { @plugins = command81(); }
860 } elsif ( $menu == 9 ) {
861 if ( $command == 1 ) { $addrbook_dsn = command91(); }
862 elsif ( $command == 2 ) { $addrbook_table = command92(); }
863 elsif ( $command == 3 ) { $prefs_dsn = command93(); }
864 elsif ( $command == 4 ) { $prefs_table = command94(); }
865 elsif ( $command == 5 ) { $prefs_user_field = command95(); }
866 elsif ( $command == 6 ) { $prefs_key_field = command96(); }
867 elsif ( $command == 7 ) { $prefs_val_field = command97(); }
868 elsif ( $command == 8 ) { $addrbook_global_dsn = command98(); }
869 elsif ( $command == 9 ) { $addrbook_global_table = command99(); }
870 elsif ( $command == 10 ) { $addrbook_global_writeable = command910(); }
871 elsif ( $command == 11 ) { $addrbook_global_listing = command911(); }
872 } elsif ( $menu == 10 ) {
873 if ( $command == 1 ) { $squirrelmail_default_language = commandA1(); }
874 elsif ( $command == 2 ) { $default_charset = commandA2(); }
875 elsif ( $command == 3 ) { $show_alternative_names = commandA3(); }
876 elsif ( $command == 4 ) { $aggressive_decoding = commandA4(); }
877 elsif ( $command == 5 ) { $lossy_encoding = commandA5(); }
878 } elsif ( $menu == 11 ) {
879 if ( $command == 1 ) { $use_iframe = commandB2(); }
880 elsif ( $command == 2 ) { $use_icons = commandB3(); }
881 elsif ( $command == 3 ) { $icon_theme_def = commandB7(); }
882 elsif ( $command == 4 ) { $use_php_recode = commandB4(); }
883 elsif ( $command == 5 ) { $use_php_iconv = commandB5(); }
884 elsif ( $command == 6 ) { $allow_remote_configtest = commandB6(); }
885 }
886 }
887 }
888
889 # we exit here
890 print "\nExiting conf.pl.\n".
891 "You might want to test your configuration by browsing to\n".
892 "http://your-squirrelmail-location/src/configtest.php\n".
893 "Happy SquirrelMailing!\n\n";
894
895
896 ####################################################################################
897
898 # org_name
899 sub command1 {
900 print "We have tried to make the name SquirrelMail as transparent as\n";
901 print "possible. If you set up an organization name, most places where\n";
902 print "SquirrelMail would take credit will be credited to your organization.\n";
903 print "\n";
904 print "If your Organization Name includes a '\$', please precede it with a \\. \n";
905 print "Other '\$' will be considered the beginning of a variable that\n";
906 print "must be defined before the \$org_name is printed.\n";
907 print "\n";
908 print "[$WHT$org_name$NRM]: $WHT";
909 $new_org_name = <STDIN>;
910 if ( $new_org_name eq "\n" ) {
911 $new_org_name = $org_name;
912 } else {
913 $new_org_name =~ s/[\r\n]//g;
914 $new_org_name =~ s/\"/&quot;/g;
915 }
916 return $new_org_name;
917 }
918
919 # org_logo
920 sub command2 {
921 print "Your organization's logo is an image that will be displayed at\n";
922 print "different times throughout SquirrelMail. ";
923 print "\n";
924 print "Please be aware of the following: \n";
925 print " - Relative URLs are relative to the config dir\n";
926 print " to use the default logo, use ../images/sm_logo.png\n";
927 print " - To specify a logo defined outside the SquirrelMail source tree\n";
928 print " use the absolute URL the webserver would use to include the file\n";
929 print " e.g. http://www.example.com/images/mylogo.gif or /images/mylogo.jpg\n";
930 print "\n";
931 print "[$WHT$org_logo$NRM]: $WHT";
932 $new_org_logo = <STDIN>;
933 if ( $new_org_logo eq "\n" ) {
934 $new_org_logo = $org_logo;
935 } else {
936 $new_org_logo =~ s/[\r\n]//g;
937 }
938 return $new_org_logo;
939 }
940
941 # org_logo_width
942 sub command2a {
943 print "Your organization's logo is an image that will be displayed at\n";
944 print "different times throughout SquirrelMail. Width\n";
945 print "and Height of your logo image. Use '0' to disable.\n";
946 print "\n";
947 print "Width: [$WHT$org_logo_width$NRM]: $WHT";
948 $new_org_logo_width = <STDIN>;
949 $new_org_logo_width =~ tr/0-9//cd; # only want digits!
950 if ( $new_org_logo_width eq '' ) {
951 $new_org_logo_width = $org_logo_width;
952 }
953 if ( $new_org_logo_width > 0 ) {
954 print "Height: [$WHT$org_logo_height$NRM]: $WHT";
955 $new_org_logo_height = <STDIN>;
956 $new_org_logo_height =~ tr/0-9//cd; # only want digits!
957 if( $new_org_logo_height eq '' ) {
958 $new_org_logo_height = $org_logo_height;
959 }
960 } else {
961 $new_org_logo_height = 0;
962 }
963 return ($new_org_logo_width, $new_org_logo_height);
964 }
965
966 # org_title
967 sub command3 {
968 print "A title is what is displayed at the top of the browser window in\n";
969 print "the titlebar. Usually this will end up looking something like:\n";
970 print "\"Netscape: $org_title\"\n";
971 print "\n";
972 print "If your Organization Title includes a '\$', please precede it with a \\. \n";
973 print "Other '\$' will be considered the beginning of a variable that\n";
974 print "must be defined before the \$org_title is printed.\n";
975 print "\n";
976 print "[$WHT$org_title$NRM]: $WHT";
977 $new_org_title = <STDIN>;
978 if ( $new_org_title eq "\n" ) {
979 $new_org_title = $org_title;
980 } else {
981 $new_org_title =~ s/[\r\n]//g;
982 $new_org_title =~ s/\"/\'/g;
983 }
984 return $new_org_title;
985 }
986
987 # signout_page
988 sub command4 {
989 print "When users click the Sign Out button they will be logged out and\n";
990 print "then sent to signout_page. If signout_page is left empty,\n";
991 print "(hit space and then return) they will be taken, as normal,\n";
992 print "to the default and rather sparse SquirrelMail signout page.\n";
993 print "\n";
994 print "[$WHT$signout_page$NRM]: $WHT";
995 $new_signout_page = <STDIN>;
996 if ( $new_signout_page eq "\n" ) {
997 $new_signout_page = $signout_page;
998 } else {
999 $new_signout_page =~ s/[\r\n]//g;
1000 $new_signout_page =~ s/^\s+$//g;
1001 }
1002 return $new_signout_page;
1003 }
1004
1005 # Default top frame
1006 sub command6 {
1007 print "SquirrelMail defaults to using the whole of the browser window.\n";
1008 print "This allows you to keep it within a specified frame. The default\n";
1009 print "is '_top'\n";
1010 print "\n";
1011 print "[$WHT$frame_top$NRM]: $WHT";
1012 $new_frame_top = <STDIN>;
1013 if ( $new_frame_top eq "\n" ) {
1014 $new_frame_top = '_top';
1015 } else {
1016 $new_frame_top =~ s/[\r\n]//g;
1017 $new_frame_top =~ s/^\s+$//g;
1018 }
1019 return $new_frame_top;
1020 }
1021
1022 # Default link to provider
1023 sub command7 {
1024 print "Here you can set the link on the right of the page.\n";
1025 print "If empty, it will link to the SquirrelMail About page.\n";
1026 print "\n";
1027 print "[$WHT$provider_uri$NRM]: $WHT";
1028 $new_provider_uri = <STDIN>;
1029 if ( $new_provider_uri eq "\n" ) {
1030 $new_provider_uri = '';
1031 } else {
1032 $new_provider_uri =~ s/[\r\n]//g;
1033 $new_provider_uri =~ s/^\s+$//g;
1034 }
1035 return $new_provider_uri;
1036 }
1037
1038 sub command8 {
1039 print "Here you can set the name of the link on the right of the page.\n";
1040 print "The default is 'SquirrelMail'\n";
1041 print "\n";
1042 print "[$WHT$provider_name$NRM]: $WHT";
1043 $new_provider_name = <STDIN>;
1044 if ( $new_provider_name eq "\n" ) {
1045 $new_provider_name = 'SquirrelMail';
1046 } else {
1047 $new_provider_name =~ s/[\r\n]//g;
1048 $new_provider_name =~ s/^\s+$//g;
1049 $new_provider_name =~ s/\'/\\'/g;
1050 }
1051 return $new_provider_name;
1052 }
1053
1054 ####################################################################################
1055
1056 # domain
1057 sub command11 {
1058 print "The domain name is the suffix at the end of all email addresses. If\n";
1059 print "for example, your email address is jdoe\@example.com, then your domain\n";
1060 print "would be example.com.\n";
1061 print "\n";
1062 print "[$WHT$domain$NRM]: $WHT";
1063 $new_domain = <STDIN>;
1064 if ( $new_domain eq "\n" ) {
1065 $new_domain = $domain;
1066 } else {
1067 $new_domain =~ s/[\r\n]//g;
1068 }
1069 return $new_domain;
1070 }
1071
1072 # imapServerAddress
1073 sub command12 {
1074 print "This is the hostname where your IMAP server can be contacted.\n";
1075 print "[$WHT$imapServerAddress$NRM]: $WHT";
1076 $new_imapServerAddress = <STDIN>;
1077 if ( $new_imapServerAddress eq "\n" ) {
1078 $new_imapServerAddress = $imapServerAddress;
1079 } else {
1080 $new_imapServerAddress =~ s/[\r\n]//g;
1081 }
1082 return $new_imapServerAddress;
1083 }
1084
1085 # imapPort
1086 sub command13 {
1087 print "This is the port that your IMAP server is on. Usually this is 143.\n";
1088 print "[$WHT$imapPort$NRM]: $WHT";
1089 $new_imapPort = <STDIN>;
1090 if ( $new_imapPort eq "\n" ) {
1091 $new_imapPort = $imapPort;
1092 } else {
1093 $new_imapPort =~ s/[\r\n]//g;
1094 }
1095 return $new_imapPort;
1096 }
1097
1098 # useSendmail
1099 sub command14 {
1100 print "You now need to choose the method that you will use for sending\n";
1101 print "messages in SquirrelMail. You can either connect to an SMTP server\n";
1102 print "or use sendmail directly.\n";
1103 if ( lc($useSendmail) eq 'true' ) {
1104 $default_value = "1";
1105 } else {
1106 $default_value = "2";
1107 }
1108 print "\n";
1109 print " 1. Sendmail\n";
1110 print " 2. SMTP\n";
1111 print "Your choice [1/2] [$WHT$default_value$NRM]: $WHT";
1112 $use_sendmail = <STDIN>;
1113 if ( ( $use_sendmail =~ /^1\n/i )
1114 || ( ( $use_sendmail =~ /^\n/ ) && ( $default_value eq "1" ) ) ) {
1115 $useSendmail = 'true';
1116 } else {
1117 $useSendmail = 'false';
1118 }
1119 return $useSendmail;
1120 }
1121
1122 # sendmail_path
1123 sub command15 {
1124 print "Specify where the sendmail executable is located. Usually /usr/sbin/sendmail\n";
1125 print "[$WHT$sendmail_path$NRM]: $WHT";
1126 $new_sendmail_path = <STDIN>;
1127 if ( $new_sendmail_path eq "\n" ) {
1128 $new_sendmail_path = $sendmail_path;
1129 } else {
1130 $new_sendmail_path =~ s/[\r\n]//g;
1131 }
1132 return $new_sendmail_path;
1133 }
1134
1135 # Extra sendmail arguments
1136 sub command_sendmail_args {
1137 print "Specify additional sendmail program arguments.\n";
1138 print "\n";
1139 print "Make sure that arguments are supported by your sendmail program. -f argument \n";
1140 print "is added automatically by SquirrelMail scripts. Variable defaults to standard\n";
1141 print "/usr/sbin/sendmail arguments. If you use qmail-inject, nbsmtp or any other \n";
1142 print "sendmail wrapper, which does not support -i and -t arguments, set variable to\n";
1143 print "empty string or use arguments suitable for your mailer.\n";
1144 print "\n";
1145 print "[$WHT$sendmail_args$NRM]: $WHT";
1146 $new_sendmail_args = <STDIN>;
1147 if ( $new_sendmail_args eq "\n" ) {
1148 $new_sendmail_args = $sendmail_args;
1149 } else {
1150 # strip linefeeds and crs.
1151 $new_sendmail_args =~ s/[\r\n]//g;
1152 }
1153 return trim($new_sendmail_args);
1154 }
1155
1156 # smtpServerAddress
1157 sub command16 {
1158 print "This is the hostname of your SMTP server.\n";
1159 print "[$WHT$smtpServerAddress$NRM]: $WHT";
1160 $new_smtpServerAddress = <STDIN>;
1161 if ( $new_smtpServerAddress eq "\n" ) {
1162 $new_smtpServerAddress = $smtpServerAddress;
1163 } else {
1164 $new_smtpServerAddress =~ s/[\r\n]//g;
1165 }
1166 return $new_smtpServerAddress;
1167 }
1168
1169 # smtpPort
1170 sub command17 {
1171 print "This is the port to connect to for SMTP. Usually 25.\n";
1172 print "[$WHT$smtpPort$NRM]: $WHT";
1173 $new_smtpPort = <STDIN>;
1174 if ( $new_smtpPort eq "\n" ) {
1175 $new_smtpPort = $smtpPort;
1176 } else {
1177 $new_smtpPort =~ s/[\r\n]//g;
1178 }
1179 return $new_smtpPort;
1180 }
1181
1182 # pop before SMTP
1183 sub command18a {
1184 print "Do you wish to use POP3 before SMTP? Your server must\n";
1185 print "support this in order for SquirrelMail to work with it.\n";
1186
1187 $YesNo = 'n';
1188 $YesNo = 'y' if ( lc($pop_before_smtp) eq 'true' );
1189
1190 print "Use pop before SMTP (y/n) [$WHT$YesNo$NRM]: $WHT";
1191
1192 $new_pop_before_smtp = <STDIN>;
1193 $new_pop_before_smtp =~ tr/yn//cd;
1194 return 'true' if ( $new_pop_before_smtp eq "y" );
1195 return 'false' if ( $new_pop_before_smtp eq "n" );
1196 return $pop_before_smtp;
1197 }
1198
1199 # imap_server_type
1200 sub command19 {
1201 print "Each IMAP server has its own quirks. As much as we tried to stick\n";
1202 print "to standards, it doesn't help much if the IMAP server doesn't follow\n";
1203 print "the same principles. We have made some work-arounds for some of\n";
1204 print "these servers. If you would like to use them, please select your\n";
1205 print "IMAP server. If you do not wish to use these work-arounds, you can\n";
1206 print "set this to \"other\", and none will be used.\n";
1207 print " courier = Courier IMAP server\n";
1208 print " cyrus = Cyrus IMAP server\n";
1209 print " dovecot = Dovecot Secure IMAP server\n";
1210 print " exchange = Microsoft Exchange IMAP server\n";
1211 print " hmailserver = hMailServer\n";
1212 print " macosx = Mac OS X Mailserver\n";
1213 print " mercury32 = Mercury Mail Transport System\n";
1214 print " uw = University of Washington's IMAP server\n";
1215 print "\n";
1216 print " other = Not one of the above servers\n";
1217 print "\n";
1218 print "[$WHT$imap_server_type$NRM]: $WHT";
1219 $new_imap_server_type = <STDIN>;
1220
1221 if ( $new_imap_server_type eq "\n" ) {
1222 $new_imap_server_type = $imap_server_type;
1223 } else {
1224 $new_imap_server_type =~ s/[\r\n]//g;
1225 }
1226 return $new_imap_server_type;
1227 }
1228
1229 # invert_time
1230 sub command110 {
1231 print "Sometimes the date of messages sent is messed up (off by a few hours\n";
1232 print "on some machines). Typically this happens if the system doesn't support\n";
1233 print "tm_gmtoff. It will happen only if your time zone is \"negative\".\n";
1234 print "This most often occurs on Solaris 7 machines in the United States.\n";
1235 print "By default, this is off. It should be kept off unless problems surface\n";
1236 print "about the time that messages are sent.\n";
1237 print " no = Do NOT fix time -- almost always correct\n";
1238 print " yes = Fix the time for this system\n";
1239
1240 $YesNo = 'n';
1241 $YesNo = 'y' if ( lc($invert_time) eq 'true' );
1242
1243 print "Fix the time for this system (y/n) [$WHT$YesNo$NRM]: $WHT";
1244
1245 $new_invert_time = <STDIN>;
1246 $new_invert_time =~ tr/yn//cd;
1247 return 'true' if ( $new_invert_time eq "y" );
1248 return 'false' if ( $new_invert_time eq "n" );
1249 return $invert_time;
1250 }
1251
1252 sub command111 {
1253 print "This is the delimiter that your IMAP server uses to distinguish between\n";
1254 print "folders. For example, Cyrus uses '.' as the delimiter and a complete\n";
1255 print "folder would look like 'INBOX.Friends.Bob', while UW uses '/' and would\n";
1256 print "look like 'INBOX/Friends/Bob'. Normally this should be left at 'detect'\n";
1257 print "but if you are sure you know what delimiter your server uses, you can\n";
1258 print "specify it here.\n";
1259 print "\nTo have it autodetect the delimiter, set it to 'detect'.\n\n";
1260 print "[$WHT$optional_delimiter$NRM]: $WHT";
1261 $new_optional_delimiter = <STDIN>;
1262
1263 if ( $new_optional_delimiter eq "\n" ) {
1264 $new_optional_delimiter = $optional_delimiter;
1265 } else {
1266 $new_optional_delimiter =~ s/[\r\n]//g;
1267 }
1268 return $new_optional_delimiter;
1269 }
1270 # IMAP authentication type
1271 # Possible values: login, plain, cram-md5, digest-md5
1272 # Now offers to detect supported mechs, assuming server & port are set correctly
1273
1274 sub command112a {
1275 if ($use_imap_tls ne "0") {
1276 # 1. Script does not handle TLS.
1277 # 2. Server does not have to declare all supported authentication mechs when
1278 # STARTTLS is used. Supported mechs are declared only after STARTTLS.
1279 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1280 } else {
1281 print "If you have already set the hostname and port number, I can try to\n";
1282 print "detect the mechanisms your IMAP server supports.\n";
1283 print "I will try to detect CRAM-MD5 and DIGEST-MD5 support. I can't test\n";
1284 print "for \"login\" or \"plain\" without knowing a username and password.\n";
1285 print "Auto-detecting is optional - you can safely say \"n\" here.\n";
1286 print "\nTry to detect supported mechanisms? [y/N]: ";
1287 $inval=<STDIN>;
1288 chomp($inval);
1289 if ($inval =~ /^y\b/i) {
1290 # Yes, let's try to detect.
1291 print "Trying to detect IMAP capabilities...\n";
1292 my $host = $imapServerAddress . ':'. $imapPort;
1293 print "CRAM-MD5:\t";
1294 my $tmp = detect_auth_support('IMAP',$host,'CRAM-MD5');
1295 if (defined($tmp)) {
1296 if ($tmp eq 'YES') {
1297 print "$WHT SUPPORTED$NRM\n";
1298 } else {
1299 print "$WHT NOT SUPPORTED$NRM\n";
1300 }
1301 } else {
1302 print $WHT . " ERROR DETECTING$NRM\n";
1303 }
1304
1305 print "DIGEST-MD5:\t";
1306 $tmp = detect_auth_support('IMAP',$host,'DIGEST-MD5');
1307 if (defined($tmp)) {
1308 if ($tmp eq 'YES') {
1309 print "$WHT SUPPORTED$NRM\n";
1310 } else {
1311 print "$WHT NOT SUPPORTED$NRM\n";
1312 }
1313 } else {
1314 print $WHT . " ERROR DETECTING$NRM\n";
1315 }
1316
1317 }
1318 }
1319 print "\nWhat authentication mechanism do you want to use for IMAP connections?\n\n";
1320 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1321 print $WHT . "plain" . $NRM . " - SASL PLAIN. If you need this, you already know it.\n";
1322 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext methods.\n";
1323 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1324 print "\n*** YOUR IMAP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n";
1325 print "If you don't understand or are unsure, you probably want \"login\"\n\n";
1326 print "login, plain, cram-md5, or digest-md5 [$WHT$imap_auth_mech$NRM]: $WHT";
1327 $inval=<STDIN>;
1328 chomp($inval);
1329 if ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) || ($inval =~ /^login\b/i) || ($inval =~ /^plain\b/i)) {
1330 return lc($inval);
1331 } else {
1332 # user entered garbage or default value so nothing needs to be set
1333 return $imap_auth_mech;
1334 }
1335 }
1336
1337
1338 # SMTP authentication type
1339 # Possible choices: none, plain, cram-md5, digest-md5
1340 sub command112b {
1341 if ($use_smtp_tls ne "0") {
1342 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1343 } elsif (eval ("use IO::Socket; 1")) {
1344 # try loading IO::Socket module
1345 print "If you have already set the hostname and port number, I can try to\n";
1346 print "automatically detect some of the mechanisms your SMTP server supports.\n";
1347 print "Auto-detection is *optional* - you can safely say \"n\" here.\n";
1348 print "\nTry to detect auth mechanisms? [y/N]: ";
1349 $inval=<STDIN>;
1350 chomp($inval);
1351 if ($inval =~ /^y\b/i) {
1352 # Yes, let's try to detect.
1353 print "Trying to detect supported methods (SMTP)...\n";
1354
1355 # Special case!
1356 # Check none by trying to relay to junk@microsoft.com
1357 $host = $smtpServerAddress . ':' . $smtpPort;
1358 my $sock = IO::Socket::INET->new($host);
1359 print "Testing none:\t\t$WHT";
1360 if (!defined($sock)) {
1361 print " ERROR TESTING\n";
1362 close $sock;
1363 } else {
1364 print $sock "HELO $domain\r\n";
1365 $got = <$sock>; # Discard
1366 print $sock "MAIL FROM:<tester\@squirrelmail.org>\r\n";
1367 $got = <$sock>; # Discard
1368 print $sock "RCPT TO:<junk\@microsoft.com\r\n";
1369 $got = <$sock>; # This is the important line
1370 if ($got =~ /^250\b/) { # SMTP will relay without auth
1371 print "SUPPORTED$NRM\n";
1372 } else {
1373 print "NOT SUPPORTED$NRM\n";
1374 }
1375 print $sock "RSET\r\n";
1376 print $sock "QUIT\r\n";
1377 close $sock;
1378 }
1379 # Try login (SquirrelMail default)
1380 print "Testing login:\t\t";
1381 $tmp=detect_auth_support('SMTP',$host,'LOGIN');
1382 if (defined($tmp)) {
1383 if ($tmp eq 'YES') {
1384 print $WHT . "SUPPORTED$NRM\n";
1385 } else {
1386 print $WHT . "NOT SUPPORTED$NRM\n";
1387 }
1388 } else {
1389 print $WHT . "ERROR DETECTING$NRM\n";
1390 }
1391
1392 # Try CRAM-MD5
1393 print "Testing CRAM-MD5:\t";
1394 $tmp=detect_auth_support('SMTP',$host,'CRAM-MD5');
1395 if (defined($tmp)) {
1396 if ($tmp eq 'YES') {
1397 print $WHT . "SUPPORTED$NRM\n";
1398 } else {
1399 print $WHT . "NOT SUPPORTED$NRM\n";
1400 }
1401 } else {
1402 print $WHT . "ERROR DETECTING$NRM\n";
1403 }
1404
1405
1406 print "Testing DIGEST-MD5:\t";
1407 $tmp=detect_auth_support('SMTP',$host,'DIGEST-MD5');
1408 if (defined($tmp)) {
1409 if ($tmp eq 'YES') {
1410 print $WHT . "SUPPORTED$NRM\n";
1411 } else {
1412 print $WHT . "NOT SUPPORTED$NRM\n";
1413 }
1414 } else {
1415 print $WHT . "ERROR DETECTING$NRM\n";
1416 }
1417 }
1418 }
1419 print "\nWhat authentication mechanism do you want to use for SMTP connections?\n";
1420 print $WHT . "none" . $NRM . " - Your SMTP server does not require authorization.\n";
1421 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1422 print $WHT . "plain" . $NRM . " - SASL PLAIN. You already know it if you need this.\n";
1423 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext.\n";
1424 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1425 print $WHT . "\n*** YOUR SMTP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n" . $NRM;
1426 print "If you don't understand or are unsure, you probably want \"none\"\n\n";
1427 print "none, login, cram-md5, or digest-md5 [$WHT$smtp_auth_mech$NRM]: $WHT";
1428 $inval=<STDIN>;
1429 chomp($inval);
1430 if ($inval =~ /^none\b/i) {
1431 # remove sitewide smtp authentication information
1432 $smtp_sitewide_user = '';
1433 $smtp_sitewide_pass = '';
1434 # SMTP doesn't necessarily require logins
1435 return "none";
1436 } elsif ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) ||
1437 ($inval =~ /^login\b/i) || ($inval =~/^plain\b/i)) {
1438 command_smtp_sitewide_userpass($inval);
1439 return lc($inval);
1440 } elsif (trim($inval) eq '') {
1441 # user selected default value
1442 command_smtp_sitewide_userpass($smtp_auth_mech);
1443 return $smtp_auth_mech;
1444 } else {
1445 # user entered garbage
1446 return $smtp_auth_mech;
1447 }
1448 }
1449
1450 sub command_smtp_sitewide_userpass($) {
1451 # get first function argument
1452 my $auth_mech = shift(@_);
1453 my $default, $tmp;
1454 $auth_mech = lc(trim($auth_mech));
1455 if ($auth_mech eq 'none') {
1456 return;
1457 }
1458 print "SMTP authentication uses IMAP username and password by default.\n";
1459 print "\n";
1460 print "Would you like to use other login and password for all SquirrelMail \n";
1461 print "SMTP connections?";
1462 if ($smtp_sitewide_user ne '') {
1463 $default = 'y';
1464 print " [Yn]:";
1465 } else {
1466 $default = 'n';
1467 print " [yN]:";
1468 }
1469 $tmp=<STDIN>;
1470 $tmp = trim($tmp);
1471
1472 if ($tmp eq '') {
1473 $tmp = $default;
1474 } else {
1475 $tmp = lc($tmp);
1476 }
1477
1478 if ($tmp eq 'n') {
1479 $smtp_sitewide_user = '';
1480 $smtp_sitewide_pass = '';
1481 } elsif ($tmp eq 'y') {
1482 print "Enter username [$smtp_sitewide_user]:";
1483 my $new_user = <STDIN>;
1484 $new_user = trim($new_user);
1485 if ($new_user ne '') {
1486 $smtp_sitewide_user = $new_user;
1487 }
1488 if ($smtp_sitewide_user ne '') {
1489 print "If you don't enter any password, current sitewide password will be used.\n";
1490 print "If you enter space, password will be set to empty string.\n";
1491 print "Enter password:";
1492 my $new_pass = <STDIN>;
1493 if ($new_pass ne "\n") {
1494 $smtp_sitewide_pass = trim($new_pass);
1495 }
1496 } else {
1497 print "Invalid input. You must set username used for SMTP authentication.\n";
1498 print "Click any key to continue\n";
1499 $tmp = <STDIN>;
1500 }
1501 } else {
1502 print "Invalid input\n";
1503 print "Click any key to continue\n";
1504 $tmp = <STDIN>;
1505 }
1506 }
1507
1508 # Sub adds information about SMTP authentication type to menu
1509 sub display_smtp_sitewide_userpass() {
1510 my $ret = '';
1511 if ($smtp_auth_mech ne 'none') {
1512 if ($smtp_sitewide_user ne '') {
1513 $ret = ' (with custom username and password)';
1514 } else {
1515 $ret = ' (with IMAP username and password)';
1516 }
1517 }
1518 return $ret;
1519 }
1520
1521 # TLS
1522 # This sub is reused for IMAP and SMTP
1523 # Args: service name, default value
1524 sub command_use_tls {
1525 my($default_val,$service,$inval);
1526 $service=$_[0];
1527 $default_val=$_[1];
1528 print "TLS (Transport Layer Security) encrypts the traffic between server and client.\n";
1529 print "STARTTLS extensions allow to start encryption on existing plain text connection.\n";
1530 print "These options add specific PHP and IMAP server configuration requirements.\n";
1531 print "See SquirrelMail documentation about connection security.\n";
1532 print "\n";
1533 print "If your " . $service . " server is localhost, you can safely disable this.\n";
1534 print "If it is remote, you may wish to seriously consider enabling this.\n";
1535 $valid_input=0;
1536 while ($valid_input eq 0) {
1537 print "\nSelect connection security model:\n";
1538 print " 0 - Use plain text connection\n";
1539 print " 1 - Use TLS connection\n";
1540 print " 2 - Use STARTTLS extension\n";
1541 print "Select [$default_val]: ";
1542 $inval=<STDIN>;
1543 $inval=trim($inval);
1544 if ($inval =~ /^[012]$/ || $inval eq '') {
1545 $valid_input = 1;
1546 }
1547 }
1548 if ($inval ne '') {$default_val = $inval};
1549 return $default_val;
1550 }
1551
1552 # This sub is used to display human readable text for
1553 # $use_imap_tls and $use_smtp_tls values in conf.pl menu
1554 sub display_use_tls($) {
1555 my $val = shift(@_);
1556 my $ret = 'disabled';
1557 if ($val eq '2') {
1558 $ret = 'STARTTLS';
1559 } elsif ($val eq '1') {
1560 $ret = 'TLS';
1561 }
1562 return $ret;
1563 }
1564
1565 # $encode_header_key
1566 sub command114{
1567 print "Encryption key allows to hide SquirrelMail Received: headers\n";
1568 print "in outbound messages. Interface uses encryption key to encode\n";
1569 print "username, remote address and proxied address, then stores encoded\n";
1570 print "information in X-Squirrel-* headers.\n";
1571 print "\n";
1572 print "Warning: used encryption function is not bulletproof. When used\n";
1573 print "with static encryption keys, it provides only minimal security\n";
1574 print "measures and information can be decoded quickly.\n";
1575 print "\n";
1576 print "Encoded information can be decoded with decrypt_headers.php script\n";
1577 print "from SquirrelMail contrib/ directory.\n";
1578 print "\n";
1579 print "Enter encryption key: ";
1580 $new_encode_header_key = <STDIN>;
1581 if ( $new_encode_header_key eq "\n" ) {
1582 $new_encode_header_key = $encode_header_key;
1583 } else {
1584 $new_encode_header_key =~ s/[\r\n]//g;
1585 }
1586 return $new_encode_header_key;
1587 }
1588
1589 # MOTD
1590 sub command71 {
1591 print "\nYou can now create the welcome message that is displayed\n";
1592 print "every time a user logs on. You can use HTML or just plain\n";
1593 print
1594 "text. If you do not wish to have one, just make it blank.\n\n(Type @ on a blank line to exit)\n";
1595
1596 $new_motd = "";
1597 do {
1598 print "] ";
1599 $line = <STDIN>;
1600 $line =~ s/[\r\n]//g;
1601 if ( $line ne "@" ) {
1602 $line =~ s/ /\&nbsp;\&nbsp;/g;
1603 $line =~ s/\t/\&nbsp;\&nbsp;\&nbsp;\&nbsp;/g;
1604 $line =~ s/$/ /;
1605 $line =~ s/\"/\\\"/g;
1606
1607 $new_motd = $new_motd . $line;
1608 }
1609 } while ( $line ne "@" );
1610 return $new_motd;
1611 }
1612
1613 ################# PLUGINS ###################
1614
1615 sub command81 {
1616 $command =~ s/[\s\n\r]*//g;
1617 if ( $command > 0 ) {
1618 $command = $command - 1;
1619 if ( $command <= $#plugins ) {
1620 @newplugins = ();
1621 $ct = 0;
1622 while ( $ct <= $#plugins ) {
1623 if ( $ct != $command ) {
1624 @newplugins = ( @newplugins, $plugins[$ct] );
1625 }
1626 $ct++;
1627 }
1628 @plugins = @newplugins;
1629 } elsif ( $command <= $#plugins + $#unused_plugins + 1 ) {
1630 $num = $command - $#plugins - 1;
1631 @newplugins = @plugins;
1632 $ct = 0;
1633 while ( $ct <= $#unused_plugins ) {
1634 if ( $ct == $num ) {
1635 @newplugins = ( @newplugins, $unused_plugins[$ct] );
1636 }
1637 $ct++;
1638 }
1639 @plugins = @newplugins;
1640 }
1641 }
1642 return @plugins;
1643 }
1644
1645 ################# FOLDERS ###################
1646
1647 # default_folder_prefix
1648 sub command21 {
1649 print "Some IMAP servers (UW, for example) store mail and folders in\n";
1650 print "your user space in a separate subdirectory. This is where you\n";
1651 print "specify what that directory is.\n";
1652 print "\n";
1653 print "EXAMPLE: mail/";
1654 print "\n";
1655 print "NOTE: If you use Cyrus, or some server that would not use this\n";
1656 print " option, you must set this to 'none'.\n";
1657 print "\n";
1658 print "[$WHT$default_folder_prefix$NRM]: $WHT";
1659 $new_default_folder_prefix = <STDIN>;
1660
1661 if ( $new_default_folder_prefix eq "\n" ) {
1662 $new_default_folder_prefix = $default_folder_prefix;
1663 } else {
1664 $new_default_folder_prefix =~ s/[\r\n]//g;
1665 }
1666 if ( ( $new_default_folder_prefix =~ /^\s*$/ ) || ( $new_default_folder_prefix =~ m/^none$/i ) ) {
1667 $new_default_folder_prefix = "";
1668 } else {
1669 # add the trailing delimiter only if we know what the server is.
1670 if (($imap_server_type eq 'cyrus' and
1671 $optional_delimiter eq 'detect') or
1672 ($imap_server_type eq 'courier' and
1673 $optional_delimiter eq 'detect')) {
1674 $new_default_folder_prefix =~ s/\.*$/\./;
1675 } elsif ($imap_server_type eq 'uw' and
1676 $optional_delimiter eq 'detect') {
1677 $new_default_folder_prefix =~ s/\/*$/\//;
1678 }
1679 }
1680 return $new_default_folder_prefix;
1681 }
1682
1683 # Show Folder Prefix
1684 sub command22 {
1685 print "It is possible to set up the default folder prefix as a user\n";
1686 print "specific option, where each user can specify what their mail\n";
1687 print "folder is. If you set this to false, they will never see the\n";
1688 print "option, but if it is true, this option will appear in the\n";
1689 print "'options' section.\n";
1690 print "\n";
1691 print "NOTE: You set the default folder prefix in option '1' of this\n";
1692 print " section. That will be the default if the user doesn't\n";
1693 print " specify anything different.\n";
1694 print "\n";
1695
1696 if ( lc($show_prefix_option) eq 'true' ) {
1697 $default_value = "y";
1698 } else {
1699 $default_value = "n";
1700 }
1701 print "\n";
1702 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
1703 $new_show = <STDIN>;
1704 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1705 $show_prefix_option = 'true';
1706 } else {
1707 $show_prefix_option = 'false';
1708 }
1709 return $show_prefix_option;
1710 }
1711
1712 # Trash Folder
1713 sub command23a {
1714 print "You can now specify where the default trash folder is located.\n";
1715 print "On servers where you do not want this, you can set it to anything\n";
1716 print "and set option 6 to false.\n";
1717 print "\n";
1718 print "This is relative to where the rest of your email is kept. You do\n";
1719 print "not need to worry about their mail directory. If this folder\n";
1720 print "would be ~/mail/trash on the filesystem, you only need to specify\n";
1721 print "that this is 'trash', and be sure to put 'mail/' in option 1.\n";
1722 print "\n";
1723
1724 print "[$WHT$trash_folder$NRM]: $WHT";
1725 $new_trash_folder = <STDIN>;
1726 if ( $new_trash_folder eq "\n" ) {
1727 $new_trash_folder = $trash_folder;
1728 } else {
1729 if (check_imap_folder($new_trash_folder)) {
1730 $new_trash_folder =~ s/[\r\n]//g;
1731 } else {
1732 $new_trash_folder = $trash_folder;
1733 }
1734 }
1735 return $new_trash_folder;
1736 }
1737
1738 # Sent Folder
1739 sub command23b {
1740 print "This is where messages that are sent will be stored. SquirrelMail\n";
1741 print "by default puts a copy of all outgoing messages in this folder.\n";
1742 print "\n";
1743 print "This is relative to where the rest of your email is kept. You do\n";
1744 print "not need to worry about their mail directory. If this folder\n";
1745 print "would be ~/mail/sent on the filesystem, you only need to specify\n";
1746 print "that this is 'sent', and be sure to put 'mail/' in option 1.\n";
1747 print "\n";
1748
1749 print "[$WHT$sent_folder$NRM]: $WHT";
1750 $new_sent_folder = <STDIN>;
1751 if ( $new_sent_folder eq "\n" ) {
1752 $new_sent_folder = $sent_folder;
1753 } else {
1754 if (check_imap_folder($new_sent_folder)) {
1755 $new_sent_folder =~ s/[\r\n]//g;
1756 } else {
1757 $new_sent_folder = $sent_folder;
1758 }
1759 }
1760 return $new_sent_folder;
1761 }
1762
1763 # Draft Folder
1764 sub command23c {
1765 print "You can now specify where the default draft folder is located.\n";
1766 print "On servers where you do not want this, you can set it to anything\n";
1767 print "and set option 9 to false.\n";
1768 print "\n";
1769 print "This is relative to where the rest of your email is kept. You do\n";
1770 print "not need to worry about their mail directory. If this folder\n";
1771 print "would be ~/mail/drafts on the filesystem, you only need to specify\n";
1772 print "that this is 'drafts', and be sure to put 'mail/' in option 1.\n";
1773 print "\n";
1774
1775 print "[$WHT$draft_folder$NRM]: $WHT";
1776 $new_draft_folder = <STDIN>;
1777 if ( $new_draft_folder eq "\n" ) {
1778 $new_draft_folder = $draft_folder;
1779 } else {
1780 if (check_imap_folder($new_draft_folder)) {
1781 $new_draft_folder =~ s/[\r\n]//g;
1782 } else {
1783 $new_draft_folder = $draft_folder;
1784 }
1785 }
1786 return $new_draft_folder;
1787 }
1788
1789 # default move to trash
1790 sub command24a {
1791 print "By default, should messages get moved to the trash folder? You\n";
1792 print "can specify the default trash folder in option 3. If this is set\n";
1793 print "to false, messages will get deleted immediately without moving\n";
1794 print "to the trash folder.\n";
1795 print "\n";
1796 print "Trash folder is currently: $trash_folder\n";
1797 print "\n";
1798
1799 if ( lc($default_move_to_trash) eq 'true' ) {
1800 $default_value = "y";
1801 } else {
1802 $default_value = "n";
1803 }
1804 print "By default, move to trash (y/n) [$WHT$default_value$NRM]: $WHT";
1805 $new_show = <STDIN>;
1806 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1807 $default_move_to_trash = 'true';
1808 } else {
1809 $default_move_to_trash = 'false';
1810 }
1811 return $default_move_to_trash;
1812 }
1813
1814 # default move to sent
1815 sub command24b {
1816 print "By default, should messages get moved to the sent folder? You\n";
1817 print "can specify the default sent folder in option 4. If this is set\n";
1818 print "to false, messages will get sent and no copy will be made.\n";
1819 print "\n";
1820 print "Sent folder is currently: $sent_folder\n";
1821 print "\n";
1822
1823 if ( lc($default_move_to_sent) eq 'true' ) {
1824 $default_value = "y";
1825 } else {
1826 $default_value = "n";
1827 }
1828 print "By default, move to sent (y/n) [$WHT$default_value$NRM]: $WHT";
1829 $new_show = <STDIN>;
1830 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1831 $default_move_to_sent = 'true';
1832 } else {
1833 $default_move_to_sent = 'false';
1834 }
1835 return $default_move_to_sent;
1836 }
1837
1838 # default save as draft
1839 sub command24c {
1840 print "By default, should the save to draft option be shown? You can\n";
1841 print "specify the default drafts folder in option 5. If this is set\n";
1842 print "to false, users will not be shown the save to draft option.\n";
1843 print "\n";
1844 print "Drafts folder is currently: $draft_folder\n";
1845 print "\n";
1846
1847 if ( lc($default_move_to_draft) eq 'true' ) {
1848 $default_value = "y";
1849 } else {
1850 $default_value = "n";
1851 }
1852 print "By default, save as draft (y/n) [$WHT$default_value$NRM]: $WHT";
1853 $new_show = <STDIN>;
1854 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1855 $default_save_as_draft = 'true';
1856 } else {
1857 $default_save_as_draft = 'false';
1858 }
1859 return $default_save_as_draft;
1860 }
1861
1862 # List special folders first
1863 sub command27 {
1864 print "SquirrelMail has what we call 'special folders' that are not\n";
1865 print "manipulated and viewed like normal folders. Some examples of\n";
1866 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
1867 print "Simply asks if you want these folders listed first in the folder\n";
1868 print "listing.\n";
1869 print "\n";
1870
1871 if ( lc($list_special_folders_first) eq 'true' ) {
1872 $default_value = "y";
1873 } else {
1874 $default_value = "n";
1875 }
1876 print "\n";
1877 print "List first (y/n) [$WHT$default_value$NRM]: $WHT";
1878 $new_show = <STDIN>;
1879 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1880 $list_special_folders_first = 'true';
1881 } else {
1882 $list_special_folders_first = 'false';
1883 }
1884 return $list_special_folders_first;
1885 }
1886
1887 # Show special folders color
1888 sub command28 {
1889 print "SquirrelMail has what we call 'special folders' that are not\n";
1890 print "manipulated and viewed like normal folders. Some examples of\n";
1891 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
1892 print "wants to know if we should display special folders in a\n";
1893 print "color than the other folders.\n";
1894 print "\n";
1895
1896 if ( lc($use_special_folder_color) eq 'true' ) {
1897 $default_value = "y";
1898 } else {
1899 $default_value = "n";
1900 }
1901 print "\n";
1902 print "Show color (y/n) [$WHT$default_value$NRM]: $WHT";
1903 $new_show = <STDIN>;
1904 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1905 $use_special_folder_color = 'true';
1906 } else {
1907 $use_special_folder_color = 'false';
1908 }
1909 return $use_special_folder_color;
1910 }
1911
1912 # Auto expunge
1913 sub command29 {
1914 print "The way that IMAP handles deleting messages is as follows. You\n";
1915 print "mark the message as deleted, and then to 'really' delete it, you\n";
1916 print "expunge it. This option asks if you want to just have messages\n";
1917 print "marked as deleted, or if you want SquirrelMail to expunge the \n";
1918 print "messages too.\n";
1919 print "\n";
1920
1921 if ( lc($auto_expunge) eq 'true' ) {
1922 $default_value = "y";
1923 } else {
1924 $default_value = "n";
1925 }
1926 print "Auto expunge (y/n) [$WHT$default_value$NRM]: $WHT";
1927 $new_show = <STDIN>;
1928 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1929 $auto_expunge = 'true';
1930 } else {
1931 $auto_expunge = 'false';
1932 }
1933 return $auto_expunge;
1934 }
1935
1936 # Default sub of inbox
1937 sub command210 {
1938 print "Some IMAP servers (Cyrus) have all folders as subfolders of INBOX.\n";
1939 print "This can cause some confusion in folder creation for users when\n";
1940 print "they try to create folders and don't put it as a subfolder of INBOX\n";
1941 print "and get permission errors. This option asks if you want folders\n";
1942 print "to be subfolders of INBOX by default.\n";
1943 print "\n";
1944
1945 if ( lc($default_sub_of_inbox) eq 'true' ) {
1946 $default_value = "y";
1947 } else {
1948 $default_value = "n";
1949 }
1950 print "Default sub of INBOX (y/n) [$WHT$default_value$NRM]: $WHT";
1951 $new_show = <STDIN>;
1952 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1953 $default_sub_of_inbox = 'true';
1954 } else {
1955 $default_sub_of_inbox = 'false';
1956 }
1957 return $default_sub_of_inbox;
1958 }
1959
1960 # Show contain subfolder option
1961 sub command211 {
1962 print "Some IMAP servers (UW) make it so that there are two types of\n";
1963 print "folders. Those that contain messages, and those that contain\n";
1964 print "subfolders. If this is the case for your server, set this to\n";
1965 print "true, and it will ask the user whether the folder they are\n";
1966 print "creating contains subfolders or messages.\n";
1967 print "\n";
1968
1969 if ( lc($show_contain_subfolders_option) eq 'true' ) {
1970 $default_value = "y";
1971 } else {
1972 $default_value = "n";
1973 }
1974 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
1975 $new_show = <STDIN>;
1976 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1977 $show_contain_subfolders_option = 'true';
1978 } else {
1979 $show_contain_subfolders_option = 'false';
1980 }
1981 return $show_contain_subfolders_option;
1982 }
1983
1984 # Default Unseen Notify
1985 sub command212 {
1986 print "This option specifies where the users will receive notification\n";
1987 print "about unseen messages by default. This is of course an option that\n";
1988 print "can be changed on a user level.\n";
1989 print " 1 = No notification\n";
1990 print " 2 = Only on the INBOX\n";
1991 print " 3 = On all folders\n";
1992 print "\n";
1993
1994 print "Which one should be default (1,2,3)? [$WHT$default_unseen_notify$NRM]: $WHT";
1995 $new_show = <STDIN>;
1996 if ( $new_show =~ /^[123]\n/i ) {
1997 $default_unseen_notify = $new_show;
1998 }
1999 $default_unseen_notify =~ s/[\r\n]//g;
2000 return $default_unseen_notify;
2001 }
2002
2003 # Default Unseen Type
2004 sub command213 {
2005 print "Here you can define the default way that unseen messages will be displayed\n";
2006 print "to the user in the folder listing on the left side.\n";
2007 print " 1 = Only unseen messages (4)\n";
2008 print " 2 = Unseen and Total messages (4/27)\n";
2009 print "\n";
2010
2011 print "Which one should be default (1,2)? [$WHT$default_unseen_type$NRM]: $WHT";
2012 $new_show = <STDIN>;
2013 if ( $new_show =~ /^[12]\n/i ) {
2014 $default_unseen_type = $new_show;
2015 }
2016 $default_unseen_type =~ s/[\r\n]//g;
2017 return $default_unseen_type;
2018 }
2019
2020 # Auto create special folders
2021 sub command214 {
2022 print "Would you like the Sent, Trash, and Drafts folders to be created\n";
2023 print "automatically print for you when a user logs in? If the user\n";
2024 print "accidentally deletes their special folders, this option will\n";
2025 print "automatically create it again for them.\n";
2026 print "\n";
2027
2028 if ( lc($auto_create_special) eq 'true' ) {
2029 $default_value = "y";
2030 } else {
2031 $default_value = "n";
2032 }
2033 print "Auto create special folders? (y/n) [$WHT$default_value$NRM]: $WHT";
2034 $new_show = <STDIN>;
2035 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2036 $auto_create_special = 'true';
2037 } else {
2038 $auto_create_special = 'false';
2039 }
2040 return $auto_create_special;
2041 }
2042
2043 # Automatically delete folders
2044 sub command215 {
2045 if ( $imap_server_type eq "uw" ) {
2046 print "UW IMAP servers will not allow folders containing mail to also contain folders.\n";
2047 print "Deleting folders will bypass the trash folder and be immediately deleted\n\n";
2048 print "If this is not the correct value for your server,\n";
2049 print "please use option D on the Main Menu to configure your server correctly.\n\n";
2050 print "Press any key to continue...\n";
2051 $new_delete = <STDIN>;
2052 $delete_folder = 'true';
2053 } else {
2054 if ( $imap_server_type eq "courier" ) {
2055 print "Courier (or Courier-IMAP) IMAP servers may not support ";
2056 print "subfolders of Trash. \n";
2057 print "Specifically, if Courier is set to always move messages to Trash, \n";
2058 print "Trash will be treated by Courier as a special folder that does not \n";
2059 print "allow subfolders. \n\n";
2060 print "Please verify your Courier configuration, and test folder deletion \n";
2061 print "when changing this setting.\n\n";
2062 }
2063
2064 print "Are subfolders of the Trash supported by your IMAP server?\n";
2065 print "If so, should deleted folders be sent to Trash?\n";
2066 print "If not, say no (deleted folders should not be sent to Trash)\n\n";
2067 # reversal of logic.
2068 # question was: Should folders be automatically deleted instead of sent to trash..
2069 # we've changed the question to make it more clear,
2070 # and are here handling that to avoid changing the answers..
2071 if ( lc($delete_folder) eq 'true' ) {
2072 $default_value = "n";
2073 } else {
2074 $default_value = "y";
2075 }
2076 print "Send deleted folders to Trash? (y/n) [$WHT$default_value$NRM]: $WHT";
2077 $new_delete = <STDIN>;
2078 if ( ( $new_delete =~ /^y\n/i ) || ( ( $new_delete =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2079 $delete_folder = 'false';
2080 } else {
2081 $delete_folder = 'true';
2082 }
2083 }
2084 return $delete_folder;
2085 }
2086
2087 #noselect fix
2088 sub command216 {
2089 print "Some IMAP server allow subfolders to exist even if the parent\n";
2090 print "folders do not. This fixes some problems with the folder list\n";
2091 print "when this is the case, causing the /NoSelect folders to be displayed\n";
2092 print "\n";
2093
2094 if ( lc($noselect_fix_enable) eq 'true' ) {
2095 $default_value = "y";
2096 } else {
2097 $default_value = "n";
2098 }
2099 print "enable noselect fix? (y/n) [$WHT$noselect_fix_enable$NRM]: $WHT";
2100 $noselect_fix_enable = <STDIN>;
2101 if ( ( $noselect_fix_enable =~ /^y\n/i ) || ( ( $noselect_fix_enable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2102 $noselect_fix_enable = 'true';
2103 } else {
2104 $noselect_fix_enable = 'false';
2105 }
2106 return $noselect_fix_enable;
2107 }
2108 ############# GENERAL OPTIONS #####################
2109
2110 # Data directory
2111 sub command33a {
2112 print "Specify the location for your data directory.\n";
2113 print "You need to create this directory yourself.\n";
2114 print "The path name can be absolute or relative (to the config directory).\n";
2115 print "Here are two examples:\n";
2116 print " Absolute: /var/local/squirrelmail/data/\n";
2117 print " Relative: ../data/\n";
2118 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2119 print "will be converted to their absolute path equivalents in config.php.\n\n";
2120 print "Note: There are potential security risks with having a writeable directory\n";
2121 print "under the web server's root directory (ex: /home/httpd/html).\n";
2122 print "For this reason, it is recommended to put the data directory\n";
2123 print "in an alternate location of your choice. \n";
2124 print "\n";
2125
2126 print "[$WHT$data_dir$NRM]: $WHT";
2127 $new_data_dir = <STDIN>;
2128 if ( $new_data_dir eq "\n" ) {
2129 $new_data_dir = $data_dir;
2130 } else {
2131 $new_data_dir =~ s/[\r\n]//g;
2132 }
2133 if ( $new_data_dir =~ /^\s*$/ ) {
2134 $new_data_dir = "";
2135 } else {
2136 $new_data_dir =~ s/\/*$//g;
2137 $new_data_dir =~ s/$/\//g;
2138 }
2139 return $new_data_dir;
2140 }
2141
2142 # Attachment directory
2143 sub command33b {
2144 print "Path to directory used for storing attachments while a mail is\n";
2145 print "being composed. The path name can be absolute or relative (to the\n";
2146 print "config directory). Here are two examples:\n";
2147 print " Absolute: /var/local/squirrelmail/attach/\n";
2148 print " Relative: ../attach/\n";
2149 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2150 print "will be converted to their absolute path equivalents in config.php.\n\n";
2151 print "Note: There are a few security considerations regarding this\n";
2152 print "directory:\n";
2153 print " 1. It should have the permission 733 (rwx-wx-wx) to make it\n";
2154 print " impossible for a random person with access to the webserver\n";
2155 print " to list files in this directory. Confidential data might\n";
2156 print " be laying around in there.\n";
2157 print " Depending on your user:group assignments, 730 (rwx-wx---)\n";
2158 print " may be possible, and more secure (e.g. root:apache)\n";
2159 print " 2. Since the webserver is not able to list the files in the\n";
2160 print " content is also impossible for the webserver to delete files\n";
2161 print " lying around there for too long.\n";
2162 print " 3. It should probably be another directory than the data\n";
2163 print " directory specified in option 3.\n";
2164 print "\n";
2165
2166 print "[$WHT$attachment_dir$NRM]: $WHT";
2167 $new_attachment_dir = <STDIN>;
2168 if ( $new_attachment_dir eq "\n" ) {
2169 $new_attachment_dir = $attachment_dir;
2170 } else {
2171 $new_attachment_dir =~ s/[\r\n]//g;
2172 }
2173 if ( $new_attachment_dir =~ /^\s*$/ ) {
2174 $new_attachment_dir = "";
2175 } else {
2176 $new_attachment_dir =~ s/\/*$//g;
2177 $new_attachment_dir =~ s/$/\//g;
2178 }
2179 return $new_attachment_dir;
2180 }
2181
2182 sub command33c {
2183 print "The directory hash level setting allows you to configure the level\n";
2184 print "of hashing that SquirrelMail employs in your data and attachment\n";
2185 print "directories. This value must be an integer ranging from 0 to 4.\n";
2186 print "When this value is set to 0, SquirrelMail will simply store all\n";
2187 print "files as normal in the data and attachment directories. However,\n";
2188 print "when set to a value from 1 to 4, a simple hashing scheme will be\n";
2189 print "used to organize the files in this directory. In short, the crc32\n";
2190 print "value for a username will be computed. Then, up to the first 4\n";
2191 print "digits of the hash, as set by this configuration value, will be\n";
2192 print "used to directory hash the files for that user in the data and\n";
2193 print "attachment directory. This allows for better performance on\n";
2194 print "servers with larger numbers of users.\n";
2195 print "\n";
2196
2197 print "[$WHT$dir_hash_level$NRM]: $WHT";
2198 $new_dir_hash_level = <STDIN>;
2199 if ( $new_dir_hash_level eq "\n" ) {
2200 $new_dir_hash_level = $dir_hash_level;
2201 } else {
2202 $new_dir_hash_level =~ s/[\r\n]//g;
2203 }
2204 if ( ( int($new_dir_hash_level) < 0 )
2205 || ( int($new_dir_hash_level) > 4 )
2206 || !( int($new_dir_hash_level) eq $new_dir_hash_level ) ) {
2207 print "Invalid Directory Hash Level.\n";
2208 print "Value must be an integer ranging from 0 to 4\n";
2209 print "Hit enter to continue.\n";
2210 $enter_key = <STDIN>;
2211
2212 $new_dir_hash_level = $dir_hash_level;
2213 }
2214
2215 return $new_dir_hash_level;
2216 }
2217
2218 sub command35 {
2219 print "This is the default size (in pixels) of the left folder list.\n";
2220 print "Default is 200, but you can set it to whatever you wish. This\n";
2221 print "is a user preference, so this will only show up as their default.\n";
2222 print "\n";
2223 print "[$WHT$default_left_size$NRM]: $WHT";
2224 $new_default_left_size = <STDIN>;
2225 if ( $new_default_left_size eq "\n" ) {
2226 $new_default_left_size = $default_left_size;
2227 } else {
2228 $new_default_left_size =~ s/[\r\n]//g;
2229 }
2230 return $new_default_left_size;
2231 }
2232
2233 sub command36 {
2234 print "Some IMAP servers only have lowercase letters in the usernames\n";
2235 print "but they still allow people with uppercase to log in. This\n";
2236 print "causes a problem with the user's preference files. This option\n";
2237 print "transparently changes all usernames to lowercase.";
2238 print "\n";
2239
2240 if ( lc($force_username_lowercase) eq 'true' ) {
2241 $default_value = "y";
2242 } else {
2243 $default_value = "n";
2244 }
2245 print "Convert usernames to lowercase (y/n) [$WHT$default_value$NRM]: $WHT";
2246 $new_show = <STDIN>;
2247 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2248 return 'true';
2249 }
2250 return 'false';
2251 }
2252
2253 sub command37 {
2254 print "";
2255 print "\n";
2256
2257 if ( lc($default_use_priority) eq 'true' ) {
2258 $default_value = "y";
2259 } else {
2260 $default_value = "n";
2261 }
2262
2263 print "Allow users to specify priority of outgoing mail (y/n) [$WHT$default_value$NRM]: $WHT";
2264 $new_show = <STDIN>;
2265 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2266 return 'true';
2267 }
2268 return 'false';
2269 }
2270
2271 sub command38 {
2272 print "";
2273 print "\n";
2274
2275 if ( lc($default_hide_attribution) eq 'true' ) {
2276 $default_value = "y";
2277 } else {
2278 $default_value = "n";
2279 }
2280
2281 print "Hide SM attributions (y/n) [$WHT$default_value$NRM]: $WHT";
2282 $new_show = <STDIN>;
2283 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2284 return 'true';
2285 }
2286 return 'false';
2287 }
2288
2289 sub command39 {
2290 print "";
2291 print "\n";
2292
2293 if ( lc($default_use_mdn) eq 'true' ) {
2294 $default_value = "y";
2295 } else {
2296 $default_value = "n";
2297 }
2298
2299 print "Enable support for read/delivery receipt support (y/n) [$WHT$default_value$NRM]: $WHT";
2300 $new_show = <STDIN>;
2301 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2302 return 'true';
2303 }
2304 return 'false';
2305 }
2306
2307
2308 sub command310 {
2309 print " In loosely managed environments, you may want to allow users
2310 to edit their full name and email address. In strictly managed
2311 environments, you may want to force users to use the name
2312 and email address assigned to them.
2313
2314 'y' - allow a user to edit their full name and email address,
2315 'n' - users must use the assigned values.
2316
2317 ";
2318
2319 if ( lc($edit_identity) eq 'true' ) {
2320 $default_value = "y";
2321 } else {
2322 $default_value = "n";
2323 }
2324 print "Allow editing of user's identity? (y/n) [$WHT$default_value$NRM]: $WHT";
2325 $new_edit = <STDIN>;
2326 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2327 $edit_identity = 'true';
2328 $edit_name = 'true';
2329 $hide_auth_header = command311b();
2330 } else {
2331 $edit_identity = 'false';
2332 $edit_name = command311();
2333 $hide_auth_header = command311b();
2334 }
2335 return $edit_identity;
2336 }
2337
2338 sub command311 {
2339 print " Given that users are not allowed to modify their
2340 email address, can they edit their full name?
2341
2342 ";
2343
2344 if ( lc($edit_name) eq 'true' ) {
2345 $default_value = "y";
2346 } else {
2347 $default_value = "n";
2348 }
2349 print "Allow the user to edit their full name? (y/n) [$WHT$default_value$NRM]: $WHT";
2350 $new_edit = <STDIN>;
2351 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2352 $edit_name = 'true';
2353 } else {
2354 $edit_name = 'false';
2355 }
2356 return $edit_name;
2357 }
2358
2359 sub command311b {
2360 print " SquirrelMail adds username information to every sent email
2361 in order to prevent possible sender forging when users are allowed
2362 to change their email and/or full name.
2363
2364 You can remove user information from this header (y), if you think that
2365 it violates privacy or security.
2366
2367 Note: If users are allowed to change their email addresses,
2368 this setting will make it difficult to determine who sent what where.
2369 Use at your own risk.
2370
2371 ";
2372
2373 if ( lc($hide_auth_header) eq "true" ) {
2374 $default_value = "y";
2375 } else {
2376 $default_value = "n";
2377 }
2378 print "Remove username from email headers? (y/n) [$WHT$default_value$NRM]: $WHT";
2379 $new_header = <STDIN>;
2380 if ( ( $new_header =~ /^y\n/i ) || ( ( $new_header =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2381 $hide_auth_header = "true";
2382 } else {
2383 $hide_auth_header = "false";
2384 }
2385 return $hide_auth_header;
2386 }
2387
2388 sub command312 {
2389 print "This option allows you to disable server side thread sorting if your server \n";
2390 print "declares THREAD support, but you don't want to provide threading options \n";
2391 print "to end users or THREAD extension is broken or extension does not work with \n";
2392 print "options used by SquirrelMail. Option is not used, if THREAD extension is \n";
2393 print "not declared in IMAP CAPABILITY.\n";
2394 print "\n";
2395
2396 if ( lc($disable_thread_sort) eq 'true' ) {
2397 $default_value = "y";
2398 } else {
2399 $default_value = "n";
2400 }
2401 print "Disable server side thread sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2402 $disable_thread_sort = <STDIN>;
2403 if ( ( $disable_thread_sort =~ /^y\n/i ) || ( ( $disable_thread_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2404 $disable_thread_sort = 'true';
2405 } else {
2406 $disable_thread_sort = 'false';
2407 }
2408 return $disable_thread_sort;
2409 }
2410
2411 sub command313 {
2412 print "This option allows you to disable server side sorting if your server declares \n";
2413 print "SORT support, but SORT extension is broken or does not work with options \n";
2414 print "used by SquirrelMail. Option is not used, if SORT extension is not declared \n";
2415 print "in IMAP CAPABILITY.\n";
2416 print "\n";
2417 print "It is strongly recommended to keep server side sorting enabled, if your ";
2418 print "IMAP server supports it.";
2419 print "\n";
2420
2421 if ( lc($disable_server_sort) eq 'true' ) {
2422 $default_value = "y";
2423 } else {
2424 $default_value = "n";
2425 }
2426 print "Disable server-side sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2427 $disable_server_sort = <STDIN>;
2428 if ( ( $disable_server_sort =~ /^y\n/i ) || ( ( $disable_server_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2429 $disable_server_sort = 'true';
2430 } else {
2431 $disable_server_sort = 'false';
2432 }
2433 return $disable_server_sort;
2434 }
2435
2436 sub command314 {
2437 print "This option allows you to choose if SM uses charset search\n";
2438 print "Your IMAP server must support the SEARCH CHARSET command for this to work\n";
2439 print "\n";
2440
2441 if ( lc($allow_charset_search) eq 'true' ) {
2442 $default_value = "y";
2443 } else {
2444 $default_value = "n";
2445 }
2446 print "Allow charset searching? (y/n) [$WHT$default_value$NRM]: $WHT";
2447 $allow_charset_search = <STDIN>;
2448 if ( ( $allow_charset_search =~ /^y\n/i ) || ( ( $allow_charset_search =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2449 $allow_charset_search = 'true';
2450 } else {
2451 $allow_charset_search = 'false';
2452 }
2453 return $allow_charset_search;
2454 }
2455
2456 # command315 (UID support) obsoleted.
2457
2458 # advanced search option
2459 sub command316 {
2460 print "This option allows you to control the use of advanced search form.\n";
2461 print " 0 = enable basic search only\n";
2462 print " 1 = enable advanced search only\n";
2463 print " 2 = enable both\n";
2464 print "\n";
2465
2466 print "Allowed search (0,1,2)? [$WHT$allow_advanced_search$NRM]: $WHT";
2467 $new_allow_advanced_search = <STDIN>;
2468 if ( $new_allow_advanced_search =~ /^[012]\n/i ) {
2469 $allow_advanced_search = $new_allow_advanced_search;
2470 }
2471 $allow_advanced_search =~ s/[\r\n]//g;
2472 return $allow_advanced_search;
2473 }
2474
2475
2476 sub command317 {
2477 print "This option allows you to change the name of the PHP session used\n";
2478 print "by SquirrelMail. Unless you know what you are doing, you probably\n";
2479 print "don't need or want to change this from the default of SQMSESSID.\n";
2480 print "[$WHT$session_name$NRM]: $WHT";
2481 $new_session_name = <STDIN>;
2482 chomp($new_session_name);
2483 if ( $new_session_name eq "" ) {
2484 $new_session_name = $session_name;
2485 }
2486 return $new_session_name;
2487 }
2488
2489 # time zone config (since 1.5.1)
2490 sub command318 {
2491 print "This option allows you to control the use of time zones.\n";
2492 print " 0 = (default) standard, GNU C time zone names\n";
2493 print " 1 = strict, generic time zone codes with offsets\n";
2494 print " 2 = custom, GNU C time zones loaded from config/timezones.php\n";
2495 print " 3 = custom strict, generic time zone codes with offsets loaded \n";
2496 print " from config/timezones.php\n";
2497 print "See SquirrelMail documentation about format of config/timezones.php file.\n";
2498 print "\n";
2499
2500 print "Used time zone configuration (0,1,2,3)? [$WHT$time_zone_type$NRM]: $WHT";
2501 $new_time_zone_type = <STDIN>;
2502 if ( $new_time_zone_type =~ /^[0123]\n/i ) {
2503 $time_zone_type = $new_time_zone_type;
2504 } else {
2505 print "\nInvalid configuration value.\n";
2506 print "\nPress enter to continue...";
2507 $tmp = <STDIN>;
2508 }
2509 $time_zone_type =~ s/[\r\n]//g;
2510 return $time_zone_type;
2511 }
2512
2513 # set the location base for redirects (since 1.5.2)
2514 sub command_config_location_base {
2515 print "Here you can set the base part of the SquirrelMail URL.\n";
2516 print "It is normally autodetected but if that fails, use this\n";
2517 print "option to override.\n";
2518 print "It should contain only the protocol and hostname/port parts\n";
2519 print "of the URL; the full path will be appended automatically.\n\n";
2520 print "Examples:\nhttp://webmail.example.org\nhttp://webmail.example.com:8080\nhttps://webmail.example.com:6691\n\n";
2521 print "Do not add any path elements.\n";
2522
2523 print "URL base? [" .$WHT."autodetect$NRM]: $WHT";
2524 $new_config_location_base = <STDIN>;
2525 chomp($new_config_location_base);
2526 $config_location_base = $new_config_location_base;
2527
2528 return $config_location_base;
2529 }
2530
2531
2532
2533 sub command41 {
2534 print "\nDefine the themes that you wish to use. If you have added ";
2535 print "a theme of your own, just follow the instructions (?) about how to add ";
2536 print "them. You can also change the default theme.\n";
2537 print "[theme] command (?=help) > ";
2538 $input = <STDIN>;
2539 $input =~ s/[\r\n]//g;
2540 while ( $input ne "d" ) {
2541 if ( $input =~ /^\s*l\s*/i ) {
2542 $count = 0;
2543 while ( $count <= $#theme_name ) {
2544 if ( $count == $theme_default ) {
2545 print " *";
2546 } else {
2547 print " ";
2548 }
2549 if ( $count < 10 ) {
2550 print " ";
2551 }
2552 $name = $theme_name[$count];
2553 $num_spaces = 35 - length($name);
2554 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2555 $name = $name . " ";
2556 }
2557
2558 print " $count. $name";
2559 print "($theme_path[$count])\n";
2560
2561 $count++;
2562 }
2563 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2564 $old_def = $theme_default;
2565 $theme_default = $input;
2566 $theme_default =~ s/^\s*m\s*//;
2567 if ( ( $theme_default > $#theme_name ) || ( $theme_default < 0 ) ) {
2568 print "Cannot set default theme to $theme_default. That theme does not exist.\n";
2569 $theme_default = $old_def;
2570 }
2571 } elsif ( $input =~ /^\s*\+/ ) {
2572 print "What is the name of this theme: ";
2573 $name = <STDIN>;
2574 $name =~ s/[\r\n]//g;
2575 $theme_name[ $#theme_name + 1 ] = $name;
2576 print "Be sure to put ../themes/ before the filename.\n";
2577 print "What file is this stored in (ex: ../themes/default_theme.php): ";
2578 $name = <STDIN>;
2579 $name =~ s/[\r\n]//g;
2580 $theme_path[ $#theme_path + 1 ] = $name;
2581 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2582 if ( $input =~ /[0-9]+\s*$/ ) {
2583 $rem_num = $input;
2584 $rem_num =~ s/^\s*-\s*//g;
2585 $rem_num =~ s/\s*$//;
2586 } else {
2587 $rem_num = $#theme_name;
2588 }
2589 if ( $rem_num == $theme_default ) {
2590 print "You cannot remove the default theme!\n";
2591 } else {
2592 $count = 0;
2593 @new_theme_name = ();
2594 @new_theme_path = ();
2595 while ( $count <= $#theme_name ) {
2596 if ( $count != $rem_num ) {
2597 @new_theme_name = ( @new_theme_name, $theme_name[$count] );
2598 @new_theme_path = ( @new_theme_path, $theme_path[$count] );
2599 }
2600 $count++;
2601 }
2602 @theme_name = @new_theme_name;
2603 @theme_path = @new_theme_path;
2604 if ( $theme_default > $rem_num ) {
2605 $theme_default--;
2606 }
2607 }
2608 } elsif ( $input =~ /^\s*t\s*/i ) {
2609 print "\nStarting detection...\n\n";
2610
2611 opendir( DIR, "../themes" );
2612 @files = grep { /\.php$/i } readdir(DIR);
2613 $cnt = 0;
2614 while ( $cnt <= $#files ) {
2615 $filename = "../themes/" . $files[$cnt];
2616 if ( $filename ne "../themes/index.php" ) {
2617 $found = 0;
2618 for ( $x = 0 ; $x <= $#theme_path ; $x++ ) {
2619 if ( $theme_path[$x] eq $filename ) {
2620 $found = 1;
2621 }
2622 }
2623 if ( $found != 1 ) {
2624 print "** Found theme: $filename\n";
2625 print " What is its name? ";
2626 $nm = <STDIN>;
2627 $nm =~ s/[\n\r]//g;
2628 $theme_name[ $#theme_name + 1 ] = $nm;
2629 $theme_path[ $#theme_path + 1 ] = $filename;
2630 }
2631 }
2632 $cnt++;
2633 }
2634 print "\n";
2635 for ( $cnt = 0 ; $cnt <= $#theme_path ; $cnt++ ) {
2636 $filename = $theme_path[$cnt];
2637 if ( !( -e $filename ) ) {
2638 print " Removing $filename (file not found)\n";
2639 $offset = 0;
2640 @new_theme_name = ();
2641 @new_theme_path = ();
2642 for ( $x = 0 ; $x < $#theme_path ; $x++ ) {
2643 if ( $theme_path[$x] eq $filename ) {
2644 $offset = 1;
2645 }
2646 if ( $offset == 1 ) {
2647 $new_theme_name[$x] = $theme_name[ $x + 1 ];
2648 $new_theme_path[$x] = $theme_path[ $x + 1 ];
2649 } else {
2650 $new_theme_name[$x] = $theme_name[$x];
2651 $new_theme_path[$x] = $theme_path[$x];
2652 }
2653 }
2654 @theme_name = @new_theme_name;
2655 @theme_path = @new_theme_path;
2656 }
2657 }
2658 print "\nDetection complete!\n\n";
2659
2660 closedir DIR;
2661 } elsif ( $input =~ /^\s*\?\s*/ ) {
2662 print ".-------------------------.\n";
2663 print "| t (detect themes) |\n";
2664 print "| + (add theme) |\n";
2665 print "| - N (remove theme) |\n";
2666 print "| m N (mark default) |\n";
2667 print "| l (list themes) |\n";
2668 print "| d (done) |\n";
2669 print "`-------------------------'\n";
2670 }
2671 print "[theme] command (?=help) > ";
2672 $input = <STDIN>;
2673 $input =~ s/[\r\n]//g;
2674 }
2675 }
2676
2677 sub command_templates {
2678 print "\nDefine the template sets that you wish to use. If you have added ";
2679 print "a template set of your own, just follow the instructions (?) about how to add ";
2680 print "them. You can also change the default template.\n";
2681
2682 print "\n Available Templates:\n";
2683
2684 $count = 0;
2685 while ( $count <= $#templateset_name ) {
2686 if ( $count == $templateset_default ) {
2687 print " *";
2688 } else {
2689 print " ";
2690 }
2691 if ( $count < 10 ) {
2692 print " ";
2693 }
2694 $name = $templateset_name[$count];
2695 $num_spaces = 35 - length($name);
2696 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2697 $name = $name . " ";
2698 }
2699
2700 print " $count. $name";
2701 print "($templateset_id[$count])\n";
2702
2703 $count++;
2704 }
2705
2706 # FIXME: what is this stuff? it is commented out, can we just blast it?
2707 # opendir( DIR, "../templates" );
2708 # @files = readdir(DIR);
2709 # $pos = 0;
2710 #
2711 # while ( $cnt <= $#files ) {
2712 # if ( -d "../templates/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne "CVS" ) {
2713 # $filename = "../templates/" . $files[$cnt];
2714 # $found = 0;
2715 # for ( $x = 0 ; $x <= $#templateset_id ; $x++ ) {
2716 # if ( $theme_path[$x] eq $filename ) {
2717 # $found = 1;
2718 # }
2719 # }
2720 # }
2721 # $cnt++;
2722 # }
2723 # for ( $i = 0 ; $i <= $#files ; $i++ ) {
2724 # if ( -d "../templates/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne "CVS" ) {
2725 # $match = 0;
2726 # for ( $k = 0 ; $k <= $#aTemplateSets ; $k++ ) {
2727 # if ( $aTemplateSets[$chosen] eq $files[$i] ) {
2728 # $match = 1;
2729 # }
2730 # }
2731 # if ( $match == 0 ) {
2732 # $unused_plugins[$pos] = $files[$i];
2733 # $pos++;
2734 # }
2735 # }
2736 # }
2737 #
2738 # for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
2739 # $num = $num + 1;
2740 # print " $num. $unused_plugins[$i]\n";
2741 # }
2742 # closedir DIR;
2743
2744 $menu_text = ".-------------------------------------.\n"
2745 . "| t (detect templates set) |\n"
2746 . "| + (add template set) |\n"
2747 . "| - N (remove template set) |\n"
2748 . "| m N (mark default template set) |\n"
2749 . "| l (list template sets) |\n"
2750 . "| d (done) |\n"
2751 . "|-------------------------------------|\n"
2752 . "| where N is a template set number |\n"
2753 . "`-------------------------------------'\n";
2754 print "\n";
2755 print <