X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=config%2Fconf.pl;h=8f75be145bb66c517d745a82a3337f3c4b1028e6;hp=e69b3f0e2abc72d73370e21e3709cdc79b39a7ec;hb=f94f306d2612ca37a97a3e6d3bae3e13e964eba4;hpb=e2409f9c01eb374bc6a531eb507d4190f5130dfc diff --git a/config/conf.pl b/config/conf.pl index e69b3f0e..8f75be14 100755 --- a/config/conf.pl +++ b/config/conf.pl @@ -46,6 +46,17 @@ $dir = cwd(); # First, lets read in the data already in there... ############################################################ if ( -e "config.php" ) { + # Make sure that file is readable + if (! -r "config.php") { + clear_screen(); + print "WARNING:\n"; + print "The file \"config/config.php\" was found, but you don't\n"; + print "have rights to read it.\n"; + print "\n"; + print "Press enter to continue"; + $ctu = ; + exit; + } open( FILE, "config.php" ); while ( $line = ) { $line =~ s/^\s+//; @@ -70,7 +81,7 @@ if ( -e "config.php" ) { if ( $config_version ne $conf_pl_version ) { clear_screen(); - print $WHT. "WARNING:\n" . $NRM; + print "WARNING:\n"; print " The file \"config/config.php\" was found, but it is for\n"; print " an older version of SquirrelMail. It is possible to still\n"; print " read the defaults from this file but be warned that many\n"; @@ -123,7 +134,7 @@ if ( -e "config.php" ) { if ( $config_version ne $conf_pl_version ) { clear_screen(); - print $WHT. "WARNING:\n" . $NRM; + print "WARNING:\n"; print " You are trying to use a 'config_default.php' from an older\n"; print " version of SquirrelMail. This is HIGHLY unrecommended. You\n"; print " should get the 'config_default.php' that matches the version\n"; @@ -242,10 +253,10 @@ while ( $line = ) { $sub =~ s/^fontsets\[\'//; $fontsets{$sub} = $options[1]; } elsif ( $options[0] =~ /^theme\[[0-9]+\]\[['"]PATH|NAME['"]\]/ ) { - ## - ## $color themes are no longer supported. Please leave this - ## so conf.pl doesn't barf if it encounters a $theme. - ## + ## + ## $color themes are no longer supported. Please leave this + ## so conf.pl doesn't barf if it encounters a $theme. + ## } elsif ( $options[0] =~ /^ldap_server\[[0-9]+\]/ ) { $sub = $options[0]; $sub =~ s/\]//; @@ -426,9 +437,6 @@ $prefs_user_size = 128 if ( !$prefs_user_size ); $prefs_key_size = 64 if ( !$prefs_key_size ); $prefs_val_size = 65536 if ( !$prefs_val_size ); -# since 1.5.2 -$icon_theme_def = '' if ( !$icon_theme_def ); - # add qmail-inject test here for backwards compatibility if ( !$sendmail_args && $sendmail_path =~ /qmail-inject/ ) { $sendmail_args = ''; @@ -460,6 +468,7 @@ $abook_file_line_length = 2048 if ( !$abook_file_line_length ); $config_location_base = '' if ( !$config_location_base ); $smtp_sitewide_user = '' if ( !$smtp_sitewide_user ); $smtp_sitewide_pass = '' if ( !$smtp_sitewide_pass ); +$icon_theme_def = '' if ( !$icon_theme_def ); if ( $ARGV[0] eq '--install-plugin' ) { print "Activating plugin " . $ARGV[1] . "\n"; @@ -1520,12 +1529,12 @@ sub command_smtp_sitewide_userpass($) { } } 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 = ; } } else { print "Invalid input\n"; - print "Click any key to continue\n"; + print "Click enter to continue\n"; $tmp = ; } } @@ -2072,7 +2081,7 @@ sub command215 { 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 = ; $delete_folder = 'true'; } else { @@ -2581,8 +2590,8 @@ sub command_userThemes { $count++; } - - print "\n"; + + print "\n"; print ".------------------------------------.\n"; print "| t (detect user themes) |\n"; print "| + (add user theme) |\n"; @@ -2591,7 +2600,7 @@ sub command_userThemes { print "| l (list user themes) |\n"; print "| d (done) |\n"; print "`------------------------------------'\n"; - + print "\n[user_themes] command (?=help) > "; $input = ; $input =~ s/[\r\n]//g; @@ -2735,14 +2744,22 @@ sub command_userThemes { 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 " "; } @@ -2761,12 +2778,15 @@ sub command_iconSets { $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"; @@ -2777,15 +2797,18 @@ sub command_iconSets { 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++ ) { @@ -2797,6 +2820,8 @@ sub command_iconSets { $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; @@ -2805,6 +2830,14 @@ sub command_iconSets { 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 = ; @@ -2825,6 +2858,8 @@ sub command_iconSets { } 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 = (); @@ -2901,6 +2936,7 @@ sub command_iconSets { 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"; @@ -2920,8 +2956,13 @@ sub command_templates { $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 " "; } @@ -2939,50 +2980,15 @@ sub command_templates { $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" + . "| f N (set fallback template set) |\n" . "| l (list template sets) |\n" . "| d (done) |\n" . "|-------------------------------------|\n" @@ -3001,8 +3007,13 @@ sub command_templates { 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 " "; } @@ -3020,18 +3031,31 @@ sub command_templates { $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*\+/ ) { @@ -3072,9 +3096,6 @@ sub command_templates { $nm =~ s/[\n\r]//g; $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++; @@ -3084,8 +3105,8 @@ sub command_templates { $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 = (); @@ -3121,8 +3142,10 @@ sub command_templates { } 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 = (); @@ -3136,16 +3159,19 @@ sub command_templates { } @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 = ; $input =~ s/[\r\n]//g; @@ -3298,10 +3324,10 @@ sub command61 { print "First, we need to have the hostname or the IP address where\n"; print "this LDAP server resides. Example: ldap.bigfoot.com\n"; - print "\n"; - print "You can use any URI compatible with your LDAP library. Please\n"; + print "\n"; + print "You can use any URI compatible with your LDAP library. Please\n"; print "note that StartTLS option is not compatible with ldaps and\n"; - print "ldapi URIs.\n"; + print "ldapi URIs.\n"; print "hostname: "; $name = ; $name =~ s/[\r\n]//g; @@ -4136,11 +4162,11 @@ sub commandB6 { # Default Icon theme sub commandB7 { - print "You may change the path to the default icon theme to be used, if icons\n"; - print "have been enabled. This theme will be used when an icon cannot be\n"; - print "found in the current theme, or when no icon theme is specified. If\n"; - print "left blank, and icons are enabled, the default theme will be used\n"; - print "from images/themes/default/.\n"; + print "You may change the path to the default icon theme to be used, if icons\n"; + print "have been enabled. This theme will be used when an icon cannot be\n"; + print "found in the current theme, or when no icon theme is specified. If\n"; + print "left blank, and icons are enabled, the default theme will be used\n"; + print "from images/themes/default/.\n"; print "\n"; print "To clear out an existing value, just type a space for the input.\n"; print "\n"; @@ -4355,7 +4381,9 @@ sub save_data { 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') { @@ -4372,15 +4400,11 @@ sub save_data { } 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"; @@ -4557,6 +4581,9 @@ $templateset_fallback = 0; close CF; print "Data saved in config.php\n"; + + build_plugin_hook_array(); + } else { print "Error saving config.php: $!\n"; } @@ -4962,7 +4989,7 @@ sub check_imap_folder($) { 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 = ; return 0; } elsif ($folder_name =~ /[&\*\%]/) { @@ -4987,3 +5014,200 @@ sub quote_single($) { $string =~ s/\'/\\'/g; return $string; } + +# 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 "; + print "\n"; + next; + } + open( FILE, "$setup_file" ); + $inside_init_fxn = 0; + $brace_count = 0; + while ( $line = ) { + + # 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; + + + # throw away lines that are not exactly one "brace set" deep + # + if ($brace_count > 1) { + next; + } + + + # count open braces + # + if ($line =~ /{/) { + $brace_count++; + } + + + # count close braces + # + if ($line =~ /}/) { + $brace_count--; + + # leaving _init() function... + if ($brace_count == 0) { + close(FILE); + next PLUGIN; + } + + } + + + # 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 .= ; + } + + + $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 = ; + 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 = ; + print "\n"; + + } + +} +