\n" .
_("ERROR : No available imapstream.") .
"\n";
error_box($string,$color);
return false;
}
}
/**
* @param stream $imap_stream imap connection resource
* @param string $query imap command
* @param boolean $handle_errors see sqimap_retrieve_imap_response()
* @param array $response empty string, if return = false
* @param array $message empty string, if return = false
* @param boolean $unique_id (since 1.3.0) see sqimap_session_id()
* @param boolean $filter (since 1.4.1 and 1.5.0) see sqimap_fread()
* @param mixed $outputstream (since 1.4.1 and 1.5.0) see sqimap_fread()
* @param boolean $no_return (since 1.4.1 and 1.5.0) see sqimap_fread()
* @return mixed returns false on imap error. displays error message
* if imap stream is not available.
* @since 1.2.3
*/
function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response,
&$message, $unique_id = false,$filter=false,
$outputstream=false,$no_return=false) {
if ($imap_stream) {
$sid = sqimap_session_id($unique_id);
fputs ($imap_stream, $sid . ' ' . $query . "\r\n");
$tag_uid_a = explode(' ',trim($sid));
$tag = $tag_uid_a[0];
$read = sqimap_read_data ($imap_stream, $tag, $handle_errors, $response,
$message, $query,$filter,$outputstream,$no_return);
if (empty($read)) { //Imap server dropped its connection
$response = '';
$message = '';
return false;
}
/* retrieve the response and the message */
$response = $response[$tag];
$message = $message[$tag];
if (!empty($read[$tag])) {
return $read[$tag][0];
} else {
return $read[$tag];
}
} else {
global $squirrelmail_language, $color;
set_up_language($squirrelmail_language);
require_once(SM_PATH . 'functions/display_messages.php');
$string = "\n" .
_("ERROR : No available imapstream.") .
"\n";
error_box($string,$color);
return false;
}
}
/**
* @param mixed $new_query
* @param string $tag
* @param array $aQuery
* @param boolean $unique_id see sqimap_session_id()
* @since 1.5.0
*/
function sqimap_prepare_pipelined_query($new_query,&$tag,&$aQuery,$unique_id) {
$sid = sqimap_session_id($unique_id);
$tag_uid_a = explode(' ',trim($sid));
$tag = $tag_uid_a[0];
$query = $sid . ' '.$new_query."\r\n";
$aQuery[$tag] = $query;
}
/**
* @param stream $imap_stream imap stream
* @param array $aQueryList
* @param boolean $handle_errors
* @param array $aServerResponse
* @param array $aServerMessage
* @param boolean $unique_id see sqimap_session_id()
* @param boolean $filter see sqimap_fread()
* @param mixed $outputstream see sqimap_fread()
* @param boolean $no_return see sqimap_fread()
* @since 1.5.0
*/
function sqimap_run_pipelined_command ($imap_stream, $aQueryList, $handle_errors,
&$aServerResponse, &$aServerMessage, $unique_id = false,
$filter=false,$outputstream=false,$no_return=false) {
$aResponse = false;
/*
Do not fire all calls at once to the imap-server but split the calls up
in portions of $iChunkSize. If we do not do that I think we misbehave as
IMAP client or should handle BYE calls if the IMAP-server drops the
connection because the number of queries is to large. This isn't tested
but a wild guess how it could work in the field.
After testing it on Exchange 2000 we discovered that a chunksize of 32
was quicker then when we raised it to 128.
*/
$iQueryCount = count($aQueryList);
$iChunkSize = 32;
// array_chunk would also do the job but it's supported from php > 4.2
$aQueryChunks = array();
$iLoops = floor($iQueryCount / $iChunkSize);
if ($iLoops * $iChunkSize != $iQueryCount) ++$iLoops;
if (!function_exists('array_chunk')) { // arraychunk replacement
reset($aQueryList);
for($i=0;$i<$iLoops;++$i) {
for($j=0;$j<$iChunkSize;++$j) {
$key = key($aQueryList);
$aTmp[$key] = $aQueryList[$key];
if (next($aQueryList) === false) break;
}
$aQueryChunks[] = $aTmp;
}
} else {
$aQueryChunks = array_chunk($aQueryList,$iChunkSize,true);
}
for ($i=0;$i<$iLoops;++$i) {
$aQuery = $aQueryChunks[$i];
foreach($aQuery as $tag => $query) {
fputs($imap_stream,$query);
$aResults[$tag] = false;
}
foreach($aQuery as $tag => $query) {
if ($aResults[$tag] == false) {
$aReturnedResponse = sqimap_retrieve_imap_response ($imap_stream, $tag,
$handle_errors, $response, $message, $query,
$filter,$outputstream,$no_return);
foreach ($aReturnedResponse as $returned_tag => $aResponse) {
if (!empty($aResponse)) {
$aResults[$returned_tag] = $aResponse[0];
} else {
$aResults[$returned_tag] = $aResponse;
}
$aServerResponse[$returned_tag] = $response[$returned_tag];
$aServerMessage[$returned_tag] = $message[$returned_tag];
}
}
}
}
return $aResults;
}
/**
* Custom fgets function: gets a line from the IMAP-server,
* no matter how big it may be.
* @param stream $imap_stream the stream to read from
* @return string a line
* @since 1.2.8
*/
function sqimap_fgets($imap_stream) {
$read = '';
$buffer = 4096;
$results = '';
$offset = 0;
while (strpos($results, "\r\n", $offset) === false) {
if (!($read = fgets($imap_stream, $buffer))) {
/* this happens in case of an error */
/* reset $results because it's useless */
$results = false;
break;
}
if ( $results != '' ) {
$offset = strlen($results) - 1;
}
$results .= $read;
}
return $results;
}
/**
* @param stream $imap_stream
* @param integer $iSize
* @param boolean $filter
* @param mixed $outputstream stream or 'php://stdout' string
* @param boolean $no_return controls data returned by function
* @return string
* @since 1.4.1
*/
function sqimap_fread($imap_stream,$iSize,$filter=false,
$outputstream=false, $no_return=false) {
if (!$filter || !$outputstream) {
$iBufferSize = $iSize;
} else {
// see php bug 24033. They changed fread behaviour %$^&$%
$iBufferSize = 7800; // multiple of 78 in case of base64 decoding.
}
if ($iSize < $iBufferSize) {
$iBufferSize = $iSize;
}
$iRetrieved = 0;
$results = '';
$sRead = $sReadRem = '';
// NB: fread can also stop at end of a packet on sockets.
while ($iRetrieved < $iSize) {
$sRead = fread($imap_stream,$iBufferSize);
$iLength = strlen($sRead);
$iRetrieved += $iLength ;
$iRemaining = $iSize - $iRetrieved;
if ($iRemaining < $iBufferSize) {
$iBufferSize = $iRemaining;
}
if ($sRead == '') {
$results = false;
break;
}
if ($sReadRem != '') {
$sRead = $sReadRem . $sRead;
$sReadRem = '';
}
if ($filter && $sRead != '') {
// in case the filter is base64 decoding we return a remainder
$sReadRem = $filter($sRead);
}
if ($outputstream && $sRead != '') {
if (is_resource($outputstream)) {
fwrite($outputstream,$sRead);
} else if ($outputstream == 'php://stdout') {
echo $sRead;
}
}
if ($no_return) {
$sRead = '';
} else {
$results .= $sRead;
}
}
return $results;
}
/**
* Obsolete function, inform plugins that use it
* @param stream $imap_stream
* @param string $tag
* @param boolean $handle_errors
* @param array $response
* @param array $message
* @param string $query
* @since 1.1.3
* @deprecated (since 1.5.0) use sqimap_run_command or sqimap_run_command_list instead
*/
function sqimap_read_data_list($imap_stream, $tag, $handle_errors,
&$response, &$message, $query = '') {
global $color, $squirrelmail_language;
set_up_language($squirrelmail_language);
require_once(SM_PATH . 'functions/display_messages.php');
$string = "\n" .
_("ERROR : Bad function call.") .
"
\n" .
_("Reason:") . ' '.
'There is a plugin installed which make use of the
' .
'SquirrelMail internal function sqimap_read_data_list.
'.
'Please adapt the installed plugin and let it use
'.
'sqimap_run_command or sqimap_run_command_list instead
'.
'The following query was issued:
'.
htmlspecialchars($query) . '
' . "
\n";
error_box($string,$color);
echo '