- added more hooks

- updated documentation on plugins to include a list of hooks
- added info in plugin.txt on how to use "options" in your plugins

git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@651 7612ce4b-ef26-0410-bec9-ea0150e637f0

diff --git a/config/conf.pl b/config/conf.pl
index 1808c2b7837288a7532073cd0c400266bd70f654..6cb6038f64738739447f7f333d33f57c169f3b0b 100755 (executable)
--- a/config/conf.pl
+++ b/config/conf.pl
@@ -38,11 +38,11 @@ if ( -e "config.php") {
    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 "  The file \"config/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 "  you do.  To do this, just move config/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/)) {
@@ -1335,9 +1335,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";
+   if ($print_config_version) {
+      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";

diff --git a/doc/plugin.txt b/doc/plugin.txt
index 574e1066bb6d981d853c1af3a9eb13fcc7ad39e5..99e5998d4cd4a783657f0a70e8b75fbbca88ee5a 100644 (file)
--- a/doc/plugin.txt
+++ b/doc/plugin.txt
@@ -72,3 +72,66 @@ Note that the SquirrelMail files assume that all other SquirrelMail
 files are available as ../directory/file. This means that if some file
 in the plugin directory is requested, it must do a chdir("..") before
 including any of the standard SquirrelMail files.
+
+
+List of hooks
+-------------
+  generic_header                 functions/page_header.php
+  menuline                       functions/page_header.php
+  compose_button_row             src/compose.php
+  left_main_before               src/left_main.php
+  left_main_after                src/left_main.php
+  options_save                   src/options.php  (see note on options)
+  options_link_and_description   src/options.php  (see note on options)
+  logout                         src/signout.php
+  login_before                   src/webmail.php
+  login_verified                 src/webmail.php
+  loading_prefs                  src/load_prefs.php
+  mailbox_index_before           functions/mailbox_display.php
+  mailbox_index_after            functions/mailbox_display.php
+
+
+Options
+-------
+
+It is possible to create your own options sections with plugins.  There are
+three hooks you will need to use.
+
+1.  options_link_and_description
+    This creates the link and has a description that are shown on the options
+    page.  This should output HTML that looks like this:
+
+    -----cut here-----  
+      function my_function() {
+         global $color
+         ?>
+         <table width=50% cellpadding=3 cellspacing=0 border=0 align=center>
+            <tr>
+               <td bgcolor="<? echo $color[9] ?>">
+                  <a href="../plugins/YOUR_PLUGIN/YOUR_OPTIONS.php">YOUR OPTIONS NAME</a>
+               </td>
+            </tr>
+            <tr>
+               <td bgcolor="<? echo $color[0] ?>">
+                  YOUR DESCRIPTION
+               </td>
+            </tr>
+         </table>
+         <?php
+      }
+    -----cut here-----  
+
+2.  options_save
+    Here is the code that you need to do to save your options in the 
+    preference files or manipulate whatever data you are trying to change
+    through the options section.  You can look at options.php for details 
+    on how this is to be done.
+
+3.  loading_prefs (optional)
+    If you are wanting to save preferences to the preference files, then
+    you need to do this step as well.  Otherwise if you are manipulating
+    other data, ignore this step.
+
+    You should put the code in here that loads your preferences back
+    into usable variables.  Examples of this can be found in the file
+    src/load_prefs.php

diff --git a/functions/mailbox_display.php b/functions/mailbox_display.php
index 638529a20701de8394c47b07d92f0d325c69fac6..e30254534dfc5a0a9f4b4adc8824238ceb11845c 100644 (file)
--- a/functions/mailbox_display.php
+++ b/functions/mailbox_display.php
@@ -190,6 +190,7 @@
       $prevGroup = $startMessage - $show_num;
       $urlMailbox = urlencode($mailbox);
 
+      do_hook("mailbox_index_before");
       /** This is the beginning of the message list table.  It wraps around all messages */
       echo "<TABLE WIDTH=100% BORDER=0 CELLPADDING=2 CELLSPACING=0>";
 
@@ -334,5 +335,7 @@
          echo "<A HREF=\"right_main.php?use_mailbox_cache=1&startMessage=$nextGroup&mailbox=$urlMailbox\" TARGET=\"right\">" . _("Next") . "</A>\n";
       }
       echo "</TD></TR></table>"; /** End of message-list table */
+
+      do_hook("mailbox_index_after");
    }
 ?>

diff --git a/functions/plugin.php b/functions/plugin.php
index 696cab5c74ba12cd3b8edbca1bdb6c44eb7b7513..cb845ea943044c7c17daf3fa9595c7e395cd2baf 100644 (file)
--- a/functions/plugin.php
+++ b/functions/plugin.php
@@ -19,9 +19,11 @@
 
    // This function adds a plugin
    function use_plugin ($name) {
-      include ('../plugins/'.$name.'/setup.php');
-      $function = 'squirrelmail_plugin_init_'.$name;
-      $function();
+      if (file_exists('../plugins/'.$name.'/setup.php')) {
+         include ('../plugins/'.$name.'/setup.php');
+         $function = 'squirrelmail_plugin_init_'.$name;
+         $function();
+      }
    }
 
    // This function executes a hook

diff --git a/src/left_main.php b/src/left_main.php
index 91d2bcc0717ef59972d4c8a61b1e8b41efcc7488..112ad87b7aca3dc1a961b526acf28b002e0a17f4 100644 (file)
--- a/src/left_main.php
+++ b/src/left_main.php
@@ -148,7 +148,7 @@
       }
       echo "\n$line<BR>\n";
    }
-
    sqimap_logout($imapConnection);
+   do_hook("left_main_after");
 ?>
 </BODY></HTML>

diff --git a/src/load_prefs.php b/src/load_prefs.php
index 94b05e35350afd723a4e0e2f2fecaf84971680c3..0cceee3fecfc1b6119147921077047019c029633 100644 (file)
--- a/src/load_prefs.php
+++ b/src/load_prefs.php
@@ -14,6 +14,8 @@
       include("../config/config.php");
    if (!isset($prefs_php))
       include("../functions/prefs.php");
+   if (!isset($plugin_php))
+      include("../functions/plugin.php");
       
    $load_prefs_php = true;
    checkForPrefs($data_dir, $username);
@@ -153,4 +155,5 @@
       $message_highlight_list[$i]["match_type"] = $ary[3];
    }
 
+   do_hook("loading_prefs");
 ?>

diff --git a/src/options.php b/src/options.php
index df5ed332ed575b07459235fc5f2a587ec23ba8a0..e32ef0dd0c8e207874825669be72c407dfda0dcf 100644 (file)
--- a/src/options.php
+++ b/src/options.php
@@ -89,7 +89,10 @@
       setPref($data_dir, $username, "unseen_type", $unseentype);
       echo "<br><center><b>"._("Successfully saved folder preferences!")."</b><br>";
       echo "<a href=\"left_main.php\" target=left>"._("Refresh Folders")."</a></center><br>";
+   } else {
+      do_hook("options_save");
    }
+   
 ?>
 
 
@@ -149,4 +152,7 @@
    </td>
 </tr>
 </table>
+   <?
+      do_hook("options_link_and_description")
+   ?>
 </body></html>