set default download link to absolute_dl = true to force download instead of
[squirrelmail.git] / functions / mime.php
CommitLineData
59177427 1<?php
2ba13803 2
35586184 3/**
4 * mime.php
5 *
15e6162e 6 * Copyright (c) 1999-2002 The SquirrelMail Project Team
35586184 7 * Licensed under the GNU GPL. For full terms see the file COPYING.
8 *
9 * This contains the functions necessary to detect and decode MIME
10 * messages.
11 *
12 * $Id$
13 */
b74ba498 14
b68edc75 15require_once(SM_PATH . 'functions/imap.php');
16require_once(SM_PATH . 'functions/attachment_common.php');
8beafbbc 17
451f74a2 18/* --------------------------------------------------------------------------------- */
19/* MIME DECODING */
20/* --------------------------------------------------------------------------------- */
b74ba498 21
451f74a2 22/* This function gets the structure of a message and stores it in the "message" class.
23 * It will return this object for use with all relevant header information and
24 * fully parsed into the standard "message" object format.
25 */
77b88425 26
a4a70693 27function mime_structure ($bodystructure, $flags=array()) {
c9d78ab4 28
3d8371be 29 /* Isolate the body structure and remove beginning and end parenthesis. */
a4a70693 30 $read = trim(substr ($bodystructure, strpos(strtolower($bodystructure), 'bodystructure') + 13));
451f74a2 31 $read = trim(substr ($read, 0, -1));
3d8371be 32 $msg =& new Message();
33 $res = $msg->parseStructure($read);
34 $msg = $res[0];
9de42168 35 if (!is_object($msg)) {
bd9c880b 36 include_once(SM_PATH . 'functions/display_messages.php');
3d8371be 37 global $color, $mailbox;
9de42168 38 displayPageHeader( $color, urldecode($mailbox) );
39 echo "<BODY TEXT=\"$color[8]\" BGCOLOR=\"$color[4]\" LINK=\"$color[7]\" VLINK=\"$color[7]\" ALINK=\"$color[7]\">\n\n" .
40 '<CENTER>';
5e8de8b6 41 $errormessage = _("SquirrelMail could not decode the bodystructure of the message");
3d8371be 42 $errormessage .= '<BR>'._("the provided bodystructure by your imap-server").':<BR><BR>';
43 $errormessage .= '<table><tr><td>' . htmlspecialchars($read) . '</td></tr></table>';
9de42168 44 plain_error_message( $errormessage, $color );
3d8371be 45 echo '</body></html>';
9de42168 46 exit;
47 }
a4a70693 48 $msg->setEnt('0');
49 if (count($flags)) {
7a9e9c89 50 foreach ($flags as $flag) {
51 $char = strtoupper($flag{1});
52 switch ($char) {
3d8371be 53 case 'S':
54 if (strtolower($flag) == '\\seen') {
55 $msg->is_seen = true;
56 }
57 break;
58 case 'A':
59 if (strtolower($flag) == '\\answered') {
60 $msg->is_answered = true;
61 }
62 break;
63 case 'D':
64 if (strtolower($flag) == '\\deleted') {
65 $msg->is_deleted = true;
66 }
67 break;
68 case 'F':
69 if (strtolower($flag) == '\\flagged') {
70 $msg->is_flagged = true;
71 }
72 break;
73 case 'M':
74 if (strtolower($flag) == '$mdnsent') {
75 $msg->is_mdnsent = true;
76 }
77 break;
78 default:
79 break;
7a9e9c89 80 }
81 }
451f74a2 82 }
7a9e9c89 83 // listEntities($msg);
3d8371be 84 return $msg;
451f74a2 85}
b74ba498 86
3d8371be 87/* This starts the parsing of a particular structure. It is called recursively,
451f74a2 88 * so it can be passed different structures. It returns an object of type
89 * $message.
90 * First, it checks to see if it is a multipart message. If it is, then it
91 * handles that as it sees is necessary. If it is just a regular entity,
92 * then it parses it and adds the necessary header information (by calling out
93 * to mime_get_elements()
94 */
451f74a2 95
93f92f03 96function mime_fetch_body($imap_stream, $id, $ent_id) {
a4a70693 97 global $uid_support;
3d8371be 98 /* Do a bit of error correction. If we couldn't find the entity id, just guess
09a4bde3 99 * that it is the first one. That is usually the case anyway.
100 */
101 if (!$ent_id) {
451f74a2 102 $ent_id = 1;
09a4bde3 103 }
6ab1bd9e 104 $cmd = "FETCH $id BODY[$ent_id]";
3d8371be 105
a4a70693 106 $data = sqimap_run_command ($imap_stream, $cmd, true, $response, $message, $uid_support);
77b88425 107 do {
3d8371be 108 $topline = trim(array_shift($data));
109 } while($topline && ($topline[0] == '*') && !preg_match('/\* [0-9]+ FETCH.*/i', $topline)) ;
a4a70693 110
451f74a2 111 $wholemessage = implode('', $data);
112 if (ereg('\\{([^\\}]*)\\}', $topline, $regs)) {
3d8371be 113 $ret = substr($wholemessage, 0, $regs[1]);
114 /* There is some information in the content info header that could be important
115 * in order to parse html messages. Let's get them here.
116 */
117 if ($ret{0} == '<') {
a4a70693 118 $data = sqimap_run_command ($imap_stream, "FETCH $id BODY[$ent_id.MIME]", true, $response, $message, $uid_support);
451f74a2 119 }
120 } else if (ereg('"([^"]*)"', $topline, $regs)) {
121 $ret = $regs[1];
122 } else {
123 global $where, $what, $mailbox, $passed_id, $startMessage;
3d8371be 124 $par = 'mailbox=' . urlencode($mailbox) . '&amp;passed_id=' . $passed_id;
451f74a2 125 if (isset($where) && isset($what)) {
3d8371be 126 $par .= '&amp;where=' . urlencode($where) . '&amp;what=' . urlencode($what);
a3daaaf3 127 } else {
3d8371be 128 $par .= '&amp;startMessage=' . $startMessage . '&amp;show_more=0';
451f74a2 129 }
e5ea9327 130 $par .= '&amp;response=' . urlencode($response) .
3d8371be 131 '&amp;message=' . urlencode($message) .
132 '&amp;topline=' . urlencode($topline);
a019eeb8 133
346817d4 134 echo '<tt><br>' .
135 '<table width="80%"><tr>' .
136 '<tr><td colspan=2>' .
0e5b61b4 137 _("Body retrieval error. The reason for this is most probably that the message is malformed.") .
346817d4 138 '</td></tr>' .
0e5b61b4 139 '<tr><td><b>' . _("Command:") . "</td><td>$cmd</td></tr>" .
140 '<tr><td><b>' . _("Response:") . "</td><td>$response</td></tr>" .
141 '<tr><td><b>' . _("Message:") . "</td><td>$message</td></tr>" .
142 '<tr><td><b>' . _("FETCH line:") . "</td><td>$topline</td></tr>" .
346817d4 143 "</table><BR></tt></font><hr>";
144
a4a70693 145 $data = sqimap_run_command ($imap_stream, "FETCH $passed_id BODY[]", true, $response, $message, $uid_support);
451f74a2 146 array_shift($data);
147 $wholemessage = implode('', $data);
a019eeb8 148
346817d4 149 $ret = $wholemessage;
a3daaaf3 150 }
3d8371be 151 return $ret;
451f74a2 152}
d4467150 153
451f74a2 154function mime_print_body_lines ($imap_stream, $id, $ent_id, $encoding) {
a4a70693 155 global $uid_support;
3d8371be 156 /* Do a bit of error correction. If we couldn't find the entity id, just guess
157 * that it is the first one. That is usually the case anyway.
158 */
451f74a2 159 if (!$ent_id) {
160 $ent_id = 1;
161 }
a4a70693 162 $sid = sqimap_session_id($uid_support);
3d8371be 163 /* Don't kill the connection if the browser is over a dialup
164 * and it would take over 30 seconds to download it.
165 * Donīt call set_time_limit in safe mode.
166 */
b7206e1d 167
3d8371be 168 if (!ini_get('safe_mode')) {
b7206e1d 169 set_time_limit(0);
170 }
1d142b8d 171 if ($uid_support) {
172 $sid_s = substr($sid,0,strpos($sid, ' '));
173 } else {
174 $sid_s = $sid;
175 }
346817d4 176
5d9c6f73 177 $body = mime_fetch_body ($imap_stream, $id, $ent_id);
178 echo decodeBody($body, $encoding);
179 return;
180/*
451f74a2 181 fputs ($imap_stream, "$sid FETCH $id BODY[$ent_id]\r\n");
182 $cnt = 0;
183 $continue = true;
1d142b8d 184 $read = fgets ($imap_stream,8192);
185
186
451f74a2 187 // This could be bad -- if the section has sqimap_session_id() . ' OK'
188 // or similar, it will kill the download.
1d142b8d 189 while (!ereg("^".$sid_s." (OK|BAD|NO)(.*)$", $read, $regs)) {
5d9c6f73 190 if (trim($read) == ')==') {
191 $read1 = $read;
192 $read = fgets ($imap_stream,4096);
193 if (ereg("^".$sid." (OK|BAD|NO)(.*)$", $read, $regs)) {
194 return;
195 } else {
196 echo decodeBody($read1, $encoding) .
197 decodeBody($read, $encoding);
198 }
199 } else if ($cnt) {
200 echo decodeBody($read, $encoding);
201 }
202 $read = fgets ($imap_stream,4096);
203 $cnt++;
1d142b8d 204// break;
451f74a2 205 }
5d9c6f73 206*/
451f74a2 207}
beb9e459 208
451f74a2 209/* -[ END MIME DECODING ]----------------------------------------------------------- */
d4467150 210
3d8371be 211/* This is here for debugging purposes. It will print out a list
212 * of all the entity IDs that are in the $message object.
213 */
451f74a2 214function listEntities ($message) {
3d8371be 215 if ($message) {
216 echo "<tt>" . $message->entity_id . ' : ' . $message->type0 . '/' . $message->type1 . ' parent = '. $message->parent->entity_id. '<br>';
217 for ($i = 0; isset($message->entities[$i]); $i++) {
218 echo "$i : ";
219 $msg = listEntities($message->entities[$i]);
220
221 if ($msg) {
222 echo "return: ";
223 return $msg;
224 }
225 }
a4a70693 226 }
451f74a2 227}
f0c4dc12 228
f792c641 229function getPriorityStr($priority) {
3d8371be 230 $priority_level = substr($priority,0,1);
231
232 switch($priority_level) {
233 /* Check for a higher then normal priority. */
234 case '1':
235 case '2':
236 $priority_string = _("High");
237 break;
238
239 /* Check for a lower then normal priority. */
240 case '4':
241 case '5':
242 $priority_string = _("Low");
243 break;
244
245 /* Check for a normal priority. */
246 case '3':
247 default:
248 $priority_level = '3';
249 $priority_string = _("Normal");
250 break;
251
252 }
253 return $priority_string;
f792c641 254}
255
451f74a2 256/* returns a $message object for a particular entity id */
257function getEntity ($message, $ent_id) {
a4a70693 258 return $message->getEntity($ent_id);
451f74a2 259}
8beafbbc 260
3d8371be 261/* translateText
da4c66e8 262 * Extracted from strings.php 23/03/2002
263 */
264
265function translateText(&$body, $wrap_at, $charset) {
3d8371be 266 global $where, $what; /* from searching */
267 global $color; /* color theme */
da4c66e8 268
b68edc75 269 require_once(SM_PATH . 'functions/url_parser.php');
da4c66e8 270
271 $body_ary = explode("\n", $body);
da4c66e8 272 for ($i=0; $i < count($body_ary); $i++) {
273 $line = $body_ary[$i];
274 if (strlen($line) - 2 >= $wrap_at) {
275 sqWordWrap($line, $wrap_at);
276 }
277 $line = charset_decode($charset, $line);
278 $line = str_replace("\t", ' ', $line);
279
280 parseUrl ($line);
281
3d8371be 282 $quotes = 0;
da4c66e8 283 $pos = 0;
3d8371be 284 $j = strlen($line);
da4c66e8 285
3d8371be 286 while ($pos < $j) {
da4c66e8 287 if ($line[$pos] == ' ') {
3d8371be 288 $pos++;
da4c66e8 289 } else if (strpos($line, '&gt;', $pos) === $pos) {
290 $pos += 4;
3d8371be 291 $quotes++;
da4c66e8 292 } else {
293 break;
294 }
295 }
3d8371be 296
297 if ($quotes > 1) {
298 if (!isset($color[14])) {
da4c66e8 299 $color[14] = '#FF0000';
300 }
301 $line = '<FONT COLOR="' . $color[14] . '">' . $line . '</FONT>';
3d8371be 302 } elseif ($quotes) {
303 if (!isset($color[13])) {
da4c66e8 304 $color[13] = '#800000';
305 }
306 $line = '<FONT COLOR="' . $color[13] . '">' . $line . '</FONT>';
307 }
3d8371be 308
da4c66e8 309 $body_ary[$i] = $line;
310 }
311 $body = '<pre>' . implode("\n", $body_ary) . '</pre>';
312}
313
c9d78ab4 314
451f74a2 315/* This returns a parsed string called $body. That string can then
3d8371be 316 * be displayed as the actual message in the HTML. It contains
317 * everything needed, including HTML Tags, Attachments at the
318 * bottom, etc.
319 */
b3af12ef 320function formatBody($imap_stream, $message, $color, $wrap_at, $ent_num, $id, $mailbox='INBOX') {
3d8371be 321 /* This if statement checks for the entity to show as the
322 * primary message. To add more of them, just put them in the
323 * order that is their priority.
324 */
008989da 325 global $startMessage, $username, $key, $imapServerAddress, $imapPort,
77bfbd2e 326 $show_html_default, $has_unsafe_images, $sort;
327
328 if ( (float)substr(PHP_VERSION,0,3) < 4.1 ) {
329 global $_GET;
330 }
331 if(isset($_GET['view_unsafe_images'])) {
332 $view_unsafe_images = $_GET['view_unsafe_images'];
333 }
d03c24f4 334
23bcec6f 335 $has_unsafe_images= 0;
cc34b00d 336 $body = '';
23bcec6f 337 $urlmailbox = urlencode($mailbox);
451f74a2 338 $body_message = getEntity($message, $ent_num);
339 if (($body_message->header->type0 == 'text') ||
340 ($body_message->header->type0 == 'rfc822')) {
3d8371be 341 $body = mime_fetch_body ($imap_stream, $id, $ent_num);
451f74a2 342 $body = decodeBody($body, $body_message->header->encoding);
343 $hookResults = do_hook("message_body", $body);
344 $body = $hookResults[1];
23bcec6f 345
3d8371be 346 /* If there are other types that shouldn't be formatted, add
347 * them here.
348 */
349
451f74a2 350 if ($body_message->header->type1 == 'html') {
3d8371be 351 if ($show_html_default <> 1) {
85015544 352 $entity_conv = array('&nbsp;' => ' ',
3d8371be 353 '<p>' => "\n",
354 '<br>' => "\n",
355 '<P>' => "\n",
356 '<BR>' => "\n",
85015544 357 '&gt;' => '>',
358 '&lt;' => '<');
85015544 359 $body = strtr($body, $entity_conv);
3d8371be 360 $body = strip_tags($body);
85015544 361 $body = trim($body);
362 translateText($body, $wrap_at,
807e884a 363 $body_message->header->getParameter('charset'));
a3daaaf3 364 } else {
3d8371be 365 $body = magicHTML($body, $id, $message, $mailbox);
a3daaaf3 366 }
451f74a2 367 } else {
3d8371be 368 translateText($body, $wrap_at,
369 $body_message->header->getParameter('charset'));
451f74a2 370 }
23bcec6f 371
7e235a1a 372 if ($has_unsafe_images) {
373 if ($view_unsafe_images) {
3d8371be 374 $untext = '">' . _("Hide Unsafe Images");
d03c24f4 375 } else {
3d8371be 376 $untext = '&amp;view_unsafe_images=1">' . _("View Unsafe Images");
d03c24f4 377 }
3d8371be 378 $body .= '<center><small><a href="read_body.php?passed_id=' . $id .
379 '&amp;passed_ent_id=' . $message->entity_id . '&amp;mailbox=' . $urlmailbox .
380 '&amp;sort=' . $sort . '&amp;startMessage=' . $startMessage . '&amp;show_more=0' .
381 $untext . '</a></small></center><br>' . "\n";
382 }
383 }
384 return $body;
451f74a2 385}
b74ba498 386
23bcec6f 387
388function formatAttachments($message, $exclude_id, $mailbox, $id) {
b583c3e8 389 global $where, $what, $startMessage, $color;
77b88425 390 static $ShownHTML = 0;
451f74a2 391
23bcec6f 392 $att_ar = $message->getAttachments($exclude_id);
451f74a2 393
23bcec6f 394 if (!count($att_ar)) return '';
2e25760a 395
8f5425ec 396 $attachments = '';
2e25760a 397
23bcec6f 398 $urlMailbox = urlencode($mailbox);
399
400 foreach ($att_ar as $att) {
767ace1f 401 $ent = urldecode($att->entity_id);
2e25760a 402 $header = $att->header;
f0c4dc12 403 $type0 = strtolower($header->type0);
404 $type1 = strtolower($header->type1);
2e25760a 405 $name = '';
3d8371be 406 $links['download link']['text'] = _("download");
407 $links['download link']['href'] =
ff9d4297 408 "../src/download.php?absolute_dl=true&amp;passed_id=$id&amp;mailbox=$urlMailbox&amp;ent_id=$ent";
2e25760a 409 $ImageURL = '';
410 if ($type0 =='message' && $type1 == 'rfc822') {
411 $default_page = '../src/read_body.php';
412 $rfc822_header = $att->rfc822_header;
413 $filename = decodeHeader($rfc822_header->subject);
f0c4dc12 414
2e25760a 415 $from_o = $rfc822_header->from;
416 if (is_object($from_o)) {
417 $from_name = $from_o->getAddress(false);
418 } else {
419 $from_name = _("Unknown sender");
f0c4dc12 420 }
2e25760a 421 $from_name = decodeHeader(htmlspecialchars($from_name));
3d8371be 422 $description = $from_name;
23bcec6f 423 } else {
2e25760a 424 $default_page = '../src/download.php';
3d8371be 425 if (is_object($header->disposition)) {
426 $filename = decodeHeader($header->disposition->getProperty('filename'));
427 if (trim($filename) == '') {
428 $name = decodeHeader($header->disposition->getProperty('name'));
429 if (trim($name) == '') {
430 if (trim( $header->id ) == '') {
431 $filename = 'untitled-[' . $ent . ']' ;
432 } else {
433 $filename = 'cid: ' . $header->id;
434 }
435 } else {
436 $filename = $name;
437 }
438 }
439 } else {
440 if (trim( $header->id ) == '') {
441 $filename = 'untitled-[' . $ent . ']' ;
442 } else {
443 $filename = 'cid: ' . $header->id;
444 }
445 }
3437d85f 446
f810c0b2 447 if ($header->description) {
448 $description = htmlspecialchars($header->description);
449 } else {
3d8371be 450 $description = '';
451 }
2e25760a 452 }
453
454 $display_filename = $filename;
3d8371be 455 if (isset($passed_ent_id)) {
456 $passed_ent_id_link = '&amp;passed_ent_id='.$passed_ent_id;
457 } else {
458 $passed_ent_id_link = '';
459 }
460 $defaultlink = $default_page . "?startMessage=$startMessage"
2e25760a 461 . "&amp;passed_id=$id&amp;mailbox=$urlMailbox"
ef0feae6 462 . '&amp;ent_id='.$ent.$passed_ent_id_link.'&amp;absolute_dl=true';
2e25760a 463 if ($where && $what) {
09f4707e 464 $defaultlink .= '&amp;where='. urlencode($where).'&amp;what='.urlencode($what);
2e25760a 465 }
3d8371be 466 /* This executes the attachment hook with a specific MIME-type.
467 * If that doesn't have results, it tries if there's a rule
468 * for a more generic type.
469 */
470 $hookresults = do_hook("attachment $type0/$type1", $links,
471 $startMessage, $id, $urlMailbox, $ent, $defaultlink,
472 $display_filename, $where, $what);
473 if(count($hookresults[1]) <= 1) {
474 $hookresults = do_hook("attachment $type0/*", $links,
475 $startMessage, $id, $urlMailbox, $ent, $defaultlink,
476 $display_filename, $where, $what);
2e25760a 477 }
451f74a2 478
3d8371be 479 $links = $hookresults[1];
480 $defaultlink = $hookresults[6];
77b88425 481
2e25760a 482 $attachments .= '<TR><TD>' .
3d8371be 483 "<A HREF=\"$defaultlink\">$display_filename</A>&nbsp;</TD>" .
23bcec6f 484 '<TD><SMALL><b>' . show_readable_size($header->size) .
77b88425 485 '</b>&nbsp;&nbsp;</small></TD>' .
486 "<TD><SMALL>[ $type0/$type1 ]&nbsp;</SMALL></TD>" .
487 '<TD><SMALL>';
f810c0b2 488 $attachments .= '<b>' . $description . '</b>';
2e25760a 489 $attachments .= '</SMALL></TD><TD><SMALL>&nbsp;';
b74ba498 490
3d8371be 491 $skipspaces = 1;
492 foreach ($links as $val) {
493 if ($skipspaces) {
494 $skipspaces = 0;
2e25760a 495 } else {
496 $attachments .= '&nbsp;&nbsp;|&nbsp;&nbsp;';
77b88425 497 }
3d8371be 498 $attachments .= '<a href="' . $val['href'] . '">' . $val['text'] . '</a>';
2e25760a 499 }
3d8371be 500 unset($links);
2e25760a 501 $attachments .= "</TD></TR>\n";
502 }
503 return $attachments;
451f74a2 504}
b74ba498 505
3d8371be 506/* This function decodes the body depending on the encoding type. */
451f74a2 507function decodeBody($body, $encoding) {
6fbd125b 508 global $languages, $squirrelmail_language;
3d8371be 509 global $show_html_default;
83be314a 510
b583c3e8 511 $body = str_replace("\r\n", "\n", $body);
512 $encoding = strtolower($encoding);
3d8371be 513
b583c3e8 514 if ($encoding == 'quoted-printable' ||
3d8371be 515 $encoding == 'quoted_printable') {
b583c3e8 516 $body = quoted_printable_decode($body);
3d8371be 517
b583c3e8 518 while (ereg("=\n", $body)) {
519 $body = ereg_replace ("=\n", '', $body);
520 }
3d8371be 521
b583c3e8 522 } else if ($encoding == 'base64') {
523 $body = base64_decode($body);
524 }
3d8371be 525
b583c3e8 526 if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
527 function_exists($languages[$squirrelmail_language]['XTRA_CODE'])) {
528 $body = $languages[$squirrelmail_language]['XTRA_CODE']('decode', $body);
529 }
3d8371be 530
b583c3e8 531 // All other encodings are returned raw.
3d8371be 532 return $body;
451f74a2 533}
534
535/*
536 * This functions decode strings that is encoded according to
537 * RFC1522 (MIME Part Two: Message Header Extensions for Non-ASCII Text).
79e07c7e 538 * Patched by Christian Schmidt <christian@ostenfeld.dk> 23/03/2002
451f74a2 539 */
540function decodeHeader ($string, $utfencode=true) {
6fbd125b 541 global $languages, $squirrelmail_language;
79e07c7e 542 if (is_array($string)) {
543 $string = implode("\n", $string);
544 }
83be314a 545
10dec454 546 if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
547 function_exists($languages[$squirrelmail_language]['XTRA_CODE'])) {
6fbd125b 548 $string = $languages[$squirrelmail_language]['XTRA_CODE']('decodeheader', $string);
83be314a 549 }
550
79e07c7e 551 $i = 0;
552 while (preg_match('/^(.{' . $i . '})(.*)=\?([^?]*)\?(Q|B)\?([^?]*)\?=/Ui',
553 $string, $res)) {
554 $prefix = $res[1];
3d8371be 555 /* Ignore white-space between consecutive encoded-words. */
79e07c7e 556 if (strspn($res[2], " \t") != strlen($res[2])) {
557 $prefix .= $res[2];
558 }
18aa168e 559
79e07c7e 560 if (ucfirst($res[4]) == 'B') {
561 $replace = base64_decode($res[5]);
562 } else {
563 $replace = str_replace('_', ' ', $res[5]);
564 $replace = preg_replace('/=([0-9a-f]{2})/ie', 'chr(hexdec("\1"))',
565 $replace);
566 /* Only encode into entities by default. Some places
3d8371be 567 * don't need the encoding, like the compose form.
568 */
79e07c7e 569 if ($utfencode) {
570 $replace = charset_decode($res[3], $replace);
571 }
18aa168e 572 }
79e07c7e 573 $string = $prefix . $replace . substr($string, strlen($res[0]));
574 $i = strlen($prefix) + strlen($replace);
18aa168e 575 }
3d8371be 576 return $string;
451f74a2 577}
578
579/*
580 * Encode a string according to RFC 1522 for use in headers if it
581 * contains 8-bit characters or anything that looks like it should
582 * be encoded.
583 */
584function encodeHeader ($string) {
6fbd125b 585 global $default_charset, $languages, $squirrelmail_language;
83be314a 586
10dec454 587 if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
588 function_exists($languages[$squirrelmail_language]['XTRA_CODE'])) {
6fbd125b 589 return $languages[$squirrelmail_language]['XTRA_CODE']('encodeheader', $string);
83be314a 590 }
793cc001 591
451f74a2 592 // Encode only if the string contains 8-bit characters or =?
3d8371be 593 $j = strlen($string);
451f74a2 594 $l = strstr($string, '=?'); // Must be encoded ?
595 $ret = '';
3d8371be 596 for($i = 0; $i < $j; ++$i) {
597 switch($string{$i}) {
598 case '=':
599 $ret .= '=3D';
600 break;
601 case '?':
602 $ret .= '=3F';
603 break;
604 case '_':
605 $ret .= '=5F';
606 break;
607 case ' ':
608 $ret .= '_';
609 break;
610 default:
611 $k = ord($string{$i});
612 if ($k > 126) {
613 $ret .= sprintf("=%02X", $k);
614 $l = TRUE;
615 } else {
616 $ret .= $string{$i};
617 }
618 break;
f7b3ba37 619 }
451f74a2 620 }
793cc001 621
3d8371be 622 if ($l) {
f7b3ba37 623 $string = "=?$default_charset?Q?$ret?=";
451f74a2 624 }
346817d4 625
3d8371be 626 return $string;
451f74a2 627}
b74ba498 628
691a2d25 629/* This function trys to locate the entity_id of a specific mime element */
3d8371be 630function find_ent_id($id, $message) {
a171b359 631 for ($i = 0, $ret = ''; $ret == '' && $i < count($message->entities); $i++) {
632 if ($message->entities[$i]->header->type0 == 'multipart') {
3d8371be 633 $ret = find_ent_id($id, $message->entities[$i]);
451f74a2 634 } else {
3d8371be 635 if (strcasecmp($message->entities[$i]->header->id, $id) == 0) {
d8cffbab 636// if (sq_check_save_extension($message->entities[$i])) {
a171b359 637 return $message->entities[$i]->entity_id;
d8cffbab 638// }
3d8371be 639 }
a3daaaf3 640 }
451f74a2 641 }
3d8371be 642 return $ret;
451f74a2 643}
a3daaaf3 644
e5e9381a 645function sq_check_save_extension($message) {
646 $filename = $message->getFilename();
647 $ext = substr($filename, strrpos($filename,'.')+1);
648 $save_extensions = array('jpg','jpeg','gif','png','bmp');
3d8371be 649 return in_array($ext, $save_extensions);
e5e9381a 650}
651
652
691a2d25 653/**
654 ** HTMLFILTER ROUTINES
655 */
451f74a2 656
691a2d25 657/**
658 * This function returns the final tag out of the tag name, an array
659 * of attributes, and the type of the tag. This function is called by
660 * sq_sanitize internally.
661 *
662 * @param $tagname the name of the tag.
663 * @param $attary the array of attributes and their values
664 * @param $tagtype The type of the tag (see in comments).
665 * @return a string with the final tag representation.
666 */
667function sq_tagprint($tagname, $attary, $tagtype){
b583c3e8 668 $me = 'sq_tagprint';
3d8371be 669
691a2d25 670 if ($tagtype == 2){
671 $fulltag = '</' . $tagname . '>';
672 } else {
673 $fulltag = '<' . $tagname;
674 if (is_array($attary) && sizeof($attary)){
675 $atts = Array();
676 while (list($attname, $attvalue) = each($attary)){
677 array_push($atts, "$attname=$attvalue");
678 }
679 $fulltag .= ' ' . join(" ", $atts);
680 }
681 if ($tagtype == 3){
b583c3e8 682 $fulltag .= ' /';
691a2d25 683 }
b583c3e8 684 $fulltag .= '>';
451f74a2 685 }
691a2d25 686 return $fulltag;
451f74a2 687}
a3daaaf3 688
691a2d25 689/**
690 * A small helper function to use with array_walk. Modifies a by-ref
691 * value and makes it lowercase.
692 *
693 * @param $val a value passed by-ref.
694 * @return void since it modifies a by-ref value.
695 */
696function sq_casenormalize(&$val){
697 $val = strtolower($val);
698}
451f74a2 699
691a2d25 700/**
701 * This function skips any whitespace from the current position within
702 * a string and to the next non-whitespace value.
703 *
704 * @param $body the string
705 * @param $offset the offset within the string where we should start
706 * looking for the next non-whitespace character.
707 * @return the location within the $body where the next
708 * non-whitespace char is located.
709 */
710function sq_skipspace($body, $offset){
b583c3e8 711 $me = 'sq_skipspace';
3d8371be 712 preg_match('/^(\s*)/s', substr($body, $offset), $matches);
691a2d25 713 if (sizeof($matches{1})){
714 $count = strlen($matches{1});
715 $offset += $count;
451f74a2 716 }
691a2d25 717 return $offset;
451f74a2 718}
a3daaaf3 719
691a2d25 720/**
721 * This function looks for the next character within a string. It's
722 * really just a glorified "strpos", except it catches if failures
723 * nicely.
724 *
725 * @param $body The string to look for needle in.
726 * @param $offset Start looking from this position.
727 * @param $needle The character/string to look for.
728 * @return location of the next occurance of the needle, or
729 * strlen($body) if needle wasn't found.
730 */
731function sq_findnxstr($body, $offset, $needle){
3d8371be 732 $me = 'sq_findnxstr';
691a2d25 733 $pos = strpos($body, $needle, $offset);
734 if ($pos === FALSE){
735 $pos = strlen($body);
451f74a2 736 }
691a2d25 737 return $pos;
451f74a2 738}
a3daaaf3 739
691a2d25 740/**
741 * This function takes a PCRE-style regexp and tries to match it
742 * within the string.
743 *
744 * @param $body The string to look for needle in.
745 * @param $offset Start looking from here.
746 * @param $reg A PCRE-style regex to match.
747 * @return Returns a false if no matches found, or an array
748 * with the following members:
749 * - integer with the location of the match within $body
750 * - string with whatever content between offset and the match
751 * - string with whatever it is we matched
752 */
753function sq_findnxreg($body, $offset, $reg){
b583c3e8 754 $me = 'sq_findnxreg';
691a2d25 755 $matches = Array();
756 $retarr = Array();
757 preg_match("%^(.*?)($reg)%s", substr($body, $offset), $matches);
758 if (!$matches{0}){
759 $retarr = false;
760 } else {
761 $retarr{0} = $offset + strlen($matches{1});
762 $retarr{1} = $matches{1};
763 $retarr{2} = $matches{2};
764 }
765 return $retarr;
766}
a3daaaf3 767
691a2d25 768/**
769 * This function looks for the next tag.
770 *
771 * @param $body String where to look for the next tag.
772 * @param $offset Start looking from here.
773 * @return false if no more tags exist in the body, or
774 * an array with the following members:
775 * - string with the name of the tag
776 * - array with attributes and their values
777 * - integer with tag type (1, 2, or 3)
778 * - integer where the tag starts (starting "<")
779 * - integer where the tag ends (ending ">")
780 * first three members will be false, if the tag is invalid.
781 */
782function sq_getnxtag($body, $offset){
b583c3e8 783 $me = 'sq_getnxtag';
691a2d25 784 if ($offset > strlen($body)){
785 return false;
786 }
787 $lt = sq_findnxstr($body, $offset, "<");
788 if ($lt == strlen($body)){
789 return false;
790 }
791 /**
792 * We are here:
793 * blah blah <tag attribute="value">
794 * \---------^
795 */
796 $pos = sq_skipspace($body, $lt+1);
797 if ($pos >= strlen($body)){
798 return Array(false, false, false, $lt, strlen($body));
799 }
800 /**
801 * There are 3 kinds of tags:
802 * 1. Opening tag, e.g.:
803 * <a href="blah">
804 * 2. Closing tag, e.g.:
805 * </a>
806 * 3. XHTML-style content-less tag, e.g.:
807 * <img src="blah"/>
808 */
809 $tagtype = false;
810 switch (substr($body, $pos, 1)){
3d8371be 811 case '/':
812 $tagtype = 2;
813 $pos++;
814 break;
815 case '!':
816 /**
817 * A comment or an SGML declaration.
818 */
819 if (substr($body, $pos+1, 2) == "--"){
820 $gt = strpos($body, "-->", $pos);
821 if ($gt === false){
822 $gt = strlen($body);
823 } else {
824 $gt += 2;
825 }
826 return Array(false, false, false, $lt, $gt);
bb8d0799 827 } else {
3d8371be 828 $gt = sq_findnxstr($body, $pos, ">");
829 return Array(false, false, false, $lt, $gt);
830 }
831 break;
832 default:
833 /**
834 * Assume tagtype 1 for now. If it's type 3, we'll switch values
835 * later.
836 */
837 $tagtype = 1;
838 break;
691a2d25 839 }
a3daaaf3 840
691a2d25 841 $tag_start = $pos;
842 $tagname = '';
843 /**
844 * Look for next [\W-_], which will indicate the end of the tag name.
845 */
846 $regary = sq_findnxreg($body, $pos, "[^\w\-_]");
847 if ($regary == false){
848 return Array(false, false, false, $lt, strlen($body));
849 }
850 list($pos, $tagname, $match) = $regary;
851 $tagname = strtolower($tagname);
852
853 /**
854 * $match can be either of these:
855 * '>' indicating the end of the tag entirely.
856 * '\s' indicating the end of the tag name.
857 * '/' indicating that this is type-3 xhtml tag.
858 *
859 * Whatever else we find there indicates an invalid tag.
860 */
861 switch ($match){
3d8371be 862 case '/':
691a2d25 863 /**
3d8371be 864 * This is an xhtml-style tag with a closing / at the
865 * end, like so: <img src="blah"/>. Check if it's followed
866 * by the closing bracket. If not, then this tag is invalid
691a2d25 867 */
3d8371be 868 if (substr($body, $pos, 2) == "/>"){
869 $pos++;
870 $tagtype = 3;
871 } else {
872 $gt = sq_findnxstr($body, $pos, ">");
873 $retary = Array(false, false, false, $lt, $gt);
874 return $retary;
875 }
876 case '>':
877 return Array($tagname, false, $tagtype, $lt, $pos);
878 break;
879 default:
880 /**
881 * Check if it's whitespace
882 */
883 if (!preg_match('/\s/', $match)){
884 /**
885 * This is an invalid tag! Look for the next closing ">".
886 */
887 $gt = sq_findnxstr($body, $offset, ">");
888 return Array(false, false, false, $lt, $gt);
889 }
890 break;
691a2d25 891 }
3d8371be 892
691a2d25 893 /**
894 * At this point we're here:
895 * <tagname attribute='blah'>
896 * \-------^
897 *
898 * At this point we loop in order to find all attributes.
899 */
900 $attname = '';
901 $atttype = false;
902 $attary = Array();
903
904 while ($pos <= strlen($body)){
905 $pos = sq_skipspace($body, $pos);
906 if ($pos == strlen($body)){
907 /**
908 * Non-closed tag.
909 */
910 return Array(false, false, false, $lt, $pos);
911 }
912 /**
913 * See if we arrived at a ">" or "/>", which means that we reached
914 * the end of the tag.
915 */
916 $matches = Array();
164800ad 917 if (preg_match("%^(\s*)(>|/>)%s", substr($body, $pos), $matches)) {
c828931c 918 /**
919 * Yep. So we did.
920 */
921 $pos += strlen($matches{1});
922 if ($matches{2} == "/>"){
923 $tagtype = 3;
924 $pos++;
925 }
926 return Array($tagname, $attary, $tagtype, $lt, $pos);
927 }
a3daaaf3 928
cca46357 929 /**
691a2d25 930 * There are several types of attributes, with optional
931 * [:space:] between members.
932 * Type 1:
933 * attrname[:space:]=[:space:]'CDATA'
934 * Type 2:
935 * attrname[:space:]=[:space:]"CDATA"
936 * Type 3:
937 * attr[:space:]=[:space:]CDATA
938 * Type 4:
939 * attrname
cca46357 940 *
691a2d25 941 * We leave types 1 and 2 the same, type 3 we check for
942 * '"' and convert to "&quot" if needed, then wrap in
943 * double quotes. Type 4 we convert into:
944 * attrname="yes".
cca46357 945 */
691a2d25 946 $regary = sq_findnxreg($body, $pos, "[^\w\-_]");
947 if ($regary == false){
948 /**
949 * Looks like body ended before the end of tag.
950 */
951 return Array(false, false, false, $lt, strlen($body));
cca46357 952 }
691a2d25 953 list($pos, $attname, $match) = $regary;
954 $attname = strtolower($attname);
955 /**
956 * We arrived at the end of attribute name. Several things possible
957 * here:
958 * '>' means the end of the tag and this is attribute type 4
959 * '/' if followed by '>' means the same thing as above
960 * '\s' means a lot of things -- look what it's followed by.
961 * anything else means the attribute is invalid.
962 */
963 switch($match){
3d8371be 964 case '/':
691a2d25 965 /**
3d8371be 966 * This is an xhtml-style tag with a closing / at the
967 * end, like so: <img src="blah"/>. Check if it's followed
968 * by the closing bracket. If not, then this tag is invalid
691a2d25 969 */
3d8371be 970 if (substr($body, $pos, 2) == "/>"){
691a2d25 971 $pos++;
3d8371be 972 $tagtype = 3;
691a2d25 973 } else {
3d8371be 974 $gt = sq_findnxstr($body, $pos, ">");
975 $retary = Array(false, false, false, $lt, $gt);
976 return $retary;
977 }
978 case '>':
979 $attary{$attname} = '"yes"';
980 return Array($tagname, $attary, $tagtype, $lt, $pos);
981 break;
982 default:
983 /**
984 * Skip whitespace and see what we arrive at.
985 */
986 $pos = sq_skipspace($body, $pos);
987 $char = substr($body, $pos, 1);
988 /**
989 * Two things are valid here:
990 * '=' means this is attribute type 1 2 or 3.
991 * \w means this was attribute type 4.
992 * anything else we ignore and re-loop. End of tag and
993 * invalid stuff will be caught by our checks at the beginning
994 * of the loop.
995 */
996 if ($char == "="){
997 $pos++;
998 $pos = sq_skipspace($body, $pos);
691a2d25 999 /**
3d8371be 1000 * Here are 3 possibilities:
1001 * "'" attribute type 1
1002 * '"' attribute type 2
1003 * everything else is the content of tag type 3
691a2d25 1004 */
3d8371be 1005 $quot = substr($body, $pos, 1);
1006 if ($quot == "'"){
1007 $regary = sq_findnxreg($body, $pos+1, "\'");
1008 if ($regary == false){
1009 return Array(false, false, false, $lt, strlen($body));
1010 }
1011 list($pos, $attval, $match) = $regary;
1012 $pos++;
1013 $attary{$attname} = "'" . $attval . "'";
1014 } else if ($quot == '"'){
1015 $regary = sq_findnxreg($body, $pos+1, '\"');
1016 if ($regary == false){
1017 return Array(false, false, false, $lt, strlen($body));
1018 }
1019 list($pos, $attval, $match) = $regary;
1020 $pos++;
1021 $attary{$attname} = '"' . $attval . '"';
1022 } else {
1023 /**
1024 * These are hateful. Look for \s, or >.
1025 */
1026 $regary = sq_findnxreg($body, $pos, "[\s>]");
1027 if ($regary == false){
1028 return Array(false, false, false, $lt, strlen($body));
1029 }
1030 list($pos, $attval, $match) = $regary;
1031 /**
1032 * If it's ">" it will be caught at the top.
1033 */
1034 $attval = preg_replace("/\"/s", "&quot;", $attval);
1035 $attary{$attname} = '"' . $attval . '"';
7e235a1a 1036 }
3d8371be 1037 } else if (preg_match("|[\w/>]|", $char)) {
691a2d25 1038 /**
3d8371be 1039 * That was attribute type 4.
691a2d25 1040 */
3d8371be 1041 $attary{$attname} = '"yes"';
1042 } else {
1043 /**
1044 * An illegal character. Find next '>' and return.
1045 */
1046 $gt = sq_findnxstr($body, $pos, ">");
1047 return Array(false, false, false, $lt, $gt);
451f74a2 1048 }
3d8371be 1049 break;
691a2d25 1050 }
1051 }
1052 /**
1053 * The fact that we got here indicates that the tag end was never
1054 * found. Return invalid tag indication so it gets stripped.
1055 */
1056 return Array(false, false, false, $lt, strlen($body));
1057}
1058
1059/**
1060 * This function checks attribute values for entity-encoded values
1061 * and returns them translated into 8-bit strings so we can run
1062 * checks on them.
1063 *
1064 * @param $attvalue A string to run entity check against.
1065 * @return Translated value.
1066 */
1067function sq_deent($attvalue){
b583c3e8 1068 $me = 'sq_deent';
691a2d25 1069 /**
1070 * See if we have to run the checks first. All entities must start
1071 * with "&".
1072 */
1073 if (strpos($attvalue, "&") === false){
1074 return $attvalue;
1075 }
1076 /**
1077 * Check named entities first.
1078 */
1079 $trans = get_html_translation_table(HTML_ENTITIES);
1080 /**
1081 * Leave &quot; in, as it can mess us up.
1082 */
1083 $trans = array_flip($trans);
1084 unset($trans{"&quot;"});
1085 while (list($ent, $val) = each($trans)){
1086 $attvalue = preg_replace("/$ent*(\W)/si", "$val\\1", $attvalue);
1087 }
1088 /**
1089 * Now translate numbered entities from 1 to 255 if needed.
1090 */
1091 if (strpos($attvalue, "#") !== false){
1092 $omit = Array(34, 39);
1093 for ($asc=1; $asc<256; $asc++){
1094 if (!in_array($asc, $omit)){
1095 $chr = chr($asc);
1096 $attvalue = preg_replace("/\&#0*$asc;*(\D)/si", "$chr\\1",
1097 $attvalue);
1098 $attvalue = preg_replace("/\&#x0*".dechex($asc).";*(\W)/si",
1099 "$chr\\1", $attvalue);
a3daaaf3 1100 }
691a2d25 1101 }
1102 }
1103 return $attvalue;
1104}
1105
1106/**
1107 * This function runs various checks against the attributes.
1108 *
1109 * @param $tagname String with the name of the tag.
1110 * @param $attary Array with all tag attributes.
1111 * @param $rm_attnames See description for sq_sanitize
1112 * @param $bad_attvals See description for sq_sanitize
1113 * @param $add_attr_to_tag See description for sq_sanitize
1114 * @param $message message object
1115 * @param $id message id
1116 * @return Array with modified attributes.
1117 */
1118function sq_fixatts($tagname,
1119 $attary,
1120 $rm_attnames,
1121 $bad_attvals,
1122 $add_attr_to_tag,
1123 $message,
b3af12ef 1124 $id,
3d8371be 1125 $mailbox
691a2d25 1126 ){
b583c3e8 1127 $me = 'sq_fixatts';
691a2d25 1128 while (list($attname, $attvalue) = each($attary)){
1129 /**
1130 * See if this attribute should be removed.
1131 */
1132 foreach ($rm_attnames as $matchtag=>$matchattrs){
1133 if (preg_match($matchtag, $tagname)){
1134 foreach ($matchattrs as $matchattr){
1135 if (preg_match($matchattr, $attname)){
1136 unset($attary{$attname});
1137 continue;
1138 }
451f74a2 1139 }
451f74a2 1140 }
691a2d25 1141 }
1142 /**
1143 * Remove any entities.
1144 */
1145 $attvalue = sq_deent($attvalue);
1146
1147 /**
1148 * Now let's run checks on the attvalues.
1149 * I don't expect anyone to comprehend this. If you do,
1150 * get in touch with me so I can drive to where you live and
1151 * shake your hand personally. :)
1152 */
1153 foreach ($bad_attvals as $matchtag=>$matchattrs){
1154 if (preg_match($matchtag, $tagname)){
1155 foreach ($matchattrs as $matchattr=>$valary){
1156 if (preg_match($matchattr, $attname)){
1157 /**
1158 * There are two arrays in valary.
1159 * First is matches.
1160 * Second one is replacements
1161 */
1162 list($valmatch, $valrepl) = $valary;
1163 $newvalue =
1164 preg_replace($valmatch, $valrepl, $attvalue);
1165 if ($newvalue != $attvalue){
1166 $attary{$attname} = $newvalue;
1167 }
1168 }
1169 }
451f74a2 1170 }
a3daaaf3 1171 }
691a2d25 1172 /**
1173 * Turn cid: urls into http-friendly ones.
1174 */
1175 if (preg_match("/^[\'\"]\s*cid:/si", $attvalue)){
b3af12ef 1176 $attary{$attname} = sq_cid2http($message, $id, $attvalue, $mailbox);
691a2d25 1177 }
a3daaaf3 1178 }
691a2d25 1179 /**
1180 * See if we need to append any attributes to this tag.
1181 */
1182 foreach ($add_attr_to_tag as $matchtag=>$addattary){
1183 if (preg_match($matchtag, $tagname)){
1184 $attary = array_merge($attary, $addattary);
1185 }
1186 }
1187 return $attary;
451f74a2 1188}
a3daaaf3 1189
691a2d25 1190/**
1191 * This function edits the style definition to make them friendly and
1192 * usable in squirrelmail.
1193 *
1194 * @param $message the message object
1195 * @param $id the message id
1196 * @param $content a string with whatever is between <style> and </style>
1197 * @return a string with edited content.
1198 */
1199function sq_fixstyle($message, $id, $content){
1200 global $view_unsafe_images;
b583c3e8 1201 $me = 'sq_fixstyle';
691a2d25 1202 /**
1203 * First look for general BODY style declaration, which would be
1204 * like so:
1205 * body {background: blah-blah}
1206 * and change it to .bodyclass so we can just assign it to a <div>
1207 */
1208 $content = preg_replace("|body(\s*\{.*?\})|si", ".bodyclass\\1", $content);
3d8371be 1209 $secremoveimg = '../images/' . _("sec_remove_eng.png");
691a2d25 1210 /**
1211 * Fix url('blah') declarations.
1212 */
1213 $content = preg_replace("|url\(([\'\"])\s*\S+script\s*:.*?([\'\"])\)|si",
1214 "url(\\1$secremoveimg\\2)", $content);
1215 /**
1216 * Fix url('https*://.*) declarations but only if $view_unsafe_images
1217 * is false.
1218 */
1219 if (!$view_unsafe_images){
1220 $content = preg_replace("|url\(([\'\"])\s*https*:.*?([\'\"])\)|si",
1221 "url(\\1$secremoveimg\\2)", $content);
1222 }
1223
1224 /**
1225 * Fix urls that refer to cid:
1226 */
1227 while (preg_match("|url\(([\'\"]\s*cid:.*?[\'\"])\)|si", $content,
1228 $matches)){
1229 $cidurl = $matches{1};
1230 $httpurl = sq_cid2http($message, $id, $cidurl);
1231 $content = preg_replace("|url\($cidurl\)|si",
1232 "url($httpurl)", $content);
1233 }
a3daaaf3 1234
691a2d25 1235 /**
bb8d0799 1236 * Fix stupid css declarations which lead to vulnerabilities
691a2d25 1237 * in IE.
1238 */
bb8d0799 1239 $match = Array('/expression/si',
3d8371be 1240 '/behaviou*r/si',
1241 '/binding/si');
bb8d0799 1242 $replace = Array('idiocy', 'idiocy', 'idiocy');
1243 $content = preg_replace($match, $replace, $content);
691a2d25 1244 return $content;
1245}
a3daaaf3 1246
691a2d25 1247/**
1248 * This function converts cid: url's into the ones that can be viewed in
1249 * the browser.
1250 *
1251 * @param $message the message object
1252 * @param $id the message id
1253 * @param $cidurl the cid: url.
1254 * @return a string with a http-friendly url
1255 */
b3af12ef 1256function sq_cid2http($message, $id, $cidurl, $mailbox){
691a2d25 1257 /**
1258 * Get rid of quotes.
1259 */
1260 $quotchar = substr($cidurl, 0, 1);
1261 $cidurl = str_replace($quotchar, "", $cidurl);
1262 $cidurl = substr(trim($cidurl), 4);
e5e9381a 1263 $linkurl = find_ent_id($cidurl, $message);
1264 /* in case of non-save cid links $httpurl should be replaced by a sort of
1265 unsave link image */
1266 $httpurl = '';
1267 if ($linkurl) {
3d8371be 1268 $httpurl = $quotchar . '../src/download.php?absolute_dl=true&amp;' .
e5e9381a 1269 "passed_id=$id&amp;mailbox=" . urlencode($mailbox) .
3d8371be 1270 '&amp;ent_id=' . $linkurl . $quotchar;
e5e9381a 1271 }
691a2d25 1272 return $httpurl;
1273}
1274
1275/**
1276 * This function changes the <body> tag into a <div> tag since we
1277 * can't really have a body-within-body.
1278 *
1279 * @param $attary an array of attributes and values of <body>
1280 * @return a modified array of attributes to be set for <div>
1281 */
1282function sq_body2div($attary){
b583c3e8 1283 $me = 'sq_body2div';
3d8371be 1284 $divattary = Array('class' => "'bodyclass'");
b583c3e8 1285 $bgcolor = '#ffffff';
1286 $text = '#000000';
1287 $styledef = '';
691a2d25 1288 if (is_array($attary) && sizeof($attary) > 0){
1289 foreach ($attary as $attname=>$attvalue){
1290 $quotchar = substr($attvalue, 0, 1);
1291 $attvalue = str_replace($quotchar, "", $attvalue);
1292 switch ($attname){
3d8371be 1293 case 'background':
1294 $styledef .= "background-image: url('$attvalue'); ";
1295 break;
1296 case 'bgcolor':
1297 $styledef .= "background-color: $attvalue; ";
1298 break;
1299 case 'text':
1300 $styledef .= "color: $attvalue; ";
1301 break;
691a2d25 1302 }
a3daaaf3 1303 }
691a2d25 1304 if (strlen($styledef) > 0){
1305 $divattary{"style"} = "\"$styledef\"";
1306 }
1307 }
1308 return $divattary;
1309}
a3daaaf3 1310
691a2d25 1311/**
1312 * This is the main function and the one you should actually be calling.
1313 * There are several variables you should be aware of an which need
1314 * special description.
1315 *
1316 * Since the description is quite lengthy, see it here:
1317 * http://www.mricon.com/html/phpfilter.html
1318 *
1319 * @param $body the string with HTML you wish to filter
1320 * @param $tag_list see description above
1321 * @param $rm_tags_with_content see description above
1322 * @param $self_closing_tags see description above
1323 * @param $force_tag_closing see description above
1324 * @param $rm_attnames see description above
1325 * @param $bad_attvals see description above
1326 * @param $add_attr_to_tag see description above
1327 * @param $message message object
1328 * @param $id message id
1329 * @return sanitized html safe to show on your pages.
1330 */
1331function sq_sanitize($body,
1332 $tag_list,
1333 $rm_tags_with_content,
1334 $self_closing_tags,
1335 $force_tag_closing,
1336 $rm_attnames,
1337 $bad_attvals,
1338 $add_attr_to_tag,
1339 $message,
b3af12ef 1340 $id,
3d8371be 1341 $mailbox
691a2d25 1342 ){
b583c3e8 1343 $me = 'sq_sanitize';
691a2d25 1344 /**
1345 * Normalize rm_tags and rm_tags_with_content.
1346 */
1347 @array_walk($rm_tags, 'sq_casenormalize');
1348 @array_walk($rm_tags_with_content, 'sq_casenormalize');
1349 @array_walk($self_closing_tags, 'sq_casenormalize');
1350 /**
1351 * See if tag_list is of tags to remove or tags to allow.
1352 * false means remove these tags
1353 * true means allow these tags
1354 */
1355 $rm_tags = array_shift($tag_list);
1356 $curpos = 0;
1357 $open_tags = Array();
1358 $trusted = "<!-- begin sanitized html -->\n";
1359 $skip_content = false;
bb8d0799 1360 /**
1361 * Take care of netscape's stupid javascript entities like
1362 * &{alert('boo')};
1363 */
1364 $body = preg_replace("/&(\{.*?\};)/si", "&amp;\\1", $body);
691a2d25 1365
1366 while (($curtag=sq_getnxtag($body, $curpos)) != FALSE){
1367 list($tagname, $attary, $tagtype, $lt, $gt) = $curtag;
1368 $free_content = substr($body, $curpos, $lt-$curpos);
1369 /**
1370 * Take care of <style>
1371 */
1372 if ($tagname == "style" && $tagtype == 2){
1373 /**
1374 * This is a closing </style>. Edit the
1375 * content before we apply it.
1376 */
1377 $free_content = sq_fixstyle($message, $id, $free_content);
691a2d25 1378 }
1379 if ($skip_content == false){
1380 $trusted .= $free_content;
691a2d25 1381 }
1382 if ($tagname != FALSE){
1383 if ($tagtype == 2){
1384 if ($skip_content == $tagname){
1385 /**
1386 * Got to the end of tag we needed to remove.
1387 */
1388 $tagname = false;
1389 $skip_content = false;
1390 } else {
1391 if ($skip_content == false){
c828931c 1392 if ($tagname == "body"){
1393 $tagname = "div";
691a2d25 1394 } else {
c828931c 1395 if (isset($open_tags{$tagname}) &&
1396 $open_tags{$tagname} > 0){
1397 $open_tags{$tagname}--;
1398 } else {
1399 $tagname = false;
1400 }
691a2d25 1401 }
691a2d25 1402 }
1403 }
1404 } else {
1405 /**
1406 * $rm_tags_with_content
1407 */
1408 if ($skip_content == false){
1409 /**
1410 * See if this is a self-closing type and change
1411 * tagtype appropriately.
1412 */
1413 if ($tagtype == 1
1414 && in_array($tagname, $self_closing_tags)){
1415 $tagtype=3;
1416 }
1417 /**
1418 * See if we should skip this tag and any content
1419 * inside it.
1420 */
1421 if ($tagtype == 1 &&
1422 in_array($tagname, $rm_tags_with_content)){
1423 $skip_content = $tagname;
1424 } else {
1425 if (($rm_tags == false
1426 && in_array($tagname, $tag_list)) ||
1427 ($rm_tags == true &&
1428 !in_array($tagname, $tag_list))){
1429 $tagname = false;
1430 } else {
1431 if ($tagtype == 1){
1432 if (isset($open_tags{$tagname})){
1433 $open_tags{$tagname}++;
1434 } else {
1435 $open_tags{$tagname}=1;
1436 }
1437 }
1438 /**
1439 * This is where we run other checks.
1440 */
1441 if (is_array($attary) && sizeof($attary) > 0){
1442 $attary = sq_fixatts($tagname,
1443 $attary,
1444 $rm_attnames,
1445 $bad_attvals,
1446 $add_attr_to_tag,
1447 $message,
b3af12ef 1448 $id,
3d8371be 1449 $mailbox
691a2d25 1450 );
1451 }
c828931c 1452 /**
1453 * Convert body into div.
1454 */
1455 if ($tagname == "body"){
1456 $tagname = "div";
1457 $attary = sq_body2div($attary, $message, $id);
1458 }
691a2d25 1459 }
1460 }
691a2d25 1461 }
1462 }
1463 if ($tagname != false && $skip_content == false){
1464 $trusted .= sq_tagprint($tagname, $attary, $tagtype);
1465 }
691a2d25 1466 }
1467 $curpos = $gt+1;
a3daaaf3 1468 }
691a2d25 1469 $trusted .= substr($body, $curpos, strlen($body)-$curpos);
1470 if ($force_tag_closing == true){
1471 foreach ($open_tags as $tagname=>$opentimes){
1472 while ($opentimes > 0){
1473 $trusted .= '</' . $tagname . '>';
1474 $opentimes--;
1475 }
1476 }
1477 $trusted .= "\n";
1478 }
1479 $trusted .= "<!-- end sanitized html -->\n";
1480 return $trusted;
1481}
451f74a2 1482
691a2d25 1483/**
1484 * This is a wrapper function to call html sanitizing routines.
1485 *
1486 * @param $body the body of the message
1487 * @param $id the id of the message
1488 * @return a string with html safe to display in the browser.
1489 */
b3af12ef 1490function magicHTML($body, $id, $message, $mailbox = 'INBOX'){
691a2d25 1491 global $attachment_common_show_images, $view_unsafe_images,
3d8371be 1492 $has_unsafe_images;
691a2d25 1493 /**
1494 * Don't display attached images in HTML mode.
1495 */
1496 $attachment_common_show_images = false;
1497 $tag_list = Array(
1498 false,
1499 "object",
1500 "meta",
1501 "html",
1502 "head",
cc34b00d 1503 "base",
e18cb31b 1504 "link",
1505 "frame",
1506 "iframe"
691a2d25 1507 );
1508
1509 $rm_tags_with_content = Array(
1510 "script",
1511 "applet",
1512 "embed",
1513 "title"
1514 );
1515
1516 $self_closing_tags = Array(
1517 "img",
1518 "br",
1519 "hr",
1520 "input"
1521 );
1522
1523 $force_tag_closing = false;
1524
1525 $rm_attnames = Array(
1526 "/.*/" =>
1527 Array(
1528 "/target/si",
bb8d0799 1529 "/^on.*/si",
3d8371be 1530 "/^dynsrc/si",
1531 "/^data.*/si"
691a2d25 1532 )
1533 );
1534
1535 $secremoveimg = "../images/" . _("sec_remove_eng.png");
1536 $bad_attvals = Array(
1537 "/.*/" =>
1538 Array(
0a6ec9b5 1539 "/^src|background/i" =>
691a2d25 1540 Array(
1541 Array(
1542 "|^([\'\"])\s*\.\./.*([\'\"])|si",
bb8d0799 1543 "/^([\'\"])\s*\S+script\s*:.*([\'\"])/si",
3d8371be 1544 "/^([\'\"])\s*mocha\s*:*.*([\'\"])/si",
1545 "/^([\'\"])\s*about\s*:.*([\'\"])/si"
691a2d25 1546 ),
1547 Array(
1548 "\\1$secremoveimg\\2",
bb8d0799 1549 "\\1$secremoveimg\\2",
3d8371be 1550 "\\1$secremoveimg\\2",
1551 "\\1$secremoveimg\\2"
691a2d25 1552 )
1553 ),
0a6ec9b5 1554 "/^href|action/i" =>
1555 Array(
1556 Array(
1557 "|^([\'\"])\s*\.\./.*([\'\"])|si",
1558 "/^([\'\"])\s*\S+script\s*:.*([\'\"])/si",
3d8371be 1559 "/^([\'\"])\s*mocha\s*:*.*([\'\"])/si",
1560 "/^([\'\"])\s*about\s*:.*([\'\"])/si"
0a6ec9b5 1561 ),
1562 Array(
1563 "\\1#\\2",
1564 "\\1#\\2",
3d8371be 1565 "\\1#\\2",
1566 "\\1#\\2"
0a6ec9b5 1567 )
1568 ),
691a2d25 1569 "/^style/si" =>
1570 Array(
1571 Array(
bb8d0799 1572 "/expression/si",
3d8371be 1573 "/binding/si",
1574 "/behaviou*r/si",
691a2d25 1575 "|url\(([\'\"])\s*\.\./.*([\'\"])\)|si",
0a6ec9b5 1576 "/url\(([\'\"])\s*\S+script\s*:.*([\'\"])\)/si",
3d8371be 1577 "/url\(([\'\"])\s*mocha\s*:.*([\'\"])\)/si",
1578 "/url\(([\'\"])\s*about\s*:.*([\'\"])\)/si"
691a2d25 1579 ),
1580 Array(
bb8d0799 1581 "idiocy",
3d8371be 1582 "idiocy",
1583 "idiocy",
1584 "url(\\1#\\2)",
0a6ec9b5 1585 "url(\\1#\\2)",
1586 "url(\\1#\\2)",
3d8371be 1587 "url(\\1#\\2)"
691a2d25 1588 )
1589 )
1590 )
1591 );
1592 if (!$view_unsafe_images){
1593 /**
1594 * Remove any references to http/https if view_unsafe_images set
1595 * to false.
1596 */
0a6ec9b5 1597 array_push($bad_attvals{'/.*/'}{'/^src|background/i'}[0],
43d678b6 1598 '/^([\'\"])\s*https*:.*([\'\"])/si');
0a6ec9b5 1599 array_push($bad_attvals{'/.*/'}{'/^src|background/i'}[1],
43d678b6 1600 "\\1$secremoveimg\\2");
1601 array_push($bad_attvals{'/.*/'}{'/^style/si'}[0],
1602 '/url\(([\'\"])\s*https*:.*([\'\"])\)/si');
1603 array_push($bad_attvals{'/.*/'}{'/^style/si'}[1],
1604 "url(\\1$secremoveimg\\2)");
691a2d25 1605 }
451f74a2 1606
691a2d25 1607 $add_attr_to_tag = Array(
1608 "/^a$/si" => Array('target'=>'"_new"')
1609 );
1610 $trusted = sq_sanitize($body,
1611 $tag_list,
1612 $rm_tags_with_content,
1613 $self_closing_tags,
1614 $force_tag_closing,
1615 $rm_attnames,
1616 $bad_attvals,
1617 $add_attr_to_tag,
1618 $message,
b3af12ef 1619 $id,
3d8371be 1620 $mailbox
691a2d25 1621 );
1622 if (preg_match("|$secremoveimg|si", $trusted)){
1623 $has_unsafe_images = true;
23bcec6f 1624 }
691a2d25 1625 return $trusted;
451f74a2 1626}
a4a70693 1627
19d470aa 1628?>