Unify address book searches. See ChangeLog comments. Also, fixed bug wherein file...

[squirrelmail.git] / plugins / spamcop / setup.php

diff --git a/plugins/spamcop/setup.php b/plugins/spamcop/setup.php
index f4d064c65e7fae8a8733108af0b2d016446084bb..2305e73696cb0958ce529d01153618181630a18e 100755 (executable)
--- a/plugins/spamcop/setup.php
+++ b/plugins/spamcop/setup.php
@@ -1,115 +1,66 @@
 <?php
 
-
-/* Initialize the plugin */
+/**
+ * setup.php -- SpamCop plugin - setup script
+ *
+ * @copyright 1999-2011 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package plugins
+ * @subpackage spamcop
+ */
+
+/**
+ * Initialize the plugin
+ * @access private
+ */
 function squirrelmail_plugin_init_spamcop() {
-   global $squirrelmail_plugin_hooks, $data_dir, $username,
-      $spamcop_is_composing;
-
-   $squirrelmail_plugin_hooks['optpage_register_block']['spamcop'] =
-      'spamcop_options';
-   $squirrelmail_plugin_hooks['loading_prefs']['spamcop'] =
-      'spamcop_load';
-   $squirrelmail_plugin_hooks['read_body_header_right']['spamcop'] =
-      'spamcop_show_link';
-      
-   if (isset($spamcop_is_composing)) {
-      $squirrelmail_plugin_hooks['compose_send']['spamcop'] =
-         'spamcop_while_sending';
-   }
+    global $squirrelmail_plugin_hooks;
+
+    $squirrelmail_plugin_hooks['optpage_register_block']['spamcop'] =
+        'spamcop_options';
+    $squirrelmail_plugin_hooks['loading_prefs']['spamcop'] =
+        'spamcop_load';
+    $squirrelmail_plugin_hooks['read_body_header_right']['spamcop'] =
+        'spamcop_show_link';
+    $squirrelmail_plugin_hooks['compose_send']['spamcop'] =
+        'spamcop_while_sending';
 }
 
-
-// Load the settings
-// Validate some of it (make '' into 'default', etc.)
+/**
+ * Loads spamcop settings and validates some of values (make '' into 'default', etc.)
+ * @access private
+ */
 function spamcop_load() {
-   global $username, $data_dir, $spamcop_enabled, $spamcop_delete,
-      $spamcop_method, $spamcop_id;
-
-   $spamcop_enabled = getPref($data_dir, $username, 'spamcop_enabled');
-   $spamcop_delete = getPref($data_dir, $username, 'spamcop_delete');
-   $spamcop_method = getPref($data_dir, $username, 'spamcop_method');
-   $spamcop_id = getPref($data_dir, $username, 'spamcop_id');
-   if ($spamcop_method == '') {
-      if (getPref($data_dir, $username, 'spamcop_form'))
-         $spamcop_method = 'web_form';
-      else
-         $spamcop_method = 'thorough_email';
-      setPref($data_dir, $username, 'spamcop_method', $spamcop_method);
-   }
-   if ($spamcop_id == '')
-      $spamcop_enabled = 0;
+    include_once(SM_PATH . 'plugins/spamcop/functions.php');
+    spamcop_load_function();
 }
 
 
-// Show the link on the read-a-message screen
-function spamcop_show_link() {
-   global $passed_id, $mailbox, $ent_num, $spamcop_enabled, $startMessage,
-      $spamcop_method;
-
-   // This was stolen from printer_friendly
-   // Do I really need/want it?
-   if (!trim($mailbox))
-      $mailbox = 'INBOX';
-
-   if (! $spamcop_enabled)
-      return;
-
-   echo "<br>\n";
-   
-   if ($spamcop_method == 'web_form') {
-?><script language=javascript>
-document.write('<a href="../plugins/spamcop/spamcop.php?passed_id=<?PHP
-echo urlencode($passed_id); ?>&js_web=1&mailbox=<?PHP
-echo urlencode($mailbox); ?>" target="_blank">');
-document.write("<?PHP echo _("Report as Spam"); ?>");
-document.write("</a>");
-</script><noscript>
-<a href="../plugins/spamcop/spamcop.php?passed_id=<?PHP
-echo urlencode($passed_id); ?>&mailbox=<?PHP
-echo urlencode($mailbox); ?>&startMessage=<?PHP
-echo urlencode($startMessage); ?>"><?PHP
-echo _("Report as Spam"); ?></a>
-</noscript><?PHP
-   } else {
-?><a href="../plugins/spamcop/spamcop.php?passed_id=<?PHP
-echo urlencode($passed_id); ?>&mailbox=<?PHP
-echo urlencode($mailbox); ?>&startMessage=<?PHP
-echo urlencode($startMessage); ?>"><?PHP
-echo _("Report as Spam"); ?></a><?PHP
-   }
+/**
+ * Shows spamcop link on the read-a-message screen
+ * @access private
+ */
+function spamcop_show_link(&$links) {
+    include_once(SM_PATH . 'plugins/spamcop/functions.php');
+    spamcop_show_link_function($links);
 }
 
-
-// Show the link to our own custom options page
-function spamcop_options()
-{
-   global $optpage_blocks;
-   
-   $optpage_blocks[] = array(
-      'name' => _("SpamCop - Spam Reporting"),
-      'url' => '../plugins/spamcop/options.php',
-      'desc' => _("Help fight the battle against unsolicited email.  SpamCop reads the spam email and determines the correct addresses to send complaints to.  Quite fast, really smart, and easy to use."),
-      'js' => false
-   );
+/**
+ * Show spamcop options block
+ * @access private
+ */
+function spamcop_options() {
+    include_once(SM_PATH . 'plugins/spamcop/functions.php');
+    spamcop_options_function();
 }
 
 
-// When we send the email, we optionally trash it then too
-function spamcop_while_sending()
-{
-   global $mailbox, $spamcop_delete, $spamcop_is_composing, $auto_expunge, 
-      $username, $key, $imapServerAddress, $imapPort;
-
-   if ($spamcop_delete) {
-      $imapConnection = sqimap_login($username, $key, $imapServerAddress, 
-         $imapPort, 0);
-      sqimap_mailbox_select($imapConnection, $mailbox);
-      sqimap_messages_delete($imapConnection, $spamcop_is_composing, 
-         $spamcop_is_composing, $mailbox);
-      if ($auto_expunge)
-         sqimap_mailbox_expunge($imapConnection, $mailbox, true);
-   }
+/**
+ * Process messages submitted by email
+ * @access private
+ */
+function spamcop_while_sending() {
+    include_once(SM_PATH . 'plugins/spamcop/functions.php');
+    spamcop_while_sending_function();
 }
-
-?>