X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fmime.php;h=0a265568041d086335b27794769a542d286eea19;hp=c13a36681f58fd4bfff4ba001769691032613350;hb=d31f73f16e3e6acd2e1be41f8e8d0e17ecd4f393;hpb=ebeb83485874b392368d359cefc6e08fcb14f559 diff --git a/functions/mime.php b/functions/mime.php index c13a3668..0a265568 100644 --- a/functions/mime.php +++ b/functions/mime.php @@ -1,33 +1,55 @@ url_parser +translateText => url_parser + */ -/** The typical includes... */ -require_once(SM_PATH . 'functions/imap.php'); -require_once(SM_PATH . 'functions/attachment_common.php'); /* -------------------------------------------------------------------------- */ /* MIME DECODING */ /* -------------------------------------------------------------------------- */ /** -* Get the MIME structure -* -* This function gets the structure of a message and stores it in the "message" class. -* It will return this object for use with all relevant header information and -* fully parsed into the standard "message" object format. -*/ + * Get the MIME structure + * + * This function gets the structure of a message and stores it in the "message" class. + * It will return this object for use with all relevant header information and + * fully parsed into the standard "message" object format. + */ function mime_structure ($bodystructure, $flags=array()) { /* Isolate the body structure and remove beginning and end parenthesis. */ @@ -35,20 +57,20 @@ function mime_structure ($bodystructure, $flags=array()) { $read = trim(substr ($read, 0, -1)); $i = 0; $msg = Message::parseStructure($read,$i); + if (!is_object($msg)) { - include_once(SM_PATH . 'functions/display_messages.php'); global $color, $mailbox; - /* removed urldecode because $_GET is auto urldecoded ??? */ displayPageHeader( $color, $mailbox ); $errormessage = _("SquirrelMail could not decode the bodystructure of the message"); - $errormessage .= '
'._("the provided bodystructure by your imap-server").':

'; + $errormessage .= '
'._("The bodystructure provided by your IMAP server:").'

'; $errormessage .= '
' . htmlspecialchars($read) . '
'; - plain_error_message( $errormessage, $color ); + plain_error_message( $errormessage ); echo ''; exit; } if (count($flags)) { foreach ($flags as $flag) { +//FIXME: please document why it is we have to check the first char of the flag but we then go ahead and do a full string comparison anyway. Is this a speed enhancement? If not, let's keep it simple and just compare the full string and forget the switch block. $char = strtoupper($flag{1}); switch ($char) { case 'S': @@ -88,18 +110,18 @@ function mime_structure ($bodystructure, $flags=array()) { /* This starts the parsing of a particular structure. It is called recursively, -* so it can be passed different structures. It returns an object of type -* $message. -* First, it checks to see if it is a multipart message. If it is, then it -* handles that as it sees is necessary. If it is just a regular entity, -* then it parses it and adds the necessary header information (by calling out -* to mime_get_elements() -*/ + * so it can be passed different structures. It returns an object of type + * $message. + * First, it checks to see if it is a multipart message. If it is, then it + * handles that as it sees is necessary. If it is just a regular entity, + * then it parses it and adds the necessary header information (by calling out + * to mime_get_elements() + */ function mime_fetch_body($imap_stream, $id, $ent_id=1, $fetch_size=0) { /* Do a bit of error correction. If we couldn't find the entity id, just guess - * that it is the first one. That is usually the case anyway. - */ + * that it is the first one. That is usually the case anyway. + */ if (!$ent_id) { $cmd = "FETCH $id BODY[]"; @@ -118,13 +140,15 @@ function mime_fetch_body($imap_stream, $id, $ent_id=1, $fetch_size=0) { if (ereg('\\{([^\\}]*)\\}', $topline, $regs)) { $ret = substr($wholemessage, 0, $regs[1]); /* There is some information in the content info header that could be important - * in order to parse html messages. Let's get them here. - */ + * in order to parse html messages. Let's get them here. + */ // if ($ret{0} == '<') { // $data = sqimap_run_command ($imap_stream, "FETCH $id BODY[$ent_id.MIME]", true, $response, $message, TRUE); // } } else if (ereg('"([^"]*)"', $topline, $regs)) { $ret = $regs[1]; + } else if ((stristr($topline, 'nil') !== false) && (empty($wholemessage))) { + $ret = $wholemessage; } else { global $where, $what, $mailbox, $passed_id, $startMessage; $par = 'mailbox=' . urlencode($mailbox) . '&passed_id=' . $passed_id; @@ -134,10 +158,10 @@ function mime_fetch_body($imap_stream, $id, $ent_id=1, $fetch_size=0) { $par .= '&startMessage=' . $startMessage . '&show_more=0'; } $par .= '&response=' . urlencode($response) . - '&message=' . urlencode($message) . - '&topline=' . urlencode($topline); + '&message=' . urlencode($message) . + '&topline=' . urlencode($topline); - echo '
' . + echo '
' . '' . '' . - '' . - '' . - '\n"; } - $attachmentadd = do_hook_function('attachments_bottom',$attachments); - if ($attachmentadd != '') - $attachments = $attachmentadd; + return $attachments; } +/** + * Displays attachment links and information + * + * Since 1.3.0 function is not included in formatBody() call. + * + * Since 1.0.2 uses attachment $type0/$type1 hook. + * Since 1.2.5 uses attachment $type0/* hook. + * Since 1.5.0 uses attachments_bottom hook. + * Since 1.5.2 uses templates and does *not* return a value. + * + * @param object $message SquirrelMail message object + * @param array $exclude_id message parts that are not attachments. + * @param string $mailbox mailbox name + * @param integer $id message id + */ +function formatAttachments($message, $exclude_id, $mailbox, $id) { + global $oTemplate; + + $attach = buildAttachmentArray($message, $exclude_id, $mailbox, $id); + + $oTemplate->assign('attachments', $attach); + $oTemplate->display('read_attachments.tpl'); +} + function sqimap_base64_decode(&$string) { // Base64 encoded data goes in pairs of 4 bytes. To achieve on the @@ -551,15 +700,23 @@ function sqimap_base64_decode(&$string) { return $sStringRem; } - -/* This function decodes the body depending on the encoding type. */ +/** + * Decodes encoded message body + * + * This function decodes the body depending on the encoding type. + * Currently quoted-printable and base64 encodings are supported. + * decode_body hook was added to this function in 1.4.2/1.5.0 + * @param string $body encoded message body + * @param string $encoding used encoding + * @return string decoded string + * @since 1.0 + */ function decodeBody($body, $encoding) { - global $show_html_default; $body = str_replace("\r\n", "\n", $body); $encoding = strtolower($encoding); - $encoding_handler = do_hook_function('decode_body', $encoding); + $encoding_handler = do_hook('decode_body', $encoding); // plugins get first shot at decoding the body @@ -567,15 +724,16 @@ function decodeBody($body, $encoding) { if (!empty($encoding_handler) && function_exists($encoding_handler)) { $body = $encoding_handler('decode', $body); - } else if ($encoding == 'quoted-printable' || - $encoding == 'quoted_printable') { + } elseif ($encoding == 'quoted-printable' || + $encoding == 'quoted_printable') { + /** + * quoted_printable_decode() function is broken in older + * php versions. Text with \r\n decoding was fixed only + * in php 4.3.0. Minimal code requirement 4.0.4 + + * str_replace("\r\n", "\n", $body); call. + */ $body = quoted_printable_decode($body); - - while (ereg("=\n", $body)) { - $body = ereg_replace ("=\n", '', $body); - } - - } else if ($encoding == 'base64') { + } elseif ($encoding == 'base64') { $body = base64_decode($body); } @@ -584,26 +742,26 @@ function decodeBody($body, $encoding) { } /** -* Decodes headers -* -* This functions decode strings that is encoded according to -* RFC1522 (MIME Part Two: Message Header Extensions for Non-ASCII Text). -* Patched by Christian Schmidt 23/03/2002 -* -* @param string $string header string that has to be made readable -* @param boolean $utfencode change message in order to be readable on user's charset. defaults to true -* @param boolean $htmlsave preserve spaces and sanitize html special characters. defaults to true -* @param boolean $decide decide if string can be utfencoded. defaults to false -* @return string decoded header string -*/ -function decodeHeader ($string, $utfencode=true,$htmlsave=true,$decide=false) { + * Decodes headers + * + * This function decodes strings that are encoded according to + * RFC1522 (MIME Part Two: Message Header Extensions for Non-ASCII Text). + * Patched by Christian Schmidt 23/03/2002 + * + * @param string $string header string that has to be made readable + * @param boolean $utfencode change message in order to be readable on user's charset. defaults to true + * @param boolean $htmlsafe preserve spaces and sanitize html special characters. defaults to true + * @param boolean $decide decide if string can be utfencoded. defaults to false + * @return string decoded header string + */ +function decodeHeader ($string, $utfencode=true,$htmlsafe=true,$decide=false) { global $languages, $squirrelmail_language,$default_charset; if (is_array($string)) { $string = implode("\n", $string); } if (isset($languages[$squirrelmail_language]['XTRA_CODE']) && - function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_decodeheader')) { + function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_decodeheader')) { $string = call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_decodeheader', $string); // Do we need to return at this point? // return $string; @@ -628,7 +786,7 @@ function decodeHeader ($string, $utfencode=true,$htmlsave=true,$decide=false) { while ($match = preg_match('/^(.*)=\?([^?]*)\?(Q|B)\?([^?]*)\?=(.*)$/Ui',$chunk,$res)) { /* if the last chunk isn't an encoded string then put back the space, otherwise don't */ if ($iLastMatch !== $j) { - if ($htmlsave) { + if ($htmlsafe) { $ret .= ' '; } else { $ret .= ' '; @@ -636,7 +794,7 @@ function decodeHeader ($string, $utfencode=true,$htmlsave=true,$decide=false) { } $iLastMatch = $i; $j = $i; - if ($htmlsave) { + if ($htmlsafe) { $ret .= htmlspecialchars($res[1]); } else { $ret .= $res[1]; @@ -645,68 +803,68 @@ function decodeHeader ($string, $utfencode=true,$htmlsave=true,$decide=false) { /* decide about valid decoding */ if ($decide && is_conversion_safe($res[2])) { - $utfencode=true; - $can_be_encoded=true; + $utfencode=true; + $can_be_encoded=true; } else { - $can_be_encoded=false; + $can_be_encoded=false; } switch ($encoding) { - case 'B': - $replace = base64_decode($res[4]); - if ($utfencode) { - if ($can_be_encoded) { - /* convert string to different charset, - * if functions asks for it (usually in compose) - */ - $ret .= charset_convert($res[2],$replace,$default_charset); + case 'B': + $replace = base64_decode($res[4]); + if ($utfencode) { + if ($can_be_encoded) { + /* convert string to different charset, + * if functions asks for it (usually in compose) + */ + $ret .= charset_convert($res[2],$replace,$default_charset,$htmlsafe); + } else { + // convert string to html codes in order to display it + $ret .= charset_decode($res[2],$replace); + } } else { - // convert string to html codes in order to display it - $ret .= charset_decode($res[2],$replace); - } - } else { - if ($htmlsave) { - $replace = htmlspecialchars($replace); + if ($htmlsafe) { + $replace = htmlspecialchars($replace); + } + $ret.= $replace; } - $ret.= $replace; - } - break; - case 'Q': - $replace = str_replace('_', ' ', $res[4]); - $replace = preg_replace('/=([0-9a-f]{2})/ie', 'chr(hexdec("\1"))', - $replace); - if ($utfencode) { - if ($can_be_encoded) { - /* convert string to different charset, - * if functions asks for it (usually in compose) - */ - $replace = charset_convert($res[2], $replace,$default_charset); - } else { - // convert string to html codes in order to display it - $replace = charset_decode($res[2], $replace); - } - } else { - if ($htmlsave) { - $replace = htmlspecialchars($replace); + break; + case 'Q': + $replace = str_replace('_', ' ', $res[4]); + $replace = preg_replace('/=([0-9a-f]{2})/ie', 'chr(hexdec("\1"))', + $replace); + if ($utfencode) { + if ($can_be_encoded) { + /* convert string to different charset, + * if functions asks for it (usually in compose) + */ + $replace = charset_convert($res[2], $replace,$default_charset,$htmlsafe); + } else { + // convert string to html codes in order to display it + $replace = charset_decode($res[2], $replace); + } + } else { + if ($htmlsafe) { + $replace = htmlspecialchars($replace); + } } - } - $ret .= $replace; - break; - default: - break; + $ret .= $replace; + break; + default: + break; } $chunk = $res[5]; $encoded = true; } if (!$encoded) { - if ($htmlsave) { + if ($htmlsafe) { $ret .= ' '; } else { $ret .= ' '; } } - if (!$encoded && $htmlsave) { + if (!$encoded && $htmlsafe) { $ret .= htmlspecialchars($chunk); } else { $ret .= $chunk; @@ -715,7 +873,7 @@ function decodeHeader ($string, $utfencode=true,$htmlsave=true,$decide=false) { } /* remove the first added space */ if ($ret) { - if ($htmlsave) { + if ($htmlsafe) { $ret = substr($ret,5); } else { $ret = substr($ret,1); @@ -726,23 +884,44 @@ function decodeHeader ($string, $utfencode=true,$htmlsave=true,$decide=false) { } /** -* Encodes header as quoted-printable -* -* Encode a string according to RFC 1522 for use in headers if it -* contains 8-bit characters or anything that looks like it should -* be encoded. -* -* @param string $string header string, that has to be encoded -* @return string quoted-printable encoded string -*/ + * Encodes header + * + * Function uses XTRA_CODE _encodeheader function, if such function exists. + * + * Function uses Q encoding by default and encodes a string according to RFC + * 1522 for use in headers if it contains 8-bit characters or anything that + * looks like it should be encoded. + * + * Function switches to B encoding and encodeHeaderBase64() function, if + * string is 8bit and multibyte character set supported by mbstring extension + * is used. It can cause E_USER_NOTICE errors, if interface is used with + * multibyte character set unsupported by mbstring extension. + * + * @param string $string header string, that has to be encoded + * @return string quoted-printable encoded string + * @todo make $mb_charsets system wide constant + */ function encodeHeader ($string) { global $default_charset, $languages, $squirrelmail_language; if (isset($languages[$squirrelmail_language]['XTRA_CODE']) && - function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_encodeheader')) { + function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_encodeheader')) { return call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_encodeheader', $string); } + // Use B encoding for multibyte charsets + $mb_charsets = array('utf-8','big5','gb2313','euc-kr'); + if (in_array($default_charset,$mb_charsets) && + in_array($default_charset,sq_mb_list_encodings()) && + sq_is8bit($string)) { + return encodeHeaderBase64($string,$default_charset); + } elseif (in_array($default_charset,$mb_charsets) && + sq_is8bit($string) && + ! in_array($default_charset,sq_mb_list_encodings())) { + // Add E_USER_NOTICE error here (can cause 'Cannot add header information' warning in compose.php) + // trigger_error('encodeHeader: Multibyte character set unsupported by mbstring extension.',E_USER_NOTICE); + } + // Encode only if the string contains 8-bit characters or =? $j = strlen($string); $max_l = 75 - strlen($default_charset) - 7; @@ -753,43 +932,18 @@ function encodeHeader ($string) { for($i = 0; $i < $j; ++$i) { switch($string{$i}) { - case '=': - case '<': - case '>': - case ',': - case '?': - case '_': - if ($iEncStart === false) { - $iEncStart = $i; - } - $cur_l+=3; - if ($cur_l > ($max_l-2)) { - /* if there is an stringpart that doesn't need encoding, add it */ - $aRet[] = substr($string,$iOffset,$iEncStart-$iOffset); - $aRet[] = "=?$default_charset?Q?$ret?="; - $iOffset = $i; - $cur_l = 0; - $ret = ''; - $iEncStart = false; - } else { - $ret .= sprintf("=%02X",ord($string{$i})); - } - break; - case '(': - case ')': - if ($iEncStart !== false) { - $aRet[] = substr($string,$iOffset,$iEncStart-$iOffset); - $aRet[] = "=?$default_charset?Q?$ret?="; - $iOffset = $i; - $cur_l = 0; - $ret = ''; - $iEncStart = false; - } - break; - case ' ': - if ($iEncStart !== false) { - $cur_l++; - if ($cur_l > $max_l) { + case '=': + case '<': + case '>': + case ',': + case '?': + case '_': + if ($iEncStart === false) { + $iEncStart = $i; + } + $cur_l+=3; + if ($cur_l > ($max_l-2)) { + /* if there is an stringpart that doesn't need encoding, add it */ $aRet[] = substr($string,$iOffset,$iEncStart-$iOffset); $aRet[] = "=?$default_charset?Q?$ret?="; $iOffset = $i; @@ -797,50 +951,75 @@ function encodeHeader ($string) { $ret = ''; $iEncStart = false; } else { - $ret .= '_'; + $ret .= sprintf("=%02X",ord($string{$i})); } - } - break; - default: - $k = ord($string{$i}); - if ($k > 126) { - if ($iEncStart === false) { - // do not start encoding in the middle of a string, also take the rest of the word. - $sLeadString = substr($string,0,$i); - $aLeadString = explode(' ',$sLeadString); - $sToBeEncoded = array_pop($aLeadString); - $iEncStart = $i - strlen($sToBeEncoded); - $ret .= $sToBeEncoded; - $cur_l += strlen($sToBeEncoded); - } - $cur_l += 3; - /* first we add the encoded string that reached it's max size */ - if ($cur_l > ($max_l-2)) { + break; + case '(': + case ')': + if ($iEncStart !== false) { $aRet[] = substr($string,$iOffset,$iEncStart-$iOffset); - $aRet[] = "=?$default_charset?Q?$ret?= "; /* the next part is also encoded => separate by space */ - $cur_l = 3; - $ret = ''; + $aRet[] = "=?$default_charset?Q?$ret?="; $iOffset = $i; - $iEncStart = $i; + $cur_l = 0; + $ret = ''; + $iEncStart = false; } - $enc_init = true; - $ret .= sprintf("=%02X", $k); - } else { + break; + case ' ': if ($iEncStart !== false) { $cur_l++; if ($cur_l > $max_l) { $aRet[] = substr($string,$iOffset,$iEncStart-$iOffset); $aRet[] = "=?$default_charset?Q?$ret?="; - $iEncStart = false; $iOffset = $i; $cur_l = 0; $ret = ''; + $iEncStart = false; } else { - $ret .= $string{$i}; + $ret .= '_'; } } - } - break; + break; + default: + $k = ord($string{$i}); + if ($k > 126) { + if ($iEncStart === false) { + // do not start encoding in the middle of a string, also take the rest of the word. + $sLeadString = substr($string,0,$i); + $aLeadString = explode(' ',$sLeadString); + $sToBeEncoded = array_pop($aLeadString); + $iEncStart = $i - strlen($sToBeEncoded); + $ret .= $sToBeEncoded; + $cur_l += strlen($sToBeEncoded); + } + $cur_l += 3; + /* first we add the encoded string that reached it's max size */ + if ($cur_l > ($max_l-2)) { + $aRet[] = substr($string,$iOffset,$iEncStart-$iOffset); + $aRet[] = "=?$default_charset?Q?$ret?= "; /* the next part is also encoded => separate by space */ + $cur_l = 3; + $ret = ''; + $iOffset = $i; + $iEncStart = $i; + } + $enc_init = true; + $ret .= sprintf("=%02X", $k); + } else { + if ($iEncStart !== false) { + $cur_l++; + if ($cur_l > $max_l) { + $aRet[] = substr($string,$iOffset,$iEncStart-$iOffset); + $aRet[] = "=?$default_charset?Q?$ret?="; + $iEncStart = false; + $iOffset = $i; + $cur_l = 0; + $ret = ''; + } else { + $ret .= $string{$i}; + } + } + } + break; } } @@ -856,6 +1035,100 @@ function encodeHeader ($string) { return $string; } +/** + * Encodes string according to rfc2047 B encoding header formating rules + * + * It is recommended way to encode headers with character sets that store + * symbols in more than one byte. + * + * Function requires mbstring support. If required mbstring functions are missing, + * function returns false and sets E_USER_WARNING level error message. + * + * Minimal requirements - php 4.0.6 with mbstring extension. Please note, + * that mbstring functions will generate E_WARNING errors, if unsupported + * character set is used. mb_encode_mimeheader function provided by php + * mbstring extension is not used in order to get better control of header + * encoding. + * + * Used php code functions - function_exists(), trigger_error(), strlen() + * (is used with charset names and base64 strings). Used php mbstring + * functions - mb_strlen and mb_substr. + * + * Related documents: rfc 2045 (BASE64 encoding), rfc 2047 (mime header + * encoding), rfc 2822 (header folding) + * + * @param string $string header string that must be encoded + * @param string $charset character set. Must be supported by mbstring extension. + * Use sq_mb_list_encodings() to detect supported charsets. + * @return string string encoded according to rfc2047 B encoding formating rules + * @since 1.5.1 + * @todo First header line can be wrapped to $iMaxLength - $HeaderFieldLength - 1 + * @todo Do we want to control max length of header? + * @todo Do we want to control EOL (end-of-line) marker? + * @todo Do we want to translate error message? + */ +function encodeHeaderBase64($string,$charset) { + /** + * Check mbstring function requirements. + */ + if (! function_exists('mb_strlen') || + ! function_exists('mb_substr')) { + // set E_USER_WARNING + trigger_error('encodeHeaderBase64: Required mbstring functions are missing.',E_USER_WARNING); + // return false + return false; + } + + // initial return array + $aRet = array(); + + /** + * header length = 75 symbols max (same as in encodeHeader) + * remove $charset length + * remove =? ? ?= (5 chars) + * remove 2 more chars (\r\n ?) + */ + $iMaxLength = 75 - strlen($charset) - 7; + + // set first character position + $iStartCharNum = 0; + + // loop through all characters. count characters and not bytes. + for ($iCharNum=1; $iCharNum<=mb_strlen($string,$charset); $iCharNum++) { + // encode string from starting character to current character. + $encoded_string = base64_encode(mb_substr($string,$iStartCharNum,$iCharNum-$iStartCharNum,$charset)); + + // Check encoded string length + if(strlen($encoded_string)>$iMaxLength) { + // if string exceeds max length, reduce number of encoded characters and add encoded string part to array + $aRet[] = base64_encode(mb_substr($string,$iStartCharNum,$iCharNum-$iStartCharNum-1,$charset)); + + // set new starting character + $iStartCharNum = $iCharNum-1; + + // encode last char (in case it is last character in string) + $encoded_string = base64_encode(mb_substr($string,$iStartCharNum,$iCharNum-$iStartCharNum,$charset)); + } // if string is shorter than max length - add next character + } + + // add last encoded string to array + $aRet[] = $encoded_string; + + // set initial return string + $sRet = ''; + + // loop through encoded strings + foreach($aRet as $string) { + // TODO: Do we want to control EOL (end-of-line) marker + if ($sRet!='') $sRet.= " "; + + // add header tags and encoded string to return string + $sRet.= '=?'.$charset.'?B?'.$string.'?='; + } + + return $sRet; +} + /* This function trys to locate the entity_id of a specific mime element */ function find_ent_id($id, $message) { for ($i = 0, $ret = ''; $ret == '' && $i < count($message->entities); $i++) { @@ -864,7 +1137,7 @@ function find_ent_id($id, $message) { } else { if (strcasecmp($message->entities[$i]->header->id, $id) == 0) { // if (sq_check_save_extension($message->entities[$i])) { - return $message->entities[$i]->entity_id; + return $message->entities[$i]->entity_id; // } } elseif (!empty($message->entities[$i]->header->parameters['name'])) { /** @@ -890,55 +1163,144 @@ function sq_check_save_extension($message) { /** -** HTMLFILTER ROUTINES -*/ + ** HTMLFILTER ROUTINES + */ /** -* This function is more or less a wrapper around stripslashes. Apparently -* Explorer is stupid enough to just remove the backslashes and then -* execute the content of the attribute as if nothing happened. -* Who does that? -* -* @param attvalue The value of the attribute -* @return attvalue The value of the attribute stripslashed. -*/ -function sq_unbackslash($attvalue){ + * This function checks attribute values for entity-encoded values + * and returns them translated into 8-bit strings so we can run + * checks on them. + * + * @param $attvalue A string to run entity check against. + * @return Nothing, modifies a reference value. + */ +function sq_defang(&$attvalue){ + $me = 'sq_defang'; /** - * Remove any backslashes. See if there are any first. - */ - - if (strstr($attvalue, '\\') !== false){ - $attvalue = stripslashes($attvalue); + * Skip this if there aren't ampersands or backslashes. + */ + if (strpos($attvalue, '&') === false + && strpos($attvalue, '\\') === false){ + return; } - return $attvalue; + $m = false; + // before deent, translate the dangerous unicode characters and ... to safe values + // otherwise the regular expressions do not match. + + + + do { + $m = false; + $m = $m || sq_deent($attvalue, '/\�*(\d+);*/s'); + $m = $m || sq_deent($attvalue, '/\�*((\d|[a-f])+);*/si', true); + $m = $m || sq_deent($attvalue, '/\\\\(\d+)/s', true); + } while ($m == true); + $attvalue = stripslashes($attvalue); } /** -* Kill any tabs, newlines, or carriage returns. Our friends the -* makers of the browser with 95% market value decided that it'd -* be funny to make "java[tab]script" be just as good as "javascript". -* -* @param attvalue The attribute value before extraneous spaces removed. -* @return attvalue The attribute value after extraneous spaces removed. -*/ -function sq_unspace($attvalue){ - if (strcspn($attvalue, "\t\r\n") != strlen($attvalue)){ - $attvalue = str_replace(Array("\t", "\r", "\n"), Array('', '', ''), - $attvalue); + * Kill any tabs, newlines, or carriage returns. Our friends the + * makers of the browser with 95% market value decided that it'd + * be funny to make "java[tab]script" be just as good as "javascript". + * + * @param attvalue The attribute value before extraneous spaces removed. + * @return attvalue Nothing, modifies a reference value. + */ +function sq_unspace(&$attvalue){ + $me = 'sq_unspace'; + if (strcspn($attvalue, "\t\r\n\0 ") != strlen($attvalue)){ + $attvalue = str_replace(Array("\t", "\r", "\n", "\0", " "), + Array('', '', '', '', ''), $attvalue); } - return $attvalue; } /** -* This function returns the final tag out of the tag name, an array -* of attributes, and the type of the tag. This function is called by -* sq_sanitize internally. -* -* @param $tagname the name of the tag. -* @param $attary the array of attributes and their values -* @param $tagtype The type of the tag (see in comments). -* @return a string with the final tag representation. -*/ + * Translate all dangerous Unicode or Shift_JIS characters which are accepted by + * IE as regular characters. + * + * @param attvalue The attribute value before dangerous characters are translated. + * @return attvalue Nothing, modifies a reference value. + * @author Marc Groot Koerkamp. + */ +function sq_fixIE_idiocy(&$attvalue) { + // remove NUL + $attvalue = str_replace("\0", "", $attvalue); + // remove comments + $attvalue = preg_replace("/(\/\*.*?\*\/)/","",$attvalue); + + // IE has the evil habit of accepting every possible value for the attribute expression. + // The table below contains characters which are parsed by IE if they are used in the "expression" + // attribute value. + $aDangerousCharsReplacementTable = array( + array('ʟ', 'ʟ' ,/* L UNICODE IPA Extension */ + 'ʀ', 'ʀ' ,/* R UNICODE IPA Extension */ + 'ɴ', 'ɴ' ,/* N UNICODE IPA Extension */ + 'E', 'E' ,/* Unicode FULLWIDTH LATIN CAPITAL LETTER E */ + 'e', 'e' ,/* Unicode FULLWIDTH LATIN SMALL LETTER E */ + 'X', 'X',/* Unicode FULLWIDTH LATIN CAPITAL LETTER X */ + 'x', 'x',/* Unicode FULLWIDTH LATIN SMALL LETTER X */ + 'P', 'P',/* Unicode FULLWIDTH LATIN CAPITAL LETTER P */ + 'p', 'p',/* Unicode FULLWIDTH LATIN SMALL LETTER P */ + 'R', 'R',/* Unicode FULLWIDTH LATIN CAPITAL LETTER R */ + 'r', 'r',/* Unicode FULLWIDTH LATIN SMALL LETTER R */ + 'S', 'S',/* Unicode FULLWIDTH LATIN CAPITAL LETTER S */ + 's', 's',/* Unicode FULLWIDTH LATIN SMALL LETTER S */ + 'I', 'I',/* Unicode FULLWIDTH LATIN CAPITAL LETTER I */ + 'i', 'i',/* Unicode FULLWIDTH LATIN SMALL LETTER I */ + 'O', 'O',/* Unicode FULLWIDTH LATIN CAPITAL LETTER O */ + 'o', 'o',/* Unicode FULLWIDTH LATIN SMALL LETTER O */ + 'N', 'N',/* Unicode FULLWIDTH LATIN CAPITAL LETTER N */ + 'n', 'n',/* Unicode FULLWIDTH LATIN SMALL LETTER N */ + 'L', 'L',/* Unicode FULLWIDTH LATIN CAPITAL LETTER L */ + 'l', 'l',/* Unicode FULLWIDTH LATIN SMALL LETTER L */ + 'U', 'U',/* Unicode FULLWIDTH LATIN CAPITAL LETTER U */ + 'u', 'u',/* Unicode FULLWIDTH LATIN SMALL LETTER U */ + 'ⁿ', 'ⁿ' ,/* Unicode SUPERSCRIPT LATIN SMALL LETTER N */ + "\xEF\xBC\xA5", /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER E */ // in unicode this is some Chinese char range + "\xEF\xBD\x85", /* Shift JIS FULLWIDTH LATIN SMALL LETTER E */ + "\xEF\xBC\xB8", /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER X */ + "\xEF\xBD\x98", /* Shift JIS FULLWIDTH LATIN SMALL LETTER X */ + "\xEF\xBC\xB0", /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER P */ + "\xEF\xBD\x90", /* Shift JIS FULLWIDTH LATIN SMALL LETTER P */ + "\xEF\xBC\xB2", /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER R */ + "\xEF\xBD\x92", /* Shift JIS FULLWIDTH LATIN SMALL LETTER R */ + "\xEF\xBC\xB3", /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER S */ + "\xEF\xBD\x93", /* Shift JIS FULLWIDTH LATIN SMALL LETTER S */ + "\xEF\xBC\xA9", /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER I */ + "\xEF\xBD\x89", /* Shift JIS FULLWIDTH LATIN SMALL LETTER I */ + "\xEF\xBC\xAF", /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER O */ + "\xEF\xBD\x8F", /* Shift JIS FULLWIDTH LATIN SMALL LETTER O */ + "\xEF\xBC\xAE", /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER N */ + "\xEF\xBD\x8E", /* Shift JIS FULLWIDTH LATIN SMALL LETTER N */ + "\xEF\xBC\xAC", /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER L */ + "\xEF\xBD\x8C", /* Shift JIS FULLWIDTH LATIN SMALL LETTER L */ + "\xEF\xBC\xB5", /* Shift JIS FULLWIDTH LATIN CAPITAL LETTER U */ + "\xEF\xBD\x95", /* Shift JIS FULLWIDTH LATIN SMALL LETTER U */ + "\xE2\x81\xBF", /* Shift JIS FULLWIDTH SUPERSCRIPT N */ + "\xCA\x9F", /* L UNICODE IPA Extension */ + "\xCA\x80", /* R UNICODE IPA Extension */ + "\xC9\xB4"), /* N UNICODE IPA Extension */ + array('l', 'l', 'r','r','n','n', + 'E','E','e','e','X','X','x','x','P','P','p','p','R','R','r','r','S','S','s','s','I','I', + 'i','i','O','O','o','o','N','N','n','n','L','L','l','l','U','U','u','u','n','n', + 'E','e','X','x','P','p','R','r','S','s','I','i','O','o','N','n','L','l','U','u','n','l','r','n')); + $attvalue = str_replace($aDangerousCharsReplacementTable[0],$aDangerousCharsReplacementTable[1],$attvalue); + + // Escapes are useful for special characters like "{}[]()'&. In other cases they are + // used for XSS. + $attvalue = preg_replace("/(\\\\)([a-zA-Z]{1})/",'$2',$attvalue); +} + +/** + * This function returns the final tag out of the tag name, an array + * of attributes, and the type of the tag. This function is called by + * sq_sanitize internally. + * + * @param $tagname the name of the tag. + * @param $attary the array of attributes and their values + * @param $tagtype The type of the tag (see in comments). + * @return a string with the final tag representation. + */ function sq_tagprint($tagname, $attary, $tagtype){ $me = 'sq_tagprint'; @@ -962,26 +1324,26 @@ function sq_tagprint($tagname, $attary, $tagtype){ } /** -* A small helper function to use with array_walk. Modifies a by-ref -* value and makes it lowercase. -* -* @param $val a value passed by-ref. -* @return void since it modifies a by-ref value. -*/ + * A small helper function to use with array_walk. Modifies a by-ref + * value and makes it lowercase. + * + * @param $val a value passed by-ref. + * @return void since it modifies a by-ref value. + */ function sq_casenormalize(&$val){ $val = strtolower($val); } /** -* This function skips any whitespace from the current position within -* a string and to the next non-whitespace value. -* -* @param $body the string -* @param $offset the offset within the string where we should start -* looking for the next non-whitespace character. -* @return the location within the $body where the next -* non-whitespace char is located. -*/ + * This function skips any whitespace from the current position within + * a string and to the next non-whitespace value. + * + * @param $body the string + * @param $offset the offset within the string where we should start + * looking for the next non-whitespace character. + * @return the location within the $body where the next + * non-whitespace char is located. + */ function sq_skipspace($body, $offset){ $me = 'sq_skipspace'; preg_match('/^(\s*)/s', substr($body, $offset), $matches); @@ -993,16 +1355,16 @@ function sq_skipspace($body, $offset){ } /** -* This function looks for the next character within a string. It's -* really just a glorified "strpos", except it catches if failures -* nicely. -* -* @param $body The string to look for needle in. -* @param $offset Start looking from this position. -* @param $needle The character/string to look for. -* @return location of the next occurance of the needle, or -* strlen($body) if needle wasn't found. -*/ + * This function looks for the next character within a string. It's + * really just a glorified "strpos", except it catches if failures + * nicely. + * + * @param $body The string to look for needle in. + * @param $offset Start looking from this position. + * @param $needle The character/string to look for. + * @return location of the next occurance of the needle, or + * strlen($body) if needle wasn't found. + */ function sq_findnxstr($body, $offset, $needle){ $me = 'sq_findnxstr'; $pos = strpos($body, $needle, $offset); @@ -1013,18 +1375,18 @@ function sq_findnxstr($body, $offset, $needle){ } /** -* This function takes a PCRE-style regexp and tries to match it -* within the string. -* -* @param $body The string to look for needle in. -* @param $offset Start looking from here. -* @param $reg A PCRE-style regex to match. -* @return Returns a false if no matches found, or an array -* with the following members: -* - integer with the location of the match within $body -* - string with whatever content between offset and the match -* - string with whatever it is we matched -*/ + * This function takes a PCRE-style regexp and tries to match it + * within the string. + * + * @param $body The string to look for needle in. + * @param $offset Start looking from here. + * @param $reg A PCRE-style regex to match. + * @return Returns a false if no matches found, or an array + * with the following members: + * - integer with the location of the match within $body + * - string with whatever content between offset and the match + * - string with whatever it is we matched + */ function sq_findnxreg($body, $offset, $reg){ $me = 'sq_findnxreg'; $matches = Array(); @@ -1041,19 +1403,19 @@ function sq_findnxreg($body, $offset, $reg){ } /** -* This function looks for the next tag. -* -* @param $body String where to look for the next tag. -* @param $offset Start looking from here. -* @return false if no more tags exist in the body, or -* an array with the following members: -* - string with the name of the tag -* - array with attributes and their values -* - integer with tag type (1, 2, or 3) -* - integer where the tag starts (starting "<") -* - integer where the tag ends (ending ">") -* first three members will be false, if the tag is invalid. -*/ + * This function looks for the next tag. + * + * @param $body String where to look for the next tag. + * @param $offset Start looking from here. + * @return false if no more tags exist in the body, or + * an array with the following members: + * - string with the name of the tag + * - array with attributes and their values + * - integer with tag type (1, 2, or 3) + * - integer where the tag starts (starting "<") + * - integer where the tag ends (ending ">") + * first three members will be false, if the tag is invalid. + */ function sq_getnxtag($body, $offset){ $me = 'sq_getnxtag'; if ($offset > strlen($body)){ @@ -1064,23 +1426,23 @@ function sq_getnxtag($body, $offset){ return false; } /** - * We are here: - * blah blah - * \---------^ - */ + * We are here: + * blah blah + * \---------^ + */ $pos = sq_skipspace($body, $lt+1); if ($pos >= strlen($body)){ return Array(false, false, false, $lt, strlen($body)); } /** - * There are 3 kinds of tags: - * 1. Opening tag, e.g.: - * - * 2. Closing tag, e.g.: - * - * 3. XHTML-style content-less tag, e.g.: - * - */ + * There are 3 kinds of tags: + * 1. Opening tag, e.g.: + * + * 2. Closing tag, e.g.: + * + * 3. XHTML-style content-less tag, e.g.: + * + */ $tagtype = false; switch (substr($body, $pos, 1)){ case '/': @@ -1089,8 +1451,8 @@ function sq_getnxtag($body, $offset){ break; case '!': /** - * A comment or an SGML declaration. - */ + * A comment or an SGML declaration. + */ if (substr($body, $pos+1, 2) == "--"){ $gt = strpos($body, "-->", $pos); if ($gt === false){ @@ -1106,17 +1468,18 @@ function sq_getnxtag($body, $offset){ break; default: /** - * Assume tagtype 1 for now. If it's type 3, we'll switch values - * later. - */ + * Assume tagtype 1 for now. If it's type 3, we'll switch values + * later. + */ $tagtype = 1; break; } + $tag_start = $pos; $tagname = ''; /** - * Look for next [\W-_], which will indicate the end of the tag name. - */ + * Look for next [\W-_], which will indicate the end of the tag name. + */ $regary = sq_findnxreg($body, $pos, "[^\w\-_]"); if ($regary == false){ return Array(false, false, false, $lt, strlen($body)); @@ -1125,20 +1488,20 @@ function sq_getnxtag($body, $offset){ $tagname = strtolower($tagname); /** - * $match can be either of these: - * '>' indicating the end of the tag entirely. - * '\s' indicating the end of the tag name. - * '/' indicating that this is type-3 xhtml tag. - * - * Whatever else we find there indicates an invalid tag. - */ + * $match can be either of these: + * '>' indicating the end of the tag entirely. + * '\s' indicating the end of the tag name. + * '/' indicating that this is type-3 xhtml tag. + * + * Whatever else we find there indicates an invalid tag. + */ switch ($match){ case '/': /** - * This is an xhtml-style tag with a closing / at the - * end, like so: . Check if it's followed - * by the closing bracket. If not, then this tag is invalid - */ + * This is an xhtml-style tag with a closing / at the + * end, like so: . Check if it's followed + * by the closing bracket. If not, then this tag is invalid + */ if (substr($body, $pos, 2) == "/>"){ $pos++; $tagtype = 3; @@ -1152,12 +1515,12 @@ function sq_getnxtag($body, $offset){ break; default: /** - * Check if it's whitespace - */ + * Check if it's whitespace + */ if (!preg_match('/\s/', $match)){ /** - * This is an invalid tag! Look for the next closing ">". - */ + * This is an invalid tag! Look for the next closing ">". + */ $gt = sq_findnxstr($body, $lt, ">"); return Array(false, false, false, $lt, $gt); } @@ -1165,32 +1528,33 @@ function sq_getnxtag($body, $offset){ } /** - * At this point we're here: - * - * \-------^ - * - * At this point we loop in order to find all attributes. - */ + * At this point we're here: + * + * \-------^ + * + * At this point we loop in order to find all attributes. + */ $attname = ''; + $atttype = false; $attary = Array(); while ($pos <= strlen($body)){ $pos = sq_skipspace($body, $pos); if ($pos == strlen($body)){ /** - * Non-closed tag. - */ + * Non-closed tag. + */ return Array(false, false, false, $lt, $pos); } /** - * See if we arrived at a ">" or "/>", which means that we reached - * the end of the tag. - */ + * See if we arrived at a ">" or "/>", which means that we reached + * the end of the tag. + */ $matches = Array(); if (preg_match("%^(\s*)(>|/>)%s", substr($body, $pos), $matches)) { /** - * Yep. So we did. - */ + * Yep. So we did. + */ $pos += strlen($matches{1}); if ($matches{2} == "/>"){ $tagtype = 3; @@ -1200,46 +1564,46 @@ function sq_getnxtag($body, $offset){ } /** - * There are several types of attributes, with optional - * [:space:] between members. - * Type 1: - * attrname[:space:]=[:space:]'CDATA' - * Type 2: - * attrname[:space:]=[:space:]"CDATA" - * Type 3: - * attr[:space:]=[:space:]CDATA - * Type 4: - * attrname - * - * We leave types 1 and 2 the same, type 3 we check for - * '"' and convert to """ if needed, then wrap in - * double quotes. Type 4 we convert into: - * attrname="yes". - */ + * There are several types of attributes, with optional + * [:space:] between members. + * Type 1: + * attrname[:space:]=[:space:]'CDATA' + * Type 2: + * attrname[:space:]=[:space:]"CDATA" + * Type 3: + * attr[:space:]=[:space:]CDATA + * Type 4: + * attrname + * + * We leave types 1 and 2 the same, type 3 we check for + * '"' and convert to """ if needed, then wrap in + * double quotes. Type 4 we convert into: + * attrname="yes". + */ $regary = sq_findnxreg($body, $pos, "[^:\w\-_]"); if ($regary == false){ /** - * Looks like body ended before the end of tag. - */ + * Looks like body ended before the end of tag. + */ return Array(false, false, false, $lt, strlen($body)); } list($pos, $attname, $match) = $regary; $attname = strtolower($attname); /** - * We arrived at the end of attribute name. Several things possible - * here: - * '>' means the end of the tag and this is attribute type 4 - * '/' if followed by '>' means the same thing as above - * '\s' means a lot of things -- look what it's followed by. - * anything else means the attribute is invalid. - */ + * We arrived at the end of attribute name. Several things possible + * here: + * '>' means the end of the tag and this is attribute type 4 + * '/' if followed by '>' means the same thing as above + * '\s' means a lot of things -- look what it's followed by. + * anything else means the attribute is invalid. + */ switch($match){ case '/': /** - * This is an xhtml-style tag with a closing / at the - * end, like so: . Check if it's followed - * by the closing bracket. If not, then this tag is invalid - */ + * This is an xhtml-style tag with a closing / at the + * end, like so: . Check if it's followed + * by the closing bracket. If not, then this tag is invalid + */ if (substr($body, $pos, 2) == "/>"){ $pos++; $tagtype = 3; @@ -1254,27 +1618,27 @@ function sq_getnxtag($body, $offset){ break; default: /** - * Skip whitespace and see what we arrive at. - */ + * Skip whitespace and see what we arrive at. + */ $pos = sq_skipspace($body, $pos); $char = substr($body, $pos, 1); /** - * Two things are valid here: - * '=' means this is attribute type 1 2 or 3. - * \w means this was attribute type 4. - * anything else we ignore and re-loop. End of tag and - * invalid stuff will be caught by our checks at the beginning - * of the loop. - */ + * Two things are valid here: + * '=' means this is attribute type 1 2 or 3. + * \w means this was attribute type 4. + * anything else we ignore and re-loop. End of tag and + * invalid stuff will be caught by our checks at the beginning + * of the loop. + */ if ($char == "="){ $pos++; $pos = sq_skipspace($body, $pos); /** - * Here are 3 possibilities: - * "'" attribute type 1 - * '"' attribute type 2 - * everything else is the content of tag type 3 - */ + * Here are 3 possibilities: + * "'" attribute type 1 + * '"' attribute type 2 + * everything else is the content of tag type 3 + */ $quot = substr($body, $pos, 1); if ($quot == "'"){ $regary = sq_findnxreg($body, $pos+1, "\'"); @@ -1294,28 +1658,28 @@ function sq_getnxtag($body, $offset){ $attary{$attname} = '"' . $attval . '"'; } else { /** - * These are hateful. Look for \s, or >. - */ + * These are hateful. Look for \s, or >. + */ $regary = sq_findnxreg($body, $pos, "[\s>]"); if ($regary == false){ return Array(false, false, false, $lt, strlen($body)); } list($pos, $attval, $match) = $regary; /** - * If it's ">" it will be caught at the top. - */ + * If it's ">" it will be caught at the top. + */ $attval = preg_replace("/\"/s", """, $attval); $attary{$attname} = '"' . $attval . '"'; } } else if (preg_match("|[\w/>]|", $char)) { /** - * That was attribute type 4. - */ + * That was attribute type 4. + */ $attary{$attname} = '"yes"'; } else { /** - * An illegal character. Find next '>' and return. - */ + * An illegal character. Find next '>' and return. + */ $gt = sq_findnxstr($body, $pos, ">"); return Array(false, false, false, $lt, $gt); } @@ -1323,72 +1687,54 @@ function sq_getnxtag($body, $offset){ } } /** - * The fact that we got here indicates that the tag end was never - * found. Return invalid tag indication so it gets stripped. - */ + * The fact that we got here indicates that the tag end was never + * found. Return invalid tag indication so it gets stripped. + */ return Array(false, false, false, $lt, strlen($body)); } /** -* This function checks attribute values for entity-encoded values -* and returns them translated into 8-bit strings so we can run -* checks on them. -* -* @param $attvalue A string to run entity check against. -* @return Translated value. -*/ - -function sq_deent($attvalue){ + * Translates entities into literal values so they can be checked. + * + * @param $attvalue the by-ref value to check. + * @param $regex the regular expression to check against. + * @param $hex whether the entites are hexadecimal. + * @return True or False depending on whether there were matches. + */ +function sq_deent(&$attvalue, $regex, $hex=false){ $me = 'sq_deent'; - /** - * See if we have to run the checks first. All entities must start - * with "&". - */ - if (strpos($attvalue, '&') === false){ - return $attvalue; - } - /** - * Check named entities first. - */ - $trans = get_html_translation_table(HTML_ENTITIES); - /** - * Leave " in, as it can mess us up. - */ - $trans = array_flip($trans); - unset($trans{'"'}); - while (list($ent, $val) = each($trans)){ - $attvalue = preg_replace('/' . $ent . '*/si', $val, $attvalue); - } - /** - * Now translate numbered entities from 1 to 255 if needed. - */ - if (strpos($attvalue, '#') !== false){ - $omit = Array(34, 39); - for ($asc = 256; $asc >= 0; $asc--){ - if (!in_array($asc, $omit)){ - $chr = chr($asc); - $octrule = '/\�*' . $asc . ';*/si'; - $hexrule = '/\�*' . dechex($asc) . ';*/si'; - $attvalue = preg_replace($octrule, $chr, $attvalue); - $attvalue = preg_replace($hexrule, $chr, $attvalue); + $ret_match = false; + // remove comments + //$attvalue = preg_replace("/(\/\*.*\*\/)/","",$attvalue); + preg_match_all($regex, $attvalue, $matches); + if (is_array($matches) && sizeof($matches[0]) > 0){ + $repl = Array(); + for ($i = 0; $i < sizeof($matches[0]); $i++){ + $numval = $matches[1][$i]; + if ($hex){ + $numval = hexdec($numval); } + $repl{$matches[0][$i]} = chr($numval); } + $attvalue = strtr($attvalue, $repl); + return true; + } else { + return false; } - return $attvalue; } /** -* This function runs various checks against the attributes. -* -* @param $tagname String with the name of the tag. -* @param $attary Array with all tag attributes. -* @param $rm_attnames See description for sq_sanitize -* @param $bad_attvals See description for sq_sanitize -* @param $add_attr_to_tag See description for sq_sanitize -* @param $message message object -* @param $id message id -* @return Array with modified attributes. -*/ + * This function runs various checks against the attributes. + * + * @param $tagname String with the name of the tag. + * @param $attary Array with all tag attributes. + * @param $rm_attnames See description for sq_sanitize + * @param $bad_attvals See description for sq_sanitize + * @param $add_attr_to_tag See description for sq_sanitize + * @param $message message object + * @param $id message id + * @return Array with modified attributes. + */ function sq_fixatts($tagname, $attary, $rm_attnames, @@ -1401,8 +1747,8 @@ function sq_fixatts($tagname, $me = 'sq_fixatts'; while (list($attname, $attvalue) = each($attary)){ /** - * See if this attribute should be removed. - */ + * See if this attribute should be removed. + */ foreach ($rm_attnames as $matchtag=>$matchattrs){ if (preg_match($matchtag, $tagname)){ foreach ($matchattrs as $matchattr){ @@ -1414,75 +1760,76 @@ function sq_fixatts($tagname, } } /** - * Remove any backslashes, entities, and extraneous whitespace. - */ - $attvalue = sq_unbackslash($attvalue); - $attvalue = sq_deent($attvalue); - $attvalue = sq_unspace($attvalue); + * Workaround for IE quirks + */ + sq_fixIE_idiocy($attvalue); /** - * Remove \r \n \t \0 " " "\\" - */ - $attvalue = str_replace(Array("\r", "\n", "\t", "\0", " ", "\\"), - Array('', '','','','',''), $attvalue); + * Remove any backslashes, entities, and extraneous whitespace. + */ + + $oldattvalue = $attvalue; + sq_defang($attvalue); + if ($attname == 'style' && $attvalue !== $oldattvalue) { + // entities are used in the attribute value. In 99% of the cases it's there as XSS + // i.e.
+ $attvalue = "idiocy"; + $attary{$attname} = $attvalue; + } + sq_unspace($attvalue); /** - * Now let's run checks on the attvalues. - * I don't expect anyone to comprehend this. If you do, - * get in touch with me so I can drive to where you live and - * shake your hand personally. :) - */ + * Now let's run checks on the attvalues. + * I don't expect anyone to comprehend this. If you do, + * get in touch with me so I can drive to where you live and + * shake your hand personally. :) + */ foreach ($bad_attvals as $matchtag=>$matchattrs){ if (preg_match($matchtag, $tagname)){ foreach ($matchattrs as $matchattr=>$valary){ if (preg_match($matchattr, $attname)){ /** - * There are two arrays in valary. - * First is matches. - * Second one is replacements - */ + * There are two arrays in valary. + * First is matches. + * Second one is replacements + */ list($valmatch, $valrepl) = $valary; $newvalue = preg_replace($valmatch, $valrepl, $attvalue); if ($newvalue != $attvalue){ $attary{$attname} = $newvalue; + $attvalue = $newvalue; } } } } } - - - /** - * Replace empty src tags with the blank image. src is only used - * for frames, images, and image inputs. Doing a replace should - * not affect them working as should be, however it will stop - * IE from being kicked off when src for img tags are not set - */ - if (($attname == 'src') && ($attvalue == '""')) { - $attary{$attname} = '"' . SM_PATH . 'images/blank.png"'; - } - - /** - * Turn cid: urls into http-friendly ones. - */ - if (preg_match("/^[\'\"]\s*cid:/si", $attvalue)){ - $attary{$attname} = sq_cid2http($message, $id, $attvalue, $mailbox); + if ($attname == 'style') { + if (preg_match('/[\0-\37\200-\377]+/',$attvalue)) { + // 8bit and control characters in style attribute values can be used for XSS, remove them + $attary{$attname} = '"disallowed character"'; + } + preg_match_all("/url\s*\((.+)\)/si",$attvalue,$aMatch); + if (count($aMatch)) { + foreach($aMatch[1] as $sMatch) { + // url value + $urlvalue = $sMatch; + sq_fix_url($attname, $urlvalue, $message, $id, $mailbox,"'"); + $attary{$attname} = str_replace($sMatch,$urlvalue,$attvalue); + } + } } - /** - * "Hack" fix for Outlook using propriatary outbind:// protocol in img tags. - * One day MS might actually make it match something useful, for now, falling - * back to using cid2http, so we can grab the blank.png. + * Use white list based filtering on attributes which can contain url's */ - if (preg_match("/^[\'\"]\s*outbind:\/\//si", $attvalue)) { - $attary{$attname} = sq_cid2http($message, $id, $attvalue, $mailbox); + else if ($attname == 'href' || $attname == 'src' || $attname == 'background') { + sq_fix_url($attname, $attvalue, $message, $id, $mailbox); + $attary{$attname} = $attvalue; } - } /** - * See if we need to append any attributes to this tag. - */ + * See if we need to append any attributes to this tag. + */ foreach ($add_attr_to_tag as $matchtag=>$addattary){ if (preg_match($matchtag, $tagname)){ $attary = array_merge($attary, $addattary); @@ -1492,84 +1839,263 @@ function sq_fixatts($tagname, } /** -* This function edits the style definition to make them friendly and -* usable in SquirrelMail. -* -* @param $message the message object -* @param $id the message id -* @param $content a string with whatever is between -* @param $mailbox the message mailbox -* @return a string with edited content. -*/ + * This function filters url's + * + * @param $attvalue String with attribute value to filter + * @param $message message object + * @param $id message id + * @param $mailbox mailbox + * @param $sQuote quoting characters around url's + */ +function sq_fix_url($attname, &$attvalue, $message, $id, $mailbox,$sQuote = '"') { + $attvalue = trim($attvalue); + if ($attvalue && ($attvalue[0] =='"'|| $attvalue[0] == "'")) { + // remove the double quotes + $sQuote = $attvalue[0]; + $attvalue = trim(substr($attvalue,1,-1)); + } + + // If there's no "view_unsafe_images" variable in the URL, turn unsafe + // images off by default. + // FIXME: Update this code to use the default value FALSE. + if( !sqgetGlobalVar('view_unsafe_images', $view_unsafe_images, SQ_GET) ) { + $view_unsafe_images = false; + } + + $secremoveimg = '../images/' . _("sec_remove_eng.png"); + + /** + * Replace empty src tags with the blank image. src is only used + * for frames, images, and image inputs. Doing a replace should + * not affect them working as should be, however it will stop + * IE from being kicked off when src for img tags are not set + */ + if ($attvalue == '') { + $attvalue = '"' . SM_PATH . 'images/blank.png"'; + } else { + // first, disallow 8 bit characters and control characters + if (preg_match('/[\0-\37\200-\377]+/',$attvalue)) { + switch ($attname) { + case 'href': + $attvalue = $sQuote . 'http://invalid-stuff-detected.example.com' . $sQuote; + break; + default: + $attvalue = $sQuote . SM_PATH . 'images/blank.png'. $sQuote; + break; + } + } else { + $aUrl = parse_url($attvalue); + if (isset($aUrl['scheme'])) { + switch(strtolower($aUrl['scheme'])) { + case 'mailto': + case 'http': + case 'https': + case 'ftp': + if ($attname != 'href') { + if ($view_unsafe_images == false) { + $attvalue = $sQuote . $secremoveimg . $sQuote; + } else { + if (isset($aUrl['path'])) { + // validate image extension. + $ext = strtolower(substr($aUrl['path'],strrpos($aUrl['path'],'.'))); + if (!in_array($ext,array('.jpeg','.jpg','xjpeg','.gif','.bmp','.jpe','.png','.xbm'))) { + $attvalue = $sQuote . SM_PATH . 'images/blank.png'. $sQuote; + } + } else { + $attvalue = $sQuote . SM_PATH . 'images/blank.png'. $sQuote; + } + } + } + break; + case 'outbind': + /** + * "Hack" fix for Outlook using propriatary outbind:// protocol in img tags. + * One day MS might actually make it match something useful, for now, falling + * back to using cid2http, so we can grab the blank.png. + */ + $attvalue = sq_cid2http($message, $id, $attvalue, $mailbox); + break; + case 'cid': + /** + * Turn cid: urls into http-friendly ones. + */ + $attvalue = sq_cid2http($message, $id, $attvalue, $mailbox); + break; + default: + $attvalue = $sQuote . SM_PATH . 'images/blank.png' . $sQuote; + break; + } + } else { + if (!(isset($aUrl['path']) && $aUrl['path'] == $secremoveimg)) { + // parse_url did not lead to satisfying result + $attvalue = $sQuote . SM_PATH . 'images/blank.png' . $sQuote; + } + } + } + } +} + +/** + * This function edits the style definition to make them friendly and + * usable in SquirrelMail. + * + * @param $message the message object + * @param $id the message id + * @param $content a string with whatever is between + * @param $mailbox the message mailbox + * @return a string with edited content. + */ function sq_fixstyle($body, $pos, $message, $id, $mailbox){ - global $view_unsafe_images; $me = 'sq_fixstyle'; - $ret = sq_findnxreg($body, $pos, ''); - if ($ret == FALSE){ + // workaround for in between comments + $iCurrentPos = $pos; + $content = ''; + $sToken = ''; + $bSucces = false; + $bEndTag = false; + for ($i=$pos,$iCount=strlen($body);$i<$iCount;++$i) { + $char = $body{$i}; + switch ($char) { + case '<': + $sToken = $char; + break; + case '/': + if ($sToken == '<') { + $sToken .= $char; + $bEndTag = true; + } else { + $content .= $char; + } + break; + case '>': + if ($bEndTag) { + $sToken .= $char; + if (preg_match('/\<\/\s*style\s*\>/i',$sToken,$aMatch)) { + $newpos = $i + 1; + $bSucces = true; + break 2; + } else { + $content .= $sToken; + } + $bEndTag = false; + } else { + $content .= $char; + } + break; + case '!': + if ($sToken == '<') { + // possible comment + if (isset($body{$i+2}) && substr($body,$i,3) == '!--') { + $i = strpos($body,'-->',$i+3); + if ($i === false) { // no end comment + $i = strlen($body); + } + $sToken = ''; + } + } else { + $content .= $char; + } + break; + default: + if ($bEndTag) { + $sToken .= $char; + } else { + $content .= $char; + } + break; + } + } + if ($bSucces == FALSE){ return array(FALSE, strlen($body)); } - $newpos = $ret[0] + strlen($ret[2]); - $content = $ret[1]; + + + /** - * First look for general BODY style declaration, which would be - * like so: - * body {background: blah-blah} - * and change it to .bodyclass so we can just assign it to a
- */ + * First look for general BODY style declaration, which would be + * like so: + * body {background: blah-blah} + * and change it to .bodyclass so we can just assign it to a
+ */ $content = preg_replace("|body(\s*\{.*?\})|si", ".bodyclass\\1", $content); $secremoveimg = '../images/' . _("sec_remove_eng.png"); /** * Fix url('blah') declarations. */ - $content = preg_replace("|url\s*\(\s*([\'\"])\s*\S+script\s*:.*?([\'\"])\s*\)|si", - "url(\\1$secremoveimg\\2)", $content); - /** - * Fix url('https*://.*) declarations but only if $view_unsafe_images - * is false. - */ - if (!$view_unsafe_images){ - $content = preg_replace("|url\s*\(\s*([\'\"])\s*https*:.*?([\'\"])\s*\)|si", - "url(\\1$secremoveimg\\2)", $content); + // $content = preg_replace("|url\s*\(\s*([\'\"])\s*\S+script\s*:.*?([\'\"])\s*\)|si", + // "url(\\1$secremoveimg\\2)", $content); + + // first check for 8bit sequences and disallowed control characters + if (preg_match('/[\16-\37\200-\377]+/',$content)) { + $content = ''; + return array($content, $newpos); } - /** - * Fix urls that refer to cid: - */ - while (preg_match("|url\s*\(\s*([\'\"]\s*cid:.*?[\'\"])\s*\)|si", - $content, $matches)){ - $cidurl = $matches{1}; - $httpurl = sq_cid2http($message, $id, $cidurl, $mailbox); - $content = preg_replace("|url\s*\(\s*$cidurl\s*\)|si", - "url($httpurl)", $content); + // IE Sucks hard. We have a special function for it. + sq_fixIE_idiocy($content); + + // remove @import line + $content = preg_replace("/^\s*(@import.*)$/mi","\n\n",$content); + + // translate ur\l and variations (IE parses that) + // TODO check if the sq_fixIE_idiocy function already handles this. + $content = preg_replace("/(\\\\)?u(\\\\)?r(\\\\)?l(\\\\)?/i", 'url', $content); + preg_match_all("/url\s*\((.+)\)/si",$content,$aMatch); + if (count($aMatch)) { + $aValue = $aReplace = array(); + foreach($aMatch[1] as $sMatch) { + // url value + $urlvalue = $sMatch; + sq_fix_url('style',$urlvalue, $message, $id, $mailbox,"'"); + $aValue[] = $sMatch; + $aReplace[] = $urlvalue; + } + $content = str_replace($aValue,$aReplace,$content); } /** - * Fix stupid css declarations which lead to vulnerabilities - * in IE. - */ - $match = Array('/expression/i', + * Remove any backslashes, entities, and extraneous whitespace. + */ + $contentTemp = $content; + sq_defang($contentTemp); + sq_unspace($contentTemp); + + /** + * Fix stupid css declarations which lead to vulnerabilities + * in IE. + */ + $match = Array('/\/\*.*\*\//', + '/expression/i', '/behaviou*r/i', '/binding/i', - '/include-source/i'); - $replace = Array('idiocy', 'idiocy', 'idiocy', 'idiocy'); - $content = preg_replace($match, $replace, $content); + '/include-source/i', + '/javascript/i', + '/script/i'); + $replace = Array('','idiocy', 'idiocy', 'idiocy', 'idiocy', 'idiocy', 'idiocy'); + $contentNew = preg_replace($match, $replace, $contentTemp); + if ($contentNew !== $contentTemp) { + // insecure css declarations are used. From now on we don't care + // anymore if the css is destroyed by sq_deent, sq_unspace or sq_unbackslash + $content = $contentNew; + } return array($content, $newpos); } + /** -* This function converts cid: url's into the ones that can be viewed in -* the browser. -* -* @param $message the message object -* @param $id the message id -* @param $cidurl the cid: url. -* @param $mailbox the message mailbox -* @return a string with a http-friendly url -*/ + * This function converts cid: url's into the ones that can be viewed in + * the browser. + * + * @param $message the message object + * @param $id the message id + * @param $cidurl the cid: url. + * @param $mailbox the message mailbox + * @return a string with a http-friendly url + */ function sq_cid2http($message, $id, $cidurl, $mailbox){ /** - * Get rid of quotes. - */ + * Get rid of quotes. + */ $quotchar = substr($cidurl, 0, 1); if ($quotchar == '"' || $quotchar == "'"){ $cidurl = str_replace($quotchar, "", $cidurl); @@ -1577,19 +2103,24 @@ function sq_cid2http($message, $id, $cidurl, $mailbox){ $quotchar = ''; } $cidurl = substr(trim($cidurl), 4); + + $match_str = '/\{.*?\}\//'; + $str_rep = ''; + $cidurl = preg_replace($match_str, $str_rep, $cidurl); + $linkurl = find_ent_id($cidurl, $message); - /* in case of non-save cid links $httpurl should be replaced by a sort of - unsave link image */ + /* in case of non-safe cid links $httpurl should be replaced by a sort of + unsafe link image */ $httpurl = ''; - /** - * This is part of a fix for Outlook Express 6.x generating - * cid URLs without creating content-id headers. These images are - * not part of the multipart/related html mail. The html contains - * references to - * attached images with as goal to render them inline although - * the attachment disposition property is not inline. - **/ + /** + * This is part of a fix for Outlook Express 6.x generating + * cid URLs without creating content-id headers. These images are + * not part of the multipart/related html mail. The html contains + * references to + * attached images with as goal to render them inline although + * the attachment disposition property is not inline. + */ if (empty($linkurl)) { if (preg_match('/{.*}\//', $cidurl)) { @@ -1599,32 +2130,32 @@ function sq_cid2http($message, $id, $cidurl, $mailbox){ } } } - + if (!empty($linkurl)) { $httpurl = $quotchar . SM_PATH . 'src/download.php?absolute_dl=true&' . - "passed_id=$id&mailbox=" . urlencode($mailbox) . - '&ent_id=' . $linkurl . $quotchar; + "passed_id=$id&mailbox=" . urlencode($mailbox) . + '&ent_id=' . $linkurl . $quotchar; } else { /** * If we couldn't generate a proper img url, drop in a blank image * instead of sending back empty, otherwise it causes unusual behaviour */ - $httpurl = $quotchar . SM_PATH . 'images/blank.png'; + $httpurl = $quotchar . SM_PATH . 'images/blank.png' . $quotchar; } - + return $httpurl; } /** -* This function changes the tag into a
tag since we -* can't really have a body-within-body. -* -* @param $attary an array of attributes and values of -* @param $mailbox mailbox we're currently reading (for cid2http) -* @param $message current message (for cid2http) -* @param $id current message id (for cid2http) -* @return a modified array of attributes to be set for
-*/ + * This function changes the tag into a
tag since we + * can't really have a body-within-body. + * + * @param $attary an array of attributes and values of + * @param $mailbox mailbox we're currently reading (for cid2http) + * @param $message current message (for cid2http) + * @param $id current message id (for cid2http) + * @return a modified array of attributes to be set for
+ */ function sq_body2div($attary, $mailbox, $message, $id){ $me = 'sq_body2div'; $divattary = Array('class' => "'bodyclass'"); @@ -1637,8 +2168,7 @@ function sq_body2div($attary, $mailbox, $message, $id){ $attvalue = str_replace($quotchar, "", $attvalue); switch ($attname){ case 'background': - $attvalue = sq_cid2http($message, $id, - $attvalue, $mailbox); + $attvalue = sq_cid2http($message, $id, $attvalue, $mailbox); $styledef .= "background-image: url('$attvalue'); "; break; case 'bgcolor': @@ -1664,66 +2194,66 @@ function sq_body2div($attary, $mailbox, $message, $id){ } /** -* This is the main function and the one you should actually be calling. -* There are several variables you should be aware of an which need -* special description. -* -* Since the description is quite lengthy, see it here: -* http://linux.duke.edu/projects/mini/htmlfilter/ -* -* @param $body the string with HTML you wish to filter -* @param $tag_list see description above -* @param $rm_tags_with_content see description above -* @param $self_closing_tags see description above -* @param $force_tag_closing see description above -* @param $rm_attnames see description above -* @param $bad_attvals see description above -* @param $add_attr_to_tag see description above -* @param $message message object -* @param $id message id -* @return sanitized html safe to show on your pages. -*/ + * This is the main function and the one you should actually be calling. + * There are several variables you should be aware of an which need + * special description. + * + * Since the description is quite lengthy, see it here: + * http://linux.duke.edu/projects/mini/htmlfilter/ + * + * @param $body the string with HTML you wish to filter + * @param $tag_list see description above + * @param $rm_tags_with_content see description above + * @param $self_closing_tags see description above + * @param $force_tag_closing see description above + * @param $rm_attnames see description above + * @param $bad_attvals see description above + * @param $add_attr_to_tag see description above + * @param $message message object + * @param $id message id + * @return sanitized html safe to show on your pages. + */ function sq_sanitize($body, - $tag_list, - $rm_tags_with_content, - $self_closing_tags, - $force_tag_closing, - $rm_attnames, - $bad_attvals, - $add_attr_to_tag, - $message, - $id, - $mailbox - ){ + $tag_list, + $rm_tags_with_content, + $self_closing_tags, + $force_tag_closing, + $rm_attnames, + $bad_attvals, + $add_attr_to_tag, + $message, + $id, + $mailbox + ){ $me = 'sq_sanitize'; $rm_tags = array_shift($tag_list); /** - * Normalize rm_tags and rm_tags_with_content. - */ + * Normalize rm_tags and rm_tags_with_content. + */ @array_walk($tag_list, 'sq_casenormalize'); @array_walk($rm_tags_with_content, 'sq_casenormalize'); @array_walk($self_closing_tags, 'sq_casenormalize'); /** - * See if tag_list is of tags to remove or tags to allow. - * false means remove these tags - * true means allow these tags - */ + * See if tag_list is of tags to remove or tags to allow. + * false means remove these tags + * true means allow these tags + */ $curpos = 0; $open_tags = Array(); $trusted = "\n\n"; $skip_content = false; /** - * Take care of netscape's stupid javascript entities like - * &{alert('boo')}; - */ + * Take care of netscape's stupid javascript entities like + * &{alert('boo')}; + */ $body = preg_replace("/&(\{.*?\};)/si", "&\\1", $body); while (($curtag = sq_getnxtag($body, $curpos)) != FALSE){ list($tagname, $attary, $tagtype, $lt, $gt) = $curtag; $free_content = substr($body, $curpos, $lt-$curpos); /** - * Take care of
' . _("Body retrieval error. The reason for this is most probably that the message is malformed.") . @@ -157,80 +181,57 @@ function mime_fetch_body($imap_stream, $id, $ent_id=1, $fetch_size=0) { return $ret; } -function mime_print_body_lines ($imap_stream, $id, $ent_id=1, $encoding) { +function mime_print_body_lines ($imap_stream, $id, $ent_id=1, $encoding, $rStream='php://stdout') { /* Don't kill the connection if the browser is over a dialup - * and it would take over 30 seconds to download it. - * Don't call set_time_limit in safe mode. - */ + * and it would take over 30 seconds to download it. + * Don't call set_time_limit in safe mode. + */ if (!ini_get('safe_mode')) { set_time_limit(0); } /* in case of base64 encoded attachments, do not buffer them. - Instead, echo the decoded attachment directly to screen */ + Instead, echo the decoded attachment directly to screen */ if (strtolower($encoding) == 'base64') { if (!$ent_id) { - $query = "FETCH $id BODY[]"; + $query = "FETCH $id BODY[]"; } else { - $query = "FETCH $id BODY[$ent_id]"; + $query = "FETCH $id BODY[$ent_id]"; } - sqimap_run_command($imap_stream,$query,true,$response,$message,TRUE,'sqimap_base64_decode','php://stdout',true); + sqimap_run_command($imap_stream,$query,true,$response,$message,TRUE,'sqimap_base64_decode',$rStream,true); } else { - $body = mime_fetch_body ($imap_stream, $id, $ent_id); - echo decodeBody($body, $encoding); + $body = mime_fetch_body ($imap_stream, $id, $ent_id); + if (is_resource($rStream)) { + fputs($rStream,decodeBody($body,$encoding)); + } else { + echo decodeBody($body, $encoding); + } } /* - TODO, use the same method for quoted printable. - However, I assume that quoted printable attachments aren't that large - so the performancegain / memory usage drop will be minimal. - If we decide to add that then we need to adapt sqimap_fread because - we need to split te result on \n and fread doesn't stop at \n. That - means we also should provide $results from sqimap_fread (by ref) to - te function and set $no_return to false. The $filter function for - quoted printable should handle unsetting of $results. - */ + TODO, use the same method for quoted printable. + However, I assume that quoted printable attachments aren't that large + so the performancegain / memory usage drop will be minimal. + If we decide to add that then we need to adapt sqimap_fread because + we need to split te result on \n and fread doesn't stop at \n. That + means we also should provide $results from sqimap_fread (by ref) to + te function and set $no_return to false. The $filter function for + quoted printable should handle unsetting of $results. + */ /* - TODO 2: find out how we write to the output stream php://stdout. fwrite - doesn't work because 'php://stdout isn't a stream. - */ + TODO 2: find out how we write to the output stream php://stdout. fwrite + doesn't work because 'php://stdout isn't a stream. + */ return; -/* - fputs ($imap_stream, "$sid FETCH $id BODY[$ent_id]\r\n"); - $cnt = 0; - $continue = true; - $read = fgets ($imap_stream,8192); - - - // This could be bad -- if the section has sqimap_session_id() . ' OK' - // or similar, it will kill the download. - while (!ereg("^".$sid_s." (OK|BAD|NO)(.*)$", $read, $regs)) { - if (trim($read) == ')==') { - $read1 = $read; - $read = fgets ($imap_stream,4096); - if (ereg("^".$sid." (OK|BAD|NO)(.*)$", $read, $regs)) { - return; - } else { - echo decodeBody($read1, $encoding) . - decodeBody($read, $encoding); - } - } else if ($cnt) { - echo decodeBody($read, $encoding); - } - $read = fgets ($imap_stream,4096); - $cnt++; -// break; - } -*/ } /* -[ END MIME DECODING ]----------------------------------------------------------- */ /* This is here for debugging purposes. It will print out a list -* of all the entity IDs that are in the $message object. -*/ + * of all the entity IDs that are in the $message object. + */ function listEntities ($message) { if ($message) { echo "" . $message->entity_id . ' : ' . $message->type0 . '/' . $message->type1 . ' parent = '. $message->parent->entity_id. '
'; @@ -279,14 +280,14 @@ function getEntity ($message, $ent_id) { } /* translateText -* Extracted from strings.php 23/03/2002 -*/ + * Extracted from strings.php 23/03/2002 + */ function translateText(&$body, $wrap_at, $charset) { global $where, $what; /* from searching */ global $color; /* color theme */ - require_once(SM_PATH . 'functions/url_parser.php'); + // require_once(SM_PATH . 'functions/url_parser.php'); $body_ary = explode("\n", $body); for ($i=0; $i < count($body_ary); $i++) { @@ -315,15 +316,9 @@ function translateText(&$body, $wrap_at, $charset) { } if ($quotes % 2) { - if (!isset($color[13])) { - $color[13] = '#800000'; - } - $line = '' . $line . ''; + $line = '' . $line . ''; } elseif ($quotes) { - if (!isset($color[14])) { - $color[14] = '#FF0000'; - } - $line = '' . $line . ''; + $line = '' . $line . ''; } $body_ary[$i] = $line; @@ -332,20 +327,41 @@ function translateText(&$body, $wrap_at, $charset) { } /** -* This returns a parsed string called $body. That string can then -* be displayed as the actual message in the HTML. It contains -* everything needed, including HTML Tags, Attachments at the -* bottom, etc. -* @param clean Do not output stuff that's irrelevant for the printable version. -*/ + * This returns a parsed string called $body. That string can then + * be displayed as the actual message in the HTML. It contains + * everything needed, including HTML Tags, Attachments at the + * bottom, etc. + * + * Since 1.2.0 function uses message_body hook. + * Till 1.3.0 function included output of formatAttachments(). + * + * @param resource $imap_stream imap connection resource + * @param object $message squirrelmail message object + * @param array $color squirrelmail color theme array + * @param integer $wrap_at number of characters per line + * @param string $ent_num (since 1.3.0) message part id + * @param integer $id (since 1.3.0) message id + * @param string $mailbox (since 1.3.0) imap folder name + * @param boolean $clean (since 1.5.1) Do not output stuff that's irrelevant for the printable version. + * @return string html formated message text + */ function formatBody($imap_stream, $message, $color, $wrap_at, $ent_num, $id, $mailbox='INBOX', $clean=FALSE) { /* This if statement checks for the entity to show as the - * primary message. To add more of them, just put them in the - * order that is their priority. - */ + * primary message. To add more of them, just put them in the + * order that is their priority. + */ global $startMessage, $languages, $squirrelmail_language, - $show_html_default, $sort, $has_unsafe_images, $passed_ent_id; + $show_html_default, $sort, $has_unsafe_images, $passed_ent_id, + $use_iframe, $iframe_height, $download_and_unsafe_link, + $download_href, $unsafe_image_toggle_href, $unsafe_image_toggle_text, + $oTemplate, $nbsp; + + // workaround for not updated config.php + if (! isset($use_iframe)) $use_iframe = false; + // If there's no "view_unsafe_images" variable in the URL, turn unsafe + // images off by default. + // FIXME: Update this code to use the default value FALSE. if( !sqgetGlobalVar('view_unsafe_images', $view_unsafe_images, SQ_GET) ) { $view_unsafe_images = false; } @@ -354,45 +370,80 @@ function formatBody($imap_stream, $message, $color, $wrap_at, $ent_num, $id, $ma $urlmailbox = urlencode($mailbox); $body_message = getEntity($message, $ent_num); if (($body_message->header->type0 == 'text') || - ($body_message->header->type0 == 'rfc822')) { + ($body_message->header->type0 == 'rfc822')) { $body = mime_fetch_body ($imap_stream, $id, $ent_num); $body = decodeBody($body, $body_message->header->encoding); if (isset($languages[$squirrelmail_language]['XTRA_CODE']) && - function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_decode')) { + function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_decode')) { if (mb_detect_encoding($body) != 'ASCII') { $body = call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_decode',$body); } } - $hookResults = do_hook("message_body", $body); - $body = $hookResults[1]; + + /* As of 1.5.2, $body is passed (and modified) by reference */ + do_hook('message_body', $body); /* If there are other types that shouldn't be formatted, add - * them here. - */ + * them here. + */ if ($body_message->header->type1 == 'html') { if ($show_html_default <> 1) { $entity_conv = array(' ' => ' ', - '

' => "\n", - '

' => "\n", - '
' => "\n", - '
' => "\n", - '
' => "\n", - '
' => "\n", - '>' => '>', - '<' => '<'); + '

' => "\n", + '

' => "\n", + '
' => "\n", + '
' => "\n", + '
' => "\n", + '
' => "\n", + '>' => '>', + '<' => '<'); $body = strtr($body, $entity_conv); $body = strip_tags($body); $body = trim($body); translateText($body, $wrap_at, - $body_message->header->getParameter('charset')); + $body_message->header->getParameter('charset')); + } elseif ($use_iframe && ! $clean) { + // $clean is used to remove iframe in printable view. + + /** + * If we don't add html message between iframe tags, + * we must detect unsafe images and modify $has_unsafe_images. + */ + $html_body = magicHTML($body, $id, $message, $mailbox); + // Convert character set in order to display html mails in different character set + $html_body = charset_decode($body_message->header->getParameter('charset'),$html_body,false,true); + + // creating iframe url + $iframeurl=sqm_baseuri().'src/view_html.php?' + . 'mailbox=' . $urlmailbox + . '&passed_id=' . $id + . '&ent_id=' . $ent_num + . '&view_unsafe_images=' . (int) $view_unsafe_images; + + global $oTemplate; + $oTemplate->assign('iframe_url', $iframeurl); + $oTemplate->assign('iframe_height', $iframe_height); + $oTemplate->assign('html_body', $html_body); + + $body = $oTemplate->fetch('read_html_iframe.tpl'); } else { + // old way of html rendering + /** + * convert character set. charset_decode does not remove html special chars + * applied by magicHTML functions and does not sanitize them second time if + * fourth argument is true. + */ + $charset = $body_message->header->getParameter('charset'); + if (!empty($charset)) { + $body = charset_decode($charset,$body,false,true); + } $body = magicHTML($body, $id, $message, $mailbox); } } else { translateText($body, $wrap_at, - $body_message->header->getParameter('charset')); + $body_message->header->getParameter('charset')); } // if this is the clean display (i.e. printer friendly), stop here. @@ -400,14 +451,37 @@ function formatBody($imap_stream, $message, $color, $wrap_at, $ent_num, $id, $ma return $body; } + /* + * Previously the links for downloading and unsafe images were printed + * under the mail. By putting the links in a global variable we can + * print it in the toolbar where it belongs. Since the original code was + * in this place it's left here. It might be possible to move it to some + * other place if that makes sense. The possibility to do so has not + * been evaluated yet. + */ + + // Initialize the global variable to an empty string. + // FIXME: To have $download_and_unsafe_link as a global variable might not be needed since the use of separate variables ($download_href, $unsafe_image_toggle_href, and $unsafe_image_toggle_text) for the templates was introduced. + $download_and_unsafe_link = ''; + + // Prepare and build a link for downloading the mail. $link = 'passed_id=' . $id . '&ent_id='.$ent_num. - '&mailbox=' . $urlmailbox .'&sort=' . $sort . - '&startMessage=' . $startMessage . '&show_more=0'; + '&mailbox=' . $urlmailbox .'&sort=' . $sort . + '&startMessage=' . $startMessage . '&show_more=0'; if (isset($passed_ent_id)) { $link .= '&passed_ent_id='.$passed_ent_id; } - $body .= '

' . _("Download this as a file") . ''; + $download_href = SM_PATH . 'src/download.php?absolute_dl=true&' . $link; + + // Always add the link for downloading the mail as a file to the global + // variable. + $download_and_unsafe_link .= "$nbsp|$nbsp" + . create_hyperlink($download_href, _("Download this as a file")); + + // Find out the right text to use in the link depending on the + // circumstances. If the unsafe images are displayed the link should + // hide them, if they aren't displayed the link should only appear if + // the mail really contains unsafe images. if ($view_unsafe_images) { $text = _("Hide Unsafe Images"); } else { @@ -418,37 +492,50 @@ function formatBody($imap_stream, $message, $color, $wrap_at, $ent_num, $id, $ma $text = ''; } } + + // Only create a link for unsafe images if there's need for one. If so: + // add it to the global variable. if($text != '') { - $body .= ' | ' . $text . ''; + $unsafe_image_toggle_href = SM_PATH . 'src/read_body.php?'.$link; + $unsafe_image_toggle_text = $text; + $download_and_unsafe_link .= "$nbsp|$nbsp" + . create_hyperlink($unsafe_image_toggle_href, $text); } - $body .= '

' . "\n"; } return $body; } - -function formatAttachments($message, $exclude_id, $mailbox, $id) { - global $where, $what, $startMessage, $color, $passed_ent_id; +/** + * Generate attachments array for passing to templates. Separated from + * formatAttachments() below so that the same array can be given to the + * print-friendly version. + * + * @since 1.5.2 + * @param object $message SquirrelMail message object + * @param array $exclude_id message parts that are not attachments. + * @param string $mailbox mailbox name + * @param integer $id message id + */ +function buildAttachmentArray($message, $exclude_id, $mailbox, $id) { + global $where, $what, $startMessage, $color, $passed_ent_id, $base_uri; $att_ar = $message->getAttachments($exclude_id); - - if (!count($att_ar)) return ''; - - $attachments = ''; - $urlMailbox = urlencode($mailbox); + $attachments = array(); foreach ($att_ar as $att) { $ent = $att->entity_id; $header = $att->header; $type0 = strtolower($header->type0); $type1 = strtolower($header->type1); $name = ''; + $links = array(); $links['download link']['text'] = _("Download"); - $links['download link']['href'] = SM_PATH . - "src/download.php?absolute_dl=true&passed_id=$id&mailbox=$urlMailbox&ent_id=$ent"; + $links['download link']['href'] = $base_uri . + "src/download.php?absolute_dl=true&passed_id=$id&mailbox=$urlMailbox&ent_id=$ent"; + if ($type0 =='message' && $type1 == 'rfc822') { - $default_page = SM_PATH . 'src/read_body.php'; + $default_page = $base_uri . 'src/read_body.php'; $rfc822_header = $att->rfc822_header; $filename = $rfc822_header->subject; if (trim( $filename ) == '') { @@ -457,12 +544,19 @@ function formatAttachments($message, $exclude_id, $mailbox, $id) { $from_o = $rfc822_header->from; if (is_object($from_o)) { $from_name = decodeHeader($from_o->getAddress(false)); + } elseif (is_array($from_o) && count($from_o) && is_object($from_o[0])) { + // something weird happens when a digest message is opened and you return to the digest + // now the from object is part of an array. Probably the parseHeader call overwrites the info + // retrieved from the bodystructure in a different way. We need to fix this later. + // possible starting point, do not fetch header we already have and inspect how + // the rfc822_header object behaves. + $from_name = decodeHeader($from_o[0]->getAddress(false)); } else { $from_name = _("Unknown sender"); } - $description = $from_name; + $description = _("From").': '.$from_name; } else { - $default_page = SM_PATH . 'src/download.php'; + $default_page = $base_uri . 'src/download.php'; $filename = $att->getFilename(); if ($header->description) { $description = decodeHeader($header->description); @@ -478,55 +572,110 @@ function formatAttachments($message, $exclude_id, $mailbox, $id) { $passed_ent_id_link = ''; } $defaultlink = $default_page . "?startMessage=$startMessage" - . "&passed_id=$id&mailbox=$urlMailbox" - . '&ent_id='.$ent.$passed_ent_id_link; + . "&passed_id=$id&mailbox=$urlMailbox" + . '&ent_id='.$ent.$passed_ent_id_link; if ($where && $what) { - $defaultlink .= '&where='. urlencode($where).'&what='.urlencode($what); + $defaultlink .= '&where='. urlencode($where).'&what='.urlencode($what); + } + // IE does make use of mime content sniffing. Forcing a download + // prohibit execution of XSS inside an application/octet-stream attachment + if ($type0 == 'application' && $type1 == 'octet-stream') { + $defaultlink .= '&absolute_dl=true'; } /* This executes the attachment hook with a specific MIME-type. - * If that doesn't have results, it tries if there's a rule - * for a more generic type. - */ - $hookresults = do_hook("attachment $type0/$type1", $links, - $startMessage, $id, $urlMailbox, $ent, $defaultlink, - $display_filename, $where, $what); - if(count($hookresults[1]) <= 1) { - $hookresults = do_hook("attachment $type0/*", $links, - $startMessage, $id, $urlMailbox, $ent, $defaultlink, - $display_filename, $where, $what); + * If that doesn't have results, it tries if there's a rule + * for a more generic type. Finally, a hook for ALL attachment + * types is run as well. + */ + // First remember the default link. + $defaultlink_orig = $defaultlink; + + /* The API for this hook has changed as of 1.5.2 so that all plugin + arguments are passed in an array instead of each their own plugin + argument, and arguments are passed by reference, so instead of + returning any changes, changes should simply be made to the original + arguments themselves. */ + $temp = array(&$links, &$startMessage, &$id, &$urlMailbox, &$ent, + &$defaultlink, &$display_filename, &$where, &$what); + do_hook("attachment $type0/$type1", $temp); + if(count($links) <= 1 && $defaultlink == $defaultlink_orig) { + /* The API for this hook has changed as of 1.5.2 so that all plugin + arguments are passed in an array instead of each their own plugin + argument, and arguments are passed by reference, so instead of + returning any changes, changes should simply be made to the original + arguments themselves. */ + $temp = array(&$links, &$startMessage, &$id, &$urlMailbox, &$ent, + &$defaultlink, &$display_filename, &$where, &$what); + do_hook("attachment $type0/*", $temp); } - - $links = $hookresults[1]; - $defaultlink = $hookresults[6]; - - $attachments .= '
' . - ''.decodeHeader($display_filename).' ' . show_readable_size($header->size) . - '  [ '.htmlspecialchars($type0).'/'.htmlspecialchars($type1).' ] '; - $attachments .= '' . $description . ''; - $attachments .= ' '; - - $skipspaces = 1; + /* The API for this hook has changed as of 1.5.2 so that all plugin + arguments are passed in an array instead of each their own plugin + argument, and arguments are passed by reference, so instead of + returning any changes, changes should simply be made to the original + arguments themselves. */ + $temp = array(&$links, &$startMessage, &$id, &$urlMailbox, &$ent, + &$defaultlink, &$display_filename, &$where, &$what); + // Do not let a generic plugin change the default link if a more + // specialized one already did it... + if ($defaultlink != $defaultlink_orig) { + $dummy = ''; + $temp[5] = &$dummy; + } + do_hook("attachment */*", $temp); + + $this_attachment = array(); + $this_attachment['Name'] = decodeHeader($display_filename); + $this_attachment['Description'] = $description; + $this_attachment['DefaultHREF'] = $defaultlink; + $this_attachment['DownloadHREF'] = $links['download link']['href']; + $this_attachment['ViewHREF'] = isset($links['attachment_common']) ? $links['attachment_common']['href'] : ''; + $this_attachment['Size'] = $header->size; + $this_attachment['ContentType'] = htmlspecialchars($type0 .'/'. $type1); + $this_attachment['OtherLinks'] = array(); foreach ($links as $val) { - if ($skipspaces) { - $skipspaces = 0; - } else { - $attachments .= '  |  '; - } - $attachments .= '' . (isset($val['text']) && !empty($val['text']) ? $val['text'] : '') . (isset($val['extra']) && !empty($val['extra']) ? $val['extra'] : '') . ''; + if ($val['text']==_("Download") || $val['text'] == _("View")) + continue; + if (empty($val['text']) && empty($val['extra'])) + continue; + + $temp = array(); + $temp['HREF'] = $val['href']; + $temp['Text'] = (empty($val['text']) ? '' : $val['text']) . (empty($val['extra']) ? '' : $val['extra']); + $this_attachment['OtherLinks'][] = $temp; } + $attachments[] = $this_attachment; + unset($links); - $attachments .= "