Add pointer to doc/ directory
[squirrelmail.git] / config / conf.pl
1 #!/usr/bin/env perl
2 # conf.pl
3 #
4 # Copyright (c) 1999-2007 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.5.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 # Make sure that file is readable
50 if (! -r "config.php") {
51 clear_screen();
52 print "WARNING:\n";
53 print "The file \"config/config.php\" was found, but you don't\n";
54 print "have rights to read it.\n";
55 print "\n";
56 print "Press enter to continue";
57 $ctu = <STDIN>;
58 exit;
59 }
60 open( FILE, "config.php" );
61 while ( $line = <FILE> ) {
62 $line =~ s/^\s+//;
63 $line =~ s/^\$//;
64 $var = $line;
65
66 $var =~ s/=/EQUALS/;
67 if ( $var =~ /^([a-z])/i ) {
68 @o = split ( /\s*EQUALS\s*/, $var );
69 if ( $o[0] eq "config_version" ) {
70 $o[1] =~ s/[\n\r]//g;
71 $o[1] =~ s/[\'\"];\s*$//;
72 $o[1] =~ s/;$//;
73 $o[1] =~ s/^[\'\"]//;
74
75 $config_version = $o[1];
76 close(FILE);
77 }
78 }
79 }
80 close(FILE);
81
82 if ( $config_version ne $conf_pl_version ) {
83 clear_screen();
84 print "WARNING:\n";
85 print " The file \"config/config.php\" was found, but it is for\n";
86 print " an older version of SquirrelMail. It is possible to still\n";
87 print " read the defaults from this file but be warned that many\n";
88 print " preferences change between versions. It is recommended that\n";
89 print " you start with a clean config.php for each upgrade that you\n";
90 print " do. To do this, just move config/config.php out of the way.\n";
91 print "\n";
92 print "Continue loading with the old config.php [y/N]? ";
93 $ctu = <STDIN>;
94
95 if ( ( $ctu !~ /^y\n/i ) || ( $ctu =~ /^\n/ ) ) {
96 exit;
97 }
98
99 print "\nDo you want me to stop warning you [y/N]? ";
100 $ctu = <STDIN>;
101 if ( $ctu =~ /^y\n/i ) {
102 $print_config_version = $conf_pl_version;
103 } else {
104 $print_config_version = $config_version;
105 }
106 } else {
107 $print_config_version = $config_version;
108 }
109
110 $config = 1;
111 open( FILE, "config.php" );
112 } elsif ( -e "config_default.php" ) {
113 open( FILE, "config_default.php" );
114 while ( $line = <FILE> ) {
115 $line =~ s/^\s+//;
116 $line =~ s/^\$//;
117 $var = $line;
118
119 $var =~ s/=/EQUALS/;
120 if ( $var =~ /^([a-z])/i ) {
121 @o = split ( /\s*EQUALS\s*/, $var );
122 if ( $o[0] eq "config_version" ) {
123 $o[1] =~ s/[\n\r]//g;
124 $o[1] =~ s/[\'\"];\s*$//;
125 $o[1] =~ s/;$//;
126 $o[1] =~ s/^[\'\"]//;
127
128 $config_version = $o[1];
129 close(FILE);
130 }
131 }
132 }
133 close(FILE);
134
135 if ( $config_version ne $conf_pl_version ) {
136 clear_screen();
137 print "WARNING:\n";
138 print " You are trying to use a 'config_default.php' from an older\n";
139 print " version of SquirrelMail. This is HIGHLY unrecommended. You\n";
140 print " should get the 'config_default.php' that matches the version\n";
141 print " of SquirrelMail that you are running. You can get this from\n";
142 print " the SquirrelMail web page by going to the following URL:\n";
143 print " http://squirrelmail.org.\n";
144 print "\n";
145 print "Continue loading with old config_default.php (a bad idea) [y/N]? ";
146 $ctu = <STDIN>;
147
148 if ( ( $ctu !~ /^y\n/i ) || ( $ctu =~ /^\n/ ) ) {
149 exit;
150 }
151
152 print "\nDo you want me to stop warning you [y/N]? ";
153 $ctu = <STDIN>;
154 if ( $ctu =~ /^y\n/i ) {
155 $print_config_version = $conf_pl_version;
156 } else {
157 $print_config_version = $config_version;
158 }
159 } else {
160 $print_config_version = $config_version;
161 }
162 $config = 2;
163 open( FILE, "config_default.php" );
164 } else {
165 print "No configuration file found. Please get config_default.php\n";
166 print "or config.php before running this again. This program needs\n";
167 print "a default config file to get default values.\n";
168 exit;
169 }
170
171 # Read and parse the current configuration file
172 # (either config.php or config_default.php).
173 while ( $line = <FILE> ) {
174 $line =~ s/^\s+//;
175 $line =~ s/^\$//;
176 $var = $line;
177
178 $var =~ s/=/EQUALS/;
179 if ( $var =~ /^([a-z])/i ) {
180 @options = split ( /\s*EQUALS\s*/, $var );
181 $options[1] =~ s/[\n\r]//g;
182 $options[1] =~ s/[\'\"];\s*$//;
183 $options[1] =~ s/;$//;
184 $options[1] =~ s/^[\'\"]//;
185 # de-escape escaped strings
186 $options[1] =~ s/\\'/'/g;
187 $options[1] =~ s/\\\\/\\/g;
188
189 if ( $options[0] =~ /^user_themes\[[0-9]+\]\[['"]PATH['"]\]/ ) {
190 $sub = $options[0];
191 $sub =~ s/\]\[['"]PATH['"]\]//;
192 $sub =~ s/.*\[//;
193 if ( -e "../css/" ) {
194 $options[1] =~ s/^\.\.\/config/\.\.\/css/;
195 }
196 $user_theme_path[$sub] = &change_to_rel_path($options[1]);
197 } elsif ( $options[0] =~ /^user_themes\[[0-9]+\]\[['"]NAME['"]\]/ ) {
198 $sub = $options[0];
199 $sub =~ s/\]\[['"]NAME['"]\]//;
200 $sub =~ s/.*\[//;
201 $user_theme_name[$sub] = $options[1];
202 } elsif ( $options[0] =~ /^icon_themes\[[0-9]+\]\[['"]PATH['"]\]/ ) {
203 $sub = $options[0];
204 $sub =~ s/\]\[['"]PATH['"]\]//;
205 $sub =~ s/.*\[//;
206 if ( -e "../images/" ) {
207 $options[1] =~ s/^\.\.\/config/\.\.\/images/;
208 }
209 $icon_theme_path[$sub] = &change_to_rel_path($options[1]);
210 } elsif ( $options[0] =~ /^icon_themes\[[0-9]+\]\[['"]NAME['"]\]/ ) {
211 $sub = $options[0];
212 $sub =~ s/\]\[['"]NAME['"]\]//;
213 $sub =~ s/.*\[//;
214 $icon_theme_name[$sub] = $options[1];
215 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]ID['"]\]/ ) {
216 $sub = $options[0];
217 $sub =~ s/\]\[['"]ID['"]\]//;
218 $sub =~ s/.*\[//;
219 if ( -e "../templates" ) {
220 $options[1] =~ s/^\.\.\/config/\.\.\/templates/;
221 }
222 $templateset_id[$sub] = $options[1];
223 ##### FIXME: This section BELOW here so old prefs files don't blow up when running conf.pl
224 ##### Remove after a month or two
225 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]PATH['"]\]/ ) {
226 $sub = $options[0];
227 $sub =~ s/\]\[['"]PATH['"]\]//;
228 $sub =~ s/.*\[//;
229 if ( -e "../templates" ) {
230 $options[1] =~ s/^\.\.\/config/\.\.\/templates/;
231 }
232 $templateset_id[$sub] = $options[1];
233 ##### FIXME: This section ABOVE here so old prefs files don't blow up when running conf.pl
234 ##### Remove after a month or two
235 } elsif ( $options[0] =~ /^aTemplateSet\[[0-9]+\]\[['"]NAME['"]\]/ ) {
236 $sub = $options[0];
237 $sub =~ s/\]\[['"]NAME['"]\]//;
238 $sub =~ s/.*\[//;
239 $templateset_name[$sub] = $options[1];
240 } elsif ( $options[0] =~ /^plugins\[[0-9]*\]/ ) {
241 $sub = $options[0];
242 $sub =~ s/\]//;
243 $sub =~ s/^plugins\[//;
244 if ($sub eq '') {
245 push @plugins, $options[1];
246 } else {
247 $plugins[$sub] = $options[1];
248 }
249 } elsif ($options[0] =~ /^fontsets\[\'[a-z]*\'\]/) {
250 # parse associative $fontsets array
251 $sub = $options[0];
252 $sub =~ s/\'\]//;
253 $sub =~ s/^fontsets\[\'//;
254 $fontsets{$sub} = $options[1];
255 } elsif ( $options[0] =~ /^theme\[[0-9]+\]\[['"]PATH|NAME['"]\]/ ) {
256 ##
257 ## $color themes are no longer supported. Please leave this
258 ## so conf.pl doesn't barf if it encounters a $theme.
259 ##
260 } elsif ( $options[0] =~ /^ldap_server\[[0-9]+\]/ ) {
261 $sub = $options[0];
262 $sub =~ s/\]//;
263 $sub =~ s/^ldap_server\[//;
264 $continue = 0;
265 while ( ( $tmp = <FILE> ) && ( $continue != 1 ) ) {
266 if ( $tmp =~ /\);\s*$/ ) {
267 $continue = 1;
268 }
269
270 if ( $tmp =~ /^\s*[\'\"]host[\'\"]/i ) {
271 $tmp =~ s/^\s*[\'\"]host[\'\"]\s*=>\s*[\'\"]//i;
272 $tmp =~ s/[\'\"],?\s*$//;
273 $tmp =~ s/[\'\"]\);\s*$//;
274 $host = $tmp;
275 } elsif ( $tmp =~ /^\s*[\'\"]base[\'\"]/i ) {
276 $tmp =~ s/^\s*[\'\"]base[\'\"]\s*=>\s*[\'\"]//i;
277 $tmp =~ s/[\'\"],?\s*$//;
278 $tmp =~ s/[\'\"]\);\s*$//;
279 $base = $tmp;
280 } elsif ( $tmp =~ /^\s*[\'\"]charset[\'\"]/i ) {
281 $tmp =~ s/^\s*[\'\"]charset[\'\"]\s*=>\s*[\'\"]//i;
282 $tmp =~ s/[\'\"],?\s*$//;
283 $tmp =~ s/[\'\"]\);\s*$//;
284 $charset = $tmp;
285 } elsif ( $tmp =~ /^\s*[\'\"]port[\'\"]/i ) {
286 $tmp =~ s/^\s*[\'\"]port[\'\"]\s*=>\s*[\'\"]?//i;
287 $tmp =~ s/[\'\"]?,?\s*$//;
288 $tmp =~ s/[\'\"]?\);\s*$//;
289 $port = $tmp;
290 } elsif ( $tmp =~ /^\s*[\'\"]maxrows[\'\"]/i ) {
291 $tmp =~ s/^\s*[\'\"]maxrows[\'\"]\s*=>\s*[\'\"]?//i;
292 $tmp =~ s/[\'\"]?,?\s*$//;
293 $tmp =~ s/[\'\"]?\);\s*$//;
294 $maxrows = $tmp;
295 } elsif ( $tmp =~ /^\s*[\'\"]filter[\'\"]/i ) {
296 $tmp =~ s/^\s*[\'\"]filter[\'\"]\s*=>\s*[\'\"]?//i;
297 $tmp =~ s/[\'\"]?,?\s*$//;
298 $tmp =~ s/[\'\"]?\);\s*$//;
299 $filter = $tmp;
300 } elsif ( $tmp =~ /^\s*[\'\"]name[\'\"]/i ) {
301 $tmp =~ s/^\s*[\'\"]name[\'\"]\s*=>\s*[\'\"]//i;
302 $tmp =~ s/[\'\"],?\s*$//;
303 $tmp =~ s/[\'\"]\);\s*$//;
304 $name = $tmp;
305 } elsif ( $tmp =~ /^\s*[\'\"]binddn[\'\"]/i ) {
306 $tmp =~ s/^\s*[\'\"]binddn[\'\"]\s*=>\s*[\'\"]//i;
307 $tmp =~ s/[\'\"],?\s*$//;
308 $tmp =~ s/[\'\"]\);\s*$//;
309 $binddn = $tmp;
310 } elsif ( $tmp =~ /^\s*[\'\"]bindpw[\'\"]/i ) {
311 $tmp =~ s/^\s*[\'\"]bindpw[\'\"]\s*=>\s*[\'\"]//i;
312 $tmp =~ s/[\'\"],?\s*$//;
313 $tmp =~ s/[\'\"]\);\s*$//;
314 $bindpw = $tmp;
315 } elsif ( $tmp =~ /^\s*[\'\"]protocol[\'\"]/i ) {
316 $tmp =~ s/^\s*[\'\"]protocol[\'\"]\s*=>\s*[\'\"]?//i;
317 $tmp =~ s/[\'\"]?,?\s*$//;
318 $tmp =~ s/[\'\"]?\);\s*$//;
319 $protocol = $tmp;
320 } elsif ( $tmp =~ /^\s*[\'\"]limit_scope[\'\"]/i ) {
321 $tmp =~ s/^\s*[\'\"]limit_scope[\'\"]\s*=>\s*[\'\"]?//i;
322 $tmp =~ s/[\'\"]?,?\s*$//;
323 $tmp =~ s/[\'\"]?\);\s*$//;
324 $limit_scope = $tmp;
325 } elsif ( $tmp =~ /^\s*[\'\"]listing[\'\"]/i ) {
326 $tmp =~ s/^\s*[\'\"]listing[\'\"]\s*=>\s*[\'\"]?//i;
327 $tmp =~ s/[\'\"]?,?\s*$//;
328 $tmp =~ s/[\'\"]?\);\s*$//;
329 $listing = $tmp;
330 } elsif ( $tmp =~ /^\s*[\'\"]writeable[\'\"]/i ) {
331 $tmp =~ s/^\s*[\'\"]writeable[\'\"]\s*=>\s*[\'\"]?//i;
332 $tmp =~ s/[\'\"]?,?\s*$//;
333 $tmp =~ s/[\'\"]?\);\s*$//;
334 $writeable = $tmp;
335 } elsif ( $tmp =~ /^\s*[\'\"]search_tree[\'\"]/i ) {
336 $tmp =~ s/^\s*[\'\"]search_tree[\'\"]\s*=>\s*[\'\"]?//i;
337 $tmp =~ s/[\'\"]?,?\s*$//;
338 $tmp =~ s/[\'\"]?\);\s*$//;
339 $search_tree = $tmp;
340 } elsif ( $tmp =~ /^\s*[\'\"]starttls[\'\"]/i ) {
341 $tmp =~ s/^\s*[\'\"]starttls[\'\"]\s*=>\s*[\'\"]?//i;
342 $tmp =~ s/[\'\"]?,?\s*$//;
343 $tmp =~ s/[\'\"]?\);\s*$//;
344 $starttls = $tmp;
345 }
346 }
347 $ldap_host[$sub] = $host;
348 $ldap_base[$sub] = $base;
349 $ldap_name[$sub] = $name;
350 $ldap_port[$sub] = $port;
351 $ldap_maxrows[$sub] = $maxrows;
352 $ldap_filter[$sub] = $filter;
353 $ldap_charset[$sub] = $charset;
354 $ldap_binddn[$sub] = $binddn;
355 $ldap_bindpw[$sub] = $bindpw;
356 $ldap_protocol[$sub] = $protocol;
357 $ldap_limit_scope[$sub] = $limit_scope;
358 $ldap_listing[$sub] = $listing;
359 $ldap_writeable[$sub] = $writeable;
360 $ldap_search_tree[$sub] = $search_tree;
361 $ldap_starttls[$sub] = $starttls;
362 } elsif ( $options[0] =~ /^(data_dir|attachment_dir|org_logo|signout_page|icon_theme_def)$/ ) {
363 ${ $options[0] } = &change_to_rel_path($options[1]);
364 } else {
365 ${ $options[0] } = $options[1];
366 }
367 }
368 }
369 close FILE;
370
371 # RPC template sets aren't included in user interface skin list,
372 # so add the one from the config file here
373 #
374 if ($rpc_templateset =~ /_rpc$/) {
375 $templateset_name[$#templateset_name + 1] = $rpc_templateset;
376 $templateset_id[$#templateset_id + 1] = $rpc_templateset;
377 }
378
379 # FIXME: unknown introduction date
380 $useSendmail = 'false' if ( lc($useSendmail) ne 'true' );
381 $sendmail_path = "/usr/sbin/sendmail" if ( !$sendmail_path );
382 $pop_before_smtp = 'false' if ( !$pop_before_smtp );
383 $pop_before_smtp_host = '' if ( !$pop_before_smtp_host );
384 $default_unseen_notify = 2 if ( !$default_unseen_notify );
385 $default_unseen_type = 1 if ( !$default_unseen_type );
386 $config_use_color = 0 if ( !$config_use_color );
387 $invert_time = 'false' if ( !$invert_time );
388 $force_username_lowercase = 'false' if ( !$force_username_lowercase );
389 $optional_delimiter = "detect" if ( !$optional_delimiter );
390 $auto_create_special = 'false' if ( !$auto_create_special );
391 $default_use_priority = 'true' if ( !$default_use_priority );
392 $default_use_mdn = 'true' if ( !$default_use_mdn );
393 $delete_folder = 'false' if ( !$delete_folder );
394 $noselect_fix_enable = 'false' if ( !$noselect_fix_enable );
395 $frame_top = "_top" if ( !$frame_top );
396 $provider_uri = '' if ( !$provider_uri );
397 $provider_name = '' if ( !$provider_name || $provider_name eq 'SquirrelMail');
398 $no_list_for_subscribe = 'false' if ( !$no_list_for_subscribe );
399 $allow_charset_search = 'true' if ( !$allow_charset_search );
400 $allow_advanced_search = 0 if ( !$allow_advanced_search) ;
401 $prefs_user_field = 'user' if ( !$prefs_user_field );
402 $prefs_key_field = 'prefkey' if ( !$prefs_key_field );
403 $prefs_val_field = 'prefval' if ( !$prefs_val_field );
404 $session_name = 'SQMSESSID' if ( !$session_name );
405 $skip_SM_header = 'false' if ( !$skip_SM_header );
406 $default_use_javascript_addr_book = 'false' if (! $default_use_javascript_addr_book);
407
408 # since 1.2.0
409 $hide_sm_attributions = 'false' if ( !$hide_sm_attributions );
410 # since 1.2.5
411 $edit_identity = 'true' if ( !$edit_identity );
412 $edit_name = 'true' if ( !$edit_name );
413
414 # since 1.4.0
415 $use_smtp_tls= 'false' if ( !$use_smtp_tls);
416 $smtp_auth_mech = 'none' if ( !$smtp_auth_mech );
417 $use_imap_tls = 'false' if ( !$use_imap_tls );
418 $imap_auth_mech = 'login' if ( !$imap_auth_mech );
419
420 # since 1.5.0
421 $show_alternative_names = 'false' if ( !$show_alternative_names );
422 # $available_languages option available only in 1.5.0. removed due to $languages
423 # implementation changes. options are provided by limit_languages plugin
424 # $available_languages = 'all' if ( !$available_languages );
425 $aggressive_decoding = 'false' if ( !$aggressive_decoding );
426 # available only in 1.5.0 and 1.5.1
427 # $advanced_tree = 'false' if ( !$advanced_tree );
428 $use_php_recode = 'false' if ( !$use_php_recode );
429 $use_php_iconv = 'false' if ( !$use_php_iconv );
430 $buffer_output = 'false' if ( !$buffer_output );
431
432 # since 1.5.1
433 $use_icons = 'false' if ( !$use_icons );
434 $use_iframe = 'false' if ( !$use_iframe );
435 $lossy_encoding = 'false' if ( !$lossy_encoding );
436 $allow_remote_configtest = 'false' if ( !$allow_remote_configtest );
437 $secured_config = 'true' if ( !$secured_config );
438 $sq_https_port = 443 if ( !$sq_https_port );
439 $sq_ignore_http_x_forwarded_headers = 'true' if ( !$sq_ignore_http_x_forwarded_headers );
440
441 $sm_debug_mode = 'SM_DEBUG_MODE_MODERATE' if ( !$sm_debug_mode );
442 #FIXME: When this is STABLE software, remove the line above and uncomment the one below:
443 #$sm_debug_mode = 'SM_DEBUG_MODE_OFF' if ( !$sm_debug_mode );
444 $sm_debug_mode = convert_debug_binary_integer_to_constants($sm_debug_mode);
445
446 $addrbook_global_table = 'global_abook' if ( !$addrbook_global_table );
447 $addrbook_global_writeable = 'false' if ( !$addrbook_global_writeable );
448 $addrbook_global_listing = 'false' if ( !$addrbook_global_listing );
449 $abook_global_file = '' if ( !$abook_global_file);
450 $abook_global_file_writeable = 'false' if ( !$abook_global_file_writeable);
451 $abook_global_file_listing = 'true' if ( !$abook_global_file_listing );
452 $encode_header_key = '' if ( !$encode_header_key );
453 $hide_auth_header = 'false' if ( !$hide_auth_header );
454 $time_zone_type = '0' if ( !$time_zone_type );
455 $prefs_user_size = 128 if ( !$prefs_user_size );
456 $prefs_key_size = 64 if ( !$prefs_key_size );
457 $prefs_val_size = 65536 if ( !$prefs_val_size );
458
459 # add qmail-inject test here for backwards compatibility
460 if ( !$sendmail_args && $sendmail_path =~ /qmail-inject/ ) {
461 $sendmail_args = '';
462 } elsif ( !$sendmail_args ) {
463 $sendmail_args = '-i -t';
464 }
465
466 $default_fontsize = '' if ( !$default_fontsize);
467 $default_fontset = '' if ( !$default_fontset);
468 if ( !%fontsets) {
469 %fontsets = ('serif', 'serif',
470 'sans', 'helvetica,arial,sans-serif',
471 'comicsans', 'comic sans ms,sans-serif',
472 'tahoma', 'tahoma,sans-serif',
473 'verasans', 'bitstream vera sans,verdana,sans-serif');
474 }
475
476 # $use_imap_tls and $use_smtp_tls are switched to integer since 1.5.1
477 $use_imap_tls = 0 if ( $use_imap_tls eq 'false');
478 $use_imap_tls = 1 if ( $use_imap_tls eq 'true');
479 $use_smtp_tls = 0 if ( $use_smtp_tls eq 'false');
480 $use_smtp_tls = 1 if ( $use_smtp_tls eq 'true');
481 # sorting options changed names and reversed values in 1.5.1
482 $disable_thread_sort = 'false' if ( !$disable_thread_sort );
483 $disable_server_sort = 'false' if ( !$disable_server_sort );
484
485 # since 1.5.2
486 $abook_file_line_length = 2048 if ( !$abook_file_line_length );
487 $config_location_base = '' if ( !$config_location_base );
488 $smtp_sitewide_user = '' if ( !$smtp_sitewide_user );
489 $smtp_sitewide_pass = '' if ( !$smtp_sitewide_pass );
490 $icon_theme_def = '' if ( !$icon_theme_def );
491 $disable_plugins = 'false' if ( !$disable_plugins );
492 $disable_plugins_user = '' if ( !$disable_plugins_user );
493 $only_secure_cookies = 'true' if ( !$only_secure_cookies );
494 $ask_user_info = 'true' if ( !$ask_user_info );
495
496 if ( $ARGV[0] eq '--install-plugin' ) {
497 print "Activating plugin " . $ARGV[1] . "\n";
498 if ( -d "../plugins/" . $ARGV[1]) {
499 push @plugins, $ARGV[1];
500 save_data();
501 exit(0);
502 } else {
503 print "No such plugin.\n";
504 exit(1);
505 }
506 } elsif ( $ARGV[0] eq '--remove-plugin' ) {
507 print "Removing plugin " . $ARGV[1] . "\n";
508 foreach $plugin (@plugins) {
509 if ( $plugin ne $ARGV[1] ) {
510 push @newplugins, $plugin;
511 }
512 }
513 @plugins = @newplugins;
514 save_data();
515 exit(0);
516 } elsif ( $ARGV[0] eq '--update-plugins' or $ARGV[0] eq '-u') {
517 build_plugin_hook_array();
518 exit(0);
519 } elsif ( $ARGV[0] eq '--help' or $ARGV[0] eq '-h') {
520 print "SquirrelMail Configuration Script\n";
521 print "Usage:\n";
522 print " * No arguments: initiates the configuration dialog\n";
523 print " * --install-plugin <plugin> : activates the specified plugin\n";
524 print " * --remove-plugin <plugin> : deactivates the specified plugin\n";
525 print " * --update-plugins , -u : rebuilds plugin_hooks.php according\n";
526 print " to plugins activated in config.php\n";
527 print " * --help , -h : Displays this help\n";
528 print "\n";
529 exit(0);
530 }
531
532
533
534 ####################################################################################
535
536 # used in multiple places, define once
537 $list_supported_imap_servers =
538 " bincimap = Binc IMAP server\n" .
539 " courier = Courier IMAP server\n" .
540 " cyrus = Cyrus IMAP server\n" .
541 " dovecot = Dovecot Secure IMAP server\n" .
542 " exchange = Microsoft Exchange IMAP server\n" .
543 " hmailserver = hMailServer\n" .
544 " macosx = Mac OS X Mailserver\n" .
545 " mercury32 = Mercury/32\n" .
546 " uw = University of Washington's IMAP server\n";
547
548 #####################################################################################
549 if ( $config_use_color == 1 ) {
550 $WHT = "\x1B[1m";
551 $NRM = "\x1B[0m";
552 } else {
553 $WHT = "";
554 $NRM = "";
555 $config_use_color = 2;
556 }
557
558 # lists can be printed in more than one column; default is just one
559 #
560 $columns = 1;
561
562 # try to get screen width dynamically if possible; default to 80
563 # (user can override with "w#" command)
564 #
565 eval { require "sys/ioctl.ph" };
566 if ($@
567 || !defined &TIOCGWINSZ
568 || !open(TTY, "+</dev/tty")
569 || !ioctl(TTY, &TIOCGWINSZ, $winsize='')) {
570 $screen_width = 80;
571 } else {
572 ($row, $col, $xpixel, $ypixel) = unpack('S4', $winsize);
573 $screen_width = $col;
574 }
575
576 while ( ( $command ne "q" ) && ( $command ne "Q" ) && ( $command ne ":q" ) ) {
577 clear_screen();
578 print $WHT. "SquirrelMail Configuration : " . $NRM;
579 if ( $config == 1 ) { print "Read: config.php"; }
580 elsif ( $config == 2 ) { print "Read: config_default.php"; }
581 print " ($print_config_version)\n";
582 print "---------------------------------------------------------\n";
583
584 if ( $menu == 0 ) {
585 print $WHT. "Main Menu --\n" . $NRM;
586 print "1. Organization Preferences\n";
587 print "2. Server Settings\n";
588 print "3. Folder Defaults\n";
589 print "4. General Options\n";
590 print "5. User Interface\n";
591 print "6. Address Books\n";
592 print "7. Message of the Day (MOTD)\n";
593 print "8. Plugins\n";
594 print "9. Database\n";
595 print "10. Language settings\n";
596 print "11. Tweaks\n";
597 print "\n";
598 print "D. Set pre-defined settings for specific IMAP servers\n";
599 print "\n";
600 } elsif ( $menu == 1 ) {
601 print $WHT. "Organization Preferences\n" . $NRM;
602 print "1. Organization Name : $WHT$org_name$NRM\n";
603 print "2. Organization Logo : $WHT$org_logo$NRM\n";
604 print "3. Org. Logo Width/Height : $WHT($org_logo_width/$org_logo_height)$NRM\n";
605 print "4. Organization Title : $WHT$org_title$NRM\n";
606 print "5. Signout Page : $WHT$signout_page$NRM\n";
607 print "6. Top Frame : $WHT$frame_top$NRM\n";
608 print "7. Provider link : $WHT$provider_uri$NRM\n";
609 print "8. Provider link text : $WHT$provider_name$NRM\n";
610
611 print "\n";
612 print "R Return to Main Menu\n";
613 } elsif ( $menu == 2 ) {
614 print $WHT. "Server Settings\n\n" . $NRM;
615 print $WHT . "General" . $NRM . "\n";
616 print "-------\n";
617 print "1. Domain : $WHT$domain$NRM\n";
618 print "2. Invert Time : $WHT$invert_time$NRM\n";
619 print "3. Sendmail or SMTP : $WHT";
620 if ( lc($useSendmail) eq 'true' ) {
621 print "Sendmail";
622 } else {
623 print "SMTP";
624 }
625 print "$NRM\n";
626 print "\n";
627
628 if ( $show_imap_settings ) {
629 print $WHT . "IMAP Settings". $NRM . "\n--------------\n";
630 print "4. IMAP Server : $WHT$imapServerAddress$NRM\n";
631 print "5. IMAP Port : $WHT$imapPort$NRM\n";
632 print "6. Authentication type : $WHT$imap_auth_mech$NRM\n";
633 print "7. Secure IMAP (TLS) : $WHT" . display_use_tls($use_imap_tls) . "$NRM\n";
634 print "8. Server software : $WHT$imap_server_type$NRM\n";
635 print "9. Delimiter : $WHT$optional_delimiter$NRM\n";
636 print "\n";
637 } elsif ( $show_smtp_settings ) {
638 if ( lc($useSendmail) eq 'true' ) {
639 print $WHT . "Sendmail" . $NRM . "\n--------\n";
640 print "4. Sendmail Path : $WHT$sendmail_path$NRM\n";
641 print "5. Sendmail arguments : $WHT$sendmail_args$NRM\n";
642 print "6. Header encryption key : $WHT$encode_header_key$NRM\n";
643 print "\n";
644 } else {
645 print $WHT . "SMTP Settings" . $NRM . "\n-------------\n";
646 print "4. SMTP Server : $WHT$smtpServerAddress$NRM\n";
647 print "5. SMTP Port : $WHT$smtpPort$NRM\n";
648 print "6. POP before SMTP : $WHT$pop_before_smtp$NRM\n";
649 print "7. SMTP Authentication : $WHT$smtp_auth_mech" . display_smtp_sitewide_userpass() ."$NRM\n";
650 print "8. Secure SMTP (TLS) : $WHT" . display_use_tls($use_smtp_tls) . "$NRM\n";
651 print "9. Header encryption key : $WHT$encode_header_key$NRM\n";
652 print "\n";
653 }
654 }
655
656 if ($show_imap_settings == 0) {
657 print "A. Update IMAP Settings : ";
658 print "$WHT$imapServerAddress$NRM:";
659 print "$WHT$imapPort$NRM ";
660 print "($WHT$imap_server_type$NRM)\n";
661 }
662 if ($show_smtp_settings == 0) {
663 if ( lc($useSendmail) eq 'true' ) {
664 print "B. Change Sendmail Config : $WHT$sendmail_path$NRM\n";
665 } else {
666 print "B. Update SMTP Settings : ";
667 print "$WHT$smtpServerAddress$NRM:";
668 print "$WHT$smtpPort$NRM\n";
669 }
670 }
671 if ( $show_smtp_settings || $show_imap_settings )
672 {
673 print "H. Hide " .
674 ($show_imap_settings ? "IMAP Server" :
675 (lc($useSendmail) eq 'true') ? "Sendmail" : "SMTP") . " Settings\n";
676 }
677
678 print "\n";
679 print "R Return to Main Menu\n";
680 } elsif ( $menu == 3 ) {
681 print $WHT. "Folder Defaults\n" . $NRM;
682 print "1. Default Folder Prefix : $WHT$default_folder_prefix$NRM\n";
683 print "2. Show Folder Prefix Option : $WHT$show_prefix_option$NRM\n";
684 print "3. Trash Folder : $WHT$trash_folder$NRM\n";
685 print "4. Sent Folder : $WHT$sent_folder$NRM\n";
686 print "5. Drafts Folder : $WHT$draft_folder$NRM\n";
687 print "6. By default, move to trash : $WHT$default_move_to_trash$NRM\n";
688 print "7. By default, save sent messages : $WHT$default_move_to_sent$NRM\n";
689 print "8. By default, save as draft : $WHT$default_save_as_draft$NRM\n";
690 print "9. List Special Folders First : $WHT$list_special_folders_first$NRM\n";
691 print "10. Show Special Folders Color : $WHT$use_special_folder_color$NRM\n";
692 print "11. Auto Expunge : $WHT$auto_expunge$NRM\n";
693 print "12. Default Sub. of INBOX : $WHT$default_sub_of_inbox$NRM\n";
694 print "13. Show 'Contain Sub.' Option : $WHT$show_contain_subfolders_option$NRM\n";
695 print "14. Default Unseen Notify : $WHT$default_unseen_notify$NRM\n";
696 print "15. Default Unseen Type : $WHT$default_unseen_type$NRM\n";
697 print "16. Auto Create Special Folders : $WHT$auto_create_special$NRM\n";
698 print "17. Folder Delete Bypasses Trash : $WHT$delete_folder$NRM\n";
699 print "18. Enable /NoSelect folder fix : $WHT$noselect_fix_enable$NRM\n";
700 print "\n";
701 print "R Return to Main Menu\n";
702 } elsif ( $menu == 4 ) {
703 print $WHT. "General Options\n" . $NRM;
704 print "1. Data Directory : $WHT$data_dir$NRM\n";
705 print "2. Attachment Directory : $WHT$attachment_dir$NRM\n";
706 print "3. Directory Hash Level : $WHT$dir_hash_level$NRM\n";
707 print "4. Default Left Size : $WHT$default_left_size$NRM\n";
708 print "5. Usernames in Lowercase : $WHT$force_username_lowercase$NRM\n";
709 print "6. Allow use of priority : $WHT$default_use_priority$NRM\n";
710 print "7. Hide SM attributions : $WHT$hide_sm_attributions$NRM\n";
711 print "8. Allow use of receipts : $WHT$default_use_mdn$NRM\n";
712 print "9. Allow editing of identity : $WHT$edit_identity$NRM\n";
713 print " Allow editing of name : $WHT$edit_name$NRM\n";
714 print " Remove username from header : $WHT$hide_auth_header$NRM\n";
715 print "10. Disable server thread sort : $WHT$disable_thread_sort$NRM\n";
716 print "11. Disable server-side sorting : $WHT$disable_server_sort$NRM\n";
717 print "12. Allow server charset search : $WHT$allow_charset_search$NRM\n";
718 print "13. Allow advanced search : $WHT$allow_advanced_search$NRM\n";
719 print "14. PHP session name : $WHT$session_name$NRM\n";
720 print "15. Time zone configuration : $WHT$time_zone_type$NRM\n";
721 print "16. Location base : $WHT$config_location_base$NRM\n";
722 print "17. Only secure cookies if poss. : $WHT$only_secure_cookies$NRM\n";
723 print "\n";
724 print "R Return to Main Menu\n";
725 } elsif ( $menu == 5 ) {
726 print $WHT. "User Interface\n" . $NRM;
727 print "1. Use Icons? : $WHT$use_icons$NRM\n";
728 # print "3. Default Icon Set : $WHT$icon_theme_def$NRM\n";
729 print "2. Default font size : $WHT$default_fontsize$NRM\n";
730 print "3. Manage template sets (skins)\n";
731 print "4. Manage user themes\n";
732 print "5. Manage font sets\n";
733 print "6. Manage icon themes\n";
734
735 print "\n";
736 print "R Return to Main Menu\n";
737 } elsif ( $menu == 6 ) {
738 print $WHT. "Address Books\n" . $NRM;
739 print "1. Change LDAP Servers\n";
740 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
741 print " > $ldap_host[$count]\n";
742 }
743 print "2. Use Javascript address book search : $WHT$default_use_javascript_addr_book$NRM\n";
744 print "3. Global address book file : $WHT$abook_global_file$NRM\n";
745 print "4. Allow writing into global file address book : $WHT$abook_global_file_writeable$NRM\n";
746 print "5. Allow listing of global file address book : $WHT$abook_global_file_listing$NRM\n";
747 print "6. Allowed address book line length : $WHT$abook_file_line_length$NRM\n";
748 print "\n";
749 print "R Return to Main Menu\n";
750 } elsif ( $menu == 7 ) {
751 print $WHT. "Message of the Day (MOTD)\n" . $NRM;
752 print "\n$motd\n";
753 print "\n";
754 print "1 Edit the MOTD\n";
755 print "\n";
756 print "R Return to Main Menu\n";
757 } elsif ( $menu == 8 ) {
758 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
759 print $WHT. "Plugins (WARNING: All plugins are currently disabled\n for the user \"$disable_plugins_user\"!)\n" . $NRM;
760 } elsif (lc($disable_plugins) eq 'true') {
761 print $WHT. "Plugins (WARNING: All plugins are currently disabled!)\n" . $NRM;
762 } else {
763 print $WHT. "Plugins\n" . $NRM;
764 }
765 print " Installed Plugins\n";
766 if ($columns > 1) {
767 $num = print_multi_col_list(1, $columns, $screen_width, 1, @plugins);
768 } else {
769 $num = 0;
770 for ( $count = 0 ; $count <= $#plugins ; $count++ ) {
771 $num = $count + 1;
772 $english_name = get_plugin_english_name($plugins[$count]);
773 if ( $english_name eq "" ) {
774 print " $WHT$num.$NRM $plugins[$count]" . get_plugin_version($plugins[$count]) . "\n";
775 } else {
776 print " $WHT$num.$NRM $english_name ($plugins[$count])" . get_plugin_version($plugins[$count]) . "\n";
777 }
778 }
779 }
780 print "\n Available Plugins:\n";
781 opendir( DIR, "../plugins" );
782 @files = sort(readdir(DIR));
783 $pos = 0;
784 @unused_plugins = ();
785 for ( $i = 0 ; $i <= $#files ; $i++ ) {
786 if ( -d "../plugins/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne ".svn" ) {
787 $match = 0;
788 for ( $k = 0 ; $k <= $#plugins ; $k++ ) {
789 if ( $plugins[$k] eq $files[$i] ) {
790 $match = 1;
791 }
792 }
793 if ( $match == 0 ) {
794 $unused_plugins[$pos] = $files[$i];
795 $pos++;
796 }
797 }
798 }
799
800 if ($columns > 1) {
801 $num = print_multi_col_list($num + 1, $columns, $screen_width, 1, @unused_plugins);
802 } else {
803 for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
804 $num = $num + 1;
805 $english_name = get_plugin_english_name($unused_plugins[$i]);
806 if ( $english_name eq "" ) {
807 print " $WHT$num.$NRM $unused_plugins[$i]" . get_plugin_version($unused_plugins[$i]) . "\n";
808 } else {
809 print " $WHT$num.$NRM $english_name ($unused_plugins[$i])" . get_plugin_version($unused_plugins[$i]) . "\n";
810 }
811 }
812 }
813 closedir DIR;
814
815 print "\n";
816 if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
817 print "E Enable active plugins (all plugins currently\n disabled for the user \"$disable_plugins_user\")\n";
818 } elsif (lc($disable_plugins) eq 'true') {
819 print "E Enable active plugins (all plugins currently\n disabled)\n";
820 } else {
821 print "D Disable all plugins\n";
822 }
823 print "U Set the user for whom plugins can be disabled\n";
824 print "R Return to Main Menu\n";
825 print "C# List plugins in <#> number of columns\n";
826 print "W# Change screen width to <#> (currently $screen_width)\n";
827 } elsif ( $menu == 9 ) {
828 print $WHT. "Database\n" . $NRM;
829 print "1. DSN for Address Book : $WHT$addrbook_dsn$NRM\n";
830 print "2. Table for Address Book : $WHT$addrbook_table$NRM\n";
831 print "\n";
832 print "3. DSN for Preferences : $WHT$prefs_dsn$NRM\n";
833 print "4. Table for Preferences : $WHT$prefs_table$NRM\n";
834 print "5. Field for username : $WHT$prefs_user_field$NRM ($prefs_user_size)\n";
835 print "6. Field for prefs key : $WHT$prefs_key_field$NRM ($prefs_key_size)\n";
836 print "7. Field for prefs value : $WHT$prefs_val_field$NRM ($prefs_val_size)\n";
837 print "\n";
838 print "8. DSN for Global Address Book : $WHT$addrbook_global_dsn$NRM\n";
839 print "9. Table for Global Address Book : $WHT$addrbook_global_table$NRM\n";
840 print "10. Allow writing into Global Address Book : $WHT$addrbook_global_writeable$NRM\n";
841 print "11. Allow listing of Global Address Book : $WHT$addrbook_global_listing$NRM\n";
842 print "\n";
843 print "R Return to Main Menu\n";
844 } elsif ( $menu == 10 ) {
845 print $WHT. "Language settings\n" . $NRM;
846 print "1. Default Language : $WHT$squirrelmail_default_language$NRM\n";
847 print "2. Default Charset : $WHT$default_charset$NRM\n";
848 print "3. Show alternative language names : $WHT$show_alternative_names$NRM\n";
849 print "4. Enable aggressive decoding : $WHT$aggressive_decoding$NRM\n";
850 print "5. Enable lossy encoding : $WHT$lossy_encoding$NRM\n";
851 print "\n";
852 print "R Return to Main Menu\n";
853 } elsif ( $menu == 11 ) {
854 print $WHT. "Interface tweaks\n" . $NRM;
855 print "1. Display html mails in iframe : $WHT$use_iframe$NRM\n";
856 print "2. Ask user info on first login : $WHT$ask_user_info$NRM\n";
857 print "\n";
858 print $WHT. "PHP tweaks\n" . $NRM;
859 print "4. Use php recode functions : $WHT$use_php_recode$NRM\n";
860 print "5. Use php iconv functions : $WHT$use_php_iconv$NRM\n";
861 print "6. Buffer all output : $WHT$buffer_output$NRM\n";
862 print "\n";
863 print $WHT. "Configuration tweaks\n" . $NRM;
864 print "7. Allow remote configtest : $WHT$allow_remote_configtest$NRM\n";
865 print "8. Debug mode : $WHT$sm_debug_mode$NRM\n";
866 print "9. Secured configuration mode : $WHT$secured_config$NRM\n";
867 print "10. HTTPS port : $WHT$sq_https_port$NRM\n";
868 print "11. Ignore HTTP_X_FORWARDED headers: $WHT$sq_ignore_http_x_forwarded_headers$NRM\n";
869 print "\n";
870 print "R Return to Main Menu\n";
871 }
872 if ( $config_use_color == 1 ) {
873 print "C Turn color off\n";
874 } else {
875 print "C Turn color on\n";
876 }
877 print "S Save data\n";
878 print "Q Quit\n";
879
880 print "\n";
881 print "Command >> " . $WHT;
882 $command = <STDIN>;
883 $command =~ s/[\n\r]//g;
884 $command =~ tr/A-Z/a-z/;
885 print "$NRM\n";
886
887 # Read the commands they entered.
888 if ( $command eq "r" ) {
889 $menu = 0;
890 } elsif ( $command eq "s" ) {
891 save_data();
892 print "Press enter to continue...";
893 $tmp = <STDIN>;
894 $saved = 1;
895 } elsif ( ( $command eq "q" ) && ( $saved == 0 ) ) {
896 print "You have not saved your data.\n";
897 print "Save? [" . $WHT . "Y" . $NRM . "/n]: ";
898 $save = <STDIN>;
899 if ( ( $save =~ /^y/i ) || ( $save =~ /^\s*$/ ) ) {
900 save_data();
901 }
902 } elsif ( $command eq "c" ) {
903 if ( $config_use_color == 1 ) {
904 $config_use_color = 2;
905 $WHT = "";
906 $NRM = "";
907 } else {
908 $config_use_color = 1;
909 $WHT = "\x1B[1m";
910 $NRM = "\x1B[0m";
911 }
912 } elsif ( $command =~ /^w([0-9]+)/ ) {
913 $screen_width = $1;
914 } elsif ( $command eq "d" && $menu == 0 ) {
915 set_defaults();
916 } else {
917 $saved = 0;
918 if ( $menu == 0 ) {
919 if ( ( $command > 0 ) && ( $command < 12 ) ) {
920 $menu = $command;
921 }
922 } elsif ( $menu == 1 ) {
923 if ( $command == 1 ) { $org_name = command1(); }
924 elsif ( $command == 2 ) { $org_logo = command2(); }
925 elsif ( $command == 3 ) { ($org_logo_width,$org_logo_height) = command2a(); }
926 elsif ( $command == 4 ) { $org_title = command3(); }
927 elsif ( $command == 5 ) { $signout_page = command4(); }
928 elsif ( $command == 6 ) { $frame_top = command6(); }
929 elsif ( $command == 7 ) { $provider_uri = command7(); }
930 elsif ( $command == 8 ) { $provider_name = command8(); }
931
932 } elsif ( $menu == 2 ) {
933 if ( $command eq "a" ) { $show_imap_settings = 1; $show_smtp_settings = 0; }
934 elsif ( $command eq "b" ) { $show_imap_settings = 0; $show_smtp_settings = 1; }
935 elsif ( $command eq "h" ) { $show_imap_settings = 0; $show_smtp_settings = 0; }
936 elsif ( $command <= 3 ) {
937 if ( $command == 1 ) { $domain = command11(); }
938 elsif ( $command == 2 ) { $invert_time = command110(); }
939 elsif ( $command == 3 ) { $useSendmail = command14(); }
940 $show_imap_settings = 0; $show_smtp_settings = 0;
941 } elsif ( $show_imap_settings ) {
942 if ( $command == 4 ) { $imapServerAddress = command12(); }
943 elsif ( $command == 5 ) { $imapPort = command13(); }
944 elsif ( $command == 6 ) { $imap_auth_mech = command112a(); }
945 elsif ( $command == 7 ) { $use_imap_tls = command_use_tls("IMAP",$use_imap_tls); }
946 elsif ( $command == 8 ) { $imap_server_type = command19(); }
947 elsif ( $command == 9 ) { $optional_delimiter = command111(); }
948 } elsif ( $show_smtp_settings && lc($useSendmail) eq 'true' ) {
949 if ( $command == 4 ) { $sendmail_path = command15(); }
950 elsif ( $command == 5 ) { $sendmail_args = command_sendmail_args(); }
951 elsif ( $command == 6 ) { $encode_header_key = command114(); }
952 } elsif ( $show_smtp_settings ) {
953 if ( $command == 4 ) { $smtpServerAddress = command16(); }
954 elsif ( $command == 5 ) { $smtpPort = command17(); }
955 elsif ( $command == 6 ) { $pop_before_smtp = command18a(); }
956 elsif ( $command == 7 ) { $smtp_auth_mech = command112b(); }
957 elsif ( $command == 8 ) { $use_smtp_tls = command_use_tls("SMTP",$use_smtp_tls); }
958 elsif ( $command == 9 ) { $encode_header_key = command114(); }
959 }
960 } elsif ( $menu == 3 ) {
961 if ( $command == 1 ) { $default_folder_prefix = command21(); }
962 elsif ( $command == 2 ) { $show_prefix_option = command22(); }
963 elsif ( $command == 3 ) { $trash_folder = command23a(); }
964 elsif ( $command == 4 ) { $sent_folder = command23b(); }
965 elsif ( $command == 5 ) { $draft_folder = command23c(); }
966 elsif ( $command == 6 ) { $default_move_to_trash = command24a(); }
967 elsif ( $command == 7 ) { $default_move_to_sent = command24b(); }
968 elsif ( $command == 8 ) { $default_save_as_draft = command24c(); }
969 elsif ( $command == 9 ) { $list_special_folders_first = command27(); }
970 elsif ( $command == 10 ) { $use_special_folder_color = command28(); }
971 elsif ( $command == 11 ) { $auto_expunge = command29(); }
972 elsif ( $command == 12 ) { $default_sub_of_inbox = command210(); }
973 elsif ( $command == 13 ) { $show_contain_subfolders_option = command211(); }
974 elsif ( $command == 14 ) { $default_unseen_notify = command212(); }
975 elsif ( $command == 15 ) { $default_unseen_type = command213(); }
976 elsif ( $command == 16 ) { $auto_create_special = command214(); }
977 elsif ( $command == 17 ) { $delete_folder = command215(); }
978 elsif ( $command == 18 ) { $noselect_fix_enable = command216(); }
979 } elsif ( $menu == 4 ) {
980 if ( $command == 1 ) { $data_dir = command33a(); }
981 elsif ( $command == 2 ) { $attachment_dir = command33b(); }
982 elsif ( $command == 3 ) { $dir_hash_level = command33c(); }
983 elsif ( $command == 4 ) { $default_left_size = command35(); }
984 elsif ( $command == 5 ) { $force_username_lowercase = command36(); }
985 elsif ( $command == 6 ) { $default_use_priority = command37(); }
986 elsif ( $command == 7 ) { $hide_sm_attributions = command38(); }
987 elsif ( $command == 8 ) { $default_use_mdn = command39(); }
988 elsif ( $command == 9 ) { $edit_identity = command310(); }
989 elsif ( $command == 10 ) { $disable_thread_sort = command312(); }
990 elsif ( $command == 11 ) { $disable_server_sort = command313(); }
991 elsif ( $command == 12 ) { $allow_charset_search = command314(); }
992 elsif ( $command == 13 ) { $allow_advanced_search = command316(); }
993 elsif ( $command == 14 ) { $session_name = command317(); }
994 elsif ( $command == 15 ) { $time_zone_type = command318(); }
995 elsif ( $command == 16 ) { $config_location_base = command_config_location_base(); }
996 elsif ( $command == 17 ) { $only_secure_cookies = command319(); }
997 } elsif ( $menu == 5 ) {
998 if ( $command == 1 ) { $use_icons = commandB3(); }
999 # elsif ( $command == 3 ) { $icon_theme_def = command53(); }
1000 elsif ( $command == 2 ) { $default_fontsize = command_default_fontsize(); }
1001 elsif ( $command == 3 ) { $templateset_default = command_templates(); }
1002 elsif ( $command == 4 ) { command_userThemes(); }
1003 elsif ( $command == 5 ) { command_fontsets(); }
1004 elsif ( $command == 6 ) { command_iconSets(); }
1005 } elsif ( $menu == 6 ) {
1006 if ( $command == 1 ) { command61(); }
1007 elsif ( $command == 2 ) { command62(); }
1008 elsif ( $command == 3 ) { $abook_global_file=command63(); }
1009 elsif ( $command == 4 ) { command64(); }
1010 elsif ( $command == 5 ) { command65(); }
1011 elsif ( $command == 6 ) { command_abook_file_line_length(); }
1012 } elsif ( $menu == 7 ) {
1013 if ( $command == 1 ) { $motd = command71(); }
1014 } elsif ( $menu == 8 ) {
1015 if ( $command =~ /^[0-9]+/ ) { @plugins = command81(); }
1016 elsif ( $command eq "u" ) { $disable_plugins_user = command82(); }
1017 elsif ( $command eq "d" ) { $disable_plugins = 'true'; }
1018 elsif ( $command eq "e" ) { $disable_plugins = 'false'; }
1019 elsif ( $command =~ /^c([0-9]+)/ ) { $columns = $1; }
1020 } elsif ( $menu == 9 ) {
1021 if ( $command == 1 ) { $addrbook_dsn = command91(); }
1022 elsif ( $command == 2 ) { $addrbook_table = command92(); }
1023 elsif ( $command == 3 ) { $prefs_dsn = command93(); }
1024 elsif ( $command == 4 ) { $prefs_table = command94(); }
1025 elsif ( $command == 5 ) { $prefs_user_field = command95(); }
1026 elsif ( $command == 6 ) { $prefs_key_field = command96(); }
1027 elsif ( $command == 7 ) { $prefs_val_field = command97(); }
1028 elsif ( $command == 8 ) { $addrbook_global_dsn = command98(); }
1029 elsif ( $command == 9 ) { $addrbook_global_table = command99(); }
1030 elsif ( $command == 10 ) { $addrbook_global_writeable = command910(); }
1031 elsif ( $command == 11 ) { $addrbook_global_listing = command911(); }
1032 } elsif ( $menu == 10 ) {
1033 if ( $command == 1 ) { $squirrelmail_default_language = commandA1(); }
1034 elsif ( $command == 2 ) { $default_charset = commandA2(); }
1035 elsif ( $command == 3 ) { $show_alternative_names = commandA3(); }
1036 elsif ( $command == 4 ) { $aggressive_decoding = commandA4(); }
1037 elsif ( $command == 5 ) { $lossy_encoding = commandA5(); }
1038 } elsif ( $menu == 11 ) {
1039 if ( $command == 1 ) { $use_iframe = commandB2(); }
1040 elsif ( $command == 2 ) { $ask_user_info = command_ask_user_info(); }
1041 elsif ( $command == 4 ) { $use_php_recode = commandB4(); }
1042 elsif ( $command == 5 ) { $use_php_iconv = commandB5(); }
1043 elsif ( $command == 6 ) { $buffer_output = commandB6(); }
1044 elsif ( $command == 7 ) { $allow_remote_configtest = commandB7(); }
1045 elsif ( $command == 8 ) { $sm_debug_mode = commandB8(); }
1046 elsif ( $command == 9 ) { $secured_config = commandB9(); }
1047 elsif ( $command == 10 ) { $sq_https_port = commandB10(); }
1048 elsif ( $command == 11 ) { $sq_ignore_http_x_forwarded_headers = commandB11(); }
1049 }
1050 }
1051 }
1052
1053 # we exit here
1054 print "\nExiting conf.pl.\n".
1055 "You might want to test your configuration by browsing to\n".
1056 "http://your-squirrelmail-location/src/configtest.php\n".
1057 "Happy SquirrelMailing!\n\n";
1058
1059
1060 ####################################################################################
1061
1062 # org_name
1063 sub command1 {
1064 print "We have tried to make the name SquirrelMail as transparent as\n";
1065 print "possible. If you set up an organization name, most places where\n";
1066 print "SquirrelMail would take credit will be credited to your organization.\n";
1067 print "\n";
1068 print "If your Organization Name includes a '\$', please precede it with a \\. \n";
1069 print "Other '\$' will be considered the beginning of a variable that\n";
1070 print "must be defined before the \$org_name is printed.\n";
1071 print "\n";
1072 print "[$WHT$org_name$NRM]: $WHT";
1073 $new_org_name = <STDIN>;
1074 if ( $new_org_name eq "\n" ) {
1075 $new_org_name = $org_name;
1076 } else {
1077 $new_org_name =~ s/[\r\n]//g;
1078 $new_org_name =~ s/\"/&quot;/g;
1079 }
1080 return $new_org_name;
1081 }
1082
1083 # org_logo
1084 sub command2 {
1085 print "Your organization's logo is an image that will be displayed at\n";
1086 print "different times throughout SquirrelMail. ";
1087 print "\n";
1088 print "Please be aware of the following: \n";
1089 print " - Relative URLs are relative to the config dir\n";
1090 print " to use the default logo, use ../images/sm_logo.png\n";
1091 print " - To specify a logo defined outside the SquirrelMail source tree\n";
1092 print " use the absolute URL the webserver would use to include the file\n";
1093 print " e.g. http://example.com/images/mylogo.gif or /images/mylogo.jpg\n";
1094 print "\n";
1095 print "[$WHT$org_logo$NRM]: $WHT";
1096 $new_org_logo = <STDIN>;
1097 if ( $new_org_logo eq "\n" ) {
1098 $new_org_logo = $org_logo;
1099 } else {
1100 $new_org_logo =~ s/[\r\n]//g;
1101 }
1102 return $new_org_logo;
1103 }
1104
1105 # org_logo_width
1106 sub command2a {
1107 print "Your organization's logo is an image that will be displayed at\n";
1108 print "different times throughout SquirrelMail. Width\n";
1109 print "and Height of your logo image. Use '0' to disable.\n";
1110 print "\n";
1111 print "Width: [$WHT$org_logo_width$NRM]: $WHT";
1112 $new_org_logo_width = <STDIN>;
1113 $new_org_logo_width =~ tr/0-9//cd; # only want digits!
1114 if ( $new_org_logo_width eq '' ) {
1115 $new_org_logo_width = $org_logo_width;
1116 }
1117 if ( $new_org_logo_width > 0 ) {
1118 print "Height: [$WHT$org_logo_height$NRM]: $WHT";
1119 $new_org_logo_height = <STDIN>;
1120 $new_org_logo_height =~ tr/0-9//cd; # only want digits!
1121 if( $new_org_logo_height eq '' ) {
1122 $new_org_logo_height = $org_logo_height;
1123 }
1124 } else {
1125 $new_org_logo_height = 0;
1126 }
1127 return ($new_org_logo_width, $new_org_logo_height);
1128 }
1129
1130 # org_title
1131 sub command3 {
1132 print "A title is what is displayed at the top of the browser window in\n";
1133 print "the titlebar. Usually this will end up looking something like:\n";
1134 print "\"Netscape: $org_title\"\n";
1135 print "\n";
1136 print "If your Organization Title includes a '\$', please precede it with a \\. \n";
1137 print "Other '\$' will be considered the beginning of a variable that\n";
1138 print "must be defined before the \$org_title is printed.\n";
1139 print "\n";
1140 print "[$WHT$org_title$NRM]: $WHT";
1141 $new_org_title = <STDIN>;
1142 if ( $new_org_title eq "\n" ) {
1143 $new_org_title = $org_title;
1144 } else {
1145 $new_org_title =~ s/[\r\n]//g;
1146 $new_org_title =~ s/\"/\'/g;
1147 }
1148 return $new_org_title;
1149 }
1150
1151 # signout_page
1152 sub command4 {
1153 print "When users click the Sign Out button they will be logged out and\n";
1154 print "then sent to signout_page. If signout_page is left empty,\n";
1155 print "(hit space and then return) they will be taken, as normal,\n";
1156 print "to the default and rather sparse SquirrelMail signout page.\n";
1157 print "\n";
1158 print "[$WHT$signout_page$NRM]: $WHT";
1159 $new_signout_page = <STDIN>;
1160 if ( $new_signout_page eq "\n" ) {
1161 $new_signout_page = $signout_page;
1162 } else {
1163 $new_signout_page =~ s/[\r\n]//g;
1164 $new_signout_page =~ s/^\s+$//g;
1165 }
1166 return $new_signout_page;
1167 }
1168
1169 # Default top frame
1170 sub command6 {
1171 print "SquirrelMail defaults to using the whole of the browser window.\n";
1172 print "This allows you to keep it within a specified frame. The default\n";
1173 print "is '_top'\n";
1174 print "\n";
1175 print "[$WHT$frame_top$NRM]: $WHT";
1176 $new_frame_top = <STDIN>;
1177 if ( $new_frame_top eq "\n" ) {
1178 $new_frame_top = '_top';
1179 } else {
1180 $new_frame_top =~ s/[\r\n]//g;
1181 $new_frame_top =~ s/^\s+$//g;
1182 }
1183 return $new_frame_top;
1184 }
1185
1186 # Default link to provider
1187 sub command7 {
1188 print "Here you can set the link on the top-right of the message list.\n";
1189 print "If empty, it will not be displayed.\n";
1190 print "\n";
1191 print "[$WHT$provider_uri$NRM]: $WHT";
1192 $new_provider_uri = <STDIN>;
1193 if ( $new_provider_uri eq "\n" ) {
1194 $new_provider_uri = '';
1195 } else {
1196 $new_provider_uri =~ s/[\r\n]//g;
1197 $new_provider_uri =~ s/^\s+$//g;
1198 }
1199 return $new_provider_uri;
1200 }
1201
1202 sub command8 {
1203 print "Here you can set the name of the link on the top-right of the message list.\n";
1204 print "The default is empty (do not display anything).'\n";
1205 print "\n";
1206 print "[$WHT$provider_name$NRM]: $WHT";
1207 $new_provider_name = <STDIN>;
1208 if ( $new_provider_name eq "\n" ) {
1209 $new_provider_name = '';
1210 } else {
1211 $new_provider_name =~ s/[\r\n]//g;
1212 $new_provider_name =~ s/^\s+$//g;
1213 $new_provider_name =~ s/\'/\\'/g;
1214 }
1215 return $new_provider_name;
1216 }
1217
1218 ####################################################################################
1219
1220 # domain
1221 sub command11 {
1222 print "The domain name is the suffix at the end of all email addresses. If\n";
1223 print "for example, your email address is jdoe\@example.com, then your domain\n";
1224 print "would be example.com.\n";
1225 print "\n";
1226 print "[$WHT$domain$NRM]: $WHT";
1227 $new_domain = <STDIN>;
1228 if ( $new_domain eq "\n" ) {
1229 $new_domain = $domain;
1230 } else {
1231 $new_domain =~ s/\s//g;
1232 }
1233 return $new_domain;
1234 }
1235
1236 # imapServerAddress
1237 sub command12 {
1238 print "This is the hostname where your IMAP server can be contacted.\n";
1239 print "[$WHT$imapServerAddress$NRM]: $WHT";
1240 $new_imapServerAddress = <STDIN>;
1241 if ( $new_imapServerAddress eq "\n" ) {
1242 $new_imapServerAddress = $imapServerAddress;
1243 } else {
1244 $new_imapServerAddress =~ s/[\r\n]//g;
1245 }
1246 return $new_imapServerAddress;
1247 }
1248
1249 # imapPort
1250 sub command13 {
1251 print "This is the port that your IMAP server is on. Usually this is 143.\n";
1252 print "[$WHT$imapPort$NRM]: $WHT";
1253 $new_imapPort = <STDIN>;
1254 if ( $new_imapPort eq "\n" ) {
1255 $new_imapPort = $imapPort;
1256 } else {
1257 $new_imapPort =~ s/[\r\n]//g;
1258 }
1259 return $new_imapPort;
1260 }
1261
1262 # useSendmail
1263 sub command14 {
1264 print "You now need to choose the method that you will use for sending\n";
1265 print "messages in SquirrelMail. You can either connect to an SMTP server\n";
1266 print "or use sendmail directly.\n";
1267 if ( lc($useSendmail) eq 'true' ) {
1268 $default_value = "1";
1269 } else {
1270 $default_value = "2";
1271 }
1272 print "\n";
1273 print " 1. Sendmail\n";
1274 print " 2. SMTP\n";
1275 print "Your choice [1/2] [$WHT$default_value$NRM]: $WHT";
1276 $use_sendmail = <STDIN>;
1277 if ( ( $use_sendmail =~ /^1\n/i )
1278 || ( ( $use_sendmail =~ /^\n/ ) && ( $default_value eq "1" ) ) ) {
1279 $useSendmail = 'true';
1280 } else {
1281 $useSendmail = 'false';
1282 }
1283 return $useSendmail;
1284 }
1285
1286 # sendmail_path
1287 sub command15 {
1288 print "Specify where the sendmail executable is located. Usually /usr/sbin/sendmail\n";
1289 print "[$WHT$sendmail_path$NRM]: $WHT";
1290 $new_sendmail_path = <STDIN>;
1291 if ( $new_sendmail_path eq "\n" ) {
1292 $new_sendmail_path = $sendmail_path;
1293 } else {
1294 $new_sendmail_path =~ s/[\r\n]//g;
1295 }
1296 return $new_sendmail_path;
1297 }
1298
1299 # Extra sendmail arguments
1300 sub command_sendmail_args {
1301 print "Specify additional sendmail program arguments.\n";
1302 print "\n";
1303 print "Make sure that arguments are supported by your sendmail program. -f argument \n";
1304 print "is added automatically by SquirrelMail scripts. Variable defaults to standard\n";
1305 print "/usr/sbin/sendmail arguments. If you use qmail-inject, nbsmtp or any other \n";
1306 print "sendmail wrapper, which does not support -i and -t arguments, set variable to\n";
1307 print "empty string or use arguments suitable for your mailer.\n";
1308 print "\n";
1309 print "[$WHT$sendmail_args$NRM]: $WHT";
1310 $new_sendmail_args = <STDIN>;
1311 if ( $new_sendmail_args eq "\n" ) {
1312 $new_sendmail_args = $sendmail_args;
1313 } else {
1314 # strip linefeeds and crs.
1315 $new_sendmail_args =~ s/[\r\n]//g;
1316 }
1317 return trim($new_sendmail_args);
1318 }
1319
1320 # smtpServerAddress
1321 sub command16 {
1322 print "This is the hostname of your SMTP server.\n";
1323 print "[$WHT$smtpServerAddress$NRM]: $WHT";
1324 $new_smtpServerAddress = <STDIN>;
1325 if ( $new_smtpServerAddress eq "\n" ) {
1326 $new_smtpServerAddress = $smtpServerAddress;
1327 } else {
1328 $new_smtpServerAddress =~ s/[\r\n]//g;
1329 }
1330 return $new_smtpServerAddress;
1331 }
1332
1333 # smtpPort
1334 sub command17 {
1335 print "This is the port to connect to for SMTP. Usually 25.\n";
1336 print "[$WHT$smtpPort$NRM]: $WHT";
1337 $new_smtpPort = <STDIN>;
1338 if ( $new_smtpPort eq "\n" ) {
1339 $new_smtpPort = $smtpPort;
1340 } else {
1341 $new_smtpPort =~ s/[\r\n]//g;
1342 }
1343 return $new_smtpPort;
1344 }
1345
1346 # pop before SMTP
1347 sub command18a {
1348 print "Do you wish to use POP3 before SMTP? Your server must\n";
1349 print "support this in order for SquirrelMail to work with it.\n";
1350
1351 $YesNo = 'n';
1352 $YesNo = 'y' if ( lc($pop_before_smtp) eq 'true' );
1353
1354 print "Use POP before SMTP (y/n) [$WHT$YesNo$NRM]: $WHT";
1355
1356 $new_pop_before_smtp = <STDIN>;
1357 $new_pop_before_smtp =~ tr/yn//cd;
1358 if ( $new_pop_before_smtp eq "y" ) {
1359 $new_pop_before_smtp = "true";
1360 } elsif ( $new_pop_before_smtp eq "n" ) {
1361 $new_pop_before_smtp = "false";
1362 } else {
1363 $new_pop_before_smtp = $pop_before_smtp;
1364 }
1365
1366 # if using POP before SMTP, allow setting of custom POP server address
1367 if ($new_pop_before_smtp eq "true") {
1368 print "$NRM\nIf the address of the POP server is not the same as\n";
1369 print "your SMTP server, you may specify it here. Leave blank (to\n";
1370 print "clear this, enter only spaces) to use the same address as\n";
1371 print "your SMTP server.\n";
1372 print "POP before SMTP server address [$WHT$pop_before_smtp_host$NRM]: $WHT";
1373
1374 $new_pop_before_smtp_host = <STDIN>;
1375 if ( $new_pop_before_smtp_host eq "\n" ) {
1376 $new_pop_before_smtp_host = $pop_before_smtp_host;
1377 } elsif ($new_pop_before_smtp_host =~ /^\s+$/) {
1378 $new_pop_before_smtp_host = '';
1379 } else {
1380 $new_pop_before_smtp_host =~ s/[\r|\n]//g;
1381 }
1382 $pop_before_smtp_host = $new_pop_before_smtp_host;
1383 }
1384
1385 return $new_pop_before_smtp;
1386 }
1387
1388 # imap_server_type
1389 sub command19 {
1390 print "Each IMAP server has its own quirks. As much as we tried to stick\n";
1391 print "to standards, it doesn't help much if the IMAP server doesn't follow\n";
1392 print "the same principles. We have made some work-arounds for some of\n";
1393 print "these servers. If you would like to use them, please select your\n";
1394 print "IMAP server. If you do not wish to use these work-arounds, you can\n";
1395 print "set this to \"other\", and none will be used.\n";
1396 print $list_supported_imap_servers;
1397 print "\n";
1398 print " other = Not one of the above servers\n";
1399 print "\n";
1400 print "[$WHT$imap_server_type$NRM]: $WHT";
1401 $new_imap_server_type = <STDIN>;
1402
1403 if ( $new_imap_server_type eq "\n" ) {
1404 $new_imap_server_type = $imap_server_type;
1405 } else {
1406 $new_imap_server_type =~ s/[\r\n]//g;
1407 }
1408 return $new_imap_server_type;
1409 }
1410
1411 # invert_time
1412 sub command110 {
1413 print "Sometimes the date of messages sent is messed up (off by a few hours\n";
1414 print "on some machines). Typically this happens if the system doesn't support\n";
1415 print "tm_gmtoff. It will happen only if your time zone is \"negative\".\n";
1416 print "This most often occurs on Solaris 7 machines in the United States.\n";
1417 print "By default, this is off. It should be kept off unless problems surface\n";
1418 print "about the time that messages are sent.\n";
1419 print " no = Do NOT fix time -- almost always correct\n";
1420 print " yes = Fix the time for this system\n";
1421
1422 $YesNo = 'n';
1423 $YesNo = 'y' if ( lc($invert_time) eq 'true' );
1424
1425 print "Fix the time for this system (y/n) [$WHT$YesNo$NRM]: $WHT";
1426
1427 $new_invert_time = <STDIN>;
1428 $new_invert_time =~ tr/yn//cd;
1429 return 'true' if ( $new_invert_time eq "y" );
1430 return 'false' if ( $new_invert_time eq "n" );
1431 return $invert_time;
1432 }
1433
1434 sub command111 {
1435 print "This is the delimiter that your IMAP server uses to distinguish between\n";
1436 print "folders. For example, Cyrus uses '.' as the delimiter and a complete\n";
1437 print "folder would look like 'INBOX.Friends.Bob', while UW uses '/' and would\n";
1438 print "look like 'INBOX/Friends/Bob'. Normally this should be left at 'detect'\n";
1439 print "but if you are sure you know what delimiter your server uses, you can\n";
1440 print "specify it here.\n";
1441 print "\nTo have it autodetect the delimiter, set it to 'detect'.\n\n";
1442 print "[$WHT$optional_delimiter$NRM]: $WHT";
1443 $new_optional_delimiter = <STDIN>;
1444
1445 if ( $new_optional_delimiter eq "\n" ) {
1446 $new_optional_delimiter = $optional_delimiter;
1447 } else {
1448 $new_optional_delimiter =~ s/[\r\n]//g;
1449 }
1450 return $new_optional_delimiter;
1451 }
1452 # IMAP authentication type
1453 # Possible values: login, plain, cram-md5, digest-md5
1454 # Now offers to detect supported mechs, assuming server & port are set correctly
1455
1456 sub command112a {
1457 if ($use_imap_tls ne "0") {
1458 # 1. Script does not handle TLS.
1459 # 2. Server does not have to declare all supported authentication mechs when
1460 # STARTTLS is used. Supported mechs are declared only after STARTTLS.
1461 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1462 } else {
1463 print "If you have already set the hostname and port number, I can try to\n";
1464 print "detect the mechanisms your IMAP server supports.\n";
1465 print "I will try to detect CRAM-MD5 and DIGEST-MD5 support. I can't test\n";
1466 print "for \"login\" or \"plain\" without knowing a username and password.\n";
1467 print "Auto-detecting is optional - you can safely say \"n\" here.\n";
1468 print "\nTry to detect supported mechanisms? [y/N]: ";
1469 $inval=<STDIN>;
1470 chomp($inval);
1471 if ($inval =~ /^y\b/i) {
1472 # Yes, let's try to detect.
1473 print "Trying to detect IMAP capabilities...\n";
1474 my $host = $imapServerAddress . ':'. $imapPort;
1475 print "CRAM-MD5:\t";
1476 my $tmp = detect_auth_support('IMAP',$host,'CRAM-MD5');
1477 if (defined($tmp)) {
1478 if ($tmp eq 'YES') {
1479 print "$WHT SUPPORTED$NRM\n";
1480 } else {
1481 print "$WHT NOT SUPPORTED$NRM\n";
1482 }
1483 } else {
1484 print $WHT . " ERROR DETECTING$NRM\n";
1485 }
1486
1487 print "DIGEST-MD5:\t";
1488 $tmp = detect_auth_support('IMAP',$host,'DIGEST-MD5');
1489 if (defined($tmp)) {
1490 if ($tmp eq 'YES') {
1491 print "$WHT SUPPORTED$NRM\n";
1492 } else {
1493 print "$WHT NOT SUPPORTED$NRM\n";
1494 }
1495 } else {
1496 print $WHT . " ERROR DETECTING$NRM\n";
1497 }
1498
1499 }
1500 }
1501 print "\nWhat authentication mechanism do you want to use for IMAP connections?\n\n";
1502 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1503 print $WHT . "plain" . $NRM . " - SASL PLAIN. If you need this, you already know it.\n";
1504 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext methods.\n";
1505 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1506 print "\n*** YOUR IMAP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n";
1507 print "If you don't understand or are unsure, you probably want \"login\"\n\n";
1508 print "login, plain, cram-md5, or digest-md5 [$WHT$imap_auth_mech$NRM]: $WHT";
1509 $inval=<STDIN>;
1510 chomp($inval);
1511 if ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) || ($inval =~ /^login\b/i) || ($inval =~ /^plain\b/i)) {
1512 return lc($inval);
1513 } else {
1514 # user entered garbage or default value so nothing needs to be set
1515 return $imap_auth_mech;
1516 }
1517 }
1518
1519
1520 # SMTP authentication type
1521 # Possible choices: none, plain, cram-md5, digest-md5
1522 sub command112b {
1523 if ($use_smtp_tls ne "0") {
1524 print "Auto-detection of login methods is unavailable when using TLS or STARTTLS.\n";
1525 } elsif (eval ("use IO::Socket; 1")) {
1526 # try loading IO::Socket module
1527 print "If you have already set the hostname and port number, I can try to\n";
1528 print "automatically detect some of the mechanisms your SMTP server supports.\n";
1529 print "Auto-detection is *optional* - you can safely say \"n\" here.\n";
1530 print "\nTry to detect auth mechanisms? [y/N]: ";
1531 $inval=<STDIN>;
1532 chomp($inval);
1533 if ($inval =~ /^y\b/i) {
1534 # Yes, let's try to detect.
1535 print "Trying to detect supported methods (SMTP)...\n";
1536
1537 # Special case!
1538 # Check none by trying to relay to junk@microsoft.com
1539 $host = $smtpServerAddress . ':' . $smtpPort;
1540 my $sock = IO::Socket::INET->new($host);
1541 print "Testing none:\t\t$WHT";
1542 if (!defined($sock)) {
1543 print " ERROR TESTING\n";
1544 close $sock;
1545 } else {
1546 $got = <$sock>; # Discard greeting
1547 print $sock "HELO $domain\r\n";
1548 $got = <$sock>; # Discard
1549 print $sock "MAIL FROM:<tester\@squirrelmail.org>\r\n";
1550 $got = <$sock>; # Discard
1551 print $sock "RCPT TO:<junk\@microsoft.com\r\n";
1552 $got = <$sock>; # This is the important line
1553 if ($got =~ /^250\b/) { # SMTP will relay without auth
1554 print "SUPPORTED$NRM\n";
1555 } else {
1556 print "NOT SUPPORTED$NRM\n";
1557 }
1558 print $sock "RSET\r\n";
1559 print $sock "QUIT\r\n";
1560 close $sock;
1561 }
1562 # Try login (SquirrelMail default)
1563 print "Testing login:\t\t";
1564 $tmp=detect_auth_support('SMTP',$host,'LOGIN');
1565 if (defined($tmp)) {
1566 if ($tmp eq 'YES') {
1567 print $WHT . "SUPPORTED$NRM\n";
1568 } else {
1569 print $WHT . "NOT SUPPORTED$NRM\n";
1570 }
1571 } else {
1572 print $WHT . "ERROR DETECTING$NRM\n";
1573 }
1574
1575 # Try CRAM-MD5
1576 print "Testing CRAM-MD5:\t";
1577 $tmp=detect_auth_support('SMTP',$host,'CRAM-MD5');
1578 if (defined($tmp)) {
1579 if ($tmp eq 'YES') {
1580 print $WHT . "SUPPORTED$NRM\n";
1581 } else {
1582 print $WHT . "NOT SUPPORTED$NRM\n";
1583 }
1584 } else {
1585 print $WHT . "ERROR DETECTING$NRM\n";
1586 }
1587
1588
1589 print "Testing DIGEST-MD5:\t";
1590 $tmp=detect_auth_support('SMTP',$host,'DIGEST-MD5');
1591 if (defined($tmp)) {
1592 if ($tmp eq 'YES') {
1593 print $WHT . "SUPPORTED$NRM\n";
1594 } else {
1595 print $WHT . "NOT SUPPORTED$NRM\n";
1596 }
1597 } else {
1598 print $WHT . "ERROR DETECTING$NRM\n";
1599 }
1600 }
1601 }
1602 print "\nWhat authentication mechanism do you want to use for SMTP connections?\n";
1603 print $WHT . "none" . $NRM . " - Your SMTP server does not require authorization.\n";
1604 print $WHT . "login" . $NRM . " - Plaintext. If you can do better, you probably should.\n";
1605 print $WHT . "plain" . $NRM . " - SASL PLAIN. You already know it if you need this.\n";
1606 print $WHT . "cram-md5" . $NRM . " - Slightly better than plaintext.\n";
1607 print $WHT . "digest-md5" . $NRM . " - Privacy protection - better than cram-md5.\n";
1608 print $WHT . "\n*** YOUR SMTP SERVER MUST SUPPORT THE MECHANISM YOU CHOOSE HERE ***\n" . $NRM;
1609 print "If you don't understand or are unsure, you probably want \"none\"\n\n";
1610 print "none, login, cram-md5, or digest-md5 [$WHT$smtp_auth_mech$NRM]: $WHT";
1611 $inval=<STDIN>;
1612 chomp($inval);
1613 if ($inval =~ /^none\b/i) {
1614 # remove sitewide smtp authentication information
1615 $smtp_sitewide_user = '';
1616 $smtp_sitewide_pass = '';
1617 # SMTP doesn't necessarily require logins
1618 return "none";
1619 } elsif ( ($inval =~ /^cram-md5\b/i) || ($inval =~ /^digest-md5\b/i) ||
1620 ($inval =~ /^login\b/i) || ($inval =~/^plain\b/i)) {
1621 command_smtp_sitewide_userpass($inval);
1622 return lc($inval);
1623 } elsif (trim($inval) eq '') {
1624 # user selected default value
1625 command_smtp_sitewide_userpass($smtp_auth_mech);
1626 return $smtp_auth_mech;
1627 } else {
1628 # user entered garbage
1629 return $smtp_auth_mech;
1630 }
1631 }
1632
1633 sub command_smtp_sitewide_userpass($) {
1634 # get first function argument
1635 my $auth_mech = shift(@_);
1636 my $default, $tmp;
1637 $auth_mech = lc(trim($auth_mech));
1638 if ($auth_mech eq 'none') {
1639 return;
1640 }
1641 print "SMTP authentication uses IMAP username and password by default.\n";
1642 print "\n";
1643 print "Would you like to use other login and password for all SquirrelMail \n";
1644 print "SMTP connections?";
1645 if ($smtp_sitewide_user ne '') {
1646 $default = 'y';
1647 print " [Y/n]:";
1648 } else {
1649 $default = 'n';
1650 print " [y/N]:";
1651 }
1652 $tmp=<STDIN>;
1653 $tmp = trim($tmp);
1654
1655 if ($tmp eq '') {
1656 $tmp = $default;
1657 } else {
1658 $tmp = lc($tmp);
1659 }
1660
1661 if ($tmp eq 'n') {
1662 $smtp_sitewide_user = '';
1663 $smtp_sitewide_pass = '';
1664 } elsif ($tmp eq 'y') {
1665 print "Enter username [$smtp_sitewide_user]:";
1666 my $new_user = <STDIN>;
1667 $new_user = trim($new_user);
1668 if ($new_user ne '') {
1669 $smtp_sitewide_user = $new_user;
1670 }
1671 if ($smtp_sitewide_user ne '') {
1672 print "If you don't enter any password, current sitewide password will be used.\n";
1673 print "If you enter space, password will be set to empty string.\n";
1674 print "Enter password:";
1675 my $new_pass = <STDIN>;
1676 if ($new_pass ne "\n") {
1677 $smtp_sitewide_pass = trim($new_pass);
1678 }
1679 } else {
1680 print "Invalid input. You must set username used for SMTP authentication.\n";
1681 print "Click enter to continue\n";
1682 $tmp = <STDIN>;
1683 }
1684 } else {
1685 print "Invalid input\n";
1686 print "Click enter to continue\n";
1687 $tmp = <STDIN>;
1688 }
1689 }
1690
1691 # Sub adds information about SMTP authentication type to menu
1692 sub display_smtp_sitewide_userpass() {
1693 my $ret = '';
1694 if ($smtp_auth_mech ne 'none') {
1695 if ($smtp_sitewide_user ne '') {
1696 $ret = ' (with custom username and password)';
1697 } else {
1698 $ret = ' (with IMAP username and password)';
1699 }
1700 }
1701 return $ret;
1702 }
1703
1704 # TLS
1705 # This sub is reused for IMAP and SMTP
1706 # Args: service name, default value
1707 sub command_use_tls {
1708 my($default_val,$service,$inval);
1709 $service=$_[0];
1710 $default_val=$_[1];
1711 print "TLS (Transport Layer Security) encrypts the traffic between server and client.\n";
1712 print "STARTTLS extensions allow to start encryption on existing plain text connection.\n";
1713 print "These options add specific PHP and IMAP server configuration requirements.\n";
1714 print "See SquirrelMail documentation about connection security.\n";
1715 print "\n";
1716 print "If your " . $service . " server is localhost, you can safely disable this.\n";
1717 print "If it is remote, you may wish to seriously consider enabling this.\n";
1718 $valid_input=0;
1719 while ($valid_input eq 0) {
1720 print "\nSelect connection security model:\n";
1721 print " 0 - Use plain text connection\n";
1722 print " 1 - Use TLS connection\n";
1723 print " 2 - Use STARTTLS extension\n";
1724 print "Select [$default_val]: ";
1725 $inval=<STDIN>;
1726 $inval=trim($inval);
1727 if ($inval =~ /^[012]$/ || $inval eq '') {
1728 $valid_input = 1;
1729 }
1730 }
1731 if ($inval ne '') {$default_val = $inval};
1732 return $default_val;
1733 }
1734
1735 # This sub is used to display human readable text for
1736 # $use_imap_tls and $use_smtp_tls values in conf.pl menu
1737 sub display_use_tls($) {
1738 my $val = shift(@_);
1739 my $ret = 'disabled';
1740 if ($val eq '2') {
1741 $ret = 'STARTTLS';
1742 } elsif ($val eq '1') {
1743 $ret = 'TLS';
1744 }
1745 return $ret;
1746 }
1747
1748 # $encode_header_key
1749 sub command114 {
1750 print "This encryption key allows the hiding of SquirrelMail Received:\n";
1751 print "headers in outbound messages. SquirrelMail uses the encryption\n";
1752 print "key to encode the username, remote address, and proxied address\n";
1753 print "and then stores that encoded information in X-Squirrel-* headers.\n";
1754 print "\n";
1755 print "Warning: the encryption function used to accomplish this is not\n";
1756 print "bulletproof. When used with a static encryption key as it is here,\n";
1757 print "it provides only minimal security and the encoded user information\n";
1758 print "in the X-Squirrel-* headers can be decoded quickly by a skilled\n";
1759 print "attacker.\n";
1760 print "\n";
1761 print "When you need to inspect an email sent from your system with the\n";
1762 print "X-Squirrel-* headers, you can decode the user information therein\n";
1763 print "by using the decrypt_headers.php script found in the SquirrelMail\n";
1764 print "contrib/ directory. You'll need the encryption key that you\n";
1765 print "defined here when doing so.\n";
1766 print "\n";
1767 print "Enter encryption key: ";
1768 $new_encode_header_key = <STDIN>;
1769 if ( $new_encode_header_key eq "\n" ) {
1770 $new_encode_header_key = $encode_header_key;
1771 } else {
1772 $new_encode_header_key =~ s/[\r\n]//g;
1773 }
1774 return $new_encode_header_key;
1775 }
1776
1777 # MOTD
1778 sub command71 {
1779 print "\nYou can now create the welcome message that is displayed\n";
1780 print "every time a user logs on. You can use HTML or just plain\n";
1781 print
1782 "text. If you do not wish to have one, just make it blank.\n\n(Type @ on a blank line to exit)\n";
1783
1784 $new_motd = "";
1785 do {
1786 print "] ";
1787 $line = <STDIN>;
1788 $line =~ s/[\r\n]//g;
1789 if ( $line ne "@" ) {
1790 $line =~ s/ /\&nbsp;\&nbsp;/g;
1791 $line =~ s/\t/\&nbsp;\&nbsp;\&nbsp;\&nbsp;/g;
1792 $line =~ s/$/ /;
1793 $line =~ s/\"/\\\"/g;
1794
1795 $new_motd = $new_motd . $line;
1796 }
1797 } while ( $line ne "@" );
1798 return $new_motd;
1799 }
1800
1801 ################# PLUGINS ###################
1802
1803 sub command81 {
1804 $command =~ s/[\s\n\r]*//g;
1805 if ( $command > 0 ) {
1806 $command = $command - 1;
1807 if ( $command <= $#plugins ) {
1808 @newplugins = ();
1809 $ct = 0;
1810 while ( $ct <= $#plugins ) {
1811 if ( $ct != $command ) {
1812 @newplugins = ( @newplugins, $plugins[$ct] );
1813 }
1814 $ct++;
1815 }
1816 @plugins = @newplugins;
1817 } elsif ( $command <= $#plugins + $#unused_plugins + 1 ) {
1818 $num = $command - $#plugins - 1;
1819 @newplugins = @plugins;
1820 $ct = 0;
1821 while ( $ct <= $#unused_plugins ) {
1822 if ( $ct == $num ) {
1823 @newplugins = ( @newplugins, $unused_plugins[$ct] );
1824 }
1825 $ct++;
1826 }
1827 @plugins = @newplugins;
1828 }
1829 }
1830 return @plugins;
1831 }
1832
1833 # disable_plugins_user
1834 sub command82 {
1835 print "When all active plugins are disabled, they can be disabled only\n";
1836 print "for the one user named here. If left blank, plugins will be\n";
1837 print "disabled for ALL users. This setting has no effect if plugins\n";
1838 print "are not disabled.\n";
1839 print "\n";
1840 print "This must be the exact IMAP login name for the desired user.\n";
1841 print "\n";
1842 print "[$WHT$disable_plugins_user$NRM]: $WHT";
1843 $new_disable_plugins_user = <STDIN>;
1844 if ( $new_disable_plugins_user eq "\n" ) {
1845 $new_disable_plugins_user = $disable_plugins_user;
1846 } else {
1847 $new_disable_plugins_user =~ s/[\r\n]//g;
1848 }
1849 return $new_disable_plugins_user;
1850 }
1851
1852 ################# FOLDERS ###################
1853
1854 # default_folder_prefix
1855 sub command21 {
1856 print "Some IMAP servers (UW, for example) store mail and folders in\n";
1857 print "your user space in a separate subdirectory. This is where you\n";
1858 print "specify what that directory is.\n";
1859 print "\n";
1860 print "EXAMPLE: mail/";
1861 print "\n";
1862 print "NOTE: If you use Cyrus, or some server that would not use this\n";
1863 print " option, you must set this to 'none'.\n";
1864 print "\n";
1865 print "[$WHT$default_folder_prefix$NRM]: $WHT";
1866 $new_default_folder_prefix = <STDIN>;
1867
1868 if ( $new_default_folder_prefix eq "\n" ) {
1869 $new_default_folder_prefix = $default_folder_prefix;
1870 } else {
1871 $new_default_folder_prefix =~ s/[\r\n]//g;
1872 }
1873 if ( ( $new_default_folder_prefix =~ /^\s*$/ ) || ( $new_default_folder_prefix =~ m/^none$/i ) ) {
1874 $new_default_folder_prefix = "";
1875 } else {
1876 # add the trailing delimiter only if we know what the server is.
1877 if (($imap_server_type eq 'cyrus' and
1878 $optional_delimiter eq 'detect') or
1879 ($imap_server_type eq 'courier' and
1880 $optional_delimiter eq 'detect')) {
1881 $new_default_folder_prefix =~ s/\.*$/\./;
1882 } elsif ($imap_server_type eq 'uw' and
1883 $optional_delimiter eq 'detect') {
1884 $new_default_folder_prefix =~ s/\/*$/\//;
1885 }
1886 }
1887 return $new_default_folder_prefix;
1888 }
1889
1890 # Show Folder Prefix
1891 sub command22 {
1892 print "It is possible to set up the default folder prefix as a user\n";
1893 print "specific option, where each user can specify what their mail\n";
1894 print "folder is. If you set this to false, they will never see the\n";
1895 print "option, but if it is true, this option will appear in the\n";
1896 print "'options' section.\n";
1897 print "\n";
1898 print "NOTE: You set the default folder prefix in option '1' of this\n";
1899 print " section. That will be the default if the user doesn't\n";
1900 print " specify anything different.\n";
1901 print "\n";
1902
1903 if ( lc($show_prefix_option) eq 'true' ) {
1904 $default_value = "y";
1905 } else {
1906 $default_value = "n";
1907 }
1908 print "\n";
1909 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
1910 $new_show = <STDIN>;
1911 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
1912 $show_prefix_option = 'true';
1913 } else {
1914 $show_prefix_option = 'false';
1915 }
1916 return $show_prefix_option;
1917 }
1918
1919 # Trash Folder
1920 sub command23a {
1921 print "You can now specify where the default trash folder is located.\n";
1922 print "On servers where you do not want this, you can set it to anything\n";
1923 print "and set option 6 to false.\n";
1924 print "\n";
1925 print "This is relative to where the rest of your email is kept. You do\n";
1926 print "not need to worry about their mail directory. If this folder\n";
1927 print "would be ~/mail/trash on the filesystem, you only need to specify\n";
1928 print "that this is 'trash', and be sure to put 'mail/' in option 1.\n";
1929 print "\n";
1930
1931 print "[$WHT$trash_folder$NRM]: $WHT";
1932 $new_trash_folder = <STDIN>;
1933 if ( $new_trash_folder eq "\n" ) {
1934 $new_trash_folder = $trash_folder;
1935 } else {
1936 if (check_imap_folder($new_trash_folder)) {
1937 $new_trash_folder =~ s/[\r\n]//g;
1938 } else {
1939 $new_trash_folder = $trash_folder;
1940 }
1941 }
1942 return $new_trash_folder;
1943 }
1944
1945 # Sent Folder
1946 sub command23b {
1947 print "This is where messages that are sent will be stored. SquirrelMail\n";
1948 print "by default puts a copy of all outgoing messages in this folder.\n";
1949 print "\n";
1950 print "This is relative to where the rest of your email is kept. You do\n";
1951 print "not need to worry about their mail directory. If this folder\n";
1952 print "would be ~/mail/sent on the filesystem, you only need to specify\n";
1953 print "that this is 'sent', and be sure to put 'mail/' in option 1.\n";
1954 print "\n";
1955
1956 print "[$WHT$sent_folder$NRM]: $WHT";
1957 $new_sent_folder = <STDIN>;
1958 if ( $new_sent_folder eq "\n" ) {
1959 $new_sent_folder = $sent_folder;
1960 } else {
1961 if (check_imap_folder($new_sent_folder)) {
1962 $new_sent_folder =~ s/[\r\n]//g;
1963 } else {
1964 $new_sent_folder = $sent_folder;
1965 }
1966 }
1967 return $new_sent_folder;
1968 }
1969
1970 # Draft Folder
1971 sub command23c {
1972 print "You can now specify where the default draft folder is located.\n";
1973 print "On servers where you do not want this, you can set it to anything\n";
1974 print "and set option 9 to false.\n";
1975 print "\n";
1976 print "This is relative to where the rest of your email is kept. You do\n";
1977 print "not need to worry about their mail directory. If this folder\n";
1978 print "would be ~/mail/drafts on the filesystem, you only need to specify\n";
1979 print "that this is 'drafts', and be sure to put 'mail/' in option 1.\n";
1980 print "\n";
1981
1982 print "[$WHT$draft_folder$NRM]: $WHT";
1983 $new_draft_folder = <STDIN>;
1984 if ( $new_draft_folder eq "\n" ) {
1985 $new_draft_folder = $draft_folder;
1986 } else {
1987 if (check_imap_folder($new_draft_folder)) {
1988 $new_draft_folder =~ s/[\r\n]//g;
1989 } else {
1990 $new_draft_folder = $draft_folder;
1991 }
1992 }
1993 return $new_draft_folder;
1994 }
1995
1996 # default move to trash
1997 sub command24a {
1998 print "By default, should messages get moved to the trash folder? You\n";
1999 print "can specify the default trash folder in option 3. If this is set\n";
2000 print "to false, messages will get deleted immediately without moving\n";
2001 print "to the trash folder.\n";
2002 print "\n";
2003 print "Trash folder is currently: $trash_folder\n";
2004 print "\n";
2005
2006 if ( lc($default_move_to_trash) eq 'true' ) {
2007 $default_value = "y";
2008 } else {
2009 $default_value = "n";
2010 }
2011 print "By default, move to trash (y/n) [$WHT$default_value$NRM]: $WHT";
2012 $new_show = <STDIN>;
2013 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2014 $default_move_to_trash = 'true';
2015 } else {
2016 $default_move_to_trash = 'false';
2017 }
2018 return $default_move_to_trash;
2019 }
2020
2021 # default move to sent (save sent messages)
2022 sub command24b {
2023 print "By default, should copies of outgoing messages get saved in the\n";
2024 print "sent folder? You can specify the default sent folder in option 4.\n";
2025 print "If this is set to false, messages will get sent and no copy will\n";
2026 print "be made.\n";
2027 print "\n";
2028 print "Sent folder is currently: $sent_folder\n";
2029 print "\n";
2030
2031 if ( lc($default_move_to_sent) eq 'true' ) {
2032 $default_value = "y";
2033 } else {
2034 $default_value = "n";
2035 }
2036 print "By default, save sent messages (y/n) [$WHT$default_value$NRM]: $WHT";
2037 $new_show = <STDIN>;
2038 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2039 $default_move_to_sent = 'true';
2040 } else {
2041 $default_move_to_sent = 'false';
2042 }
2043 return $default_move_to_sent;
2044 }
2045
2046 # default save as draft
2047 sub command24c {
2048 print "By default, should the save to draft option be shown? You can\n";
2049 print "specify the default drafts folder in option 5. If this is set\n";
2050 print "to false, users will not be shown the save to draft option.\n";
2051 print "\n";
2052 print "Drafts folder is currently: $draft_folder\n";
2053 print "\n";
2054
2055 if ( lc($default_save_as_draft) eq 'true' ) {
2056 $default_value = "y";
2057 } else {
2058 $default_value = "n";
2059 }
2060 print "By default, save as draft (y/n) [$WHT$default_value$NRM]: $WHT";
2061 $new_show = <STDIN>;
2062 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2063 $default_save_as_draft = 'true';
2064 } else {
2065 $default_save_as_draft = 'false';
2066 }
2067 return $default_save_as_draft;
2068 }
2069
2070 # List special folders first
2071 sub command27 {
2072 print "SquirrelMail has what we call 'special folders' that are not\n";
2073 print "manipulated and viewed like normal folders. Some examples of\n";
2074 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
2075 print "Simply asks if you want these folders listed first in the folder\n";
2076 print "listing.\n";
2077 print "\n";
2078
2079 if ( lc($list_special_folders_first) eq 'true' ) {
2080 $default_value = "y";
2081 } else {
2082 $default_value = "n";
2083 }
2084 print "\n";
2085 print "List first (y/n) [$WHT$default_value$NRM]: $WHT";
2086 $new_show = <STDIN>;
2087 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2088 $list_special_folders_first = 'true';
2089 } else {
2090 $list_special_folders_first = 'false';
2091 }
2092 return $list_special_folders_first;
2093 }
2094
2095 # Show special folders color
2096 sub command28 {
2097 print "SquirrelMail has what we call 'special folders' that are not\n";
2098 print "manipulated and viewed like normal folders. Some examples of\n";
2099 print "these folders would be INBOX, Trash, Sent, etc. This option\n";
2100 print "wants to know if we should display special folders in a\n";
2101 print "color than the other folders.\n";
2102 print "\n";
2103
2104 if ( lc($use_special_folder_color) eq 'true' ) {
2105 $default_value = "y";
2106 } else {
2107 $default_value = "n";
2108 }
2109 print "\n";
2110 print "Show color (y/n) [$WHT$default_value$NRM]: $WHT";
2111 $new_show = <STDIN>;
2112 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2113 $use_special_folder_color = 'true';
2114 } else {
2115 $use_special_folder_color = 'false';
2116 }
2117 return $use_special_folder_color;
2118 }
2119
2120 # Auto expunge
2121 sub command29 {
2122 print "The way that IMAP handles deleting messages is as follows. You\n";
2123 print "mark the message as deleted, and then to 'really' delete it, you\n";
2124 print "expunge it. This option asks if you want to just have messages\n";
2125 print "marked as deleted, or if you want SquirrelMail to expunge the \n";
2126 print "messages too.\n";
2127 print "\n";
2128
2129 if ( lc($auto_expunge) eq 'true' ) {
2130 $default_value = "y";
2131 } else {
2132 $default_value = "n";
2133 }
2134 print "Auto expunge (y/n) [$WHT$default_value$NRM]: $WHT";
2135 $new_show = <STDIN>;
2136 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2137 $auto_expunge = 'true';
2138 } else {
2139 $auto_expunge = 'false';
2140 }
2141 return $auto_expunge;
2142 }
2143
2144 # Default sub of inbox
2145 sub command210 {
2146 print "Some IMAP servers (Cyrus) have all folders as subfolders of INBOX.\n";
2147 print "This can cause some confusion in folder creation for users when\n";
2148 print "they try to create folders and don't put it as a subfolder of INBOX\n";
2149 print "and get permission errors. This option asks if you want folders\n";
2150 print "to be subfolders of INBOX by default.\n";
2151 print "\n";
2152
2153 if ( lc($default_sub_of_inbox) eq 'true' ) {
2154 $default_value = "y";
2155 } else {
2156 $default_value = "n";
2157 }
2158 print "Default sub of INBOX (y/n) [$WHT$default_value$NRM]: $WHT";
2159 $new_show = <STDIN>;
2160 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2161 $default_sub_of_inbox = 'true';
2162 } else {
2163 $default_sub_of_inbox = 'false';
2164 }
2165 return $default_sub_of_inbox;
2166 }
2167
2168 # Show contain subfolder option
2169 sub command211 {
2170 print "Some IMAP servers (UW) make it so that there are two types of\n";
2171 print "folders. Those that contain messages, and those that contain\n";
2172 print "subfolders. If this is the case for your server, set this to\n";
2173 print "true, and it will ask the user whether the folder they are\n";
2174 print "creating contains subfolders or messages.\n";
2175 print "\n";
2176
2177 if ( lc($show_contain_subfolders_option) eq 'true' ) {
2178 $default_value = "y";
2179 } else {
2180 $default_value = "n";
2181 }
2182 print "Show option (y/n) [$WHT$default_value$NRM]: $WHT";
2183 $new_show = <STDIN>;
2184 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2185 $show_contain_subfolders_option = 'true';
2186 } else {
2187 $show_contain_subfolders_option = 'false';
2188 }
2189 return $show_contain_subfolders_option;
2190 }
2191
2192 # Default Unseen Notify
2193 sub command212 {
2194 print "This option specifies where the users will receive notification\n";
2195 print "about unseen messages by default. This is of course an option that\n";
2196 print "can be changed on a user level.\n";
2197 print " 1 = No notification\n";
2198 print " 2 = Only on the INBOX\n";
2199 print " 3 = On all folders\n";
2200 print "\n";
2201
2202 print "Which one should be default (1,2,3)? [$WHT$default_unseen_notify$NRM]: $WHT";
2203 $new_show = <STDIN>;
2204 if ( $new_show =~ /^[123]\n/i ) {
2205 $default_unseen_notify = $new_show;
2206 }
2207 $default_unseen_notify =~ s/[\r\n]//g;
2208 return $default_unseen_notify;
2209 }
2210
2211 # Default Unseen Type
2212 sub command213 {
2213 print "Here you can define the default way that unseen messages will be displayed\n";
2214 print "to the user in the folder listing on the left side.\n";
2215 print " 1 = Only unseen messages (4)\n";
2216 print " 2 = Unseen and Total messages (4/27)\n";
2217 print "\n";
2218
2219 print "Which one should be default (1,2)? [$WHT$default_unseen_type$NRM]: $WHT";
2220 $new_show = <STDIN>;
2221 if ( $new_show =~ /^[12]\n/i ) {
2222 $default_unseen_type = $new_show;
2223 }
2224 $default_unseen_type =~ s/[\r\n]//g;
2225 return $default_unseen_type;
2226 }
2227
2228 # Auto create special folders
2229 sub command214 {
2230 print "Would you like the Sent, Trash, and Drafts folders to be created\n";
2231 print "automatically print for you when a user logs in? If the user\n";
2232 print "accidentally deletes their special folders, this option will\n";
2233 print "automatically create it again for them.\n";
2234 print "\n";
2235
2236 if ( lc($auto_create_special) eq 'true' ) {
2237 $default_value = "y";
2238 } else {
2239 $default_value = "n";
2240 }
2241 print "Auto create special folders? (y/n) [$WHT$default_value$NRM]: $WHT";
2242 $new_show = <STDIN>;
2243 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2244 $auto_create_special = 'true';
2245 } else {
2246 $auto_create_special = 'false';
2247 }
2248 return $auto_create_special;
2249 }
2250
2251 # Automatically delete folders
2252 sub command215 {
2253 if ( $imap_server_type eq "uw" ) {
2254 print "UW IMAP servers will not allow folders containing mail to also contain folders.\n";
2255 print "Deleting folders will bypass the trash folder and be immediately deleted\n\n";
2256 print "If this is not the correct value for your server,\n";
2257 print "please use option D on the Main Menu to configure your server correctly.\n\n";
2258 print "Press enter to continue...\n";
2259 $new_delete = <STDIN>;
2260 $delete_folder = 'true';
2261 } else {
2262 if ( $imap_server_type eq "courier" ) {
2263 print "Courier (or Courier-IMAP) IMAP servers may not support ";
2264 print "subfolders of Trash. \n";
2265 print "Specifically, if Courier is set to always move messages to Trash, \n";
2266 print "Trash will be treated by Courier as a special folder that does not \n";
2267 print "allow subfolders. \n\n";
2268 print "Please verify your Courier configuration, and test folder deletion \n";
2269 print "when changing this setting.\n\n";
2270 }
2271
2272 print "Are subfolders of the Trash supported by your IMAP server?\n";
2273 print "If so, should deleted folders be sent to Trash?\n";
2274 print "If not, say no (deleted folders should not be sent to Trash)\n\n";
2275 # reversal of logic.
2276 # question was: Should folders be automatically deleted instead of sent to trash..
2277 # we've changed the question to make it more clear,
2278 # and are here handling that to avoid changing the answers..
2279 if ( lc($delete_folder) eq 'true' ) {
2280 $default_value = "n";
2281 } else {
2282 $default_value = "y";
2283 }
2284 print "Send deleted folders to Trash? (y/n) [$WHT$default_value$NRM]: $WHT";
2285 $new_delete = <STDIN>;
2286 if ( ( $new_delete =~ /^y\n/i ) || ( ( $new_delete =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2287 $delete_folder = 'false';
2288 } else {
2289 $delete_folder = 'true';
2290 }
2291 }
2292 return $delete_folder;
2293 }
2294
2295 #noselect fix
2296 sub command216 {
2297 print "Some IMAP servers allow subfolders to exist even if the parent\n";
2298 print "folders do not. This fixes some problems with the folder list\n";
2299 print "when this is the case, causing the /NoSelect folders to be displayed\n";
2300 print "\n";
2301
2302 if ( lc($noselect_fix_enable) eq 'true' ) {
2303 $default_value = "y";
2304 } else {
2305 $default_value = "n";
2306 }
2307 print "enable noselect fix? (y/n) [$WHT$noselect_fix_enable$NRM]: $WHT";
2308 $noselect_fix_enable = <STDIN>;
2309 if ( ( $noselect_fix_enable =~ /^y\n/i ) || ( ( $noselect_fix_enable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2310 $noselect_fix_enable = 'true';
2311 } else {
2312 $noselect_fix_enable = 'false';
2313 }
2314 return $noselect_fix_enable;
2315 }
2316 ############# GENERAL OPTIONS #####################
2317
2318 # Data directory
2319 sub command33a {
2320 print "Specify the location for your data directory.\n";
2321 print "You need to create this directory yourself.\n";
2322 print "The path name can be absolute or relative (to the config directory).\n";
2323 print "Here are two examples:\n";
2324 print " Absolute: /var/local/squirrelmail/data/\n";
2325 print " Relative: ../data/\n";
2326 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2327 print "will be converted to their absolute path equivalents in config.php.\n\n";
2328 print "Note: There are potential security risks with having a writeable directory\n";
2329 print "under the web server's root directory (ex: /home/httpd/html).\n";
2330 print "For this reason, it is recommended to put the data directory\n";
2331 print "in an alternate location of your choice. \n";
2332 print "\n";
2333
2334 print "[$WHT$data_dir$NRM]: $WHT";
2335 $new_data_dir = <STDIN>;
2336 if ( $new_data_dir eq "\n" ) {
2337 $new_data_dir = $data_dir;
2338 } else {
2339 $new_data_dir =~ s/[\r\n]//g;
2340 }
2341 if ( $new_data_dir =~ /^\s*$/ ) {
2342 $new_data_dir = "";
2343 } else {
2344 $new_data_dir =~ s/\/*$//g;
2345 $new_data_dir =~ s/$/\//g;
2346 }
2347 return $new_data_dir;
2348 }
2349
2350 # Attachment directory
2351 sub command33b {
2352 print "Path to directory used for storing attachments while a mail is\n";
2353 print "being composed. The path name can be absolute or relative (to the\n";
2354 print "config directory). Here are two examples:\n";
2355 print " Absolute: /var/local/squirrelmail/attach/\n";
2356 print " Relative: ../attach/\n";
2357 print "Relative paths to directories outside of the SquirrelMail distribution\n";
2358 print "will be converted to their absolute path equivalents in config.php.\n\n";
2359 print "Note: There are a few security considerations regarding this\n";
2360 print "directory:\n";
2361 print " 1. It should have the permission 733 (rwx-wx-wx) to make it\n";
2362 print " impossible for a random person with access to the webserver\n";
2363 print " to list files in this directory. Confidential data might\n";
2364 print " be laying around in there.\n";
2365 print " Depending on your user:group assignments, 730 (rwx-wx---)\n";
2366 print " may be possible, and more secure (e.g. root:apache)\n";
2367 print " 2. Since the webserver is not able to list the files in the\n";
2368 print " content is also impossible for the webserver to delete files\n";
2369 print " lying around there for too long.\n";
2370 print " 3. It should probably be another directory than the data\n";
2371 print " directory specified in option 3.\n";
2372 print "\n";
2373
2374 print "[$WHT$attachment_dir$NRM]: $WHT";
2375 $new_attachment_dir = <STDIN>;
2376 if ( $new_attachment_dir eq "\n" ) {
2377 $new_attachment_dir = $attachment_dir;
2378 } else {
2379 $new_attachment_dir =~ s/[\r\n]//g;
2380 }
2381 if ( $new_attachment_dir =~ /^\s*$/ ) {
2382 $new_attachment_dir = "";
2383 } else {
2384 $new_attachment_dir =~ s/\/*$//g;
2385 $new_attachment_dir =~ s/$/\//g;
2386 }
2387 return $new_attachment_dir;
2388 }
2389
2390 sub command33c {
2391 print "The directory hash level setting allows you to configure the level\n";
2392 print "of hashing that SquirrelMail employs in your data and attachment\n";
2393 print "directories. This value must be an integer ranging from 0 to 4.\n";
2394 print "When this value is set to 0, SquirrelMail will simply store all\n";
2395 print "files as normal in the data and attachment directories. However,\n";
2396 print "when set to a value from 1 to 4, a simple hashing scheme will be\n";
2397 print "used to organize the files in this directory. In short, the crc32\n";
2398 print "value for a username will be computed. Then, up to the first 4\n";
2399 print "digits of the hash, as set by this configuration value, will be\n";
2400 print "used to directory hash the files for that user in the data and\n";
2401 print "attachment directory. This allows for better performance on\n";
2402 print "servers with larger numbers of users.\n";
2403 print "\n";
2404
2405 print "[$WHT$dir_hash_level$NRM]: $WHT";
2406 $new_dir_hash_level = <STDIN>;
2407 if ( $new_dir_hash_level eq "\n" ) {
2408 $new_dir_hash_level = $dir_hash_level;
2409 } else {
2410 $new_dir_hash_level =~ s/[\r\n]//g;
2411 }
2412 if ( ( int($new_dir_hash_level) < 0 )
2413 || ( int($new_dir_hash_level) > 4 )
2414 || !( int($new_dir_hash_level) eq $new_dir_hash_level ) ) {
2415 print "Invalid Directory Hash Level.\n";
2416 print "Value must be an integer ranging from 0 to 4\n";
2417 print "Hit enter to continue.\n";
2418 $enter_key = <STDIN>;
2419
2420 $new_dir_hash_level = $dir_hash_level;
2421 }
2422
2423 return $new_dir_hash_level;
2424 }
2425
2426 sub command35 {
2427 print "This is the default size (in pixels) of the left folder list.\n";
2428 print "Default is 200, but you can set it to whatever you wish. This\n";
2429 print "is a user preference, so this will only show up as their default.\n";
2430 print "\n";
2431 print "[$WHT$default_left_size$NRM]: $WHT";
2432 $new_default_left_size = <STDIN>;
2433 if ( $new_default_left_size eq "\n" ) {
2434 $new_default_left_size = $default_left_size;
2435 } else {
2436 $new_default_left_size =~ s/[\r\n]//g;
2437 }
2438 return $new_default_left_size;
2439 }
2440
2441 sub command36 {
2442 print "Some IMAP servers only have lowercase letters in the usernames\n";
2443 print "but they still allow people with uppercase to log in. This\n";
2444 print "causes a problem with the user's preference files. This option\n";
2445 print "transparently changes all usernames to lowercase.";
2446 print "\n";
2447
2448 if ( lc($force_username_lowercase) eq 'true' ) {
2449 $default_value = "y";
2450 } else {
2451 $default_value = "n";
2452 }
2453 print "Convert usernames to lowercase (y/n) [$WHT$default_value$NRM]: $WHT";
2454 $new_show = <STDIN>;
2455 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2456 return 'true';
2457 }
2458 return 'false';
2459 }
2460
2461 sub command37 {
2462 print "";
2463 print "\n";
2464
2465 if ( lc($default_use_priority) eq 'true' ) {
2466 $default_value = "y";
2467 } else {
2468 $default_value = "n";
2469 }
2470
2471 print "Allow users to specify priority of outgoing mail (y/n) [$WHT$default_value$NRM]: $WHT";
2472 $new_show = <STDIN>;
2473 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2474 return 'true';
2475 }
2476 return 'false';
2477 }
2478
2479 sub command38 {
2480 print "";
2481 print "\n";
2482
2483 if ( lc($hide_sm_attributions) eq 'true' ) {
2484 $default_value = "y";
2485 } else {
2486 $default_value = "n";
2487 }
2488
2489 print "Hide SM attributions (y/n) [$WHT$default_value$NRM]: $WHT";
2490 $new_show = <STDIN>;
2491 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2492 return 'true';
2493 }
2494 return 'false';
2495 }
2496
2497 sub command39 {
2498 print "";
2499 print "\n";
2500
2501 if ( lc($default_use_mdn) eq 'true' ) {
2502 $default_value = "y";
2503 } else {
2504 $default_value = "n";
2505 }
2506
2507 print "Enable support for read/delivery receipt support (y/n) [$WHT$default_value$NRM]: $WHT";
2508 $new_show = <STDIN>;
2509 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2510 return 'true';
2511 }
2512 return 'false';
2513 }
2514
2515
2516 sub command310 {
2517 print " In loosely managed environments, you may want to allow users
2518 to edit their full name and email address. In strictly managed
2519 environments, you may want to force users to use the name
2520 and email address assigned to them.
2521
2522 'y' - allow a user to edit their full name and email address,
2523 'n' - users must use the assigned values.
2524
2525 ";
2526
2527 if ( lc($edit_identity) eq 'true' ) {
2528 $default_value = "y";
2529 } else {
2530 $default_value = "n";
2531 }
2532 print "Allow editing of user's identity? (y/n) [$WHT$default_value$NRM]: $WHT";
2533 $new_edit = <STDIN>;
2534 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2535 $edit_identity = 'true';
2536 $edit_name = 'true';
2537 $hide_auth_header = command311b();
2538 } else {
2539 $edit_identity = 'false';
2540 $edit_name = command311();
2541 $hide_auth_header = command311b();
2542 }
2543 return $edit_identity;
2544 }
2545
2546 sub command311 {
2547 print "$NRM";
2548 print "\n Given that users are not allowed to modify their
2549 email address, can they edit their full name?
2550
2551 ";
2552
2553 if ( lc($edit_name) eq 'true' ) {
2554 $default_value = "y";
2555 } else {
2556 $default_value = "n";
2557 }
2558 print "Allow the user to edit their full name? (y/n) [$WHT$default_value$NRM]: $WHT";
2559 $new_edit = <STDIN>;
2560 if ( ( $new_edit =~ /^y\n/i ) || ( ( $new_edit =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2561 $edit_name = 'true';
2562 } else {
2563 $edit_name = 'false';
2564 }
2565 return $edit_name;
2566 }
2567
2568 sub command311b {
2569 print "$NRM";
2570 print "\n SquirrelMail adds username information to every outgoing
2571 email in order to prevent possible sender forging when users are
2572 allowed to change their email and/or full name.
2573
2574 You can remove user information from this header (y) if you think that
2575 it violates privacy or security.
2576
2577 Note: If users are allowed to change their email addresses,
2578 this setting will make it difficult to determine who sent what where.
2579 Use at your own risk.
2580
2581 Note: If you have defined a header encryption key in your SMTP or
2582 Sendmail settings (see the \"Server Settings\" option page), this
2583 setting is ignored because all user information in outgoing messages
2584 is encoded.
2585
2586 ";
2587
2588 if ( lc($hide_auth_header) eq "true" ) {
2589 $default_value = "y";
2590 } else {
2591 $default_value = "n";
2592 }
2593 print "Remove username from email headers? (y/n) [$WHT$default_value$NRM]: $WHT";
2594 $new_header = <STDIN>;
2595 if ( ( $new_header =~ /^y\n/i ) || ( ( $new_header =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2596 $hide_auth_header = "true";
2597 } else {
2598 $hide_auth_header = "false";
2599 }
2600 return $hide_auth_header;
2601 }
2602
2603 sub command312 {
2604 print "This option allows you to disable server side thread sorting if your server \n";
2605 print "declares THREAD support, but you don't want to provide threading options \n";
2606 print "to end users or THREAD extension is broken or extension does not work with \n";
2607 print "options used by SquirrelMail. Option is not used, if THREAD extension is \n";
2608 print "not declared in IMAP CAPABILITY.\n";
2609 print "\n";
2610
2611 if ( lc($disable_thread_sort) eq 'true' ) {
2612 $default_value = "y";
2613 } else {
2614 $default_value = "n";
2615 }
2616 print "Disable server side thread sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2617 $disable_thread_sort = <STDIN>;
2618 if ( ( $disable_thread_sort =~ /^y\n/i ) || ( ( $disable_thread_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2619 $disable_thread_sort = 'true';
2620 } else {
2621 $disable_thread_sort = 'false';
2622 }
2623 return $disable_thread_sort;
2624 }
2625
2626 sub command313 {
2627 print "This option allows you to disable server side sorting if your server declares \n";
2628 print "SORT support, but SORT extension is broken or does not work with options \n";
2629 print "used by SquirrelMail. Option is not used, if SORT extension is not declared \n";
2630 print "in IMAP CAPABILITY.\n";
2631 print "\n";
2632 print "It is strongly recommended to keep server side sorting enabled, if your ";
2633 print "IMAP server supports it.";
2634 print "\n";
2635
2636 if ( lc($disable_server_sort) eq 'true' ) {
2637 $default_value = "y";
2638 } else {
2639 $default_value = "n";
2640 }
2641 print "Disable server-side sorting? (y/n) [$WHT$default_value$NRM]: $WHT";
2642 $disable_server_sort = <STDIN>;
2643 if ( ( $disable_server_sort =~ /^y\n/i ) || ( ( $disable_server_sort =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2644 $disable_server_sort = 'true';
2645 } else {
2646 $disable_server_sort = 'false';
2647 }
2648 return $disable_server_sort;
2649 }
2650
2651 sub command314 {
2652 print "This option allows you to choose if SM uses charset search\n";
2653 print "Your IMAP server must support the SEARCH CHARSET command for this to work\n";
2654 print "\n";
2655
2656 if ( lc($allow_charset_search) eq 'true' ) {
2657 $default_value = "y";
2658 } else {
2659 $default_value = "n";
2660 }
2661 print "Allow charset searching? (y/n) [$WHT$default_value$NRM]: $WHT";
2662 $allow_charset_search = <STDIN>;
2663 if ( ( $allow_charset_search =~ /^y\n/i ) || ( ( $allow_charset_search =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2664 $allow_charset_search = 'true';
2665 } else {
2666 $allow_charset_search = 'false';
2667 }
2668 return $allow_charset_search;
2669 }
2670
2671 # command315 (UID support) obsoleted.
2672
2673 # advanced search option
2674 sub command316 {
2675 print "This option allows you to control the use of advanced search form.\n";
2676 print " 0 = enable basic search only\n";
2677 print " 1 = enable advanced search only\n";
2678 print " 2 = enable both\n";
2679 print "\n";
2680
2681 print "Allowed search (0,1,2)? [$WHT$allow_advanced_search$NRM]: $WHT";
2682 $new_allow_advanced_search = <STDIN>;
2683 if ( $new_allow_advanced_search =~ /^[012]\n/i ) {
2684 $allow_advanced_search = $new_allow_advanced_search;
2685 }
2686 $allow_advanced_search =~ s/[\r\n]//g;
2687 return $allow_advanced_search;
2688 }
2689
2690
2691 sub command317 {
2692 print "This option allows you to change the name of the PHP session used\n";
2693 print "by SquirrelMail. Unless you know what you are doing, you probably\n";
2694 print "don't need or want to change this from the default of SQMSESSID.\n";
2695 print "[$WHT$session_name$NRM]: $WHT";
2696 $new_session_name = <STDIN>;
2697 chomp($new_session_name);
2698 if ( $new_session_name eq "" ) {
2699 $new_session_name = $session_name;
2700 }
2701 return $new_session_name;
2702 }
2703
2704 # time zone config (since 1.5.1)
2705 sub command318 {
2706 print "This option allows you to control the use of time zones.\n";
2707 print " 0 = (default) standard, GNU C time zone names\n";
2708 print " 1 = strict, generic time zone codes with offsets\n";
2709 print " 2 = custom, GNU C time zones loaded from config/timezones.php\n";
2710 print " 3 = custom strict, generic time zone codes with offsets loaded \n";
2711 print " from config/timezones.php\n";
2712 print "See SquirrelMail documentation about format of config/timezones.php file.\n";
2713 print "\n";
2714
2715 print "Desired time zone configuration (0,1,2,3)? [$WHT$time_zone_type$NRM]: $WHT";
2716 $new_time_zone_type = <STDIN>;
2717 if ( $new_time_zone_type =~ /^[0123]\n/i ) {
2718 $time_zone_type = $new_time_zone_type;
2719 } else {
2720 print "\nInvalid configuration value.\n";
2721 print "\nPress enter to continue...";
2722 $tmp = <STDIN>;
2723 }
2724 $time_zone_type =~ s/[\r\n]//g;
2725 return $time_zone_type;
2726 }
2727
2728 # set the location base for redirects (since 1.5.2)
2729 sub command_config_location_base {
2730 print "Here you can set the base part of the SquirrelMail URL.\n";
2731 print "It is normally autodetected but if that fails, use this\n";
2732 print "option to override.\n";
2733 print "It should contain only the protocol and hostname/port parts\n";
2734 print "of the URL; the full path will be appended automatically.\n\n";
2735 print "Examples:\nhttp://webmail.example.org\nhttp://webmail.example.com:8080\nhttps://webmail.example.com:6691\n\n";
2736 print "Do not add any path elements.\n";
2737
2738 print "URL base? [" .$WHT."autodetect$NRM]: $WHT";
2739 $new_config_location_base = <STDIN>;
2740 chomp($new_config_location_base);
2741 $config_location_base = $new_config_location_base;
2742
2743 return $config_location_base;
2744 }
2745
2746 # only_secure_cookies (since 1.5.2)
2747 sub command319 {
2748 print "This option allows you to specify that if a user session is initiated\n";
2749 print "under a secure (HTTPS, SSL-encrypted) connection, the cookies given to\n";
2750 print "the browser will ONLY be transmitted via a secure connection henceforth.\n\n";
2751 print "Generally this is a Good Thing, and should NOT be disabled. However,\n";
2752 print "if you intend to use the Secure Login or Show SSL Link plugins to\n";
2753 print "encrypt the user login, but not the rest of the SquirrelMail session,\n";
2754 print "this can be turned off. Think twice before doing so.\n";
2755 print "\n";
2756
2757 if ( lc($only_secure_cookies) eq 'true' ) {
2758 $default_value = "y";
2759 } else {
2760 $default_value = "n";
2761 }
2762 print "Transmit cookies only on secure connection when available? (y/n) [$WHT$default_value$NRM]: $WHT";
2763 $only_secure_cookies = <STDIN>;
2764 if ( ( $only_secure_cookies =~ /^y\n/i ) || ( ( $only_secure_cookies =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
2765 $only_secure_cookies = 'true';
2766 } else {
2767 $only_secure_cookies = 'false';
2768 }
2769 return $only_secure_cookies;
2770 }
2771
2772
2773 sub command_userThemes {
2774 print "\nDefine the user themes that you wish to use. If you have added\n";
2775 print "a theme of your own, just follow the instructions (?) about\n";
2776 print "how to add them. You can also change the default theme.\n\n";
2777
2778 print "Available user themes:\n";
2779 $count = 0;
2780 while ( $count <= $#user_theme_name ) {
2781 if ( $count == $user_theme_default ) {
2782 print " *";
2783 } else {
2784 print " ";
2785 }
2786 if ( $count < 10 ) {
2787 print " ";
2788 }
2789 $name = $user_theme_name[$count];
2790 $num_spaces = 35 - length($name);
2791 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2792 $name = $name . " ";
2793 }
2794
2795 print " $count. $name";
2796 print "($user_theme_path[$count])\n";
2797
2798 $count++;
2799 }
2800
2801 print "\n";
2802 print ".------------------------------------.\n";
2803 print "| t (detect user themes) |\n";
2804 print "| + (add user theme) |\n";
2805 print "| - N (remove user theme) |\n";
2806 print "| m N (mark default user theme) |\n";
2807 print "| l (list user themes) |\n";
2808 print "| d (done) |\n";
2809 print "`------------------------------------'\n";
2810
2811 print "\n[user_themes] command (?=help) > ";
2812 $input = <STDIN>;
2813 $input =~ s/[\r\n]//g;
2814 while ( $input ne "d" ) {
2815 if ( $input =~ /^\s*l\s*/i ) {
2816 $count = 0;
2817 while ( $count <= $#user_theme_name ) {
2818 if ( $count == $user_theme_default ) {
2819 print " *";
2820 } else {
2821 print " ";
2822 }
2823 if ( $count < 10 ) {
2824 print " ";
2825 }
2826 $name = $user_theme_name[$count];
2827 $num_spaces = 35 - length($name);
2828 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2829 $name = $name . " ";
2830 }
2831
2832 print " $count. $name";
2833 print "($user_theme_path[$count])\n";
2834
2835 $count++;
2836 }
2837 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
2838 $old_def = $user_theme_default;
2839 $user_theme_default = $input;
2840 $user_theme_default =~ s/^\s*m\s*//;
2841 if ( ( $user_theme_default > $#user_theme_name ) || ( $user_theme_default < 0 ) ) {
2842 print "Cannot set default theme to $user_theme_default. That theme does not exist.\n";
2843 $user_theme_default = $old_def;
2844 }
2845 } elsif ( $input =~ /^\s*\+/ ) {
2846 print "What is the name of this theme? ";
2847 $name = <STDIN>;
2848 $name =~ s/[\r\n]//g;
2849 $user_theme_name[ $#user_theme_name + 1 ] = $name;
2850 print "Be sure to put ../css/ before the filename.\n";
2851 print "What file is this stored in (ex: ../css/my_theme/): ";
2852 $name = <STDIN>;
2853 $name =~ s/[\r\n]//g;
2854 $user_theme_path[ $#user_theme_path + 1 ] = $name;
2855 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
2856 if ( $input =~ /[0-9]+\s*$/ ) {
2857 $rem_num = $input;
2858 $rem_num =~ s/^\s*-\s*//g;
2859 $rem_num =~ s/\s*$//;
2860 } else {
2861 $rem_num = $#user_theme_name;
2862 }
2863 if ( $rem_num == $user_theme_default ) {
2864 print "You cannot remove the default theme!\n";
2865 } else {
2866 $count = 0;
2867 @new_theme_name = ();
2868 @new_theme_path = ();
2869 while ( $count <= $#user_theme_name ) {
2870 if ( $count != $rem_num ) {
2871 @new_theme_name = ( @new_theme_name, $user_theme_name[$count] );
2872 @new_theme_path = ( @new_theme_path, $user_theme_path[$count] );
2873 }
2874 $count++;
2875 }
2876 @user_theme_name = @new_theme_name;
2877 @user_theme_path = @new_theme_path;
2878 if ( $user_theme_default > $rem_num ) {
2879 $user_theme_default--;
2880 }
2881 }
2882 } elsif ( $input =~ /^\s*t\s*/i ) {
2883 print "\nStarting detection...\n\n";
2884
2885 opendir( DIR, "../css" );
2886 @files = sort(readdir(DIR));
2887 $cnt = 0;
2888 while ( $cnt <= $#files ) {
2889 $filename = "../css/" . $files[$cnt] .'/';
2890 if ( $files[$cnt] !~ /^\./ && $filename ne "../css/rtl.css" && -e $filename . "default.css" ) {
2891 $found = 0;
2892 for ( $x = 0 ; $x <= $#user_theme_path ; $x++ ) {
2893 if ( $user_theme_path[$x] eq $filename ) {
2894 $found = 1;
2895 }
2896 }
2897 if ( $found != 1 ) {
2898 print "** Found user theme: $filename\n";
2899 $def = $files[$cnt];
2900 $def =~ s/_/ /g;
2901 $def = lc($def);
2902 #$def =~ s/(^\w+)/ucfirst $1/eg;
2903 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
2904 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
2905 print " What is its name? [$def]: ";
2906 $nm = <STDIN>;
2907 $nm =~ s/^\s+|\s+$|[\n\r]//g;
2908 if ( $nm eq '' ) { $nm = $def; }
2909 $user_theme_name[ $#user_theme_name + 1 ] = $nm;
2910 $user_theme_path[ $#user_theme_path + 1 ] = $filename;
2911 }
2912 }
2913 $cnt++;
2914 }
2915 print "\n";
2916 for ( $cnt = 0 ; $cnt <= $#user_theme_path ; $cnt++ ) {
2917 $filename = $user_theme_path[$cnt];
2918 if ( $filename != 'none' && !( -e $filename ."/default.css" ) ) {
2919 print " Removing $filename (file not found)\n";
2920 $offset = 0;
2921 @new_user_theme_name = ();
2922 @new_user_theme_path = ();
2923 for ( $x = 0 ; $x < $#user_theme_path ; $x++ ) {
2924 if ( $user_theme_path[$x] eq $filename ) {
2925 $offset = 1;
2926 }
2927 if ( $offset == 1 ) {
2928 $new_user_theme_name[$x] = $user_theme_name[ $x + 1 ];
2929 $new_user_theme_path[$x] = $user_theme_path[ $x + 1 ];
2930 } else {
2931 $new_user_theme_name[$x] = $user_theme_name[$x];
2932 $new_user_theme_path[$x] = $user_theme_path[$x];
2933 }
2934 }
2935 @user_theme_name = @new_user_theme_name;
2936 @user_theme_path = @new_user_theme_path;
2937 }
2938 }
2939 print "\nDetection complete!\n\n";
2940
2941 closedir DIR;
2942 } elsif ( $input =~ /^\s*\?\s*/ ) {
2943 print ".------------------------------------.\n";
2944 print "| t (detect user themes) |\n";
2945 print "| + (add user theme) |\n";
2946 print "| - N (remove user theme) |\n";
2947 print "| m N (mark default user theme) |\n";
2948 print "| l (list user themes) |\n";
2949 print "| d (done) |\n";
2950 print "`------------------------------------'\n";
2951 }
2952 print "[user_themes] command (?=help) > ";
2953 $input = <STDIN>;
2954 $input =~ s/[\r\n]//g;
2955 }
2956 }
2957
2958 sub command_iconSets {
2959 print "\nDefine the icon themes that you wish to use. If you have added\n";
2960 print "a theme of your own, just follow the instructions (?) about\n";
2961 print "how to add them. You can also change the default and fallback\n";
2962 print "themes. The default theme will be used when no icon theme is\n";
2963 print "set by the user. The fallback theme will be used if an icon\n";
2964 print "cannot be found in the currently selected icon theme.\n\n";
2965
2966 print "Available icon themes:\n\n";
2967
2968 $count = 0;
2969 while ( $count <= $#icon_theme_name ) {
2970 if ( $count == $icon_theme_def ) {
2971 print " d";
2972 } else {
2973 print " ";
2974 }
2975 if ( $count eq $icon_theme_fallback ) {
2976 print "f ";
2977 } else {
2978 print " ";
2979 }
2980 if ( $count < 10 ) {
2981 print " ";
2982 }
2983 $name = $icon_theme_name[$count];
2984 $num_spaces = 35 - length($name);
2985 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
2986 $name = $name . " ";
2987 }
2988
2989 print " $count. $name";
2990 print "($icon_theme_path[$count])\n";
2991
2992 $count++;
2993 }
2994
2995 print "\n d = Default icon theme\n";
2996 print " f = Fallback icon theme\n";
2997 print "\n";
2998 print ".------------------------------------.\n";
2999 print "| t (detect icon themes) |\n";
3000 print "| + (add icon theme) |\n";
3001 print "| - N (remove icon theme) |\n";
3002 print "| m N (mark default icon theme) |\n";
3003 print "| f N (set fallback icon set) |\n";
3004 print "| l (list icon themes) |\n";
3005 print "| d (done) |\n";
3006 print "`------------------------------------'\n";
3007
3008 print "\n[icon_themes] command (?=help) > ";
3009 $input = <STDIN>;
3010 $input =~ s/[\r\n]//g;
3011 while ( $input ne "d" ) {
3012 if ( $input =~ /^\s*l\s*/i ) {
3013 $count = 0;
3014 print "\n";
3015 while ( $count <= $#icon_theme_name ) {
3016 if ( $count == $icon_theme_def ) {
3017 print " d";
3018 } else {
3019 print " ";
3020 }
3021 if ( $count eq $icon_theme_fallback ) {
3022 print "f ";
3023 } else {
3024 print " ";
3025 }
3026 $name = $icon_theme_name[$count];
3027 $num_spaces = 35 - length($name);
3028 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3029 $name = $name . " ";
3030 }
3031
3032 print " $count. $name";
3033 print "($icon_theme_path[$count])\n";
3034
3035 $count++;
3036 }
3037 print "\n d = Default icon theme\n";
3038 print " f = Fallback icon theme\n\n";
3039 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
3040 $old_def = $icon_theme_def;
3041 $icon_theme_def = $input;
3042 $icon_theme_def =~ s/^\s*m\s*//;
3043 if ( ( $icon_theme_default > $#icon_theme_name ) || ( $icon_theme_default < 0 ) ) {
3044 print "Cannot set default icon theme to $icon_theme_default. That theme does not exist.\n";
3045 $icon_theme_def = $old_def;
3046 }
3047 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
3048 $old_fb = $icon_theme_fallback;
3049 $icon_theme_fallback = $input;
3050 $icon_theme_fallback =~ s/^\s*f\s*//;
3051 if ( ( $icon_theme_fallback > $#icon_theme_name ) || ( $icon_theme_fallback < 0 ) ) {
3052 print "Cannot set fallback icon theme to $icon_theme_fallback. That theme does not exist.\n";
3053 $icon_theme_fallback = $old_fb;
3054 }
3055 } elsif ( $input =~ /^\s*\+/ ) {
3056 print "What is the name of this icon theme? ";
3057 $name = <STDIN>;
3058 $name =~ s/[\r\n]//g;
3059 $icon_theme_name[ $#icon_theme_name + 1 ] = $name;
3060 print "Be sure to put ../images/themes/ before the filename.\n";
3061 print "What directory is this icon theme stored in (ex: ../images/themes/my_theme/)? ";
3062 $name = <STDIN>;
3063 $name =~ s/[\r\n]//g;
3064 $icon_theme_path[ $#icon_theme_path + 1 ] = $name;
3065 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3066 if ( $input =~ /[0-9]+\s*$/ ) {
3067 $rem_num = $input;
3068 $rem_num =~ s/^\s*-\s*//g;
3069 $rem_num =~ s/\s*$//;
3070 } else {
3071 $rem_num = $#icon_theme_name;
3072 }
3073 if ( $rem_num == $icon_theme_def ) {
3074 print "You cannot remove the default icon theme!\n";
3075 } elsif ( $rem_num == $icon_theme_fallback ) {
3076 print "You cannot remove the fallback icon theme!\n";
3077 } else {
3078 $count = 0;
3079 @new_theme_name = ();
3080 @new_theme_path = ();
3081 while ( $count <= $#icon_theme_name ) {
3082 if ( $count != $rem_num ) {
3083 @new_theme_name = ( @new_theme_name, $icon_theme_name[$count] );
3084 @new_theme_path = ( @new_theme_path, $icon_theme_path[$count] );
3085 }
3086 $count++;
3087 }
3088 @icon_theme_name = @new_theme_name;
3089 @icon_theme_path = @new_theme_path;
3090 if ( $icon_theme_def > $rem_num ) {
3091 $icon_theme_def--;
3092 }
3093 }
3094 } elsif ( $input =~ /^\s*t\s*/i ) {
3095 print "\nStarting detection...\n\n";
3096
3097 opendir( DIR, "../images/themes/" );
3098 @files = sort(readdir(DIR));
3099 $cnt = 0;
3100 while ( $cnt <= $#files ) {
3101 $filename = "../images/themes/" . $files[$cnt] .'/';
3102 if ( -d "../images/themes/" . $files[$cnt] && $files[$cnt] !~ /^\./ && $files[$cnt] ne ".svn" ) {
3103 $found = 0;
3104 for ( $x = 0 ; $x <= $#icon_theme_path ; $x++ ) {
3105 if ( $icon_theme_path[$x] eq $filename ) {
3106 $found = 1;
3107 }
3108 }
3109 if ( $found != 1 ) {
3110 print "** Found icon theme: $filename\n";
3111 $def = $files[$cnt];
3112 $def =~ s/_/ /g;
3113 $def = lc($def);
3114 #$def =~ s/(^\w+)/ucfirst $1/eg;
3115 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3116 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3117 print " What is its name? [$def]: ";
3118 $nm = <STDIN>;
3119 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3120 if ( $nm eq '' ) { $nm = $def; }
3121 $icon_theme_name[ $#icon_theme_name + 1 ] = $nm;
3122 $icon_theme_path[ $#icon_theme_path + 1 ] = $filename;
3123 }
3124 }
3125 $cnt++;
3126 }
3127 print "\n";
3128 for ( $cnt = 0 ; $cnt <= $#icon_theme_path ; $cnt++ ) {
3129 $filename = $icon_theme_path[$cnt];
3130 if ( $filename ne "none" && $filename ne "template" && ! -d $filename ) {
3131 print " Removing $filename (file not found)\n";
3132 $offset = 0;
3133 @new_icon_theme_name = ();
3134 @new_icon_theme_path = ();
3135 for ( $x = 0 ; $x < $#icon_theme_path ; $x++ ) {
3136 if ( $icon_theme_path[$x] eq $filename ) {
3137 $offset = 1;
3138 }
3139 if ( $offset == 1 ) {
3140 $new_icon_theme_name[$x] = $icon_theme_name[ $x + 1 ];
3141 $new_icon_theme_path[$x] = $icon_theme_path[ $x + 1 ];
3142 } else {
3143 $new_icon_theme_name[$x] = $icon_theme_name[$x];
3144 $new_icon_theme_path[$x] = $icon_theme_path[$x];
3145 }
3146 }
3147 @icon_theme_name = @new_icon_theme_name;
3148 @icon_theme_path = @new_icon_theme_path;
3149 }
3150 }
3151 print "\nDetection complete!\n\n";
3152
3153 closedir DIR;
3154 } elsif ( $input =~ /^\s*\?\s*/ ) {
3155 print ".------------------------------------.\n";
3156 print "| t (detect icon themes) |\n";
3157 print "| + (add icon theme) |\n";
3158 print "| - N (remove icon theme) |\n";
3159 print "| m N (mark default icon theme) |\n";
3160 print "| f N (set fallback icon set) |\n";
3161 print "| l (list icon themes) |\n";
3162 print "| d (done) |\n";
3163 print "`------------------------------------'\n";
3164 }
3165 print "[icon_themes] command (?=help) > ";
3166 $input = <STDIN>;
3167 $input =~ s/[\r\n]//g;
3168 }
3169 }
3170
3171 sub command_templates {
3172 print "\nDefine the template sets (skins) that you wish to use. If you have added\n";
3173 print "a template set of your own, just follow the instructions (?) about\n";
3174 print "how to add them. You can also change the default template.\n";
3175
3176 print "\n Available Templates:\n";
3177
3178 $count = 0;
3179 while ( $count <= $#templateset_name ) {
3180 if ( $templateset_id[$count] eq $templateset_default ) {
3181 print " d";
3182 } else {
3183 print " ";
3184 }
3185 if ( $templateset_id[$count] eq $templateset_fallback ) {
3186 print "f";
3187 } else {
3188 print " ";
3189 }
3190 if ( $templateset_id[$count] eq $rpc_templateset ) {
3191 print "r ";
3192 } else {
3193 print " ";
3194 }
3195 if ( $count < 10 ) {
3196 print " ";
3197 }
3198 if ( $count < 100 ) {
3199 print " ";
3200 }
3201 $name = $templateset_name[$count];
3202
3203 # present RPC template sets differently
3204 #
3205 if ( $templateset_id[$count] =~ /_rpc$/ ) {
3206 $name = $name . " (not shown in user interface; used for RPC interface only)";
3207 } else {
3208
3209 $num_spaces = 35 - length($name);
3210 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3211 $name = $name . " ";
3212 }
3213 $name = $name . "($templateset_id[$count])";
3214
3215 }
3216
3217 print " $count. $name\n";
3218
3219 $count++;
3220 }
3221 print "\n d = default template set\n"
3222 . " f = fallback template set\n"
3223 . " r = RPC template set\n\n";
3224
3225 $menu_text = ".-------------------------------------.\n"
3226 . "| t (detect template set) |\n"
3227 . "| + (add template set) |\n"
3228 . "| - N (remove template set) |\n"
3229 . "| m N (mark default template set) |\n"
3230 . "| f N (set fallback template set) |\n"
3231 . "| r N (set RPC template set) |\n"
3232 . "| l (list template sets/skins) |\n"
3233 . "| d (done) |\n"
3234 . "|-------------------------------------|\n"
3235 . "| where N is a template set number |\n"
3236 . "`-------------------------------------'\n";
3237 print "\n";
3238 print $menu_text;
3239 print "\n[template set] command (?=help) > ";
3240
3241 $input = <STDIN>;
3242 $input =~ s/[\r\n]//g;
3243 while ( $input ne "d" ) {
3244
3245 # list template sets
3246 #
3247 if ( $input =~ /^\s*l\s*/i ) {
3248 $count = 0;
3249 while ( $count <= $#templateset_name ) {
3250 if ( $templateset_id[$count] eq $templateset_default ) {
3251 print " d";
3252 } else {
3253 print " ";
3254 }
3255 if ( $templateset_id[$count] eq $templateset_fallback ) {
3256 print "f";
3257 } else {
3258 print " ";
3259 }
3260 if ( $templateset_id[$count] eq $rpc_templateset ) {
3261 print "r ";
3262 } else {
3263 print " ";
3264 }
3265 if ( $count < 10 ) {
3266 print " ";
3267 }
3268 if ( $count < 100 ) {
3269 print " ";
3270 }
3271 $name = $templateset_name[$count];
3272
3273 # present RPC template sets differently
3274 #
3275 if ( $templateset_id[$count] =~ /_rpc$/ ) {
3276 $name = $name . " (not shown in user interface; used for RPC interface only)";
3277 } else {
3278
3279 $num_spaces = 35 - length($name);
3280 for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
3281 $name = $name . " ";
3282 }
3283 $name = $name . "($templateset_id[$count])";
3284
3285 }
3286
3287 print " $count. $name\n";
3288
3289 $count++;
3290 }
3291 print "\n d = default template set\n"
3292 . " f = fallback template set\n"
3293 . " r = RPC template set\n\n";
3294
3295 # mark default template set
3296 #
3297 } elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
3298 $old_def = $templateset_default;
3299 $input =~ s/^\s*m\s*//;
3300 $templateset_default = $templateset_id[$input];
3301 if ( $templateset_default =~ /^\s*$/ ) {
3302 print "Cannot set default template set to $input. That template set does not exist.\n";
3303 $templateset_default = $old_def;
3304 }
3305 if ( $templateset_default =~ /_rpc$/ ) {
3306 print "Cannot set default template set to $input. That template set is intended for the RPC interface only.\n";
3307 $templateset_default = $old_def;
3308 }
3309
3310 # set fallback template set
3311 #
3312 } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
3313 $old_def = $templateset_fallback;
3314 $input =~ s/^\s*f\s*//;
3315 $templateset_fallback = $templateset_id[$input];
3316 if ( $templateset_fallback =~ /^\s*$/ ) {
3317 print "Cannot set fallback template set to $input. That template set does not exist.\n";
3318 $templateset_fallback = $old_def;
3319 }
3320 if ( $templateset_fallback =~ /_rpc$/ ) {
3321 print "Cannot set fallback template set to $input. That template set is intended for the RPC interface only.\n";
3322 $templateset_fallback = $old_def;
3323 }
3324
3325 # set RPC template set
3326 #
3327 } elsif ( $input =~ /^\s*r\s*[0-9]+/i ) {
3328 $old_def = $rpc_templateset;
3329 $input =~ s/^\s*r\s*//;
3330 $rpc_templateset = $templateset_id[$input];
3331 if ( $rpc_templateset =~ /^\s*$/ ) {
3332 print "Cannot set RPC template set to $input. That template set does not exist.\n";
3333 $rpc_templateset = $old_def;
3334 }
3335 if ( $rpc_templateset !~ /_rpc$/ ) {
3336 print "Cannot set fallback template set to $input. That template set is not intended for the RPC interface.\n";
3337 $rpc_templateset = $old_def;
3338 }
3339
3340 # add template set
3341 #
3342 } elsif ( $input =~ /^\s*\+/ ) {
3343 print "\nWhat is the name of this template (as shown to your users): ";
3344 $name = <STDIN>;
3345 $name =~ s/[\r\n]//g;
3346 $templateset_name[ $#templateset_name + 1 ] = $name;
3347 print "\n\nThe directory name should not contain any path information\n"
3348 . "or slashes, and should be the name of the directory that the\n"
3349 . "template set is found in within the SquirrelMail templates\n"
3350 . "directory.\n\n";
3351 print "What directory is this stored in (ex: default_advanced): ";
3352 $name = <STDIN>;
3353 $name =~ s/[\r\n]//g;
3354 $templateset_id[ $#templateset_id + 1 ] = $name;
3355
3356 # detect template sets
3357 #
3358 } elsif ( $input =~ /^\s*t\s*/i ) {
3359 print "\nStarting detection...\n\n";
3360 opendir( DIR, "../templates" );
3361 @files = sort(readdir(DIR));
3362 $cnt = 0;
3363 while ( $cnt <= $#files ) {
3364 if ( -d "../templates/" . $files[$cnt] && $files[$cnt] !~ /^\./ && $files[$cnt] ne ".svn" ) {
3365 $filename = $files[$cnt];
3366 $found = 0;
3367 for ( $x = 0 ; $x <= $#templateset_id ; $x++ ) {
3368 if ( $templateset_id[$x] eq $filename ) {
3369 $found = 1;
3370 last;
3371 }
3372 }
3373 if ( $found != 1) {
3374 print "** Found template set: $filename\n";
3375 $def = $files[$cnt];
3376
3377 # no user-friendly names needed for RPC template sets
3378 #
3379 if ( $def =~ /_rpc$/ ) {
3380 $nm = $def;
3381 } else {
3382 $def = lc($def);
3383 $def =~ s/_/ /g;
3384 #$def =~ s/(^\w+)/ucfirst $1/eg;
3385 #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
3386 $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
3387 print " What is it's name (as shown to your users)? [$def]: ";
3388 $nm = <STDIN>;
3389 $nm =~ s/^\s+|\s+$|[\n\r]//g;
3390 if ( $nm eq '' ) { $nm = $def; }
3391 }
3392 $templateset_id[ $#templateset_id + 1 ] = $filename;
3393 $templateset_name[ $#templateset_name + 1 ] = $nm;
3394 }
3395 }
3396 $cnt++;
3397 }
3398 print "\n";
3399 for ( $cnt= 0 ; $cnt <= $#templateset_id ; ) {
3400 $filename = $templateset_id[$cnt];
3401 if ( !(-d change_to_rel_path('SM_PATH . \'templates/' . $filename)) ) {
3402 print " Removing \"$filename\" (template set directory not found)\n";
3403 if ( $templateset_default eq $filename ) { $templateset_default = 'default'; }
3404 if ( $templateset_fallback eq $filename ) { $templateset_fallback = 'default'; }
3405 if ( $rpc_templateset eq $filename ) { $rpc_templateset = 'default_rpc'; }
3406 $offset = 0;
3407 @new_templateset_name = ();
3408 @new_templateset_id = ();
3409 for ( $x = 0 ; $x < $#templateset_id ; $x++ ) {
3410 if ( $templateset_id[$x] eq $filename ) {
3411 $offset = 1;
3412 }
3413 if ( $offset == 1 ) {
3414 $new_templateset_name[$x] = $templateset_name[ $x + 1 ];
3415 $new_templateset_id[$x] = $templateset_id[ $x + 1 ];
3416 } else {
3417 $new_templateset_name[$x] = $templateset_name[$x];
3418 $new_templateset_id[$x] = $templateset_id[$x];
3419 }
3420 }
3421 @templateset_name = @new_templateset_name;
3422 @templateset_id = @new_templateset_id;
3423 } else { $cnt++; }
3424 }
3425 print "\nDetection complete!\n\n";
3426
3427 closedir DIR;
3428
3429 # remove template set
3430 #
3431 # undocumented functionality of removing last template set isn't that great
3432 #} elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3433 } elsif ( $input =~ /^\s*-\s*[0-9]+/ ) {
3434 if ( $input =~ /[0-9]+\s*$/ ) {
3435 $rem_num = $input;
3436 $rem_num =~ s/^\s*-\s*//g;
3437 $rem_num =~ s/\s*$//;
3438 } else {
3439 $rem_num = $#templateset_name;
3440 }
3441 if ( $templateset_id[$rem_num] eq $templateset_default ) {
3442 print "You cannot remove the default template set!\n";
3443 } elsif ( $templateset_id[$rem_num] eq $templateset_fallback ) {
3444 print "You cannot remove the fallback template set!\n";
3445 } elsif ( $templateset_id[$rem_num] eq $rpc_templateset ) {
3446 print "You cannot remove the RPC template set!\n";
3447 } else {
3448 $count = 0;
3449 @new_templateset_name = ();
3450 @new_templateset_id = ();
3451 while ( $count <= $#templateset_name ) {
3452 if ( $count != $rem_num ) {
3453 @new_templateset_name = ( @new_templateset_name, $templateset_name[$count] );
3454 @new_templateset_id = ( @new_templateset_id, $templateset_id[$count] );
3455 }
3456 $count++;
3457 }
3458 @templateset_name = @new_templateset_name;
3459 @templateset_id = @new_templateset_id;
3460 }
3461
3462 # help
3463 #
3464 } elsif ( $input =~ /^\s*\?\s*/ ) {
3465 print $menu_text;
3466
3467 # command not understood
3468 #
3469 } else {
3470 print "Command not understood\n";
3471 }
3472
3473 print "[template set] command (?=help) > ";
3474 $input = <STDIN>;
3475 $input =~ s/[\r\n]//g;
3476 }
3477 return $templateset_default;
3478 }
3479
3480
3481 # sets default font size option
3482 sub command_default_fontsize {
3483 print "Enter default font size [$WHT$$default_fontsize$NRM]: $WHT";
3484 $new_size = <STDIN>;
3485 if ( $new_size eq "\n" ) {
3486 $new_size = $size;
3487 } else {
3488 $new_size =~ s/[\r\n]//g;
3489 }
3490 return $new_size;
3491 }
3492
3493 # controls available fontsets
3494 sub command_fontsets {
3495 # Greeting
3496 print "You can control fontsets available to end users here.\n";
3497 # set initial $input value
3498 $input = 'l';
3499 while ( $input ne "x" ) {
3500 if ( $input =~ /^\s*a\s*/i ) {
3501 # add new fontset
3502 print "\nFontset name: ";
3503 $name = <STDIN>;
3504 if (! $fontsets{trim($name)}) {
3505 print "Fontset string: ";
3506 $value = <STDIN>;
3507 $fontsets{trim($name)} = trim($value);
3508 } else {
3509 print "\nERROR: Such fontset already exists.\n";
3510 }
3511 } elsif ( $input =~ /^\s*e\s*/i ) {
3512 # edit existing fontset
3513 print "\nFontset name: ";
3514 $name = <STDIN>;
3515 if (! $fontsets{trim($name)}) {
3516 print "\nERROR: No such fontset.\n";
3517 } else {
3518 print "Fontset string [$fontsets{trim($name)}]: ";
3519 $value = <STDIN>;
3520 $fontsets{trim($name)} = trim($value);
3521 }
3522 } elsif ( $input =~ /^\s*d\s*/ ) {
3523 # delete existing fontset
3524 print "\nFontset name: ";
3525 $name = <STDIN>;
3526 if (! $fontsets{trim($name)}) {
3527 print "\nERROR: No such fontset.\n";
3528 } else {
3529 delete $fontsets{trim($name)};
3530 }
3531 } elsif ( $input =~ /^\s*l\s*/ ) {
3532 # list fontsets
3533 print "\nConfigured fontsets:\n";
3534 while (($fontset_name, $fontset_string) = each(%fontsets)) {
3535 print " $fontset_name = $fontset_string\n";
3536 }
3537 print "Default fontset: $default_fontset\n";
3538 } elsif ( $input =~ /^\s*m\s*/ ) {
3539 # set default fontset
3540 print "\nSet default fontset [$default_fontset]: ";
3541 $name = <STDIN>;
3542 if (trim($name) ne '' and ! $fontsets{trim($name)}) {
3543 print "\nERROR: No such fontset.\n";
3544 } else {
3545 $default_fontset = trim($name);
3546 }
3547 } else {
3548 # print available commands on any other input
3549 print "\nAvailable commands:\n";
3550 print " a - Adds new fontset.\n";
3551 print " d - Deletes existing fontset.\n";
3552 print " e - Edits existing fontset.\n";
3553 print " h or ? - Shows this help screen.\n";
3554 print " l - Lists available fontsets.\n";
3555 print " m - Sets default fontset.\n";
3556 print " x - Exits fontset editor mode.\n";
3557 }
3558 print "\nCommand [fontsets] (a,d,e,h,?=help,l,m,x)> ";
3559 $input = <STDIN>;
3560 $input =~ s/[\r\n]//g;
3561 }
3562 }
3563
3564 sub command61 {
3565 print "You can now define different LDAP servers.\n";
3566 print "Please ensure proper permissions for config.php when including\n";
3567 print "sensitive passwords.\n\n";
3568 print "[ldap] command (?=help) > ";
3569 $input = <STDIN>;
3570 $input =~ s/[\r\n]//g;
3571 while ( $input ne "d" ) {
3572 if ( $input =~ /^\s*l\s*/i ) {
3573 $count = 0;
3574 while ( $count <= $#ldap_host ) {
3575 print "$count. $ldap_host[$count]\n";
3576 print " base: $ldap_base[$count]\n";
3577 if ( $ldap_charset[$count] ) {
3578 print " charset: $ldap_charset[$count]\n";
3579 }
3580 if ( $ldap_port[$count] ) {
3581 print " port: $ldap_port[$count]\n";
3582 }
3583 if ( $ldap_name[$count] ) {
3584 print " name: $ldap_name[$count]\n";
3585 }
3586 if ( $ldap_maxrows[$count] ) {
3587 print " maxrows: $ldap_maxrows[$count]\n";
3588 }
3589 if ( $ldap_filter[$count] ) {
3590 print " filter: $ldap_filter[$count]\n";
3591 }
3592 if ( $ldap_binddn[$count] ) {
3593 print " binddn: $ldap_binddn[$count]\n";
3594 if ( $ldap_bindpw[$count] ) {
3595 print " bindpw: $ldap_bindpw[$count]\n";
3596 }
3597 }
3598 if ( $ldap_protocol[$count] ) {
3599 print " protocol: $ldap_protocol[$count]\n";
3600 }
3601 if ( $ldap_limit_scope[$count] ) {
3602 print " limit_scope: $ldap_limit_scope[$count]\n";
3603 }
3604 if ( $ldap_listing[$count] ) {
3605 print " listing: $ldap_listing[$count]\n";
3606 }
3607 if ( $ldap_writeable[$count] ) {
3608 print " writeable: $ldap_writeable[$count]\n";
3609 }
3610 if ( $ldap_search_tree[$count] ) {
3611 print " search_tree: $ldap_search_tree[$count]\n";
3612 }
3613 if ( $ldap_starttls[$count] ) {
3614 print " starttls: $ldap_starttls[$count]\n";
3615 }
3616
3617 print "\n";
3618 $count++;
3619 }
3620 } elsif ( $input =~ /^\s*\+/ ) {
3621 $sub = $#ldap_host + 1;
3622
3623 print "First, we need to have the hostname or the IP address where\n";
3624 print "this LDAP server resides. Example: ldap.bigfoot.com\n";
3625 print "\n";
3626 print "You can use any URI compatible with your LDAP library. Please\n";
3627 print "note that StartTLS option is not compatible with ldaps and\n";
3628 print "ldapi URIs.\n";
3629 print "hostname: ";
3630 $name = <STDIN>;
3631 $name =~ s/[\r\n]//g;
3632 $ldap_host[$sub] = $name;
3633
3634 print "\n";
3635
3636 print "Next, we need the server root (base dn). For this, an empty\n";
3637 print "string is allowed.\n";
3638 print "Example: ou=member_directory,o=netcenter.com\n";
3639 print "base: ";
3640 $name = <STDIN>;
3641 $name =~ s/[\r\n]//g;
3642 $ldap_base[$sub] = $name;
3643
3644 print "\n";
3645
3646 print "This is the TCP/IP port number for the LDAP server. Default\n";
3647 print "port is 389. This is optional. Press ENTER for default.\n";
3648 print "port: ";
3649 $name = <STDIN>;
3650 $name =~ s/[\r\n]//g;
3651 $ldap_port[$sub] = $name;
3652
3653 print "\n";
3654
3655 print "This is the charset for the server. Default is utf-8. This\n";
3656 print "is also optional. Press ENTER for default.\n";
3657 print "charset: ";
3658 $name = <STDIN>;
3659 $name =~ s/[\r\n]//g;
3660 $ldap_charset[$sub] = $name;
3661
3662 print "\n";
3663
3664 print "This is the name for the server, used to tag the results of\n";
3665 print "the search. Default it \"LDAP: hostname\". Press ENTER for default\n";
3666 print "name: ";
3667 $name = <STDIN>;
3668 $name =~ s/[\r\n]//g;
3669 $ldap_name[$sub] = $name;
3670
3671 print "\n";
3672
3673 print "You can specify the maximum number of rows in the search result.\n";
3674 print "Default value is equal to 250 rows. Press ENTER for default.\n";
3675 print "maxrows: ";
3676 $name = <STDIN>;
3677 $name =~ s/[\r\n]//g;
3678 $ldap_maxrows[$sub] = $name;
3679
3680
3681 print "\n";
3682
3683 print "If your LDAP server does not like anonymous logins, you can specify bind DN.\n";
3684 print "Default is none, anonymous bind. Press ENTER for default.\n";
3685 print "binddn: ";
3686 $name = <STDIN>;
3687 $name =~ s/[\r\n]//g;
3688 $ldap_binddn[$sub] = $name;
3689
3690 print "\n";
3691
3692 if ( $ldap_binddn[$sub] ne '' ) {
3693
3694 print "Now, please specify password for that DN.\n";
3695 print "bindpw: ";
3696 $name = <STDIN>;
3697 $name =~ s/[\r\n]//g;
3698 $ldap_bindpw[$sub] = $name;
3699
3700 print "\n";
3701 }
3702
3703 print "You can specify bind protocol version here.\n";
3704 print "Default protocol version depends on your php ldap settings.\n";
3705 print "Press ENTER for default.\n";
3706 print "protocol: ";
3707 $name = <STDIN>;
3708 $name =~ s/[\r\n]//g;
3709 $ldap_protocol[$sub] = $name;
3710
3711 print "\n";
3712
3713 print "This configuration section allows to set some rarely used\n";
3714 print "options and options specific to some LDAP implementations.\n";
3715 print "\n";
3716 print "Do you want to set advanced LDAP directory settings? (y/N):";
3717 $ldap_advanced_settings = <STDIN>;
3718 if ( $ldap_advanced_settings =~ /^y\n/i ) {
3719 $ldap_advanced_settings = 'true';
3720 } else {
3721 $ldap_advanced_settings = 'false';
3722 }
3723
3724 if ($ldap_advanced_settings eq 'true') {
3725 print "\n";
3726
3727 print "You can control LDAP directory listing here. This option can\n";
3728 print "be useful if you run small LDAP server and want to provide listing\n";
3729 print "of all addresses stored in LDAP to users of webmail interface.\n";
3730 print "Number of displayed entries is limited by maxrows setting.\n";
3731 print "\n";
3732 print "Don't enable this option for public LDAP directories.\n";
3733 print "\n";
3734 print "Allow listing of LDAP directory? (y/N):";
3735 $name = <STDIN>;
3736 if ( $name =~ /^y\n/i ) {
3737 $name = 'true';
3738 } else {
3739 $name = 'false';
3740 }
3741 $ldap_listing[$sub] = $name;
3742
3743 print "\n";
3744
3745 print "You can control write access to LDAP address book here. This option can\n";
3746 print "be useful if you run small LDAP server and want to provide writable\n";
3747 print "shared address book stored in LDAP to users of webmail interface.\n";
3748 print "\n";
3749 print "Don't enable this option for public LDAP directories.\n";
3750 print "\n";
3751 print "Allow writing to LDAP directory? (y/N):";
3752 $name = <STDIN>;
3753 if ( $name =~ /^y\n/i ) {
3754 $name = 'true';
3755 } else {
3756 $name = 'false';
3757 }
3758 $ldap_writeable[$sub] = $name;
3759
3760 print "\n";
3761
3762 print "You can specify an additional search filter.\n";
3763 print "This could be something like \"(objectclass=posixAccount)\".\n";
3764 print "No filtering is performed by default. Press ENTER for default.\n";
3765 print "filter: ";
3766 $name = <STDIN>;
3767 $name =~ s/[\r|\n]//g;
3768 $ldap_filter[$sub] = $name;
3769
3770 print "\n";
3771
3772 print "You can control search scope here.\n";
3773 print "This option is specific to Microsoft ADS implementation.\n";
3774 print "It requires use of v3 or newer LDAP protocol.\n";
3775 print "Don't enable it, if you use other LDAP server.\n";
3776 print "\n";
3777 print "Limit ldap scope? (y/N):";
3778 $name = <STDIN>;
3779 if ( $name =~ /^y\n/i ) {
3780 $name = 'true';
3781 } else {
3782 $name = 'false';
3783 }
3784 $ldap_limit_scope[$sub] = $name;
3785
3786 print "\n";
3787
3788 print "You can control ldap search type here.\n";
3789 print "Addresses can be searched in entire LDAP subtree (default)\n";
3790 print "or only first level entries are returned.\n";
3791 print "\n";
3792 print "Search entire LDAP subtree? (Y/n):";
3793 $name = <STDIN>;
3794 if ( $name =~ /^n\n/i ) {
3795 $name = 'false';
3796 } else {
3797 $name = 'true';
3798 }
3799 $ldap_search_tree[$sub] = $name;
3800
3801 print "\n";
3802
3803 print "You can control use of StartTLS on LDAP connection here.\n";
3804 print "This option requires use of v3 or newer LDAP protocol and php 4.2+.\n";
3805 print "\n";
3806 print "Use StartTLS? (y/N):";
3807 $name = <STDIN>;
3808 if ( $name =~ /^y\n/i ) {
3809 $name = 'true';
3810 } else {
3811 $name = 'false';
3812 }
3813 $ldap_starttls[$sub] = $name;
3814 }
3815 print "\n";
3816
3817 } elsif ( $input =~ /^\s*-\s*[0-9]?/ ) {
3818 if ( $input =~ /[0-9]+\s*$/ ) {
3819 $rem_num = $input;
3820 $rem_num =~ s/^\s*-\s*//g;
3821 $rem_num =~ s/\s*$//;
3822 } else {
3823 $rem_num = $#ldap_host;
3824 }
3825 $count = 0;
3826 @new_ldap_host = ();
3827 @new_ldap_base = ();
3828 @new_ldap_port = ();
3829 @new_ldap_name = ();
3830 @new_ldap_charset = ();
3831 @new_ldap_maxrows = ();
3832 @new_ldap_filter = ();
3833 @new_ldap_bindpw = ();
3834 @new_ldap_binddn = ();
3835 @new_ldap_protocol = ();
3836 @new_ldap_limit_scope = ();
3837 @new_ldap_listing = ();
3838 @new_ldap_writeable = ();
3839 @new_ldap_search_tree = ();
3840 @new_ldap_starttls = ();
3841
3842 while ( $count <= $#ldap_host ) {
3843 if ( $count != $rem_num ) {
3844 @new_ldap_host = ( @new_ldap_host, $ldap_host[$count] );
3845 @new_ldap_base = ( @new_ldap_base, $ldap_base[$count] );
3846 @new_ldap_port = ( @new_ldap_port, $ldap_port[$count] );
3847 @new_ldap_name = ( @new_ldap_name, $ldap_name[$count] );
3848 @new_ldap_charset = ( @new_ldap_charset, $ldap_charset[$count] );
3849 @new_ldap_maxrows = ( @new_ldap_maxrows, $ldap_maxrows[$count] );
3850 @new_ldap_filter = ( @new_ldap_filter, $ldap_filter[$count] );
3851 @new_ldap_binddn = ( @new_ldap_binddn, $ldap_binddn[$count] );
3852 @new_ldap_bindpw = ( @new_ldap_bindpw, $ldap_bindpw[$count] );
3853 @new_ldap_protocol = ( @new_ldap_protocol, $ldap_protocol[$count] );
3854 @new_ldap_limit_scope = ( @new_ldap_limit_scope, $ldap_limit_scope[$count] );
3855 @new_ldap_listing = ( @new_ldap_listing, $ldap_listing[$count] );
3856 @new_ldap_writeable = ( @new_ldap_writeable, $ldap_writeable[$count] );
3857 @new_ldap_search_tree = ( @new_ldap_search_tree, $ldap_search_tree[$count] );
3858 @new_ldap_starttls = ( @new_ldap_starttls, $ldap_starttls[$count] );
3859 }
3860 $count++;
3861 }
3862 @ldap_host = @new_ldap_host;
3863 @ldap_base = @new_ldap_base;
3864 @ldap_port = @new_ldap_port;
3865 @ldap_name = @new_ldap_name;
3866 @ldap_charset = @new_ldap_charset;
3867 @ldap_maxrows = @new_ldap_maxrows;
3868 @ldap_filter = @new_ldap_filter;
3869 @ldap_binddn = @new_ldap_binddn;
3870 @ldap_bindpw = @new_ldap_bindpw;
3871 @ldap_protocol = @new_ldap_protocol;
3872 @ldap_limit_scope = @new_ldap_limit_scope;
3873 @ldap_listing = @new_ldap_listing;
3874 @ldap_writeable = @new_ldap_writeable;
3875 @ldap_search_tree = @new_ldap_search_tree;
3876 @ldap_starttls = @new_ldap_starttls;
3877
3878 } elsif ( $input =~ /^\s*\?\s*/ ) {
3879 print ".-------------------------.\n";
3880 print "| + (add host) |\n";
3881 print "| - N (remove host) |\n";
3882 print "| l (list hosts) |\n";
3883 print "| d (done) |\n";
3884 print "`-------------------------'\n";
3885 }
3886 print "[ldap] command (?=help) > ";
3887 $input = <STDIN>;
3888 $input =~ s/[\r\n]//g;
3889 }
3890 }
3891
3892 sub command62 {
3893 print "Some of our developers have come up with very good javascript interface\n";
3894 print "for searching through address books, however, our original goals said\n";
3895 print "that we would be 100% HTML. In order to make it possible to use their\n";
3896 print "interface, and yet stick with our goals, we have also written a plain\n";
3897 print "HTML version of the search. Here, you can choose which version to use.\n";
3898 print "\n";
3899 print "This is just the default value. It is also a user option that each\n";
3900 print "user can configure individually\n";
3901 print "\n";
3902
3903 if ( lc($default_use_javascript_addr_book) eq 'true' ) {
3904 $default_value = "y";
3905 } else {
3906 $default_use_javascript_addr_book = 'false';
3907 $default_value = "n";
3908 }
3909 print "Use javascript version by default (y/n) [$WHT$default_value$NRM]: $WHT";
3910 $new_show = <STDIN>;
3911 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3912 $default_use_javascript_addr_book = 'true';
3913 } else {
3914 $default_use_javascript_addr_book = 'false';
3915 }
3916 return $default_use_javascript_addr_book;
3917 }
3918
3919 # global filebased address book
3920 sub command63 {
3921 print "If you want to use global file address book, then you\n";
3922 print "must set this option to a valid value. If option does\n";
3923 print "not have path elements, system assumes that file is\n";
3924 print "stored in data directory. If relative path is set, it is\n";
3925 print "relative to main SquirrelMail directory. If value is empty,\n";
3926 print "address book is not enabled.\n";
3927 print "\n";
3928
3929 print "[$WHT$abook_global_file$NRM]: $WHT";
3930 $new_abook_global_file = <STDIN>;
3931 if ( $new_abook_global_file eq "\n" ) {
3932 $new_abook_global_file = $abook_global_file;
3933 } else {
3934 $new_abook_global_file =~ s/[\r\n]//g;
3935 }
3936 return $new_abook_global_file;
3937 }
3938
3939 # writing into global filebased abook control
3940 sub command64 {
3941 print "This setting controls writing into global file address\n";
3942 print "book options. Address book file must be writeable by\n";
3943 print "webserver's user, if you want to enable this option.\n";
3944 print "\n";
3945
3946 if ( lc($abook_global_file_writeable) eq 'true' ) {
3947 $default_value = "y";
3948 } else {
3949 $abook_global_file_writeable = 'false';
3950 $default_value = "n";
3951 }
3952 print "Allow writing into global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
3953 $new_show = <STDIN>;
3954 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3955 $abook_global_file_writeable = 'true';
3956 } else {
3957 $abook_global_file_writeable = 'false';
3958 }
3959 return $abook_global_file_writeable;
3960 }
3961
3962 # listing of global filebased abook control
3963 sub command65 {
3964 print "This setting controls listing of global file address\n";
3965 print "book in addresses page.\n";
3966 print "\n";
3967
3968 if ( lc($abook_global_file_listing) eq 'true' ) {
3969 $default_value = "y";
3970 } else {
3971 $abook_global_file_listing = 'false';
3972 $default_value = "n";
3973 }
3974 print "Allow listing of global file address book (y/n) [$WHT$default_value$NRM]: $WHT";
3975 $new_show = <STDIN>;
3976 if ( ( $new_show =~ /^y\n/i ) || ( ( $new_show =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
3977 $abook_global_file_listing = 'true';
3978 } else {
3979 $abook_global_file_listing = 'false';
3980 }
3981 return $abook_global_file_listing;
3982 }
3983
3984 # controls $abook_file_line_length setting
3985 sub command_abook_file_line_length {
3986 print "This setting controls space allocated to file based address book records.\n";
3987 print "End users will be unable to save address book entry, if total entry size \n";
3988 print "(quoted address book fields + 4 delimiters + linefeed) exceeds allowed \n";
3989 print "address book length size.\n";
3990 print "\n";
3991 print "Same setting is applied to personal and global file based address books.\n";
3992 print "\n";
3993 print "It is strongly recommended to keep default setting value. Change it only\n";
3994 print "if you really want to store address book entries that are bigger than two\n";
3995 print "kilobytes (2048).\n";
3996 print "\n";
3997
3998 print "Enter allowed address book line length [$abook_file_line_length]: ";
3999 my $tmp = <STDIN>;
4000 $tmp = trim($tmp);
4001 # value is not modified, if user hits Enter or enters space
4002 if ($tmp ne '') {
4003 # make sure that input is numeric
4004 if ($tmp =~ /^\d+$/) {
4005 $abook_file_line_length = $tmp;
4006 } else {
4007 print "If you want to change this setting, you must enter number.\n";
4008 print "If you want to keep original setting - enter space.\n\n";
4009 print "Press Enter to continue...";
4010 $tmp = <STDIN>;
4011 }
4012 }
4013 }
4014
4015 sub command91 {
4016 print "If you want to store your users address book details in a database then\n";
4017 print "you need to set this DSN to a valid value. The format for this is:\n";
4018 print "mysql://user:pass\@hostname/dbname\n";
4019 print "Where mysql can be one of the databases PHP supports, the most common\n";
4020 print "of these are mysql, msql and pgsql.\n";
4021 print "Please ensure proper permissions for config.php when including\n";
4022 print "sensitive passwords.\n\n";
4023 print "If the DSN is left empty (hit space and then return) the database\n";
4024 print "related code for address books will not be used.\n";
4025 print "\n";
4026
4027 if ( $addrbook_dsn eq "" ) {
4028 $default_value = "Disabled";
4029 } else {
4030 $default_value = $addrbook_dsn;
4031 }
4032 print "[$WHT$addrbook_dsn$NRM]: $WHT";
4033 $new_dsn = <STDIN>;
4034 if ( $new_dsn eq "\n" ) {
4035 $new_dsn = "";
4036 } else {
4037 $new_dsn =~ s/[\r\n]//g;
4038 $new_dsn =~ s/^\s+$//g;
4039 }
4040 return $new_dsn;
4041 }
4042
4043 sub command92 {
4044 print "This is the name of the table you want to store the address book\n";
4045 print "data in, it defaults to 'address'\n";
4046 print "\n";
4047 print "[$WHT$addrbook_table$NRM]: $WHT";
4048 $new_table = <STDIN>;
4049 if ( $new_table eq "\n" ) {
4050 $new_table = $addrbook_table;
4051 } else {
4052 $new_table =~ s/[\r\n]//g;
4053 }
4054 return $new_table;
4055 }
4056
4057 sub command93 {
4058 print "If you want to store your users preferences in a database then\n";
4059 print "you need to set this DSN to a valid value. The format for this is:\n";
4060 print "mysql://user:pass\@hostname/dbname\n";
4061 print "Where mysql can be one of the databases PHP supports, the most common\n";
4062 print "of these are mysql, msql and pgsql.\n";
4063 print "Please ensure proper permissions for config.php when including\n";
4064 print "sensitive passwords.\n\n";
4065 print "If the DSN is left empty (hit space and then return) the database\n";
4066 print "related code for address books will not be used.\n";
4067 print "\n";
4068
4069 if ( $prefs_dsn eq "" ) {
4070 $default_value = "Disabled";
4071 } else {
4072 $default_value = $prefs_dsn;
4073 }
4074 print "[$WHT$prefs_dsn$NRM]: $WHT";
4075 $new_dsn = <STDIN>;
4076 if ( $new_dsn eq "\n" ) {
4077 $new_dsn = "";
4078 } else {
4079 $new_dsn =~ s/[\r\n]//g;
4080 $new_dsn =~ s/^\s+$//g;
4081 }
4082 return $new_dsn;
4083 }
4084
4085 sub command94 {
4086 print "This is the name of the table you want to store the preferences\n";
4087 print "data in, it defaults to 'userprefs'\n";
4088 print "\n";
4089 print "[$WHT$prefs_table$NRM]: $WHT";
4090 $new_table = <STDIN>;
4091 if ( $new_table eq "\n" ) {
4092 $new_table = $prefs_table;
4093 } else {
4094 $new_table =~ s/[\r\n]//g;
4095 }
4096 return $new_table;
4097 }
4098
4099 sub command95 {
4100 print "This is the name of the field in which you want to store the\n";
4101 print "username of the person the prefs are for. It default to 'user'\n";
4102 print "which clashes with a reserved keyword in PostgreSQL so this\n";
4103 print "will need to be changed for that database at least\n";
4104 print "\n";
4105 print "[$WHT$prefs_user_field$NRM]: $WHT";
4106 $new_field = <STDIN>;
4107 if ( $new_field eq "\n" ) {
4108 $new_field = $prefs_user_field;
4109 } else {
4110 $new_field =~ s/[\r\n]//g;
4111 }
4112 $prefs_user_size = db_pref_size($prefs_user_size);
4113 return $new_field;
4114 }
4115
4116 sub command96 {
4117 print "This is the name of the field in which you want to store the\n";
4118 print "preferences keyword. It defaults to 'prefkey'\n";
4119 print "\n";
4120 print "[$WHT$prefs_key_field$NRM]: $WHT";
4121 $new_field = <STDIN>;
4122 if ( $new_field eq "\n" ) {
4123 $new_field = $prefs_key_field;
4124 } else {
4125 $new_field =~ s/[\r\n]//g;
4126 }
4127 $prefs_key_size = db_pref_size($prefs_key_size);
4128 return $new_field;
4129 }
4130
4131 sub command97 {
4132 print "This is the name of the field in which you want to store the\n";
4133 print "preferences value. It defaults to 'prefval'\n";
4134 print "\n";
4135 print "[$WHT$prefs_val_field$NRM]: $WHT";
4136 $new_field = <STDIN>;
4137 if ( $new_field eq "\n" ) {
4138 $new_field = $prefs_val_field;
4139 } else {
4140 $new_field =~ s/[\r\n]//g;
4141 }
4142 $prefs_val_size = db_pref_size($prefs_val_size);
4143 return $new_field;
4144 }
4145
4146 # routine is used to set database field limits
4147 # it needs one argument
4148 sub db_pref_size() {
4149 my ($size) = $_[0];
4150 print "\nDatabase fields have size limits.\n";
4151 print "\n";
4152 print "What limit is set for this field? [$WHT$size$NRM]: $WHT";
4153 $new_size = <STDIN>;
4154 if ( $new_size eq "\n" ) {
4155 $new_size = $size;
4156 } else {
4157 $new_size =~ s/[\r\n]//g;
4158 }
4159 return $new_size;
4160 }
4161
4162 sub command98 {
4163 print "If you want to store your global address book in a database then\n";
4164 print "you need to set this DSN to a valid value. The format for this is:\n";
4165 print "mysql://user:pass\@hostname/dbname\n";
4166 print "Where mysql can be one of the databases PHP supports, the most common\n";
4167 print "of these are mysql, msql and pgsql.\n";
4168 print "Please ensure proper permissions for config.php when including\n";
4169 print "sensitive passwords.\n\n";
4170 print "If the DSN is left empty (hit space and then return) the database\n";
4171 print "related code for global SQL address book will not be used.\n";
4172 print "\n";
4173
4174 if ( $addrbook_global_dsn eq "" ) {
4175 $default_value = "Disabled";
4176 } else {
4177 $default_value = $addrbook_global_dsn;
4178 }
4179 print "[$WHT$addrbook_global_dsn$NRM]: $WHT";
4180 $new_dsn = <STDIN>;
4181 if ( $new_dsn eq "\n" ) {
4182 $new_dsn = "";
4183 } else {
4184 $new_dsn =~ s/[\r\n]//g;
4185 $new_dsn =~ s/^\s+$//g;
4186 }
4187 return $new_dsn;
4188 }
4189
4190 sub command99 {
4191 print "This is the name of the table you want to store the global address book\n";
4192 print "data in. Default table name is 'global_abook'. Address book uses same\n";
4193 print "database format as personal address book.\n";
4194 print "\n";
4195 print "[$WHT$addrbook_global_table$NRM]: $WHT";
4196 $new_table = <STDIN>;
4197 if ( $new_table eq "\n" ) {
4198 $new_table = $addrbook_global_table;
4199 } else {
4200 $new_table =~ s/[\r\n]//g;
4201 }
4202 return $new_table;
4203 }
4204
4205 sub command910 {
4206 print "This option controls users\' ability to add or modify records stored \n";
4207 print "in global address book\n";
4208
4209 if ( lc($addrbook_global_writeable) eq 'true' ) {
4210 $default_value = "y";
4211 } else {
4212 $default_value = "n";
4213 }
4214 print "Allow writing into global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
4215 $addrbook_global_writeable = <STDIN>;
4216 if ( ( $addrbook_global_writeable =~ /^y\n/i ) || ( ( $addrbook_global_writeable =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4217 $addrbook_global_writeable = 'true';
4218 } else {
4219 $addrbook_global_writeable = 'false';
4220 }
4221 return $addrbook_global_writeable;
4222 }
4223
4224 sub command911 {
4225 print "Enable this option if you want to see listing of addresses stored \n";
4226 print "in global address book\n";
4227
4228 if ( lc($addrbook_global_listing) eq 'true' ) {
4229 $default_value = "y";
4230 } else {
4231 $default_value = "n";
4232 }
4233 print "Allow listing of global address book? (y/n) [$WHT$default_value$NRM]: $WHT";
4234 $addrbook_global_listing = <STDIN>;
4235 if ( ( $addrbook_global_listing =~ /^y\n/i ) || ( ( $addrbook_global_listing =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4236 $addrbook_global_listing = 'true';
4237 } else {
4238 $addrbook_global_listing = 'false';
4239 }
4240 return $addrbook_global_listing;
4241 }
4242
4243
4244 # Default language
4245 sub commandA1 {
4246 print "SquirrelMail attempts to set the language in many ways. If it\n";
4247 print "can not figure it out in another way, it will default to this\n";
4248 print "language. Please use the code for the desired language.\n";
4249 print "\n";
4250 print "[$WHT$squirrelmail_default_language$NRM]: $WHT";
4251 $new_squirrelmail_default_language = <STDIN>;
4252 if ( $new_squirrelmail_default_language eq "\n" ) {
4253 $new_squirrelmail_default_language = $squirrelmail_default_language;
4254 } else {
4255 $new_squirrelmail_default_language =~ s/[\r\n]//g;
4256 $new_squirrelmail_default_language =~ s/^\s+$//g;
4257 }
4258 return $new_squirrelmail_default_language;
4259 }
4260 # Default Charset
4261 sub commandA2 {
4262 print "This option controls what character set is used when sending\n";
4263 print "mail and when sending HTML to the browser. Option works only\n";
4264 print "with US English (en_US) translation. Other translations use\n";
4265 print "charsets that are set in translation settings.\n";
4266 print "\n";
4267
4268 print "[$WHT$default_charset$NRM]: $WHT";
4269 $new_default_charset = <STDIN>;
4270 if ( $new_default_charset eq "\n" ) {
4271 $new_default_charset = $default_charset;
4272 } else {
4273 $new_default_charset =~ s/[\r\n]//g;
4274 }
4275 return $new_default_charset;
4276 }
4277 # Alternative language names
4278 sub commandA3 {
4279 print "Enable this option if you want to see localized language names in\n";
4280 print "language selection box. Note, that this option can trigger\n";
4281 print "installation of foreign language support modules in some browsers.\n";
4282 print "\n";
4283
4284 if ( lc($show_alternative_names) eq 'true' ) {
4285 $default_value = "y";
4286 } else {
4287 $default_value = "n";
4288 }
4289 print "Show alternative language names? (y/n) [$WHT$default_value$NRM]: $WHT";
4290 $show_alternative_names = <STDIN>;
4291 if ( ( $show_alternative_names =~ /^y\n/i ) || ( ( $show_alternative_names =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4292 $show_alternative_names = 'true';
4293 } else {
4294 $show_alternative_names = 'false';
4295 }
4296 return $show_alternative_names;
4297 }
4298
4299 # Aggressive decoding
4300 sub commandA4 {
4301 print "Enable this option if you want to use CPU and memory intensive decoding\n";
4302 print "functions. This option allows reading multibyte charset, that are used\n";
4303 print "in Eastern Asia. SquirrelMail will try to use recode functions here,\n";
4304 print "even when you have disabled use of recode in Tweaks section.\n";
4305 print "\n";
4306
4307 if ( lc($aggressive_decoding) eq 'true' ) {
4308 $default_value = "y";
4309 } else {
4310 $default_value = "n";
4311 }
4312 print "Enable aggressive decoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4313 $aggressive_decoding = <STDIN>;
4314 if ( ( $aggressive_decoding =~ /^y\n/i ) || ( ( $aggressive_decoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4315 $aggressive_decoding = 'true';
4316 } else {
4317 $aggressive_decoding = 'false';
4318 }
4319 return $aggressive_decoding;
4320 }
4321
4322 # Lossy encoding
4323 sub commandA5 {
4324 print "Enable this option if you want to allow lossy charset encoding in message\n";
4325 print "composition pages. This option allows charset conversions when output\n";
4326 print "charset does not support all symbols used in original charset. Symbols\n";
4327 print "unsupported by output charset will be replaced with question marks.\n";
4328 print "\n";
4329
4330 if ( lc($lossy_encoding) eq 'true' ) {
4331 $default_value = "y";
4332 } else {
4333 $default_value = "n";
4334 }
4335 print "Enable lossy encoding? (y/n) [$WHT$default_value$NRM]: $WHT";
4336 $lossy_encoding = <STDIN>;
4337 if ( ( $lossy_encoding =~ /^y\n/i ) || ( ( $lossy_encoding =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4338 $lossy_encoding = 'true';
4339 } else {
4340 $lossy_encoding = 'false';
4341 }
4342 return $lossy_encoding;
4343 }
4344
4345 # display html emails in iframe
4346 sub commandB2 {
4347 print "This option can enable html email rendering inside iframe.\n";
4348 print "Inline frames are used in order to provide sandbox environment";
4349 print "for html code included in html formated emails.";
4350 print "Option is experimental and might have glitches in some parts of code.";
4351 print "\n";
4352
4353 if ( lc($use_iframe) eq 'true' ) {
4354 $default_value = "y";
4355 } else {
4356 $default_value = "n";
4357 }
4358 print "Display html emails in iframe? (y/n) [$WHT$default_value$NRM]: $WHT";
4359 $use_iframe = <STDIN>;
4360 if ( ( $use_iframe =~ /^y\n/i ) || ( ( $use_iframe =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4361 $use_iframe = 'true';
4362 } else {
4363 $use_iframe = 'false';
4364 }
4365 return $use_iframe;
4366 }
4367
4368 # ask user info
4369 sub command_ask_user_info {
4370 print "New users need to supply their real name and email address to\n";
4371 print "send out proper mails. When this option is enabled, a user that\n";
4372 print "logs in for the first time will be redirected to the Personal\n";
4373 print "Options screen and asked to supply their personal data.\n";
4374 print "\n";
4375
4376 if ( lc($ask_user_info) eq 'true' ) {
4377 $default_value = "y";
4378 } else {
4379 $default_value = "n";
4380 }
4381 print "Ask user info? (y/n) [$WHT$default_value$NRM]: $WHT";
4382 $ask_user_info = <STDIN>;
4383 if ( ( $ask_user_info =~ /^y\n/i ) || ( ( $ask_user_info =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4384 $ask_user_info = 'true';
4385 } else {
4386 $ask_user_info = 'false';
4387 }
4388 return $ask_user_info;
4389 }
4390
4391 # use icons
4392 sub commandB3 {
4393 print "Enabling this option will cause icons to be used instead of text\n";
4394 print "markers next to each message in mailbox lists that represent\n";
4395 print "new, read, flagged, and deleted messages, as well as those that\n";
4396 print "have been replied to and forwarded. Icons are also used next to\n";
4397 print "(un)expanded folders in the folder list (Oldway = false). These\n";
4398 print "icons are quite small, but will obviously be more of a resource\n";
4399 print "drain than text markers.\n";
4400 print "\n";
4401
4402 if ( lc($use_icons) eq 'true' ) {
4403 $default_value = "y";
4404 } else {
4405 $default_value = "n";
4406 }
4407 print "Use icons? (y/n) [$WHT$default_value$NRM]: $WHT";
4408 $use_icons = <STDIN>;
4409 if ( ( $use_icons =~ /^y\n/i ) || ( ( $use_icons =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4410 $use_icons = 'true';
4411 } else {
4412 $use_icons = 'false';
4413 }
4414 return $use_icons;
4415 }
4416 # php recode
4417 sub commandB4 {
4418 print "Enable this option if you want to use php recode functions to read\n";
4419 print "emails written in charset that differs from the one that is set in\n";
4420 print "translation selected by user. Code is experimental, it might cause\n";
4421 print "errors, if email contains charset unsupported by recode or if your\n";
4422 print "php does not have recode support.\n";
4423 print "\n";
4424
4425 if ( lc($use_php_recode) eq 'true' ) {
4426 $default_value = "y";
4427 } else {
4428 $default_value = "n";
4429 }
4430 print "Use php recode functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4431 $use_php_recode = <STDIN>;
4432 if ( ( $use_php_recode =~ /^y\n/i ) || ( ( $use_php_recode =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4433 $use_php_recode = 'true';
4434 } else {
4435 $use_php_recode = 'false';
4436 }
4437 return $use_php_recode;
4438 }
4439 # php iconv
4440 sub commandB5 {
4441 print "Enable this option if you want to use php iconv functions to read\n";
4442 print "emails written in charset that differs from the one that is set in\n";
4443 print "translation selected by user. Code is experimental, it works only\n";
4444 print "with translations that use utf-8 charset. Code might cause errors,\n";
4445 print "if email contains charset unsupported by iconv or if your php does\n";
4446 print "not have iconv support.\n";
4447 print "\n";
4448
4449 if ( lc($use_php_iconv) eq 'true' ) {
4450 $default_value = "y";
4451 } else {
4452 $default_value = "n";
4453 }
4454 print "Use php iconv functions? (y/n) [$WHT$default_value$NRM]: $WHT";
4455 $use_php_iconv = <STDIN>;
4456 if ( ( $use_php_iconv =~ /^y\n/i ) || ( ( $use_php_iconv =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4457 $use_php_iconv = 'true';
4458 } else {
4459 $use_php_iconv = 'false';
4460 }
4461 return $use_php_iconv;
4462 }
4463
4464 # buffer output
4465 sub commandB6 {
4466 print "In some cases, buffering all output (holding it on the server until\n";
4467 print "the full page is ready to send to the browser) allows more complex\n";
4468 print "functionality, especially for plugins that want to add headers on hooks\n";
4469 print "that are beyond the point of output having been sent to the browser\n";
4470 print "otherwise. Most plugins that need this functionality will enable it\n";
4471 print "automatically on their own, but you can turn it on manually here. You'd\n";
4472 print "usually want to do this if you want to specify a custom output handler\n";
4473 print "for parsing the output - you can do that by specifying a value for\n";
4474 print "\$buffered_output_handler in config_local.php. Don't forget to define\n";
4475 print "a function of the same name as what \$buffered_output_handler is set to.\n";
4476 print "\n";
4477
4478 if ( lc($buffer_output) eq 'true' ) {
4479 $default_value = "y";
4480 } else {
4481 $default_value = "n";
4482 }
4483 print "Buffer all output? (y/n) [$WHT$default_value$NRM]: $WHT";
4484 $buffer_output = <STDIN>;
4485 if ( ( $buffer_output =~ /^y\n/i ) || ( ( $buffer_output =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4486 $buffer_output = 'true';
4487 } else {
4488 $buffer_output = 'false';
4489 }
4490 return $buffer_output;
4491 }
4492
4493 # configtest block
4494 sub commandB7 {
4495 print "Enable this option if you want to check SquirrelMail configuration\n";
4496 print "remotely with configtest.php script.\n";
4497 print "\n";
4498
4499 if ( lc($allow_remote_configtest) eq 'true' ) {
4500 $default_value = "y";
4501 } else {
4502 $default_value = "n";
4503 }
4504 print "Allow remote configuration tests? (y/n) [$WHT$default_value$NRM]: $WHT";
4505 $allow_remote_configtest = <STDIN>;
4506 if ( ( $allow_remote_configtest =~ /^y\n/i ) || ( ( $allow_remote_configtest =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4507 $allow_remote_configtest = 'true';
4508 } else {
4509 $allow_remote_configtest = 'false';
4510 }
4511 return $allow_remote_configtest;
4512 }
4513
4514 # Default Icon theme
4515 sub command53 {
4516 print "You may change the path to the default icon theme to be used, if icons\n";
4517 print "have been enabled. This theme will be used when an icon cannot be\n";
4518 print "found in the current theme, or when no icon theme is specified. If\n";
4519 print "left blank, and icons are enabled, the default theme will be used\n";
4520 print "from images/themes/default/.\n";
4521 print "\n";
4522 print "To clear out an existing value, just type a space for the input.\n";
4523 print "\n";
4524 print "Please be aware of the following: \n";
4525 print " - Relative URLs are relative to the config dir\n";
4526 print " to use the icon themes directory, use ../images/themes/newtheme/\n";
4527 print " - The icon theme may be outside the SquirrelMail directory, but\n";
4528 print " it must be web accessible.\n";
4529 print "[$WHT$icon_theme_def$NRM]: $WHT";
4530 $new_icon_theme_def = <STDIN>;
4531
4532 if ( $new_icon_theme_def eq "\n" ) {
4533 $new_icon_theme_def = $icon_theme_def;
4534 } else {
4535 $new_icon_theme_def =~ s/[\r\n]//g;
4536 }
4537 $new_icon_theme_def =~ s/^\s*//;
4538 return $new_icon_theme_def;
4539 }
4540
4541 # SquirrelMail debug mode (since 1.5.2)
4542 sub commandB8 {
4543 print "When debugging or developing SquirrelMail, you may want to increase\n";
4544 print "the verbosity of certain kinds of errors, notices, and/or diagnostics.\n";
4545 print "You may enable one or more of the debugging modes here. Please make\n";
4546 print "sure that you have turned off debugging if you are using SquirrelMail\n";
4547 print "in a production environment.\n\n";
4548
4549 $input = "";
4550 while ( $input ne "d\n" ) {
4551 $sm_debug_mode = convert_debug_constants_to_binary_integer($sm_debug_mode);
4552
4553 # per include/constants.php, here are the debug mode values:
4554 #
4555 # 0 SM_DEBUG_MODE_OFF
4556 # 1 SM_DEBUG_MODE_SIMPLE
4557 # 512 SM_DEBUG_MODE_MODERATE
4558 # 524288 SM_DEBUG_MODE_ADVANCED
4559 # 536870912 SM_DEBUG_MODE_STRICT
4560 #
4561 print "\n# Enabled? Description\n";
4562 print "---------------------------------------------------------------------\n";
4563 print "0 " . ($sm_debug_mode == 0 ? "y" : " ")
4564 . " No debugging (recommended in production environments)\n";
4565 print "1 " . ($sm_debug_mode & 1 ? "y" : " ")
4566 . " Simple debugging (PHP E_ERROR)\n";
4567 print "2 " . ($sm_debug_mode & 512 ? "y" : " ")
4568 . " Moderate debugging (PHP E_ALL)\n";
4569 print "3 " . ($sm_debug_mode & 524288 ? "y" : " ")
4570 . " Advanced debugging (PHP E_ALL plus log errors\n";
4571 print " intentionally suppressed)\n";
4572 print "4 " . ($sm_debug_mode & 536870912 ? "y" : " ")
4573 . " Strict debugging (PHP E_STRICT)\n";
4574 print "\n";
4575
4576 print "SquirrelMail debug mode (0,1,2,3,4) or d when done? : $WHT";
4577 $input = <STDIN>;
4578 if ( $input eq "d\n" ) {
4579 # nothing
4580 } elsif ($input !~ /^[0-9]+\n$/) {
4581 print "\nInvalid configuration value.\n";
4582 print "\nPress enter to continue...";
4583 $tmp = <STDIN>;
4584 } elsif ( $input == "0\n" ) {
4585 $sm_debug_mode = 0;
4586 } elsif ( $input == "1\n" ) {
4587 if ($sm_debug_mode & 1) {
4588 $sm_debug_mode ^= 1;
4589 } else {
4590 $sm_debug_mode |= 1;
4591 }
4592 } elsif ( $input == "2\n" ) {
4593 if ($sm_debug_mode & 512) {
4594 $sm_debug_mode ^= 512;
4595 } else {
4596 $sm_debug_mode |= 512;
4597 }
4598 } elsif ( $input == "3\n" ) {
4599 if ($sm_debug_mode & 524288) {
4600 $sm_debug_mode ^= 524288;
4601 } else {
4602 $sm_debug_mode |= 524288;
4603 }
4604 } elsif ( $input == "4\n" ) {
4605 if ($sm_debug_mode & 536870912) {
4606 $sm_debug_mode ^= 536870912;
4607 } else {
4608 $sm_debug_mode |= 536870912;
4609 }
4610 } else {
4611 print "\nInvalid configuration value.\n";
4612 print "\nPress enter to continue...";
4613 $tmp = <STDIN>;
4614 }
4615 print "\n";
4616 }
4617 $sm_debug_mode = convert_debug_binary_integer_to_constants($sm_debug_mode);
4618 return $sm_debug_mode;
4619 }
4620
4621 # Secured configuration mode (since 1.5.2)
4622 sub commandB9 {
4623 print "This option allows you to enable \"Secured Configuration\" mode,\n";
4624 print "which will guarantee that certain settings made herein will be\n";
4625 print "made immutable and will not be subject to override by either friendly\n";
4626 print "or unfriendly code/plugins. Only a small number of settings herein\n";
4627 print "will be used in this manner - just those that are deemed to be a\n";
4628 print "potential security threat when rouge plugin or other code may be\n";
4629 print "executed inside SquirrelMail.\n";
4630 print "\n";
4631
4632 if ( lc($secured_config) eq 'true' ) {
4633 $default_value = "y";
4634 } else {
4635 $default_value = "n";
4636 }
4637 print "Enable secured configuration mode? (y/n) [$WHT$default_value$NRM]: $WHT";
4638 $secured_config = <STDIN>;
4639 if ( ( $secured_config =~ /^y\n/i ) || ( ( $secured_config =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4640 $secured_config = 'true';
4641 } else {
4642 $secured_config = 'false';
4643 }
4644 return $secured_config;
4645 }
4646
4647 # Set a (non-standard) HTTPS port
4648 sub commandB10 {
4649 print "If you run HTTPS (SSL-secured HTTP) on a non-standard port, you should\n";
4650 print "indicate that port here. Even if you do not, SquirrelMail may still\n";
4651 print "auto-detect secure connections, but it is safer and also very useful\n";
4652 print "for third party plugins if you specify the port number here.\n";
4653 print "\n";
4654 print "Most SquirrelMail administrators will not need to use this setting\n";
4655 print "because most all web servers use port 443 for HTTPS connections, and\n";
4656 print "SquirrelMail assumes 443 unless something else is given here.\n";
4657 print "\n";
4658
4659 print "Enter your HTTPS port [$sq_https_port]: ";
4660 my $tmp = <STDIN>;
4661 $tmp = trim($tmp);
4662 # value is not modified, if user hits Enter or enters space
4663 if ($tmp ne '') {
4664 # make sure that input is numeric
4665 if ($tmp =~ /^\d+$/) {
4666 $sq_https_port = $tmp;
4667 } else {
4668 print "\n";
4669 print "--- INPUT ERROR ---\n";
4670 print "\n";
4671 print "If you want to change this setting, you must enter a number.\n";
4672 print "If you want to keep the original value, just press Enter.\n\n";
4673 print "Press Enter to continue...";
4674 $tmp = <STDIN>;
4675 }
4676 }
4677 return $sq_https_port;
4678 }
4679
4680 # Ignore HTTP_X_FORWARDED_* headers?
4681 sub commandB11 {
4682
4683 if ( lc($sq_ignore_http_x_forwarded_headers) eq 'true' ) {
4684 $default_value = "y";
4685 } else {
4686 $default_value = "n";
4687 }
4688
4689 print "Because HTTP_X_FORWARDED_* headers can be sent by the client and\n";
4690 print "therefore possibly exploited by an outsider, SquirrelMail ignores\n";
4691 print "them by default. If a proxy server or other machine sits between\n";
4692 print "clients and your SquirrelMail server, you can turn this off to\n";
4693 print "tell SquirrelMail to use such headers.\n";
4694 print "\n";
4695
4696 print "Ignore HTTP_X_FORWARDED headers? (y/n) [$WHT$default_value$NRM]: $WHT";
4697 $sq_ignore_http_x_forwarded_headers = <STDIN>;
4698 if ( ( $sq_ignore_http_x_forwarded_headers =~ /^y\n/i ) || ( ( $sq_ignore_http_x_forwarded_headers =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
4699 $sq_ignore_http_x_forwarded_headers = 'true';
4700 } else {
4701 $sq_ignore_http_x_forwarded_headers = 'false';
4702 }
4703 return $sq_ignore_http_x_forwarded_headers;
4704 }
4705
4706 sub save_data {
4707 $tab = " ";
4708 if ( open( CF, ">config.php" ) ) {
4709 print CF "<?php\n";
4710 print CF "\n";
4711
4712 print CF "/**\n";
4713 print CF " * SquirrelMail Configuration File\n";
4714 print CF " * Created using the configure script, conf.pl\n";
4715 print CF " */\n";
4716 print CF "\n";
4717
4718 if ($print_config_version) {
4719 print CF "\$config_version = '$print_config_version';\n";
4720 }
4721 # integer
4722 print CF "\$config_use_color = $config_use_color;\n";
4723 print CF "\n";
4724
4725 # string
4726 print CF "\$org_name = \"$org_name\";\n";
4727 # string
4728 print CF "\$org_logo = " . &change_to_SM_path($org_logo) . ";\n";
4729 $org_logo_width |= 0;
4730 $org_logo_height |= 0;
4731 # string
4732 print CF "\$org_logo_width = '$org_logo_width';\n";
4733 # string
4734 print CF "\$org_logo_height = '$org_logo_height';\n";
4735 # string that can contain variables.
4736 print CF "\$org_title = \"$org_title\";\n";
4737 # string
4738 print CF "\$signout_page = " . &change_to_SM_path($signout_page) . ";\n";
4739 # string
4740 print CF "\$frame_top = '$frame_top';\n";
4741 print CF "\n";
4742
4743 print CF "\$provider_uri = '$provider_uri';\n";
4744 print CF "\n";
4745
4746 print CF "\$provider_name = '$provider_name';\n";
4747 print CF "\n";
4748
4749 # string that can contain variables
4750 print CF "\$motd = \"$motd\";\n";
4751 print CF "\n";
4752
4753 # string
4754 print CF "\$squirrelmail_default_language = '$squirrelmail_default_language';\n";
4755 # string
4756 print CF "\$default_charset = '$default_charset';\n";
4757 # boolean
4758 print CF "\$show_alternative_names = $show_alternative_names;\n";
4759 # boolean
4760 print CF "\$aggressive_decoding = $aggressive_decoding;\n";
4761 # boolean
4762 print CF "\$lossy_encoding = $lossy_encoding;\n";
4763 print CF "\n";
4764
4765 # string
4766 print CF "\$domain = '$domain';\n";
4767 # string
4768 print CF "\$imapServerAddress = '$imapServerAddress';\n";
4769 # integer
4770 print CF "\$imapPort = $imapPort;\n";
4771 # boolean
4772 print CF "\$useSendmail = $useSendmail;\n";
4773 # string
4774 print CF "\$smtpServerAddress = '$smtpServerAddress';\n";
4775 # integer
4776 print CF "\$smtpPort = $smtpPort;\n";
4777 # string
4778 print CF "\$sendmail_path = '$sendmail_path';\n";
4779 # string
4780 print CF "\$sendmail_args = '$sendmail_args';\n";
4781 # boolean
4782 # print CF "\$use_authenticated_smtp = $use_authenticated_smtp;\n";
4783 # boolean
4784 print CF "\$pop_before_smtp = $pop_before_smtp;\n";
4785 # string
4786 print CF "\$pop_before_smtp_host = '$pop_before_smtp_host';\n";
4787 # string
4788 print CF "\$imap_server_type = '$imap_server_type';\n";
4789 # boolean
4790 print CF "\$invert_time = $invert_time;\n";
4791 # string
4792 print CF "\$optional_delimiter = '$optional_delimiter';\n";
4793 # string
4794 print CF "\$encode_header_key = '$encode_header_key';\n";
4795 print CF "\n";
4796
4797 # string
4798 print CF "\$default_folder_prefix = '$default_folder_prefix';\n";
4799 # string
4800 print CF "\$trash_folder = '$trash_folder';\n";
4801 # string
4802 print CF "\$sent_folder = '$sent_folder';\n";
4803 # string
4804 print CF "\$draft_folder = '$draft_folder';\n";
4805 # boolean
4806 print CF "\$default_move_to_trash = $default_move_to_trash;\n";
4807 # boolean
4808 print CF "\$default_move_to_sent = $default_move_to_sent;\n";
4809 # boolean
4810 print CF "\$default_save_as_draft = $default_save_as_draft;\n";
4811 # boolean
4812 print CF "\$show_prefix_option = $show_prefix_option;\n";
4813 # boolean
4814 print CF "\$list_special_folders_first = $list_special_folders_first;\n";
4815 # boolean
4816 print CF "\$use_special_folder_color = $use_special_folder_color;\n";
4817 # boolean
4818 print CF "\$auto_expunge = $auto_expunge;\n";
4819 # boolean
4820 print CF "\$default_sub_of_inbox = $default_sub_of_inbox;\n";
4821 # boolean
4822 print CF "\$show_contain_subfolders_option = $show_contain_subfolders_option;\n";
4823 # integer
4824 print CF "\$default_unseen_notify = $default_unseen_notify;\n";
4825 # integer
4826 print CF "\$default_unseen_type = $default_unseen_type;\n";
4827 # boolean
4828 print CF "\$auto_create_special = $auto_create_special;\n";
4829 # boolean
4830 print CF "\$delete_folder = $delete_folder;\n";
4831 # boolean
4832 print CF "\$noselect_fix_enable = $noselect_fix_enable;\n";
4833
4834 print CF "\n";
4835
4836 # string
4837 print CF "\$data_dir = " . &change_to_SM_path($data_dir) . ";\n";
4838 # string that can contain a variable
4839 print CF "\$attachment_dir = " . &change_to_SM_path($attachment_dir) . ";\n";
4840 # integer
4841 print CF "\$dir_hash_level = $dir_hash_level;\n";
4842 # string
4843 print CF "\$default_left_size = '$default_left_size';\n";
4844 # boolean
4845 print CF "\$force_username_lowercase = $force_username_lowercase;\n";
4846 # boolean
4847 print CF "\$default_use_priority = $default_use_priority;\n";
4848 # boolean
4849 print CF "\$hide_sm_attributions = $hide_sm_attributions;\n";
4850 # boolean
4851 print CF "\$default_use_mdn = $default_use_mdn;\n";
4852 # boolean
4853 print CF "\$edit_identity = $edit_identity;\n";
4854 # boolean
4855 print CF "\$edit_name = $edit_name;\n";
4856 # boolean
4857 print CF "\$hide_auth_header = $hide_auth_header;\n";
4858 # boolean
4859 print CF "\$disable_thread_sort = $disable_thread_sort;\n";
4860 # boolean
4861 print CF "\$disable_server_sort = $disable_server_sort;\n";
4862 # boolean
4863 print CF "\$allow_charset_search = $allow_charset_search;\n";
4864 # integer
4865 print CF "\$allow_advanced_search = $allow_advanced_search;\n";
4866 print CF "\n";
4867 # integer
4868 print CF "\$time_zone_type = $time_zone_type;\n";
4869 print CF "\n";
4870 # string
4871 print CF "\$config_location_base = '$config_location_base';\n";
4872 print CF "\n";
4873 # boolean
4874 print CF "\$disable_plugins = $disable_plugins;\n";
4875 # string
4876 print CF "\$disable_plugins_user = '$disable_plugins_user';\n";
4877 print CF "\n";
4878
4879 # all plugins are strings
4880 for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
4881 print CF "\$plugins[] = '$plugins[$ct]';\n";
4882 }
4883 print CF "\n";
4884
4885 # strings
4886 if ( $user_theme_default eq '' ) { $user_theme_default = '0'; }
4887 print CF "\$user_theme_default = $user_theme_default;\n";
4888
4889 for ( $count = 0 ; $count <= $#user_theme_name ; $count++ ) {
4890 if ($user_theme_path[$count] eq 'none') {
4891 $path = '\'none\'';
4892 } else {
4893 $path = &change_to_SM_path($user_theme_path[$count]);
4894 }
4895 print CF "\$user_themes[$count]['PATH'] = " . $path . ";\n";
4896 # escape theme name so it can contain single quotes.
4897 $esc_name = $user_theme_name[$count];
4898 $esc_name =~ s/\\/\\\\/g;
4899 $esc_name =~ s/'/\\'/g;
4900 print CF "\$user_themes[$count]['NAME'] = '$esc_name';\n";
4901 }
4902 print CF "\n";
4903
4904 if ( $icon_theme_def eq '' ) { $icon_theme_def = '0'; }
4905 print CF "\$icon_theme_def = $icon_theme_def;\n";
4906 if ( $icon_theme_fallback eq '' ) { $icon_theme_fallback = '0'; }
4907 print CF "\$icon_theme_fallback = $icon_theme_fallback;\n";
4908
4909 for ( $count = 0 ; $count <= $#icon_theme_name ; $count++ ) {
4910 $path = $icon_theme_path[$count];
4911 if ($path eq 'none' || $path eq 'template') {
4912 $path = "'".$path."'";
4913 } else {
4914 $path = &change_to_SM_path($icon_theme_path[$count]);
4915 }
4916 print CF "\$icon_themes[$count]['PATH'] = " . $path . ";\n";
4917 # escape theme name so it can contain single quotes.
4918 $esc_name = $icon_theme_name[$count];
4919 $esc_name =~ s/\\/\\\\/g;
4920 $esc_name =~ s/'/\\'/g;
4921 print CF "\$icon_themes[$count]['NAME'] = '$esc_name';\n";
4922 }
4923 print CF "\n";
4924
4925 if ( $templateset_default eq '' ) { $templateset_default = 'default'; }
4926 print CF "\$templateset_default = '$templateset_default';\n";
4927
4928 if ( $templateset_fallback eq '' ) { $templateset_fallback = 'default'; }
4929 print CF "\$templateset_fallback = '$templateset_fallback';\n";
4930
4931 if ( $rpc_templateset eq '' ) { $rpc_templateset = 'default_rpc'; }
4932 print CF "\$rpc_templateset = '$rpc_templateset';\n";
4933
4934 for ( $count = 0 ; $count <= $#templateset_name ; $count++ ) {
4935
4936 # don't include RPC template sets
4937 #
4938 if ( $templateset_id[$count] =~ /_rpc$/ ) { next; }
4939
4940 print CF "\$aTemplateSet[$count]['ID'] = '" . $templateset_id[$count] . "';\n";
4941 # escape theme name so it can contain single quotes.
4942 $esc_name = $templateset_name[$count];
4943 $esc_name =~ s/\\/\\\\/g;
4944 $esc_name =~ s/'/\\'/g;
4945 print CF "\$aTemplateSet[$count]['NAME'] = '$esc_name';\n";
4946 }
4947 print CF "\n";
4948
4949
4950 # integer
4951 print CF "\$default_fontsize = '$default_fontsize';\n";
4952 # string
4953 print CF "\$default_fontset = '$default_fontset';\n";
4954 print CF "\n";
4955 # assoc. array (maybe initial value should be set somewhere else)
4956 print CF '$fontsets = array();'."\n";
4957 while (($fontset_name, $fontset_value) = each(%fontsets)) {
4958 print CF "\$fontsets\['$fontset_name'\] = '$fontset_value';\n";
4959 }
4960 print CF "\n";
4961
4962 ## Address books
4963 # boolean
4964 print CF "\$default_use_javascript_addr_book = $default_use_javascript_addr_book;\n";
4965 for ( $count = 0 ; $count <= $#ldap_host ; $count++ ) {
4966 print CF "\$ldap_server[$count] = array(\n";
4967 # string
4968 print CF " 'host' => '$ldap_host[$count]',\n";
4969 # string
4970 print CF " 'base' => '$ldap_base[$count]'";
4971 if ( $ldap_name[$count] ) {
4972 print CF ",\n";
4973 # string
4974 print CF " 'name' => '$ldap_name[$count]'";
4975 }
4976 if ( $ldap_port[$count] ) {
4977 print CF ",\n";
4978 # integer
4979 print CF " 'port' => $ldap_port[$count]";
4980 }
4981 if ( $ldap_charset[$count] ) {
4982 print CF ",\n";
4983 # string
4984 print CF " 'charset' => '$ldap_charset[$count]'";
4985 }
4986 if ( $ldap_maxrows[$count] ) {
4987 print CF ",\n";
4988 # integer
4989 print CF " 'maxrows' => $ldap_maxrows[$count]";
4990 }
4991 # string
4992 if ( $ldap_filter[$count] ) {
4993 print CF ",\n";
4994 print CF " 'filter' => '$ldap_filter[$count]'";
4995 }
4996 if ( $ldap_binddn[$count] ) {
4997 print CF ",\n";
4998 # string
4999 print CF " 'binddn' => '$ldap_binddn[$count]'";
5000 if ( $ldap_bindpw[$count] ) {
5001 print CF ",\n";
5002 # string
5003 print CF " 'bindpw' => '$ldap_bindpw[$count]'";
5004 }
5005 }
5006 if ( $ldap_protocol[$count] ) {
5007 print CF ",\n";
5008 # integer
5009 print CF " 'protocol' => $ldap_protocol[$count]";
5010 }
5011 if ( $ldap_limit_scope[$count] ) {
5012 print CF ",\n";
5013 # boolean
5014 print CF " 'limit_scope' => $ldap_limit_scope[$count]";
5015 }
5016 if ( $ldap_listing[$count] ) {
5017 print CF ",\n";
5018 # boolean
5019 print CF " 'listing' => $ldap_listing[$count]";
5020 }
5021 if ( $ldap_writeable[$count] ) {
5022 print CF ",\n";
5023 # boolean
5024 print CF " 'writeable' => $ldap_writeable[$count]";
5025 }
5026 if ( $ldap_search_tree[$count] ) {
5027 print CF ",\n";
5028 # integer
5029 print CF " 'search_tree' => $ldap_search_tree[$count]";
5030 }
5031 if ( $ldap_listing[$count] ) {
5032 print CF ",\n";
5033 # boolean
5034 print CF " 'starttls' => $ldap_starttls[$count]";
5035 }
5036 print CF "\n";
5037 print CF ");\n";
5038 print CF "\n";
5039 }
5040
5041 # string
5042 print CF "\$addrbook_dsn = '$addrbook_dsn';\n";
5043 # string
5044 print CF "\$addrbook_table = '$addrbook_table';\n\n";
5045 # string
5046 print CF "\$prefs_dsn = '$prefs_dsn';\n";
5047 # string
5048 print CF "\$prefs_table = '$prefs_table';\n";
5049 # string
5050 print CF "\$prefs_user_field = '$prefs_user_field';\n";
5051 # integer
5052 print CF "\$prefs_user_size = $prefs_user_size;\n";
5053 # string
5054 print CF "\$prefs_key_field = '$prefs_key_field';\n";
5055 # integer
5056 print CF "\$prefs_key_size = $prefs_key_size;\n";
5057 # string
5058 print CF "\$prefs_val_field = '$prefs_val_field';\n";
5059 # integer
5060 print CF "\$prefs_val_size = $prefs_val_size;\n\n";
5061 # string
5062 print CF "\$addrbook_global_dsn = '$addrbook_global_dsn';\n";
5063 # string
5064 print CF "\$addrbook_global_table = '$addrbook_global_table';\n";
5065 # boolean
5066 print CF "\$addrbook_global_writeable = $addrbook_global_writeable;\n";
5067 # boolean
5068 print CF "\$addrbook_global_listing = $addrbook_global_listing;\n\n";
5069 # string
5070 print CF "\$abook_global_file = '$abook_global_file';\n";
5071 # boolean
5072 print CF "\$abook_global_file_writeable = $abook_global_file_writeable;\n\n";
5073 # boolean
5074 print CF "\$abook_global_file_listing = $abook_global_file_listing;\n\n";
5075 # integer
5076 print CF "\$abook_file_line_length = $abook_file_line_length;\n\n";
5077 # boolean
5078 print CF "\$no_list_for_subscribe = $no_list_for_subscribe;\n";
5079
5080 # string
5081 print CF "\$smtp_auth_mech = '$smtp_auth_mech';\n";
5082 print CF "\$smtp_sitewide_user = '". quote_single($smtp_sitewide_user) ."';\n";
5083 print CF "\$smtp_sitewide_pass = '". quote_single($smtp_sitewide_pass) ."';\n";
5084 # string
5085 print CF "\$imap_auth_mech = '$imap_auth_mech';\n";
5086 # boolean
5087 print CF "\$use_imap_tls = $use_imap_tls;\n";
5088 # boolean
5089 print CF "\$use_smtp_tls = $use_smtp_tls;\n";
5090 # string
5091 print CF "\$session_name = '$session_name';\n";
5092 # boolean
5093 print CF "\$only_secure_cookies = $only_secure_cookies;\n";
5094
5095 print CF "\n";
5096
5097 # boolean
5098 print CF "\$use_iframe = $use_iframe;\n";
5099 # boolean
5100 print CF "\$ask_user_info = $ask_user_info;\n";
5101 # boolean
5102 print CF "\$use_icons = $use_icons;\n";
5103 print CF "\n";
5104 # boolean
5105 print CF "\$use_php_recode = $use_php_recode;\n";
5106 # boolean
5107 print CF "\$use_php_iconv = $use_php_iconv;\n";
5108 print CF "\n";
5109 # boolean
5110 print CF "\$buffer_output = $buffer_output;\n";
5111 print CF "\n";
5112 # boolean
5113 print CF "\$allow_remote_configtest = $allow_remote_configtest;\n";
5114 print CF "\$secured_config = $secured_config;\n";
5115 # integer
5116 print CF "\$sq_https_port = $sq_https_port;\n";
5117 # boolean
5118 print CF "\$sq_ignore_http_x_forwarded_headers = $sq_ignore_http_x_forwarded_headers;\n";
5119 # (binary) integer or constant - convert integer
5120 # values to constants before output
5121 $sm_debug_mode = convert_debug_binary_integer_to_constants($sm_debug_mode);
5122 print CF "\$sm_debug_mode = $sm_debug_mode;\n";
5123 print CF "\n";
5124
5125 close CF;
5126
5127 print "Data saved in config.php\n";
5128
5129 build_plugin_hook_array();
5130
5131 } else {
5132 print "Error saving config.php: $!\n";
5133 }
5134 }
5135
5136 sub set_defaults {
5137 clear_screen();
5138 print $WHT. "SquirrelMail Configuration : " . $NRM;
5139 if ( $config == 1 ) { print "Read: config.php"; }
5140 elsif ( $config == 2 ) { print "Read: config_default.php"; }
5141 print "\n";
5142 print "---------------------------------------------------------\n";
5143
5144 print "While we have been building SquirrelMail, we have discovered some\n";
5145 print "preferences that work better with some servers that don't work so\n";
5146 print "well with others. If you select your IMAP server, this option will\n";
5147 print "set some pre-defined settings for that server.\n";
5148 print "\n";
5149 print "Please note that you will still need to go through and make sure\n";
5150 print "everything is correct. This does not change everything. There are\n";
5151 print "only a few settings that this will change.\n";
5152 print "\n";
5153
5154 $continue = 0;
5155 while ( $continue != 1 ) {
5156 print "Please select your IMAP server:\n";
5157 print $list_supported_imap_servers;
5158 print "\n";
5159 print " quit = Do not change anything\n";
5160 print "\n";
5161 print "Command >> ";
5162 $server = <STDIN>;
5163 $server =~ s/[\r\n]//g;
5164
5165 # variable is used to display additional messages.
5166 $message = "";
5167
5168 print "\n";
5169 if ( $server eq "cyrus" ) {
5170 $imap_server_type = "cyrus";
5171 $default_folder_prefix = "";
5172 $trash_folder = "INBOX.Trash";
5173 $sent_folder = "INBOX.Sent";
5174 $draft_folder = "INBOX.Drafts";
5175 $show_prefix_option = false;
5176 $default_sub_of_inbox = true;
5177 $show_contain_subfolders_option = false;
5178 $optional_delimiter = ".";
5179 $disp_default_folder_prefix = "<none>";
5180 $force_username_lowercase = false;
5181
5182 # Delimiter might differ if unixhierarchysep is set to yes.
5183 $message = "\nIf you have enabled unixhierarchysep, you must change delimiter and special folder names.\n";
5184
5185 $continue = 1;
5186 } elsif ( $server eq "uw" ) {
5187 $imap_server_type = "uw";
5188 $default_folder_prefix = "mail/";
5189 $trash_folder = "Trash";
5190 $sent_folder = "Sent";
5191 $draft_folder = "Drafts";
5192 $show_prefix_option = true;
5193 $default_sub_of_inbox = false;
5194 $show_contain_subfolders_option = true;
5195 $optional_delimiter = "/";
5196 $disp_default_folder_prefix = $default_folder_prefix;
5197 $delete_folder = true;
5198 $force_username_lowercase = true;
5199
5200 $continue = 1;
5201 } elsif ( $server eq "exchange" ) {
5202 $imap_server_type = "exchange";
5203 $default_folder_prefix = "";
5204 $default_sub_of_inbox = true;
5205 $trash_folder = "INBOX/Deleted Items";
5206 $sent_folder = "INBOX/Sent Items";
5207 $drafts_folder = "INBOX/Drafts";
5208 $show_prefix_option = false;
5209 $show_contain_subfolders_option = false;
5210 $optional_delimiter = "detect";
5211 $disp_default_folder_prefix = "<none>";
5212 $force_username_lowercase = true;
5213
5214 $continue = 1;
5215 } elsif ( $server eq "courier" ) {
5216 $imap_server_type = "courier";
5217 $default_folder_prefix = "INBOX.";
5218 $trash_folder = "Trash";
5219 $sent_folder = "Sent";
5220 $draft_folder = "Drafts";
5221 $show_prefix_option = false;
5222 $default_sub_of_inbox = false;
5223 $show_contain_subfolders_option = false;
5224 $optional_delimiter = ".";
5225 $disp_default_folder_prefix = $default_folder_prefix;
5226 $delete_folder = true;
5227 $force_username_lowercase = false;
5228
5229 $continue = 1;
5230 } elsif ( $server eq "macosx" ) {
5231 $imap_server_type = "macosx";
5232 $default_folder_prefix = "INBOX/";
5233 $trash_folder = "Trash";
5234 $sent_folder = "Sent";
5235 $draft_folder = "Drafts";
5236 $show_prefix_option = false;
5237 $default_sub_of_inbox = true;
5238 $show_contain_subfolders_option = false;
5239 $optional_delimiter = "detect";
5240 $allow_charset_search = false;
5241 $disp_default_folder_prefix = $default_folder_prefix;
5242
5243 $continue = 1;
5244 } elsif ( $server eq "hmailserver" ) {
5245 $imap_server_type = "hmailserver";
5246 $default_folder_prefix = "";
5247 $trash_folder = "INBOX.Trash";
5248 $sent_folder = "INBOX.Sent";
5249 $draft_folder = "INBOX.Drafts";
5250 $show_prefix_option = false;
5251 $default_sub_of_inbox = true;
5252 $show_contain_subfolders_option = false;
5253 $optional_delimiter = "detect";
5254 $allow_charset_search = false;
5255 $disp_default_folder_prefix = $default_folder_prefix;
5256 $delete_folder = false;
5257 $force_username_lowercase = false;
5258
5259 $continue = 1;
5260 } elsif ( $server eq "mercury32" ) {
5261 $imap_server_type = "mercury32";
5262 $default_folder_prefix = "";
5263 $trash_folder = "Trash";
5264 $sent_folder = "Sent";
5265 $draft_folder = "Drafts";
5266 $show_prefix_option = false;
5267 $default_sub_of_inbox = true;
5268 $show_contain_subfolders_option = true;
5269 $optional_delimiter = "detect";
5270 $delete_folder = true;
5271 $force_username_lowercase = true;
5272
5273 $continue = 1;
5274 } elsif ( $server eq "dovecot" ) {
5275 $imap_server_type = "dovecot";
5276 $default_folder_prefix = "";
5277 $trash_folder = "Trash";
5278 $sent_folder = "Sent";
5279 $draft_folder = "Drafts";
5280 $show_prefix_option = false;
5281 $default_sub_of_inbox = false;
5282 $show_contain_subfolders_option = false;
5283 $delete_folder = false;
5284 $force_username_lowercase = true;
5285 $optional_delimiter = "detect";
5286 $disp_default_folder_prefix = "<none>";
5287
5288 $continue = 1;
5289 } elsif ( $server eq "bincimap" ) {
5290 $imap_server_type = "bincimap";
5291 $default_folder_prefix = "INBOX/";
5292 $trash_folder = "Trash";
5293 $sent_folder = "Sent";
5294 $draft_folder = "Drafts";
5295 $show_prefix_option = false;
5296 $default_sub_of_inbox = false;
5297 $show_contain_subfolders_option = false;
5298 $delete_folder = true;
5299 $force_username_lowercase = false;
5300 $optional_delimiter = "detect";
5301 $disp_default_folder_prefix = $default_folder_prefix;
5302
5303 # Default folder prefix depends on used depot.
5304 $message = "\nIf you use IMAPdir depot, you must set default folder prefix to empty string.\n";
5305
5306 $continue = 1;
5307 } elsif ( $server eq "quit" ) {
5308 $continue = 1;
5309 } else {
5310 $disp_default_folder_prefix = $default_folder_prefix;
5311 print "Unrecognized server: $server\n";
5312 print "\n";
5313 }
5314
5315 print " imap_server_type = $imap_server_type\n";
5316 print " default_folder_prefix = $disp_default_folder_prefix\n";
5317 print " trash_folder = $trash_folder\n";
5318 print " sent_folder = $sent_folder\n";
5319 print " draft_folder = $draft_folder\n";
5320 print " show_prefix_option = $show_prefix_option\n";
5321 print " default_sub_of_inbox = $default_sub_of_inbox\n";
5322 print "show_contain_subfolders_option = $show_contain_subfolders_option\n";
5323 print " optional_delimiter = $optional_delimiter\n";
5324 print " delete_folder = $delete_folder\n";
5325 print " force_username_lowercase = $force_username_lowercase\n";
5326
5327 print "$message";
5328 }
5329 print "\nPress enter to continue...";
5330 $tmp = <STDIN>;
5331 }
5332
5333 # This subroutine corrects relative paths to ensure they
5334 # will work within the SM space. If the path falls within
5335 # the SM directory tree, the SM_PATH variable will be
5336 # prepended to the path, if not, then the path will be
5337 # converted to an absolute path, e.g.
5338 # '../images/logo.gif' --> SM_PATH . 'images/logo.gif'
5339 # '../../someplace/data' --> '/absolute/path/someplace/data'
5340 # 'images/logo.gif' --> SM_PATH . 'config/images/logo.gif'
5341 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
5342 # 'http://whatever/' --> 'http://whatever'
5343 # $some_var/path --> "$some_var/path"
5344 sub change_to_SM_path() {
5345 my ($old_path) = @_;
5346 my $new_path = '';
5347 my @rel_path;
5348 my @abs_path;
5349 my $subdir;
5350
5351 # If the path is absolute, don't bother.
5352 return "\'" . $old_path . "\'" if ( $old_path eq '');
5353 return "\'" . $old_path . "\'" if ( $old_path =~ /^(\/|http)/ );
5354 return "\'" . $old_path . "\'" if ( $old_path =~ /^\w:\// );
5355 return $old_path if ( $old_path =~ /^\'(\/|http)/ );
5356 return $old_path if ( $old_path =~ /^\'\w:\// );
5357 return $old_path if ( $old_path =~ /^SM_PATH/);
5358
5359 if ( $old_path =~ /^\$/ ) {
5360 # check if it's a single var, or a $var/path combination
5361 # if it's $var/path, enclose in ""
5362 if ( $old_path =~ /\// ) {
5363 return '"'.$old_path.'"';
5364 }
5365 return $old_path;
5366 }
5367
5368 # Remove remaining '
5369 $old_path =~ s/\'//g;
5370
5371 # For relative paths, split on '../'
5372 @rel_path = split(/\.\.\//, $old_path);
5373
5374 if ( $#rel_path > 1 ) {
5375 # more than two levels away. Make it absolute.
5376 @abs_path = split(/\//, $dir);
5377
5378 # Lop off the relative pieces of the absolute path..
5379 for ( $i = 0; $i <= $#rel_path; $i++ ) {
5380 pop @abs_path;
5381 shift @rel_path;
5382 }
5383 push @abs_path, @rel_path;
5384 $new_path = "\'" . join('/', @abs_path) . "\'";
5385 } elsif ( $#rel_path > 0 ) {
5386 # it's within the SM tree, prepend SM_PATH
5387 $new_path = $old_path;
5388 $new_path =~ s/^\.\.\//SM_PATH . \'/;
5389 $new_path .= "\'";
5390 } else {
5391 # Last, it's a relative path without any leading '.'
5392 # Prepend SM_PATH and config, since the paths are
5393 # relative to the config directory
5394 $new_path = "SM_PATH . \'config/" . $old_path . "\'";
5395 }
5396 return $new_path;
5397 }
5398
5399
5400 # Change SM_PATH to admin-friendly version, e.g.:
5401 # SM_PATH . 'images/logo.gif' --> '../images/logo.gif'
5402 # SM_PATH . 'config/some.php' --> 'some.php'
5403 # '/absolute/path/logo.gif' --> '/absolute/path/logo.gif'
5404 # 'http://whatever/' --> 'http://whatever'
5405 sub change_to_rel_path() {
5406 my ($old_path) = @_;
5407 my $new_path = $old_path;
5408
5409 if ( $old_path =~ /^SM_PATH/ ) {
5410 # FIXME: the following replacement loses the opening quote mark!
5411 $new_path =~ s/^SM_PATH . \'/\.\.\//;
5412 $new_path =~ s/\.\.\/config\///;
5413 }
5414
5415 return $new_path;
5416 }
5417
5418 # Attempts to auto-detect if a specific auth mechanism is supported.
5419 # Called by 'command112a' and 'command112b'
5420 # ARGS: service-name (IMAP or SMTP), host:port, mech-name (ie. CRAM-MD5)
5421 sub detect_auth_support {
5422 # Try loading IO::Socket
5423 unless (eval("use IO::Socket; 1")) {
5424 print "Perl IO::Socket module is not available.";
5425 return undef;
5426 }
5427 # Misc setup
5428 my $service = shift;
5429 my $host = shift;
5430 my $mech = shift;
5431 # Sanity checks
5432 if ((!defined($service)) or (!defined($host)) or (!defined($mech))) {
5433 # Error - wrong # of args
5434 print "BAD ARGS!\n";
5435 return undef;
5436 }
5437
5438 if ($service eq 'SMTP') {
5439 $cmd = "AUTH $mech\r\n";
5440 $logout = "QUIT\r\n";
5441 } elsif ($service eq 'IMAP') {
5442 $cmd = "A01 AUTHENTICATE $mech\n";
5443 $logout = "C01 LOGOUT\n";
5444 } else {
5445 # unknown service - whoops.
5446 return undef;
5447 }
5448
5449 # Get this show on the road
5450 my $sock=IO::Socket::INET->new($host);
5451 if (!defined($sock)) {
5452 # Connect failed
5453 return undef;
5454 }
5455 my $discard = <$sock>; # Server greeting/banner - who cares..
5456
5457 if ($service eq 'SMTP') {
5458 # Say hello first..
5459 print $sock "HELO $domain\r\n";
5460 $discard = <$sock>; # Yeah yeah, you're happy to see me..
5461 }
5462 print $sock $cmd;
5463
5464 my $response = <$sock>;
5465 chomp($response);
5466 if (!defined($response)) {
5467 return undef;
5468 }
5469
5470 # So at this point, we have a response, and it is (hopefully) valid.
5471 if ($service eq 'SMTP') {
5472 if (!($response =~ /^334/)) {
5473 # Not supported
5474 print $sock $logout;
5475 close $sock;
5476 return 'NO';
5477 }
5478 } elsif ($service eq 'IMAP') {
5479 if ($response =~ /^A01/) {
5480 # Not supported
5481 print $sock $logout;
5482 close $sock;
5483 return 'NO';
5484 }
5485 } else {
5486 # Unknown service - this shouldn't be able to happen.
5487 close $sock;
5488 return undef;
5489 }
5490
5491 # If it gets here, the mech is supported
5492 print $sock "*\n"; # Attempt to cancel authentication
5493 print $sock $logout; # Try to log out, but we don't really care if this fails
5494 close $sock;
5495 return 'YES';
5496 }
5497
5498 # trims whitespace
5499 # Example code from O'Reilly Perl Cookbook
5500 sub trim {
5501 my @out = @_;
5502 for (@out) {
5503 s/^\s+//;
5504 s/\s+$//;
5505 }
5506 return wantarray ? @out : $out[0];
5507 }
5508
5509 sub clear_screen() {
5510 if ( $^O =~ /^mswin/i) {
5511 system "cls";
5512 } else {
5513 system "clear";
5514 }
5515 }
5516
5517 # checks IMAP mailbox name. Refuses to accept 8bit folders
5518 # returns 0 (folder name is not correct) or 1 (folder name is correct)
5519 sub check_imap_folder($) {
5520 my $folder_name = shift(@_);
5521
5522 if ($folder_name =~ /[\x80-\xFFFF]/) {
5523 print "Folder name contains 8bit characters. Configuration utility requires\n";
5524 print "UTF7-IMAP encoded folder names.\n";
5525 print "Press enter to continue...";
5526 my $tmp = <STDIN>;
5527 return 0;
5528 } elsif ($folder_name =~ /[&\*\%]/) {
5529 # check for ampersand and list-wildcards
5530 print "Folder name contains special UTF7-IMAP characters.\n";
5531 print "Are you sure that folder name is correct? (y/N): ";
5532 my $tmp = <STDIN>;
5533 $tmp = lc(trim($tmp));
5534 if ($tmp =~ /^y$/) {
5535 return 1;
5536 } else {
5537 return 0;
5538 }
5539 } else {
5540 return 1;
5541 }
5542 }
5543
5544 # quotes string written in single quotes
5545 sub quote_single($) {
5546 my $string = shift(@_);
5547 $string =~ s/\'/\\'/g;
5548 return $string;
5549 }
5550
5551 # determine a plugin's version number
5552 #
5553 # parses the setup.php file, looking for the
5554 # version string in the <plugin>_info() or the
5555 # <plugin>_version functions.
5556 #
5557 sub get_plugin_version() {
5558
5559 my $plugin_name = shift(@_);
5560
5561 $setup_file = '../plugins/' . $plugin_name . '/setup.php';
5562 if ( -e "$setup_file" ) {
5563 # Make sure that file is readable
5564 if (! -r "$setup_file") {
5565 print "\n";
5566 print "WARNING:\n";
5567 print "The file \"$setup_file\" was found, but you don't\n";
5568 print "have rights to read it. The plugin \"";
5569 print $plugin_name . "\" may not work correctly until you fix this.\n";
5570 print "\nPress enter to continue";
5571 $ctu = <STDIN>;
5572 print "\n";
5573 next;
5574 }
5575
5576 $version = ' ';
5577 # FIXME: grep the file instead of reading it into memory?
5578 $whole_file = '';
5579 open( FILE, "$setup_file" );
5580 while ( $line = <FILE> ) {
5581 $whole_file .= $line;
5582 }
5583 close(FILE);
5584
5585 # ideally, there is a version in the <plugin>_info function...
5586 #
5587 if ($whole_file =~ /('version'\s*=>\s*['"](.*?)['"])/) {
5588 $version .= $2;
5589
5590 # this assumes there is only one function that returns
5591 # a static string in the setup file
5592 #
5593 } elsif ($whole_file =~ /(return\s*['"](.*?)['"])/) {
5594 $version .= $2;
5595 }
5596
5597 return $version;
5598
5599 } else {
5600 print "\n";
5601 print "WARNING:\n";
5602 print "The file \"$setup_file\" was not found.\n";
5603 print "The plugin \"" . $plugin_name;
5604 print "\" may not work correctly until you fix this.\n";
5605 print "\nPress enter to continue";
5606 $ctu = <STDIN>;
5607 print "\n";
5608 next;
5609 }
5610
5611 }
5612
5613 # determine a plugin's English name
5614 #
5615 # parses the setup.php file, looking for the
5616 # English name in the <plugin>_info() function.
5617 #
5618 sub get_plugin_english_name() {
5619
5620 my $plugin_name = shift(@_);
5621
5622 $setup_file = '../plugins/' . $plugin_name . '/setup.php';
5623 if ( -e "$setup_file" ) {
5624 # Make sure that file is readable
5625 if (! -r "$setup_file") {
5626 print "\n";
5627 print "WARNING:\n";
5628 print "The file \"$setup_file\" was found, but you don't\n";
5629 print "have rights to read it. The plugin \"";
5630 print $plugin_name . "\" may not work correctly until you fix this.\n";
5631 print "\nPress enter to continue";
5632 $ctu = <STDIN>;
5633 print "\n";
5634 next;
5635 }
5636
5637 $english_name = '';
5638 # FIXME: grep the file instead of reading it into memory?
5639 $whole_file = '';
5640 open( FILE, "$setup_file" );
5641 while ( $line = <FILE> ) {
5642 $whole_file .= $line;
5643 }
5644 close(FILE);
5645
5646 # the English name is in the <plugin>_info function or nothing...
5647 #
5648 if ($whole_file =~ /('english_name'\s*=>\s*['"](.*?)['"])/) {
5649 $english_name .= $2;
5650 }
5651
5652 return $english_name;
5653
5654 } else {
5655 print "\n";
5656 print "WARNING:\n";
5657 print "The file \"$setup_file\" was not found.\n";
5658 print "The plugin \"" . $plugin_name;
5659 print "\" may not work correctly until you fix this.\n";
5660 print "\nPress enter to continue";
5661 $ctu = <STDIN>;
5662 print "\n";
5663 next;
5664 }
5665
5666 }
5667
5668 # parses the setup.php files for all activated plugins and
5669 # builds static plugin hooks array so we don't have to load
5670 # ALL plugins are runtime and build the hook array on every
5671 # page request
5672 #
5673 # hook array is saved in config/plugin_hooks.php
5674 #
5675 # Note the $verbose variable at the top of this routine
5676 # can be set to zero to quiet it down.
5677 #
5678 # NOTE/FIXME: we aren't necessarily interested in writing
5679 # a full-blown PHP parsing engine, so plenty
5680 # of assumptions are included herein about the
5681 # coding of the plugin setup files, and things
5682 # like commented out curly braces or other
5683 # such oddities can break this in a bad way.
5684 #
5685 sub build_plugin_hook_array() {
5686
5687 $verbose = 1;
5688
5689 if ($verbose) {
5690 print "\n\n";
5691 }
5692
5693 if ( open( HOOKFILE, ">plugin_hooks.php" ) ) {
5694 print HOOKFILE "<?php\n";
5695 print HOOKFILE "\n";
5696
5697 print HOOKFILE "/**\n";
5698 print HOOKFILE " * SquirrelMail Plugin Hook Registration File\n";
5699 print HOOKFILE " * Auto-generated using the configure script, conf.pl\n";
5700 print HOOKFILE " */\n";
5701 print HOOKFILE "\n";
5702 print HOOKFILE "global \$squirrelmail_plugin_hooks;\n";
5703 print HOOKFILE "\n";
5704
5705 PLUGIN: for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
5706
5707 if ($verbose) {
5708 print "Activating plugin \"" . $plugins[$ct] . "\"...\n";
5709 }
5710
5711 $setup_file = '../plugins/' . $plugins[$ct] . '/setup.php';
5712 if ( -e "$setup_file" ) {
5713 # Make sure that file is readable
5714 if (! -r "$setup_file") {
5715 print "\n";
5716 print "WARNING:\n";
5717 print "The file \"$setup_file\" was found, but you don't\n";
5718 print "have rights to read it. The plugin \"";
5719 print $plugins[$ct] . "\" will not be activated until you fix this.\n";
5720 print "\nPress enter to continue";
5721 $ctu = <STDIN>;
5722 print "\n";
5723 next;
5724 }
5725 open( FILE, "$setup_file" );
5726 $inside_init_fxn = 0;
5727 $brace_count = 0;
5728 while ( $line = <FILE> ) {
5729
5730 # throw away lines until we get to target function
5731 #
5732 if (!$inside_init_fxn
5733 && $line !~ /^\s*function\s*squirrelmail_plugin_init_/i) {
5734 next;
5735 }
5736 $inside_init_fxn = 1;
5737
5738
5739 # count open braces
5740 #
5741 if ($line =~ /{/) {
5742 $brace_count++;
5743 }
5744
5745
5746 # count close braces
5747 #
5748 if ($line =~ /}/) {
5749 $brace_count--;
5750
5751 # leaving <plugin>_init() function...
5752 if ($brace_count == 0) {
5753 close(FILE);
5754 next PLUGIN;
5755 }
5756
5757 }
5758
5759
5760 # throw away lines that are not exactly one "brace set" deep
5761 #
5762 if ($brace_count > 1) {
5763 next;
5764 }
5765
5766
5767 # also not interested in lines that are not
5768 # hook registration points
5769 #
5770 if ($line !~ /^\s*\$squirrelmail_plugin_hooks/i) {
5771 next;
5772 }
5773
5774
5775 # if $line does not have an ending semicolon,
5776 # we need to recursively read in subsequent
5777 # lines until we find one
5778 while ( $line !~ /;\s*$/ ) {
5779 $line =~ s/[\n\r]\s*$//;
5780 $line .= <FILE>;
5781 }
5782
5783
5784 $line =~ s/^\s+//;
5785 $line =~ s/^\$//;
5786 $var = $line;
5787
5788 $var =~ s/=/EQUALS/;
5789 if ( $var =~ /^([a-z])/i ) {
5790 @options = split ( /\s*EQUALS\s*/, $var );
5791 $options[1] =~ s/[\n\r]//g;
5792 $options[1] =~ s/[\'\"];\s*$//;
5793 $options[1] =~ s/;$//;
5794 $options[1] =~ s/^[\'\"]//;
5795 # de-escape escaped strings
5796 $options[1] =~ s/\\'/'/g;
5797 $options[1] =~ s/\\\\/\\/g;
5798
5799 if ( $options[0] =~ /^squirrelmail_plugin_hooks\s*\[\s*['"]([a-z0-9 \/._*-]+)['"]\s*\]\s*\[\s*['"]([0-9a-z._-]+)['"]\s*\]/i ) {
5800 $hook_name = $1;
5801 $hooked_plugin_name = $2;
5802 # Note: if we wanted to stop plugins from registering
5803 # a *different* plugin on a hook, we could catch
5804 # it here, however this has actually proven to be
5805 # a useful *feature*
5806 #if ($hooked_plugin_name ne $plugins[$ct]) {
5807 # print "...plugin is tring to hook in under different name...\n";
5808 #}
5809
5810 #FIXME: do we want to count the number of hook registrations for each plugin and warn if a plugin doesn't have any?
5811 # hook registration has been found!
5812 if ($verbose) {
5813 if ($hooked_plugin_name ne $plugins[$ct]) {
5814 print " registering on hook \"" . $hook_name . "\" (as \"$hooked_plugin_name\" plugin)\n";
5815 } else {
5816 print " registering on hook \"" . $hook_name . "\"\n";
5817 }
5818 }
5819 $line =~ s/ {2,}/ /g;
5820 $line =~ s/=/\n =/;
5821 print HOOKFILE "\$$line";
5822
5823 }
5824
5825 }
5826
5827 }
5828 close(FILE);
5829
5830 } else {
5831 print "\n";
5832 print "WARNING:\n";
5833 print "The file \"$setup_file\" was not found.\n";
5834 print "The plugin \"" . $plugins[$ct];
5835 print "\" will not be activated until you fix this.\n";
5836 print "\nPress enter to continue";
5837 $ctu = <STDIN>;
5838 print "\n";
5839 next;
5840 }
5841
5842 }
5843
5844 print HOOKFILE "\n\n";
5845 close(HOOKFILE);
5846 # if ($verbose) {
5847 print "\nDone activating plugins; registration data saved in plugin_hooks.php\n\n";
5848 # }
5849
5850 } else {
5851
5852 print "\n";
5853 print "WARNING:\n";
5854 print "The file \"plugin_hooks.php\" was not able to be written to.\n";
5855 print "No plugins will be activated until you fix this.\n";
5856 print "\nPress enter to continue";
5857 $ctu = <STDIN>;
5858 print "\n";
5859
5860 }
5861
5862 }
5863
5864 # converts (binary) integer values that correspond
5865 # to the SquirrelMail debug mode constants (see
5866 # include/constants.php) into those constant strings
5867 # (bitwise or'd if more than one is enabled)
5868 #
5869 # if the value passed in is not an integer, it is
5870 # returned unmolested
5871 #
5872 sub convert_debug_binary_integer_to_constants() {
5873
5874 my ($debug_mode) = @_;
5875 if ($debug_mode =~ /^[^0-9]/) {
5876 return $debug_mode;
5877 }
5878 $debug_mode = int($debug_mode);
5879 $new_debug_mode = '';
5880
5881 # per include/constants.php, here are their values:
5882 #
5883 # 0 SM_DEBUG_MODE_OFF
5884 # 1 SM_DEBUG_MODE_SIMPLE
5885 # 512 SM_DEBUG_MODE_MODERATE
5886 # 524288 SM_DEBUG_MODE_ADVANCED
5887 # 536870912 SM_DEBUG_MODE_STRICT
5888 #
5889 if ($debug_mode & 1) {
5890 $new_debug_mode .= ' | SM_DEBUG_MODE_SIMPLE';
5891 }
5892 if ($debug_mode & 512) {
5893 $new_debug_mode .= ' | SM_DEBUG_MODE_MODERATE';
5894 }
5895 if ($debug_mode & 524288) {
5896 $new_debug_mode .= ' | SM_DEBUG_MODE_ADVANCED';
5897 }
5898 if ($debug_mode & 536870912) {
5899 $new_debug_mode .= ' | SM_DEBUG_MODE_STRICT';
5900 }
5901
5902 $new_debug_mode =~ s/^ \| //;
5903 if (!$new_debug_mode) {
5904 $new_debug_mode = 'SM_DEBUG_MODE_OFF';
5905 }
5906
5907 return $new_debug_mode;
5908 }
5909
5910 # converts SquirrelMail debug mode constants (see
5911 # include/constants.php) into their corresponding
5912 # (binary) integer values
5913 #
5914 # if the value passed in is an integer already, it
5915 # is returned unmolested
5916 #
5917 sub convert_debug_constants_to_binary_integer() {
5918
5919 my ($debug_mode) = @_;
5920 if ($debug_mode =~ /^[0-9]/) {
5921 return $debug_mode;
5922 }
5923 $new_debug_mode = 0;
5924
5925 # per include/constants.php, here are their values:
5926 #
5927 # 0 SM_DEBUG_MODE_OFF
5928 # 1 SM_DEBUG_MODE_SIMPLE
5929 # 512 SM_DEBUG_MODE_MODERATE
5930 # 524288 SM_DEBUG_MODE_ADVANCED
5931 # 536870912 SM_DEBUG_MODE_STRICT
5932 #
5933 if ($debug_mode =~ /\bSM_DEBUG_MODE_OFF\b/) {
5934 $new_debug_mode = 0;
5935 }
5936 if ($debug_mode =~ /\bSM_DEBUG_MODE_SIMPLE\b/) {
5937 $new_debug_mode |= 1;
5938 }
5939 if ($debug_mode =~ /\bSM_DEBUG_MODE_MODERATE\b/) {
5940 $new_debug_mode |= 512;
5941 }
5942 if ($debug_mode =~ /\bSM_DEBUG_MODE_ADVANCED\b/) {
5943 $new_debug_mode |= 524288;
5944 }
5945 if ($debug_mode =~ /\bSM_DEBUG_MODE_STRICT\b/) {
5946 $new_debug_mode |= 536870912;
5947 }
5948
5949 return $new_debug_mode;
5950 }
5951
5952 # Function to print n column numbered lists
5953 #
5954 # WARNING: the names in the list will be truncated
5955 # to fit in their respective columns based on the
5956 # screen width and number of columns.
5957 #
5958 # Expected arguments (in this order):
5959 #
5960 # * The start number to use for the list
5961 # * The number of columns to use
5962 # * The screen width
5963 # * Boolean (zero/one), indicating
5964 # whether or not to show item numbers
5965 # * The list of strings to be shown
5966 #
5967 # Returns: The number printed on screen of the last item in the list
5968 #
5969 sub print_multi_col_list {
5970 my ($num, $cols, $screen_width, $show_numbering, @list) = @_;
5971 my $x;
5972 my $col_cnt = 0;
5973 my $row_cnt = 0;
5974 my $rows;
5975 my $col_width;
5976 my $total = 0;
5977 my @layout = ();
5978 my @numbers = ();
5979
5980 $rows = int(@list / $cols);
5981 if (@list % $cols) { $rows++; }
5982 if ($show_numbering) { $col_width = int(($screen_width - 2) / $cols) - 5; }
5983 else { $col_width = int(($screen_width - 2) / $cols) - 2; }
5984
5985 # build the layout array so numbers run down each column
5986 #
5987 for ( $x = 0; $x < @list; $x++ ) {
5988
5989 $layout[$row_cnt][$col_cnt] = $list[$x];
5990 $numbers[$row_cnt][$col_cnt] = $num++;
5991
5992 # move to next column
5993 #
5994 if ($row_cnt == $rows - 1) {
5995 $row_cnt = 0;
5996 $col_cnt++;
5997 }
5998 else { $row_cnt++; }
5999
6000 }
6001
6002 # if we filled up fewer rows than needed, recalc column width
6003 #
6004 if ($rows * $col_cnt == @list) { $col_cnt--; } # loop above ended right after increment
6005 if ($col_cnt + 1 < $cols) {
6006 if ($show_numbering) { $col_width = int(($screen_width - 2) / ($col_cnt + 1)) - 5; }
6007 else { $col_width = int(($screen_width - 2) / ($col_cnt + 1)) - 2; }
6008 }
6009
6010 # print it
6011 # iterate rows
6012 #
6013 for ( $row_cnt = 0; $row_cnt <= $rows; $row_cnt++ ) {
6014
6015 # indent the row
6016 #
6017 print " ";
6018
6019 # iterate columns for this row
6020 #
6021 for ( $col_cnt = 0; $col_cnt <= $cols; $col_cnt++ ) {
6022 if ($layout[$row_cnt][$col_cnt]) {
6023 print " ";
6024 if ($show_numbering) { printf "$WHT% 2u.$NRM", $numbers[$row_cnt][$col_cnt]; }
6025 printf " %-$col_width." . $col_width . "s", $layout[$row_cnt][$col_cnt];
6026 }
6027 }
6028 print "\n";
6029 }
6030
6031
6032 return $num - 1;
6033 }
6034