Call me anal
[squirrelmail.git] / class / mime / Rfc822Header.class.php
index c5b99d6c6543025aad4fc92bbc8d0287238509f2..2d44a4b725121a6c188b0cc55afb79a01504d0b8 100644 (file)
@@ -5,7 +5,7 @@
  *
  * This file contains functions needed to handle headers in mime messages.
  *
- * @copyright © 2003-2006 The SquirrelMail Project Team
+ * @copyright © 2003-2007 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
@@ -29,6 +29,11 @@ class Rfc822Header {
      * @var mixed
      */
     var $date = -1;
+    /**
+     * Original date header as fallback for unparsable dates
+     * @var mixed
+     */
+    var $date_unparsed = '';
     /**
      * Subject header
      * @var string
@@ -132,6 +137,11 @@ class Rfc822Header {
      * @var mixed
      */
     var $mlist = array();
+    /**
+     * SpamAssassin 'x-spam-status' header
+     * @var mixed
+     */
+    var $x_spam_status = array();
     /**
      * Extra header
      * only needed for constructing headers in delivery class
@@ -229,6 +239,7 @@ class Rfc822Header {
                 $d = strtr($value, array('  ' => ' '));
                 $d = explode(' ', $d);
                 $this->date = getTimeStamp($d);
+                $this->date_unparsed = strtr($value,'<>','  ');
                 break;
             case 'subject':
                 $this->subject = $value;
@@ -338,6 +349,9 @@ class Rfc822Header {
                 $value = $this->stripComments($value);
                 $this->mlist('id', $value);
                 break;
+            case 'x-spam-status':
+                $this->x_spam_status = $this->parseSpamStatus($value);
+                break;
             default:
                 break;
         }
@@ -495,7 +509,7 @@ class Rfc822Header {
             $sComment = trim(implode(' ',$aComment));
             $sPersonal .= $sComment;
         }
-        $oAddr =& new AddressStructure();
+        $oAddr = new AddressStructure();
         if ($sPersonal && substr($sPersonal,0,2) == '=?') {
             $oAddr->personal = encodeHeader($sPersonal);
         } else {
@@ -552,7 +566,7 @@ class Rfc822Header {
                 if ($sGroup) {
                     $aAddress[] = $this->createAddressObject($aStack,$aComment,$sEmail,$sGroup);
                     $oAddr = end($aAddress);
-                    if(!$oAddr || ((isset($oAddr)) && !$oAddr->mailbox && !$oAddr->personal)) {
+                    if(!$oAddr || ((isset($oAddr)) && !strlen($oAddr->mailbox) && !$oAddr->personal)) {
                         $sEmail = $sGroup . ':;';
                     }
                     $aAddress[] = $this->createAddressObject($aStack,$aComment,$sEmail,$sGroup);
@@ -593,8 +607,13 @@ class Rfc822Header {
                          $aAddrBookAddress = $this->parseAddress($aAddr['email'],true);
                      } else {
                          $iPosAt = strpos($aAddr['email'], '@');
-                         $oAddr->mailbox = substr($aAddr['email'], 0, $iPosAt);
-                         $oAddr->host = substr($aAddr['email'], $iPosAt+1);
+                         if ($iPosAt === FALSE) {
+                             $oAddr->mailbox = $aAddr['email'];
+                             $oAddr->host = FALSE;
+                         } else {
+                             $oAddr->mailbox = substr($aAddr['email'], 0, $iPosAt);
+                             $oAddr->host = substr($aAddr['email'], $iPosAt+1);
+                         } 
                          if (isset($aAddr['name'])) {
                              $oAddr->personal = $aAddr['name'];
                          } else {
@@ -603,18 +622,18 @@ class Rfc822Header {
                      }
                  }
             }
-            if (!$grouplookup && !$oAddr->mailbox) {
+            if (!$grouplookup && !strlen($oAddr->mailbox)) {
                 $oAddr->mailbox = trim($sEmail);
-                if ($sHost && $oAddr->mailbox) {
+                if ($sHost && strlen($oAddr->mailbox)) {
                     $oAddr->host = $sHost;
                 }
             } else if (!$grouplookup && !$oAddr->host) {
-                if ($sHost && $oAddr->mailbox) {
+                if ($sHost && strlen($oAddr->mailbox)) {
                     $oAddr->host = $sHost;
                 }
             }
           }
-          if (!$aAddrBookAddress && $oAddr->mailbox) {
+          if (!$aAddrBookAddress && strlen($oAddr->mailbox)) {
               $aProcessedAddress[] = $oAddr;
           } else {
               $aProcessedAddress = array_merge($aProcessedAddress,$aAddrBookAddress);
@@ -623,7 +642,10 @@ class Rfc822Header {
         if ($ar) {
             return $aProcessedAddress;
         } else {
-            return $aProcessedAddress[0];
+            if (isset($aProcessedAddress[0]))
+                return $aProcessedAddress[0];
+            else
+                return '';
         }
     }
 
@@ -634,15 +656,16 @@ class Rfc822Header {
      * X-MS-Mail-Priority is not parsed because it always coincides
      * with one of the other headers.
      *
-     * NOTE: this is actually a duplicate from the function in
-     * functions/imap_messages. I'm not sure if it's ok here to call
+     * NOTE: this is actually a duplicate from the code in
+     * functions/imap_messages:parseFetch().
+     * I'm not sure if it's ok here to call
      * that function?
      * @param string $sValue literal priority name
      * @return integer
      */
     function parsePriority($sValue) {
         // don't use function call inside array_shift.
-        $aValue = split('/\w/',trim($sValue));
+        $aValue = preg_split('/\s/',trim($sValue));
         $value = strtolower(array_shift($aValue));
 
         if ( is_numeric($value) ) {
@@ -785,6 +808,53 @@ class Rfc822Header {
         $this->mlist[$field] = $res_a;
     }
 
+    /**
+     * Parses the X-Spam-Status header
+     * @param string $value
+     */
+    function parseSpamStatus($value) {
+        // Header value looks like this:
+        // No, score=1.5 required=5.0 tests=MSGID_FROM_MTA_ID,NO_REAL_NAME,UPPERCASE_25_50 autolearn=disabled version=3.1.0-gr0
+
+        $spam_status = array();
+
+        if (preg_match ('/^(No|Yes),\s+score=(-?\d+\.\d+)\s+required=(-?\d+\.\d+)\s+tests=(.*?)\s+autolearn=(.*?)\s+version=(.+?)$/', $value, $matches)) {
+            // full header
+            $spam_status['bad_format'] = 0;
+            $spam_status['value'] = $matches[0];
+            // is_spam
+            if (isset($matches[1])
+                && strtolower($matches[1]) == 'yes') {
+                $spam_status['is_spam'] = true;
+            } else {
+                $spam_status['is_spam'] = false;
+            }
+
+            // score
+            $spam_status['score'] = $matches[2];
+
+            // required
+            $spam_status['required'] = $matches[3];
+
+            // tests
+            $tests = array();
+            $tests = explode(',', $matches[4]);
+            foreach ($tests as $test) {
+                $spam_status['tests'][] = trim($test);
+            }
+
+            // autolearn
+            $spam_status['autolearn'] = $matches[5];
+
+            // version
+            $spam_status['version'] = $matches[6];
+        } else {
+            $spam_status['bad_format'] = 1;
+            $spam_status['value'] = $value;
+        }
+        return $spam_status;
+    }
+
     /**
      * function to get the address strings out of the header.
      * example1: header->getAddr_s('to').
@@ -794,7 +864,7 @@ class Rfc822Header {
      * @param boolean $encoded (since 1.4.0) return encoded or plain text addresses
      * @return string
      */
-    function getAddr_s($arr, $separator = ',',$encoded=false) {
+    function getAddr_s($arr, $separator = ', ', $encoded=false) {
         $s = '';
 
         if (is_array($arr)) {
@@ -873,6 +943,7 @@ class Rfc822Header {
     }
 
     /**
+//FIXME: This needs some documentation (inside the function too)!  Don't code w/out comments!
      * @param mixed $address array or string
      * @param boolean $recurs
      * @return mixed array, boolean
@@ -895,13 +966,14 @@ class Rfc822Header {
             }
         } else {
             if (!is_array($this->cc)) $this->cc = array();
+            if (!is_array($this->to)) $this->to = array();
             $srch_addr = $this->parseAddress($address);
             $results = array();
             foreach ($this->to as $to) {
-                if ($to->host == $srch_addr->host) {
-                    if ($to->mailbox == $srch_addr->mailbox) {
+                if (strtolower($to->host) == strtolower($srch_addr->host)) {
+                    if (strtolower($to->mailbox) == strtolower($srch_addr->mailbox)) {
                         $results[] = $srch_addr;
-                        if ($to->personal == $srch_addr->personal) {
+                        if (strtolower($to->personal) == strtolower($srch_addr->personal)) {
                             if ($recurs) {
                                 return array($results, true);
                             } else {
@@ -912,10 +984,10 @@ class Rfc822Header {
                 }
             }
             foreach ($this->cc as $cc) {
-                if ($cc->host == $srch_addr->host) {
-                    if ($cc->mailbox == $srch_addr->mailbox) {
+                if (strtolower($cc->host) == strtolower($srch_addr->host)) {
+                    if (strtolower($cc->mailbox) == strtolower($srch_addr->mailbox)) {
                         $results[] = $srch_addr;
-                        if ($cc->personal == $srch_addr->personal) {
+                        if (strtolower($cc->personal) == strtolower($srch_addr->personal)) {
                             if ($recurs) {
                                 return array($results, true);
                             } else {