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