plugins/filters/filters.php

   1 <?php
   2
   3 /**
   4  * Message and Spam Filter Plugin
   5  *
   6  * Copyright (c) 1999-2003 The SquirrelMail Project Team
   7  * Licensed under the GNU GPL. For full terms see the file COPYING.
   8  *
   9  * This plugin filters your inbox into different folders based upon given
  10  * criteria.  It is most useful for people who are subscibed to mailing lists
  11  * to help organize their messages.  The argument stands that filtering is
  12  * not the place of the client, which is why this has been made a plugin for
  13  * SquirrelMail.  You may be better off using products such as Sieve or
  14  * Procmail to do your filtering so it happens even when SquirrelMail isn't
  15  * running.
  16  *
  17  * If you need help with this, or see improvements that can be made, please
  18  * email me directly at the address above.  I definately welcome suggestions
  19  * and comments.  This plugin, as is the case with all SquirrelMail plugins,
  20  * is not directly supported by the developers.  Please come to me off the
  21  * mailing list if you have trouble with it.
  22  *
  23  * Also view plugins/README.plugins for more information.
  24  *
  25  * $Id$
  26  */
  27
  28 function filters_SaveCache () {
  29     global $data_dir, $SpamFilters_DNScache;
  30
  31     if (file_exists($data_dir . '/dnscache')) {
  32         $fp = fopen($data_dir . '/dnscache', 'r');
  33     } else {
  34         $fp = false;
  35     }
  36     if ($fp) {
  37         flock($fp,LOCK_EX);
  38     } else {
  39        $fp = fopen($data_dir . '/dnscache', 'w+');
  40        fclose($fp);
  41        $fp = fopen($data_dir . '/dnscache', 'r');
  42        flock($fp,LOCK_EX);
  43     }
  44     $fp1=fopen($data_dir . '/dnscache', 'w+');
  45
  46     foreach ($SpamFilters_DNScache as $Key=> $Value) {
  47        $tstr = $Key . ',' . $Value['L'] . ',' . $Value['T'] . "\n";
  48        fputs ($fp1, $tstr);
  49     }
  50     fclose($fp1);
  51     flock($fp,LOCK_UN);
  52     fclose($fp);
  53 }
  54
  55 function filters_LoadCache () {
  56     global $data_dir, $SpamFilters_DNScache;
  57
  58     if (file_exists($data_dir . '/dnscache')) {
  59         $SpamFilters_DNScache = array();
  60         if ($fp = fopen ($data_dir . '/dnscache', 'r')) {
  61             flock($fp,LOCK_SH);
  62             while ($data=fgetcsv($fp,1024)) {
  63                if ($data[2] > time()) {
  64                   $SpamFilters_DNScache[$data[0]]['L'] = $data[1];
  65                   $SpamFilters_DNScache[$data[0]]['T'] = $data[2];
  66                }
  67             }
  68
  69             flock($fp,LOCK_UN);
  70         }
  71     }
  72 }
  73
  74 function filters_bulkquery($filters, $IPs) {
  75     global $SpamFilters_YourHop, $attachment_dir, $username,
  76            $SpamFilters_DNScache, $SpamFilters_BulkQuery,
  77            $SpamFilters_CacheTTL;
  78
  79     if (count($IPs) > 0) {
  80         $rbls = array();
  81         foreach ($filters as $key => $value) {
  82             if ($filters[$key]['enabled']) {
  83                 if ($filters[$key]['dns']) {
  84                     $rbls[$filters[$key]['dns']] = true;
  85                 }
  86             }
  87         }
  88
  89         $bqfil = $attachment_dir . $username . '-bq.in';
  90         $fp = fopen($bqfil, 'w');
  91         fputs ($fp, $SpamFilters_CacheTTL . "\n");
  92         foreach ($rbls as $key => $value) {
  93             fputs ($fp, '.' . $key . "\n");
  94         }
  95         fputs ($fp, "----------\n");
  96         foreach ($IPs as $key => $value) {
  97             fputs ($fp, $key . "\n");
  98         }
  99         fclose ($fp);
 100         $bqout = array();
 101         exec ($SpamFilters_BulkQuery . ' < ' . $bqfil, $bqout);
 102         foreach ($bqout as $value) {
 103             $Chunks = explode(',', $value);
 104             $SpamFilters_DNScache[$Chunks[0]]['L'] = $Chunks[1];
 105             $SpamFilters_DNScache[$Chunks[0]]['T'] = $Chunks[2] + time();
 106         }
 107         unlink($bqfil);
 108     }
 109 }
 110
 111 function start_filters() {
 112     global $mailbox, $imapServerAddress, $imapPort, $imap,
 113            $imap_general, $filters, $imap_stream, $imapConnection,
 114            $UseSeparateImapConnection, $AllowSpamFilters;
 115
 116     sqgetGlobalVar('username', $username, SQ_SESSION);
 117     sqgetGlobalVar('key',      $key,      SQ_COOKIE);
 118
 119 #    if ($mailbox == 'INBOX') {
 120         // Detect if we have already connected to IMAP or not.
 121         // Also check if we are forced to use a separate IMAP connection
 122         if ((!isset($imap_stream) && !isset($imapConnection)) ||
 123             $UseSeparateImapConnection) {
 124                 $stream = sqimap_login($username, $key, $imapServerAddress,
 125                                     $imapPort, 10);
 126                 $previously_connected = false;
 127         } elseif (isset($imapConnection)) {
 128             $stream = $imapConnection;
 129             $previously_connected = true;
 130         } else {
 131             $previously_connected = true;
 132             $stream = $imap_stream;
 133         }
 134
 135         if (sqimap_get_num_messages($stream, 'INBOX') > 0) {
 136             // Filter spam from inbox before we sort them into folders
 137             if ($AllowSpamFilters) {
 138                 spam_filters($stream);
 139             }
 140
 141             // Sort into folders
 142             user_filters($stream);
 143         }
 144
 145         if (!$previously_connected) {
 146             sqimap_logout($stream);
 147         }
 148 #    }
 149 }
 150
 151 function user_filters($imap_stream) {
 152     global $data_dir, $username;
 153     $filters = load_filters();
 154     if (! $filters) return;
 155     $filters_user_scan = getPref($data_dir, $username, 'filters_user_scan');
 156
 157     sqimap_mailbox_select($imap_stream, 'INBOX');
 158     $expunge = false;
 159     // For every rule
 160     for ($i=0, $num = count($filters); $i < $num; $i++) {
 161         // If it is the "combo" rule
 162         if ($filters[$i]['where'] == 'To or Cc') {
 163             /*
 164             *  If it's "TO OR CC", we have to do two searches, one for TO
 165             *  and the other for CC.
 166             */
 167             $expunge = filter_search_and_delete($imap_stream, 'TO',
 168                   $filters[$i]['what'], $filters[$i]['folder'], $filters_user_scan, $expunge);
 169             $expunge = filter_search_and_delete($imap_stream, 'CC',
 170                   $filters[$i]['what'], $filters[$i]['folder'], $filters_user_scan, $expunge);
 171         } else {
 172             /*
 173             *  If it's a normal TO, CC, SUBJECT, or FROM, then handle it
 174             *  normally.
 175             */
 176             $expunge = filter_search_and_delete($imap_stream, $filters[$i]['where'],
 177                  $filters[$i]['what'], $filters[$i]['folder'], $filters_user_scan, $expunge);
 178         }
 179     }
 180     // Clean out the mailbox whether or not auto_expunge is on
 181     // That way it looks like it was redirected properly
 182     if ($expunge) {
 183         sqimap_mailbox_expunge($imap_stream, 'INBOX');
 184     }
 185 }
 186
 187 function filter_search_and_delete($imap_stream, $where, $what, $where_to, $user_scan,
 188                                   $should_expunge) {
 189     global $languages, $squirrelmail_language, $allow_charset_search,
 190            $uid_support, $imap_server_type;
 191     if ($user_scan == 'new') {
 192         $category = 'UNSEEN';
 193     } else {
 194         $category = 'ALL';
 195     }
 196
 197     if ($allow_charset_search &&
 198         isset($languages[$squirrelmail_language]['CHARSET']) &&
 199         $languages[$squirrelmail_language]['CHARSET']) {
 200         $search_str = 'SEARCH CHARSET '
 201                     . strtoupper($languages[$squirrelmail_language]['CHARSET'])
 202                     . ' ' . $category;
 203     } else {
 204         $search_str = 'SEARCH CHARSET US-ASCII ' . $category;
 205     }
 206     if ($where == 'Header') {
 207         $what  = explode(':', $what);
 208         $where = trim($where . ' ' . $what[0]);
 209         $what  = addslashes(trim($what[1]));
 210     }
 211
 212     if ($imap_server_type == 'macosx') {
 213         $search_str .= ' ' . $where . ' ' . $what;
 214     } else {
 215         $search_str .= ' ' . $where . ' {' . strlen($what) . "}\r\n"
 216                     . $what . "\r\n";
 217     }
 218
 219     /* read data back from IMAP */
 220     $read = sqimap_run_command($imap_stream, $search_str, true, $response, $message, $uid_support);
 221
 222     // This may have problems with EIMS due to it being goofy
 223
 224     for ($r=0, $num = count($read); $r < $num &&
 225                 substr($read[$r], 0, 8) != '* SEARCH'; $r++) {}
 226     if ($response == 'OK') {
 227         $ids = explode(' ', $read[$r]);
 228
 229         if (sqimap_mailbox_exists($imap_stream, $where_to)) {
 230             $del_id = array();
 231             for ($j=2, $num = count($ids); $j < $num; $j++) {
 232                 $id = trim($ids[$j]);
 233                 if (is_numeric($id)) {
 234                     $del_id[] = $id;
 235                 }
 236             }
 237             if (count($del_id)) {
 238                 $should_expunge = true;
 239                 sqimap_msgs_list_move ($imap_stream, $del_id, $where_to);
 240                 // sqimap_mailbox_expunge($imap_stream, 'INBOX');
 241             }
 242         }
 243     }
 244     return $should_expunge;
 245 }
 246
 247 // These are the spam filters
 248 function spam_filters($imap_stream) {
 249     global $data_dir, $username, $uid_support;
 250     global $SpamFilters_YourHop;
 251     global $SpamFilters_DNScache;
 252     global $SpamFilters_SharedCache;
 253     global $SpamFilters_BulkQuery;
 254     global $SpamFilters_CacheTTL;
 255
 256     $filters_spam_scan = getPref($data_dir, $username, 'filters_spam_scan');
 257     $filters_spam_folder = getPref($data_dir, $username, 'filters_spam_folder');
 258     $filters = load_spam_filters();
 259
 260     if ($SpamFilters_SharedCache) {
 261        filters_LoadCache();
 262     }
 263
 264     $run = false;
 265
 266     foreach ($filters as $Key => $Value) {
 267         if ($Value['enabled']) {
 268             $run = true;
 269             break;
 270         }
 271     }
 272
 273     // short-circuit
 274     if (!$run) {
 275         return;
 276     }
 277
 278     sqimap_mailbox_select($imap_stream, 'INBOX');
 279
 280     // Ask for a big list of all "Received" headers in the inbox with
 281     // flags for each message.  Kinda big.
 282
 283     // MGK, removed FLAGS from query. It wasn't used.
 284     if ($filters_spam_scan != 'new') {
 285         $query = 'FETCH 1:* (BODY.PEEK[HEADER.FIELDS (Received)])';
 286     } else {
 287         $read = sqimap_run_command($imap_stream, 'SEARCH UNSEEN', true, $response, $message, $uid_support);
 288         if ($response != 'OK' || trim($read[0]) == '* SEARCH') {
 289             $query = 'FETCH 1:* (BODY.PEEK[HEADER.FIELDS (RECEIVED)])';
 290         } else {
 291             if (isset($read[0])) {
 292                 if (preg_match("/^\* SEARCH (.+)$/", $read[0], $regs)) {
 293                     $search_array = preg_split("/ /", trim($regs[1]));
 294                 }
 295             }
 296             $msgs_str = sqimap_message_list_squisher($search_array);
 297             $query =  'FETCH ' . $msgs_str . ' (BODY.PEEK[HEADER.FIELDS (RECEIVED)])';
 298             }
 299     }
 300     $headers = filter_get_headers ($imap_stream, $query);
 301     if (!$headers) {
 302         return;
 303     }
 304
 305     $bulkquery = (strlen($SpamFilters_BulkQuery) > 0 ? true : false);
 306     $IPs = array();
 307     $aSpamIds = array();
 308     foreach ($headers as $id => $aValue) {
 309         if (isset($aValue['UID'])) {
 310             $MsgNum = $aValue['UID'];
 311         } else {
 312             $MsgNum = $id;
 313         }
 314         // Look through all of the Received headers for IP addresses
 315         if (isset($aValue['HEADER']['Received'])) {
 316             foreach ($aValue['HEADER']['Received'] as $received) {
 317                 // Check to see if this line is the right "Received from" line
 318                 // to check
 319
 320                 // $aValue['HEADER']['Received'] is an array with all the received lines.
 321                 // We should check them from bottom to top and only check the first 2.
 322                 // Currently we check only the header where $SpamFilters_YourHop in occures
 323
 324                 if (is_int(strpos($received, $SpamFilters_YourHop))) {
 325                     if (preg_match('/([0-9]{1,3})\.([0-9]{1,3})\.([0-9]{1,3})\.([0-9]{1,3})/',$received,$aMatch)) {
 326                         $isspam = false;
 327                         if (filters_spam_check_site($aMatch[1],$aMatch[2],$aMatch[3],$aMatch[4],$filters)) {
 328                             $aSpamIds[] = $MsgNum;
 329                             $isspam = true;
 330                         }
 331                         if ($bulkquery) {
 332                             array_shift($aMatch);
 333                             $IP = explode('.',$aMatch);
 334                             foreach ($filters as $key => $value) {
 335                                 if ($filters[$key]['enabled'] && $filters[$key]['dns']) {
 336                                     if (strlen($SpamFilters_DNScache[$IP.'.'.$filters[$key]['dns']]) == 0) {
 337                                        $IPs[$IP] = true;
 338                                        break;
 339                                     }
 340                                 }
 341                             }
 342                         }
 343                         // If we've checked one IP and YourHop is
 344                         // just a space
 345                         if ($SpamFilters_YourHop == ' ' || $isspam) {
 346                             break;  // don't check any more
 347                         }
 348                     }
 349                 }
 350             }
 351         }
 352     }
 353     // Lookie!  It's spam!  Yum!
 354     if (count($aSpamIds) && sqimap_mailbox_exists($imap_stream, $filters_spam_folder)) {
 355         sqimap_msgs_list_move ($imap_stream, $aSpamIds, $filters_spam_folder);
 356         sqimap_mailbox_expunge($imap_stream, 'INBOX');
 357     }
 358
 359     if ($bulkquery && count($IPs)) {
 360         filters_bulkquery($filters, $IPs);
 361     }
 362
 363     if ($SpamFilters_SharedCache) {
 364        filters_SaveCache();
 365     } else {
 366        sqsession_register($SpamFilters_DNScache, 'SpamFilters_DNScache');
 367     }
 368 }
 369
 370 // Does the loop through each enabled filter for the specified IP address.
 371 // IP format:  $a.$b.$c.$d
 372 function filters_spam_check_site($a, $b, $c, $d, &$filters) {
 373     global $SpamFilters_DNScache, $SpamFilters_CacheTTL;
 374     foreach ($filters as $key => $value) {
 375         if ($filters[$key]['enabled']) {
 376             if ($filters[$key]['dns']) {
 377                 $filter_revip = $d . '.' . $c . '.' . $b . '.' . $a . '.' .
 378                                 $filters[$key]['dns'];
 379
 380                 if(!isset($SpamFilters_DNScache[$filter_revip]['L']))
 381                         $SpamFilters_DNScache[$filter_revip]['L'] = '';
 382
 383                 if(!isset($SpamFilters_DNScache[$filter_revip]['T']))
 384                         $SpamFilters_DNScache[$filter_revip]['T'] = '';
 385
 386                 if (strlen($SpamFilters_DNScache[$filter_revip]['L']) == 0) {
 387                     $SpamFilters_DNScache[$filter_revip]['L'] =
 388                                     gethostbyname($filter_revip);
 389                     $SpamFilters_DNScache[$filter_revip]['T'] =
 390                                        time() + $SpamFilters_CacheTTL;
 391                 }
 392                 if ($SpamFilters_DNScache[$filter_revip]['L'] ==
 393                     $filters[$key]['result']) {
 394                     return 1;
 395                 }
 396             }
 397         }
 398     }
 399     return 0;
 400 }
 401
 402 function load_filters() {
 403     global $data_dir, $username;
 404
 405     $filters = array();
 406     for ($i=0; $fltr = getPref($data_dir, $username, 'filter' . $i); $i++) {
 407         $ary = explode(',', $fltr);
 408         $filters[$i]['where'] = $ary[0];
 409         $filters[$i]['what'] = $ary[1];
 410         $filters[$i]['folder'] = $ary[2];
 411     }
 412     return $filters;
 413 }
 414
 415 function load_spam_filters() {
 416     global $data_dir, $username, $SpamFilters_ShowCommercial;
 417
 418     if ($SpamFilters_ShowCommercial) {
 419         $filters['MAPS RBL']['prefname'] = 'filters_spam_maps_rbl';
 420         $filters['MAPS RBL']['name'] = 'MAPS Realtime Blackhole List';
 421         $filters['MAPS RBL']['link'] = 'http://www.mail-abuse.org/rbl/';
 422         $filters['MAPS RBL']['dns'] = 'blackholes.mail-abuse.org';
 423         $filters['MAPS RBL']['result'] = '127.0.0.2';
 424         $filters['MAPS RBL']['comment'] =
 425             _("COMMERCIAL - This list contains servers that are verified spam senders. It is a pretty reliable list to scan spam from.");
 426
 427         $filters['MAPS RSS']['prefname'] = 'filters_spam_maps_rss';
 428         $filters['MAPS RSS']['name'] = 'MAPS Relay Spam Stopper';
 429         $filters['MAPS RSS']['link'] = 'http://www.mail-abuse.org/rss/';
 430         $filters['MAPS RSS']['dns'] = 'relays.mail-abuse.org';
 431         $filters['MAPS RSS']['result'] = '127.0.0.2';
 432         $filters['MAPS RSS']['comment'] =
 433             _("COMMERCIAL - Servers that are configured (or misconfigured) to allow spam to be relayed through their system will be banned with this.  Another good one to use.");
 434
 435         $filters['MAPS DUL']['prefname'] = 'filters_spam_maps_dul';
 436         $filters['MAPS DUL']['name'] = 'MAPS Dial-Up List';
 437         $filters['MAPS DUL']['link'] = 'http://www.mail-abuse.org/dul/';
 438         $filters['MAPS DUL']['dns'] = 'dialups.mail-abuse.org';
 439         $filters['MAPS DUL']['result'] = '127.0.0.3';
 440         $filters['MAPS DUL']['comment'] =
 441             _("COMMERCIAL - Dial-up users are often filtered out since they should use their ISP's mail servers to send mail.  Spammers typically get a dial-up account and send spam directly from there.");
 442
 443         $filters['MAPS RBLplus-RBL']['prefname'] = 'filters_spam_maps_rblplus_rbl';
 444         $filters['MAPS RBLplus-RBL']['name'] = 'MAPS RBL+ RBL List';
 445         $filters['MAPS RBLplus-RBL']['link'] = 'http://www.mail-abuse.org/';
 446         $filters['MAPS RBLplus-RBL']['dns'] = 'rbl-plus.mail-abuse.org';
 447         $filters['MAPS RBLplus-RBL']['result'] = '127.0.0.2';
 448         $filters['MAPS RBLplus-RBL']['comment'] =
 449             _("COMMERCIAL - RBL+ Blackhole entries.");
 450
 451         $filters['MAPS RBLplus-RSS']['prefname'] = 'filters_spam_maps_rblplus_rss';
 452         $filters['MAPS RBLplus-RSS']['name'] = 'MAPS RBL+ List RSS entries';
 453         $filters['MAPS RBLplus-RSS']['link'] = 'http://www.mail-abuse.org/';
 454         $filters['MAPS RBLplus-RSS']['dns'] = 'rbl-plus.mail-abuse.org';
 455         $filters['MAPS RBLplus-RSS']['result'] = '127.0.0.2';
 456         $filters['MAPS RBLplus-RSS']['comment'] =
 457             _("COMMERCIAL - RBL+ OpenRelay entries.");
 458
 459         $filters['MAPS RBLplus-DUL']['prefname'] = 'filters_spam_maps_rblplus_dul';
 460         $filters['MAPS RBLplus-DUL']['name'] = 'MAPS RBL+ List DUL entries';
 461         $filters['MAPS RBLplus-DUL']['link'] = 'http://www.mail-abuse.org/';
 462         $filters['MAPS RBLplus-DUL']['dns'] = 'rbl-plus.mail-abuse.org';
 463         $filters['MAPS RBLplus-DUL']['result'] = '127.0.0.3';
 464         $filters['MAPS RBLplus-DUL']['comment'] =
 465             _("COMMERCIAL - RBL+ Dial-up entries.");
 466     }
 467
 468     $filters['ORDB']['prefname'] = 'filters_spam_ordb';
 469     $filters['ORDB']['name'] = 'Open Relay Database List';
 470     $filters['ORDB']['link'] = 'http://www.ordb.org/';
 471     $filters['ORDB']['dns'] = 'relays.ordb.org';
 472     $filters['ORDB']['result'] = '127.0.0.2';
 473     $filters['ORDB']['comment'] =
 474         _("FREE - ORDB was born when ORBS went off the air. It seems to have fewer false positives than ORBS did though.");
 475
 476     $filters['FiveTen Direct']['prefname'] = 'filters_spam_fiveten_src';
 477     $filters['FiveTen Direct']['name'] = 'Five-Ten-sg.com Direct SPAM Sources';
 478     $filters['FiveTen Direct']['link'] = 'http://www.five-ten-sg.com/blackhole.php';
 479     $filters['FiveTen Direct']['dns'] = 'blackholes.five-ten-sg.com';
 480     $filters['FiveTen Direct']['result'] = '127.0.0.2';
 481     $filters['FiveTen Direct']['comment'] =
 482         _("FREE - Five-Ten-sg.com - Direct SPAM sources.");
 483
 484     $filters['FiveTen DUL']['prefname'] = 'filters_spam_fiveten_dul';
 485     $filters['FiveTen DUL']['name'] = 'Five-Ten-sg.com DUL Lists';
 486     $filters['FiveTen DUL']['link'] = 'http://www.five-ten-sg.com/blackhole.php';
 487     $filters['FiveTen DUL']['dns'] = 'blackholes.five-ten-sg.com';
 488     $filters['FiveTen DUL']['result'] = '127.0.0.3';
 489     $filters['FiveTen DUL']['comment'] =
 490         _("FREE - Five-Ten-sg.com - Dial-up lists - includes some DSL IPs.");
 491
 492     $filters['FiveTen Unc. OptIn']['prefname'] = 'filters_spam_fiveten_oi';
 493     $filters['FiveTen Unc. OptIn']['name'] = 'Five-Ten-sg.com Unconfirmed OptIn Lists';
 494     $filters['FiveTen Unc. OptIn']['link'] = 'http://www.five-ten-sg.com/blackhole.php';
 495     $filters['FiveTen Unc. OptIn']['dns'] = 'blackholes.five-ten-sg.com';
 496     $filters['FiveTen Unc. OptIn']['result'] = '127.0.0.4';
 497     $filters['FiveTen Unc. OptIn']['comment'] =
 498         _("FREE - Five-Ten-sg.com - Bulk mailers that do not use confirmed opt-in.");
 499
 500     $filters['FiveTen Others']['prefname'] = 'filters_spam_fiveten_oth';
 501     $filters['FiveTen Others']['name'] = 'Five-Ten-sg.com Other Misc. Servers';
 502     $filters['FiveTen Others']['link'] = 'http://www.five-ten-sg.com/blackhole.php';
 503     $filters['FiveTen Others']['dns'] = 'blackholes.five-ten-sg.com';
 504     $filters['FiveTen Others']['result'] = '127.0.0.5';
 505     $filters['FiveTen Others']['comment'] =
 506         _("FREE - Five-Ten-sg.com - Other misc. servers.");
 507
 508     $filters['FiveTen Single Stage']['prefname'] = 'filters_spam_fiveten_ss';
 509     $filters['FiveTen Single Stage']['name'] = 'Five-Ten-sg.com Single Stage Servers';
 510     $filters['FiveTen Single Stage']['link'] = 'http://www.five-ten-sg.com/blackhole.php';
 511     $filters['FiveTen Single Stage']['dns'] = 'blackholes.five-ten-sg.com';
 512     $filters['FiveTen Single Stage']['result'] = '127.0.0.6';
 513     $filters['FiveTen Single Stage']['comment'] =
 514         _("FREE - Five-Ten-sg.com - Single Stage servers.");
 515
 516     $filters['FiveTen SPAM Support']['prefname'] = 'filters_spam_fiveten_supp';
 517     $filters['FiveTen SPAM Support']['name'] = 'Five-Ten-sg.com SPAM Support Servers';
 518     $filters['FiveTen SPAM Support']['link'] = 'http://www.five-ten-sg.com/blackhole.php';
 519     $filters['FiveTen SPAM Support']['dns'] = 'blackholes.five-ten-sg.com';
 520     $filters['FiveTen SPAM Support']['result'] = '127.0.0.7';
 521     $filters['FiveTen SPAM Support']['comment'] =
 522         _("FREE - Five-Ten-sg.com - SPAM Support servers.");
 523
 524     $filters['FiveTen Web forms']['prefname'] = 'filters_spam_fiveten_wf';
 525     $filters['FiveTen Web forms']['name'] = 'Five-Ten-sg.com Web Form IPs';
 526     $filters['FiveTen Web forms']['link'] = 'http://www.five-ten-sg.com/blackhole.php';
 527     $filters['FiveTen Web forms']['dns'] = 'blackholes.five-ten-sg.com';
 528     $filters['FiveTen Web forms']['result'] = '127.0.0.8';
 529     $filters['FiveTen Web forms']['comment'] =
 530         _("FREE - Five-Ten-sg.com - Web Form IPs.");
 531
 532     $filters['Dorkslayers']['prefname'] = 'filters_spam_dorks';
 533     $filters['Dorkslayers']['name'] = 'Dorkslayers Lists';
 534     $filters['Dorkslayers']['link'] = 'http://www.dorkslayers.com';
 535     $filters['Dorkslayers']['dns'] = 'orbs.dorkslayers.com';
 536     $filters['Dorkslayers']['result'] = '127.0.0.2';
 537     $filters['Dorkslayers']['comment'] =
 538         _("FREE - Dorkslayers appears to include only really bad open relays outside the US to avoid being sued. Interestingly enough, their website recommends you NOT use their service.");
 539
 540     $filters['SPAMhaus']['prefname'] = 'filters_spam_spamhaus';
 541     $filters['SPAMhaus']['name'] = 'SPAMhaus Lists';
 542     $filters['SPAMhaus']['link'] = 'http://www.spamhaus.org';
 543     $filters['SPAMhaus']['dns'] = 'sbl.spamhaus.org';
 544     $filters['SPAMhaus']['result'] = '127.0.0.6';
 545     $filters['SPAMhaus']['comment'] =
 546         _("FREE - SPAMhaus - A list of well-known SPAM sources.");
 547
 548     $filters['SPAMcop']['prefname'] = 'filters_spam_spamcop';
 549     $filters['SPAMcop']['name'] = 'SPAM Cop Lists';
 550     $filters['SPAMcop']['link'] = 'http://spamcop.net/bl.shtml';
 551     $filters['SPAMcop']['dns'] = 'bl.spamcop.net';
 552     $filters['SPAMcop']['result'] = '127.0.0.2';
 553     $filters['SPAMcop']['comment'] =
 554         _("FREE, for now - SPAMCOP - An interesting solution that lists servers that have a very high spam to legit email ratio (85 percent or more).");
 555
 556     $filters['dev.null.dk']['prefname'] = 'filters_spam_devnull';
 557     $filters['dev.null.dk']['name'] = 'dev.null.dk Lists';
 558     $filters['dev.null.dk']['link'] = 'http://dev.null.dk/';
 559     $filters['dev.null.dk']['dns'] = 'dev.null.dk';
 560     $filters['dev.null.dk']['result'] = '127.0.0.2';
 561     $filters['dev.null.dk']['comment'] =
 562         _("FREE - dev.null.dk - I don't have any detailed info on this list.");
 563
 564     $filters['visi.com']['prefname'] = 'filters_spam_visi';
 565     $filters['visi.com']['name'] = 'visi.com Relay Stop List';
 566     $filters['visi.com']['link'] = 'http://relays.visi.com';
 567     $filters['visi.com']['dns'] = 'relays.visi.com';
 568     $filters['visi.com']['result'] = '127.0.0.2';
 569     $filters['visi.com']['comment'] =
 570         _("FREE - visi.com - Relay Stop List. Very conservative OpenRelay List.");
 571
 572     $filters['2mbit.com Open Relays']['prefname'] = 'filters_spam_2mb_or';
 573     $filters['2mbit.com Open Relays']['name'] = '2mbit.com Open Relays List';
 574     $filters['2mbit.com Open Relays']['link'] = 'http://www.2mbit.com/sbl.php';
 575     $filters['2mbit.com Open Relays']['dns'] = 'blackholes.2mbit.com';
 576     $filters['2mbit.com Open Relays']['result'] = '127.0.0.2';
 577     $filters['2mbit.com Open Relays']['comment'] =
 578         _("FREE - 2mbit.com Open Relays - Another list of Open Relays.");
 579
 580     $filters['2mbit.com SPAM Source']['prefname'] = 'filters_spam_2mb_ss';
 581     $filters['2mbit.com SPAM Source']['name'] = '2mbit.com SPAM Source List';
 582     $filters['2mbit.com SPAM Source']['link'] = 'http://www.2mbit.com/sbl.php';
 583     $filters['2mbit.com SPAM Source']['dns'] = 'blackholes.2mbit.com';
 584     $filters['2mbit.com SPAM Source']['result'] = '127.0.0.4';
 585     $filters['2mbit.com SPAM Source']['comment'] =
 586         _("FREE - 2mbit.com SPAM Source - List of Direct SPAM Sources.");
 587
 588     $filters['2mbit.com SPAM ISPs']['prefname'] = 'filters_spam_2mb_isp';
 589     $filters['2mbit.com SPAM ISPs']['name'] = '2mbit.com SPAM-friendly ISP List';
 590     $filters['2mbit.com SPAM ISPs']['link'] = 'http://www.2mbit.com/sbl.php';
 591     $filters['2mbit.com SPAM ISPs']['dns'] = 'blackholes.2mbit.com';
 592     $filters['2mbit.com SPAM ISPs']['result'] = '127.0.0.10';
 593     $filters['2mbit.com SPAM ISPs']['comment'] =
 594         _("FREE - 2mbit.com SPAM ISPs - List of SPAM-friendly ISPs.");
 595
 596     $filters['Leadmon DUL']['prefname'] = 'filters_spam_lm_dul';
 597     $filters['Leadmon DUL']['name'] = 'Leadmon.net DUL List';
 598     $filters['Leadmon DUL']['link'] = 'http://www.leadmon.net/spamguard/';
 599     $filters['Leadmon DUL']['dns'] = 'spamguard.leadmon.net';
 600     $filters['Leadmon DUL']['result'] = '127.0.0.2';
 601     $filters['Leadmon DUL']['comment'] =
 602         _("FREE - Leadmon DUL - Another list of Dial-up or otherwise dynamically assigned IPs.");
 603
 604     $filters['Leadmon SPAM Source']['prefname'] = 'filters_spam_lm_ss';
 605     $filters['Leadmon SPAM Source']['name'] = 'Leadmon.net SPAM Source List';
 606     $filters['Leadmon SPAM Source']['link'] = 'http://www.leadmon.net/spamguard/';
 607     $filters['Leadmon SPAM Source']['dns'] = 'spamguard.leadmon.net';
 608     $filters['Leadmon SPAM Source']['result'] = '127.0.0.3';
 609     $filters['Leadmon SPAM Source']['comment'] =
 610         _("FREE - Leadmon SPAM Source - List of IPs Leadmon.net has received SPAM directly from.");
 611
 612     $filters['Leadmon Bulk Mailers']['prefname'] = 'filters_spam_lm_bm';
 613     $filters['Leadmon Bulk Mailers']['name'] = 'Leadmon.net Bulk Mailers List';
 614     $filters['Leadmon Bulk Mailers']['link'] = 'http://www.leadmon.net/spamguard/';
 615     $filters['Leadmon Bulk Mailers']['dns'] = 'spamguard.leadmon.net';
 616     $filters['Leadmon Bulk Mailers']['result'] = '127.0.0.4';
 617     $filters['Leadmon Bulk Mailers']['comment'] =
 618         _("FREE - Leadmon Bulk Mailers - Bulk mailers that do not require confirmed opt-in or that have allowed known spammers to become clients and abuse their services.");
 619
 620     $filters['Leadmon Open Relays']['prefname'] = 'filters_spam_lm_or';
 621     $filters['Leadmon Open Relays']['name'] = 'Leadmon.net Open Relays List';
 622     $filters['Leadmon Open Relays']['link'] = 'http://www.leadmon.net/spamguard/';
 623     $filters['Leadmon Open Relays']['dns'] = 'spamguard.leadmon.net';
 624     $filters['Leadmon Open Relays']['result'] = '127.0.0.5';
 625     $filters['Leadmon Open Relays']['comment'] =
 626         _("FREE - Leadmon Open Relays - Single Stage Open Relays that are not listed on other active RBLs.");
 627
 628     $filters['Leadmon Multi-stage']['prefname'] = 'filters_spam_lm_ms';
 629     $filters['Leadmon Multi-stage']['name'] = 'Leadmon.net Multi-Stage Relay List';
 630     $filters['Leadmon Multi-stage']['link'] = 'http://www.leadmon.net/spamguard/';
 631     $filters['Leadmon Multi-stage']['dns'] = 'spamguard.leadmon.net';
 632     $filters['Leadmon Multi-stage']['result'] = '127.0.0.6';
 633     $filters['Leadmon Multi-stage']['comment'] =
 634         _("FREE - Leadmon Multi-stage - Multi-Stage Open Relays that are not listed on other active RBLs and that have sent SPAM to Leadmon.net.");
 635
 636     $filters['Leadmon SpamBlock']['prefname'] = 'filters_spam_lm_sb';
 637     $filters['Leadmon SpamBlock']['name'] = 'Leadmon.net SpamBlock Sites List';
 638     $filters['Leadmon SpamBlock']['link'] = 'http://www.leadmon.net/spamguard/';
 639     $filters['Leadmon SpamBlock']['dns'] = 'spamguard.leadmon.net';
 640     $filters['Leadmon SpamBlock']['result'] = '127.0.0.7';
 641     $filters['Leadmon SpamBlock']['comment'] =
 642         _("FREE - Leadmon SpamBlock - Sites on this listing have sent Leadmon.net direct SPAM from IPs in netblocks where the entire block has no DNS mappings. It's a list of BLOCKS of IPs being used by people who have SPAMmed Leadmon.net.");
 643
 644     $filters['NJABL Open Relays']['prefname'] = 'filters_spam_njabl_or';
 645     $filters['NJABL Open Relays']['name'] = 'NJABL Open Relay/Direct Spam Source List';
 646     $filters['NJABL Open Relays']['link'] = 'http://www.njabl.org/';
 647     $filters['NJABL Open Relays']['dns'] = 'dnsbl.njabl.org';
 648     $filters['NJABL Open Relays']['result'] = '127.0.0.2';
 649     $filters['NJABL Open Relays']['comment'] =
 650         _("FREE, for now - Not Just Another Blacklist - Both Open Relays and Direct SPAM Sources.");
 651
 652     $filters['NJABL DUL']['prefname'] = 'filters_spam_njabl_dul';
 653     $filters['NJABL DUL']['name'] = 'NJABL Dial-ups List';
 654     $filters['NJABL DUL']['link'] = 'http://www.njabl.org/';
 655     $filters['NJABL DUL']['dns'] = 'dnsbl.njabl.org';
 656     $filters['NJABL DUL']['result'] = '127.0.0.3';
 657     $filters['NJABL DUL']['comment'] =
 658         _("FREE, for now - Not Just Another Blacklist - Dial-up IPs.");
 659
 660     $filters['Conf DSBL.ORG Relay']['prefname'] = 'filters_spam_dsbl_conf_ss';
 661     $filters['Conf DSBL.ORG Relay']['name'] = 'DSBL.org Confirmed Relay List';
 662     $filters['Conf DSBL.ORG Relay']['link'] = 'http://www.dsbl.org/';
 663     $filters['Conf DSBL.ORG Relay']['dns'] = 'list.dsbl.org';
 664     $filters['Conf DSBL.ORG Relay']['result'] = '127.0.0.2';
 665     $filters['Conf DSBL.ORG Relay']['comment'] =
 666         _("FREE - Distributed Sender Boycott List - Confirmed Relays");
 667
 668     $filters['Conf DSBL.ORG Multi-Stage']['prefname'] = 'filters_spam_dsbl_conf_ms';
 669     $filters['Conf DSBL.ORG Multi-Stage']['name'] = 'DSBL.org Confirmed Multi-Stage Relay List';
 670     $filters['Conf DSBL.ORG Multi-Stage']['link'] = 'http://www.dsbl.org/';
 671     $filters['Conf DSBL.ORG Multi-Stage']['dns'] = 'multihop.dsbl.org';
 672     $filters['Conf DSBL.ORG Multi-Stage']['result'] = '127.0.0.2';
 673     $filters['Conf DSBL.ORG Multi-Stage']['comment'] =
 674         _("FREE - Distributed Sender Boycott List - Confirmed Multi-stage Relays");
 675
 676     $filters['UN-Conf DSBL.ORG']['prefname'] = 'filters_spam_dsbl_unc';
 677     $filters['UN-Conf DSBL.ORG']['name'] = 'DSBL.org UN-Confirmed Relay List';
 678     $filters['UN-Conf DSBL.ORG']['link'] = 'http://www.dsbl.org/';
 679     $filters['UN-Conf DSBL.ORG']['dns'] = 'unconfirmed.dsbl.org';
 680     $filters['UN-Conf DSBL.ORG']['result'] = '127.0.0.2';
 681     $filters['UN-Conf DSBL.ORG']['comment'] =
 682         _("FREE - Distributed Sender Boycott List - UN-Confirmed Relays");
 683
 684     foreach ($filters as $Key => $Value) {
 685         $filters[$Key]['enabled'] = getPref($data_dir, $username,
 686             $filters[$Key]['prefname']);
 687     }
 688
 689     return $filters;
 690 }
 691
 692 function remove_filter ($id) {
 693     global $data_dir, $username;
 694
 695     while ($nextFilter = getPref($data_dir, $username, 'filter' .
 696         ($id + 1))) {
 697         setPref($data_dir, $username, 'filter' . $id, $nextFilter);
 698         $id ++;
 699     }
 700
 701     removePref($data_dir, $username, 'filter' . $id);
 702 }
 703
 704 function filter_swap($id1, $id2) {
 705     global $data_dir, $username;
 706
 707     $FirstFilter = getPref($data_dir, $username, 'filter' . $id1);
 708     $SecondFilter = getPref($data_dir, $username, 'filter' . $id2);
 709
 710     if ($FirstFilter && $SecondFilter) {
 711         setPref($data_dir, $username, 'filter' . $id2, $FirstFilter);
 712         setPref($data_dir, $username, 'filter' . $id1, $SecondFilter);
 713     }
 714 }
 715
 716 /* This update the filter rules when
 717    renaming or deleting folders */
 718 function update_for_folder ($args) {
 719     $old_folder = $args[0];
 720         $new_folder = $args[2];
 721         $action = $args[1];
 722     global $plugins, $data_dir, $username;
 723     $filters = array();
 724     $filters = load_filters();
 725     $filter_count = count($filters);
 726     $p = 0;
 727     for ($i=0;$i<$filter_count;$i++) {
 728         if (!empty($filters)) {
 729             if ($old_folder == $filters[$i]['folder']) {
 730                 if ($action == 'rename') {
 731                     $filters[$i]['folder'] = $new_folder;
 732                     setPref($data_dir, $username, 'filter'.$i,
 733                     $filters[$i]['where'].','.$filters[$i]['what'].','.$new_folder);
 734                 }
 735                 elseif ($action == 'delete') {
 736                     remove_filter($p);
 737                     $p = $p-1;
 738                 }
 739             }
 740         $p++;
 741         }
 742     }
 743 }
 744 /*
 745  * Function extracted from sqimap_get_small_header_list.
 746  * The unused FETCH arguments and HEADERS are disabled.
 747  */
 748 function filter_get_headers ($imap_stream, $query) {
 749     global $uid_support;
 750     /* Get the small headers for each message in $msg_list */
 751
 752     $read_list = sqimap_run_command_list ($imap_stream, $query, false, $response, $message, $uid_support);
 753
 754     if (isset($response) && $response != 'OK') {
 755         return false;
 756     }
 757
 758
 759     foreach ($read_list as $r) {
 760         $read = implode('',$r);
 761         /*
 762             * #id<space>FETCH<space>(
 763         */
 764         /* extract the message id */
 765         $i_space = strpos($read,' ',2);
 766         $id = substr($read,2,$i_space-2);
 767         $fetch = substr($read,$i_space+1,5);
 768         if (!is_numeric($id) && $fetch !== 'FETCH') {
 769             set_up_language($squirrelmail_language);
 770             echo '<br><b><font color=$color[2]>' .
 771                  _("ERROR : Could not complete request.") .
 772                  '</b><br>' .
 773                  _("Unknown response from IMAP server: ") . ' 1.' .
 774                  htmlspecialchars($read) . "</font><br>\n";
 775                  break;
 776         }
 777         $i = strpos($read,'(',$i_space+5);
 778         $read = substr($read,$i+1);
 779         $i_len = strlen($read);
 780         $i = 0;
 781         while ($i < $i_len && $i !== false) {
 782             /* get argument */
 783             $read = trim(substr($read,$i));
 784             $i_len = strlen($read);
 785             $i = strpos($read,' ');
 786             $arg = substr($read,0,$i);
 787             ++$i;
 788             switch ($arg)
 789             {
 790             case 'UID':
 791                 $i_pos = strpos($read,' ',$i);
 792                 if (!$i_pos) {
 793                     $i_pos = strpos($read,')',$i);
 794                 }
 795                 if ($i_pos) {
 796                     $unique_id = substr($read,$i,$i_pos-$i);
 797                     $i = $i_pos+1;
 798                 } else {
 799                     break 3;
 800                 }
 801                 $msgs[$id]['UID'] = $unique_id;
 802                 break;
 803             // case 'FLAGS':
 804             //    $flags = parseArray($read,$i);
 805             //    if (!$flags) break 3;
 806             //    $msgs[$id]['FLAGS'] = $flags;
 807             //    break;
 808             // case 'RFC822.SIZE':
 809             //    $i_pos = strpos($read,' ',$i);
 810             //    if (!$i_pos) {
 811             //        $i_pos = strpos($read,')',$i);
 812             //    }
 813             //    if ($i_pos) {
 814             //        $size = substr($read,$i,$i_pos-$i);
 815             //        $i = $i_pos+1;
 816             //    } else {
 817             //        break 3;
 818             //    }
 819             //    $msgs[$id]['SIZE'] = $size;
 820             //
 821             //    break;
 822             // case 'INTERNALDATE':
 823             //    $msgs[$id]['INTERNALDATE'] = parseString($read,$i);
 824             //    break;
 825             case 'BODY.PEEK[HEADER.FIELDS':
 826             case 'BODY[HEADER.FIELDS':
 827                 $i = strpos($read,'{',$i);
 828                 $header = parseString($read,$i);
 829                 if ($header === false) break 3;
 830                 /* First we unfold the header */
 831                 $hdr = trim(str_replace(array("\r\n\t", "\r\n "),array('', ''), $header));
 832                 /* Now we can make a new header array with */
 833                 /* each element representing a headerline  */
 834                 $hdr = explode("\r\n" , $hdr);
 835                 foreach ($hdr as $line) {
 836                     $pos = strpos($line, ':');
 837                     if ($pos > 0) {
 838                         $field = strtolower(substr($line, 0, $pos));
 839                         if (!strstr($field,' ')) { /* valid field */
 840                             $value = trim(substr($line, $pos+1));
 841                             switch($field) {
 842                             case 'received':    $msgs[$id]['HEADER']['Received'][] =       $value; break;
 843                             // case 'to':          $msgs[$id]['HEADER']['To']=             $value; break;
 844                             // case 'cc':          $msgs[$id]['HEADER']['Cc'] =            $value; break;
 845                             // case 'from':        $msgs[$id]['HEADER']['From'] =          $value; break;
 846                             // case 'date':        $msgs[$id]['HEADER']['Date'] =          $value; break;
 847                             // case 'x-priority':  $msgs[$id]['HEADER']['Prio'] =          $value; break;
 848                             // case 'subject':     $msgs[$id]['HEADER']['Subject'] =       $value; break;
 849                             // case 'content-type':$msgs[$id]['HEADER']['Content-Type'] =  $value; break;
 850                             default: break;
 851                             }
 852                         }
 853                     }
 854                 }
 855                 break;
 856             default:
 857                 ++$i;
 858                 break;
 859             }
 860         }
 861     }
 862     return $msgs;
 863 }
 864
 865 ?>