added config file versions so conf.pl can detect if you are using a
[squirrelmail.git] / config / conf.pl
index 6f91787275d5345e9a23d4fec4a91afb7f2b7a7a..af2335262b1790f1de3574235e3e9b468e29a3db 100755 (executable)
 ############################################################              
 $WHT = "\x1B[37;1m";
 $NRM = "\x1B[0m";
+$conf_pl_version = "x51";
 
 ############################################################              
 # First, lets read in the data already in there...
 ############################################################              
 if ( -e "config.php") {
+   open (FILE, "config.php");
+   while ($line = <FILE>) {
+      if ($line =~ /^\s+\$/) {
+         $line =~ s/^\s+\$//;
+         $var = $line;
+      
+         $var =~ s/=/EQUALS/;
+         if ($var =~ /^([a-z]|[A-Z])/) {
+            @o = split(/\s*EQUALS\s*/, $var);
+            if ($o[0] eq "config_version") {
+               $o[1] =~ s/[\n|\r]//g;
+               $o[1] =~ s/\";\s*$//;
+               $o[1] =~ s/;$//;
+               $o[1] =~ s/^"//;
+
+               $config_version = $o[1];
+               close (FILE);
+            }
+         }
+      }   
+   }
+   close (FILE);
+
+   if ($config_version ne $conf_pl_version) {
+      system "clear";
+      print $WHT."WARNING:\n".$NRM;
+      print "  The file \"config.php\" was found, but it is for an older version of\n";
+      print "  SquirrelMail.  It is possible to still read the defaults from this file\n";
+      print "  but be warned that many preferences change between versions.  It is\n";
+      print "  recommended that you start with a clean config.php for each upgrade that\n";
+      print "  you do.  To do this, just move config.php out of the way.\n\n";
+      print "Continue loading with the old config.php [y/n]? ";
+      $ctu = <STDIN>;
+      if (($ctu =~ /^n\n/i) || ($ctu =~ /^\n/)) {
+         exit;
+      }
+
+      print "\nDo you want me to stop warning you [y/n]? ";
+      $ctu = <STDIN>;
+      if ($ctu =~ /^y\n/i) {
+         $print_config_version = $conf_pl_version;
+      } else {
+         $print_config_version = $config_version;
+      }
+   } else {
+      $print_config_version = $config_version;
+   } 
+
    $config = 1;
    open (FILE, "config.php");
 } elsif (-e "config_default.php") {
+   open (FILE, "config_default.php");
+   while ($line = <FILE>) {
+      if ($line =~ /^\s+\$/) {
+         $line =~ s/^\s+\$//;
+         $var = $line;
+      
+         $var =~ s/=/EQUALS/;
+         if ($var =~ /^([a-z]|[A-Z])/) {
+            @o = split(/\s*EQUALS\s*/, $var);
+            if ($o[0] eq "config_version") {
+               $o[1] =~ s/[\n|\r]//g;
+               $o[1] =~ s/\";\s*$//;
+               $o[1] =~ s/;$//;
+               $o[1] =~ s/^"//;
+
+               $config_version = $o[1];
+               close (FILE);
+            }
+         }
+      }   
+   }
+   close (FILE);
+
+   if ($config_version ne $conf_pl_version) {
+      system "clear";
+      print $WHT."WARNING:\n".$NRM;
+      print "  You are trying to use a \"config_default.php\" from an older version of\n";
+      print "  SquirrelMail.  This is HIGHLY unrecommended.  You should get the\n";
+      print "  \"config_default.php\" that matches the version of SquirrelMail that you\n";
+      print "  are running.  You can get this from the SquirrelMail web page by going\n";
+      print "  to:  http://www.squirrelmail.org.\n\n";
+      print "Continue loading with the old config_default.php (not a good idea) [y/n]? ";
+      $ctu = <STDIN>;
+      if (($ctu =~ /^n\n/i) || ($ctu =~ /^\n/)) {
+         exit;
+      }
+
+      print "\nDo you want me to stop warning you [y/n]? ";
+      $ctu = <STDIN>;
+      if ($ctu =~ /^y\n/i) {
+         $print_config_version = $conf_pl_version;
+      } else {
+         $print_config_version = $config_version;
+      }
+   } else {
+      $print_config_version = $config_version;
+   }
    $config = 2;
    open (FILE, "config_default.php");
 } else {
@@ -31,26 +127,33 @@ while ($line = <FILE>) {
       $line =~ s/^\s+\$//;
       $var = $line;
       
+      $var =~ s/=/EQUALS/;
       if ($var =~ /^([a-z]|[A-Z])/) {
-         @options = split(/\s*=\s*/, $var);
+         @options = split(/\s*EQUALS\s*/, $var);
          $options[1] =~ s/[\n|\r]//g;
-         $options[1] =~ s/^"//g;
-         $options[1] =~ s/;\s*$//g;
-         $options[1] =~ s/"$//g;
+         $options[1] =~ s/\";\s*$//;
+         $options[1] =~ s/;$//;
+         $options[1] =~ s/^"//;
 
          if ($options[0] =~ /^theme\[[0-9]+\]\["PATH"\]/) {
             $sub = $options[0];
             $sub =~ s/\]\["PATH"\]//;
-            $sub = substr ($sub, @sub-1, 1);
+            $sub =~ s/.*\[//; 
             $theme_path[$sub] = $options[1];
          } elsif ($options[0] =~ /^theme\[[0-9]+\]\["NAME"\]/) {
             $sub = $options[0];
             $sub =~ s/\]\["NAME"\]//;
-            $sub = substr ($sub, @sub-1, 1);
+            $sub =~ s/.*\[//; 
             $theme_name[$sub] = $options[1];
+         } elsif ($options[0] =~ /^plugins\[[0-9]+\]/) {
+            $sub = $options[0];
+            $sub =~ s/\]//; 
+            $sub =~ s/^plugins\[//;
+            $plugins[$sub] = $options[1];
          } elsif ($options[0] =~ /^ldap_server\[[0-9]+\]/) {
             $sub = $options[0];
-            $sub = substr ($sub, length($sub)-2, 1);
+            $sub =~ s/\]//; 
+            $sub =~ s/^ldap_server\[//;
             $continue = 0;
             while (($tmp = <FILE>) && ($continue != 1)) {
                if ($tmp =~ /\);\s*$/) {
@@ -107,6 +210,12 @@ if ($useSendmail ne "true") {
 if (!$sendmail_path) {
    $sendmail_path = "/usr/sbin/sendmail";
 }
+if (!$default_unseen_notify) {
+   $default_unseen_notify = 2;
+}
+if (!$default_unseen_type) {
+   $default_unseen_type = 1;
+}
 
 #####################################################################################
 
@@ -126,6 +235,7 @@ while (($command ne "q") && ($command ne "Q")) {
       print "5.  Themes\n";
       print "6.  Address Books (LDAP)\n";
       print "7.  Message of the Day (MOTD)\n";
+      print "8.  Plugins\n";
       print "\n";
       print "D.  Set pre-defined settings for specific IMAP servers\n";
       print "\n";
@@ -164,15 +274,16 @@ while (($command ne "q") && ($command ne "Q")) {
       print "9.  Auto Expunge               : $WHT$auto_expunge$NRM\n";
       print "10. Default Sub. of INBOX      : $WHT$default_sub_of_inbox$NRM\n";
       print "11. Show 'Contain Sub.' Option : $WHT$show_contain_subfolders_option$NRM\n";
+      print "12. Default Unseen Notify      : $WHT$default_unseen_notify$NRM\n";
+      print "13. Default Unseen Type        : $WHT$default_unseen_type$NRM\n";
       print "\n";
       print "R   Return to Main Menu\n";
    } elsif ($menu == 4) {
       print $WHT."General Options\n".$NRM;
       print "1.  Default Charset      : $WHT$default_charset$NRM\n";
-      print "2.  Auto Forward         : $WHT$auto_forward$NRM\n";
-      print "3.  Data Directory       : $WHT$data_dir$NRM\n";
-      print "4.  Attachment Directory : $WHT$attachment_dir$NRM\n";
-      print "5.  Default Left Size    : $WHT$default_left_size$NRM\n";
+      print "2.  Data Directory       : $WHT$data_dir$NRM\n";
+      print "3.  Attachment Directory : $WHT$attachment_dir$NRM\n";
+      print "4.  Default Left Size    : $WHT$default_left_size$NRM\n";
       print "\n";
       print "R   Return to Main Menu\n";
    } elsif ($menu == 5) {
@@ -199,6 +310,14 @@ while (($command ne "q") && ($command ne "Q")) {
       print "1   Edit the MOTD\n";
       print "\n";
       print "R   Return to Main Menu\n";
+   } elsif ($menu == 8) {
+      print $WHT."Plugins\n".$NRM;
+      print "1   Change Plugins\n";
+      for ($count = 0; $count <= $#plugins; $count++) {
+         print "    >  $plugins[$count]\n";
+      }
+      print "\n";
+      print "R   Return to Main Menu\n";
    }
    print "S   Save data\n";
    print "Q   Quit\n";
@@ -230,7 +349,7 @@ while (($command ne "q") && ($command ne "Q")) {
    } else {
       $saved = 0;
       if ($menu == 0) {
-         if (($command > 0) && ($command < 8)) {
+         if (($command > 0) && ($command < 9)) {
             $menu = $command;
          }
       } elsif ($menu == 1) {
@@ -258,12 +377,13 @@ while (($command ne "q") && ($command ne "Q")) {
          elsif ($command == 9) { $auto_expunge                   = command29 (); }
          elsif ($command == 10){ $default_sub_of_inbox           = command210(); }
          elsif ($command == 11){ $show_contain_subfolders_option = command211(); }
+         elsif ($command == 12){ $default_unseen_notify          = command212(); }
+         elsif ($command == 13){ $default_unseen_type            = command213(); }
       } elsif ($menu == 4) {
          if    ($command == 1) { $default_charset    = command31 (); }
-         elsif ($command == 2) { $auto_forward       = command32 (); }
-         elsif ($command == 3) { $data_dir           = command33 (); }
-         elsif ($command == 4) { $attachment_dir     = command34 (); }
-         elsif ($command == 5) { $default_left_size  = command35 (); }
+         elsif ($command == 2) { $data_dir           = command33 (); }
+         elsif ($command == 3) { $attachment_dir     = command34 (); }
+         elsif ($command == 4) { $default_left_size  = command35 (); }
       } elsif ($menu == 5) {
          if ($command == 1) { 
             command41 (); 
@@ -273,6 +393,8 @@ while (($command ne "q") && ($command ne "Q")) {
          elsif ($command == 2) { command62(); }
       } elsif ($menu == 7) {
          if    ($command == 1) { $motd = command71(); }
+      } elsif ($menu == 8) {
+         if    ($command == 1) { $motd = command81(); }
       }
    }   
 }
@@ -463,6 +585,7 @@ sub command71 {
    print "every time a user logs on.  You can use HTML or just plain\n";
    print "text.\n\n(Type @ on a blank line to exit)\n";
    
+   $new_motd = "";
    do {
       print "] ";
       $line = <STDIN>;
@@ -471,7 +594,7 @@ sub command71 {
          $line =~ s/  /\&nbsp;\&nbsp;/g;
          $line =~ s/\t/\&nbsp;\&nbsp;\&nbsp;\&nbsp;/g;
          $line =~ s/$/ /;
-         $line =~ s/"/\"/g;
+         $line =~ s/\"/\\\"/g;
 
          $new_motd = $new_motd . $line;
       }
@@ -479,6 +602,77 @@ sub command71 {
    return $new_motd;
 }
 
+################# PLUGINS ###################
+
+sub command81 {
+   print "\nThis is where you can define plugins.  The plugin must already exist in the\n";
+   print "plugins/ directory in order to add them here.  A plugin name is the name of the\n";
+   print "directory that it resides in.  For example, if you have a plugin in the directory\n";
+   print "plugins/myplug, the name is \"myplug\".\n\n";
+   print "[plugins] command (?=help) > ";
+   $input = <STDIN>;
+   $input =~ s/[\r|\n]//g;
+   while ($input ne "d") {
+      if ($input =~ /^\s*l\s*/i) {
+         $count = 0;
+         while ($count <= $#plugins) {
+            print " $count.  $plugins[$count]\n";
+            $count++;
+         }
+         print "\n";
+      } elsif ($input =~ /^\s*\+/) {
+         print "What is the name of this plugin: ";
+         $name = <STDIN>;
+         $name =~ s/[\r|\n]//g;
+
+         if (-e "../plugins/$name") {
+            $exists = 0;
+            for ($m=0; $m <= $#plugins; $m++) {
+               if ($plugins[$m] eq $name) {
+                  $exists = 1;
+               }
+            }
+            if ($exists == 1) {
+               print "\nThat plugin already exists in the list!\n";
+            } else {
+               $plugins[$#plugins+1] = $name;
+            }   
+            print "\n";
+         } else {
+            print "\nThat plugin does not exist in the plugins/ directory!\n\n";
+         }
+      } elsif ($input =~ /^\s*-\s*[0-9]?/) {
+         if ($input =~ /[0-9]+\s*$/) {
+            $rem_num = $input;
+            $rem_num =~ s/^\s*-\s*//g;
+            $rem_num =~ s/\s*$//;
+         } else {
+            $rem_num = $#plugins;
+         }
+            
+         $count = 0;
+         @new_plugins = ();
+         while ($count <= $#plugins) {
+            if ($count != $rem_num) {
+               @new_plugins = (@new_plugins, $plugins[$count]);
+            }
+            $count++;
+         }
+         @plugins = @new_plugins;
+      } elsif ($input =~ /^\s*\?\s*/) {
+         print ".-------------------------.\n";
+         print "| +          (add plugin) |\n";
+         print "| - N     (remove plugin) |\n";
+         print "| l        (list plugins) |\n";
+         print "| d                (done) |\n";
+         print "`-------------------------'\n";
+      }
+      print "[plugins] command (?=help) > ";
+      $input = <STDIN>;
+      $input =~ s/[\r|\n]//g;
+   }
+}   
+
 ################# FOLDERS ###################
 
 # default_folder_prefix
@@ -609,8 +803,7 @@ sub command25 {
 sub command26 {
    print "By default, should messages get moved to the sent folder?  You\n";
    print "can specify the default sent folder in option 4.  If this is set\n";
-   print "to false, messages will get deleted immediately without moving\n";
-   print "to the sent folder.\n";
+   print "to false, messages will get sent an no copy will be made.\n";
    print "\n";
    print "Trash folder is currently: $sent_folder\n";
    print "\n";
@@ -752,6 +945,43 @@ sub command211 {
    return $show_contain_subfolders_option;
 }
 
+# Default Unseen Notify 
+sub command212 {
+   print "This option specifies where the users will receive notification\n";
+   print "about unseen messages by default.  This is of course an option that\n";
+   print "can be changed on a user level.\n";
+   print "  1 = No notification\n";
+   print "  2 = Only on the INBOX\n";
+   print "  3 = On all folders\n";
+   print "\n";
+   
+   print "Which one should be default (1,2,3)? [$WHT$default_unseen_notify$NRM]: $WHT";
+   $new_show = <STDIN>;
+   if ($new_show =~ /^[1|2|3]\n/i) {
+      $default_unseen_notify = $new_show;
+   }
+   $default_unseen_notify =~ s/[\r|\n]//g;
+   return $default_unseen_notify;
+}
+
+# Default Unseen Type 
+sub command213 {
+   print "Here you can define the default way that unseen messages will be displayed\n";
+   print "to the user in the folder listing on the left side.\n";
+   print "  1 = Only unseen messages   (4)\n";
+   print "  2 = Unseen and Total messages  (4/27)\n";
+   print "\n";
+   
+   print "Which one should be default (1,2)? [$WHT$default_unseen_type$NRM]: $WHT";
+   $new_show = <STDIN>;
+   if ($new_show =~ /^[1|2]\n/i) {
+      $default_unseen_type = $new_show;
+   }
+   $default_unseen_type =~ s/[\r|\n]//g;
+   return $default_unseen_type;
+}
+
+
 ############# GENERAL OPTIONS #####################
 
 # Default Charset
@@ -773,32 +1003,6 @@ sub command31 {
    return $new_default_charset;
 }
 
-# Auto Forward
-sub command32 {
-   print "There are some places that we will automatically forward the user\n";
-   print "rather than display pointless messages like 'Message sent!' or\n";
-   print "stuff like that.  Use this or not?\n";
-   print "\n";
-   print "NOTE:  This is not working currently as we are trying to find a\n";
-   print "       better way to handle this.  This option really doesn't do\n";
-   print "       much.\n";
-   print "\n";
-   
-   if ($auto_forward eq "true") {
-      $default_value = "y";
-   } else {
-      $default_value = "n";
-   }
-   print "Auto forward (y/n) [$WHT$default_value$NRM]: $WHT";
-   $new_show = <STDIN>;
-   if (($new_show =~ /^y\n/i) || (($new_show =~ /^\n/) && ($default_value eq "y"))) {
-      $auto_forward = "true";
-   } else {
-      $auto_forward = "false";
-   }
-   return $auto_forward;
-}
-
 # Data directory
 sub command33 {
    print "It is a possible security hole to have a writable directory\n";
@@ -916,8 +1120,8 @@ sub command41 {
          $name = <STDIN>;
          $name =~ s/[\r|\n]//g;
          $theme_name[$#theme_name+1] = $name;
-         print "Be sure to put ../config/ before the filename.\n";
-         print "What file is this stored in (ex: ../config/default_theme.php): ";
+         print "Be sure to put ../themes/ before the filename.\n";
+         print "What file is this stored in (ex: ../themes/default_theme.php): ";
          $name = <STDIN>;
          $name =~ s/[\r|\n]//g;
          $theme_path[$#theme_path+1] = $name;
@@ -1128,6 +1332,10 @@ sub save_data {
    print FILE "<?php\n\t/** SquirrelMail configuration\n";
    print FILE "\t ** Created using the configure script, conf.pl\n\t **/\n\n";
 
+   print FILE "\t\$config_version = \"$print_config_version\";\n";
+
+   print FILE "\n";
+   
    print FILE "\t\$org_name   = \"$org_name\";\n";
    print FILE "\t\$org_logo   = \"$org_logo\";\n";
    print FILE "\t\$org_title  = \"$org_title\";\n";
@@ -1156,16 +1364,23 @@ sub save_data {
    print FILE "\t\$auto_expunge                     =  $auto_expunge;\n";
    print FILE "\t\$default_sub_of_inbox             =  $default_sub_of_inbox;\n";
    print FILE "\t\$show_contain_subfolders_option   =  $show_contain_subfolders_option;\n";
+   print FILE "\t\$default_unseen_notify            =  $default_unseen_notify;\n";
+   print FILE "\t\$default_unseen_type              =  $default_unseen_type;\n";
    print FILE "\n";
 
    print FILE "\t\$default_charset   = \"$default_charset\";\n";
-   print FILE "\t\$auto_forward      =  $auto_forward;\n";
    print FILE "\t\$data_dir          = \"$data_dir\";\n";
    print FILE "\t\$attachment_dir    = \"$attachment_dir\";\n";
    print FILE "\t\$default_left_size =  $default_left_size;\n";
 
    print FILE "\n";
 
+   for ($count=0; $count <= $#plugins; $count++) {
+      print FILE "\t\$plugins[$count] = \"$plugins[$count]\";\n";
+   }
+   
+   print FILE "\n";
+
    for ($count=0; $count <= $#theme_name; $count++) {
       print FILE "\t\$theme[$count][\"PATH\"] = \"$theme_path[$count]\";\n";
       print FILE "\t\$theme[$count][\"NAME\"] = \"$theme_name[$count]\";\n";
@@ -1196,7 +1411,6 @@ sub save_data {
       print FILE ");\n\n";
    }
 
-   print FILE "\n";
    print FILE "\t\$motd = \"$motd\";\n";
 
    print FILE "?>\n";
@@ -1212,7 +1426,7 @@ sub set_defaults {
    print "\n";
    print "Please note that you will still need to go through and make sure\n";
    print "everything is correct.  This does not change everything.  There are\n";
-   print "only a few settings that thils will change.\n";
+   print "only a few settings that this will change.\n";
    print "\n";
 
    $continue = 0;
@@ -1240,7 +1454,7 @@ sub set_defaults {
          print "         default_folder_prefix = INBOX\n";
          print "                  trash_folder = INBOX.Trash\n";
          print "                   sent_folder = INBOX.Sent\n";
-         print "             show_prefix_optin = false\n";
+         print "            show_prefix_option = false\n";
          print "          default_sub_of_inbox = true\n";
          print "show_contain_subfolders_option = false\n";
          print "              imap_server_type = cyrus\n";