functions/mime.php

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