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