Minor fix
[squirrelmail.git] / class / mime / Rfc822Header.class.php
CommitLineData
19d470aa 1<?php
2
3/**
4 * Rfc822Header.class.php
5 *
0f459286 6 * This file contains functions needed to handle headers in mime messages.
19d470aa 7 *
5e5daa47 8 * @copyright 2003-2015 The SquirrelMail Project Team
4b4abf93 9 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
883d9cd3 10 * @version $Id$
2b646597 11 * @package squirrelmail
0f459286 12 * @subpackage mime
13 * @since 1.3.2
19d470aa 14 */
15
2b646597 16/**
0f459286 17 * MIME header class
19d470aa 18 * input: header_string or array
0f459286 19 * You must call parseHeader() function after creating object in order to fill object's
20 * parameters.
21 * @todo FIXME: there is no constructor function and class should ignore all input args.
2b646597 22 * @package squirrelmail
0f459286 23 * @subpackage mime
24 * @since 1.3.0
19d470aa 25 */
26class Rfc822Header {
9ed80157 27 /**
28 * Date header
29 * @var mixed
30 */
31 var $date = -1;
32 /**
609f416c 33 * Original date header as fallback for unparsable dates
3aaa3214 34 * @var mixed
35 */
36 var $date_unparsed = '';
37 /**
9ed80157 38 * Subject header
39 * @var string
40 */
41 var $subject = '';
42 /**
43 * From header
44 * @var array
45 */
46 var $from = array();
47 /**
48 * @var mixed
49 */
50 var $sender = '';
51 /**
52 * Reply-To header
53 * @var array
54 */
55 var $reply_to = array();
56 /**
57 * Mail-Followup-To header
58 * @var array
59 */
60 var $mail_followup_to = array();
61 /**
62 * To header
63 * @var array
64 */
65 var $to = array();
66 /**
67 * Cc header
68 * @var array
69 */
70 var $cc = array();
71 /**
72 * Bcc header
73 * @var array
74 */
75 var $bcc = array();
76 /**
77 * In-reply-to header
78 * @var string
79 */
80 var $in_reply_to = '';
81 /**
82 * Message-ID header
83 * @var string
84 */
85 var $message_id = '';
86 /**
87 * References header
88 * @var string
89 */
90 var $references = '';
91 /**
92 * @var mixed
93 */
94 var $mime = false;
95 /**
ae1c6dbe 96 * Content Type object
97 * @var object
9ed80157 98 */
99 var $content_type = '';
100 /**
101 * @var mixed
102 */
103 var $disposition = '';
104 /**
105 * X-Mailer header
106 * @var string
107 */
108 var $xmailer = '';
109 /**
110 * Priority header
111 * @var integer
112 */
113 var $priority = 3;
114 /**
644c6055 115 * Disposition notification for requesting message delivery notification (MDN)
9ed80157 116 * @var mixed
117 */
118 var $dnt = '';
119 /**
644c6055 120 * Delivery notification (DR)
121 * @var mixed
122 */
123 var $drnt = '';
124 /**
9ed80157 125 * @var mixed
126 */
127 var $encoding = '';
128 /**
129 * @var mixed
130 */
131 var $content_id = '';
132 /**
133 * @var mixed
134 */
135 var $content_desc = '';
136 /**
137 * @var mixed
138 */
139 var $mlist = array();
140 /**
1a64a084 141 * SpamAssassin 'x-spam-status' header
142 * @var mixed
143 */
144 var $x_spam_status = array();
145 /**
9ed80157 146 * Extra header
147 * only needed for constructing headers in delivery class
148 * @var array
149 */
150 var $more_headers = array();
151
0f459286 152 /**
153 * @param mixed $hdr string or array with message headers
154 */
19d470aa 155 function parseHeader($hdr) {
156 if (is_array($hdr)) {
157 $hdr = implode('', $hdr);
158 }
2a9b0fad 159 /* First we replace \r\n by \n and unfold the header */
0f459286 160 /* FIXME: unfolding header with multiple spaces "\n( +)" */
2a9b0fad 161 $hdr = trim(str_replace(array("\r\n", "\n\t", "\n "),array("\n", ' ', ' '), $hdr));
19d470aa 162
163 /* Now we can make a new header array with */
164 /* each element representing a headerline */
2a9b0fad 165 $hdr = explode("\n" , $hdr);
19d470aa 166 foreach ($hdr as $line) {
167 $pos = strpos($line, ':');
168 if ($pos > 0) {
169 $field = substr($line, 0, $pos);
340d67c2 170 if (!strstr($field,' ')) { /* valid field */
171 $value = trim(substr($line, $pos+1));
172 $this->parseField($field, $value);
173 }
19d470aa 174 }
175 }
ae1c6dbe 176 if (!is_object($this->content_type)) {
19d470aa 177 $this->parseContentType('text/plain; charset=us-ascii');
178 }
179 }
180
0f459286 181 /**
182 * @param string $value
183 * @return string
184 */
19d470aa 185 function stripComments($value) {
186 $result = '';
19d470aa 187 $cnt = strlen($value);
188 for ($i = 0; $i < $cnt; ++$i) {
189 switch ($value{$i}) {
190 case '"':
191 $result .= '"';
192 while ((++$i < $cnt) && ($value{$i} != '"')) {
193 if ($value{$i} == '\\') {
194 $result .= '\\';
195 ++$i;
196 }
197 $result .= $value{$i};
198 }
bf489229 199 if($i < $cnt) {
200 $result .= $value{$i};
201 }
19d470aa 202 break;
203 case '(':
204 $depth = 1;
205 while (($depth > 0) && (++$i < $cnt)) {
206 switch($value{$i}) {
207 case '\\':
208 ++$i;
209 break;
210 case '(':
211 ++$depth;
212 break;
213 case ')':
214 --$depth;
215 break;
216 default:
217 break;
218 }
219 }
220 break;
221 default:
222 $result .= $value{$i};
223 break;
224 }
225 }
226 return $result;
227 }
228
0f459286 229 /**
230 * Parse header field according to field type
231 * @param string $field field name
232 * @param string $value field value
233 */
19d470aa 234 function parseField($field, $value) {
235 $field = strtolower($field);
236 switch($field) {
237 case 'date':
340d67c2 238 $value = $this->stripComments($value);
19d470aa 239 $d = strtr($value, array(' ' => ' '));
240 $d = explode(' ', $d);
241 $this->date = getTimeStamp($d);
3aaa3214 242 $this->date_unparsed = strtr($value,'<>',' ');
19d470aa 243 break;
244 case 'subject':
245 $this->subject = $value;
246 break;
247 case 'from':
248 $this->from = $this->parseAddress($value,true);
249 break;
250 case 'sender':
251 $this->sender = $this->parseAddress($value);
252 break;
253 case 'reply-to':
254 $this->reply_to = $this->parseAddress($value, true);
255 break;
b268e66b 256 case 'mail-followup-to':
257 $this->mail_followup_to = $this->parseAddress($value, true);
258 break;
19d470aa 259 case 'to':
260 $this->to = $this->parseAddress($value, true);
261 break;
262 case 'cc':
263 $this->cc = $this->parseAddress($value, true);
264 break;
265 case 'bcc':
266 $this->bcc = $this->parseAddress($value, true);
267 break;
268 case 'in-reply-to':
269 $this->in_reply_to = $value;
270 break;
271 case 'message-id':
340d67c2 272 $value = $this->stripComments($value);
19d470aa 273 $this->message_id = $value;
274 break;
340d67c2 275 case 'references':
276 $value = $this->stripComments($value);
277 $this->references = $value;
278 break;
279 case 'x-confirm-reading-to':
19d470aa 280 case 'disposition-notification-to':
340d67c2 281 $value = $this->stripComments($value);
19d470aa 282 $this->dnt = $this->parseAddress($value);
283 break;
644c6055 284 case 'return-receipt-to':
285 $value = $this->stripComments($value);
286 $this->drnt = $this->parseAddress($value);
287 break;
19d470aa 288 case 'mime-version':
340d67c2 289 $value = $this->stripComments($value);
19d470aa 290 $value = str_replace(' ', '', $value);
291 $this->mime = ($value == '1.0' ? true : $this->mime);
292 break;
293 case 'content-type':
340d67c2 294 $value = $this->stripComments($value);
19d470aa 295 $this->parseContentType($value);
296 break;
297 case 'content-disposition':
340d67c2 298 $value = $this->stripComments($value);
19d470aa 299 $this->parseDisposition($value);
300 break;
cfebb724 301 case 'content-transfer-encoding':
302 $this->encoding = $value;
303 break;
304 case 'content-description':
305 $this->content_desc = $value;
306 break;
307 case 'content-id':
308 $value = $this->stripComments($value);
309 $this->content_id = $value;
310 break;
19d470aa 311 case 'user-agent':
312 case 'x-mailer':
340d67c2 313 $this->xmailer = $value;
19d470aa 314 break;
315 case 'x-priority':
bddb3448 316 case 'importance':
317 case 'priority':
318 $this->priority = $this->parsePriority($value);
19d470aa 319 break;
320 case 'list-post':
340d67c2 321 $value = $this->stripComments($value);
19d470aa 322 $this->mlist('post', $value);
323 break;
324 case 'list-reply':
cfebb724 325 $value = $this->stripComments($value);
19d470aa 326 $this->mlist('reply', $value);
327 break;
328 case 'list-subscribe':
cfebb724 329 $value = $this->stripComments($value);
19d470aa 330 $this->mlist('subscribe', $value);
331 break;
332 case 'list-unsubscribe':
340d67c2 333 $value = $this->stripComments($value);
19d470aa 334 $this->mlist('unsubscribe', $value);
335 break;
336 case 'list-archive':
340d67c2 337 $value = $this->stripComments($value);
19d470aa 338 $this->mlist('archive', $value);
339 break;
340 case 'list-owner':
340d67c2 341 $value = $this->stripComments($value);
19d470aa 342 $this->mlist('owner', $value);
343 break;
344 case 'list-help':
340d67c2 345 $value = $this->stripComments($value);
19d470aa 346 $this->mlist('help', $value);
347 break;
ba4d5a32 348 case 'list-id':
349 $value = $this->stripComments($value);
350 $this->mlist('id', $value);
351 break;
3aaa3214 352 case 'x-spam-status':
1a64a084 353 $this->x_spam_status = $this->parseSpamStatus($value);
354 break;
19d470aa 355 default:
356 break;
357 }
358 }
14882b16 359
0f459286 360 /**
361 * @param string $address
362 * @return array
363 */
14882b16 364 function getAddressTokens($address) {
365 $aTokens = array();
14882b16 366 $aSpecials = array('(' ,'<' ,',' ,';' ,':');
367 $aReplace = array(' (',' <',' ,',' ;',' :');
368 $address = str_replace($aSpecials,$aReplace,$address);
55243181 369 $iCnt = strlen($address);
14882b16 370 $i = 0;
371 while ($i < $iCnt) {
372 $cChar = $address{$i};
373 switch($cChar)
374 {
375 case '<':
376 $iEnd = strpos($address,'>',$i+1);
377 if (!$iEnd) {
378 $sToken = substr($address,$i);
379 $i = $iCnt;
380 } else {
381 $sToken = substr($address,$i,$iEnd - $i +1);
382 $i = $iEnd;
383 }
384 $sToken = str_replace($aReplace, $aSpecials,$sToken);
cfebb724 385 if ($sToken) $aTokens[] = $sToken;
14882b16 386 break;
387 case '"':
388 $iEnd = strpos($address,$cChar,$i+1);
0b4d4be7 389 if ($iEnd) {
390 // skip escaped quotes
391 $prev_char = $address{$iEnd-1};
392 while ($prev_char === '\\' && substr($address,$iEnd-2,2) !== '\\\\') {
393 $iEnd = strpos($address,$cChar,$iEnd+1);
394 if ($iEnd) {
395 $prev_char = $address{$iEnd-1};
396 } else {
397 $prev_char = false;
398 }
399 }
400 }
14882b16 401 if (!$iEnd) {
402 $sToken = substr($address,$i);
403 $i = $iCnt;
404 } else {
405 // also remove the surrounding quotes
406 $sToken = substr($address,$i+1,$iEnd - $i -1);
407 $i = $iEnd;
408 }
409 $sToken = str_replace($aReplace, $aSpecials,$sToken);
72956ab6 410 if ($sToken) $aTokens[] = $sToken;
14882b16 411 break;
412 case '(':
0b4d4be7 413 array_pop($aTokens); //remove inserted space
14882b16 414 $iEnd = strpos($address,')',$i);
415 if (!$iEnd) {
416 $sToken = substr($address,$i);
417 $i = $iCnt;
418 } else {
55243181 419 $iDepth = 1;
420 $iComment = $i;
421 while (($iDepth > 0) && (++$iComment < $iCnt)) {
422 $cCharComment = $address{$iComment};
423 switch($cCharComment) {
424 case '\\':
425 ++$iComment;
426 break;
427 case '(':
428 ++$iDepth;
429 break;
430 case ')':
431 --$iDepth;
432 break;
433 default:
434 break;
435 }
436 }
437 if ($iDepth == 0) {
438 $sToken = substr($address,$i,$iComment - $i +1);
439 $i = $iComment;
440 } else {
441 $sToken = substr($address,$i,$iEnd - $i + 1);
442 $i = $iEnd;
443 }
14882b16 444 }
0b4d4be7 445 // check the next token in case comments appear in the middle of email addresses
446 $prevToken = end($aTokens);
447 if (!in_array($prevToken,$aSpecials,true)) {
43c0e295 448 if ($i+1<strlen($address) && !in_array($address{$i+1},$aSpecials,true)) {
0b4d4be7 449 $iEnd = strpos($address,' ',$i+1);
450 if ($iEnd) {
451 $sNextToken = trim(substr($address,$i+1,$iEnd - $i -1));
452 $i = $iEnd-1;
453 } else {
a5ae4bc8 454 $sNextToken = trim(substr($address,$i+1));
0b4d4be7 455 $i = $iCnt;
456 }
457 // remove the token
458 array_pop($aTokens);
459 // create token and add it again
460 $sNewToken = $prevToken . $sNextToken;
1f0269d6 461 if($sNewToken) $aTokens[] = $sNewToken;
0b4d4be7 462 }
463 }
14882b16 464 $sToken = str_replace($aReplace, $aSpecials,$sToken);
cfebb724 465 if ($sToken) $aTokens[] = $sToken;
14882b16 466 break;
467 case ',':
0b4d4be7 468 case ':':
14882b16 469 case ';':
470 case ' ':
471 $aTokens[] = $cChar;
472 break;
473 default:
474 $iEnd = strpos($address,' ',$i+1);
475 if ($iEnd) {
476 $sToken = trim(substr($address,$i,$iEnd - $i));
477 $i = $iEnd-1;
478 } else {
479 $sToken = trim(substr($address,$i));
480 $i = $iCnt;
481 }
482 if ($sToken) $aTokens[] = $sToken;
483 }
484 ++$i;
485 }
486 return $aTokens;
487 }
0f459286 488
489 /**
490 * @param array $aStack
491 * @param array $aComment
492 * @param string $sEmail
493 * @param string $sGroup
494 * @return object AddressStructure object
495 */
14882b16 496 function createAddressObject(&$aStack,&$aComment,&$sEmail,$sGroup='') {
0b4d4be7 497 //$aStack=explode(' ',implode('',$aStack));
14882b16 498 if (!$sEmail) {
499 while (count($aStack) && !$sEmail) {
500 $sEmail = trim(array_pop($aStack));
501 }
502 }
503 if (count($aStack)) {
504 $sPersonal = trim(implode('',$aStack));
cfebb724 505 } else {
14882b16 506 $sPersonal = '';
507 }
508 if (!$sPersonal && count($aComment)) {
509 $sComment = trim(implode(' ',$aComment));
510 $sPersonal .= $sComment;
511 }
c6e83897 512 $oAddr = new AddressStructure();
14882b16 513 if ($sPersonal && substr($sPersonal,0,2) == '=?') {
514 $oAddr->personal = encodeHeader($sPersonal);
515 } else {
516 $oAddr->personal = $sPersonal;
517 }
0b4d4be7 518 // $oAddr->group = $sGroup;
14882b16 519 $iPosAt = strpos($sEmail,'@');
520 if ($iPosAt) {
521 $oAddr->mailbox = substr($sEmail, 0, $iPosAt);
522 $oAddr->host = substr($sEmail, $iPosAt+1);
523 } else {
524 $oAddr->mailbox = $sEmail;
525 $oAddr->host = false;
526 }
14882b16 527 $sEmail = '';
528 $aStack = $aComment = array();
529 return $oAddr;
530 }
531
0f459286 532 /**
533 * recursive function for parsing address strings and storing them in an address stucture object.
340d67c2 534 * personal name: encoded: =?charset?Q|B?string?=
535 * quoted: "string"
536 * normal: string
537 * email : <mailbox@host>
538 * : mailbox@host
539 * This function is also used for validating addresses returned from compose
14882b16 540 * That's also the reason that the function became a little bit huge
0f459286 541 * @param string $address
542 * @param boolean $ar return array instead of only the first element
543 * @param array $addr_ar (obsolete) array with parsed addresses
544 * @param string $group (obsolete)
545 * @param string $host default domainname in case of addresses without a domainname
546 * @param string $lookup (since) callback function for lookup of address strings which are probably nicks (without @)
547 * @return mixed array with AddressStructure objects or only one address_structure object.
e74ba378 548 */
14882b16 549 function parseAddress($address,$ar=false,$aAddress=array(),$sGroup='',$sHost='',$lookup=false) {
550 $aTokens = $this->getAddressTokens($address);
8d8da447 551 $sPersonal = $sEmail = $sGroup = '';
14882b16 552 $aStack = $aComment = array();
553 foreach ($aTokens as $sToken) {
554 $cChar = $sToken{0};
555 switch ($cChar)
340d67c2 556 {
557 case '=':
14882b16 558 case '"':
559 case ' ':
cfebb724 560 $aStack[] = $sToken;
340d67c2 561 break;
14882b16 562 case '(':
563 $aComment[] = substr($sToken,1,-1);
340d67c2 564 break;
3fcadedb 565 case ';':
14882b16 566 if ($sGroup) {
29f842a4 567 $aAddress[] = $this->createAddressObject($aStack,$aComment,$sEmail,$sGroup);
14882b16 568 $oAddr = end($aAddress);
7d38dfae 569 if(!$oAddr || ((isset($oAddr)) && !strlen($oAddr->mailbox) && !$oAddr->personal)) {
0b4d4be7 570 $sEmail = $sGroup . ':;';
cfebb724 571 }
0b4d4be7 572 $aAddress[] = $this->createAddressObject($aStack,$aComment,$sEmail,$sGroup);
14882b16 573 $sGroup = '';
574 $aStack = $aComment = array();
575 break;
340d67c2 576 }
14882b16 577 case ',':
578 $aAddress[] = $this->createAddressObject($aStack,$aComment,$sEmail,$sGroup);
579 break;
cfebb724 580 case ':':
29f842a4 581 $sGroup = trim(implode(' ',$aStack));
0b4d4be7 582 $sGroup = preg_replace('/\s+/',' ',$sGroup);
14882b16 583 $aStack = array();
584 break;
585 case '<':
586 $sEmail = trim(substr($sToken,1,-1));
587 break;
588 case '>':
589 /* skip */
cfebb724 590 break;
14882b16 591 default: $aStack[] = $sToken; break;
19d470aa 592 }
593 }
14882b16 594 /* now do the action again for the last address */
595 $aAddress[] = $this->createAddressObject($aStack,$aComment,$sEmail);
596 /* try to lookup the addresses in case of invalid email addresses */
597 $aProcessedAddress = array();
598 foreach ($aAddress as $oAddr) {
599 $aAddrBookAddress = array();
600 if (!$oAddr->host) {
601 $grouplookup = false;
340d67c2 602 if ($lookup) {
14882b16 603 $aAddr = call_user_func_array($lookup,array($oAddr->mailbox));
604 if (isset($aAddr['email'])) {
605 if (strpos($aAddr['email'],',')) {
606 $grouplookup = true;
607 $aAddrBookAddress = $this->parseAddress($aAddr['email'],true);
608 } else {
609 $iPosAt = strpos($aAddr['email'], '@');
5b3a1a3a 610 if ($iPosAt === FALSE) {
611 $oAddr->mailbox = $aAddr['email'];
da0135f6 612 $oAddr->host = FALSE;
5b3a1a3a 613 } else {
614 $oAddr->mailbox = substr($aAddr['email'], 0, $iPosAt);
615 $oAddr->host = substr($aAddr['email'], $iPosAt+1);
616 }
14882b16 617 if (isset($aAddr['name'])) {
618 $oAddr->personal = $aAddr['name'];
619 } else {
620 $oAddr->personal = encodeHeader($sPersonal);
621 }
622 }
623 }
340d67c2 624 }
7d38dfae 625 if (!$grouplookup && !strlen($oAddr->mailbox)) {
14882b16 626 $oAddr->mailbox = trim($sEmail);
7d38dfae 627 if ($sHost && strlen($oAddr->mailbox)) {
14882b16 628 $oAddr->host = $sHost;
340d67c2 629 }
8b53b4ba 630 } else if (!$grouplookup && !$oAddr->host) {
7d38dfae 631 if ($sHost && strlen($oAddr->mailbox)) {
8b53b4ba 632 $oAddr->host = $sHost;
633 }
cfebb724 634 }
14882b16 635 }
7d38dfae 636 if (!$aAddrBookAddress && strlen($oAddr->mailbox)) {
14882b16 637 $aProcessedAddress[] = $oAddr;
638 } else {
cfebb724 639 $aProcessedAddress = array_merge($aProcessedAddress,$aAddrBookAddress);
14882b16 640 }
340d67c2 641 }
cfebb724 642 if ($ar) {
14882b16 643 return $aProcessedAddress;
19d470aa 644 } else {
66010edf 645 if (isset($aProcessedAddress[0]))
646 return $aProcessedAddress[0];
647 else
648 return '';
19d470aa 649 }
cfebb724 650 }
19d470aa 651
bddb3448 652 /**
653 * Normalise the different Priority headers into a uniform value,
654 * namely that of the X-Priority header (1, 3, 5). Supports:
0f459286 655 * Priority, X-Priority, Importance.
bddb3448 656 * X-MS-Mail-Priority is not parsed because it always coincides
657 * with one of the other headers.
658 *
8b08e46d 659 * NOTE: this is actually a duplicate from the code in
660 * functions/imap_messages:parseFetch().
661 * I'm not sure if it's ok here to call
bddb3448 662 * that function?
ba17b6c7 663 * @param string $sValue literal priority name
0f459286 664 * @return integer
bddb3448 665 */
ba17b6c7 666 function parsePriority($sValue) {
667 // don't use function call inside array_shift.
c10512eb 668 $aValue = preg_split('/\s/',trim($sValue));
ba17b6c7 669 $value = strtolower(array_shift($aValue));
670
bddb3448 671 if ( is_numeric($value) ) {
672 return $value;
673 }
674 if ( $value == 'urgent' || $value == 'high' ) {
675 return 1;
676 } elseif ( $value == 'non-urgent' || $value == 'low' ) {
677 return 5;
678 }
679 // default is normal priority
680 return 3;
681 }
682
0f459286 683 /**
684 * @param string $value content type header
685 */
19d470aa 686 function parseContentType($value) {
687 $pos = strpos($value, ';');
688 $props = '';
689 if ($pos > 0) {
690 $type = trim(substr($value, 0, $pos));
38d6fba7 691 $props = trim(substr($value, $pos+1));
19d470aa 692 } else {
693 $type = $value;
694 }
695 $content_type = new ContentType($type);
696 if ($props) {
697 $properties = $this->parseProperties($props);
698 if (!isset($properties['charset'])) {
699 $properties['charset'] = 'us-ascii';
700 }
701 $content_type->properties = $this->parseProperties($props);
702 }
703 $this->content_type = $content_type;
704 }
cfebb724 705
0f459286 706 /**
707 * RFC2184
708 * @param array $aParameters
709 * @return array
710 */
cfebb724 711 function processParameters($aParameters) {
2ddf00ae 712 $aResults = array();
cfebb724 713 $aCharset = array();
714 // handle multiline parameters
2ddf00ae 715 foreach($aParameters as $key => $value) {
cfebb724 716 if ($iPos = strpos($key,'*')) {
717 $sKey = substr($key,0,$iPos);
718 if (!isset($aResults[$sKey])) {
719 $aResults[$sKey] = $value;
720 if (substr($key,-1) == '*') { // parameter contains language/charset info
721 $aCharset[] = $sKey;
722 }
723 } else {
724 $aResults[$sKey] .= $value;
725 }
726 } else {
727 $aResults[$key] = $value;
728 }
729 }
730 foreach ($aCharset as $key) {
731 $value = $aResults[$key];
732 // extract the charset & language
733 $charset = substr($value,0,strpos($value,"'"));
734 $value = substr($value,strlen($charset)+1);
735 $language = substr($value,0,strpos($value,"'"));
736 $value = substr($value,strlen($charset)+1);
0f459286 737 /* FIXME: What's the status of charset decode with language information ????
738 * Maybe language information contains only ascii text and charset_decode()
3047e291 739 * only runs sm_encode_html_special_chars() on it. If it contains 8bit information, you
0f459286 740 * get html encoded text in charset used by selected translation.
741 */
cfebb724 742 $value = charset_decode($charset,$value);
743 $aResults[$key] = $value;
2ddf00ae 744 }
cfebb724 745 return $aResults;
2ddf00ae 746 }
19d470aa 747
0f459286 748 /**
749 * @param string $value
750 * @return array
751 */
19d470aa 752 function parseProperties($value) {
753 $propArray = explode(';', $value);
754 $propResultArray = array();
755 foreach ($propArray as $prop) {
756 $prop = trim($prop);
757 $pos = strpos($prop, '=');
758 if ($pos > 0) {
759 $key = trim(substr($prop, 0, $pos));
760 $val = trim(substr($prop, $pos+1));
bbb92b4c 761 if (strlen($val) > 0 && $val{0} == '"') {
19d470aa 762 $val = substr($val, 1, -1);
763 }
764 $propResultArray[$key] = $val;
765 }
766 }
2ddf00ae 767 return $this->processParameters($propResultArray);
19d470aa 768 }
769
0f459286 770 /**
771 * Fills disposition object in rfc822Header object
772 * @param string $value
773 */
19d470aa 774 function parseDisposition($value) {
775 $pos = strpos($value, ';');
776 $props = '';
777 if ($pos > 0) {
778 $name = trim(substr($value, 0, $pos));
fc9269ec 779 $props = trim(substr($value, $pos+1));
19d470aa 780 } else {
781 $name = $value;
782 }
783 $props_a = $this->parseProperties($props);
784 $disp = new Disposition($name);
785 $disp->properties = $props_a;
786 $this->disposition = $disp;
787 }
788
0f459286 789 /**
790 * Fills mlist array keys in rfc822Header object
791 * @param string $field
792 * @param string $value
793 */
19d470aa 794 function mlist($field, $value) {
795 $res_a = array();
796 $value_a = explode(',', $value);
797 foreach ($value_a as $val) {
798 $val = trim($val);
799 if ($val{0} == '<') {
800 $val = substr($val, 1, -1);
801 }
802 if (substr($val, 0, 7) == 'mailto:') {
803 $res_a['mailto'] = substr($val, 7);
804 } else {
805 $res_a['href'] = $val;
806 }
807 }
808 $this->mlist[$field] = $res_a;
809 }
810
0f459286 811 /**
1a64a084 812 * Parses the X-Spam-Status header
813 * @param string $value
814 */
815 function parseSpamStatus($value) {
816 // Header value looks like this:
817 // 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
818
819 $spam_status = array();
820
821 if (preg_match ('/^(No|Yes),\s+score=(-?\d+\.\d+)\s+required=(-?\d+\.\d+)\s+tests=(.*?)\s+autolearn=(.*?)\s+version=(.+?)$/', $value, $matches)) {
822 // full header
823 $spam_status['bad_format'] = 0;
824 $spam_status['value'] = $matches[0];
825 // is_spam
826 if (isset($matches[1])
827 && strtolower($matches[1]) == 'yes') {
828 $spam_status['is_spam'] = true;
829 } else {
830 $spam_status['is_spam'] = false;
831 }
832
833 // score
834 $spam_status['score'] = $matches[2];
835
836 // required
837 $spam_status['required'] = $matches[3];
838
839 // tests
840 $tests = array();
841 $tests = explode(',', $matches[4]);
842 foreach ($tests as $test) {
843 $spam_status['tests'][] = trim($test);
844 }
845
846 // autolearn
847 $spam_status['autolearn'] = $matches[5];
848
849 // version
850 $spam_status['version'] = $matches[6];
851 } else {
852 $spam_status['bad_format'] = 1;
853 $spam_status['value'] = $value;
854 }
855 return $spam_status;
856 }
857
858 /**
0f459286 859 * function to get the address strings out of the header.
19d470aa 860 * example1: header->getAddr_s('to').
861 * example2: header->getAddr_s(array('to', 'cc', 'bcc'))
0f459286 862 * @param mixed $arr string or array of strings
863 * @param string $separator
864 * @param boolean $encoded (since 1.4.0) return encoded or plain text addresses
a9b9e5d3 865 * @param boolean $unconditionally_quote (since 1.4.21/1.5.2) When TRUE, always
866 * quote the personal part,
867 * whether or not it is
868 * encoded, otherwise quoting
869 * is only added if the
870 * personal part is not encoded
0f459286 871 * @return string
19d470aa 872 */
a9b9e5d3 873 function getAddr_s($arr, $separator = ', ', $encoded=false, $unconditionally_quote=FALSE) {
19d470aa 874 $s = '';
875
876 if (is_array($arr)) {
877 foreach($arr as $arg) {
a9b9e5d3 878 if ($this->getAddr_s($arg, $separator, $encoded, $unconditionally_quote)) {
8d8da447 879 $s .= $separator;
19d470aa 880 }
881 }
882 $s = ($s ? substr($s, 2) : $s);
883 } else {
2c9ecd11 884 $addr = $this->{$arr};
19d470aa 885 if (is_array($addr)) {
886 foreach ($addr as $addr_o) {
887 if (is_object($addr_o)) {
2c9ecd11 888 if ($encoded) {
a9b9e5d3 889 $s .= $addr_o->getEncodedAddress($unconditionally_quote) . $separator;
2c9ecd11 890 } else {
a9b9e5d3 891 $s .= $addr_o->getAddress(TRUE, FALSE, $unconditionally_quote) . $separator;
2c9ecd11 892 }
19d470aa 893 }
894 }
895 $s = substr($s, 0, -strlen($separator));
896 } else {
897 if (is_object($addr)) {
2c9ecd11 898 if ($encoded) {
a9b9e5d3 899 $s .= $addr->getEncodedAddress($unconditionally_quote);
2c9ecd11 900 } else {
a9b9e5d3 901 $s .= $addr->getAddress(TRUE, FALSE, $unconditionally_quote);
2c9ecd11 902 }
19d470aa 903 }
904 }
905 }
906 return $s;
907 }
908
0f459286 909 /**
910 * function to get the array of addresses out of the header.
911 * @param mixed $arg string or array of strings
912 * @param array $excl_arr array of excluded email addresses
913 * @param array $arr array of added email addresses
914 * @return array
915 */
19d470aa 916 function getAddr_a($arg, $excl_arr = array(), $arr = array()) {
917 if (is_array($arg)) {
918 foreach($arg as $argument) {
919 $arr = $this->getAddr_a($argument, $excl_arr, $arr);
920 }
921 } else {
340d67c2 922 $addr = $this->{$arg};
19d470aa 923 if (is_array($addr)) {
924 foreach ($addr as $next_addr) {
925 if (is_object($next_addr)) {
926 if (isset($next_addr->host) && ($next_addr->host != '')) {
927 $email = $next_addr->mailbox . '@' . $next_addr->host;
928 } else {
929 $email = $next_addr->mailbox;
930 }
931 $email = strtolower($email);
932 if ($email && !isset($arr[$email]) && !isset($excl_arr[$email])) {
933 $arr[$email] = $next_addr->personal;
934 }
935 }
936 }
937 } else {
938 if (is_object($addr)) {
939 $email = $addr->mailbox;
940 $email .= (isset($addr->host) ? '@' . $addr->host : '');
941 $email = strtolower($email);
942 if ($email && !isset($arr[$email]) && !isset($excl_arr[$email])) {
943 $arr[$email] = $addr->personal;
944 }
945 }
946 }
947 }
948 return $arr;
949 }
cfebb724 950
0f459286 951 /**
8d2d85f5 952//FIXME: This needs some documentation (inside the function too)! Don't code w/out comments!
b546a42a 953 * Looking at the code years after it was written,
954 * this is my (Paul) best guess as to what this
955 * function does (note that docs previously claimed
956 * that this function returns boolean or an array,
957 * but it no longer appears to return an array - an
958 * integer instead):
959 *
960 * Inspects the TO and CC headers of the message
961 * represented by this object, looking for the
962 * address(es) given by $address
963 *
964 * If $address is a string:
965 * Serves as a test (returns boolean) as to
966 * whether or not the given address is found
967 * anywhere in the TO or CC headers
968 *
969 * If $address is an array:
970 * Looks through this list of addresses and
971 * returns the array index (an integer even
972 * if the array is given with keys of a
973 * different type) of the *last* matching
974 * $address found in this message's
975 * TO or CC headers, unless there is an exact
976 * match (meaning that the "personal
977 * information" in addition to the email
978 * address also matches), in which case that
979 * index (the first one found) is returned
980 *
981 * @param mixed $address Address(es) to search for in this
982 * message's TO and CC headers - please
983 * see above how the format of this
984 * argument affects the return value
985 * of this function
986 * @param boolean $recurs FOR INTERNAL USE ONLY
987 *
988 * @return mixed Boolean when $address is a scalar,
989 * indicating whether or not the address
990 * was found in the TO or CC headers.
991 * An integer when $address is an array,
992 * containing the index of the value in
993 * that array that was found in the TO
994 * or CC headers, or boolean FALSE if
995 * there were no matches at all
996 *
0f459286 997 * @since 1.3.2
998 */
d0719411 999 function findAddress($address, $recurs = false) {
340d67c2 1000 $result = false;
d0719411 1001 if (is_array($address)) {
340d67c2 1002 $i=0;
d0719411 1003 foreach($address as $argument) {
1004 $match = $this->findAddress($argument, true);
340d67c2 1005 if ($match[1]) {
1006 return $i;
1007 } else {
1008 if (count($match[0]) && !$result) {
1009 $result = $i;
1010 }
1011 }
cfebb724 1012 ++$i;
340d67c2 1013 }
1014 } else {
1015 if (!is_array($this->cc)) $this->cc = array();
7c8a0b77 1016 if (!is_array($this->to)) $this->to = array();
340d67c2 1017 $srch_addr = $this->parseAddress($address);
1018 $results = array();
1019 foreach ($this->to as $to) {
8d2d85f5 1020 if (strtolower($to->host) == strtolower($srch_addr->host)) {
1021 if (strtolower($to->mailbox) == strtolower($srch_addr->mailbox)) {
340d67c2 1022 $results[] = $srch_addr;
8d2d85f5 1023 if (strtolower($to->personal) == strtolower($srch_addr->personal)) {
340d67c2 1024 if ($recurs) {
1025 return array($results, true);
1026 } else {
1027 return true;
1028 }
1029 }
1030 }
1031 }
d0719411 1032 }
0f459286 1033 foreach ($this->cc as $cc) {
8d2d85f5 1034 if (strtolower($cc->host) == strtolower($srch_addr->host)) {
1035 if (strtolower($cc->mailbox) == strtolower($srch_addr->mailbox)) {
340d67c2 1036 $results[] = $srch_addr;
8d2d85f5 1037 if (strtolower($cc->personal) == strtolower($srch_addr->personal)) {
340d67c2 1038 if ($recurs) {
1039 return array($results, true);
1040 } else {
1041 return true;
1042 }
1043 }
1044 }
1045 }
1046 }
1047 if ($recurs) {
1048 return array($results, false);
fd9881f0 1049 } elseif (count($results)) {
340d67c2 1050 return true;
1051 } else {
1052 return false;
cfebb724 1053 }
340d67c2 1054 }
1465f80c 1055 //exit;
340d67c2 1056 return $result;
d0719411 1057 }
19d470aa 1058
0f459286 1059 /**
1060 * @param string $type0 media type
1061 * @param string $type1 media subtype
1062 * @return array media properties
1063 * @todo check use of media type arguments
1064 */
19d470aa 1065 function getContentType($type0, $type1) {
1066 $type0 = $this->content_type->type0;
1067 $type1 = $this->content_type->type1;
1068 return $this->content_type->properties;
1069 }
1070}