X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fstrings.php;h=b8166754d2d57b6a52ee7d61b2f6194d7f015bcf;hb=653a7e8738ce74830826c25771c1d8938106da96;hp=c0984ebca98a202f49ff720cabca65b221994177;hpb=0391864cbf0683727f9227ffc381db2ac31fd6b5;p=squirrelmail.git
diff --git a/functions/strings.php b/functions/strings.php
index c0984ebc..b8166754 100644
--- a/functions/strings.php
+++ b/functions/strings.php
@@ -1,518 +1,1676 @@
';
+ }
+ if ($citeLevel != 0) {
+ $str .= ' ';
+ }
+}
- //*************************************************************************
- // Count the number of occurances of $needle are in $haystack.
- // $needle can be a character or string, and need not occur in $haystack
- //*************************************************************************
- function countCharInString($haystack, $needle) {
- if ($needle == '') return 0;
- return count(explode($needle, $haystack));
- }
+/**
+ * Create a newline in the string, adding citation
+ * markers to the newline as necessary.
+ *
+ * @author Justus Pendleton
+ * @param string $str the string to make a newline in
+ * @param int $citeLevel the citation level the newline is at
+ * @param int $column starting column of the newline
+ * @return null
+ * @since 1.5.1
+ */
+function sqMakeNewLine (&$str, $citeLevel, &$column) {
+ $str .= "\n";
+ $column = 0;
+ if ($citeLevel > 0) {
+ sqMakeCite ($str, $citeLevel);
+ $column = $citeLevel + 1;
+ } else {
+ $column = 0;
+ }
+}
- //*************************************************************************
- // Read from the back of $haystack until $needle is found, or the begining
- // of the $haystack is reached. $needle is a single character
- //*************************************************************************
- function readShortMailboxName($haystack, $needle) {
- if ($needle == '') return $haystack;
- $parts = explode($needle, $haystack);
- $elem = array_pop($parts);
- while ($elem == '' && count($parts))
- {
- $elem = array_pop($parts);
- }
- return $elem;
- }
+/**
+ * Checks for spaces in strings - only used if PHP doesn't have native ctype support
+ *
+ * You might be able to rewrite the function by adding short evaluation form.
+ *
+ * possible problems:
+ * - iso-2022-xx charsets - hex 20 might be part of other symbol. I might
+ * be wrong. 0x20 is not used in iso-2022-jp. I haven't checked iso-2022-kr
+ * and iso-2022-cn mappings.
+ *
+ * - no-break space ( ) - it is 8bit symbol, that depends on charset.
+ * there are at least three different charset groups that have nbsp in
+ * different places.
+ *
+ * I don't see any charset/nbsp options in php ctype either.
+ *
+ * @param string $string tested string
+ * @return bool true when only whitespace symbols are present in test string
+ * @since 1.5.1
+ */
+function sm_ctype_space($string) {
+ if ( preg_match('/^[\x09-\x0D]|^\x20/', $string) || $string=='') {
+ return true;
+ } else {
+ return false;
+ }
+}
- //*************************************************************************
- // Read from the back of $haystack until $needle is found, or the begining
- // of the $haystack is reached. $needle is a single character
- //*************************************************************************
- function readMailboxParent($haystack, $needle) {
- if ($needle == '') return '';
- $parts = explode($needle, $haystack);
- $elem = array_pop($parts);
- while ($elem == '' && count($parts))
- {
- $elem = array_pop($parts);
- }
- return join($needle, $parts);
- }
+/**
+ * Wraps text at $wrap characters. While sqWordWrap takes
+ * a single line of text and wraps it, this function works
+ * on the entire corpus at once, this allows it to be a little
+ * bit smarter and when and how to wrap.
+ *
+ * @author Justus Pendleton
+ * @param string $body the entire body of text
+ * @param int $wrap the maximum line length
+ * @return string the wrapped text
+ * @since 1.5.1
+ */
+function &sqBodyWrap (&$body, $wrap) {
+ //check for ctype support, and fake it if it doesn't exist
+ if (!function_exists('ctype_space')) {
+ function ctype_space ($string) {
+ return sm_ctype_space($string);
+ }
+ }
- // Searches for the next position in a string minus white space
- function next_pos_minus_white ($haystack, $pos) {
- while (substr($haystack, $pos, 1) == ' ' ||
- substr($haystack, $pos, 1) == "\t" ||
- substr($haystack, $pos, 1) == "\n" ||
- substr($haystack, $pos, 1) == "\r") {
- if ($pos >= strlen($haystack))
- return -1;
- $pos++;
- }
- return $pos;
- }
+ // the newly wrapped text
+ $outString = '';
+ // current column since the last newline in the outstring
+ $outStringCol = 0;
+ $length = sq_strlen($body);
+ // where we are in the original string
+ $pos = 0;
+ // the number of >>> citation markers we are currently at
+ $citeLevel = 0;
+
+ // the main loop, whenever we start a newline of input text
+ // we start from here
+ while ($pos < $length) {
+ // we're at the beginning of a line, get the new cite level
+ $newCiteLevel = 0;
+
+ while (($pos < $length) && (sq_substr($body,$pos,1) == '>')) {
+ $newCiteLevel++;
+ $pos++;
+
+ // skip over any spaces interleaved among the cite markers
+ while (($pos < $length) && (sq_substr($body,$pos,1) == ' ')) {
+
+ $pos++;
- // Wraps text at $wrap characters
- // Has a problem with special HTML characters, so call this before
- // you do character translation.
- // Specifically, ' comes up as 5 characters instead of 1.
- // This should not add newlines to the end of lines.
- function sqWordWrap(&$line, $wrap) {
- ereg("^([\t >]*)([^\t >].*)?$", $line, $regs);
- $beginning_spaces = $regs[1];
- if (isset($regs[2])) {
- $words = explode(' ', $regs[2]);
- } else {
- $words = "";
}
+ if ($pos >= $length) {
+ break;
+ }
+ }
- $i = 0;
- $line = $beginning_spaces;
-
- while ($i < count($words)) {
- // Force one word to be on a line (minimum)
- $line .= $words[$i];
- $line_len = strlen($beginning_spaces) + strlen($words[$i]) + 2;
- if (isset($words[$i + 1]))
- $line_len += strlen($words[$i + 1]);
- $i ++;
-
- // Add more words (as long as they fit)
- while ($line_len < $wrap && $i < count($words)) {
- $line .= ' ' . $words[$i];
- $i++;
- if (isset($words[$i]))
- $line_len += strlen($words[$i]) + 1;
- else
- $line_len += 1;
- }
-
- // Skip spaces if they are the first thing on a continued line
- while (!isset($words[$i]) && $i < count($words)) {
- $i ++;
- }
+ // special case: if this is a blank line then maintain it
+ // (i.e. try to preserve original paragraph breaks)
+ // unless they occur at the very beginning of the text
+ if ((sq_substr($body,$pos,1) == "\n" ) && (sq_strlen($outString) != 0)) {
+ $outStringLast = $outString{sq_strlen($outString) - 1};
+ if ($outStringLast != "\n") {
+ $outString .= "\n";
+ }
+ sqMakeCite ($outString, $newCiteLevel);
+ $outString .= "\n";
+ $pos++;
+ $outStringCol = 0;
+ continue;
+ }
- // Go to the next line if we have more to process
- if ($i < count($words)) {
- $line .= "\n" . $beginning_spaces;
- }
- }
- }
-
-
- // Does the opposite of sqWordWrap()
- function sqUnWordWrap(&$body)
- {
- $lines = explode("\n", $body);
- $body = "";
- $PreviousSpaces = "";
- for ($i = 0; $i < count($lines); $i ++)
- {
- ereg("^([\t >]*)([^\t >].*)?$", $lines[$i], $regs);
- $CurrentSpaces = $regs[1];
- if (isset($regs[2]))
- $CurrentRest = $regs[2];
- if ($i == 0)
- {
- $PreviousSpaces = $CurrentSpaces;
- $body = $lines[$i];
+ // if the cite level has changed, then start a new line
+ // with the new cite level.
+ if (($citeLevel != $newCiteLevel) && ($pos > ($newCiteLevel + 1)) && ($outStringCol != 0)) {
+ sqMakeNewLine ($outString, 0, $outStringCol);
+ }
+
+ $citeLevel = $newCiteLevel;
+
+ // prepend the quote level if necessary
+ if ($outStringCol == 0) {
+ sqMakeCite ($outString, $citeLevel);
+ // if we added a citation then move the column
+ // out by citelevel + 1 (the cite markers + the space)
+ $outStringCol = $citeLevel + ($citeLevel ? 1 : 0);
+ } else if ($outStringCol > $citeLevel) {
+ // not a cite and we're not at the beginning of a line
+ // in the output. add a space to separate the new text
+ // from previous text.
+ $outString .= ' ';
+ $outStringCol++;
+ }
+
+ // find the next newline -- we don't want to go further than that
+ $nextNewline = sq_strpos ($body, "\n", $pos);
+ if ($nextNewline === FALSE) {
+ $nextNewline = $length;
+ }
+
+ // Don't wrap unquoted lines at all. For now the textarea
+ // will work fine for this. Maybe revisit this later though
+ // (for completeness more than anything else, I think)
+ if ($citeLevel == 0) {
+ $outString .= sq_substr ($body, $pos, ($nextNewline - $pos));
+ $outStringCol = $nextNewline - $pos;
+ if ($nextNewline != $length) {
+ sqMakeNewLine ($outString, 0, $outStringCol);
}
- else if ($PreviousSpaces == $CurrentSpaces && // Do the beginnings match
- strlen($lines[$i - 1]) > 65 && // Over 65 characters long
- strlen($CurrentRest)) // and there's a line to continue with
- {
- $body .= ' ' . $CurrentRest;
+ $pos = $nextNewline + 1;
+ continue;
+ }
+ /**
+ * Set this to false to stop appending short strings to previous lines
+ */
+ $smartwrap = true;
+ // inner loop, (obviously) handles wrapping up to
+ // the next newline
+ while ($pos < $nextNewline) {
+ // skip over initial spaces
+ while (($pos < $nextNewline) && (ctype_space (sq_substr($body,$pos,1)))) {
+ $pos++;
}
- else
- {
- $body .= "\n" . $lines[$i];
- $PreviousSpaces = $CurrentSpaces;
+ // if this is a short line then just append it and continue outer loop
+ if (($outStringCol + $nextNewline - $pos) <= ($wrap - $citeLevel - 1) ) {
+ // if this is the final line in the input string then include
+ // any trailing newlines
+ // echo substr($body,$pos,$wrap). "
";
+ if (($nextNewline + 1 == $length) && (sq_substr($body,$nextNewline,1) == "\n")) {
+ $nextNewline++;
+ }
+
+ // trim trailing spaces
+ $lastRealChar = $nextNewline;
+ while (($lastRealChar > $pos && $lastRealChar < $length) && (ctype_space (sq_substr($body,$lastRealChar,1)))) {
+ $lastRealChar--;
+ }
+ // decide if appending the short string is what we want
+ if (($nextNewline < $length && sq_substr($body,$nextNewline,1) == "\n") &&
+ isset($lastRealChar)) {
+ $mypos = $pos;
+ //check the first word:
+ while (($mypos < $length) && (sq_substr($body,$mypos,1) == '>')) {
+ $mypos++;
+ // skip over any spaces interleaved among the cite markers
+ while (($mypos < $length) && (sq_substr($body,$mypos,1) == ' ')) {
+ $mypos++;
+ }
+ }
+/*
+ $ldnspacecnt = 0;
+ if ($mypos == $nextNewline+1) {
+ while (($mypos < $length) && ($body{$mypos} == ' ')) {
+ $ldnspacecnt++;
+ }
+ }
+*/
+
+ $firstword = sq_substr($body,$mypos,sq_strpos($body,' ',$mypos) - $mypos);
+ //if ($dowrap || $ldnspacecnt > 1 || ($firstword && (
+ if (!$smartwrap || $firstword && (
+ $firstword{0} == '-' ||
+ $firstword{0} == '+' ||
+ $firstword{0} == '*' ||
+ sq_substr($firstword,0,1) == sq_strtoupper(sq_substr($firstword,0,1)) ||
+ strpos($firstword,':'))) {
+ $outString .= sq_substr($body,$pos,($lastRealChar - $pos+1));
+ $outStringCol += ($lastRealChar - $pos);
+ sqMakeNewLine($outString,$citeLevel,$outStringCol);
+ $nextNewline++;
+ $pos = $nextNewline;
+ $outStringCol--;
+ continue;
+ }
+
+ }
+
+ $outString .= sq_substr ($body, $pos, ($lastRealChar - $pos + 1));
+ $outStringCol += ($lastRealChar - $pos);
+ $pos = $nextNewline + 1;
+ continue;
+ }
+
+ $eol = $pos + $wrap - $citeLevel - $outStringCol;
+ // eol is the tentative end of line.
+ // look backwards for there for a whitespace to break at.
+ // if it's already less than our current position then
+ // our current line is already too long, break immediately
+ // and restart outer loop
+ if ($eol <= $pos) {
+ sqMakeNewLine ($outString, $citeLevel, $outStringCol);
+ continue;
+ }
+
+ // start looking backwards for whitespace to break at.
+ $breakPoint = $eol;
+ while (($breakPoint > $pos) && (! ctype_space (sq_substr($body,$breakPoint,1)))) {
+ $breakPoint--;
+ }
+
+ // if we didn't find a breakpoint by looking backward then we
+ // need to figure out what to do about that
+ if ($breakPoint == $pos) {
+ // if we are not at the beginning then end this line
+ // and start a new loop
+ if ($outStringCol > ($citeLevel + 1)) {
+ sqMakeNewLine ($outString, $citeLevel, $outStringCol);
+ continue;
+ } else {
+ // just hard break here. most likely we are breaking
+ // a really long URL. could also try searching
+ // forward for a break point, which is what Mozilla
+ // does. don't bother for now.
+ $breakPoint = $eol;
+ }
+ }
+
+ // special case: maybe we should have wrapped last
+ // time. if the first breakpoint here makes the
+ // current line too long and there is already text on
+ // the current line, break and loop again if at
+ // beginning of current line, don't force break
+ $SLOP = 6;
+ if ((($outStringCol + ($breakPoint - $pos)) > ($wrap + $SLOP)) && ($outStringCol > ($citeLevel + 1))) {
+ sqMakeNewLine ($outString, $citeLevel, $outStringCol);
+ continue;
+ }
+
+ // skip newlines or whitespace at the beginning of the string
+ $substring = sq_substr ($body, $pos, ($breakPoint - $pos));
+ $substring = rtrim ($substring); // do rtrim and ctype_space have the same ideas about whitespace?
+ $outString .= $substring;
+ $outStringCol += sq_strlen ($substring);
+ // advance past the whitespace which caused the wrap
+ $pos = $breakPoint;
+ while (($pos < $length) && (ctype_space (sq_substr($body,$pos,1)))) {
+ $pos++;
+ }
+ if ($pos < $length) {
+ sqMakeNewLine ($outString, $citeLevel, $outStringCol);
}
}
- $body .= "\n";
- }
-
-
- /** Returns an array of email addresses **/
- /* Be cautious of "user@host.com" */
- function parseAddrs($text) {
- if (trim($text) == "")
- return array();
- $text = str_replace(' ', '', $text);
- $text = ereg_replace('"[^"]*"', '', $text);
- $text = ereg_replace('\\([^\\)]*\\)', '', $text);
- $text = str_replace(',', ';', $text);
- $array = explode(';', $text);
- for ($i = 0; $i < count ($array); $i++) {
- $array[$i] = eregi_replace ("^.*[<]", '', $array[$i]);
- $array[$i] = eregi_replace ("[>].*$", '', $array[$i]);
- }
- return $array;
- }
+ }
- /** Returns a line of comma separated email addresses from an array **/
- function getLineOfAddrs($array) {
- if (is_array($array)) {
- $to_line = implode(', ', $array);
- $to_line = trim(ereg_replace(', (, )+', ', ', $to_line));
- } else {
- $to_line = '';
- }
- return $to_line;
- }
+ return $outString;
+}
- function translateText(&$body, $wrap_at, $charset) {
- global $where, $what; // from searching
- global $color; // color theme
-
- include '../functions/url_parser.php';
-
- $body_ary = explode("\n", $body);
- $PriorQuotes = 0;
- for ($i=0; $i < count($body_ary); $i++) {
- $line = $body_ary[$i];
- if (strlen($line) - 2 >= $wrap_at) {
- sqWordWrap($line, $wrap_at);
- }
- $line = charset_decode($charset, $line);
- $line = str_replace("\t", ' ', $line);
-
- parseUrl ($line);
-
- $Quotes = 0;
- $pos = 0;
- while (1)
- {
- if ($line[$pos] == ' ')
- {
- $pos ++;
- }
- else if (strpos($line, '>', $pos) === $pos)
- {
- $pos += 4;
- $Quotes ++;
- }
- else
- {
- break;
- }
- }
-
- if ($Quotes > 1) {
- if (! isset($color[13]))
- $color[13] = '#FF0000';
- $line = '' . $line . '';
- } elseif ($Quotes) {
- if (! isset($color[14]))
- $color[14] = '#800000';
- $line = '' . $line . '';
- }
-
- $body_ary[$i] = $line;
- }
- $body = '
' . implode("\n", $body_ary) . ''; - } +/** + * Wraps text at $wrap characters + * + * Has a problem with special HTML characters, so call this before + * you do character translation. + * + * Specifically, ' comes up as 5 characters instead of 1. + * This should not add newlines to the end of lines. + * + * @param string $line the line of text to wrap, by ref + * @param int $wrap the maximum line lenth + * @param string $charset name of charset used in $line string. Available since v.1.5.1. + * @return void + * @since 1.0 + */ +function sqWordWrap(&$line, $wrap, $charset='') { + global $languages, $squirrelmail_language; - /* SquirrelMail version number -- DO NOT CHANGE */ - global $version; - $version = '1.1.3 [cvs]'; + // Use custom wrapping function, if translation provides it + if (isset($languages[$squirrelmail_language]['XTRA_CODE']) && + function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_wordwrap')) { + if (mb_detect_encoding($line) != 'ASCII') { + $line = call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_wordwrap', $line, $wrap); + return; + } + } + preg_match('/^([\t >]*)([^\t >].*)?$/', $line, $regs); + $beginning_spaces = $regs[1]; + if (isset($regs[2])) { + $words = explode(' ', $regs[2]); + } else { + $words = array(); + } - function find_mailbox_name ($mailbox) { - if (ereg(" *\"([^\r\n\"]*)\"[ \r\n]*$", $mailbox, $regs)) - return $regs[1]; - ereg(" *([^ \r\n\"]*)[ \r\n]*$",$mailbox,$regs); - return $regs[1]; + $i = 0; + $line = $beginning_spaces; - } + while ($i < count($words)) { + /* Force one word to be on a line (minimum) */ + $line .= $words[$i]; + $line_len = strlen($beginning_spaces) + sq_strlen($words[$i],$charset) + 2; + if (isset($words[$i + 1])) + $line_len += sq_strlen($words[$i + 1],$charset); + $i ++; + + /* Add more words (as long as they fit) */ + while ($line_len < $wrap && $i < count($words)) { + $line .= ' ' . $words[$i]; + $i++; + if (isset($words[$i])) + $line_len += sq_strlen($words[$i],$charset) + 1; + else + $line_len += 1; + } - function get_location () { - # This determines the location to forward to relative - # to your server. If this doesnt work correctly for - # you (although it should), you can remove all this - # code except the last two lines, and change the header() - # function to look something like this, customized to - # the location of SquirrelMail on your server: - # - # http://www.myhost.com/squirrelmail/src/login.php - - global $PHP_SELF, $SERVER_NAME, $HTTP_HOST, $SERVER_PORT, - $HTTP_SERVER_VARS; - - // Get the path - $path = substr($PHP_SELF, 0, strrpos($PHP_SELF, '/')); - - // Check if this is a HTTPS or regular HTTP request - $proto = 'http://'; - // If you have 'SSLOptions +StdEnvVars' in your apache config - // OR if you have HTTPS in your HTTP_SERVER_VARS - // OR if you are on port 443 - $getEnvVar = getenv('HTTPS'); - if ((isset($getEnvVar) && !strcasecmp($getEnvVar, 'on')) || - (isset($HTTP_SERVER_VARS['HTTPS'])) || - (isset($HTTP_SERVER_VARS['SERVER_PORT']) && - $HTTP_SERVER_VARS['SERVER_PORT'] == 443)) { + /* Skip spaces if they are the first thing on a continued line */ + while (!isset($words[$i]) && $i < count($words)) { + $i ++; + } + + /* Go to the next line if we have more to process */ + if ($i < count($words)) { + $line .= "\n"; + } + } +} + +/** + * Does the opposite of sqWordWrap() + * @param string $body the text to un-wordwrap + * @return void + * @since 1.0 + */ +function sqUnWordWrap(&$body) { + global $squirrelmail_language; + + if ($squirrelmail_language == 'ja_JP') { + return; + } + + $lines = explode("\n", $body); + $body = ''; + $PreviousSpaces = ''; + $cnt = count($lines); + for ($i = 0; $i < $cnt; $i ++) { + preg_match("/^([\t >]*)([^\t >].*)?$/", $lines[$i], $regs); + $CurrentSpaces = $regs[1]; + if (isset($regs[2])) { + $CurrentRest = $regs[2]; + } else { + $CurrentRest = ''; + } + + if ($i == 0) { + $PreviousSpaces = $CurrentSpaces; + $body = $lines[$i]; + } else if (($PreviousSpaces == $CurrentSpaces) /* Do the beginnings match */ + && (strlen($lines[$i - 1]) > 65) /* Over 65 characters long */ + && strlen($CurrentRest)) { /* and there's a line to continue with */ + $body .= ' ' . $CurrentRest; + } else { + $body .= "\n" . $lines[$i]; + $PreviousSpaces = $CurrentSpaces; + } + } + $body .= "\n"; +} + +/** + * If $haystack is a full mailbox name and $needle is the mailbox + * separator character, returns the last part of the mailbox name. + * + * @param string haystack full mailbox name to search + * @param string needle the mailbox separator character + * @return string the last part of the mailbox name + * @since 1.0 + */ +function readShortMailboxName($haystack, $needle) { + + if ($needle == '') { + $elem = $haystack; + } else { + $parts = explode($needle, $haystack); + $elem = array_pop($parts); + while ($elem == '' && count($parts)) { + $elem = array_pop($parts); + } + } + return( $elem ); +} + + +/** + * get_location + * + * Determines the location to forward to, relative to your server. + * This is used in HTTP Location: redirects. + * + * If set, it uses $config_location_base as the first part of the URL, + * specifically, the protocol, hostname and port parts. The path is + * always autodetected. + * + * @return string the base url for this SquirrelMail installation + * @since 1.0 + */ +function get_location () { + + global $imap_server_type, $config_location_base, + $is_secure_connection, $sq_ignore_http_x_forwarded_headers; + + /* Get the path, handle virtual directories */ + if(strpos(php_self(), '?')) { + $path = substr(php_self(), 0, strpos(php_self(), '?')); + } else { + $path = php_self(); + } + $path = substr($path, 0, strrpos($path, '/')); + + // proto+host+port are already set in config: + if ( !empty($config_location_base) ) { + return $config_location_base . $path ; + } + // we computed it before, get it from the session: + if ( sqgetGlobalVar('sq_base_url', $full_url, SQ_SESSION) ) { + return $full_url . $path; + } + // else: autodetect + + /* Check if this is a HTTPS or regular HTTP request. */ + $proto = 'http://'; + if ($is_secure_connection) $proto = 'https://'; - } - - // Get the hostname from the Host header or server config. - $host = ''; - if (isset($HTTP_HOST) && !empty($HTTP_HOST)) - { - $host = $HTTP_HOST; - } - else if (isset($SERVER_NAME) && !empty($SERVER_NAME)) - { - $host = $SERVER_NAME; - } - - $port = ''; - if (! strstr($host, ':')) + + /* Get the hostname from the Host header or server config. */ + if ($sq_ignore_http_x_forwarded_headers + || !sqgetGlobalVar('HTTP_X_FORWARDED_HOST', $host, SQ_SERVER) + || empty($host)) { + if ( !sqgetGlobalVar('HTTP_HOST', $host, SQ_SERVER) || empty($host) ) { + if ( !sqgetGlobalVar('SERVER_NAME', $host, SQ_SERVER) || empty($host) ) { + $host = ''; + } + } + } + + $port = ''; + if (! strstr($host, ':')) { + // Note: HTTP_X_FORWARDED_PROTO could be sent from the client and + // therefore possibly spoofed/hackable. Thus, SquirrelMail + // ignores such headers by default. The administrator + // can tell SM to use such header values by setting + // $sq_ignore_http_x_forwarded_headers to boolean FALSE + // in config/config.php or by using config/conf.pl. + global $sq_ignore_http_x_forwarded_headers; + if ($sq_ignore_http_x_forwarded_headers + || !sqgetGlobalVar('HTTP_X_FORWARDED_PROTO', $forwarded_proto, SQ_SERVER)) + $forwarded_proto = ''; + if (sqgetGlobalVar('SERVER_PORT', $server_port, SQ_SERVER)) { + if (($server_port != 80 && $proto == 'http://') || + ($server_port != 443 && $proto == 'https://' && + strcasecmp($forwarded_proto, 'https') !== 0)) { + $port = sprintf(':%d', $server_port); + } + } + } + + /* this is a workaround for the weird macosx caching that + * causes Apache to return 16080 as the port number, which causes + * SM to bail */ + + if ($imap_server_type == 'macosx' && $port == ':16080') { + $port = ''; + } + + /* Fallback is to omit the server name and use a relative */ + /* URI, although this is not RFC 2616 compliant. */ + $full_url = ($host ? $proto . $host . $port : ''); + sqsession_register($full_url, 'sq_base_url'); + return $full_url . $path; +} + + +/** + * Get Message List URI + * + * @param string $mailbox Current mailbox name (unencoded/raw) + * @param string $startMessage The mailbox page offset + * @param string $what Any current search parameters (OPTIONAL; + * default empty string) + * + * @return string The message list URI + * + * @since 1.5.2 + * + */ +function get_message_list_uri($mailbox, $startMessage, $what='') { + + global $base_uri; + + $urlMailbox = urlencode($mailbox); + + $list_xtra = "?where=read_body.php&what=$what&mailbox=" . $urlMailbox. + "&startMessage=$startMessage"; + + return $base_uri .'src/right_main.php'. $list_xtra; +} + + +/** + * Encrypts password + * + * These functions are used to encrypt the password before it is + * stored in a cookie. The encryption key is generated by + * OneTimePadCreate(); + * + * @param string $string the (password)string to encrypt + * @param string $epad the encryption key + * @return string the base64-encoded encrypted password + * @since 1.0 + */ +function OneTimePadEncrypt ($string, $epad) { + $pad = base64_decode($epad); + + if (strlen($pad)>0) { + // make sure that pad is longer than string + while (strlen($string)>strlen($pad)) { + $pad.=$pad; + } + } else { + // FIXME: what should we do when $epad is not base64 encoded or empty. + } + + $encrypted = ''; + for ($i = 0; $i < strlen ($string); $i++) { + $encrypted .= chr (ord($string[$i]) ^ ord($pad[$i])); + } + + return base64_encode($encrypted); +} + +/** + * Decrypts a password from the cookie + * + * Decrypts a password from the cookie, encrypted by OneTimePadEncrypt. + * This uses the encryption key that is stored in the session. + * + * @param string $string the string to decrypt + * @param string $epad the encryption key from the session + * @return string the decrypted password + * @since 1.0 + */ +function OneTimePadDecrypt ($string, $epad) { + $pad = base64_decode($epad); + + if (strlen($pad)>0) { + // make sure that pad is longer than string + while (strlen($string)>strlen($pad)) { + $pad.=$pad; + } + } else { + // FIXME: what should we do when $epad is not base64 encoded or empty. + } + + $encrypted = base64_decode ($string); + $decrypted = ''; + for ($i = 0; $i < strlen ($encrypted); $i++) { + $decrypted .= chr (ord($encrypted[$i]) ^ ord($pad[$i])); + } + + return $decrypted; +} + +/** + * Creates encryption key + * + * Creates an encryption key for encrypting the password stored in the cookie. + * The encryption key itself is stored in the session. + * + * Pad must be longer or equal to encoded string length in 1.4.4/1.5.0 and older. + * @param int $length optional, length of the string to generate + * @return string the encryption key + * @since 1.0 + */ +function OneTimePadCreate ($length=100) { + $pad = ''; + for ($i = 0; $i < $length; $i++) { + $pad .= chr(mt_rand(0,255)); + } + + return base64_encode($pad); +} + +/** + * Returns a string showing a byte size figure in + * a more easily digested (readable) format + * + * @param int $bytes the size in bytes + * + * @return string The size in human readable format + * + * @since 1.0 + * + */ +function show_readable_size($bytes) { + $bytes /= 1024; + $type = _("KiB"); + + if ($bytes / 1024 > 1) { + $bytes /= 1024; + $type = _("MiB"); + } + + if ($bytes < 10) { + $bytes *= 10; + settype($bytes, 'integer'); + $bytes /= 10; + } else { + settype($bytes, 'integer'); + } + + global $nbsp; + return $bytes . $nbsp . $type; +} + +/** + * Generates a random string from the character set you pass in + * + * @param int $size the length of the string to generate + * @param string $chars a string containing the characters to use + * @param int $flags a flag to add a specific set to the characters to use: + * Flags: + * 1 = add lowercase a-z to $chars + * 2 = add uppercase A-Z to $chars + * 4 = add numbers 0-9 to $chars + * @return string the random string + * @since 1.0 + */ +function GenerateRandomString($size, $chars, $flags = 0) { + if ($flags & 0x1) { + $chars .= 'abcdefghijklmnopqrstuvwxyz'; + } + if ($flags & 0x2) { + $chars .= 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'; + } + if ($flags & 0x4) { + $chars .= '0123456789'; + } + + if (($size < 1) || (strlen($chars) < 1)) { + return ''; + } + + $String = ''; + $j = strlen( $chars ) - 1; + while (strlen($String) < $size) { + $String .= $chars{mt_rand(0, $j)}; + } + + return $String; +} + +/** + * Escapes special characters for use in IMAP commands. + * + * @param string $str the string to escape + * @return string the escaped string + * @since 1.0.3 + */ +function quoteimap($str) { + return str_replace(array('\\', '"'), array('\\\\', '\\"'), $str); +} + +/** + * Create compose link + * + * Returns a link to the compose-page, taking in consideration + * the compose_in_new and javascript settings. + * + * @param string $url The URL to the compose page + * @param string $text The link text, default "Compose" + * @param string $target URL target, if any (since 1.4.3) + * @param string $accesskey The access key to be used, if any + * + * @return string a link to the compose page + * + * @since 1.4.2 + */ +function makeComposeLink($url, $text = null, $target='', $accesskey='NONE') { + global $compose_new_win, $compose_width, + $compose_height, $oTemplate; + + if(!$text) { + $text = _("Compose"); + } + + // if not using "compose in new window", make + // regular link and be done with it + if($compose_new_win != '1') { + return makeInternalLink($url, $text, $target, $accesskey); + } + + // build the compose in new window link... + + + // if javascript is on, use onclick event to handle it + if(checkForJavascript()) { + sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION); + $compuri = SM_BASE_URI.$url; + + return create_hyperlink('javascript:void(0)', $text, '', + "comp_in_new('$compuri','$compose_width','$compose_height')", + '', '', '', + ($accesskey == 'NONE' + ? array() + : array('accesskey' => $accesskey))); + } + + // otherwise, just open new window using regular HTML + return makeInternalLink($url, $text, '_blank', $accesskey); +} + +/** + * version of fwrite which checks for failure + * @param resource $fp + * @param string $string + * @return number of written bytes. false on failure + * @since 1.4.3 + */ +function sq_fwrite($fp, $string) { + // write to file + $count = @fwrite($fp,$string); + // the number of bytes written should be the length of the string + if($count != strlen($string)) { + return FALSE; + } + + return $count; +} + +/** + * sq_get_html_translation_table + * + * Returns the translation table used by sq_htmlentities() + * + * @param integer $table html translation table. Possible values (without quotes): + *