not sure, why message details provides this hook. If it have other effects
[squirrelmail.git] / plugins / filters / spamoptions.php
index 9f93a9fbce98b1eefebdd8b6a08d04bae23e359f..39cbb4e51d139a67b664f5ba59adb040105ee7a4 100644 (file)
@@ -1,9 +1,6 @@
 <?php
 /**
- * Message and Spam Filter Plugin
- *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
+ * Message and Spam Filter Plugin - Spam Options
  *
  * This plugin filters your inbox into different folders based upon given
  * criteria.  It is most useful for people who are subscibed to mailing lists
  *
  * Also view plugins/README.plugins for more information.
  *
- * $Id$
+ * @version $Id$
+ * @copyright (c) 1999-2004 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @package plugins
+ * @subpackage filters
  */
 
-   chdir ('..');
-   require_once('../src/validate.php');
-   require_once('../functions/page_header.php');
-   require_once('../functions/imap.php');
-   require_once('../src/load_prefs.php');
-
-   global $AllowSpamFilters;
-
-   displayPageHeader($color, 'None');
-
-   if (isset($spam_submit)) {
-      $spam_filters = load_spam_filters();
-      setPref($data_dir, $username, 'filters_spam_folder', $filters_spam_folder_set);
-      setPref($data_dir, $username, 'filters_spam_scan', $filters_spam_scan_set);
-      foreach ($spam_filters as $Key => $Value) {
-          $input = $spam_filters[$Key]['prefname'] . '_set';
-          setPref($data_dir, $username, $spam_filters[$Key]['prefname'],
-              $$input);
-      }
-   }
-
-   $filters_spam_folder = getPref($data_dir, $username, 'filters_spam_folder');
-   $filters_spam_scan = getPref($data_dir, $username, 'filters_spam_scan');
-   $filters = load_filters();
-
-   echo "<table width=95% align=center border=0 cellpadding=2 cellspacing=0 bgcolor=\"$color[0]\">".
-           '<tr><th align=center>' . _("Spam Filtering") . '</th></tr>'.
-       '</table>';
-
-    if ($SpamFilters_YourHop == ' ') {
-       echo '<BR><center><b>' . _("WARNING! Tell your admin to set the SpamFilters_YourHop variable") . '</b></center><BR>';
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
+define('SM_PATH','../../');
+
+/* SquirrelMail required files. */
+require_once(SM_PATH . 'include/validate.php');
+require_once(SM_PATH . 'functions/page_header.php');
+require_once(SM_PATH . 'functions/imap.php');
+require_once(SM_PATH . 'include/load_prefs.php');
+require_once(SM_PATH . 'functions/html.php');
+require_once(SM_PATH . 'plugins/filters/filters.php');
+global $AllowSpamFilters;
+
+/* get globals */
+sqgetGlobalVar('username', $username, SQ_SESSION);
+sqgetGlobalVar('key', $key, SQ_COOKIE);
+sqgetGlobalVar('onetimepad', $onetimepad, SQ_SESSION);
+sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
+
+sqgetGlobalVar('action', $action, SQ_GET);
+/* end globals */
+
+displayPageHeader($color, 'None');
+
+if (sqgetGlobalVar('spam_submit',$spam_submit,SQ_POST)) {
+    $spam_filters = load_spam_filters();
+
+    // setting spam folder    
+    sqgetGlobalVar('filters_spam_folder_set',$filters_spam_folder_set,SQ_POST);
+    if (isset($filters_spam_folder_set)) {
+        setPref($data_dir, $username, 'filters_spam_folder', $filters_spam_folder_set);
+    } else {
+       echo _("You must select spam folder.");
     }
 
+    // setting scan type
+    sqgetGlobalVar('filters_spam_scan_set',$filters_spam_scan_set,SQ_POST);
+    if (isset($filters_spam_scan_set)) {
+       setPref($data_dir, $username, 'filters_spam_scan', $filters_spam_scan_set);
+    } else {
+       echo _("You must select scan type.");
+    }
 
-   if (isset($action) && $action == 'spam') {
-       $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
-       $boxes = sqimap_mailbox_list($imapConnection);
-       sqimap_logout($imapConnection);
-       for ($i = 0; $i < count($boxes) && $filters_spam_folder == ''; $i++) {
-           if ($boxes[$i]['flags'][0] != 'noselect' &&
-               $boxes[$i]['flags'][1] != 'noselect' &&
-               $boxes[$i]['flags'][2] != 'noselect') {
-               $filters_spam_folder = $boxes[$i]['unformatted'];
-           }
-       }
-
-       echo '<form method=post action="spamoptions.php">'.
-           '<center>'.
-           '<table width=85% cellpadding=2 cellspacing=0 border=0>'.
-               '<tr>'.
-               '<th align=right nowrap>' . _("Move spam to:") . '</th>'.
-               '<td><select name="filters_spam_folder_set">';
-
-       for ($i = 0; $i < count($boxes); $i++) {
-           if (! in_array('noselect', $boxes[$i]['flags'])) {
-               $box = $boxes[$i]['unformatted'];
-               $box2 = str_replace(' ', '&nbsp;', $boxes[$i]['formatted']);
-               if ($filters_spam_folder == $box)
-               echo "<OPTION VALUE=\"$box\" SELECTED>$box2</OPTION>\n";
-               else
-               echo "<OPTION VALUE=\"$box\">$box2</OPTION>\n";
-           }
-       }
-       echo    '</select>'.
-           '</td>'.
-           '</tr>'.
-           '<tr><td></td><td>' .
-           _("Moving spam directly to the trash may not be a good idea at first, since messages from friends and mailing lists might accidentally be marked as spam. Whatever folder you set this to, make sure that it gets cleaned out periodically, so that you don't have an excessively large mailbox hanging around.") .
-           '</td></tr>'.
-           '<tr>'.
-               '<th align=right nowrap>' . _("What to Scan:") . '</th>'.
-               '<td><select name="filters_spam_scan_set">'.
-               '<option value=""';
-       if ($filters_spam_scan == '')
-           echo ' SELECTED';
-       echo '>' . _("All messages") . '</option>'.
-               '<option value="new"';
-       if ($filters_spam_scan == 'new')
-           echo ' SELECTED';
-       echo '>' . _("Only unread messages") . '</option>' .
-               '</select>'.
-           '</td>'.
-       '</tr>'.
-       '<tr>'.
-           '<td></td><td>'.
-           _("The more messages you scan, the longer it takes.  I would suggest that you scan only new messages.  If you make a change to your filters, I would set it to scan all messages, then go view my INBOX, then come back and set it to scan only new messages.  That way, your new spam filters will be applied and you'll scan even the spam you read with the new filters.").
-           '</td></tr>';
-
-       $spam_filters = load_spam_filters();
-
-       foreach ($spam_filters as $Key => $Value) {
-           echo "<tr><th align=right nowrap>$Key</th>\n" .
-               '<td><input type=checkbox name="' .
-               $spam_filters[$Key]['prefname'] .
-               '_set"';
-           if ($spam_filters[$Key]['enabled'])
-           echo ' CHECKED';
-           echo '> - ';
-           if ($spam_filters[$Key]['link']) {
-           echo '<a href="' .
-                   $spam_filters[$Key]['link'] .
-                   '" target="_blank">';
-           }
-           echo $spam_filters[$Key]['name'];
-           if ($spam_filters[$Key]['link']) {
-           echo '</a>';
-           }
-           echo '</td></tr><tr><td></td><td>' .
-               $spam_filters[$Key]['comment'] .
-               "</td></tr>\n";
-       }
-       echo '<tr><td colspan=2 align=center><input type=submit name="spam_submit" value="' . _("Save") . '"></td></tr>'.
-           '</table>'.
-           '</center>'.
-           '</form>';
-
-       sqimap_logout($imapConnection);
-   }
-
-   if (! isset($action) || $action != 'spam') {
-
-       echo '<p align=center>[<a href="spamoptions.php?action=spam">' . _("Edit") . '</a>]' .
-   ' - [<a href="../../src/options.php">' . _("Done") . '</a>]</center><br><br>';
-       printf( _("Spam is sent to <b>%s</b>"), ($filters_spam_folder?$filters_spam_folder:_("[<i>not set yet</i>]") ) );
-       echo '<br>';
-       printf( _("Spam scan is limited to <b>%s</b>"), (($filters_spam_scan == 'new')?_("New Messages Only"):_("All Messages") ) );
-       echo '</p>'.
-           "<table border=0 cellpadding=3 cellspacing=0 align=center bgcolor=\"$color[0]\">";
-
-       $spam_filters = load_spam_filters();
-
-       foreach ($spam_filters as $Key => $Value) {
-           echo '<tr><th align=center>';
-
-           if ($spam_filters[$Key]['enabled']) {
-               echo _("ON");
-           } else {
-               echo _("OFF");
-           }
-
-           echo '</th><td>&nbsp;-&nbsp;</td><td>';
-
-           if ($spam_filters[$Key]['link']) {
-           echo '<a href="' .
-               $spam_filters[$Key]['link'] .
-               '" target="_blank">';
-           }
-
-           echo $spam_filters[$Key]['name'];
-           if ($spam_filters[$Key]['link']) {
-           echo '</a>';
-           }
-           echo "</td></tr>\n";
-       }
-       echo '</table>';
-   }
+    foreach ($spam_filters as $Key => $Value) {
+        $input = $spam_filters[$Key]['prefname'] . '_set';
+        if ( sqgetGlobalVar($input,$input_key,SQ_POST) ) {
+            setPref( $data_dir, $username, $spam_filters[$Key]['prefname'],$input_key);
+        } else {
+            removePref($data_dir, $username, $spam_filters[$Key]['prefname']);
+        }
+    }
+}
+
+$filters_spam_folder = getPref($data_dir, $username, 'filters_spam_folder');
+$filters_spam_scan = getPref($data_dir, $username, 'filters_spam_scan');
+$filters = load_filters();
+
+echo html_tag( 'table',
+            html_tag( 'tr',
+                html_tag( 'th', _("Spam Filtering"), 'center' )
+            ) ,
+        'center', $color[0], 'width="95%" border="0" cellpadding="2" cellspacing="0"' );
+
+if ($SpamFilters_YourHop == ' ') {
+    echo '<br />' .
+        html_tag( 'div', '<b>' .
+            sprintf(_("WARNING! Tell your admin to set the %s variable"),'SpamFilters_YourHop') .
+            '</b>' ,
+        'center' ) .
+        '<br />';
+}
+
+
+if (isset($action) && $action == 'spam') {
+    $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
+    $boxes = sqimap_mailbox_list($imapConnection);
+    sqimap_logout($imapConnection);
+    $numboxes = count($boxes);
+
+    for ($i = 0; $i < $numboxes && $filters_spam_folder == ''; $i++) {
+        if ((isset($boxes[$i]['flags'][0]) && $boxes[$i]['flags'][0] != 'noselect') &&
+            (isset($boxes[$i]['flags'][1]) && $boxes[$i]['flags'][1] != 'noselect') &&
+            (isset($boxes[$i]['flags'][2]) && $boxes[$i]['flags'][2] != 'noselect')) {
+            $filters_spam_folder = $boxes[$i]['unformatted'];
+        }
+    }
 
+    echo '<form method="post" action="spamoptions.php">'.
+        '<center>'.
+        html_tag( 'table', '', '', '', 'width="85%" border="0" cellpadding="2" cellspacing="0"' ) .
+            html_tag( 'tr' ) .
+                html_tag( 'th', _("Move spam to:"), 'right', '', 'nowrap' ) .
+                html_tag( 'td', '', 'left' ) .
+                    '<select name="filters_spam_folder_set">';
+
+        $selected = 0;
+        if ( isset($filters_spam_folder) )
+          $selected = array(strtolower($filters_spam_folder));
+        echo sqimap_mailbox_option_list(0, $selected, 0, $boxes);
+    echo    '</select>'.
+        '</td>'.
+        '</tr>'.
+        html_tag( 'tr',
+            html_tag( 'td', '&nbsp;' ) .
+            html_tag( 'td',
+                _("Moving spam directly to the trash may not be a good idea at first, since messages from friends and mailing lists might accidentally be marked as spam. Whatever folder you set this to, make sure that it gets cleaned out periodically, so that you don't have an excessively large mailbox hanging around.") ,
+            'left' )
+        ) .
+        html_tag( 'tr' ) .
+            html_tag( 'th', _("What to Scan:"), 'right', '', 'nowrap' ) .
+            html_tag( 'td' ) .
+            '<select name="filters_spam_scan_set">'.
+            '<option value=""';
+    if ($filters_spam_scan == '') {
+        echo ' selected';
+    }
+    echo '>' . _("All messages") . '</option>'.
+            '<option value="new"';
+    if ($filters_spam_scan == 'new') {
+        echo ' selected';
+    }
+    echo '>' . _("Only unread messages") . '</option>' .
+            '</select>'.
+        '</td>'.
+    '</tr>'.
+    html_tag( 'tr',
+          html_tag( 'td', '&nbsp;' ) .
+          html_tag( 'td',
+              _("The more messages you scan, the longer it takes. I would suggest that you scan only new messages.  If you make a change to your filters, I would set it to scan all messages, then go view my INBOX, then come back and set it to scan only new messages. That way, your new spam filters will be applied and you'll scan even the spam you read with the new filters.") ,
+          'left' )
+      );
+
+    $spam_filters = load_spam_filters();
+
+    foreach ($spam_filters as $Key => $Value) {
+        echo html_tag( 'tr' ) .
+                   html_tag( 'th', $Key, 'right', '', 'nowrap' ) ."\n" .
+                   html_tag( 'td' ) .
+            '<input type="checkbox" name="' .
+            $spam_filters[$Key]['prefname'] .
+            '_set"';
+        if ($spam_filters[$Key]['enabled']) {
+            echo ' checked';
+        }
+        echo ' /> - ';
+        if ($spam_filters[$Key]['link']) {
+            echo '<a href="' .
+                 $spam_filters[$Key]['link'] .
+                 '" target="_blank">';
+        }
+        echo $spam_filters[$Key]['name'];
+        if ($spam_filters[$Key]['link']) {
+            echo '</a>';
+        }
+        echo '</td></tr>' .
+        html_tag( 'tr',
+            html_tag( 'td', '&nbsp;' ) .
+            html_tag( 'td', $spam_filters[$Key]['comment'], 'left' )
+        ) . "\n";
+
+    }
+    echo html_tag( 'tr',
+        html_tag( 'td', '<input type="submit" name="spam_submit" value="' . _("Save") . '" />', 'center', '', 'colspan="2"' )
+    ) . "\n" .
+        '</table>'.
+        '</center>'.
+        '</form>';
+} else {
+    // action is not set or action is not spam
+    echo html_tag( 'p', '', 'center' ) .
+         '[<a href="spamoptions.php?action=spam">' . _("Edit") . '</a>]' .
+         ' - [<a href="../../src/options.php">' . _("Done") . '</a>]</center><br /><br />';
+    printf( _("Spam is sent to %s"), ($filters_spam_folder?'<b>'.imap_utf7_decode_local($filters_spam_folder).'</b>':'[<i>'._("not set yet").'</i>]' ) );
+    echo '<br>';
+    printf( _("Spam scan is limited to <b>%s</b>"), (($filters_spam_scan == 'new')?_("New Messages Only"):_("All Messages") ) );
+    echo '</p>'.
+        '<table border="0" cellpadding="3" cellspacing="0" align="center" bgcolor="' . $color[0] . "\">\n";
+
+    $spam_filters = load_spam_filters();
+
+    foreach ($spam_filters as $Key => $Value) {
+        echo html_tag( 'tr' ) .
+                    html_tag( 'th', '', 'center' );
+
+        if ($spam_filters[$Key]['enabled']) {
+            echo _("ON");
+        } else {
+            echo _("OFF");
+        }
+
+        echo '</th>' . 
+               html_tag( 'td', '&nbsp;-&nbsp;', 'left' ) .
+               html_tag( 'td', '', 'left' );
+
+        if ($spam_filters[$Key]['link']) {
+        echo '<a href="' .
+            $spam_filters[$Key]['link'] .
+            '" target="_blank">';
+        }
+
+        echo $spam_filters[$Key]['name'];
+        if ($spam_filters[$Key]['link']) {
+        echo '</a>';
+        }
+        echo "</td></tr>\n";
+    }
+    echo '</table>';
+}
 ?>
+</body></html>