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