Fix rendering of multipart/alternative when it is a subpart
[banana.git] / banana / mimepart.inc.php
1 <?php
2 /********************************************************************************
3 * banana/mimepart.inc.php : class for MIME parts
4 * ------------------------
5 *
6 * This file is part of the banana distribution
7 * Copyright: See COPYING files that comes with this distribution
8 ********************************************************************************/
9
10 class BananaMimePart
11 {
12 public $headers = null; /* Should be protected */
13
14 private $id = null;
15 private $content_type = null;
16 private $charset = null;
17 private $encoding = null;
18 private $disposition = null;
19 private $boundary = null;
20 private $filename = null;
21 private $format = null;
22 private $signature = array();
23
24 private $body = null;
25 private $multipart = null;
26
27 protected function __construct($data = null)
28 {
29 if ($data instanceof BananaMimePart) {
30 foreach ($this as $key=>$value) {
31 $this->$key = $data->$key;
32 }
33 } elseif (!is_null($data)) {
34 $this->fromRaw($data);
35 }
36 }
37
38 protected function makeTextPart($body, $content_type, $encoding, $charset = null, $format = 'fixed')
39 {
40 $this->body = $body;
41 $this->charset = $charset;
42 $this->encoding = $encoding;
43 $this->content_type = $content_type;
44 $this->format = strtolower($format);
45 $this->parse();
46 }
47
48 protected function makeDataPart($body, $content_type, $encoding, $filename, $disposition, $id = null)
49 {
50 $this->body = $body;
51 $this->content_type = $content_type;
52 $this->encoding = $encoding;
53 $this->filename = $filename;
54 $this->disposition = $disposition;
55 $this->id = $id;
56 if (is_null($content_type) || $content_type == 'application/octet-stream') {
57 $this->decodeContent();
58 $this->content_type = BananaMimePart::getMimeType($this->body, false);
59 }
60 }
61
62 protected function makeFilePart(array $file, $content_type = null, $disposition = 'attachment')
63 {
64 $body = file_get_contents($file['tmp_name']);
65 if ($body === false || strlen($body) != $file['size']) {
66 return false;
67 }
68 if (is_null($content_type) || $content_type == 'application/octet-stream') {
69 $content_type = BananaMimePart::getMimeType($file['tmp_name']);
70 }
71 if (substr($content_type, 0, 5) == 'text/') {
72 $encoding = '8bit';
73 } else {
74 $encoding = 'base64';
75 $body = chunk_split(base64_encode($body));
76 }
77 $this->filename = $file['name'];
78 $this->content_type = $content_type;
79 $this->disposition = $disposition;
80 $this->body = $body;
81 $this->encoding = $encoding;
82 return true;
83 }
84
85 protected function makeMultiPart($body, $content_type, $encoding, $boundary, $sign_protocole)
86 {
87 $this->body = $body;
88 $this->content_type = $content_type;
89 $this->encoding = $encoding;
90 $this->boundary = $boundary;
91 $this->signature['protocole'] = $sign_protocole;
92 $this->parse();
93 }
94
95 protected function convertToMultiPart()
96 {
97 if (!$this->isType('multipart', 'mixed')) {
98 $newpart = new BananaMimePart($this);
99 $this->content_type = 'multipart/mixed';
100 $this->encoding = '8bit';
101 $this->multipart = array($newpart);
102 $this->headers = null;
103 $this->charset = null;
104 $this->disposition = null;
105 $this->filename = null;
106 $this->boundary = null;
107 $this->body = null;
108 $this->format = null;
109 $this->id = null;
110 }
111 }
112
113 public function addAttachment(array $file, $content_type = null, $disposition = 'attachment')
114 {
115 if (!is_uploaded_file($file['tmp_name'])) {
116 return false;
117 }
118 $newpart = new BananaMimePart;
119 if ($newpart->makeFilePart($file, $content_type, $disposition)) {
120 $this->convertToMultiPart();
121 $this->multipart[] = $newpart;
122 return true;
123 }
124 return false;
125 }
126
127 protected function getHeader($title, $filter = null)
128 {
129 if (!isset($this->headers[$title])) {
130 return null;
131 }
132 $header =& $this->headers[$title];
133 if (is_null($filter)) {
134 return trim($header);
135 } elseif (preg_match($filter, $header, $matches)) {
136 return trim($matches[1]);
137 }
138 return null;
139 }
140
141 protected function fromRaw($data)
142 {
143 if (is_array($data)) {
144 if (array_key_exists('From', $data)) {
145 $this->headers = array_map(array($this, 'decodeHeader'), array_change_key_case($data));
146 return;
147 } else {
148 $lines = $data;
149 }
150 } else {
151 $lines = explode("\n", $data);
152 }
153 $headers = BananaMimePart::parseHeaders($lines);
154 $this->headers =& $headers;
155 if (empty($headers) || empty($lines)) {
156 return;
157 }
158 $content = join("\n", $lines);
159 $test = trim($content);
160 if (empty($test)) {
161 return;
162 }
163
164 $content_type = strtolower($this->getHeader('content-type', '/^\s*([^ ;]+?)(;|$)/'));
165 if (empty($content_type)) {
166 $encoding = '8bit';
167 $charset = 'CP1252';
168 $content_type = 'text/plain';
169 $format = strtolower($this->getHeader('x-rfc2646', '/format="?([^ w@"]+?)"?\s*(;|$)/i'));
170 } else {
171 $encoding = strtolower($this->getHeader('content-transfer-encoding'));
172 $disposition = $this->getHeader('content-disposition', '/(inline|attachment)/i');
173 $boundary = $this->getHeader('content-type', '/boundary="?([^ "]+?)"?\s*(;|$)/i');
174 $charset = strtolower($this->getHeader('content-type', '/charset="?([^ "]+?)"?\s*(;|$)/i'));
175 $filename = $this->getHeader('content-disposition', '/filename="?([^ "]+?)"?\s*(;|$)/i');
176 $format = strtolower($this->getHeader('content-type', '/format="?([^ "]+?)"?\s*(;|$)/i'));
177 $id = $this->getHeader('content-id', '/<(.*?)>/');
178 $sign_protocole = strtolower($this->getHeader('content-type', '/protocol="?([^ "]+?)"?\s*(;|$)/i'));
179 if (empty($filename)) {
180 $filename = $this->getHeader('content-type', '/name="?([^"]+)"?/');
181 }
182 }
183 list($type, $subtype) = explode('/', $content_type);
184 switch ($type) {
185 case 'text': case 'message':
186 $this->makeTextPart($content, $content_type, $encoding, $charset, $format);
187 break;
188 case 'multipart':
189 $this->makeMultiPart($content, $content_type, $encoding, $boundary, $sign_protocole);
190 break;
191 default:
192 $this->makeDataPart($content, $content_type, $encoding, $filename, $disposition, $id);
193 }
194 }
195
196 private function parse()
197 {
198 if ($this->isType('multipart')) {
199 $this->splitMultipart();
200 } else {
201 $parts = $this->findUUEncoded();
202 if (count($parts)) {
203 $this->convertToMultiPart();
204 $this->multipart = array_merge(array($textpart), $parts);
205 }
206 }
207 }
208
209 private function splitMultipart()
210 {
211 $this->decodeContent();
212 if (is_null($this->multipart)) {
213 $this->multipart = array();
214 }
215 $boundary =& $this->boundary;
216 $parts = preg_split("/(^|\n)--" . preg_quote($boundary, '/') . "(--|\n)/", $this->body, -1, PREG_SPLIT_NO_EMPTY);
217 $signed = $this->isType('multipart', 'signed');
218 $signature = null;
219 $signed_message = null;
220 foreach ($parts as &$part) {
221 $newpart = new BananaMimePart($part);
222 if (!is_null($newpart->content_type)) {
223 if ($signed && $newpart->content_type == $this->signature['protocole']) {
224 $signature = $newpart->body;
225 } elseif ($signed) {
226 $signed_message = $part;
227 }
228 $this->multipart[] = $newpart;
229 }
230 }
231 if ($signed) {
232 $this->checkPGPSignature($signature, $signed_message);
233 }
234 $this->body = null;
235 }
236
237 public static function getMimeType($data, $is_filename = true)
238 {
239 if ($is_filename) {
240 $type = mime_content_type($data);
241 } else {
242 $arg = escapeshellarg($data);
243 $type = preg_replace('/;.*/', '', trim(shell_exec("echo $arg | file -bi -")));
244 }
245 return empty($type) ? 'application/octet-stream' : $type;
246 }
247
248 private function findUUEncoded()
249 {
250 $this->decodeContent();
251 $parts = array();
252 if (preg_match_all("/\n(begin \d+ ([^\r\n]+)\r?(?:\n(?!end)[^\n]*)*\nend)/",
253 $this->body, $matches, PREG_SET_ORDER)) {
254 foreach ($matches as &$match) {
255 $data = convert_uudecode($match[1]);
256 $mime = BananaMimePart::getMimeType($data, false);
257 if ($mime != 'application/x-empty') {
258 $this->body = trim(str_replace($match[0], '', $this->body));
259 $newpart = new BananaMimePart;
260 $newpart->makeDataPart($data, $mime, '8bit', $match[2], 'attachment');
261 $parts[] = $newpart;
262 }
263 }
264 }
265 return $parts;
266 }
267
268 static private function _decodeHeader($charset, $c, $str)
269 {
270 $s = ($c == 'Q' || $c == 'q') ? quoted_printable_decode($str) : base64_decode($str);
271 $s = @iconv($charset, 'UTF-8', $s);
272 return str_replace('_', ' ', $s);
273 }
274
275 static public function decodeHeader(&$val, $key)
276 {
277 if (preg_match('/[\x80-\xff]/', $val)) {
278 if (!is_utf8($val)) {
279 $val = utf8_encode($val);
280 }
281 } elseif (strpos($val, '=') !== false) {
282 $val = preg_replace('/(=\?.*?\?[bq]\?.*?\?=) (=\?.*?\?[bq]\?.*?\?=)/i', '\1\2', $val);
283 $val = preg_replace('/=\?(.*?)\?([bq])\?(.*?)\?=/ie', 'BananaMimePart::_decodeHeader("\1", "\2", "\3")', $val);
284 }
285 }
286
287 static public function &parseHeaders(array &$lines)
288 {
289 $headers = array();
290 while ($lines) {
291 $line = array_shift($lines);
292 if (isset($hdr) && $line && ctype_space($line{0})) {
293 $headers[$hdr] .= ' ' . trim($line);
294 } elseif (!empty($line)) {
295 if (strpos($line, ':') !== false) {
296 list($hdr, $val) = explode(":", $line, 2);
297 $hdr = strtolower($hdr);
298 if (in_array($hdr, Banana::$msgparse_headers)) {
299 $headers[$hdr] = ltrim($val);
300 } else {
301 unset($hdr);
302 }
303 }
304 } else {
305 break;
306 }
307 }
308 array_walk($headers, array('BananaMimePart', 'decodeHeader'));
309 return $headers;
310 }
311
312 static public function encodeHeader($value, $trim = 0)
313 {
314 if ($trim) {
315 if (strlen($value) > $trim) {
316 $value = substr($value, 0, $trim);
317 }
318 }
319 $value = preg_replace('/([\x80-\xff]+)/e', '"=?UTF-8?B?" . base64_encode("\1") . "?="', $value);
320 return $value;
321 }
322
323 private function decodeContent()
324 {
325 $encodings = Array('quoted-printable' => 'quoted_printable_decode',
326 'base64' => 'base64_decode',
327 'x-uuencode' => 'convert_uudecode');
328 foreach ($encodings as $encoding => $callback) {
329 if ($this->encoding == $encoding) {
330 $this->body = $callback($this->body);
331 $this->encoding = '8bit';
332 break;
333 }
334 }
335 if (!$this->isType('text')) {
336 return;
337 }
338
339 if (!is_null($this->charset)) {
340 $body = iconv($this->charset, 'UTF-8//IGNORE', $this->body);
341 if (empty($body)) {
342 return;
343 }
344 $this->body = $body;
345 } else {
346 $this->body = utf8_encode($this->body);
347 }
348 $this->charset = 'utf-8';
349 }
350
351 public function send($force_inline = false)
352 {
353 $this->decodeContent();
354 if ($force_inline) {
355 $dispostion = $this->disposition;
356 $this->disposition = 'inline';
357 }
358 $headers = $this->getHeaders();
359 foreach ($headers as $key => $value) {
360 header("$key: $value");
361 }
362 if ($force_inline) {
363 $this->disposition = $disposition;
364 }
365 echo $this->body;
366 exit;
367 }
368
369 private function setBoundary()
370 {
371 if ($this->isType('multipart') && is_null($this->boundary)) {
372 $this->boundary = '--banana-bound-' . time() . rand(0, 255) . '-';
373 }
374 }
375
376 public function getHeaders()
377 {
378 $headers = array();
379 $this->setBoundary();
380 $headers['Content-Type'] = $this->content_type . ";"
381 . ($this->filename ? " name=\"{$this->filename}\";" : '')
382 . ($this->charset ? " charset=\"{$this->charset}\";" : '')
383 . ($this->boundary ? " boundary=\"{$this->boundary}\";" : "")
384 . ($this->format ? " format={$this->format}" : "");
385 if ($this->encoding) {
386 $headers['Content-Transfer-Encoding'] = $this->encoding;
387 }
388 if ($this->disposition) {
389 $headers['Content-Disposition'] = $this->disposition
390 . ($this->filename ? "; filename=\"{$this->filename}\"" : '');
391 }
392 return array_map(array($this, 'encodeHeader'), $headers);
393 }
394
395 public function hasBody()
396 {
397 if (is_null($this->content) && !$this->isType('multipart')) {
398 return false;
399 }
400 return true;
401 }
402
403 public function get($with_headers = false)
404 {
405 $content = "";
406 if ($with_headers) {
407 foreach ($this->getHeaders() as $key => $value) {
408 $line = "$key: $value";
409 $line = explode("\n", wordwrap($line, Banana::$msgshow_wrap));
410 for ($i = 1 ; $i < count($line) ; $i++) {
411 $line[$i] = "\t" . $line[$i];
412 }
413 $content .= implode("\n", $line) . "\n";
414 }
415 $content .= "\n";
416 }
417 if ($this->isType('multipart')) {
418 $this->setBoundary();
419 foreach ($this->multipart as &$part) {
420 $content .= "\n--{$this->boundary}\n" . $part->get(true);
421 }
422 $content .= "\n--{$this->boundary}--";
423 } elseif ($this->isType('text', 'plain')) {
424 $content .= banana_flow($this->body);
425 } else {
426 $content .= banana_wordwrap($this->body);
427 }
428 return $content;
429 }
430
431 public function getText()
432 {
433 $signed =& $this->getSignedPart();
434 if ($signed !== $this) {
435 return $signed->getText();
436 }
437 $this->decodeContent();
438 return $this->body;
439 }
440
441 public function toHtml()
442 {
443 $signed =& $this->getSignedPart();
444 if ($signed !== $this) {
445 return $signed->toHtml();
446 }
447 @list($type, $subtype) = $this->getType();
448 if ($type == 'image') {
449 $part = $this->id ? $this->id : $this->filename;
450 return '<img class="multipart" src="'
451 . banana_htmlentities(Banana::$page->makeUrl(array('group' => Banana::$group,
452 'artid' => Banana::$artid,
453 'part' => $part)))
454 . '" alt="' . banana_htmlentities($this->filename) . '" />';
455 } else if ($type == 'multipart' && $subtype == 'alternative') {
456 $types =& Banana::$msgshow_mimeparts;
457 foreach ($types as $type) {
458 @list($type, $subtype) = explode('/', $type);
459 $part = $this->getParts($type, $subtype);
460 if (count($part) > 0) {
461 return $part[0]->toHtml();
462 }
463 }
464 } elseif ((!in_array($type, Banana::$msgshow_mimeparts)
465 && !in_array($this->content_type, Banana::$msgshow_mimeparts))
466 || $this->disposition == 'attachment') {
467 $part = $this->id ? $this->id : $this->filename;
468 if (!$part) {
469 $part = $this->content_type;
470 }
471 return '[' . Banana::$page->makeImgLink(array('group' => Banana::$group,
472 'artid' => Banana::$artid,
473 'part' => $part,
474 'text' => $this->filename ? $this->filename : $this->content_type,
475 'img' => 'save')) . ']';
476 } elseif ($type == 'multipart' && ($subtype == 'mixed' || $subtype == 'report')) {
477 $text = '';
478 foreach ($this->multipart as &$part) {
479 $text .= $part->toHtml();
480 }
481 return $text;
482 } else {
483 switch ($subtype) {
484 case 'html': return banana_formatHtml($this);
485 case 'enriched': case 'richtext': return banana_formatRichText($this);
486 default:
487 if ($type == 'message') { // we have a raw source of data (no specific pre-formatting)
488 return '<hr />' . utf8_encode(banana_formatPlainText($this));
489 }
490 return banana_formatPlainText($this);
491 }
492 }
493 return null;
494 }
495
496 public function quote()
497 {
498 $signed =& $this->getSignedPart();
499 if ($signed !== $this) {
500 return $signed->quote();
501 }
502 list($type, $subtype) = $this->getType();
503 if (in_array($type, Banana::$msgedit_mimeparts) || in_array($this->content_type, Banana::$msgedit_mimeparts)) {
504 if ($type == 'multipart' && ($subtype == 'mixed' || $subtype == 'report')) {
505 $text = '';
506 foreach ($this->multipart as &$part) {
507 $qt = $part->quote();
508 $qt = rtrim($qt);
509 if (!empty($text)) {
510 $text .= "\n" . banana_quote("", 1) . "\n";
511 }
512 $text .= $qt;
513 }
514 return $text;
515 }
516 switch ($subtype) {
517 case 'html': return banana_quoteHtml($this);
518 case 'enriched': case 'richtext': return banana_quoteRichText($this);
519 default: return banana_quotePlainText($this);
520 }
521 }
522 }
523
524 protected function getType()
525 {
526 return explode('/', $this->content_type);
527 }
528
529 protected function isType($type, $subtype = null)
530 {
531 list($mytype, $mysub) = $this->getType();
532 return ($mytype == $type) && (is_null($subtype) || $mysub == $subtype);
533 }
534
535 public function isFlowed()
536 {
537 return $this->format == 'flowed';
538 }
539
540 public function getFilename()
541 {
542 return $this->filename;
543 }
544
545 protected function getParts($type, $subtype = null)
546 {
547 $parts = array();
548 if ($this->isType($type, $subtype)) {
549 return array($this);
550 } elseif ($this->isType('multipart')) {
551 foreach ($this->multipart as &$part) {
552 $parts = array_merge($parts, $part->getParts($type, $subtype));
553 }
554 }
555 return $parts;
556 }
557
558 public function getFile($filename)
559 {
560 if ($this->filename == $filename) {
561 return $this;
562 } elseif ($this->isType('multipart')) {
563 foreach ($this->multipart as &$part) {
564 $file = $part->getFile($filename);
565 if (!is_null($file)) {
566 return $file;
567 }
568 }
569 }
570 return null;
571 }
572
573 public function getAttachments()
574 {
575 if (!is_null($this->filename)) {
576 return array($this);
577 } elseif ($this->isType('multipart')) {
578 $parts = array();
579 foreach ($this->multipart as &$part) {
580 $parts = array_merge($parts, $part->getAttachments());
581 }
582 return $parts;
583 }
584 return array();
585 }
586
587 public function getAlternatives()
588 {
589 $types =& Banana::$msgshow_mimeparts;
590 $names =& Banana::$mimeparts;
591 $source = null;
592 if (in_array('source', $types)) {
593 $source = @$names['source'] ? $names['source'] : 'source';
594 }
595 if ($this->isType('multipart', 'signed')) {
596 $parts = array($this->getSignedPart());
597 } else if (!$this->isType('multipart', 'alternative') && !$this->isType('multipart', 'related')) {
598 if ($source) {
599 $parts = array($this);
600 } else {
601 return array();
602 }
603 } else {
604 $parts =& $this->multipart;
605 }
606 $alt = array();
607 foreach ($parts as &$part) {
608 list($type, $subtype) = $part->getType();
609 $ct = $type . '/' . $subtype;
610 if (in_array($ct, $types) || in_array($type, $types)) {
611 if (isset($names[$ct])) {
612 $alt[$ct] = $names[$ct];
613 } elseif (isset($names[$type])) {
614 $alt[$ct] = $names[$type];
615 } else {
616 $alt[$ct] = $ct;
617 }
618 }
619 }
620 if ($source) {
621 $alt['source'] = $source;
622 }
623 return $alt;
624 }
625
626 public function getPartById($id)
627 {
628 if ($this->id == $id) {
629 return $this;
630 } elseif ($this->isType('multipart')) {
631 foreach ($this->multipart as &$part) {
632 $res = $part->getPartById($id);
633 if (!is_null($res)) {
634 return $res;
635 }
636 }
637 }
638 return null;
639 }
640
641 protected function &getSignedPart()
642 {
643 if ($this->isType('multipart', 'signed')) {
644 foreach ($this->multipart as &$part) {
645 if ($part->content_type != $this->signature['protocole']) {
646 return $part;
647 }
648 }
649 }
650 return $this;
651 }
652
653 private function checkPGPSignature($signature, $message = null)
654 {
655 if (!Banana::$msgshow_pgpcheck) {
656 return true;
657 }
658 $signname = tempnam(Banana::$spool_root, 'banana_pgp_');
659 $gpg = 'LC_ALL="en_US" ' . Banana::$msgshow_pgppath . ' ' . Banana::$msgshow_pgpoptions . ' --verify '
660 . $signname . '.asc ';
661 file_put_contents($signname. '.asc', $signature);
662 $gpg_check = array();
663 if (!is_null($message)) {
664 file_put_contents($signname, str_replace(array("\r\n", "\n"), array("\n", "\r\n"), $message));
665 exec($gpg . $signname . ' 2>&1', $gpg_check, $result);
666 unlink($signname);
667 } else {
668 exec($gpg . '2&>1', $gpg_check, $result);
669 }
670 unlink("$signname.asc");
671 if (preg_match('/Signature made (.+) using (.+) key ID (.+)/', array_shift($gpg_check), $matches)) {
672 $this->signature['date'] = strtotime($matches[1]);
673 $this->signature['key'] = array('format' => $matches[2],
674 'id' => $matches[3]);
675 } else {
676 return false;
677 }
678 $signature = array_shift($gpg_check);
679 if (preg_match('/Good signature from "(.+)"/', $signature, $matches)) {
680 $this->signature['verify'] = true;
681 $this->signature['identity'] = array($matches[1]);
682 $this->signature['certified'] = true;
683 } elseif (preg_match('/BAD signature from "(.+)"/', $signature, $matches)) {
684 $this->signature['verify'] = false;
685 $this->signature['identity'] = array($matches[1]);
686 $this->signature['certified'] = false;
687 } else {
688 return false;
689 }
690 foreach ($gpg_check as $aka) {
691 if (preg_match('/aka "(.+)"/', $aka, $matches)) {
692 $this->signature['identity'][] = $matches[1];
693 }
694 if (preg_match('/This key is not certified with a trusted signature!/', $aka)) {
695 $this->signature['certified'] = false;
696 $this->signature['certification_error'] = _b_("identité non confirmée");
697 }
698 }
699 return true;
700 }
701
702 public function getSignature()
703 {
704 return $this->signature;
705 }
706 }
707
708 // vim:set et sw=4 sts=4 ts=4 enc=utf-8:
709 ?>