#!/usr/bin/env perl
# conf.pl
#
-# Copyright (c) 1999-2006 The SquirrelMail Project Team
+# Copyright (c) 1999-2007 The SquirrelMail Project Team
# Licensed under the GNU GPL. For full terms see COPYING.
#
# A simple configure script to configure SquirrelMail
print "The file \"config/config.php\" was found, but you don't\n";
print "have rights to read it.\n";
print "\n";
- print "Press any key to continue";
+ print "Press enter to continue";
$ctu = <STDIN>;
exit;
}
print " should get the 'config_default.php' that matches the version\n";
print " of SquirrelMail that you are running. You can get this from\n";
print " the SquirrelMail web page by going to the following URL:\n";
- print " http://www.squirrelmail.org.\n";
+ print " http://squirrelmail.org.\n";
print "\n";
print "Continue loading with old config_default.php (a bad idea) [y/N]? ";
$ctu = <STDIN>;
$noselect_fix_enable = 'false' if ( !$noselect_fix_enable );
$frame_top = "_top" if ( !$frame_top );
$provider_uri = '' if ( !$provider_uri );
-$provider_name = '' if ( !$provider_name );
+$provider_name = '' if ( !$provider_name || $provider_name eq 'SquirrelMail');
$no_list_for_subscribe = 'false' if ( !$no_list_for_subscribe );
$allow_charset_search = 'true' if ( !$allow_charset_search );
$allow_advanced_search = 0 if ( !$allow_advanced_search) ;
$use_iframe = 'false' if ( !$use_iframe );
$lossy_encoding = 'false' if ( !$lossy_encoding );
$allow_remote_configtest = 'false' if ( !$allow_remote_configtest );
+$secured_config = 'true' if ( !$secured_config );
+
+$sm_debug_mode = 'SM_DEBUG_MODE_MODERATE' if ( !$sm_debug_mode );
+#FIXME: When this is STABLE software, remove the line above and uncomment the one below:
+#$sm_debug_mode = 'SM_DEBUG_MODE_OFF' if ( !$sm_debug_mode );
+$sm_debug_mode = convert_debug_binary_integer_to_constants($sm_debug_mode);
+
$addrbook_global_table = 'global_abook' if ( !$addrbook_global_table );
$addrbook_global_writeable = 'false' if ( !$addrbook_global_writeable );
$addrbook_global_listing = 'false' if ( !$addrbook_global_listing );
$smtp_sitewide_user = '' if ( !$smtp_sitewide_user );
$smtp_sitewide_pass = '' if ( !$smtp_sitewide_pass );
$icon_theme_def = '' if ( !$icon_theme_def );
+$disable_plugins = 'false' if ( !$disable_plugins );
+$disable_plugins_user = '' if ( !$disable_plugins_user );
+$only_secure_cookies = 'true' if ( !$only_secure_cookies );
+$ask_user_info = 'true' if ( !$ask_user_info );
if ( $ARGV[0] eq '--install-plugin' ) {
print "Activating plugin " . $ARGV[1] . "\n";
- push @plugins, $ARGV[1];
- save_data();
- exit(0);
+ if ( -d "../plugins/" . $ARGV[1]) {
+ push @plugins, $ARGV[1];
+ save_data();
+ exit(0);
+ } else {
+ print "No such plugin.\n";
+ exit(1);
+ }
} elsif ( $ARGV[0] eq '--remove-plugin' ) {
print "Removing plugin " . $ARGV[1] . "\n";
foreach $plugin (@plugins) {
@plugins = @newplugins;
save_data();
exit(0);
+} elsif ( $ARGV[0] eq '--update-plugins' or $ARGV[0] eq '-u') {
+ build_plugin_hook_array();
+ exit(0);
+} elsif ( $ARGV[0] eq '--help' or $ARGV[0] eq '-h') {
+ print "SquirrelMail Configuration Script\n";
+ print "Usage:\n";
+ print " * No arguments: initiates the configuration dialog\n";
+ print " * --install-plugin <plugin> : activates the specified plugin\n";
+ print " * --remove-plugin <plugin> : deactivates the specified plugin\n";
+ print " * --update-plugins , -u : rebuilds plugin_hooks.php according\n";
+ print " to plugins activated in config.php\n";
+ print " * --help , -h : Displays this help\n";
+ print "\n";
+ exit(0);
}
+
+
+####################################################################################
+
+# used in multiple places, define once
+$list_supported_imap_servers =
+ " bincimap = Binc IMAP server\n" .
+ " courier = Courier IMAP server\n" .
+ " cyrus = Cyrus IMAP server\n" .
+ " dovecot = Dovecot Secure IMAP server\n" .
+ " exchange = Microsoft Exchange IMAP server\n" .
+ " hmailserver = hMailServer\n" .
+ " macosx = Mac OS X Mailserver\n" .
+ " mercury32 = Mercury/32\n" .
+ " uw = University of Washington's IMAP server\n";
+
#####################################################################################
if ( $config_use_color == 1 ) {
$WHT = "\x1B[37;1m";
print "5. Signout Page : $WHT$signout_page$NRM\n";
print "6. Top Frame : $WHT$frame_top$NRM\n";
print "7. Provider link : $WHT$provider_uri$NRM\n";
- print "8. Provider name : $WHT$provider_name$NRM\n";
+ print "8. Provider link text : $WHT$provider_name$NRM\n";
print "\n";
print "R Return to Main Menu\n";
print "R Return to Main Menu\n";
} elsif ( $menu == 4 ) {
print $WHT. "General Options\n" . $NRM;
- print "1. Data Directory : $WHT$data_dir$NRM\n";
- print "2. Attachment Directory : $WHT$attachment_dir$NRM\n";
- print "3. Directory Hash Level : $WHT$dir_hash_level$NRM\n";
- print "4. Default Left Size : $WHT$default_left_size$NRM\n";
- print "5. Usernames in Lowercase : $WHT$force_username_lowercase$NRM\n";
- print "6. Allow use of priority : $WHT$default_use_priority$NRM\n";
- print "7. Hide SM attributions : $WHT$hide_sm_attributions$NRM\n";
- print "8. Allow use of receipts : $WHT$default_use_mdn$NRM\n";
- print "9. Allow editing of identity : $WHT$edit_identity$NRM\n";
- print " Allow editing of name : $WHT$edit_name$NRM\n";
- print " Remove username from header : $WHT$hide_auth_header$NRM\n";
- print "10. Disable server thread sort : $WHT$disable_thread_sort$NRM\n";
- print "11. Disable server-side sorting : $WHT$disable_server_sort$NRM\n";
- print "12. Allow server charset search : $WHT$allow_charset_search$NRM\n";
- print "13. Allow advanced search : $WHT$allow_advanced_search$NRM\n";
- print "14. PHP session name : $WHT$session_name$NRM\n";
- print "15. Time zone configuration : $WHT$time_zone_type$NRM\n";
- print "16. Location base : $WHT$config_location_base$NRM\n";
+ print "1. Data Directory : $WHT$data_dir$NRM\n";
+ print "2. Attachment Directory : $WHT$attachment_dir$NRM\n";
+ print "3. Directory Hash Level : $WHT$dir_hash_level$NRM\n";
+ print "4. Default Left Size : $WHT$default_left_size$NRM\n";
+ print "5. Usernames in Lowercase : $WHT$force_username_lowercase$NRM\n";
+ print "6. Allow use of priority : $WHT$default_use_priority$NRM\n";
+ print "7. Hide SM attributions : $WHT$hide_sm_attributions$NRM\n";
+ print "8. Allow use of receipts : $WHT$default_use_mdn$NRM\n";
+ print "9. Allow editing of identity : $WHT$edit_identity$NRM\n";
+ print " Allow editing of name : $WHT$edit_name$NRM\n";
+ print " Remove username from header : $WHT$hide_auth_header$NRM\n";
+ print "10. Disable server thread sort : $WHT$disable_thread_sort$NRM\n";
+ print "11. Disable server-side sorting : $WHT$disable_server_sort$NRM\n";
+ print "12. Allow server charset search : $WHT$allow_charset_search$NRM\n";
+ print "13. Allow advanced search : $WHT$allow_advanced_search$NRM\n";
+ print "14. PHP session name : $WHT$session_name$NRM\n";
+ print "15. Time zone configuration : $WHT$time_zone_type$NRM\n";
+ print "16. Location base : $WHT$config_location_base$NRM\n";
+ print "17. Only secure cookies if poss. : $WHT$only_secure_cookies$NRM\n";
print "\n";
print "R Return to Main Menu\n";
} elsif ( $menu == 5 ) {
print "1. Use Icons? : $WHT$use_icons$NRM\n";
# print "3. Default Icon Set : $WHT$icon_theme_def$NRM\n";
print "2. Default font size : $WHT$default_fontsize$NRM\n";
- print "3. Manage template sets\n";
+ print "3. Manage template sets (skins)\n";
print "4. Manage user themes\n";
print "5. Manage font sets\n";
print "6. Manage icon themes\n";
print "\n";
print "R Return to Main Menu\n";
} elsif ( $menu == 8 ) {
- print $WHT. "Plugins\n" . $NRM;
+ if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
+ print $WHT. "Plugins (WARNING: All plugins are currently disabled\n for the user \"$disable_plugins_user\"!)\n" . $NRM;
+ } elsif (lc($disable_plugins) eq 'true') {
+ print $WHT. "Plugins (WARNING: All plugins are currently disabled!)\n" . $NRM;
+ } else {
+ print $WHT. "Plugins\n" . $NRM;
+ }
print " Installed Plugins\n";
$num = 0;
for ( $count = 0 ; $count <= $#plugins ; $count++ ) {
$num = $count + 1;
- print " $num. $plugins[$count]\n";
+ $english_name = get_plugin_english_name($plugins[$count]);
+ if ( $english_name eq "" ) {
+ print " $num. $plugins[$count]" . get_plugin_version($plugins[$count]) . "\n";
+ } else {
+ print " $num. $english_name ($plugins[$count])" . get_plugin_version($plugins[$count]) . "\n";
+ }
}
print "\n Available Plugins:\n";
opendir( DIR, "../plugins" );
- @files = readdir(DIR);
+ @files = sort(readdir(DIR));
$pos = 0;
@unused_plugins = ();
for ( $i = 0 ; $i <= $#files ; $i++ ) {
- if ( -d "../plugins/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne "CVS" ) {
+ if ( -d "../plugins/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne ".svn" ) {
$match = 0;
for ( $k = 0 ; $k <= $#plugins ; $k++ ) {
if ( $plugins[$k] eq $files[$i] ) {
for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
$num = $num + 1;
- print " $num. $unused_plugins[$i]\n";
+ $english_name = get_plugin_english_name($unused_plugins[$i]);
+ if ( $english_name eq "" ) {
+ print " $num. $unused_plugins[$i]" . get_plugin_version($unused_plugins[$i]) . "\n";
+ } else {
+ print " $num. $english_name ($unused_plugins[$i])" . get_plugin_version($unused_plugins[$i]) . "\n";
+ }
}
closedir DIR;
print "\n";
+ if (lc($disable_plugins) eq 'true' && $disable_plugins_user ne '') {
+ print "E Enable active plugins (all plugins currently\n disabled for the user \"$disable_plugins_user\")\n";
+ } elsif (lc($disable_plugins) eq 'true') {
+ print "E Enable active plugins (all plugins currently\n disabled)\n";
+ } else {
+ print "D Disable all plugins\n";
+ }
+ print "U Set the user for whom plugins can be disabled\n";
print "R Return to Main Menu\n";
} elsif ( $menu == 9 ) {
print $WHT. "Database\n" . $NRM;
} elsif ( $menu == 11 ) {
print $WHT. "Interface tweaks\n" . $NRM;
print "1. Display html mails in iframe : $WHT$use_iframe$NRM\n";
+ print "2. Ask user info on first login : $WHT$ask_user_info$NRM\n";
print "\n";
print $WHT. "PHP tweaks\n" . $NRM;
print "4. Use php recode functions : $WHT$use_php_recode$NRM\n";
print "\n";
print $WHT. "Configuration tweaks\n" . $NRM;
print "6. Allow remote configtest : $WHT$allow_remote_configtest$NRM\n";
+ print "7. Debug mode : $WHT$sm_debug_mode$NRM\n";
+ print "8. Secured configuration mode : $WHT$secured_config$NRM\n";
print "\n";
print "R Return to Main Menu\n";
}
elsif ( $command == 14 ) { $session_name = command317(); }
elsif ( $command == 15 ) { $time_zone_type = command318(); }
elsif ( $command == 16 ) { $config_location_base = command_config_location_base(); }
+ elsif ( $command == 17 ) { $only_secure_cookies = command319(); }
} elsif ( $menu == 5 ) {
if ( $command == 1 ) { $use_icons = commandB3(); }
# elsif ( $command == 3 ) { $icon_theme_def = commandB7(); }
} elsif ( $menu == 7 ) {
if ( $command == 1 ) { $motd = command71(); }
} elsif ( $menu == 8 ) {
- if ( $command =~ /^[0-9]+/ ) { @plugins = command81(); }
+ if ( $command =~ /^[0-9]+/ ) { @plugins = command81(); }
+ elsif ( $command eq "u" ) { $disable_plugins_user = command82(); }
+ elsif ( $command eq "d" ) { $disable_plugins = 'true'; }
+ elsif ( $command eq "e" ) { $disable_plugins = 'false'; }
} elsif ( $menu == 9 ) {
if ( $command == 1 ) { $addrbook_dsn = command91(); }
elsif ( $command == 2 ) { $addrbook_table = command92(); }
elsif ( $command == 5 ) { $lossy_encoding = commandA5(); }
} elsif ( $menu == 11 ) {
if ( $command == 1 ) { $use_iframe = commandB2(); }
+ elsif ( $command == 2 ) { $ask_user_info = command_ask_user_info(); }
elsif ( $command == 4 ) { $use_php_recode = commandB4(); }
elsif ( $command == 5 ) { $use_php_iconv = commandB5(); }
elsif ( $command == 6 ) { $allow_remote_configtest = commandB6(); }
+ elsif ( $command == 7 ) { $sm_debug_mode = commandB8(); }
+ elsif ( $command == 8 ) { $secured_config = commandB9(); }
}
}
}
print " to use the default logo, use ../images/sm_logo.png\n";
print " - To specify a logo defined outside the SquirrelMail source tree\n";
print " use the absolute URL the webserver would use to include the file\n";
- print " e.g. http://www.example.com/images/mylogo.gif or /images/mylogo.jpg\n";
+ print " e.g. http://example.com/images/mylogo.gif or /images/mylogo.jpg\n";
print "\n";
print "[$WHT$org_logo$NRM]: $WHT";
$new_org_logo = <STDIN>;
# Default link to provider
sub command7 {
- print "Here you can set the link on the right of the page.\n";
- print "If empty, it will link to the SquirrelMail About page.\n";
+ print "Here you can set the link on the top-right of the message list.\n";
+ print "If empty, it will not be displayed.\n";
print "\n";
print "[$WHT$provider_uri$NRM]: $WHT";
$new_provider_uri = <STDIN>;
}
sub command8 {
- print "Here you can set the name of the link on the right of the page.\n";
- print "The default is 'SquirrelMail'\n";
+ print "Here you can set the name of the link on the top-right of the message list.\n";
+ print "The default is empty (do not display anything).'\n";
print "\n";
print "[$WHT$provider_name$NRM]: $WHT";
$new_provider_name = <STDIN>;
if ( $new_provider_name eq "\n" ) {
- $new_provider_name = 'SquirrelMail';
+ $new_provider_name = '';
} else {
$new_provider_name =~ s/[\r\n]//g;
$new_provider_name =~ s/^\s+$//g;
if ( $new_domain eq "\n" ) {
$new_domain = $domain;
} else {
- $new_domain =~ s/[\r\n]//g;
+ $new_domain =~ s/\s//g;
}
return $new_domain;
}
print "these servers. If you would like to use them, please select your\n";
print "IMAP server. If you do not wish to use these work-arounds, you can\n";
print "set this to \"other\", and none will be used.\n";
- print " courier = Courier IMAP server\n";
- print " cyrus = Cyrus IMAP server\n";
- print " dovecot = Dovecot Secure IMAP server\n";
- print " exchange = Microsoft Exchange IMAP server\n";
- print " hmailserver = hMailServer\n";
- print " macosx = Mac OS X Mailserver\n";
- print " mercury32 = Mercury Mail Transport System\n";
- print " uw = University of Washington's IMAP server\n";
+ print $list_supported_imap_servers;
print "\n";
print " other = Not one of the above servers\n";
print "\n";
print " ERROR TESTING\n";
close $sock;
} else {
+ $got = <$sock>; # Discard greeting
print $sock "HELO $domain\r\n";
$got = <$sock>; # Discard
print $sock "MAIL FROM:<tester\@squirrelmail.org>\r\n";
print "SMTP connections?";
if ($smtp_sitewide_user ne '') {
$default = 'y';
- print " [Yn]:";
+ print " [Y/n]:";
} else {
$default = 'n';
- print " [yN]:";
+ print " [y/N]:";
}
$tmp=<STDIN>;
$tmp = trim($tmp);
}
} else {
print "Invalid input. You must set username used for SMTP authentication.\n";
- print "Click any key to continue\n";
+ print "Click enter to continue\n";
$tmp = <STDIN>;
}
} else {
print "Invalid input\n";
- print "Click any key to continue\n";
+ print "Click enter to continue\n";
$tmp = <STDIN>;
}
}
return @plugins;
}
+# disable_plugins_user
+sub command82 {
+ print "When all active plugins are disabled, they can be disabled only\n";
+ print "for the one user named here. If left blank, plugins will be\n";
+ print "disabled for ALL users. This setting has no effect if plugins\n";
+ print "are not disabled.\n";
+ print "\n";
+ print "This must be the exact IMAP login name for the desired user.\n";
+ print "\n";
+ print "[$WHT$disable_plugins_user$NRM]: $WHT";
+ $new_disable_plugins_user = <STDIN>;
+ if ( $new_disable_plugins_user eq "\n" ) {
+ $new_disable_plugins_user = $disable_plugins_user;
+ } else {
+ $new_disable_plugins_user =~ s/[\r\n]//g;
+ }
+ return $new_disable_plugins_user;
+}
+
################# FOLDERS ###################
# default_folder_prefix
print "Deleting folders will bypass the trash folder and be immediately deleted\n\n";
print "If this is not the correct value for your server,\n";
print "please use option D on the Main Menu to configure your server correctly.\n\n";
- print "Press any key to continue...\n";
+ print "Press enter to continue...\n";
$new_delete = <STDIN>;
$delete_folder = 'true';
} else {
#noselect fix
sub command216 {
- print "Some IMAP server allow subfolders to exist even if the parent\n";
+ print "Some IMAP servers allow subfolders to exist even if the parent\n";
print "folders do not. This fixes some problems with the folder list\n";
print "when this is the case, causing the /NoSelect folders to be displayed\n";
print "\n";
print "";
print "\n";
- if ( lc($default_hide_attribution) eq 'true' ) {
+ if ( lc($hide_sm_attributions) eq 'true' ) {
$default_value = "y";
} else {
$default_value = "n";
print "See SquirrelMail documentation about format of config/timezones.php file.\n";
print "\n";
- print "Used time zone configuration (0,1,2,3)? [$WHT$time_zone_type$NRM]: $WHT";
+ print "Desired time zone configuration (0,1,2,3)? [$WHT$time_zone_type$NRM]: $WHT";
$new_time_zone_type = <STDIN>;
if ( $new_time_zone_type =~ /^[0123]\n/i ) {
$time_zone_type = $new_time_zone_type;
return $config_location_base;
}
+# only_secure_cookies (since 1.5.2)
+sub command319 {
+ print "This option allows you to specify that if a user session is initiated\n";
+ print "under a secure (HTTPS, SSL-encrypted) connection, the cookies given to\n";
+ print "the browser will ONLY be transmitted via a secure connection henceforth.\n\n";
+ print "Generally this is a Good Thing, and should NOT be disabled. However,\n";
+ print "if you intend to use the Secure Login or Show SSL Link plugins to\n";
+ print "encrypt the user login, but not the rest of the SquirrelMail session,\n";
+ print "this can be turned off. Think twice before doing so.\n";
+ print "\n";
+
+ if ( lc($only_secure_cookies) eq 'true' ) {
+ $default_value = "y";
+ } else {
+ $default_value = "n";
+ }
+ print "Transmit cookies only on secure connection when available? (y/n) [$WHT$default_value$NRM]: $WHT";
+ $only_secure_cookies = <STDIN>;
+ if ( ( $only_secure_cookies =~ /^y\n/i ) || ( ( $only_secure_cookies =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
+ $only_secure_cookies = 'true';
+ } else {
+ $only_secure_cookies = 'false';
+ }
+ return $only_secure_cookies;
+}
+
sub command_userThemes {
print "\nDefine the user themes that you wish to use. If you have added\n";
print "\nStarting detection...\n\n";
opendir( DIR, "../css" );
- @files = readdir(DIR);
+ @files = sort(readdir(DIR));
$cnt = 0;
while ( $cnt <= $#files ) {
$filename = "../css/" . $files[$cnt] .'/';
- if ( $filename ne "../css/rtl.css" && -e $filename . "default.css" ) {
+ if ( $files[$cnt] !~ /^\./ && $filename ne "../css/rtl.css" && -e $filename . "default.css" ) {
$found = 0;
for ( $x = 0 ; $x <= $#user_theme_path ; $x++ ) {
if ( $user_theme_path[$x] eq $filename ) {
}
if ( $found != 1 ) {
print "** Found user theme: $filename\n";
- print " What is its name? ";
+ $def = $files[$cnt];
+ $def =~ s/_/ /g;
+ $def = lc($def);
+ #$def =~ s/(^\w+)/ucfirst $1/eg;
+ #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
+ $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
+ print " What is its name? [$def]: ";
$nm = <STDIN>;
- $nm =~ s/[\n\r]//g;
+ $nm =~ s/^\s+|\s+$|[\n\r]//g;
+ if ( $nm eq '' ) { $nm = $def; }
$user_theme_name[ $#user_theme_name + 1 ] = $nm;
$user_theme_path[ $#user_theme_path + 1 ] = $filename;
}
sub command_iconSets {
print "\nDefine the icon themes that you wish to use. If you have added\n";
print "a theme of your own, just follow the instructions (?) about\n";
- print "how to add them. You can also change the default theme.\n\n";
+ print "how to add them. You can also change the default and fallback\n";
+ print "themes. The default theme will be used when no icon theme is\n";
+ print "set by the user. The fallback theme will be used if an icon\n";
+ print "cannot be found in the currently selected icon theme.\n\n";
print "Available icon themes:\n\n";
$count = 0;
while ( $count <= $#icon_theme_name ) {
if ( $count == $icon_theme_def ) {
- print " *";
+ print " d";
+ } else {
+ print " ";
+ }
+ if ( $count eq $icon_theme_fallback ) {
+ print "f ";
} else {
print " ";
}
$count++;
}
+ print "\n d = Default icon theme\n";
+ print " f = Fallback icon theme\n";
print "\n";
print ".------------------------------------.\n";
print "| t (detect icon themes) |\n";
print "| + (add icon theme) |\n";
print "| - N (remove icon theme) |\n";
print "| m N (mark default icon theme) |\n";
+ print "| f N (set fallback icon set) |\n";
print "| l (list icon themes) |\n";
print "| d (done) |\n";
print "`------------------------------------'\n";
while ( $input ne "d" ) {
if ( $input =~ /^\s*l\s*/i ) {
$count = 0;
+ print "\n";
while ( $count <= $#icon_theme_name ) {
- if ( $count == $icon_theme_def ) {
- print " *";
- } else {
- print " ";
- }
- if ( $count < 10 ) {
- print " ";
- }
+ if ( $count == $icon_theme_def ) {
+ print " d";
+ } else {
+ print " ";
+ }
+ if ( $count eq $icon_theme_fallback ) {
+ print "f ";
+ } else {
+ print " ";
+ }
$name = $icon_theme_name[$count];
$num_spaces = 35 - length($name);
for ( $i = 0 ; $i < $num_spaces ; $i++ ) {
$count++;
}
+ print "\n d = Default icon theme\n";
+ print " f = Fallback icon theme\n\n";
} elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
$old_def = $icon_theme_def;
$icon_theme_def = $input;
print "Cannot set default icon theme to $icon_theme_default. That theme does not exist.\n";
$icon_theme_def = $old_def;
}
+ } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
+ $old_fb = $icon_theme_fallback;
+ $icon_theme_fallback = $input;
+ $icon_theme_fallback =~ s/^\s*f\s*//;
+ if ( ( $icon_theme_fallback > $#icon_theme_name ) || ( $icon_theme_fallback < 0 ) ) {
+ print "Cannot set fallback icon theme to $icon_theme_fallback. That theme does not exist.\n";
+ $icon_theme_fallback = $old_fb;
+ }
} elsif ( $input =~ /^\s*\+/ ) {
print "What is the name of this icon theme? ";
$name = <STDIN>;
}
if ( $rem_num == $icon_theme_def ) {
print "You cannot remove the default icon theme!\n";
+ } elsif ( $rem_num == $icon_theme_fallback ) {
+ print "You cannot remove the fallback icon theme!\n";
} else {
$count = 0;
@new_theme_name = ();
print "\nStarting detection...\n\n";
opendir( DIR, "../images/themes/" );
- @files = readdir(DIR);
+ @files = sort(readdir(DIR));
$cnt = 0;
while ( $cnt <= $#files ) {
$filename = "../images/themes/" . $files[$cnt] .'/';
- if ( -d "../images/themes/" . $files[$cnt] && $files[$cnt] !~ /^\./ && $files[$cnt] ne "CVS" ) {
+ if ( -d "../images/themes/" . $files[$cnt] && $files[$cnt] !~ /^\./ && $files[$cnt] ne ".svn" ) {
$found = 0;
for ( $x = 0 ; $x <= $#icon_theme_path ; $x++ ) {
if ( $icon_theme_path[$x] eq $filename ) {
}
if ( $found != 1 ) {
print "** Found icon theme: $filename\n";
- print " What is its name? ";
+ $def = $files[$cnt];
+ $def =~ s/_/ /g;
+ $def = lc($def);
+ #$def =~ s/(^\w+)/ucfirst $1/eg;
+ #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
+ $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
+ print " What is its name? [$def]: ";
$nm = <STDIN>;
- $nm =~ s/[\n\r]//g;
+ $nm =~ s/^\s+|\s+$|[\n\r]//g;
+ if ( $nm eq '' ) { $nm = $def; }
$icon_theme_name[ $#icon_theme_name + 1 ] = $nm;
$icon_theme_path[ $#icon_theme_path + 1 ] = $filename;
}
print "| + (add icon theme) |\n";
print "| - N (remove icon theme) |\n";
print "| m N (mark default icon theme) |\n";
+ print "| f N (set fallback icon set) |\n";
print "| l (list icon themes) |\n";
print "| d (done) |\n";
print "`------------------------------------'\n";
}
sub command_templates {
- print "\nDefine the template sets that you wish to use. If you have added\n";
+ print "\nDefine the template sets (skins) that you wish to use. If you have added\n";
print "a template set of your own, just follow the instructions (?) about\n";
print "how to add them. You can also change the default template.\n";
$count = 0;
while ( $count <= $#templateset_name ) {
- if ( $count == $templateset_default ) {
- print " *";
+ if ( $templateset_id[$count] eq $templateset_default ) {
+ print " d";
+ } else {
+ print " ";
+ }
+ if ( $templateset_id[$count] eq $templateset_fallback ) {
+ print "f ";
} else {
print " ";
}
$count++;
}
-
-# FIXME: what is this stuff? it is commented out, can we just blast it?
-# opendir( DIR, "../templates" );
-# @files = readdir(DIR);
-# $pos = 0;
-#
-# while ( $cnt <= $#files ) {
-# if ( -d "../templates/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne "CVS" ) {
-# $filename = "../templates/" . $files[$cnt];
-# $found = 0;
-# for ( $x = 0 ; $x <= $#templateset_id ; $x++ ) {
-# if ( $theme_path[$x] eq $filename ) {
-# $found = 1;
-# }
-# }
-# }
-# $cnt++;
-# }
-# for ( $i = 0 ; $i <= $#files ; $i++ ) {
-# if ( -d "../templates/" . $files[$i] && $files[$i] !~ /^\./ && $files[$i] ne "CVS" ) {
-# $match = 0;
-# for ( $k = 0 ; $k <= $#aTemplateSets ; $k++ ) {
-# if ( $aTemplateSets[$chosen] eq $files[$i] ) {
-# $match = 1;
-# }
-# }
-# if ( $match == 0 ) {
-# $unused_plugins[$pos] = $files[$i];
-# $pos++;
-# }
-# }
-# }
-#
-# for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
-# $num = $num + 1;
-# print " $num. $unused_plugins[$i]\n";
-# }
-# closedir DIR;
+ print "\n d = default template set\n"
+ . " f = fallback template set\n\n";
$menu_text = ".-------------------------------------.\n"
. "| t (detect template set) |\n"
. "| + (add template set) |\n"
. "| - N (remove template set) |\n"
. "| m N (mark default template set) |\n"
- . "| l (list template sets) |\n"
+ . "| f N (set fallback template set) |\n"
+ . "| l (list template sets/skins) |\n"
. "| d (done) |\n"
. "|-------------------------------------|\n"
. "| where N is a template set number |\n"
if ( $input =~ /^\s*l\s*/i ) {
$count = 0;
while ( $count <= $#templateset_name ) {
- if ( $count == $templateset_default ) {
- print " *";
+ if ( $templateset_id[$count] eq $templateset_default ) {
+ print " d";
+ } else {
+ print " ";
+ }
+ if ( $templateset_id[$count] eq $templateset_fallback ) {
+ print "f ";
} else {
print " ";
}
$count++;
}
+ print "\n d = default template set\n"
+ . " f = fallback template set\n\n";
# mark default template set
#
} elsif ( $input =~ /^\s*m\s*[0-9]+/i ) {
$old_def = $templateset_default;
- $templateset_default = $input;
- $templateset_default =~ s/^\s*m\s*//;
- if ( ( $templateset_default > $#templateset_name ) || ( $templateset_default < 0 ) ) {
- print "Cannot set default template set to $templateset_default. That template set does not exist.\n";
+ $input =~ s/^\s*m\s*//;
+ $templateset_default = $templateset_id[$input];
+ if ( $templateset_default =~ /^\s*$/ ) {
+ print "Cannot set default template set to $input. That template set does not exist.\n";
$templateset_default = $old_def;
}
+ # set fallback template set
+ #
+ } elsif ( $input =~ /^\s*f\s*[0-9]+/i ) {
+ $old_def = $templateset_fallback;
+ $input =~ s/^\s*f\s*//;
+ $templateset_fallback = $templateset_id[$input];
+ if ( $templateset_fallback =~ /^\s*$/ ) {
+ print "Cannot set fallback template set to $input. That template set does not exist.\n";
+ $templateset_fallback = $old_def;
+ }
+
# add template set
#
} elsif ( $input =~ /^\s*\+/ ) {
} elsif ( $input =~ /^\s*t\s*/i ) {
print "\nStarting detection...\n\n";
opendir( DIR, "../templates" );
- @files = readdir(DIR);
+ @files = sort(readdir(DIR));
$cnt = 0;
while ( $cnt <= $#files ) {
- if ( -d "../templates/" . $files[$cnt] && $files[$cnt] !~ /^\./ && $files[$cnt] ne "CVS" ) {
+ if ( -d "../templates/" . $files[$cnt] && $files[$cnt] !~ /^\./ && $files[$cnt] ne ".svn" ) {
$filename = $files[$cnt];
$found = 0;
for ( $x = 0 ; $x <= $#templateset_id ; $x++ ) {
}
if ( $found != 1) {
print "** Found template set: $filename\n";
- print " What is it's name (as shown to your users)? ";
+ $def = $files[$cnt];
+ $def =~ s/_/ /g;
+ $def = lc($def);
+ #$def =~ s/(^\w+)/ucfirst $1/eg;
+ #$def =~ s/(\s+)(\w+)/$1 . ucfirst $2/eg;
+ $def =~ s/(^\w+)|(\s+)(\w+)/ucfirst $1 . $2 . ucfirst $3/eg;
+ print " What is it's name (as shown to your users)? [$def]: ";
$nm = <STDIN>;
- $nm =~ s/[\n\r]//g;
+ $nm =~ s/^\s+|\s+$|[\n\r]//g;
+ if ( $nm eq '' ) { $nm = $def; }
$templateset_id[ $#templateset_id + 1 ] = $filename;
$templateset_name[ $#templateset_name + 1 ] = $nm;
-# FIXME: why are these two lines here?
-# $aTemplateSet[ $#templateset_name + 1 ] = $nm;
-# $aTemplateSet[ $#templateset_id + 1 ] = $filename;
}
}
$cnt++;
$filename = $templateset_id[$cnt];
if ( !(-d change_to_rel_path('SM_PATH . \'templates/' . $filename)) ) {
print " Removing \"$filename\" (template set directory not found)\n";
- if ( $templateset_default gt $cnt ) { $templateset_default--; }
- elsif ( $templateset_default eq $cnt ) { $templateset_default = 0; }
+ if ( $templateset_default eq $filename ) { $templateset_default = 'default'; }
+ if ( $templateset_fallback eq $filename ) { $templateset_fallback = 'default'; }
$offset = 0;
@new_templateset_name = ();
@new_templateset_id = ();
} else {
$rem_num = $#templateset_name;
}
- if ( $rem_num == $templateset_default ) {
+ if ( $templateset_id[$rem_num] eq $templateset_default ) {
print "You cannot remove the default template set!\n";
+ } elsif ( $templateset_id[$rem_num] eq $templateset_fallback ) {
+ print "You cannot remove the fallback template set!\n";
} else {
$count = 0;
@new_templateset_name = ();
}
@templateset_name = @new_templateset_name;
@templateset_id = @new_templateset_id;
- if ( $templateset_default > $rem_num ) {
- $templateset_default--;
- }
}
# help
#
} elsif ( $input =~ /^\s*\?\s*/ ) {
print $menu_text;
+
+ # command not understood
+ #
+ } else {
+ print "Command not understood\n";
}
+
print "[template set] command (?=help) > ";
$input = <STDIN>;
$input =~ s/[\r\n]//g;
}
return $use_iframe;
}
+
+# ask user info
+sub command_ask_user_info {
+ print "New users need to supply their real name and email address to\n";
+ print "send out proper mails. When this option is enabled, a user that\n";
+ print "logs in for the first time will be redirected to the Personal\n";
+ print "Options screen and asked to supply their personal data.\n";
+ print "\n";
+
+ if ( lc($ask_user_info) eq 'true' ) {
+ $default_value = "y";
+ } else {
+ $default_value = "n";
+ }
+ print "Ask user info? (y/n) [$WHT$default_value$NRM]: $WHT";
+ $ask_user_info = <STDIN>;
+ if ( ( $ask_user_info =~ /^y\n/i ) || ( ( $ask_user_info =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
+ $ask_user_info = 'true';
+ } else {
+ $ask_user_info = 'false';
+ }
+ return $ask_user_info;
+}
+
# use icons
sub commandB3 {
print "Enabling this option will cause icons to be used instead of text\n";
return $new_icon_theme_def;
}
+# SquirrelMail debug mode (since 1.5.2)
+sub commandB8 {
+ print "When debugging or developing SquirrelMail, you may want to increase\n";
+ print "the verbosity of certain kinds of errors, notices, and/or diagnostics.\n";
+ print "You may enable one or more of the debugging modes here. Please make\n";
+ print "sure that you have turned off debugging if you are using SquirrelMail\n";
+ print "in a production environment.\n\n";
+
+ $input = "";
+ while ( $input ne "d\n" ) {
+ $sm_debug_mode = convert_debug_constants_to_binary_integer($sm_debug_mode);
+
+ # per include/constants.php, here are the debug mode values:
+ #
+ # 0 SM_DEBUG_MODE_OFF
+ # 1 SM_DEBUG_MODE_SIMPLE
+ # 512 SM_DEBUG_MODE_MODERATE
+ # 524288 SM_DEBUG_MODE_ADVANCED
+ # 536870912 SM_DEBUG_MODE_STRICT
+ #
+ print "\n# Enabled? Description\n";
+ print "---------------------------------------------------------------------\n";
+ print "0 " . ($sm_debug_mode == 0 ? "y" : " ")
+ . " No debugging (recommended in production environments)\n";
+ print "1 " . ($sm_debug_mode & 1 ? "y" : " ")
+ . " Simple debugging (PHP E_ERROR)\n";
+ print "2 " . ($sm_debug_mode & 512 ? "y" : " ")
+ . " Moderate debugging (PHP E_ALL)\n";
+ print "3 " . ($sm_debug_mode & 524288 ? "y" : " ")
+ . " Advanced debugging (PHP E_ALL plus log errors\n";
+ print " intentionally suppressed)\n";
+ print "4 " . ($sm_debug_mode & 536870912 ? "y" : " ")
+ . " Strict debugging (PHP E_STRICT)\n";
+ print "\n";
+
+ print "SquirrelMail debug mode (0,1,2,3,4) or d when done? : $WHT";
+ $input = <STDIN>;
+ if ( $input eq "d\n" ) {
+ # nothing
+ } elsif ($input !~ /^[0-9]+\n$/) {
+ print "\nInvalid configuration value.\n";
+ print "\nPress enter to continue...";
+ $tmp = <STDIN>;
+ } elsif ( $input == "0\n" ) {
+ $sm_debug_mode = 0;
+ } elsif ( $input == "1\n" ) {
+ if ($sm_debug_mode & 1) {
+ $sm_debug_mode ^= 1;
+ } else {
+ $sm_debug_mode |= 1;
+ }
+ } elsif ( $input == "2\n" ) {
+ if ($sm_debug_mode & 512) {
+ $sm_debug_mode ^= 512;
+ } else {
+ $sm_debug_mode |= 512;
+ }
+ } elsif ( $input == "3\n" ) {
+ if ($sm_debug_mode & 524288) {
+ $sm_debug_mode ^= 524288;
+ } else {
+ $sm_debug_mode |= 524288;
+ }
+ } elsif ( $input == "4\n" ) {
+ if ($sm_debug_mode & 536870912) {
+ $sm_debug_mode ^= 536870912;
+ } else {
+ $sm_debug_mode |= 536870912;
+ }
+ } else {
+ print "\nInvalid configuration value.\n";
+ print "\nPress enter to continue...";
+ $tmp = <STDIN>;
+ }
+ print "\n";
+ }
+ $sm_debug_mode = convert_debug_binary_integer_to_constants($sm_debug_mode);
+ return $sm_debug_mode;
+}
+
+# Secured configuration mode (since 1.5.2)
+sub commandB9 {
+ print "This option allows you to enable \"Secured Configuration\" mode,\n";
+ print "which will guarantee that certain settings made herein will be\n";
+ print "made immutable and will not be subject to override by either friendly\n";
+ print "or unfriendly code/plugins. Only a small number of settings herein\n";
+ print "will be used in this manner - just those that are deemed to be a\n";
+ print "potential security threat when rouge plugin or other code may be\n";
+ print "executed inside SquirrelMail.\n";
+ print "\n";
+
+ if ( lc($secured_config) eq 'true' ) {
+ $default_value = "y";
+ } else {
+ $default_value = "n";
+ }
+ print "Enable secured configuration mode? (y/n) [$WHT$default_value$NRM]: $WHT";
+ $secured_config = <STDIN>;
+ if ( ( $secured_config =~ /^y\n/i ) || ( ( $secured_config =~ /^\n/ ) && ( $default_value eq "y" ) ) ) {
+ $secured_config = 'true';
+ } else {
+ $secured_config = 'false';
+ }
+ return $secured_config;
+}
+
sub save_data {
$tab = " ";
if ( open( CF, ">config.php" ) ) {
print CF " * Created using the configure script, conf.pl\n";
print CF " */\n";
print CF "\n";
- print CF "global \$version;\n";
if ($print_config_version) {
print CF "\$config_version = '$print_config_version';\n";
# string
print CF "\$config_location_base = '$config_location_base';\n";
print CF "\n";
+ # boolean
+ print CF "\$disable_plugins = $disable_plugins;\n";
+ # string
+ print CF "\$disable_plugins_user = '$disable_plugins_user';\n";
+ print CF "\n";
# all plugins are strings
for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
if ( $icon_theme_def eq '' ) { $icon_theme_def = '0'; }
print CF "\$icon_theme_def = $icon_theme_def;\n";
-
+ if ( $icon_theme_fallback eq '' ) { $icon_theme_fallback = '0'; }
+ print CF "\$icon_theme_fallback = $icon_theme_fallback;\n";
+
for ( $count = 0 ; $count <= $#icon_theme_name ; $count++ ) {
$path = $icon_theme_path[$count];
if ($path eq 'none' || $path eq 'template') {
}
print CF "\n";
- if ( $templateset_default eq '' ) { $templateset_default = '0'; }
- print CF "\$templateset_default = $templateset_default;\n";
-# FIXME: need to make this a setting the user can change herein
-# This REALLY needs to be done, since the index of the "default"
-# set cannot always be predicted!
-# Heck, why are default and fallback indexes? If we make them
-# into the ID strings, then it would not cause such issues
-$templateset_fallback = 0;
- print CF "\$templateset_fallback = $templateset_fallback;\n";
+ if ( $templateset_default eq '' ) { $templateset_default = 'default'; }
+ print CF "\$templateset_default = '$templateset_default';\n";
+
+ if ( $templateset_fallback eq '' ) { $templateset_fallback = 'default'; }
+ print CF "\$templateset_fallback = '$templateset_fallback';\n";
for ( $count = 0 ; $count <= $#templateset_name ; $count++ ) {
print CF "\$aTemplateSet[$count]['ID'] = '" . $templateset_id[$count] . "';\n";
print CF "\$no_list_for_subscribe = $no_list_for_subscribe;\n";
# string
- print CF "\$smtp_auth_mech = '$smtp_auth_mech';\n";
- print CF "\$smtp_sitewide_user = '". quote_single($smtp_sitewide_user) ."';\n";
- print CF "\$smtp_sitewide_pass = '". quote_single($smtp_sitewide_pass) ."';\n";
+ print CF "\$smtp_auth_mech = '$smtp_auth_mech';\n";
+ print CF "\$smtp_sitewide_user = '". quote_single($smtp_sitewide_user) ."';\n";
+ print CF "\$smtp_sitewide_pass = '". quote_single($smtp_sitewide_pass) ."';\n";
# string
- print CF "\$imap_auth_mech = '$imap_auth_mech';\n";
+ print CF "\$imap_auth_mech = '$imap_auth_mech';\n";
# boolean
- print CF "\$use_imap_tls = $use_imap_tls;\n";
+ print CF "\$use_imap_tls = $use_imap_tls;\n";
# boolean
- print CF "\$use_smtp_tls = $use_smtp_tls;\n";
+ print CF "\$use_smtp_tls = $use_smtp_tls;\n";
# string
- print CF "\$session_name = '$session_name';\n";
+ print CF "\$session_name = '$session_name';\n";
+ # boolean
+ print CF "\$only_secure_cookies = $only_secure_cookies;\n";
print CF "\n";
# boolean
print CF "\$use_iframe = $use_iframe;\n";
- print CF "\n";
+ # boolean
+ print CF "\$ask_user_info = $ask_user_info;\n";
# boolean
print CF "\$use_icons = $use_icons;\n";
print CF "\n";
# boolean
print CF "\$use_php_recode = $use_php_recode;\n";
- print CF "\n";
# boolean
print CF "\$use_php_iconv = $use_php_iconv;\n";
print CF "\n";
# boolean
print CF "\$allow_remote_configtest = $allow_remote_configtest;\n";
+ print CF "\$secured_config = $secured_config;\n";
+ # (binary) integer or constant - convert integer
+ # values to constants before output
+ $sm_debug_mode = convert_debug_binary_integer_to_constants($sm_debug_mode);
+ print CF "\$sm_debug_mode = $sm_debug_mode;\n";
print CF "\n";
close CF;
print "Data saved in config.php\n";
+
+ build_plugin_hook_array();
+
} else {
print "Error saving config.php: $!\n";
}
$continue = 0;
while ( $continue != 1 ) {
print "Please select your IMAP server:\n";
- print " bincimap = Binc IMAP server\n";
- print " courier = Courier IMAP server\n";
- print " cyrus = Cyrus IMAP server\n";
- print " dovecot = Dovecot Secure IMAP server\n";
- print " exchange = Microsoft Exchange IMAP server\n";
- print " hmailserver = hMailServer\n";
- print " macosx = Mac OS X Mailserver\n";
- print " mercury32 = Mercury/32\n";
- print " uw = University of Washington's IMAP server\n";
+ print $list_supported_imap_servers;
print "\n";
print " quit = Do not change anything\n";
print "\n";
# So at this point, we have a response, and it is (hopefully) valid.
if ($service eq 'SMTP') {
- if (($response =~ /^535/) or ($response =~/^502/)) {
+ if (!($response =~ /^334/)) {
# Not supported
print $sock $logout;
close $sock;
return 'NO';
- } elsif ($response =~ /^503/) {
- #Something went wrong
- return undef;
}
} elsif ($service eq 'IMAP') {
if ($response =~ /^A01/) {
if ($folder_name =~ /[\x80-\xFFFF]/) {
print "Folder name contains 8bit characters. Configuration utility requires\n";
print "UTF7-IMAP encoded folder names.\n";
- print "Press any key to continue...";
+ print "Press enter to continue...";
my $tmp = <STDIN>;
return 0;
} elsif ($folder_name =~ /[&\*\%]/) {
# check for ampersand and list-wildcards
print "Folder name contains special UTF7-IMAP characters.\n";
- print "Are you sure that folder name is correct? (yN): ";
+ print "Are you sure that folder name is correct? (y/N): ";
my $tmp = <STDIN>;
$tmp = lc(trim($tmp));
if ($tmp =~ /^y$/) {
$string =~ s/\'/\\'/g;
return $string;
}
+
+# determine a plugin's version number
+#
+# parses the setup.php file, looking for the
+# version string in the <plugin>_info() or the
+# <plugin>_version functions.
+#
+sub get_plugin_version() {
+
+ my $plugin_name = shift(@_);
+
+ $setup_file = '../plugins/' . $plugin_name . '/setup.php';
+ if ( -e "$setup_file" ) {
+ # Make sure that file is readable
+ if (! -r "$setup_file") {
+ print "\n";
+ print "WARNING:\n";
+ print "The file \"$setup_file\" was found, but you don't\n";
+ print "have rights to read it. The plugin \"";
+ print $plugin_name . "\" may not work correctly until you fix this.\n";
+ print "\nPress enter to continue";
+ $ctu = <STDIN>;
+ print "\n";
+ next;
+ }
+
+ $version = ' ';
+# FIXME: grep the file instead of reading it into memory?
+ $whole_file = '';
+ open( FILE, "$setup_file" );
+ while ( $line = <FILE> ) {
+ $whole_file .= $line;
+ }
+ close(FILE);
+
+ # ideally, there is a version in the <plugin>_info function...
+ #
+ if ($whole_file =~ /('version'\s*=>\s*['"](.*?)['"])/) {
+ $version .= $2;
+
+ # this assumes there is only one function that returns
+ # a static string in the setup file
+ #
+ } elsif ($whole_file =~ /(return\s*['"](.*?)['"])/) {
+ $version .= $2;
+ }
+
+ return $version;
+
+ } else {
+ print "\n";
+ print "WARNING:\n";
+ print "The file \"$setup_file\" was not found.\n";
+ print "The plugin \"" . $plugin_name;
+ print "\" may not work correctly until you fix this.\n";
+ print "\nPress enter to continue";
+ $ctu = <STDIN>;
+ print "\n";
+ next;
+ }
+
+}
+
+# determine a plugin's English name
+#
+# parses the setup.php file, looking for the
+# English name in the <plugin>_info() function.
+#
+sub get_plugin_english_name() {
+
+ my $plugin_name = shift(@_);
+
+ $setup_file = '../plugins/' . $plugin_name . '/setup.php';
+ if ( -e "$setup_file" ) {
+ # Make sure that file is readable
+ if (! -r "$setup_file") {
+ print "\n";
+ print "WARNING:\n";
+ print "The file \"$setup_file\" was found, but you don't\n";
+ print "have rights to read it. The plugin \"";
+ print $plugin_name . "\" may not work correctly until you fix this.\n";
+ print "\nPress enter to continue";
+ $ctu = <STDIN>;
+ print "\n";
+ next;
+ }
+
+ $english_name = '';
+# FIXME: grep the file instead of reading it into memory?
+ $whole_file = '';
+ open( FILE, "$setup_file" );
+ while ( $line = <FILE> ) {
+ $whole_file .= $line;
+ }
+ close(FILE);
+
+ # the English name is in the <plugin>_info function or nothing...
+ #
+ if ($whole_file =~ /('english_name'\s*=>\s*['"](.*?)['"])/) {
+ $english_name .= $2;
+ }
+
+ return $english_name;
+
+ } else {
+ print "\n";
+ print "WARNING:\n";
+ print "The file \"$setup_file\" was not found.\n";
+ print "The plugin \"" . $plugin_name;
+ print "\" may not work correctly until you fix this.\n";
+ print "\nPress enter to continue";
+ $ctu = <STDIN>;
+ print "\n";
+ next;
+ }
+
+}
+
+# parses the setup.php files for all activated plugins and
+# builds static plugin hooks array so we don't have to load
+# ALL plugins are runtime and build the hook array on every
+# page request
+#
+# hook array is saved in config/plugin_hooks.php
+#
+# Note the $verbose variable at the top of this routine
+# can be set to zero to quiet it down.
+#
+# NOTE/FIXME: we aren't necessarily interested in writing
+# a full-blown PHP parsing engine, so plenty
+# of assumptions are included herein about the
+# coding of the plugin setup files, and things
+# like commented out curly braces or other
+# such oddities can break this in a bad way.
+#
+sub build_plugin_hook_array() {
+
+ $verbose = 1;
+
+ if ($verbose) {
+ print "\n\n";
+ }
+
+ if ( open( HOOKFILE, ">plugin_hooks.php" ) ) {
+ print HOOKFILE "<?php\n";
+ print HOOKFILE "\n";
+
+ print HOOKFILE "/**\n";
+ print HOOKFILE " * SquirrelMail Plugin Hook Registration File\n";
+ print HOOKFILE " * Auto-generated using the configure script, conf.pl\n";
+ print HOOKFILE " */\n";
+ print HOOKFILE "\n";
+ print HOOKFILE "global \$squirrelmail_plugin_hooks;\n";
+ print HOOKFILE "\n";
+
+PLUGIN: for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
+
+ if ($verbose) {
+ print "Activating plugin \"" . $plugins[$ct] . "\"...\n";
+ }
+
+ $setup_file = '../plugins/' . $plugins[$ct] . '/setup.php';
+ if ( -e "$setup_file" ) {
+ # Make sure that file is readable
+ if (! -r "$setup_file") {
+ print "\n";
+ print "WARNING:\n";
+ print "The file \"$setup_file\" was found, but you don't\n";
+ print "have rights to read it. The plugin \"";
+ print $plugins[$ct] . "\" will not be activated until you fix this.\n";
+ print "\nPress enter to continue";
+ $ctu = <STDIN>;
+ print "\n";
+ next;
+ }
+ open( FILE, "$setup_file" );
+ $inside_init_fxn = 0;
+ $brace_count = 0;
+ while ( $line = <FILE> ) {
+
+ # throw away lines until we get to target function
+ #
+ if (!$inside_init_fxn
+ && $line !~ /^\s*function\s*squirrelmail_plugin_init_/i) {
+ next;
+ }
+ $inside_init_fxn = 1;
+
+
+ # count open braces
+ #
+ if ($line =~ /{/) {
+ $brace_count++;
+ }
+
+
+ # count close braces
+ #
+ if ($line =~ /}/) {
+ $brace_count--;
+
+ # leaving <plugin>_init() function...
+ if ($brace_count == 0) {
+ close(FILE);
+ next PLUGIN;
+ }
+
+ }
+
+
+ # throw away lines that are not exactly one "brace set" deep
+ #
+ if ($brace_count > 1) {
+ next;
+ }
+
+
+ # also not interested in lines that are not
+ # hook registration points
+ #
+ if ($line !~ /^\s*\$squirrelmail_plugin_hooks/i) {
+ next;
+ }
+
+
+ # if $line does not have an ending semicolon,
+ # we need to recursively read in subsequent
+ # lines until we find one
+ while ( $line !~ /;\s*$/ ) {
+ $line =~ s/[\n\r]\s*$//;
+ $line .= <FILE>;
+ }
+
+
+ $line =~ s/^\s+//;
+ $line =~ s/^\$//;
+ $var = $line;
+
+ $var =~ s/=/EQUALS/;
+ if ( $var =~ /^([a-z])/i ) {
+ @options = split ( /\s*EQUALS\s*/, $var );
+ $options[1] =~ s/[\n\r]//g;
+ $options[1] =~ s/[\'\"];\s*$//;
+ $options[1] =~ s/;$//;
+ $options[1] =~ s/^[\'\"]//;
+ # de-escape escaped strings
+ $options[1] =~ s/\\'/'/g;
+ $options[1] =~ s/\\\\/\\/g;
+
+ if ( $options[0] =~ /^squirrelmail_plugin_hooks\s*\[\s*['"]([a-z0-9 \/._*-]+)['"]\s*\]\s*\[\s*['"]([0-9a-z._-]+)['"]\s*\]/i ) {
+ $hook_name = $1;
+ $hooked_plugin_name = $2;
+ # Note: if we wanted to stop plugins from registering
+ # a *different* plugin on a hook, we could catch
+ # it here, however this has actually proven to be
+ # a useful *feature*
+ #if ($hooked_plugin_name ne $plugins[$ct]) {
+ # print "...plugin is tring to hook in under different name...\n";
+ #}
+
+#FIXME: do we want to count the number of hook registrations for each plugin and warn if a plugin doesn't have any?
+ # hook registration has been found!
+ if ($verbose) {
+ if ($hooked_plugin_name ne $plugins[$ct]) {
+ print " registering on hook \"" . $hook_name . "\" (as \"$hooked_plugin_name\" plugin)\n";
+ } else {
+ print " registering on hook \"" . $hook_name . "\"\n";
+ }
+ }
+ $line =~ s/ {2,}/ /g;
+ $line =~ s/=/\n =/;
+ print HOOKFILE "\$$line";
+
+ }
+
+ }
+
+ }
+ close(FILE);
+
+ } else {
+ print "\n";
+ print "WARNING:\n";
+ print "The file \"$setup_file\" was not found.\n";
+ print "The plugin \"" . $plugins[$ct];
+ print "\" will not be activated until you fix this.\n";
+ print "\nPress enter to continue";
+ $ctu = <STDIN>;
+ print "\n";
+ next;
+ }
+
+ }
+
+ print HOOKFILE "\n\n";
+ close(HOOKFILE);
+# if ($verbose) {
+ print "\nDone activating plugins; registration data saved in plugin_hooks.php\n\n";
+# }
+
+ } else {
+
+ print "\n";
+ print "WARNING:\n";
+ print "The file \"plugin_hooks.php\" was not able to be written to.\n";
+ print "No plugins will be activated until you fix this.\n";
+ print "\nPress enter to continue";
+ $ctu = <STDIN>;
+ print "\n";
+
+ }
+
+}
+
+# converts (binary) integer values that correspond
+# to the SquirrelMail debug mode constants (see
+# include/constants.php) into those constant strings
+# (bitwise or'd if more than one is enabled)
+#
+# if the value passed in is not an integer, it is
+# returned unmolested
+#
+sub convert_debug_binary_integer_to_constants() {
+
+ my ($debug_mode) = @_;
+ if ($debug_mode =~ /^[^0-9]/) {
+ return $debug_mode;
+ }
+ $debug_mode = int($debug_mode);
+ $new_debug_mode = '';
+
+ # per include/constants.php, here are their values:
+ #
+ # 0 SM_DEBUG_MODE_OFF
+ # 1 SM_DEBUG_MODE_SIMPLE
+ # 512 SM_DEBUG_MODE_MODERATE
+ # 524288 SM_DEBUG_MODE_ADVANCED
+ # 536870912 SM_DEBUG_MODE_STRICT
+ #
+ if ($debug_mode & 1) {
+ $new_debug_mode .= ' | SM_DEBUG_MODE_SIMPLE';
+ }
+ if ($debug_mode & 512) {
+ $new_debug_mode .= ' | SM_DEBUG_MODE_MODERATE';
+ }
+ if ($debug_mode & 524288) {
+ $new_debug_mode .= ' | SM_DEBUG_MODE_ADVANCED';
+ }
+ if ($debug_mode & 536870912) {
+ $new_debug_mode .= ' | SM_DEBUG_MODE_STRICT';
+ }
+
+ $new_debug_mode =~ s/^ \| //;
+ if (!$new_debug_mode) {
+ $new_debug_mode = 'SM_DEBUG_MODE_OFF';
+ }
+
+ return $new_debug_mode;
+}
+
+# converts SquirrelMail debug mode constants (see
+# include/constants.php) into their corresponding
+# (binary) integer values
+#
+# if the value passed in is an integer already, it
+# is returned unmolested
+#
+sub convert_debug_constants_to_binary_integer() {
+
+ my ($debug_mode) = @_;
+ if ($debug_mode =~ /^[0-9]/) {
+ return $debug_mode;
+ }
+ $new_debug_mode = 0;
+
+ # per include/constants.php, here are their values:
+ #
+ # 0 SM_DEBUG_MODE_OFF
+ # 1 SM_DEBUG_MODE_SIMPLE
+ # 512 SM_DEBUG_MODE_MODERATE
+ # 524288 SM_DEBUG_MODE_ADVANCED
+ # 536870912 SM_DEBUG_MODE_STRICT
+ #
+ if ($debug_mode =~ /\bSM_DEBUG_MODE_OFF\b/) {
+ $new_debug_mode = 0;
+ }
+ if ($debug_mode =~ /\bSM_DEBUG_MODE_SIMPLE\b/) {
+ $new_debug_mode |= 1;
+ }
+ if ($debug_mode =~ /\bSM_DEBUG_MODE_MODERATE\b/) {
+ $new_debug_mode |= 512;
+ }
+ if ($debug_mode =~ /\bSM_DEBUG_MODE_ADVANCED\b/) {
+ $new_debug_mode |= 524288;
+ }
+ if ($debug_mode =~ /\bSM_DEBUG_MODE_STRICT\b/) {
+ $new_debug_mode |= 536870912;
+ }
+
+ return $new_debug_mode;
+}
projects / squirrelmail.git / blobdiff