Add two new command line options in conf.pl: --update-plugins or -u updates plugin_ho...
[squirrelmail.git] / config / conf.pl
index 732c4aaebc138f0f0292188db5746f62aa3e7b1a..a3d1c7f7a98d0a28ba2904f65573b85532db75c9 100755 (executable)
@@ -53,7 +53,7 @@ if ( -e "config.php" ) {
         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;
     }
@@ -485,6 +485,20 @@ if ( $ARGV[0] eq '--install-plugin' ) {
     @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);
 }
 
 #####################################################################################
@@ -1529,12 +1543,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 = <STDIN>;
         }
     } else {
         print "Invalid input\n";
-        print "Click any key to continue\n";
+        print "Click enter to continue\n";
         $tmp = <STDIN>;
     }
 }
@@ -2081,7 +2095,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 = <STDIN>;
         $delete_folder = 'true';
     } else {
@@ -2744,14 +2758,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 "  ";
         }
@@ -2770,12 +2792,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";
@@ -2786,15 +2811,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++ ) {
@@ -2806,6 +2834,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;
@@ -2814,6 +2844,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 = <STDIN>;
@@ -2834,6 +2872,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 = ();
@@ -2910,6 +2950,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";
@@ -4354,7 +4395,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') {
@@ -4552,6 +4595,9 @@ sub save_data {
         close CF;
 
         print "Data saved in config.php\n";
+
+        build_plugin_hook_array();
+
     } else {
         print "Error saving config.php: $!\n";
     }
@@ -4957,7 +5003,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 = <STDIN>;
         return 0;
     } elsif ($folder_name =~ /[&\*\%]/) {
@@ -4982,3 +5028,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 "<?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;
+
+
+                # 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 <plugin>_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 .= <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";
+
+    }
+
+}
+