*
* This file contains functions needed to handle headers in mime messages.
*
- * @copyright 2003-2012 The SquirrelMail Project Team
+ * @copyright 2003-2020 The SquirrelMail Project Team
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id$
* @package squirrelmail
* @since 1.3.0
*/
class Rfc822Header {
+ /**
+ * All headers, unparsed
+ * @var array
+ */
+ var $raw_headers = array();
/**
* Date header
* @var mixed
foreach ($hdr as $line) {
$pos = strpos($line, ':');
if ($pos > 0) {
+ $this->raw_headers[] = $line;
$field = substr($line, 0, $pos);
if (!strstr($field,' ')) { /* valid field */
$value = trim(substr($line, $pos+1));
$this->mlist('id', $value);
break;
case 'x-spam-status':
+ case 'x-spam-score':
$this->x_spam_status = $this->parseSpamStatus($value);
break;
+ case 'x-sm-flag-reply':
+ $this->x_sm_flag_reply = $value;
+ break;
default:
break;
}
$value = substr($value,strlen($charset)+1);
/* FIXME: What's the status of charset decode with language information ????
* Maybe language information contains only ascii text and charset_decode()
- * only runs htmlspecialchars() on it. If it contains 8bit information, you
+ * only runs sm_encode_html_special_chars() on it. If it contains 8bit information, you
* get html encoded text in charset used by selected translation.
*/
$value = charset_decode($charset,$value);
}
/**
- * Parses the X-Spam-Status header
+ * Parses the X-Spam-Status or X-Spam-Score 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
+ // Update circa 2018, this header can also be simply:
+ // No, score=1.5
+ // So we make the rest of the line optional (there are likely other permutations, so
+ // each element is made optional except the first two... maybe even that's not flexible enough)
+ //
+ // Also now allow parsing of X-Spam-Score header, whose value is just a float
$spam_status = array();
- if (preg_match ('/^(No|Yes),\s+score=(-?\d+\.\d+)\s+required=(-?\d+\.\d+)\s+tests=(.*?)\s+autolearn=(.*?)\s+version=(.+?)$/', $value, $matches)) {
+ if (preg_match ('/^(?:(No|Yes),\s+score=)?(-?\d+\.\d+)(?:\s+required=(-?\d+\.\d+))?(?:\s+tests=(.*?))?(?:\s+autolearn=(.*?))?(?:\s+version=(.+?))?$/i', $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;
+ if (!empty($matches[1])) {
+ if (strtolower($matches[1]) == 'yes')
+ $spam_status['is_spam'] = true;
+ else
+ $spam_status['is_spam'] = false;
}
// score
- $spam_status['score'] = $matches[2];
+ if (!empty($matches[2]))
+ $spam_status['score'] = $matches[2];
// required
- $spam_status['required'] = $matches[3];
+ if (!empty($matches[3]))
+ $spam_status['required'] = $matches[3];
// tests
- $tests = array();
- $tests = explode(',', $matches[4]);
- foreach ($tests as $test) {
- $spam_status['tests'][] = trim($test);
+ if (isset($matches[4])) {
+ $tests = array();
+ $tests = explode(',', $matches[4]);
+ foreach ($tests as $test) {
+ $spam_status['tests'][] = trim($test);
+ }
}
// autolearn
- $spam_status['autolearn'] = $matches[5];
+ if (isset($matches[5]))
+ $spam_status['autolearn'] = $matches[5];
// version
- $spam_status['version'] = $matches[6];
+ if (isset($matches[6]))
+ $spam_status['version'] = $matches[6];
+
} else {
$spam_status['bad_format'] = 1;
$spam_status['value'] = $value;
/**
//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
+ * Looking at the code years after it was written,
+ * this is my (Paul) best guess as to what this
+ * function does (note that docs previously claimed
+ * that this function returns boolean or an array,
+ * but it no longer appears to return an array - an
+ * integer instead):
+ *
+ * Inspects the TO and CC headers of the message
+ * represented by this object, looking for the
+ * address(es) given by $address
+ *
+ * If $address is a string:
+ * Serves as a test (returns boolean) as to
+ * whether or not the given address is found
+ * anywhere in the TO or CC headers
+ *
+ * If $address is an array:
+ * Looks through this list of addresses and
+ * returns the array index (an integer even
+ * if the array is given with keys of a
+ * different type) of the first matching
+ * $address found in this message's
+ * TO or CC headers, unless there is an exact
+ * match (meaning that the "personal
+ * information" in addition to the email
+ * address also matches), in which case that
+ * index (the first one found) is returned
+ *
+ * @param mixed $address Address(es) to search for in this
+ * message's TO and CC headers - please
+ * see above how the format of this
+ * argument affects the return value
+ * of this function
+ * @param boolean $recurs FOR INTERNAL USE ONLY
+ *
+ * @return mixed Boolean when $address is a scalar,
+ * indicating whether or not the address
+ * was found in the TO or CC headers.
+ * An integer when $address is an array,
+ * containing the index of the value in
+ * that array that was found in the TO
+ * or CC headers, or boolean FALSE if
+ * there were no matches at all
+ *
* @since 1.3.2
*/
function findAddress($address, $recurs = false) {
$i=0;
foreach($address as $argument) {
$match = $this->findAddress($argument, true);
- if ($match[1]) {
+ if ($match[1]) { // this indicates when the personal information matched
return $i;
} else {
- if (count($match[0]) && !$result) {
+ if (count($match[0]) && $result === FALSE) {
$result = $i;
}
}
}
if ($recurs) {
return array($results, false);
- } elseif (count($result)) {
+ } elseif (count($results)) {
return true;
} else {
return false;
projects / squirrelmail.git / blobdiff