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