Use <plugin>_info() function if at all possible instead of <plugin>_version()
[squirrelmail.git] / plugins / filters / options.php
index 421975b3bdb8e8e50bbe87ee2b4e0ede3eb09df9..8056a83dc5cb2cefe04fc1a91ef8827be3ff8e34 100644 (file)
 <?php
-   /**
-    **  Message and Spam Filter Plugin
-    **
-    **  Copyright (c) 1999-2001 The Squirrelmail Development Team
-    **  Licensed under the GNU GPL. For full terms see the file COPYING.
-    **
-    **  This plugin filters your inbox into different folders based upon given
-    **  criteria.  It is most useful for people who are subscibed to mailing lists
-    **  to help organize their messages.  The argument stands that filtering is
-    **  not the place of the client, which is why this has been made a plugin for
-    **  SquirrelMail.  You may be better off using products such as Sieve or
-    **  Procmail to do your filtering so it happens even when SquirrelMail isn't
-    **  running.
-    **
-    **  If you need help with this, or see improvements that can be made, please
-    **  email me directly at the address above.  I definately welcome suggestions
-    **  and comments.  This plugin, as is the case with all SquirrelMail plugins,
-    **  is not directly supported by the developers.  Please come to me off the
-    **  mailing list if you have trouble with it.
-    **
-    **  Also view plugins/README.plugins for more information.
-    **
-    **/
-
-   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($filter_submit)) {
-      if (!isset($theid)) $theid = 0;
-      $filter_what = ereg_replace(",", " ", $filter_what);
-      $filter_what = str_replace("\\\\", "\\", $filter_what);
-      $filter_what = str_replace("\\\"", "\"", $filter_what);
-      $filter_what = str_replace("\"", "&quot;", $filter_what);
-
-      setPref($data_dir, $username, "filter".$theid, $filter_where.",".$filter_what.",".$filter_folder);
-      $filters[$theid]["where"] = $filter_where;
-      $filters[$theid]["what"] = $filter_what;
-      $filters[$theid]["folder"] = $filter_folder;
-   } elseif (isset($spam_submit) && $AllowSpamFilters) {
-      $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);
-      }
-   } elseif (isset($action) && $action == 'delete') {
+
+/**
+ * Message and Spam Filter Plugin - Filtering Options
+ *
+ * @copyright &copy; 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package plugins
+ * @subpackage filters
+ */
+
+/**
+ * Include the SquirrelMail initialization file.
+ */
+require('../../include/init.php');
+include_once(SM_PATH . 'functions/imap_general.php');
+include_once(SM_PATH . 'functions/forms.php');
+include_once(SM_PATH . 'plugins/filters/filters.php');
+
+displayPageHeader($color, 'None');
+
+/* get globals */
+sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
+
+sqgetGlobalVar('theid', $theid);
+sqgetGlobalVar('action', $action, SQ_GET);
+
+if (sqgetGlobalVar('filter_submit',$filter_submit,SQ_POST)) {
+
+    if(! isset($theid) ) $theid = 0;
+
+    $complete_post=true;
+
+    // FIXME: write human readable error messages
+    sqgetGlobalVar('filter_what', $filter_what, SQ_POST);
+    if (!sqgetGlobalVar('filter_what', $filter_what, SQ_POST)) {
+        do_error("Post error");
+        $complete_post=false;
+    }
+
+    sqgetGlobalVar('filter_where', $filter_where, SQ_POST);
+    if (!sqgetGlobalVar('filter_where', $filter_where, SQ_POST)) {
+        do_error("Post error");
+        $complete_post=false;
+    }
+
+    sqgetGlobalVar('filter_folder', $filter_folder, SQ_POST);
+    if (!sqgetGlobalVar('filter_folder', $filter_folder, SQ_POST)) {
+        do_error("Post error");
+        $complete_post=false;
+    }
+
+    if ($complete_post) {
+        $filter_what = str_replace(',', ' ', $filter_what);
+        $filter_what = str_replace("\\\\", "\\", $filter_what);
+        $filter_what = str_replace("\\\"", '"', $filter_what);
+        $filter_what = str_replace('"', '&quot;', $filter_what);
+
+        if (empty($filter_what)) {
+            do_error(_("WARNING! You must enter something to search for."));
+            $action = 'edit';
+        }
+
+        if (($filter_where == 'Header') && (strchr($filter_what,':') == '')) {
+            do_error(_("WARNING! Header filters should be of the format &quot;Header: value&quot;"));
+            $action = 'edit';
+        }
+        if ($action != 'edit') {
+        setPref($data_dir, $username, 'filter'.$theid, $filter_where.','.$filter_what.','.$filter_folder);
+        }
+        $filters[$theid]['where'] = $filter_where;
+        $filters[$theid]['what'] = $filter_what;
+        $filters[$theid]['folder'] = $filter_folder;
+    }
+} elseif (isset($action) && $action == 'delete') {
       remove_filter($theid);
-   } elseif (isset($action) && $action == 'move_up') {
+} elseif (isset($action) && $action == 'move_up') {
       filter_swap($theid, $theid - 1);
-   } elseif (isset($action) && $action == 'move_down') {
+} elseif (isset($action) && $action == 'move_down') {
       filter_swap($theid, $theid + 1);
-   }
+} elseif (sqgetGlobalVar('user_submit',$user_submit,SQ_POST)) {
+    sqgetGlobalVar('filters_user_scan_set',$filters_user_scan_set,SQ_POST);
+    setPref($data_dir, $username, 'filters_user_scan', $filters_user_scan_set);
+    echo '<br /><div style="text-align: center;"><b>'._("Saved Scan type")."</b></div>\n";
+}
 
-   if ($AllowSpamFilters) {
-      $filters_spam_folder = getPref($data_dir, $username, 'filters_spam_folder');
-      $filters_spam_scan = getPref($data_dir, $username, 'filters_spam_scan');
-   }
    $filters = load_filters();
+   $filters_user_scan = getPref($data_dir, $username, 'filters_user_scan');
+
+   echo html_tag( 'table',
+            html_tag( 'tr',
+                html_tag( 'td',
+                    '<div style="text-align: center;"><b>' . _("Options") . ' - ' . _("Message Filtering") . '</b></div>' ,
+                    'left', $color[0]
+                )
+            ),
+            'center', '', 'width="95%" border="0" cellpadding="2" cellspacing="0"'
+        ) .
+        '<br /><form method="post" action="options.php">'.
+        html_tag( 'table', '', 'center', '', 'border="0" cellpadding="2" cellspacing="0"' ) .
+            html_tag( 'tr' ) .
+                html_tag( 'th', _("What to Scan:"), 'right', '', 'style="white-space: nowrap;"' ) .
+                html_tag( 'td', '', 'left' ) .
+            '<select name="filters_user_scan_set">'.
+            '<option value=""';
+    if ($filters_user_scan == '') {
+        echo ' selected="selected"';
+    }
+    echo '>' . _("All messages") . '</option>'.
+            '<option value="new"';
+    if ($filters_user_scan == 'new') {
+        echo ' selected="selected"';
+    }
+    echo '>' . _("Only unread messages") . '</option>' .
+            '</select>'.
+        '</td>'.
+        html_tag( 'td', '<input type="submit" name="user_submit" value="' . _("Save") . '" />', 'left' ) .
+        '</table>'.
+        '</form>'.
+
+        html_tag( 'div', '[<a href="options.php?action=add">' . _("New") .
+            '</a>] - [<a href="'.SM_PATH.'src/options.php">' . _("Done") . '</a>]' ,
+        'center' ) . '<br />';
 
     if (isset($action) && ($action == 'add' || $action == 'edit')) {
-        $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
+
+        $imapConnection = sqimap_login($username, false, $imapServerAddress, $imapPort, 0);
         $boxes = sqimap_mailbox_list($imapConnection);
+
+        for ($a = 0, $cnt = count($boxes); $a < $cnt; $a++) {
+            if (strtolower($boxes[$a]['formatted']) == 'inbox') {
+                unset($boxes[$a]);
+            }
+        }
+
         sqimap_logout($imapConnection);
         if ( !isset($theid) ) {
             $theid = count($filters);
         }
-        echo '<center>'.
-            '<form action="options.php" method=post>'.
-            '<br><table cellpadding=2 cellspacing=0 border=0>'.
-            '<tr>'.
-                '<td>&nbsp;</td>'.
-                '<td>'.
-                    '<select name=filter_where>';
+        echo html_tag( 'div', '', 'center' ) .
+             '<form action="options.php" method="post">'.
+             html_tag( 'table', '', '', '', 'border="0" cellpadding="2" cellspacing="0"' ) .
+             html_tag( 'tr' ) .
+                html_tag( 'td', _("Match:"), 'left' ) .
+                html_tag( 'td', '', 'left' ) .
+                    '<select name="filter_where">';
 
         $L = isset($filters[$theid]['where']);
 
-        $sel = (($L && $filters[$theid]['where'] == 'From')?'selected':'');
-        echo "<option value=\"From\" $sel>" . _ ("From") . '</option>';
+        $sel = (($L && $filters[$theid]['where'] == 'From')?' selected="selected"':'');
+        echo "<option value=\"From\"$sel>" . _("From") . '</option>';
+
+        $sel = (($L && $filters[$theid]['where'] == 'To')?' selected="selected"':'');
+        echo "<option value=\"To\"$sel>" . _("To") . '</option>';
+
+        $sel = (($L && $filters[$theid]['where'] == 'Cc')?' selected="selected"':'');
+        echo "<option value=\"Cc\"$sel>" . _("Cc") . '</option>';
 
-        $sel = (($L && $filters[$theid]['where'] == 'To')?'selected':'');
-        echo "<option value=\"To\" $sel>" . _ ("To") . '</option>';
+        $sel = (($L && $filters[$theid]['where'] == 'To or Cc')?' selected="selected"':'');
+        echo "<option value=\"To or Cc\"$sel>" . _("To or Cc") . '</option>';
 
-        $sel = (($L && $filters[$theid]['where'] == 'Cc')?'selected':'');
-        echo "<option value=\"Cc\" $sel>" . _ ("Cc") . '</option>';
+        $sel = (($L && $filters[$theid]['where'] == 'Subject')?' selected="selected"':'');
+        echo "<option value=\"Subject\"$sel>" . _("Subject") . '</option>';
 
-        $sel = (($L && $filters[$theid]['where'] == 'To or Cc')?'selected':'');
-        echo "<option value=\"To or Cc\" $sel>" . _ ("To or Cc") . '</option>';
+        $sel = (($L && $filters[$theid]['where'] == 'Message Body')?' selected="selected"':'');
+        echo "<option value=\"Message Body\"$sel>" . _("Message Body") . '</option>';
 
-        $sel = (($L && $filters[$theid]['where'] == 'Subject')?'selected':'');
-        echo "<option value=\"Subject\" $sel>" . _ ("Subject") . '</option>';
+        $sel = (($L && $filters[$theid]['where'] == 'Header and Body')?' selected="selected"':'');
+        echo "<option value=\"Header and Body\"$sel>" . _("Header and Body") . '</option>';
+
+        $sel = (($L && $filters[$theid]['where'] == 'Header')?' selected="selected"':'');
+        echo "<option value=\"Header\"$sel>" . _("Header") . '</option>';
 
         echo         '</select>'.
                 '</td>'.
             '</tr>'.
-            '<tr>'.
-                '<td align=right>'.
-                    _("Contains:").
-                '</td>'.
-                '<td>'.
-                    '<input type=text size=32 name=filter_what value="';
+            html_tag( 'tr' ) .
+                html_tag( 'td', _("Contains:"), 'right' ) .
+                html_tag( 'td', '', 'left' ) .
+                    '<input type="text" size="32" name="filter_what" value="';
         if (isset($filters[$theid]['what'])) {
-            echo $filters[$theid]["what"];
+            echo htmlspecialchars($filters[$theid]['what']);
         }
-        echo '">'.
+        echo '" />'.
                 '</td>'.
             '</tr>'.
-            '<tr>'.
-                '<td>'.
-                    _("Move to:").
-                '</td>'.
-                '<td>'.
+            html_tag( 'tr' ) .
+                html_tag( 'td', _("Move to:"), 'left' ) .
+                html_tag( 'td', '', 'left' ) .
                     '<tt>'.
-                    '<select name=filter_folder>';
-
-        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 (isset($filters[$theid]['folder']) &&
-                    $filters[$theid]['folder'] == $box)
-                echo "<OPTION VALUE=\"$box\" SELECTED>$box2</option>";
-                else
-                echo "<OPTION VALUE=\"$box\">$box2</option>";
-            }
-        }
-        echo         '</tt>'.
-                    '</select>'.
+                    '<select name="filter_folder">';
+        $selected = 0;
+        if ( isset($filters[$theid]['folder']) )
+          $selected = array(strtolower($filters[$theid]['folder']));
+        echo sqimap_mailbox_option_list(0, $selected, 0, $boxes);
+        echo        '</select>'.
+                    '</tt>'.
                 '</td>'.
             '</tr>'.
             '</table>'.
-            '<input type=submit name=filter_submit value=' . _("Submit") . '>'.
-            "<input type=hidden name=theid value=$theid>".
+            '<input type="submit" name="filter_submit" value="' . _("Submit") . "\" />\n".
+            addHidden('theid', $theid).
             '</form>'.
-            '</center>';
-
-    } else if (isset($action) && $action == 'spam' && $AllowSpamFilters) {
-        $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="options.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>';
+            '</div>';
 
-        sqimap_logout($imapConnection);
     }
 
-   echo '<br>' .
-        '<table width=95% align=center border=0 cellpadding=2 cellspacing=0>'.
-        "<tr><td bgcolor=\"$color[0]\">".
-        '<center><b>' . _("Options") . ' -  ' . _("Message Filtering") . '</b></center>'.
-        '</td></tr></table>'.
-        '<br><center>[<a href="options.php?action=add">' . _("New") .
-        '</a>] - [<a href="../../src/options.php">' . _("Done") . '</a>]</center><br>' .
-        '<table border=0 cellpadding=3 cellspacing=0 align=center>';
+if (count($filters)) {
+    echo html_tag( 'table', '', 'center', '', 'border="0" cellpadding="3" cellspacing="0"' );
 
-    for ($i=0; $i < count($filters); $i++) {
+    for ($i=0, $num = count($filters); $i < $num; $i++) {
 
         $clr = (($i % 2)?$color[0]:$color[9]);
         $fdr = ($folder_prefix)?str_replace($folder_prefix, "", $filters[$i]["folder"]):$filters[$i]["folder"];
-        echo "<tr bgcolor=\"$clr\"><td><small>".
-            "[<a href=\"options.php?theid=$i&action=edit\">" . _("Edit") . '</a>]'.
-            '</small></td><td><small>'.
-            "[<a href=\"options.php?theid=$i&action=delete\">" . _("Delete") . '</a>]'.
-            '</small></td><td align=center><small>[';
-
-        if (isset($filters[$i + 1])) {
-            echo "<a href=\"options.php?theid=$i&action=move_down\">" . _("Down") . '</a>';
+        echo html_tag( 'tr', '', '', $clr ) .
+                   html_tag( 'td',
+                       '<small>' .
+                       "[<a href=\"options.php?theid=$i&amp;action=edit\">" . _("Edit") . '</a>]'.
+                       '</small>' ,
+                   'left' ) .
+                   html_tag( 'td',
+                       '<small>' .
+                       "[<a href=\"options.php?theid=$i&amp;action=delete\">" . _("Delete") . '</a>]'.
+                       '</small>' ,
+                   'left' );
+
+        if ($num > 1) {
+            echo html_tag( 'td', '', 'center' ) . '<small>[';
+            if (isset($filters[$i + 1])) {
+                echo "<a href=\"options.php?theid=$i&amp;action=move_down\">" . _("Down") . '</a>';
+                if ($i > 0) {
+                    echo '&nbsp;|&nbsp;';
+                }
+            }
             if ($i > 0) {
-                echo ' | ';
+                echo "<a href=\"options.php?theid=$i&amp;action=move_up\">" . _("Up") . '</a>';
             }
+            echo ']</small></td>';
         }
-        if ($i > 0) {
-            echo "<a href=\"options.php?theid=$i&action=move_up\">" . _("Up") . '</a>';
-        }
-        echo ']</small></td><td> - ';
-        printf( _("If <b>%s</b> contains <b>%s</b> then move to <b>%s</b>"), _($filters[$i]['where']), $filters[$i]['what'], $fdr );
+        echo html_tag( 'td', '-', 'left' ) .
+             html_tag( 'td', '', 'left' );
+        printf( _("If %s contains %s then move to %s"),
+            '<b>'.$filters[$i]['where'].'</b>',
+            '<b>'.$filters[$i]['what'].'</b>',
+            '<b>'.htmlspecialchars(imap_utf7_decode_local($fdr)).'</b>');
         echo '</td></tr>';
 
     }
-    echo '</table>'.
-        '<table width=80% align=center border=0 cellpadding=2 cellspacing=0">'.
-            '<tr><td>&nbsp</td></tr>'.
-        '</table>';
-
-
-    if ($AllowSpamFilters) {
-
-        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 (! isset($action) || $action != 'spam') {
-
-            echo '<p align=center>[<a href="options.php?action=spam">' . _("Edit") . '</a>]<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>';
-        }
-    }
-
-?>
+    echo '</table>';
+}
+    echo html_tag( 'table',
+            html_tag( 'tr',
+                html_tag( 'td', '&nbsp;', 'left' )
+            ) ,
+        'center', '', 'width="80%" border="0" cellpadding="2" cellspacing="0"' );
+    echo '</body></html>';