Adding debug mode to core. Please run the configuration utility once after retrievin...
[squirrelmail.git] / config / conf.pl
index d98b9aff126ffd6a6b115963f918863175c952f1..191480e38687865f73d24bd243ff3b8cd3b8d639 100755 (executable)
@@ -424,6 +424,12 @@ $use_icons = 'false'                    if ( !$use_icons );
 $use_iframe = 'false'                   if ( !$use_iframe );
 $lossy_encoding = 'false'               if ( !$lossy_encoding );
 $allow_remote_configtest = 'false'      if ( !$allow_remote_configtest );
+
+$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 );
@@ -724,7 +730,12 @@ while ( ( $command ne "q" ) && ( $command ne "Q" ) && ( $command ne ":q" ) ) {
         $num = 0;
         for ( $count = 0 ; $count <= $#plugins ; $count++ ) {
             $num = $count + 1;
-            print "    $num. $plugins[$count]" . get_plugin_version($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" );
@@ -732,7 +743,7 @@ while ( ( $command ne "q" ) && ( $command ne "Q" ) && ( $command ne ":q" ) ) {
         $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] ) {
@@ -748,7 +759,12 @@ while ( ( $command ne "q" ) && ( $command ne "Q" ) && ( $command ne ":q" ) ) {
 
         for ( $i = 0 ; $i <= $#unused_plugins ; $i++ ) {
             $num = $num + 1;
-            print "    $num. $unused_plugins[$i]" . get_plugin_version($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;
 
@@ -799,6 +815,7 @@ while ( ( $command ne "q" ) && ( $command ne "Q" ) && ( $command ne ":q" ) ) {
     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 "\n";
         print "R   Return to Main Menu\n";
     }
@@ -971,6 +988,7 @@ while ( ( $command ne "q" ) && ( $command ne "Q" ) && ( $command ne ":q" ) ) {
             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(); }
         }
     }
 }
@@ -1544,10 +1562,10 @@ sub command_smtp_sitewide_userpass($) {
     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);
@@ -2599,7 +2617,7 @@ sub command318 {
     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;
@@ -2770,11 +2788,11 @@ sub command_userThemes {
             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 ) {
@@ -2783,9 +2801,16 @@ sub command_userThemes {
                     }
                     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;
                     }
@@ -2975,11 +3000,11 @@ sub command_iconSets {
             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 ) {
@@ -2988,9 +3013,16 @@ sub command_iconSets {
                     }
                     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;
                     }
@@ -3171,10 +3203,10 @@ sub command_templates {
         } 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++ ) {
@@ -3185,9 +3217,16 @@ sub command_templates {
                     }
                     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;
                     }
@@ -4305,6 +4344,86 @@ sub commandB7 {
     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;
+}
+
 sub save_data {
     $tab = "    ";
     if ( open( CF, ">config.php" ) ) {
@@ -4700,6 +4819,10 @@ sub save_data {
         print CF "\n";
         # boolean
         print CF "\$allow_remote_configtest = $allow_remote_configtest;\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;
@@ -5108,7 +5231,7 @@ sub check_imap_folder($) {
     } 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$/) {
@@ -5190,6 +5313,61 @@ sub get_plugin_version() {
 
 }
 
+# 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
@@ -5385,3 +5563,91 @@ PLUGIN: for ( $ct = 0 ; $ct <= $#plugins ; $ct++ ) {
     }
 
 }
+
+# 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;
+}