- Fix busy loop and notice when two literals in IMAP fetch (#1739433).
[squirrelmail.git] / functions / imap_general.php
CommitLineData
59177427 1<?php
bccadd02 2
35586184 3/**
a6fd80f5 4 * imap_general.php
35586184 5 *
0e1a248b 6 * This implements all functions that do general IMAP functions.
35586184 7 *
4b5049de 8 * @copyright &copy; 1999-2007 The SquirrelMail Project Team
4b4abf93 9 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
eb19bc67 10 * @version $Id$
d6c32258 11 * @package squirrelmail
eb19bc67 12 * @subpackage imap
35586184 13 */
14
d6c32258 15/** Includes.. */
202bcbcc 16
17require_once(SM_PATH . 'functions/rfc822address.php');
47a29326 18
35586184 19
48af4b64 20/**
21 * Generates a new session ID by incrementing the last one used;
22 * this ensures that each command has a unique ID.
0e1a248b 23 * @param bool $unique_id (since 1.3.0) controls use of unique
b35a5862 24 * identifiers/message sequence numbers in IMAP commands. See IMAP
25 * rfc 'UID command' chapter.
48af4b64 26 * @return string IMAP session id of the form 'A000'.
b35a5862 27 * @since 1.2.0
48af4b64 28 */
2aca19a1 29function sqimap_session_id($unique_id = FALSE) {
30 static $sqimap_session_id = 1;
31
487daa81 32 if (!$unique_id) {
098ea084 33 return( sprintf("A%03d", $sqimap_session_id++) );
487daa81 34 } else {
098ea084 35 return( sprintf("A%03d", $sqimap_session_id++) . ' UID' );
487daa81 36 }
9c737111 37}
38
48af4b64 39/**
3411d4ec 40 * Both send a command and accept the result from the command.
41 * This is to allow proper session number handling.
95e3afc1 42 * @param stream $imap_stream imap connection resource
b35a5862 43 * @param string $query imap command
44 * @param boolean $handle_errors see sqimap_retrieve_imap_response()
95e3afc1 45 * @param array $response
46 * @param array $message
47 * @param boolean $unique_id (since 1.3.0) see sqimap_session_id().
0e1a248b 48 * @return mixed returns false on imap error. displays error message
b35a5862 49 * if imap stream is not available.
50 * @since 1.2.3
3411d4ec 51 */
487daa81 52function sqimap_run_command_list ($imap_stream, $query, $handle_errors, &$response, &$message, $unique_id = false) {
c5809184 53 if ($imap_stream) {
098ea084 54 $sid = sqimap_session_id($unique_id);
55 fputs ($imap_stream, $sid . ' ' . $query . "\r\n");
bc78cc6e 56 $tag_uid_a = explode(' ',trim($sid));
57 $tag = $tag_uid_a[0];
0dc05a81 58 $read = sqimap_retrieve_imap_response ($imap_stream, $tag, $handle_errors, $response, $message, $query );
bc78cc6e 59 /* get the response and the message */
60 $message = $message[$tag];
1e0a2f0e 61 $response = $response[$tag];
bc78cc6e 62 return $read[$tag];
c5809184 63 } else {
64 global $squirrelmail_language, $color;
65 set_up_language($squirrelmail_language);
6fd95361 66 $string = "<b><font color=\"$color[2]\">\n" .
0e1a248b 67 _("ERROR: No available IMAP stream.") .
c5809184 68 "</b></font>\n";
1b858d86 69 error_box($string);
098ea084 70 return false;
c5809184 71 }
1c72b151 72}
73
b35a5862 74/**
95e3afc1 75 * @param stream $imap_stream imap connection resource
b35a5862 76 * @param string $query imap command
77 * @param boolean $handle_errors see sqimap_retrieve_imap_response()
95e3afc1 78 * @param array $response empty string, if return = false
79 * @param array $message empty string, if return = false
80 * @param boolean $unique_id (since 1.3.0) see sqimap_session_id()
81 * @param boolean $filter (since 1.4.1 and 1.5.0) see sqimap_fread()
82 * @param mixed $outputstream (since 1.4.1 and 1.5.0) see sqimap_fread()
83 * @param boolean $no_return (since 1.4.1 and 1.5.0) see sqimap_fread()
0e1a248b 84 * @return mixed returns false on imap error. displays error message
b35a5862 85 * if imap stream is not available.
86 * @since 1.2.3
87 */
1e0a2f0e 88function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response,
7c7b74b3 89 &$message, $unique_id = false,$filter=false,
90 $outputstream=false,$no_return=false) {
c5809184 91 if ($imap_stream) {
92 $sid = sqimap_session_id($unique_id);
1e0a2f0e 93 fputs ($imap_stream, $sid . ' ' . $query . "\r\n");
bc78cc6e 94 $tag_uid_a = explode(' ',trim($sid));
95 $tag = $tag_uid_a[0];
1e0a2f0e 96
bc78cc6e 97 $read = sqimap_read_data ($imap_stream, $tag, $handle_errors, $response,
7c7b74b3 98 $message, $query,$filter,$outputstream,$no_return);
0e1a248b 99 if (empty($read)) { //IMAP server dropped its connection
ec73f243 100 $response = '';
101 $message = '';
102 return false;
103 }
bc78cc6e 104 /* retrieve the response and the message */
105 $response = $response[$tag];
106 $message = $message[$tag];
1e0a2f0e 107
bc78cc6e 108 if (!empty($read[$tag])) {
109 return $read[$tag][0];
110 } else {
111 return $read[$tag];
112 }
c5809184 113 } else {
114 global $squirrelmail_language, $color;
115 set_up_language($squirrelmail_language);
6fd95361 116 $string = "<b><font color=\"$color[2]\">\n" .
0e1a248b 117 _("ERROR: No available IMAP stream.") .
c5809184 118 "</b></font>\n";
1b858d86 119 error_box($string);
098ea084 120 return false;
1e0a2f0e 121 }
bc78cc6e 122}
48af4b64 123
0022f6db 124/**
125 * @param mixed $new_query
126 * @param string $tag
127 * @param array $aQuery
95e3afc1 128 * @param boolean $unique_id see sqimap_session_id()
0022f6db 129 * @since 1.5.0
130 */
bc78cc6e 131function sqimap_prepare_pipelined_query($new_query,&$tag,&$aQuery,$unique_id) {
132 $sid = sqimap_session_id($unique_id);
133 $tag_uid_a = explode(' ',trim($sid));
134 $tag = $tag_uid_a[0];
0b38d197 135 $query = $sid . ' '.$new_query."\r\n";
bc78cc6e 136 $aQuery[$tag] = $query;
42a07ac1 137}
138
0022f6db 139/**
95e3afc1 140 * @param stream $imap_stream imap stream
0022f6db 141 * @param array $aQueryList
142 * @param boolean $handle_errors
143 * @param array $aServerResponse
144 * @param array $aServerMessage
95e3afc1 145 * @param boolean $unique_id see sqimap_session_id()
146 * @param boolean $filter see sqimap_fread()
147 * @param mixed $outputstream see sqimap_fread()
148 * @param boolean $no_return see sqimap_fread()
0022f6db 149 * @since 1.5.0
150 */
1e0a2f0e 151function sqimap_run_pipelined_command ($imap_stream, $aQueryList, $handle_errors,
bc78cc6e 152 &$aServerResponse, &$aServerMessage, $unique_id = false,
1e0a2f0e 153 $filter=false,$outputstream=false,$no_return=false) {
bc78cc6e 154 $aResponse = false;
5c300c60 155
1e0a2f0e 156 /*
0e1a248b 157 Do not fire all calls at once to the IMAP server but split the calls up
1e0a2f0e 158 in portions of $iChunkSize. If we do not do that I think we misbehave as
0e1a248b 159 IMAP client or should handle BYE calls if the IMAP server drops the
52c8b585 160 connection because the number of queries is to large. This isn't tested
161 but a wild guess how it could work in the field.
1e0a2f0e 162
163 After testing it on Exchange 2000 we discovered that a chunksize of 32
0b38d197 164 was quicker then when we raised it to 128.
52c8b585 165 */
166 $iQueryCount = count($aQueryList);
167 $iChunkSize = 32;
168 // array_chunk would also do the job but it's supported from php > 4.2
169 $aQueryChunks = array();
170 $iLoops = floor($iQueryCount / $iChunkSize);
171
5c300c60 172 if ($iLoops * $iChunkSize != $iQueryCount) ++$iLoops;
52c8b585 173
174 if (!function_exists('array_chunk')) { // arraychunk replacement
5c300c60 175 reset($aQueryList);
52c8b585 176 for($i=0;$i<$iLoops;++$i) {
5c300c60 177 for($j=0;$j<$iChunkSize;++$j) {
178 $key = key($aQueryList);
179 $aTmp[$key] = $aQueryList[$key];
180 if (next($aQueryList) === false) break;
181 }
182 $aQueryChunks[] = $aTmp;
1e0a2f0e 183 }
52c8b585 184 } else {
185 $aQueryChunks = array_chunk($aQueryList,$iChunkSize,true);
bc78cc6e 186 }
1e0a2f0e 187
52c8b585 188 for ($i=0;$i<$iLoops;++$i) {
189 $aQuery = $aQueryChunks[$i];
190 foreach($aQuery as $tag => $query) {
191 fputs($imap_stream,$query);
192 $aResults[$tag] = false;
193 }
52c8b585 194 foreach($aQuery as $tag => $query) {
5c300c60 195 if ($aResults[$tag] == false) {
1e0a2f0e 196 $aReturnedResponse = sqimap_retrieve_imap_response ($imap_stream, $tag,
bc78cc6e 197 $handle_errors, $response, $message, $query,
198 $filter,$outputstream,$no_return);
52c8b585 199 foreach ($aReturnedResponse as $returned_tag => $aResponse) {
5c300c60 200 if (!empty($aResponse)) {
52c8b585 201 $aResults[$returned_tag] = $aResponse[0];
5c300c60 202 } else {
203 $aResults[$returned_tag] = $aResponse;
204 }
52c8b585 205 $aServerResponse[$returned_tag] = $response[$returned_tag];
206 $aServerMessage[$returned_tag] = $message[$returned_tag];
207 }
bc78cc6e 208 }
209 }
210 }
b7277e4f 211 return $aResults;
bc78cc6e 212}
9c737111 213
1e0a2f0e 214/**
0e1a248b 215 * Custom fgets function: gets a line from the IMAP server,
48af4b64 216 * no matter how big it may be.
95e3afc1 217 * @param stream $imap_stream the stream to read from
48af4b64 218 * @return string a line
0022f6db 219 * @since 1.2.8
b8c285ab 220 */
b8c285ab 221function sqimap_fgets($imap_stream) {
222 $read = '';
223 $buffer = 4096;
224 $results = '';
c41daf03 225 $offset = 0;
226 while (strpos($results, "\r\n", $offset) === false) {
b8c285ab 227 if (!($read = fgets($imap_stream, $buffer))) {
329a7ca5 228 /* this happens in case of an error */
229 /* reset $results because it's useless */
230 $results = false;
b8c285ab 231 break;
232 }
c41daf03 233 if ( $results != '' ) {
234 $offset = strlen($results) - 1;
235 }
b8c285ab 236 $results .= $read;
237 }
238 return $results;
239}
240
0022f6db 241/**
242 * @param stream $imap_stream
243 * @param integer $iSize
95e3afc1 244 * @param boolean $filter
245 * @param mixed $outputstream stream or 'php://stdout' string
0e1a248b 246 * @param boolean $no_return controls data returned by function
0022f6db 247 * @return string
248 * @since 1.4.1
249 */
7c7b74b3 250function sqimap_fread($imap_stream,$iSize,$filter=false,
251 $outputstream=false, $no_return=false) {
252 if (!$filter || !$outputstream) {
253 $iBufferSize = $iSize;
254 } else {
811318c5 255 // see php bug 24033. They changed fread behaviour %$^&$%
977a6085 256 $iBufferSize = 7800; // multiple of 78 in case of base64 decoding.
257 }
258 if ($iSize < $iBufferSize) {
259 $iBufferSize = $iSize;
7c7b74b3 260 }
7c0ec1d8 261
5eba0be2 262 $iRetrieved = 0;
977a6085 263 $results = '';
264 $sRead = $sReadRem = '';
1e0a2f0e 265 // NB: fread can also stop at end of a packet on sockets.
977a6085 266 while ($iRetrieved < $iSize) {
7c7b74b3 267 $sRead = fread($imap_stream,$iBufferSize);
977a6085 268 $iLength = strlen($sRead);
269 $iRetrieved += $iLength ;
270 $iRemaining = $iSize - $iRetrieved;
271 if ($iRemaining < $iBufferSize) {
272 $iBufferSize = $iRemaining;
273 }
13aabbcf 274 if ($sRead == '') {
7c7b74b3 275 $results = false;
276 break;
277 }
13aabbcf 278 if ($sReadRem != '') {
977a6085 279 $sRead = $sReadRem . $sRead;
280 $sReadRem = '';
281 }
7c0ec1d8 282
13aabbcf 283 if ($filter && $sRead != '') {
1e0a2f0e 284 // in case the filter is base64 decoding we return a remainder
7c0ec1d8 285 $sReadRem = $filter($sRead);
7c7b74b3 286 }
13aabbcf 287 if ($outputstream && $sRead != '') {
7c7b74b3 288 if (is_resource($outputstream)) {
289 fwrite($outputstream,$sRead);
290 } else if ($outputstream == 'php://stdout') {
291 echo $sRead;
292 }
293 }
294 if ($no_return) {
295 $sRead = '';
1e0a2f0e 296 } else {
977a6085 297 $results .= $sRead;
7c7b74b3 298 }
7c7b74b3 299 }
1e0a2f0e 300 return $results;
301}
977a6085 302
7c0ec1d8 303
48af4b64 304/**
305 * Obsolete function, inform plugins that use it
95e3afc1 306 * @param stream $imap_stream
307 * @param string $tag
308 * @param boolean $handle_errors
309 * @param array $response
310 * @param array $message
311 * @param string $query
b35a5862 312 * @since 1.1.3
313 * @deprecated (since 1.5.0) use sqimap_run_command or sqimap_run_command_list instead
48af4b64 314 */
1e0a2f0e 315function sqimap_read_data_list($imap_stream, $tag, $handle_errors,
0dc05a81 316 &$response, &$message, $query = '') {
1b858d86 317 global $color, $oTemplate, $squirrelmail_language;
0dc05a81 318 set_up_language($squirrelmail_language);
6fd95361 319 $string = "<b><font color=\"$color[2]\">\n" .
0e1a248b 320 _("ERROR: Bad function call.") .
6fd95361 321 "</b><br />\n" .
0dc05a81 322 _("Reason:") . ' '.
6fd95361 323 'There is a plugin installed which make use of the <br />' .
324 'SquirrelMail internal function sqimap_read_data_list.<br />'.
325 'Please adapt the installed plugin and let it use<br />'.
326 'sqimap_run_command or sqimap_run_command_list instead<br /><br />'.
327 'The following query was issued:<br />'.
328 htmlspecialchars($query) . '<br />' . "</font><br />\n";
1b858d86 329 error_box($string);
330 $oTemplate->display('footer.tpl');
1e0a2f0e 331 exit;
0dc05a81 332}
7c7b74b3 333
48af4b64 334/**
0e1a248b 335 * Function to display an error related to an IMAP query.
48af4b64 336 * @param string title the caption of the error box
337 * @param string query the query that went wrong
ec73f243 338 * @param string message_title optional message title
339 * @param string message optional error message
340 * @param string $link an optional link to try again
48af4b64 341 * @return void
0022f6db 342 * @since 1.5.0
48af4b64 343 */
ec73f243 344function sqimap_error_box($title, $query = '', $message_title = '', $message = '', $link = '')
4974c2a0 345{
346 global $color, $squirrelmail_language;
347
348 set_up_language($squirrelmail_language);
6fd95361 349 $string = "<font color=\"$color[2]\"><b>\n" . $title . "</b><br />\n";
bf15f116 350 $cmd = explode(' ',$query);
351 $cmd= strtolower($cmd[0]);
352
353 if ($query != '' && $cmd != 'login')
6fd95361 354 $string .= _("Query:") . ' ' . htmlspecialchars($query) . '<br />';
4974c2a0 355 if ($message_title != '')
356 $string .= $message_title;
357 if ($message != '')
358 $string .= htmlspecialchars($message);
6fd95361 359 $string .= "</font><br />\n";
ec73f243 360 if ($link != '')
361 $string .= $link;
1b858d86 362 error_box($string);
4974c2a0 363}
364
48af4b64 365/**
3411d4ec 366 * Reads the output from the IMAP stream. If handle_errors is set to true,
367 * this will also handle all errors that are received. If it is not set,
48af4b64 368 * the errors will be sent back through $response and $message.
95e3afc1 369 * @param stream $imap_stream imap stream
370 * @param string $tag
371 * @param boolean $handle_errors handle errors internally or send them in $response and $message.
0022f6db 372 * @param array $response
373 * @param array $message
95e3afc1 374 * @param string $query command that can be printed if something fails
375 * @param boolean $filter see sqimap_fread()
376 * @param mixed $outputstream see sqimap_fread()
377 * @param boolean $no_return see sqimap_fread()
0022f6db 378 * @since 1.5.0
bee165ef 379 */
1e0a2f0e 380function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors,
7c7b74b3 381 &$response, &$message, $query = '',
382 $filter = false, $outputstream = false, $no_return = false) {
9c737111 383 global $color, $squirrelmail_language;
9c737111 384 $read = '';
bc78cc6e 385 if (!is_array($message)) $message = array();
386 if (!is_array($response)) $response = array();
ec73f243 387 $aResponse = '';
b8c285ab 388 $resultlist = array();
389 $data = array();
ee231c8b 390 $sCommand = '';
391 if (preg_match("/^(\w+)\s*/",$query,$aMatch)) {
392 $sCommand = strtoupper($aMatch[1]);
393 } else {
394 // error reporting (shouldn't happen)
395 }
b8c285ab 396 $read = sqimap_fgets($imap_stream);
8d8da447 397 $i = 0;
bea3eb1e 398 while ($read) {
399 $char = $read{0};
400 switch ($char)
401 {
15bc7f66 402 case '+':
403 default:
404 $read = sqimap_fgets($imap_stream);
405 break;
406
407 case $tag{0}:
408 {
bea3eb1e 409 /* get the command */
410 $arg = '';
411 $i = strlen($tag)+1;
412 $s = substr($read,$i);
413 if (($j = strpos($s,' ')) || ($j = strpos($s,"\n"))) {
414 $arg = substr($s,0,$j);
415 }
416 $found_tag = substr($read,0,$i-1);
5c300c60 417 if ($found_tag) {
bea3eb1e 418 switch ($arg)
419 {
15bc7f66 420 case 'OK':
421 case 'BAD':
422 case 'NO':
423 case 'BYE':
424 case 'PREAUTH':
bc78cc6e 425 $response[$found_tag] = $arg;
426 $message[$found_tag] = trim(substr($read,$i+strlen($arg)));
427 if (!empty($data)) {
428 $resultlist[] = $data;
429 }
5c300c60 430 $aResponse[$found_tag] = $resultlist;
431 $data = $resultlist = array();
432 if ($found_tag == $tag) {
433 break 3; /* switch switch while */
434 }
435 break;
1e0a2f0e 436 default:
bea3eb1e 437 /* this shouldn't happen */
bc78cc6e 438 $response[$found_tag] = $arg;
439 $message[$found_tag] = trim(substr($read,$i+strlen($arg)));
440 if (!empty($data)) {
441 $resultlist[] = $data;
442 }
443 $aResponse[$found_tag] = $resultlist;
5c300c60 444 $data = $resultlist = array();
445 if ($found_tag == $tag) {
446 break 3; /* switch switch while */
447 }
bc78cc6e 448 }
bea3eb1e 449 }
5c300c60 450 $read = sqimap_fgets($imap_stream);
451 if ($read === false) { /* error */
4920e1e0 452 break 2; /* switch while */
5c300c60 453 }
454 break;
15bc7f66 455 } // end case $tag{0}
456
457 case '*':
458 {
202bcbcc 459 if (($sCommand == "FETCH" || $sCommand == "STORE") && preg_match('/^\*\s\d+\sFETCH/',$read)) {
bea3eb1e 460 /* check for literal */
461 $s = substr($read,-3);
462 $fetch_data = array();
463 do { /* outer loop, continue until next untagged fetch
464 or tagged reponse */
465 do { /* innerloop for fetching literals. with this loop
466 we prohibid that literal responses appear in the
467 outer loop so we can trust the untagged and
468 tagged info provided by $read */
935d09e1 469 $read_literal = false;
bea3eb1e 470 if ($s === "}\r\n") {
471 $j = strrpos($read,'{');
472 $iLit = substr($read,$j+1,-3);
473 $fetch_data[] = $read;
7c7b74b3 474 $sLiteral = sqimap_fread($imap_stream,$iLit,$filter,$outputstream,$no_return);
329a7ca5 475 if ($sLiteral === false) { /* error */
476 break 4; /* while while switch while */
477 }
bea3eb1e 478 /* backwards compattibility */
479 $aLiteral = explode("\n", $sLiteral);
480 /* release not neaded data */
481 unset($sLiteral);
482 foreach ($aLiteral as $line) {
483 $fetch_data[] = $line ."\n";
484 }
485 /* release not neaded data */
1e0a2f0e 486 unset($aLiteral);
bea3eb1e 487 /* next fgets belongs to this fetch because
488 we just got the exact literalsize and there
489 must follow data to complete the response */
329a7ca5 490 $read = sqimap_fgets($imap_stream);
491 if ($read === false) { /* error */
492 break 4; /* while while switch while */
493 }
935d09e1 494 $s = substr($read,-3);
495 $read_literal = true;
496 continue;
bea3eb1e 497 } else {
329a7ca5 498 $fetch_data[] = $read;
bea3eb1e 499 }
500 /* retrieve next line and check in the while
501 statements if it belongs to this fetch response */
502 $read = sqimap_fgets($imap_stream);
329a7ca5 503 if ($read === false) { /* error */
504 break 4; /* while while switch while */
505 }
bea3eb1e 506 /* check for next untagged reponse and break */
507 if ($read{0} == '*') break 2;
508 $s = substr($read,-3);
935d09e1 509 } while ($s === "}\r\n" || $read_literal);
bea3eb1e 510 $s = substr($read,-3);
511 } while ($read{0} !== '*' &&
106d4087 512 substr($read,0,strlen($tag)) !== $tag);
329a7ca5 513 $resultlist[] = $fetch_data;
bea3eb1e 514 /* release not neaded data */
515 unset ($fetch_data);
516 } else {
517 $s = substr($read,-3);
518 do {
519 if ($s === "}\r\n") {
520 $j = strrpos($read,'{');
521 $iLit = substr($read,$j+1,-3);
9c093ecf 522 // check for numeric value to avoid that untagged responses like:
523 // * OK [PARSE] Unexpected characters at end of address: {SET:debug=51}
524 // will trigger literal fetching ({SET:debug=51} !== int )
525 if (is_numeric($iLit)) {
526 $data[] = $read;
527 $sLiteral = fread($imap_stream,$iLit);
528 if ($sLiteral === false) { /* error */
529 $read = false;
530 break 3; /* while switch while */
531 }
532 $data[] = $sLiteral;
533 $data[] = sqimap_fgets($imap_stream);
534 } else {
535 $data[] = $read;
329a7ca5 536 }
bea3eb1e 537 } else {
329a7ca5 538 $data[] = $read;
bea3eb1e 539 }
540 $read = sqimap_fgets($imap_stream);
329a7ca5 541 if ($read === false) {
542 break 3; /* while switch while */
543 } else if ($read{0} == '*') {
106d4087 544 break;
545 }
bea3eb1e 546 $s = substr($read,-3);
547 } while ($s === "}\r\n");
548 break 1;
1e0a2f0e 549 }
bea3eb1e 550 break;
15bc7f66 551 } // end case '*'
552 } // end switch
c0b23345 553 } // end while
1e0a2f0e 554
c0b23345 555 /* error processing in case $read is false */
d7542838 556 if ($read === false) {
d3d9ef2d 557 // try to retrieve an untagged bye respons from the results
558 $sResponse = array_pop($data);
d7542838 559 if ($sResponse !== NULL && strpos($sResponse,'* BYE') !== false) {
560 if (!$handle_errors) {
561 $query = '';
562 }
0e1a248b 563 sqimap_error_box(_("ERROR: IMAP server closed the connection."), $query, _("Server responded:"),$sResponse);
d7542838 564 echo '</body></html>';
565 exit;
566 } else if ($handle_errors) {
1e0a2f0e 567 unset($data);
0e1a248b 568 sqimap_error_box(_("ERROR: Connection dropped by IMAP server."), $query);
ec73f243 569 exit;
570 }
b8c285ab 571 }
1e0a2f0e 572
15bc7f66 573 /* Set $resultlist array */
b8c285ab 574 if (!empty($data)) {
bc78cc6e 575 //$resultlist[] = $data;
9c737111 576 }
b8c285ab 577 elseif (empty($resultlist)) {
1e0a2f0e 578 $resultlist[] = array();
b8c285ab 579 }
15bc7f66 580
581 /* Return result or handle errors */
bee165ef 582 if ($handle_errors == false) {
bc78cc6e 583 return $aResponse;
dd381002 584 }
4974c2a0 585 switch ($response[$tag]) {
dd381002 586 case 'OK':
bc78cc6e 587 return $aResponse;
329a7ca5 588 break;
1e0a2f0e 589 case 'NO':
dd381002 590 /* ignore this error from M$ exchange, it is not fatal (aka bug) */
6b6c2e06 591 if (strstr($message[$tag], 'command resulted in') === false) {
0e1a248b 592 sqimap_error_box(_("ERROR: Could not complete request."), $query, _("Reason Given:") . ' ', $message[$tag]);
329a7ca5 593 echo '</body></html>';
052e0c26 594 exit;
9c737111 595 }
329a7ca5 596 break;
1e0a2f0e 597 case 'BAD':
0e1a248b 598 sqimap_error_box(_("ERROR: Bad or malformed request."), $query, _("Server responded:") . ' ', $message[$tag]);
1e0a2f0e 599 echo '</body></html>';
600 exit;
601 case 'BYE':
0e1a248b 602 sqimap_error_box(_("ERROR: IMAP server closed the connection."), $query, _("Server responded:") . ' ', $message[$tag]);
1e0a2f0e 603 echo '</body></html>';
9c737111 604 exit;
1e0a2f0e 605 default:
0e1a248b 606 sqimap_error_box(_("ERROR: Unknown IMAP response."), $query, _("Server responded:") . ' ', $message[$tag]);
329a7ca5 607 /* the error is displayed but because we don't know the reponse we
608 return the result anyway */
1e0a2f0e 609 return $aResponse;
329a7ca5 610 break;
9c737111 611 }
9c737111 612}
613
0022f6db 614/**
95e3afc1 615 * @param stream $imap_stream imap string
0022f6db 616 * @param string $tag_uid
617 * @param boolean $handle_errors
618 * @param array $response
619 * @param array $message
95e3afc1 620 * @param string $query (since 1.2.5)
621 * @param boolean $filter (since 1.4.1) see sqimap_fread()
622 * @param mixed $outputstream (since 1.4.1) see sqimap_fread()
623 * @param boolean $no_return (since 1.4.1) see sqimap_fread()
0022f6db 624 */
1e0a2f0e 625function sqimap_read_data ($imap_stream, $tag_uid, $handle_errors,
7c7b74b3 626 &$response, &$message, $query = '',
627 $filter=false,$outputstream=false,$no_return=false) {
bc78cc6e 628
629 $tag_uid_a = explode(' ',trim($tag_uid));
630 $tag = $tag_uid_a[0];
631
1e0a2f0e 632 $res = sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors,
633 $response, $message, $query,$filter,$outputstream,$no_return);
634 return $res;
9c737111 635}
636
48af4b64 637/**
b98732e8 638 * Connects to the IMAP server and returns a resource identifier for use with
a15f9d93 639 * the other SquirrelMail IMAP functions. Does NOT login!
48af4b64 640 * @param string server hostname of IMAP server
641 * @param int port port number to connect to
a15f9d93 642 * @param integer $tls whether to use plain text(0), TLS(1) or STARTTLS(2) when connecting.
643 * Argument was boolean before 1.5.1.
48af4b64 644 * @return imap-stream resource identifier
0022f6db 645 * @since 1.5.0 (usable only in 1.5.1 or later)
b98732e8 646 */
a15f9d93 647function sqimap_create_stream($server,$port,$tls=0) {
ce68b76b 648 global $squirrelmail_language;
b98732e8 649
abc4a428 650 if (strstr($server,':') && ! preg_match("/^\[.*\]$/",$server)) {
651 // numerical IPv6 address must be enclosed in square brackets
652 $server = '['.$server.']';
653 }
a15f9d93 654
655 if ($tls == 1) {
b98732e8 656 if ((check_php_version(4,3)) and (extension_loaded('openssl'))) {
657 /* Use TLS by prefixing "tls://" to the hostname */
57ffe0af 658 $server = 'tls://' . $server;
b98732e8 659 } else {
660 require_once(SM_PATH . 'functions/display_messages.php');
3b151851 661 logout_error( sprintf(_("Error connecting to IMAP server: %s."), $server).
662 '<br />'.
663 _("TLS is enabled, but this version of PHP does not support TLS sockets, or is missing the openssl extension.").
664 '<br /><br />'.
0a6be7d1 665 _("Please contact your system administrator and report this error."),
abc4a428 666 sprintf(_("Error connecting to IMAP server: %s."), $server));
b98732e8 667 }
668 }
669
82f403aa 670 $imap_stream = @fsockopen($server, $port, $error_number, $error_string, 15);
b98732e8 671
672 /* Do some error correction */
673 if (!$imap_stream) {
674 set_up_language($squirrelmail_language, true);
675 require_once(SM_PATH . 'functions/display_messages.php');
3b151851 676 logout_error( sprintf(_("Error connecting to IMAP server: %s."), $server).
0a6be7d1 677 "<br />\r\n$error_number : $error_string<br />\r\n",
abc4a428 678 sprintf(_("Error connecting to IMAP server: %s."), $server) );
b98732e8 679 exit;
680 }
681 $server_info = fgets ($imap_stream, 1024);
a15f9d93 682
683 /**
684 * Implementing IMAP STARTTLS (rfc2595) in php 5.1.0+
685 * http://www.php.net/stream-socket-enable-crypto
686 */
c4de9863 687 if ($tls === 2) {
a15f9d93 688 if (function_exists('stream_socket_enable_crypto')) {
689 // check starttls capability, don't use cached capability version
690 if (! sqimap_capability($imap_stream, 'STARTTLS', false)) {
691 // imap server does not declare starttls support
692 sqimap_error_box(sprintf(_("Error connecting to IMAP server: %s."), $server),
693 '','',
694 _("IMAP STARTTLS is enabled in SquirrelMail configuration, but used IMAP server does not support STARTTLS."));
695 exit;
696 }
697
698 // issue starttls command and check response
699 sqimap_run_command($imap_stream, 'STARTTLS', false, $starttls_response, $starttls_message);
700 // check response
701 if ($starttls_response!='OK') {
702 // starttls command failed
703 sqimap_error_box(sprintf(_("Error connecting to IMAP server: %s."), $server),
704 'STARTTLS',
3c021d16 705 _("Server replied:") . ' ',
a15f9d93 706 $starttls_message);
707 exit();
708 }
709
710 // start crypto on connection. suppress function errors.
711 if (@stream_socket_enable_crypto($imap_stream,true,STREAM_CRYPTO_METHOD_TLS_CLIENT)) {
712 // starttls was successful
713
714 /**
4ae9beb7 715 * RFC 2595 requires to discard CAPABILITY information after successful
716 * STARTTLS command. We don't follow RFC, because SquirrelMail stores CAPABILITY
717 * information only after successful login (src/redirect.php) and cached information
718 * is used only in other php script connections after successful STARTTLS. If script
719 * issues sqimap_capability() call before sqimap_login() and wants to get initial
720 * capability response, script should set third sqimap_capability() argument to false.
a15f9d93 721 */
4ae9beb7 722 //sqsession_unregister('sqimap_capabilities');
a15f9d93 723 } else {
724 /**
725 * stream_socket_enable_crypto() call failed. Possible issues:
726 * - broken ssl certificate (uw drops connection, error is in syslog mail facility)
4ae9beb7 727 * - some ssl error (can reproduce with STREAM_CRYPTO_METHOD_SSLv3_CLIENT, PHP E_WARNING
a15f9d93 728 * suppressed in stream_socket_enable_crypto() call)
729 */
730 sqimap_error_box(sprintf(_("Error connecting to IMAP server: %s."), $server),
731 '','',
732 _("Unable to start TLS."));
733 /**
4ae9beb7 734 * Bug: stream_socket_enable_crypto() does not register SSL errors in
735 * openssl_error_string() or stream notification wrapper and displays
736 * them in E_WARNING level message. It is impossible to retrieve error
a15f9d93 737 * message without own error handler.
738 */
739 exit;
740 }
741 } else {
742 // php install does not support stream_socket_enable_crypto() function
743 sqimap_error_box(sprintf(_("Error connecting to IMAP server: %s."), $server),
744 '','',
745 _("IMAP STARTTLS is enabled in SquirrelMail configuration, but used PHP version does not support functions that allow to enable encryption on open socket."));
746 exit;
747 }
748 }
b98732e8 749 return $imap_stream;
750}
751
48af4b64 752/**
0e1a248b 753 * Logs the user into the IMAP server. If $hide is set, no error messages
b86f98e4 754 * will be displayed (if set to 1, just exits, if set to 2, returns FALSE).
41d66087 755 * This function returns the IMAP connection handle.
0022f6db 756 * @param string $username user name
9c093ecf 757 * @param string $password password encrypted with onetimepad. Since 1.5.2
758 * function can use internal password functions, if parameter is set to
759 * boolean false.
0022f6db 760 * @param string $imap_server_address address of imap server
761 * @param integer $imap_port port of imap server
41d66087 762 * @param int $hide controls display connection errors:
5a908046 763 * 0 = do not hide
764 * 1 = show no errors (just exit)
765 * 2 = show no errors (return FALSE)
b4e0d365 766 * 3 = show no errors (return error string)
767 * @return mixed The IMAP connection stream, or if the connection fails,
b86f98e4 768 * FALSE if $hide is set to 2 or an error string if $hide
b4e0d365 769 * is set to 3.
3411d4ec 770 */
9c737111 771function sqimap_login ($username, $password, $imap_server_address, $imap_port, $hide) {
fe55c7c7 772 global $color, $squirrelmail_language, $onetimepad, $use_imap_tls,
773 $imap_auth_mech, $sqimap_capabilities;
85fc999e 774
b0434236 775 // Note/TODO: This hack grabs the $authz argument from the session. In the short future,
776 // a new argument in function sqimap_login() will be used instead.
777 $authz = '';
778 global $authz;
779 sqgetglobalvar('authz' , $authz , SQ_SESSION);
780
781 if(!empty($authz)) {
782 /* authz plugin - specific:
b86f98e4 783 * Get proxy login parameters from authz plugin configuration. If they
b0434236 784 * exist, they will override the current ones.
785 * This is useful if we want to use different SASL authentication mechanism
786 * and/or different TLS settings for proxy logins. */
b86f98e4 787 global $authz_imap_auth_mech, $authz_use_imap_tls, $authz_imapPort_tls;
b0434236 788 $imap_auth_mech = !empty($authz_imap_auth_mech) ? strtolower($authz_imap_auth_mech) : $imap_auth_mech;
6a645613 789 $use_imap_tls = !empty($authz_use_imap_tls)? $authz_use_imap_tls : $use_imap_tls;
790 $imap_port = !empty($authz_use_imap_tls)? $authz_imapPort_tls : $imap_port;
b0434236 791
792 if($imap_auth_mech == 'login' || $imap_auth_mech == 'cram-md5') {
793 logout_error("Misconfigured Plugin (authz or equivalent):<br/>".
794 "The LOGIN and CRAM-MD5 authentication mechanisms cannot be used when attempting proxy login.");
795 exit;
796 }
797 }
798
045ec1a1 799 /* get imap login password */
800 if ($password===false) {
801 /* standard functions */
802 $password = sqauth_read_password();
803 } else {
804 /* old way. $key must be extracted from cookie */
805 if (!isset($onetimepad) || empty($onetimepad)) {
806 sqgetglobalvar('onetimepad' , $onetimepad , SQ_SESSION );
807 }
808 /* Decrypt the password */
809 $password = OneTimePadDecrypt($password, $onetimepad);
eb2f6102 810 }
045ec1a1 811
fe55c7c7 812 if (!isset($sqimap_capabilities)) {
72bc549b 813 sqgetglobalvar('sqimap_capabilities' , $sqimap_capabilities , SQ_SESSION );
fe55c7c7 814 }
815
b98732e8 816 $host = $imap_server_address;
bd9829d7 817 $imap_server_address = sqimap_get_user_server($imap_server_address, $username);
fe55c7c7 818
b98732e8 819 $imap_stream = sqimap_create_stream($imap_server_address,$imap_port,$use_imap_tls);
fe55c7c7 820
b98732e8 821 if (($imap_auth_mech == 'cram-md5') OR ($imap_auth_mech == 'digest-md5')) {
3b151851 822 // We're using some sort of authentication OTHER than plain or login
b98732e8 823 $tag=sqimap_session_id(false);
824 if ($imap_auth_mech == 'digest-md5') {
098ea084 825 $query = $tag . " AUTHENTICATE DIGEST-MD5\r\n";
b98732e8 826 } elseif ($imap_auth_mech == 'cram-md5') {
098ea084 827 $query = $tag . " AUTHENTICATE CRAM-MD5\r\n";
b98732e8 828 }
829 fputs($imap_stream,$query);
830 $answer=sqimap_fgets($imap_stream);
831 // Trim the "+ " off the front
832 $response=explode(" ",$answer,3);
833 if ($response[0] == '+') {
098ea084 834 // Got a challenge back
b98732e8 835 $challenge=$response[1];
836 if ($imap_auth_mech == 'digest-md5') {
b0434236 837 $reply = digest_md5_response($username,$password,$challenge,'imap',$host,$authz);
b98732e8 838 } elseif ($imap_auth_mech == 'cram-md5') {
839 $reply = cram_md5_response($username,$password,$challenge);
840 }
841 fputs($imap_stream,$reply);
842 $read=sqimap_fgets($imap_stream);
843 if ($imap_auth_mech == 'digest-md5') {
3b151851 844 // DIGEST-MD5 has an extra step..
b98732e8 845 if (substr($read,0,1) == '+') { // OK so far..
098ea084 846 fputs($imap_stream,"\r\n");
847 $read=sqimap_fgets($imap_stream);
098ea084 848 }
b98732e8 849 }
850 $results=explode(" ",$read,3);
851 $response=$results[1];
852 $message=$results[2];
853 } else {
3b151851 854 // Fake the response, so the error trap at the bottom will work
b98732e8 855 $response="BAD";
856 $message='IMAP server does not appear to support the authentication method selected.';
857 $message .= ' Please contact your system administrator.';
858 }
fe0b18b3 859 } elseif ($imap_auth_mech == 'login') {
b98732e8 860 // Original IMAP login code
861 $query = 'LOGIN "' . quoteimap($username) . '" "' . quoteimap($password) . '"';
862 $read = sqimap_run_command ($imap_stream, $query, false, $response, $message);
1e7fc1cb 863 } elseif ($imap_auth_mech == 'plain') {
fe55c7c7 864 /***
b0434236 865 * SASL PLAIN, RFC 4616 (updates 2595)
fe55c7c7 866 *
b0434236 867 * The mechanism consists of a single message, a string of [UTF-8]
868 * encoded [Unicode] characters, from the client to the server. The
869 * client presents the authorization identity (identity to act as),
870 * followed by a NUL (U+0000) character, followed by the authentication
871 * identity (identity whose password will be used), followed by a NUL
872 * (U+0000) character, followed by the clear-text password. As with
873 * other SASL mechanisms, the client does not provide an authorization
874 * identity when it wishes the server to derive an identity from the
875 * credentials and use that as the authorization identity.
876 */
b98732e8 877 $tag=sqimap_session_id(false);
72bc549b 878 $sasl = (isset($sqimap_capabilities['SASL-IR']) && $sqimap_capabilities['SASL-IR']) ? true : false;
b0434236 879 if(!empty($authz)) {
880 $auth = base64_encode("$username\0$authz\0$password");
881 } else {
882 $auth = base64_encode("$username\0$username\0$password");
883 }
fe55c7c7 884 if ($sasl) {
885 // IMAP Extension for SASL Initial Client Response
2bd6b461 886 // <draft-siemborski-imap-sasl-initial-response-01b.txt>
fe55c7c7 887 $query = $tag . " AUTHENTICATE PLAIN $auth\r\n";
888 fputs($imap_stream, $query);
b98732e8 889 $read = sqimap_fgets($imap_stream);
fe55c7c7 890 } else {
891 $query = $tag . " AUTHENTICATE PLAIN\r\n";
892 fputs($imap_stream, $query);
893 $read=sqimap_fgets($imap_stream);
894 if (substr($read,0,1) == '+') { // OK so far..
895 fputs($imap_stream, "$auth\r\n");
896 $read = sqimap_fgets($imap_stream);
897 }
098ea084 898 }
b98732e8 899 $results=explode(" ",$read,3);
900 $response=$results[1];
901 $message=$results[2];
b0434236 902
b98732e8 903 } else {
904 $response="BAD";
905 $message="Internal SquirrelMail error - unknown IMAP authentication method chosen. Please contact the developers.";
906 }
fe55c7c7 907
b98732e8 908 /* If the connection was not successful, lets see why */
9c737111 909 if ($response != 'OK') {
b4e0d365 910 if (!$hide || $hide == 3) {
911//FIXME: UUURG... We don't want HTML in error messages, should also do html sanitizing of error messages elsewhere; should't assume output is destined for an HTML browser here
74424a43 912 if ($response != 'NO') {
3411d4ec 913 /* "BAD" and anything else gets reported here. */
098ea084 914 $message = htmlspecialchars($message);
9c737111 915 set_up_language($squirrelmail_language, true);
916 if ($response == 'BAD') {
b4e0d365 917 if ($hide == 3) return sprintf(_("Bad request: %s"), $message);
6fd95361 918 $string = sprintf (_("Bad request: %s")."<br />\r\n", $message);
9c737111 919 } else {
b4e0d365 920 if ($hide == 3) return sprintf(_("Unknown error: %s"), $message);
6fd95361 921 $string = sprintf (_("Unknown error: %s") . "<br />\n", $message);
9c737111 922 }
1e7fc1cb 923 if (isset($read) && is_array($read)) {
6fd95361 924 $string .= '<br />' . _("Read data:") . "<br />\n";
9c737111 925 foreach ($read as $line) {
6fd95361 926 $string .= htmlspecialchars($line) . "<br />\n";
9c737111 927 }
928 }
1b858d86 929 error_box($string);
9c737111 930 exit;
165e24a7 931 } else {
3411d4ec 932 /*
933 * If the user does not log in with the correct
1c72b151 934 * username and password it is not possible to get the
935 * correct locale from the user's preferences.
936 * Therefore, apply the same hack as on the login
937 * screen.
3411d4ec 938 *
939 * $squirrelmail_language is set by a cookie when
1c72b151 940 * the user selects language and logs out
bee165ef 941 */
fe55c7c7 942
9c737111 943 set_up_language($squirrelmail_language, true);
098ea084 944 sqsession_destroy();
b86f98e4 945
d5c472f1 946 /* terminate the session nicely */
947 sqimap_logout($imap_stream);
b4e0d365 948 if ($hide == 3) return _("Unknown user or password incorrect.");
bd9c880b 949 logout_error( _("Unknown user or password incorrect.") );
9c737111 950 exit;
052e0c26 951 }
9c737111 952 } else {
41d66087 953 if ($hide == 2) return FALSE;
052e0c26 954 exit;
9c737111 955 }
956 }
1d20443c 957
958 /* Special error case:
959 * Login referrals. The server returns:
0e1a248b 960 * ? OK [REFERRAL <imap url>]
961 * Check RFC 2221 for details. Since we do not support login referrals yet
962 * we log the user out.
963 */
2da1524c 964 if ( stristr($message, 'REFERRAL imap') === TRUE ) {
0e1a248b 965 sqimap_logout($imap_stream);
1d20443c 966 set_up_language($squirrelmail_language, true);
1d20443c 967 sqsession_destroy();
edde1f5c 968 logout_error( _("Your mailbox is not located at this server. Try a different server or consult your system administrator") );
1d20443c 969 exit;
970 }
0e1a248b 971
9c737111 972 return $imap_stream;
973}
f1e6f580 974
48af4b64 975/**
976 * Simply logs out the IMAP session
95e3afc1 977 * @param stream $imap_stream the IMAP connection to log out.
48af4b64 978 * @return void
979 */
9c737111 980function sqimap_logout ($imap_stream) {
8d936b0c 981 /* Logout is not valid until the server returns 'BYE'
982 * If we don't have an imap_ stream we're already logged out */
26a2cc8b 983 if(isset($imap_stream) && $imap_stream)
8d936b0c 984 sqimap_run_command($imap_stream, 'LOGOUT', false, $response, $message);
9c737111 985}
986
48af4b64 987/**
95e3afc1 988 * Retrieve the CAPABILITY string from the IMAP server.
48af4b64 989 * If capability is set, returns only that specific capability,
990 * else returns array of all capabilities.
95e3afc1 991 * @param stream $imap_stream
a15f9d93 992 * @param string $capability (since 1.3.0)
4ae9beb7 993 * @param boolean $bUseCache (since 1.5.1) Controls use of capability data stored in session
0e1a248b 994 * @return mixed (string if $capability is set and found,
0022f6db 995 * false, if $capability is set and not found,
996 * array if $capability not set)
48af4b64 997 */
a15f9d93 998function sqimap_capability($imap_stream, $capability='', $bUseCache=true) {
999 // sqgetGlobalVar('sqimap_capabilities', $sqimap_capabilities, SQ_SESSION);
0493ed11 1000
a15f9d93 1001 if (!$bUseCache || ! sqgetGlobalVar('sqimap_capabilities', $sqimap_capabilities, SQ_SESSION)) {
1c72b151 1002 $read = sqimap_run_command($imap_stream, 'CAPABILITY', true, $a, $b);
9c737111 1003 $c = explode(' ', $read[0]);
1004 for ($i=2; $i < count($c); $i++) {
1005 $cap_list = explode('=', $c[$i]);
3411d4ec 1006 if (isset($cap_list[1])) {
045dee91 1007 if(isset($sqimap_capabilities[trim($cap_list[0])]) &&
1008 !is_array($sqimap_capabilities[trim($cap_list[0])])) {
1009 // Remove array key that was added in 'else' block below
1010 // This is to accomodate for capabilities like:
1011 // SORT SORT=MODSEQ
1012 unset($sqimap_capabilities[trim($cap_list[0])]);
1013 }
3cfa833d 1014 $sqimap_capabilities[trim($cap_list[0])][] = $cap_list[1];
3411d4ec 1015 } else {
045dee91 1016 if(!isset($sqimap_capabilities[trim($cap_list[0])])) {
1017 $sqimap_capabilities[trim($cap_list[0])] = TRUE;
1018 }
3411d4ec 1019 }
f1e6f580 1020 }
9c737111 1021 }
487daa81 1022 if ($capability) {
098ea084 1023 if (isset($sqimap_capabilities[$capability])) {
1024 return $sqimap_capabilities[$capability];
1025 } else {
1026 return false;
1027 }
f1e6f580 1028 }
487daa81 1029 return $sqimap_capabilities;
9c737111 1030}
1031
48af4b64 1032/**
95e3afc1 1033 * Returns the delimiter between mailboxes: INBOX/Test, or INBOX.Test
0022f6db 1034 * @param stream $imap_stream
1035 * @return string
48af4b64 1036 */
9c737111 1037function sqimap_get_delimiter ($imap_stream = false) {
3411d4ec 1038 global $sqimap_delimiter, $optional_delimiter;
85fc999e 1039
9c737111 1040 /* Use configured delimiter if set */
1041 if((!empty($optional_delimiter)) && $optional_delimiter != 'detect') {
1042 return $optional_delimiter;
1043 }
85fc999e 1044
7eb6261e 1045 /* Delimiter is stored in the session from redirect. Try fetching from there first */
cc54580f 1046 if (empty($sqimap_delimiter)) {
7eb6261e 1047 sqgetGlobalVar('delimiter',$sqimap_delimiter,SQ_SESSION);
1048 }
1049
9c737111 1050 /* Do some caching here */
1051 if (!$sqimap_delimiter) {
1052 if (sqimap_capability($imap_stream, 'NAMESPACE')) {
3411d4ec 1053 /*
1054 * According to something that I can't find, this is supposed to work on all systems
1055 * OS: This won't work in Courier IMAP.
1056 * OS: According to rfc2342 response from NAMESPACE command is:
1057 * OS: * NAMESPACE (PERSONAL NAMESPACES) (OTHER_USERS NAMESPACE) (SHARED NAMESPACES)
1058 * OS: We want to lookup all personal NAMESPACES...
b86f98e4 1059 *
6a645613 1060 * TODO: remove this in favour of the information from sqimap_get_namespace()
3411d4ec 1061 */
1c72b151 1062 $read = sqimap_run_command($imap_stream, 'NAMESPACE', true, $a, $b);
f1e6f580 1063 if (eregi('\\* NAMESPACE +(\\( *\\(.+\\) *\\)|NIL) +(\\( *\\(.+\\) *\\)|NIL) +(\\( *\\(.+\\) *\\)|NIL)', $read[0], $data)) {
9c737111 1064 if (eregi('^\\( *\\((.*)\\) *\\)', $data[1], $data2)) {
f1e6f580 1065 $pn = $data2[1];
9c737111 1066 }
f1e6f580 1067 $pna = explode(')(', $pn);
9c737111 1068 while (list($k, $v) = each($pna)) {
862ff2d3 1069 $lst = explode('"', $v);
1070 if (isset($lst[3])) {
1071 $pn[$lst[1]] = $lst[3];
1072 } else {
74424a43 1073 $pn[$lst[1]] = '';
862ff2d3 1074 }
f1e6f580 1075 }
1076 }
1077 $sqimap_delimiter = $pn[0];
1078 } else {
1079 fputs ($imap_stream, ". LIST \"INBOX\" \"\"\r\n");
1080 $read = sqimap_read_data($imap_stream, '.', true, $a, $b);
91e0dccc 1081 $read = $read['.'][0]; //sqimap_read_data() now returns a tag array of response array
f1e6f580 1082 $quote_position = strpos ($read[0], '"');
1083 $sqimap_delimiter = substr ($read[0], $quote_position+1, 1);
1084 }
1085 }
1086 return $sqimap_delimiter;
9c737111 1087}
052e0c26 1088
48af4b64 1089/**
6a645613 1090 * Retrieves the namespaces from the IMAP server.
1091 * NAMESPACE is an IMAP extension defined in RFC 2342.
1092 *
1093 * @param stream $imap_stream
1094 * @return array
1095 */
1096function sqimap_get_namespace($imap_stream) {
1097 $read = sqimap_run_command($imap_stream, 'NAMESPACE', true, $a, $b);
1098 return sqimap_parse_namespace($read[0]);
1099}
b86f98e4 1100
6a645613 1101/**
1102 * Parses a NAMESPACE response and returns an array with the available
1103 * personal, users and shared namespaces.
1104 *
1105 * @param string $input
1106 * @return array The returned array has the following format:
1107 * <pre>
1108 * array(
1109 * 'personal' => array(
1110 * 0 => array('prefix'=>'INBOX.','delimiter' =>'.'),
1111 * 1 => ...
1112 * ),
1113 * 'users' => array(..
1114 * ),
1115 * 'shared' => array( ..
1116 * )
1117 * )
1118 * </pre>
1119 * Note that if a namespace is not defined in the server, then the corresponding
1120 * array will be empty.
1121 */
1122function sqimap_parse_namespace(&$input) {
1123 $ns_strings = array(1=>'personal', 2=>'users', 3=>'shared');
1124 $namespace = array();
1125
1126 if(ereg('NAMESPACE (\(\(.*\)\)|NIL) (\(\(.*\)\)|NIL) (\(\(.*\)\)|NIL)', $input, $regs) !== false) {
1127 for($i=1; $i<=3; $i++) {
1128 if($regs[$i] == 'NIL') {
1129 $namespace[$ns_strings[$i]] = array();
1130 } else {
1131 // Pop-out the first ( and last ) for easier parsing
1132 $ns = substr($regs[$i], 1, sizeof($regs[$i])-2);
1133 if($c = preg_match_all('/\((?:(.*?)\s*?)\)/', $ns, $regs2)) {
1134 $namespace[$ns_strings[$i]] = array();
1135 for($j=0; $j<sizeof($regs2[1]); $j++) {
61d8f26d 1136 preg_match('/"(.*)"\s+("(.*)"|NIL)/', $regs2[1][$j], $regs3);
6a645613 1137 $namespace[$ns_strings[$i]][$j]['prefix'] = $regs3[1];
61d8f26d 1138 if($regs3[2] == 'NIL') {
1139 $namespace[$ns_strings[$i]][$j]['delimiter'] = null;
1140 } else {
1141 // $regs[3] is $regs[2] without the quotes
1142 $namespace[$ns_strings[$i]][$j]['delimiter'] = $regs3[3];
1143 }
6a645613 1144 unset($regs3);
1145 }
1146 }
1147 unset($ns);
1148 }
1149 }
1150 }
1151 return($namespace);
1152}
1153
1154/**
48af4b64 1155 * This encodes a mailbox name for use in IMAP commands.
95e3afc1 1156 * @param string $what the mailbox to encode
48af4b64 1157 * @return string the encoded mailbox string
0022f6db 1158 * @since 1.5.0
48af4b64 1159 */
b2306cbe 1160function sqimap_encode_mailbox_name($what)
1161{
91e0dccc 1162 if (ereg("[\"\\\r\n]", $what))
1163 return '{' . strlen($what) . "}\r\n" . $what; /* 4.3 literal form */
1164 return '"' . $what . '"'; /* 4.3 quoted string form */
b2306cbe 1165}
1166
48af4b64 1167/**
1168 * Gets the number of messages in the current mailbox.
1e0a2f0e 1169 *
1170 * OBSOLETE use sqimap_status_messages instead.
95e3afc1 1171 * @param stream $imap_stream imap stream
1172 * @param string $mailbox
1173 * @deprecated
48af4b64 1174 */
9c737111 1175function sqimap_get_num_messages ($imap_stream, $mailbox) {
48879ef0 1176 $aStatus = sqimap_status_messages($imap_stream,$mailbox,array('MESSAGES'));
1177 return $aStatus['MESSAGES'];
9c737111 1178}
95e3afc1 1179
1e0a2f0e 1180/**
1181 * OBSOLETE FUNCTION should be removed after mailbox_display,
1182 * printMessage function is adapted
95e3afc1 1183 * $addr_ar = array(), $group = '' and $host='' arguments are used in 1.4.0
1184 * @param string $address
1185 * @param integer $max
1186 * @since 1.4.0
1187 * @deprecated See Rfc822Address.php
1e0a2f0e 1188 */
91688e5f 1189function parseAddress($address, $max=0) {
1e0a2f0e 1190 $aAddress = parseRFC822Address($address,array('limit'=> $max));
1191 /*
1192 * Because the expected format of the array element is changed we adapt it now.
1193 * This also implies that this function is obsolete and should be removed after the
1194 * rest of the source is adapted. See Rfc822Address.php for the new function.
1195 */
1196 array_walk($aAddress, '_adaptAddress');
1197 return $aAddress;
1198}
91688e5f 1199
1e0a2f0e 1200/**
1201 * OBSOLETE FUNCTION should be removed after mailbox_display,
1202 * printMessage function is adapted
95e3afc1 1203 *
0e1a248b 1204 * callback function used for formating of addresses array in
95e3afc1 1205 * parseAddress() function
1206 * @param array $aAddr
1207 * @param integer $k array key
1208 * @since 1.5.1
1209 * @deprecated
1e0a2f0e 1210 */
1211function _adaptAddress(&$aAddr,$k) {
1212 $sPersonal = (isset($aAddr[SQM_ADDR_PERSONAL]) && $aAddr[SQM_ADDR_PERSONAL]) ?
1213 $aAddr[SQM_ADDR_PERSONAL] : '';
1214 $sEmail = ($aAddr[SQM_ADDR_HOST]) ?
3cd52f38 1215 $aAddr[SQM_ADDR_MAILBOX] . '@'.$aAddr[SQM_ADDR_HOST] :
1216 $aAddr[SQM_ADDR_MAILBOX];
1e0a2f0e 1217 $aAddr = array($sEmail,$sPersonal);
1218}
91688e5f 1219
48af4b64 1220/**
1221 * Returns the number of unseen messages in this folder.
26e90c74 1222 * obsoleted by sqimap_status_messages !
95e3afc1 1223 * Arguments differ in 1.0.x
1224 * @param stream $imap_stream
1225 * @param string $mailbox
1226 * @return integer
1227 * @deprecated
3411d4ec 1228 */
9c737111 1229function sqimap_unseen_messages ($imap_stream, $mailbox) {
26e90c74 1230 $aStatus = sqimap_status_messages($imap_stream,$mailbox,array('UNSEEN'));
1231 return $aStatus['UNSEEN'];
9c737111 1232}
1233
48af4b64 1234/**
26e90c74 1235 * Returns the status items of a mailbox.
1236 * Default it returns MESSAGES,UNSEEN and RECENT
0e1a248b 1237 * Supported status items are MESSAGES, UNSEEN, RECENT (since 1.4.0),
95e3afc1 1238 * UIDNEXT (since 1.5.1) and UIDVALIDITY (since 1.5.1)
1239 * @param stream $imap_stream imap stream
1240 * @param string $mailbox mail folder
1241 * @param array $aStatusItems status items
1242 * @return array
1243 * @since 1.3.2
1f720b34 1244 */
1e0a2f0e 1245function sqimap_status_messages ($imap_stream, $mailbox,
26e90c74 1246 $aStatusItems = array('MESSAGES','UNSEEN','RECENT')) {
1247
3fedd15b 1248 $aStatusItems = implode(' ',$aStatusItems);
26e90c74 1249 $read_ary = sqimap_run_command ($imap_stream, 'STATUS ' . sqimap_encode_mailbox_name($mailbox) .
1250 " ($aStatusItems)", false, $result, $message);
1f720b34 1251 $i = 0;
26e90c74 1252 $messages = $unseen = $recent = $uidnext = $uidvalidity = false;
1f720b34 1253 $regs = array(false,false);
1254 while (isset($read_ary[$i])) {
1255 if (preg_match('/UNSEEN\s+([0-9]+)/i', $read_ary[$i], $regs)) {
098ea084 1256 $unseen = $regs[1];
1257 }
1f720b34 1258 if (preg_match('/MESSAGES\s+([0-9]+)/i', $read_ary[$i], $regs)) {
098ea084 1259 $messages = $regs[1];
1260 }
b8ec18ef 1261 if (preg_match('/RECENT\s+([0-9]+)/i', $read_ary[$i], $regs)) {
098ea084 1262 $recent = $regs[1];
1e0a2f0e 1263 }
26e90c74 1264 if (preg_match('/UIDNEXT\s+([0-9]+)/i', $read_ary[$i], $regs)) {
1265 $uidnext = $regs[1];
1e0a2f0e 1266 }
26e90c74 1267 if (preg_match('/UIDVALIDITY\s+([0-9]+)/i', $read_ary[$i], $regs)) {
1268 $uidvalidity = $regs[1];
1e0a2f0e 1269 }
1f720b34 1270 $i++;
1271 }
48879ef0 1272
1273 $status=array('MESSAGES' => $messages,
1e0a2f0e 1274 'UNSEEN'=>$unseen,
26e90c74 1275 'RECENT' => $recent,
1276 'UIDNEXT' => $uidnext,
1277 'UIDVALIDITY' => $uidvalidity);
48879ef0 1278
1279 if (!empty($messages)) { $hook_status['MESSAGES']=$messages; }
1280 if (!empty($unseen)) { $hook_status['UNSEEN']=$unseen; }
1281 if (!empty($recent)) { $hook_status['RECENT']=$recent; }
81de00c0 1282 if (!empty($hook_status)) {
48879ef0 1283 $hook_status['MAILBOX']=$mailbox;
1284 $hook_status['CALLER']='sqimap_status_messages';
d849b570 1285 do_hook('folder_status', $hook_status);
48879ef0 1286 }
1287 return $status;
1f720b34 1288}
1289
9c737111 1290
48af4b64 1291/**
1292 * Saves a message to a given folder -- used for saving sent messages
95e3afc1 1293 * @param stream $imap_stream
1294 * @param string $sent_folder
1295 * @param $length
81de00c0 1296 * @return string $sid
3411d4ec 1297 */
81de00c0 1298function sqimap_append ($imap_stream, $sMailbox, $length) {
1299 $sid = sqimap_session_id();
1300 $query = $sid . ' APPEND ' . sqimap_encode_mailbox_name($sMailbox) . " (\\Seen) {".$length."}";
1301 fputs ($imap_stream, "$query\r\n");
85fc999e 1302 $tmp = fgets ($imap_stream, 1024);
81de00c0 1303 sqimap_append_checkresponse($tmp, $sMailbox,$sid, $query);
1304 return $sid;
9c737111 1305}
1306
95e3afc1 1307/**
1308 * @param stream imap_stream
1309 * @param string $folder (since 1.3.2)
1310 */
81de00c0 1311function sqimap_append_done ($imap_stream, $sMailbox='') {
9c737111 1312 fputs ($imap_stream, "\r\n");
1313 $tmp = fgets ($imap_stream, 1024);
81de00c0 1314 while (!sqimap_append_checkresponse($tmp, $sMailbox)) {
1315 $tmp = fgets ($imap_stream, 1024);
1316 }
7ec3a6b9 1317}
1318
95e3afc1 1319/**
0e1a248b 1320 * Displays error messages, if there are errors in responses to
95e3afc1 1321 * commands issues by sqimap_append() and sqimap_append_done() functions.
1322 * @param string $response
81de00c0 1323 * @param string $sMailbox
1324 * @return bool $bDone
9948500c 1325 * @since 1.5.1 and 1.4.5
95e3afc1 1326 */
81de00c0 1327function sqimap_append_checkresponse($response, $sMailbox, $sid='', $query='') {
81de00c0 1328 // static vars to keep them available when sqimap_append_done calls this function.
1329 static $imapquery, $imapsid;
7ec3a6b9 1330
81de00c0 1331 $bDone = false;
1332
1333 if ($query) {
1334 $imapquery = $query;
1335 }
1336 if ($sid) {
1337 $imapsid = $sid;
1338 }
1339 if ($response{0} == '+') {
1340 // continuation request triggerd by sqimap_append()
1341 $bDone = true;
1342 } else {
1343 $i = strpos($response, ' ');
1344 $sRsp = substr($response,0,$i);
1345 $sMsg = substr($response,$i+1);
1346 $aExtra = array('MAILBOX' => $sMailbox);
1347 switch ($sRsp) {
1348 case '*': //untagged response
1349 $i = strpos($sMsg, ' ');
1350 $sRsp = strtoupper(substr($sMsg,0,$i));
1351 $sMsg = substr($sMsg,$i+1);
1352 if ($sRsp == 'NO' || $sRsp == 'BAD') {
1353 // for the moment disabled. Enable after 1.5.1 release.
1354 // Notices could give valueable information about the mailbox
1355 // sqm_trigger_imap_error('SQM_IMAP_APPEND_NOTICE',$imapquery,$sRsp,$sMsg);
1356 }
1357 $bDone = false;
1358 case $imapsid:
1359 // A001 OK message
1360 // $imapsid<space>$sRsp<space>$sMsg
1361 $bDone = true;
1362 $i = strpos($sMsg, ' ');
1363 $sRsp = strtoupper(substr($sMsg,0,$i));
1364 $sMsg = substr($sMsg,$i+1);
1365 switch ($sRsp) {
1366 case 'NO':
1367 if (preg_match("/(.*)(quota)(.*)$/i", $sMsg, $aMatch)) {
1368 sqm_trigger_imap_error('SQM_IMAP_APPEND_QUOTA_ERROR',$imapquery,$sRsp,$sMsg,$aExtra);
1369 } else {
1370 sqm_trigger_imap_error('SQM_IMAP_APPEND_ERROR',$imapquery,$sRsp,$sMsg,$aExtra);
1371 }
1372 break;
1373 case 'BAD':
1374 sqm_trigger_imap_error('SQM_IMAP_ERROR',$imapquery,$sRsp,$sMsg,$aExtra);
1375 break;
1376 case 'BYE':
1377 sqm_trigger_imap_error('SQM_IMAP_BYE',$imapquery,$sRsp,$sMsg,$aExtra);
1378 break;
1379 case 'OK':
1380 break;
1381 default:
1382 break;
1383 }
1384 break;
1385 default:
1386 // should be false because of the unexpected response but i'm not sure if
1387 // that will cause an endless loop in sqimap_append_done
1388 $bDone = true;
098ea084 1389 }
69146537 1390 }
81de00c0 1391 return $bDone;
9c737111 1392}
85fc999e 1393
95e3afc1 1394/**
0e1a248b 1395 * Allows mapping of IMAP server address with custom function
95e3afc1 1396 * see map_yp_alias()
1397 * @param string $imap_server imap server address or mapping
1398 * @param string $username
1399 * @return string
1400 * @since 1.3.0
1401 */
bd9829d7 1402function sqimap_get_user_server ($imap_server, $username) {
bd9829d7 1403 if (substr($imap_server, 0, 4) != "map:") {
1404 return $imap_server;
1405 }
bd9829d7 1406 $function = substr($imap_server, 4);
1407 return $function($username);
1408}
1409
48af4b64 1410/**
0e1a248b 1411 * This is an example that gets IMAP servers from yellowpages (NIS).
1e0a2f0e 1412 * you can simple put map:map_yp_alias in your $imap_server_address
bd9829d7 1413 * in config.php use your own function instead map_yp_alias to map your
0e1a248b 1414 * LDAP whatever way to find the users IMAP server.
1415 *
95e3afc1 1416 * Requires access to external ypmatch program
1417 * FIXME: it can be implemented in php yp extension or pecl (since php 5.1.0)
1418 * @param string $username
1419 * @return string
1420 * @since 1.3.0
48af4b64 1421 */
bd9829d7 1422function map_yp_alias($username) {
1423 $yp = `ypmatch $username aliases`;
1424 return chop(substr($yp, strlen($username)+1));
1e0a2f0e 1425}