<?php
-/**
+/**
* strings.php
*
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
+ * Copyright (c) 1999-2005 The SquirrelMail Project Team
* Licensed under the GNU GPL. For full terms see the file COPYING.
*
* This code provides various string manipulation functions that are
- * used by the rest of the Squirrelmail code.
+ * used by the rest of the SquirrelMail code.
*
- * $Id$
+ * @version $Id$
+ * @package squirrelmail
*/
-
/**
* SquirrelMail version number -- DO NOT CHANGE
*/
global $version;
-$version = '1.5.0 [CVS]';
+$version = '1.5.1 [CVS]';
-/**
+/**
* SquirrelMail internal version number -- DO NOT CHANGE
* $sm_internal_version = array (release, major, minor)
*/
global $SQM_INTERNAL_VERSION;
-$SQM_INTERNAL_VERSION = array(1,5,0);
-
+$SQM_INTERNAL_VERSION = array(1,5,1);
/**
* There can be a circular issue with includes, where the $version string is
*/
require_once(SM_PATH . 'functions/global.php');
+/**
+ * Appends citation markers to the string.
+ * Also appends a trailing space.
+ *
+ * @author Justus Pendleton
+ *
+ * @param string str The string to append to
+ * @param int citeLevel the number of markers to append
+ * @return null
+ */
+function sqMakeCite (&$str, $citeLevel) {
+ for ($i = 0; $i < $citeLevel; $i++) {
+ $str .= '>';
+ }
+ if ($citeLevel != 0) {
+ $str .= ' ';
+ }
+}
+
+/**
+ * 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
+ */
+function sqMakeNewLine (&$str, $citeLevel, &$column) {
+ $str .= "\n";
+ $column = 0;
+ if ($citeLevel > 0) {
+ sqMakeCite ($str, $citeLevel);
+ $column = $citeLevel + 1;
+ } else {
+ $column = 0;
+ }
+}
+
+/**
+ * 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
+ */
+function sm_ctype_space($string) {
+ if ( preg_match('/^[\x09-\x0D]|^\x20/', $string) || $string=='') {
+ return true;
+ } else {
+ return false;
+ }
+}
+
+/**
+ * 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
+ */
+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);
+ }
+ }
+
+ // 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++;
+
+ }
+ if ($pos >= $length) {
+ break;
+ }
+ }
+
+ // 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;
+ }
+
+ // 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);
+ }
+ $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++;
+ }
+ // 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). "<br />";
+ 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);
+ }
+ }
+ }
+
+ return $outString;
+}
+
/**
* 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.
+ * Specifically, &#039; 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
*/
-function sqWordWrap(&$line, $wrap) {
+function sqWordWrap(&$line, $wrap, $charset='') {
global $languages, $squirrelmail_language;
+ // Use custom wrapping function, if translation provides it
if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
- function_exists($languages[$squirrelmail_language]['XTRA_CODE'])) {
+ function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_wordwrap')) {
if (mb_detect_encoding($line) != 'ASCII') {
- $line = $languages[$squirrelmail_language]['XTRA_CODE']('wordwrap', $line, $wrap);
+ $line = call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_wordwrap', $line, $wrap);
return;
}
}
} else {
$words = '';
}
-
+
$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;
+ $line_len = strlen($beginning_spaces) + sq_strlen($words[$i],$charset) + 2;
if (isset($words[$i + 1]))
- $line_len += strlen($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 += strlen($words[$i]) + 1;
+ $line_len += sq_strlen($words[$i],$charset) + 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 ++;
}
-
+
/* 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
*/
function sqUnWordWrap(&$body) {
global $squirrelmail_language;
-
+
if ($squirrelmail_language == 'ja_JP') {
return;
}
if (isset($regs[2])) {
$CurrentRest = $regs[2];
} else {
- $CurrentRest = '';
- }
-
+ $CurrentRest = '';
+ }
+
if ($i == 0) {
$PreviousSpaces = $CurrentSpaces;
$body = $lines[$i];
/**
* 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
*/
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);
- }
+ $parts = explode($needle, $haystack);
+ $elem = array_pop($parts);
+ while ($elem == '' && count($parts)) {
+ $elem = array_pop($parts);
+ }
}
return( $elem );
}
+/**
+ * php_self
+ *
+ * Creates an URL for the page calling this function, using either the PHP global
+ * REQUEST_URI, or the PHP global PHP_SELF with QUERY_STRING added.
+ *
+ * @return string the complete url for this page
+ */
function php_self () {
if ( sqgetGlobalVar('REQUEST_URI', $req_uri, SQ_SERVER) && !empty($req_uri) ) {
return $req_uri;
}
-
+
if ( sqgetGlobalVar('PHP_SELF', $php_self, SQ_SERVER) && !empty($php_self) ) {
+
+ // need to add query string to end of PHP_SELF to match REQUEST_URI
+ //
+ if ( sqgetGlobalVar('QUERY_STRING', $query_string, SQ_SERVER) && !empty($query_string) ) {
+ $php_self .= '?' . $query_string;
+ }
+
return $php_self;
- }
-
+ }
+
return '';
}
/**
- * This determines the location to forward to relative to your server.
+ * get_location
+ *
+ * Determines the location to forward to, relative to your server.
+ * This is used in HTTP Location: redirects.
* 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:
+ * remove all this code except the last two lines, and have it return
+ * the right URL for your site, something like:
*
- * http://www.myhost.com/squirrelmail/src/login.php
+ * http://www.example.com/squirrelmail/
+ *
+ * @return string the base url for this SquirrelMail installation
*/
function get_location () {
-
+
global $imap_server_type;
/* Get the path, handle virtual directories */
- $path = substr(php_self(), 0, strrpos(php_self(), '/'));
-
+ if(strpos(php_self(), '?')) {
+ $path = substr(php_self(), 0, strpos(php_self(), '?'));
+ } else {
+ $path = php_self();
+ }
+ $path = substr($path, 0, strrpos($path, '/'));
if ( sqgetGlobalVar('sq_base_url', $full_url, SQ_SESSION) ) {
return $full_url . $path;
}
/* 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=on in your HTTP_SERVER_VARS
(sqgetGlobalVar('SERVER_PORT', $server_port, SQ_SERVER) && $server_port == 443)) {
$proto = 'https://';
}
-
+
/* Get the hostname from the Host header or server config. */
if ( !sqgetGlobalVar('HTTP_HOST', $host, SQ_SERVER) || empty($host) ) {
if ( !sqgetGlobalVar('SERVER_NAME', $host, SQ_SERVER) || empty($host) ) {
$host = '';
}
}
-
+
$port = '';
if (! strstr($host, ':')) {
if (sqgetGlobalVar('SERVER_PORT', $server_port, SQ_SERVER)) {
- if (($server_port != 80 && $proto == 'http://') ||
+ if (($server_port != 80 && $proto == 'http://') ||
($server_port != 443 && $proto == 'https://')) {
$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 : '');
/**
- * These functions are used to encrypt the passowrd before it is
- * stored in a cookie.
+ * 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
*/
function OneTimePadEncrypt ($string, $epad) {
$pad = base64_decode($epad);
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
+ */
function OneTimePadDecrypt ($string, $epad) {
$pad = base64_decode($epad);
$encrypted = base64_decode ($string);
for ($i = 0; $i < strlen ($encrypted); $i++) {
$decrypted .= chr (ord($encrypted[$i]) ^ ord($pad[$i]));
}
-
+
return $decrypted;
}
/**
- * Randomize the mt_rand() function. Toss this in strings or integers
- * and it will seed the generator appropriately. With strings, it is
- * better to get them long. Use md5() to lengthen smaller strings.
+ * Randomizes the mt_rand() function.
+ *
+ * Toss this in strings or integers and it will seed the generator
+ * appropriately. With strings, it is better to get them long.
+ * Use md5() to lengthen smaller strings.
+ *
+ * @param mixed val a value to seed the random number generator
+ * @return void
*/
function sq_mt_seed($Val) {
/* if mt_getrandmax() does not return a 2^n - 1 number,
this might not work well. This uses $Max as a bitmask. */
$Max = mt_getrandmax();
-
+
if (! is_int($Val)) {
$Val = crc32($Val);
}
-
+
if ($Val < 0) {
$Val *= -1;
}
-
- if ($Val = 0) {
+
+ if ($Val == 0) {
return;
}
-
+
mt_srand(($Val ^ mt_rand(0, $Max)) & $Max);
}
/**
+ * Init random number generator
+ *
* This function initializes the random number generator fairly well.
* It also only initializes it once, so you don't accidentally get
* the same 'random' numbers twice in one session.
+ *
+ * @return void
*/
function sq_mt_randomize() {
static $randomized;
-
+
if ($randomized) {
return;
}
-
+
/* Global. */
sqgetGlobalVar('REMOTE_PORT', $remote_port, SQ_SERVER);
sqgetGlobalVar('REMOTE_ADDR', $remote_addr, SQ_SERVER);
sq_mt_seed((int)((double) microtime() * 1000000));
sq_mt_seed(md5($remote_port . $remote_addr . getmypid()));
-
+
/* getrusage */
if (function_exists('getrusage')) {
/* Avoid warnings with Win32 */
sq_mt_seed(md5($Str));
}
}
-
+
if(sqgetGlobalVar('UNIQUE_ID', $unique_id, SQ_SERVER)) {
sq_mt_seed(md5($unique_id));
}
-
+
$randomized = 1;
}
+/**
+ * Creates encryption key
+ *
+ * Creates an encryption key for encrypting the password stored in the cookie.
+ * The encryption key itself is stored in the session.
+ *
+ * @param int length optional, length of the string to generate
+ * @return string the encryption key
+ */
function OneTimePadCreate ($length=100) {
sq_mt_randomize();
-
+
$pad = '';
for ($i = 0; $i < $length; $i++) {
$pad .= chr(mt_rand(0,255));
}
-
+
return base64_encode($pad);
}
/**
- * Returns a string showing the size of the message/attachment.
+ * Returns a string showing the size of the message/attachment.
+ *
+ * @param int bytes the filesize in bytes
+ * @return string the filesize in human readable format
*/
function show_readable_size($bytes) {
$bytes /= 1024;
$type = 'k';
-
+
if ($bytes / 1024 > 1) {
$bytes /= 1024;
$type = 'M';
}
-
+
if ($bytes < 10) {
$bytes *= 10;
settype($bytes, 'integer');
} else {
settype($bytes, 'integer');
}
-
+
return $bytes . '<small> ' . $type . '</small>';
}
/**
- * Generates a random string from the caracter set you pass in
+ * Generates a random string from the character set you pass in
*
- * Flags:
- * 1 = add lowercase a-z to $chars
- * 2 = add uppercase A-Z to $chars
- * 4 = add numbers 0-9 to $chars
+ * @param int size the size 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
*/
-
function GenerateRandomString($size, $chars, $flags = 0) {
if ($flags & 0x1) {
$chars .= 'abcdefghijklmnopqrstuvwxyz';
if ($flags & 0x4) {
$chars .= '0123456789';
}
-
+
if (($size < 1) || (strlen($chars) < 1)) {
return '';
}
return $String;
}
+/**
+ * Escapes special characters for use in IMAP commands.
+ *
+ * @param string the string to escape
+ * @return string the escaped string
+ */
function quoteimap($str) {
- return ereg_replace('(["\\])', '\\\\1', $str);
+ return preg_replace("/([\"\\\\])/", "\\\\$1", $str);
}
/**
- * Trims every element in the array
+ * Trims array
+ *
+ * Trims every element in the array, ie. remove the first char of each element
+ * @param array array the array to trim
*/
function TrimArray(&$array) {
foreach ($array as $k => $v) {
} else {
$$k = substr($v, 1);
}
-
+
/* Re-assign back to array. */
$array[$k] = $$k;
}
-}
+}
-$PHP_SELF = php_self();
+/**
+ * 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"
+ * @return string a link to the compose page
+ */
+function makeComposeLink($url, $text = null, $target='')
+{
+ global $compose_new_win,$javascript_on;
+
+ 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);
+ }
+
+
+ // build the compose in new window link...
+
+
+ // if javascript is on, use onclick event to handle it
+ if($javascript_on) {
+ sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION);
+ return '<a href="javascript:void(0)" onclick="comp_in_new(\''.$base_uri.$url.'\')">'. $text.'</a>';
+ }
+
+
+ // otherwise, just open new window using regular HTML
+ return makeInternalLink($url, $text, '_blank');
+
+}
+
+/**
+ * Print variable
+ *
+ * sm_print_r($some_variable, [$some_other_variable [, ...]]);
+ *
+ * Debugging function - does the same as print_r, but makes sure special
+ * characters are converted to htmlentities first. This will allow
+ * values like <some@email.address> to be displayed.
+ * The output is wrapped in <<pre>> and <</pre>> tags.
+ *
+ * @return void
+ */
+function sm_print_r() {
+ ob_start(); // Buffer output
+ foreach(func_get_args() as $var) {
+ print_r($var);
+ echo "\n";
+ // php has get_class_methods function that can print class methods
+ if (is_object($var)) {
+ // get class methods if $var is object
+ $aMethods=get_class_methods(get_class($var));
+ // make sure that $aMethods is array and array is not empty
+ if (is_array($aMethods) && $aMethods!=array()) {
+ echo "Object methods:\n";
+ foreach($aMethods as $method) {
+ echo '* ' . $method . "\n";
+ }
+ }
+ echo "\n";
+ }
+ }
+ $buffer = ob_get_contents(); // Grab the print_r output
+ ob_end_clean(); // Silently discard the output & stop buffering
+ print '<pre>';
+ print htmlentities($buffer);
+ print '</pre>';
+}
+
+/**
+ * version of fwrite which checks for failure
+ */
+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):
+ * <ul>
+ * <li>HTML_ENTITIES - full html entities table defined by charset</li>
+ * <li>HTML_SPECIALCHARS - html special characters table</li>
+ * </ul>
+ * @param integer $quote_style quote encoding style. Possible values (without quotes):
+ * <ul>
+ * <li>ENT_COMPAT - (default) encode double quotes</li>
+ * <li>ENT_NOQUOTES - don't encode double or single quotes</li>
+ * <li>ENT_QUOTES - encode double and single quotes</li>
+ * </ul>
+ * @param string $charset charset used for encoding. default to us-ascii, 'auto' uses $default_charset global value.
+ * @return array html translation array
+ */
+function sq_get_html_translation_table($table,$quote_style=ENT_COMPAT,$charset='us-ascii') {
+ global $default_charset;
+
+ if ($table == HTML_SPECIALCHARS) $charset='us-ascii';
+
+ // Start array with ampersand
+ $sq_html_ent_table = array( "&" => '&' );
+
+ // < and >
+ $sq_html_ent_table = array_merge($sq_html_ent_table,
+ array("<" => '<',
+ ">" => '>')
+ );
+ // double quotes
+ if ($quote_style == ENT_COMPAT)
+ $sq_html_ent_table = array_merge($sq_html_ent_table,
+ array("\"" => '"')
+ );
+
+ // double and single quotes
+ if ($quote_style == ENT_QUOTES)
+ $sq_html_ent_table = array_merge($sq_html_ent_table,
+ array("\"" => '"',
+ "'" => ''')
+ );
+
+ if ($charset=='auto') $charset=$default_charset;
+
+ // add entities that depend on charset
+ switch($charset){
+ case 'iso-8859-1':
+ include_once(SM_PATH . 'functions/htmlentities/iso-8859-1.php');
+ break;
+ case 'utf-8':
+ include_once(SM_PATH . 'functions/htmlentities/utf-8.php');
+ break;
+ case 'us-ascii':
+ default:
+ break;
+ }
+ // return table
+ return $sq_html_ent_table;
+}
+
+/**
+ * sq_htmlentities
+ *
+ * Convert all applicable characters to HTML entities.
+ * Minimal php requirement - v.4.0.5.
+ *
+ * Function is designed for people that want to use full power of htmlentities() in
+ * i18n environment.
+ *
+ * @param string $string string that has to be sanitized
+ * @param integer $quote_style quote encoding style. Possible values (without quotes):
+ * <ul>
+ * <li>ENT_COMPAT - (default) encode double quotes</li>
+ * <li>ENT_NOQUOTES - don't encode double or single quotes</li>
+ * <li>ENT_QUOTES - encode double and single quotes</li>
+ * </ul>
+ * @param string $charset charset used for encoding. defaults to 'us-ascii', 'auto' uses $default_charset global value.
+ * @return string sanitized string
+ */
+function sq_htmlentities($string,$quote_style=ENT_COMPAT,$charset='us-ascii') {
+ // get translation table
+ $sq_html_ent_table=sq_get_html_translation_table(HTML_ENTITIES,$quote_style,$charset);
+ // convert characters
+ return str_replace(array_keys($sq_html_ent_table),array_values($sq_html_ent_table),$string);
+}
+
+/**
+ * Tests if string contains 8bit symbols.
+ *
+ * If charset is not set, function defaults to default_charset.
+ * $default_charset global must be set correctly if $charset is
+ * not used.
+ * @param string $string tested string
+ * @param string $charset charset used in a string
+ * @return bool true if 8bit symbols are detected
+ * @since 1.5.1 and 1.4.4
+ */
+function sq_is8bit($string,$charset='') {
+ global $default_charset;
-?>
+ if ($charset=='') $charset=$default_charset;
+
+ /**
+ * Don't use \240 in ranges. Sometimes RH 7.2 doesn't like it.
+ * Don't use \200-\237 for iso-8859-x charsets. This range
+ * stores control symbols in those charsets.
+ * Use preg_match instead of ereg in order to avoid problems
+ * with mbstring overloading
+ */
+ if (preg_match("/^iso-8859/i",$charset)) {
+ $needle='/\240|[\241-\377]/';
+ } else {
+ $needle='/[\200-\237]|\240|[\241-\377]/';
+ }
+ return preg_match("$needle",$string);
+}
+
+/**
+ * Replacement of mb_list_encodings function
+ *
+ * This function provides replacement for function that is available only
+ * in php 5.x. Function does not test all mbstring encodings. Only the ones
+ * that might be used in SM translations.
+ *
+ * Supported strings are stored in session in order to reduce number of
+ * mb_internal_encoding function calls.
+ *
+ * If you want to test all mbstring encodings - fill $list_of_encodings
+ * array.
+ * @return array list of encodings supported by php mbstring extension
+ * @since 1.5.1
+ */
+function sq_mb_list_encodings() {
+ if (! function_exists('mb_internal_encoding'))
+ return array();
+
+ // don't try to test encodings, if they are already stored in session
+ if (sqgetGlobalVar('mb_supported_encodings',$mb_supported_encodings,SQ_SESSION))
+ return $mb_supported_encodings;
+
+ // save original encoding
+ $orig_encoding=mb_internal_encoding();
+
+ $list_of_encoding=array(
+ 'pass',
+ 'auto',
+ 'ascii',
+ 'jis',
+ 'utf-8',
+ 'sjis',
+ 'euc-jp',
+ 'iso-8859-1',
+ 'iso-8859-2',
+ 'iso-8859-7',
+ 'iso-8859-9',
+ 'iso-8859-15',
+ 'koi8-r',
+ 'koi8-u',
+ 'big5',
+ 'gb2312',
+ 'gb18030',
+ 'windows-1251',
+ 'windows-1255',
+ 'windows-1256',
+ 'tis-620',
+ 'iso-2022-jp',
+ 'euc-kr',
+ 'utf7-imap');
+
+ $supported_encodings=array();
+
+ foreach ($list_of_encoding as $encoding) {
+ // try setting encodings. suppress warning messages
+ if (@mb_internal_encoding($encoding))
+ $supported_encodings[]=$encoding;
+ }
+
+ // restore original encoding
+ mb_internal_encoding($orig_encoding);
+
+ // register list in session
+ sqsession_register($supported_encodings,'mb_supported_encodings');
+
+ return $supported_encodings;
+}
+
+/**
+ * Function returns number of characters in string.
+ *
+ * Returned number might be different from number of bytes in string,
+ * if $charset is multibyte charset. Detection depends on mbstring
+ * functions. If mbstring does not support tested multibyte charset,
+ * vanilla string length function is used.
+ * @param string $str string
+ * @param string $charset charset
+ * @since 1.5.1
+ * @return integer number of characters in string
+ */
+function sq_strlen($str, $charset=''){
+ // default option
+ if ($charset=='') return strlen($str);
+
+ // use automatic charset detection, if function call asks for it
+ if ($charset=='auto') {
+ global $default_charset;
+ set_my_charset();
+ $charset=$default_charset;
+ }
+
+ // lowercase charset name
+ $charset=strtolower($charset);
+
+ // Use mbstring only with listed charsets
+ $aList_of_mb_charsets=array('utf-8','big5','gb2312','gb18030','euc-jp','euc-cn','euc-tw','euc-kr');
+
+ // calculate string length according to charset
+ if (in_array($charset,$aList_of_mb_charsets) && in_array($charset,sq_mb_list_encodings())) {
+ $real_length = mb_strlen($str,$charset);
+ } else {
+ // own strlen detection code is removed because missing strpos,
+ // strtoupper and substr implementations break string wrapping.
+ $real_length=strlen($str);
+ }
+ return $real_length;
+}
+
+/**
+ * string padding with multibyte support
+ *
+ * @link http://www.php.net/str_pad
+ * @param string $string original string
+ * @param integer $width padded string width
+ * @param string $pad padding symbols
+ * @param integer $padtype padding type
+ * (internal php defines, see str_pad() description)
+ * @param string $charset charset used in original string
+ * @return string padded string
+ */
+function sq_str_pad($string, $width, $pad, $padtype, $charset='') {
+
+ $charset = strtolower($charset);
+ $padded_string = '';
+
+ switch ($charset) {
+ case 'utf-8':
+ case 'big5':
+ case 'gb2312':
+ case 'euc-kr':
+ /*
+ * all multibyte charsets try to increase width value by
+ * adding difference between number of bytes and real length
+ */
+ $width = $width - sq_strlen($string,$charset) + strlen($string);
+ default:
+ $padded_string=str_pad($string,$width,$pad,$padtype);
+ }
+ return $padded_string;
+}
+
+/**
+ * Wrapper that is used to switch between vanilla and multibyte substr
+ * functions.
+ * @param string $string
+ * @param integer $start
+ * @param integer $length
+ * @param string $charset
+ * @return string
+ * @since 1.5.1
+ * @link http://www.php.net/substr
+ * @link http://www.php.net/mb_substr
+ */
+function sq_substr($string,$start,$length,$charset='auto') {
+ // use automatic charset detection, if function call asks for it
+ if ($charset=='auto') {
+ global $default_charset;
+ set_my_charset();
+ $charset=$default_charset;
+ }
+ $charset = strtolower($charset);
+ if (function_exists('mb_internal_encoding') &&
+ in_array($charset,sq_mb_list_encodings())) {
+ return mb_substr($string,$start,$length,$charset);
+ }
+ // TODO: add mbstring independent code
+
+ // use vanilla string functions as last option
+ return substr($string,$start,$length);
+}
+
+/**
+ * Wrapper that is used to switch between vanilla and multibyte strpos
+ * functions.
+ * @param string $haystack
+ * @param mixed $needle
+ * @param integer $offset
+ * @param string $charset
+ * @return string
+ * @since 1.5.1
+ * @link http://www.php.net/strpos
+ * @link http://www.php.net/mb_strpos
+ */
+function sq_strpos($haystack,$needle,$offset,$charset='auto') {
+ // use automatic charset detection, if function call asks for it
+ if ($charset=='auto') {
+ global $default_charset;
+ set_my_charset();
+ $charset=$default_charset;
+ }
+ $charset = strtolower($charset);
+ if (function_exists('mb_internal_encoding') &&
+ in_array($charset,sq_mb_list_encodings())) {
+ return mb_strpos($haystack,$needle,$offset,$charset);
+ }
+ // TODO: add mbstring independent code
+
+ // use vanilla string functions as last option
+ return strpos($haystack,$needle,$offset);
+}
+
+/**
+ * Wrapper that is used to switch between vanilla and multibyte strtoupper
+ * functions.
+ * @param string $string
+ * @param string $charset
+ * @return string
+ * @since 1.5.1
+ * @link http://www.php.net/strtoupper
+ * @link http://www.php.net/mb_strtoupper
+ */
+function sq_strtoupper($string,$charset='auto') {
+ // use automatic charset detection, if function call asks for it
+ if ($charset=='auto') {
+ global $default_charset;
+ set_my_charset();
+ $charset=$default_charset;
+ }
+ $charset = strtolower($charset);
+ if (function_exists('mb_internal_encoding') &&
+ in_array($charset,sq_mb_list_encodings())) {
+ return mb_strtoupper($string,$charset);
+ }
+ // TODO: add mbstring independent code
+
+ // use vanilla string functions as last option
+ return strtoupper($string);
+}
+$PHP_SELF = php_self();
+?>
\ No newline at end of file
projects / squirrelmail.git / blobdiff