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