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